Sylius/UPGRADE-1.8.md

UPGRADE FROM v1.7.X TO v1.8.0

1. Add new bundles to your list of used bundles in config/bundles.php if you are not using it apart from Sylius:

   +   ApiPlatform\Core\Bridge\Symfony\Bundle\ApiPlatformBundle::class => ['all' => true],
   +   Sylius\Bundle\ApiBundle\SyliusApiBundle::class => ['all' => true],
   +   Lexik\Bundle\JWTAuthenticationBundle\LexikJWTAuthenticationBundle::class => ['all' => true],
   +   SyliusLabs\DoctrineMigrationsExtraBundle\SyliusLabsDoctrineMigrationsExtraBundle::class => ['all' => true],
   

2. Add configuration of ApiBundle in your config/packages/_sylius.yaml file:

       imports:
   +       - { resource: "@SyliusApiBundle/Resources/config/app/config.yaml" }
   

3. Add configuration of new ApiBundle in your config/packages/security.yaml file:

       parameters:
   -       sylius.security.shop_regex: "^/(?!admin|api/.*|api$|media/.*)[^/]++"
   +       sylius.security.shop_regex: "^/(?!admin|new-api|api/.*|api$|media/.*)[^/]++"
   +       sylius.security.new_api_route: "/new-api"
   +       sylius.security.new_api_regex: "^%sylius.security.new_api_route%"
   
       security:
           providers:
   +           sylius_api_admin_user_provider:
   +               id: sylius.admin_user_provider.email_or_name_based
   +           sylius_api_shop_user_provider:
   +               id: sylius.shop_user_provider.email_or_name_based
   +           sylius_api_chain_provider:
   +               chain:
   +                   providers: [sylius_api_shop_user_provider, sylius_api_admin_user_provider]
   
           firewalls:
   +           new_api_admin_user:
   +               pattern: "%sylius.security.new_api_route%/admin-user-authentication-token"
   +               provider: sylius_admin_user_provider
   +               stateless: true
   +               anonymous: true
   +               json_login:
   +                   check_path: "%sylius.security.new_api_route%/admin-user-authentication-token"
   +                   username_path: email
   +                   password_path: password
   +                   success_handler: lexik_jwt_authentication.handler.authentication_success
   +                   failure_handler: lexik_jwt_authentication.handler.authentication_failure
   +               guard:
   +                   authenticators:
   +                       - lexik_jwt_authentication.jwt_token_authenticator
   +   
   +           new_api_shop_user:
   +               pattern: "%sylius.security.new_api_route%/shop-user-authentication-token"
   +               provider: sylius_shop_user_provider
   +               stateless: true
   +               anonymous: true
   +               json_login:
   +                   check_path: "%sylius.security.new_api_route%/shop-user-authentication-token"
   +                   username_path: email
   +                   password_path: password
   +                   success_handler: lexik_jwt_authentication.handler.authentication_success
   +                   failure_handler: lexik_jwt_authentication.handler.authentication_failure
   +               guard:
   +                   authenticators:
   +                       - lexik_jwt_authentication.jwt_token_authenticator
   +   
   +           new_api:
   +               pattern: "%sylius.security.new_api_regex%/*"
   +               provider: sylius_api_chain_provider
   +               stateless: true
   +               anonymous: lazy
   +               guard:
   +                   authenticators:
   +                       - lexik_jwt_authentication.jwt_token_authenticator
   

4. Add sylius_api.yaml file to config/routes/ directory:

      sylius_api:
          resource: "@SyliusApiBundle/Resources/config/routing.yml"
          prefix: "%sylius.security.new_api_route%"
   

5. All consts classes has been changed from final classes to interfaces. As a result initialization of \Sylius\Bundle\UserBundle\UserEvents is not longer possible. The whole list of changed classes can be found here.

6. Service alias Sylius\Component\Channel\Context\ChannelContextInterface was changed from sylius.context.channel.composite to sylius.context.channel. The later is being decorated by sylius.context.channel.cached which caches the channel per request and reduces the amount of database queries.

7. A serialization group has been added to the route sylius_admin_ajax_product_index to avoid an infinite loop, or a time out during this ajax request (previously no serialization group was defined on this route).

8. We now use the parameter sylius_admin.path_name to retrieve the admin routes prefix. If you used the /admin prefix in some admin URLs you can now replace /admin by /%sylius_admin.path_prefix%.
   Also the route is now dynamic. You can change the SYLIUS_ADMIN_ROUTING_PATH_NAME environment variable to custom the admin's URL.

9. Replace the DoctrineMigrationsBundle configuration in config/packages/doctrine_migrations.yaml:

   doctrine_migrations:
   -    dir_name: "%kernel.project_dir%/src/Migrations"
   -
   -    # Namespace is arbitrary but should be different from App\Migrations as migrations classes should NOT be autoloaded
   -    namespace: DoctrineMigrations
   +    storage:
   +        table_storage:
   +            table_name: sylius_migrations
   

Special attention

Translations

Some translations have changed, you may want to search for them in your project:

• sylius.email.shipment_confirmation.tracking_code has been removed.
• sylius.email.shipment_confirmation.you_can_check_its_location has been removed.
• sylius.email.shipment_confirmation.you_can_check_its_location_with_the_tracking_code has been added instead of the two above.