limitly 1.0.2 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +471 -22
- package/dist/algorithms/concurrency.d.ts +11 -0
- package/dist/algorithms/concurrency.d.ts.map +1 -0
- package/dist/algorithms/concurrency.js +19 -0
- package/dist/algorithms/concurrency.js.map +1 -0
- package/dist/algorithms/factory.d.ts +3 -2
- package/dist/algorithms/factory.d.ts.map +1 -1
- package/dist/algorithms/factory.js +9 -3
- package/dist/algorithms/factory.js.map +1 -1
- package/dist/algorithms/gcra.d.ts +10 -0
- package/dist/algorithms/gcra.d.ts.map +1 -0
- package/dist/algorithms/gcra.js +15 -0
- package/dist/algorithms/gcra.js.map +1 -0
- package/dist/algorithms/sliding-window.d.ts +4 -4
- package/dist/algorithms/sliding-window.d.ts.map +1 -1
- package/dist/algorithms/sliding-window.js +3 -23
- package/dist/algorithms/sliding-window.js.map +1 -1
- package/dist/algorithms/token-bucket.d.ts +4 -4
- package/dist/algorithms/token-bucket.d.ts.map +1 -1
- package/dist/algorithms/token-bucket.js +3 -20
- package/dist/algorithms/token-bucket.js.map +1 -1
- package/dist/index.d.ts +19 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +46 -1
- package/dist/index.js.map +1 -1
- package/dist/limiter.d.ts +23 -7
- package/dist/limiter.d.ts.map +1 -1
- package/dist/limiter.js +86 -16
- package/dist/limiter.js.map +1 -1
- package/dist/middleware/bun.d.ts +9 -0
- package/dist/middleware/bun.d.ts.map +1 -0
- package/dist/middleware/bun.js +107 -0
- package/dist/middleware/bun.js.map +1 -0
- package/dist/middleware/express.d.ts.map +1 -1
- package/dist/middleware/express.js +30 -14
- package/dist/middleware/express.js.map +1 -1
- package/dist/middleware/fastify.d.ts +3 -3
- package/dist/middleware/fastify.d.ts.map +1 -1
- package/dist/middleware/fastify.js +34 -17
- package/dist/middleware/fastify.js.map +1 -1
- package/dist/middleware/hono.d.ts +5 -0
- package/dist/middleware/hono.d.ts.map +1 -0
- package/dist/middleware/hono.js +71 -0
- package/dist/middleware/hono.js.map +1 -0
- package/dist/middleware/koa.d.ts +5 -0
- package/dist/middleware/koa.d.ts.map +1 -0
- package/dist/middleware/koa.js +65 -0
- package/dist/middleware/koa.js.map +1 -0
- package/dist/middleware/nest.d.ts +14 -0
- package/dist/middleware/nest.d.ts.map +1 -0
- package/dist/middleware/nest.js +112 -0
- package/dist/middleware/nest.js.map +1 -0
- package/dist/observability/index.d.ts +4 -0
- package/dist/observability/index.d.ts.map +1 -0
- package/dist/observability/index.js +10 -0
- package/dist/observability/index.js.map +1 -0
- package/dist/observability/opentelemetry.d.ts +28 -0
- package/dist/observability/opentelemetry.d.ts.map +1 -0
- package/dist/observability/opentelemetry.js +85 -0
- package/dist/observability/opentelemetry.js.map +1 -0
- package/dist/observability/prometheus.d.ts +27 -0
- package/dist/observability/prometheus.d.ts.map +1 -0
- package/dist/observability/prometheus.js +88 -0
- package/dist/observability/prometheus.js.map +1 -0
- package/dist/observability/types.d.ts +9 -0
- package/dist/observability/types.d.ts.map +1 -0
- package/dist/observability/types.js +3 -0
- package/dist/observability/types.js.map +1 -0
- package/dist/prometheus.d.ts +3 -0
- package/dist/prometheus.d.ts.map +1 -0
- package/dist/prometheus.js +9 -0
- package/dist/prometheus.js.map +1 -0
- package/dist/scripts/concurrencyAcquire.lua +34 -0
- package/dist/scripts/concurrencyRelease.lua +9 -0
- package/dist/scripts/gcra.lua +38 -0
- package/dist/stores/factory.d.ts +5 -0
- package/dist/stores/factory.d.ts.map +1 -0
- package/dist/stores/factory.js +40 -0
- package/dist/stores/factory.js.map +1 -0
- package/dist/stores/memcached-store.d.ts +16 -0
- package/dist/stores/memcached-store.d.ts.map +1 -0
- package/dist/stores/memcached-store.js +211 -0
- package/dist/stores/memcached-store.js.map +1 -0
- package/dist/stores/redis-store.d.ts +19 -0
- package/dist/stores/redis-store.d.ts.map +1 -0
- package/dist/stores/redis-store.js +97 -0
- package/dist/stores/redis-store.js.map +1 -0
- package/dist/stores/types.d.ts +11 -0
- package/dist/stores/types.d.ts.map +1 -0
- package/dist/stores/types.js +3 -0
- package/dist/stores/types.js.map +1 -0
- package/dist/types/index.d.ts +94 -5
- package/dist/types/index.d.ts.map +1 -1
- package/dist/utils/defaults.d.ts +8 -0
- package/dist/utils/defaults.d.ts.map +1 -0
- package/dist/utils/defaults.js +100 -0
- package/dist/utils/defaults.js.map +1 -0
- package/dist/utils/limit-execution.d.ts +40 -0
- package/dist/utils/limit-execution.d.ts.map +1 -0
- package/dist/utils/limit-execution.js +50 -0
- package/dist/utils/limit-execution.js.map +1 -0
- package/dist/utils/memcached.d.ts +12 -0
- package/dist/utils/memcached.d.ts.map +1 -0
- package/dist/utils/memcached.js +103 -0
- package/dist/utils/memcached.js.map +1 -0
- package/dist/utils/metrics.d.ts +21 -0
- package/dist/utils/metrics.d.ts.map +1 -0
- package/dist/utils/metrics.js +99 -0
- package/dist/utils/metrics.js.map +1 -0
- package/dist/utils/redis.d.ts +5 -1
- package/dist/utils/redis.d.ts.map +1 -1
- package/dist/utils/redis.js +38 -3
- package/dist/utils/redis.js.map +1 -1
- package/dist/utils/scripts.d.ts +16 -2
- package/dist/utils/scripts.d.ts.map +1 -1
- package/dist/utils/scripts.js +79 -33
- package/dist/utils/scripts.js.map +1 -1
- package/package.json +86 -3
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.createMemcachedClient = createMemcachedClient;
|
|
7
|
+
exports.memcachedGet = memcachedGet;
|
|
8
|
+
exports.memcachedGets = memcachedGets;
|
|
9
|
+
exports.memcachedIncr = memcachedIncr;
|
|
10
|
+
exports.memcachedDecr = memcachedDecr;
|
|
11
|
+
exports.memcachedAdd = memcachedAdd;
|
|
12
|
+
exports.memcachedCas = memcachedCas;
|
|
13
|
+
const memcached_1 = __importDefault(require("memcached"));
|
|
14
|
+
function createMemcachedClient(config) {
|
|
15
|
+
if (isMemcachedClient(config)) {
|
|
16
|
+
return config;
|
|
17
|
+
}
|
|
18
|
+
if (typeof config === "string" || Array.isArray(config)) {
|
|
19
|
+
return new memcached_1.default(config);
|
|
20
|
+
}
|
|
21
|
+
return new memcached_1.default(config.servers, config.options);
|
|
22
|
+
}
|
|
23
|
+
function isMemcachedClient(config) {
|
|
24
|
+
return (typeof config === "object" &&
|
|
25
|
+
config !== null &&
|
|
26
|
+
"incr" in config &&
|
|
27
|
+
typeof config.incr === "function");
|
|
28
|
+
}
|
|
29
|
+
function memcachedGet(client, key) {
|
|
30
|
+
return new Promise((resolve, reject) => {
|
|
31
|
+
client.get(key, (err, data) => {
|
|
32
|
+
if (err) {
|
|
33
|
+
reject(err);
|
|
34
|
+
return;
|
|
35
|
+
}
|
|
36
|
+
resolve(data?.toString());
|
|
37
|
+
});
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
function memcachedGets(client, key) {
|
|
41
|
+
return new Promise((resolve, reject) => {
|
|
42
|
+
client.gets(key, (err, data) => {
|
|
43
|
+
if (err) {
|
|
44
|
+
reject(err);
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
if (!data?.value) {
|
|
48
|
+
resolve(undefined);
|
|
49
|
+
return;
|
|
50
|
+
}
|
|
51
|
+
resolve({ value: data.value.toString(), cas: String(data.cas) });
|
|
52
|
+
});
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
function memcachedIncr(client, key, amount = 1) {
|
|
56
|
+
return new Promise((resolve, reject) => {
|
|
57
|
+
client.incr(key, amount, (err, result) => {
|
|
58
|
+
if (err) {
|
|
59
|
+
reject(err);
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
resolve(Number(result));
|
|
63
|
+
});
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
function memcachedDecr(client, key, amount = 1) {
|
|
67
|
+
return new Promise((resolve, reject) => {
|
|
68
|
+
client.decr(key, amount, (err, result) => {
|
|
69
|
+
if (err) {
|
|
70
|
+
reject(err);
|
|
71
|
+
return;
|
|
72
|
+
}
|
|
73
|
+
resolve(Number(result));
|
|
74
|
+
});
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
function memcachedAdd(client, key, value, ttl) {
|
|
78
|
+
return new Promise((resolve, reject) => {
|
|
79
|
+
client.add(key, value, ttl, (err) => {
|
|
80
|
+
if (err && err.code !== "EEXIST") {
|
|
81
|
+
reject(err);
|
|
82
|
+
return;
|
|
83
|
+
}
|
|
84
|
+
resolve();
|
|
85
|
+
});
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
function memcachedCas(client, key, value, cas, ttl) {
|
|
89
|
+
return new Promise((resolve, reject) => {
|
|
90
|
+
client.cas(key, value, cas, ttl, (err) => {
|
|
91
|
+
if (err) {
|
|
92
|
+
if (err.code === "EEXIST") {
|
|
93
|
+
resolve(false);
|
|
94
|
+
return;
|
|
95
|
+
}
|
|
96
|
+
reject(err);
|
|
97
|
+
return;
|
|
98
|
+
}
|
|
99
|
+
resolve(true);
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
//# sourceMappingURL=memcached.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"memcached.js","sourceRoot":"","sources":["../../src/utils/memcached.ts"],"names":[],"mappings":";;;;;AAGA,sDAUC;AAWD,oCAaC;AAED,sCAiBC;AAED,sCAcC;AAED,sCAcC;AAED,oCAeC;AAED,oCAoBC;AA/HD,0DAAkC;AAGlC,SAAgB,qBAAqB,CAAC,MAAuB;IAC3D,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,OAAO,IAAI,mBAAS,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,IAAI,mBAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAuB;IAChD,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,MAAM,IAAI,MAAM;QAChB,OAAQ,MAA0B,CAAC,IAAI,KAAK,UAAU,CACvD,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAsB,EAAE,IAAwB,EAAE,EAAE;YACnE,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAsB,EAAE,IAAsC,EAAE,EAAE;YAClF,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;gBACjB,OAAO,CAAC,SAAS,CAAC,CAAC;gBACnB,OAAO;YACT,CAAC;YACD,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,GAAW,EACX,MAAM,GAAG,CAAC;IAEV,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAsB,EAAE,MAAyB,EAAE,EAAE;YAC7E,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,GAAW,EACX,MAAM,GAAG,CAAC;IAEV,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAsB,EAAE,MAAyB,EAAE,EAAE;YAC7E,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW,EACX,KAAa,EACb,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,GAAsC,EAAE,EAAE;YACrE,IAAI,GAAG,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC5D,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW,EACX,KAAa,EACb,GAAW,EACX,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,GAAsC,EAAE,EAAE;YAC1E,IAAI,GAAG,EAAE,CAAC;gBACR,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACrD,OAAO,CAAC,KAAK,CAAC,CAAC;oBACf,OAAO;gBACT,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { MiddlewareOptions, RateLimitResult, RateLimitStrategy, StoreType } from "../types";
|
|
2
|
+
export type RateLimitCheckOutcome = {
|
|
3
|
+
status: "allowed";
|
|
4
|
+
result: RateLimitResult;
|
|
5
|
+
} | {
|
|
6
|
+
status: "blocked";
|
|
7
|
+
result: RateLimitResult;
|
|
8
|
+
} | {
|
|
9
|
+
status: "error";
|
|
10
|
+
error: unknown;
|
|
11
|
+
failOpen: boolean;
|
|
12
|
+
};
|
|
13
|
+
export declare function consumeRateLimit(params: {
|
|
14
|
+
strategy: RateLimitStrategy;
|
|
15
|
+
key: string;
|
|
16
|
+
options: MiddlewareOptions;
|
|
17
|
+
failOpen: boolean;
|
|
18
|
+
storeType?: StoreType;
|
|
19
|
+
context?: unknown;
|
|
20
|
+
}): Promise<RateLimitCheckOutcome>;
|
|
21
|
+
//# sourceMappingURL=metrics.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../src/utils/metrics.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,iBAAiB,EAGjB,eAAe,EACf,iBAAiB,EACjB,SAAS,EACV,MAAM,UAAU,CAAC;AAElB,MAAM,MAAM,qBAAqB,GAC7B;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAC;AA2E3D,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAwDjC"}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.consumeRateLimit = consumeRateLimit;
|
|
4
|
+
function getAlgorithm(options) {
|
|
5
|
+
return options.algorithm;
|
|
6
|
+
}
|
|
7
|
+
async function emitMetrics(hooks, event) {
|
|
8
|
+
if (!hooks) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
const handlers = Array.isArray(hooks) ? hooks : [hooks];
|
|
12
|
+
await Promise.all(handlers.map((hook) => hook(event)));
|
|
13
|
+
}
|
|
14
|
+
function startTraceSpan(options, params) {
|
|
15
|
+
const tracer = options.tracer;
|
|
16
|
+
if (!tracer) {
|
|
17
|
+
return undefined;
|
|
18
|
+
}
|
|
19
|
+
const attributes = {
|
|
20
|
+
"limitly.algorithm": params.algorithm,
|
|
21
|
+
};
|
|
22
|
+
if (params.storeType) {
|
|
23
|
+
attributes["limitly.store"] = params.storeType;
|
|
24
|
+
}
|
|
25
|
+
return tracer.startSpan("limitly.check", attributes);
|
|
26
|
+
}
|
|
27
|
+
function finishTraceSpan(span, params) {
|
|
28
|
+
if (!span) {
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
span.setAttribute("limitly.outcome", params.outcome);
|
|
32
|
+
if (params.result) {
|
|
33
|
+
span.setAttribute("limitly.limit", params.result.limit);
|
|
34
|
+
span.setAttribute("limitly.remaining", params.result.remaining);
|
|
35
|
+
span.setAttribute("limitly.allowed", params.result.allowed);
|
|
36
|
+
}
|
|
37
|
+
if (params.error) {
|
|
38
|
+
const message = params.error instanceof Error ? params.error.message : String(params.error);
|
|
39
|
+
span.setStatus(false, message);
|
|
40
|
+
}
|
|
41
|
+
else if (params.outcome === "error") {
|
|
42
|
+
span.setStatus(false, "rate limit store error");
|
|
43
|
+
}
|
|
44
|
+
else {
|
|
45
|
+
span.setStatus(true);
|
|
46
|
+
}
|
|
47
|
+
span.end();
|
|
48
|
+
}
|
|
49
|
+
async function consumeRateLimit(params) {
|
|
50
|
+
const { strategy, key, options, failOpen, storeType, context } = params;
|
|
51
|
+
const algorithm = getAlgorithm(options);
|
|
52
|
+
const startedAt = performance.now();
|
|
53
|
+
const span = startTraceSpan(options, { algorithm, key, storeType });
|
|
54
|
+
try {
|
|
55
|
+
const result = await strategy.consume(key);
|
|
56
|
+
const durationMs = performance.now() - startedAt;
|
|
57
|
+
const outcome = result.allowed ? "allowed" : "blocked";
|
|
58
|
+
finishTraceSpan(span, { outcome, result });
|
|
59
|
+
await emitMetrics(options.onMetrics, {
|
|
60
|
+
type: outcome,
|
|
61
|
+
key,
|
|
62
|
+
algorithm,
|
|
63
|
+
result,
|
|
64
|
+
durationMs,
|
|
65
|
+
store: storeType,
|
|
66
|
+
context,
|
|
67
|
+
});
|
|
68
|
+
return {
|
|
69
|
+
status: outcome,
|
|
70
|
+
result,
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
catch (error) {
|
|
74
|
+
const durationMs = performance.now() - startedAt;
|
|
75
|
+
finishTraceSpan(span, { outcome: "error", error });
|
|
76
|
+
await emitMetrics(options.onMetrics, {
|
|
77
|
+
type: "error",
|
|
78
|
+
key,
|
|
79
|
+
algorithm,
|
|
80
|
+
error,
|
|
81
|
+
durationMs,
|
|
82
|
+
failOpen,
|
|
83
|
+
store: storeType,
|
|
84
|
+
context,
|
|
85
|
+
});
|
|
86
|
+
if (failOpen) {
|
|
87
|
+
await emitMetrics(options.onMetrics, {
|
|
88
|
+
type: "fail_open",
|
|
89
|
+
key,
|
|
90
|
+
algorithm,
|
|
91
|
+
durationMs,
|
|
92
|
+
store: storeType,
|
|
93
|
+
context,
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
return { status: "error", error, failOpen };
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=metrics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../src/utils/metrics.ts"],"names":[],"mappings":";;AAyFA,4CA+DC;AAxID,SAAS,YAAY,CAAC,OAA0B;IAC9C,OAAO,OAAO,CAAC,SAAS,CAAC;AAC3B,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,KAAgE,EAChE,KAA4B;IAE5B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,cAAc,CACrB,OAA0B,EAC1B,MAIC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAA8C;QAC5D,mBAAmB,EAAE,MAAM,CAAC,SAAS;KACtC,CAAC;IAEF,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,UAAU,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,eAAe,CACtB,IAA+B,EAC/B,MAIC;IAED,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO;IACT,CAAC;IAED,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAErD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxD,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,OAAO,GACX,MAAM,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9E,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;SAAM,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;IAClD,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAED,IAAI,CAAC,GAAG,EAAE,CAAC;AACb,CAAC;AAEM,KAAK,UAAU,gBAAgB,CAAC,MAOtC;IACC,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACxE,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QACjD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAEvD,eAAe,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAE3C,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;YACnC,IAAI,EAAE,OAAO;YACb,GAAG;YACH,SAAS;YACT,MAAM;YACN,UAAU;YACV,KAAK,EAAE,SAAS;YAChB,OAAO;SACR,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,OAAO;YACf,MAAM;SACP,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAEjD,eAAe,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAEnD,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;YACnC,IAAI,EAAE,OAAO;YACb,GAAG;YACH,SAAS;YACT,KAAK;YACL,UAAU;YACV,QAAQ;YACR,KAAK,EAAE,SAAS;YAChB,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;gBACnC,IAAI,EAAE,WAAW;gBACjB,GAAG;gBACH,SAAS;gBACT,UAAU;gBACV,KAAK,EAAE,SAAS;gBAChB,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC9C,CAAC;AACH,CAAC"}
|
package/dist/utils/redis.d.ts
CHANGED
|
@@ -1,4 +1,8 @@
|
|
|
1
|
+
import { Cluster, type ClusterOptions } from "ioredis";
|
|
1
2
|
import type { RedisClient, RedisConfig } from "../types";
|
|
3
|
+
export declare const DEFAULT_KEY_PREFIX = "limitly";
|
|
4
|
+
export declare const DEFAULT_CLUSTER_OPTIONS: ClusterOptions;
|
|
5
|
+
export declare function isRedisCluster(client: RedisClient): client is Cluster;
|
|
2
6
|
export declare function createRedisClient(config: RedisConfig): RedisClient;
|
|
3
|
-
export declare function buildKey(prefix: string, key: string): string;
|
|
7
|
+
export declare function buildKey(prefix: string, key: string, hashTag?: string): string;
|
|
4
8
|
//# sourceMappingURL=redis.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../../src/utils/redis.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../../src/utils/redis.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGzD,eAAO,MAAM,kBAAkB,YAAY,CAAC;AAE5C,eAAO,MAAM,uBAAuB,EAAE,cAWrC,CAAC;AAEF,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,IAAI,OAAO,CAErE;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CA0BlE;AAiBD,wBAAgB,QAAQ,CACtB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,GACf,MAAM,CAQR"}
|
package/dist/utils/redis.js
CHANGED
|
@@ -33,9 +33,28 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
33
33
|
};
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
+
exports.DEFAULT_CLUSTER_OPTIONS = exports.DEFAULT_KEY_PREFIX = void 0;
|
|
37
|
+
exports.isRedisCluster = isRedisCluster;
|
|
36
38
|
exports.createRedisClient = createRedisClient;
|
|
37
39
|
exports.buildKey = buildKey;
|
|
38
40
|
const ioredis_1 = __importStar(require("ioredis"));
|
|
41
|
+
const scripts_1 = require("./scripts");
|
|
42
|
+
exports.DEFAULT_KEY_PREFIX = "limitly";
|
|
43
|
+
exports.DEFAULT_CLUSTER_OPTIONS = {
|
|
44
|
+
scaleReads: "master",
|
|
45
|
+
enableReadyCheck: true,
|
|
46
|
+
maxRedirections: 16,
|
|
47
|
+
retryDelayOnFailover: 100,
|
|
48
|
+
retryDelayOnClusterDown: 300,
|
|
49
|
+
slotsRefreshTimeout: 2000,
|
|
50
|
+
enableAutoPipelining: true,
|
|
51
|
+
redisOptions: {
|
|
52
|
+
maxRetriesPerRequest: null,
|
|
53
|
+
},
|
|
54
|
+
};
|
|
55
|
+
function isRedisCluster(client) {
|
|
56
|
+
return client instanceof ioredis_1.Cluster || client.isCluster === true;
|
|
57
|
+
}
|
|
39
58
|
function createRedisClient(config) {
|
|
40
59
|
if (isRedisClient(config)) {
|
|
41
60
|
return config;
|
|
@@ -44,7 +63,19 @@ function createRedisClient(config) {
|
|
|
44
63
|
return new ioredis_1.default(config);
|
|
45
64
|
}
|
|
46
65
|
if (isClusterConfig(config)) {
|
|
47
|
-
|
|
66
|
+
const { nodes, options } = config;
|
|
67
|
+
return new ioredis_1.Cluster(nodes, {
|
|
68
|
+
...exports.DEFAULT_CLUSTER_OPTIONS,
|
|
69
|
+
...options,
|
|
70
|
+
scripts: {
|
|
71
|
+
...(0, scripts_1.getClusterScriptDefinitions)(),
|
|
72
|
+
...options?.scripts,
|
|
73
|
+
},
|
|
74
|
+
redisOptions: {
|
|
75
|
+
...exports.DEFAULT_CLUSTER_OPTIONS.redisOptions,
|
|
76
|
+
...options?.redisOptions,
|
|
77
|
+
},
|
|
78
|
+
});
|
|
48
79
|
}
|
|
49
80
|
return new ioredis_1.default(config);
|
|
50
81
|
}
|
|
@@ -57,7 +88,11 @@ function isClusterConfig(config) {
|
|
|
57
88
|
"nodes" in config &&
|
|
58
89
|
Array.isArray(config.nodes));
|
|
59
90
|
}
|
|
60
|
-
function buildKey(prefix, key) {
|
|
61
|
-
|
|
91
|
+
function buildKey(prefix, key, hashTag) {
|
|
92
|
+
const namespaced = `${prefix}:${key}`;
|
|
93
|
+
if (!hashTag) {
|
|
94
|
+
return namespaced;
|
|
95
|
+
}
|
|
96
|
+
return `{${hashTag}}:${namespaced}`;
|
|
62
97
|
}
|
|
63
98
|
//# sourceMappingURL=redis.js.map
|
package/dist/utils/redis.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../src/utils/redis.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../src/utils/redis.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBA,wCAEC;AAED,8CA0BC;AAiBD,4BAYC;AA9ED,mDAA8D;AAE9D,uCAAwD;AAE3C,QAAA,kBAAkB,GAAG,SAAS,CAAC;AAE/B,QAAA,uBAAuB,GAAmB;IACrD,UAAU,EAAE,QAAQ;IACpB,gBAAgB,EAAE,IAAI;IACtB,eAAe,EAAE,EAAE;IACnB,oBAAoB,EAAE,GAAG;IACzB,uBAAuB,EAAE,GAAG;IAC5B,mBAAmB,EAAE,IAAI;IACzB,oBAAoB,EAAE,IAAI;IAC1B,YAAY,EAAE;QACZ,oBAAoB,EAAE,IAAI;KAC3B;CACF,CAAC;AAEF,SAAgB,cAAc,CAAC,MAAmB;IAChD,OAAO,MAAM,YAAY,iBAAO,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC;AAChE,CAAC;AAED,SAAgB,iBAAiB,CAAC,MAAmB;IACnD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,IAAI,iBAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,iBAAO,CAAC,KAAK,EAAE;YACxB,GAAG,+BAAuB;YAC1B,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,IAAA,qCAA2B,GAAE;gBAChC,GAAG,OAAO,EAAE,OAAO;aACpB;YACD,YAAY,EAAE;gBACZ,GAAG,+BAAuB,CAAC,YAAY;gBACvC,GAAG,OAAO,EAAE,YAAY;aACzB;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,iBAAK,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,aAAa,CAAC,MAAmB;IACxC,OAAO,MAAM,YAAY,iBAAK,IAAI,MAAM,YAAY,iBAAO,CAAC;AAC9D,CAAC;AAED,SAAS,eAAe,CACtB,MAAmB;IAEnB,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,OAAO,IAAI,MAAM;QACjB,KAAK,CAAC,OAAO,CAAE,MAA6B,CAAC,KAAK,CAAC,CACpD,CAAC;AACJ,CAAC;AAED,SAAgB,QAAQ,CACtB,MAAc,EACd,GAAW,EACX,OAAgB;IAEhB,MAAM,UAAU,GAAG,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;IAEtC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;AACtC,CAAC"}
|
package/dist/utils/scripts.d.ts
CHANGED
|
@@ -1,11 +1,25 @@
|
|
|
1
1
|
import type { RedisClient } from "../types";
|
|
2
|
-
export declare
|
|
3
|
-
|
|
2
|
+
export declare const SCRIPT_COMMANDS: {
|
|
3
|
+
readonly sliding: "limitlySliding";
|
|
4
|
+
readonly token: "limitlyToken";
|
|
5
|
+
readonly concurrencyAcquire: "limitlyConcurrencyAcquire";
|
|
6
|
+
readonly concurrencyRelease: "limitlyConcurrencyRelease";
|
|
7
|
+
readonly gcra: "limitlyGcra";
|
|
8
|
+
};
|
|
9
|
+
export type ScriptName = keyof typeof SCRIPT_COMMANDS;
|
|
10
|
+
export declare function getClusterScriptDefinitions(): Record<string, {
|
|
11
|
+
lua: string;
|
|
12
|
+
numberOfKeys: number;
|
|
13
|
+
}>;
|
|
14
|
+
export declare function registerRedisScripts(redis: RedisClient): void;
|
|
15
|
+
export declare function warmupRedisScripts(redis: RedisClient): Promise<void>;
|
|
16
|
+
export declare function evalScript(redis: RedisClient, name: ScriptName, keys: string[], args: (string | number)[]): Promise<(string | number)[]>;
|
|
4
17
|
export declare function parseScriptResult(result: (string | number)[]): {
|
|
5
18
|
allowed: boolean;
|
|
6
19
|
limit: number;
|
|
7
20
|
remaining: number;
|
|
8
21
|
reset: number;
|
|
9
22
|
retryAfter: number;
|
|
23
|
+
slotId?: string;
|
|
10
24
|
};
|
|
11
25
|
//# sourceMappingURL=scripts.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scripts.d.ts","sourceRoot":"","sources":["../../src/utils/scripts.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"scripts.d.ts","sourceRoot":"","sources":["../../src/utils/scripts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAM5C,eAAO,MAAM,eAAe;;;;;;CAMlB,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,eAAe,CAAC;AAiBtD,wBAAgB,2BAA2B,IAAI,MAAM,CACnD,MAAM,EACN;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CACtC,CAuBA;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,CAc7D;AAED,wBAAsB,kBAAkB,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAoB1E;AAmBD,wBAAsB,UAAU,CAC9B,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,MAAM,EAAE,EACd,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACxB,OAAO,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,CAK9B;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAC1B;IACD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAgBA"}
|
package/dist/utils/scripts.js
CHANGED
|
@@ -1,12 +1,26 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
3
|
+
exports.SCRIPT_COMMANDS = void 0;
|
|
4
|
+
exports.getClusterScriptDefinitions = getClusterScriptDefinitions;
|
|
5
|
+
exports.registerRedisScripts = registerRedisScripts;
|
|
6
|
+
exports.warmupRedisScripts = warmupRedisScripts;
|
|
4
7
|
exports.evalScript = evalScript;
|
|
5
8
|
exports.parseScriptResult = parseScriptResult;
|
|
6
9
|
const fs_1 = require("fs");
|
|
7
10
|
const path_1 = require("path");
|
|
11
|
+
const ioredis_1 = require("ioredis");
|
|
12
|
+
function isRedisCluster(client) {
|
|
13
|
+
return client instanceof ioredis_1.Cluster || client.isCluster === true;
|
|
14
|
+
}
|
|
15
|
+
exports.SCRIPT_COMMANDS = {
|
|
16
|
+
sliding: "limitlySliding",
|
|
17
|
+
token: "limitlyToken",
|
|
18
|
+
concurrencyAcquire: "limitlyConcurrencyAcquire",
|
|
19
|
+
concurrencyRelease: "limitlyConcurrencyRelease",
|
|
20
|
+
gcra: "limitlyGcra",
|
|
21
|
+
};
|
|
8
22
|
const scriptCache = new Map();
|
|
9
|
-
const
|
|
23
|
+
const registeredClients = new WeakSet();
|
|
10
24
|
function loadScript(name) {
|
|
11
25
|
const cached = scriptCache.get(name);
|
|
12
26
|
if (cached) {
|
|
@@ -17,50 +31,82 @@ function loadScript(name) {
|
|
|
17
31
|
scriptCache.set(name, script);
|
|
18
32
|
return script;
|
|
19
33
|
}
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
34
|
+
function getClusterScriptDefinitions() {
|
|
35
|
+
return {
|
|
36
|
+
[exports.SCRIPT_COMMANDS.sliding]: {
|
|
37
|
+
numberOfKeys: 1,
|
|
38
|
+
lua: loadScript("sliding"),
|
|
39
|
+
},
|
|
40
|
+
[exports.SCRIPT_COMMANDS.token]: {
|
|
41
|
+
numberOfKeys: 1,
|
|
42
|
+
lua: loadScript("token"),
|
|
43
|
+
},
|
|
44
|
+
[exports.SCRIPT_COMMANDS.concurrencyAcquire]: {
|
|
45
|
+
numberOfKeys: 1,
|
|
46
|
+
lua: loadScript("concurrencyAcquire"),
|
|
47
|
+
},
|
|
48
|
+
[exports.SCRIPT_COMMANDS.concurrencyRelease]: {
|
|
49
|
+
numberOfKeys: 1,
|
|
50
|
+
lua: loadScript("concurrencyRelease"),
|
|
51
|
+
},
|
|
52
|
+
[exports.SCRIPT_COMMANDS.gcra]: {
|
|
53
|
+
numberOfKeys: 1,
|
|
54
|
+
lua: loadScript("gcra"),
|
|
55
|
+
},
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
function registerRedisScripts(redis) {
|
|
59
|
+
if (registeredClients.has(redis)) {
|
|
60
|
+
return;
|
|
25
61
|
}
|
|
26
|
-
const
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
62
|
+
for (const name of Object.keys(exports.SCRIPT_COMMANDS)) {
|
|
63
|
+
const command = exports.SCRIPT_COMMANDS[name];
|
|
64
|
+
redis.defineCommand(command, {
|
|
65
|
+
numberOfKeys: 1,
|
|
66
|
+
lua: loadScript(name),
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
registeredClients.add(redis);
|
|
30
70
|
}
|
|
31
|
-
async function
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
return result;
|
|
71
|
+
async function warmupRedisScripts(redis) {
|
|
72
|
+
registerRedisScripts(redis);
|
|
73
|
+
if (!isRedisCluster(redis)) {
|
|
74
|
+
return;
|
|
36
75
|
}
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
const result = await redis.eval(script, keys.length, ...keys, ...args.map(String));
|
|
41
|
-
const newSha = (await redis.script("LOAD", script));
|
|
42
|
-
shaCache.set(getCacheKey(redis, name), newSha);
|
|
43
|
-
return result;
|
|
44
|
-
}
|
|
45
|
-
throw error;
|
|
76
|
+
const masters = redis.nodes("master");
|
|
77
|
+
if (masters.length === 0) {
|
|
78
|
+
return;
|
|
46
79
|
}
|
|
80
|
+
const definitions = getClusterScriptDefinitions();
|
|
81
|
+
await Promise.all(masters.flatMap((node) => Object.values(definitions).map((definition) => node.script("LOAD", definition.lua))));
|
|
47
82
|
}
|
|
48
|
-
function
|
|
49
|
-
const
|
|
50
|
-
|
|
83
|
+
function getScriptRunner(redis, name) {
|
|
84
|
+
const command = exports.SCRIPT_COMMANDS[name];
|
|
85
|
+
const runner = redis[command];
|
|
86
|
+
if (!runner) {
|
|
87
|
+
throw new Error(`Redis script command "${command}" is not registered`);
|
|
88
|
+
}
|
|
89
|
+
return runner.bind(redis);
|
|
51
90
|
}
|
|
52
|
-
function
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
91
|
+
async function evalScript(redis, name, keys, args) {
|
|
92
|
+
registerRedisScripts(redis);
|
|
93
|
+
const runner = getScriptRunner(redis, name);
|
|
94
|
+
const result = await runner(...keys, ...args);
|
|
95
|
+
return result;
|
|
56
96
|
}
|
|
57
97
|
function parseScriptResult(result) {
|
|
58
|
-
|
|
98
|
+
const parsed = {
|
|
59
99
|
allowed: Number(result[0]) === 1,
|
|
60
100
|
limit: Number(result[1]),
|
|
61
101
|
remaining: Number(result[2]),
|
|
62
102
|
reset: Number(result[3]),
|
|
63
103
|
retryAfter: Number(result[4]),
|
|
104
|
+
slotId: undefined,
|
|
64
105
|
};
|
|
106
|
+
const slotId = result[5];
|
|
107
|
+
if (parsed.allowed && slotId !== undefined && String(slotId).length > 0) {
|
|
108
|
+
parsed.slotId = String(slotId);
|
|
109
|
+
}
|
|
110
|
+
return parsed;
|
|
65
111
|
}
|
|
66
112
|
//# sourceMappingURL=scripts.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scripts.js","sourceRoot":"","sources":["../../src/utils/scripts.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"scripts.js","sourceRoot":"","sources":["../../src/utils/scripts.ts"],"names":[],"mappings":";;;AAkCA,kEA0BC;AAED,oDAcC;AAED,gDAoBC;AAmBD,gCAUC;AAED,8CAyBC;AA1JD,2BAAkC;AAClC,+BAA4B;AAC5B,qCAAkC;AAGlC,SAAS,cAAc,CAAC,MAAmB;IACzC,OAAO,MAAM,YAAY,iBAAO,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC;AAChE,CAAC;AAEY,QAAA,eAAe,GAAG;IAC7B,OAAO,EAAE,gBAAgB;IACzB,KAAK,EAAE,cAAc;IACrB,kBAAkB,EAAE,2BAA2B;IAC/C,kBAAkB,EAAE,2BAA2B;IAC/C,IAAI,EAAE,aAAa;CACX,CAAC;AAIX,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;AAC9C,MAAM,iBAAiB,GAAG,IAAI,OAAO,EAAU,CAAC;AAEhD,SAAS,UAAU,CAAC,IAAgB;IAClC,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC;IACnE,MAAM,MAAM,GAAG,IAAA,iBAAY,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACjD,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,2BAA2B;IAIzC,OAAO;QACL,CAAC,uBAAe,CAAC,OAAO,CAAC,EAAE;YACzB,YAAY,EAAE,CAAC;YACf,GAAG,EAAE,UAAU,CAAC,SAAS,CAAC;SAC3B;QACD,CAAC,uBAAe,CAAC,KAAK,CAAC,EAAE;YACvB,YAAY,EAAE,CAAC;YACf,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC;SACzB;QACD,CAAC,uBAAe,CAAC,kBAAkB,CAAC,EAAE;YACpC,YAAY,EAAE,CAAC;YACf,GAAG,EAAE,UAAU,CAAC,oBAAoB,CAAC;SACtC;QACD,CAAC,uBAAe,CAAC,kBAAkB,CAAC,EAAE;YACpC,YAAY,EAAE,CAAC;YACf,GAAG,EAAE,UAAU,CAAC,oBAAoB,CAAC;SACtC;QACD,CAAC,uBAAe,CAAC,IAAI,CAAC,EAAE;YACtB,YAAY,EAAE,CAAC;YACf,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC;SACxB;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAAkB;IACrD,IAAI,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,uBAAe,CAAiB,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,uBAAe,CAAC,IAAI,CAAC,CAAC;QACtC,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE;YAC3B,YAAY,EAAE,CAAC;YACf,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC;SACtB,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAEM,KAAK,UAAU,kBAAkB,CAAC,KAAkB;IACzD,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,MAAM,WAAW,GAAG,2BAA2B,EAAE,CAAC;IAClD,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACvB,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAC5C,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,CACpC,CACF,CACF,CAAC;AACJ,CAAC;AAMD,SAAS,eAAe,CAAC,KAAkB,EAAE,IAAgB;IAC3D,MAAM,OAAO,GAAG,uBAAe,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,MAAM,GAAI,KAA6D,CAC3E,OAAO,CACR,CAAC;IAEF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,OAAO,qBAAqB,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAiB,CAAC;AAC5C,CAAC;AAEM,KAAK,UAAU,UAAU,CAC9B,KAAkB,EAClB,IAAgB,EAChB,IAAc,EACd,IAAyB;IAEzB,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,iBAAiB,CAC/B,MAA2B;IAS3B,MAAM,MAAM,GAAG;QACb,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAChC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC5B,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,EAAE,SAA+B;KACxC,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
|