@withjoy/limiter 0.1.3 → 0.1.4-test

package/limitd-redis/test/validation.tests.js

@@ -0,0 +1,124 @@
+const assert = require('chai').assert;
+
+const { validateParams } = require('../lib/validation');
+
+describe('validation', () => {
+  describe('validateParameters', () => {
+
+    const buckets = {
+      user: {
+        size: 10
+      }
+    };
+
+    describe('when providing invalid parameters', () => {
+      const invalidParameterSets = [
+        {
+          result: {
+            message: 'params are required',
+            code: 101
+          }
+        }, {
+          params: {},
+          result: {
+            message: 'type is required',
+            code: 102
+          }
+        }, {
+          params: {
+            type: 'ip'
+          },
+          result: {
+            message: 'undefined bucket type ip',
+            code: 103
+          }
+        }, {
+          params: {
+            type: 'user'
+          },
+          result: {
+            message: 'key is required',
+            code: 104
+          }
+        }, {
+          params: {
+            type: 'user',
+            key: 'tenant|username',
+            configOverride: 5
+          },
+          result: {
+            message: 'configuration overrides must be an object',
+            code: 105
+          }
+        }, {
+          params: {
+            type: 'user',
+            key: 'tenant|username',
+            configOverride: {}
+          },
+          result: {
+            message: 'configuration overrides must provide either a size or interval',
+            code: 106
+          }
+        }
+      ];
+
+      invalidParameterSets.forEach(testcase => {
+        it(`Should return a validation error, code ${testcase.result.code}`, () => {
+          const result = validateParams(testcase.params, buckets);
+          assert.strictEqual(result.name, 'LimitdRedisValidationError');
+          assert.strictEqual(result.message, testcase.result.message);
+          assert.deepEqual(result.extra, { code: testcase.result.code });
+          assert.exists(result.stack);
+        });
+      });
+    });
+
+    describe('when providing valid parameters', () => {
+      const validParameterSerts = [
+        {
+          params: {
+            type: 'user',
+            key: 'tenant|username',
+          },
+          name: 'type and key params'
+        }, {
+          params: {
+            type: 'user',
+            key: 'tenant|username',
+            configOverride: {
+              size: 77
+            }
+          },
+          name: 'configOverride with size'
+        }, {
+          params: {
+            type: 'user',
+            key: 'tenant|username',
+            configOverride: {
+              per_hour: 300
+            }
+          },
+          name: 'configOverride with interval'
+        }, {
+          params: {
+            type: 'user',
+            key: 'tenant|username',
+            configOverride: {
+              size: 30,
+              per_hour: 300
+            }
+          },
+          name: 'configOverride with size and interval'
+        },
+      ];
+
+      validParameterSerts.forEach(testcase => {
+        it(`Should not cause a validation error for ${testcase.name}`, () => {
+          const result = validateParams(testcase.params, buckets);
+          assert.isUndefined(result);
+        });
+      });
+    });
+  });
+});

package/limiter.js

@@ -1,6 +1,7 @@
 "use strict";
 
 var LimitdRedis = require("limitd-redis"); // name to redis matter
+var z = require('zod');
 
 const defaultBuckets = {
 	emailsByEventId: { size: 3000 },
@@ -37,6 +38,56 @@ class Operation {
 // global singleton
 let connection = null;
 
+const LIMITER_CIRCUIT_BREAKER_DEFAULTS = {
+	timeout: "0.50s",
+	maxFailures: 50,
+	cooldown: "1s",
+	maxCooldown: "3s",
+	name: "limitr",
+};
+
+const LIMITER_RETRY_DEFAULTS = {
+	retries: 3,
+	minTimeout: 10,
+	maxTimeout: 30,
+};
+
+/**
+ * Circuit Breaker configuration for limiter. derived from limitd-redis package
+ * https://github.com/auth0/limitd-redis/blob/03ba193fe436c5b887ff410d4f2623512ee5c9e2/lib/client.js#L11C1-L12C1
+ */
+const limiterCircuitBreakerConfig = z
+	.object({
+		timeout: z.coerce
+			.string()
+			.default(LIMITER_CIRCUIT_BREAKER_DEFAULTS.timeout),
+		maxFailures: z.coerce
+			.number()
+			.default(LIMITER_CIRCUIT_BREAKER_DEFAULTS.maxFailures),
+		cooldown: z.coerce
+			.string()
+			.default(LIMITER_CIRCUIT_BREAKER_DEFAULTS.cooldown),
+		maxCooldown: z.coerce
+			.string()
+			.default(LIMITER_CIRCUIT_BREAKER_DEFAULTS.maxCooldown),
+		name: z.coerce.string().default(LIMITER_CIRCUIT_BREAKER_DEFAULTS.name),
+	})
+	.strict()
+	.default(LIMITER_CIRCUIT_BREAKER_DEFAULTS);
+
+/**
+ * Limiter Retry configuration for limiter. derived from limitd-redis package
+ * https://github.com/auth0/limitd-redis/blob/03ba193fe436c5b887ff410d4f2623512ee5c9e2/lib/client.js#L22
+ */
+const limiterRetryConfig = z
+	.object({
+		retries: z.coerce.number().default(LIMITER_RETRY_DEFAULTS.retries),
+		minTimeout: z.coerce.number().default(LIMITER_RETRY_DEFAULTS.minTimeout),
+		maxTimeout: z.coerce.number().default(LIMITER_RETRY_DEFAULTS.maxTimeout),
+	})
+	.strict()
+	.default(LIMITER_RETRY_DEFAULTS);
+
 class Limiter {
 	// static defaultBuckets;
 	// static pickDefaultBuckets(keys) { ... };
@@ -53,7 +104,7 @@ class Limiter {
 	*/
 	connect() {
 		return new Promise((resolve, reject) => {
-			let buckets = this._config.buckets || {};
+let buckets = this._config.buckets || {};
 			buckets = {
 				...defaultBuckets,
 				...buckets,
@@ -64,6 +115,9 @@ class Limiter {
 					uri: this._config.limitdUrl,
 					buckets,
 					keyPrefix,
+					circuitbreaker: this._config.circuitbreaker,
+					commandTimeout: this._config.commandTimeout,
+					retry: this._config.retry,
 				});
 				connection.db.on('ready', () => {
 					return resolve(connection);
@@ -199,5 +253,7 @@ Limiter.pickDefaultBuckets = function pickDefaultBuckets(keyArray) {
 	}
 	return buckets;
 };
+Limiter.limiterCircuitBreakerConfig = limiterCircuitBreakerConfig;
+Limiter.limiterRetryConfig = limiterRetryConfig;
 
 module.exports = Limiter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@withjoy/limiter",
-  "version": "0.1.3",
+  "version": "0.1.4-test",
   "description": "Api Rate limiter",
   "main": "limiter.js",
   "scripts": {
@@ -10,7 +10,8 @@
   "author": "services@withjoy.com",
   "license": "MIT",
   "dependencies": {
-    "limitd-redis": "^5.1.1"
+    "limitd-redis": "file:./limitd-redis",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "jest": "^24.9.0"