@prairielearn/migrations 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @prairielearn/migrations
 
+## 2.0.2
+
+### Patch Changes
+
+- 2b003b4d9: Upgrade all dependencies
+- Updated dependencies [2b003b4d9]
+- Updated dependencies [297bbce5a]
+  - @prairielearn/named-locks@1.4.0
+  - @prairielearn/postgres@1.7.2
+  - @prairielearn/logger@1.0.2
+  - @prairielearn/error@1.0.3
+
+## 2.0.1
+
+### Patch Changes
+
+- 8fd47d928: Upgrade all dependencies
+- Updated dependencies [8fd47d928]
+  - @prairielearn/named-locks@1.3.3
+  - @prairielearn/postgres@1.7.1
+  - @prairielearn/logger@1.0.1
+  - @prairielearn/error@1.0.2
+
 ## 2.0.0
 
 ### Major Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/migrations",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "main": "./dist/index.js",
   "repository": {
     "type": "git",
@@ -16,17 +16,17 @@
     "@prairielearn/tsconfig": "^0.0.0",
     "@types/fs-extra": "^11.0.1",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.16.3",
+    "@types/node": "^18.16.19",
     "mocha": "^10.2.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4",
+    "typescript": "^5.1.6",
     "typescript-cp": "^0.1.8"
   },
   "dependencies": {
-    "@prairielearn/error": "^1.0.1",
-    "@prairielearn/logger": "^1.0.0",
-    "@prairielearn/named-locks": "^1.3.2",
-    "@prairielearn/postgres": "^1.7.0",
+    "@prairielearn/error": "^1.0.3",
+    "@prairielearn/logger": "^1.0.2",
+    "@prairielearn/named-locks": "^1.4.0",
+    "@prairielearn/postgres": "^1.7.2",
     "fs-extra": "^11.1.1",
     "serialize-error": "^8.1.0",
     "zod": "^3.21.4"

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

@@ -24,11 +24,11 @@ export type BatchedMigrationJobRow = z.infer<typeof BatchedMigrationJobRowSchema
 export async function selectRecentJobsWithStatus(
   batchedMigrationId: string,
   status: BatchedMigrationJobStatus,
-  limit: number
+  limit: number,
 ): Promise<BatchedMigrationJobRow[]> {
   return queryValidatedRows(
     sql.select_recent_jobs_with_status,
     { batched_migration_id: batchedMigrationId, status, limit },
-    BatchedMigrationJobRowSchema
+    BatchedMigrationJobRowSchema,
   );
 }

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

@@ -57,7 +57,7 @@ async function getBatchedMigration(migrationId: string) {
   return queryValidatedOneRow(
     'SELECT * FROM batched_migrations WHERE id = $id;',
     { id: migrationId },
-    BatchedMigrationRowSchema
+    BatchedMigrationRowSchema,
   );
 }
 
@@ -65,7 +65,7 @@ async function getBatchedMigrationJobs(migrationId: string) {
   return queryValidatedRows(
     'SELECT * FROM batched_migration_jobs WHERE batched_migration_id = $batched_migration_id ORDER BY id ASC;',
     { batched_migration_id: migrationId },
-    BatchedMigrationJobRowSchema
+    BatchedMigrationJobRowSchema,
   );
 }
 
@@ -74,7 +74,7 @@ async function resetFailedBatchedMigrationJobs(migrationId: string) {
     "UPDATE batched_migration_jobs SET status = 'pending', updated_at = CURRENT_TIMESTAMP WHERE batched_migration_id = $batched_migration_id AND status = 'failed'",
     {
       batched_migration_id: migrationId,
-    }
+    },
   );
 }
 

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

@@ -37,7 +37,7 @@ export class BatchedMigrationRunner {
   constructor(
     migration: BatchedMigrationRow,
     migrationImplementation: BatchedMigrationImplementation,
-    options: BatchedMigrationRunnerOptions = {}
+    options: BatchedMigrationRunnerOptions = {},
   ) {
     this.options = options;
     this.migration = migration;
@@ -55,7 +55,7 @@ export class BatchedMigrationRunner {
     return queryValidatedSingleColumnOneRow(
       sql.batched_migration_has_incomplete_jobs,
       { batched_migration_id: migration.id },
-      z.boolean()
+      z.boolean(),
     );
   }
 
@@ -63,7 +63,7 @@ export class BatchedMigrationRunner {
     return queryValidatedSingleColumnOneRow(
       sql.batched_migration_has_failed_jobs,
       { batched_migration_id: migration.id },
-      z.boolean()
+      z.boolean(),
     );
   }
 
@@ -73,7 +73,7 @@ export class BatchedMigrationRunner {
       {
         id: migration.id,
       },
-      BatchedMigrationStatusSchema
+      BatchedMigrationStatusSchema,
     );
   }
 
@@ -92,12 +92,12 @@ export class BatchedMigrationRunner {
   }
 
   private async getNextBatchBounds(
-    migration: BatchedMigrationRow
+    migration: BatchedMigrationRow,
   ): Promise<null | [bigint, bigint]> {
     const lastJob = await queryValidatedZeroOrOneRow(
       sql.select_last_batched_migration_job,
       { batched_migration_id: migration.id },
-      BatchedMigrationJobRowSchema
+      BatchedMigrationJobRowSchema,
     );
 
     const nextMin = lastJob ? lastJob.max_value + 1n : migration.min_value;
@@ -129,7 +129,7 @@ export class BatchedMigrationRunner {
   private async finishJob(
     job: BatchedMigrationJobRow,
     status: Extract<BatchedMigrationJobStatus, 'failed' | 'succeeded'>,
-    data?: unknown
+    data?: unknown,
   ) {
     await queryAsync(sql.finish_batched_migration_job, {
       id: job.id,
@@ -140,7 +140,7 @@ export class BatchedMigrationRunner {
   }
 
   private async getOrCreateNextMigrationJob(
-    migration: BatchedMigrationRow
+    migration: BatchedMigrationRow,
   ): Promise<BatchedMigrationJobRow | null> {
     const nextBatchBounds = await this.getNextBatchBounds(migration);
     if (nextBatchBounds) {
@@ -151,7 +151,7 @@ export class BatchedMigrationRunner {
           min_value: nextBatchBounds[0],
           max_value: nextBatchBounds[1],
         },
-        BatchedMigrationJobRowSchema
+        BatchedMigrationJobRowSchema,
       );
     } else {
       // Pick up any old pending jobs from this migration. These will only exist if
@@ -160,14 +160,14 @@ export class BatchedMigrationRunner {
       return queryValidatedZeroOrOneRow(
         sql.select_first_pending_batched_migration_job,
         { batched_migration_id: migration.id },
-        BatchedMigrationJobRowSchema
+        BatchedMigrationJobRowSchema,
       );
     }
   }
 
   private async runMigrationJob(
     migration: BatchedMigrationRow,
-    migrationImplementation: BatchedMigrationImplementation
+    migrationImplementation: BatchedMigrationImplementation,
   ) {
     const nextJob = await this.getOrCreateNextMigrationJob(migration);
     if (nextJob) {

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

@@ -54,7 +54,7 @@ export function makeBatchedMigration<T extends BatchedMigrationImplementation>(f
 }
 
 export function validateBatchedMigrationImplementation(
-  fns: BatchedMigrationImplementation
+  fns: BatchedMigrationImplementation,
 ): asserts fns is BatchedMigrationImplementation {
   if (typeof fns.getParameters !== 'function') {
     throw new Error('getParameters() must be a function');
@@ -74,12 +74,12 @@ type NewBatchedMigration = Pick<
  * project/timestamp pair, returns null, otherwise returns the inserted row.
  */
 export async function insertBatchedMigration(
-  migration: NewBatchedMigration
+  migration: NewBatchedMigration,
 ): Promise<BatchedMigrationRow | null> {
   return queryValidatedZeroOrOneRow(
     sql.insert_batched_migration,
     migration,
-    BatchedMigrationRowSchema
+    BatchedMigrationRowSchema,
   );
 }
 
@@ -87,40 +87,40 @@ export async function selectAllBatchedMigrations(project: string) {
   return queryValidatedRows(
     sql.select_all_batched_migrations,
     { project },
-    BatchedMigrationRowSchema
+    BatchedMigrationRowSchema,
   );
 }
 
 export async function selectBatchedMigration(
   project: string,
-  id: string
+  id: string,
 ): Promise<BatchedMigrationRow> {
   return queryValidatedOneRow(
     sql.select_batched_migration,
     { project, id },
-    BatchedMigrationRowSchema
+    BatchedMigrationRowSchema,
   );
 }
 
 export async function selectBatchedMigrationForTimestamp(
   project: string,
-  timestamp: string
+  timestamp: string,
 ): Promise<BatchedMigrationRow> {
   return queryValidatedOneRow(
     sql.select_batched_migration_for_timestamp,
     { project, timestamp },
-    BatchedMigrationRowSchema
+    BatchedMigrationRowSchema,
   );
 }
 
 export async function updateBatchedMigrationStatus(
   id: string,
-  status: BatchedMigrationStatus
+  status: BatchedMigrationStatus,
 ): Promise<BatchedMigrationRow> {
   return queryValidatedOneRow(
     sql.update_batched_migration_status,
     { id, status },
-    BatchedMigrationRowSchema
+    BatchedMigrationRowSchema,
   );
 }
 

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

@@ -100,7 +100,7 @@ describe('BatchedMigrationsRunner', () => {
       runner.finalizeBatchedMigration('20230406184107_failing_migration', {
         logProgress: false,
       }),
-      "but it is 'failed'"
+      "but it is 'failed'",
     );
 
     const migrations = await selectAllBatchedMigrations('test');

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

@@ -60,7 +60,7 @@ export class BatchedMigrationsRunner extends EventEmitter {
     if (!this.migrationFiles) {
       this.migrationFiles = await readAndValidateMigrationsFromDirectories(
         this.options.directories,
-        EXTENSIONS
+        EXTENSIONS,
       );
     }
     return this.migrationFiles;
@@ -153,7 +153,7 @@ export class BatchedMigrationsRunner extends EventEmitter {
     if (migration.status === 'succeeded') return;
 
     throw new Error(
-      `Expected batched migration with identifier ${identifier} to be marked as 'succeeded', but it is '${migration.status}'.`
+      `Expected batched migration with identifier ${identifier} to be marked as 'succeeded', but it is '${migration.status}'.`,
     );
   }
 
@@ -208,14 +208,14 @@ export class BatchedMigrationsRunner extends EventEmitter {
       let migration = await queryValidatedZeroOrOneRow(
         sql.select_running_migration,
         { project: this.options.project },
-        BatchedMigrationRowSchema
+        BatchedMigrationRowSchema,
       );
 
       if (!migration) {
         migration = await queryValidatedZeroOrOneRow(
           sql.start_next_pending_migration,
           { project: this.options.project },
-          BatchedMigrationRowSchema
+          BatchedMigrationRowSchema,
         );
       }
 
@@ -252,7 +252,7 @@ export class BatchedMigrationsRunner extends EventEmitter {
         } catch (err) {
           this.emit('error', err);
         }
-      }
+      },
     );
 
     return didWork;
@@ -271,7 +271,7 @@ export class BatchedMigrationsRunner extends EventEmitter {
 let runner: BatchedMigrationsRunner | null = null;
 
 function assertRunner(
-  runner: BatchedMigrationsRunner | null
+  runner: BatchedMigrationsRunner | null,
 ): asserts runner is BatchedMigrationsRunner {
   if (!runner) throw new Error('Batched migrations not initialized');
 }
@@ -320,7 +320,7 @@ export async function enqueueBatchedMigration(identifier: string) {
  */
 export async function finalizeBatchedMigration(
   identifier: string,
-  options?: BatchedMigrationFinalizeOptions
+  options?: BatchedMigrationFinalizeOptions,
 ) {
   assertRunner(runner);
   await runner.finalizeBatchedMigration(identifier, options);

package/src/load-migrations.test.ts

@@ -20,7 +20,7 @@ async function withMigrationFiles(files: string[], fn: (tmpDir: string) => Promi
       }
       await fn(tmpDir.path);
     },
-    { unsafeCleanup: true }
+    { unsafeCleanup: true },
   );
 }
 
@@ -30,7 +30,7 @@ describe('load-migrations', () => {
       await withMigrationFiles(['001_testing.sql'], async (tmpDir) => {
         await assert.isRejected(
           readAndValidateMigrationsFromDirectory(tmpDir, ['.sql']),
-          'Invalid migration filename: 001_testing.sql'
+          'Invalid migration filename: 001_testing.sql',
         );
       });
     });
@@ -41,9 +41,9 @@ describe('load-migrations', () => {
         async (tmpDir) => {
           await assert.isRejected(
             readAndValidateMigrationsFromDirectory(tmpDir, ['.sql']),
-            'Duplicate migration timestamp'
+            'Duplicate migration timestamp',
           );
-        }
+        },
       );
     });
   });
@@ -84,7 +84,7 @@ describe('load-migrations', () => {
             filename: '20220101010103_testing_3.sql',
             timestamp: '20220101010103',
           },
-        ]
+        ],
       );
     });
   });

package/src/load-migrations.ts

@@ -26,10 +26,10 @@ export interface MigrationFile {
 
 export async function readAndValidateMigrationsFromDirectory(
   dir: string,
-  extensions: string[]
+  extensions: string[],
 ): Promise<MigrationFile[]> {
   const migrationFiles = (await fs.readdir(dir)).filter((m) =>
-    extensions.some((e) => m.endsWith(e))
+    extensions.some((e) => m.endsWith(e)),
   );
 
   const migrations = migrationFiles.map((mf) => {
@@ -71,7 +71,7 @@ export async function readAndValidateMigrationsFromDirectory(
 
 export async function readAndValidateMigrationsFromDirectories(
   directories: string[],
-  extensions: string[]
+  extensions: string[],
 ): Promise<MigrationFile[]> {
   const allMigrations: MigrationFile[] = [];
   for (const directory of directories) {

package/src/migrations/migrations.ts

@@ -34,14 +34,14 @@ export async function init(directories: string | string[], project: string) {
     async () => {
       logger.verbose(`Acquired lock ${lockName}`);
       await initWithLock(migrationDirectories, project);
-    }
+    },
   );
   logger.verbose(`Released lock ${lockName}`);
 }
 
 export function getMigrationsToExecute(
   migrationFiles: MigrationFile[],
-  executedMigrations: { timestamp: string | null }[]
+  executedMigrations: { timestamp: string | null }[],
 ): MigrationFile[] {
   // If no migrations have ever been run, run them all.
   if (executedMigrations.length === 0) {
@@ -101,7 +101,7 @@ export async function initWithLock(directories: string[], project: string) {
         // This revision was the most recent commit to `master` before the
         // code handling indexes was removed.
         'You must deploy revision 1aa43c7348fa24cf636413d720d06a2fa9e38ef2 first.',
-      ].join('\n')
+      ].join('\n'),
     );
   }