Skip to content
  • Documentation >
  • Update and migration >
  • Update from v2.5 >
  • Update to v3.3

Update the app to v3.3

Before you start this procedure, make sure you have completed the previous step, Updating code to v3.

5. Update to v3.3

Ibexa DXP v3.3 uses Symfony Flex. When updating from v3.2 to v3.3, you need to follow a special update procedure.

Note

Ibexa DXP v3.3 requires Composer 2.0.13 or higher.

First, create an update branch update-3.3 in git and commit your work.

If you have not done it before, add the relevant meta-repository as an upstream remote:

1
git remote add upstream http://github.com/ezsystems/ezplatform.git

1
git remote add upstream http://github.com/ezsystems/ezplatform-ee.git

1
git remote add upstream http://github.com/ezsystems/ezcommerce.git

Tip

It is good practice to make git commits after every step of the update procedure.

A. Merge project skeleton

Merge the current skeleton into your project:

1
2
3
git remote add content-skeleton https://github.com/ibexa/content-skeleton.git
git fetch content-skeleton --tags
git merge v3.3.43 --allow-unrelated-histories

1
2
3
git remote add experience-skeleton https://github.com/ibexa/experience-skeleton.git
git fetch experience-skeleton --tags
git merge v3.3.43 --allow-unrelated-histories

1
2
3
git remote add commerce-skeleton https://github.com/ibexa/commerce-skeleton.git
git fetch commerce-skeleton --tags
git merge v3.3.43 --allow-unrelated-histories

This introduces changes from the relevant website skeleton and results in conflicts.

Resolve the conflicts in the following way:

  • Make sure all automatically added ezsystems/* packages are removed. If you explicitly added any packages that are not part of the standard installation, retain them.
  • Review the rest of the packages. If your project requires a package, keep it.
  • If a package is only used as a dependency of an ezsystems package, remove it. You can check how the package is used with composer why <packageName>.
  • Keep the dependencies listed in the website skeleton.

Tip

You can also approach resolving conflicts differently: run git checkout --theirs composer.json to get a clean composer.json from the skeleton and then manually add any necessary changes from your project.

Caution

It is impossible to update an Enterprise edition (ezsystems/ezplatform-ee) to an Ibexa Content edition.

Also, make sure that composer.json has the following repositories entry:

1
2
3
4
"ibexa": {
    "type": "composer",
    "url": "https://updates.ibexa.co"
}

B. Update the app

Update Symfony Flex, then update the dependencies:

1
2
composer update symfony/flex --no-plugins --no-scripts
composer update

Caution

Composer repository changes between 3.2 and 3.3 from updates.ez.no to updates.ibexa.co, therefore your credentials might be outdated.

username and password don't change. The repository they're used on changes.

See Composer authentication documentation to find the precedure that suits the way you're passing credentials.

In production, replace the old repository with the new one. But as a developer, you may need to go back to an earlier version, and should keep the old repository as well. For example, your auth.json may look like this:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "http-basic": {
        "updates.ibexa.co": {
            "username": "abcdefghijklmnopqrstuvwxyz012345",
            "password": "6789abcdefghijklmnopqrstuvwxyz01"
        },
        "updates.ez.no": {
            "username": "abcdefghijklmnopqrstuvwxyz012345",
            "password": "6789abcdefghijklmnopqrstuvwxyz01"
        }
    }
}

C. Configure the web server

Add the following rewrite rule to your web server configuration:

1
RewriteRule ^/build/ - [L]

1
rewrite "^/build/(.*)" "/build/$1" break;

6. Update the database

Apply the following database update script:

Ibexa DXP

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ezplatform-2.5-to-ibexa-3.3.0.sql

1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ezplatform-2.5-to-ibexa-3.3.0.sql

If you are updating from an installation based on the ezsystems/ezplatform-ee metarepository, run the following command to upgrade your database:

1
php bin/console ibexa:upgrade

Caution

You can only run this command once.

Check the Location ID of the "Components" Content item and set it as a value of the content_tree_module.contextual_tree_root_location_ids key in config/ezplatform.yaml:

1
- 60 # Components

If you are upgrading between Ibexa Commerce versions, add the content/read Policy with the Owner Limitation set to self to the "Ecommerce registered users" Role.

Ibexa Open Source

If you are upgrading to Ibexa Open Source v3.3 and have no access to ibexa/installer package, run the following SQL commands:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
START TRANSACTION;
DELETE FROM `ezsite_data` WHERE `name` IN ('ezpublish-version', 'ezpublish-release', 'ezplatform-release');
INSERT INTO ezsite_data (`name`, `value`) VALUES ('ibexa-release', '3.3');
COMMIT;

ALTER TABLE `ezcontentclass_attribute` MODIFY `data_text1` VARCHAR(255);
ALTER TABLE `ezcontentclass_attribute` ADD COLUMN `is_thumbnail` BOOLEAN NOT NULL DEFAULT false;

ALTER TABLE `ezkeyword_attribute_link`
    ADD COLUMN `version` INT(11) DEFAULT '0',
    ADD KEY `ezkeyword_attr_link_oaid_ver` (`objectattribute_id`, `version`);
UPDATE `ezkeyword_attribute_link`
    SET `version` = COALESCE(
    (
        SELECT `current_version`
        FROM `ezcontentobject_attribute` AS `a`
        JOIN `ezcontentobject` AS `c`
            ON `a`.`contentobject_id` = `c`.`id` AND `a`.`version` = `c`.`current_version`
        WHERE `a`.`id` = `ezkeyword_attribute_link`.`objectattribute_id`
    ), 0);
ALTER TABLE `ezkeyword_attribute_link` MODIFY `version` INT(11) NOT NULL DEFAULT '0';

UPDATE `ezcontentclass_attribute`
    SET `data_text2` = '^[^@]+$'
WHERE `data_type_string` = 'ezuser' AND `data_text2` IS NULL;

UPDATE `ezuser`
    SET `email` =
        CASE
            WHEN `contentobject_id` = 10 THEN '[email protected]'
            WHEN `contentobject_id` = 14 THEN '[email protected]'
        END
    WHERE `contentobject_id` IN (10, 14) AND `email` IN ('[email protected]', '[email protected]');

DROP TABLE IF EXISTS `ibexa_setting`;
CREATE TABLE `ibexa_setting` (
    `id`            int(11)                                     NOT NULL AUTO_INCREMENT,
    `group`         varchar(128) COLLATE utf8mb4_unicode_520_ci NOT NULL,
    `identifier`    varchar(128) COLLATE utf8mb4_unicode_520_ci NOT NULL,
    `value`         text COLLATE utf8mb4_unicode_520_ci         NOT NULL,
    PRIMARY KEY (`id`),
    UNIQUE KEY `ibexa_setting_group_identifier` (`group`, `identifier`)
) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_520_ci;

UPDATE ezcontentobject_attribute
    SET data_text=NULL
WHERE data_type_string='ezimageasset'
    AND data_text IN ('null', '{"destinationContentId":null,"alternativeText":"null"}');

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
START TRANSACTION;
DELETE FROM "ezsite_data" WHERE "name" IN ('ezpublish-version', 'ezpublish-release', 'ezplatform-release');
INSERT INTO "ezsite_data" ("name", "value") VALUES ('ibexa-release', '3.3');
COMMIT;

ALTER TABLE "ezcontentclass_attribute" ALTER COLUMN "data_text1" TYPE varchar(255);
ALTER TABLE "ezcontentclass_attribute" ADD "is_thumbnail" boolean DEFAULT false NOT NULL;

ALTER TABLE "ezkeyword_attribute_link" ADD COLUMN "version" INT;
UPDATE "ezkeyword_attribute_link"
    SET "version" = COALESCE(
    (
        SELECT "current_version"
        FROM "ezcontentobject_attribute" AS a
        JOIN "ezcontentobject" AS c
            ON a.contentobject_id = c.id AND a.version = c.current_version
        WHERE a.id = ezkeyword_attribute_link.objectattribute_id
    ), 0);
ALTER TABLE "ezkeyword_attribute_link" ALTER COLUMN "version" SET NOT NULL;
CREATE INDEX "ezkeyword_attr_link_oaid_ver" ON "ezkeyword_attribute_link" ("objectattribute_id", "version");

UPDATE "ezcontentclass_attribute"
    SET "data_text2" = '^[^@]+$'
WHERE "data_type_string" = 'ezuser' AND "data_text2" IS NULL;

UPDATE "ezuser"
    SET "email" =
        CASE
            WHEN "contentobject_id" = 10 THEN '[email protected]'
            WHEN "contentobject_id" = 14 THEN '[email protected]'
        END
WHERE "contentobject_id" IN (10, 14) AND "email" IN ('[email protected]', '[email protected]');

DROP TABLE IF EXISTS "ibexa_setting";
CREATE TABLE "ibexa_setting" (
    "id" SERIAL NOT NULL,
    "group" varchar(128) NOT NULL,
    "identifier" varchar(128) NOT NULL,
    "value" json NOT NULL,
    PRIMARY KEY ("id"),
    CONSTRAINT "ibexa_setting_group_identifier" UNIQUE ("group", identifier)
);

UPDATE ezcontentobject_attribute
    SET data_text=NULL
WHERE data_type_string='ezimageasset'
    AND data_text IN ('null', '{"destinationContentId":null,"alternativeText":"null"}');

7. Update to the latest patch version

Now, proceed to the last step, updating to the latest v3.3 patch version.