@terreno/api 57.2.0 → 57.4.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/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
- package/README.md +23 -7
- package/dist/actions.js +19 -7
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +14 -0
- package/dist/api.js +111 -60
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +155 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +102 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +162 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +230 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +101 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +82 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +373 -0
- 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 +39 -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 +40 -0
- package/dist/collectionRegistry.js +97 -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 +42 -1
- package/dist/index.js +84 -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 -15
- package/dist/mcp/query.js +8 -8
- 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/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +277 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +236 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +145 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +503 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +326 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/mcpServiceToken.d.ts +3 -0
- package/dist/models/mcpServiceToken.js +208 -0
- package/dist/models/notification.d.ts +2 -0
- package/dist/models/notification.js +62 -0
- package/dist/models/notificationPreference.d.ts +2 -0
- package/dist/models/notificationPreference.js +49 -0
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +323 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +250 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +77 -0
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +7 -6
- package/dist/openApiBuilder.d.ts +19 -7
- package/dist/openApiBuilder.js +61 -8
- package/dist/openApiCompat.js +1 -1
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +200 -38
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +198 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +77 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +84 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +301 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +120 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +678 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +8 -31
- 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 +3 -0
- package/dist/rateLimit/middleware.js +109 -0
- package/dist/rateLimit/mongoStore.d.ts +4 -0
- package/dist/rateLimit/mongoStore.js +123 -0
- package/dist/rateLimit/policies.d.ts +10 -0
- package/dist/rateLimit/policies.js +149 -0
- package/dist/rateLimit/redisStore.d.ts +4 -0
- package/dist/rateLimit/redisStore.js +156 -0
- package/dist/rateLimit/types.d.ts +54 -0
- package/dist/rateLimit/types.js +9 -0
- package/dist/rbac/access.js +35 -14
- package/dist/rbac/assertAllowed.d.ts +9 -0
- package/dist/rbac/assertAllowed.js +182 -0
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +122 -0
- package/dist/rbac/modelRouterAccess.d.ts +4 -0
- package/dist/rbac/modelRouterAccess.js +11 -4
- package/dist/rbac/permissionUtils.js +3 -2
- package/dist/rbac/resolve.js +65 -35
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +18 -4
- package/dist/rbac/routes.js +15 -6
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +19 -2
- package/dist/rbac/types.d.ts +5 -0
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +110 -64
- package/dist/realtime/deprecation.d.ts +13 -0
- package/dist/realtime/deprecation.js +33 -0
- package/dist/realtime/realtimeApp.d.ts +2 -1
- package/dist/realtime/realtimeApp.js +11 -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 +524 -0
- package/dist/seedRunner.d.ts +88 -0
- package/dist/seedRunner.js +627 -0
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +194 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +96 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +247 -0
- package/dist/sync/executors.d.ts +19 -3
- package/dist/sync/executors.js +194 -165
- package/dist/sync/loadHarness.js +28 -19
- package/dist/sync/models.js +26 -24
- package/dist/sync/mutationHandler.d.ts +14 -2
- package/dist/sync/mutationHandler.js +201 -76
- 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 +42 -187
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +116 -58
- package/dist/sync/scripts/compactTombstones.js +0 -2
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +144 -50
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +7 -1
- package/dist/sync/syncApp.d.ts +4 -3
- package/dist/sync/syncApp.js +5 -4
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +7 -6
- package/dist/sync/syncSeqPlugin.d.ts +1 -1
- package/dist/sync/syncSeqPlugin.js +20 -16
- package/dist/sync/types.d.ts +18 -0
- package/dist/terrenoApp.d.ts +48 -5
- package/dist/terrenoApp.js +157 -72
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +3 -5
- package/dist/tests/models.d.ts +3 -0
- package/dist/tests/models.js +15 -2
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +2 -9
- 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/types/membership.d.ts +23 -0
- package/dist/types/membership.js +2 -0
- package/dist/types/notification.d.ts +28 -0
- package/dist/types/notification.js +2 -0
- package/dist/types/notificationPreference.d.ts +20 -0
- package/dist/types/notificationPreference.js +2 -0
- package/dist/types/organization.d.ts +36 -0
- package/dist/types/organization.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 +17 -0
- package/dist/webhooks/idempotency/webhookReceipt.js +39 -0
- package/dist/webhooks/rawBody.d.ts +15 -0
- package/dist/webhooks/rawBody.js +23 -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 +32 -27
- package/src/__snapshots__/openApi.test.ts.snap +444 -36
- package/src/__snapshots__/openApiBuilder.test.ts.snap +24 -24
- package/src/__snapshots__/schemaMetadata.test.ts.snap +196 -0
- package/src/actions.ts +20 -13
- package/src/adminModelRouter.test.ts +133 -0
- package/src/adminTypes.ts +8 -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 +133 -97
- package/src/api.ts +84 -27
- package/src/audit/auditApp.test.ts +243 -0
- package/src/audit/auditApp.ts +139 -0
- package/src/audit/auditEventModel.ts +156 -0
- package/src/audit/auditRouter.test.ts +456 -0
- package/src/audit/cloudTasksEnqueue.test.ts +124 -0
- package/src/audit/cloudTasksEnqueue.ts +104 -0
- package/src/audit/diff.ts +163 -0
- package/src/audit/processQueue.ts +69 -0
- package/src/audit/rbacSink.test.ts +86 -0
- package/src/audit/rbacSink.ts +42 -0
- package/src/audit/record.test.ts +402 -0
- package/src/audit/record.ts +328 -0
- package/src/auth.test.ts +108 -52
- 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 +31 -0
- package/src/betterAuthApp.test.ts +1 -0
- package/src/betterAuthApp.ts +27 -9
- package/src/betterAuthSetup.test.ts +595 -38
- package/src/betterAuthSetup.ts +261 -5
- package/src/collectionRegistry.test.ts +164 -0
- package/src/collectionRegistry.ts +135 -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 +3 -0
- package/src/expressServer.test.ts +180 -68
- package/src/expressServer.ts +75 -19
- package/src/githubAuth.test.ts +60 -55
- package/src/index.ts +127 -0
- package/src/mcp/auth.test.ts +47 -0
- package/src/mcp/auth.ts +32 -11
- package/src/mcp/handlers.test.ts +275 -0
- package/src/mcp/handlers.ts +45 -172
- package/src/mcp/integration.test.ts +59 -9
- package/src/mcp/query.ts +5 -7
- 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 +82 -1
- package/src/mcp/types.ts +2 -6
- package/src/migrations/cli.test.ts +376 -0
- package/src/migrations/cli.ts +283 -0
- package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
- package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
- package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
- package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
- package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
- package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
- package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
- package/src/migrations/generate.test.ts +333 -0
- package/src/migrations/generate.ts +216 -0
- package/src/migrations/load.test.ts +103 -0
- package/src/migrations/load.ts +124 -0
- package/src/migrations/lock.test.ts +133 -0
- package/src/migrations/lock.ts +118 -0
- package/src/migrations/runner.test.ts +504 -0
- package/src/migrations/runner.ts +358 -0
- package/src/migrations/schemaCatalog.test.ts +159 -0
- package/src/migrations/schemaCatalog.ts +262 -0
- package/src/migrations/types.ts +94 -0
- package/src/models/mcpServiceToken.test.ts +129 -0
- package/src/models/mcpServiceToken.ts +158 -0
- package/src/models/notification.ts +68 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +505 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/openApi.test.ts +80 -65
- package/src/openApi.ts +2 -1
- package/src/openApiBuilder.test.ts +95 -7
- package/src/openApiBuilder.ts +60 -12
- package/src/openApiCompat.ts +1 -1
- package/src/openApiValidator.test.ts +270 -56
- package/src/openApiValidator.ts +219 -36
- package/src/orgs/orgAccessOptIn.test.ts +87 -0
- package/src/orgs/orgContext.test.ts +259 -0
- package/src/orgs/orgContext.ts +151 -0
- package/src/orgs/orgPermissions.test.ts +105 -0
- package/src/orgs/orgPermissions.ts +40 -0
- package/src/orgs/orgPlugin.test.ts +130 -0
- package/src/orgs/orgPlugin.ts +70 -0
- package/src/orgs/orgRbac.test.ts +267 -0
- package/src/orgs/orgSecurityDefects.test.ts +415 -0
- package/src/orgs/organizationModel.test.ts +205 -0
- package/src/orgs/organizationModel.ts +257 -0
- package/src/orgs/organizationSettings.test.ts +113 -0
- package/src/orgs/organizationSettings.ts +126 -0
- package/src/orgs/orgsApp.test.ts +382 -0
- package/src/orgs/orgsApp.ts +563 -0
- package/src/permissions.test.ts +62 -36
- package/src/permissions.ts +8 -30
- 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 +77 -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 +86 -0
- package/src/rateLimit/types.ts +64 -0
- package/src/rbac/access.ts +16 -4
- 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/membershipOrgAdminSource.ts +59 -0
- package/src/rbac/modelRouterAccess.test.ts +126 -0
- package/src/rbac/modelRouterAccess.ts +8 -2
- package/src/rbac/permissionUtils.test.ts +26 -5
- package/src/rbac/permissionUtils.ts +3 -2
- package/src/rbac/realtimeAccess.test.ts +109 -1
- package/src/rbac/resolve.test.ts +34 -2
- package/src/rbac/resolve.ts +31 -11
- package/src/rbac/roleManager.test.ts +169 -0
- package/src/rbac/roleModel.test.ts +34 -1
- package/src/rbac/roleModel.ts +17 -1
- package/src/rbac/routes.test.ts +233 -0
- package/src/rbac/routes.ts +16 -6
- package/src/rbac/statements.test.ts +19 -0
- package/src/rbac/statements.ts +19 -1
- package/src/rbac/types.ts +5 -0
- package/src/realtime/changeStreamWatcher.ts +73 -33
- package/src/realtime/deprecation.test.ts +60 -0
- package/src/realtime/deprecation.ts +33 -0
- package/src/realtime/realtime.test.ts +365 -189
- package/src/realtime/realtimeApp.ts +11 -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 +419 -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/adminBroadcastConfig.test.ts +96 -0
- package/src/sync/adminBroadcastScope.test.ts +155 -0
- package/src/sync/adminBroadcastScope.ts +123 -0
- package/src/sync/adminWindowAccess.test.ts +57 -0
- package/src/sync/adminWindowAccess.ts +32 -0
- package/src/sync/adminWindowMutation.test.ts +450 -0
- package/src/sync/adminWindowMutation.ts +283 -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 +57 -18
- 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 +293 -17
- package/src/sync/mutationHandler.ts +180 -36
- package/src/sync/registrationSideEffects.test.ts +126 -0
- package/src/sync/registrationSideEffects.ts +131 -0
- package/src/sync/registry.ts +49 -171
- package/src/sync/routes.ts +55 -10
- package/src/sync/scripts/compactTombstones.ts +0 -2
- package/src/sync/sessionRevalidationIntegration.test.ts +12 -11
- package/src/sync/socketHandlers.ts +154 -58
- package/src/sync/streams.ts +6 -0
- package/src/sync/sync.test.ts +28 -25
- package/src/sync/syncApp.ts +5 -4
- package/src/sync/syncBatch.ts +10 -4
- package/src/sync/syncFrontier.test.ts +17 -15
- package/src/sync/syncPhaseC.test.ts +54 -43
- package/src/sync/syncRoutes.test.ts +347 -38
- package/src/sync/syncSeqPlugin.ts +66 -44
- package/src/sync/syncSocket.test.ts +341 -81
- package/src/sync/types.ts +20 -0
- package/src/terrenoApp.mcpServiceTokens.test.ts +173 -0
- package/src/terrenoApp.migrations.test.ts +114 -0
- package/src/terrenoApp.test.ts +41 -0
- package/src/terrenoApp.ts +181 -46
- package/src/tests/createTestData.ts +2 -2
- package/src/tests/models.ts +24 -3
- package/src/tests/testHelper.ts +1 -7
- package/src/types/authToken.ts +41 -0
- package/src/types/mcpServiceToken.ts +48 -0
- package/src/types/membership.ts +48 -0
- package/src/types/notification.ts +34 -0
- package/src/types/notificationPreference.ts +28 -0
- package/src/types/organization.ts +49 -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 +67 -0
- package/src/webhooks/rawBody.test.ts +107 -0
- package/src/webhooks/rawBody.ts +24 -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
- package/tsconfig.json +1 -1
- package/tsconfig.typedoc.json +2 -1
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
- package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import type mongoose from "mongoose";
|
|
2
|
+
import type {FindExactlyOnePlugin, FindOneOrNonePlugin} from "../plugins";
|
|
3
|
+
|
|
4
|
+
// biome-ignore lint/complexity/noBannedTypes: No instance methods.
|
|
5
|
+
export type OrganizationMethods = {};
|
|
6
|
+
|
|
7
|
+
export interface OrganizationStatics
|
|
8
|
+
extends FindExactlyOnePlugin<OrganizationDocument>,
|
|
9
|
+
FindOneOrNonePlugin<OrganizationDocument> {}
|
|
10
|
+
|
|
11
|
+
export interface OrganizationModel
|
|
12
|
+
extends mongoose.Model<OrganizationDocument, object, OrganizationMethods>,
|
|
13
|
+
OrganizationStatics {}
|
|
14
|
+
|
|
15
|
+
export type OrganizationSchema = mongoose.Schema<
|
|
16
|
+
OrganizationDocument,
|
|
17
|
+
OrganizationModel,
|
|
18
|
+
OrganizationMethods
|
|
19
|
+
>;
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* App-defined `Organization.settings` shape.
|
|
23
|
+
*
|
|
24
|
+
* Augment in the consumer app:
|
|
25
|
+
*
|
|
26
|
+
* ```ts
|
|
27
|
+
* declare module "@terreno/api" {
|
|
28
|
+
* interface OrganizationSettings {
|
|
29
|
+
* timezone?: string;
|
|
30
|
+
* }
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*
|
|
34
|
+
* Or pass a generic to `organizationSettingsOf<MySettings>(organization)`.
|
|
35
|
+
*/
|
|
36
|
+
// biome-ignore lint/suspicious/noEmptyInterface: Declaration merging for consumer settings.
|
|
37
|
+
export interface OrganizationSettings {}
|
|
38
|
+
|
|
39
|
+
export interface OrganizationDocument extends mongoose.Document {
|
|
40
|
+
_id: mongoose.Types.ObjectId;
|
|
41
|
+
created: Date;
|
|
42
|
+
deleted: boolean;
|
|
43
|
+
disabled: boolean;
|
|
44
|
+
name: string;
|
|
45
|
+
ownerId: mongoose.Types.ObjectId;
|
|
46
|
+
settings?: OrganizationSettings;
|
|
47
|
+
slug: string;
|
|
48
|
+
updated: Date;
|
|
49
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
import type {Request} from "express";
|
|
4
|
+
|
|
5
|
+
import {headerValue} from "./headerValue";
|
|
6
|
+
|
|
7
|
+
describe("headerValue", () => {
|
|
8
|
+
it("returns the first value when the header is an array", () => {
|
|
9
|
+
const req = {headers: {"x-sig": ["first", "second"]}} as unknown as Request;
|
|
10
|
+
assert.equal(headerValue(req, "X-Sig"), "first");
|
|
11
|
+
});
|
|
12
|
+
|
|
13
|
+
it("returns a string header", () => {
|
|
14
|
+
const req = {headers: {"x-sig": "abc"}} as unknown as Request;
|
|
15
|
+
assert.equal(headerValue(req, "X-Sig"), "abc");
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
it("returns undefined when the header is missing", () => {
|
|
19
|
+
const req = {headers: {}} as unknown as Request;
|
|
20
|
+
assert.isUndefined(headerValue(req, "X-Sig"));
|
|
21
|
+
});
|
|
22
|
+
});
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type {Request} from "express";
|
|
2
|
+
|
|
3
|
+
export const headerValue = (req: Request, header: string): string | undefined => {
|
|
4
|
+
const raw = req.headers[header.toLowerCase()];
|
|
5
|
+
if (Array.isArray(raw)) {
|
|
6
|
+
return raw[0];
|
|
7
|
+
}
|
|
8
|
+
if (typeof raw === "string") {
|
|
9
|
+
return raw;
|
|
10
|
+
}
|
|
11
|
+
return undefined;
|
|
12
|
+
};
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
export type WebhookClaimResult = "claimed" | "duplicate";
|
|
2
|
+
|
|
3
|
+
export interface WebhookClaimArgs {
|
|
4
|
+
eventId: string;
|
|
5
|
+
source: string;
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
export interface WebhookIdempotencyStore {
|
|
9
|
+
claim: (args: WebhookClaimArgs) => Promise<WebhookClaimResult>;
|
|
10
|
+
release: (args: WebhookClaimArgs) => Promise<void>;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
const claimKey = ({source, eventId}: WebhookClaimArgs): string => {
|
|
14
|
+
return `${source}\0${eventId}`;
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
export const createMemoryIdempotencyStore = (): WebhookIdempotencyStore => {
|
|
18
|
+
const claimed = new Set<string>();
|
|
19
|
+
|
|
20
|
+
const claim = async (args: WebhookClaimArgs): Promise<WebhookClaimResult> => {
|
|
21
|
+
const key = claimKey(args);
|
|
22
|
+
if (claimed.has(key)) {
|
|
23
|
+
return "duplicate";
|
|
24
|
+
}
|
|
25
|
+
claimed.add(key);
|
|
26
|
+
return "claimed";
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
const release = async (args: WebhookClaimArgs): Promise<void> => {
|
|
30
|
+
claimed.delete(claimKey(args));
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
return {claim, release};
|
|
34
|
+
};
|
|
@@ -0,0 +1,274 @@
|
|
|
1
|
+
import {beforeEach, describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
import type {Application} from "express";
|
|
4
|
+
import mongoose from "mongoose";
|
|
5
|
+
import supertest from "supertest";
|
|
6
|
+
|
|
7
|
+
import type {UserModel as AuthUserModel} from "../../auth";
|
|
8
|
+
import {TerrenoApp} from "../../terrenoApp";
|
|
9
|
+
import {setupTestData, UserModel} from "../../tests";
|
|
10
|
+
import {hmacSignature} from "../verifiers/hmac";
|
|
11
|
+
import {WebhooksApp} from "../webhooksApp";
|
|
12
|
+
import {createMongoIdempotencyStore} from "./mongoStore";
|
|
13
|
+
import {
|
|
14
|
+
DEFAULT_WEBHOOK_RECEIPT_TTL_DAYS,
|
|
15
|
+
getWebhookReceiptModel,
|
|
16
|
+
WEBHOOK_RECEIPTS_COLLECTION,
|
|
17
|
+
} from "./webhookReceipt";
|
|
18
|
+
|
|
19
|
+
const WEBHOOK_SECRET = "whsec_test";
|
|
20
|
+
const FIXTURE_BODY = `{"id":"evt_1"}`;
|
|
21
|
+
const FIXTURE_HMAC_HEX = "030fa3b2413d1993c551364bd53bb9b3edb5c0c34d55dba6ada6041245632811";
|
|
22
|
+
|
|
23
|
+
const buildApp = ({
|
|
24
|
+
handler,
|
|
25
|
+
source = "example",
|
|
26
|
+
}: {
|
|
27
|
+
handler: () => void;
|
|
28
|
+
source?: string;
|
|
29
|
+
}): Application => {
|
|
30
|
+
const webhooks = new WebhooksApp({idempotency: {store: "mongo"}});
|
|
31
|
+
webhooks.route({
|
|
32
|
+
eventId: (req) => String((req.body as {id?: string})?.id ?? ""),
|
|
33
|
+
handler,
|
|
34
|
+
path: "/webhooks/example",
|
|
35
|
+
source,
|
|
36
|
+
verify: hmacSignature({header: "X-Webhook-Signature", secret: WEBHOOK_SECRET}),
|
|
37
|
+
});
|
|
38
|
+
return new TerrenoApp({
|
|
39
|
+
logRequests: false,
|
|
40
|
+
skipListen: true,
|
|
41
|
+
userModel: UserModel as unknown as AuthUserModel,
|
|
42
|
+
})
|
|
43
|
+
.register(webhooks)
|
|
44
|
+
.build();
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
describe("mongo webhook idempotency store", () => {
|
|
48
|
+
beforeEach(async () => {
|
|
49
|
+
await setupTestData();
|
|
50
|
+
await getWebhookReceiptModel().deleteMany({});
|
|
51
|
+
await getWebhookReceiptModel().syncIndexes();
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
it("returns duplicate: true for the same source and eventId without a second handler call", async () => {
|
|
55
|
+
let handlerCalls = 0;
|
|
56
|
+
const app = buildApp({
|
|
57
|
+
handler: () => {
|
|
58
|
+
handlerCalls += 1;
|
|
59
|
+
},
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
const first = await supertest(app)
|
|
63
|
+
.post("/webhooks/example")
|
|
64
|
+
.set("Content-Type", "application/json")
|
|
65
|
+
.set("X-Webhook-Signature", FIXTURE_HMAC_HEX)
|
|
66
|
+
.send(FIXTURE_BODY);
|
|
67
|
+
const second = await supertest(app)
|
|
68
|
+
.post("/webhooks/example")
|
|
69
|
+
.set("Content-Type", "application/json")
|
|
70
|
+
.set("X-Webhook-Signature", FIXTURE_HMAC_HEX)
|
|
71
|
+
.send(FIXTURE_BODY);
|
|
72
|
+
|
|
73
|
+
assert.equal(first.status, 200);
|
|
74
|
+
assert.equal(second.status, 200);
|
|
75
|
+
assert.equal(second.body.duplicate, true);
|
|
76
|
+
assert.equal(handlerCalls, 1);
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
it("lets two sources share the same event id string", async () => {
|
|
80
|
+
const webhooks = new WebhooksApp({idempotency: {store: "mongo"}});
|
|
81
|
+
let stripeCalls = 0;
|
|
82
|
+
let twilioCalls = 0;
|
|
83
|
+
webhooks.route({
|
|
84
|
+
eventId: () => "shared-id",
|
|
85
|
+
handler: () => {
|
|
86
|
+
stripeCalls += 1;
|
|
87
|
+
},
|
|
88
|
+
path: "/webhooks/stripe",
|
|
89
|
+
source: "stripe",
|
|
90
|
+
verify: () => true,
|
|
91
|
+
});
|
|
92
|
+
webhooks.route({
|
|
93
|
+
eventId: () => "shared-id",
|
|
94
|
+
handler: () => {
|
|
95
|
+
twilioCalls += 1;
|
|
96
|
+
},
|
|
97
|
+
path: "/webhooks/twilio",
|
|
98
|
+
source: "twilio",
|
|
99
|
+
verify: () => true,
|
|
100
|
+
});
|
|
101
|
+
const app = new TerrenoApp({
|
|
102
|
+
logRequests: false,
|
|
103
|
+
skipListen: true,
|
|
104
|
+
userModel: UserModel as unknown as AuthUserModel,
|
|
105
|
+
})
|
|
106
|
+
.register(webhooks)
|
|
107
|
+
.build();
|
|
108
|
+
|
|
109
|
+
const stripeRes = await supertest(app)
|
|
110
|
+
.post("/webhooks/stripe")
|
|
111
|
+
.set("Content-Type", "application/json")
|
|
112
|
+
.send(`{"id":"shared-id"}`);
|
|
113
|
+
const twilioRes = await supertest(app)
|
|
114
|
+
.post("/webhooks/twilio")
|
|
115
|
+
.set("Content-Type", "application/json")
|
|
116
|
+
.send(`{"id":"shared-id"}`);
|
|
117
|
+
|
|
118
|
+
assert.equal(stripeRes.status, 200);
|
|
119
|
+
assert.equal(twilioRes.status, 200);
|
|
120
|
+
assert.equal(stripeCalls, 1);
|
|
121
|
+
assert.equal(twilioCalls, 1);
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
it("releases the mongo claim when the handler throws", async () => {
|
|
125
|
+
let handlerCalls = 0;
|
|
126
|
+
const app = buildApp({
|
|
127
|
+
handler: () => {
|
|
128
|
+
handlerCalls += 1;
|
|
129
|
+
if (handlerCalls === 1) {
|
|
130
|
+
throw new Error("mongo handler exploded");
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
const failed = await supertest(app)
|
|
136
|
+
.post("/webhooks/example")
|
|
137
|
+
.set("Content-Type", "application/json")
|
|
138
|
+
.set("X-Webhook-Signature", FIXTURE_HMAC_HEX)
|
|
139
|
+
.send(FIXTURE_BODY);
|
|
140
|
+
const retried = await supertest(app)
|
|
141
|
+
.post("/webhooks/example")
|
|
142
|
+
.set("Content-Type", "application/json")
|
|
143
|
+
.set("X-Webhook-Signature", FIXTURE_HMAC_HEX)
|
|
144
|
+
.send(FIXTURE_BODY);
|
|
145
|
+
|
|
146
|
+
assert.equal(failed.status, 500);
|
|
147
|
+
assert.equal(retried.status, 200);
|
|
148
|
+
assert.equal(handlerCalls, 2);
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
it("creates a unique compound index and a TTL index on created", async () => {
|
|
152
|
+
await getWebhookReceiptModel().create({eventId: "idx", source: "example"});
|
|
153
|
+
const db = mongoose.connection.db;
|
|
154
|
+
assert.ok(db);
|
|
155
|
+
const indexes = await db.collection(WEBHOOK_RECEIPTS_COLLECTION).indexes();
|
|
156
|
+
const unique = indexes.find((index) => {
|
|
157
|
+
return Boolean(index.unique && index.key.source === 1 && index.key.eventId === 1);
|
|
158
|
+
});
|
|
159
|
+
const ttl = indexes.find((index) => index.key.created === 1);
|
|
160
|
+
assert.ok(unique);
|
|
161
|
+
assert.ok(ttl);
|
|
162
|
+
assert.equal(ttl.expireAfterSeconds, DEFAULT_WEBHOOK_RECEIPT_TTL_DAYS * 86_400);
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it("does not expose webhookReceipts on a modelRouter path", async () => {
|
|
166
|
+
const app = buildApp({handler: () => undefined});
|
|
167
|
+
const spec = await supertest(app).get("/openapi.json").expect(200);
|
|
168
|
+
const paths = spec.body.paths as Record<string, unknown>;
|
|
169
|
+
assert.isUndefined(paths["/webhookReceipts"]);
|
|
170
|
+
assert.isUndefined(paths["/webhook-receipts"]);
|
|
171
|
+
});
|
|
172
|
+
|
|
173
|
+
it("retries index sync after a transient failure", async () => {
|
|
174
|
+
const model = getWebhookReceiptModel();
|
|
175
|
+
const originalSync = model.syncIndexes.bind(model);
|
|
176
|
+
let syncCalls = 0;
|
|
177
|
+
model.syncIndexes = (async () => {
|
|
178
|
+
syncCalls += 1;
|
|
179
|
+
if (syncCalls === 1) {
|
|
180
|
+
throw new Error("index sync failed");
|
|
181
|
+
}
|
|
182
|
+
return originalSync();
|
|
183
|
+
}) as typeof model.syncIndexes;
|
|
184
|
+
const store = createMongoIdempotencyStore();
|
|
185
|
+
try {
|
|
186
|
+
let firstFailed = false;
|
|
187
|
+
try {
|
|
188
|
+
await store.claim({eventId: "retry-1", source: "example"});
|
|
189
|
+
} catch {
|
|
190
|
+
firstFailed = true;
|
|
191
|
+
}
|
|
192
|
+
assert.isTrue(firstFailed);
|
|
193
|
+
const result = await store.claim({eventId: "retry-1", source: "example"});
|
|
194
|
+
assert.equal(result, "claimed");
|
|
195
|
+
assert.equal(syncCalls, 2);
|
|
196
|
+
} finally {
|
|
197
|
+
model.syncIndexes = originalSync;
|
|
198
|
+
}
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
it("rethrows non-duplicate create errors", async () => {
|
|
202
|
+
const store = createMongoIdempotencyStore();
|
|
203
|
+
const model = getWebhookReceiptModel();
|
|
204
|
+
const originalCreate = model.create.bind(model);
|
|
205
|
+
model.create = (async () => {
|
|
206
|
+
throw new Error("write failed");
|
|
207
|
+
}) as typeof model.create;
|
|
208
|
+
try {
|
|
209
|
+
let failed = false;
|
|
210
|
+
try {
|
|
211
|
+
await store.claim({eventId: "write-fail", source: "example"});
|
|
212
|
+
} catch {
|
|
213
|
+
failed = true;
|
|
214
|
+
}
|
|
215
|
+
assert.isTrue(failed);
|
|
216
|
+
} finally {
|
|
217
|
+
model.create = originalCreate;
|
|
218
|
+
}
|
|
219
|
+
});
|
|
220
|
+
|
|
221
|
+
it("applies idempotency.ttlDays to the created TTL index", async () => {
|
|
222
|
+
const webhooks = new WebhooksApp({idempotency: {store: "mongo", ttlDays: 1}});
|
|
223
|
+
webhooks.route({
|
|
224
|
+
eventId: () => "ttl-custom",
|
|
225
|
+
handler: () => undefined,
|
|
226
|
+
path: "/webhooks/ttl",
|
|
227
|
+
source: "example",
|
|
228
|
+
verify: () => true,
|
|
229
|
+
});
|
|
230
|
+
const app = new TerrenoApp({
|
|
231
|
+
logRequests: false,
|
|
232
|
+
skipListen: true,
|
|
233
|
+
userModel: UserModel as unknown as AuthUserModel,
|
|
234
|
+
})
|
|
235
|
+
.register(webhooks)
|
|
236
|
+
.build();
|
|
237
|
+
await supertest(app).post("/webhooks/ttl").set("Content-Type", "application/json").send("{}");
|
|
238
|
+
const db = mongoose.connection.db;
|
|
239
|
+
assert.ok(db);
|
|
240
|
+
const indexes = await db.collection(WEBHOOK_RECEIPTS_COLLECTION).indexes();
|
|
241
|
+
const ttl = indexes.find((index) => index.key.created === 1);
|
|
242
|
+
assert.ok(ttl);
|
|
243
|
+
assert.equal(ttl.expireAfterSeconds, 86_400);
|
|
244
|
+
});
|
|
245
|
+
|
|
246
|
+
it("throws when ttlDays is not a positive number", (): void => {
|
|
247
|
+
let failed = false;
|
|
248
|
+
try {
|
|
249
|
+
createMongoIdempotencyStore({ttlDays: 0});
|
|
250
|
+
} catch {
|
|
251
|
+
failed = true;
|
|
252
|
+
}
|
|
253
|
+
assert.isTrue(failed);
|
|
254
|
+
});
|
|
255
|
+
|
|
256
|
+
it("throws when mongoose is not connected", async () => {
|
|
257
|
+
const store = createMongoIdempotencyStore();
|
|
258
|
+
const descriptor = Object.getOwnPropertyDescriptor(mongoose.connection, "db");
|
|
259
|
+
Object.defineProperty(mongoose.connection, "db", {configurable: true, value: undefined});
|
|
260
|
+
try {
|
|
261
|
+
let failed = false;
|
|
262
|
+
try {
|
|
263
|
+
await store.claim({eventId: "offline", source: "example"});
|
|
264
|
+
} catch {
|
|
265
|
+
failed = true;
|
|
266
|
+
}
|
|
267
|
+
assert.isTrue(failed);
|
|
268
|
+
} finally {
|
|
269
|
+
if (descriptor) {
|
|
270
|
+
Object.defineProperty(mongoose.connection, "db", descriptor);
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
});
|
|
274
|
+
});
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import mongoose from "mongoose";
|
|
2
|
+
|
|
3
|
+
import {APIError} from "../../errors";
|
|
4
|
+
import type {WebhookClaimArgs, WebhookClaimResult, WebhookIdempotencyStore} from "./memoryStore";
|
|
5
|
+
import {
|
|
6
|
+
DEFAULT_WEBHOOK_RECEIPT_TTL_DAYS,
|
|
7
|
+
getWebhookReceiptModel,
|
|
8
|
+
WEBHOOK_RECEIPTS_COLLECTION,
|
|
9
|
+
} from "./webhookReceipt";
|
|
10
|
+
|
|
11
|
+
const isDuplicateKeyError = (error: unknown): boolean => {
|
|
12
|
+
if (!error || typeof error !== "object" || !("code" in error)) {
|
|
13
|
+
return false;
|
|
14
|
+
}
|
|
15
|
+
return (error as {code: unknown}).code === 11000;
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
export const createMongoIdempotencyStore = ({
|
|
19
|
+
ttlDays = DEFAULT_WEBHOOK_RECEIPT_TTL_DAYS,
|
|
20
|
+
}: {
|
|
21
|
+
ttlDays?: number;
|
|
22
|
+
} = {}): WebhookIdempotencyStore => {
|
|
23
|
+
if (!Number.isFinite(ttlDays) || ttlDays <= 0) {
|
|
24
|
+
throw new APIError({
|
|
25
|
+
status: 500,
|
|
26
|
+
title: "Mongo webhook idempotency ttlDays must be a positive number",
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
const expireAfterSeconds = Math.round(ttlDays * 86_400);
|
|
30
|
+
let indexesReady: Promise<void> | undefined;
|
|
31
|
+
|
|
32
|
+
const ensureIndexes = async (): Promise<void> => {
|
|
33
|
+
if (!indexesReady) {
|
|
34
|
+
indexesReady = getWebhookReceiptModel()
|
|
35
|
+
.syncIndexes()
|
|
36
|
+
.then(async () => {
|
|
37
|
+
const db = mongoose.connection.db;
|
|
38
|
+
if (!db) {
|
|
39
|
+
return;
|
|
40
|
+
}
|
|
41
|
+
await db.command({
|
|
42
|
+
collMod: WEBHOOK_RECEIPTS_COLLECTION,
|
|
43
|
+
index: {
|
|
44
|
+
expireAfterSeconds,
|
|
45
|
+
keyPattern: {created: 1},
|
|
46
|
+
},
|
|
47
|
+
});
|
|
48
|
+
})
|
|
49
|
+
.catch((error: unknown) => {
|
|
50
|
+
indexesReady = undefined;
|
|
51
|
+
throw error;
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
await indexesReady;
|
|
55
|
+
};
|
|
56
|
+
|
|
57
|
+
const claim = async (args: WebhookClaimArgs): Promise<WebhookClaimResult> => {
|
|
58
|
+
if (!mongoose.connection.db) {
|
|
59
|
+
throw new APIError({
|
|
60
|
+
status: 500,
|
|
61
|
+
title: "Mongo webhook idempotency store requires an open mongoose connection",
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
await ensureIndexes();
|
|
65
|
+
const WebhookReceipt = getWebhookReceiptModel();
|
|
66
|
+
try {
|
|
67
|
+
await WebhookReceipt.create({eventId: args.eventId, source: args.source});
|
|
68
|
+
return "claimed";
|
|
69
|
+
} catch (error) {
|
|
70
|
+
if (isDuplicateKeyError(error)) {
|
|
71
|
+
return "duplicate";
|
|
72
|
+
}
|
|
73
|
+
throw error;
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
const release = async (args: WebhookClaimArgs): Promise<void> => {
|
|
78
|
+
const WebhookReceipt = getWebhookReceiptModel();
|
|
79
|
+
await WebhookReceipt.deleteOne({eventId: args.eventId, source: args.source});
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
return {claim, release};
|
|
83
|
+
};
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import {DateTime} from "luxon";
|
|
2
|
+
import mongoose from "mongoose";
|
|
3
|
+
import type {FindExactlyOnePlugin, FindOneOrNonePlugin} from "../../plugins";
|
|
4
|
+
import {findExactlyOne, findOneOrNone} from "../../plugins";
|
|
5
|
+
|
|
6
|
+
export const WEBHOOK_RECEIPTS_COLLECTION = "webhookReceipts";
|
|
7
|
+
export const DEFAULT_WEBHOOK_RECEIPT_TTL_DAYS = 7;
|
|
8
|
+
|
|
9
|
+
type WebhookReceiptMethods = Record<string, never>;
|
|
10
|
+
|
|
11
|
+
interface WebhookReceiptStatics
|
|
12
|
+
extends FindExactlyOnePlugin<WebhookReceiptDocument>,
|
|
13
|
+
FindOneOrNonePlugin<WebhookReceiptDocument> {}
|
|
14
|
+
|
|
15
|
+
export interface WebhookReceiptModel
|
|
16
|
+
extends mongoose.Model<WebhookReceiptDocument, object, WebhookReceiptMethods>,
|
|
17
|
+
WebhookReceiptStatics {}
|
|
18
|
+
|
|
19
|
+
interface WebhookReceiptDocument extends mongoose.Document {
|
|
20
|
+
_id: mongoose.Types.ObjectId;
|
|
21
|
+
created: Date;
|
|
22
|
+
eventId: string;
|
|
23
|
+
source: string;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
const secondsPerDay = 86_400;
|
|
27
|
+
|
|
28
|
+
const webhookReceiptSchema = new mongoose.Schema<WebhookReceiptDocument, WebhookReceiptModel>(
|
|
29
|
+
{
|
|
30
|
+
created: {
|
|
31
|
+
default: () => DateTime.utc().toJSDate(),
|
|
32
|
+
description: "When this webhook event id was first claimed",
|
|
33
|
+
required: true,
|
|
34
|
+
type: Date,
|
|
35
|
+
},
|
|
36
|
+
eventId: {
|
|
37
|
+
description: "Provider event id claimed for this source",
|
|
38
|
+
required: true,
|
|
39
|
+
type: String,
|
|
40
|
+
},
|
|
41
|
+
source: {
|
|
42
|
+
description: "Webhook source label (for example stripe or sendgrid)",
|
|
43
|
+
required: true,
|
|
44
|
+
type: String,
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
{collection: WEBHOOK_RECEIPTS_COLLECTION, strict: "throw"}
|
|
48
|
+
);
|
|
49
|
+
|
|
50
|
+
webhookReceiptSchema.index({eventId: 1, source: 1}, {unique: true});
|
|
51
|
+
webhookReceiptSchema.index(
|
|
52
|
+
{created: 1},
|
|
53
|
+
{expireAfterSeconds: DEFAULT_WEBHOOK_RECEIPT_TTL_DAYS * secondsPerDay}
|
|
54
|
+
);
|
|
55
|
+
|
|
56
|
+
webhookReceiptSchema.plugin(findOneOrNone);
|
|
57
|
+
webhookReceiptSchema.plugin(findExactlyOne);
|
|
58
|
+
|
|
59
|
+
export const getWebhookReceiptModel = (): WebhookReceiptModel => {
|
|
60
|
+
return (
|
|
61
|
+
(mongoose.models.WebhookReceipt as WebhookReceiptModel | undefined) ??
|
|
62
|
+
mongoose.model<WebhookReceiptDocument, WebhookReceiptModel>(
|
|
63
|
+
"WebhookReceipt",
|
|
64
|
+
webhookReceiptSchema
|
|
65
|
+
)
|
|
66
|
+
);
|
|
67
|
+
};
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import type {OutgoingMessage} from "node:http";
|
|
3
|
+
import {assert} from "chai";
|
|
4
|
+
import type {Application, Request} from "express";
|
|
5
|
+
import supertest from "supertest";
|
|
6
|
+
|
|
7
|
+
import type {UserModel as AuthUserModel} from "../auth";
|
|
8
|
+
import {TerrenoApp} from "../terrenoApp";
|
|
9
|
+
import {UserModel} from "../tests";
|
|
10
|
+
import {captureRawBody, jsonBodyParserOptions, urlencodedBodyParserOptions} from "./rawBody";
|
|
11
|
+
|
|
12
|
+
const buildEchoApp = (): Application => {
|
|
13
|
+
return new TerrenoApp({
|
|
14
|
+
configureApp: (app) => {
|
|
15
|
+
app.post("/__raw-body-echo", (req: Request, res) => {
|
|
16
|
+
if (req.body && typeof req.body === "object") {
|
|
17
|
+
(req.body as {mutated?: boolean}).mutated = true;
|
|
18
|
+
}
|
|
19
|
+
const rawBody = req.rawBody;
|
|
20
|
+
res.json({
|
|
21
|
+
body: req.body,
|
|
22
|
+
rawBodyUtf8: rawBody ? rawBody.toString("utf8") : null,
|
|
23
|
+
});
|
|
24
|
+
});
|
|
25
|
+
},
|
|
26
|
+
logRequests: false,
|
|
27
|
+
skipListen: true,
|
|
28
|
+
userModel: UserModel as unknown as AuthUserModel,
|
|
29
|
+
}).build();
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
describe("captureRawBody", () => {
|
|
33
|
+
const buildReq = (): Request => ({}) as unknown as Request;
|
|
34
|
+
const res = {} as OutgoingMessage;
|
|
35
|
+
|
|
36
|
+
it("copies the buffer so later mutations of the original do not leak", () => {
|
|
37
|
+
const req = buildReq();
|
|
38
|
+
const buf = Buffer.from("hello");
|
|
39
|
+
|
|
40
|
+
captureRawBody(req, res, buf);
|
|
41
|
+
buf.write("jello");
|
|
42
|
+
|
|
43
|
+
assert.isTrue(Buffer.isBuffer(req.rawBody));
|
|
44
|
+
assert.strictEqual(req.rawBody?.toString("utf8"), "hello");
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
it("leaves rawBody unset when the verify hook receives a non-buffer", () => {
|
|
48
|
+
const req = buildReq();
|
|
49
|
+
|
|
50
|
+
captureRawBody(req, res, "not a buffer" as unknown as Buffer);
|
|
51
|
+
|
|
52
|
+
assert.isUndefined(req.rawBody);
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
it("wires captureRawBody into both body parser option sets", () => {
|
|
56
|
+
assert.strictEqual(jsonBodyParserOptions.verify, captureRawBody);
|
|
57
|
+
assert.strictEqual(jsonBodyParserOptions.limit, "50mb");
|
|
58
|
+
assert.strictEqual(urlencodedBodyParserOptions.verify, captureRawBody);
|
|
59
|
+
assert.isFalse(urlencodedBodyParserOptions.extended);
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
describe("TerrenoApp raw body capture", () => {
|
|
64
|
+
it("stores JSON request bytes on req.rawBody and still parses req.body", async () => {
|
|
65
|
+
const app = buildEchoApp();
|
|
66
|
+
const payload = `{"hello":"world"}`;
|
|
67
|
+
|
|
68
|
+
const res = await supertest(app)
|
|
69
|
+
.post("/__raw-body-echo")
|
|
70
|
+
.set("Content-Type", "application/json")
|
|
71
|
+
.send(payload)
|
|
72
|
+
.expect(200);
|
|
73
|
+
|
|
74
|
+
assert.strictEqual(res.body.rawBodyUtf8, payload);
|
|
75
|
+
assert.strictEqual(res.body.body.hello, "world");
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
it("does not change rawBody when the parsed JSON object is mutated", async () => {
|
|
79
|
+
const app = buildEchoApp();
|
|
80
|
+
const payload = `{"hello":"world"}`;
|
|
81
|
+
|
|
82
|
+
const res = await supertest(app)
|
|
83
|
+
.post("/__raw-body-echo")
|
|
84
|
+
.set("Content-Type", "application/json")
|
|
85
|
+
.send(payload)
|
|
86
|
+
.expect(200);
|
|
87
|
+
|
|
88
|
+
assert.strictEqual(res.body.body.mutated, true);
|
|
89
|
+
assert.strictEqual(res.body.rawBodyUtf8, payload);
|
|
90
|
+
assert.notInclude(res.body.rawBodyUtf8, "mutated");
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
it("stores urlencoded request bytes on req.rawBody", async () => {
|
|
94
|
+
const app = buildEchoApp();
|
|
95
|
+
const payload = "MessageSid=SM123&MessageStatus=delivered";
|
|
96
|
+
|
|
97
|
+
const res = await supertest(app)
|
|
98
|
+
.post("/__raw-body-echo")
|
|
99
|
+
.set("Content-Type", "application/x-www-form-urlencoded")
|
|
100
|
+
.send(payload)
|
|
101
|
+
.expect(200);
|
|
102
|
+
|
|
103
|
+
assert.strictEqual(res.body.rawBodyUtf8, payload);
|
|
104
|
+
assert.strictEqual(res.body.body.MessageSid, "SM123");
|
|
105
|
+
assert.strictEqual(res.body.body.MessageStatus, "delivered");
|
|
106
|
+
});
|
|
107
|
+
});
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type {IncomingMessage, OutgoingMessage} from "node:http";
|
|
2
|
+
import type {Request} from "express";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Copies the parsed request buffer onto `req.rawBody`.
|
|
6
|
+
* Express may reuse `buf`; webhook signatures need the original bytes.
|
|
7
|
+
*/
|
|
8
|
+
/** @internal */
|
|
9
|
+
export const captureRawBody = (req: IncomingMessage, _res: OutgoingMessage, buf: Buffer): void => {
|
|
10
|
+
if (!Buffer.isBuffer(buf)) {
|
|
11
|
+
return;
|
|
12
|
+
}
|
|
13
|
+
(req as Request).rawBody = Buffer.from(buf);
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
export const jsonBodyParserOptions = {
|
|
17
|
+
limit: "50mb" as const,
|
|
18
|
+
verify: captureRawBody,
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
export const urlencodedBodyParserOptions = {
|
|
22
|
+
extended: false as const,
|
|
23
|
+
verify: captureRawBody,
|
|
24
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import crypto from "node:crypto";
|
|
2
|
+
|
|
3
|
+
export const timingSafeEqualUtf8 = ({
|
|
4
|
+
expected,
|
|
5
|
+
provided,
|
|
6
|
+
}: {
|
|
7
|
+
expected: string;
|
|
8
|
+
provided: string;
|
|
9
|
+
}): boolean => {
|
|
10
|
+
const expectedBuf = Buffer.from(expected, "utf8");
|
|
11
|
+
const providedBuf = Buffer.from(provided, "utf8");
|
|
12
|
+
if (expectedBuf.length !== providedBuf.length) {
|
|
13
|
+
return false;
|
|
14
|
+
}
|
|
15
|
+
return crypto.timingSafeEqual(expectedBuf, providedBuf);
|
|
16
|
+
};
|