@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,333 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tests for writing a timestamped migration from a Mongoose schema diff.
|
|
3
|
+
*/
|
|
4
|
+
import {describe, expect, it} from "bun:test";
|
|
5
|
+
import {mkdtemp, readFile, rm} from "node:fs/promises";
|
|
6
|
+
import {tmpdir} from "node:os";
|
|
7
|
+
import {join} from "node:path";
|
|
8
|
+
import {DateTime} from "luxon";
|
|
9
|
+
import mongoose from "mongoose";
|
|
10
|
+
|
|
11
|
+
import {generateMigration, lastSchemaAfter} from "./generate";
|
|
12
|
+
import {checkMigrationFiles} from "./load";
|
|
13
|
+
|
|
14
|
+
const fixtures = (...parts: string[]): string => {
|
|
15
|
+
return join(import.meta.dir, "fixtures", ...parts);
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
const register = (name: string, schema: mongoose.Schema): mongoose.Model<mongoose.Document> => {
|
|
19
|
+
if (mongoose.models[name]) {
|
|
20
|
+
mongoose.deleteModel(name);
|
|
21
|
+
}
|
|
22
|
+
return mongoose.model(name, schema);
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
const makeModels = ({
|
|
26
|
+
notes,
|
|
27
|
+
requiredTitle,
|
|
28
|
+
}: {
|
|
29
|
+
notes?: boolean;
|
|
30
|
+
requiredTitle?: boolean;
|
|
31
|
+
}): mongoose.Model<mongoose.Document>[] => {
|
|
32
|
+
const schema = new mongoose.Schema(
|
|
33
|
+
{
|
|
34
|
+
title: {description: "Title", required: requiredTitle !== false, type: String},
|
|
35
|
+
...(notes ? {notes: {description: "Notes", type: String}} : {}),
|
|
36
|
+
},
|
|
37
|
+
{collection: "gen_todos"}
|
|
38
|
+
);
|
|
39
|
+
schema.index({title: 1});
|
|
40
|
+
return [register("GenTodo", schema)];
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
describe("lastSchemaAfter", () => {
|
|
44
|
+
it("returns the last object snapshot and skips missing entries", () => {
|
|
45
|
+
expect(lastSchemaAfter([])).toBeUndefined();
|
|
46
|
+
expect(lastSchemaAfter([{schemaAfter: "nope"}, {schemaAfter: {models: {}}}])).toEqual({
|
|
47
|
+
models: {},
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
describe("generateMigration", () => {
|
|
53
|
+
it("writes the first file from an empty snapshot", async () => {
|
|
54
|
+
const dir = await mkdtemp(join(tmpdir(), "migrate-gen-"));
|
|
55
|
+
try {
|
|
56
|
+
const result = await generateMigration({
|
|
57
|
+
dir,
|
|
58
|
+
models: makeModels({notes: true}),
|
|
59
|
+
name: "init",
|
|
60
|
+
now: () => DateTime.fromISO("2026-09-10T12:00:00.000Z"),
|
|
61
|
+
});
|
|
62
|
+
expect(result.noop).toBe(false);
|
|
63
|
+
expect(result.path).toContain("20260910120000-init.ts");
|
|
64
|
+
const source = await readFile(result.path as string, "utf8");
|
|
65
|
+
expect(source).toContain("schemaAfter");
|
|
66
|
+
expect(source).toContain("gen_todos");
|
|
67
|
+
const loaded = await checkMigrationFiles({dir});
|
|
68
|
+
expect(loaded).toHaveLength(1);
|
|
69
|
+
} finally {
|
|
70
|
+
await rm(dir, {force: true, recursive: true});
|
|
71
|
+
}
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it("exits as a no-op when the catalog matches the last schemaAfter", async () => {
|
|
75
|
+
const dir = await mkdtemp(join(tmpdir(), "migrate-gen-"));
|
|
76
|
+
try {
|
|
77
|
+
const models = makeModels({notes: true});
|
|
78
|
+
await generateMigration({
|
|
79
|
+
dir,
|
|
80
|
+
models,
|
|
81
|
+
name: "init",
|
|
82
|
+
now: () => DateTime.fromISO("2026-09-10T12:00:00.000Z"),
|
|
83
|
+
});
|
|
84
|
+
const second = await generateMigration({
|
|
85
|
+
dir,
|
|
86
|
+
models,
|
|
87
|
+
name: "again",
|
|
88
|
+
now: () => DateTime.fromISO("2026-09-10T12:01:00.000Z"),
|
|
89
|
+
});
|
|
90
|
+
expect(second.noop).toBe(true);
|
|
91
|
+
expect(second.path).toBeNull();
|
|
92
|
+
expect(await checkMigrationFiles({dir})).toHaveLength(1);
|
|
93
|
+
} finally {
|
|
94
|
+
await rm(dir, {force: true, recursive: true});
|
|
95
|
+
}
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
it("emits a required-field stub that throws in dry-run and wet", async () => {
|
|
99
|
+
const dir = await mkdtemp(join(tmpdir(), "migrate-gen-"));
|
|
100
|
+
try {
|
|
101
|
+
const firstModels = makeModels({notes: false, requiredTitle: false});
|
|
102
|
+
await generateMigration({
|
|
103
|
+
dir,
|
|
104
|
+
models: firstModels,
|
|
105
|
+
name: "base",
|
|
106
|
+
now: () => DateTime.fromISO("2026-09-10T12:00:00.000Z"),
|
|
107
|
+
});
|
|
108
|
+
const required = new mongoose.Schema(
|
|
109
|
+
{
|
|
110
|
+
title: {description: "Title", required: true, type: String},
|
|
111
|
+
},
|
|
112
|
+
{collection: "gen_todos"}
|
|
113
|
+
);
|
|
114
|
+
required.index({title: 1});
|
|
115
|
+
const result = await generateMigration({
|
|
116
|
+
dir,
|
|
117
|
+
models: [register("GenTodo", required)],
|
|
118
|
+
name: "require-title",
|
|
119
|
+
now: () => DateTime.fromISO("2026-09-10T12:02:00.000Z"),
|
|
120
|
+
});
|
|
121
|
+
expect(result.noop).toBe(false);
|
|
122
|
+
const loaded = await checkMigrationFiles({dir});
|
|
123
|
+
const stub = loaded[loaded.length - 1];
|
|
124
|
+
await expect(
|
|
125
|
+
stub.up({
|
|
126
|
+
dryRun: true,
|
|
127
|
+
logger: {
|
|
128
|
+
debug: () => undefined,
|
|
129
|
+
error: () => undefined,
|
|
130
|
+
info: () => undefined,
|
|
131
|
+
warn: () => undefined,
|
|
132
|
+
},
|
|
133
|
+
mongoose,
|
|
134
|
+
})
|
|
135
|
+
).rejects.toThrow("Unsafe");
|
|
136
|
+
await expect(
|
|
137
|
+
stub.up({
|
|
138
|
+
dryRun: false,
|
|
139
|
+
logger: {
|
|
140
|
+
debug: () => undefined,
|
|
141
|
+
error: () => undefined,
|
|
142
|
+
info: () => undefined,
|
|
143
|
+
warn: () => undefined,
|
|
144
|
+
},
|
|
145
|
+
mongoose,
|
|
146
|
+
})
|
|
147
|
+
).rejects.toThrow("Unsafe");
|
|
148
|
+
} finally {
|
|
149
|
+
await rm(dir, {force: true, recursive: true});
|
|
150
|
+
}
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
it("skips createIndex when a generated safe up runs with dryRun", async () => {
|
|
154
|
+
const dir = await mkdtemp(join(tmpdir(), "migrate-gen-"));
|
|
155
|
+
try {
|
|
156
|
+
const schema = new mongoose.Schema(
|
|
157
|
+
{title: {description: "Title", type: String}},
|
|
158
|
+
{collection: "gen_todos"}
|
|
159
|
+
);
|
|
160
|
+
await generateMigration({
|
|
161
|
+
dir,
|
|
162
|
+
models: [register("GenTodo", schema)],
|
|
163
|
+
name: "base",
|
|
164
|
+
now: () => DateTime.fromISO("2026-09-10T12:00:00.000Z"),
|
|
165
|
+
});
|
|
166
|
+
const indexed = new mongoose.Schema(
|
|
167
|
+
{title: {description: "Title", type: String}},
|
|
168
|
+
{collection: "gen_todos"}
|
|
169
|
+
);
|
|
170
|
+
indexed.index({title: 1});
|
|
171
|
+
const result = await generateMigration({
|
|
172
|
+
dir,
|
|
173
|
+
models: [register("GenTodo", indexed)],
|
|
174
|
+
name: "title-index",
|
|
175
|
+
now: () => DateTime.fromISO("2026-09-10T12:03:00.000Z"),
|
|
176
|
+
});
|
|
177
|
+
expect(result.noop).toBe(false);
|
|
178
|
+
const source = await readFile(result.path as string, "utf8");
|
|
179
|
+
expect(source).toContain("if (ctx.dryRun)");
|
|
180
|
+
expect(source).toContain("createIndex");
|
|
181
|
+
const loaded = await checkMigrationFiles({dir});
|
|
182
|
+
const generated = loaded[loaded.length - 1];
|
|
183
|
+
await generated.up({
|
|
184
|
+
dryRun: true,
|
|
185
|
+
logger: {
|
|
186
|
+
debug: () => undefined,
|
|
187
|
+
error: () => undefined,
|
|
188
|
+
info: () => undefined,
|
|
189
|
+
warn: () => undefined,
|
|
190
|
+
},
|
|
191
|
+
mongoose,
|
|
192
|
+
});
|
|
193
|
+
expect(source).toContain("dropIndex");
|
|
194
|
+
expect(source).toContain("title_1");
|
|
195
|
+
} finally {
|
|
196
|
+
await rm(dir, {force: true, recursive: true});
|
|
197
|
+
}
|
|
198
|
+
});
|
|
199
|
+
|
|
200
|
+
it("emits dropIndex when a generated safe down reverses an index add", async () => {
|
|
201
|
+
const dir = await mkdtemp(join(tmpdir(), "migrate-gen-"));
|
|
202
|
+
try {
|
|
203
|
+
const schema = new mongoose.Schema(
|
|
204
|
+
{title: {description: "Title", type: String}},
|
|
205
|
+
{collection: "gen_todos"}
|
|
206
|
+
);
|
|
207
|
+
schema.index({title: 1});
|
|
208
|
+
await generateMigration({
|
|
209
|
+
dir,
|
|
210
|
+
models: [register("GenTodo", schema)],
|
|
211
|
+
name: "with-index",
|
|
212
|
+
now: () => DateTime.fromISO("2026-09-10T12:00:00.000Z"),
|
|
213
|
+
});
|
|
214
|
+
const plain = new mongoose.Schema(
|
|
215
|
+
{title: {description: "Title", type: String}},
|
|
216
|
+
{collection: "gen_todos"}
|
|
217
|
+
);
|
|
218
|
+
const result = await generateMigration({
|
|
219
|
+
dir,
|
|
220
|
+
models: [register("GenTodo", plain)],
|
|
221
|
+
name: "drop-title-index",
|
|
222
|
+
now: () => DateTime.fromISO("2026-09-10T12:06:00.000Z"),
|
|
223
|
+
});
|
|
224
|
+
expect(result.noop).toBe(false);
|
|
225
|
+
const source = await readFile(result.path as string, "utf8");
|
|
226
|
+
expect(source).toContain("dropIndex");
|
|
227
|
+
expect(source).toContain("createIndex");
|
|
228
|
+
} finally {
|
|
229
|
+
await rm(dir, {force: true, recursive: true});
|
|
230
|
+
}
|
|
231
|
+
});
|
|
232
|
+
|
|
233
|
+
it("keeps safe index calls as comments when any op is unsafe", async () => {
|
|
234
|
+
const dir = await mkdtemp(join(tmpdir(), "migrate-gen-"));
|
|
235
|
+
try {
|
|
236
|
+
const result = await generateMigration({
|
|
237
|
+
dir,
|
|
238
|
+
models: makeModels({}),
|
|
239
|
+
name: "init",
|
|
240
|
+
now: () => DateTime.fromISO("2026-09-10T12:00:00.000Z"),
|
|
241
|
+
});
|
|
242
|
+
expect(result.noop).toBe(false);
|
|
243
|
+
const source = await readFile(result.path as string, "utf8");
|
|
244
|
+
expect(source).toContain("throw new Error(");
|
|
245
|
+
expect(source).toContain("Keep these safe index operations when replacing the stub");
|
|
246
|
+
expect(source).toContain("createIndex");
|
|
247
|
+
expect(source).toContain("addIndex");
|
|
248
|
+
} finally {
|
|
249
|
+
await rm(dir, {force: true, recursive: true});
|
|
250
|
+
}
|
|
251
|
+
});
|
|
252
|
+
|
|
253
|
+
it("emits a unique-index stub that is valid JavaScript", async () => {
|
|
254
|
+
const dir = await mkdtemp(join(tmpdir(), "migrate-gen-"));
|
|
255
|
+
try {
|
|
256
|
+
const base = new mongoose.Schema(
|
|
257
|
+
{title: {description: "Title", type: String}},
|
|
258
|
+
{collection: "gen_todos"}
|
|
259
|
+
);
|
|
260
|
+
await generateMigration({
|
|
261
|
+
dir,
|
|
262
|
+
models: [register("GenTodo", base)],
|
|
263
|
+
name: "base",
|
|
264
|
+
now: () => DateTime.fromISO("2026-09-10T12:00:00.000Z"),
|
|
265
|
+
});
|
|
266
|
+
const unique = new mongoose.Schema(
|
|
267
|
+
{title: {description: "Title", type: String}},
|
|
268
|
+
{collection: "gen_todos"}
|
|
269
|
+
);
|
|
270
|
+
unique.index({title: 1}, {unique: true});
|
|
271
|
+
const result = await generateMigration({
|
|
272
|
+
dir,
|
|
273
|
+
models: [register("GenTodo", unique)],
|
|
274
|
+
name: "unique-title",
|
|
275
|
+
now: () => DateTime.fromISO("2026-09-10T12:05:00.000Z"),
|
|
276
|
+
});
|
|
277
|
+
expect(result.noop).toBe(false);
|
|
278
|
+
const source = await readFile(result.path as string, "utf8");
|
|
279
|
+
expect(source).toContain("throw new Error(");
|
|
280
|
+
expect(source).not.toMatch(/throw new Error\("[^"]*\{"/);
|
|
281
|
+
const loaded = await checkMigrationFiles({dir});
|
|
282
|
+
const stub = loaded[loaded.length - 1];
|
|
283
|
+
await expect(
|
|
284
|
+
stub.up({
|
|
285
|
+
dryRun: true,
|
|
286
|
+
logger: {
|
|
287
|
+
debug: () => undefined,
|
|
288
|
+
error: () => undefined,
|
|
289
|
+
info: () => undefined,
|
|
290
|
+
warn: () => undefined,
|
|
291
|
+
},
|
|
292
|
+
mongoose,
|
|
293
|
+
})
|
|
294
|
+
).rejects.toThrow("Unsafe migration stub");
|
|
295
|
+
} finally {
|
|
296
|
+
await rm(dir, {force: true, recursive: true});
|
|
297
|
+
}
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
it("rethrows migration load errors other than a missing directory", async () => {
|
|
301
|
+
await expect(
|
|
302
|
+
generateMigration({
|
|
303
|
+
dir: fixtures("bad-name"),
|
|
304
|
+
models: makeModels({notes: true}),
|
|
305
|
+
name: "oops",
|
|
306
|
+
now: () => DateTime.fromISO("2026-09-10T12:07:00.000Z"),
|
|
307
|
+
})
|
|
308
|
+
).rejects.toThrow("Invalid migration filename");
|
|
309
|
+
});
|
|
310
|
+
|
|
311
|
+
it("fails closed when generate is called with no models", async () => {
|
|
312
|
+
const dir = await mkdtemp(join(tmpdir(), "migrate-gen-"));
|
|
313
|
+
try {
|
|
314
|
+
await generateMigration({
|
|
315
|
+
dir,
|
|
316
|
+
models: makeModels({notes: true}),
|
|
317
|
+
name: "init",
|
|
318
|
+
now: () => DateTime.fromISO("2026-09-10T12:00:00.000Z"),
|
|
319
|
+
});
|
|
320
|
+
await expect(
|
|
321
|
+
generateMigration({
|
|
322
|
+
dir,
|
|
323
|
+
models: [],
|
|
324
|
+
name: "oops",
|
|
325
|
+
now: () => DateTime.fromISO("2026-09-10T12:04:00.000Z"),
|
|
326
|
+
})
|
|
327
|
+
).rejects.toThrow("No Mongoose models found");
|
|
328
|
+
expect(await checkMigrationFiles({dir})).toHaveLength(1);
|
|
329
|
+
} finally {
|
|
330
|
+
await rm(dir, {force: true, recursive: true});
|
|
331
|
+
}
|
|
332
|
+
});
|
|
333
|
+
});
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Write a timestamped migration file from the current Mongoose models vs the last
|
|
3
|
+
* committed `schemaAfter` snapshot in `migrations/`.
|
|
4
|
+
*/
|
|
5
|
+
import {mkdir, writeFile} from "node:fs/promises";
|
|
6
|
+
import {join} from "node:path";
|
|
7
|
+
|
|
8
|
+
import {DateTime} from "luxon";
|
|
9
|
+
import type {Model, Document as MongooseDocument} from "mongoose";
|
|
10
|
+
|
|
11
|
+
import {APIError} from "../errors";
|
|
12
|
+
import {checkMigrationFiles} from "./load";
|
|
13
|
+
import {
|
|
14
|
+
buildSchemaCatalog,
|
|
15
|
+
diffSchemaCatalog,
|
|
16
|
+
type SchemaCatalog,
|
|
17
|
+
type SchemaDiffOp,
|
|
18
|
+
} from "./schemaCatalog";
|
|
19
|
+
|
|
20
|
+
export interface GenerateMigrationOptions {
|
|
21
|
+
dir: string;
|
|
22
|
+
models: Model<MongooseDocument>[];
|
|
23
|
+
name?: string;
|
|
24
|
+
now?: () => DateTime;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export interface GenerateMigrationResult {
|
|
28
|
+
noop: boolean;
|
|
29
|
+
path: string | null;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const emptyCatalog = (): SchemaCatalog => {
|
|
33
|
+
return {models: {}};
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
const slugify = (name: string): string => {
|
|
37
|
+
const slug = name
|
|
38
|
+
.toLowerCase()
|
|
39
|
+
.replace(/[^a-z0-9]+/g, "-")
|
|
40
|
+
.replace(/^-+|-+$/g, "");
|
|
41
|
+
return slug.length > 0 ? slug : "auto";
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
export const lastSchemaAfter = (
|
|
45
|
+
catalogs: Array<{schemaAfter?: unknown}>
|
|
46
|
+
): SchemaCatalog | undefined => {
|
|
47
|
+
for (let index = catalogs.length - 1; index >= 0; index -= 1) {
|
|
48
|
+
const snapshot = catalogs[index]?.schemaAfter;
|
|
49
|
+
if (snapshot && typeof snapshot === "object") {
|
|
50
|
+
return snapshot as SchemaCatalog;
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
return undefined;
|
|
54
|
+
};
|
|
55
|
+
|
|
56
|
+
const describeOp = (op: SchemaDiffOp): string => {
|
|
57
|
+
return `${op.kind} ${op.modelName} ${op.path ?? op.toPath ?? JSON.stringify(op.keys)}`;
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
const mongoIndexName = (keys: Record<string, number | string>): string => {
|
|
61
|
+
return Object.entries(keys)
|
|
62
|
+
.map(([key, value]) => `${key}_${value}`)
|
|
63
|
+
.join("_");
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
const renderIndexCall = ({
|
|
67
|
+
collection,
|
|
68
|
+
keys,
|
|
69
|
+
kind,
|
|
70
|
+
}: {
|
|
71
|
+
collection: string;
|
|
72
|
+
keys: Record<string, number | string>;
|
|
73
|
+
kind: "createIndex" | "dropIndex";
|
|
74
|
+
}): string => {
|
|
75
|
+
const name = mongoIndexName(keys);
|
|
76
|
+
if (kind === "dropIndex") {
|
|
77
|
+
return ` await ctx.mongoose.connection.collection(${JSON.stringify(collection)}).dropIndex(${JSON.stringify(name)});`;
|
|
78
|
+
}
|
|
79
|
+
return ` await ctx.mongoose.connection.collection(${JSON.stringify(collection)}).createIndex(${JSON.stringify(keys)}, {name: ${JSON.stringify(name)}});`;
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
const renderUnsafeBody = ({
|
|
83
|
+
catalog,
|
|
84
|
+
ops,
|
|
85
|
+
reverse,
|
|
86
|
+
}: {
|
|
87
|
+
catalog: SchemaCatalog;
|
|
88
|
+
ops: SchemaDiffOp[];
|
|
89
|
+
reverse: boolean;
|
|
90
|
+
}): string => {
|
|
91
|
+
const detail = ops.map(describeOp).join("; ");
|
|
92
|
+
const ordered = reverse ? [...ops].reverse() : ops;
|
|
93
|
+
const safeIndexComments: string[] = [];
|
|
94
|
+
for (const op of ordered) {
|
|
95
|
+
if (!op.safe || !op.keys || (op.kind !== "addIndex" && op.kind !== "dropIndex")) {
|
|
96
|
+
continue;
|
|
97
|
+
}
|
|
98
|
+
const collection = catalog.models[op.modelName]?.collection ?? op.modelName;
|
|
99
|
+
let kind: "createIndex" | "dropIndex";
|
|
100
|
+
if (op.kind === "addIndex") {
|
|
101
|
+
kind = reverse ? "dropIndex" : "createIndex";
|
|
102
|
+
} else {
|
|
103
|
+
kind = reverse ? "createIndex" : "dropIndex";
|
|
104
|
+
}
|
|
105
|
+
safeIndexComments.push(` // ${renderIndexCall({collection, keys: op.keys, kind}).trim()}`);
|
|
106
|
+
}
|
|
107
|
+
const commentBlock =
|
|
108
|
+
safeIndexComments.length > 0
|
|
109
|
+
? ` // Keep these safe index operations when replacing the stub:\n${safeIndexComments.join("\n")}\n`
|
|
110
|
+
: "";
|
|
111
|
+
return `${commentBlock} throw new Error(${JSON.stringify(`Unsafe migration stub: ${detail}. Replace this stub with a backfill before applying.`)});`;
|
|
112
|
+
};
|
|
113
|
+
|
|
114
|
+
const renderSafeUp = (ops: SchemaDiffOp[], catalog: SchemaCatalog): string => {
|
|
115
|
+
const lines: string[] = [" if (ctx.dryRun) {", " return;", " }"];
|
|
116
|
+
for (const op of ops) {
|
|
117
|
+
const collection = catalog.models[op.modelName]?.collection ?? op.modelName;
|
|
118
|
+
if (op.kind === "addIndex" && op.keys) {
|
|
119
|
+
lines.push(renderIndexCall({collection, keys: op.keys, kind: "createIndex"}));
|
|
120
|
+
continue;
|
|
121
|
+
}
|
|
122
|
+
if (op.kind === "dropIndex" && op.keys) {
|
|
123
|
+
lines.push(renderIndexCall({collection, keys: op.keys, kind: "dropIndex"}));
|
|
124
|
+
continue;
|
|
125
|
+
}
|
|
126
|
+
if (op.kind === "addOptionalField") {
|
|
127
|
+
lines.push(
|
|
128
|
+
` // Optional field ${op.modelName}.${op.path} is schemaless in Mongo; snapshot only.`
|
|
129
|
+
);
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
return lines.join("\n");
|
|
133
|
+
};
|
|
134
|
+
|
|
135
|
+
const renderSafeDown = (ops: SchemaDiffOp[], catalog: SchemaCatalog): string => {
|
|
136
|
+
const lines: string[] = [" if (ctx.dryRun) {", " return;", " }"];
|
|
137
|
+
for (const op of [...ops].reverse()) {
|
|
138
|
+
const collection = catalog.models[op.modelName]?.collection ?? op.modelName;
|
|
139
|
+
if (op.kind === "addIndex" && op.keys) {
|
|
140
|
+
lines.push(renderIndexCall({collection, keys: op.keys, kind: "dropIndex"}));
|
|
141
|
+
continue;
|
|
142
|
+
}
|
|
143
|
+
if (op.kind === "dropIndex" && op.keys) {
|
|
144
|
+
lines.push(renderIndexCall({collection, keys: op.keys, kind: "createIndex"}));
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
return lines.join("\n");
|
|
148
|
+
};
|
|
149
|
+
|
|
150
|
+
const renderFile = ({
|
|
151
|
+
catalog,
|
|
152
|
+
id,
|
|
153
|
+
ops,
|
|
154
|
+
}: {
|
|
155
|
+
catalog: SchemaCatalog;
|
|
156
|
+
id: string;
|
|
157
|
+
ops: SchemaDiffOp[];
|
|
158
|
+
}): string => {
|
|
159
|
+
const unsafe = ops.some((op) => !op.safe);
|
|
160
|
+
const upBody = unsafe
|
|
161
|
+
? renderUnsafeBody({catalog, ops, reverse: false})
|
|
162
|
+
: renderSafeUp(ops, catalog);
|
|
163
|
+
const downBody = unsafe
|
|
164
|
+
? renderUnsafeBody({catalog, ops, reverse: true})
|
|
165
|
+
: renderSafeDown(ops, catalog);
|
|
166
|
+
return `export const id = ${JSON.stringify(id)};
|
|
167
|
+
|
|
168
|
+
export const schemaAfter = ${JSON.stringify(catalog)};
|
|
169
|
+
|
|
170
|
+
export const up = async (ctx) => {
|
|
171
|
+
${upBody}
|
|
172
|
+
};
|
|
173
|
+
|
|
174
|
+
export const down = async (ctx) => {
|
|
175
|
+
${downBody}
|
|
176
|
+
};
|
|
177
|
+
`;
|
|
178
|
+
};
|
|
179
|
+
|
|
180
|
+
export const generateMigration = async ({
|
|
181
|
+
dir,
|
|
182
|
+
models,
|
|
183
|
+
name = "auto",
|
|
184
|
+
now = () => DateTime.now(),
|
|
185
|
+
}: GenerateMigrationOptions): Promise<GenerateMigrationResult> => {
|
|
186
|
+
await mkdir(dir, {recursive: true});
|
|
187
|
+
let previous = emptyCatalog();
|
|
188
|
+
try {
|
|
189
|
+
const loaded = await checkMigrationFiles({dir});
|
|
190
|
+
previous = lastSchemaAfter(loaded) ?? emptyCatalog();
|
|
191
|
+
} catch (error) {
|
|
192
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
193
|
+
if (!message.includes("ENOENT")) {
|
|
194
|
+
throw error;
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
if (models.length === 0) {
|
|
199
|
+
throw new APIError({
|
|
200
|
+
detail: "Pass a --models module that exports models or {models: Model[]}.",
|
|
201
|
+
status: 400,
|
|
202
|
+
title: "No Mongoose models found",
|
|
203
|
+
});
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
const catalog = buildSchemaCatalog({models});
|
|
207
|
+
const diff = diffSchemaCatalog({after: catalog, before: previous});
|
|
208
|
+
if (diff.ops.length === 0) {
|
|
209
|
+
return {noop: true, path: null};
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
const id = `${now().toUTC().toFormat("yyyyMMddHHmmss")}-${slugify(name)}`;
|
|
213
|
+
const path = join(dir, `${id}.ts`);
|
|
214
|
+
await writeFile(path, renderFile({catalog, id, ops: diff.ops}), "utf8");
|
|
215
|
+
return {noop: false, path};
|
|
216
|
+
};
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tests for loading timestamped migration files (order, id match, required `up`).
|
|
3
|
+
*/
|
|
4
|
+
import {describe, expect, it} from "bun:test";
|
|
5
|
+
import {mkdir, mkdtemp, rm, writeFile} from "node:fs/promises";
|
|
6
|
+
import {tmpdir} from "node:os";
|
|
7
|
+
import {join} from "node:path";
|
|
8
|
+
|
|
9
|
+
import {APIError} from "../errors";
|
|
10
|
+
import {checkMigrationFiles, loadMigrations, resolveMigrationDir} from "./load";
|
|
11
|
+
|
|
12
|
+
const fixtures = (...parts: string[]): string => {
|
|
13
|
+
return join(import.meta.dir, "fixtures", ...parts);
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
describe("checkMigrationFiles", () => {
|
|
17
|
+
it("loads timestamped files in filename order with optional down", async () => {
|
|
18
|
+
const loaded = await checkMigrationFiles({dir: fixtures("valid")});
|
|
19
|
+
expect(loaded.map((m) => m.id)).toEqual(["20260910120000-alpha", "20260910120001-beta"]);
|
|
20
|
+
expect(typeof loaded[0].up).toBe("function");
|
|
21
|
+
expect(loaded[0].down).toBeUndefined();
|
|
22
|
+
expect(typeof loaded[1].down).toBe("function");
|
|
23
|
+
expect(loaded[0].checksum).toHaveLength(64);
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
it("rejects an id that does not match the filename", async () => {
|
|
27
|
+
await expect(checkMigrationFiles({dir: fixtures("bad-id")})).rejects.toThrow(
|
|
28
|
+
"Migration id does not match filename"
|
|
29
|
+
);
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
it("rejects a filename that is not YYYYMMDDHHmmss-slug.ts", async () => {
|
|
33
|
+
await expect(checkMigrationFiles({dir: fixtures("bad-name")})).rejects.toThrow(
|
|
34
|
+
"Invalid migration filename"
|
|
35
|
+
);
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
it("rejects a module without up", async () => {
|
|
39
|
+
await expect(checkMigrationFiles({dir: fixtures("missing-up")})).rejects.toThrow(
|
|
40
|
+
"Migration missing up"
|
|
41
|
+
);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it("maps a missing directory to a 404 APIError", async () => {
|
|
45
|
+
try {
|
|
46
|
+
await checkMigrationFiles({dir: join(tmpdir(), "terreno-migrations-missing-dir")});
|
|
47
|
+
throw new Error("expected checkMigrationFiles to reject");
|
|
48
|
+
} catch (error) {
|
|
49
|
+
expect(error).toBeInstanceOf(APIError);
|
|
50
|
+
expect((error as APIError).status).toBe(404);
|
|
51
|
+
expect((error as APIError).message).toBe("Migration directory not found");
|
|
52
|
+
}
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
it("loads from MIGRATIONS_DIR when dir is on $bunfs", async () => {
|
|
56
|
+
const root = await mkdtemp(join(tmpdir(), "terreno-migrations-bunfs-"));
|
|
57
|
+
const dir = join(root, "migrations");
|
|
58
|
+
await mkdir(dir);
|
|
59
|
+
await writeFile(
|
|
60
|
+
join(dir, "20260910120000-from-env.ts"),
|
|
61
|
+
'export const id = "20260910120000-from-env";\nexport const up = async () => {};\n'
|
|
62
|
+
);
|
|
63
|
+
process.env.MIGRATIONS_DIR = dir;
|
|
64
|
+
try {
|
|
65
|
+
const loaded = await checkMigrationFiles({dir: "/$bunfs/migrations"});
|
|
66
|
+
expect(loaded.map((migration) => migration.id)).toEqual(["20260910120000-from-env"]);
|
|
67
|
+
} finally {
|
|
68
|
+
Reflect.deleteProperty(process.env, "MIGRATIONS_DIR");
|
|
69
|
+
await rm(root, {force: true, recursive: true});
|
|
70
|
+
}
|
|
71
|
+
});
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
describe("resolveMigrationDir", () => {
|
|
75
|
+
it("keeps a real on-disk dir", () => {
|
|
76
|
+
expect(resolveMigrationDir({dir: "/app/migrations", envDir: "/env/migrations"})).toBe(
|
|
77
|
+
"/app/migrations"
|
|
78
|
+
);
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
it("does not keep a $bunfs dir; uses MIGRATIONS_DIR then cwd/migrations", () => {
|
|
82
|
+
expect(
|
|
83
|
+
resolveMigrationDir({
|
|
84
|
+
cwd: "/app",
|
|
85
|
+
dir: "/$bunfs/migrations",
|
|
86
|
+
envDir: "/app/migrations",
|
|
87
|
+
})
|
|
88
|
+
).toBe("/app/migrations");
|
|
89
|
+
expect(
|
|
90
|
+
resolveMigrationDir({cwd: "/app", dir: "file:///$bunfs/root/src/migrationsDir.ts"})
|
|
91
|
+
).toBe("/app/migrations");
|
|
92
|
+
});
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
describe("loadMigrations", () => {
|
|
96
|
+
it("aliases checkMigrationFiles", async () => {
|
|
97
|
+
const loaded = await loadMigrations({dir: fixtures("valid")});
|
|
98
|
+
expect(loaded.map((migration) => migration.id)).toEqual([
|
|
99
|
+
"20260910120000-alpha",
|
|
100
|
+
"20260910120001-beta",
|
|
101
|
+
]);
|
|
102
|
+
});
|
|
103
|
+
});
|