Skip to content

Update from v4.2.x to v4.3

This update procedure applies if you are using a v4.2 installation.

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.2.x to v4.2.latest

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

Update the application

Run:

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

Update from v4.2.latest to v4.3

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

Update the application

First, run:

1
2
composer require ibexa/content:4.3.5 --with-all-dependencies --no-scripts
composer recipes:install ibexa/content --force -v
1
2
composer require ibexa/experience:4.3.5 --with-all-dependencies --no-scripts
composer recipes:install ibexa/experience --force -v
1
2
composer require ibexa/commerce:4.3.5 --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.

Run data migration

Customer Portal self-registration

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

1
php bin/console ibexa:migrations:import vendor/ibexa/corporate-account/src/bundle/Resources/migrations/corporate_account_registration.yaml --name=012_corporate_account_registration.yaml

Migration to customer content type

This step is required if you have users in your installation that need to be transferred to a new User content type: customer. This content type is dedicated to registered frontend customers. This migration is intended for all product versions. If there are no users that are customers in your platform, you can skip this step and move on to executing migrations.

Basic migration

Use this option to define a user group that should be migrated to a new content type.

1
php bin/console ibexa:migrate:customers  --input-user-group=3a3beb3d09ae0dacebf1d324f61bbc34 --create-content-type
  • --input-user-group - represents the remote ID of a User Group you want to migrate to a new content type. After migration, this will also be the ID of a new Private Customer User Group.
  • --create-content-type - if you add this parameter, the system creates the new content type based on the one defined in --input-user-content-type
Additional parameters

Use the parameters below if you need to change a content type name during migration, for example because you already have a customer content type, or you want to define different source content type. If you don't have custom User content types, use the basic migration.

  • --input-user-content-type - defines input content type
  • --output-user-content-type - defines output content type
  • --user - defines the user that this command should be executed as, default is Admin
  • --batch-limit - defines data limit for migration of one batch, default value is 25

Caution

This improvement will prevent logged in backend users from making purchases in the frontend store.

Execute migrations

Run php bin/console ibexa:migrations:migrate -v --dry-run to ensure that all migrations are ready to be performed. If the dry run is successful, run the following command to execute the above migrations:

1
php bin/console ibexa:migrations:migrate

Update the database

Next, update the database.

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/ibexa-4.2.latest-to-4.3.0.sql
1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.2.latest-to-4.3.0.sql

Ibexa Open Source

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

Clean-up taxonomy database

Run the following command for each of your taxonomies to ensure that there are no content items orphaned during deletion of subtrees:

php bin/console ibexa:taxonomy:remove-orphaned-content <taxonomy> --force

For example:

1
2
php bin/console ibexa:taxonomy:remove-orphaned-content tags --force
php bin/console ibexa:taxonomy:remove-orphaned-content product_categories --force

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 update

Finish the update process:

1
composer run post-install-cmd