@terreno/api 57.3.0 → 57.6.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 +11 -5
- package/bunfig.toml +1 -1
- package/dist/actions.js +197 -368
- package/dist/adminModelRouter.js +88 -173
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +10 -0
- package/dist/api.js +601 -792
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +114 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +101 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +69 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +140 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +56 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +41 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +251 -0
- package/dist/auth.js +432 -681
- package/dist/authRecovery.js +155 -269
- package/dist/authTokens.js +43 -118
- package/dist/betterAuth.d.ts +6 -0
- package/dist/betterAuthApp.js +25 -26
- package/dist/betterAuthSetup.js +258 -413
- package/dist/browserLogsRoute.d.ts +6 -0
- package/dist/browserLogsRoute.js +97 -0
- package/dist/collectionRegistry.d.ts +3 -1
- package/dist/collectionRegistry.js +43 -33
- package/dist/config.js +53 -122
- package/dist/configurationApp.js +180 -361
- package/dist/configurationPlugin.js +130 -302
- package/dist/consentApp.js +276 -421
- package/dist/docLoader.js +78 -126
- package/dist/envConfigurationPlugin.js +25 -147
- package/dist/errors.js +151 -247
- package/dist/example.js +28 -34
- package/dist/expressServer.d.ts +10 -0
- package/dist/expressServer.js +109 -255
- package/dist/frameworkModelNames.d.ts +24 -0
- package/dist/frameworkModelNames.js +31 -0
- package/dist/githubAuth.js +152 -216
- package/dist/httpClient.js +176 -264
- package/dist/index.d.ts +28 -1
- package/dist/index.js +53 -2
- package/dist/logger.js +145 -278
- package/dist/mcp/auth.js +76 -128
- package/dist/mcp/createMCPRequest.js +4 -5
- package/dist/mcp/handlers.js +268 -480
- package/dist/mcp/query.d.ts +0 -13
- package/dist/mcp/query.js +57 -151
- package/dist/mcp/registry.js +17 -30
- package/dist/mcp/schemaGenerator.js +95 -181
- package/dist/mcp/server.js +28 -100
- package/dist/mcp/serviceTokens.js +102 -191
- package/dist/mcp/toolGenerator.js +78 -191
- package/dist/middleware.js +15 -27
- package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +9 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +9 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +7 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +7 -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 +7 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +9 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +155 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +110 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +73 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +249 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +185 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/consentForm.js +6 -6
- package/dist/models/consentResponse.js +5 -5
- package/dist/models/mcpServiceToken.js +66 -156
- 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/models/versionConfig.js +5 -5
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +183 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +156 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +32 -0
- package/dist/notifiers/googleChatNotifier.js +36 -117
- package/dist/notifiers/slackNotifier.d.ts +31 -2
- package/dist/notifiers/slackNotifier.js +170 -119
- package/dist/notifiers/zoomNotifier.js +60 -111
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +113 -127
- package/dist/openApiBuilder.d.ts +14 -3
- package/dist/openApiBuilder.js +117 -159
- package/dist/openApiCompat.js +81 -148
- package/dist/openApiEtag.js +7 -7
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +301 -246
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +128 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +38 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +66 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +200 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +113 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +416 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +95 -211
- package/dist/plugins.js +125 -218
- package/dist/populate.js +130 -240
- package/dist/rateLimit/applyTrustProxy.js +1 -1
- package/dist/rateLimit/createStore.js +7 -8
- package/dist/rateLimit/memoryStore.js +22 -100
- package/dist/rateLimit/middleware.d.ts +0 -8
- package/dist/rateLimit/middleware.js +49 -101
- package/dist/rateLimit/mongoStore.d.ts +1 -0
- package/dist/rateLimit/mongoStore.js +55 -112
- package/dist/rateLimit/policies.d.ts +0 -4
- package/dist/rateLimit/policies.js +44 -80
- package/dist/rateLimit/redisStore.d.ts +1 -0
- package/dist/rateLimit/redisStore.js +40 -133
- package/dist/rbac/access.js +122 -253
- package/dist/rbac/assertAllowed.js +95 -171
- package/dist/rbac/auditModel.js +14 -58
- package/dist/rbac/backfillAdmins.js +24 -130
- package/dist/rbac/fieldViews.js +46 -141
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +51 -0
- package/dist/rbac/middleware.js +30 -96
- package/dist/rbac/modelRouterAccess.d.ts +3 -0
- package/dist/rbac/modelRouterAccess.js +133 -307
- package/dist/rbac/permissionUtils.js +40 -179
- package/dist/rbac/realtimeAccess.js +81 -147
- package/dist/rbac/resolve.d.ts +1 -1
- package/dist/rbac/resolve.js +154 -319
- package/dist/rbac/roleManager.js +318 -700
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +60 -173
- package/dist/rbac/routes.js +93 -196
- package/dist/rbac/scopes.js +39 -133
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +42 -93
- package/dist/rbac/types.d.ts +5 -0
- package/dist/rbac/userPlugin.js +3 -29
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +499 -764
- package/dist/realtime/deprecation.d.ts +1 -0
- package/dist/realtime/deprecation.js +9 -10
- package/dist/realtime/queryMatcher.js +110 -191
- package/dist/realtime/queryStore.js +35 -118
- package/dist/realtime/realtimeApp.d.ts +1 -0
- package/dist/realtime/realtimeApp.js +248 -401
- package/dist/realtime/registry.js +19 -30
- package/dist/realtime/sessionRevalidation.js +132 -358
- package/dist/realtime/socketAuth.js +89 -208
- package/dist/realtime/socketUser.js +10 -56
- package/dist/requestContext.js +93 -139
- package/dist/schemaMetadata.js +181 -265
- package/dist/scriptRunner.js +96 -266
- package/dist/scrubAdminFields.js +36 -108
- package/dist/secretProviders.js +130 -299
- package/dist/seedRunner.js +221 -514
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +82 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +25 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +176 -0
- package/dist/sync/executors.d.ts +9 -3
- package/dist/sync/executors.js +425 -598
- package/dist/sync/loadHarness.js +392 -689
- package/dist/sync/models.js +181 -341
- package/dist/sync/mutationHandler.d.ts +5 -2
- package/dist/sync/mutationHandler.js +549 -697
- package/dist/sync/registrationSideEffects.js +41 -95
- package/dist/sync/registry.js +31 -47
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +484 -760
- package/dist/sync/scripts/compactTombstones.js +83 -228
- package/dist/sync/serialize.js +18 -58
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +271 -402
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +54 -116
- package/dist/sync/syncApp.d.ts +2 -1
- package/dist/sync/syncApp.js +14 -16
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +63 -168
- package/dist/sync/syncSeqPlugin.js +430 -702
- package/dist/sync/types.d.ts +18 -0
- package/dist/syncConsents.js +113 -253
- package/dist/terrenoApp.d.ts +29 -0
- package/dist/terrenoApp.js +184 -257
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +147 -259
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +23 -56
- package/dist/tests/mongoTestSetup.js +42 -103
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +32 -101
- package/dist/tests.js +12 -51
- package/dist/transformers.js +61 -164
- package/dist/types/authToken.d.ts +3 -3
- package/dist/types/mcpServiceToken.d.ts +2 -2
- 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/utils.js +31 -93
- package/dist/vendor/wesleytodd-openapi/index.js +37 -51
- package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js +32 -40
- package/dist/vendor/wesleytodd-openapi/lib/layer-schema.js +3 -3
- package/dist/vendor/wesleytodd-openapi/lib/ui.js +50 -19
- package/dist/vendor/wesleytodd-openapi/lib/validate.js +19 -47
- package/dist/versionCheckPlugin.js +52 -100
- package/dist/webhooks/headerValue.js +2 -2
- package/dist/webhooks/idempotency/memoryStore.js +16 -59
- package/dist/webhooks/idempotency/mongoStore.js +55 -130
- package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
- package/dist/webhooks/idempotency/webhookReceipt.js +14 -14
- package/dist/webhooks/rawBody.d.ts +1 -0
- package/dist/webhooks/rawBody.js +2 -1
- package/dist/webhooks/timingSafeEqual.js +4 -5
- package/dist/webhooks/verifiers/hmac.js +17 -18
- package/dist/webhooks/verifiers/sendgrid.js +20 -22
- package/dist/webhooks/verifiers/stripe.js +31 -65
- package/dist/webhooks/verifiers/twilio.js +23 -73
- package/dist/webhooks/webhooksApp.js +78 -177
- package/dist/zodOpenApi.js +2 -2
- package/package.json +34 -28
- package/src/__snapshots__/openApi.test.ts.snap +192 -54
- package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
- package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
- package/src/__tests__/browserLogsRoute.test.ts +165 -0
- package/src/adminTypes.ts +8 -0
- package/src/api.test.ts +39 -2
- package/src/api.ts +68 -0
- package/src/audit/auditApp.test.ts +243 -0
- package/src/audit/auditApp.ts +139 -0
- package/src/audit/auditEventModel.ts +160 -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 +329 -0
- package/src/auth.test.ts +1 -1
- package/src/auth.ts +1 -1
- package/src/authRecovery.test.ts +43 -0
- package/src/authRecovery.ts +16 -10
- package/src/authTokens.ts +6 -2
- package/src/authVerification.test.ts +22 -0
- package/src/betterAuth.ts +7 -0
- package/src/betterAuthSetup.test.ts +27 -0
- package/src/betterAuthSetup.ts +1 -0
- package/src/browserLogsRoute.ts +110 -0
- package/src/collectionRegistry.test.ts +8 -9
- package/src/collectionRegistry.ts +21 -1
- package/src/configurationPlugin.test.ts +1 -11
- package/src/express.d.ts +2 -0
- package/src/expressServer.test.ts +50 -2
- package/src/expressServer.ts +10 -0
- package/src/frameworkModelNames.test.ts +62 -0
- package/src/frameworkModelNames.ts +33 -0
- package/src/index.ts +76 -0
- package/src/isolated/migrateCliConnect.isolated.ts +51 -0
- package/src/mcp/auth.test.ts +34 -1
- package/src/mcp/handlers.test.ts +275 -0
- package/src/mcp/query.ts +3 -3
- package/src/mcp/toolGenerator.test.ts +81 -0
- package/src/migrations/cli.test.ts +353 -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.ts +4 -3
- package/src/models/notification.ts +69 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +528 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/notifiers/slackNotifier.test.ts +186 -1
- package/src/notifiers/slackNotifier.ts +167 -8
- package/src/openApi.test.ts +0 -1
- package/src/openApi.ts +2 -1
- package/src/openApiBuilder.ts +14 -3
- package/src/openApiValidator.test.ts +221 -2
- package/src/openApiValidator.ts +218 -33
- 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 +262 -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 +5 -0
- package/src/plugins.ts +3 -0
- package/src/rateLimit/middleware.ts +1 -1
- package/src/rateLimit/mongoStore.ts +1 -0
- package/src/rateLimit/policies.ts +2 -2
- package/src/rateLimit/redisStore.ts +1 -0
- package/src/rbac/access.ts +11 -3
- package/src/rbac/membershipOrgAdminSource.ts +59 -0
- package/src/rbac/modelRouterAccess.ts +3 -0
- package/src/rbac/permissionUtils.test.ts +26 -5
- package/src/rbac/resolve.test.ts +34 -2
- package/src/rbac/resolve.ts +26 -7
- package/src/rbac/roleModel.test.ts +34 -1
- package/src/rbac/roleModel.ts +17 -1
- 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.ts +1 -0
- package/src/realtime/realtime.test.ts +357 -185
- package/src/realtime/realtimeApp.ts +2 -1
- package/src/schemaMetadata.test.ts +14 -0
- package/src/schemaMetadata.ts +5 -5
- 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/executors.ts +33 -6
- package/src/sync/integration.test.ts +2 -2
- package/src/sync/mutationHandler.test.ts +277 -1
- package/src/sync/mutationHandler.ts +171 -29
- package/src/sync/registry.ts +4 -0
- package/src/sync/routes.ts +52 -8
- package/src/sync/socketHandlers.ts +154 -58
- package/src/sync/streams.ts +6 -0
- package/src/sync/sync.test.ts +3 -2
- package/src/sync/syncApp.ts +2 -1
- package/src/sync/syncBatch.ts +7 -2
- package/src/sync/syncRoutes.test.ts +297 -3
- package/src/sync/syncSocket.test.ts +229 -0
- package/src/sync/types.ts +20 -0
- package/src/terrenoApp.migrations.test.ts +114 -0
- package/src/terrenoApp.test.ts +41 -0
- package/src/terrenoApp.ts +97 -31
- package/src/tests/createTestData.ts +2 -2
- package/src/tests/models.ts +10 -2
- package/src/tests/testHelper.ts +1 -7
- package/src/types/authToken.ts +2 -4
- package/src/types/mcpServiceToken.ts +1 -7
- 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/types.d.ts +1 -0
- package/src/webhooks/idempotency/webhookReceipt.ts +8 -10
- package/src/webhooks/rawBody.test.ts +33 -0
- package/src/webhooks/rawBody.ts +1 -0
- package/tsconfig.json +13 -54
- package/tsconfig.typedoc.json +4 -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,155 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.generateMigration = exports.lastSchemaAfter = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Write a timestamped migration file from the current Mongoose models vs the last
|
|
6
|
+
* committed `schemaAfter` snapshot in `migrations/`.
|
|
7
|
+
*/
|
|
8
|
+
const promises_1 = require("node:fs/promises");
|
|
9
|
+
const node_path_1 = require("node:path");
|
|
10
|
+
const luxon_1 = require("luxon");
|
|
11
|
+
const errors_1 = require("../errors");
|
|
12
|
+
const load_1 = require("./load");
|
|
13
|
+
const schemaCatalog_1 = require("./schemaCatalog");
|
|
14
|
+
const emptyCatalog = () => {
|
|
15
|
+
return { models: {} };
|
|
16
|
+
};
|
|
17
|
+
const slugify = (name) => {
|
|
18
|
+
const slug = name
|
|
19
|
+
.toLowerCase()
|
|
20
|
+
.replace(/[^a-z0-9]+/g, "-")
|
|
21
|
+
.replace(/^-+|-+$/g, "");
|
|
22
|
+
return slug.length > 0 ? slug : "auto";
|
|
23
|
+
};
|
|
24
|
+
const lastSchemaAfter = (catalogs) => {
|
|
25
|
+
for (let index = catalogs.length - 1; index >= 0; index -= 1) {
|
|
26
|
+
const snapshot = catalogs[index]?.schemaAfter;
|
|
27
|
+
if (snapshot && typeof snapshot === "object") {
|
|
28
|
+
return snapshot;
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
return undefined;
|
|
32
|
+
};
|
|
33
|
+
exports.lastSchemaAfter = lastSchemaAfter;
|
|
34
|
+
const describeOp = (op) => {
|
|
35
|
+
return `${op.kind} ${op.modelName} ${op.path ?? op.toPath ?? JSON.stringify(op.keys)}`;
|
|
36
|
+
};
|
|
37
|
+
const mongoIndexName = (keys) => {
|
|
38
|
+
return Object.entries(keys)
|
|
39
|
+
.map(([key, value]) => `${key}_${value}`)
|
|
40
|
+
.join("_");
|
|
41
|
+
};
|
|
42
|
+
const renderIndexCall = ({ collection, keys, kind, }) => {
|
|
43
|
+
const name = mongoIndexName(keys);
|
|
44
|
+
if (kind === "dropIndex") {
|
|
45
|
+
return ` await ctx.mongoose.connection.collection(${JSON.stringify(collection)}).dropIndex(${JSON.stringify(name)});`;
|
|
46
|
+
}
|
|
47
|
+
return ` await ctx.mongoose.connection.collection(${JSON.stringify(collection)}).createIndex(${JSON.stringify(keys)}, {name: ${JSON.stringify(name)}});`;
|
|
48
|
+
};
|
|
49
|
+
const renderUnsafeBody = ({ catalog, ops, reverse, }) => {
|
|
50
|
+
const detail = ops.map(describeOp).join("; ");
|
|
51
|
+
const ordered = reverse ? [...ops].reverse() : ops;
|
|
52
|
+
const safeIndexComments = [];
|
|
53
|
+
for (const op of ordered) {
|
|
54
|
+
if (!op.safe || !op.keys || (op.kind !== "addIndex" && op.kind !== "dropIndex")) {
|
|
55
|
+
continue;
|
|
56
|
+
}
|
|
57
|
+
const collection = catalog.models[op.modelName]?.collection ?? op.modelName;
|
|
58
|
+
let kind;
|
|
59
|
+
if (op.kind === "addIndex") {
|
|
60
|
+
kind = reverse ? "dropIndex" : "createIndex";
|
|
61
|
+
}
|
|
62
|
+
else {
|
|
63
|
+
kind = reverse ? "createIndex" : "dropIndex";
|
|
64
|
+
}
|
|
65
|
+
safeIndexComments.push(` // ${renderIndexCall({ collection, keys: op.keys, kind }).trim()}`);
|
|
66
|
+
}
|
|
67
|
+
const commentBlock = safeIndexComments.length > 0
|
|
68
|
+
? ` // Keep these safe index operations when replacing the stub:\n${safeIndexComments.join("\n")}\n`
|
|
69
|
+
: "";
|
|
70
|
+
return `${commentBlock} throw new Error(${JSON.stringify(`Unsafe migration stub: ${detail}. Replace this stub with a backfill before applying.`)});`;
|
|
71
|
+
};
|
|
72
|
+
const renderSafeUp = (ops, catalog) => {
|
|
73
|
+
const lines = [" if (ctx.dryRun) {", " return;", " }"];
|
|
74
|
+
for (const op of ops) {
|
|
75
|
+
const collection = catalog.models[op.modelName]?.collection ?? op.modelName;
|
|
76
|
+
if (op.kind === "addIndex" && op.keys) {
|
|
77
|
+
lines.push(renderIndexCall({ collection, keys: op.keys, kind: "createIndex" }));
|
|
78
|
+
continue;
|
|
79
|
+
}
|
|
80
|
+
if (op.kind === "dropIndex" && op.keys) {
|
|
81
|
+
lines.push(renderIndexCall({ collection, keys: op.keys, kind: "dropIndex" }));
|
|
82
|
+
continue;
|
|
83
|
+
}
|
|
84
|
+
if (op.kind === "addOptionalField") {
|
|
85
|
+
lines.push(` // Optional field ${op.modelName}.${op.path} is schemaless in Mongo; snapshot only.`);
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
return lines.join("\n");
|
|
89
|
+
};
|
|
90
|
+
const renderSafeDown = (ops, catalog) => {
|
|
91
|
+
const lines = [" if (ctx.dryRun) {", " return;", " }"];
|
|
92
|
+
for (const op of [...ops].reverse()) {
|
|
93
|
+
const collection = catalog.models[op.modelName]?.collection ?? op.modelName;
|
|
94
|
+
if (op.kind === "addIndex" && op.keys) {
|
|
95
|
+
lines.push(renderIndexCall({ collection, keys: op.keys, kind: "dropIndex" }));
|
|
96
|
+
continue;
|
|
97
|
+
}
|
|
98
|
+
if (op.kind === "dropIndex" && op.keys) {
|
|
99
|
+
lines.push(renderIndexCall({ collection, keys: op.keys, kind: "createIndex" }));
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
return lines.join("\n");
|
|
103
|
+
};
|
|
104
|
+
const renderFile = ({ catalog, id, ops, }) => {
|
|
105
|
+
const unsafe = ops.some((op) => !op.safe);
|
|
106
|
+
const upBody = unsafe
|
|
107
|
+
? renderUnsafeBody({ catalog, ops, reverse: false })
|
|
108
|
+
: renderSafeUp(ops, catalog);
|
|
109
|
+
const downBody = unsafe
|
|
110
|
+
? renderUnsafeBody({ catalog, ops, reverse: true })
|
|
111
|
+
: renderSafeDown(ops, catalog);
|
|
112
|
+
return `export const id = ${JSON.stringify(id)};
|
|
113
|
+
|
|
114
|
+
export const schemaAfter = ${JSON.stringify(catalog)};
|
|
115
|
+
|
|
116
|
+
export const up = async (ctx) => {
|
|
117
|
+
${upBody}
|
|
118
|
+
};
|
|
119
|
+
|
|
120
|
+
export const down = async (ctx) => {
|
|
121
|
+
${downBody}
|
|
122
|
+
};
|
|
123
|
+
`;
|
|
124
|
+
};
|
|
125
|
+
const generateMigration = async ({ dir, models, name = "auto", now = () => luxon_1.DateTime.now(), }) => {
|
|
126
|
+
await (0, promises_1.mkdir)(dir, { recursive: true });
|
|
127
|
+
let previous = emptyCatalog();
|
|
128
|
+
try {
|
|
129
|
+
const loaded = await (0, load_1.checkMigrationFiles)({ dir });
|
|
130
|
+
previous = (0, exports.lastSchemaAfter)(loaded) ?? emptyCatalog();
|
|
131
|
+
}
|
|
132
|
+
catch (error) {
|
|
133
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
134
|
+
if (!message.includes("ENOENT")) {
|
|
135
|
+
throw error;
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
if (models.length === 0) {
|
|
139
|
+
throw new errors_1.APIError({
|
|
140
|
+
detail: "Pass a --models module that exports models or {models: Model[]}.",
|
|
141
|
+
status: 400,
|
|
142
|
+
title: "No Mongoose models found",
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
const catalog = (0, schemaCatalog_1.buildSchemaCatalog)({ models });
|
|
146
|
+
const diff = (0, schemaCatalog_1.diffSchemaCatalog)({ after: catalog, before: previous });
|
|
147
|
+
if (diff.ops.length === 0) {
|
|
148
|
+
return { noop: true, path: null };
|
|
149
|
+
}
|
|
150
|
+
const id = `${now().toUTC().toFormat("yyyyMMddHHmmss")}-${slugify(name)}`;
|
|
151
|
+
const path = (0, node_path_1.join)(dir, `${id}.ts`);
|
|
152
|
+
await (0, promises_1.writeFile)(path, renderFile({ catalog, id, ops: diff.ops }), "utf8");
|
|
153
|
+
return { noop: false, path };
|
|
154
|
+
};
|
|
155
|
+
exports.generateMigration = generateMigration;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { LoadedMigration } from "./types";
|
|
2
|
+
export declare const MIGRATION_FILENAME: RegExp;
|
|
3
|
+
/**
|
|
4
|
+
* Pick a real on-disk migrations directory.
|
|
5
|
+
* `bun build --compile` rewrites `import.meta.url` to `$bunfs`, which is not
|
|
6
|
+
* scandir-able. Prefer an explicit real `dir`, then `MIGRATIONS_DIR`, then
|
|
7
|
+
* `<cwd>/migrations`.
|
|
8
|
+
*/
|
|
9
|
+
export declare const resolveMigrationDir: ({ cwd, dir, envDir, }: {
|
|
10
|
+
cwd?: string;
|
|
11
|
+
dir?: string;
|
|
12
|
+
envDir?: string;
|
|
13
|
+
}) => string;
|
|
14
|
+
export declare const checkMigrationFiles: ({ dir }: {
|
|
15
|
+
dir: string;
|
|
16
|
+
}) => Promise<LoadedMigration[]>;
|
|
17
|
+
/** Public alias for `checkMigrationFiles`; kept as a wrapper so Knip does not treat it as a duplicate export. */
|
|
18
|
+
export declare const loadMigrations: ({ dir }: {
|
|
19
|
+
dir: string;
|
|
20
|
+
}) => Promise<LoadedMigration[]>;
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.loadMigrations = exports.checkMigrationFiles = exports.resolveMigrationDir = exports.MIGRATION_FILENAME = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Load and validate timestamped `migrations/<YYYYMMDDHHmmss>-<slug>.ts` files
|
|
6
|
+
* without connecting to Mongo. Used by `terreno-migrate check` and as input to the runner.
|
|
7
|
+
*/
|
|
8
|
+
const node_crypto_1 = require("node:crypto");
|
|
9
|
+
const promises_1 = require("node:fs/promises");
|
|
10
|
+
const node_path_1 = require("node:path");
|
|
11
|
+
const node_url_1 = require("node:url");
|
|
12
|
+
const errors_1 = require("../errors");
|
|
13
|
+
exports.MIGRATION_FILENAME = /^(\d{14})-[a-z0-9-]+\.ts$/;
|
|
14
|
+
/** Bun compile (`bun build --compile`) puts modules on a virtual FS. */
|
|
15
|
+
const isBunVirtualFsPath = (value) => {
|
|
16
|
+
return value.includes("$bunfs");
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Pick a real on-disk migrations directory.
|
|
20
|
+
* `bun build --compile` rewrites `import.meta.url` to `$bunfs`, which is not
|
|
21
|
+
* scandir-able. Prefer an explicit real `dir`, then `MIGRATIONS_DIR`, then
|
|
22
|
+
* `<cwd>/migrations`.
|
|
23
|
+
*/
|
|
24
|
+
const resolveMigrationDir = ({ cwd = process.cwd(), dir, envDir = process.env.MIGRATIONS_DIR, }) => {
|
|
25
|
+
if (dir && !isBunVirtualFsPath(dir)) {
|
|
26
|
+
return dir;
|
|
27
|
+
}
|
|
28
|
+
if (envDir) {
|
|
29
|
+
return envDir;
|
|
30
|
+
}
|
|
31
|
+
return (0, node_path_1.join)(cwd, "migrations");
|
|
32
|
+
};
|
|
33
|
+
exports.resolveMigrationDir = resolveMigrationDir;
|
|
34
|
+
const readMigrationFilenames = async (dir) => {
|
|
35
|
+
try {
|
|
36
|
+
return await (0, promises_1.readdir)(dir);
|
|
37
|
+
}
|
|
38
|
+
catch (error) {
|
|
39
|
+
const code = error.code;
|
|
40
|
+
if (code === "ENOENT") {
|
|
41
|
+
throw new errors_1.APIError({
|
|
42
|
+
detail: `No directory at ${dir}`,
|
|
43
|
+
status: 404,
|
|
44
|
+
title: "Migration directory not found",
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
throw error;
|
|
48
|
+
}
|
|
49
|
+
};
|
|
50
|
+
const checksumOf = (source) => {
|
|
51
|
+
return (0, node_crypto_1.createHash)("sha256").update(source).digest("hex");
|
|
52
|
+
};
|
|
53
|
+
const expectedIdFromFilename = (filename) => {
|
|
54
|
+
return filename.replace(/\.ts$/, "");
|
|
55
|
+
};
|
|
56
|
+
const checkMigrationFiles = async ({ dir }) => {
|
|
57
|
+
const resolvedDir = (0, exports.resolveMigrationDir)({ dir });
|
|
58
|
+
const entries = await readMigrationFilenames(resolvedDir);
|
|
59
|
+
const files = entries.filter((name) => name.endsWith(".ts")).sort();
|
|
60
|
+
const loaded = [];
|
|
61
|
+
const seenIds = new Set();
|
|
62
|
+
for (const filename of files) {
|
|
63
|
+
if (!exports.MIGRATION_FILENAME.test(filename)) {
|
|
64
|
+
throw new errors_1.APIError({
|
|
65
|
+
detail: `Expected YYYYMMDDHHmmss-slug.ts, received ${filename}`,
|
|
66
|
+
status: 400,
|
|
67
|
+
title: "Invalid migration filename",
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
const source = await (0, promises_1.readFile)((0, node_path_1.join)(resolvedDir, filename), "utf8");
|
|
71
|
+
const mod = (await import((0, node_url_1.pathToFileURL)((0, node_path_1.join)(resolvedDir, filename)).href));
|
|
72
|
+
const expectedId = expectedIdFromFilename(filename);
|
|
73
|
+
if (mod.id !== expectedId) {
|
|
74
|
+
throw new errors_1.APIError({
|
|
75
|
+
detail: `File ${filename} exported id ${String(mod.id)}`,
|
|
76
|
+
status: 400,
|
|
77
|
+
title: "Migration id does not match filename",
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
if (typeof mod.up !== "function") {
|
|
81
|
+
throw new errors_1.APIError({
|
|
82
|
+
detail: `${filename} must export an up function`,
|
|
83
|
+
status: 400,
|
|
84
|
+
title: "Migration missing up",
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
if (seenIds.has(mod.id)) {
|
|
88
|
+
throw new errors_1.APIError({
|
|
89
|
+
detail: `Duplicate migration id ${mod.id}`,
|
|
90
|
+
status: 400,
|
|
91
|
+
title: "Duplicate migration id",
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
seenIds.add(mod.id);
|
|
95
|
+
loaded.push({
|
|
96
|
+
checksum: checksumOf(source),
|
|
97
|
+
down: mod.down,
|
|
98
|
+
id: mod.id,
|
|
99
|
+
schemaAfter: mod.schemaAfter,
|
|
100
|
+
up: mod.up,
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
return loaded;
|
|
104
|
+
};
|
|
105
|
+
exports.checkMigrationFiles = checkMigrationFiles;
|
|
106
|
+
/** Public alias for `checkMigrationFiles`; kept as a wrapper so Knip does not treat it as a duplicate export. */
|
|
107
|
+
const loadMigrations = async ({ dir }) => {
|
|
108
|
+
return (0, exports.checkMigrationFiles)({ dir });
|
|
109
|
+
};
|
|
110
|
+
exports.loadMigrations = loadMigrations;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { DateTime } from "luxon";
|
|
2
|
+
import type mongoose from "mongoose";
|
|
3
|
+
/** Default lock lifetime before another runner may steal it. */
|
|
4
|
+
export declare const MIGRATION_LOCK_TTL_MS: number;
|
|
5
|
+
export interface WithMigrationLockOptions<T> {
|
|
6
|
+
connection: mongoose.Connection;
|
|
7
|
+
fn: () => Promise<T>;
|
|
8
|
+
ttlMs?: number;
|
|
9
|
+
pollMs?: number;
|
|
10
|
+
holder?: string;
|
|
11
|
+
now?: () => DateTime;
|
|
12
|
+
}
|
|
13
|
+
export declare const withMigrationLock: <T>({ connection, fn, holder, now, pollMs, ttlMs, }: WithMigrationLockOptions<T>) => Promise<T>;
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.withMigrationLock = exports.MIGRATION_LOCK_TTL_MS = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Exclusive lock for wet migrate so concurrent CLI, boot, and admin runs cannot
|
|
6
|
+
* double-apply. Holders heartbeat; a stale lock may be stolen after the TTL.
|
|
7
|
+
*/
|
|
8
|
+
const node_crypto_1 = require("node:crypto");
|
|
9
|
+
const luxon_1 = require("luxon");
|
|
10
|
+
const types_1 = require("./types");
|
|
11
|
+
/** Default lock lifetime before another runner may steal it. */
|
|
12
|
+
exports.MIGRATION_LOCK_TTL_MS = 10 * 60 * 1000;
|
|
13
|
+
const lockCollection = (connection) => {
|
|
14
|
+
return connection.collection(types_1.MIGRATIONS_COLLECTION);
|
|
15
|
+
};
|
|
16
|
+
const isDuplicateKey = (error) => {
|
|
17
|
+
if (typeof error !== "object" || error === null) {
|
|
18
|
+
return false;
|
|
19
|
+
}
|
|
20
|
+
const code = "code" in error ? error.code : undefined;
|
|
21
|
+
return code === 11000;
|
|
22
|
+
};
|
|
23
|
+
const tryAcquire = async ({ col, expiresAt, holder, nowJs, }) => {
|
|
24
|
+
try {
|
|
25
|
+
await col.insertOne({
|
|
26
|
+
_id: types_1.MIGRATION_LOCK_ID,
|
|
27
|
+
expiresAt,
|
|
28
|
+
heartbeatAt: nowJs,
|
|
29
|
+
holder,
|
|
30
|
+
});
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
catch (error) {
|
|
34
|
+
if (!isDuplicateKey(error)) {
|
|
35
|
+
throw error;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
const stolen = await col.findOneAndUpdate({ _id: types_1.MIGRATION_LOCK_ID, expiresAt: { $lte: nowJs } }, { $set: { expiresAt, heartbeatAt: nowJs, holder } }, { returnDocument: "after" });
|
|
39
|
+
return stolen !== null && stolen.holder === holder;
|
|
40
|
+
};
|
|
41
|
+
const withMigrationLock = async ({ connection, fn, holder = (0, node_crypto_1.randomUUID)(), now = () => luxon_1.DateTime.now(), pollMs = 1000, ttlMs = exports.MIGRATION_LOCK_TTL_MS, }) => {
|
|
42
|
+
const col = lockCollection(connection);
|
|
43
|
+
const acquire = async () => {
|
|
44
|
+
while (true) {
|
|
45
|
+
const nowDt = now();
|
|
46
|
+
const nowJs = nowDt.toJSDate();
|
|
47
|
+
const expiresAt = nowDt.plus({ milliseconds: ttlMs }).toJSDate();
|
|
48
|
+
const acquired = await tryAcquire({ col, expiresAt, holder, nowJs });
|
|
49
|
+
if (acquired) {
|
|
50
|
+
return;
|
|
51
|
+
}
|
|
52
|
+
await Bun.sleep(pollMs);
|
|
53
|
+
}
|
|
54
|
+
};
|
|
55
|
+
await acquire();
|
|
56
|
+
const heartbeat = setInterval(() => {
|
|
57
|
+
const nowDt = now();
|
|
58
|
+
void col.updateOne({ _id: types_1.MIGRATION_LOCK_ID, holder }, {
|
|
59
|
+
$set: {
|
|
60
|
+
expiresAt: nowDt.plus({ milliseconds: ttlMs }).toJSDate(),
|
|
61
|
+
heartbeatAt: nowDt.toJSDate(),
|
|
62
|
+
},
|
|
63
|
+
});
|
|
64
|
+
}, Math.max(50, Math.floor(ttlMs / 3)));
|
|
65
|
+
try {
|
|
66
|
+
return await fn();
|
|
67
|
+
}
|
|
68
|
+
finally {
|
|
69
|
+
clearInterval(heartbeat);
|
|
70
|
+
await col.deleteOne({ _id: types_1.MIGRATION_LOCK_ID, holder });
|
|
71
|
+
}
|
|
72
|
+
};
|
|
73
|
+
exports.withMigrationLock = withMigrationLock;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import mongoose from "mongoose";
|
|
2
|
+
import { type LoadedMigration, type MigrationStatus, type RunDownMigrationsOptions, type RunDownMigrationsResult, type RunMigrationsOptions, type RunMigrationsResult } from "./types";
|
|
3
|
+
export declare const runMigrations: ({ addLog, checkCancellation, connection, dryRun, lockPollMs, lockTtlMs, logger, migrations, mongoose: mongooseNs, }: RunMigrationsOptions) => Promise<RunMigrationsResult>;
|
|
4
|
+
export declare const getMigrationStatus: ({ connection, migrations, }: {
|
|
5
|
+
connection: mongoose.Connection;
|
|
6
|
+
migrations: LoadedMigration[];
|
|
7
|
+
}) => Promise<MigrationStatus>;
|
|
8
|
+
export declare const runDownMigrations: ({ connection, dryRun, lockPollMs, lockTtlMs, logger, migrations, mongoose: mongooseNs, steps, }: RunDownMigrationsOptions) => Promise<RunDownMigrationsResult>;
|
|
9
|
+
export interface AssertMigrationsAllowedOptions {
|
|
10
|
+
allowEnv: boolean;
|
|
11
|
+
dryRun: boolean;
|
|
12
|
+
force: boolean;
|
|
13
|
+
isProduction: boolean;
|
|
14
|
+
}
|
|
15
|
+
/** Fail closed for production wet apply unless ALLOW_MIGRATIONS and force (CLI `--force` or boot/admin Apply). */
|
|
16
|
+
export declare const assertMigrationsAllowed: ({ allowEnv, dryRun, force, isProduction, }: AssertMigrationsAllowedOptions) => void;
|
|
17
|
+
export interface StartupMigrationsOption {
|
|
18
|
+
dir: string;
|
|
19
|
+
runOnStart?: boolean;
|
|
20
|
+
}
|
|
21
|
+
export declare const runStartupMigrations: ({ env, migrations, mongoose: mongooseNs, }: {
|
|
22
|
+
env?: NodeJS.ProcessEnv;
|
|
23
|
+
migrations?: StartupMigrationsOption;
|
|
24
|
+
mongoose: typeof mongoose;
|
|
25
|
+
}) => Promise<{
|
|
26
|
+
applied: string[];
|
|
27
|
+
ran: boolean;
|
|
28
|
+
}>;
|
|
29
|
+
export interface ExerciseReversibleMigrationsOptions {
|
|
30
|
+
dir: string;
|
|
31
|
+
connect: () => Promise<mongoose.Connection>;
|
|
32
|
+
}
|
|
33
|
+
export interface ExerciseReversibleMigrationsResult {
|
|
34
|
+
applied: string[];
|
|
35
|
+
reversed: string[];
|
|
36
|
+
skippedIrreversible: string | null;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* CI helper: apply every file, then roll back in reverse until a file without
|
|
40
|
+
* `down` stops the chain. The irreversible id is recorded; earlier files stay applied.
|
|
41
|
+
*/
|
|
42
|
+
export declare const exerciseReversibleMigrations: ({ connect, dir, }: ExerciseReversibleMigrationsOptions) => Promise<ExerciseReversibleMigrationsResult>;
|
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.exerciseReversibleMigrations = exports.runStartupMigrations = exports.assertMigrationsAllowed = exports.runDownMigrations = exports.getMigrationStatus = exports.runMigrations = void 0;
|
|
7
|
+
/**
|
|
8
|
+
* Apply, roll back, and inspect MongoDB migration history. This module also
|
|
9
|
+
* owns the production wet-apply gate, the TerrenoApp `runOnStart` hook, and the
|
|
10
|
+
* CI helper that applies then reverses reversible files.
|
|
11
|
+
*/
|
|
12
|
+
const luxon_1 = require("luxon");
|
|
13
|
+
const mongoose_1 = __importDefault(require("mongoose"));
|
|
14
|
+
const errors_1 = require("../errors");
|
|
15
|
+
const logger_1 = require("../logger");
|
|
16
|
+
const load_1 = require("./load");
|
|
17
|
+
const lock_1 = require("./lock");
|
|
18
|
+
const types_1 = require("./types");
|
|
19
|
+
const historyCollection = (connection) => {
|
|
20
|
+
return connection.collection(types_1.MIGRATIONS_COLLECTION);
|
|
21
|
+
};
|
|
22
|
+
const toJsDate = (value) => {
|
|
23
|
+
if (value instanceof Date) {
|
|
24
|
+
const parsed = luxon_1.DateTime.fromJSDate(value, { zone: "utc" });
|
|
25
|
+
if (!parsed.isValid) {
|
|
26
|
+
throw new errors_1.APIError({ status: 500, title: "Invalid migration timestamp" });
|
|
27
|
+
}
|
|
28
|
+
return parsed.toJSDate();
|
|
29
|
+
}
|
|
30
|
+
const parsed = luxon_1.DateTime.fromISO(String(value ?? ""), { zone: "utc" });
|
|
31
|
+
if (!parsed.isValid) {
|
|
32
|
+
throw new errors_1.APIError({ status: 500, title: "Invalid migration timestamp" });
|
|
33
|
+
}
|
|
34
|
+
return parsed.toJSDate();
|
|
35
|
+
};
|
|
36
|
+
const loadApplied = async (connection) => {
|
|
37
|
+
const docs = await historyCollection(connection)
|
|
38
|
+
.find({ _id: { $ne: types_1.MIGRATION_LOCK_ID } })
|
|
39
|
+
.toArray();
|
|
40
|
+
const applied = new Map();
|
|
41
|
+
for (const doc of docs) {
|
|
42
|
+
const id = String(doc.id ?? doc._id);
|
|
43
|
+
applied.set(id, {
|
|
44
|
+
appliedAt: toJsDate(doc.appliedAt),
|
|
45
|
+
checksum: String(doc.checksum ?? ""),
|
|
46
|
+
id,
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
return applied;
|
|
50
|
+
};
|
|
51
|
+
const recordApplied = async ({ connection, migration, }) => {
|
|
52
|
+
await historyCollection(connection).insertOne({
|
|
53
|
+
_id: migration.id,
|
|
54
|
+
appliedAt: luxon_1.DateTime.utc().toJSDate(),
|
|
55
|
+
checksum: migration.checksum,
|
|
56
|
+
id: migration.id,
|
|
57
|
+
});
|
|
58
|
+
};
|
|
59
|
+
const runMigrations = async ({ addLog, checkCancellation, connection, dryRun, lockPollMs, lockTtlMs, logger = logger_1.logger, migrations, mongoose: mongooseNs, }) => {
|
|
60
|
+
const execute = async () => {
|
|
61
|
+
const appliedRecords = await loadApplied(connection);
|
|
62
|
+
const applied = [];
|
|
63
|
+
const skipped = [];
|
|
64
|
+
for (const migration of migrations) {
|
|
65
|
+
const existing = appliedRecords.get(migration.id);
|
|
66
|
+
if (existing) {
|
|
67
|
+
if (existing.checksum !== migration.checksum) {
|
|
68
|
+
throw new errors_1.APIError({
|
|
69
|
+
detail: `Migration ${migration.id} was applied with checksum ${existing.checksum} but the current file is ${migration.checksum}`,
|
|
70
|
+
status: 409,
|
|
71
|
+
title: "Migration checksum mismatch",
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
skipped.push(migration.id);
|
|
75
|
+
continue;
|
|
76
|
+
}
|
|
77
|
+
const ctx = {
|
|
78
|
+
addLog,
|
|
79
|
+
checkCancellation,
|
|
80
|
+
dryRun,
|
|
81
|
+
logger,
|
|
82
|
+
mongoose: mongooseNs,
|
|
83
|
+
};
|
|
84
|
+
await checkCancellation?.();
|
|
85
|
+
await migration.up(ctx);
|
|
86
|
+
applied.push(migration.id);
|
|
87
|
+
if (!dryRun) {
|
|
88
|
+
await recordApplied({ connection, migration });
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
return { applied, dryRun, skipped };
|
|
92
|
+
};
|
|
93
|
+
return (0, lock_1.withMigrationLock)({
|
|
94
|
+
connection,
|
|
95
|
+
fn: execute,
|
|
96
|
+
pollMs: lockPollMs,
|
|
97
|
+
ttlMs: lockTtlMs,
|
|
98
|
+
});
|
|
99
|
+
};
|
|
100
|
+
exports.runMigrations = runMigrations;
|
|
101
|
+
const removeApplied = async ({ connection, id, }) => {
|
|
102
|
+
await historyCollection(connection).deleteOne({ _id: id });
|
|
103
|
+
};
|
|
104
|
+
const getMigrationStatus = async ({ connection, migrations, }) => {
|
|
105
|
+
const appliedRecords = await loadApplied(connection);
|
|
106
|
+
const applied = [];
|
|
107
|
+
const pending = [];
|
|
108
|
+
for (const migration of migrations) {
|
|
109
|
+
const existing = appliedRecords.get(migration.id);
|
|
110
|
+
if (existing) {
|
|
111
|
+
applied.push(existing);
|
|
112
|
+
continue;
|
|
113
|
+
}
|
|
114
|
+
pending.push({ checksum: migration.checksum, id: migration.id });
|
|
115
|
+
}
|
|
116
|
+
const collection = historyCollection(connection);
|
|
117
|
+
const lockDoc = await collection.findOne({ _id: types_1.MIGRATION_LOCK_ID });
|
|
118
|
+
const lock = lockDoc == null
|
|
119
|
+
? null
|
|
120
|
+
: {
|
|
121
|
+
expiresAt: toJsDate(lockDoc.expiresAt),
|
|
122
|
+
holder: String(lockDoc.holder ?? ""),
|
|
123
|
+
};
|
|
124
|
+
return { applied, lock, pending };
|
|
125
|
+
};
|
|
126
|
+
exports.getMigrationStatus = getMigrationStatus;
|
|
127
|
+
const runDownMigrations = async ({ connection, dryRun, lockPollMs, lockTtlMs, logger = logger_1.logger, migrations, mongoose: mongooseNs, steps, }) => {
|
|
128
|
+
if (!Number.isInteger(steps) || steps < 1) {
|
|
129
|
+
throw new errors_1.APIError({
|
|
130
|
+
detail: "down --steps must be a positive integer",
|
|
131
|
+
status: 400,
|
|
132
|
+
title: "Invalid down steps",
|
|
133
|
+
});
|
|
134
|
+
}
|
|
135
|
+
const execute = async () => {
|
|
136
|
+
const appliedRecords = await loadApplied(connection);
|
|
137
|
+
const appliedInOrder = migrations.filter((migration) => appliedRecords.has(migration.id));
|
|
138
|
+
const targets = appliedInOrder.slice(-steps).reverse();
|
|
139
|
+
const reversed = [];
|
|
140
|
+
const reversible = targets.map((migration) => {
|
|
141
|
+
if (typeof migration.down !== "function") {
|
|
142
|
+
throw new errors_1.APIError({
|
|
143
|
+
detail: `Migration ${migration.id} has no down. Rollback stopped.`,
|
|
144
|
+
status: 400,
|
|
145
|
+
title: "Migration has no down",
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
return { down: migration.down, id: migration.id };
|
|
149
|
+
});
|
|
150
|
+
for (const migration of reversible) {
|
|
151
|
+
const ctx = {
|
|
152
|
+
dryRun,
|
|
153
|
+
logger,
|
|
154
|
+
mongoose: mongooseNs,
|
|
155
|
+
};
|
|
156
|
+
await ctx.checkCancellation?.();
|
|
157
|
+
await migration.down(ctx);
|
|
158
|
+
reversed.push(migration.id);
|
|
159
|
+
if (!dryRun) {
|
|
160
|
+
await removeApplied({ connection, id: migration.id });
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
return { dryRun, reversed };
|
|
164
|
+
};
|
|
165
|
+
return (0, lock_1.withMigrationLock)({
|
|
166
|
+
connection,
|
|
167
|
+
fn: execute,
|
|
168
|
+
pollMs: lockPollMs,
|
|
169
|
+
ttlMs: lockTtlMs,
|
|
170
|
+
});
|
|
171
|
+
};
|
|
172
|
+
exports.runDownMigrations = runDownMigrations;
|
|
173
|
+
/** Fail closed for production wet apply unless ALLOW_MIGRATIONS and force (CLI `--force` or boot/admin Apply). */
|
|
174
|
+
const assertMigrationsAllowed = ({ allowEnv, dryRun, force, isProduction, }) => {
|
|
175
|
+
if (dryRun) {
|
|
176
|
+
return;
|
|
177
|
+
}
|
|
178
|
+
if (!isProduction) {
|
|
179
|
+
return;
|
|
180
|
+
}
|
|
181
|
+
if (allowEnv && force) {
|
|
182
|
+
return;
|
|
183
|
+
}
|
|
184
|
+
const detail = allowEnv
|
|
185
|
+
? "Production wet migrations also require --force (or an equivalent boot/admin Apply)."
|
|
186
|
+
: "Set ALLOW_MIGRATIONS=true for production wet migrations.";
|
|
187
|
+
throw new errors_1.APIError({
|
|
188
|
+
detail,
|
|
189
|
+
status: 403,
|
|
190
|
+
title: "Migrations not allowed",
|
|
191
|
+
});
|
|
192
|
+
};
|
|
193
|
+
exports.assertMigrationsAllowed = assertMigrationsAllowed;
|
|
194
|
+
const runStartupMigrations = async ({ env = process.env, migrations, mongoose: mongooseNs, }) => {
|
|
195
|
+
if (!migrations?.runOnStart) {
|
|
196
|
+
return { applied: [], ran: false };
|
|
197
|
+
}
|
|
198
|
+
(0, exports.assertMigrationsAllowed)({
|
|
199
|
+
allowEnv: env.ALLOW_MIGRATIONS === "true",
|
|
200
|
+
dryRun: false,
|
|
201
|
+
force: true,
|
|
202
|
+
isProduction: env.NODE_ENV === "production",
|
|
203
|
+
});
|
|
204
|
+
const loaded = await (0, load_1.checkMigrationFiles)({ dir: migrations.dir });
|
|
205
|
+
const result = await (0, exports.runMigrations)({
|
|
206
|
+
connection: mongooseNs.connection,
|
|
207
|
+
dryRun: false,
|
|
208
|
+
migrations: loaded,
|
|
209
|
+
mongoose: mongooseNs,
|
|
210
|
+
});
|
|
211
|
+
return { applied: result.applied, ran: true };
|
|
212
|
+
};
|
|
213
|
+
exports.runStartupMigrations = runStartupMigrations;
|
|
214
|
+
/**
|
|
215
|
+
* CI helper: apply every file, then roll back in reverse until a file without
|
|
216
|
+
* `down` stops the chain. The irreversible id is recorded; earlier files stay applied.
|
|
217
|
+
*/
|
|
218
|
+
const exerciseReversibleMigrations = async ({ connect, dir, }) => {
|
|
219
|
+
const connection = await connect();
|
|
220
|
+
const migrations = await (0, load_1.checkMigrationFiles)({ dir });
|
|
221
|
+
const upResult = await (0, exports.runMigrations)({
|
|
222
|
+
connection,
|
|
223
|
+
dryRun: false,
|
|
224
|
+
migrations,
|
|
225
|
+
mongoose: mongoose_1.default,
|
|
226
|
+
});
|
|
227
|
+
const reversed = [];
|
|
228
|
+
let skippedIrreversible = null;
|
|
229
|
+
for (const migration of [...migrations].reverse()) {
|
|
230
|
+
if (typeof migration.down !== "function") {
|
|
231
|
+
skippedIrreversible = migration.id;
|
|
232
|
+
break;
|
|
233
|
+
}
|
|
234
|
+
const downResult = await (0, exports.runDownMigrations)({
|
|
235
|
+
connection,
|
|
236
|
+
dryRun: false,
|
|
237
|
+
migrations,
|
|
238
|
+
mongoose: mongoose_1.default,
|
|
239
|
+
steps: 1,
|
|
240
|
+
});
|
|
241
|
+
reversed.push(...downResult.reversed);
|
|
242
|
+
}
|
|
243
|
+
return {
|
|
244
|
+
applied: [...upResult.applied, ...upResult.skipped],
|
|
245
|
+
reversed,
|
|
246
|
+
skippedIrreversible,
|
|
247
|
+
};
|
|
248
|
+
};
|
|
249
|
+
exports.exerciseReversibleMigrations = exerciseReversibleMigrations;
|