@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,124 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
|
|
4
|
+
import {APIError} from "../errors";
|
|
5
|
+
import {auditEnqueueFromEnv, createCloudTasksAuditEnqueue} from "./cloudTasksEnqueue";
|
|
6
|
+
import type {AuditEventWrite} from "./record";
|
|
7
|
+
|
|
8
|
+
const sampleWrite: AuditEventWrite = {
|
|
9
|
+
modelName: "Note",
|
|
10
|
+
operation: "create",
|
|
11
|
+
source: "modelRouter",
|
|
12
|
+
verb: "created",
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
describe("createCloudTasksAuditEnqueue", () => {
|
|
16
|
+
it("POSTs the write to the queue URL with the shared secret", async () => {
|
|
17
|
+
const created: unknown[] = [];
|
|
18
|
+
const enqueue = createCloudTasksAuditEnqueue({
|
|
19
|
+
loadModule: async () => ({
|
|
20
|
+
CloudTasksClient: class {
|
|
21
|
+
createTask = async (request: unknown): Promise<void> => {
|
|
22
|
+
created.push(request);
|
|
23
|
+
};
|
|
24
|
+
},
|
|
25
|
+
}),
|
|
26
|
+
location: "us-central1",
|
|
27
|
+
project: "proj",
|
|
28
|
+
queue: "audit-queue",
|
|
29
|
+
secret: "s3cret",
|
|
30
|
+
url: "https://api.example.com/internal/audit-events",
|
|
31
|
+
});
|
|
32
|
+
await enqueue(sampleWrite);
|
|
33
|
+
await enqueue(sampleWrite);
|
|
34
|
+
assert.equal(created.length, 2);
|
|
35
|
+
const request = created[0] as {
|
|
36
|
+
parent: string;
|
|
37
|
+
task: {httpRequest: {body: string; headers: Record<string, string>; url: string}};
|
|
38
|
+
};
|
|
39
|
+
assert.equal(request.parent, "projects/proj/locations/us-central1/queues/audit-queue");
|
|
40
|
+
assert.equal(request.task.httpRequest.url, "https://api.example.com/internal/audit-events");
|
|
41
|
+
assert.equal(request.task.httpRequest.headers["X-Terreno-Audit-Secret"], "s3cret");
|
|
42
|
+
const payload = JSON.parse(
|
|
43
|
+
Buffer.from(request.task.httpRequest.body, "base64").toString("utf8")
|
|
44
|
+
) as AuditEventWrite;
|
|
45
|
+
assert.equal(payload.modelName, "Note");
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
it("throws when @google-cloud/tasks cannot be loaded", async () => {
|
|
49
|
+
const enqueue = createCloudTasksAuditEnqueue({
|
|
50
|
+
loadModule: async () => {
|
|
51
|
+
throw new Error("not installed");
|
|
52
|
+
},
|
|
53
|
+
location: "us-central1",
|
|
54
|
+
project: "proj",
|
|
55
|
+
queue: "audit-queue",
|
|
56
|
+
secret: "s3cret",
|
|
57
|
+
url: "https://api.example.com/internal/audit-events",
|
|
58
|
+
});
|
|
59
|
+
try {
|
|
60
|
+
await enqueue(sampleWrite);
|
|
61
|
+
assert.fail("expected enqueue to throw");
|
|
62
|
+
} catch (error: unknown) {
|
|
63
|
+
assert.instanceOf(error, APIError);
|
|
64
|
+
assert.include((error as APIError).title, "@google-cloud/tasks");
|
|
65
|
+
}
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
it("throws when CloudTasksClient is missing from the module", async () => {
|
|
69
|
+
const enqueue = createCloudTasksAuditEnqueue({
|
|
70
|
+
loadModule: async () => ({}),
|
|
71
|
+
location: "us-central1",
|
|
72
|
+
project: "proj",
|
|
73
|
+
queue: "audit-queue",
|
|
74
|
+
secret: "s3cret",
|
|
75
|
+
url: "https://api.example.com/internal/audit-events",
|
|
76
|
+
});
|
|
77
|
+
try {
|
|
78
|
+
await enqueue(sampleWrite);
|
|
79
|
+
assert.fail("expected enqueue to throw");
|
|
80
|
+
} catch (error: unknown) {
|
|
81
|
+
assert.instanceOf(error, APIError);
|
|
82
|
+
assert.include((error as APIError).title, "CloudTasksClient not found");
|
|
83
|
+
}
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it("wraps a missing default @google-cloud/tasks install", async () => {
|
|
87
|
+
const enqueue = createCloudTasksAuditEnqueue({
|
|
88
|
+
location: "us-central1",
|
|
89
|
+
project: "proj",
|
|
90
|
+
queue: "audit-queue",
|
|
91
|
+
secret: "s3cret",
|
|
92
|
+
url: "https://api.example.com/internal/audit-events",
|
|
93
|
+
});
|
|
94
|
+
try {
|
|
95
|
+
await enqueue(sampleWrite);
|
|
96
|
+
assert.fail("expected enqueue to throw");
|
|
97
|
+
} catch (error: unknown) {
|
|
98
|
+
assert.instanceOf(error, APIError);
|
|
99
|
+
}
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
describe("auditEnqueueFromEnv", () => {
|
|
104
|
+
it("returns undefined until project, location, queue, url, and secret are set", () => {
|
|
105
|
+
assert.isUndefined(auditEnqueueFromEnv({}));
|
|
106
|
+
assert.isUndefined(
|
|
107
|
+
auditEnqueueFromEnv({
|
|
108
|
+
AUDIT_TASKS_SECRET: "s",
|
|
109
|
+
AUDIT_TASKS_URL: "https://example.com/internal/audit-events",
|
|
110
|
+
GCP_LOCATION: "us-central1",
|
|
111
|
+
GCP_PROJECT: "proj",
|
|
112
|
+
})
|
|
113
|
+
);
|
|
114
|
+
assert.isDefined(
|
|
115
|
+
auditEnqueueFromEnv({
|
|
116
|
+
AUDIT_TASKS_SECRET: "s",
|
|
117
|
+
AUDIT_TASKS_URL: "https://example.com/internal/audit-events",
|
|
118
|
+
GCP_LOCATION: "us-central1",
|
|
119
|
+
GCP_PROJECT: "proj",
|
|
120
|
+
GCP_TASKS_AUDIT_QUEUE: "audit-q",
|
|
121
|
+
})
|
|
122
|
+
);
|
|
123
|
+
});
|
|
124
|
+
});
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import {APIError} from "../errors";
|
|
2
|
+
import type {AuditEnqueue, AuditEventWrite} from "./record";
|
|
3
|
+
|
|
4
|
+
interface CloudTasksClient {
|
|
5
|
+
createTask: (request: {
|
|
6
|
+
parent: string;
|
|
7
|
+
task: {
|
|
8
|
+
httpRequest: {
|
|
9
|
+
body: string;
|
|
10
|
+
headers: Record<string, string>;
|
|
11
|
+
httpMethod: "POST";
|
|
12
|
+
url: string;
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
}) => Promise<unknown>;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
interface CloudTasksModule {
|
|
19
|
+
CloudTasksClient?: new () => CloudTasksClient;
|
|
20
|
+
default?: {CloudTasksClient?: new () => CloudTasksClient};
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export interface CloudTasksAuditEnqueueOptions {
|
|
24
|
+
location: string;
|
|
25
|
+
project: string;
|
|
26
|
+
queue: string;
|
|
27
|
+
secret: string;
|
|
28
|
+
url: string;
|
|
29
|
+
loadModule?: () => Promise<CloudTasksModule>;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const AUDIT_SECRET_HEADER = "X-Terreno-Audit-Secret";
|
|
33
|
+
|
|
34
|
+
export const createCloudTasksAuditEnqueue = (
|
|
35
|
+
options: CloudTasksAuditEnqueueOptions
|
|
36
|
+
): AuditEnqueue => {
|
|
37
|
+
let client: CloudTasksClient | undefined;
|
|
38
|
+
const loadModule =
|
|
39
|
+
options.loadModule ??
|
|
40
|
+
(() => {
|
|
41
|
+
const moduleName = "@google-cloud/tasks";
|
|
42
|
+
return import(/* webpackIgnore: true */ moduleName);
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
const getClient = async (): Promise<CloudTasksClient> => {
|
|
46
|
+
if (client) {
|
|
47
|
+
return client;
|
|
48
|
+
}
|
|
49
|
+
let mod: CloudTasksModule;
|
|
50
|
+
try {
|
|
51
|
+
mod = await loadModule();
|
|
52
|
+
} catch {
|
|
53
|
+
throw new APIError({
|
|
54
|
+
status: 500,
|
|
55
|
+
title:
|
|
56
|
+
"Cloud Tasks audit enqueue requires @google-cloud/tasks. Install it with: bun add @google-cloud/tasks",
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
const Client = mod.CloudTasksClient ?? mod.default?.CloudTasksClient;
|
|
60
|
+
if (!Client) {
|
|
61
|
+
throw new APIError({
|
|
62
|
+
status: 500,
|
|
63
|
+
title: "CloudTasksClient not found in @google-cloud/tasks module",
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
client = new Client();
|
|
67
|
+
return client;
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
return async (write: AuditEventWrite): Promise<void> => {
|
|
71
|
+
const tasks = await getClient();
|
|
72
|
+
const parent = `projects/${options.project}/locations/${options.location}/queues/${options.queue}`;
|
|
73
|
+
await tasks.createTask({
|
|
74
|
+
parent,
|
|
75
|
+
task: {
|
|
76
|
+
httpRequest: {
|
|
77
|
+
body: Buffer.from(JSON.stringify(write), "utf8").toString("base64"),
|
|
78
|
+
headers: {
|
|
79
|
+
"Content-Type": "application/json",
|
|
80
|
+
[AUDIT_SECRET_HEADER]: options.secret,
|
|
81
|
+
},
|
|
82
|
+
httpMethod: "POST",
|
|
83
|
+
url: options.url,
|
|
84
|
+
},
|
|
85
|
+
},
|
|
86
|
+
});
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
export const auditEnqueueFromEnv = (
|
|
91
|
+
env: NodeJS.ProcessEnv = process.env
|
|
92
|
+
): AuditEnqueue | undefined => {
|
|
93
|
+
const queue = env.GCP_TASKS_AUDIT_QUEUE;
|
|
94
|
+
const url = env.AUDIT_TASKS_URL;
|
|
95
|
+
const project = env.GCP_PROJECT;
|
|
96
|
+
const location = env.GCP_LOCATION;
|
|
97
|
+
const secret = env.AUDIT_TASKS_SECRET;
|
|
98
|
+
if (!queue || !url || !project || !location || !secret) {
|
|
99
|
+
return undefined;
|
|
100
|
+
}
|
|
101
|
+
return createCloudTasksAuditEnqueue({location, project, queue, secret, url});
|
|
102
|
+
};
|
|
103
|
+
|
|
104
|
+
export {AUDIT_SECRET_HEADER};
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
const DEFAULT_AUDIT_REDACT_SEGMENTS = [
|
|
2
|
+
"hash",
|
|
3
|
+
"password",
|
|
4
|
+
"refreshToken",
|
|
5
|
+
"salt",
|
|
6
|
+
"secret",
|
|
7
|
+
"token",
|
|
8
|
+
] as const;
|
|
9
|
+
|
|
10
|
+
const isPlainObject = (value: unknown): value is Record<string, unknown> => {
|
|
11
|
+
return Boolean(value) && typeof value === "object" && !Array.isArray(value);
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
const DEFAULT_REDACT_LOWER = DEFAULT_AUDIT_REDACT_SEGMENTS.map((segment) => segment.toLowerCase());
|
|
15
|
+
|
|
16
|
+
/** Split camelCase / snake_case keys so `tokenHash` matches default `token` and `hash`. */
|
|
17
|
+
const fieldNameParts = (name: string): string[] => {
|
|
18
|
+
return name
|
|
19
|
+
.replace(/([a-z0-9])([A-Z])/g, "$1 $2")
|
|
20
|
+
.replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2")
|
|
21
|
+
.split(/[^A-Za-z0-9]+/)
|
|
22
|
+
.filter((part) => part.length > 0)
|
|
23
|
+
.map((part) => part.toLowerCase());
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
const isRedactedSegment = (name: string, extraRedact: string[] = []): boolean => {
|
|
27
|
+
const lower = name.toLowerCase();
|
|
28
|
+
const parts = fieldNameParts(name);
|
|
29
|
+
if (
|
|
30
|
+
DEFAULT_REDACT_LOWER.includes(lower) ||
|
|
31
|
+
parts.some((part) => DEFAULT_REDACT_LOWER.includes(part))
|
|
32
|
+
) {
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
return extraRedact.some((segment) => segment.toLowerCase() === lower);
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
const redactValue = (value: unknown, extraRedact: string[]): unknown => {
|
|
39
|
+
if (Array.isArray(value)) {
|
|
40
|
+
return value.map((item) => redactValue(item, extraRedact));
|
|
41
|
+
}
|
|
42
|
+
if (isPlainObject(value)) {
|
|
43
|
+
return redactRecord(value, extraRedact);
|
|
44
|
+
}
|
|
45
|
+
return value;
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
const redactRecord = (
|
|
49
|
+
input: Record<string, unknown>,
|
|
50
|
+
extraRedact: string[]
|
|
51
|
+
): Record<string, unknown> => {
|
|
52
|
+
const out: Record<string, unknown> = {};
|
|
53
|
+
for (const [key, nested] of Object.entries(input)) {
|
|
54
|
+
if (isRedactedSegment(key, extraRedact)) {
|
|
55
|
+
continue;
|
|
56
|
+
}
|
|
57
|
+
out[key] = redactValue(nested, extraRedact);
|
|
58
|
+
}
|
|
59
|
+
return out;
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
export const toAuditPlain = (value: unknown): Record<string, unknown> | undefined => {
|
|
63
|
+
if (value === null || value === undefined) {
|
|
64
|
+
return undefined;
|
|
65
|
+
}
|
|
66
|
+
const withJson = value as {toJSON?: () => unknown};
|
|
67
|
+
const raw = typeof withJson.toJSON === "function" ? withJson.toJSON() : value;
|
|
68
|
+
if (!isPlainObject(raw)) {
|
|
69
|
+
return undefined;
|
|
70
|
+
}
|
|
71
|
+
return JSON.parse(JSON.stringify(raw)) as Record<string, unknown>;
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
const valuesEqual = (left: unknown, right: unknown): boolean => {
|
|
75
|
+
return JSON.stringify(left) === JSON.stringify(right);
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
const diffShallow = (
|
|
79
|
+
before: Record<string, unknown>,
|
|
80
|
+
after: Record<string, unknown>
|
|
81
|
+
): {after: Record<string, unknown>; before: Record<string, unknown>} => {
|
|
82
|
+
const beforeOut: Record<string, unknown> = {};
|
|
83
|
+
const afterOut: Record<string, unknown> = {};
|
|
84
|
+
const keys = new Set([...Object.keys(before), ...Object.keys(after)]);
|
|
85
|
+
for (const key of keys) {
|
|
86
|
+
const previous = before[key];
|
|
87
|
+
const next = after[key];
|
|
88
|
+
if (valuesEqual(previous, next)) {
|
|
89
|
+
continue;
|
|
90
|
+
}
|
|
91
|
+
if (previous !== undefined) {
|
|
92
|
+
beforeOut[key] = previous;
|
|
93
|
+
}
|
|
94
|
+
if (next !== undefined) {
|
|
95
|
+
afterOut[key] = next;
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
return {after: afterOut, before: beforeOut};
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
export const changedFieldDiff = ({
|
|
102
|
+
after,
|
|
103
|
+
before,
|
|
104
|
+
extraRedact = [],
|
|
105
|
+
}: {
|
|
106
|
+
after?: Record<string, unknown>;
|
|
107
|
+
before?: Record<string, unknown>;
|
|
108
|
+
extraRedact?: string[];
|
|
109
|
+
}): {after?: Record<string, unknown>; before?: Record<string, unknown>} => {
|
|
110
|
+
const redactedBefore = before ? redactRecord(before, extraRedact) : undefined;
|
|
111
|
+
const redactedAfter = after ? redactRecord(after, extraRedact) : undefined;
|
|
112
|
+
if (!redactedBefore) {
|
|
113
|
+
return redactedAfter ? {after: redactedAfter} : {};
|
|
114
|
+
}
|
|
115
|
+
if (!redactedAfter) {
|
|
116
|
+
return {before: redactedBefore};
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
const beforeOut: Record<string, unknown> = {};
|
|
120
|
+
const afterOut: Record<string, unknown> = {};
|
|
121
|
+
const keys = new Set([...Object.keys(redactedBefore), ...Object.keys(redactedAfter)]);
|
|
122
|
+
for (const key of keys) {
|
|
123
|
+
const previous = redactedBefore[key];
|
|
124
|
+
const next = redactedAfter[key];
|
|
125
|
+
if (isPlainObject(previous) && isPlainObject(next)) {
|
|
126
|
+
const nested = diffShallow(previous, next);
|
|
127
|
+
if (Object.keys(nested.before).length > 0) {
|
|
128
|
+
beforeOut[key] = nested.before;
|
|
129
|
+
}
|
|
130
|
+
if (Object.keys(nested.after).length > 0) {
|
|
131
|
+
afterOut[key] = nested.after;
|
|
132
|
+
}
|
|
133
|
+
continue;
|
|
134
|
+
}
|
|
135
|
+
if (valuesEqual(previous, next)) {
|
|
136
|
+
continue;
|
|
137
|
+
}
|
|
138
|
+
if (previous !== undefined) {
|
|
139
|
+
beforeOut[key] = previous;
|
|
140
|
+
}
|
|
141
|
+
if (next !== undefined) {
|
|
142
|
+
afterOut[key] = next;
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
return {
|
|
147
|
+
...(Object.keys(afterOut).length > 0 ? {after: afterOut} : {}),
|
|
148
|
+
...(Object.keys(beforeOut).length > 0 ? {before: beforeOut} : {}),
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
|
|
152
|
+
export const recordLabelFromDoc = (doc?: Record<string, unknown>): string | undefined => {
|
|
153
|
+
if (!doc) {
|
|
154
|
+
return undefined;
|
|
155
|
+
}
|
|
156
|
+
for (const field of ["title", "name", "email"]) {
|
|
157
|
+
const value = doc[field];
|
|
158
|
+
if (typeof value === "string" && value.length > 0) {
|
|
159
|
+
return value;
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
return undefined;
|
|
163
|
+
};
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import {timingSafeEqual} from "node:crypto";
|
|
2
|
+
|
|
3
|
+
import type {Request, Response} from "express";
|
|
4
|
+
|
|
5
|
+
import {APIError} from "../errors";
|
|
6
|
+
import {AUDIT_SECRET_HEADER} from "./cloudTasksEnqueue";
|
|
7
|
+
import type {AuditEventWrite} from "./record";
|
|
8
|
+
import {persistEnqueuedAuditEvent} from "./record";
|
|
9
|
+
|
|
10
|
+
const secretsMatch = (provided: string | undefined, expected: string): boolean => {
|
|
11
|
+
if (!provided) {
|
|
12
|
+
return false;
|
|
13
|
+
}
|
|
14
|
+
const left = Buffer.from(provided);
|
|
15
|
+
const right = Buffer.from(expected);
|
|
16
|
+
if (left.length !== right.length) {
|
|
17
|
+
return false;
|
|
18
|
+
}
|
|
19
|
+
return timingSafeEqual(left, right);
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
const isAuditEventWrite = (value: unknown): value is AuditEventWrite => {
|
|
23
|
+
if (!value || typeof value !== "object") {
|
|
24
|
+
return false;
|
|
25
|
+
}
|
|
26
|
+
const record = value as Record<string, unknown>;
|
|
27
|
+
const validOperations: AuditEventWrite["operation"][] = [
|
|
28
|
+
"arrayPush",
|
|
29
|
+
"arrayRemove",
|
|
30
|
+
"arrayUpdate",
|
|
31
|
+
"create",
|
|
32
|
+
"delete",
|
|
33
|
+
"update",
|
|
34
|
+
];
|
|
35
|
+
const validSources: AuditEventWrite["source"][] = ["admin", "modelRouter", "rbac"];
|
|
36
|
+
const validVerbs: AuditEventWrite["verb"][] = ["created", "deleted", "updated"];
|
|
37
|
+
return (
|
|
38
|
+
typeof record.modelName === "string" &&
|
|
39
|
+
record.modelName.length > 0 &&
|
|
40
|
+
typeof record.operation === "string" &&
|
|
41
|
+
validOperations.includes(record.operation as AuditEventWrite["operation"]) &&
|
|
42
|
+
typeof record.source === "string" &&
|
|
43
|
+
validSources.includes(record.source as AuditEventWrite["source"]) &&
|
|
44
|
+
typeof record.verb === "string" &&
|
|
45
|
+
validVerbs.includes(record.verb as AuditEventWrite["verb"])
|
|
46
|
+
);
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
export const handleEnqueuedAuditWrite = async ({
|
|
50
|
+
req,
|
|
51
|
+
res,
|
|
52
|
+
secret,
|
|
53
|
+
}: {
|
|
54
|
+
req: Request;
|
|
55
|
+
res: Response;
|
|
56
|
+
secret: string;
|
|
57
|
+
}): Promise<Response> => {
|
|
58
|
+
const provided = req.header(AUDIT_SECRET_HEADER);
|
|
59
|
+
if (!secretsMatch(provided, secret)) {
|
|
60
|
+
throw new APIError({status: 401, title: "Unauthorized"});
|
|
61
|
+
}
|
|
62
|
+
if (!isAuditEventWrite(req.body)) {
|
|
63
|
+
// Cloud Tasks retries every non-2xx response. This authenticated task cannot
|
|
64
|
+
// become valid on retry, so acknowledge it rather than retrying it forever.
|
|
65
|
+
return res.status(204).end();
|
|
66
|
+
}
|
|
67
|
+
await persistEnqueuedAuditEvent(req.body);
|
|
68
|
+
return res.status(204).end();
|
|
69
|
+
};
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import {afterEach, beforeEach, describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
import mongoose from "mongoose";
|
|
4
|
+
|
|
5
|
+
import type {UserModel as AuthUserModel} from "../auth";
|
|
6
|
+
import {TerrenoApp} from "../terrenoApp";
|
|
7
|
+
import {setupDb, UserModel} from "../tests";
|
|
8
|
+
import {AuditApp} from "./auditApp";
|
|
9
|
+
import {persistRbacAuditToAuditEvent} from "./rbacSink";
|
|
10
|
+
import {flushAuditRecorderForTests, resetAuditRecorderForTests} from "./record";
|
|
11
|
+
|
|
12
|
+
const typedUserModel = UserModel as unknown as AuthUserModel;
|
|
13
|
+
|
|
14
|
+
const deleteAuditEventModel = (): void => {
|
|
15
|
+
if (mongoose.connection.models.AuditEvent) {
|
|
16
|
+
mongoose.connection.deleteModel("AuditEvent");
|
|
17
|
+
}
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
describe("persistRbacAuditToAuditEvent", () => {
|
|
21
|
+
beforeEach(async () => {
|
|
22
|
+
deleteAuditEventModel();
|
|
23
|
+
resetAuditRecorderForTests();
|
|
24
|
+
await setupDb();
|
|
25
|
+
await mongoose.connection.collection("auditevents").deleteMany({});
|
|
26
|
+
new TerrenoApp({
|
|
27
|
+
skipListen: true,
|
|
28
|
+
userModel: typedUserModel,
|
|
29
|
+
})
|
|
30
|
+
.register(new AuditApp())
|
|
31
|
+
.build();
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
afterEach(() => {
|
|
35
|
+
resetAuditRecorderForTests();
|
|
36
|
+
deleteAuditEventModel();
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it("maps role.create to source rbac with created verb and permissionDelta", async () => {
|
|
40
|
+
const actorId = new mongoose.Types.ObjectId().toString();
|
|
41
|
+
await persistRbacAuditToAuditEvent({
|
|
42
|
+
action: "role.create",
|
|
43
|
+
actorId,
|
|
44
|
+
permissionDelta: {gained: {todo: ["read"]}, lost: {}},
|
|
45
|
+
targetRoleName: "manager",
|
|
46
|
+
});
|
|
47
|
+
await flushAuditRecorderForTests();
|
|
48
|
+
const events = await mongoose.connection.collection("auditevents").find({}).toArray();
|
|
49
|
+
assert.equal(events.length, 1);
|
|
50
|
+
assert.equal(events[0]?.source, "rbac");
|
|
51
|
+
assert.equal(events[0]?.verb, "created");
|
|
52
|
+
assert.equal(events[0]?.operation, "create");
|
|
53
|
+
assert.equal(events[0]?.modelName, "RbacRole");
|
|
54
|
+
assert.equal(events[0]?.recordLabel, "manager");
|
|
55
|
+
assert.deepEqual((events[0]?.after as {gained?: unknown})?.gained, {todo: ["read"]});
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it("maps denied actions to updated", async () => {
|
|
59
|
+
const actorId = new mongoose.Types.ObjectId().toString();
|
|
60
|
+
await persistRbacAuditToAuditEvent({
|
|
61
|
+
action: "role.create",
|
|
62
|
+
actorId,
|
|
63
|
+
denied: true,
|
|
64
|
+
permissionDelta: {gained: {todo: ["delete"]}, lost: {}},
|
|
65
|
+
targetUserId: actorId,
|
|
66
|
+
});
|
|
67
|
+
await flushAuditRecorderForTests();
|
|
68
|
+
const events = await mongoose.connection.collection("auditevents").find({}).toArray();
|
|
69
|
+
assert.equal(events[0]?.verb, "updated");
|
|
70
|
+
assert.equal(events[0]?.source, "rbac");
|
|
71
|
+
assert.equal(events[0]?.modelName, "User");
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it("omits a 12-character actorId that mongoose would otherwise coerce", async () => {
|
|
75
|
+
await persistRbacAuditToAuditEvent({
|
|
76
|
+
action: "role.create",
|
|
77
|
+
actorId: "microsoft123",
|
|
78
|
+
permissionDelta: {gained: {todo: ["read"]}, lost: {}},
|
|
79
|
+
targetRoleName: "manager",
|
|
80
|
+
});
|
|
81
|
+
await flushAuditRecorderForTests();
|
|
82
|
+
const event = await mongoose.connection.collection("auditevents").findOne({});
|
|
83
|
+
assert.equal(event?.modelName, "RbacRole");
|
|
84
|
+
assert.isUndefined(event?.actorId);
|
|
85
|
+
});
|
|
86
|
+
});
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type {RbacAuditWrite} from "../rbac/auditModel";
|
|
2
|
+
import type {AuditEventOperation, AuditEventVerb} from "./auditEventModel";
|
|
3
|
+
import {actorIdForAuditWrite, recordAuditEvent} from "./record";
|
|
4
|
+
|
|
5
|
+
const RBAC_AUDIT_VERBS: Record<string, AuditEventVerb> = {
|
|
6
|
+
"role.create": "created",
|
|
7
|
+
"role.remove": "deleted",
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
const operationFromVerb = (verb: AuditEventVerb): AuditEventOperation => {
|
|
11
|
+
if (verb === "created") {
|
|
12
|
+
return "create";
|
|
13
|
+
}
|
|
14
|
+
if (verb === "deleted") {
|
|
15
|
+
return "delete";
|
|
16
|
+
}
|
|
17
|
+
return "update";
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
export const persistRbacAuditToAuditEvent = async (record: RbacAuditWrite): Promise<void> => {
|
|
21
|
+
const mappedVerb = RBAC_AUDIT_VERBS[record.action];
|
|
22
|
+
const verb: AuditEventVerb = record.denied || !mappedVerb ? "updated" : mappedVerb;
|
|
23
|
+
const after: Record<string, unknown> = {
|
|
24
|
+
action: record.action,
|
|
25
|
+
denied: record.denied ?? false,
|
|
26
|
+
};
|
|
27
|
+
if (record.permissionDelta?.gained) {
|
|
28
|
+
after.gained = record.permissionDelta.gained;
|
|
29
|
+
}
|
|
30
|
+
const before = record.permissionDelta?.lost ? {lost: record.permissionDelta.lost} : undefined;
|
|
31
|
+
void recordAuditEvent({
|
|
32
|
+
actorId: actorIdForAuditWrite(record.actorId),
|
|
33
|
+
after,
|
|
34
|
+
before,
|
|
35
|
+
modelName: record.targetRoleName ? "RbacRole" : "User",
|
|
36
|
+
operation: operationFromVerb(verb),
|
|
37
|
+
recordId: record.targetUserId ?? record.targetRoleName,
|
|
38
|
+
recordLabel: record.targetRoleName ?? record.targetUserId,
|
|
39
|
+
source: "rbac",
|
|
40
|
+
verb,
|
|
41
|
+
});
|
|
42
|
+
};
|