Skip to content

Update with old Commerce packages

This update procedure applies if you have a v4.3 installation, you use Commerce packages and would like to continue to use them.

Note that all commerce packages as of v4.4 are deprecated and will be removed in v5. Until that time, they will be maintained by Ibexa with fixes, including security fixes, but they won't be further developed. Old packages are replaced by the all-new Ibexa Commerce packages.

Temporary need of Composer conflict

To go through this update, map the conflicting packages in your composer.json file as following:

1
2
3
4
"conflict": {
    "jms/serializer": ">=3.30.0",
    "gedmo/doctrine-extensions": ">=3.12.0"
},
These entries can be removed after fully upgrading to v4.6 LTS.

Update from v4.3.x to v4.3.latest

Before you update to v4.4, you need to go through the following steps to update to the latest maintenance release of v4.3 (v4.3.5).

Update the application to v4.3.latest

Run:

1
composer require ibexa/content:4.3.5 --with-all-dependencies --no-scripts
1
composer require ibexa/experience:4.3.5 --with-all-dependencies --no-scripts
1
composer require ibexa/commerce:4.3.5 --with-all-dependencies --no-scripts

Update from v4.3.latest to v4.4

When you have the latest version of v4.3, you can update to v4.4.

Update the application to v4.4

First, run:

1
2
composer require ibexa/content:4.4.4 --with-all-dependencies --no-scripts
composer recipes:install ibexa/content --force -v
1
2
composer require ibexa/experience:4.4.4 --with-all-dependencies --no-scripts
composer recipes:install ibexa/experience --force -v
1
2
composer require ibexa/commerce:4.4.4 --with-all-dependencies --no-scripts
composer recipes:install ibexa/commerce --force -v

The recipes:install command installs new YAML configuration files. Review the old YAML files and move your custom configuration to the relevant new files.

Flysystem v2

Local adapters' directory key changed to location. It is defined in config/packages/oneup_flysystem.yaml:

1
2
3
4
5
oneup_flysystem:
    adapters:
        default_adapter:
            local:
                location: '%kernel.cache_dir%/flysystem'

If you haven't applied custom changes to that file, you can reset third-party oneup/flysystem-bundle recipe by executing:

1
composer recipe:install --force --reset -- oneup/flysystem-bundle

Add ibexa/commerce-* packages dependencies

Add the following dependencies in the require section in composer.json:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
"require":{
    "ibexa/commerce-base-design": "4.4.0",
    "ibexa/commerce-checkout": "4.4.0",
    "ibexa/commerce-fieldtypes": "4.4.0",
    "ibexa/commerce-price-engine": "4.4.0",
    "ibexa/commerce-shop": "4.4.0",
    "ibexa/commerce-shop-ui": "4.4.0",
    "ezsystems/apache-tika-bundle": "^2.0",
    "ezsystems/comment-bundle": "^3.1",
    "ezsystems/job-queue-bundle": "^4.0",
    "ezsystems/payment-core-bundle": "^3.0",
    "ezsystems/stash-bundle": "^0.9",
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
"require":{
    "ibexa/commerce-base-design": "4.4.0",
    "ibexa/commerce-checkout": "4.4.0",
    "ibexa/commerce-fieldtypes": "4.4.0",
    "ibexa/commerce-price-engine": "4.4.0",
    "ibexa/commerce-shop": "4.4.0",
    "ibexa/commerce-shop-ui": "4.4.0",
    "ezsystems/apache-tika-bundle": "^2.0",
    "ezsystems/comment-bundle": "^3.1",
    "ezsystems/job-queue-bundle": "^4.0",
    "ezsystems/payment-core-bundle": "^3.0",
    "ezsystems/stash-bundle": "^0.9",
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
"require":{
    "ibexa/commerce-base-design": "4.4.0",
    "ibexa/commerce-checkout": "4.4.0",
    "ibexa/commerce-fieldtypes": "4.4.0",
    "ibexa/commerce-price-engine": "4.4.0",
    "ibexa/commerce-shop": "4.4.0",
    "ibexa/commerce-shop-ui": "4.4.0",
    "ezsystems/apache-tika-bundle": "^2.0",
    "ezsystems/comment-bundle": "^3.1",
    "ezsystems/job-queue-bundle": "^4.0",
    "ezsystems/payment-core-bundle": "^3.0",
    "ezsystems/stash-bundle": "^0.9",
    "ibexa/commerce-admin-ui": "4.4.0",
    "ibexa/commerce-erp-admin": "4.4.0",
    "ibexa/commerce-order-history": "4.4.0",
    "ibexa/commerce-page-builder": "4.4.0",
    "ibexa/commerce-rest": "4.4.0",
    "ibexa/commerce-transaction": "4.4.0"
}

Next, remove the entries with new packages alongside with routing and configuration in config/routes/ibexa_cart.yaml, config/routes/ibexa_checkout.yaml and config/routes/ibexa_storefront.yaml:

1
2
3
    Ibexa\Bundle\Cart\IbexaCartBundle::class => ['all' => true],
    Ibexa\Bundle\Checkout\IbexaCheckoutBundle::class => ['all' => true],
    Ibexa\Bundle\Storefront\IbexaStorefrontBundle::class => ['all' => true],

Finally, remove the new storefront_group SiteAccess from config/packages/ibexa.yaml:

1
2
3
4
5
ibexa:
    siteaccess:
        groups:
            site_group: [import, site]
            storefront_group: [site]

Update the database

Next, update the database if you are using Ibexa Commerce. Ibexa Content and Ibexa Experience do not require the database update.

Caution

Always back up your data before running any database update scripts.

After updating the database, clear the cache.

Do not use --force argument for mysql / psql commands when performing update queries. If there is any problem during the update, it is best if the query fails immediately, so you can fix the underlying problem before you execute the update again. If you leave this for later you risk ending up with an incompatible database, though the problems might not surface immediately.

Apply the following database update scripts:

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/commerce/ibexa-4.3.latest-to-4.4.0.sql
1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/commerce/ibexa-4.3.latest-to-4.4.0.sql

Ibexa Open Source

If you have no access to Ibexa DXP's ibexa/installer package, database upgrade is not necessary.

Ensure password safety

Following Security advisory: IBEXA-SA-2022-009, unless you can verify based on your log files that the vulnerability has not been exploited, you should revoke passwords for all affected users.

Finish code update

Finish the code update by running:

1
composer run post-install-cmd

Run data migration

Customer Portal self-registration

If you are using Ibexa Experience or Ibexa Commerce, run data migration required by the Customer Portal applications feature:

1
2
php bin/console ibexa:migrations:import vendor/ibexa/corporate-account/src/bundle/Resources/migrations/application_internal_fields.yaml --name=2022_11_07_22_46_application_internal_fields.yaml
php bin/console ibexa:migrations:migrate --file=2022_11_07_22_46_application_internal_fields.yaml