Merge branch 'develop' into 4.0

# Conflicts:
#	composer.lock

Author: nfourtythree

CHANGELOG.md

@@ -4,7 +4,9 @@
 
 - Added an `async` flag to the `craft/shopify/sync` command.
 - Added an `async` param to the sync utility.
-- Fixed a bug where the template routing setting would not save. 
+- Fixed a bug where the template routing setting would not save.
+- Added `craft\shopify\helpers\Api`.
+- Added `craft\shopify\jobs\UpdateProductVariants`.
 
 ## 3.2.0 - 2023-06-12
 

README.md

@@ -843,3 +843,11 @@ return [
   ],
 ];
 ```
+
+## Rate Limiting
+
+The Shopify API implements [rate limiting rules](https://shopify.dev/docs/api/usage/rate-limits) the plugin makes its best effort to avoid hitting these limits.
+
+By default, when syncing all products the plugin moves some of the load of retrieving data to queue jobs. Therefore the variant and meta field data is asynchronously updated on to the Shopify products.
+
+It is possible to turn off the plugin's rate limiting measures by setting the `rateLimitRequests` config option to `false`. Or, if you are hitting rate limiting issues you can increase the timeout length updating the `rateLimitSeconds` config setting (number of seconds as an integer).

src/helpers/Api.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license https://craftcms.github.io/license/
+ */
+
+namespace craft\shopify\helpers;
+
+use craft\shopify\Plugin;
+
+/**
+ * Shopify API Helper.
+ *
+ * @author Pixel & Tonic, Inc. <[email protected]>
+ * @since 3.3.0
+ */
+class Api
+{
+    /**
+     * @return void
+     */
+    public static function rateLimit(): void
+    {
+        if (!Plugin::getInstance()->getSettings()->rateLimitRequests) {
+            return;
+        }
+
+        sleep(Plugin::getInstance()->getSettings()->rateLimitSeconds);
+    }
+}

src/jobs/UpdateProductMetadata.php

@@ -4,6 +4,7 @@
 
 use craft\queue\BaseJob;
 use craft\shopify\elements\Product;
+use craft\shopify\helpers\Api as ApiHelper;
 use craft\shopify\helpers\Metafields as MetafieldsHelper;
 use craft\shopify\Plugin;
 use craft\shopify\records\ProductData as ProductDataRecord;
@@ -30,7 +31,7 @@ public function execute($queue): void
             $productData = ProductDataRecord::find()->where(['shopifyId' => $this->shopifyProductId])->one();
             $productData->metaFields = $metaFields;
             $productData->save();
-            sleep(1); // Avoid rate limiting
+            ApiHelper::rateLimit(); // Avoid rate limiting
         }
     }
 

src/jobs/UpdateProductVariants.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace craft\shopify\jobs;
+
+use craft\queue\BaseJob;
+use craft\shopify\elements\Product;
+use craft\shopify\helpers\Api as ApiHelper;
+use craft\shopify\Plugin;
+use craft\shopify\records\ProductData as ProductDataRecord;
+
+/**
+ * Updates the variants for a Shopify product.
+ * @since 3.3.0
+ */
+class UpdateProductVariants extends BaseJob
+{
+    public int $shopifyProductId;
+
+    /**
+     * @inheritdoc
+     */
+    public function execute($queue): void
+    {
+        $api = Plugin::getInstance()->getApi();
+
+        /** @var Product|null $product */
+        $product = Product::find()->shopifyId($this->shopifyProductId)->one();
+
+        if ($product) {
+            $variants = $api->getVariantsByProductId($this->shopifyProductId);
+            $product->setVariants($variants);
+            /** @var ProductDataRecord $productData */
+            $productData = ProductDataRecord::find()->where(['shopifyId' => $this->shopifyProductId])->one();
+            $productData->variants = $variants;
+            $productData->save();
+            ApiHelper::rateLimit(); // Avoid rate limiting
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function defaultDescription(): ?string
+    {
+        return null;
+    }
+}

src/models/Settings.php

@@ -28,10 +28,23 @@ class Settings extends Model
     public string $template = '';
     private mixed $_productFieldLayout;
 
+    /**
+     * @var bool Whether to rate limit requests to Shopify
+     * @since 3.3.0
+     */
+    public bool $rateLimitRequests = true;
+
+    /**
+     * @var int The number of seconds to wait between requests
+     * @since 3.3.0
+     */
+    public int $rateLimitSeconds = 1;
+
     public function rules(): array
     {
         return [
             [['apiSecretKey', 'apiKey', 'accessToken', 'hostName'], 'required'],
+            [['rateLimitSeconds', 'rateLimitRequests'], 'safe'],
         ];
     }
 
@@ -47,6 +60,8 @@ public function attributeLabels(): array
             'hostName' => Craft::t('shopify', 'Shopify Host Name'),
             'uriFormat' => Craft::t('shopify', 'Product URI format'),
             'template' => Craft::t('shopify', 'Product Template'),
+            'rateLimitRequests' => Craft::t('shopify', 'Rate Limit Requests'),
+            'rateLimitSeconds' => Craft::t('shopify', 'Rate Limit Seconds'),
         ];
     }
 

src/services/Api.php

@@ -11,6 +11,7 @@
 use craft\base\Component;
 use craft\helpers\App;
 use craft\log\MonologTarget;
+use craft\shopify\helpers\Api as ApiHelper;
 use craft\shopify\Plugin;
 use Shopify\Auth\FileSessionStorage;
 use Shopify\Auth\Session;
@@ -146,6 +147,7 @@ public function getAll(string $type, array $params = []): array
                 [],
                 $type::$NEXT_PAGE_QUERY ?: $params,
             ));
+            ApiHelper::rateLimit(); // Avoid rate limiting
         } while ($type::$NEXT_PAGE_QUERY);
 
         return $resources;

src/services/Products.php

@@ -11,12 +11,15 @@
 use craft\shopify\elements\Product;
 use craft\shopify\elements\Product as ProductElement;
 use craft\shopify\events\ShopifyProductSyncEvent;
+use craft\shopify\helpers\Api as ApiHelper;
 use craft\shopify\helpers\Metafields as MetafieldsHelper;
 use craft\shopify\jobs\UpdateProductMetadata;
+use craft\shopify\jobs\UpdateProductVariants;
 use craft\shopify\Plugin;
 use craft\shopify\records\ProductData as ProductDataRecord;
 use Shopify\Rest\Admin2022_10\Metafield as ShopifyMetafield;
 use Shopify\Rest\Admin2022_10\Product as ShopifyProduct;
+use Shopify\Rest\Admin2022_10\Variant as ShopifyVariant;
 
 /**
  * Shopify Products service.
@@ -72,9 +75,17 @@ public function syncAllProducts(bool $asynchronous = true): void
                     ]),
                     'shopifyProductId' => $product->id,
                 ]));
+                Craft::$app->getQueue()->push(new UpdateProductVariants([
+                    'description' => Craft::t('shopify', 'Updating product variants for “{title}”', [
+                        'title' => $product->title,
+                    ]),
+                    'shopifyProductId' => $product->id,
+                ]));
             } else {
                 $metaFields = $api->getMetafieldsByProductId($product->id);
-                $this->createOrUpdateProduct($product, $metaFields);
+                ApiHelper::rateLimit();
+                $variants = $api->getVariantsByProductId($product->id);
+                $this->createOrUpdateProduct($product, $metaFields, $variants);
             }
         }
 
@@ -98,8 +109,9 @@ public function syncProductByShopifyId($id): void
 
         $product = $api->getProductByShopifyId($id);
         $metaFields = $api->getMetafieldsByProductId($id);
+        $variants = $api->getVariantsByProductId($id);
 
-        $this->createOrUpdateProduct($product, $metaFields);
+        $this->createOrUpdateProduct($product, $metaFields, $variants);
     }
 
     /**
@@ -123,14 +135,14 @@ public function syncProductByInventoryItemId($id): void
      *
      * @param ShopifyProduct $product
      * @param ShopifyMetafield[] $metafields
+     * @param ShopifyVariant[] $variants
      * @return bool Whether the synchronization succeeded.
      */
-    public function createOrUpdateProduct(ShopifyProduct $product, array $metafields = []): bool
+    public function createOrUpdateProduct(ShopifyProduct $product, array $metafields = [], ?array $variants = null): bool
     {
         // Expand any JSON-like properties:
         $metaFields = MetafieldsHelper::unpack($metafields);
 
-        $variants = Plugin::getInstance()->getApi()->getVariantsByProductId($product->id);
         // Build our attribute set from the Shopify product data:
         $attributes = [
             'shopifyId' => $product->id,
@@ -147,7 +159,7 @@ public function createOrUpdateProduct(ShopifyProduct $product, array $metafields
             'tags' => $product->tags,
             'templateSuffix' => $product->template_suffix,
             'updatedAt' => $product->updated_at,
-            'variants' => $variants,
+            'variants' => $variants ?? $product->variants,
             'vendor' => $product->vendor,
             // This one is unusual, because we’re merging two different Shopify API resources:
             'metaFields' => $metaFields,

src/services/Store.php

@@ -22,8 +22,8 @@ class Store extends Component
      *
      * @param string $path
      * @param array $params
-     * @return string
      * @throws InvalidConfigException when no hostname is set up.
+     * @return string
      */
     public function getUrl(string $path = '', array $params = []): string
     {

src/translations/en/shopify.php

@@ -14,6 +14,16 @@
  * @since     0.0.1
  */
 return [
+    'Product Template' => 'Product Template',
+    'Product URI format' => 'Product URI format',
+    'Rate Limit Requests' => 'Rate Limit Requests',
+    'Rate Limit Seconds' => 'Rate Limit Seconds',
+    'Shopify API Key' => 'Shopify API Key',
+    'Shopify API Secret Key' => 'Shopify API Secret Key',
+    'Shopify Access Token' => 'Shopify Access Token',
+    'Shopify Host Name' => 'Shopify Host Name',
     'Shopify plugin loaded' => 'Shopify plugin loaded',
+    'Updating product metafields for “{title}”' => 'Updating product metafields for “{title}”',
+    'Updating product variants for “{title}”' => 'Updating product variants for “{title}”',
     '{name} option values: {values}' => '{name} option values: {values}',
 ];