Codestin Search App

Tomanhez · 2020-10-13T14:09:54Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
License	MIT

This PR is first step to improve IRI that are return in responses on shop and admin endpoints.
First problem was IriConverter that was returning bad IRI because RouteNameResolver return first matching route without aware who was called - admin or shop. It was working bad because we break all path into two prefixes (before all entities had one path).
Second problem is resources configuration: All IRI-s have to proper paths on other sites: admin and shop.
My solution:

RouteNameResolver looks for not the first occurrence, but all matching routes and match it by current prefix.
Added necessary configuration for resources to get all proper IRI-s and routes on shop and admin contexts

To complete this PR, we need cover all occurs IRI in entities that have path on two contexts:

Example:
Before

After:

oallain · 2020-10-14T11:55:27Z

Thanks @Tomanhez
I think, this is a part fix of #11893 💪

… shipments and payments

lchrusciel · 2020-11-12T13:17:00Z

+     * @When I try to see one of the items from the order placed by a customer :customer
+     */
+    public function iTryToSeeOneOfTheItemsFromTheOrderPlacedByACustomer(): void
+    {
+        /** @var OrderInterface $order */
+        $order = $this->sharedStorage->get('order');


customer is never checked in this context, we are checking the last order registered in shared storage. Perhaps adjusting of a step definition and/or asserting if the ordered belongs to customer should done.

lchrusciel · 2020-11-12T13:17:22Z

+    }
+
+    /**
+     * @When I try to see one of the units from the order placed by a customer :customer


same as above

And in every customer aware endpoint

lchrusciel · 2020-11-12T13:21:02Z

+        if ($customer !== null && in_array('ROLE_USER', $user->getRoles(), true)) {
+            return $this->orderItemRepository->findOneByCustomer($id, $customer);
+        }
+
+        if ($user instanceof AdminUserInterface && in_array('ROLE_API_ACCESS', $user->getRoles(), true)) {
+            return $this->orderItemRepository->findOneBy(['id' => $id]);
+        }


I'm wondering if we should extract this behavior to separate classes to make it easier to override.

lchrusciel · 2020-11-12T13:21:56Z

+        }
+
+        if ($user instanceof AdminUserInterface && in_array('ROLE_API_ACCESS', $user->getRoles(), true)) {
+            return $this->shipmentRepository->findOneBy(['id' => $id]);


Suggested change

return $this->shipmentRepository->findOneBy(['id' => $id]);

return $this->shipmentRepository->find($id);

lchrusciel · 2020-11-12T13:24:18Z

+    private function returnMatchingRouteName(
+        array $matchingRoutes,
+        string $operationType,
+        string$resourceClass


Suggested change

string$resourceClass

string $resourceClass

lchrusciel · 2020-11-12T13:25:26Z

+        $pathElements = array_values(array_filter(explode('/', $path)));
+
+        if ('/' . $pathElements[0] !== $this->apiRoute) {
+            return null;
+        }
+
+        if ($pathElements[1] === PathPrefixes::SHOP_PREFIX) {
+            return PathPrefixes::SHOP_PREFIX;
+        }
+
+        if ($pathElements[1] === PathPrefixes::ADMIN_PREFIX) {
+            return PathPrefixes::ADMIN_PREFIX;
+        }
+
+        return null;


I'm wondering if we can reuse UriBasedSectionProvider instead of this construction. But it should be an idea for future improvements.

lchrusciel · 2020-11-12T13:55:35Z

        </itemOperations>

+        <subresourceOperations>
+            <subresourceOperation name="methods_get_subresource">


Suggested change

<subresourceOperation name="methods_get_subresource">

<subresourceOperation name="shop_get_shipping_methods_subresource">

or

Suggested change

<subresourceOperation name="methods_get_subresource">

<subresourceOperation name="shop_shipping_methods_subresource_get">

WDYT?

Looks cool, but this subresource name couldn't be changed as it is an identifier of this operation. This is the only way I can change the operation's parameters for a subresource endpoint that is configured below

<property name="method"> <subresource resourceClass="%sylius.model.shipping_method.class%" /> </property>

lchrusciel · 2020-11-12T13:56:09Z

 >
    <class name="Sylius\Component\Core\Model\Address">
+        <attribute name="id">
+            <group>address:read</group>


shop/admin?

lchrusciel · 2020-11-12T14:00:11Z

+
+class OrderItemRepository extends BaseOrderItemRepository implements OrderItemRepositoryInterface
+{
+    public function findOneByCustomer($id, CustomerInterface $customer): ?OrderItemInterface


Suggested change

public function findOneByCustomer($id, CustomerInterface $customer): ?OrderItemInterface

public function findOneByIdAndCustomer($id, CustomerInterface $customer): ?OrderItemInterface

lchrusciel · 2020-11-12T14:03:46Z

Thanks, Tomasz! 🥇

…om slug to code (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | based on #11925 | License | MIT Commits ------- 58ce6bd [API][Product] Change identifier for shop endpoint from slug to code

…t contexts (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | fixes after #11925 | License | MIT Commits ------- f8a6101 [API] Fixes after PR with resolving proper iri in different contexts

…om slug to code (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | based on Sylius/Sylius#11925 | License | MIT Commits ------- 58ce6bd3d4745cb281ed97374f2324fd9e0af66d [API][Product] Change identifier for shop endpoint from slug to code

…t contexts (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | fixes after Sylius/Sylius#11925 | License | MIT Commits ------- f8a6101be7004d97dc7d112dcebccb7a36deb381 [API] Fixes after PR with resolving proper iri in different contexts

…ces (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Related tickets | after #11925 | License | MIT Commits ------- 4fbbbde [API] Add missing endpoints for address and country resources

…om slug to code (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | based on Sylius/Sylius#11925 | License | MIT Commits ------- 58ce6bd3d4745cb281ed97374f2324fd9e0af66d [API][Product] Change identifier for shop endpoint from slug to code

…t contexts (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | fixes after Sylius/Sylius#11925 | License | MIT Commits ------- f8a6101be7004d97dc7d112dcebccb7a36deb381 [API] Fixes after PR with resolving proper iri in different contexts

…om slug to code (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | based on Sylius/Sylius#11925 | License | MIT Commits ------- 58ce6bd3d4745cb281ed97374f2324fd9e0af66d [API][Product] Change identifier for shop endpoint from slug to code

…t contexts (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Related tickets | fixes after Sylius/Sylius#11925 | License | MIT Commits ------- f8a6101be7004d97dc7d112dcebccb7a36deb381 [API] Fixes after PR with resolving proper iri in different contexts

…ces (GSadee) This PR was merged into the 1.9-dev branch. Discussion ---------- | Q | A | --------------- | ----- | Branch? | master | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Related tickets | after Sylius/Sylius#11925 | License | MIT Commits ------- 4fbbbde7eb6224f733d736dc4f712d4cb2bb9378 [API] Add missing endpoints for address and country resources

Tomanhez requested a review from a team as a code owner October 13, 2020 14:09

Tomanhez changed the title ~~[Api][Spike] Iri converter~~ [Api]Iri converter Oct 13, 2020

Tomanhez force-pushed the iri-converter-spike branch 2 times, most recently from aa82aa2 to f32016f Compare October 14, 2020 11:16

Tomanhez force-pushed the iri-converter-spike branch 2 times, most recently from aab699a to c9ab309 Compare October 14, 2020 17:41

GSadee reviewed Oct 15, 2020

View reviewed changes

Comment thread src/Sylius/Bundle/ApiBundle/Resolver/RouteNameResolver.php Outdated

GSadee reviewed Oct 15, 2020

View reviewed changes

Comment thread src/Sylius/Bundle/ApiBundle/Resolver/RouteNameResolver.php Outdated

Comment thread src/Sylius/Bundle/ApiBundle/Resolver/CachedRouteNameResolver.php Outdated

GSadee added API APIs related issues and PRs. RFC Discussions about potential changes or new features. labels Oct 15, 2020

Tomanhez force-pushed the iri-converter-spike branch 3 times, most recently from aba9058 to 4723946 Compare October 15, 2020 06:39

Tomanhez changed the title ~~[Api]Iri converter~~ [PoC][API] Resolve proper IRI in admin/shop contexts Oct 15, 2020

Tomanhez commented Oct 15, 2020

View reviewed changes

Comment thread src/Sylius/Behat/Service/Provider/RequestApiPathPrefixProvider.php Outdated

Tomanhez force-pushed the iri-converter-spike branch 3 times, most recently from 1940564 to 17f3030 Compare October 16, 2020 08:45

AdamKasp reviewed Oct 16, 2020

View reviewed changes

Comment thread features/product/viewing_products/viewing_product_with_proper_iri_identifiers.feature Outdated

Tomanhez force-pushed the iri-converter-spike branch from 17f3030 to d896c11 Compare October 16, 2020 09:31

arti0090 reviewed Oct 16, 2020

View reviewed changes

Comment thread src/Sylius/Bundle/ApiBundle/Provider/RequestApiPathPrefixProvider.php Outdated

lchrusciel reviewed Oct 16, 2020

View reviewed changes

Tomanhez force-pushed the iri-converter-spike branch 2 times, most recently from 1bff68f to 2bf0ebe Compare October 19, 2020 13:16

GSadee reviewed Oct 21, 2020

View reviewed changes

GSadee force-pushed the iri-converter-spike branch from 2bf0ebe to 1afdc9f Compare November 11, 2020 11:39

Tomanhez added 3 commits November 11, 2020 13:41

Add behat scenario for iri product

c47e4af

Add path providers and spec test

9044b19

Add RequestApiPathPrefixProvider on behat services

36fe001

GSadee added 4 commits November 11, 2020 13:41

[API][Behat] Remove admin to shop iri converter

fe0d4cd

[API] Add shop endpoints for resources

89caa88

[API] Secure access in shop context to order items, order item units,…

1533967

… shipments and payments

[API] Improve serialization for payment and shipment resource

5ba4d7c

GSadee force-pushed the iri-converter-spike branch from 1afdc9f to 5ba4d7c Compare November 11, 2020 13:13

GSadee added 2 commits November 11, 2020 16:30

[API][Behat] Fixes to make the build green

ef01ab5

[API][Behat] Remove exploding an iri to get address id

66df68b

arti0090 reviewed Nov 12, 2020

View reviewed changes

AdamKasp reviewed Nov 12, 2020

View reviewed changes

Comment thread src/Sylius/Behat/Context/Api/Shop/CartContext.php Outdated

Comment thread src/Sylius/Behat/Resources/config/services/api.xml Outdated

Comment thread src/Sylius/Behat/Resources/config/services/api.xml Outdated

GSadee force-pushed the iri-converter-spike branch 2 times, most recently from 99b1835 to ef5675f Compare November 12, 2020 07:59

[API] Minor fixes after PR review

5e15454

GSadee force-pushed the iri-converter-spike branch from ef5675f to 5e15454 Compare November 12, 2020 10:02

GSadee mentioned this pull request Nov 12, 2020

[API][Product] Change identifier for shop endpoint from slug to code #12034

Merged

lchrusciel reviewed Nov 12, 2020

View reviewed changes

lchrusciel merged commit 11dd149 into Sylius:master Nov 12, 2020

GSadee mentioned this pull request Nov 13, 2020

[API] Fixes after PR with resolving proper iri in different contexts #12041

Merged

GSadee mentioned this pull request Nov 13, 2020

[API] Add missing endpoints for address and country resources #12045

Merged

oallain mentioned this pull request Dec 19, 2020

[New Api] Uri of sub-ressources #11893

Closed

	return $this->shipmentRepository->findOneBy(['id' => $id]);
	return $this->shipmentRepository->find($id);

	<subresourceOperation name="methods_get_subresource">
	<subresourceOperation name="shop_get_shipping_methods_subresource">

	<subresourceOperation name="methods_get_subresource">
	<subresourceOperation name="shop_shipping_methods_subresource_get">

	public function findOneByCustomer($id, CustomerInterface $customer): ?OrderItemInterface
	public function findOneByIdAndCustomer($id, CustomerInterface $customer): ?OrderItemInterface

Uh oh!

Conversation

Tomanhez commented Oct 13, 2020 • edited by GSadee Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oallain commented Oct 14, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lchrusciel commented Nov 12, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Tomanhez commented Oct 13, 2020 •

edited by GSadee

Loading