Merge pull request #120 from roberttolton/master

Fixes REST API Rate Limiting

Author: Tyler King

src/Middleware/RateLimiting.php

@@ -50,13 +50,13 @@ protected function handleRest(BasicShopifyAPI $api): bool
         $ts = $client->getTimeStore();
 
         $times = $ts->get($api->getSession());
-        if (count($times) !== $api->getOptions()->getRestLimit()) {
+        if (count($times) < $api->getOptions()->getRestLimit()) {
             // Not at our limit yet, allow through without limiting
             return false;
         }
 
         // Determine if this call has passed the window
-        $firstTime = end($times);
+        $firstTime = end($times)['time'];
         $windowTime = $firstTime + 1000000;
         $currentTime = $td->getCurrentTime();
 

src/Middleware/UpdateApiLimits.php

@@ -107,6 +107,7 @@ protected function updateRestLimits(ResponseInterface $response): void
                 'left' => (int) $calls[1] - (int) $calls[0],
                 'made' => (int) $calls[0],
                 'limit' => (int) $calls[1],
+                'time' => $client->getTimeDeferrer()->getCurrentTime(),
             ],
             $this->api->getSession()
         );

test/Middleware/RateLimitingTest.php

@@ -22,12 +22,25 @@ public function testRestSleep(): void
         // Create fake times
         $td = $api->getRestClient()->getTimeDeferrer();
         $currentTime = $td->getCurrentTime();
-        $firstTime = $currentTime - 200;
-        $lastTime = $currentTime - 100;
+        $firstTime = $currentTime - 500;
+        $secondTime = $currentTime - 300;
 
         // Fill fake times
         $ts = $api->getRestClient()->getTimeStore();
-        $ts->set([$lastTime, $firstTime], $api->getSession());
+        $ts->set([
+            [
+                'left' => 38,
+                'made' => 2,
+                'limit' => 40,
+                'time' => $secondTime,
+            ],
+            [
+                'left' => 39,
+                'made' => 1,
+                'limit' => 40,
+                'time' => $firstTime,
+            ]
+        ], $api->getSession());
 
         // Given we have 2 previous calls within 1 second window, sleep should trigger
         $result = $method->invoke(new RateLimiting($api), $api);
@@ -47,12 +60,25 @@ public function testRestNoSleep(): void
         // Create fake times
         $td = $api->getRestClient()->getTimeDeferrer();
         $currentTime = $td->getCurrentTime();
-        $firstTime = $currentTime - 200;
-        $lastTime = $currentTime - 100;
+        $firstTime = $currentTime - 500;
+        $secondTime = $currentTime - 300;
 
         // Fill fake times
         $ts = $api->getRestClient()->getTimeStore();
-        $ts->set([$lastTime, $firstTime], $api->getSession());
+        $ts->set([
+            [
+                'left' => 38,
+                'made' => 2,
+                'limit' => 40,
+                'time' => $secondTime,
+            ],
+            [
+                'left' => 39,
+                'made' => 1,
+                'limit' => 40,
+                'time' => $firstTime,
+            ]
+        ], $api->getSession());
 
         // Even though two requests happened within 1 second window,
         // If we do the "next" call after the window time, it should