Rate limiting adjusted to microseconds, option to optionally remove rate limiting

Author: Tyler King

README.md

@@ -408,17 +408,30 @@ $api = new BasicShopifyAPI($options);
 $api->rest('GET', '/admin/api/unstable/shop.json'); // Will ignore "2020-01" version and use "unstable" for this request
 ```
 
-### Rate Limiting
+### Rate limiting
 
-This library comes with a built-in basic rate limiter via `usleep`.
+This library comes with a built-in basic rate limiter which utilizes `usleep` between applicable calls.
 
-For REST, it ensures you do not request more than the default of 2 calls per second.
-
-For GraphQL, it ensures you do not use more than the default of 50 points per second.
+* For REST: it ensures you do not request more than the default of 2 calls per second.
+* For GraphQL: it ensures you do not use more than the default of 50 points per second.
 
 To adjust the default limits, use the option class' `setRestLimit` and `setGraphLimit`.
 
-### page_info / pagination Support
+#### Custom rate limiting
+
+You simply need to disable the built-in rate limiter and push in a custom Guzzle middleware. Example:
+
+```php
+$options = new Options();
+// ...
+$options->disableRateLimiting();
+
+// ...
+$api = new BasicShopifyAPI($options);
+$api->addMiddleware(new CustomRateLimiter($api), 'rate:limiting');
+```
+
+### page_info / pagination support
 
 2019-07 API version introduced a new `Link` header which is used for pagination ([explained here](https://help.shopify.com/en/api/guides/paginated-rest-results)).
 

src/Osiset/BasicShopifyAPI/BasicShopifyAPI.php

@@ -122,10 +122,12 @@ public function __construct(
         $this->stack = HandlerStack::create($this->getOptions()->getGuzzleHandler());
         $this
             ->addMiddleware(new AuthRequest($this), 'request:auth')
-            ->addMiddleware(new RateLimiting($this), 'rate:limiting')
             ->addMiddleware(new UpdateApiLimits($this), 'rate:update')
             ->addMiddleware(new UpdateRequestTime($this), 'time:update')
             ->addMiddleware(GuzzleRetryMiddleware::factory(), 'request:retry');
+        if ($this->getOptions()->isRateLimitingEnabled()) {
+            $this->addMiddleware(new RateLimiting($this), 'rate:limiting');
+        }
 
         // Create a default Guzzle client with our stack
         $this->setClient(
@@ -182,7 +184,6 @@ public function getOptions(): Options
     public function setGraphClient(GraphRequester $client): self
     {
         $this->graphClient = $client;
-
         return $this;
     }
 
@@ -206,7 +207,6 @@ public function getGraphClient(): GraphRequester
     public function setRestClient(RestRequester $client): self
     {
         $this->restClient = $client;
-
         return $this;
     }
 
@@ -252,7 +252,6 @@ public function withSession(Session $session, Closure $closure)
         // Clone the API class and bind it to the closure
         $clonedApi = clone $this;
         $clonedApi->setSession($session);
-
         return $closure->call($clonedApi);
     }
 
@@ -267,7 +266,6 @@ public function withSession(Session $session, Closure $closure)
     public function addMiddleware(callable $callable, string $name = ''): self
     {
         $this->stack->push($callable, $name);
-
         return $this;
     }
 
@@ -281,7 +279,6 @@ public function addMiddleware(callable $callable, string $name = ''): self
     public function removeMiddleware(string $name = ''): self
     {
         $this->stack->remove($name);
-
         return $this;
     }
 
@@ -356,7 +353,6 @@ public function verifyRequest(array $params): bool
             // Grab the HMAC, remove it from the params, then sort the params for hashing
             $hmac = $params['hmac'];
             unset($params['hmac']);
-
             ksort($params);
 
             // Encode and hash the params (without HMAC), add the API secret, and compare to the HMAC from params

src/Osiset/BasicShopifyAPI/Clients/Graph.php

@@ -45,14 +45,12 @@ public function request(string $query, array $variables = [], bool $sync = true)
         if ($sync === false) {
             // Async request
             $promise = $requestFn($request);
-
             return $promise->then([$this, 'handleSuccess'], [$this, 'handleFailure']);
         }
 
         // Sync request (default)
         try {
             $response = $requestFn($request);
-
             return $this->handleSuccess($response);
         } catch (RequestException $e) {
             return $this->handleFailure($e);

src/Osiset/BasicShopifyAPI/Clients/Rest.php

@@ -31,7 +31,6 @@ protected function extractLinkHeader(string $header): ResponseAccess
             preg_match(str_replace('{type}', $type, $regex), $header, $matches);
             $links[$type] = isset($matches[1]) ? $matches[1] : null;
         }
-
         return new ResponseAccess($links);
     }
 
@@ -63,10 +62,8 @@ public function requestAccess(string $code): ResponseAccess
             );
         } catch (ClientException $e) {
             $body = json_decode($e->getResponse()->getBody()->getContents());
-
             throw new Exception($body->error_description);
         }
-
         return $this->toResponse($response->getBody());
     }
 
@@ -131,14 +128,12 @@ public function request(string $type, string $path, array $params = null, array
          */
         $requestFn = function () use ($sync, $type, $uri, $guzzleParams) {
             $fn = $sync ? 'request' : 'requestAsync';
-
             return $this->getClient()->{$fn}($type, $uri, $guzzleParams);
         };
 
         if ($sync === false) {
             // Async request
             $promise = $requestFn();
-
             return $promise->then([$this, 'handleSuccess'], [$this, 'handleFailure']);
         }
 

src/Osiset/BasicShopifyAPI/Deferrers/Sleep.php

@@ -15,7 +15,7 @@ class Sleep implements TimeDeferrer
      */
     public function getCurrentTime(): float
     {
-        return microtime(true);
+        return microtime(true) * 1000000;
     }
 
     /**

src/Osiset/BasicShopifyAPI/Middleware/AuthRequest.php

@@ -29,7 +29,6 @@ class AuthRequest extends AbstractMiddleware
     public function __invoke(callable $handler): callable
     {
         $self = $this;
-
         return function (RequestInterface $request, array $options) use ($self, $handler) {
             // Get the request URI
             $uri = $request->getUri();
@@ -81,7 +80,6 @@ public function __invoke(callable $handler): callable
                     $this->versionPath($uri->getPath())
                 )
             );
-
             return $handler($request, $options);
         };
     }

src/Osiset/BasicShopifyAPI/Middleware/RateLimiting.php

@@ -23,14 +23,12 @@ class RateLimiting extends AbstractMiddleware
     public function __invoke(callable $handler): callable
     {
         $self = $this;
-
         return function (RequestInterface $request, array $options) use ($self, $handler) {
             if ($self->isRestRequest($request->getUri())) {
                 $this->handleRest($self->api);
             } else {
                 $this->handleGraph($self->api);
             }
-
             return $handler($request, $options);
         };
     }
@@ -57,21 +55,19 @@ protected function handleRest(BasicShopifyAPI $api): bool
 
         // Determine if this call has passed the window
         $firstTime = end($times);
-        $windowTime = $firstTime + 1;
+        $windowTime = $firstTime + 1000000;
         $currentTime = $td->getCurrentTime();
 
         if ($currentTime > $windowTime) {
             // Call is passed the window, reset and allow through without limiting
             $ts->reset($api->getSession());
-
             return false;
         }
 
         // Call is inside the window and not at the call limit, sleep until window can be reset
         $sleepTime = $windowTime - $currentTime;
         $td->sleep($sleepTime < 0 ? 0 : $sleepTime);
         $ts->reset($api->getSession());
-
         return true;
     }
 
@@ -99,7 +95,6 @@ protected function handleGraph(BasicShopifyAPI $api): bool
         /** @var int $lastCost */
         $lastCost = $ls->get($api->getSession());
         $lastCost = isset($lastCost[0]) && isset($lastCost[0]['actualCost']) ? $lastCost[0]['actualCost'] : 0;
-
         if ($lastTime === 0 || $lastCost === 0) {
             // This is the first request, nothing to do
             return false;
@@ -108,14 +103,11 @@ protected function handleGraph(BasicShopifyAPI $api): bool
         // How many points can be spent every second and time difference
         $pointsEverySecond = $api->getOptions()->getGraphLimit();
         $timeDiff = $currentTime - $lastTime;
-
         if ($timeDiff < 1000000 && $lastCost > $pointsEverySecond) {
             // Less than a second has passed and the cost is over the limit
             $td->sleep(1000000 - $timeDiff);
-
             return true;
         }
-
         return false;
     }
 }

src/Osiset/BasicShopifyAPI/Middleware/UpdateApiLimits.php

@@ -26,7 +26,6 @@ class UpdateApiLimits extends AbstractMiddleware
     public function __invoke(callable $handler): callable
     {
         $self = $this;
-
         return function (RequestInterface $request, array $options) use ($self, $handler) {
             $promise = $handler($request, $options);
 
@@ -37,7 +36,6 @@ function (ResponseInterface $response) use ($self) {
                     } else {
                         $self->updateGraphCosts($response);
                     }
-
                     return $response;
                 }
             );

src/Osiset/BasicShopifyAPI/Middleware/UpdateRequestTime.php

@@ -22,7 +22,6 @@ class UpdateRequestTime extends AbstractMiddleware
     public function __invoke(callable $handler): callable
     {
         $self = $this;
-
         return function (RequestInterface $request, array $options) use ($self, $handler) {
             // Get the client
             $api = $self->api;
@@ -34,7 +33,6 @@ public function __invoke(callable $handler): callable
                 $client->getTimeDeferrer()->getCurrentTime(),
                 $api->getSession()
             );
-
             return $handler($request, $options);
         };
     }

src/Osiset/BasicShopifyAPI/Options.php

@@ -65,6 +65,13 @@ class Options
      */
     protected $version;
 
+    /**
+     * Enable or disable built-in rate limiting.
+     *
+     * @var bool
+     */
+    protected $rateLimiting = true;
+
     /**
      * Additional Guzzle options.
      *
@@ -98,7 +105,6 @@ class Options
     public function setType(bool $private): self
     {
         $this->private = $private;
-
         return $this;
     }
 
@@ -142,7 +148,6 @@ public function isPublic(): bool
     public function setApiKey(string $apiKey): self
     {
         $this->apiKey = $apiKey;
-
         return $this;
     }
 
@@ -166,7 +171,6 @@ public function getApiKey(): ?string
     public function setApiSecret(string $apiSecret): self
     {
         $this->apiSecret = $apiSecret;
-
         return $this;
     }
 
@@ -190,7 +194,6 @@ public function getApiSecret(): ?string
     public function setApiPassword(string $apiPassword): self
     {
         $this->apiPassword = $apiPassword;
-
         return $this;
     }
 
@@ -214,7 +217,6 @@ public function getApiPassword(): ?string
     public function setRestLimit(int $limit): self
     {
         $this->restLimit = $limit;
-
         return $this;
     }
 
@@ -238,7 +240,6 @@ public function getRestLimit(): int
     public function setGraphLimit(int $limit): self
     {
         $this->graphLimit = $limit;
-
         return $this;
     }
 
@@ -262,7 +263,6 @@ public function getGraphLimit(): int
     public function setGuzzleOptions(array $options): self
     {
         $this->guzzleOptions = array_merge($this->guzzleOptions, $options);
-
         return $this;
     }
 
@@ -286,7 +286,6 @@ public function getGuzzleOptions(): array
     public function setGuzzleHandler(callable $handler): self
     {
         $this->guzzleHandler = $handler;
-
         return $this;
     }
 
@@ -317,7 +316,6 @@ public function setVersion(string $version): self
         }
 
         $this->version = $version;
-
         return $this;
     }
 
@@ -330,4 +328,36 @@ public function getVersion(): ?string
     {
         return $this->version;
     }
+
+    /**
+     * Enable built-in rate limiting.
+     *
+     * @return self
+     */
+    public function enableRateLimiting(): self
+    {
+        $this->rateLimiting = true;
+        return $this;
+    }
+
+    /**
+     * Disable built-in rate limiting.
+     *
+     * @return self
+     */
+    public function disableRateLimiting(): self
+    {
+        $this->rateLimiting = false;
+        return $this;
+    }
+
+    /**
+     * Is built-in rate limiting enabled?
+     *
+     * @return bool
+     */
+    public function isRateLimitingEnabled(): bool
+    {
+        return $this->rateLimiting;
+    }
 }