Configuration to enable/disable automatic sync jobs

ENG-14343

Author: hadomskyi

.github/workflows/craft-versions.yml

@@ -116,6 +116,28 @@ jobs:
           "3.8.5",
           "3.8.6",
           "3.8.7",
+          "3.8.8",
+          "3.8.9",
+          "3.8.10",
+          "3.8.10.1",
+          "3.8.10.2",
+          "3.8.11",
+          "3.8.12",
+          "3.8.13",
+          "3.8.14",
+          "3.8.15",
+          "3.8.16",
+          "3.8.17",
+          "3.9.0",
+          "3.9.1",
+          "3.9.2",
+          "3.9.3",
+          "3.9.4",
+          "3.9.5",
+          "3.9.6",
+          "3.9.10",
+          "3.9.11",
+          "3.9.12",
         ]
     runs-on: ubuntu-latest
     steps:

.github/workflows/e2e.yml

@@ -40,12 +40,18 @@ jobs:
         run: |
           echo "CYPRESS_SCENARIO=${{ matrix.scenario }}" >> $GITHUB_ENV
           echo "DB_DATABASE=$(uuidgen)" >> $GITHUB_ENV
-      - name: Run automation
+      - name: Prepare automation
         working-directory: ./e2e
         run: |
           echo ${DB_DATABASE}
           make up
-          make e2e-github
+      - name: Run automation with retry
+        uses: nick-invision/retry@v2
+        working-directory: ./e2e
+        with:
+          timeout_minutes: 60
+          max_attempts: 3
+          command: make e2e-github
       - name: Copy artifacts
         if: ${{ failure() }}
         working-directory: ./e2e

src/controllers/PostConfigurationController.php

@@ -98,6 +98,7 @@ public function actionInvoke(): Response
             $request->getBodyParam('copyEntriesSlugFromSourceToTarget') ?? '0'
         );
 
+        // queueEachTranslationFileSeparately
         $queueEachTranslationFileSeparately = $request->getBodyParam('queueEachTranslationFileSeparately');
         if (empty($queueEachTranslationFileSeparately)) {
             $queueEachTranslationFileSeparately = 0;
@@ -108,6 +109,17 @@ public function actionInvoke(): Response
             (string)$queueEachTranslationFileSeparately
         );
 
+        // queueDisableAutomaticSync
+        $queueDisableAutomaticSync = $request->getBodyParam('queueDisableAutomaticSync');
+        if (empty($queueDisableAutomaticSync)) {
+            $queueDisableAutomaticSync = 0;
+        }
+
+        Craftliltplugin::getInstance()->settingsRepository->save(
+            SettingsRepository::QUEUE_DISABLE_AUTOMATIC_SYNC,
+            (string)$queueDisableAutomaticSync
+        );
+
         $settingsRequest = new SettingsRequest();
         $settingsRequest->setProjectPrefix(
             $request->getBodyParam('projectPrefix')

src/modules/FetchJobStatusFromConnector.php

@@ -19,6 +19,7 @@
 use lilthq\craftliltplugin\elements\Job;
 use lilthq\craftliltplugin\records\JobRecord;
 use lilthq\craftliltplugin\records\TranslationRecord;
+use lilthq\craftliltplugin\services\repositories\SettingsRepository;
 
 class FetchJobStatusFromConnector extends AbstractRetryJob
 {
@@ -107,18 +108,24 @@ public function execute($queue): void
         }
 
         if (!$isJobFinished) {
-            Queue::push(
-                (new FetchJobStatusFromConnector(
-                    [
-                        'jobId' => $this->jobId,
-                        'liltJobId' => $this->liltJobId,
-                    ]
-                )),
-                self::PRIORITY,
-                self::getDelay(),
-                self::TTR
+            $queueDisableAutomaticSync = (bool) Craftliltplugin::getInstance()->settingsRepository->get(
+                SettingsRepository::QUEUE_DISABLE_AUTOMATIC_SYNC
             );
 
+            if(!$queueDisableAutomaticSync) {
+                Queue::push(
+                    (new FetchJobStatusFromConnector(
+                        [
+                            'jobId' => $this->jobId,
+                            'liltJobId' => $this->liltJobId,
+                        ]
+                    )),
+                    self::PRIORITY,
+                    self::getDelay(),
+                    self::TTR
+                );
+            }
+
             $mutex->release($mutexKey);
             $this->markAsDone($queue);
 
@@ -177,18 +184,24 @@ function (TranslationResponse $connectorTranslation) {
                 return;
             }
 
-            Queue::push(
-                (new FetchJobStatusFromConnector(
-                    [
-                        'jobId' => $this->jobId,
-                        'liltJobId' => $this->liltJobId,
-                    ]
-                )),
-                self::PRIORITY,
-                self::getDelay(),
-                self::TTR
+            $queueDisableAutomaticSync = (bool) Craftliltplugin::getInstance()->settingsRepository->get(
+                SettingsRepository::QUEUE_DISABLE_AUTOMATIC_SYNC
             );
 
+            if(!$queueDisableAutomaticSync) {
+                Queue::push(
+                    (new FetchJobStatusFromConnector(
+                        [
+                            'jobId' => $this->jobId,
+                            'liltJobId' => $this->liltJobId,
+                        ]
+                    )),
+                    self::PRIORITY,
+                    self::getDelay(),
+                    self::TTR
+                );
+            }
+
             $mutex->release($mutexKey);
             $this->markAsDone($queue);
 

src/modules/QueueManager.php

@@ -12,9 +12,11 @@
 use Craft;
 use craft\queue\BaseJob;
 use craft\helpers\Queue as CraftHelpersQueue;
+use lilthq\craftliltplugin\Craftliltplugin;
 use lilthq\craftliltplugin\elements\Job;
 use lilthq\craftliltplugin\parameters\CraftliltpluginParameters;
 use lilthq\craftliltplugin\records\JobRecord;
+use lilthq\craftliltplugin\services\repositories\SettingsRepository;
 
 class QueueManager extends BaseJob
 {
@@ -25,6 +27,15 @@ class QueueManager extends BaseJob
      */
     public function execute($queue): void
     {
+        $queueDisableAutomaticSync = (bool) Craftliltplugin::getInstance()->settingsRepository->get(
+            SettingsRepository::QUEUE_DISABLE_AUTOMATIC_SYNC
+        );
+
+        if($queueDisableAutomaticSync) {
+            // skip because automatic sync is disabled
+            return;
+        }
+
         $mutex = Craft::$app->getMutex();
         $mutexKey = __CLASS__ . '_' . __FUNCTION__;
         if (!$mutex->acquire($mutexKey)) {

src/modules/SendTranslationToConnector.php

@@ -20,6 +20,7 @@
 use lilthq\craftliltplugin\models\TranslationModel;
 use lilthq\craftliltplugin\records\TranslationRecord;
 use lilthq\craftliltplugin\services\handlers\commands\SendTranslationCommand;
+use lilthq\craftliltplugin\services\repositories\SettingsRepository;
 use Throwable;
 
 class SendTranslationToConnector extends AbstractRetryJob
@@ -180,15 +181,21 @@ function (TranslationModel $translationModel) {
                 );
             }
 
-            Queue::push(
-                (new FetchJobStatusFromConnector([
-                    'jobId' => $command->getJob()->id,
-                    'liltJobId' => $command->getJob()->liltJobId,
-                ])),
-                FetchJobStatusFromConnector::PRIORITY,
-                10
+            $queueDisableAutomaticSync = (bool) Craftliltplugin::getInstance()->settingsRepository->get(
+                SettingsRepository::QUEUE_DISABLE_AUTOMATIC_SYNC
             );
 
+            if(!$queueDisableAutomaticSync) {
+                Queue::push(
+                    (new FetchJobStatusFromConnector([
+                        'jobId' => $command->getJob()->id,
+                        'liltJobId' => $command->getJob()->liltJobId,
+                    ])),
+                    FetchJobStatusFromConnector::PRIORITY,
+                    10
+                );
+            }
+
             $this->markAsDone($queue);
             $this->release();
 

src/services/handlers/SendJobToLiltConnectorHandler.php

@@ -196,14 +196,21 @@ public function __invoke(Job $job): void
             'Job uploaded to Lilt Platform'
         );
 
-        Queue::push(
-            (new FetchJobStatusFromConnector([
-                'jobId' => $job->id,
-                'liltJobId' => $jobLilt->getId(),
-            ])),
-            FetchJobStatusFromConnector::PRIORITY,
-            10 //10 seconds for fist job
+        $queueDisableAutomaticSync = (bool) Craftliltplugin::getInstance()->settingsRepository->get(
+            SettingsRepository::QUEUE_DISABLE_AUTOMATIC_SYNC
         );
+
+        if(!$queueDisableAutomaticSync) {
+            // push fetch status job from connector
+            Queue::push(
+                (new FetchJobStatusFromConnector([
+                    'jobId' => $job->id,
+                    'liltJobId' => $jobLilt->getId(),
+                ])),
+                FetchJobStatusFromConnector::PRIORITY,
+                10 //10 seconds for fist job
+            );
+        }
     }
 
     /**

src/services/repositories/SettingsRepository.php

@@ -17,8 +17,8 @@ class SettingsRepository
 {
     public const ENABLE_ENTRIES_FOR_TARGET_SITES = 'enable_entries_for_target_sites';
     public const COPY_ENTRIES_SLUG_FROM_SOURCE_TO_TARGET = 'copy_entries_slug_from_source_to_target';
-
     public const QUEUE_EACH_TRANSLATION_FILE_SEPARATELY = 'queue_each_translation_file_separately';
+    public const QUEUE_DISABLE_AUTOMATIC_SYNC = 'queue_disable_automatic_sync';
     public const QUEUE_MANAGER_EXECUTED_AT = 'queue_manager_executed_at';
 
     public const IGNORE_DROPDOWNS = 'ignore_dropdowns';
@@ -56,6 +56,25 @@ public function isQueueEachTranslationFileSeparately(): bool
         return (bool)$settingValue->value;
     }
 
+    public function get(string $name): ?string
+    {
+        $tableSchema = Craft::$app->getDb()->schema->getTableSchema(CraftliltpluginParameters::SETTINGS_TABLE_NAME);
+        if ($tableSchema === null) {
+            return null;
+        }
+
+
+        $settingValue = SettingRecord::findOne(
+            ['name' => $name]
+        );
+
+        if (empty($settingValue) || empty($settingValue->value)) {
+            return null;
+        }
+
+        return $settingValue->value;
+    }
+
     public function ignoreDropdowns(): bool
     {
         $tableSchema = Craft::$app->getDb()->schema->getTableSchema(CraftliltpluginParameters::SETTINGS_TABLE_NAME);

src/templates/_components/utilities/configuration.twig

@@ -91,6 +91,17 @@
         }) }}
         </div>
 
+        <div class="field">
+        {{ forms.checkbox({
+            label: 'Disable automatic synchronization of sent translation jobs',
+            name: 'queueDisableAutomaticSync',
+            id: 'queueDisableAutomaticSync',
+            checked: queueDisableAutomaticSync,
+            errors: model is defined? model.getErrors('queueDisableAutomaticSync') : [],
+            disabled: liltConfigDisabled
+        }) }}
+        </div>
+
         {{ forms.textField({
             name: 'liltConfigDisabled',
             id: 'liltConfigDisabled',

src/utilities/Configuration.php

@@ -92,6 +92,11 @@ public static function contentHtml(): string
         );
         $queueEachTranslationFileSeparately = (bool) ($queueEachTranslationFileSeparately->value ?? false);
 
+        $queueDisableAutomaticSync = SettingRecord::findOne(
+            ['name' => SettingsRepository::QUEUE_DISABLE_AUTOMATIC_SYNC,]
+        );
+        $queueDisableAutomaticSync = (bool) ($queueDisableAutomaticSync->value ?? false);
+
         return Craft::$app->getView()->renderTemplate(
             'craft-lilt-plugin/_components/utilities/configuration.twig',
             [
@@ -106,6 +111,7 @@ public static function contentHtml(): string
                 'enableEntriesForTargetSites' => $enableEntriesForTargetSites,
                 'copyEntriesSlugFromSourceToTarget' => $copyEntriesSlugFromSourceToTarget,
                 'queueEachTranslationFileSeparately' => $queueEachTranslationFileSeparately,
+                'queueDisableAutomaticSync' => $queueDisableAutomaticSync,
             ]
         );
     }