@prairielearn/migrations 3.0.11 → 3.0.13

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @prairielearn/migrations
 
+## 3.0.13
+
+### Patch Changes
+
+- 984dc62: Upgrade all JavaScript dependencies
+- Updated dependencies [984dc62]
+  - @prairielearn/named-locks@3.0.13
+  - @prairielearn/postgres@2.1.9
+  - @prairielearn/logger@2.0.11
+  - @prairielearn/error@2.0.11
+
+## 3.0.12
+
+### Patch Changes
+
+- 49bb3fa: Upgrade all JavaScript dependencies
+- Updated dependencies [49bb3fa]
+  - @prairielearn/named-locks@3.0.12
+  - @prairielearn/postgres@2.1.8
+  - @prairielearn/logger@2.0.10
+  - @prairielearn/error@2.0.10
+
 ## 3.0.11
 
 ### Patch Changes

package/dist/batched-migrations/batched-migration-runner.d.ts

@@ -1,4 +1,4 @@
-import { type BatchedMigrationRow, type BatchedMigrationImplementation } from './batched-migration.js';
+import { type BatchedMigrationImplementation, type BatchedMigrationRow } from './batched-migration.js';
 interface BatchedMigrationRunnerOptions {
     logProgress?: boolean;
 }

package/dist/batched-migrations/batched-migration-runner.js

@@ -1,9 +1,9 @@
 import { serializeError } from 'serialize-error';
 import { z } from 'zod';
 import { logger } from '@prairielearn/logger';
-import { loadSqlEquiv, queryAsync, queryRow, queryOptionalRow } from '@prairielearn/postgres';
+import { loadSqlEquiv, queryAsync, queryOptionalRow, queryRow } from '@prairielearn/postgres';
 import { BatchedMigrationJobRowSchema, } from './batched-migration-job.js';
-import { updateBatchedMigrationStatus, BatchedMigrationStatusSchema, } from './batched-migration.js';
+import { BatchedMigrationStatusSchema, updateBatchedMigrationStatus, } from './batched-migration.js';
 const sql = loadSqlEquiv(import.meta.filename);
 export class BatchedMigrationRunner {
     options;

package/dist/batched-migrations/batched-migration-runner.js.map

@@ -1 +1 @@
-{"version":3,"file":"batched-migration-runner.js","sourceRoot":"","sources":["../../src/batched-migrations/batched-migration-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE9F,OAAO,EACL,4BAA4B,GAG7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAGL,4BAA4B,EAC5B,4BAA4B,GAE7B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAM/C,MAAM,OAAO,sBAAsB;IACzB,OAAO,CAAgC;IACvC,SAAS,CAAsB;IAC/B,uBAAuB,CAAiC;IACxD,eAAe,CAAyB;IAEhD,YACE,SAA8B,EAC9B,uBAAuD,EACvD,UAAyC,EAAE;QAE3C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC;IAC1C,CAAC;IAEO,GAAG,CAAC,OAAe,EAAE,GAAG,IAAW;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,SAA8B;QAC5D,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,qCAAqC,EACzC,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,EAAE,EACtC,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,SAA8B;QACxD,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,iCAAiC,EACrC,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,EAAE,EACtC,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,SAA8B;QACjE,IAAI,CAAC,eAAe,GAAG,MAAM,QAAQ,CACnC,GAAG,CAAC,oBAAoB,EACxB;YACE,EAAE,EAAE,SAAS,CAAC,EAAE;SACjB,EACD,4BAA4B,CAC7B,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,SAA8B;QACjE,+DAA+D;QAC/D,yBAAyB;QACzB,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;YAC3D,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC;QAC3D,MAAM,4BAA4B,CAAC,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,GAAG,CAAC,yBAAyB,WAAW,GAAG,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,SAA8B;QAE9B,MAAM,OAAO,GAAG,MAAM,gBAAgB,CACpC,GAAG,CAAC,iCAAiC,EACrC,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,EAAE,EACtC,4BAA4B,CAC7B,CAAC;QAEF,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;QACvE,IAAI,OAAO,GAAG,SAAS,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAE/C,IAAI,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC1D,IAAI,OAAO,GAAG,SAAS,CAAC,SAAS;YAAE,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC;QAEjE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,GAA2B;QAChD,MAAM,UAAU,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,GAAG,CAAC;QACxD,MAAM,cAAc,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,SAAS,GAAG,CAAC;QACpF,IAAI,CAAC,GAAG,CAAC,eAAe,GAAG,CAAC,EAAE,cAAc,QAAQ,OAAO,cAAc,EAAE,CAAC,CAAC;IAC/E,CAAC;IAEO,gBAAgB,CAAC,IAAa;QACpC,IAAI,IAAI,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QAE9B,4DAA4D;QAC5D,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;YACvD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,SAAS,CACrB,GAA2B,EAC3B,MAAkE,EAClE,IAAc;QAEd,MAAM,UAAU,CAAC,GAAG,CAAC,4BAA4B,EAAE;YACjD,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,MAAM;YACN,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,EAAE,0BAA0B,MAAM,GAAG,CAAC,CAAC;IAC7D,CAAC;IAEO,KAAK,CAAC,2BAA2B,CACvC,SAA8B;QAE9B,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACjE,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,4BAA4B,EAChC;gBACE,oBAAoB,EAAE,SAAS,CAAC,EAAE;gBAClC,SAAS,EAAE,eAAe,CAAC,CAAC,CAAC;gBAC7B,SAAS,EAAE,eAAe,CAAC,CAAC,CAAC;aAC9B,EACD,4BAA4B,CAC7B,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,6EAA6E;YAC7E,gFAAgF;YAChF,0CAA0C;YAC1C,OAAO,MAAM,gBAAgB,CAC3B,GAAG,CAAC,0CAA0C,EAC9C,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,EAAE,EACtC,4BAA4B,CAC7B,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,SAA8B,EAC9B,uBAAuD;QAEvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAE7B,IAAI,KAAK,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC;gBACH,qEAAqE;gBACrE,uEAAuE;gBACvE,MAAM,uBAAuB,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9E,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,KAAK,GAAG,GAAG,CAAC;YACd,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,KAAK,CACV,qBAAqB,OAAO,CAAC,EAAE,0BAA0B,SAAS,CAAC,QAAQ,EAAE,EAC7E,KAAK,CACN,CAAC;gBACF,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC5E,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,EACR,MAAM,EACN,UAAU,EACV,UAAU,MAC4D,EAAE;QACxE,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5D,OACE,CAAC,MAAM,EAAE,OAAO;YAChB,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;YACjD,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;YACvC,CAAC,IAAI,CAAC,eAAe,KAAK,SAAS,IAAI,IAAI,CAAC,eAAe,KAAK,YAAY,CAAC,EAC7E,CAAC;YACD,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACzE,cAAc,IAAI,CAAC,CAAC;YACpB,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;CACF","sourcesContent":["import { serializeError } from 'serialize-error';\nimport { z } from 'zod';\n\nimport { logger } from '@prairielearn/logger';\nimport { loadSqlEquiv, queryAsync, queryRow, queryOptionalRow } from '@prairielearn/postgres';\n\nimport {\n  BatchedMigrationJobRowSchema,\n  type BatchedMigrationJobStatus,\n  type BatchedMigrationJobRow,\n} from './batched-migration-job.js';\nimport {\n  type BatchedMigrationStatus,\n  type BatchedMigrationRow,\n  updateBatchedMigrationStatus,\n  BatchedMigrationStatusSchema,\n  type BatchedMigrationImplementation,\n} from './batched-migration.js';\n\nconst sql = loadSqlEquiv(import.meta.filename);\n\ninterface BatchedMigrationRunnerOptions {\n  logProgress?: boolean;\n}\n\nexport class BatchedMigrationRunner {\n  private options: BatchedMigrationRunnerOptions;\n  private migration: BatchedMigrationRow;\n  private migrationImplementation: BatchedMigrationImplementation;\n  private migrationStatus: BatchedMigrationStatus;\n\n  constructor(\n    migration: BatchedMigrationRow,\n    migrationImplementation: BatchedMigrationImplementation,\n    options: BatchedMigrationRunnerOptions = {},\n  ) {\n    this.options = options;\n    this.migration = migration;\n    this.migrationImplementation = migrationImplementation;\n    this.migrationStatus = migration.status;\n  }\n\n  private log(message: string, ...meta: any[]) {\n    if (this.options.logProgress) {\n      logger.info(`[${this.migration.filename}] ${message}`, ...meta);\n    }\n  }\n\n  private async hasIncompleteJobs(migration: BatchedMigrationRow): Promise<boolean> {\n    return await queryRow(\n      sql.batched_migration_has_incomplete_jobs,\n      { batched_migration_id: migration.id },\n      z.boolean(),\n    );\n  }\n\n  private async hasFailedJobs(migration: BatchedMigrationRow): Promise<boolean> {\n    return await queryRow(\n      sql.batched_migration_has_failed_jobs,\n      { batched_migration_id: migration.id },\n      z.boolean(),\n    );\n  }\n\n  private async refreshMigrationStatus(migration: BatchedMigrationRow) {\n    this.migrationStatus = await queryRow(\n      sql.get_migration_status,\n      {\n        id: migration.id,\n      },\n      BatchedMigrationStatusSchema,\n    );\n  }\n\n  private async finishRunningMigration(migration: BatchedMigrationRow) {\n    // Safety check: if there are any pending jobs, don't mark this\n    // migration as finished.\n    if (await this.hasIncompleteJobs(migration)) {\n      this.log('Incomplete jobs found, not marking as finished');\n      return;\n    }\n\n    const hasFailedJobs = await this.hasFailedJobs(migration);\n    const finalStatus = hasFailedJobs ? 'failed' : 'succeeded';\n    await updateBatchedMigrationStatus(migration.id, finalStatus);\n    this.log(`Finished with status '${finalStatus}'`);\n  }\n\n  private async getNextBatchBounds(\n    migration: BatchedMigrationRow,\n  ): Promise<null | [bigint, bigint]> {\n    const lastJob = await queryOptionalRow(\n      sql.select_last_batched_migration_job,\n      { batched_migration_id: migration.id },\n      BatchedMigrationJobRowSchema,\n    );\n\n    const nextMin = lastJob ? lastJob.max_value + 1n : migration.min_value;\n    if (nextMin > migration.max_value) return null;\n\n    let nextMax = nextMin + BigInt(migration.batch_size) - 1n;\n    if (nextMax > migration.max_value) nextMax = migration.max_value;\n\n    return [nextMin, nextMax];\n  }\n\n  private async startJob(job: BatchedMigrationJobRow) {\n    await queryAsync(sql.start_batched_migration_job, { id: job.id });\n    const jobRange = `[${job.min_value}, ${job.max_value}]`;\n    const migrationRange = `[${this.migration.min_value}, ${this.migration.max_value}]`;\n    this.log(`Started job ${job.id} for range ${jobRange} in ${migrationRange}`);\n  }\n\n  private serializeJobData(data: unknown) {\n    if (data == null) return null;\n\n    // Return JSON-stringified data. Convert BigInts to strings.\n    return JSON.stringify(data, (_key, value) => {\n      if (typeof value === 'bigint') return value.toString();\n      return value;\n    });\n  }\n\n  private async finishJob(\n    job: BatchedMigrationJobRow,\n    status: Extract<BatchedMigrationJobStatus, 'failed' | 'succeeded'>,\n    data?: unknown,\n  ) {\n    await queryAsync(sql.finish_batched_migration_job, {\n      id: job.id,\n      status,\n      data: this.serializeJobData(data),\n    });\n    this.log(`Job ${job.id} finished with status '${status}'`);\n  }\n\n  private async getOrCreateNextMigrationJob(\n    migration: BatchedMigrationRow,\n  ): Promise<BatchedMigrationJobRow | null> {\n    const nextBatchBounds = await this.getNextBatchBounds(migration);\n    if (nextBatchBounds) {\n      return await queryRow(\n        sql.insert_batched_migration_job,\n        {\n          batched_migration_id: migration.id,\n          min_value: nextBatchBounds[0],\n          max_value: nextBatchBounds[1],\n        },\n        BatchedMigrationJobRowSchema,\n      );\n    } else {\n      // Pick up any old pending jobs from this migration. These will only exist if\n      // an admin manually elected to retry all failed jobs; we'll never automatically\n      // transition failed jobs back to pending.\n      return await queryOptionalRow(\n        sql.select_first_pending_batched_migration_job,\n        { batched_migration_id: migration.id },\n        BatchedMigrationJobRowSchema,\n      );\n    }\n  }\n\n  private async runMigrationJob(\n    migration: BatchedMigrationRow,\n    migrationImplementation: BatchedMigrationImplementation,\n  ) {\n    const nextJob = await this.getOrCreateNextMigrationJob(migration);\n    if (nextJob) {\n      await this.startJob(nextJob);\n\n      let error = null;\n      try {\n        // We'll only handle errors thrown by the migration itself. If any of\n        // our own execution machinery throws an error, we'll let it bubble up.\n        await migrationImplementation.execute(nextJob.min_value, nextJob.max_value);\n      } catch (err) {\n        error = err;\n      }\n\n      if (error) {\n        logger.error(\n          `Error running job ${nextJob.id} for batched migration ${migration.filename}`,\n          error,\n        );\n        await this.finishJob(nextJob, 'failed', { error: serializeError(error) });\n      } else {\n        await this.finishJob(nextJob, 'succeeded');\n      }\n    } else {\n      await this.finishRunningMigration(migration);\n    }\n  }\n\n  async run({\n    signal,\n    iterations,\n    durationMs,\n  }: { signal?: AbortSignal; iterations?: number; durationMs?: number } = {}) {\n    let iterationCount = 0;\n    const endTime = durationMs ? Date.now() + durationMs : null;\n    while (\n      !signal?.aborted &&\n      (iterations ? iterationCount < iterations : true) &&\n      (endTime ? Date.now() < endTime : true) &&\n      (this.migrationStatus === 'running' || this.migrationStatus === 'finalizing')\n    ) {\n      await this.runMigrationJob(this.migration, this.migrationImplementation);\n      iterationCount += 1;\n      // Always refresh the status so we can detect if the migration was marked\n      // as paused by another process.\n      await this.refreshMigrationStatus(this.migration);\n    }\n  }\n}\n"]}
+{"version":3,"file":"batched-migration-runner.js","sourceRoot":"","sources":["../../src/batched-migrations/batched-migration-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAE9F,OAAO,EAEL,4BAA4B,GAE7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAIL,4BAA4B,EAC5B,4BAA4B,GAC7B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAM/C,MAAM,OAAO,sBAAsB;IACzB,OAAO,CAAgC;IACvC,SAAS,CAAsB;IAC/B,uBAAuB,CAAiC;IACxD,eAAe,CAAyB;IAEhD,YACE,SAA8B,EAC9B,uBAAuD,EACvD,UAAyC,EAAE;QAE3C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC;IAC1C,CAAC;IAEO,GAAG,CAAC,OAAe,EAAE,GAAG,IAAW;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,SAA8B;QAC5D,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,qCAAqC,EACzC,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,EAAE,EACtC,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,SAA8B;QACxD,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,iCAAiC,EACrC,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,EAAE,EACtC,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,SAA8B;QACjE,IAAI,CAAC,eAAe,GAAG,MAAM,QAAQ,CACnC,GAAG,CAAC,oBAAoB,EACxB;YACE,EAAE,EAAE,SAAS,CAAC,EAAE;SACjB,EACD,4BAA4B,CAC7B,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,SAA8B;QACjE,+DAA+D;QAC/D,yBAAyB;QACzB,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;YAC3D,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC;QAC3D,MAAM,4BAA4B,CAAC,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,GAAG,CAAC,yBAAyB,WAAW,GAAG,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,SAA8B;QAE9B,MAAM,OAAO,GAAG,MAAM,gBAAgB,CACpC,GAAG,CAAC,iCAAiC,EACrC,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,EAAE,EACtC,4BAA4B,CAC7B,CAAC;QAEF,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;QACvE,IAAI,OAAO,GAAG,SAAS,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAE/C,IAAI,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC1D,IAAI,OAAO,GAAG,SAAS,CAAC,SAAS;YAAE,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC;QAEjE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,GAA2B;QAChD,MAAM,UAAU,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,GAAG,CAAC;QACxD,MAAM,cAAc,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,SAAS,GAAG,CAAC;QACpF,IAAI,CAAC,GAAG,CAAC,eAAe,GAAG,CAAC,EAAE,cAAc,QAAQ,OAAO,cAAc,EAAE,CAAC,CAAC;IAC/E,CAAC;IAEO,gBAAgB,CAAC,IAAa;QACpC,IAAI,IAAI,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QAE9B,4DAA4D;QAC5D,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;YACvD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,SAAS,CACrB,GAA2B,EAC3B,MAAkE,EAClE,IAAc;QAEd,MAAM,UAAU,CAAC,GAAG,CAAC,4BAA4B,EAAE;YACjD,EAAE,EAAE,GAAG,CAAC,EAAE;YACV,MAAM;YACN,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,EAAE,0BAA0B,MAAM,GAAG,CAAC,CAAC;IAC7D,CAAC;IAEO,KAAK,CAAC,2BAA2B,CACvC,SAA8B;QAE9B,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACjE,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,4BAA4B,EAChC;gBACE,oBAAoB,EAAE,SAAS,CAAC,EAAE;gBAClC,SAAS,EAAE,eAAe,CAAC,CAAC,CAAC;gBAC7B,SAAS,EAAE,eAAe,CAAC,CAAC,CAAC;aAC9B,EACD,4BAA4B,CAC7B,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,6EAA6E;YAC7E,gFAAgF;YAChF,0CAA0C;YAC1C,OAAO,MAAM,gBAAgB,CAC3B,GAAG,CAAC,0CAA0C,EAC9C,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,EAAE,EACtC,4BAA4B,CAC7B,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,SAA8B,EAC9B,uBAAuD;QAEvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAE7B,IAAI,KAAK,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC;gBACH,qEAAqE;gBACrE,uEAAuE;gBACvE,MAAM,uBAAuB,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9E,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,KAAK,GAAG,GAAG,CAAC;YACd,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,KAAK,CACV,qBAAqB,OAAO,CAAC,EAAE,0BAA0B,SAAS,CAAC,QAAQ,EAAE,EAC7E,KAAK,CACN,CAAC;gBACF,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC5E,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,EACR,MAAM,EACN,UAAU,EACV,UAAU,MAC4D,EAAE;QACxE,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5D,OACE,CAAC,MAAM,EAAE,OAAO;YAChB,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;YACjD,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;YACvC,CAAC,IAAI,CAAC,eAAe,KAAK,SAAS,IAAI,IAAI,CAAC,eAAe,KAAK,YAAY,CAAC,EAC7E,CAAC;YACD,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACzE,cAAc,IAAI,CAAC,CAAC;YACpB,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;CACF","sourcesContent":["import { serializeError } from 'serialize-error';\nimport { z } from 'zod';\n\nimport { logger } from '@prairielearn/logger';\nimport { loadSqlEquiv, queryAsync, queryOptionalRow, queryRow } from '@prairielearn/postgres';\n\nimport {\n  type BatchedMigrationJobRow,\n  BatchedMigrationJobRowSchema,\n  type BatchedMigrationJobStatus,\n} from './batched-migration-job.js';\nimport {\n  type BatchedMigrationImplementation,\n  type BatchedMigrationRow,\n  type BatchedMigrationStatus,\n  BatchedMigrationStatusSchema,\n  updateBatchedMigrationStatus,\n} from './batched-migration.js';\n\nconst sql = loadSqlEquiv(import.meta.filename);\n\ninterface BatchedMigrationRunnerOptions {\n  logProgress?: boolean;\n}\n\nexport class BatchedMigrationRunner {\n  private options: BatchedMigrationRunnerOptions;\n  private migration: BatchedMigrationRow;\n  private migrationImplementation: BatchedMigrationImplementation;\n  private migrationStatus: BatchedMigrationStatus;\n\n  constructor(\n    migration: BatchedMigrationRow,\n    migrationImplementation: BatchedMigrationImplementation,\n    options: BatchedMigrationRunnerOptions = {},\n  ) {\n    this.options = options;\n    this.migration = migration;\n    this.migrationImplementation = migrationImplementation;\n    this.migrationStatus = migration.status;\n  }\n\n  private log(message: string, ...meta: any[]) {\n    if (this.options.logProgress) {\n      logger.info(`[${this.migration.filename}] ${message}`, ...meta);\n    }\n  }\n\n  private async hasIncompleteJobs(migration: BatchedMigrationRow): Promise<boolean> {\n    return await queryRow(\n      sql.batched_migration_has_incomplete_jobs,\n      { batched_migration_id: migration.id },\n      z.boolean(),\n    );\n  }\n\n  private async hasFailedJobs(migration: BatchedMigrationRow): Promise<boolean> {\n    return await queryRow(\n      sql.batched_migration_has_failed_jobs,\n      { batched_migration_id: migration.id },\n      z.boolean(),\n    );\n  }\n\n  private async refreshMigrationStatus(migration: BatchedMigrationRow) {\n    this.migrationStatus = await queryRow(\n      sql.get_migration_status,\n      {\n        id: migration.id,\n      },\n      BatchedMigrationStatusSchema,\n    );\n  }\n\n  private async finishRunningMigration(migration: BatchedMigrationRow) {\n    // Safety check: if there are any pending jobs, don't mark this\n    // migration as finished.\n    if (await this.hasIncompleteJobs(migration)) {\n      this.log('Incomplete jobs found, not marking as finished');\n      return;\n    }\n\n    const hasFailedJobs = await this.hasFailedJobs(migration);\n    const finalStatus = hasFailedJobs ? 'failed' : 'succeeded';\n    await updateBatchedMigrationStatus(migration.id, finalStatus);\n    this.log(`Finished with status '${finalStatus}'`);\n  }\n\n  private async getNextBatchBounds(\n    migration: BatchedMigrationRow,\n  ): Promise<null | [bigint, bigint]> {\n    const lastJob = await queryOptionalRow(\n      sql.select_last_batched_migration_job,\n      { batched_migration_id: migration.id },\n      BatchedMigrationJobRowSchema,\n    );\n\n    const nextMin = lastJob ? lastJob.max_value + 1n : migration.min_value;\n    if (nextMin > migration.max_value) return null;\n\n    let nextMax = nextMin + BigInt(migration.batch_size) - 1n;\n    if (nextMax > migration.max_value) nextMax = migration.max_value;\n\n    return [nextMin, nextMax];\n  }\n\n  private async startJob(job: BatchedMigrationJobRow) {\n    await queryAsync(sql.start_batched_migration_job, { id: job.id });\n    const jobRange = `[${job.min_value}, ${job.max_value}]`;\n    const migrationRange = `[${this.migration.min_value}, ${this.migration.max_value}]`;\n    this.log(`Started job ${job.id} for range ${jobRange} in ${migrationRange}`);\n  }\n\n  private serializeJobData(data: unknown) {\n    if (data == null) return null;\n\n    // Return JSON-stringified data. Convert BigInts to strings.\n    return JSON.stringify(data, (_key, value) => {\n      if (typeof value === 'bigint') return value.toString();\n      return value;\n    });\n  }\n\n  private async finishJob(\n    job: BatchedMigrationJobRow,\n    status: Extract<BatchedMigrationJobStatus, 'failed' | 'succeeded'>,\n    data?: unknown,\n  ) {\n    await queryAsync(sql.finish_batched_migration_job, {\n      id: job.id,\n      status,\n      data: this.serializeJobData(data),\n    });\n    this.log(`Job ${job.id} finished with status '${status}'`);\n  }\n\n  private async getOrCreateNextMigrationJob(\n    migration: BatchedMigrationRow,\n  ): Promise<BatchedMigrationJobRow | null> {\n    const nextBatchBounds = await this.getNextBatchBounds(migration);\n    if (nextBatchBounds) {\n      return await queryRow(\n        sql.insert_batched_migration_job,\n        {\n          batched_migration_id: migration.id,\n          min_value: nextBatchBounds[0],\n          max_value: nextBatchBounds[1],\n        },\n        BatchedMigrationJobRowSchema,\n      );\n    } else {\n      // Pick up any old pending jobs from this migration. These will only exist if\n      // an admin manually elected to retry all failed jobs; we'll never automatically\n      // transition failed jobs back to pending.\n      return await queryOptionalRow(\n        sql.select_first_pending_batched_migration_job,\n        { batched_migration_id: migration.id },\n        BatchedMigrationJobRowSchema,\n      );\n    }\n  }\n\n  private async runMigrationJob(\n    migration: BatchedMigrationRow,\n    migrationImplementation: BatchedMigrationImplementation,\n  ) {\n    const nextJob = await this.getOrCreateNextMigrationJob(migration);\n    if (nextJob) {\n      await this.startJob(nextJob);\n\n      let error = null;\n      try {\n        // We'll only handle errors thrown by the migration itself. If any of\n        // our own execution machinery throws an error, we'll let it bubble up.\n        await migrationImplementation.execute(nextJob.min_value, nextJob.max_value);\n      } catch (err) {\n        error = err;\n      }\n\n      if (error) {\n        logger.error(\n          `Error running job ${nextJob.id} for batched migration ${migration.filename}`,\n          error,\n        );\n        await this.finishJob(nextJob, 'failed', { error: serializeError(error) });\n      } else {\n        await this.finishJob(nextJob, 'succeeded');\n      }\n    } else {\n      await this.finishRunningMigration(migration);\n    }\n  }\n\n  async run({\n    signal,\n    iterations,\n    durationMs,\n  }: { signal?: AbortSignal; iterations?: number; durationMs?: number } = {}) {\n    let iterationCount = 0;\n    const endTime = durationMs ? Date.now() + durationMs : null;\n    while (\n      !signal?.aborted &&\n      (iterations ? iterationCount < iterations : true) &&\n      (endTime ? Date.now() < endTime : true) &&\n      (this.migrationStatus === 'running' || this.migrationStatus === 'finalizing')\n    ) {\n      await this.runMigrationJob(this.migration, this.migrationImplementation);\n      iterationCount += 1;\n      // Always refresh the status so we can detect if the migration was marked\n      // as paused by another process.\n      await this.refreshMigrationStatus(this.migration);\n    }\n  }\n}\n"]}

package/dist/batched-migrations/batched-migration.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { loadSqlEquiv, queryAsync, queryRow, queryRows, queryOptionalRow, } from '@prairielearn/postgres';
+import { loadSqlEquiv, queryAsync, queryOptionalRow, queryRow, queryRows, } from '@prairielearn/postgres';
 const sql = loadSqlEquiv(import.meta.filename);
 export const BatchedMigrationStatusSchema = z.enum([
     'pending',

package/dist/batched-migrations/batched-migration.js.map

@@ -1 +1 @@
-{"version":3,"file":"batched-migration.js","sourceRoot":"","sources":["../../src/batched-migrations/batched-migration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,SAAS,EACT,gBAAgB,GACjB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAE/C,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,IAAI,CAAC;IACjD,SAAS;IACT,QAAQ;IACR,SAAS;IACT,YAAY;IACZ,QAAQ;IACR,WAAW;CACZ,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACrC,MAAM,EAAE,4BAA4B;IACpC,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAcH;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAA2C,GAAM;IACnF,sCAAsC,CAAC,GAAG,CAAC,CAAC;IAC5C,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,sCAAsC,CACpD,GAAmC;IAEnC,IAAI,OAAO,GAAG,CAAC,aAAa,KAAK,UAAU,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAOD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,SAA8B;IAE9B,OAAO,MAAM,gBAAgB,CAAC,GAAG,CAAC,wBAAwB,EAAE,SAAS,EAAE,yBAAyB,CAAC,CAAC;AACpG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,OAAe;IAC9D,OAAO,MAAM,SAAS,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,OAAO,EAAE,EAAE,yBAAyB,CAAC,CAAC;AACpG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAe,EACf,EAAU;IAEV,OAAO,MAAM,QAAQ,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,yBAAyB,CAAC,CAAC;AAClG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACtD,OAAe,EACf,SAAiB;IAEjB,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,sCAAsC,EAC1C,EAAE,OAAO,EAAE,SAAS,EAAE,EACtB,yBAAyB,CAC1B,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,EAAU,EACV,MAA8B;IAE9B,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,+BAA+B,EACnC,EAAE,EAAE,EAAE,MAAM,EAAE,EACd,yBAAyB,CAC1B,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAC,OAAe,EAAE,EAAU;IAC/E,MAAM,UAAU,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import { z } from 'zod';\n\nimport {\n  loadSqlEquiv,\n  queryAsync,\n  queryRow,\n  queryRows,\n  queryOptionalRow,\n} from '@prairielearn/postgres';\n\nconst sql = loadSqlEquiv(import.meta.filename);\n\nexport const BatchedMigrationStatusSchema = z.enum([\n  'pending',\n  'paused',\n  'running',\n  'finalizing',\n  'failed',\n  'succeeded',\n]);\nexport type BatchedMigrationStatus = z.infer<typeof BatchedMigrationStatusSchema>;\n\nexport const BatchedMigrationRowSchema = z.object({\n  id: z.string(),\n  project: z.string(),\n  filename: z.string(),\n  timestamp: z.string(),\n  batch_size: z.number(),\n  min_value: z.bigint({ coerce: true }),\n  max_value: z.bigint({ coerce: true }),\n  status: BatchedMigrationStatusSchema,\n  created_at: z.date(),\n  updated_at: z.date(),\n  started_at: z.date().nullable(),\n});\nexport type BatchedMigrationRow = z.infer<typeof BatchedMigrationRowSchema>;\n\nexport interface BatchedMigrationParameters {\n  min?: bigint | string | null;\n  max: bigint | string | null;\n  batchSize?: number;\n}\n\nexport interface BatchedMigrationImplementation {\n  getParameters(): Promise<BatchedMigrationParameters>;\n  execute(start: bigint, end: bigint): Promise<void>;\n}\n\n/**\n * Identity function that helps to write correct batched migrations.\n */\nexport function makeBatchedMigration<T extends BatchedMigrationImplementation>(fns: T): T {\n  validateBatchedMigrationImplementation(fns);\n  return fns;\n}\n\nexport function validateBatchedMigrationImplementation(\n  fns: BatchedMigrationImplementation,\n): asserts fns is BatchedMigrationImplementation {\n  if (typeof fns.getParameters !== 'function') {\n    throw new Error('getParameters() must be a function');\n  }\n  if (typeof fns.execute !== 'function') {\n    throw new Error('execute() must be a function');\n  }\n}\n\ntype NewBatchedMigration = Pick<\n  BatchedMigrationRow,\n  'project' | 'filename' | 'timestamp' | 'batch_size' | 'min_value' | 'max_value' | 'status'\n>;\n\n/**\n * Inserts a new batched migration. If one already exists for the given\n * project/timestamp pair, returns null, otherwise returns the inserted row.\n */\nexport async function insertBatchedMigration(\n  migration: NewBatchedMigration,\n): Promise<BatchedMigrationRow | null> {\n  return await queryOptionalRow(sql.insert_batched_migration, migration, BatchedMigrationRowSchema);\n}\n\nexport async function selectAllBatchedMigrations(project: string) {\n  return await queryRows(sql.select_all_batched_migrations, { project }, BatchedMigrationRowSchema);\n}\n\nexport async function selectBatchedMigration(\n  project: string,\n  id: string,\n): Promise<BatchedMigrationRow> {\n  return await queryRow(sql.select_batched_migration, { project, id }, BatchedMigrationRowSchema);\n}\n\nexport async function selectBatchedMigrationForTimestamp(\n  project: string,\n  timestamp: string,\n): Promise<BatchedMigrationRow> {\n  return await queryRow(\n    sql.select_batched_migration_for_timestamp,\n    { project, timestamp },\n    BatchedMigrationRowSchema,\n  );\n}\n\nexport async function updateBatchedMigrationStatus(\n  id: string,\n  status: BatchedMigrationStatus,\n): Promise<BatchedMigrationRow> {\n  return await queryRow(\n    sql.update_batched_migration_status,\n    { id, status },\n    BatchedMigrationRowSchema,\n  );\n}\n\nexport async function retryFailedBatchedMigrationJobs(project: string, id: string): Promise<void> {\n  await queryAsync(sql.retry_failed_jobs, { project, id });\n}\n"]}
+{"version":3,"file":"batched-migration.js","sourceRoot":"","sources":["../../src/batched-migrations/batched-migration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,QAAQ,EACR,SAAS,GACV,MAAM,wBAAwB,CAAC;AAEhC,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAE/C,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,IAAI,CAAC;IACjD,SAAS;IACT,QAAQ;IACR,SAAS;IACT,YAAY;IACZ,QAAQ;IACR,WAAW;CACZ,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACrC,MAAM,EAAE,4BAA4B;IACpC,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAcH;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAA2C,GAAM;IACnF,sCAAsC,CAAC,GAAG,CAAC,CAAC;IAC5C,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,sCAAsC,CACpD,GAAmC;IAEnC,IAAI,OAAO,GAAG,CAAC,aAAa,KAAK,UAAU,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAOD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,SAA8B;IAE9B,OAAO,MAAM,gBAAgB,CAAC,GAAG,CAAC,wBAAwB,EAAE,SAAS,EAAE,yBAAyB,CAAC,CAAC;AACpG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,OAAe;IAC9D,OAAO,MAAM,SAAS,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,OAAO,EAAE,EAAE,yBAAyB,CAAC,CAAC;AACpG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAe,EACf,EAAU;IAEV,OAAO,MAAM,QAAQ,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,yBAAyB,CAAC,CAAC;AAClG,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACtD,OAAe,EACf,SAAiB;IAEjB,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,sCAAsC,EAC1C,EAAE,OAAO,EAAE,SAAS,EAAE,EACtB,yBAAyB,CAC1B,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,EAAU,EACV,MAA8B;IAE9B,OAAO,MAAM,QAAQ,CACnB,GAAG,CAAC,+BAA+B,EACnC,EAAE,EAAE,EAAE,MAAM,EAAE,EACd,yBAAyB,CAC1B,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAC,OAAe,EAAE,EAAU;IAC/E,MAAM,UAAU,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import { z } from 'zod';\n\nimport {\n  loadSqlEquiv,\n  queryAsync,\n  queryOptionalRow,\n  queryRow,\n  queryRows,\n} from '@prairielearn/postgres';\n\nconst sql = loadSqlEquiv(import.meta.filename);\n\nexport const BatchedMigrationStatusSchema = z.enum([\n  'pending',\n  'paused',\n  'running',\n  'finalizing',\n  'failed',\n  'succeeded',\n]);\nexport type BatchedMigrationStatus = z.infer<typeof BatchedMigrationStatusSchema>;\n\nexport const BatchedMigrationRowSchema = z.object({\n  id: z.string(),\n  project: z.string(),\n  filename: z.string(),\n  timestamp: z.string(),\n  batch_size: z.number(),\n  min_value: z.bigint({ coerce: true }),\n  max_value: z.bigint({ coerce: true }),\n  status: BatchedMigrationStatusSchema,\n  created_at: z.date(),\n  updated_at: z.date(),\n  started_at: z.date().nullable(),\n});\nexport type BatchedMigrationRow = z.infer<typeof BatchedMigrationRowSchema>;\n\nexport interface BatchedMigrationParameters {\n  min?: bigint | string | null;\n  max: bigint | string | null;\n  batchSize?: number;\n}\n\nexport interface BatchedMigrationImplementation {\n  getParameters(): Promise<BatchedMigrationParameters>;\n  execute(start: bigint, end: bigint): Promise<void>;\n}\n\n/**\n * Identity function that helps to write correct batched migrations.\n */\nexport function makeBatchedMigration<T extends BatchedMigrationImplementation>(fns: T): T {\n  validateBatchedMigrationImplementation(fns);\n  return fns;\n}\n\nexport function validateBatchedMigrationImplementation(\n  fns: BatchedMigrationImplementation,\n): asserts fns is BatchedMigrationImplementation {\n  if (typeof fns.getParameters !== 'function') {\n    throw new Error('getParameters() must be a function');\n  }\n  if (typeof fns.execute !== 'function') {\n    throw new Error('execute() must be a function');\n  }\n}\n\ntype NewBatchedMigration = Pick<\n  BatchedMigrationRow,\n  'project' | 'filename' | 'timestamp' | 'batch_size' | 'min_value' | 'max_value' | 'status'\n>;\n\n/**\n * Inserts a new batched migration. If one already exists for the given\n * project/timestamp pair, returns null, otherwise returns the inserted row.\n */\nexport async function insertBatchedMigration(\n  migration: NewBatchedMigration,\n): Promise<BatchedMigrationRow | null> {\n  return await queryOptionalRow(sql.insert_batched_migration, migration, BatchedMigrationRowSchema);\n}\n\nexport async function selectAllBatchedMigrations(project: string) {\n  return await queryRows(sql.select_all_batched_migrations, { project }, BatchedMigrationRowSchema);\n}\n\nexport async function selectBatchedMigration(\n  project: string,\n  id: string,\n): Promise<BatchedMigrationRow> {\n  return await queryRow(sql.select_batched_migration, { project, id }, BatchedMigrationRowSchema);\n}\n\nexport async function selectBatchedMigrationForTimestamp(\n  project: string,\n  timestamp: string,\n): Promise<BatchedMigrationRow> {\n  return await queryRow(\n    sql.select_batched_migration_for_timestamp,\n    { project, timestamp },\n    BatchedMigrationRowSchema,\n  );\n}\n\nexport async function updateBatchedMigrationStatus(\n  id: string,\n  status: BatchedMigrationStatus,\n): Promise<BatchedMigrationRow> {\n  return await queryRow(\n    sql.update_batched_migration_status,\n    { id, status },\n    BatchedMigrationRowSchema,\n  );\n}\n\nexport async function retryFailedBatchedMigrationJobs(project: string, id: string): Promise<void> {\n  await queryAsync(sql.retry_failed_jobs, { project, id });\n}\n"]}

package/dist/batched-migrations/batched-migrations-runner.js.map

@@ -1 +1 @@
-{"version":3,"file":"batched-migrations-runner.js","sourceRoot":"","sources":["../../src/batched-migrations/batched-migrations-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,UAAU,IAAI,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EAEL,wCAAwC,GACzC,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EACL,yBAAyB,EAEzB,sBAAsB,EAEtB,kCAAkC,EAClC,4BAA4B,EAE5B,sCAAsC,GACvC,MAAM,wBAAwB,CAAC;AAEhC,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAE/C,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,KAAK,CAAC;AACjC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AACxC,MAAM,yBAAyB,GAAG,MAAM,CAAC;AACzC,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAgBlD,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IACtC,OAAO,CAAgC;IACvC,QAAQ,CAAS;IAC1B,OAAO,GAAG,KAAK,CAAC;IAChB,cAAc,GAA2B,IAAI,CAAC;IAC9C,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAEhD,YAAY,OAAsC;QAChD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,sBAAsB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAC/D,CAAC;IAEO,oBAAoB,CAAC,SAAiB;QAC5C,OAAO,GAAG,IAAI,CAAC,QAAQ,IAAI,SAAS,EAAE,CAAC;IACzC,CAAC;IAEO,iBAAiB,GAAG,KAAK,IAAI,EAAE;QACrC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,IAAI,CAAC,cAAc,GAAG,MAAM,wCAAwC,CAClE,IAAI,CAAC,OAAO,CAAC,WAAW,EACxB,UAAU,CACX,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,UAAkB;QACxD,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACtD,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAC5E,OAAO,aAAa,IAAI,IAAI,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,2BAA2B,CAAC,aAA4B;QACpE,6DAA6D;QAC7D,MAAM,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvF,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,CAAC;QAE1D,MAAM,uBAAuB,GAAG,eAAe,CAAC,OAAyC,CAAC;QAC1F,sCAAsC,CAAC,uBAAuB,CAAC,CAAC;QAChE,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,UAAkB;QAC9C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qCAAqC,UAAU,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC;QACtF,MAAM,mBAAmB,GAAG,MAAM,uBAAuB,CAAC,aAAa,EAAE,CAAC;QAE1E,uEAAuE;QACvE,qDAAqD;QACrD,MAAM,MAAM,GACV,mBAAmB,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,CAAC,mBAAmB,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;QACtE,MAAM,QAAQ,GAAG,MAAM,CAAC,mBAAmB,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,mBAAmB,CAAC,SAAS,IAAI,kBAAkB,CAAC;QAEtE,MAAM,sBAAsB,CAAC;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;YAC7B,QAAQ,EAAE,aAAa,CAAC,QAAQ;YAChC,SAAS,EAAE,aAAa,CAAC,SAAS;YAClC,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,QAAQ;YACnB,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,UAAkB,EAAE,OAAyC;QAC1F,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3C,IAAI,SAAS,GAAG,MAAM,kCAAkC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAE1F,IAAI,SAAS,CAAC,MAAM,KAAK,WAAW;YAAE,OAAO;QAE7C,2EAA2E;QAC3E,IAAI,SAAS,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YACtC,SAAS,GAAG,MAAM,4BAA4B,CAAC,SAAS,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QAC7E,CAAC;QAED,MAAM,UAAU,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;YACvE,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,qCAAqC,UAAU,EAAE,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC;YAEtF,MAAM,MAAM,GAAG,IAAI,sBAAsB,CAAC,SAAS,EAAE,uBAAuB,EAAE;gBAC5E,kDAAkD;gBAClD,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,IAAI;aAC1C,CAAC,CAAC;YAEH,uEAAuE;YACvE,2BAA2B;YAC3B,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,SAAS,GAAG,MAAM,kCAAkC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAEtF,IAAI,SAAS,CAAC,MAAM,KAAK,WAAW;YAAE,OAAO;QAE7C,MAAM,IAAI,KAAK,CACb,8CAA8C,UAAU,4CAA4C,SAAS,CAAC,MAAM,IAAI,CACzH,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAwC,EAAE;QAC9C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,eAAe,EAAgC;QAC1E,cAAc,KAAK,wBAAwB,CAAC;QAC5C,eAAe,KAAK,yBAAyB,CAAC;QAE9C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACxC,uEAAuE;gBACvE,mBAAmB;gBACnB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;gBACrB,OAAO;YACT,CAAC;YAED,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC;gBACH,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;YACxD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC1B,CAAC;YAED,0EAA0E;YAC1E,0EAA0E;YAC1E,yBAAyB;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,qEAAqE;gBACrE,4BAA4B;gBAC5B,IAAI,CAAC;oBACH,MAAM,KAAK,CAAC,eAAe,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC1F,CAAC;gBAAC,MAAM,CAAC;oBACP,oEAAoE;oBACpE,oEAAoE;oBACpE,gCAAgC;oBAChC,SAAS;gBACX,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,mBAAmB;QAC/B,OAAO,UAAU,CACf,IAAI,CAAC,QAAQ,EACb;YACE,2DAA2D;YAC3D,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI;SAC1B,EACD,KAAK,IAAI,EAAE;YACT,IAAI,SAAS,GAAG,MAAM,gBAAgB,CACpC,GAAG,CAAC,wBAAwB,EAC5B,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EACjC,yBAAyB,CAC1B,CAAC;YAEF,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,SAAS,GAAG,MAAM,gBAAgB,CAChC,GAAG,CAAC,4BAA4B,EAChC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EACjC,yBAAyB,CAC1B,CAAC;YACJ,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QACvC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACnD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,mCAAmC;YACnC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,uEAAuE;QACvE,+CAA+C;QAC/C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,UAAU,CACd,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,SAAS,CAAC,EAClD;YACE,SAAS,EAAE,IAAI;YACf,4DAA4D;YAC5D,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI;SAC1B,EACD,KAAK,IAAI,EAAE;YACT,OAAO,GAAG,IAAI,CAAC;YACf,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC;YAEtF,MAAM,MAAM,GAAG,IAAI,sBAAsB,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;YAE9E,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;YACxE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAE7B,sCAAsC;QACtC,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;CACF;AAED,IAAI,MAAM,GAAmC,IAAI,CAAC;AAElD,SAAS,YAAY,CACnB,MAAsC;IAEtC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,OAAsC;IAC1E,IAAI,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACtE,MAAM,GAAG,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,UAAwC,EAAE;IAC/E,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;IACpB,MAAM,GAAG,IAAI,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,UAAkB;IAC9D,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,MAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,UAAkB,EAClB,OAAyC;IAEzC,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,MAAM,CAAC,wBAAwB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAC7D,CAAC","sourcesContent":["import { EventEmitter } from 'node:events';\nimport path from 'node:path';\nimport { setTimeout as sleep } from 'node:timers/promises';\n\nimport { doWithLock } from '@prairielearn/named-locks';\nimport { loadSqlEquiv, queryOptionalRow } from '@prairielearn/postgres';\n\nimport {\n  type MigrationFile,\n  readAndValidateMigrationsFromDirectories,\n} from '../load-migrations.js';\n\nimport { BatchedMigrationRunner } from './batched-migration-runner.js';\nimport {\n  BatchedMigrationRowSchema,\n  type BatchedMigrationRow,\n  insertBatchedMigration,\n  type BatchedMigrationStatus,\n  selectBatchedMigrationForTimestamp,\n  updateBatchedMigrationStatus,\n  type BatchedMigrationImplementation,\n  validateBatchedMigrationImplementation,\n} from './batched-migration.js';\n\nconst sql = loadSqlEquiv(import.meta.filename);\n\nconst DEFAULT_MIN_VALUE = 1n;\nconst DEFAULT_BATCH_SIZE = 1_000;\nconst DEFAULT_WORK_DURATION_MS = 60_000;\nconst DEFAULT_SLEEP_DURATION_MS = 30_000;\nconst EXTENSIONS = ['.js', '.ts', '.mjs', '.mts'];\n\ninterface BatchedMigrationRunnerOptions {\n  project: string;\n  directories: string[];\n}\n\ninterface BatchedMigrationStartOptions {\n  workDurationMs?: number;\n  sleepDurationMs?: number;\n}\n\ninterface BatchedMigrationFinalizeOptions {\n  logProgress?: boolean;\n}\n\nexport class BatchedMigrationsRunner extends EventEmitter {\n  private readonly options: BatchedMigrationRunnerOptions;\n  private readonly lockName: string;\n  private running = false;\n  private migrationFiles: MigrationFile[] | null = null;\n  private abortController = new AbortController();\n\n  constructor(options: BatchedMigrationRunnerOptions) {\n    super();\n    this.options = options;\n    this.lockName = `batched-migrations:${this.options.project}`;\n  }\n\n  private lockNameForTimestamp(timestamp: string) {\n    return `${this.lockName}:${timestamp}`;\n  }\n\n  private getMigrationFiles = async () => {\n    if (!this.migrationFiles) {\n      this.migrationFiles = await readAndValidateMigrationsFromDirectories(\n        this.options.directories,\n        EXTENSIONS,\n      );\n    }\n    return this.migrationFiles;\n  };\n\n  private async getMigrationForIdentifier(identifier: string): Promise<MigrationFile | null> {\n    const timestamp = identifier.split('_')[0];\n\n    const migrationFiles = await this.getMigrationFiles();\n    const migrationFile = migrationFiles.find((m) => m.timestamp === timestamp);\n    return migrationFile ?? null;\n  }\n\n  /**\n   * Loads the implementation for the migration with the given identifier. The identifier\n   * must start with a 14-character timestamp. It may optionally be followed by\n   * an underscore with additional characters, which are ignored. These should\n   * typically be used to provide a human-readable name for the migration.\n   */\n  private async loadMigrationImplementation(migrationFile: MigrationFile) {\n    // We use dynamic imports to handle both CJS and ESM modules.\n    const migrationModulePath = path.join(migrationFile.directory, migrationFile.filename);\n    const migrationModule = await import(migrationModulePath);\n\n    const migrationImplementation = migrationModule.default as BatchedMigrationImplementation;\n    validateBatchedMigrationImplementation(migrationImplementation);\n    return migrationImplementation;\n  }\n\n  async enqueueBatchedMigration(identifier: string) {\n    const migrationFile = await this.getMigrationForIdentifier(identifier);\n    if (!migrationFile) {\n      throw new Error(`No migration found for identifier ${identifier}`);\n    }\n\n    const migrationImplementation = await this.loadMigrationImplementation(migrationFile);\n    const migrationParameters = await migrationImplementation.getParameters();\n\n    // If `max` is null, that implies that there are no rows to process, so\n    // we can immediately mark the migration as finished.\n    const status: BatchedMigrationStatus =\n      migrationParameters.max === null ? 'succeeded' : 'pending';\n\n    const minValue = BigInt(migrationParameters.min ?? DEFAULT_MIN_VALUE);\n    const maxValue = BigInt(migrationParameters.max ?? minValue);\n    const batchSize = migrationParameters.batchSize ?? DEFAULT_BATCH_SIZE;\n\n    await insertBatchedMigration({\n      project: this.options.project,\n      filename: migrationFile.filename,\n      timestamp: migrationFile.timestamp,\n      batch_size: batchSize,\n      min_value: minValue,\n      max_value: maxValue,\n      status,\n    });\n  }\n\n  async finalizeBatchedMigration(identifier: string, options?: BatchedMigrationFinalizeOptions) {\n    const timestamp = identifier.split('_')[0];\n\n    let migration = await selectBatchedMigrationForTimestamp(this.options.project, timestamp);\n\n    if (migration.status === 'succeeded') return;\n\n    // If the migration isn't already in the finalizing state, mark it as such.\n    if (migration.status !== 'finalizing') {\n      migration = await updateBatchedMigrationStatus(migration.id, 'finalizing');\n    }\n\n    await doWithLock(this.lockNameForTimestamp(timestamp), { autoRenew: true }, async () => {\n      const migrationFile = await this.getMigrationForIdentifier(identifier);\n      if (!migrationFile) {\n        throw new Error(`No migration found for identifier ${identifier}`);\n      }\n      const migrationImplementation = await this.loadMigrationImplementation(migrationFile);\n\n      const runner = new BatchedMigrationRunner(migration, migrationImplementation, {\n        // Always log progress unless explicitly disabled.\n        logProgress: options?.logProgress ?? true,\n      });\n\n      // Because we don't give any arguments to `run()`, it will run until it\n      // has attempted every job.\n      await runner.run();\n    });\n\n    migration = await selectBatchedMigrationForTimestamp(this.options.project, timestamp);\n\n    if (migration.status === 'succeeded') return;\n\n    throw new Error(\n      `Expected batched migration with identifier ${identifier} to be marked as 'succeeded', but it is '${migration.status}'.`,\n    );\n  }\n\n  start(options: BatchedMigrationStartOptions = {}) {\n    if (this.running) {\n      throw new Error('BatchedMigrationsRunner is already running');\n    }\n\n    this.loop(options);\n  }\n\n  async loop({ workDurationMs, sleepDurationMs }: BatchedMigrationStartOptions) {\n    workDurationMs ??= DEFAULT_WORK_DURATION_MS;\n    sleepDurationMs ??= DEFAULT_SLEEP_DURATION_MS;\n\n    this.running = true;\n    while (this.running) {\n      if (this.abortController.signal.aborted) {\n        // We assign this here so that `stop()` can tell when this loop is done\n        // processing jobs.\n        this.running = false;\n        return;\n      }\n\n      let didWork = false;\n      try {\n        didWork = await this.maybePerformWork(workDurationMs);\n      } catch (err) {\n        this.emit('error', err);\n      }\n\n      // If we did work, we'll immediately try again since there's probably more\n      // work to be done. If not, we'll sleep for a while - maybe some more work\n      // will become available!\n      if (!didWork) {\n        // We provide the signal here so that we can more quickly stop things\n        // when we're shutting down.\n        try {\n          await sleep(sleepDurationMs, null, { ref: false, signal: this.abortController.signal });\n        } catch {\n          // We don't care about errors here, they should only ever occur when\n          // the AbortController is aborted. Continue to the next iteration of\n          // the loop so we can shut down.\n          continue;\n        }\n      }\n    }\n  }\n\n  private async getOrStartMigration(): Promise<BatchedMigrationRow | null> {\n    return doWithLock(\n      this.lockName,\n      {\n        // Don't fail if the lock couldn't be acquired immediately.\n        onNotAcquired: () => null,\n      },\n      async () => {\n        let migration = await queryOptionalRow(\n          sql.select_running_migration,\n          { project: this.options.project },\n          BatchedMigrationRowSchema,\n        );\n\n        if (!migration) {\n          migration = await queryOptionalRow(\n            sql.start_next_pending_migration,\n            { project: this.options.project },\n            BatchedMigrationRowSchema,\n          );\n        }\n\n        return migration;\n      },\n    );\n  }\n\n  async maybePerformWork(durationMs: number): Promise<boolean> {\n    const migration = await this.getOrStartMigration();\n    if (!migration) {\n      // No work to do. Handle this case.\n      return false;\n    }\n\n    // This server may not yet know about the current running migration. If\n    // that's the case, we'll just skip it for now.\n    const migrationFile = await this.getMigrationForIdentifier(migration.timestamp);\n    if (!migrationFile) {\n      return false;\n    }\n\n    let didWork = false;\n    await doWithLock(\n      this.lockNameForTimestamp(migrationFile.timestamp),\n      {\n        autoRenew: true,\n        // Do nothing if the lock could not immediately be acquired.\n        onNotAcquired: () => null,\n      },\n      async () => {\n        didWork = true;\n        const migrationImplementation = await this.loadMigrationImplementation(migrationFile);\n\n        const runner = new BatchedMigrationRunner(migration, migrationImplementation);\n\n        try {\n          await runner.run({ signal: this.abortController.signal, durationMs });\n        } catch (err) {\n          this.emit('error', err);\n        }\n      },\n    );\n\n    return didWork;\n  }\n\n  async stop() {\n    this.abortController.abort();\n\n    // Spin until we're no longer running.\n    while (this.running) {\n      await sleep(1000);\n    }\n  }\n}\n\nlet runner: BatchedMigrationsRunner | null = null;\n\nfunction assertRunner(\n  runner: BatchedMigrationsRunner | null,\n): asserts runner is BatchedMigrationsRunner {\n  if (!runner) throw new Error('Batched migrations not initialized');\n}\n\nexport function initBatchedMigrations(options: BatchedMigrationRunnerOptions) {\n  if (runner) throw new Error('Batched migrations already initialized');\n  runner = new BatchedMigrationsRunner(options);\n  return runner;\n}\n\nexport function startBatchedMigrations(options: BatchedMigrationStartOptions = {}) {\n  assertRunner(runner);\n  runner.start(options);\n  return runner;\n}\n\nexport async function stopBatchedMigrations() {\n  assertRunner(runner);\n  await runner.stop();\n  runner = null;\n}\n\n/**\n * Given a batched migration identifier like `20230406184103_migration`,\n * enqueues it for execution by creating a row in the `batched_migrations`\n * table.\n *\n * Despite taking a full identifier, only the timestamp is used to uniquely\n * identify the batched migration. The remaining part is just used to make\n * calls more human-readable.\n *\n * @param identifier The identifier of the batched migration to enqueue.\n */\nexport async function enqueueBatchedMigration(identifier: string) {\n  assertRunner(runner);\n  await runner.enqueueBatchedMigration(identifier);\n}\n\n/**\n * Given a batched migration identifier like `20230406184103_migration`,\n * synchronously runs it to completion. An error will be thrown if the final\n * status of the migration is not `succeeded`.\n *\n * @param identifier The identifier of the batched migration to finalize.\n * @param options Options for finalizing the batched migration.\n */\nexport async function finalizeBatchedMigration(\n  identifier: string,\n  options?: BatchedMigrationFinalizeOptions,\n) {\n  assertRunner(runner);\n  await runner.finalizeBatchedMigration(identifier, options);\n}\n"]}
+{"version":3,"file":"batched-migrations-runner.js","sourceRoot":"","sources":["../../src/batched-migrations/batched-migrations-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,UAAU,IAAI,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EAEL,wCAAwC,GACzC,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAGL,yBAAyB,EAEzB,sBAAsB,EACtB,kCAAkC,EAClC,4BAA4B,EAC5B,sCAAsC,GACvC,MAAM,wBAAwB,CAAC;AAEhC,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAE/C,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,KAAK,CAAC;AACjC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AACxC,MAAM,yBAAyB,GAAG,MAAM,CAAC;AACzC,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAgBlD,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IACtC,OAAO,CAAgC;IACvC,QAAQ,CAAS;IAC1B,OAAO,GAAG,KAAK,CAAC;IAChB,cAAc,GAA2B,IAAI,CAAC;IAC9C,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAEhD,YAAY,OAAsC;QAChD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,sBAAsB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAC/D,CAAC;IAEO,oBAAoB,CAAC,SAAiB;QAC5C,OAAO,GAAG,IAAI,CAAC,QAAQ,IAAI,SAAS,EAAE,CAAC;IACzC,CAAC;IAEO,iBAAiB,GAAG,KAAK,IAAI,EAAE;QACrC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,IAAI,CAAC,cAAc,GAAG,MAAM,wCAAwC,CAClE,IAAI,CAAC,OAAO,CAAC,WAAW,EACxB,UAAU,CACX,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,UAAkB;QACxD,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACtD,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAC5E,OAAO,aAAa,IAAI,IAAI,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,2BAA2B,CAAC,aAA4B;QACpE,6DAA6D;QAC7D,MAAM,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvF,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,CAAC;QAE1D,MAAM,uBAAuB,GAAG,eAAe,CAAC,OAAyC,CAAC;QAC1F,sCAAsC,CAAC,uBAAuB,CAAC,CAAC;QAChE,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,UAAkB;QAC9C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qCAAqC,UAAU,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC;QACtF,MAAM,mBAAmB,GAAG,MAAM,uBAAuB,CAAC,aAAa,EAAE,CAAC;QAE1E,uEAAuE;QACvE,qDAAqD;QACrD,MAAM,MAAM,GACV,mBAAmB,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,CAAC,mBAAmB,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;QACtE,MAAM,QAAQ,GAAG,MAAM,CAAC,mBAAmB,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,mBAAmB,CAAC,SAAS,IAAI,kBAAkB,CAAC;QAEtE,MAAM,sBAAsB,CAAC;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;YAC7B,QAAQ,EAAE,aAAa,CAAC,QAAQ;YAChC,SAAS,EAAE,aAAa,CAAC,SAAS;YAClC,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,QAAQ;YACnB,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,UAAkB,EAAE,OAAyC;QAC1F,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3C,IAAI,SAAS,GAAG,MAAM,kCAAkC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAE1F,IAAI,SAAS,CAAC,MAAM,KAAK,WAAW;YAAE,OAAO;QAE7C,2EAA2E;QAC3E,IAAI,SAAS,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YACtC,SAAS,GAAG,MAAM,4BAA4B,CAAC,SAAS,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;QAC7E,CAAC;QAED,MAAM,UAAU,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;YACvE,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,qCAAqC,UAAU,EAAE,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC;YAEtF,MAAM,MAAM,GAAG,IAAI,sBAAsB,CAAC,SAAS,EAAE,uBAAuB,EAAE;gBAC5E,kDAAkD;gBAClD,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,IAAI;aAC1C,CAAC,CAAC;YAEH,uEAAuE;YACvE,2BAA2B;YAC3B,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,SAAS,GAAG,MAAM,kCAAkC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAEtF,IAAI,SAAS,CAAC,MAAM,KAAK,WAAW;YAAE,OAAO;QAE7C,MAAM,IAAI,KAAK,CACb,8CAA8C,UAAU,4CAA4C,SAAS,CAAC,MAAM,IAAI,CACzH,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAwC,EAAE;QAC9C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,eAAe,EAAgC;QAC1E,cAAc,KAAK,wBAAwB,CAAC;QAC5C,eAAe,KAAK,yBAAyB,CAAC;QAE9C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACxC,uEAAuE;gBACvE,mBAAmB;gBACnB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;gBACrB,OAAO;YACT,CAAC;YAED,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC;gBACH,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;YACxD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC1B,CAAC;YAED,0EAA0E;YAC1E,0EAA0E;YAC1E,yBAAyB;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,qEAAqE;gBACrE,4BAA4B;gBAC5B,IAAI,CAAC;oBACH,MAAM,KAAK,CAAC,eAAe,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC1F,CAAC;gBAAC,MAAM,CAAC;oBACP,oEAAoE;oBACpE,oEAAoE;oBACpE,gCAAgC;oBAChC,SAAS;gBACX,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,mBAAmB;QAC/B,OAAO,UAAU,CACf,IAAI,CAAC,QAAQ,EACb;YACE,2DAA2D;YAC3D,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI;SAC1B,EACD,KAAK,IAAI,EAAE;YACT,IAAI,SAAS,GAAG,MAAM,gBAAgB,CACpC,GAAG,CAAC,wBAAwB,EAC5B,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EACjC,yBAAyB,CAC1B,CAAC;YAEF,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,SAAS,GAAG,MAAM,gBAAgB,CAChC,GAAG,CAAC,4BAA4B,EAChC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EACjC,yBAAyB,CAC1B,CAAC;YACJ,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QACvC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACnD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,mCAAmC;YACnC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,uEAAuE;QACvE,+CAA+C;QAC/C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,UAAU,CACd,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,SAAS,CAAC,EAClD;YACE,SAAS,EAAE,IAAI;YACf,4DAA4D;YAC5D,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI;SAC1B,EACD,KAAK,IAAI,EAAE;YACT,OAAO,GAAG,IAAI,CAAC;YACf,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,CAAC;YAEtF,MAAM,MAAM,GAAG,IAAI,sBAAsB,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;YAE9E,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;YACxE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAE7B,sCAAsC;QACtC,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;CACF;AAED,IAAI,MAAM,GAAmC,IAAI,CAAC;AAElD,SAAS,YAAY,CACnB,MAAsC;IAEtC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,OAAsC;IAC1E,IAAI,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACtE,MAAM,GAAG,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,UAAwC,EAAE;IAC/E,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;IACpB,MAAM,GAAG,IAAI,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,UAAkB;IAC9D,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,MAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,UAAkB,EAClB,OAAyC;IAEzC,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,MAAM,MAAM,CAAC,wBAAwB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAC7D,CAAC","sourcesContent":["import { EventEmitter } from 'node:events';\nimport path from 'node:path';\nimport { setTimeout as sleep } from 'node:timers/promises';\n\nimport { doWithLock } from '@prairielearn/named-locks';\nimport { loadSqlEquiv, queryOptionalRow } from '@prairielearn/postgres';\n\nimport {\n  type MigrationFile,\n  readAndValidateMigrationsFromDirectories,\n} from '../load-migrations.js';\n\nimport { BatchedMigrationRunner } from './batched-migration-runner.js';\nimport {\n  type BatchedMigrationImplementation,\n  type BatchedMigrationRow,\n  BatchedMigrationRowSchema,\n  type BatchedMigrationStatus,\n  insertBatchedMigration,\n  selectBatchedMigrationForTimestamp,\n  updateBatchedMigrationStatus,\n  validateBatchedMigrationImplementation,\n} from './batched-migration.js';\n\nconst sql = loadSqlEquiv(import.meta.filename);\n\nconst DEFAULT_MIN_VALUE = 1n;\nconst DEFAULT_BATCH_SIZE = 1_000;\nconst DEFAULT_WORK_DURATION_MS = 60_000;\nconst DEFAULT_SLEEP_DURATION_MS = 30_000;\nconst EXTENSIONS = ['.js', '.ts', '.mjs', '.mts'];\n\ninterface BatchedMigrationRunnerOptions {\n  project: string;\n  directories: string[];\n}\n\ninterface BatchedMigrationStartOptions {\n  workDurationMs?: number;\n  sleepDurationMs?: number;\n}\n\ninterface BatchedMigrationFinalizeOptions {\n  logProgress?: boolean;\n}\n\nexport class BatchedMigrationsRunner extends EventEmitter {\n  private readonly options: BatchedMigrationRunnerOptions;\n  private readonly lockName: string;\n  private running = false;\n  private migrationFiles: MigrationFile[] | null = null;\n  private abortController = new AbortController();\n\n  constructor(options: BatchedMigrationRunnerOptions) {\n    super();\n    this.options = options;\n    this.lockName = `batched-migrations:${this.options.project}`;\n  }\n\n  private lockNameForTimestamp(timestamp: string) {\n    return `${this.lockName}:${timestamp}`;\n  }\n\n  private getMigrationFiles = async () => {\n    if (!this.migrationFiles) {\n      this.migrationFiles = await readAndValidateMigrationsFromDirectories(\n        this.options.directories,\n        EXTENSIONS,\n      );\n    }\n    return this.migrationFiles;\n  };\n\n  private async getMigrationForIdentifier(identifier: string): Promise<MigrationFile | null> {\n    const timestamp = identifier.split('_')[0];\n\n    const migrationFiles = await this.getMigrationFiles();\n    const migrationFile = migrationFiles.find((m) => m.timestamp === timestamp);\n    return migrationFile ?? null;\n  }\n\n  /**\n   * Loads the implementation for the migration with the given identifier. The identifier\n   * must start with a 14-character timestamp. It may optionally be followed by\n   * an underscore with additional characters, which are ignored. These should\n   * typically be used to provide a human-readable name for the migration.\n   */\n  private async loadMigrationImplementation(migrationFile: MigrationFile) {\n    // We use dynamic imports to handle both CJS and ESM modules.\n    const migrationModulePath = path.join(migrationFile.directory, migrationFile.filename);\n    const migrationModule = await import(migrationModulePath);\n\n    const migrationImplementation = migrationModule.default as BatchedMigrationImplementation;\n    validateBatchedMigrationImplementation(migrationImplementation);\n    return migrationImplementation;\n  }\n\n  async enqueueBatchedMigration(identifier: string) {\n    const migrationFile = await this.getMigrationForIdentifier(identifier);\n    if (!migrationFile) {\n      throw new Error(`No migration found for identifier ${identifier}`);\n    }\n\n    const migrationImplementation = await this.loadMigrationImplementation(migrationFile);\n    const migrationParameters = await migrationImplementation.getParameters();\n\n    // If `max` is null, that implies that there are no rows to process, so\n    // we can immediately mark the migration as finished.\n    const status: BatchedMigrationStatus =\n      migrationParameters.max === null ? 'succeeded' : 'pending';\n\n    const minValue = BigInt(migrationParameters.min ?? DEFAULT_MIN_VALUE);\n    const maxValue = BigInt(migrationParameters.max ?? minValue);\n    const batchSize = migrationParameters.batchSize ?? DEFAULT_BATCH_SIZE;\n\n    await insertBatchedMigration({\n      project: this.options.project,\n      filename: migrationFile.filename,\n      timestamp: migrationFile.timestamp,\n      batch_size: batchSize,\n      min_value: minValue,\n      max_value: maxValue,\n      status,\n    });\n  }\n\n  async finalizeBatchedMigration(identifier: string, options?: BatchedMigrationFinalizeOptions) {\n    const timestamp = identifier.split('_')[0];\n\n    let migration = await selectBatchedMigrationForTimestamp(this.options.project, timestamp);\n\n    if (migration.status === 'succeeded') return;\n\n    // If the migration isn't already in the finalizing state, mark it as such.\n    if (migration.status !== 'finalizing') {\n      migration = await updateBatchedMigrationStatus(migration.id, 'finalizing');\n    }\n\n    await doWithLock(this.lockNameForTimestamp(timestamp), { autoRenew: true }, async () => {\n      const migrationFile = await this.getMigrationForIdentifier(identifier);\n      if (!migrationFile) {\n        throw new Error(`No migration found for identifier ${identifier}`);\n      }\n      const migrationImplementation = await this.loadMigrationImplementation(migrationFile);\n\n      const runner = new BatchedMigrationRunner(migration, migrationImplementation, {\n        // Always log progress unless explicitly disabled.\n        logProgress: options?.logProgress ?? true,\n      });\n\n      // Because we don't give any arguments to `run()`, it will run until it\n      // has attempted every job.\n      await runner.run();\n    });\n\n    migration = await selectBatchedMigrationForTimestamp(this.options.project, timestamp);\n\n    if (migration.status === 'succeeded') return;\n\n    throw new Error(\n      `Expected batched migration with identifier ${identifier} to be marked as 'succeeded', but it is '${migration.status}'.`,\n    );\n  }\n\n  start(options: BatchedMigrationStartOptions = {}) {\n    if (this.running) {\n      throw new Error('BatchedMigrationsRunner is already running');\n    }\n\n    this.loop(options);\n  }\n\n  async loop({ workDurationMs, sleepDurationMs }: BatchedMigrationStartOptions) {\n    workDurationMs ??= DEFAULT_WORK_DURATION_MS;\n    sleepDurationMs ??= DEFAULT_SLEEP_DURATION_MS;\n\n    this.running = true;\n    while (this.running) {\n      if (this.abortController.signal.aborted) {\n        // We assign this here so that `stop()` can tell when this loop is done\n        // processing jobs.\n        this.running = false;\n        return;\n      }\n\n      let didWork = false;\n      try {\n        didWork = await this.maybePerformWork(workDurationMs);\n      } catch (err) {\n        this.emit('error', err);\n      }\n\n      // If we did work, we'll immediately try again since there's probably more\n      // work to be done. If not, we'll sleep for a while - maybe some more work\n      // will become available!\n      if (!didWork) {\n        // We provide the signal here so that we can more quickly stop things\n        // when we're shutting down.\n        try {\n          await sleep(sleepDurationMs, null, { ref: false, signal: this.abortController.signal });\n        } catch {\n          // We don't care about errors here, they should only ever occur when\n          // the AbortController is aborted. Continue to the next iteration of\n          // the loop so we can shut down.\n          continue;\n        }\n      }\n    }\n  }\n\n  private async getOrStartMigration(): Promise<BatchedMigrationRow | null> {\n    return doWithLock(\n      this.lockName,\n      {\n        // Don't fail if the lock couldn't be acquired immediately.\n        onNotAcquired: () => null,\n      },\n      async () => {\n        let migration = await queryOptionalRow(\n          sql.select_running_migration,\n          { project: this.options.project },\n          BatchedMigrationRowSchema,\n        );\n\n        if (!migration) {\n          migration = await queryOptionalRow(\n            sql.start_next_pending_migration,\n            { project: this.options.project },\n            BatchedMigrationRowSchema,\n          );\n        }\n\n        return migration;\n      },\n    );\n  }\n\n  async maybePerformWork(durationMs: number): Promise<boolean> {\n    const migration = await this.getOrStartMigration();\n    if (!migration) {\n      // No work to do. Handle this case.\n      return false;\n    }\n\n    // This server may not yet know about the current running migration. If\n    // that's the case, we'll just skip it for now.\n    const migrationFile = await this.getMigrationForIdentifier(migration.timestamp);\n    if (!migrationFile) {\n      return false;\n    }\n\n    let didWork = false;\n    await doWithLock(\n      this.lockNameForTimestamp(migrationFile.timestamp),\n      {\n        autoRenew: true,\n        // Do nothing if the lock could not immediately be acquired.\n        onNotAcquired: () => null,\n      },\n      async () => {\n        didWork = true;\n        const migrationImplementation = await this.loadMigrationImplementation(migrationFile);\n\n        const runner = new BatchedMigrationRunner(migration, migrationImplementation);\n\n        try {\n          await runner.run({ signal: this.abortController.signal, durationMs });\n        } catch (err) {\n          this.emit('error', err);\n        }\n      },\n    );\n\n    return didWork;\n  }\n\n  async stop() {\n    this.abortController.abort();\n\n    // Spin until we're no longer running.\n    while (this.running) {\n      await sleep(1000);\n    }\n  }\n}\n\nlet runner: BatchedMigrationsRunner | null = null;\n\nfunction assertRunner(\n  runner: BatchedMigrationsRunner | null,\n): asserts runner is BatchedMigrationsRunner {\n  if (!runner) throw new Error('Batched migrations not initialized');\n}\n\nexport function initBatchedMigrations(options: BatchedMigrationRunnerOptions) {\n  if (runner) throw new Error('Batched migrations already initialized');\n  runner = new BatchedMigrationsRunner(options);\n  return runner;\n}\n\nexport function startBatchedMigrations(options: BatchedMigrationStartOptions = {}) {\n  assertRunner(runner);\n  runner.start(options);\n  return runner;\n}\n\nexport async function stopBatchedMigrations() {\n  assertRunner(runner);\n  await runner.stop();\n  runner = null;\n}\n\n/**\n * Given a batched migration identifier like `20230406184103_migration`,\n * enqueues it for execution by creating a row in the `batched_migrations`\n * table.\n *\n * Despite taking a full identifier, only the timestamp is used to uniquely\n * identify the batched migration. The remaining part is just used to make\n * calls more human-readable.\n *\n * @param identifier The identifier of the batched migration to enqueue.\n */\nexport async function enqueueBatchedMigration(identifier: string) {\n  assertRunner(runner);\n  await runner.enqueueBatchedMigration(identifier);\n}\n\n/**\n * Given a batched migration identifier like `20230406184103_migration`,\n * synchronously runs it to completion. An error will be thrown if the final\n * status of the migration is not `succeeded`.\n *\n * @param identifier The identifier of the batched migration to finalize.\n * @param options Options for finalizing the batched migration.\n */\nexport async function finalizeBatchedMigration(\n  identifier: string,\n  options?: BatchedMigrationFinalizeOptions,\n) {\n  assertRunner(runner);\n  await runner.finalizeBatchedMigration(identifier, options);\n}\n"]}

package/dist/batched-migrations/batched-migrations-runner.test.js

@@ -1,5 +1,5 @@
 import path from 'node:path';
-import { use as chaiUse, assert } from 'chai';
+import { assert, use as chaiUse } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import * as namedLocks from '@prairielearn/named-locks';
 import { makePostgresTestUtils } from '@prairielearn/postgres';

package/dist/batched-migrations/batched-migrations-runner.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"batched-migrations-runner.test.js","sourceRoot":"","sources":["../../src/batched-migrations/batched-migrations-runner.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,OAAO,KAAK,UAAU,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAE3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAEzE,OAAO,CAAC,cAAc,CAAC,CAAC;AAExB,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;IAC9C,QAAQ,EAAE,yBAAyB;CACpC,CAAC,CAAC;AAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,iBAAiB,CAAC,cAAc,EAAE,CAAC;QACzC,MAAM,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;YAC/D,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,CAAC,sBAAsB,CAAC,EAAE,yBAAyB,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,iBAAiB,CAAC,aAAa,EAAE,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,KAAK,IAAI,EAAE;QACf,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,iBAAiB,CAAC,YAAY,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,MAAM,GAAG,IAAI,uBAAuB,CAAC;YACzC,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAC5E,MAAM,MAAM,CAAC,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;QACzE,MAAM,MAAM,CAAC,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;QAEzE,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAE5D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,wCAAwC,CAAC,CAAC;QAC/E,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,MAAM,GAAG,IAAI,uBAAuB,CAAC;YACzC,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAC5E,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAC5E,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAE5E,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAE5D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,MAAM,GAAG,IAAI,uBAAuB,CAAC;YACzC,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAC5E,MAAM,MAAM,CAAC,wBAAwB,CAAC,qCAAqC,EAAE;YAC3E,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,MAAM,GAAG,IAAI,uBAAuB,CAAC;YACzC,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;QAEzE,MAAM,MAAM,CAAC,UAAU,CACrB,MAAM,CAAC,wBAAwB,CAAC,kCAAkC,EAAE;YAClE,WAAW,EAAE,KAAK;SACnB,CAAC,EACF,oBAAoB,CACrB,CAAC;QAEF,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import path from 'node:path';\n\nimport { use as chaiUse, assert } from 'chai';\nimport chaiAsPromised from 'chai-as-promised';\n\nimport * as namedLocks from '@prairielearn/named-locks';\nimport { makePostgresTestUtils } from '@prairielearn/postgres';\n\nimport { SCHEMA_MIGRATIONS_PATH, init } from '../index.js';\n\nimport { selectAllBatchedMigrations } from './batched-migration.js';\nimport { BatchedMigrationsRunner } from './batched-migrations-runner.js';\n\nchaiUse(chaiAsPromised);\n\nconst postgresTestUtils = makePostgresTestUtils({\n  database: 'prairielearn_migrations',\n});\n\ndescribe('BatchedMigrationsRunner', () => {\n  before(async () => {\n    await postgresTestUtils.createDatabase();\n    await namedLocks.init(postgresTestUtils.getPoolConfig(), (err) => {\n      throw err;\n    });\n    await init([SCHEMA_MIGRATIONS_PATH], 'prairielearn_migrations');\n  });\n\n  afterEach(async () => {\n    await postgresTestUtils.resetDatabase();\n  });\n\n  after(async () => {\n    await namedLocks.close();\n    await postgresTestUtils.dropDatabase();\n  });\n\n  it('enqueues migrations', async () => {\n    const runner = new BatchedMigrationsRunner({\n      project: 'test',\n      directories: [path.join(import.meta.dirname, 'fixtures')],\n    });\n\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n    await runner.enqueueBatchedMigration('20230406184107_failing_migration');\n    await runner.enqueueBatchedMigration('20230407230446_no_rows_migration');\n\n    const migrations = await selectAllBatchedMigrations('test');\n\n    assert.lengthOf(migrations, 3);\n    assert.equal(migrations[0].timestamp, '20230406184103');\n    assert.equal(migrations[0].filename, '20230406184103_successful_migration.ts');\n    assert.equal(migrations[0].status, 'pending');\n    assert.equal(migrations[1].timestamp, '20230406184107');\n    assert.equal(migrations[1].filename, '20230406184107_failing_migration.ts');\n    assert.equal(migrations[1].status, 'pending');\n    assert.equal(migrations[2].timestamp, '20230407230446');\n    assert.equal(migrations[2].filename, '20230407230446_no_rows_migration.ts');\n    assert.equal(migrations[2].status, 'succeeded');\n  });\n\n  it('safely enqueues migrations multiple times', async () => {\n    const runner = new BatchedMigrationsRunner({\n      project: 'test',\n      directories: [path.join(import.meta.dirname, 'fixtures')],\n    });\n\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n\n    const migrations = await selectAllBatchedMigrations('test');\n\n    assert.lengthOf(migrations, 1);\n  });\n\n  it('finalizes a successful migration', async () => {\n    const runner = new BatchedMigrationsRunner({\n      project: 'test',\n      directories: [path.join(import.meta.dirname, 'fixtures')],\n    });\n\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n    await runner.finalizeBatchedMigration('20230406184103_successful_migration', {\n      logProgress: false,\n    });\n\n    const migrations = await selectAllBatchedMigrations('test');\n    assert.lengthOf(migrations, 1);\n    assert.equal(migrations[0].timestamp, '20230406184103');\n    assert.equal(migrations[0].status, 'succeeded');\n  });\n\n  it('finalizes a failing migration', async () => {\n    const runner = new BatchedMigrationsRunner({\n      project: 'test',\n      directories: [path.join(import.meta.dirname, 'fixtures')],\n    });\n\n    await runner.enqueueBatchedMigration('20230406184107_failing_migration');\n\n    await assert.isRejected(\n      runner.finalizeBatchedMigration('20230406184107_failing_migration', {\n        logProgress: false,\n      }),\n      \"but it is 'failed'\",\n    );\n\n    const migrations = await selectAllBatchedMigrations('test');\n    assert.lengthOf(migrations, 1);\n    assert.equal(migrations[0].timestamp, '20230406184107');\n    assert.equal(migrations[0].status, 'failed');\n  });\n});\n"]}
+{"version":3,"file":"batched-migrations-runner.test.js","sourceRoot":"","sources":["../../src/batched-migrations/batched-migrations-runner.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,MAAM,CAAC;AAC9C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,OAAO,KAAK,UAAU,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAE3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAEzE,OAAO,CAAC,cAAc,CAAC,CAAC;AAExB,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;IAC9C,QAAQ,EAAE,yBAAyB;CACpC,CAAC,CAAC;AAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,iBAAiB,CAAC,cAAc,EAAE,CAAC;QACzC,MAAM,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;YAC/D,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,CAAC,sBAAsB,CAAC,EAAE,yBAAyB,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,iBAAiB,CAAC,aAAa,EAAE,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,KAAK,IAAI,EAAE;QACf,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,iBAAiB,CAAC,YAAY,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,MAAM,GAAG,IAAI,uBAAuB,CAAC;YACzC,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAC5E,MAAM,MAAM,CAAC,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;QACzE,MAAM,MAAM,CAAC,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;QAEzE,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAE5D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,wCAAwC,CAAC,CAAC;QAC/E,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,MAAM,GAAG,IAAI,uBAAuB,CAAC;YACzC,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAC5E,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAC5E,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAE5E,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAE5D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,MAAM,GAAG,IAAI,uBAAuB,CAAC;YACzC,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,uBAAuB,CAAC,qCAAqC,CAAC,CAAC;QAC5E,MAAM,MAAM,CAAC,wBAAwB,CAAC,qCAAqC,EAAE;YAC3E,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,MAAM,GAAG,IAAI,uBAAuB,CAAC;YACzC,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SAC1D,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;QAEzE,MAAM,MAAM,CAAC,UAAU,CACrB,MAAM,CAAC,wBAAwB,CAAC,kCAAkC,EAAE;YAClE,WAAW,EAAE,KAAK;SACnB,CAAC,EACF,oBAAoB,CACrB,CAAC;QAEF,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import path from 'node:path';\n\nimport { assert, use as chaiUse } from 'chai';\nimport chaiAsPromised from 'chai-as-promised';\n\nimport * as namedLocks from '@prairielearn/named-locks';\nimport { makePostgresTestUtils } from '@prairielearn/postgres';\n\nimport { SCHEMA_MIGRATIONS_PATH, init } from '../index.js';\n\nimport { selectAllBatchedMigrations } from './batched-migration.js';\nimport { BatchedMigrationsRunner } from './batched-migrations-runner.js';\n\nchaiUse(chaiAsPromised);\n\nconst postgresTestUtils = makePostgresTestUtils({\n  database: 'prairielearn_migrations',\n});\n\ndescribe('BatchedMigrationsRunner', () => {\n  before(async () => {\n    await postgresTestUtils.createDatabase();\n    await namedLocks.init(postgresTestUtils.getPoolConfig(), (err) => {\n      throw err;\n    });\n    await init([SCHEMA_MIGRATIONS_PATH], 'prairielearn_migrations');\n  });\n\n  afterEach(async () => {\n    await postgresTestUtils.resetDatabase();\n  });\n\n  after(async () => {\n    await namedLocks.close();\n    await postgresTestUtils.dropDatabase();\n  });\n\n  it('enqueues migrations', async () => {\n    const runner = new BatchedMigrationsRunner({\n      project: 'test',\n      directories: [path.join(import.meta.dirname, 'fixtures')],\n    });\n\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n    await runner.enqueueBatchedMigration('20230406184107_failing_migration');\n    await runner.enqueueBatchedMigration('20230407230446_no_rows_migration');\n\n    const migrations = await selectAllBatchedMigrations('test');\n\n    assert.lengthOf(migrations, 3);\n    assert.equal(migrations[0].timestamp, '20230406184103');\n    assert.equal(migrations[0].filename, '20230406184103_successful_migration.ts');\n    assert.equal(migrations[0].status, 'pending');\n    assert.equal(migrations[1].timestamp, '20230406184107');\n    assert.equal(migrations[1].filename, '20230406184107_failing_migration.ts');\n    assert.equal(migrations[1].status, 'pending');\n    assert.equal(migrations[2].timestamp, '20230407230446');\n    assert.equal(migrations[2].filename, '20230407230446_no_rows_migration.ts');\n    assert.equal(migrations[2].status, 'succeeded');\n  });\n\n  it('safely enqueues migrations multiple times', async () => {\n    const runner = new BatchedMigrationsRunner({\n      project: 'test',\n      directories: [path.join(import.meta.dirname, 'fixtures')],\n    });\n\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n\n    const migrations = await selectAllBatchedMigrations('test');\n\n    assert.lengthOf(migrations, 1);\n  });\n\n  it('finalizes a successful migration', async () => {\n    const runner = new BatchedMigrationsRunner({\n      project: 'test',\n      directories: [path.join(import.meta.dirname, 'fixtures')],\n    });\n\n    await runner.enqueueBatchedMigration('20230406184103_successful_migration');\n    await runner.finalizeBatchedMigration('20230406184103_successful_migration', {\n      logProgress: false,\n    });\n\n    const migrations = await selectAllBatchedMigrations('test');\n    assert.lengthOf(migrations, 1);\n    assert.equal(migrations[0].timestamp, '20230406184103');\n    assert.equal(migrations[0].status, 'succeeded');\n  });\n\n  it('finalizes a failing migration', async () => {\n    const runner = new BatchedMigrationsRunner({\n      project: 'test',\n      directories: [path.join(import.meta.dirname, 'fixtures')],\n    });\n\n    await runner.enqueueBatchedMigration('20230406184107_failing_migration');\n\n    await assert.isRejected(\n      runner.finalizeBatchedMigration('20230406184107_failing_migration', {\n        logProgress: false,\n      }),\n      \"but it is 'failed'\",\n    );\n\n    const migrations = await selectAllBatchedMigrations('test');\n    assert.lengthOf(migrations, 1);\n    assert.equal(migrations[0].timestamp, '20230406184107');\n    assert.equal(migrations[0].status, 'failed');\n  });\n});\n"]}

package/dist/load-migrations.test.js

@@ -1,5 +1,5 @@
 import path from 'path';
-import { use as chaiUse, assert } from 'chai';
+import { assert, use as chaiUse } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import fs from 'fs-extra';
 import tmp from 'tmp-promise';

package/dist/load-migrations.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"load-migrations.test.js","sourceRoot":"","sources":["../src/load-migrations.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B,OAAO,EACL,gBAAgB,EAChB,sCAAsC,EACtC,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,CAAC,cAAc,CAAC,CAAC;AAExB,KAAK,UAAU,kBAAkB,CAAC,KAAe,EAAE,EAAqC;IACtF,MAAM,GAAG,CAAC,OAAO,CACf,KAAK,WAAW,MAAM;QACpB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,EACD,EAAE,aAAa,EAAE,IAAI,EAAE,CACxB,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;QACtD,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,kBAAkB,CAAC,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;gBAC7D,MAAM,MAAM,CAAC,UAAU,CACrB,sCAAsC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,EACxD,6CAA6C,CAC9C,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,kBAAkB,CACtB,CAAC,4BAA4B,EAAE,kCAAkC,CAAC,EAClE,KAAK,EAAE,MAAM,EAAE,EAAE;gBACf,MAAM,MAAM,CAAC,UAAU,CACrB,sCAAsC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,EACxD,+BAA+B,CAChC,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,MAAM,CAAC,SAAS,CACd,kBAAkB,CAAC;gBACjB;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;aACF,CAAC,EACF;gBACE;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;aACF,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,MAAM,WAAW,GAAG,gBAAgB,CAAC,2CAA2C,CAAC,CAAC;YAClF,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;gBACjB,gBAAgB,CAAC,oCAAoC,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import path from 'path';\n\nimport { use as chaiUse, assert } from 'chai';\nimport chaiAsPromised from 'chai-as-promised';\nimport fs from 'fs-extra';\nimport tmp from 'tmp-promise';\n\nimport {\n  parseAnnotations,\n  readAndValidateMigrationsFromDirectory,\n  sortMigrationFiles,\n} from './load-migrations.js';\n\nchaiUse(chaiAsPromised);\n\nasync function withMigrationFiles(files: string[], fn: (tmpDir: string) => Promise<void>) {\n  await tmp.withDir(\n    async function (tmpDir) {\n      for (const file of files) {\n        await fs.writeFile(path.join(tmpDir.path, file), '');\n      }\n      await fn(tmpDir.path);\n    },\n    { unsafeCleanup: true },\n  );\n}\n\ndescribe('load-migrations', () => {\n  describe('readAndValidateMigrationsFromDirectory', () => {\n    it('handles migrations without a timestamp', async () => {\n      await withMigrationFiles(['001_testing.sql'], async (tmpDir) => {\n        await assert.isRejected(\n          readAndValidateMigrationsFromDirectory(tmpDir, ['.sql']),\n          'Invalid migration filename: 001_testing.sql',\n        );\n      });\n    });\n\n    it('handles duplicate timestamps', async () => {\n      await withMigrationFiles(\n        ['20220101010101_testing.sql', '20220101010101_testing_again.sql'],\n        async (tmpDir) => {\n          await assert.isRejected(\n            readAndValidateMigrationsFromDirectory(tmpDir, ['.sql']),\n            'Duplicate migration timestamp',\n          );\n        },\n      );\n    });\n  });\n\n  describe('sortMigrationFiles', () => {\n    it('sorts by timestamp', () => {\n      assert.deepEqual(\n        sortMigrationFiles([\n          {\n            directory: 'migrations',\n            filename: '20220101010103_testing_3.sql',\n            timestamp: '20220101010103',\n          },\n          {\n            directory: 'migrations',\n            filename: '20220101010101_testing_1.sql',\n            timestamp: '20220101010101',\n          },\n          {\n            directory: 'migrations',\n            filename: '20220101010102_testing_2.sql',\n            timestamp: '20220101010102',\n          },\n        ]),\n        [\n          {\n            directory: 'migrations',\n            filename: '20220101010101_testing_1.sql',\n            timestamp: '20220101010101',\n          },\n          {\n            directory: 'migrations',\n            filename: '20220101010102_testing_2.sql',\n            timestamp: '20220101010102',\n          },\n          {\n            directory: 'migrations',\n            filename: '20220101010103_testing_3.sql',\n            timestamp: '20220101010103',\n          },\n        ],\n      );\n    });\n  });\n\n  describe('parseAnnotations', () => {\n    it('parses a NO TRANSACTION annotation', () => {\n      const annotations = parseAnnotations('-- prairielearn:migrations NO TRANSACTION');\n      assert.deepEqual(annotations, new Set(['NO TRANSACTION']));\n    });\n\n    it('throws an error for an invalid annotation', () => {\n      assert.throws(() => {\n        parseAnnotations('-- prairielearn:migrations INVALID');\n      });\n    });\n  });\n});\n"]}
+{"version":3,"file":"load-migrations.test.js","sourceRoot":"","sources":["../src/load-migrations.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,MAAM,CAAC;AAC9C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B,OAAO,EACL,gBAAgB,EAChB,sCAAsC,EACtC,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,CAAC,cAAc,CAAC,CAAC;AAExB,KAAK,UAAU,kBAAkB,CAAC,KAAe,EAAE,EAAqC;IACtF,MAAM,GAAG,CAAC,OAAO,CACf,KAAK,WAAW,MAAM;QACpB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,EACD,EAAE,aAAa,EAAE,IAAI,EAAE,CACxB,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;QACtD,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,kBAAkB,CAAC,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;gBAC7D,MAAM,MAAM,CAAC,UAAU,CACrB,sCAAsC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,EACxD,6CAA6C,CAC9C,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,kBAAkB,CACtB,CAAC,4BAA4B,EAAE,kCAAkC,CAAC,EAClE,KAAK,EAAE,MAAM,EAAE,EAAE;gBACf,MAAM,MAAM,CAAC,UAAU,CACrB,sCAAsC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,EACxD,+BAA+B,CAChC,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,MAAM,CAAC,SAAS,CACd,kBAAkB,CAAC;gBACjB;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;aACF,CAAC,EACF;gBACE;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,8BAA8B;oBACxC,SAAS,EAAE,gBAAgB;iBAC5B;aACF,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,MAAM,WAAW,GAAG,gBAAgB,CAAC,2CAA2C,CAAC,CAAC;YAClF,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;gBACjB,gBAAgB,CAAC,oCAAoC,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import path from 'path';\n\nimport { assert, use as chaiUse } from 'chai';\nimport chaiAsPromised from 'chai-as-promised';\nimport fs from 'fs-extra';\nimport tmp from 'tmp-promise';\n\nimport {\n  parseAnnotations,\n  readAndValidateMigrationsFromDirectory,\n  sortMigrationFiles,\n} from './load-migrations.js';\n\nchaiUse(chaiAsPromised);\n\nasync function withMigrationFiles(files: string[], fn: (tmpDir: string) => Promise<void>) {\n  await tmp.withDir(\n    async function (tmpDir) {\n      for (const file of files) {\n        await fs.writeFile(path.join(tmpDir.path, file), '');\n      }\n      await fn(tmpDir.path);\n    },\n    { unsafeCleanup: true },\n  );\n}\n\ndescribe('load-migrations', () => {\n  describe('readAndValidateMigrationsFromDirectory', () => {\n    it('handles migrations without a timestamp', async () => {\n      await withMigrationFiles(['001_testing.sql'], async (tmpDir) => {\n        await assert.isRejected(\n          readAndValidateMigrationsFromDirectory(tmpDir, ['.sql']),\n          'Invalid migration filename: 001_testing.sql',\n        );\n      });\n    });\n\n    it('handles duplicate timestamps', async () => {\n      await withMigrationFiles(\n        ['20220101010101_testing.sql', '20220101010101_testing_again.sql'],\n        async (tmpDir) => {\n          await assert.isRejected(\n            readAndValidateMigrationsFromDirectory(tmpDir, ['.sql']),\n            'Duplicate migration timestamp',\n          );\n        },\n      );\n    });\n  });\n\n  describe('sortMigrationFiles', () => {\n    it('sorts by timestamp', () => {\n      assert.deepEqual(\n        sortMigrationFiles([\n          {\n            directory: 'migrations',\n            filename: '20220101010103_testing_3.sql',\n            timestamp: '20220101010103',\n          },\n          {\n            directory: 'migrations',\n            filename: '20220101010101_testing_1.sql',\n            timestamp: '20220101010101',\n          },\n          {\n            directory: 'migrations',\n            filename: '20220101010102_testing_2.sql',\n            timestamp: '20220101010102',\n          },\n        ]),\n        [\n          {\n            directory: 'migrations',\n            filename: '20220101010101_testing_1.sql',\n            timestamp: '20220101010101',\n          },\n          {\n            directory: 'migrations',\n            filename: '20220101010102_testing_2.sql',\n            timestamp: '20220101010102',\n          },\n          {\n            directory: 'migrations',\n            filename: '20220101010103_testing_3.sql',\n            timestamp: '20220101010103',\n          },\n        ],\n      );\n    });\n  });\n\n  describe('parseAnnotations', () => {\n    it('parses a NO TRANSACTION annotation', () => {\n      const annotations = parseAnnotations('-- prairielearn:migrations NO TRANSACTION');\n      assert.deepEqual(annotations, new Set(['NO TRANSACTION']));\n    });\n\n    it('throws an error for an invalid annotation', () => {\n      assert.throws(() => {\n        parseAnnotations('-- prairielearn:migrations INVALID');\n      });\n    });\n  });\n});\n"]}

package/package.json

@@ -1,39 +1,39 @@
 {
   "name": "@prairielearn/migrations",
-  "version": "3.0.11",
+  "version": "3.0.13",
   "type": "module",
-  "main": "./dist/index.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/PrairieLearn/PrairieLearn.git",
     "directory": "packages/migrations"
   },
+  "main": "./dist/index.js",
   "scripts": {
     "build": "tsc && tscp",
     "dev": "tsc --watch --preserveWatchOutput & tscp --watch",
     "test": "c8 mocha src/**/*.test.ts"
   },
   "dependencies": {
-    "@prairielearn/error": "^2.0.9",
-    "@prairielearn/logger": "^2.0.9",
-    "@prairielearn/named-locks": "^3.0.11",
-    "@prairielearn/postgres": "^2.1.7",
+    "@prairielearn/error": "^2.0.11",
+    "@prairielearn/logger": "^2.0.11",
+    "@prairielearn/named-locks": "^3.0.13",
+    "@prairielearn/postgres": "^2.1.9",
     "fs-extra": "^11.3.0",
-    "serialize-error": "^11.0.3",
-    "zod": "^3.24.1"
+    "serialize-error": "^12.0.0",
+    "zod": "^3.24.2"
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "^0.0.0",
     "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^20.17.16",
+    "@types/node": "^20.17.28",
     "c8": "^10.1.3",
-    "chai": "^5.1.2",
+    "chai": "^5.2.0",
     "chai-as-promised": "^8.0.1",
-    "mocha": "^10.8.2",
+    "mocha": "^11.1.0",
     "tmp-promise": "^3.0.3",
-    "tsx": "^4.19.2",
-    "typescript": "^5.7.3",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
     "typescript-cp": "^0.1.9"
   },
   "c8": {

package/src/batched-migrations/batched-migration-runner.ts

@@ -2,19 +2,19 @@ import { serializeError } from 'serialize-error';
 import { z } from 'zod';
 
 import { logger } from '@prairielearn/logger';
-import { loadSqlEquiv, queryAsync, queryRow, queryOptionalRow } from '@prairielearn/postgres';
+import { loadSqlEquiv, queryAsync, queryOptionalRow, queryRow } from '@prairielearn/postgres';
 
 import {
+  type BatchedMigrationJobRow,
   BatchedMigrationJobRowSchema,
   type BatchedMigrationJobStatus,
-  type BatchedMigrationJobRow,
 } from './batched-migration-job.js';
 import {
-  type BatchedMigrationStatus,
+  type BatchedMigrationImplementation,
   type BatchedMigrationRow,
-  updateBatchedMigrationStatus,
+  type BatchedMigrationStatus,
   BatchedMigrationStatusSchema,
-  type BatchedMigrationImplementation,
+  updateBatchedMigrationStatus,
 } from './batched-migration.js';
 
 const sql = loadSqlEquiv(import.meta.filename);

package/src/batched-migrations/batched-migration.ts

@@ -3,9 +3,9 @@ import { z } from 'zod';
 import {
   loadSqlEquiv,
   queryAsync,
+  queryOptionalRow,
   queryRow,
   queryRows,
-  queryOptionalRow,
 } from '@prairielearn/postgres';
 
 const sql = loadSqlEquiv(import.meta.filename);

package/src/batched-migrations/batched-migrations-runner.test.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
 
-import { use as chaiUse, assert } from 'chai';
+import { assert, use as chaiUse } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 
 import * as namedLocks from '@prairielearn/named-locks';

package/src/batched-migrations/batched-migrations-runner.ts

@@ -12,13 +12,13 @@ import {
 
 import { BatchedMigrationRunner } from './batched-migration-runner.js';
 import {
-  BatchedMigrationRowSchema,
+  type BatchedMigrationImplementation,
   type BatchedMigrationRow,
-  insertBatchedMigration,
+  BatchedMigrationRowSchema,
   type BatchedMigrationStatus,
+  insertBatchedMigration,
   selectBatchedMigrationForTimestamp,
   updateBatchedMigrationStatus,
-  type BatchedMigrationImplementation,
   validateBatchedMigrationImplementation,
 } from './batched-migration.js';
 

package/src/load-migrations.test.ts

@@ -1,6 +1,6 @@
 import path from 'path';
 
-import { use as chaiUse, assert } from 'chai';
+import { assert, use as chaiUse } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import fs from 'fs-extra';
 import tmp from 'tmp-promise';