IBX-11939: Added Doctrine Migrations baseline for ibexa/messenger

composer.json

@@ -16,7 +16,8 @@
         "symfony/http-foundation": "^7.4",
         "symfony/http-kernel": "^7.4",
         "symfony/messenger": "^7.4",
-        "symfony/yaml": "^7.4"
+        "symfony/yaml": "^7.4",
+        "ibexa/doctrine-migrations": "dev-feat/doctrine-migrations-5.0"
     },
     "require-dev": {
         "dama/doctrine-test-bundle": "^8",

src/bundle/Migration/FixMessengerMessagesIndexesMigration.php

@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Messenger\Migration;
+
+use DateTimeImmutable;
+use Doctrine\DBAL\Schema\Schema;
+use Ibexa\Contracts\DoctrineMigrations\Migrations\AbstractSqlMigration;
+use Ibexa\Contracts\DoctrineMigrations\Migrations\IbexaMigrationInterface;
+use Ibexa\DoctrineMigrations\Migration\SqlPlatform;
+use Symfony\Component\Messenger\Bridge\Doctrine\Transport\Connection;
+
+/**
+ * Replaces the 3 separate, explicitly-named single-column indexes the original schema.yaml (and
+ * {@see InstallSchemaMigration}) mistakenly created on `ibexa_messenger_messages`
+ * (`ibexa_messenger_created_at_idx`/`available_at_idx`/`delivered_at_idx`) with the single
+ * composite index this table's actual owner, symfony/doctrine-messenger's own
+ * {@see Connection}, has always created:
+ * one index over `(queue_name, available_at, delivered_at, id)`.
+ *
+ * Needed for any install that already ran the old {@see InstallSchemaMigration} (which is
+ * guarded against re-running once the table exists) or the old, incorrect schema.yaml via the
+ * legacy SchemaBuilderEvent install path, before both were corrected.
+ */
+final class FixMessengerMessagesIndexesMigration extends AbstractSqlMigration implements IbexaMigrationInterface
+{
+    public function getDescription(): string
+    {
+        return 'Replaces the 3 incorrect per-column indexes on ibexa_messenger_messages with the single composite index Symfony\'s own Doctrine Messenger transport actually uses';
+    }
+
+    public static function getTargetVersion(): string
+    {
+        return '5.0.0';
+    }
+
+    public static function getCreationDate(): DateTimeImmutable
+    {
+        return new DateTimeImmutable('2026-07-27 00:00:00');
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->abortIfUnsupportedPlatform(SqlPlatform::MYSQL, SqlPlatform::POSTGRESQL, SqlPlatform::SQLITE);
+
+        if ($schema->getTable('ibexa_messenger_messages')->hasIndex('ibexa_messenger_messages_queue_available_delivered_idx')) {
+            return;
+        }
+
+        if ($this->isMySQL()) {
+            $this->addSqlFile(__DIR__ . '/sql/fix-messenger-messages-indexes-mysql.sql');
+        } elseif ($this->isPostgreSQL()) {
+            $this->addSqlFile(__DIR__ . '/sql/fix-messenger-messages-indexes-postgresql.sql');
+        } elseif ($this->isSqlite()) {
+            $this->addSqlFile(__DIR__ . '/sql/fix-messenger-messages-indexes-sqlite.sql');
+        }
+    }
+}

src/bundle/Migration/InstallSchemaMigration.php

@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Messenger\Migration;
+
+use DateTimeImmutable;
+use Doctrine\DBAL\Schema\Schema;
+use Ibexa\Contracts\DoctrineMigrations\Migrations\AbstractSqlMigration;
+use Ibexa\Contracts\DoctrineMigrations\Migrations\IbexaMigrationInterface;
+use Ibexa\DoctrineMigrations\Migration\SqlPlatform;
+
+final class InstallSchemaMigration extends AbstractSqlMigration implements IbexaMigrationInterface
+{
+    public function getDescription(): string
+    {
+        return 'Creates the ibexa/messenger database schema';
+    }
+
+    public static function getTargetVersion(): string
+    {
+        return '5.0.0';
+    }
+
+    public static function getCreationDate(): DateTimeImmutable
+    {
+        return new DateTimeImmutable('2026-07-20 00:00:00');
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->abortIfUnsupportedPlatform(SqlPlatform::MYSQL, SqlPlatform::POSTGRESQL, SqlPlatform::SQLITE);
+
+        if ($schema->hasTable('ibexa_messenger_messages')
+            && $schema->hasTable('ibexa_messenger_lock_keys')) {
+            return;
+        }
+
+        if ($this->isMySQL()) {
+            $this->addSqlFile(__DIR__ . '/sql/install-schema-mysql.sql');
+        } elseif ($this->isPostgreSQL()) {
+            $this->addSqlFile(__DIR__ . '/sql/install-schema-postgresql.sql');
+        } elseif ($this->isSqlite()) {
+            $this->addSqlFile(__DIR__ . '/sql/install-schema-sqlite.sql');
+        }
+    }
+}

src/bundle/Migration/sql/fix-messenger-messages-indexes-mysql.sql

@@ -0,0 +1,7 @@
+DROP INDEX ibexa_messenger_created_at_idx ON ibexa_messenger_messages;
+-- ibexa:sql-statement-separator
+DROP INDEX ibexa_messenger_available_at_idx ON ibexa_messenger_messages;
+-- ibexa:sql-statement-separator
+DROP INDEX ibexa_messenger_delivered_at_idx ON ibexa_messenger_messages;
+-- ibexa:sql-statement-separator
+CREATE INDEX ibexa_messenger_messages_queue_available_delivered_idx ON ibexa_messenger_messages (queue_name, available_at, delivered_at, id);

src/bundle/Migration/sql/fix-messenger-messages-indexes-postgresql.sql

@@ -0,0 +1,7 @@
+DROP INDEX ibexa_messenger_created_at_idx;
+-- ibexa:sql-statement-separator
+DROP INDEX ibexa_messenger_available_at_idx;
+-- ibexa:sql-statement-separator
+DROP INDEX ibexa_messenger_delivered_at_idx;
+-- ibexa:sql-statement-separator
+CREATE INDEX ibexa_messenger_messages_queue_available_delivered_idx ON ibexa_messenger_messages (queue_name, available_at, delivered_at, id);

src/bundle/Migration/sql/fix-messenger-messages-indexes-sqlite.sql

@@ -0,0 +1,7 @@
+DROP INDEX ibexa_messenger_created_at_idx;
+-- ibexa:sql-statement-separator
+DROP INDEX ibexa_messenger_available_at_idx;
+-- ibexa:sql-statement-separator
+DROP INDEX ibexa_messenger_delivered_at_idx;
+-- ibexa:sql-statement-separator
+CREATE INDEX ibexa_messenger_messages_queue_available_delivered_idx ON ibexa_messenger_messages (queue_name, available_at, delivered_at, id);

src/bundle/Migration/sql/install-schema-mysql.sql

@@ -0,0 +1,3 @@
+CREATE TABLE ibexa_messenger_messages (id BIGINT AUTO_INCREMENT NOT NULL, body LONGTEXT NOT NULL, headers LONGTEXT NOT NULL, queue_name VARCHAR(190) NOT NULL, created_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)', available_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)', delivered_at DATETIME DEFAULT NULL COMMENT '(DC2Type:datetime_immutable)', INDEX ibexa_messenger_messages_queue_available_delivered_idx (queue_name, available_at, delivered_at, id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+-- ibexa:sql-statement-separator
+CREATE TABLE ibexa_messenger_lock_keys (key_id VARCHAR(64) NOT NULL, key_token VARCHAR(44) NOT NULL, key_expiration INT UNSIGNED NOT NULL, PRIMARY KEY(key_id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;

src/bundle/Migration/sql/install-schema-postgresql.sql

@@ -0,0 +1,11 @@
+CREATE TABLE ibexa_messenger_messages (id BIGSERIAL NOT NULL, body TEXT NOT NULL, headers TEXT NOT NULL, queue_name VARCHAR(190) NOT NULL, created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, available_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, delivered_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL, PRIMARY KEY(id));
+-- ibexa:sql-statement-separator
+CREATE INDEX ibexa_messenger_messages_queue_available_delivered_idx ON ibexa_messenger_messages (queue_name, available_at, delivered_at, id);
+-- ibexa:sql-statement-separator
+COMMENT ON COLUMN ibexa_messenger_messages.created_at IS '(DC2Type:datetime_immutable)';
+-- ibexa:sql-statement-separator
+COMMENT ON COLUMN ibexa_messenger_messages.available_at IS '(DC2Type:datetime_immutable)';
+-- ibexa:sql-statement-separator
+COMMENT ON COLUMN ibexa_messenger_messages.delivered_at IS '(DC2Type:datetime_immutable)';
+-- ibexa:sql-statement-separator
+CREATE TABLE ibexa_messenger_lock_keys (key_id VARCHAR(64) NOT NULL, key_token VARCHAR(44) NOT NULL, key_expiration INT NOT NULL, PRIMARY KEY(key_id));

src/bundle/Migration/sql/install-schema-sqlite.sql

@@ -0,0 +1,8 @@
+CREATE TABLE ibexa_messenger_messages (id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, body CLOB NOT NULL, headers CLOB NOT NULL, queue_name VARCHAR(190) NOT NULL, created_at DATETIME NOT NULL --(DC2Type:datetime_immutable)
+, available_at DATETIME NOT NULL --(DC2Type:datetime_immutable)
+, delivered_at DATETIME DEFAULT NULL --(DC2Type:datetime_immutable)
+);
+-- ibexa:sql-statement-separator
+CREATE INDEX ibexa_messenger_messages_queue_available_delivered_idx ON ibexa_messenger_messages (queue_name, available_at, delivered_at, id);
+-- ibexa:sql-statement-separator
+CREATE TABLE ibexa_messenger_lock_keys (key_id VARCHAR(64) NOT NULL, key_token VARCHAR(44) NOT NULL, key_expiration INTEGER UNSIGNED NOT NULL, PRIMARY KEY(key_id));

src/bundle/Resources/config/schema.yaml

@@ -1,5 +1,7 @@
 tables:
     ibexa_messenger_messages:
+        indexes:
+            ibexa_messenger_messages_queue_available_delivered_idx: { fields: [ queue_name, available_at, delivered_at, id ] }
         id:
             id:
                 type: bigint
@@ -20,18 +22,12 @@ tables:
             created_at:
                 type: datetime_immutable
                 nullable: false
-                index:
-                    name: ibexa_messenger_created_at_idx
             available_at:
                 type: datetime_immutable
                 nullable: false
-                index:
-                    name: ibexa_messenger_available_at_idx
             delivered_at:
                 type: datetime_immutable
                 nullable: true
-                index:
-                    name: ibexa_messenger_delivered_at_idx
 
     ibexa_messenger_lock_keys:
         id:

src/bundle/Resources/config/services/doctrine_migrations.yaml

@@ -0,0 +1,17 @@
+services:
+    Ibexa\Bundle\Messenger\Migration\InstallSchemaMigration:
+        autowire: true
+        public: false
+        arguments:
+            $connection: '@ibexa.persistence.connection'
+        tags:
+            - { name: !php/const Ibexa\Contracts\DoctrineMigrations\Migrations\IbexaMigrationTag::TAG }
+
+    Ibexa\Bundle\Messenger\Migration\FixMessengerMessagesIndexesMigration:
+        autowire: true
+        autoconfigure: false
+        public: false
+        arguments:
+            $connection: '@ibexa.persistence.connection'
+        tags:
+            - { name: !php/const Ibexa\Contracts\DoctrineMigrations\Migrations\IbexaMigrationTag::TAG }