@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.
Files changed (293) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +6 -0
  3. package/dist/adminTypes.d.ts +7 -0
  4. package/dist/adminTypes.js +6 -1
  5. package/dist/api.d.ts +10 -0
  6. package/dist/api.js +99 -36
  7. package/dist/audit/auditApp.d.ts +30 -0
  8. package/dist/audit/auditApp.js +155 -0
  9. package/dist/audit/auditEventModel.d.ts +29 -0
  10. package/dist/audit/auditEventModel.js +102 -0
  11. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  12. package/dist/audit/cloudTasksEnqueue.js +162 -0
  13. package/dist/audit/diff.d.ts +10 -0
  14. package/dist/audit/diff.js +230 -0
  15. package/dist/audit/processQueue.d.ts +6 -0
  16. package/dist/audit/processQueue.js +101 -0
  17. package/dist/audit/rbacSink.d.ts +2 -0
  18. package/dist/audit/rbacSink.js +82 -0
  19. package/dist/audit/record.d.ts +56 -0
  20. package/dist/audit/record.js +373 -0
  21. package/dist/betterAuth.d.ts +6 -0
  22. package/dist/betterAuthSetup.js +1 -1
  23. package/dist/collectionRegistry.d.ts +3 -1
  24. package/dist/collectionRegistry.js +25 -0
  25. package/dist/index.d.ts +26 -1
  26. package/dist/index.js +48 -2
  27. package/dist/mcp/query.d.ts +0 -13
  28. package/dist/mcp/query.js +8 -8
  29. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  30. package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
  31. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  32. package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
  33. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  34. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
  35. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  36. package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
  37. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  38. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  39. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  40. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
  41. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  42. package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
  43. package/dist/migrations/generate.d.ts +17 -0
  44. package/dist/migrations/generate.js +277 -0
  45. package/dist/migrations/load.d.ts +20 -0
  46. package/dist/migrations/load.js +236 -0
  47. package/dist/migrations/lock.d.ts +13 -0
  48. package/dist/migrations/lock.js +145 -0
  49. package/dist/migrations/runner.d.ts +42 -0
  50. package/dist/migrations/runner.js +503 -0
  51. package/dist/migrations/schemaCatalog.d.ts +44 -0
  52. package/dist/migrations/schemaCatalog.js +326 -0
  53. package/dist/migrations/types.d.ts +87 -0
  54. package/dist/migrations/types.js +7 -0
  55. package/dist/models/notification.d.ts +2 -0
  56. package/dist/models/notification.js +62 -0
  57. package/dist/models/notificationPreference.d.ts +2 -0
  58. package/dist/models/notificationPreference.js +49 -0
  59. package/dist/notifications/notificationService.d.ts +40 -0
  60. package/dist/notifications/notificationService.js +323 -0
  61. package/dist/notifications/notificationsApp.d.ts +18 -0
  62. package/dist/notifications/notificationsApp.js +250 -0
  63. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  64. package/dist/notifications/notificationsBeforeSend.js +77 -0
  65. package/dist/openApi.d.ts +1 -7
  66. package/dist/openApi.js +7 -6
  67. package/dist/openApiBuilder.d.ts +14 -3
  68. package/dist/openApiValidator.d.ts +13 -1
  69. package/dist/openApiValidator.js +200 -36
  70. package/dist/orgs/orgContext.d.ts +23 -0
  71. package/dist/orgs/orgContext.js +198 -0
  72. package/dist/orgs/orgPermissions.d.ts +4 -0
  73. package/dist/orgs/orgPermissions.js +77 -0
  74. package/dist/orgs/orgPlugin.d.ts +13 -0
  75. package/dist/orgs/orgPlugin.js +84 -0
  76. package/dist/orgs/organizationModel.d.ts +13 -0
  77. package/dist/orgs/organizationModel.js +301 -0
  78. package/dist/orgs/organizationSettings.d.ts +19 -0
  79. package/dist/orgs/organizationSettings.js +120 -0
  80. package/dist/orgs/orgsApp.d.ts +28 -0
  81. package/dist/orgs/orgsApp.js +678 -0
  82. package/dist/permissions.d.ts +7 -13
  83. package/dist/permissions.js +8 -31
  84. package/dist/rateLimit/middleware.d.ts +0 -8
  85. package/dist/rateLimit/middleware.js +2 -3
  86. package/dist/rateLimit/mongoStore.d.ts +1 -0
  87. package/dist/rateLimit/mongoStore.js +1 -0
  88. package/dist/rateLimit/policies.d.ts +0 -4
  89. package/dist/rateLimit/policies.js +5 -7
  90. package/dist/rateLimit/redisStore.d.ts +1 -0
  91. package/dist/rateLimit/redisStore.js +1 -0
  92. package/dist/rbac/access.js +30 -13
  93. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  94. package/dist/rbac/membershipOrgAdminSource.js +122 -0
  95. package/dist/rbac/modelRouterAccess.d.ts +3 -0
  96. package/dist/rbac/modelRouterAccess.js +3 -0
  97. package/dist/rbac/resolve.js +60 -31
  98. package/dist/rbac/roleModel.d.ts +2 -5
  99. package/dist/rbac/roleModel.js +18 -4
  100. package/dist/rbac/statements.d.ts +10 -1
  101. package/dist/rbac/statements.js +19 -2
  102. package/dist/rbac/types.d.ts +5 -0
  103. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  104. package/dist/realtime/changeStreamWatcher.js +110 -64
  105. package/dist/realtime/deprecation.d.ts +1 -0
  106. package/dist/realtime/deprecation.js +1 -0
  107. package/dist/realtime/realtimeApp.d.ts +1 -0
  108. package/dist/realtime/realtimeApp.js +1 -0
  109. package/dist/schemaMetadata.js +16 -5
  110. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  111. package/dist/sync/adminBroadcastScope.js +194 -0
  112. package/dist/sync/adminWindowAccess.d.ts +13 -0
  113. package/dist/sync/adminWindowAccess.js +96 -0
  114. package/dist/sync/adminWindowMutation.d.ts +88 -0
  115. package/dist/sync/adminWindowMutation.js +247 -0
  116. package/dist/sync/executors.d.ts +9 -3
  117. package/dist/sync/executors.js +190 -159
  118. package/dist/sync/mutationHandler.d.ts +5 -2
  119. package/dist/sync/mutationHandler.js +191 -71
  120. package/dist/sync/registry.js +4 -0
  121. package/dist/sync/routes.d.ts +13 -0
  122. package/dist/sync/routes.js +113 -56
  123. package/dist/sync/socketHandlers.d.ts +8 -2
  124. package/dist/sync/socketHandlers.js +144 -50
  125. package/dist/sync/streams.d.ts +2 -0
  126. package/dist/sync/streams.js +7 -1
  127. package/dist/sync/syncApp.d.ts +2 -1
  128. package/dist/sync/syncApp.js +2 -1
  129. package/dist/sync/syncBatch.d.ts +5 -2
  130. package/dist/sync/syncBatch.js +4 -4
  131. package/dist/sync/types.d.ts +18 -0
  132. package/dist/terrenoApp.d.ts +29 -0
  133. package/dist/terrenoApp.js +91 -54
  134. package/dist/tests/createTestData.d.ts +1 -3
  135. package/dist/tests/createTestData.js +3 -5
  136. package/dist/tests/models.d.ts +1 -0
  137. package/dist/tests/models.js +9 -2
  138. package/dist/tests/testHelper.d.ts +0 -5
  139. package/dist/tests/testHelper.js +2 -9
  140. package/dist/types/authToken.d.ts +3 -3
  141. package/dist/types/mcpServiceToken.d.ts +2 -2
  142. package/dist/types/membership.d.ts +23 -0
  143. package/dist/types/membership.js +2 -0
  144. package/dist/types/notification.d.ts +28 -0
  145. package/dist/types/notification.js +2 -0
  146. package/dist/types/notificationPreference.d.ts +20 -0
  147. package/dist/types/notificationPreference.js +2 -0
  148. package/dist/types/organization.d.ts +36 -0
  149. package/dist/types/organization.js +2 -0
  150. package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
  151. package/dist/webhooks/idempotency/webhookReceipt.js +7 -7
  152. package/dist/webhooks/rawBody.d.ts +1 -0
  153. package/dist/webhooks/rawBody.js +1 -0
  154. package/package.json +31 -25
  155. package/src/__snapshots__/openApi.test.ts.snap +192 -54
  156. package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
  157. package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
  158. package/src/adminTypes.ts +8 -0
  159. package/src/api.test.ts +39 -2
  160. package/src/api.ts +68 -0
  161. package/src/audit/auditApp.test.ts +243 -0
  162. package/src/audit/auditApp.ts +139 -0
  163. package/src/audit/auditEventModel.ts +156 -0
  164. package/src/audit/auditRouter.test.ts +456 -0
  165. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  166. package/src/audit/cloudTasksEnqueue.ts +104 -0
  167. package/src/audit/diff.ts +163 -0
  168. package/src/audit/processQueue.ts +69 -0
  169. package/src/audit/rbacSink.test.ts +86 -0
  170. package/src/audit/rbacSink.ts +42 -0
  171. package/src/audit/record.test.ts +402 -0
  172. package/src/audit/record.ts +328 -0
  173. package/src/auth.test.ts +1 -1
  174. package/src/betterAuth.ts +7 -0
  175. package/src/betterAuthSetup.test.ts +27 -0
  176. package/src/betterAuthSetup.ts +1 -0
  177. package/src/collectionRegistry.test.ts +8 -9
  178. package/src/collectionRegistry.ts +21 -1
  179. package/src/express.d.ts +2 -0
  180. package/src/expressServer.test.ts +50 -2
  181. package/src/index.ts +69 -0
  182. package/src/mcp/handlers.test.ts +275 -0
  183. package/src/mcp/query.ts +3 -3
  184. package/src/mcp/toolGenerator.test.ts +81 -0
  185. package/src/migrations/cli.test.ts +376 -0
  186. package/src/migrations/cli.ts +283 -0
  187. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  188. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  189. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  190. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  191. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  192. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  193. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  194. package/src/migrations/generate.test.ts +333 -0
  195. package/src/migrations/generate.ts +216 -0
  196. package/src/migrations/load.test.ts +103 -0
  197. package/src/migrations/load.ts +124 -0
  198. package/src/migrations/lock.test.ts +133 -0
  199. package/src/migrations/lock.ts +118 -0
  200. package/src/migrations/runner.test.ts +504 -0
  201. package/src/migrations/runner.ts +358 -0
  202. package/src/migrations/schemaCatalog.test.ts +159 -0
  203. package/src/migrations/schemaCatalog.ts +262 -0
  204. package/src/migrations/types.ts +94 -0
  205. package/src/models/notification.ts +68 -0
  206. package/src/models/notificationPreference.ts +62 -0
  207. package/src/notifications/notificationService.ts +254 -0
  208. package/src/notifications/notificationsApp.test.ts +505 -0
  209. package/src/notifications/notificationsApp.ts +200 -0
  210. package/src/notifications/notificationsBeforeSend.ts +51 -0
  211. package/src/openApi.test.ts +0 -1
  212. package/src/openApi.ts +2 -1
  213. package/src/openApiBuilder.ts +14 -3
  214. package/src/openApiValidator.test.ts +221 -2
  215. package/src/openApiValidator.ts +218 -33
  216. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  217. package/src/orgs/orgContext.test.ts +259 -0
  218. package/src/orgs/orgContext.ts +151 -0
  219. package/src/orgs/orgPermissions.test.ts +105 -0
  220. package/src/orgs/orgPermissions.ts +40 -0
  221. package/src/orgs/orgPlugin.test.ts +130 -0
  222. package/src/orgs/orgPlugin.ts +70 -0
  223. package/src/orgs/orgRbac.test.ts +267 -0
  224. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  225. package/src/orgs/organizationModel.test.ts +205 -0
  226. package/src/orgs/organizationModel.ts +257 -0
  227. package/src/orgs/organizationSettings.test.ts +113 -0
  228. package/src/orgs/organizationSettings.ts +126 -0
  229. package/src/orgs/orgsApp.test.ts +382 -0
  230. package/src/orgs/orgsApp.ts +563 -0
  231. package/src/permissions.test.ts +62 -36
  232. package/src/permissions.ts +8 -30
  233. package/src/rateLimit/middleware.ts +1 -1
  234. package/src/rateLimit/mongoStore.ts +1 -0
  235. package/src/rateLimit/policies.ts +2 -2
  236. package/src/rateLimit/redisStore.ts +1 -0
  237. package/src/rbac/access.ts +11 -3
  238. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  239. package/src/rbac/modelRouterAccess.ts +3 -0
  240. package/src/rbac/permissionUtils.test.ts +26 -5
  241. package/src/rbac/resolve.test.ts +34 -2
  242. package/src/rbac/resolve.ts +26 -7
  243. package/src/rbac/roleModel.test.ts +34 -1
  244. package/src/rbac/roleModel.ts +17 -1
  245. package/src/rbac/statements.test.ts +19 -0
  246. package/src/rbac/statements.ts +19 -1
  247. package/src/rbac/types.ts +5 -0
  248. package/src/realtime/changeStreamWatcher.ts +73 -33
  249. package/src/realtime/deprecation.ts +1 -0
  250. package/src/realtime/realtime.test.ts +357 -185
  251. package/src/realtime/realtimeApp.ts +1 -0
  252. package/src/schemaMetadata.test.ts +14 -0
  253. package/src/schemaMetadata.ts +5 -5
  254. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  255. package/src/sync/adminBroadcastScope.test.ts +155 -0
  256. package/src/sync/adminBroadcastScope.ts +123 -0
  257. package/src/sync/adminWindowAccess.test.ts +57 -0
  258. package/src/sync/adminWindowAccess.ts +32 -0
  259. package/src/sync/adminWindowMutation.test.ts +450 -0
  260. package/src/sync/adminWindowMutation.ts +283 -0
  261. package/src/sync/executors.ts +33 -6
  262. package/src/sync/mutationHandler.test.ts +277 -1
  263. package/src/sync/mutationHandler.ts +171 -29
  264. package/src/sync/registry.ts +4 -0
  265. package/src/sync/routes.ts +52 -8
  266. package/src/sync/socketHandlers.ts +154 -58
  267. package/src/sync/streams.ts +6 -0
  268. package/src/sync/sync.test.ts +3 -2
  269. package/src/sync/syncApp.ts +2 -1
  270. package/src/sync/syncBatch.ts +7 -2
  271. package/src/sync/syncRoutes.test.ts +297 -3
  272. package/src/sync/syncSocket.test.ts +229 -0
  273. package/src/sync/types.ts +20 -0
  274. package/src/terrenoApp.migrations.test.ts +114 -0
  275. package/src/terrenoApp.test.ts +41 -0
  276. package/src/terrenoApp.ts +94 -31
  277. package/src/tests/createTestData.ts +2 -2
  278. package/src/tests/models.ts +10 -2
  279. package/src/tests/testHelper.ts +1 -7
  280. package/src/types/authToken.ts +2 -4
  281. package/src/types/mcpServiceToken.ts +1 -7
  282. package/src/types/membership.ts +48 -0
  283. package/src/types/notification.ts +34 -0
  284. package/src/types/notificationPreference.ts +28 -0
  285. package/src/types/organization.ts +49 -0
  286. package/src/webhooks/idempotency/webhookReceipt.ts +4 -7
  287. package/src/webhooks/rawBody.test.ts +33 -0
  288. package/src/webhooks/rawBody.ts +1 -0
  289. package/tsconfig.json +1 -1
  290. package/tsconfig.typedoc.json +2 -1
  291. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  292. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  293. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
@@ -0,0 +1,504 @@
1
+ /**
2
+ * Tests for applying, rolling back, and inspecting migration history, plus the
3
+ * production wet-apply gate and the CI reverse-exercise helper.
4
+ */
5
+ import {beforeEach, describe, expect, it} from "bun:test";
6
+ import {join} from "node:path";
7
+ import mongoose from "mongoose";
8
+
9
+ import {APIError} from "../errors";
10
+ import {setupDb} from "../tests";
11
+ import {
12
+ assertMigrationsAllowed,
13
+ exerciseReversibleMigrations,
14
+ getMigrationStatus,
15
+ runDownMigrations,
16
+ runMigrations,
17
+ } from "./runner";
18
+ import {type LoadedMigration, MIGRATION_LOCK_ID, MIGRATIONS_COLLECTION} from "./types";
19
+
20
+ const collection = (): mongoose.Collection => {
21
+ return mongoose.connection.collection(MIGRATIONS_COLLECTION);
22
+ };
23
+
24
+ const appliedIds = async (): Promise<string[]> => {
25
+ const docs = await collection()
26
+ .find({_id: {$ne: MIGRATION_LOCK_ID}})
27
+ .project({id: 1})
28
+ .toArray();
29
+ return docs.map((doc) => String(doc.id));
30
+ };
31
+
32
+ const makeMigration = ({
33
+ id,
34
+ checksum,
35
+ up,
36
+ }: {
37
+ id: string;
38
+ checksum: string;
39
+ up: LoadedMigration["up"];
40
+ }): LoadedMigration => {
41
+ return {checksum, id, up};
42
+ };
43
+
44
+ describe("runMigrations", () => {
45
+ beforeEach(async () => {
46
+ await setupDb();
47
+ await collection().deleteMany({});
48
+ });
49
+
50
+ it("calls up with dryRun true and does not record history", async () => {
51
+ const seen: boolean[] = [];
52
+ const migrations = [
53
+ makeMigration({
54
+ checksum: "aaa",
55
+ id: "20260910120000-dry",
56
+ up: async (ctx) => {
57
+ seen.push(ctx.dryRun);
58
+ },
59
+ }),
60
+ ];
61
+
62
+ const result = await runMigrations({
63
+ connection: mongoose.connection,
64
+ dryRun: true,
65
+ migrations,
66
+ mongoose,
67
+ });
68
+
69
+ expect(result.dryRun).toBe(true);
70
+ expect(result.applied).toEqual(["20260910120000-dry"]);
71
+ expect(seen).toEqual([true]);
72
+ expect(await appliedIds()).toEqual([]);
73
+ });
74
+
75
+ it("records checksum and appliedAt on a wet run", async () => {
76
+ const migrations = [
77
+ makeMigration({
78
+ checksum: "bbb",
79
+ id: "20260910120000-wet",
80
+ up: async () => undefined,
81
+ }),
82
+ ];
83
+
84
+ const result = await runMigrations({
85
+ connection: mongoose.connection,
86
+ dryRun: false,
87
+ migrations,
88
+ mongoose,
89
+ });
90
+
91
+ expect(result.applied).toEqual(["20260910120000-wet"]);
92
+ expect(result.skipped).toEqual([]);
93
+ const stored = await collection().findOne({_id: "20260910120000-wet"});
94
+ expect(stored?.id).toBe("20260910120000-wet");
95
+ expect(stored?.checksum).toBe("bbb");
96
+ expect(stored?.appliedAt).toBeInstanceOf(Date);
97
+ });
98
+
99
+ it("skips already-applied ids on a second wet run", async () => {
100
+ let calls = 0;
101
+ const migrations = [
102
+ makeMigration({
103
+ checksum: "ccc",
104
+ id: "20260910120000-once",
105
+ up: async () => {
106
+ calls += 1;
107
+ },
108
+ }),
109
+ ];
110
+ const options = {
111
+ connection: mongoose.connection,
112
+ dryRun: false,
113
+ migrations,
114
+ mongoose,
115
+ };
116
+
117
+ await runMigrations(options);
118
+ const second = await runMigrations(options);
119
+
120
+ expect(calls).toBe(1);
121
+ expect(second.applied).toEqual([]);
122
+ expect(second.skipped).toEqual(["20260910120000-once"]);
123
+ });
124
+
125
+ it("throws when an applied id has a different checksum", async () => {
126
+ await runMigrations({
127
+ connection: mongoose.connection,
128
+ dryRun: false,
129
+ migrations: [
130
+ makeMigration({
131
+ checksum: "original",
132
+ id: "20260910120000-edit",
133
+ up: async () => undefined,
134
+ }),
135
+ ],
136
+ mongoose,
137
+ });
138
+
139
+ await expect(
140
+ runMigrations({
141
+ connection: mongoose.connection,
142
+ dryRun: false,
143
+ migrations: [
144
+ makeMigration({
145
+ checksum: "edited",
146
+ id: "20260910120000-edit",
147
+ up: async () => undefined,
148
+ }),
149
+ ],
150
+ mongoose,
151
+ })
152
+ ).rejects.toThrow("checksum");
153
+ });
154
+ });
155
+
156
+ describe("runDownMigrations", () => {
157
+ beforeEach(async () => {
158
+ await setupDb();
159
+ await collection().deleteMany({});
160
+ });
161
+
162
+ it("rolls back the last applied migration and deletes history", async () => {
163
+ const events: string[] = [];
164
+ const migrations: LoadedMigration[] = [
165
+ {
166
+ checksum: "one",
167
+ down: async () => {
168
+ events.push("down-a");
169
+ },
170
+ id: "20260910120000-a",
171
+ up: async () => {
172
+ events.push("up-a");
173
+ },
174
+ },
175
+ {
176
+ checksum: "two",
177
+ down: async () => {
178
+ events.push("down-b");
179
+ },
180
+ id: "20260910120001-b",
181
+ up: async () => {
182
+ events.push("up-b");
183
+ },
184
+ },
185
+ ];
186
+
187
+ await runMigrations({
188
+ connection: mongoose.connection,
189
+ dryRun: false,
190
+ migrations,
191
+ mongoose,
192
+ });
193
+ const result = await runDownMigrations({
194
+ connection: mongoose.connection,
195
+ dryRun: false,
196
+ migrations,
197
+ mongoose,
198
+ steps: 1,
199
+ });
200
+
201
+ expect(result.reversed).toEqual(["20260910120001-b"]);
202
+ expect(events).toEqual(["up-a", "up-b", "down-b"]);
203
+ expect(await appliedIds()).toEqual(["20260910120000-a"]);
204
+ });
205
+
206
+ it("does not delete history on dry-run down", async () => {
207
+ const migrations: LoadedMigration[] = [
208
+ {
209
+ checksum: "dry-down",
210
+ down: async (ctx) => {
211
+ expect(ctx.dryRun).toBe(true);
212
+ },
213
+ id: "20260910120000-dry-down",
214
+ up: async () => undefined,
215
+ },
216
+ ];
217
+ await runMigrations({
218
+ connection: mongoose.connection,
219
+ dryRun: false,
220
+ migrations,
221
+ mongoose,
222
+ });
223
+
224
+ const result = await runDownMigrations({
225
+ connection: mongoose.connection,
226
+ dryRun: true,
227
+ migrations,
228
+ mongoose,
229
+ steps: 1,
230
+ });
231
+
232
+ expect(result.reversed).toEqual(["20260910120000-dry-down"]);
233
+ expect(await appliedIds()).toEqual(["20260910120000-dry-down"]);
234
+ });
235
+
236
+ it("throws when the target migration has no down", async () => {
237
+ const migrations: LoadedMigration[] = [
238
+ {
239
+ checksum: "irreversible",
240
+ id: "20260910120000-irreversible",
241
+ up: async () => undefined,
242
+ },
243
+ ];
244
+ await runMigrations({
245
+ connection: mongoose.connection,
246
+ dryRun: false,
247
+ migrations,
248
+ mongoose,
249
+ });
250
+
251
+ await expect(
252
+ runDownMigrations({
253
+ connection: mongoose.connection,
254
+ dryRun: false,
255
+ migrations,
256
+ mongoose,
257
+ steps: 1,
258
+ })
259
+ ).rejects.toThrow("has no down");
260
+ expect(await appliedIds()).toEqual(["20260910120000-irreversible"]);
261
+ });
262
+
263
+ it("rejects a non-positive or non-integer steps value before touching history", async () => {
264
+ const migrations: LoadedMigration[] = [
265
+ {
266
+ checksum: "steps",
267
+ down: async () => undefined,
268
+ id: "20260910120000-steps",
269
+ up: async () => undefined,
270
+ },
271
+ ];
272
+ await runMigrations({connection: mongoose.connection, dryRun: false, migrations, mongoose});
273
+
274
+ for (const steps of [0, -1, 1.5]) {
275
+ await expect(
276
+ runDownMigrations({
277
+ connection: mongoose.connection,
278
+ dryRun: false,
279
+ migrations,
280
+ mongoose,
281
+ steps,
282
+ })
283
+ ).rejects.toThrow("Invalid down steps");
284
+ }
285
+ expect(await appliedIds()).toEqual(["20260910120000-steps"]);
286
+ });
287
+
288
+ it("stops before up when checkCancellation rejects", async () => {
289
+ let ran = false;
290
+ await expect(
291
+ runMigrations({
292
+ checkCancellation: async () => {
293
+ throw new APIError({status: 409, title: "Task was cancelled"});
294
+ },
295
+ connection: mongoose.connection,
296
+ dryRun: false,
297
+ migrations: [
298
+ makeMigration({
299
+ checksum: "cancel",
300
+ id: "20260910120000-cancel",
301
+ up: async () => {
302
+ ran = true;
303
+ },
304
+ }),
305
+ ],
306
+ mongoose,
307
+ })
308
+ ).rejects.toThrow("cancelled");
309
+ expect(ran).toBe(false);
310
+ expect(await appliedIds()).toEqual([]);
311
+ });
312
+ });
313
+
314
+ describe("getMigrationStatus", () => {
315
+ beforeEach(async () => {
316
+ await setupDb();
317
+ await collection().deleteMany({});
318
+ });
319
+
320
+ const migrations: LoadedMigration[] = [
321
+ {checksum: "one", id: "20260910120000-a", up: async () => undefined},
322
+ {checksum: "two", id: "20260910120001-b", up: async () => undefined},
323
+ ];
324
+
325
+ it("splits migrations into applied and pending with no lock", async () => {
326
+ await runMigrations({
327
+ connection: mongoose.connection,
328
+ dryRun: false,
329
+ migrations: [migrations[0]],
330
+ mongoose,
331
+ });
332
+
333
+ const status = await getMigrationStatus({connection: mongoose.connection, migrations});
334
+
335
+ expect(status.lock).toBeNull();
336
+ expect(status.pending).toEqual([{checksum: "two", id: "20260910120001-b"}]);
337
+ expect(status.applied).toHaveLength(1);
338
+ expect(status.applied[0].id).toBe("20260910120000-a");
339
+ expect(status.applied[0].checksum).toBe("one");
340
+ expect(status.applied[0].appliedAt).toBeInstanceOf(Date);
341
+ });
342
+
343
+ it("reports the active lock holder and expiry", async () => {
344
+ const expiresAt = new Date("2026-09-10T12:00:00.000Z");
345
+ await collection().insertOne({_id: MIGRATION_LOCK_ID, expiresAt, holder: "worker-1"});
346
+
347
+ const status = await getMigrationStatus({connection: mongoose.connection, migrations});
348
+
349
+ expect(status.lock).toEqual({expiresAt, holder: "worker-1"});
350
+ expect(status.applied).toEqual([]);
351
+ expect(status.pending.map((m) => m.id)).toEqual(["20260910120000-a", "20260910120001-b"]);
352
+ });
353
+
354
+ it("defaults a lock holder to an empty string when missing", async () => {
355
+ await collection().insertOne({
356
+ _id: MIGRATION_LOCK_ID,
357
+ expiresAt: "2026-09-10T12:00:00.000Z",
358
+ });
359
+
360
+ const status = await getMigrationStatus({connection: mongoose.connection, migrations});
361
+
362
+ expect(status.lock?.holder).toBe("");
363
+ expect(status.lock?.expiresAt).toEqual(new Date("2026-09-10T12:00:00.000Z"));
364
+ });
365
+
366
+ it("parses ISO string appliedAt values from legacy history docs", async () => {
367
+ await collection().insertOne({
368
+ _id: "20260910120000-a",
369
+ appliedAt: "2026-09-10T11:00:00.000Z",
370
+ checksum: "one",
371
+ id: "20260910120000-a",
372
+ });
373
+
374
+ const status = await getMigrationStatus({connection: mongoose.connection, migrations});
375
+
376
+ expect(status.applied[0].appliedAt).toEqual(new Date("2026-09-10T11:00:00.000Z"));
377
+ });
378
+
379
+ it("throws when a stored timestamp is not a valid date", async () => {
380
+ await collection().insertOne({
381
+ _id: "20260910120000-a",
382
+ appliedAt: "not-a-date",
383
+ checksum: "one",
384
+ id: "20260910120000-a",
385
+ });
386
+
387
+ await expect(getMigrationStatus({connection: mongoose.connection, migrations})).rejects.toThrow(
388
+ "Invalid migration timestamp"
389
+ );
390
+ });
391
+ });
392
+
393
+ describe("assertMigrationsAllowed", () => {
394
+ it("allows dry-run in production without ALLOW_MIGRATIONS or force", () => {
395
+ expect(() => {
396
+ assertMigrationsAllowed({
397
+ allowEnv: false,
398
+ dryRun: true,
399
+ force: false,
400
+ isProduction: true,
401
+ });
402
+ }).not.toThrow();
403
+ });
404
+
405
+ it("allows wet runs outside production without force", () => {
406
+ expect(() => {
407
+ assertMigrationsAllowed({
408
+ allowEnv: false,
409
+ dryRun: false,
410
+ force: false,
411
+ isProduction: false,
412
+ });
413
+ }).not.toThrow();
414
+ });
415
+
416
+ it("denies wet production when ALLOW_MIGRATIONS is unset", () => {
417
+ expect(() => {
418
+ assertMigrationsAllowed({
419
+ allowEnv: false,
420
+ dryRun: false,
421
+ force: true,
422
+ isProduction: true,
423
+ });
424
+ }).toThrow(APIError);
425
+ try {
426
+ assertMigrationsAllowed({
427
+ allowEnv: false,
428
+ dryRun: false,
429
+ force: true,
430
+ isProduction: true,
431
+ });
432
+ } catch (error) {
433
+ expect(error).toBeInstanceOf(APIError);
434
+ expect((error as APIError).status).toBe(403);
435
+ expect((error as APIError).title).toBe("Migrations not allowed");
436
+ }
437
+ });
438
+
439
+ it("denies wet production when ALLOW_MIGRATIONS is set but force is missing", () => {
440
+ expect(() => {
441
+ assertMigrationsAllowed({
442
+ allowEnv: true,
443
+ dryRun: false,
444
+ force: false,
445
+ isProduction: true,
446
+ });
447
+ }).toThrow("Migrations not allowed");
448
+ });
449
+
450
+ it("allows wet production when ALLOW_MIGRATIONS and force are both set", () => {
451
+ expect(() => {
452
+ assertMigrationsAllowed({
453
+ allowEnv: true,
454
+ dryRun: false,
455
+ force: true,
456
+ isProduction: true,
457
+ });
458
+ }).not.toThrow();
459
+ });
460
+ });
461
+
462
+ describe("exerciseReversibleMigrations", () => {
463
+ const fixtures = (...parts: string[]): string => {
464
+ return join(import.meta.dir, "fixtures", ...parts);
465
+ };
466
+
467
+ const sortedAppliedIds = async (): Promise<string[]> => {
468
+ const docs = await mongoose.connection
469
+ .collection(MIGRATIONS_COLLECTION)
470
+ .find({_id: {$ne: MIGRATION_LOCK_ID}})
471
+ .project({id: 1})
472
+ .toArray();
473
+ return docs.map((doc) => String(doc.id)).sort();
474
+ };
475
+
476
+ beforeEach(async () => {
477
+ await setupDb();
478
+ await mongoose.connection.collection(MIGRATIONS_COLLECTION).deleteMany({});
479
+ });
480
+
481
+ it("applies all files then rolls back until an irreversible file stops the chain", async () => {
482
+ const result = await exerciseReversibleMigrations({
483
+ connect: async () => mongoose.connection,
484
+ dir: fixtures("valid"),
485
+ });
486
+
487
+ expect(result.applied).toEqual(["20260910120000-alpha", "20260910120001-beta"]);
488
+ expect(result.reversed).toEqual(["20260910120001-beta"]);
489
+ expect(result.skippedIrreversible).toBe("20260910120000-alpha");
490
+ expect(await sortedAppliedIds()).toEqual(["20260910120000-alpha"]);
491
+ });
492
+
493
+ it("reverses every file when all have down", async () => {
494
+ const result = await exerciseReversibleMigrations({
495
+ connect: async () => mongoose.connection,
496
+ dir: fixtures("all-down"),
497
+ });
498
+
499
+ expect(result.applied).toEqual(["20260910120000-one", "20260910120001-two"]);
500
+ expect(result.reversed).toEqual(["20260910120001-two", "20260910120000-one"]);
501
+ expect(result.skippedIrreversible).toBeNull();
502
+ expect(await sortedAppliedIds()).toEqual([]);
503
+ });
504
+ });