@terreno/api 57.2.0 → 57.3.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.
Files changed (277) hide show
  1. package/README.md +17 -7
  2. package/dist/actions.js +19 -7
  3. package/dist/api.d.ts +4 -0
  4. package/dist/api.js +12 -24
  5. package/dist/auth.d.ts +23 -10
  6. package/dist/auth.js +97 -32
  7. package/dist/authRecovery.d.ts +5 -0
  8. package/dist/authRecovery.js +350 -0
  9. package/dist/authTokens.d.ts +8 -0
  10. package/dist/authTokens.js +162 -0
  11. package/dist/betterAuth.d.ts +33 -0
  12. package/dist/betterAuthApp.d.ts +4 -0
  13. package/dist/betterAuthApp.js +26 -8
  14. package/dist/betterAuthSetup.d.ts +44 -2
  15. package/dist/betterAuthSetup.js +288 -18
  16. package/dist/collectionRegistry.d.ts +38 -0
  17. package/dist/collectionRegistry.js +72 -0
  18. package/dist/configurationApp.d.ts +11 -2
  19. package/dist/configurationApp.js +2 -4
  20. package/dist/docLoader.js +35 -6
  21. package/dist/expressServer.d.ts +26 -3
  22. package/dist/expressServer.js +79 -11
  23. package/dist/index.d.ts +16 -0
  24. package/dist/index.js +38 -2
  25. package/dist/mcp/auth.d.ts +1 -0
  26. package/dist/mcp/auth.js +47 -25
  27. package/dist/mcp/handlers.d.ts +1 -1
  28. package/dist/mcp/handlers.js +67 -233
  29. package/dist/mcp/query.d.ts +2 -2
  30. package/dist/mcp/registry.d.ts +1 -5
  31. package/dist/mcp/registry.js +31 -20
  32. package/dist/mcp/schemaGenerator.d.ts +2 -7
  33. package/dist/mcp/schemaGenerator.js +41 -116
  34. package/dist/mcp/server.d.ts +1 -0
  35. package/dist/mcp/server.js +1 -0
  36. package/dist/mcp/serviceTokens.d.ts +16 -0
  37. package/dist/mcp/serviceTokens.js +345 -0
  38. package/dist/mcp/types.d.ts +2 -2
  39. package/dist/models/mcpServiceToken.d.ts +3 -0
  40. package/dist/models/mcpServiceToken.js +208 -0
  41. package/dist/openApiBuilder.d.ts +5 -4
  42. package/dist/openApiBuilder.js +61 -8
  43. package/dist/openApiCompat.js +1 -1
  44. package/dist/openApiValidator.js +0 -2
  45. package/dist/plugins.d.ts +14 -1
  46. package/dist/plugins.js +17 -6
  47. package/dist/populate.d.ts +2 -2
  48. package/dist/populate.js +47 -42
  49. package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
  50. package/dist/rateLimit/applyTrustProxy.js +17 -0
  51. package/dist/rateLimit/createStore.d.ts +2 -0
  52. package/dist/rateLimit/createStore.js +28 -0
  53. package/dist/rateLimit/memoryStore.d.ts +2 -0
  54. package/dist/rateLimit/memoryStore.js +108 -0
  55. package/dist/rateLimit/middleware.d.ts +11 -0
  56. package/dist/rateLimit/middleware.js +110 -0
  57. package/dist/rateLimit/mongoStore.d.ts +3 -0
  58. package/dist/rateLimit/mongoStore.js +122 -0
  59. package/dist/rateLimit/policies.d.ts +14 -0
  60. package/dist/rateLimit/policies.js +151 -0
  61. package/dist/rateLimit/redisStore.d.ts +3 -0
  62. package/dist/rateLimit/redisStore.js +155 -0
  63. package/dist/rateLimit/types.d.ts +54 -0
  64. package/dist/rateLimit/types.js +9 -0
  65. package/dist/rbac/access.js +5 -1
  66. package/dist/rbac/assertAllowed.d.ts +9 -0
  67. package/dist/rbac/assertAllowed.js +182 -0
  68. package/dist/rbac/modelRouterAccess.d.ts +1 -0
  69. package/dist/rbac/modelRouterAccess.js +8 -4
  70. package/dist/rbac/permissionUtils.js +3 -2
  71. package/dist/rbac/resolve.js +5 -4
  72. package/dist/rbac/routes.js +15 -6
  73. package/dist/realtime/deprecation.d.ts +12 -0
  74. package/dist/realtime/deprecation.js +32 -0
  75. package/dist/realtime/realtimeApp.d.ts +1 -1
  76. package/dist/realtime/realtimeApp.js +10 -11
  77. package/dist/realtime/registry.d.ts +0 -31
  78. package/dist/realtime/registry.js +44 -31
  79. package/dist/realtime/socketAuth.d.ts +5 -5
  80. package/dist/realtime/socketAuth.js +11 -1
  81. package/dist/realtime/socketUser.d.ts +5 -1
  82. package/dist/realtime/types.d.ts +14 -4
  83. package/dist/schemaMetadata.d.ts +56 -0
  84. package/dist/schemaMetadata.js +513 -0
  85. package/dist/seedRunner.d.ts +88 -0
  86. package/dist/seedRunner.js +627 -0
  87. package/dist/sync/executors.d.ts +12 -2
  88. package/dist/sync/executors.js +8 -10
  89. package/dist/sync/loadHarness.js +28 -19
  90. package/dist/sync/models.js +26 -24
  91. package/dist/sync/mutationHandler.d.ts +9 -0
  92. package/dist/sync/mutationHandler.js +11 -6
  93. package/dist/sync/registrationSideEffects.d.ts +35 -0
  94. package/dist/sync/registrationSideEffects.js +151 -0
  95. package/dist/sync/registry.d.ts +2 -52
  96. package/dist/sync/registry.js +38 -187
  97. package/dist/sync/routes.js +3 -2
  98. package/dist/sync/scripts/compactTombstones.js +0 -2
  99. package/dist/sync/syncApp.d.ts +3 -3
  100. package/dist/sync/syncApp.js +4 -4
  101. package/dist/sync/syncBatch.js +3 -2
  102. package/dist/sync/syncSeqPlugin.d.ts +1 -1
  103. package/dist/sync/syncSeqPlugin.js +20 -16
  104. package/dist/terrenoApp.d.ts +19 -5
  105. package/dist/terrenoApp.js +66 -18
  106. package/dist/tests/models.d.ts +2 -0
  107. package/dist/tests/models.js +6 -0
  108. package/dist/types/authToken.d.ts +33 -0
  109. package/dist/types/authToken.js +2 -0
  110. package/dist/types/mcpServiceToken.d.ts +41 -0
  111. package/dist/types/mcpServiceToken.js +2 -0
  112. package/dist/webhooks/headerValue.d.ts +2 -0
  113. package/dist/webhooks/headerValue.js +14 -0
  114. package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
  115. package/dist/webhooks/idempotency/memoryStore.js +65 -0
  116. package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
  117. package/dist/webhooks/idempotency/mongoStore.js +150 -0
  118. package/dist/webhooks/idempotency/webhookReceipt.d.ts +62 -0
  119. package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
  120. package/dist/webhooks/rawBody.d.ts +14 -0
  121. package/dist/webhooks/rawBody.js +22 -0
  122. package/dist/webhooks/timingSafeEqual.d.ts +4 -0
  123. package/dist/webhooks/timingSafeEqual.js +17 -0
  124. package/dist/webhooks/verifiers/hmac.d.ts +15 -0
  125. package/dist/webhooks/verifiers/hmac.js +49 -0
  126. package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
  127. package/dist/webhooks/verifiers/sendgrid.js +56 -0
  128. package/dist/webhooks/verifiers/stripe.d.ts +9 -0
  129. package/dist/webhooks/verifiers/stripe.js +99 -0
  130. package/dist/webhooks/verifiers/twilio.d.ts +9 -0
  131. package/dist/webhooks/verifiers/twilio.js +112 -0
  132. package/dist/webhooks/webhooksApp.d.ts +33 -0
  133. package/dist/webhooks/webhooksApp.js +195 -0
  134. package/package.json +4 -5
  135. package/src/__snapshots__/openApi.test.ts.snap +270 -0
  136. package/src/__snapshots__/openApiBuilder.test.ts.snap +30 -12
  137. package/src/__snapshots__/schemaMetadata.test.ts.snap +197 -0
  138. package/src/actions.ts +20 -13
  139. package/src/adminModelRouter.test.ts +133 -0
  140. package/src/api.arrayOperations.test.ts +43 -31
  141. package/src/api.hooks.test.ts +38 -29
  142. package/src/api.query.test.ts +31 -31
  143. package/src/api.test.ts +95 -96
  144. package/src/api.ts +16 -27
  145. package/src/auth.test.ts +107 -51
  146. package/src/auth.ts +98 -29
  147. package/src/authRecovery.test.ts +281 -0
  148. package/src/authRecovery.ts +279 -0
  149. package/src/authTokens.test.ts +94 -0
  150. package/src/authTokens.ts +118 -0
  151. package/src/authVerification.test.ts +293 -0
  152. package/src/betterAuth.ts +24 -0
  153. package/src/betterAuthApp.test.ts +1 -0
  154. package/src/betterAuthApp.ts +27 -9
  155. package/src/betterAuthSetup.test.ts +568 -38
  156. package/src/betterAuthSetup.ts +260 -5
  157. package/src/collectionRegistry.test.ts +165 -0
  158. package/src/collectionRegistry.ts +115 -0
  159. package/src/configurationApp.ts +13 -7
  160. package/src/docLoader.test.ts +45 -1
  161. package/src/docLoader.ts +37 -6
  162. package/src/express.d.ts +1 -0
  163. package/src/expressServer.test.ts +130 -66
  164. package/src/expressServer.ts +75 -19
  165. package/src/githubAuth.test.ts +60 -55
  166. package/src/index.ts +58 -0
  167. package/src/mcp/auth.test.ts +47 -0
  168. package/src/mcp/auth.ts +32 -11
  169. package/src/mcp/handlers.ts +45 -172
  170. package/src/mcp/integration.test.ts +59 -9
  171. package/src/mcp/query.ts +2 -4
  172. package/src/mcp/registry.ts +29 -20
  173. package/src/mcp/schemaGenerator.test.ts +8 -0
  174. package/src/mcp/schemaGenerator.ts +49 -131
  175. package/src/mcp/server.ts +2 -0
  176. package/src/mcp/serviceTokens.test.ts +330 -0
  177. package/src/mcp/serviceTokens.ts +307 -0
  178. package/src/mcp/toolGenerator.test.ts +1 -1
  179. package/src/mcp/types.ts +2 -6
  180. package/src/models/mcpServiceToken.test.ts +129 -0
  181. package/src/models/mcpServiceToken.ts +158 -0
  182. package/src/openApi.test.ts +80 -64
  183. package/src/openApiBuilder.test.ts +95 -7
  184. package/src/openApiBuilder.ts +46 -9
  185. package/src/openApiCompat.ts +1 -1
  186. package/src/openApiValidator.test.ts +49 -54
  187. package/src/openApiValidator.ts +1 -3
  188. package/src/plugins.test.ts +14 -0
  189. package/src/plugins.ts +34 -9
  190. package/src/populate.test.ts +34 -0
  191. package/src/populate.ts +40 -29
  192. package/src/rateLimit/applyTrustProxy.ts +17 -0
  193. package/src/rateLimit/createStore.ts +25 -0
  194. package/src/rateLimit/memoryStore.ts +40 -0
  195. package/src/rateLimit/middleware.ts +79 -0
  196. package/src/rateLimit/mongoStore.test.ts +80 -0
  197. package/src/rateLimit/mongoStore.ts +76 -0
  198. package/src/rateLimit/policies.ts +130 -0
  199. package/src/rateLimit/rateLimit.test.ts +328 -0
  200. package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
  201. package/src/rateLimit/redisStore.test.ts +114 -0
  202. package/src/rateLimit/redisStore.ts +85 -0
  203. package/src/rateLimit/types.ts +64 -0
  204. package/src/rbac/access.ts +5 -1
  205. package/src/rbac/assertAllowed.test.ts +325 -0
  206. package/src/rbac/assertAllowed.ts +157 -0
  207. package/src/rbac/backfillAdmins.test.ts +124 -0
  208. package/src/rbac/fieldViews.test.ts +89 -0
  209. package/src/rbac/modelRouterAccess.test.ts +126 -0
  210. package/src/rbac/modelRouterAccess.ts +5 -2
  211. package/src/rbac/permissionUtils.ts +3 -2
  212. package/src/rbac/realtimeAccess.test.ts +109 -1
  213. package/src/rbac/resolve.ts +5 -4
  214. package/src/rbac/roleManager.test.ts +169 -0
  215. package/src/rbac/routes.test.ts +233 -0
  216. package/src/rbac/routes.ts +16 -6
  217. package/src/realtime/deprecation.test.ts +60 -0
  218. package/src/realtime/deprecation.ts +32 -0
  219. package/src/realtime/realtime.test.ts +8 -4
  220. package/src/realtime/realtimeApp.ts +10 -11
  221. package/src/realtime/realtimeAppSetup.test.ts +32 -5
  222. package/src/realtime/registry.ts +48 -42
  223. package/src/realtime/sessionRevalidation.test.ts +57 -44
  224. package/src/realtime/socketAuth.test.ts +75 -23
  225. package/src/realtime/socketAuth.ts +17 -6
  226. package/src/realtime/socketUser.ts +5 -3
  227. package/src/realtime/types.ts +14 -4
  228. package/src/schemaMetadata.test.ts +405 -0
  229. package/src/schemaMetadata.ts +593 -0
  230. package/src/scrubAdminFields.test.ts +105 -0
  231. package/src/seedRunner.test.ts +591 -0
  232. package/src/seedRunner.ts +464 -0
  233. package/src/sync/docMatchesMutationData.test.ts +16 -0
  234. package/src/sync/ensureSyncIndexes.test.ts +54 -15
  235. package/src/sync/executors.test.ts +40 -0
  236. package/src/sync/executors.ts +24 -12
  237. package/src/sync/integration.test.ts +15 -7
  238. package/src/sync/loadHarness.ts +28 -19
  239. package/src/sync/models.ts +32 -18
  240. package/src/sync/mutationHandler.test.ts +16 -16
  241. package/src/sync/mutationHandler.ts +9 -7
  242. package/src/sync/registrationSideEffects.test.ts +126 -0
  243. package/src/sync/registrationSideEffects.ts +131 -0
  244. package/src/sync/registry.ts +45 -171
  245. package/src/sync/routes.ts +3 -2
  246. package/src/sync/scripts/compactTombstones.ts +0 -2
  247. package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
  248. package/src/sync/sync.test.ts +25 -23
  249. package/src/sync/syncApp.ts +4 -4
  250. package/src/sync/syncBatch.ts +3 -2
  251. package/src/sync/syncFrontier.test.ts +17 -15
  252. package/src/sync/syncPhaseC.test.ts +54 -43
  253. package/src/sync/syncRoutes.test.ts +51 -36
  254. package/src/sync/syncSeqPlugin.ts +66 -44
  255. package/src/sync/syncSocket.test.ts +112 -81
  256. package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
  257. package/src/terrenoApp.ts +87 -15
  258. package/src/tests/models.ts +14 -1
  259. package/src/types/authToken.ts +43 -0
  260. package/src/types/mcpServiceToken.ts +54 -0
  261. package/src/webhooks/headerValue.test.ts +22 -0
  262. package/src/webhooks/headerValue.ts +12 -0
  263. package/src/webhooks/idempotency/memoryStore.ts +34 -0
  264. package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
  265. package/src/webhooks/idempotency/mongoStore.ts +83 -0
  266. package/src/webhooks/idempotency/webhookReceipt.ts +70 -0
  267. package/src/webhooks/rawBody.test.ts +74 -0
  268. package/src/webhooks/rawBody.ts +23 -0
  269. package/src/webhooks/timingSafeEqual.ts +16 -0
  270. package/src/webhooks/verifiers/hmac.test.ts +110 -0
  271. package/src/webhooks/verifiers/hmac.ts +54 -0
  272. package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
  273. package/src/webhooks/verifiers/sendgrid.ts +59 -0
  274. package/src/webhooks/verifiers/stripe.ts +67 -0
  275. package/src/webhooks/verifiers/twilio.ts +69 -0
  276. package/src/webhooks/webhooksApp.test.ts +221 -0
  277. package/src/webhooks/webhooksApp.ts +144 -0
@@ -0,0 +1,40 @@
1
+ import type {RateLimitConsumeArgs, RateLimitConsumeResult, RateLimitStore} from "./types";
2
+
3
+ interface MemoryWindow {
4
+ count: number;
5
+ resetAt: number;
6
+ }
7
+
8
+ export const createMemoryRateLimitStore = (): RateLimitStore => {
9
+ const windows = new Map<string, MemoryWindow>();
10
+
11
+ const consume = async ({
12
+ key,
13
+ max,
14
+ windowMs,
15
+ now,
16
+ }: RateLimitConsumeArgs): Promise<RateLimitConsumeResult> => {
17
+ const existing = windows.get(key);
18
+ if (!existing || existing.resetAt <= now) {
19
+ if (windows.size > 10_000) {
20
+ for (const [windowKey, window] of windows) {
21
+ if (window.resetAt <= now) {
22
+ windows.delete(windowKey);
23
+ }
24
+ }
25
+ }
26
+ const resetAt = now + windowMs;
27
+ windows.set(key, {count: 1, resetAt});
28
+ return {allowed: true, remaining: Math.max(0, max - 1), resetAt};
29
+ }
30
+ existing.count += 1;
31
+ const allowed = existing.count <= max;
32
+ return {
33
+ allowed,
34
+ remaining: Math.max(0, max - existing.count),
35
+ resetAt: existing.resetAt,
36
+ };
37
+ };
38
+
39
+ return {consume};
40
+ };
@@ -0,0 +1,79 @@
1
+ import type {NextFunction, Request, Response} from "express";
2
+ import {DateTime} from "luxon";
3
+
4
+ import {APIError} from "../errors";
5
+ import {classifyRateLimitPolicy, rateLimitKey, shouldSkipRateLimit} from "./policies";
6
+ import type {RateLimitOptions, RateLimitStore} from "./types";
7
+ import {DEFAULT_API_MAX, DEFAULT_AUTH_MAX, DEFAULT_WINDOW_MS} from "./types";
8
+
9
+ const secondsUntil = (resetAt: number, now: number): number => {
10
+ return Math.max(1, Math.ceil((resetAt - now) / 1000));
11
+ };
12
+
13
+ export const setRateLimitExceededHeaders = ({
14
+ max,
15
+ remaining,
16
+ resetAt,
17
+ now,
18
+ windowMs,
19
+ res,
20
+ }: {
21
+ max: number;
22
+ remaining: number;
23
+ resetAt: number;
24
+ now: number;
25
+ windowMs: number;
26
+ res: Response;
27
+ }): void => {
28
+ const retryAfter = secondsUntil(resetAt, now);
29
+ const windowSec = Math.max(1, Math.ceil(windowMs / 1000));
30
+ res.setHeader("Retry-After", String(retryAfter));
31
+ res.setHeader("RateLimit", `limit=${max}, remaining=${remaining}, reset=${retryAfter}`);
32
+ res.setHeader("RateLimit-Policy", `${max};w=${windowSec}`);
33
+ };
34
+
35
+ export const createRateLimitMiddleware = (
36
+ store: RateLimitStore,
37
+ options: RateLimitOptions = {}
38
+ ): ((req: Request, res: Response, next: NextFunction) => Promise<void>) => {
39
+ const windowMs = options.limits?.windowMs ?? DEFAULT_WINDOW_MS;
40
+ const authMax = options.limits?.authMax ?? DEFAULT_AUTH_MAX;
41
+ const apiMax = options.limits?.apiMax ?? DEFAULT_API_MAX;
42
+ const betterAuthBasePath = options.betterAuthBasePath;
43
+ const nowFn = options.now ?? ((): number => DateTime.now().toMillis());
44
+
45
+ return async (req: Request, res: Response, next: NextFunction): Promise<void> => {
46
+ if (shouldSkipRateLimit(req, options.skip)) {
47
+ next();
48
+ return;
49
+ }
50
+ const policy = classifyRateLimitPolicy(req, betterAuthBasePath);
51
+ const max = policy === "auth" ? authMax : apiMax;
52
+ const key = `${policy}:${rateLimitKey(req, policy)}`;
53
+ const now = nowFn();
54
+ try {
55
+ const result = await store.consume({key, max, now, windowMs});
56
+ if (result.allowed) {
57
+ next();
58
+ return;
59
+ }
60
+ setRateLimitExceededHeaders({
61
+ max,
62
+ now,
63
+ remaining: result.remaining,
64
+ res,
65
+ resetAt: result.resetAt,
66
+ windowMs,
67
+ });
68
+ next(
69
+ new APIError({
70
+ code: "rate-limit-exceeded",
71
+ status: 429,
72
+ title: "Too many requests",
73
+ })
74
+ );
75
+ } catch (error) {
76
+ next(error);
77
+ }
78
+ };
79
+ };
@@ -0,0 +1,80 @@
1
+ import {beforeEach, describe, it} from "bun:test";
2
+ import {assert} from "chai";
3
+ import mongoose from "mongoose";
4
+
5
+ import {setupTestData} from "../tests";
6
+ import {createRateLimitStore} from "./createStore";
7
+ import {createMongoRateLimitStore, RATE_LIMIT_HITS_COLLECTION} from "./mongoStore";
8
+
9
+ describe("mongo rate limit store", () => {
10
+ beforeEach(async () => {
11
+ await setupTestData();
12
+ const db = mongoose.connection.db;
13
+ if (db) {
14
+ await db.collection(RATE_LIMIT_HITS_COLLECTION).deleteMany({});
15
+ }
16
+ });
17
+
18
+ it("isolates keys and resets after the window", async () => {
19
+ const store = createRateLimitStore({store: "mongo"});
20
+ const t0 = 1_000_000;
21
+ const a1 = await store.consume({key: "a", max: 2, now: t0, windowMs: 1000});
22
+ const a2 = await store.consume({key: "a", max: 2, now: t0 + 10, windowMs: 1000});
23
+ const a3 = await store.consume({key: "a", max: 2, now: t0 + 20, windowMs: 1000});
24
+ const b1 = await store.consume({key: "b", max: 2, now: t0, windowMs: 1000});
25
+ assert.isTrue(a1.allowed);
26
+ assert.isTrue(a2.allowed);
27
+ assert.isFalse(a3.allowed);
28
+ assert.isTrue(b1.allowed);
29
+ const after = await store.consume({key: "a", max: 2, now: t0 + 1001, windowMs: 1000});
30
+ assert.isTrue(after.allowed);
31
+ });
32
+
33
+ it("does not expose rateLimitHits as a modelRouter catalog path", () => {
34
+ const names = mongoose.modelNames();
35
+ assert.notInclude(names, RATE_LIMIT_HITS_COLLECTION);
36
+ assert.notInclude(names, "RateLimitHits");
37
+ });
38
+
39
+ it("creates a TTL index on expiresAt", async () => {
40
+ const store = createMongoRateLimitStore();
41
+ await store.consume({key: "idx", max: 1, now: 1, windowMs: 1000});
42
+ const db = mongoose.connection.db;
43
+ assert.ok(db);
44
+ const indexes = await db.collection(RATE_LIMIT_HITS_COLLECTION).indexes();
45
+ const ttl = indexes.find((index) => index.key.expiresAt === 1);
46
+ assert.ok(ttl);
47
+ assert.equal(ttl.expireAfterSeconds, 0);
48
+ });
49
+
50
+ it("throws APIError when mongoose has no open db", async () => {
51
+ const store = createMongoRateLimitStore();
52
+ const connection = mongoose.connection as {db?: unknown};
53
+ const previous = connection.db;
54
+ Object.defineProperty(mongoose.connection, "db", {
55
+ configurable: true,
56
+ value: undefined,
57
+ });
58
+ try {
59
+ await store.consume({key: "none", max: 1, now: 1, windowMs: 1000});
60
+ assert.fail("expected missing mongoose db to throw");
61
+ } catch (error) {
62
+ assert.include(String(error), "open mongoose connection");
63
+ } finally {
64
+ Object.defineProperty(mongoose.connection, "db", {
65
+ configurable: true,
66
+ value: previous,
67
+ });
68
+ }
69
+ });
70
+
71
+ it("does not allow more than max under concurrent consumes", async () => {
72
+ const store = createMongoRateLimitStore();
73
+ const now = 9_000_000;
74
+ const results = await Promise.all(
75
+ Array.from({length: 20}, () => store.consume({key: "burst", max: 5, now, windowMs: 60_000}))
76
+ );
77
+ const allowed = results.filter((result) => result.allowed).length;
78
+ assert.equal(allowed, 5);
79
+ });
80
+ });
@@ -0,0 +1,76 @@
1
+ import {DateTime} from "luxon";
2
+ import mongoose from "mongoose";
3
+
4
+ import {APIError} from "../errors";
5
+ import type {RateLimitConsumeArgs, RateLimitConsumeResult, RateLimitStore} from "./types";
6
+
7
+ export const RATE_LIMIT_HITS_COLLECTION = "rateLimitHits";
8
+
9
+ const ensureIndexes = async (collection: mongoose.mongo.Collection): Promise<void> => {
10
+ await collection.createIndex({key: 1}, {unique: true});
11
+ await collection.createIndex({expiresAt: 1}, {expireAfterSeconds: 0});
12
+ };
13
+
14
+ export const createMongoRateLimitStore = (): RateLimitStore => {
15
+ let indexed = false;
16
+
17
+ const consume = async ({
18
+ key,
19
+ max,
20
+ windowMs,
21
+ now,
22
+ }: RateLimitConsumeArgs): Promise<RateLimitConsumeResult> => {
23
+ const db = mongoose.connection.db;
24
+ if (!db) {
25
+ throw new APIError({
26
+ status: 500,
27
+ title: "Mongo rate limit store requires an open mongoose connection",
28
+ });
29
+ }
30
+ const collection = db.collection(RATE_LIMIT_HITS_COLLECTION);
31
+ if (!indexed) {
32
+ await ensureIndexes(collection);
33
+ indexed = true;
34
+ }
35
+
36
+ const nowDate = DateTime.fromMillis(now).toJSDate();
37
+ const resetAtDate = DateTime.fromMillis(now + windowMs).toJSDate();
38
+ const updated = await collection.findOneAndUpdate(
39
+ {key},
40
+ [
41
+ {
42
+ $set: {
43
+ expiresAt: {
44
+ $cond: [
45
+ {$and: [{$ne: ["$expiresAt", null]}, {$gt: ["$expiresAt", nowDate]}]},
46
+ "$expiresAt",
47
+ resetAtDate,
48
+ ],
49
+ },
50
+ hits: {
51
+ $cond: [
52
+ {$and: [{$ne: ["$expiresAt", null]}, {$gt: ["$expiresAt", nowDate]}]},
53
+ {$add: [{$ifNull: ["$hits", 0]}, 1]},
54
+ 1,
55
+ ],
56
+ },
57
+ key,
58
+ },
59
+ },
60
+ ],
61
+ {returnDocument: "after", upsert: true}
62
+ );
63
+
64
+ const hits = Number(updated?.hits ?? 1);
65
+ const expiresAt = updated?.expiresAt;
66
+ const resetAt =
67
+ expiresAt != null ? DateTime.fromJSDate(expiresAt as Date).toMillis() : now + windowMs;
68
+ return {
69
+ allowed: hits <= max,
70
+ remaining: Math.max(0, max - hits),
71
+ resetAt,
72
+ };
73
+ };
74
+
75
+ return {consume};
76
+ };
@@ -0,0 +1,130 @@
1
+ import type {Request} from "express";
2
+
3
+ import type {RateLimitPolicyName} from "./types";
4
+
5
+ const DEFAULT_BETTER_AUTH_BASE_PATH = "/api/auth";
6
+
7
+ const stripQueryAndFragment = (url: string): string => {
8
+ const hash = url.indexOf("#");
9
+ const withoutHash = hash === -1 ? url : url.slice(0, hash);
10
+ const q = withoutHash.indexOf("?");
11
+ return q === -1 ? withoutHash : withoutHash.slice(0, q);
12
+ };
13
+
14
+ /** Strip query, fragment, and a trailing slash so `/auth/login/` matches `/auth/login`. */
15
+ export const normalizeRequestPath = (url: string): string => {
16
+ const withoutQuery = stripQueryAndFragment(url);
17
+ const withoutSlash =
18
+ withoutQuery.length > 1 && withoutQuery.endsWith("/")
19
+ ? withoutQuery.slice(0, -1)
20
+ : withoutQuery;
21
+ return withoutSlash.toLowerCase();
22
+ };
23
+
24
+ /** Prefer Express `req.path` (routing) over the raw request-target. */
25
+ export const requestPath = (req: Request): string => {
26
+ const raw = req.path || req.url || req.originalUrl || "";
27
+ return normalizeRequestPath(raw);
28
+ };
29
+
30
+ const JWT_CREDENTIAL_EXCHANGE_EXACT = new Set([
31
+ "/auth/login",
32
+ "/auth/signup",
33
+ "/auth/refresh_token",
34
+ "/auth/forgotpassword",
35
+ "/auth/resetpassword",
36
+ "/resetpassword",
37
+ "/auth/verifyemail",
38
+ ]);
39
+
40
+ /**
41
+ * JWT login, signup, and refresh must not 401 on a stale access token.
42
+ * `setupAuth` runs before those routes so the client can still exchange credentials.
43
+ */
44
+ export const isJwtCredentialExchangePath = (req: Request): boolean => {
45
+ return JWT_CREDENTIAL_EXCHANGE_EXACT.has(requestPath(req));
46
+ };
47
+
48
+ export const shouldSkipRateLimit = (
49
+ req: Request,
50
+ extraSkip?: (req: Request) => boolean
51
+ ): boolean => {
52
+ const path = requestPath(req);
53
+ if (req.method === "GET" && (path === "/health" || path === "/healthz")) {
54
+ return true;
55
+ }
56
+ if (path === "/openapi.json" || path.startsWith("/openapi.json")) {
57
+ return true;
58
+ }
59
+ if (path === "/swagger" || path.startsWith("/swagger/")) {
60
+ return true;
61
+ }
62
+ if (extraSkip?.(req)) {
63
+ return true;
64
+ }
65
+ return false;
66
+ };
67
+
68
+ // `requestPath` lowercases, so camelCase routes live here as lowercase.
69
+ const AUTH_EXACT = new Set([
70
+ "/auth/login",
71
+ "/auth/signup",
72
+ "/auth/refresh_token",
73
+ "/auth/forgotpassword",
74
+ "/auth/resetpassword",
75
+ "/resetpassword",
76
+ "/auth/sendverification",
77
+ "/auth/verifyemail",
78
+ "/auth/github",
79
+ "/auth/github/callback",
80
+ "/auth/github/failure",
81
+ ]);
82
+
83
+ const AUTH_PREFIXES = ["/auth/github/"];
84
+
85
+ const betterAuthAuthPrefixes = (basePath: string): string[] => {
86
+ const trimmed = basePath.endsWith("/") ? basePath.slice(0, -1) : basePath;
87
+ const base = trimmed.toLowerCase();
88
+ return [
89
+ `${base}/sign-in`,
90
+ `${base}/sign-up`,
91
+ `${base}/forget-password`,
92
+ `${base}/request-password-reset`,
93
+ `${base}/reset-password`,
94
+ `${base}/send-verification-email`,
95
+ `${base}/verify-email`,
96
+ `${base}/callback`,
97
+ ];
98
+ };
99
+
100
+ export const classifyRateLimitPolicy = (
101
+ req: Request,
102
+ betterAuthBasePath = DEFAULT_BETTER_AUTH_BASE_PATH
103
+ ): RateLimitPolicyName => {
104
+ const path = requestPath(req);
105
+ if (AUTH_EXACT.has(path)) {
106
+ return "auth";
107
+ }
108
+ for (const prefix of AUTH_PREFIXES) {
109
+ if (path.startsWith(prefix)) {
110
+ return "auth";
111
+ }
112
+ }
113
+ for (const prefix of betterAuthAuthPrefixes(betterAuthBasePath)) {
114
+ if (path === prefix || path.startsWith(`${prefix}/`)) {
115
+ return "auth";
116
+ }
117
+ }
118
+ return "api";
119
+ };
120
+
121
+ export const rateLimitKey = (req: Request, policy: RateLimitPolicyName): string => {
122
+ if (policy !== "auth") {
123
+ const user = req.user as {_id?: unknown; id?: string} | undefined;
124
+ const userId = user?.id ?? (user?._id != null ? String(user._id) : undefined);
125
+ if (userId) {
126
+ return `user:${userId}`;
127
+ }
128
+ }
129
+ return `ip:${req.ip || req.socket?.remoteAddress || "unknown"}`;
130
+ };