Merge pull request #155 from data-provider/fix-154-throttle

Release v2.8.1

Author: javierbrea

CHANGELOG.md

@@ -10,6 +10,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 ### Removed
 
+## [2.8.1] - 2020-11-27
+
+### Fixed
+- fix(#154): Pass original arguments to throttled methods
+
 ## [2.8.0] - 2020-11-23
 
 ### Added

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-provider/core",
-  "version": "2.8.0",
+  "version": "2.8.1",
   "description": "Async Data Provider agnostic about data origins",
   "keywords": [
     "data",

package.json

@@ -1,6 +1,6 @@
 sonar.organization=data-provider
 sonar.projectKey=data-provider-core
-sonar.projectVersion=2.8.0
+sonar.projectVersion=2.8.1
 
 sonar.sources=src,test
 sonar.exclusions=node_modules/**

sonar-project.properties

@@ -116,12 +116,13 @@ export function throttle(func, limit) {
   let inThrottle = false;
   let calledWhileInThrottle = false;
   let finishThrottleTimeout = null;
-  const checkFinishThrottle = (context) => {
+  const checkFinishThrottle = (context, args) => {
     finishThrottleTimeout = setTimeout(() => {
       if (calledWhileInThrottle) {
+        inThrottle = true;
         calledWhileInThrottle = false;
-        checkFinishThrottle(context);
-        func.apply(context, arguments);
+        checkFinishThrottle(context, args);
+        func.apply(context, args);
       } else {
         inThrottle = false;
       }
@@ -135,7 +136,7 @@ export function throttle(func, limit) {
       }
       inThrottle = true;
       calledWhileInThrottle = false;
-      checkFinishThrottle(context);
+      checkFinishThrottle(context, arguments);
       func.apply(context, arguments);
     } else {
       calledWhileInThrottle = true;

src/helpers.js

@@ -73,7 +73,7 @@ describe("Provider cleanCacheThrottle option", () => {
     });
   });
 
-  describe("withot cleanCacheThrottle option", () => {
+  describe("with cleanCacheThrottle option", () => {
     it("should execute read method all times cleanCache is called if option value is 0", async () => {
       provider.config({
         cleanCacheThrottle: 0,
@@ -119,6 +119,33 @@ describe("Provider cleanCacheThrottle option", () => {
       expect(spies.read.callCount).toEqual(2);
     });
 
+    it("should pass same options to cleanCache method when it is throttled", async () => {
+      expect.assertions(7);
+      const options = { foo: "foo" };
+      const originalUnthrottledCleanCache = provider._unthrottledCleanCache.bind(provider);
+      provider._unthrottledCleanCache = function (options) {
+        originalUnthrottledCleanCache(options);
+      };
+      const spy = sandbox.spy(provider, "_unthrottledCleanCache");
+      provider.config({
+        cleanCacheThrottle: 500,
+      });
+      sandbox.spy(provider, "_throttledCleanCache");
+      await provider.read();
+      provider.cleanCache(options); // This one cleans the cache
+      expect(provider._throttledCleanCache.getCall(0).args[0]).toBe(options);
+      expect(spy.getCall(0).args[0]).toBe(options);
+      provider.cleanCache(); // throttled
+      provider.cleanCache(); // throttled
+      expect(provider._throttledCleanCache.callCount).toEqual(3);
+      expect(spy.callCount).toEqual(1);
+      await wait(700);
+      // It should have cleaned cache again after throttle time
+      expect(provider._throttledCleanCache.callCount).toEqual(3);
+      expect(spy.callCount).toEqual(2);
+      expect(spy.getCall(1).args[0]).toBe(options);
+    });
+
     it("should clean cache one more time after throttle time if it receive calls while throttled", async () => {
       expect.assertions(4);
       provider.config({