@aomex/rate-limit 0.0.26 → 0.0.27

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/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @aomex/rate-limit
2
2
 
3
+ ## 0.0.27
4
+
5
+ ### Patch Changes
6
+
7
+ - [`00bafbb`](https://github.com/aomex/aomex/commit/00bafbbac2d32205b63a6bf561fb0a69c38a54bb) Thanks [@geekact](https://github.com/geekact)! - refactor(core): 缓存迁移到新的包@aomex/internal-cache
8
+
9
+ - [`8becf8e`](https://github.com/aomex/aomex/commit/8becf8ee5ef86a5909783d0654e536db7be9bf5b) Thanks [@geekact](https://github.com/geekact)! - refactor(core): 工具移动到新的包@aomex/internal-tools
10
+
11
+ - Updated dependencies [[`00bafbb`](https://github.com/aomex/aomex/commit/00bafbbac2d32205b63a6bf561fb0a69c38a54bb), [`8becf8e`](https://github.com/aomex/aomex/commit/8becf8ee5ef86a5909783d0654e536db7be9bf5b), [`0776719`](https://github.com/aomex/aomex/commit/077671963401f1dafb5b03722899452d45df13fc), [`f996bf7`](https://github.com/aomex/aomex/commit/f996bf7e529e7751a5e858c579feed33f5f02d65)]:
12
+ - @aomex/memory-cache@0.0.27
13
+ - @aomex/core@0.0.27
14
+ - @aomex/web@0.0.28
15
+ - @aomex/internal-tools@0.0.27
16
+
3
17
  ## 0.0.26
4
18
 
5
19
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -1,13 +1,13 @@
1
- import { Cache } from '@aomex/core';
1
+ import { Caching } from '@aomex/core';
2
2
  import { WebContext, WebMiddleware } from '@aomex/web';
3
3
 
4
4
  interface RateLimitOptions {
5
5
  /**
6
6
  * 存储和共享请求记录。默认值:`MemoryCache`
7
7
  */
8
- driver?: Cache;
8
+ driver?: Caching;
9
9
  /**
10
- * 限速时间周期。默认值:`3600 * 1000`ms
10
+ * 限速时间周期。默认值:`3600 * 1000`(1小时)
11
11
  */
12
12
  duration?: number;
13
13
  /**
package/dist/index.js CHANGED
@@ -1,5 +1,6 @@
1
1
  // src/index.ts
2
- import { middleware, MemoryCache } from "@aomex/core";
2
+ import { middleware } from "@aomex/core";
3
+ import { MemoryCache } from "@aomex/memory-cache";
3
4
  import microtime from "microtime";
4
5
  import ms from "ms";
5
6
  var getState = async (cache, id, max, duration) => {
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { middleware, Cache, MemoryCache } from '@aomex/core';\nimport type { WebContext, WebMiddleware } from '@aomex/web';\nimport microtime from 'microtime';\nimport ms from 'ms';\n\nexport interface RateLimitOptions {\n /**\n * 存储和共享请求记录。默认值:`MemoryCache`\n */\n driver?: Cache;\n\n /**\n * 限速时间周期。默认值:`3600 * 1000`ms\n */\n duration?: number;\n\n /**\n * 一个客户端(根据id字段)在一个时间周期内的最大可请求数量\n */\n max?: number;\n\n /**\n * 请求客户端的身份识别信息,默认使用客户端的IP地址。如果返回`false`,则代表该请求不需要限速\n */\n id?: (ctx: WebContext) => string | false;\n\n /**\n * 被限速(状态码:429)时响应的报错信息\n */\n errorMessage?: string;\n\n /**\n * 相关的响应头部名称。如果传入`false`,则代表不设置\n */\n headers?:\n | false\n | {\n /**\n * 指定时间段内剩下的请求次数。默认名称:`X-RateLimit-Remaining`\n */\n remaining?: string;\n\n /**\n * 以UTC秒为单位,限流重置之前的剩余时间。默认名称:`X-RateLimit-Reset`\n */\n reset?: string;\n\n /**\n * 指定时间内允许的最大请求次数。默认名称:`X-RateLimit-Limit`\n */\n total?: string;\n };\n\n /**\n * 白名单,不做请求频率限制\n */\n allowList?: (ctx: WebContext) => boolean | Promise<boolean>;\n\n /**\n * 黑名单,直接抛出`403`状态码\n */\n denyList?: (ctx: WebContext) => boolean | Promise<boolean>;\n}\n\ninterface LimitState {\n id: string;\n reset: number;\n current: number;\n total: number;\n}\n\nconst getState = async (\n cache: Cache,\n id: string,\n max: number,\n duration: number,\n) => {\n const key = `ratelimit:${id}`;\n let state = await cache.get<LimitState>(key);\n const now = microtime.now();\n const expired = state && state.reset * 1e6 < now;\n\n if (!state || expired) {\n state = {\n id,\n reset: (now + duration * 1e3) / 1e6,\n current: max,\n total: max,\n };\n } else {\n state.current = state.current > 0 ? state.current - 1 : 0;\n }\n\n await cache.set(key, state);\n return state!;\n};\n\nexport const rateLimit = (options: RateLimitOptions = {}): WebMiddleware => {\n const {\n driver: cache = new MemoryCache(),\n duration = 3600 * 1000, // 1 hour\n max = 2500,\n id: getId = (ctx) => ctx.request.ip,\n headers: headerNames = {},\n denyList,\n allowList,\n } = options;\n\n return middleware.web(async (ctx, next) => {\n if (denyList && (await denyList(ctx))) {\n ctx.throw(403);\n }\n\n const id = getId(ctx);\n if (id === false || (allowList && (await allowList(ctx)))) {\n return next();\n }\n\n const { response } = ctx;\n const state = await getState(cache, id, max, duration);\n let headers: Record<string, number> = {};\n if (headerNames !== false) {\n const {\n remaining = 'X-RateLimit-Remaining',\n reset = 'X-RateLimit-Reset',\n total = 'X-RateLimit-Limit',\n } = headerNames;\n\n headers = {\n [remaining]: state.current > 0 ? state.current - 1 : 0,\n [reset]: state.reset,\n [total]: state.total,\n };\n response.setHeaders(headers);\n }\n\n if (state.current) return next();\n\n const now = Date.now();\n const delta = Math.round(state.reset * 1e3 - now);\n const body =\n options.errorMessage ||\n `Rate limit exceeded, retry in ${ms(delta, { long: true })}.`;\n\n headers['Retry-After'] = Math.round(state.reset - now / 1e3);\n ctx.throw(429, body, { headers });\n });\n};\n"],"mappings":";AAAA,SAAS,YAAmB,mBAAmB;AAE/C,OAAO,eAAe;AACtB,OAAO,QAAQ;AAoEf,IAAM,WAAW,OACf,OACA,IACA,KACA,aACG;AACH,QAAM,MAAM,aAAa,EAAE;AAC3B,MAAI,QAAQ,MAAM,MAAM,IAAgB,GAAG;AAC3C,QAAM,MAAM,UAAU,IAAI;AAC1B,QAAM,UAAU,SAAS,MAAM,QAAQ,MAAM;AAE7C,MAAI,CAAC,SAAS,SAAS;AACrB,YAAQ;AAAA,MACN;AAAA,MACA,QAAQ,MAAM,WAAW,OAAO;AAAA,MAChC,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,EACF,OAAO;AACL,UAAM,UAAU,MAAM,UAAU,IAAI,MAAM,UAAU,IAAI;AAAA,EAC1D;AAEA,QAAM,MAAM,IAAI,KAAK,KAAK;AAC1B,SAAO;AACT;AAEO,IAAM,YAAY,CAAC,UAA4B,CAAC,MAAqB;AAC1E,QAAM;AAAA,IACJ,QAAQ,QAAQ,IAAI,YAAY;AAAA,IAChC,WAAW,OAAO;AAAA;AAAA,IAClB,MAAM;AAAA,IACN,IAAI,QAAQ,CAAC,QAAQ,IAAI,QAAQ;AAAA,IACjC,SAAS,cAAc,CAAC;AAAA,IACxB;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,SAAO,WAAW,IAAI,OAAO,KAAK,SAAS;AACzC,QAAI,YAAa,MAAM,SAAS,GAAG,GAAI;AACrC,UAAI,MAAM,GAAG;AAAA,IACf;AAEA,UAAM,KAAK,MAAM,GAAG;AACpB,QAAI,OAAO,SAAU,aAAc,MAAM,UAAU,GAAG,GAAK;AACzD,aAAO,KAAK;AAAA,IACd;AAEA,UAAM,EAAE,SAAS,IAAI;AACrB,UAAM,QAAQ,MAAM,SAAS,OAAO,IAAI,KAAK,QAAQ;AACrD,QAAI,UAAkC,CAAC;AACvC,QAAI,gBAAgB,OAAO;AACzB,YAAM;AAAA,QACJ,YAAY;AAAA,QACZ,QAAQ;AAAA,QACR,QAAQ;AAAA,MACV,IAAI;AAEJ,gBAAU;AAAA,QACR,CAAC,SAAS,GAAG,MAAM,UAAU,IAAI,MAAM,UAAU,IAAI;AAAA,QACrD,CAAC,KAAK,GAAG,MAAM;AAAA,QACf,CAAC,KAAK,GAAG,MAAM;AAAA,MACjB;AACA,eAAS,WAAW,OAAO;AAAA,IAC7B;AAEA,QAAI,MAAM;AAAS,aAAO,KAAK;AAE/B,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,QAAQ,KAAK,MAAM,MAAM,QAAQ,MAAM,GAAG;AAChD,UAAM,OACJ,QAAQ,gBACR,iCAAiC,GAAG,OAAO,EAAE,MAAM,KAAK,CAAC,CAAC;AAE5D,YAAQ,aAAa,IAAI,KAAK,MAAM,MAAM,QAAQ,MAAM,GAAG;AAC3D,QAAI,MAAM,KAAK,MAAM,EAAE,QAAQ,CAAC;AAAA,EAClC,CAAC;AACH;","names":[]}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { middleware, Caching } from '@aomex/core';\nimport type { WebContext, WebMiddleware } from '@aomex/web';\nimport { MemoryCache } from '@aomex/memory-cache';\nimport microtime from 'microtime';\nimport ms from 'ms';\n\nexport interface RateLimitOptions {\n /**\n * 存储和共享请求记录。默认值:`MemoryCache`\n */\n driver?: Caching;\n\n /**\n * 限速时间周期。默认值:`3600 * 1000`(1小时)\n */\n duration?: number;\n\n /**\n * 一个客户端(根据id字段)在一个时间周期内的最大可请求数量\n */\n max?: number;\n\n /**\n * 请求客户端的身份识别信息,默认使用客户端的IP地址。如果返回`false`,则代表该请求不需要限速\n */\n id?: (ctx: WebContext) => string | false;\n\n /**\n * 被限速(状态码:429)时响应的报错信息\n */\n errorMessage?: string;\n\n /**\n * 相关的响应头部名称。如果传入`false`,则代表不设置\n */\n headers?:\n | false\n | {\n /**\n * 指定时间段内剩下的请求次数。默认名称:`X-RateLimit-Remaining`\n */\n remaining?: string;\n /**\n * 以UTC秒为单位,限流重置之前的剩余时间。默认名称:`X-RateLimit-Reset`\n */\n reset?: string;\n /**\n * 指定时间内允许的最大请求次数。默认名称:`X-RateLimit-Limit`\n */\n total?: string;\n };\n\n /**\n * 白名单,不做请求频率限制\n */\n allowList?: (ctx: WebContext) => boolean | Promise<boolean>;\n\n /**\n * 黑名单,直接抛出`403`状态码\n */\n denyList?: (ctx: WebContext) => boolean | Promise<boolean>;\n}\n\ninterface LimitState {\n id: string;\n reset: number;\n current: number;\n total: number;\n}\n\nconst getState = async (\n cache: Caching,\n id: string,\n max: number,\n duration: number,\n) => {\n const key = `ratelimit:${id}`;\n let state = await cache.get<LimitState>(key);\n const now = microtime.now();\n const expired = state && state.reset * 1e6 < now;\n\n if (!state || expired) {\n state = {\n id,\n reset: (now + duration * 1e3) / 1e6,\n current: max,\n total: max,\n };\n } else {\n state.current = state.current > 0 ? state.current - 1 : 0;\n }\n\n await cache.set(key, state);\n return state!;\n};\n\nexport const rateLimit = (options: RateLimitOptions = {}): WebMiddleware => {\n const {\n driver: cache = new MemoryCache(),\n duration = 3600 * 1000, // 1 hour\n max = 2500,\n id: getId = (ctx) => ctx.request.ip,\n headers: headerNames = {},\n denyList,\n allowList,\n } = options;\n\n return middleware.web(async (ctx, next) => {\n if (denyList && (await denyList(ctx))) {\n ctx.throw(403);\n }\n\n const id = getId(ctx);\n if (id === false || (allowList && (await allowList(ctx)))) {\n return next();\n }\n\n const { response } = ctx;\n const state = await getState(cache, id, max, duration);\n let headers: Record<string, number> = {};\n if (headerNames !== false) {\n const {\n remaining = 'X-RateLimit-Remaining',\n reset = 'X-RateLimit-Reset',\n total = 'X-RateLimit-Limit',\n } = headerNames;\n\n headers = {\n [remaining]: state.current > 0 ? state.current - 1 : 0,\n [reset]: state.reset,\n [total]: state.total,\n };\n response.setHeaders(headers);\n }\n\n if (state.current) return next();\n\n const now = Date.now();\n const delta = Math.round(state.reset * 1e3 - now);\n const body =\n options.errorMessage ||\n `Rate limit exceeded, retry in ${ms(delta, { long: true })}.`;\n\n headers['Retry-After'] = Math.round(state.reset - now / 1e3);\n ctx.throw(429, body, { headers });\n });\n};\n"],"mappings":";AAAA,SAAS,kBAA2B;AAEpC,SAAS,mBAAmB;AAC5B,OAAO,eAAe;AACtB,OAAO,QAAQ;AAkEf,IAAM,WAAW,OACf,OACA,IACA,KACA,aACG;AACH,QAAM,MAAM,aAAa,EAAE;AAC3B,MAAI,QAAQ,MAAM,MAAM,IAAgB,GAAG;AAC3C,QAAM,MAAM,UAAU,IAAI;AAC1B,QAAM,UAAU,SAAS,MAAM,QAAQ,MAAM;AAE7C,MAAI,CAAC,SAAS,SAAS;AACrB,YAAQ;AAAA,MACN;AAAA,MACA,QAAQ,MAAM,WAAW,OAAO;AAAA,MAChC,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,EACF,OAAO;AACL,UAAM,UAAU,MAAM,UAAU,IAAI,MAAM,UAAU,IAAI;AAAA,EAC1D;AAEA,QAAM,MAAM,IAAI,KAAK,KAAK;AAC1B,SAAO;AACT;AAEO,IAAM,YAAY,CAAC,UAA4B,CAAC,MAAqB;AAC1E,QAAM;AAAA,IACJ,QAAQ,QAAQ,IAAI,YAAY;AAAA,IAChC,WAAW,OAAO;AAAA;AAAA,IAClB,MAAM;AAAA,IACN,IAAI,QAAQ,CAAC,QAAQ,IAAI,QAAQ;AAAA,IACjC,SAAS,cAAc,CAAC;AAAA,IACxB;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,SAAO,WAAW,IAAI,OAAO,KAAK,SAAS;AACzC,QAAI,YAAa,MAAM,SAAS,GAAG,GAAI;AACrC,UAAI,MAAM,GAAG;AAAA,IACf;AAEA,UAAM,KAAK,MAAM,GAAG;AACpB,QAAI,OAAO,SAAU,aAAc,MAAM,UAAU,GAAG,GAAK;AACzD,aAAO,KAAK;AAAA,IACd;AAEA,UAAM,EAAE,SAAS,IAAI;AACrB,UAAM,QAAQ,MAAM,SAAS,OAAO,IAAI,KAAK,QAAQ;AACrD,QAAI,UAAkC,CAAC;AACvC,QAAI,gBAAgB,OAAO;AACzB,YAAM;AAAA,QACJ,YAAY;AAAA,QACZ,QAAQ;AAAA,QACR,QAAQ;AAAA,MACV,IAAI;AAEJ,gBAAU;AAAA,QACR,CAAC,SAAS,GAAG,MAAM,UAAU,IAAI,MAAM,UAAU,IAAI;AAAA,QACrD,CAAC,KAAK,GAAG,MAAM;AAAA,QACf,CAAC,KAAK,GAAG,MAAM;AAAA,MACjB;AACA,eAAS,WAAW,OAAO;AAAA,IAC7B;AAEA,QAAI,MAAM;AAAS,aAAO,KAAK;AAE/B,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,QAAQ,KAAK,MAAM,MAAM,QAAQ,MAAM,GAAG;AAChD,UAAM,OACJ,QAAQ,gBACR,iCAAiC,GAAG,OAAO,EAAE,MAAM,KAAK,CAAC,CAAC;AAE5D,YAAQ,aAAa,IAAI,KAAK,MAAM,MAAM,QAAQ,MAAM,GAAG;AAC3D,QAAI,MAAM,KAAK,MAAM,EAAE,QAAQ,CAAC;AAAA,EAClC,CAAC;AACH;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aomex/rate-limit",
3
- "version": "0.0.26",
3
+ "version": "0.0.27",
4
4
  "description": "Web request rate limit",
5
5
  "repository": "git@github.com:aomex/aomex.git",
6
6
  "homepage": "https://aomex.js.org",
@@ -26,16 +26,18 @@
26
26
  "access": "public"
27
27
  },
28
28
  "peerDependencies": {
29
- "@aomex/core": "^0.0.26",
30
- "@aomex/web": "^0.0.27"
29
+ "@aomex/core": "^0.0.27",
30
+ "@aomex/web": "^0.0.28"
31
31
  },
32
32
  "dependencies": {
33
33
  "microtime": "^3.1.1",
34
- "ms": "^2.1.3"
34
+ "ms": "^2.1.3",
35
+ "@aomex/internal-tools": "^0.0.27",
36
+ "@aomex/memory-cache": "^0.0.27"
35
37
  },
36
38
  "devDependencies": {
37
- "@aomex/core": "^0.0.26",
38
- "@aomex/web": "^0.0.27",
39
+ "@aomex/core": "^0.0.27",
40
+ "@aomex/web": "^0.0.28",
39
41
  "@types/microtime": "^2.1.0",
40
42
  "@types/ms": "^0.7.31"
41
43
  },