@terreno/api 57.1.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.
- package/README.md +17 -7
- package/dist/actions.js +19 -7
- package/dist/adminTypes.d.ts +26 -0
- package/dist/api.d.ts +4 -0
- package/dist/api.js +12 -24
- package/dist/auth.d.ts +23 -10
- package/dist/auth.js +97 -32
- package/dist/authRecovery.d.ts +5 -0
- package/dist/authRecovery.js +350 -0
- package/dist/authTokens.d.ts +8 -0
- package/dist/authTokens.js +162 -0
- package/dist/betterAuth.d.ts +33 -0
- package/dist/betterAuthApp.d.ts +4 -0
- package/dist/betterAuthApp.js +26 -8
- package/dist/betterAuthSetup.d.ts +44 -2
- package/dist/betterAuthSetup.js +288 -18
- package/dist/collectionRegistry.d.ts +38 -0
- package/dist/collectionRegistry.js +72 -0
- package/dist/configurationApp.d.ts +11 -2
- package/dist/configurationApp.js +2 -4
- package/dist/docLoader.js +35 -6
- package/dist/expressServer.d.ts +26 -3
- package/dist/expressServer.js +79 -11
- package/dist/index.d.ts +16 -0
- package/dist/index.js +38 -2
- package/dist/mcp/auth.d.ts +1 -0
- package/dist/mcp/auth.js +47 -25
- package/dist/mcp/handlers.d.ts +1 -1
- package/dist/mcp/handlers.js +67 -233
- package/dist/mcp/query.d.ts +2 -2
- package/dist/mcp/registry.d.ts +1 -5
- package/dist/mcp/registry.js +31 -20
- package/dist/mcp/schemaGenerator.d.ts +2 -7
- package/dist/mcp/schemaGenerator.js +41 -116
- package/dist/mcp/server.d.ts +1 -0
- package/dist/mcp/server.js +1 -0
- package/dist/mcp/serviceTokens.d.ts +16 -0
- package/dist/mcp/serviceTokens.js +345 -0
- package/dist/mcp/types.d.ts +2 -2
- package/dist/models/mcpServiceToken.d.ts +3 -0
- package/dist/models/mcpServiceToken.js +208 -0
- package/dist/openApiBuilder.d.ts +5 -4
- package/dist/openApiBuilder.js +61 -8
- package/dist/openApiCompat.js +1 -1
- package/dist/openApiValidator.js +0 -2
- package/dist/plugins.d.ts +14 -1
- package/dist/plugins.js +17 -6
- package/dist/populate.d.ts +2 -2
- package/dist/populate.js +47 -42
- package/dist/rateLimit/applyTrustProxy.d.ts +3 -0
- package/dist/rateLimit/applyTrustProxy.js +17 -0
- package/dist/rateLimit/createStore.d.ts +2 -0
- package/dist/rateLimit/createStore.js +28 -0
- package/dist/rateLimit/memoryStore.d.ts +2 -0
- package/dist/rateLimit/memoryStore.js +108 -0
- package/dist/rateLimit/middleware.d.ts +11 -0
- package/dist/rateLimit/middleware.js +110 -0
- package/dist/rateLimit/mongoStore.d.ts +3 -0
- package/dist/rateLimit/mongoStore.js +122 -0
- package/dist/rateLimit/policies.d.ts +14 -0
- package/dist/rateLimit/policies.js +151 -0
- package/dist/rateLimit/redisStore.d.ts +3 -0
- package/dist/rateLimit/redisStore.js +155 -0
- package/dist/rateLimit/types.d.ts +54 -0
- package/dist/rateLimit/types.js +9 -0
- package/dist/rbac/access.js +5 -1
- package/dist/rbac/assertAllowed.d.ts +9 -0
- package/dist/rbac/assertAllowed.js +182 -0
- package/dist/rbac/modelRouterAccess.d.ts +1 -0
- package/dist/rbac/modelRouterAccess.js +8 -4
- package/dist/rbac/permissionUtils.js +3 -2
- package/dist/rbac/resolve.js +5 -4
- package/dist/rbac/routes.js +15 -6
- package/dist/rbac/statements.d.ts +10 -0
- package/dist/rbac/statements.js +13 -2
- package/dist/realtime/deprecation.d.ts +12 -0
- package/dist/realtime/deprecation.js +32 -0
- package/dist/realtime/realtimeApp.d.ts +1 -1
- package/dist/realtime/realtimeApp.js +10 -11
- package/dist/realtime/registry.d.ts +0 -31
- package/dist/realtime/registry.js +44 -31
- package/dist/realtime/socketAuth.d.ts +5 -5
- package/dist/realtime/socketAuth.js +11 -1
- package/dist/realtime/socketUser.d.ts +5 -1
- package/dist/realtime/types.d.ts +14 -4
- package/dist/schemaMetadata.d.ts +56 -0
- package/dist/schemaMetadata.js +513 -0
- package/dist/seedRunner.d.ts +88 -0
- package/dist/seedRunner.js +627 -0
- package/dist/sync/executors.d.ts +12 -2
- package/dist/sync/executors.js +8 -10
- package/dist/sync/loadHarness.js +28 -19
- package/dist/sync/models.js +26 -24
- package/dist/sync/mutationHandler.d.ts +9 -0
- package/dist/sync/mutationHandler.js +11 -6
- package/dist/sync/registrationSideEffects.d.ts +35 -0
- package/dist/sync/registrationSideEffects.js +151 -0
- package/dist/sync/registry.d.ts +2 -52
- package/dist/sync/registry.js +38 -187
- package/dist/sync/routes.js +3 -2
- package/dist/sync/scripts/compactTombstones.js +0 -2
- package/dist/sync/syncApp.d.ts +3 -3
- package/dist/sync/syncApp.js +4 -4
- package/dist/sync/syncBatch.js +3 -2
- package/dist/sync/syncSeqPlugin.d.ts +1 -1
- package/dist/sync/syncSeqPlugin.js +20 -16
- package/dist/terrenoApp.d.ts +19 -5
- package/dist/terrenoApp.js +66 -18
- package/dist/tests/models.d.ts +2 -0
- package/dist/tests/models.js +6 -0
- package/dist/types/authToken.d.ts +33 -0
- package/dist/types/authToken.js +2 -0
- package/dist/types/mcpServiceToken.d.ts +41 -0
- package/dist/types/mcpServiceToken.js +2 -0
- package/dist/webhooks/headerValue.d.ts +2 -0
- package/dist/webhooks/headerValue.js +14 -0
- package/dist/webhooks/idempotency/memoryStore.d.ts +10 -0
- package/dist/webhooks/idempotency/memoryStore.js +65 -0
- package/dist/webhooks/idempotency/mongoStore.d.ts +4 -0
- package/dist/webhooks/idempotency/mongoStore.js +150 -0
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +62 -0
- package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
- package/dist/webhooks/rawBody.d.ts +14 -0
- package/dist/webhooks/rawBody.js +22 -0
- package/dist/webhooks/timingSafeEqual.d.ts +4 -0
- package/dist/webhooks/timingSafeEqual.js +17 -0
- package/dist/webhooks/verifiers/hmac.d.ts +15 -0
- package/dist/webhooks/verifiers/hmac.js +49 -0
- package/dist/webhooks/verifiers/sendgrid.d.ts +10 -0
- package/dist/webhooks/verifiers/sendgrid.js +56 -0
- package/dist/webhooks/verifiers/stripe.d.ts +9 -0
- package/dist/webhooks/verifiers/stripe.js +99 -0
- package/dist/webhooks/verifiers/twilio.d.ts +9 -0
- package/dist/webhooks/verifiers/twilio.js +112 -0
- package/dist/webhooks/webhooksApp.d.ts +33 -0
- package/dist/webhooks/webhooksApp.js +195 -0
- package/package.json +5 -6
- package/src/__snapshots__/openApi.test.ts.snap +270 -0
- package/src/__snapshots__/openApiBuilder.test.ts.snap +30 -12
- package/src/__snapshots__/schemaMetadata.test.ts.snap +197 -0
- package/src/actions.ts +20 -13
- package/src/adminModelRouter.test.ts +133 -0
- package/src/adminTypes.ts +23 -0
- package/src/api.arrayOperations.test.ts +43 -31
- package/src/api.hooks.test.ts +38 -29
- package/src/api.query.test.ts +31 -31
- package/src/api.test.ts +95 -96
- package/src/api.ts +16 -27
- package/src/auth.test.ts +107 -51
- package/src/auth.ts +98 -29
- package/src/authRecovery.test.ts +281 -0
- package/src/authRecovery.ts +279 -0
- package/src/authTokens.test.ts +94 -0
- package/src/authTokens.ts +118 -0
- package/src/authVerification.test.ts +293 -0
- package/src/betterAuth.ts +24 -0
- package/src/betterAuthApp.test.ts +1 -0
- package/src/betterAuthApp.ts +27 -9
- package/src/betterAuthSetup.test.ts +568 -38
- package/src/betterAuthSetup.ts +260 -5
- package/src/collectionRegistry.test.ts +165 -0
- package/src/collectionRegistry.ts +115 -0
- package/src/configurationApp.ts +13 -7
- package/src/docLoader.test.ts +45 -1
- package/src/docLoader.ts +37 -6
- package/src/express.d.ts +1 -0
- package/src/expressServer.test.ts +130 -66
- package/src/expressServer.ts +75 -19
- package/src/githubAuth.test.ts +60 -55
- package/src/index.ts +58 -0
- package/src/mcp/auth.test.ts +47 -0
- package/src/mcp/auth.ts +32 -11
- package/src/mcp/handlers.ts +45 -172
- package/src/mcp/integration.test.ts +59 -9
- package/src/mcp/query.ts +2 -4
- package/src/mcp/registry.ts +29 -20
- package/src/mcp/schemaGenerator.test.ts +8 -0
- package/src/mcp/schemaGenerator.ts +49 -131
- package/src/mcp/server.ts +2 -0
- package/src/mcp/serviceTokens.test.ts +330 -0
- package/src/mcp/serviceTokens.ts +307 -0
- package/src/mcp/toolGenerator.test.ts +1 -1
- package/src/mcp/types.ts +2 -6
- package/src/models/mcpServiceToken.test.ts +129 -0
- package/src/models/mcpServiceToken.ts +158 -0
- package/src/openApi.test.ts +80 -64
- package/src/openApiBuilder.test.ts +95 -7
- package/src/openApiBuilder.ts +46 -9
- package/src/openApiCompat.ts +1 -1
- package/src/openApiValidator.test.ts +49 -54
- package/src/openApiValidator.ts +1 -3
- package/src/plugins.test.ts +14 -0
- package/src/plugins.ts +34 -9
- package/src/populate.test.ts +34 -0
- package/src/populate.ts +40 -29
- package/src/rateLimit/applyTrustProxy.ts +17 -0
- package/src/rateLimit/createStore.ts +25 -0
- package/src/rateLimit/memoryStore.ts +40 -0
- package/src/rateLimit/middleware.ts +79 -0
- package/src/rateLimit/mongoStore.test.ts +80 -0
- package/src/rateLimit/mongoStore.ts +76 -0
- package/src/rateLimit/policies.ts +130 -0
- package/src/rateLimit/rateLimit.test.ts +328 -0
- package/src/rateLimit/redisStore.ioredis.test.ts +29 -0
- package/src/rateLimit/redisStore.test.ts +114 -0
- package/src/rateLimit/redisStore.ts +85 -0
- package/src/rateLimit/types.ts +64 -0
- package/src/rbac/access.ts +5 -1
- package/src/rbac/assertAllowed.test.ts +325 -0
- package/src/rbac/assertAllowed.ts +157 -0
- package/src/rbac/backfillAdmins.test.ts +124 -0
- package/src/rbac/fieldViews.test.ts +89 -0
- package/src/rbac/modelRouterAccess.test.ts +126 -0
- package/src/rbac/modelRouterAccess.ts +5 -2
- package/src/rbac/permissionUtils.ts +3 -2
- package/src/rbac/realtimeAccess.test.ts +109 -1
- package/src/rbac/resolve.ts +5 -4
- package/src/rbac/roleManager.test.ts +169 -0
- package/src/rbac/routes.test.ts +233 -0
- package/src/rbac/routes.ts +16 -6
- package/src/rbac/statements.test.ts +2 -0
- package/src/rbac/statements.ts +12 -1
- package/src/realtime/deprecation.test.ts +60 -0
- package/src/realtime/deprecation.ts +32 -0
- package/src/realtime/realtime.test.ts +8 -4
- package/src/realtime/realtimeApp.ts +10 -11
- package/src/realtime/realtimeAppSetup.test.ts +32 -5
- package/src/realtime/registry.ts +48 -42
- package/src/realtime/sessionRevalidation.test.ts +57 -44
- package/src/realtime/socketAuth.test.ts +75 -23
- package/src/realtime/socketAuth.ts +17 -6
- package/src/realtime/socketUser.ts +5 -3
- package/src/realtime/types.ts +14 -4
- package/src/schemaMetadata.test.ts +405 -0
- package/src/schemaMetadata.ts +593 -0
- package/src/scrubAdminFields.test.ts +105 -0
- package/src/seedRunner.test.ts +591 -0
- package/src/seedRunner.ts +464 -0
- package/src/sync/docMatchesMutationData.test.ts +16 -0
- package/src/sync/ensureSyncIndexes.test.ts +54 -15
- package/src/sync/executors.test.ts +40 -0
- package/src/sync/executors.ts +24 -12
- package/src/sync/integration.test.ts +15 -7
- package/src/sync/loadHarness.ts +28 -19
- package/src/sync/models.ts +32 -18
- package/src/sync/mutationHandler.test.ts +16 -16
- package/src/sync/mutationHandler.ts +9 -7
- package/src/sync/registrationSideEffects.test.ts +126 -0
- package/src/sync/registrationSideEffects.ts +131 -0
- package/src/sync/registry.ts +45 -171
- package/src/sync/routes.ts +3 -2
- package/src/sync/scripts/compactTombstones.ts +0 -2
- package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
- package/src/sync/sync.test.ts +25 -23
- package/src/sync/syncApp.ts +4 -4
- package/src/sync/syncBatch.ts +3 -2
- package/src/sync/syncFrontier.test.ts +17 -15
- package/src/sync/syncPhaseC.test.ts +54 -43
- package/src/sync/syncRoutes.test.ts +51 -36
- package/src/sync/syncSeqPlugin.ts +66 -44
- package/src/sync/syncSocket.test.ts +112 -81
- package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
- package/src/terrenoApp.ts +87 -15
- package/src/tests/models.ts +14 -1
- package/src/types/authToken.ts +43 -0
- package/src/types/mcpServiceToken.ts +54 -0
- package/src/webhooks/headerValue.test.ts +22 -0
- package/src/webhooks/headerValue.ts +12 -0
- package/src/webhooks/idempotency/memoryStore.ts +34 -0
- package/src/webhooks/idempotency/mongoStore.test.ts +274 -0
- package/src/webhooks/idempotency/mongoStore.ts +83 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +70 -0
- package/src/webhooks/rawBody.test.ts +74 -0
- package/src/webhooks/rawBody.ts +23 -0
- package/src/webhooks/timingSafeEqual.ts +16 -0
- package/src/webhooks/verifiers/hmac.test.ts +110 -0
- package/src/webhooks/verifiers/hmac.ts +54 -0
- package/src/webhooks/verifiers/providerVerifiers.test.ts +388 -0
- package/src/webhooks/verifiers/sendgrid.ts +59 -0
- package/src/webhooks/verifiers/stripe.ts +67 -0
- package/src/webhooks/verifiers/twilio.ts +69 -0
- package/src/webhooks/webhooksApp.test.ts +221 -0
- package/src/webhooks/webhooksApp.ts +144 -0
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
import type {Application, Request} from "express";
|
|
4
|
+
import supertest from "supertest";
|
|
5
|
+
|
|
6
|
+
import type {UserModel as AuthUserModel} from "../auth";
|
|
7
|
+
import {TerrenoApp} from "../terrenoApp";
|
|
8
|
+
import {UserModel} from "../tests";
|
|
9
|
+
import {hmacSignature} from "./verifiers/hmac";
|
|
10
|
+
import {WebhooksApp} from "./webhooksApp";
|
|
11
|
+
|
|
12
|
+
const WEBHOOK_SECRET = "whsec_test";
|
|
13
|
+
const FIXTURE_BODY = `{"id":"evt_1"}`;
|
|
14
|
+
/** openssl dgst -sha256 -hmac whsec_test of {"id":"evt_1"} */
|
|
15
|
+
const FIXTURE_HMAC_HEX = "030fa3b2413d1993c551364bd53bb9b3edb5c0c34d55dba6ada6041245632811";
|
|
16
|
+
const SPACED_BODY = `{"id": "evt_1"}`;
|
|
17
|
+
/** HMAC of JSON.stringify({id:"evt_1"}) which is FIXTURE_BODY, not SPACED_BODY */
|
|
18
|
+
const STRINGIFY_HMAC_HEX = FIXTURE_HMAC_HEX;
|
|
19
|
+
/** openssl dgst -sha256 -hmac whsec_test of {"id": "evt_1"} */
|
|
20
|
+
const SPACED_HMAC_HEX = "13b1c709ea677bd832fb32f71b5ab6e9fbb22ead444bc5471aff93caffeb5042";
|
|
21
|
+
|
|
22
|
+
const buildWebhookApp = ({
|
|
23
|
+
eventId,
|
|
24
|
+
handler,
|
|
25
|
+
}: {
|
|
26
|
+
eventId?: (req: Request) => string;
|
|
27
|
+
handler: () => Promise<void> | void;
|
|
28
|
+
}): {app: Application; webhooks: WebhooksApp} => {
|
|
29
|
+
const webhooks = new WebhooksApp({idempotency: {store: "memory"}});
|
|
30
|
+
webhooks.route({
|
|
31
|
+
eventId: eventId ?? ((req) => String((req.body as {id?: string})?.id ?? "")),
|
|
32
|
+
handler,
|
|
33
|
+
path: "/webhooks/example",
|
|
34
|
+
source: "example",
|
|
35
|
+
verify: hmacSignature({header: "X-Webhook-Signature", secret: WEBHOOK_SECRET}),
|
|
36
|
+
});
|
|
37
|
+
const app = new TerrenoApp({
|
|
38
|
+
logRequests: false,
|
|
39
|
+
skipListen: true,
|
|
40
|
+
userModel: UserModel as unknown as AuthUserModel,
|
|
41
|
+
})
|
|
42
|
+
.register(webhooks)
|
|
43
|
+
.build();
|
|
44
|
+
return {app, webhooks};
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
const postSigned = (
|
|
48
|
+
app: Application,
|
|
49
|
+
{body = FIXTURE_BODY, signature = FIXTURE_HMAC_HEX}: {body?: string; signature?: string} = {}
|
|
50
|
+
): Promise<supertest.Response> => {
|
|
51
|
+
const request = supertest(app).post("/webhooks/example").set("Content-Type", "application/json");
|
|
52
|
+
if (signature) {
|
|
53
|
+
request.set("X-Webhook-Signature", signature);
|
|
54
|
+
}
|
|
55
|
+
return request.send(body);
|
|
56
|
+
};
|
|
57
|
+
|
|
58
|
+
describe("WebhooksApp HMAC tracer", () => {
|
|
59
|
+
it("returns 200 and runs the handler once for a valid HMAC", async () => {
|
|
60
|
+
let handlerCalls = 0;
|
|
61
|
+
const {app} = buildWebhookApp({
|
|
62
|
+
handler: () => {
|
|
63
|
+
handlerCalls += 1;
|
|
64
|
+
},
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
const res = await postSigned(app);
|
|
68
|
+
|
|
69
|
+
assert.equal(res.status, 200);
|
|
70
|
+
assert.equal(res.body.received, true);
|
|
71
|
+
assert.isUndefined(res.body.duplicate);
|
|
72
|
+
assert.equal(handlerCalls, 1);
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
it("returns 401 webhook-signature-invalid when the signature header is missing", async () => {
|
|
76
|
+
let handlerCalls = 0;
|
|
77
|
+
const {app} = buildWebhookApp({
|
|
78
|
+
handler: () => {
|
|
79
|
+
handlerCalls += 1;
|
|
80
|
+
},
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
const res = await postSigned(app, {signature: ""});
|
|
84
|
+
|
|
85
|
+
assert.equal(res.status, 401);
|
|
86
|
+
assert.equal(res.body.code, "webhook-signature-invalid");
|
|
87
|
+
assert.equal(handlerCalls, 0);
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
it("returns 401 when the body is tampered after signing", async () => {
|
|
91
|
+
let handlerCalls = 0;
|
|
92
|
+
const {app} = buildWebhookApp({
|
|
93
|
+
handler: () => {
|
|
94
|
+
handlerCalls += 1;
|
|
95
|
+
},
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
const res = await postSigned(app, {body: `{"id":"evt_tampered"}`});
|
|
99
|
+
|
|
100
|
+
assert.equal(res.status, 401);
|
|
101
|
+
assert.equal(res.body.code, "webhook-signature-invalid");
|
|
102
|
+
assert.equal(handlerCalls, 0);
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
it("rejects HMAC computed from JSON.stringify(parsed body) when it differs from raw bytes", async () => {
|
|
106
|
+
let handlerCalls = 0;
|
|
107
|
+
const {app} = buildWebhookApp({
|
|
108
|
+
handler: () => {
|
|
109
|
+
handlerCalls += 1;
|
|
110
|
+
},
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
const rejected = await postSigned(app, {
|
|
114
|
+
body: SPACED_BODY,
|
|
115
|
+
signature: STRINGIFY_HMAC_HEX,
|
|
116
|
+
});
|
|
117
|
+
assert.equal(rejected.status, 401);
|
|
118
|
+
assert.equal(handlerCalls, 0);
|
|
119
|
+
|
|
120
|
+
const accepted = await postSigned(app, {
|
|
121
|
+
body: SPACED_BODY,
|
|
122
|
+
signature: SPACED_HMAC_HEX,
|
|
123
|
+
});
|
|
124
|
+
assert.equal(accepted.status, 200);
|
|
125
|
+
assert.equal(handlerCalls, 1);
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
it("returns duplicate: true on a replayed eventId without a second handler call", async () => {
|
|
129
|
+
let handlerCalls = 0;
|
|
130
|
+
const {app} = buildWebhookApp({
|
|
131
|
+
handler: () => {
|
|
132
|
+
handlerCalls += 1;
|
|
133
|
+
},
|
|
134
|
+
});
|
|
135
|
+
|
|
136
|
+
const first = await postSigned(app);
|
|
137
|
+
const second = await postSigned(app);
|
|
138
|
+
|
|
139
|
+
assert.equal(first.status, 200);
|
|
140
|
+
assert.isUndefined(first.body.duplicate);
|
|
141
|
+
assert.equal(second.status, 200);
|
|
142
|
+
assert.equal(second.body.received, true);
|
|
143
|
+
assert.equal(second.body.duplicate, true);
|
|
144
|
+
assert.equal(handlerCalls, 1);
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
it("releases the claim when the handler throws so a retry succeeds", async () => {
|
|
148
|
+
let handlerCalls = 0;
|
|
149
|
+
const {app} = buildWebhookApp({
|
|
150
|
+
handler: () => {
|
|
151
|
+
handlerCalls += 1;
|
|
152
|
+
if (handlerCalls === 1) {
|
|
153
|
+
throw new Error("handler exploded");
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
const failed = await postSigned(app);
|
|
159
|
+
const retried = await postSigned(app);
|
|
160
|
+
|
|
161
|
+
assert.equal(failed.status, 500);
|
|
162
|
+
assert.equal(failed.body.title, "Webhook handler failed");
|
|
163
|
+
assert.equal(retried.status, 200);
|
|
164
|
+
assert.equal(retried.body.received, true);
|
|
165
|
+
assert.isUndefined(retried.body.duplicate);
|
|
166
|
+
assert.equal(handlerCalls, 2);
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
it("does not list the webhook path in /openapi.json", async () => {
|
|
170
|
+
const {app} = buildWebhookApp({handler: () => undefined});
|
|
171
|
+
|
|
172
|
+
const res = await supertest(app).get("/openapi.json").expect(200);
|
|
173
|
+
const paths = res.body.paths as Record<string, unknown> | undefined;
|
|
174
|
+
assert.isUndefined(paths?.["/webhooks/example"]);
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
it("skips the idempotency store when eventId is empty and still runs the handler", async () => {
|
|
178
|
+
let handlerCalls = 0;
|
|
179
|
+
const {app} = buildWebhookApp({
|
|
180
|
+
eventId: () => "",
|
|
181
|
+
handler: () => {
|
|
182
|
+
handlerCalls += 1;
|
|
183
|
+
},
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
const first = await postSigned(app);
|
|
187
|
+
const second = await postSigned(app);
|
|
188
|
+
|
|
189
|
+
assert.equal(first.status, 200);
|
|
190
|
+
assert.equal(second.status, 200);
|
|
191
|
+
assert.isUndefined(second.body.duplicate);
|
|
192
|
+
assert.equal(handlerCalls, 2);
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
it("lets a handler claim nested event ids through webhooks.claim", async () => {
|
|
196
|
+
const claims: string[] = [];
|
|
197
|
+
const webhooks = new WebhooksApp({idempotency: {store: "memory"}});
|
|
198
|
+
webhooks.route({
|
|
199
|
+
eventId: () => "",
|
|
200
|
+
handler: async () => {
|
|
201
|
+
const first = await webhooks.claim({eventId: "sg_nested", source: "sendgrid"});
|
|
202
|
+
const second = await webhooks.claim({eventId: "sg_nested", source: "sendgrid"});
|
|
203
|
+
claims.push(first, second);
|
|
204
|
+
},
|
|
205
|
+
path: "/webhooks/example",
|
|
206
|
+
source: "example",
|
|
207
|
+
verify: hmacSignature({header: "X-Webhook-Signature", secret: WEBHOOK_SECRET}),
|
|
208
|
+
});
|
|
209
|
+
const app = new TerrenoApp({
|
|
210
|
+
logRequests: false,
|
|
211
|
+
skipListen: true,
|
|
212
|
+
userModel: UserModel as unknown as AuthUserModel,
|
|
213
|
+
})
|
|
214
|
+
.register(webhooks)
|
|
215
|
+
.build();
|
|
216
|
+
|
|
217
|
+
const res = await postSigned(app);
|
|
218
|
+
assert.equal(res.status, 200);
|
|
219
|
+
assert.deepEqual(claims, ["claimed", "duplicate"]);
|
|
220
|
+
});
|
|
221
|
+
});
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import type {IncomingHttpHeaders} from "node:http";
|
|
2
|
+
import type {Application, Request, Response} from "express";
|
|
3
|
+
|
|
4
|
+
import {asyncHandler} from "../api";
|
|
5
|
+
import {APIError, isAPIError} from "../errors";
|
|
6
|
+
import {createScopedLogger} from "../logger";
|
|
7
|
+
|
|
8
|
+
import type {TerrenoPlugin} from "../terrenoPlugin";
|
|
9
|
+
import {
|
|
10
|
+
createMemoryIdempotencyStore,
|
|
11
|
+
type WebhookClaimArgs,
|
|
12
|
+
type WebhookClaimResult,
|
|
13
|
+
type WebhookIdempotencyStore,
|
|
14
|
+
} from "./idempotency/memoryStore";
|
|
15
|
+
import {createMongoIdempotencyStore} from "./idempotency/mongoStore";
|
|
16
|
+
|
|
17
|
+
export interface WebhookHandlerContext {
|
|
18
|
+
body: unknown;
|
|
19
|
+
eventId: string;
|
|
20
|
+
headers: IncomingHttpHeaders;
|
|
21
|
+
rawBody: Buffer;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface WebhookRouteOptions {
|
|
25
|
+
eventId?: (req: Request) => string;
|
|
26
|
+
handler: (context: WebhookHandlerContext) => Promise<void> | void;
|
|
27
|
+
path: string;
|
|
28
|
+
source: string;
|
|
29
|
+
verify: (req: Request) => boolean | Promise<boolean>;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export interface WebhooksAppOptions {
|
|
33
|
+
idempotency?: {
|
|
34
|
+
store?: "memory" | "mongo";
|
|
35
|
+
ttlDays?: number;
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export class WebhooksApp implements TerrenoPlugin {
|
|
40
|
+
private readonly routes: WebhookRouteOptions[] = [];
|
|
41
|
+
private readonly store: WebhookIdempotencyStore;
|
|
42
|
+
|
|
43
|
+
constructor(options: WebhooksAppOptions = {}) {
|
|
44
|
+
const storeKind = options.idempotency?.store ?? "memory";
|
|
45
|
+
if (storeKind === "mongo") {
|
|
46
|
+
this.store = createMongoIdempotencyStore({ttlDays: options.idempotency?.ttlDays});
|
|
47
|
+
} else {
|
|
48
|
+
this.store = createMemoryIdempotencyStore();
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
route(options: WebhookRouteOptions): this {
|
|
53
|
+
this.routes.push(options);
|
|
54
|
+
return this;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
claim = async (args: WebhookClaimArgs): Promise<WebhookClaimResult> => {
|
|
58
|
+
return this.store.claim(args);
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
release = async (args: WebhookClaimArgs): Promise<void> => {
|
|
62
|
+
await this.store.release(args);
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
register(app: Application): void {
|
|
66
|
+
for (const route of this.routes) {
|
|
67
|
+
app.post(
|
|
68
|
+
route.path,
|
|
69
|
+
asyncHandler(async (req: Request, res) => {
|
|
70
|
+
await this.dispatch({req, res, route});
|
|
71
|
+
})
|
|
72
|
+
);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
private dispatch = async ({
|
|
77
|
+
req,
|
|
78
|
+
res,
|
|
79
|
+
route,
|
|
80
|
+
}: {
|
|
81
|
+
req: Request;
|
|
82
|
+
res: Response;
|
|
83
|
+
route: WebhookRouteOptions;
|
|
84
|
+
}): Promise<void> => {
|
|
85
|
+
if (!req.rawBody) {
|
|
86
|
+
throw new APIError({
|
|
87
|
+
code: "webhook-body-missing",
|
|
88
|
+
disableExternalErrorTracking: true,
|
|
89
|
+
status: 400,
|
|
90
|
+
title: "Missing webhook body",
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
const isValid = await route.verify(req);
|
|
95
|
+
if (!isValid) {
|
|
96
|
+
throw new APIError({
|
|
97
|
+
code: "webhook-signature-invalid",
|
|
98
|
+
disableExternalErrorTracking: true,
|
|
99
|
+
status: 401,
|
|
100
|
+
title: "Invalid webhook signature",
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const eventId = route.eventId ? route.eventId(req) : "";
|
|
105
|
+
const log = createScopedLogger({
|
|
106
|
+
labels: {eventId: eventId || "none", source: route.source},
|
|
107
|
+
prefix: "[Webhook]",
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
if (!eventId) {
|
|
111
|
+
log.warn("Empty eventId; skipping idempotency claim");
|
|
112
|
+
} else {
|
|
113
|
+
const claimResult = await this.claim({eventId, source: route.source});
|
|
114
|
+
if (claimResult === "duplicate") {
|
|
115
|
+
log.info("Duplicate webhook event");
|
|
116
|
+
res.status(200).json({duplicate: true, received: true});
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
try {
|
|
122
|
+
await route.handler({
|
|
123
|
+
body: req.body,
|
|
124
|
+
eventId,
|
|
125
|
+
headers: req.headers,
|
|
126
|
+
rawBody: req.rawBody,
|
|
127
|
+
});
|
|
128
|
+
} catch (error) {
|
|
129
|
+
if (eventId) {
|
|
130
|
+
await this.release({eventId, source: route.source});
|
|
131
|
+
}
|
|
132
|
+
if (isAPIError(error)) {
|
|
133
|
+
throw error;
|
|
134
|
+
}
|
|
135
|
+
throw new APIError({
|
|
136
|
+
cause: error,
|
|
137
|
+
status: 500,
|
|
138
|
+
title: "Webhook handler failed",
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
res.status(200).json({received: true});
|
|
143
|
+
};
|
|
144
|
+
}
|