refactor: add migration logging optional fields

.github/workflows/integration.yaml

@@ -55,7 +55,7 @@ jobs:
             }
       - name: Import SW5 TestData DB
         working-directory: custom/plugins/${{ github.event.repository.name }}/tests
-        run: mysql -uroot < testData/sw55.sql
+        run: mysql -uroot < _fixtures/database/sw55.sql
       - name: Run PHPUnit
         working-directory: custom/plugins/${{ github.event.repository.name }}
         run: php -d pcov.enabled=1 -d pcov.directory=${PWD} -d pcov.exclude='~(vendor|tests|node_modules)~' ${GITHUB_WORKSPACE}/vendor/bin/phpunit --configuration phpunit.xml.dist
@@ -118,7 +118,7 @@ jobs:
         run: |
           composer run build:js:admin
           cd custom/plugins/${{ github.event.repository.name }}/tests
-          mysql -uroot < testData/sw55.sql
+          mysql -uroot < _fixtures/database/sw55.sql
       - name: Install playwright
         working-directory: custom/plugins/${{ github.event.repository.name }}/tests/acceptance
         run: |

.gitlab/install_test_data.php

@@ -35,12 +35,12 @@ function failAssert(bool $condition, string $message) {
 echo "SwagMigrationAssistant: found DB host: " . $host . PHP_EOL;
 echo "SwagMigrationAssistant: found DB user: " . $user . PHP_EOL;
 
-$testDataPath = $pluginPath . '/tests/testData/sw55.sql';
+$testDataPath = $pluginPath . '/tests/_fixtures/database/sw55.sql';
 echo "SwagMigrationAssistant: test data path: " . $testDataPath . PHP_EOL;
 failAssert(file_exists($testDataPath), 'test data sql file does not exists');
 
 // import test data
-// mysql -u"$user" -p"$password" --host "$host" < tests/testData/sw55.sql
+// mysql -u"$user" -p"$password" --host "$host" < tests/_fixtures/database/sw55.sql
 $cmd = sprintf('mysql -u"%s" -p"%s" --host "%s" < %s', $user, $password, $host, $testDataPath);
 $output = [];
 $resultCode = 0;

bin/install-5-test-data.sh

@@ -26,4 +26,4 @@ echo "MySQL host: $host"
 echo "MySQL user: $user"
 
 # import test data
-mysql -u"$user" -p"$password" --host "$host" < tests/testData/sw55.sql
+mysql -u"$user" -p"$password" --host "$host" < tests/_fixtures/database/sw55.sql

src/Controller/StatusController.php

@@ -347,7 +347,6 @@ public function resetChecksums(Request $request, Context $context): Response
             throw MigrationException::noConnectionFound();
         }
 
-        // ToDo: MIG-965 - Check how we could put this into the MQ
         $this->runService->cleanupMappingChecksums($connectionId, $context);
 
         return new Response();

src/Core/Migration/Migration1754897550AddRequiredFieldsToMigrationLogs.php → src/Core/Migration/Migration1754897550AddFieldsToMigrationLogs.php

@@ -15,21 +15,35 @@
 use Shopware\Core\Framework\Migration\MigrationStep;
 
 #[Package('fundamentals@after-sales')]
-class Migration1754897550AddRequiredFieldsToMigrationLogs extends MigrationStep
+class Migration1754897550AddFieldsToMigrationLogs extends MigrationStep
 {
     public const MIGRATION_LOGGING_TABLE = 'swag_migration_logging';
 
     public const REQUIRED_FIELDS = [
         'id' => 'BINARY(16) NOT NULL',
-        'run_id' => null,
-        'level' => null,
-        'code' => null,
-        'profile_name' => 'VARCHAR(255) NOT NULL',
-        'gateway_name' => 'VARCHAR(255) NOT NULL',
+        'run_id' => 'BINARY(16) NULL',
+        'profile_name' => 'VARCHAR(64) NOT NULL',
+        'gateway_name' => 'VARCHAR(64) NOT NULL',
+        'level' => 'VARCHAR(64) NOT NULL',
+        'code' => 'VARCHAR(255) NOT NULL',
         'user_fixable' => 'TINYINT(1) NOT NULL DEFAULT 0',
-        'auto_increment' => null,
-        'created_at' => null,
-        'updated_at' => null,
+    ];
+
+    public const OPTIONAL_FIELDS = [
+        'entity_name' => 'VARCHAR(64) NULL',
+        'field_name' => 'VARCHAR(64) NULL',
+        'field_source_path' => 'VARCHAR(255) NULL',
+        'source_data' => 'JSON NULL',
+        'converted_data' => 'JSON NULL',
+        'used_mapping' => 'JSON NULL',
+        'exception_message' => 'VARCHAR(255) NULL',
+        'exception_trace' => 'JSON NULL',
+    ];
+
+    public const SYSTEM_FIELDS = [
+        'auto_increment' => 'BIGINT UNSIGNED AUTO_INCREMENT UNIQUE',
+        'created_at' => 'DATETIME(3) NOT NULL',
+        'updated_at' => 'DATETIME(3) NULL',
     ];
 
     public function getCreationTimestamp(): int
@@ -53,7 +67,7 @@ public function update(Connection $connection): void
         $this->dropConstraintIfExists($connection, 'json.swag_migration_logging.log_entry');
 
         $this->dropObsoleteColumns($connection, $schemaManager);
-        $this->addOrModifyRequiredColumns($connection, $schemaManager);
+        $this->addOrModifyColumns($connection, $schemaManager);
         $this->ensureRelations($connection, $schemaManager);
     }
 
@@ -64,8 +78,14 @@ private function dropObsoleteColumns(Connection $connection, AbstractSchemaManag
     {
         $columns = $schemaManager->listTableColumns(self::MIGRATION_LOGGING_TABLE);
 
+        $allFields = array_merge(
+            self::REQUIRED_FIELDS,
+            self::OPTIONAL_FIELDS,
+            self::SYSTEM_FIELDS
+        );
+
         foreach ($columns as $column) {
-            if (!\array_key_exists($column->getName(), self::REQUIRED_FIELDS)) {
+            if (!\array_key_exists($column->getName(), $allFields)) {
                 $connection->executeStatement(
                     \sprintf(
                         'ALTER TABLE `%s` DROP COLUMN `%s`;',
@@ -80,15 +100,17 @@ private function dropObsoleteColumns(Connection $connection, AbstractSchemaManag
     /**
      * @param AbstractSchemaManager<MySQLPlatform> $schemaManager
      */
-    private function addOrModifyRequiredColumns(Connection $connection, AbstractSchemaManager $schemaManager): void
+    private function addOrModifyColumns(Connection $connection, AbstractSchemaManager $schemaManager): void
     {
         $columns = $schemaManager->listTableColumns(self::MIGRATION_LOGGING_TABLE);
 
-        foreach (self::REQUIRED_FIELDS as $name => $type) {
-            if ($type === null) {
-                continue;
-            }
+        $orderedFields = array_merge(
+            self::REQUIRED_FIELDS,
+            self::OPTIONAL_FIELDS,
+            self::SYSTEM_FIELDS
+        );
 
+        foreach ($orderedFields as $name => $type) {
             if (!isset($columns[$name])) {
                 $connection->executeStatement(
                     \sprintf(

src/DataProvider/Provider/Data/OrderProvider.php

@@ -66,7 +66,6 @@ public function getProvidedData(int $limit, int $offset, Context $context): arra
                 $row['positionPrice']
             );
 
-            // ToDo MIG-902: properly migrate this association
             if (!empty($row['lineItems'])) {
                 foreach ($row['lineItems'] as &$lineItem) {
                     unset($lineItem['promotionId']);

src/DataProvider/Provider/Data/ProductProvider.php

@@ -86,10 +86,9 @@ public function getProvidedData(int $limit, int $offset, Context $context): arra
             'thumbnails',
             'thumbnailsRo',
             'hasFile',
-            'userId', // maybe put back in, if we migrate users
-
-            'canonicalProductId', // ToDo MIG-900: properly migrate this association in a separate DataSet
-            'cmsPageId', // ToDo MIG-901: properly migrate this association in a separate DataSet
+            'userId',
+            'canonicalProductId',
+            'cmsPageId',
         ]);
 
         foreach ($cleanResult as &$product) {

src/Exception/MigrationException.php

@@ -96,6 +96,8 @@ class MigrationException extends HttpException
 
     public const API_CONNECTION_ERROR = 'SWAG_MIGRATION__API_CONNECTION_ERROR';
 
+    public const FAILED_TO_CREATE_MIGRATION_LOG = 'SWAG_MIGRATION__FAILED_TO_CREATE_MIGRATION_LOG';
+
     public static function associationEntityRequiredMissing(string $entity, string $missingEntity): self
     {
         return new AssociationEntityRequiredMissingException(
@@ -499,4 +501,14 @@ public static function invalidWriteContext(Context $invalidContext): self
             ]
         );
     }
+
+    public static function failedToCreateMigrationLog(string $logClass): self
+    {
+        return new self(
+            Response::HTTP_INTERNAL_SERVER_ERROR,
+            self::FAILED_TO_CREATE_MIGRATION_LOG,
+            'Failed to create migration log of class "{{ logClass }}".',
+            ['logClass' => $logClass]
+        );
+    }
 }