@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,505 @@
|
|
|
1
|
+
import {afterEach, beforeEach, describe, it} from "bun:test";
|
|
2
|
+
import {authAsUser as authWithCredentials} from "@terreno/test";
|
|
3
|
+
import {assert} from "chai";
|
|
4
|
+
import type express from "express";
|
|
5
|
+
import {DateTime} from "luxon";
|
|
6
|
+
import type {Model} from "mongoose";
|
|
7
|
+
import supertest from "supertest";
|
|
8
|
+
import type TestAgent from "supertest/lib/agent";
|
|
9
|
+
import {signupUser, type UserModel as UserMongooseModel} from "../auth";
|
|
10
|
+
import {Notification} from "../models/notification";
|
|
11
|
+
import {NotificationPreference} from "../models/notificationPreference";
|
|
12
|
+
import {clearSyncRegistry} from "../sync/registry";
|
|
13
|
+
import {SyncApp} from "../sync/syncApp";
|
|
14
|
+
import {TerrenoApp} from "../terrenoApp";
|
|
15
|
+
import {authAsUser, setupDb, UserModel} from "../tests";
|
|
16
|
+
import {configureNotificationService, getNotificationService} from "./notificationService";
|
|
17
|
+
import {NotificationsApp} from "./notificationsApp";
|
|
18
|
+
import {notificationsBeforeSend} from "./notificationsBeforeSend";
|
|
19
|
+
|
|
20
|
+
interface FakeComms {
|
|
21
|
+
mailCalls: Array<{html?: string; subject: string; to: string}>;
|
|
22
|
+
mailUserIds: Array<string | undefined>;
|
|
23
|
+
pushCalls: Array<{title: string; userId: string}>;
|
|
24
|
+
smsCalls: Array<{body: string; to: string}>;
|
|
25
|
+
smsUserIds: Array<string | undefined>;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
const buildFakeComms = (
|
|
29
|
+
fakeOptions: {mailError?: Error} = {}
|
|
30
|
+
): {
|
|
31
|
+
comms: FakeComms;
|
|
32
|
+
getComms: () => FakeComms & {
|
|
33
|
+
sendMail: (
|
|
34
|
+
message: {html?: string; subject: string; to: string},
|
|
35
|
+
options?: {userId?: string}
|
|
36
|
+
) => Promise<{accepted: boolean}>;
|
|
37
|
+
sendPushToUser: (message: {title: string; userId: string}) => Promise<unknown[]>;
|
|
38
|
+
sendSms: (
|
|
39
|
+
message: {body: string; to: string},
|
|
40
|
+
options?: {userId?: string}
|
|
41
|
+
) => Promise<{accepted: boolean}>;
|
|
42
|
+
};
|
|
43
|
+
} => {
|
|
44
|
+
const comms: FakeComms = {
|
|
45
|
+
mailCalls: [],
|
|
46
|
+
mailUserIds: [],
|
|
47
|
+
pushCalls: [],
|
|
48
|
+
smsCalls: [],
|
|
49
|
+
smsUserIds: [],
|
|
50
|
+
};
|
|
51
|
+
return {
|
|
52
|
+
comms,
|
|
53
|
+
getComms: () => ({
|
|
54
|
+
...comms,
|
|
55
|
+
sendMail: async (message, options) => {
|
|
56
|
+
if (fakeOptions.mailError) {
|
|
57
|
+
throw fakeOptions.mailError;
|
|
58
|
+
}
|
|
59
|
+
comms.mailCalls.push(message);
|
|
60
|
+
comms.mailUserIds.push(options?.userId);
|
|
61
|
+
return {accepted: true};
|
|
62
|
+
},
|
|
63
|
+
sendPushToUser: async (message) => {
|
|
64
|
+
comms.pushCalls.push(message);
|
|
65
|
+
return [{accepted: true}];
|
|
66
|
+
},
|
|
67
|
+
sendSms: async (message, options) => {
|
|
68
|
+
comms.smsCalls.push(message);
|
|
69
|
+
comms.smsUserIds.push(options?.userId);
|
|
70
|
+
return {accepted: true};
|
|
71
|
+
},
|
|
72
|
+
}),
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
|
|
76
|
+
const buildApp = (
|
|
77
|
+
options: {
|
|
78
|
+
getComms?: () => ReturnType<typeof buildFakeComms>["getComms"];
|
|
79
|
+
retainDays?: number;
|
|
80
|
+
} = {}
|
|
81
|
+
): express.Application => {
|
|
82
|
+
clearSyncRegistry();
|
|
83
|
+
return new TerrenoApp({
|
|
84
|
+
skipListen: true,
|
|
85
|
+
userModel: UserModel as unknown as UserMongooseModel,
|
|
86
|
+
})
|
|
87
|
+
.register(new SyncApp({}))
|
|
88
|
+
.register(
|
|
89
|
+
new NotificationsApp({
|
|
90
|
+
getComms: options.getComms,
|
|
91
|
+
retainDays: options.retainDays,
|
|
92
|
+
userModel: UserModel,
|
|
93
|
+
})
|
|
94
|
+
)
|
|
95
|
+
.build();
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
describe("NotificationsApp", () => {
|
|
99
|
+
let userAgent: TestAgent;
|
|
100
|
+
let otherUserAgent: TestAgent;
|
|
101
|
+
let userId = "";
|
|
102
|
+
|
|
103
|
+
const clearNotificationData = async (): Promise<void> => {
|
|
104
|
+
await Notification.collection.deleteMany({});
|
|
105
|
+
await NotificationPreference.collection.deleteMany({});
|
|
106
|
+
};
|
|
107
|
+
|
|
108
|
+
beforeEach(async () => {
|
|
109
|
+
const [, notAdmin] = await setupDb();
|
|
110
|
+
userId = String(notAdmin._id);
|
|
111
|
+
const app = buildApp();
|
|
112
|
+
userAgent = await authAsUser(app, "notAdmin");
|
|
113
|
+
await UserModel.deleteOne({email: "other-user@example.com"});
|
|
114
|
+
await signupUser(UserModel, "other-user@example.com", "password");
|
|
115
|
+
otherUserAgent = await authWithCredentials(app, {
|
|
116
|
+
email: "other-user@example.com",
|
|
117
|
+
password: "password",
|
|
118
|
+
});
|
|
119
|
+
await clearNotificationData();
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
afterEach(async () => {
|
|
123
|
+
configureNotificationService({});
|
|
124
|
+
await clearNotificationData();
|
|
125
|
+
clearSyncRegistry();
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
it("notify creates one owner row when inapp is on", async () => {
|
|
129
|
+
const id = await getNotificationService().notify({
|
|
130
|
+
body: "Hello",
|
|
131
|
+
title: "Welcome",
|
|
132
|
+
userId,
|
|
133
|
+
});
|
|
134
|
+
assert.isString(id);
|
|
135
|
+
assert.isNotEmpty(id);
|
|
136
|
+
const row = await Notification.findExactlyOne({_id: id});
|
|
137
|
+
assert.equal(String(row.ownerId), userId);
|
|
138
|
+
assert.equal(row.title, "Welcome");
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
it("notify does not insert when inapp preference is off", async () => {
|
|
142
|
+
await NotificationPreference.create({inapp: false, ownerId: userId});
|
|
143
|
+
const id = await getNotificationService().notify({
|
|
144
|
+
body: "Hidden",
|
|
145
|
+
title: "Off",
|
|
146
|
+
userId,
|
|
147
|
+
});
|
|
148
|
+
assert.equal(id, "");
|
|
149
|
+
assert.equal(await Notification.countDocuments({ownerId: userId}), 0);
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
it("rejects unauthenticated list", async () => {
|
|
153
|
+
const app = buildApp();
|
|
154
|
+
await supertest(app).get("/notifications").expect(401);
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
it("can register the same plugin instance on repeated app builds", async () => {
|
|
158
|
+
clearSyncRegistry();
|
|
159
|
+
const notificationsApp = new NotificationsApp({userModel: UserModel});
|
|
160
|
+
const createApp = (): express.Application =>
|
|
161
|
+
new TerrenoApp({
|
|
162
|
+
skipListen: true,
|
|
163
|
+
userModel: UserModel as unknown as UserMongooseModel,
|
|
164
|
+
})
|
|
165
|
+
.register(new SyncApp({}))
|
|
166
|
+
.register(notificationsApp)
|
|
167
|
+
.build();
|
|
168
|
+
|
|
169
|
+
createApp();
|
|
170
|
+
const rebuilt = createApp();
|
|
171
|
+
|
|
172
|
+
await supertest(rebuilt).get("/notifications").expect(401);
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
it("blocks other users from reading a notification", async () => {
|
|
176
|
+
const id = await getNotificationService().notify({
|
|
177
|
+
body: "Private",
|
|
178
|
+
title: "Mine",
|
|
179
|
+
userId,
|
|
180
|
+
});
|
|
181
|
+
await otherUserAgent.get(`/notifications/${id}`).expect(403);
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
it("rejects HTTP create on notifications", async () => {
|
|
185
|
+
await userAgent
|
|
186
|
+
.post("/notifications")
|
|
187
|
+
.send({body: "x", ownerId: userId, title: "y"})
|
|
188
|
+
.expect(405);
|
|
189
|
+
});
|
|
190
|
+
|
|
191
|
+
it("creates notification preferences for the authenticated owner", async () => {
|
|
192
|
+
const response = await userAgent.post("/notification-preferences").send({mail: false});
|
|
193
|
+
assert.include([200, 201], response.status);
|
|
194
|
+
const preference = await NotificationPreference.findExactlyOne({ownerId: userId});
|
|
195
|
+
assert.isFalse(preference.mail);
|
|
196
|
+
assert.equal(String(preference.ownerId), userId);
|
|
197
|
+
});
|
|
198
|
+
|
|
199
|
+
it("allows creating preferences after the owner deletes the previous row", async () => {
|
|
200
|
+
const created = await userAgent.post("/notification-preferences").send({mail: false});
|
|
201
|
+
assert.include([200, 201], created.status);
|
|
202
|
+
const preferenceId = created.body.data._id as string;
|
|
203
|
+
await userAgent.delete(`/notification-preferences/${preferenceId}`).expect(204);
|
|
204
|
+
|
|
205
|
+
const recreated = await userAgent.post("/notification-preferences").send({sms: false});
|
|
206
|
+
assert.include([200, 201], recreated.status);
|
|
207
|
+
const preference = await NotificationPreference.findExactlyOne({ownerId: userId});
|
|
208
|
+
assert.isFalse(preference.sms);
|
|
209
|
+
assert.notEqual(preference._id, preferenceId);
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
it("does not allow preference PATCH to change the owner", async () => {
|
|
213
|
+
const preference = await NotificationPreference.create({ownerId: userId});
|
|
214
|
+
const otherUser = await UserModel.findOne({email: "other-user@example.com"});
|
|
215
|
+
assert.isOk(otherUser);
|
|
216
|
+
|
|
217
|
+
await userAgent
|
|
218
|
+
.patch(`/notification-preferences/${preference._id}`)
|
|
219
|
+
.send({mail: false, ownerId: String(otherUser?._id)})
|
|
220
|
+
.expect(200);
|
|
221
|
+
|
|
222
|
+
const updated = await NotificationPreference.findExactlyOne({_id: preference._id});
|
|
223
|
+
assert.equal(String(updated.ownerId), userId);
|
|
224
|
+
assert.isFalse(updated.mail);
|
|
225
|
+
});
|
|
226
|
+
|
|
227
|
+
it("rejects sync create on notifications", async () => {
|
|
228
|
+
const response = await userAgent.post("/sync/mutate").send({
|
|
229
|
+
collection: "notifications",
|
|
230
|
+
data: {body: "x", ownerId: userId, title: "y"},
|
|
231
|
+
mutationId: "notification-create-rejected",
|
|
232
|
+
operation: "create",
|
|
233
|
+
});
|
|
234
|
+
assert.equal(response.status, 403);
|
|
235
|
+
assert.equal(response.body.nack?.code, "unauthorized");
|
|
236
|
+
assert.equal(await Notification.countDocuments({ownerId: userId}), 0);
|
|
237
|
+
});
|
|
238
|
+
|
|
239
|
+
it("PATCH readAt persists and strips other fields", async () => {
|
|
240
|
+
const id = await getNotificationService().notify({
|
|
241
|
+
body: "Body",
|
|
242
|
+
title: "Original",
|
|
243
|
+
userId,
|
|
244
|
+
});
|
|
245
|
+
const readAt = DateTime.now().toISO();
|
|
246
|
+
await userAgent.patch(`/notifications/${id}`).send({readAt, title: "Hacked"}).expect(200);
|
|
247
|
+
const row = await Notification.findExactlyOne({_id: id});
|
|
248
|
+
assert.equal(row.title, "Original");
|
|
249
|
+
assert.isOk(row.readAt);
|
|
250
|
+
});
|
|
251
|
+
|
|
252
|
+
it("PATCH readAt null marks a notification unread", async () => {
|
|
253
|
+
const id = await getNotificationService().notify({
|
|
254
|
+
body: "Body",
|
|
255
|
+
title: "Read then unread",
|
|
256
|
+
userId,
|
|
257
|
+
});
|
|
258
|
+
await Notification.updateOne({_id: id}, {readAt: DateTime.now().toJSDate()});
|
|
259
|
+
await userAgent.patch(`/notifications/${id}`).send({readAt: null}).expect(200);
|
|
260
|
+
const row = await Notification.findExactlyOne({_id: id});
|
|
261
|
+
assert.isNull(row.readAt);
|
|
262
|
+
});
|
|
263
|
+
|
|
264
|
+
it("rejects invalid readAt values", async () => {
|
|
265
|
+
const id = await getNotificationService().notify({
|
|
266
|
+
body: "Body",
|
|
267
|
+
title: "Invalid readAt",
|
|
268
|
+
userId,
|
|
269
|
+
});
|
|
270
|
+
await userAgent.patch(`/notifications/${id}`).send({readAt: "not-a-date"}).expect(400);
|
|
271
|
+
await userAgent
|
|
272
|
+
.patch(`/notifications/${id}`)
|
|
273
|
+
.send({readAt: {invalid: true}})
|
|
274
|
+
.expect(400);
|
|
275
|
+
});
|
|
276
|
+
|
|
277
|
+
it("DELETE soft-deletes from list", async () => {
|
|
278
|
+
const id = await getNotificationService().notify({
|
|
279
|
+
body: "Body",
|
|
280
|
+
title: "Dismiss me",
|
|
281
|
+
userId,
|
|
282
|
+
});
|
|
283
|
+
await userAgent.delete(`/notifications/${id}`).expect(204);
|
|
284
|
+
const list = await userAgent.get("/notifications").expect(200);
|
|
285
|
+
assert.equal(list.body.data.length, 0);
|
|
286
|
+
});
|
|
287
|
+
|
|
288
|
+
it("PATCH archivedAt archives a notification without tombstoning it", async () => {
|
|
289
|
+
const id = await getNotificationService().notify({
|
|
290
|
+
body: "Archive me",
|
|
291
|
+
title: "Archive me",
|
|
292
|
+
userId,
|
|
293
|
+
});
|
|
294
|
+
const archivedAt = DateTime.now().toISO();
|
|
295
|
+
await userAgent.patch(`/notifications/${id}`).send({archivedAt}).expect(200);
|
|
296
|
+
const row = await Notification.findExactlyOne({_id: id});
|
|
297
|
+
assert.isOk(row.archivedAt);
|
|
298
|
+
assert.isFalse(row.deleted);
|
|
299
|
+
const list = await userAgent.get("/notifications").expect(200);
|
|
300
|
+
assert.equal(list.body.data.length, 1);
|
|
301
|
+
assert.equal(list.body.data[0]?._id, id);
|
|
302
|
+
});
|
|
303
|
+
|
|
304
|
+
it("rejects invalid archivedAt values", async () => {
|
|
305
|
+
const id = await getNotificationService().notify({
|
|
306
|
+
body: "Body",
|
|
307
|
+
title: "Invalid archivedAt",
|
|
308
|
+
userId,
|
|
309
|
+
});
|
|
310
|
+
await userAgent.patch(`/notifications/${id}`).send({archivedAt: "not-a-date"}).expect(400);
|
|
311
|
+
});
|
|
312
|
+
|
|
313
|
+
it("notificationsBeforeSend cancels mail when mail pref is false", async () => {
|
|
314
|
+
await NotificationPreference.create({mail: false, ownerId: userId});
|
|
315
|
+
const result = await notificationsBeforeSend({channel: "mail", userId});
|
|
316
|
+
assert.deepEqual(result, {cancel: true});
|
|
317
|
+
});
|
|
318
|
+
|
|
319
|
+
it("notificationsBeforeSend cancels push and SMS when their preferences are false", async () => {
|
|
320
|
+
await NotificationPreference.create({ownerId: userId, push: false, sms: false});
|
|
321
|
+
assert.deepEqual(await notificationsBeforeSend({channel: "push", userId}), {cancel: true});
|
|
322
|
+
assert.deepEqual(await notificationsBeforeSend({channel: "sms", userId}), {cancel: true});
|
|
323
|
+
});
|
|
324
|
+
|
|
325
|
+
it("notificationsBeforeSend does not cancel when preference row is missing", async () => {
|
|
326
|
+
const result = await notificationsBeforeSend({channel: "mail", userId});
|
|
327
|
+
assert.isUndefined(result);
|
|
328
|
+
});
|
|
329
|
+
|
|
330
|
+
it("notificationsBeforeSend never cancels verification", async () => {
|
|
331
|
+
await NotificationPreference.create({
|
|
332
|
+
inapp: false,
|
|
333
|
+
mail: false,
|
|
334
|
+
ownerId: userId,
|
|
335
|
+
push: false,
|
|
336
|
+
sms: false,
|
|
337
|
+
});
|
|
338
|
+
const result = await notificationsBeforeSend({channel: "verification", userId});
|
|
339
|
+
assert.isUndefined(result);
|
|
340
|
+
});
|
|
341
|
+
|
|
342
|
+
it("fan-out calls mail when pref on and email present", async () => {
|
|
343
|
+
const {comms, getComms} = buildFakeComms();
|
|
344
|
+
configureNotificationService({getComms, userModel: UserModel});
|
|
345
|
+
await getNotificationService().notify({
|
|
346
|
+
body: "Body",
|
|
347
|
+
title: "Mail me",
|
|
348
|
+
userId,
|
|
349
|
+
});
|
|
350
|
+
assert.equal(comms.mailCalls.length, 1);
|
|
351
|
+
assert.equal(comms.mailCalls[0]?.to, "notAdmin@example.com");
|
|
352
|
+
assert.deepEqual(comms.mailUserIds, [userId]);
|
|
353
|
+
assert.equal(comms.mailCalls[0]?.html, "<p>Body</p>");
|
|
354
|
+
});
|
|
355
|
+
|
|
356
|
+
it("fan-out escapes HTML in mail while preserving plain text", async () => {
|
|
357
|
+
const {comms, getComms} = buildFakeComms();
|
|
358
|
+
configureNotificationService({getComms, userModel: UserModel});
|
|
359
|
+
await getNotificationService().notify({
|
|
360
|
+
body: '<script>alert("x")</script> & more',
|
|
361
|
+
title: "Safe mail",
|
|
362
|
+
userId,
|
|
363
|
+
});
|
|
364
|
+
assert.equal(
|
|
365
|
+
comms.mailCalls[0]?.html,
|
|
366
|
+
"<p><script>alert("x")</script> & more</p>"
|
|
367
|
+
);
|
|
368
|
+
});
|
|
369
|
+
|
|
370
|
+
it("fan-out calls SMS and push when preferences and destinations are available", async () => {
|
|
371
|
+
const {comms, getComms} = buildFakeComms();
|
|
372
|
+
const userModel = {
|
|
373
|
+
findById: () => ({
|
|
374
|
+
select: () => ({
|
|
375
|
+
lean: async () => ({
|
|
376
|
+
email: "notAdmin@example.com",
|
|
377
|
+
phone: "+15551234567",
|
|
378
|
+
}),
|
|
379
|
+
}),
|
|
380
|
+
}),
|
|
381
|
+
} as unknown as Model<{email?: string; phone?: string}>;
|
|
382
|
+
configureNotificationService({getComms, userModel});
|
|
383
|
+
await getNotificationService().notify({
|
|
384
|
+
body: "Body",
|
|
385
|
+
title: "Every channel",
|
|
386
|
+
userId,
|
|
387
|
+
});
|
|
388
|
+
assert.deepEqual(comms.smsCalls, [{body: "Every channel: Body", to: "+15551234567"}]);
|
|
389
|
+
assert.deepEqual(comms.smsUserIds, [userId]);
|
|
390
|
+
assert.deepEqual(comms.pushCalls, [{body: "Body", title: "Every channel", userId}]);
|
|
391
|
+
});
|
|
392
|
+
|
|
393
|
+
it("fan-out skips mail when pref off", async () => {
|
|
394
|
+
const {comms, getComms} = buildFakeComms();
|
|
395
|
+
configureNotificationService({getComms, userModel: UserModel});
|
|
396
|
+
await NotificationPreference.create({mail: false, ownerId: userId});
|
|
397
|
+
await getNotificationService().notify({
|
|
398
|
+
body: "Body",
|
|
399
|
+
title: "No mail",
|
|
400
|
+
userId,
|
|
401
|
+
});
|
|
402
|
+
assert.equal(comms.mailCalls.length, 0);
|
|
403
|
+
});
|
|
404
|
+
|
|
405
|
+
it("fan-out continues SMS and push when sendMail rejects", async () => {
|
|
406
|
+
const {comms, getComms} = buildFakeComms({mailError: new Error("smtp down")});
|
|
407
|
+
const userModel = {
|
|
408
|
+
findById: () => ({
|
|
409
|
+
select: () => ({
|
|
410
|
+
lean: async () => ({
|
|
411
|
+
email: "notAdmin@example.com",
|
|
412
|
+
phone: "+15551234567",
|
|
413
|
+
}),
|
|
414
|
+
}),
|
|
415
|
+
}),
|
|
416
|
+
} as unknown as Model<{email?: string; phone?: string}>;
|
|
417
|
+
configureNotificationService({getComms, userModel});
|
|
418
|
+
const id = await getNotificationService().notify({
|
|
419
|
+
body: "Body",
|
|
420
|
+
title: "Keep going",
|
|
421
|
+
userId,
|
|
422
|
+
});
|
|
423
|
+
assert.isNotEmpty(id);
|
|
424
|
+
assert.equal(comms.mailCalls.length, 0);
|
|
425
|
+
assert.deepEqual(comms.smsCalls, [{body: "Keep going: Body", to: "+15551234567"}]);
|
|
426
|
+
assert.deepEqual(comms.pushCalls, [{body: "Body", title: "Keep going", userId}]);
|
|
427
|
+
});
|
|
428
|
+
|
|
429
|
+
it("notify resolves when getComms throws after inbox write", async () => {
|
|
430
|
+
configureNotificationService({
|
|
431
|
+
getComms: () => {
|
|
432
|
+
throw new Error("comms down");
|
|
433
|
+
},
|
|
434
|
+
userModel: UserModel,
|
|
435
|
+
});
|
|
436
|
+
const id = await getNotificationService().notify({
|
|
437
|
+
body: "Still here",
|
|
438
|
+
title: "Resilient",
|
|
439
|
+
userId,
|
|
440
|
+
});
|
|
441
|
+
assert.isNotEmpty(id);
|
|
442
|
+
});
|
|
443
|
+
|
|
444
|
+
it("mark-all-read only affects caller", async () => {
|
|
445
|
+
const otherUserId = String((await UserModel.findOne({email: "admin@example.com"}))?._id);
|
|
446
|
+
await getNotificationService().notify({body: "A", title: "A", userId});
|
|
447
|
+
await getNotificationService().notify({body: "B", title: "B", userId: otherUserId});
|
|
448
|
+
await userAgent.post("/notifications/mark-all-read").expect(200);
|
|
449
|
+
const mine = await Notification.find({ownerId: userId});
|
|
450
|
+
const theirs = await Notification.find({ownerId: otherUserId});
|
|
451
|
+
assert.isOk(mine[0]?.readAt);
|
|
452
|
+
assert.isNull(theirs[0]?.readAt ?? null);
|
|
453
|
+
});
|
|
454
|
+
|
|
455
|
+
it("retainDays 0 leaves old rows", async () => {
|
|
456
|
+
const row = await Notification.create({
|
|
457
|
+
body: "Old",
|
|
458
|
+
created: DateTime.now().minus({days: 3}).toJSDate(),
|
|
459
|
+
ownerId: userId,
|
|
460
|
+
title: "Old",
|
|
461
|
+
});
|
|
462
|
+
configureNotificationService({retainDays: 0, userModel: UserModel});
|
|
463
|
+
const swept = await getNotificationService().sweepExpired();
|
|
464
|
+
assert.equal(swept, 0);
|
|
465
|
+
const stillThere = await Notification.findById(row._id);
|
|
466
|
+
assert.isFalse(stillThere?.deleted);
|
|
467
|
+
});
|
|
468
|
+
|
|
469
|
+
it("retainDays 1 tombstones rows older than one day", async () => {
|
|
470
|
+
configureNotificationService({retainDays: 1, userModel: UserModel});
|
|
471
|
+
const row = await Notification.create({
|
|
472
|
+
body: "Stale",
|
|
473
|
+
created: DateTime.now().minus({days: 2}).toJSDate(),
|
|
474
|
+
ownerId: userId,
|
|
475
|
+
title: "Stale",
|
|
476
|
+
});
|
|
477
|
+
const swept = await getNotificationService().sweepExpired();
|
|
478
|
+
assert.equal(swept, 1);
|
|
479
|
+
const tombstoned = await Notification.findOne({_id: row._id, deleted: true});
|
|
480
|
+
assert.isTrue(tombstoned?.deleted);
|
|
481
|
+
});
|
|
482
|
+
|
|
483
|
+
it("notify sweeps expired rows when retainDays is enabled", async () => {
|
|
484
|
+
configureNotificationService({retainDays: 1, userModel: UserModel});
|
|
485
|
+
const stale = await Notification.create({
|
|
486
|
+
body: "Stale",
|
|
487
|
+
created: DateTime.now().minus({days: 2}).toJSDate(),
|
|
488
|
+
ownerId: userId,
|
|
489
|
+
title: "Stale",
|
|
490
|
+
});
|
|
491
|
+
await getNotificationService().notify({
|
|
492
|
+
body: "Fresh",
|
|
493
|
+
title: "Fresh",
|
|
494
|
+
userId,
|
|
495
|
+
});
|
|
496
|
+
const tombstoned = await Notification.findOne({_id: stale._id, deleted: true});
|
|
497
|
+
assert.isTrue(tombstoned?.deleted);
|
|
498
|
+
});
|
|
499
|
+
|
|
500
|
+
it("notification collection has no TTL index", async () => {
|
|
501
|
+
const indexes = await Notification.collection.indexes();
|
|
502
|
+
const ttl = indexes.find((index) => "expireAfterSeconds" in index);
|
|
503
|
+
assert.isUndefined(ttl);
|
|
504
|
+
});
|
|
505
|
+
});
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
import type {Application} from "express";
|
|
2
|
+
import {DateTime} from "luxon";
|
|
3
|
+
import type {Model} from "mongoose";
|
|
4
|
+
import {
|
|
5
|
+
asyncHandler,
|
|
6
|
+
type ModelRouterOptions,
|
|
7
|
+
type ModelRouterRegistration,
|
|
8
|
+
modelRouter,
|
|
9
|
+
type OpenApiMiddleware,
|
|
10
|
+
} from "../api";
|
|
11
|
+
import {authenticateMiddleware, type User} from "../auth";
|
|
12
|
+
import {APIError} from "../errors";
|
|
13
|
+
import {logger} from "../logger";
|
|
14
|
+
import {Notification} from "../models/notification";
|
|
15
|
+
import {NotificationPreference} from "../models/notificationPreference";
|
|
16
|
+
import {createOpenApiBuilder} from "../openApiBuilder";
|
|
17
|
+
import {OwnerQueryFilter, Permissions} from "../permissions";
|
|
18
|
+
import type {TerrenoPlugin} from "../terrenoPlugin";
|
|
19
|
+
import type {NotificationDocument} from "../types/notification";
|
|
20
|
+
import type {NotificationPreferenceDocument} from "../types/notificationPreference";
|
|
21
|
+
import {
|
|
22
|
+
assertValidNotificationArchivedAt,
|
|
23
|
+
assertValidNotificationReadAt,
|
|
24
|
+
configureNotificationService,
|
|
25
|
+
type NotificationServiceOptions,
|
|
26
|
+
type NotificationsCommsService,
|
|
27
|
+
} from "./notificationService";
|
|
28
|
+
|
|
29
|
+
export interface NotificationsAppOptions extends NotificationServiceOptions {
|
|
30
|
+
getComms?: () => NotificationsCommsService;
|
|
31
|
+
retainDays?: number;
|
|
32
|
+
userModel?: Model<{email?: string; phone?: string}>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
const PREFERENCE_CHANNELS = ["inapp", "mail", "push", "sms"] as const;
|
|
36
|
+
|
|
37
|
+
const parseNotificationDate = (value: unknown, fieldName: "archivedAt" | "readAt"): Date | null => {
|
|
38
|
+
if (value === null || value === undefined) {
|
|
39
|
+
return null;
|
|
40
|
+
}
|
|
41
|
+
if (value instanceof Date) {
|
|
42
|
+
return value;
|
|
43
|
+
}
|
|
44
|
+
if (typeof value === "string") {
|
|
45
|
+
const parsed = DateTime.fromISO(value);
|
|
46
|
+
if (!parsed.isValid) {
|
|
47
|
+
throw new APIError({status: 400, title: `${fieldName} must be a date or null`});
|
|
48
|
+
}
|
|
49
|
+
return parsed.toJSDate();
|
|
50
|
+
}
|
|
51
|
+
throw new APIError({status: 400, title: `${fieldName} must be a date or null`});
|
|
52
|
+
};
|
|
53
|
+
|
|
54
|
+
const sanitizeNotificationUpdate = (body: unknown): NotificationDocument => {
|
|
55
|
+
const payload = body as Partial<Pick<NotificationDocument, "archivedAt" | "readAt">> & {
|
|
56
|
+
archivedAt?: unknown;
|
|
57
|
+
readAt?: unknown;
|
|
58
|
+
};
|
|
59
|
+
const update: Partial<NotificationDocument> = {};
|
|
60
|
+
if (payload.readAt !== undefined) {
|
|
61
|
+
assertValidNotificationReadAt(payload.readAt);
|
|
62
|
+
update.readAt = parseNotificationDate(payload.readAt, "readAt");
|
|
63
|
+
}
|
|
64
|
+
if (payload.archivedAt !== undefined) {
|
|
65
|
+
assertValidNotificationArchivedAt(payload.archivedAt);
|
|
66
|
+
update.archivedAt = parseNotificationDate(payload.archivedAt, "archivedAt");
|
|
67
|
+
}
|
|
68
|
+
return update as NotificationDocument;
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
const sanitizePreferenceUpdate = (body: unknown): NotificationPreferenceDocument => {
|
|
72
|
+
const payload = body as Partial<NotificationPreferenceDocument>;
|
|
73
|
+
const update: Partial<NotificationPreferenceDocument> = {};
|
|
74
|
+
for (const channel of PREFERENCE_CHANNELS) {
|
|
75
|
+
if (channel in payload) {
|
|
76
|
+
update[channel] = payload[channel];
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
return update as NotificationPreferenceDocument;
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
export class NotificationsApp implements TerrenoPlugin {
|
|
83
|
+
private readonly options: NotificationsAppOptions;
|
|
84
|
+
private routers?: ModelRouterRegistration[];
|
|
85
|
+
|
|
86
|
+
constructor(options: NotificationsAppOptions = {}) {
|
|
87
|
+
this.options = options;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
register(app: Application, openApi?: unknown): void {
|
|
91
|
+
configureNotificationService({
|
|
92
|
+
getComms: this.options.getComms,
|
|
93
|
+
retainDays: this.options.retainDays,
|
|
94
|
+
userModel: this.options.userModel,
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
if (this.routers) {
|
|
98
|
+
for (const router of this.routers) {
|
|
99
|
+
app.use(router.path, router.router);
|
|
100
|
+
}
|
|
101
|
+
return;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const openApiMiddleware = openApi as OpenApiMiddleware | undefined;
|
|
105
|
+
const sharedRouterOptions: Partial<ModelRouterOptions<NotificationDocument>> = openApiMiddleware
|
|
106
|
+
? {openApi: openApiMiddleware}
|
|
107
|
+
: {};
|
|
108
|
+
|
|
109
|
+
const notificationsRouter = modelRouter<NotificationDocument>("/notifications", Notification, {
|
|
110
|
+
...sharedRouterOptions,
|
|
111
|
+
endpoints: (router) => {
|
|
112
|
+
router.post(
|
|
113
|
+
"/mark-all-read",
|
|
114
|
+
[
|
|
115
|
+
authenticateMiddleware(),
|
|
116
|
+
createOpenApiBuilder(sharedRouterOptions as Partial<ModelRouterOptions<unknown>>)
|
|
117
|
+
.withTags(["notifications"])
|
|
118
|
+
.withSummary("Mark all of the caller's unread notifications as read")
|
|
119
|
+
.withResponse(200, {
|
|
120
|
+
data: {
|
|
121
|
+
properties: {modified: {type: "number"}},
|
|
122
|
+
type: "object",
|
|
123
|
+
},
|
|
124
|
+
})
|
|
125
|
+
.build(),
|
|
126
|
+
],
|
|
127
|
+
asyncHandler(async (req, res) => {
|
|
128
|
+
const user = req.user as User | undefined;
|
|
129
|
+
if (!user?.id) {
|
|
130
|
+
throw new APIError({status: 401, title: "Authentication required"});
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
const unread = await Notification.find({
|
|
134
|
+
$or: [{readAt: null}, {readAt: {$exists: false}}],
|
|
135
|
+
ownerId: user.id,
|
|
136
|
+
});
|
|
137
|
+
const now = DateTime.now().toJSDate();
|
|
138
|
+
let modified = 0;
|
|
139
|
+
for (const row of unread) {
|
|
140
|
+
row.readAt = now;
|
|
141
|
+
await row.save();
|
|
142
|
+
modified += 1;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
logger.info("[notifications] mark-all-read", {modified, userId: user.id});
|
|
146
|
+
return res.json({data: {modified}});
|
|
147
|
+
})
|
|
148
|
+
);
|
|
149
|
+
},
|
|
150
|
+
permissions: {
|
|
151
|
+
create: [],
|
|
152
|
+
delete: [Permissions.IsOwner],
|
|
153
|
+
list: [Permissions.IsAuthenticated],
|
|
154
|
+
read: [Permissions.IsOwner],
|
|
155
|
+
update: [Permissions.IsOwner],
|
|
156
|
+
},
|
|
157
|
+
preUpdate: sanitizeNotificationUpdate,
|
|
158
|
+
queryFields: ["_id", "ownerId", "readAt", "archivedAt", "kind"],
|
|
159
|
+
queryFilter: OwnerQueryFilter,
|
|
160
|
+
sort: "-created",
|
|
161
|
+
sync: {scope: {type: "owner"}},
|
|
162
|
+
});
|
|
163
|
+
app.use(notificationsRouter.path, notificationsRouter.router);
|
|
164
|
+
|
|
165
|
+
const preferencesRouter = modelRouter<NotificationPreferenceDocument>(
|
|
166
|
+
"/notification-preferences",
|
|
167
|
+
NotificationPreference,
|
|
168
|
+
{
|
|
169
|
+
...(openApiMiddleware ? {openApi: openApiMiddleware} : {}),
|
|
170
|
+
permissions: {
|
|
171
|
+
create: [Permissions.IsAuthenticated],
|
|
172
|
+
delete: [Permissions.IsOwner],
|
|
173
|
+
list: [Permissions.IsAuthenticated],
|
|
174
|
+
read: [Permissions.IsOwner],
|
|
175
|
+
update: [Permissions.IsOwner],
|
|
176
|
+
},
|
|
177
|
+
preCreate: (body, req) => {
|
|
178
|
+
const user = req.user as User | undefined;
|
|
179
|
+
if (!user?.id) {
|
|
180
|
+
throw new APIError({status: 401, title: "Authentication required"});
|
|
181
|
+
}
|
|
182
|
+
const payload = body as Partial<NotificationPreferenceDocument>;
|
|
183
|
+
return {
|
|
184
|
+
...payload,
|
|
185
|
+
ownerId: user.id,
|
|
186
|
+
} as unknown as NotificationPreferenceDocument;
|
|
187
|
+
},
|
|
188
|
+
preUpdate: sanitizePreferenceUpdate,
|
|
189
|
+
queryFields: ["ownerId"],
|
|
190
|
+
queryFilter: OwnerQueryFilter,
|
|
191
|
+
sort: "-created",
|
|
192
|
+
sync: {scope: {type: "owner"}},
|
|
193
|
+
}
|
|
194
|
+
);
|
|
195
|
+
app.use(preferencesRouter.path, preferencesRouter.router);
|
|
196
|
+
this.routers = [notificationsRouter, preferencesRouter];
|
|
197
|
+
|
|
198
|
+
logger.info("NotificationsApp registered", {retainDays: this.options.retainDays ?? 0});
|
|
199
|
+
}
|
|
200
|
+
}
|