Merge branch 'feature/async-sync-flag' into develop

craftcms · Sep 22, 2023 · e84e923 · e84e923
2 parents cd90f05 + 2e6ac37
commit e84e923
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 16 deletions.
diff --git a/src/console/controllers/SyncController.php b/src/console/controllers/SyncController.php
@@ -20,11 +20,32 @@
  */
 class SyncController extends Controller
 {
+    /** @var string $defaultAction */
     public $defaultAction = 'products';
 
+    /**
+     * @var bool Whether to sync product and other associated data in the queue.
+     * @since 3.3.0
+     */
+    public bool $async = true;
+
+    /**
+     * @inheritdoc
+     */
+    public function options($actionID): array
+    {
+        $options = parent::options($actionID);
+        $options[] = 'async';
+        return $options;
+    }
+
+    /**
+     * Sync all Shopify data.
+     */
     public function actionAll()
     {
         $this->_syncProducts();
+        return ExitCode::OK;
     }
 
     /**
@@ -39,7 +60,7 @@ public function actionProducts(): int
     private function _syncProducts(): void
     {
         $this->stdout('Syncing Shopify products…' . PHP_EOL . PHP_EOL, Console::FG_GREEN);
-        Plugin::getInstance()->getProducts()->syncAllProducts();
+        Plugin::getInstance()->getProducts()->syncAllProducts($this->async);
         $this->stdout('Finished' . PHP_EOL . PHP_EOL, Console::FG_GREEN);
     }
 }
diff --git a/src/controllers/ProductsController.php b/src/controllers/ProductsController.php
@@ -45,8 +45,10 @@ public function actionProductIndex(): Response
      */
     public function actionSync(): Response
     {
-        Plugin::getInstance()->getProducts()->syncAllProducts();
-        return $this->asSuccess(Craft::t('shopify','Products successfully synced'));
+        $async = (bool)Craft::$app->getRequest()->getParam('async', false);
+
+        Plugin::getInstance()->getProducts()->syncAllProducts($async);
+        return $this->asSuccess(Craft::t('shopify', 'Products successfully synced'));
     }
 
     /**

diff --git a/src/elements/db/ProductQuery.php b/src/elements/db/ProductQuery.php
@@ -223,13 +223,13 @@ protected function beforePrepare(): bool
         }
 
         if (isset($this->productType)) {
-            $this->subQuery->andWhere(Db::parseParam(['shopify_productdata.productType' => $this->productType]));
+            $this->subQuery->andWhere(Db::parseParam('shopify_productdata.productType', $this->productType));
         }
 
         if (isset($this->publishedScope)) {
-            $this->subQuery->andWhere(Db::parseParam(['shopify_productdata.publishedScope' => $this->publishedScope]));
+            $this->subQuery->andWhere(Db::parseParam('shopify_productdata.publishedScope', $this->publishedScope));
         }
-        
+
         if (isset($this->shopifyStatus)) {
             $this->subQuery->andWhere(Db::parseParam('shopify_productdata.shopifyStatus', $this->shopifyStatus));
         }

diff --git a/src/services/Products.php b/src/services/Products.php
@@ -58,19 +58,24 @@ class Products extends Component
      * @throws \Throwable
      * @throws \yii\base\InvalidConfigException
      */
-    public function syncAllProducts(): void
+    public function syncAllProducts(bool $asynchronous = true): void
     {
         $api = Plugin::getInstance()->getApi();
         $products = $api->getAllProducts();
 
         foreach ($products as $product) {
-            $this->createOrUpdateProduct($product);
-            Craft::$app->getQueue()->push(new UpdateProductMetadata([
-                'description' => Craft::t('shopify', 'Updating product metadata for “{title}”', [
-                    'title' => $product->title,
-                ]),
-                'shopifyProductId' => $product->id,
-            ]));
+            if ($asynchronous) {
+                $this->createOrUpdateProduct($product);
+                Craft::$app->getQueue()->push(new UpdateProductMetadata([
+                    'description' => Craft::t('shopify', 'Updating product metafields for “{title}”', [
+                        'title' => $product->title,
+                    ]),
+                    'shopifyProductId' => $product->id,
+                ]));
+            } else {
+                $metaFields = $api->getMetafieldsByProductId($product->id);
+                $this->createOrUpdateProduct($product, $metaFields);
+            }
         }
 
         // Remove any products that are no longer in Shopify just in case.
@@ -92,9 +97,9 @@ public function syncProductByShopifyId($id): void
         $api = Plugin::getInstance()->getApi();
 
         $product = $api->getProductByShopifyId($id);
-        $metafields = $api->getMetafieldsByProductId($id);
+        $metaFields = $api->getMetafieldsByProductId($id);
 
-        $this->createOrUpdateProduct($product, $metafields);
+        $this->createOrUpdateProduct($product, $metaFields);
     }
 
     /**

diff --git a/src/templates/utilities/_sync.twig b/src/templates/utilities/_sync.twig
@@ -1,7 +1,19 @@
 <h2>{{ "Shopify Sync"|t('shopify') }}</h2>
+{% import "_includes/forms" as forms %}
+
 <form method="POST">
     {{ actionInput('') }}
     {{ csrfInput() }}
+
+    {{ forms.lightswitchField({
+        label: "Use queue for syncing related objects like meta fields."|t('shopify'),
+        warning: 'If disabled timeouts may occur, or API rate limits may be hit.'|t('commerce'),
+        id: 'async',
+        name: 'async',
+        value: 1,
+        on: true
+    }) }}
+
     <a class="btn submit formsubmit" data-icon="refresh"
        data-action="shopify/products/sync"
        data-confirm="{{ 'Are you sure you want run a complete sync of all products?'|t('shopify') }}">