@aomex/rate-limit 3.8.0 → 3.9.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/CHANGELOG.md +16 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +4 -5
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,22 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [3.9.0](https://github.com/aomex/aomex/compare/v3.8.1...v3.9.0) (2024-10-30)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @aomex/rate-limit
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## [3.8.1](https://github.com/aomex/aomex/compare/v3.8.0...v3.8.1) (2024-10-26)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @aomex/rate-limit
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
6
22
|
# [3.8.0](https://github.com/aomex/aomex/compare/v3.7.2...v3.8.0) (2024-10-26)
|
|
7
23
|
|
|
8
24
|
**Note:** Version bump only for package @aomex/rate-limit
|
package/dist/index.js
CHANGED
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/rate-limit.ts","../src/store.ts","../src/memory-store.ts"],"sourcesContent":["import { middleware } from '@aomex/
|
|
1
|
+
{"version":3,"sources":["../src/rate-limit.ts","../src/store.ts","../src/memory-store.ts"],"sourcesContent":["import { middleware } from '@aomex/common';\nimport { statuses, type WebContext, type WebMiddleware } from '@aomex/web';\nimport type { RateLimitStore } from './store';\nimport { RateLimitMemoryStore } from './memory-store';\n\nexport interface RateLimitOptions {\n /**\n * 存储和共享请求记录。默认值:`RateLimitMemoryStore`\n */\n store?: RateLimitStore;\n\n /**\n * 限速时间周期。单位:`ms`。默认值:`3600 * 1000`(1小时)\n */\n duration?: number;\n\n /**\n * 一个客户端(根据id字段)在一个时间周期内的最大可请求数量\n */\n maxRequest?: 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\nexport const rateLimit = (options: RateLimitOptions = {}): WebMiddleware => {\n const {\n store = new RateLimitMemoryStore(),\n duration = 3600 * 1_000, // 1小时\n maxRequest = 2500,\n id: getId = (ctx) => ctx.request.ip,\n headers: headerNames = {},\n denyList = () => false,\n allowList = () => false,\n } = options;\n\n return middleware.web(async (ctx, next) => {\n if (await denyList(ctx)) ctx.throw(403, 'denied');\n\n const id = getId(ctx);\n if (id === false || (await allowList(ctx))) return next();\n\n const state = await store.getAndSet({\n key: `aomex-rate-limit:${id}`,\n maxRequest,\n duration,\n });\n\n const headers: Record<string, number> = {};\n if (headerNames !== false) {\n headers[headerNames.remaining || 'X-RateLimit-Remaining'] = Math.max(\n 0,\n state.remaining - 1,\n );\n headers[headerNames.reset || 'X-RateLimit-Reset'] = Math.floor(\n state.resetAt / 1_000_000,\n );\n headers[headerNames.total || 'X-RateLimit-Limit'] = maxRequest;\n ctx.response.setHeaders(headers);\n }\n\n if (state.remaining) return next();\n\n headers['Retry-After'] = Math.round((state.resetAt / 1000 - Date.now()) / 1000);\n ctx.throw(429, options.errorMessage || statuses.message[429], { headers });\n });\n};\n","const time = Date.now() * 1e3;\nconst start = process.hrtime.bigint();\n\nexport abstract class RateLimitStore {\n abstract getAndSet(data: {\n key: string;\n maxRequest: number;\n duration: number;\n }): Promise<RateLimitState>;\n\n protected getMicroTime() {\n return time + Number(process.hrtime.bigint() - start) * 1e-3;\n }\n}\n\nexport interface RateLimitState {\n /**\n * 标识\n */\n key: string;\n /**\n * 重置的具体时间戳,单位:`us`\n */\n resetAt: number;\n /**\n * 剩余可用请求次数\n */\n remaining: number;\n}\n","import { RateLimitStore, type RateLimitState } from './store';\n\nexport class RateLimitMemoryStore extends RateLimitStore {\n private store = new Map<string, { expires: number; records: number[] }>();\n\n override async getAndSet(data: {\n key: string;\n maxRequest: number;\n duration: number;\n }): Promise<RateLimitState> {\n const { key, maxRequest, duration } = data;\n const now = this.getMicroTime();\n const durationMicro = duration * 1_000;\n const startTime = now - durationMicro;\n\n let result = this.store.get(key);\n if (!result || result.expires < now) {\n this.store.set(key, (result = { expires: now + durationMicro, records: [] }));\n }\n\n result.records = result.records.filter((record) => record >= startTime);\n const usedCount = result.records.length;\n result.records.push(now);\n result.records = result.records.slice(-maxRequest);\n result.expires = now + durationMicro;\n\n const remaining = Math.max(maxRequest - usedCount, 0);\n const resetAt = Math.floor(result.records[0]! + durationMicro);\n\n return { key, remaining, resetAt };\n }\n}\n"],"mappings":";AAAA,SAAS,kBAAkB;AAC3B,SAAS,gBAAqD;;;ACD9D,IAAM,OAAO,KAAK,IAAI,IAAI;AAC1B,IAAM,QAAQ,QAAQ,OAAO,OAAO;AAE7B,IAAe,iBAAf,MAA8B;AAAA,EAOzB,eAAe;AACvB,WAAO,OAAO,OAAO,QAAQ,OAAO,OAAO,IAAI,KAAK,IAAI;AAAA,EAC1D;AACF;;;ACXO,IAAM,uBAAN,cAAmC,eAAe;AAAA,EAC/C,QAAQ,oBAAI,IAAoD;AAAA,EAExE,MAAe,UAAU,MAIG;AAC1B,UAAM,EAAE,KAAK,YAAY,SAAS,IAAI;AACtC,UAAM,MAAM,KAAK,aAAa;AAC9B,UAAM,gBAAgB,WAAW;AACjC,UAAM,YAAY,MAAM;AAExB,QAAI,SAAS,KAAK,MAAM,IAAI,GAAG;AAC/B,QAAI,CAAC,UAAU,OAAO,UAAU,KAAK;AACnC,WAAK,MAAM,IAAI,KAAM,SAAS,EAAE,SAAS,MAAM,eAAe,SAAS,CAAC,EAAE,CAAE;AAAA,IAC9E;AAEA,WAAO,UAAU,OAAO,QAAQ,OAAO,CAAC,WAAW,UAAU,SAAS;AACtE,UAAM,YAAY,OAAO,QAAQ;AACjC,WAAO,QAAQ,KAAK,GAAG;AACvB,WAAO,UAAU,OAAO,QAAQ,MAAM,CAAC,UAAU;AACjD,WAAO,UAAU,MAAM;AAEvB,UAAM,YAAY,KAAK,IAAI,aAAa,WAAW,CAAC;AACpD,UAAM,UAAU,KAAK,MAAM,OAAO,QAAQ,CAAC,IAAK,aAAa;AAE7D,WAAO,EAAE,KAAK,WAAW,QAAQ;AAAA,EACnC;AACF;;;AF+BO,IAAM,YAAY,CAAC,UAA4B,CAAC,MAAqB;AAC1E,QAAM;AAAA,IACJ,QAAQ,IAAI,qBAAqB;AAAA,IACjC,WAAW,OAAO;AAAA;AAAA,IAClB,aAAa;AAAA,IACb,IAAI,QAAQ,CAAC,QAAQ,IAAI,QAAQ;AAAA,IACjC,SAAS,cAAc,CAAC;AAAA,IACxB,WAAW,MAAM;AAAA,IACjB,YAAY,MAAM;AAAA,EACpB,IAAI;AAEJ,SAAO,WAAW,IAAI,OAAO,KAAK,SAAS;AACzC,QAAI,MAAM,SAAS,GAAG,EAAG,KAAI,MAAM,KAAK,QAAQ;AAEhD,UAAM,KAAK,MAAM,GAAG;AACpB,QAAI,OAAO,SAAU,MAAM,UAAU,GAAG,EAAI,QAAO,KAAK;AAExD,UAAM,QAAQ,MAAM,MAAM,UAAU;AAAA,MAClC,KAAK,oBAAoB,EAAE;AAAA,MAC3B;AAAA,MACA;AAAA,IACF,CAAC;AAED,UAAM,UAAkC,CAAC;AACzC,QAAI,gBAAgB,OAAO;AACzB,cAAQ,YAAY,aAAa,uBAAuB,IAAI,KAAK;AAAA,QAC/D;AAAA,QACA,MAAM,YAAY;AAAA,MACpB;AACA,cAAQ,YAAY,SAAS,mBAAmB,IAAI,KAAK;AAAA,QACvD,MAAM,UAAU;AAAA,MAClB;AACA,cAAQ,YAAY,SAAS,mBAAmB,IAAI;AACpD,UAAI,SAAS,WAAW,OAAO;AAAA,IACjC;AAEA,QAAI,MAAM,UAAW,QAAO,KAAK;AAEjC,YAAQ,aAAa,IAAI,KAAK,OAAO,MAAM,UAAU,MAAO,KAAK,IAAI,KAAK,GAAI;AAC9E,QAAI,MAAM,KAAK,QAAQ,gBAAgB,SAAS,QAAQ,GAAG,GAAG,EAAE,QAAQ,CAAC;AAAA,EAC3E,CAAC;AACH;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aomex/rate-limit",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.9.0",
|
|
4
4
|
"description": "请求限速",
|
|
5
5
|
"repository": "git@github.com:aomex/aomex.git",
|
|
6
6
|
"homepage": "https://aomex.js.org",
|
|
@@ -29,13 +29,12 @@
|
|
|
29
29
|
"node": "^20.13.0 || ^22"
|
|
30
30
|
},
|
|
31
31
|
"peerDependencies": {
|
|
32
|
-
"@aomex/
|
|
32
|
+
"@aomex/common": "^3.0.0",
|
|
33
33
|
"@aomex/web": "^3.0.0"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
|
-
"@aomex/
|
|
37
|
-
"@aomex/
|
|
38
|
-
"@aomex/web": "^3.8.0"
|
|
36
|
+
"@aomex/common": "^3.9.0",
|
|
37
|
+
"@aomex/web": "^3.9.0"
|
|
39
38
|
},
|
|
40
39
|
"scripts": {}
|
|
41
40
|
}
|