feat: add reset flag general setting

Author: larskemper

src/Controller/StatusController.php

@@ -377,17 +377,24 @@ public function getResetStatus(Context $context): JsonResponse
     }
 
     #[Route(
-        path: '/api/_action/migration/messenger-stats',
-        name: 'api.admin.migration.messenger-stats',
+        path: '/api/_action/migration/is-resetting-checksums',
+        name: 'api.admin.migration.is-resetting-checksums',
         defaults: ['_acl' => ['admin']],
         methods: [Request::METHOD_GET]
     )]
-    public function getMigrationMessengerStats(Context $context): JsonResponse
+    public function isResettingChecksums(Context $context): JsonResponse
     {
-        $messages = $this->runService->getMigrationMessengerStats($context);
+        $settings = $this->generalSettingRepo
+            ->search(new Criteria(), $context)
+            ->getEntities()
+            ->first();
 
-        return new JsonResponse([
-            'messages' => $messages,
-        ]);
+        if ($settings === null) {
+            return new JsonResponse(false);
+        }
+
+        return new JsonResponse(
+            $settings->isResettingChecksums()
+        );
     }
 }

src/Core/Migration/Migration1759000000AddIsResettingChecksumsToSetting.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+/*
+ * (c) shopware AG <[email protected]>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SwagMigrationAssistant\Core\Migration;
+
+use Doctrine\DBAL\Connection;
+use Shopware\Core\Framework\Log\Package;
+use Shopware\Core\Framework\Migration\MigrationStep;
+
+#[Package('fundamentals@after-sales')]
+class Migration1759000000AddIsResettingChecksumsToSetting extends MigrationStep
+{
+    public function getCreationTimestamp(): int
+    {
+        return 1759000000;
+    }
+
+    public function update(Connection $connection): void
+    {
+        $connection->executeStatement(<<<SQL
+            ALTER TABLE `swag_migration_general_setting` ADD `is_resetting_checksums` TINYINT(1) NOT NULL DEFAULT '0';
+        SQL);
+    }
+}

src/Migration/MessageQueue/Handler/ResetChecksumHandler.php

@@ -80,6 +80,7 @@ public function __invoke(ResetChecksumMessage $message): void
         $batchSize = \count($ids);
 
         if ($batchSize === 0) {
+            $this->clearResettingChecksumsFlag();
             $this->dispatchCompletionMessage(
                 $message,
                 $progress
@@ -107,6 +108,7 @@ public function __invoke(ResetChecksumMessage $message): void
         }
 
         if ($batchSize < self::BATCH_SIZE) {
+            $this->clearResettingChecksumsFlag();
             $this->dispatchCompletionMessage(
                 $message,
                 $progress,
@@ -205,4 +207,11 @@ private function updateProgress(ResetChecksumMessage $message, int $processed, i
 
         return $progress;
     }
+
+    private function clearResettingChecksumsFlag(): void
+    {
+        $this->connection->executeStatement(
+            'UPDATE swag_migration_general_setting SET `is_resetting_checksums` = 0;'
+        );
+    }
 }

src/Migration/Run/RunService.php

@@ -179,6 +179,10 @@ public function startCleanupMappingChecksums(string $connectionId, Context $cont
             throw MigrationException::noConnectionFound();
         }
 
+        $this->dbalConnection->executeStatement(
+            'UPDATE swag_migration_general_setting SET `is_resetting_checksums` = 1;'
+        );
+
         $this->bus->dispatch(new ResetChecksumMessage(
             $connectionId,
             $context,
@@ -255,24 +259,6 @@ public function assignThemeToSalesChannel(string $runUuid, Context $context): vo
         $this->loggingService->saveLogging($context);
     }
 
-    /**
-     * @return list<mixed>
-     */
-    public function getMigrationMessengerStats(Context $context): array
-    {
-        $query = $this->dbalConnection->createQueryBuilder();
-        $query->select('JSON_EXTRACT(headers, "$.type") as message_type')
-            ->from('messenger_messages')
-            ->where($query->expr()->like('headers', ':namespace'))
-            ->andWhere($query->expr()->isNull('delivered_at'))
-            ->groupBy('message_type')
-            ->orderBy('message_type', 'ASC');
-
-        return $query->setParameter('namespace', '%SwagMigrationAssistant%')
-            ->executeQuery()
-            ->fetchFirstColumn();
-    }
-
     /**
      * @param array<int, string> $dataSelectionIds
      */

src/Migration/Run/RunServiceInterface.php

@@ -38,11 +38,6 @@ public function startCleanupMappingChecksums(string $connectionUuid, Context $co
 
     public function startCleanupMigrationData(Context $context): void;
 
-    /**
-     * @return list<mixed>
-     */
-    public function getMigrationMessengerStats(Context $context): array;
-
     /**
      * @param array<int, string> $dataSelectionIds
      */

src/Migration/Setting/GeneralSettingDefinition.php

@@ -46,6 +46,7 @@ protected function defineFields(): FieldCollection
             (new IdField('id', 'id'))->addFlags(new PrimaryKey(), new Required()),
             new FkField('selected_connection_id', 'selectedConnectionId', SwagMigrationConnectionDefinition::class),
             new BoolField('is_reset', 'isReset'),
+            new BoolField('is_resetting_checksums', 'isResettingChecksums'),
             new CreatedAtField(),
             new UpdatedAtField(),
             new ManyToOneAssociationField('selectedConnection', 'selected_connection_id', SwagMigrationConnectionDefinition::class, 'id', true),

src/Migration/Setting/GeneralSettingEntity.php

@@ -23,6 +23,8 @@ class GeneralSettingEntity extends Entity
 
     protected bool $isReset;
 
+    protected bool $isResettingChecksums = false;
+
     public function getSelectedConnectionId(): ?string
     {
         return $this->selectedConnectionId;
@@ -52,4 +54,14 @@ public function setIsReset(bool $isReset): void
     {
         $this->isReset = $isReset;
     }
+
+    public function isResettingChecksums(): bool
+    {
+        return $this->isResettingChecksums;
+    }
+
+    public function setIsResettingChecksums(bool $isResettingChecksums): void
+    {
+        $this->isResettingChecksums = $isResettingChecksums;
+    }
 }

src/Resources/app/administration/src/core/service/api/swag-migration.api.service.ts

@@ -399,18 +399,16 @@ export default class MigrationApiService extends ApiService {
         });
     }
 
-    async getMigrationMessengerStats(): Promise<{ messages: string[] }> {
+    async isResettingChecksums(): Promise<boolean> {
         // @ts-ignore
         const headers = this.getBasicHeaders();
 
         // @ts-ignore
-        return this.httpClient
-            .get(`_action/${this.getApiBasePath()}/messenger-stats`, {
-                ...this.basicConfig,
-                headers,
-            })
-            .then((response) => {
-                return ApiService.handleResponse(response);
-            });
+        return this.httpClient.get(`_action/${this.getApiBasePath()}/is-resetting-checksums`, {
+            ...this.basicConfig,
+            headers,
+        }).then((response: AxiosResponse) => {
+            return ApiService.handleResponse(response);
+        });
     }
 }

src/Resources/app/administration/src/module/swag-migration/component/card/swag-migration-shop-information/index.ts

@@ -22,8 +22,6 @@ const BADGE_TYPE = {
 
 const MIGRATION_RESET_CHECKSUM_POLLING_INTERVAL = 2500 as const;
 
-const MIGRATION_RESET_CHECKSUM_MESSAGE = 'ResetChecksumMessage' as const;
-
 /**
  * @private
  */
@@ -231,7 +229,7 @@ export default Shopware.Component.wrapComponentConfig({
 
             try {
                 const [isResetting] = await Promise.all([
-                    this.checkIsResettingChecksum(),
+                    this.migrationApiService.isResettingChecksums(),
                     this.updateLastMigrationDate(),
                 ]);
 
@@ -267,16 +265,16 @@ export default Shopware.Component.wrapComponentConfig({
             this.unregisterPolling();
 
             this.migrationStore.setIsResettingChecksum(true);
-            this.pollingIntervalId = setInterval(this.resetCheckSumRoller, MIGRATION_RESET_CHECKSUM_POLLING_INTERVAL);
+            this.pollingIntervalId = setInterval(this.resetCheckSumPoller, MIGRATION_RESET_CHECKSUM_POLLING_INTERVAL);
         },
 
-        async resetCheckSumRoller() {
+        async resetCheckSumPoller() {
             if (!this.isResettingChecksum) {
                 return;
             }
 
             try {
-                if ((await this.checkIsResettingChecksum()) === false) {
+                if ((await this.migrationApiService.isResettingChecksums()) === false) {
                     this.unregisterPolling();
                 }
             } catch {
@@ -288,18 +286,6 @@ export default Shopware.Component.wrapComponentConfig({
             }
         },
 
-        async checkIsResettingChecksum(): Promise<boolean> {
-            const response = await this.migrationApiService.getMigrationMessengerStats();
-
-            return (
-                (Array.isArray(response?.messages) &&
-                    response.messages.some((msg: string) => {
-                        return msg.toLowerCase().includes(MIGRATION_RESET_CHECKSUM_MESSAGE.toLowerCase());
-                    })) ||
-                false
-            );
-        },
-
         async updateLastMigrationDate() {
             const criteria = new Criteria(1, 1).addSorting(Criteria.sort('createdAt', 'DESC'));
 

tests/Profile/Shopware/Gateway/Local/SeoUrlReaderTest.php

@@ -110,15 +110,15 @@ private function setRouterToLowerValue(bool $value): void
         )->fetchOne();
 
         if (!\is_string($value)) {
-            $connection->executeQuery(
+            $connection->executeStatement(
                 'INSERT INTO `s_core_config_values` (`element_id`, `shop_id`, `value`) VALUES (:elementId, :shopId, :value)',
                 ['elementId' => $elementId, 'shopId' => 1, 'value' => $serializedValue]
             );
 
             return;
         }
 
-        $connection->executeQuery(
+        $connection->executeStatement(
             'UPDATE `s_core_config_values` SET `value` = :value WHERE `element_id` = :elementId AND `shop_id` = 1;',
             ['elementId' => $elementId, 'value' => $serializedValue]
         );