@terreno/api 57.3.0 → 57.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
- package/README.md +6 -0
- package/dist/adminTypes.d.ts +7 -0
- package/dist/adminTypes.js +6 -1
- package/dist/api.d.ts +10 -0
- package/dist/api.js +99 -36
- package/dist/audit/auditApp.d.ts +30 -0
- package/dist/audit/auditApp.js +155 -0
- package/dist/audit/auditEventModel.d.ts +29 -0
- package/dist/audit/auditEventModel.js +102 -0
- package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
- package/dist/audit/cloudTasksEnqueue.js +162 -0
- package/dist/audit/diff.d.ts +10 -0
- package/dist/audit/diff.js +230 -0
- package/dist/audit/processQueue.d.ts +6 -0
- package/dist/audit/processQueue.js +101 -0
- package/dist/audit/rbacSink.d.ts +2 -0
- package/dist/audit/rbacSink.js +82 -0
- package/dist/audit/record.d.ts +56 -0
- package/dist/audit/record.js +373 -0
- package/dist/betterAuth.d.ts +6 -0
- package/dist/betterAuthSetup.js +1 -1
- package/dist/collectionRegistry.d.ts +3 -1
- package/dist/collectionRegistry.js +25 -0
- package/dist/index.d.ts +26 -1
- package/dist/index.js +48 -2
- package/dist/mcp/query.d.ts +0 -13
- package/dist/mcp/query.js +8 -8
- package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
- package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
- package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
- package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
- package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
- package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
- package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
- package/dist/migrations/generate.d.ts +17 -0
- package/dist/migrations/generate.js +277 -0
- package/dist/migrations/load.d.ts +20 -0
- package/dist/migrations/load.js +236 -0
- package/dist/migrations/lock.d.ts +13 -0
- package/dist/migrations/lock.js +145 -0
- package/dist/migrations/runner.d.ts +42 -0
- package/dist/migrations/runner.js +503 -0
- package/dist/migrations/schemaCatalog.d.ts +44 -0
- package/dist/migrations/schemaCatalog.js +326 -0
- package/dist/migrations/types.d.ts +87 -0
- package/dist/migrations/types.js +7 -0
- package/dist/models/notification.d.ts +2 -0
- package/dist/models/notification.js +62 -0
- package/dist/models/notificationPreference.d.ts +2 -0
- package/dist/models/notificationPreference.js +49 -0
- package/dist/notifications/notificationService.d.ts +40 -0
- package/dist/notifications/notificationService.js +323 -0
- package/dist/notifications/notificationsApp.d.ts +18 -0
- package/dist/notifications/notificationsApp.js +250 -0
- package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
- package/dist/notifications/notificationsBeforeSend.js +77 -0
- package/dist/openApi.d.ts +1 -7
- package/dist/openApi.js +7 -6
- package/dist/openApiBuilder.d.ts +14 -3
- package/dist/openApiValidator.d.ts +13 -1
- package/dist/openApiValidator.js +200 -36
- package/dist/orgs/orgContext.d.ts +23 -0
- package/dist/orgs/orgContext.js +198 -0
- package/dist/orgs/orgPermissions.d.ts +4 -0
- package/dist/orgs/orgPermissions.js +77 -0
- package/dist/orgs/orgPlugin.d.ts +13 -0
- package/dist/orgs/orgPlugin.js +84 -0
- package/dist/orgs/organizationModel.d.ts +13 -0
- package/dist/orgs/organizationModel.js +301 -0
- package/dist/orgs/organizationSettings.d.ts +19 -0
- package/dist/orgs/organizationSettings.js +120 -0
- package/dist/orgs/orgsApp.d.ts +28 -0
- package/dist/orgs/orgsApp.js +678 -0
- package/dist/permissions.d.ts +7 -13
- package/dist/permissions.js +8 -31
- package/dist/rateLimit/middleware.d.ts +0 -8
- package/dist/rateLimit/middleware.js +2 -3
- package/dist/rateLimit/mongoStore.d.ts +1 -0
- package/dist/rateLimit/mongoStore.js +1 -0
- package/dist/rateLimit/policies.d.ts +0 -4
- package/dist/rateLimit/policies.js +5 -7
- package/dist/rateLimit/redisStore.d.ts +1 -0
- package/dist/rateLimit/redisStore.js +1 -0
- package/dist/rbac/access.js +30 -13
- package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
- package/dist/rbac/membershipOrgAdminSource.js +122 -0
- package/dist/rbac/modelRouterAccess.d.ts +3 -0
- package/dist/rbac/modelRouterAccess.js +3 -0
- package/dist/rbac/resolve.js +60 -31
- package/dist/rbac/roleModel.d.ts +2 -5
- package/dist/rbac/roleModel.js +18 -4
- package/dist/rbac/statements.d.ts +10 -1
- package/dist/rbac/statements.js +19 -2
- package/dist/rbac/types.d.ts +5 -0
- package/dist/realtime/changeStreamWatcher.d.ts +10 -4
- package/dist/realtime/changeStreamWatcher.js +110 -64
- package/dist/realtime/deprecation.d.ts +1 -0
- package/dist/realtime/deprecation.js +1 -0
- package/dist/realtime/realtimeApp.d.ts +1 -0
- package/dist/realtime/realtimeApp.js +1 -0
- package/dist/schemaMetadata.js +16 -5
- package/dist/sync/adminBroadcastScope.d.ts +40 -0
- package/dist/sync/adminBroadcastScope.js +194 -0
- package/dist/sync/adminWindowAccess.d.ts +13 -0
- package/dist/sync/adminWindowAccess.js +96 -0
- package/dist/sync/adminWindowMutation.d.ts +88 -0
- package/dist/sync/adminWindowMutation.js +247 -0
- package/dist/sync/executors.d.ts +9 -3
- package/dist/sync/executors.js +190 -159
- package/dist/sync/mutationHandler.d.ts +5 -2
- package/dist/sync/mutationHandler.js +191 -71
- package/dist/sync/registry.js +4 -0
- package/dist/sync/routes.d.ts +13 -0
- package/dist/sync/routes.js +113 -56
- package/dist/sync/socketHandlers.d.ts +8 -2
- package/dist/sync/socketHandlers.js +144 -50
- package/dist/sync/streams.d.ts +2 -0
- package/dist/sync/streams.js +7 -1
- package/dist/sync/syncApp.d.ts +2 -1
- package/dist/sync/syncApp.js +2 -1
- package/dist/sync/syncBatch.d.ts +5 -2
- package/dist/sync/syncBatch.js +4 -4
- package/dist/sync/types.d.ts +18 -0
- package/dist/terrenoApp.d.ts +29 -0
- package/dist/terrenoApp.js +91 -54
- package/dist/tests/createTestData.d.ts +1 -3
- package/dist/tests/createTestData.js +3 -5
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +9 -2
- package/dist/tests/testHelper.d.ts +0 -5
- package/dist/tests/testHelper.js +2 -9
- 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/webhooks/idempotency/webhookReceipt.d.ts +4 -49
- package/dist/webhooks/idempotency/webhookReceipt.js +7 -7
- package/dist/webhooks/rawBody.d.ts +1 -0
- package/dist/webhooks/rawBody.js +1 -0
- package/package.json +31 -25
- 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/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 +156 -0
- package/src/audit/auditRouter.test.ts +456 -0
- package/src/audit/cloudTasksEnqueue.test.ts +124 -0
- package/src/audit/cloudTasksEnqueue.ts +104 -0
- package/src/audit/diff.ts +163 -0
- package/src/audit/processQueue.ts +69 -0
- package/src/audit/rbacSink.test.ts +86 -0
- package/src/audit/rbacSink.ts +42 -0
- package/src/audit/record.test.ts +402 -0
- package/src/audit/record.ts +328 -0
- package/src/auth.test.ts +1 -1
- package/src/betterAuth.ts +7 -0
- package/src/betterAuthSetup.test.ts +27 -0
- package/src/betterAuthSetup.ts +1 -0
- package/src/collectionRegistry.test.ts +8 -9
- package/src/collectionRegistry.ts +21 -1
- package/src/express.d.ts +2 -0
- package/src/expressServer.test.ts +50 -2
- package/src/index.ts +69 -0
- 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 +376 -0
- package/src/migrations/cli.ts +283 -0
- package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
- package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
- package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
- package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
- package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
- package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
- package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
- package/src/migrations/generate.test.ts +333 -0
- package/src/migrations/generate.ts +216 -0
- package/src/migrations/load.test.ts +103 -0
- package/src/migrations/load.ts +124 -0
- package/src/migrations/lock.test.ts +133 -0
- package/src/migrations/lock.ts +118 -0
- package/src/migrations/runner.test.ts +504 -0
- package/src/migrations/runner.ts +358 -0
- package/src/migrations/schemaCatalog.test.ts +159 -0
- package/src/migrations/schemaCatalog.ts +262 -0
- package/src/migrations/types.ts +94 -0
- package/src/models/notification.ts +68 -0
- package/src/models/notificationPreference.ts +62 -0
- package/src/notifications/notificationService.ts +254 -0
- package/src/notifications/notificationsApp.test.ts +505 -0
- package/src/notifications/notificationsApp.ts +200 -0
- package/src/notifications/notificationsBeforeSend.ts +51 -0
- package/src/openApi.test.ts +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 +257 -0
- package/src/orgs/organizationSettings.test.ts +113 -0
- package/src/orgs/organizationSettings.ts +126 -0
- package/src/orgs/orgsApp.test.ts +382 -0
- package/src/orgs/orgsApp.ts +563 -0
- package/src/permissions.test.ts +62 -36
- package/src/permissions.ts +8 -30
- package/src/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 +1 -0
- 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/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 +94 -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/webhooks/idempotency/webhookReceipt.ts +4 -7
- package/src/webhooks/rawBody.test.ts +33 -0
- package/src/webhooks/rawBody.ts +1 -0
- package/tsconfig.json +1 -1
- package/tsconfig.typedoc.json +2 -1
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
- package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
- package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
|
@@ -0,0 +1,358 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Apply, roll back, and inspect MongoDB migration history. This module also
|
|
3
|
+
* owns the production wet-apply gate, the TerrenoApp `runOnStart` hook, and the
|
|
4
|
+
* CI helper that applies then reverses reversible files.
|
|
5
|
+
*/
|
|
6
|
+
import {DateTime} from "luxon";
|
|
7
|
+
import mongoose from "mongoose";
|
|
8
|
+
|
|
9
|
+
import {APIError} from "../errors";
|
|
10
|
+
import {logger as defaultLogger} from "../logger";
|
|
11
|
+
import {checkMigrationFiles} from "./load";
|
|
12
|
+
import {withMigrationLock} from "./lock";
|
|
13
|
+
import {
|
|
14
|
+
type AppliedMigrationRecord,
|
|
15
|
+
type LoadedMigration,
|
|
16
|
+
MIGRATION_LOCK_ID,
|
|
17
|
+
MIGRATIONS_COLLECTION,
|
|
18
|
+
type MigrationContext,
|
|
19
|
+
type MigrationStatus,
|
|
20
|
+
type MigrationStoreDoc,
|
|
21
|
+
type RunDownMigrationsOptions,
|
|
22
|
+
type RunDownMigrationsResult,
|
|
23
|
+
type RunMigrationsOptions,
|
|
24
|
+
type RunMigrationsResult,
|
|
25
|
+
} from "./types";
|
|
26
|
+
|
|
27
|
+
const historyCollection = (
|
|
28
|
+
connection: mongoose.Connection
|
|
29
|
+
): mongoose.Collection<MigrationStoreDoc> => {
|
|
30
|
+
return connection.collection<MigrationStoreDoc>(MIGRATIONS_COLLECTION);
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
const toJsDate = (value: Date | string | undefined): Date => {
|
|
34
|
+
if (value instanceof Date) {
|
|
35
|
+
const parsed = DateTime.fromJSDate(value, {zone: "utc"});
|
|
36
|
+
if (!parsed.isValid) {
|
|
37
|
+
throw new APIError({status: 500, title: "Invalid migration timestamp"});
|
|
38
|
+
}
|
|
39
|
+
return parsed.toJSDate();
|
|
40
|
+
}
|
|
41
|
+
const parsed = DateTime.fromISO(String(value ?? ""), {zone: "utc"});
|
|
42
|
+
if (!parsed.isValid) {
|
|
43
|
+
throw new APIError({status: 500, title: "Invalid migration timestamp"});
|
|
44
|
+
}
|
|
45
|
+
return parsed.toJSDate();
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
const loadApplied = async (
|
|
49
|
+
connection: mongoose.Connection
|
|
50
|
+
): Promise<Map<string, AppliedMigrationRecord>> => {
|
|
51
|
+
const docs = await historyCollection(connection)
|
|
52
|
+
.find({_id: {$ne: MIGRATION_LOCK_ID}})
|
|
53
|
+
.toArray();
|
|
54
|
+
const applied = new Map<string, AppliedMigrationRecord>();
|
|
55
|
+
for (const doc of docs) {
|
|
56
|
+
const id = String(doc.id ?? doc._id);
|
|
57
|
+
applied.set(id, {
|
|
58
|
+
appliedAt: toJsDate(doc.appliedAt),
|
|
59
|
+
checksum: String(doc.checksum ?? ""),
|
|
60
|
+
id,
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
return applied;
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
const recordApplied = async ({
|
|
67
|
+
connection,
|
|
68
|
+
migration,
|
|
69
|
+
}: {
|
|
70
|
+
connection: mongoose.Connection;
|
|
71
|
+
migration: LoadedMigration;
|
|
72
|
+
}): Promise<void> => {
|
|
73
|
+
await historyCollection(connection).insertOne({
|
|
74
|
+
_id: migration.id,
|
|
75
|
+
appliedAt: DateTime.utc().toJSDate(),
|
|
76
|
+
checksum: migration.checksum,
|
|
77
|
+
id: migration.id,
|
|
78
|
+
});
|
|
79
|
+
};
|
|
80
|
+
|
|
81
|
+
export const runMigrations = async ({
|
|
82
|
+
addLog,
|
|
83
|
+
checkCancellation,
|
|
84
|
+
connection,
|
|
85
|
+
dryRun,
|
|
86
|
+
lockPollMs,
|
|
87
|
+
lockTtlMs,
|
|
88
|
+
logger = defaultLogger,
|
|
89
|
+
migrations,
|
|
90
|
+
mongoose: mongooseNs,
|
|
91
|
+
}: RunMigrationsOptions): Promise<RunMigrationsResult> => {
|
|
92
|
+
const execute = async (): Promise<RunMigrationsResult> => {
|
|
93
|
+
const appliedRecords = await loadApplied(connection);
|
|
94
|
+
const applied: string[] = [];
|
|
95
|
+
const skipped: string[] = [];
|
|
96
|
+
|
|
97
|
+
for (const migration of migrations) {
|
|
98
|
+
const existing = appliedRecords.get(migration.id);
|
|
99
|
+
if (existing) {
|
|
100
|
+
if (existing.checksum !== migration.checksum) {
|
|
101
|
+
throw new APIError({
|
|
102
|
+
detail: `Migration ${migration.id} was applied with checksum ${existing.checksum} but the current file is ${migration.checksum}`,
|
|
103
|
+
status: 409,
|
|
104
|
+
title: "Migration checksum mismatch",
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
skipped.push(migration.id);
|
|
108
|
+
continue;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
const ctx: MigrationContext = {
|
|
112
|
+
addLog,
|
|
113
|
+
checkCancellation,
|
|
114
|
+
dryRun,
|
|
115
|
+
logger,
|
|
116
|
+
mongoose: mongooseNs,
|
|
117
|
+
};
|
|
118
|
+
await checkCancellation?.();
|
|
119
|
+
await migration.up(ctx);
|
|
120
|
+
applied.push(migration.id);
|
|
121
|
+
if (!dryRun) {
|
|
122
|
+
await recordApplied({connection, migration});
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
return {applied, dryRun, skipped};
|
|
127
|
+
};
|
|
128
|
+
|
|
129
|
+
return withMigrationLock({
|
|
130
|
+
connection,
|
|
131
|
+
fn: execute,
|
|
132
|
+
pollMs: lockPollMs,
|
|
133
|
+
ttlMs: lockTtlMs,
|
|
134
|
+
});
|
|
135
|
+
};
|
|
136
|
+
|
|
137
|
+
const removeApplied = async ({
|
|
138
|
+
connection,
|
|
139
|
+
id,
|
|
140
|
+
}: {
|
|
141
|
+
connection: mongoose.Connection;
|
|
142
|
+
id: string;
|
|
143
|
+
}): Promise<void> => {
|
|
144
|
+
await historyCollection(connection).deleteOne({_id: id});
|
|
145
|
+
};
|
|
146
|
+
|
|
147
|
+
export const getMigrationStatus = async ({
|
|
148
|
+
connection,
|
|
149
|
+
migrations,
|
|
150
|
+
}: {
|
|
151
|
+
connection: mongoose.Connection;
|
|
152
|
+
migrations: LoadedMigration[];
|
|
153
|
+
}): Promise<MigrationStatus> => {
|
|
154
|
+
const appliedRecords = await loadApplied(connection);
|
|
155
|
+
const applied: AppliedMigrationRecord[] = [];
|
|
156
|
+
const pending: Array<{checksum: string; id: string}> = [];
|
|
157
|
+
for (const migration of migrations) {
|
|
158
|
+
const existing = appliedRecords.get(migration.id);
|
|
159
|
+
if (existing) {
|
|
160
|
+
applied.push(existing);
|
|
161
|
+
continue;
|
|
162
|
+
}
|
|
163
|
+
pending.push({checksum: migration.checksum, id: migration.id});
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
const collection = historyCollection(connection);
|
|
167
|
+
const lockDoc = await collection.findOne({_id: MIGRATION_LOCK_ID});
|
|
168
|
+
const lock =
|
|
169
|
+
lockDoc == null
|
|
170
|
+
? null
|
|
171
|
+
: {
|
|
172
|
+
expiresAt: toJsDate(lockDoc.expiresAt),
|
|
173
|
+
holder: String(lockDoc.holder ?? ""),
|
|
174
|
+
};
|
|
175
|
+
|
|
176
|
+
return {applied, lock, pending};
|
|
177
|
+
};
|
|
178
|
+
|
|
179
|
+
export const runDownMigrations = async ({
|
|
180
|
+
connection,
|
|
181
|
+
dryRun,
|
|
182
|
+
lockPollMs,
|
|
183
|
+
lockTtlMs,
|
|
184
|
+
logger = defaultLogger,
|
|
185
|
+
migrations,
|
|
186
|
+
mongoose: mongooseNs,
|
|
187
|
+
steps,
|
|
188
|
+
}: RunDownMigrationsOptions): Promise<RunDownMigrationsResult> => {
|
|
189
|
+
if (!Number.isInteger(steps) || steps < 1) {
|
|
190
|
+
throw new APIError({
|
|
191
|
+
detail: "down --steps must be a positive integer",
|
|
192
|
+
status: 400,
|
|
193
|
+
title: "Invalid down steps",
|
|
194
|
+
});
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
const execute = async (): Promise<RunDownMigrationsResult> => {
|
|
198
|
+
const appliedRecords = await loadApplied(connection);
|
|
199
|
+
const appliedInOrder = migrations.filter((migration) => appliedRecords.has(migration.id));
|
|
200
|
+
const targets = appliedInOrder.slice(-steps).reverse();
|
|
201
|
+
const reversed: string[] = [];
|
|
202
|
+
|
|
203
|
+
const reversible = targets.map((migration) => {
|
|
204
|
+
if (typeof migration.down !== "function") {
|
|
205
|
+
throw new APIError({
|
|
206
|
+
detail: `Migration ${migration.id} has no down. Rollback stopped.`,
|
|
207
|
+
status: 400,
|
|
208
|
+
title: "Migration has no down",
|
|
209
|
+
});
|
|
210
|
+
}
|
|
211
|
+
return {down: migration.down, id: migration.id};
|
|
212
|
+
});
|
|
213
|
+
|
|
214
|
+
for (const migration of reversible) {
|
|
215
|
+
const ctx: MigrationContext = {
|
|
216
|
+
dryRun,
|
|
217
|
+
logger,
|
|
218
|
+
mongoose: mongooseNs,
|
|
219
|
+
};
|
|
220
|
+
await ctx.checkCancellation?.();
|
|
221
|
+
await migration.down(ctx);
|
|
222
|
+
reversed.push(migration.id);
|
|
223
|
+
if (!dryRun) {
|
|
224
|
+
await removeApplied({connection, id: migration.id});
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
return {dryRun, reversed};
|
|
229
|
+
};
|
|
230
|
+
|
|
231
|
+
return withMigrationLock({
|
|
232
|
+
connection,
|
|
233
|
+
fn: execute,
|
|
234
|
+
pollMs: lockPollMs,
|
|
235
|
+
ttlMs: lockTtlMs,
|
|
236
|
+
});
|
|
237
|
+
};
|
|
238
|
+
|
|
239
|
+
export interface AssertMigrationsAllowedOptions {
|
|
240
|
+
allowEnv: boolean;
|
|
241
|
+
dryRun: boolean;
|
|
242
|
+
force: boolean;
|
|
243
|
+
isProduction: boolean;
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
/** Fail closed for production wet apply unless ALLOW_MIGRATIONS and force (CLI `--force` or boot/admin Apply). */
|
|
247
|
+
export const assertMigrationsAllowed = ({
|
|
248
|
+
allowEnv,
|
|
249
|
+
dryRun,
|
|
250
|
+
force,
|
|
251
|
+
isProduction,
|
|
252
|
+
}: AssertMigrationsAllowedOptions): void => {
|
|
253
|
+
if (dryRun) {
|
|
254
|
+
return;
|
|
255
|
+
}
|
|
256
|
+
if (!isProduction) {
|
|
257
|
+
return;
|
|
258
|
+
}
|
|
259
|
+
if (allowEnv && force) {
|
|
260
|
+
return;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
const detail = allowEnv
|
|
264
|
+
? "Production wet migrations also require --force (or an equivalent boot/admin Apply)."
|
|
265
|
+
: "Set ALLOW_MIGRATIONS=true for production wet migrations.";
|
|
266
|
+
throw new APIError({
|
|
267
|
+
detail,
|
|
268
|
+
status: 403,
|
|
269
|
+
title: "Migrations not allowed",
|
|
270
|
+
});
|
|
271
|
+
};
|
|
272
|
+
|
|
273
|
+
export interface StartupMigrationsOption {
|
|
274
|
+
dir: string;
|
|
275
|
+
runOnStart?: boolean;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
export const runStartupMigrations = async ({
|
|
279
|
+
env = process.env,
|
|
280
|
+
migrations,
|
|
281
|
+
mongoose: mongooseNs,
|
|
282
|
+
}: {
|
|
283
|
+
env?: NodeJS.ProcessEnv;
|
|
284
|
+
migrations?: StartupMigrationsOption;
|
|
285
|
+
mongoose: typeof mongoose;
|
|
286
|
+
}): Promise<{applied: string[]; ran: boolean}> => {
|
|
287
|
+
if (!migrations?.runOnStart) {
|
|
288
|
+
return {applied: [], ran: false};
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
assertMigrationsAllowed({
|
|
292
|
+
allowEnv: env.ALLOW_MIGRATIONS === "true",
|
|
293
|
+
dryRun: false,
|
|
294
|
+
force: true,
|
|
295
|
+
isProduction: env.NODE_ENV === "production",
|
|
296
|
+
});
|
|
297
|
+
|
|
298
|
+
const loaded = await checkMigrationFiles({dir: migrations.dir});
|
|
299
|
+
const result = await runMigrations({
|
|
300
|
+
connection: mongooseNs.connection,
|
|
301
|
+
dryRun: false,
|
|
302
|
+
migrations: loaded,
|
|
303
|
+
mongoose: mongooseNs,
|
|
304
|
+
});
|
|
305
|
+
return {applied: result.applied, ran: true};
|
|
306
|
+
};
|
|
307
|
+
|
|
308
|
+
export interface ExerciseReversibleMigrationsOptions {
|
|
309
|
+
dir: string;
|
|
310
|
+
connect: () => Promise<mongoose.Connection>;
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
export interface ExerciseReversibleMigrationsResult {
|
|
314
|
+
applied: string[];
|
|
315
|
+
reversed: string[];
|
|
316
|
+
skippedIrreversible: string | null;
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* CI helper: apply every file, then roll back in reverse until a file without
|
|
321
|
+
* `down` stops the chain. The irreversible id is recorded; earlier files stay applied.
|
|
322
|
+
*/
|
|
323
|
+
export const exerciseReversibleMigrations = async ({
|
|
324
|
+
connect,
|
|
325
|
+
dir,
|
|
326
|
+
}: ExerciseReversibleMigrationsOptions): Promise<ExerciseReversibleMigrationsResult> => {
|
|
327
|
+
const connection = await connect();
|
|
328
|
+
const migrations = await checkMigrationFiles({dir});
|
|
329
|
+
const upResult = await runMigrations({
|
|
330
|
+
connection,
|
|
331
|
+
dryRun: false,
|
|
332
|
+
migrations,
|
|
333
|
+
mongoose,
|
|
334
|
+
});
|
|
335
|
+
|
|
336
|
+
const reversed: string[] = [];
|
|
337
|
+
let skippedIrreversible: string | null = null;
|
|
338
|
+
for (const migration of [...migrations].reverse()) {
|
|
339
|
+
if (typeof migration.down !== "function") {
|
|
340
|
+
skippedIrreversible = migration.id;
|
|
341
|
+
break;
|
|
342
|
+
}
|
|
343
|
+
const downResult = await runDownMigrations({
|
|
344
|
+
connection,
|
|
345
|
+
dryRun: false,
|
|
346
|
+
migrations,
|
|
347
|
+
mongoose,
|
|
348
|
+
steps: 1,
|
|
349
|
+
});
|
|
350
|
+
reversed.push(...downResult.reversed);
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
return {
|
|
354
|
+
applied: [...upResult.applied, ...upResult.skipped],
|
|
355
|
+
reversed,
|
|
356
|
+
skippedIrreversible,
|
|
357
|
+
};
|
|
358
|
+
};
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tests for cataloging Mongoose schemas and classifying generate-time diffs.
|
|
3
|
+
*/
|
|
4
|
+
import {describe, expect, it} from "bun:test";
|
|
5
|
+
import mongoose from "mongoose";
|
|
6
|
+
|
|
7
|
+
import {buildSchemaCatalog, diffSchemaCatalog} from "./schemaCatalog";
|
|
8
|
+
|
|
9
|
+
const catalogTodo = (): mongoose.Model<mongoose.Document> => {
|
|
10
|
+
const schema = new mongoose.Schema(
|
|
11
|
+
{
|
|
12
|
+
notes: {description: "Notes", type: String},
|
|
13
|
+
title: {description: "Title", required: true, type: String},
|
|
14
|
+
},
|
|
15
|
+
{collection: "todos"}
|
|
16
|
+
);
|
|
17
|
+
schema.index({title: 1});
|
|
18
|
+
return mongoose.model(`TodoCatalog${Math.random().toString(16).slice(2)}`, schema);
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
describe("buildSchemaCatalog", () => {
|
|
22
|
+
it("records paths, required flags, and indexes without methods", () => {
|
|
23
|
+
const Model = catalogTodo();
|
|
24
|
+
const catalog = buildSchemaCatalog({models: [Model]});
|
|
25
|
+
const model = catalog.models[Model.modelName];
|
|
26
|
+
expect(model.collection).toBe("todos");
|
|
27
|
+
expect(model.fields.map((field) => field.path).sort()).toEqual(["notes", "title"]);
|
|
28
|
+
expect(model.fields.find((field) => field.path === "title")?.required).toBe(true);
|
|
29
|
+
expect(model.fields.find((field) => field.path === "notes")?.required).toBe(false);
|
|
30
|
+
expect(model.indexes.some((index) => index.keys.title === 1)).toBe(true);
|
|
31
|
+
const again = buildSchemaCatalog({models: [Model]});
|
|
32
|
+
expect(JSON.stringify(again)).toBe(JSON.stringify(catalog));
|
|
33
|
+
});
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
describe("diffSchemaCatalog", () => {
|
|
37
|
+
it("classifies optional field and index adds as safe", () => {
|
|
38
|
+
const before = {
|
|
39
|
+
models: {
|
|
40
|
+
Todo: {
|
|
41
|
+
collection: "todos",
|
|
42
|
+
fields: [{instance: "String", path: "title", required: true, unique: false}],
|
|
43
|
+
indexes: [],
|
|
44
|
+
modelName: "Todo",
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
};
|
|
48
|
+
const after = {
|
|
49
|
+
models: {
|
|
50
|
+
Todo: {
|
|
51
|
+
collection: "todos",
|
|
52
|
+
fields: [
|
|
53
|
+
{instance: "String", path: "notes", required: false, unique: false},
|
|
54
|
+
{instance: "String", path: "title", required: true, unique: false},
|
|
55
|
+
],
|
|
56
|
+
indexes: [{keys: {title: 1}, unique: false}],
|
|
57
|
+
modelName: "Todo",
|
|
58
|
+
},
|
|
59
|
+
},
|
|
60
|
+
};
|
|
61
|
+
const diff = diffSchemaCatalog({after, before});
|
|
62
|
+
expect(diff.ops.map((op) => op.kind).sort()).toEqual(["addIndex", "addOptionalField"]);
|
|
63
|
+
expect(diff.ops.every((op) => op.safe)).toBe(true);
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
it("classifies required, unique, and rename as unsafe", () => {
|
|
67
|
+
const before = {
|
|
68
|
+
models: {
|
|
69
|
+
Todo: {
|
|
70
|
+
collection: "todos",
|
|
71
|
+
fields: [{instance: "String", path: "title", required: false, unique: false}],
|
|
72
|
+
indexes: [],
|
|
73
|
+
modelName: "Todo",
|
|
74
|
+
},
|
|
75
|
+
},
|
|
76
|
+
};
|
|
77
|
+
const after = {
|
|
78
|
+
models: {
|
|
79
|
+
Todo: {
|
|
80
|
+
collection: "todos",
|
|
81
|
+
fields: [
|
|
82
|
+
{instance: "String", path: "heading", required: true, unique: false},
|
|
83
|
+
{instance: "String", path: "owner", required: false, unique: true},
|
|
84
|
+
],
|
|
85
|
+
indexes: [{keys: {owner: 1}, unique: true}],
|
|
86
|
+
modelName: "Todo",
|
|
87
|
+
},
|
|
88
|
+
},
|
|
89
|
+
};
|
|
90
|
+
const diff = diffSchemaCatalog({after, before});
|
|
91
|
+
const kinds = diff.ops.map((op) => op.kind).sort();
|
|
92
|
+
expect(kinds).toContain("renameField");
|
|
93
|
+
expect(kinds).toContain("addRequiredField");
|
|
94
|
+
expect(kinds).toContain("addUniqueIndex");
|
|
95
|
+
expect(diff.ops.filter((op) => !op.safe).length).toBeGreaterThan(0);
|
|
96
|
+
expect(diff.ops.find((op) => op.kind === "renameField")?.safe).toBe(false);
|
|
97
|
+
expect(diff.ops.find((op) => op.kind === "addRequiredField")?.safe).toBe(false);
|
|
98
|
+
expect(diff.ops.find((op) => op.kind === "addUniqueIndex")?.safe).toBe(false);
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
it("classifies tightening required on an existing path as unsafe", () => {
|
|
102
|
+
const before = {
|
|
103
|
+
models: {
|
|
104
|
+
Todo: {
|
|
105
|
+
collection: "todos",
|
|
106
|
+
fields: [{instance: "String", path: "title", required: false, unique: false}],
|
|
107
|
+
indexes: [{keys: {title: 1}, unique: false}],
|
|
108
|
+
modelName: "Todo",
|
|
109
|
+
},
|
|
110
|
+
},
|
|
111
|
+
};
|
|
112
|
+
const after = {
|
|
113
|
+
models: {
|
|
114
|
+
Todo: {
|
|
115
|
+
collection: "todos",
|
|
116
|
+
fields: [{instance: "String", path: "title", required: true, unique: false}],
|
|
117
|
+
indexes: [],
|
|
118
|
+
modelName: "Todo",
|
|
119
|
+
},
|
|
120
|
+
},
|
|
121
|
+
};
|
|
122
|
+
const diff = diffSchemaCatalog({after, before});
|
|
123
|
+
expect(diff.ops.some((op) => op.kind === "addRequiredField" && op.safe === false)).toBe(true);
|
|
124
|
+
expect(diff.ops.some((op) => op.kind === "dropIndex" && op.safe === true)).toBe(true);
|
|
125
|
+
});
|
|
126
|
+
|
|
127
|
+
it("classifies removed paths and same-path type changes as unsafe", () => {
|
|
128
|
+
const before = {
|
|
129
|
+
models: {
|
|
130
|
+
Todo: {
|
|
131
|
+
collection: "todos",
|
|
132
|
+
fields: [
|
|
133
|
+
{instance: "String", path: "notes", required: false, unique: false},
|
|
134
|
+
{instance: "String", path: "title", required: true, unique: false},
|
|
135
|
+
],
|
|
136
|
+
indexes: [],
|
|
137
|
+
modelName: "Todo",
|
|
138
|
+
},
|
|
139
|
+
},
|
|
140
|
+
};
|
|
141
|
+
const after = {
|
|
142
|
+
models: {
|
|
143
|
+
Todo: {
|
|
144
|
+
collection: "todos",
|
|
145
|
+
fields: [{instance: "Number", path: "title", required: true, unique: false}],
|
|
146
|
+
indexes: [],
|
|
147
|
+
modelName: "Todo",
|
|
148
|
+
},
|
|
149
|
+
},
|
|
150
|
+
};
|
|
151
|
+
const diff = diffSchemaCatalog({after, before});
|
|
152
|
+
expect(diff.ops).toEqual(
|
|
153
|
+
expect.arrayContaining([
|
|
154
|
+
{kind: "removeField", modelName: "Todo", path: "notes", safe: false},
|
|
155
|
+
{kind: "changeFieldType", modelName: "Todo", path: "title", safe: false},
|
|
156
|
+
])
|
|
157
|
+
);
|
|
158
|
+
});
|
|
159
|
+
});
|