minor #15803 Duplicate all serializer groups with sylius prefix (Rafi…

…kooo) This PR was merged into the 1.13 branch. Discussion ---------- | Q | A | |-----------------|--------------------------------------------------------------| | Branch? | 1.13  | | Bug fix? | no | | New feature? | no | | BC breaks? | no | | Deprecations? | yes  | | License | MIT | To avoid conflicts with duplicated naming for the end apps, we have introduced prefixed serialization groups in the Sylius serialization groups configurations. Commits ------- [ApiBundle] Duplicate all serializer groups with sylius prefix [CoreBundle] Duplicate all serializer groups with sylius prefix [ApiBundle] Duplicate all resources normalization and denormalization config groups with sylius prefix [Upgrade] Note new sylius prefix in serialization groups [ApiBundle][Tests] Duplicate all resources normalization and denormalization config groups with sylius prefix
Sylius · Feb 7, 2024 · 7735d06 · 7735d06
2 parents 7e34b0e + 1b29548
commit 7735d06
Show file tree

Hide file tree

Showing 146 changed files with 3,039 additions and 279 deletions.
diff --git a/UPGRADE-2.0.md b/UPGRADE-2.0.md
@@ -1,5 +1,13 @@
 # UPGRADE FROM `v1.X.X` TO `v2.0.0`
 
+1. Non-prefix serialization groups in Sylius resources have been removed. 
+   If you have extended any of them, you must prefix them with `sylius:`, for example:
+
+    ```diff
+    - #[Groups(['admin:product:index'])]
+    + #[Groups(['sylius:admin:product:index'])]
+    ```
+
 ## Codebase
 
 * Doctrine MongoDB and PHPCR is not longer supported in ResourceBundle and GridBundle:

diff --git a/UPGRADE-API-1.13.md b/UPGRADE-API-1.13.md
@@ -13,6 +13,10 @@
             skip_adding_read_group: true
     ```
 
+1. Sylius serialization groups have been updated with a new prefix of `sylius:some_resource`.
+   If you extend any of the Sylius resources, you should update your serialization groups to use the new prefix.
+   Non-prefix serialization groups are deprecated and will be removed in Sylius 2.0.
+
 1. The constructor of `Sylius\Bundle\ApiBundle\Serializer\ChannelDenormalizer` has been changed:
 
     ```diff

diff --git a/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AccountResetPassword.xml b/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AccountResetPassword.xml
@@ -27,7 +27,10 @@
                 <attribute name="output">false</attribute>
                 <attribute name="status">202</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">shop:reset_password:create</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:reset_password:create</attribute>
+                        <attribute>sylius:shop:reset_password:create</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="openapi_context">
                     <attribute name="summary">Requests password reset</attribute>
@@ -43,7 +46,10 @@
                 <attribute name="output">false</attribute>
                 <attribute name="status">202</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">shop:reset_password:update</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:reset_password:update</attribute>
+                        <attribute>sylius:shop:reset_password:update</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="openapi_context">
                     <attribute name="summary">Resets password</attribute>

diff --git a/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Address.xml b/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Address.xml
@@ -19,18 +19,27 @@
                 <attribute name="method">GET</attribute>
                 <attribute name="path">/shop/addresses</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">shop:address:index</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:address:index</attribute>
+                        <attribute>sylius:shop:address:index</attribute>
+                    </attribute>
                 </attribute>
             </collectionOperation>
 
             <collectionOperation name="shop_post">
                 <attribute name="method">POST</attribute>
                 <attribute name="path">/shop/addresses</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">shop:address:create</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:address:create</attribute>
+                        <attribute>sylius:shop:address:create</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">shop:address:show</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:address:show</attribute>
+                        <attribute>sylius:shop:address:show</attribute>
+                    </attribute>
                 </attribute>
             </collectionOperation>
         </collectionOperations>
@@ -42,6 +51,7 @@
                 <attribute name="normalization_context">
                     <attribute name="groups">
                         <attribute>admin:address:show</attribute>
+                        <attribute>sylius:admin:address:show</attribute>
                     </attribute>
                 </attribute>
             </itemOperation>
@@ -52,11 +62,13 @@
                 <attribute name="denormalization_context">
                     <attribute name="groups">
                         <attribute>admin:address:update</attribute>
+                        <attribute>sylius:admin:address:update</attribute>
                     </attribute>
                 </attribute>
                 <attribute name="normalization_context">
                     <attribute name="groups">
                         <attribute>admin:address:show</attribute>
+                        <attribute>sylius:admin:address:show</attribute>
                     </attribute>
                 </attribute>
             </itemOperation>
@@ -66,7 +78,10 @@
                 <attribute name="path">/admin/addresses/{id}/log-entries</attribute>
                 <attribute name="controller">Sylius\Bundle\ApiBundle\Controller\GetAddressLogEntryCollectionAction</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:address:log_entry:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:address:log_entry:show</attribute>
+                        <attribute>sylius:admin:address:log_entry:show</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="openapi_context">
                     <attribute name="summary">Retrieves the collection of AddressLogEntry resources.</attribute>
@@ -78,7 +93,10 @@
                 <attribute name="method">GET</attribute>
                 <attribute name="path">/shop/addresses/{id}</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">shop:address:show</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:address:show</attribute>
+                        <attribute>sylius:shop:address:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
 
@@ -91,10 +109,16 @@
                 <attribute name="method">PUT</attribute>
                 <attribute name="path">/shop/addresses/{id}</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">shop:address:update</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:address:update</attribute>
+                        <attribute>sylius:shop:address:update</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">shop:address:show</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:address:show</attribute>
+                        <attribute>sylius:shop:address:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
         </itemOperations>

diff --git a/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Adjustment.xml b/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Adjustment.xml
@@ -24,7 +24,10 @@
                     <attribute>sylius.api.order_token_filter</attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:adjustment:index</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:adjustment:index</attribute>
+                        <attribute>sylius:admin:adjustment:index</attribute>
+                    </attribute>
                 </attribute>
             </collectionOperation>
         </collectionOperations>
@@ -34,28 +37,40 @@
                 <attribute name="method">GET</attribute>
                 <attribute name="path">/admin/adjustments/{id}</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:adjustment:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:adjustment:show</attribute>
+                        <attribute>sylius:admin:adjustment:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
 
             <itemOperation name="shop_get">
                 <attribute name="method">GET</attribute>
                 <attribute name="path">/shop/adjustments/{id}</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">shop:adjustment:show</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:adjustment:show</attribute>
+                        <attribute>sylius:shop:adjustment:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
         </itemOperations>
 
         <subresourceOperations>
             <subresourceOperation name="api_orders_adjustments_get_subresource">
                 <attribute name="normalization_context">
-                    <attribute name="groups">shop:cart:show</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:cart:show</attribute>
+                        <attribute>sylius:shop:cart:show</attribute>
+                    </attribute>
                 </attribute>
             </subresourceOperation>
             <subresourceOperation name="api_orders_items_adjustments_get_subresource">
                 <attribute name="normalization_context">
-                    <attribute name="groups">shop:cart:show</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:cart:show</attribute>
+                        <attribute>sylius:shop:cart:show</attribute>
+                    </attribute>
                 </attribute>
             </subresourceOperation>
         </subresourceOperations>

diff --git a/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AdminResetPassword.xml b/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AdminResetPassword.xml
@@ -27,7 +27,10 @@
                 <attribute name="output">false</attribute>
                 <attribute name="status">202</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">admin:reset_password:create</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:reset_password:create</attribute>
+                        <attribute>sylius:admin:reset_password:create</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="openapi_context">
                     <attribute name="summary">Requests administrator's password reset</attribute>
@@ -43,7 +46,10 @@
                 <attribute name="output">false</attribute>
                 <attribute name="status">202</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">admin:reset_password:update</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:reset_password:update</attribute>
+                        <attribute>sylius:admin:reset_password:update</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="openapi_context">
                     <attribute name="summary">Resets administrator's password</attribute>

diff --git a/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AdminUser.xml b/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AdminUser.xml
@@ -24,7 +24,10 @@
             <collectionOperation name="admin_get">
                 <attribute name="method">GET</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:admin_user:index</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:admin_user:index</attribute>
+                        <attribute>sylius:admin:admin_user:index</attribute>
+                    </attribute>
                 </attribute>
             </collectionOperation>
 
@@ -35,10 +38,16 @@
                     <attribute>sylius_user_create</attribute>
                 </attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">admin:admin_user:create</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:admin_user:create</attribute>
+                        <attribute>sylius:admin:admin_user:create</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:admin_user:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:admin_user:show</attribute>
+                        <attribute>sylius:admin:admin_user:show</attribute>
+                    </attribute>
                 </attribute>
             </collectionOperation>
         </collectionOperations>
@@ -47,17 +56,26 @@
             <itemOperation name="admin_get">
                 <attribute name="method">GET</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:admin_user:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:admin_user:show</attribute>
+                        <attribute>sylius:admin:admin_user:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
 
             <itemOperation name="admin_put">
                 <attribute name="method">PUT</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">admin:admin_user:update</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:admin_user:update</attribute>
+                        <attribute>sylius:admin:admin_user:update</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:admin_user:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:admin_user:show</attribute>
+                        <attribute>sylius:admin:admin_user:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
 

diff --git a/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AvatarImage.xml b/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AvatarImage.xml
@@ -45,7 +45,10 @@
                     </attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:avatar_image:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:avatar_image:show</attribute>
+                        <attribute>sylius:admin:avatar_image:show</attribute>
+                    </attribute>
                 </attribute>
             </collectionOperation>
         </collectionOperations>
@@ -54,7 +57,10 @@
             <itemOperation name="admin_get">
                 <attribute name="method">GET</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:avatar_image:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:avatar_image:show</attribute>
+                        <attribute>sylius:admin:avatar_image:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
 

diff --git a/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/CatalogPromotion.xml b/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/CatalogPromotion.xml
@@ -36,18 +36,27 @@
                     <attribute>sylius.api.order_filter.priority</attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:catalog_promotion:index</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:catalog_promotion:index</attribute>
+                        <attribute>sylius:admin:catalog_promotion:index</attribute>
+                    </attribute>
                 </attribute>
             </collectionOperation>
 
             <collectionOperation name="admin_post">
                 <attribute name="path">/admin/catalog-promotions</attribute>
                 <attribute name="method">POST</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">admin:catalog_promotion:create</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:catalog_promotion:create</attribute>
+                        <attribute>sylius:admin:catalog_promotion:create</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:catalog_promotion:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:catalog_promotion:show</attribute>
+                        <attribute>sylius:admin:catalog_promotion:show</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="openapi_context">
                     <attribute name="description">
@@ -84,26 +93,38 @@ Example configuration for `percentage_discount` action type:
                 <attribute name="path">/admin/catalog-promotions/{code}</attribute>
                 <attribute name="method">GET</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:catalog_promotion:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:catalog_promotion:show</attribute>
+                        <attribute>sylius:admin:catalog_promotion:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
 
             <itemOperation name="shop_get">
                 <attribute name="path">/shop/catalog-promotions/{code}</attribute>
                 <attribute name="method">GET</attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">shop:catalog_promotion:show</attribute>
+                    <attribute name="groups">
+                        <attribute>shop:catalog_promotion:show</attribute>
+                        <attribute>sylius:shop:catalog_promotion:show</attribute>
+                    </attribute>
                 </attribute>
             </itemOperation>
 
             <itemOperation name="admin_put">
                 <attribute name="path">/admin/catalog-promotions/{code}</attribute>
                 <attribute name="method">PUT</attribute>
                 <attribute name="denormalization_context">
-                    <attribute name="groups">admin:catalog_promotion:update</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:catalog_promotion:update</attribute>
+                        <attribute>sylius:admin:catalog_promotion:update</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="normalization_context">
-                    <attribute name="groups">admin:catalog_promotion:show</attribute>
+                    <attribute name="groups">
+                        <attribute>admin:catalog_promotion:show</attribute>
+                        <attribute>sylius:admin:catalog_promotion:show</attribute>
+                    </attribute>
                 </attribute>
                 <attribute name="openapi_context">
                     <attribute name="description">