Upgrade to Symfony 5

Last updated:
Edit on GitHub

Spryker supports Symfony 5 that was released in November 2019. We tried to keep BC for all three major versions of Symfony, but due to some changes in version 5, we had to partially drop support for Symfony 3.

Avoid old Symfony versions

Although Spryker still supports older versions of Symfony, avoid installing them. Installing older versions of Symfony may cause conflicts with other packages that may have different requirements. Always try to keep your dependencies updated.

Main changes in Symfony 5

Most of the changes in Symfony 5 are related to changes in symfony/http-kernel and the symfony/translation components. In version 4 of the symfony/http-kernel component, new event classes were introduced, some were deprecated, and the event classes are final in version 5. Thus, we had to use the new final event classes and refactor some modules that use the old event classes.

In version 5 of the symfony/translation component, some interfaces were extracted into the symfony/translation-contracts component. Due to this, we had to refactor some modules that used those interfaces.

Upgrade Symfony to version 5

To make your project compatible with Symfony 5, update the Symfony module and all modules that use it:

composer require spryker/symfony:"^3.5.0"

If you can’t install the required version, run the following command to see what else you need to update:

composer why-not spryker/symfony:3.5.0

This gives you a list of modules that require the latest spryker/symfony module and that need to be updated as well.

Automated migration of your project code

Make sure to check if you need to update your project code to make it compatible with the changes in Symfony 5.

Before you manually start to migrate your project code, consider using Rector. Rector is a tool that does instant upgrades and instant refactoring of your code. To install Rector, follow the installation instructions.

Once Rector is installed, run it on your codebase using the following command:

vendor/bin/rector process path/to/files -c path/to/configuration

We have refactored our code with two configurations. The first one uses some default sets provided by Rector:

<?php

/**
 * Copyright © 2020-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

declare(strict_types = 1);

use Rector\Core\Configuration\Option;
use Rector\Set\ValueObject\SetList;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $containerConfigurator): void {
    $parameters = $containerConfigurator->parameters();
    $parameters->set(Option::SETS, [
        SetList::SYMFONY_34,
        SetList::SYMFONY_40,
        SetList::SYMFONY_41,
        SetList::SYMFONY_42,
        SetList::SYMFONY_43,
        SetList::SYMFONY_44,
        SetList::SYMFONY_50,
        SetList::SYMFONY_50_TYPES,
    ]);

    $parameters->set(Option::AUTO_IMPORT_NAMES, true);
};

The second configuration we have added:

<?php

/**
 * Copyright © 2020-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

declare(strict_types = 1);

use Rector\Core\Configuration\Option;
use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
use Rector\Renaming\Rector\Name\RenameClassRector;
use Rector\Renaming\ValueObject\MethodCallRename;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use function Rector\SymfonyPhpConfig\inline_value_objects;

return static function (ContainerConfigurator $containerConfigurator): void {
    $services = $containerConfigurator->services();

    $services->set(RenameClassRector::class)
        ->call('configure', [[
            RenameClassRector::OLD_TO_NEW_CLASSES => [
                'Symfony\Component\Translation\TranslatorInterface' => 'Symfony\Contracts\Translation\TranslatorInterface',
                'Symfony\Component\Debug\Exception\FlattenException' => 'Symfony\Component\ErrorHandler\Exception\FlattenException',
                'Symfony\Component\Validator\ValidatorBuilderInterface' => 'Symfony\Component\Validator\ValidatorBuilder',
            ],
        ]]);

    $services->set(RenameMethodRector::class)
        ->call('configure', [[
            RenameMethodRector::METHOD_CALL_RENAMES => inline_value_objects([
                new MethodCallRename('Symfony\Component\HttpKernel\Event\ExceptionEvent', 'getException', 'getThrowable'),
            ]),
        ]]);
};