sliding-window-limiter 1.0.1 → 1.1.1

package/lib/rate_limiter.js

@@ -1,4 +1,5 @@
-const {isNumber} = require('lodash/fp');
+const {isNumber, isObject, isString} = require('lodash/fp');
+const {DateTime} = require('luxon');
 const {Window} = require('./window');
 const {NullStore} = require('./null_store');
 
@@ -42,7 +43,7 @@ class RateLimiter {
     }
   }
 
-  // should update the buckets according to configuration
+  // should update the buckets according to configuration.
   // returns true if update successful
   async update(value, timestamp) {
     if (!isNumber(value) || value <= 0)
@@ -62,6 +63,29 @@ class RateLimiter {
     }
   }
 
+  // should update the buckets according to configuration.
+  // only updates the time and recalculates window's buckets
+  async updateTime(timestamp) {
+    let _timestamp = timestamp;
+    if (timestamp instanceof Date)
+      _timestamp = DateTime.fromJSDate(timestamp);
+    if (isString(timestamp))
+      _timestamp = DateTime.fromISO(timestamp);
+    if (DateTime.isDateTime(_timestamp) && !_timestamp.isValid)
+      throw new TypeError('timestamp must be valid DateTime, Date or ISO string');
+    if (!_timestamp)
+      throw new TypeError('timestamp is required');
+
+    try {
+      this.window = this.window || Window.fromConfig(this.windowConfig);
+      this.window.recalculate(_timestamp);
+      await this.store.set(this.name, this.window.toObject());
+    }
+    catch (err) {
+      throw new Error(`Failed to update rate-limit window ${this.name}`, {cause: err});
+    }
+  }
+
   set(state) {
     if (this.window) return this;
     this.window = state ? new Window(state) : Window.fromConfig(this.windowConfig);

package/lib/window.js

@@ -45,12 +45,13 @@ class Window {
       _timestamp = DateTime.fromJSDate(timestamp);
     if (isString(timestamp))
       _timestamp = DateTime.fromISO(timestamp);
-    if (!_timestamp.isValid)
+    if (DateTime.isDateTime(_timestamp) && !_timestamp.isValid)
       throw new TypeError('timestamp must be valid DateTime, Date or ISO string');
+    if (!_timestamp)
+      throw new TypeError('timestamp is required');
 
     this.recalculate(_timestamp);
     this.timeSlices[0] += value;
-    this.updated = _timestamp;
   }
 
   slicesBetween(now, start) {
@@ -79,6 +80,7 @@ class Window {
         ...slice(0, -invalidSlices)(this.timeSlices),
       ];
     }
+    this.updated = timestamp;
   }
 
   valueOf() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sliding-window-limiter",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "Implementation of the Sliding Window rate limiting algorithm",
   "keywords": [
     "sliding-window",

package/test/rate_limiter.spec.js

@@ -147,4 +147,44 @@ describe('RateLimiter', () => {
       await expect(fn()).rejects.toThrow('Failed to update rate-limit window ip-req-per-minute-max10-u00001');
     });
   });
+
+  describe('#updateTime', () => {
+    test('should update window with ISO timestamp string', async () => {
+      const lim = new RateLimiter(DefaultOptions());
+      await expect(lim.updateTime('2025-01-01T00:00:30Z')).resolves.toBeUndefined();
+      expect(MockStore.set).toHaveBeenCalled();
+    });
+
+    test('should update window with Date object', async () => {
+      const lim = new RateLimiter(DefaultOptions());
+      const date = new Date('2025-01-01T00:00:30Z');
+      await expect(lim.updateTime(date)).resolves.toBeUndefined();
+      expect(MockStore.set).toHaveBeenCalled();
+    });
+
+    test('should throw error if timestamp is invalid', async () => {
+      const lim = new RateLimiter(DefaultOptions());
+      const fn = () => lim.updateTime('invalid-timestamp');
+      await expect(fn()).rejects.toThrow('timestamp must be valid DateTime, Date or ISO string');
+    });
+
+    test('should throw error if timestamp is null or undefined', async () => {
+      const lim = new RateLimiter(DefaultOptions());
+      const fn = () => lim.updateTime(null);
+      await expect(fn()).rejects.toThrow('timestamp is required');
+    });
+
+    test('should throw an error if failed to update store', async () => {
+      const lim = new RateLimiter({...DefaultOptions(), store: ErrorStore});
+      const fn = () => lim.updateTime('2025-01-01T00:00:30Z');
+      await expect(fn()).rejects.toThrow('Failed to update rate-limit window ip-req-per-minute-max10-u00001');
+    });
+
+    test('should initialize window if not already initialized', async () => {
+      const lim = new RateLimiter(DefaultOptions());
+      expect(lim.window).toBeFalsy();
+      await lim.updateTime('2025-01-01T00:00:30Z');
+      expect(lim.window).toBeTruthy();
+    });
+  });
 });