@prairielearn/migrations 2.1.0 → 3.0.1

package/dist/migrations/migrations.js

@@ -1,44 +1,15 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initWithLock = exports.getMigrationsToExecute = exports.init = void 0;
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const path_1 = __importDefault(require("path"));
-const namedLocks = __importStar(require("@prairielearn/named-locks"));
-const logger_1 = require("@prairielearn/logger");
-const sqldb = __importStar(require("@prairielearn/postgres"));
-const error = __importStar(require("@prairielearn/error"));
-const load_migrations_1 = require("../load-migrations");
-const sql = sqldb.loadSqlEquiv(__filename);
-async function init(directories, project) {
+import path from 'path';
+import fs from 'fs-extra';
+import * as error from '@prairielearn/error';
+import { logger } from '@prairielearn/logger';
+import * as namedLocks from '@prairielearn/named-locks';
+import * as sqldb from '@prairielearn/postgres';
+import { parseAnnotations, readAndValidateMigrationsFromDirectories, sortMigrationFiles, } from '../load-migrations.js';
+const sql = sqldb.loadSqlEquiv(import.meta.filename);
+export async function init(directories, project) {
     const migrationDirectories = Array.isArray(directories) ? directories : [directories];
     const lockName = 'migrations';
-    logger_1.logger.verbose(`Waiting for lock ${lockName}`);
+    logger.verbose(`Waiting for lock ${lockName}`);
     await namedLocks.doWithLock(lockName, {
         // Migrations *might* take a long time to run, so we'll enable automatic
         // lock renewal so that our lock doesn't get killed by the Postgres
@@ -49,13 +20,12 @@ async function init(directories, project) {
         // Postgres is locking a whole table, which is unacceptable in production.
         autoRenew: true,
     }, async () => {
-        logger_1.logger.verbose(`Acquired lock ${lockName}`);
+        logger.verbose(`Acquired lock ${lockName}`);
         await initWithLock(migrationDirectories, project);
     });
-    logger_1.logger.verbose(`Released lock ${lockName}`);
+    logger.verbose(`Released lock ${lockName}`);
 }
-exports.init = init;
-function getMigrationsToExecute(migrationFiles, executedMigrations) {
+export function getMigrationsToExecute(migrationFiles, executedMigrations) {
     // If no migrations have ever been run, run them all.
     if (executedMigrations.length === 0) {
         return migrationFiles;
@@ -63,9 +33,8 @@ function getMigrationsToExecute(migrationFiles, executedMigrations) {
     const executedMigrationTimestamps = new Set(executedMigrations.map((m) => m.timestamp));
     return migrationFiles.filter((m) => !executedMigrationTimestamps.has(m.timestamp));
 }
-exports.getMigrationsToExecute = getMigrationsToExecute;
-async function initWithLock(directories, project) {
-    logger_1.logger.verbose('Starting DB schema migration');
+export async function initWithLock(directories, project) {
+    logger.verbose('Starting DB schema migration');
     // Create the migrations table if needed
     await sqldb.queryAsync(sql.create_migrations_table, {});
     // Apply necessary changes to the migrations table as needed.
@@ -74,7 +43,7 @@ async function initWithLock(directories, project) {
     }
     catch (err) {
         if (err.routine === 'errorMissingColumn') {
-            logger_1.logger.info('Altering migrations table');
+            logger.info('Altering migrations table');
             await sqldb.queryAsync(sql.add_projects_column, {});
         }
         else {
@@ -86,7 +55,7 @@ async function initWithLock(directories, project) {
     }
     catch (err) {
         if (err.routine === 'errorMissingColumn') {
-            logger_1.logger.info('Altering migrations table again');
+            logger.info('Altering migrations table again');
             await sqldb.queryAsync(sql.add_timestamp_column, {});
         }
         else {
@@ -94,7 +63,7 @@ async function initWithLock(directories, project) {
         }
     }
     let allMigrations = await sqldb.queryAsync(sql.get_migrations, { project });
-    const migrationFiles = await (0, load_migrations_1.readAndValidateMigrationsFromDirectories)(directories, [
+    const migrationFiles = await readAndValidateMigrationsFromDirectories(directories, [
         '.sql',
         '.js',
         '.ts',
@@ -116,21 +85,21 @@ async function initWithLock(directories, project) {
     // Refetch the list of migrations from the database.
     allMigrations = await sqldb.queryAsync(sql.get_migrations, { project });
     // Sort the migration files into execution order.
-    const sortedMigrationFiles = (0, load_migrations_1.sortMigrationFiles)(migrationFiles);
+    const sortedMigrationFiles = sortMigrationFiles(migrationFiles);
     // Figure out which migrations have to be applied.
     const migrationsToExecute = getMigrationsToExecute(sortedMigrationFiles, allMigrations.rows);
     for (const { directory, filename, timestamp } of migrationsToExecute) {
         if (allMigrations.rows.length === 0) {
             // if we are running all the migrations then log at a lower level
-            logger_1.logger.verbose(`Running migration ${filename}`);
+            logger.verbose(`Running migration ${filename}`);
         }
         else {
-            logger_1.logger.info(`Running migration ${filename}`);
+            logger.info(`Running migration ${filename}`);
         }
-        const migrationPath = path_1.default.join(directory, filename);
+        const migrationPath = path.join(directory, filename);
         if (filename.endsWith('.sql')) {
-            const migrationSql = await fs_extra_1.default.readFile(migrationPath, 'utf8');
-            const annotations = (0, load_migrations_1.parseAnnotations)(migrationSql);
+            const migrationSql = await fs.readFile(migrationPath, 'utf8');
+            const annotations = parseAnnotations(migrationSql);
             try {
                 if (annotations.has('NO TRANSACTION')) {
                     await sqldb.queryAsync(migrationSql, {});
@@ -147,7 +116,7 @@ async function initWithLock(directories, project) {
             }
         }
         else {
-            const migrationModule = await Promise.resolve(`${migrationPath}`).then(s => __importStar(require(s)));
+            const migrationModule = await import(migrationPath);
             const implementation = migrationModule.default;
             if (typeof implementation !== 'function') {
                 throw new Error(`Migration ${filename} does not export a default function`);
@@ -162,5 +131,4 @@ async function initWithLock(directories, project) {
         });
     }
 }
-exports.initWithLock = initWithLock;
 //# sourceMappingURL=migrations.js.map

package/dist/migrations/migrations.js.map

@@ -1 +1 @@
-{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/migrations/migrations.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wDAA0B;AAC1B,gDAAwB;AAExB,sEAAwD;AACxD,iDAA8C;AAC9C,8DAAgD;AAChD,2DAA6C;AAE7C,wDAK4B;AAE5B,MAAM,GAAG,GAAG,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;AAEpC,KAAK,UAAU,IAAI,CAAC,WAA8B,EAAE,OAAe;IACxE,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IACtF,MAAM,QAAQ,GAAG,YAAY,CAAC;IAC9B,eAAM,CAAC,OAAO,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IAC/C,MAAM,UAAU,CAAC,UAAU,CACzB,QAAQ,EACR;QACE,wEAAwE;QACxE,mEAAmE;QACnE,wBAAwB;QACxB,EAAE;QACF,qEAAqE;QACrE,kEAAkE;QAClE,0EAA0E;QAC1E,SAAS,EAAE,IAAI;KAChB,EACD,KAAK,IAAI,EAAE;QACT,eAAM,CAAC,OAAO,CAAC,iBAAiB,QAAQ,EAAE,CAAC,CAAC;QAC5C,MAAM,YAAY,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC,CACF,CAAC;IACF,eAAM,CAAC,OAAO,CAAC,iBAAiB,QAAQ,EAAE,CAAC,CAAC;AAC9C,CAAC;AAtBD,oBAsBC;AAED,SAAgB,sBAAsB,CACpC,cAA+B,EAC/B,kBAAkD;IAElD,qDAAqD;IACrD,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,MAAM,2BAA2B,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACxF,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AACrF,CAAC;AAXD,wDAWC;AAEM,KAAK,UAAU,YAAY,CAAC,WAAqB,EAAE,OAAe;IACvE,eAAM,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE/C,wCAAwC;IACxC,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IAExD,6DAA6D;IAC7D,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,UAAU,CAAC,iCAAiC,EAAE,EAAE,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,CAAC,OAAO,KAAK,oBAAoB,EAAE,CAAC;YACzC,eAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;YACzC,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IACD,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,UAAU,CAAC,mCAAmC,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,CAAC,OAAO,KAAK,oBAAoB,EAAE,CAAC;YACzC,eAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YAC/C,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED,IAAI,aAAa,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE5E,MAAM,cAAc,GAAG,MAAM,IAAA,0DAAwC,EAAC,WAAW,EAAE;QACjF,MAAM;QACN,KAAK;QACL,KAAK;QACL,MAAM;KACP,CAAC,CAAC;IAEH,4EAA4E;IAC5E,0EAA0E;IAC1E,kBAAkB;IAClB,MAAM,2BAA2B,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACnF,IAAI,2BAA2B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb;YACE,kDAAkD;YAClD,2BAA2B,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YACzD,kEAAkE;YAClE,qCAAqC;YACrC,0EAA0E;SAC3E,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;IACJ,CAAC;IAED,oDAAoD;IACpD,aAAa,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAExE,iDAAiD;IACjD,MAAM,oBAAoB,GAAG,IAAA,oCAAkB,EAAC,cAAc,CAAC,CAAC;IAEhE,kDAAkD;IAClD,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,oBAAoB,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAE7F,KAAK,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,mBAAmB,EAAE,CAAC;QACrE,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,iEAAiE;YACjE,eAAM,CAAC,OAAO,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,eAAM,CAAC,IAAI,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrD,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,YAAY,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YAC9D,MAAM,WAAW,GAAG,IAAA,kCAAgB,EAAC,YAAY,CAAC,CAAC;YACnD,IAAI,CAAC;gBACH,IAAI,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACtC,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAC3C,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,CAAC,qBAAqB,CAAC,KAAK,IAAI,EAAE;wBAC3C,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;oBAC3C,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC1C,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,eAAe,GAAG,yBAAa,aAAa,uCAAC,CAAC;YACpD,MAAM,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC;YAC/C,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,aAAa,QAAQ,qCAAqC,CAAC,CAAC;YAC9E,CAAC;YACD,MAAM,cAAc,EAAE,CAAC;QACzB,CAAC;QAED,wBAAwB;QACxB,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,gBAAgB,EAAE;YAC3C,QAAQ;YACR,SAAS;YACT,OAAO;SACR,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAtGD,oCAsGC","sourcesContent":["import fs from 'fs-extra';\nimport path from 'path';\n\nimport * as namedLocks from '@prairielearn/named-locks';\nimport { logger } from '@prairielearn/logger';\nimport * as sqldb from '@prairielearn/postgres';\nimport * as error from '@prairielearn/error';\n\nimport {\n  MigrationFile,\n  parseAnnotations,\n  readAndValidateMigrationsFromDirectories,\n  sortMigrationFiles,\n} from '../load-migrations';\n\nconst sql = sqldb.loadSqlEquiv(__filename);\n\nexport async function init(directories: string | string[], project: string) {\n  const migrationDirectories = Array.isArray(directories) ? directories : [directories];\n  const lockName = 'migrations';\n  logger.verbose(`Waiting for lock ${lockName}`);\n  await namedLocks.doWithLock(\n    lockName,\n    {\n      // Migrations *might* take a long time to run, so we'll enable automatic\n      // lock renewal so that our lock doesn't get killed by the Postgres\n      // idle session timeout.\n      //\n      // That said, we should generally try to keep migrations executing as\n      // quickly as possible. A long-running migration likely means that\n      // Postgres is locking a whole table, which is unacceptable in production.\n      autoRenew: true,\n    },\n    async () => {\n      logger.verbose(`Acquired lock ${lockName}`);\n      await initWithLock(migrationDirectories, project);\n    },\n  );\n  logger.verbose(`Released lock ${lockName}`);\n}\n\nexport function getMigrationsToExecute(\n  migrationFiles: MigrationFile[],\n  executedMigrations: { timestamp: string | null }[],\n): MigrationFile[] {\n  // If no migrations have ever been run, run them all.\n  if (executedMigrations.length === 0) {\n    return migrationFiles;\n  }\n\n  const executedMigrationTimestamps = new Set(executedMigrations.map((m) => m.timestamp));\n  return migrationFiles.filter((m) => !executedMigrationTimestamps.has(m.timestamp));\n}\n\nexport async function initWithLock(directories: string[], project: string) {\n  logger.verbose('Starting DB schema migration');\n\n  // Create the migrations table if needed\n  await sqldb.queryAsync(sql.create_migrations_table, {});\n\n  // Apply necessary changes to the migrations table as needed.\n  try {\n    await sqldb.queryAsync('SELECT project FROM migrations;', {});\n  } catch (err: any) {\n    if (err.routine === 'errorMissingColumn') {\n      logger.info('Altering migrations table');\n      await sqldb.queryAsync(sql.add_projects_column, {});\n    } else {\n      throw err;\n    }\n  }\n  try {\n    await sqldb.queryAsync('SELECT timestamp FROM migrations;', {});\n  } catch (err: any) {\n    if (err.routine === 'errorMissingColumn') {\n      logger.info('Altering migrations table again');\n      await sqldb.queryAsync(sql.add_timestamp_column, {});\n    } else {\n      throw err;\n    }\n  }\n\n  let allMigrations = await sqldb.queryAsync(sql.get_migrations, { project });\n\n  const migrationFiles = await readAndValidateMigrationsFromDirectories(directories, [\n    '.sql',\n    '.js',\n    '.ts',\n    '.mjs',\n  ]);\n\n  // Validation: if we not all previously-executed migrations have timestamps,\n  // prompt the user to deploy an earlier version that includes both indexes\n  // and timestamps.\n  const migrationsMissingTimestamps = allMigrations.rows.filter((m) => !m.timestamp);\n  if (migrationsMissingTimestamps.length > 0) {\n    throw new Error(\n      [\n        'The following migrations are missing timestamps:',\n        migrationsMissingTimestamps.map((m) => `  ${m.filename}`),\n        // This revision was the most recent commit to `master` before the\n        // code handling indexes was removed.\n        'You must deploy revision 1aa43c7348fa24cf636413d720d06a2fa9e38ef2 first.',\n      ].join('\\n'),\n    );\n  }\n\n  // Refetch the list of migrations from the database.\n  allMigrations = await sqldb.queryAsync(sql.get_migrations, { project });\n\n  // Sort the migration files into execution order.\n  const sortedMigrationFiles = sortMigrationFiles(migrationFiles);\n\n  // Figure out which migrations have to be applied.\n  const migrationsToExecute = getMigrationsToExecute(sortedMigrationFiles, allMigrations.rows);\n\n  for (const { directory, filename, timestamp } of migrationsToExecute) {\n    if (allMigrations.rows.length === 0) {\n      // if we are running all the migrations then log at a lower level\n      logger.verbose(`Running migration ${filename}`);\n    } else {\n      logger.info(`Running migration ${filename}`);\n    }\n\n    const migrationPath = path.join(directory, filename);\n    if (filename.endsWith('.sql')) {\n      const migrationSql = await fs.readFile(migrationPath, 'utf8');\n      const annotations = parseAnnotations(migrationSql);\n      try {\n        if (annotations.has('NO TRANSACTION')) {\n          await sqldb.queryAsync(migrationSql, {});\n        } else {\n          await sqldb.runInTransactionAsync(async () => {\n            await sqldb.queryAsync(migrationSql, {});\n          });\n        }\n      } catch (err) {\n        error.addData(err, { sqlFile: filename });\n        throw err;\n      }\n    } else {\n      const migrationModule = await import(migrationPath);\n      const implementation = migrationModule.default;\n      if (typeof implementation !== 'function') {\n        throw new Error(`Migration ${filename} does not export a default function`);\n      }\n      await implementation();\n    }\n\n    // Record the migration.\n    await sqldb.queryAsync(sql.insert_migration, {\n      filename,\n      timestamp,\n      project,\n    });\n  }\n}\n"]}
+{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/migrations/migrations.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,MAAM,UAAU,CAAC;AAE1B,OAAO,KAAK,KAAK,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,KAAK,UAAU,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,KAAK,MAAM,wBAAwB,CAAC;AAEhD,OAAO,EAEL,gBAAgB,EAChB,wCAAwC,EACxC,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,GAAG,GAAG,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAErD,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,WAA8B,EAAE,OAAe;IACxE,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IACtF,MAAM,QAAQ,GAAG,YAAY,CAAC;IAC9B,MAAM,CAAC,OAAO,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IAC/C,MAAM,UAAU,CAAC,UAAU,CACzB,QAAQ,EACR;QACE,wEAAwE;QACxE,mEAAmE;QACnE,wBAAwB;QACxB,EAAE;QACF,qEAAqE;QACrE,kEAAkE;QAClE,0EAA0E;QAC1E,SAAS,EAAE,IAAI;KAChB,EACD,KAAK,IAAI,EAAE;QACT,MAAM,CAAC,OAAO,CAAC,iBAAiB,QAAQ,EAAE,CAAC,CAAC;QAC5C,MAAM,YAAY,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC,CACF,CAAC;IACF,MAAM,CAAC,OAAO,CAAC,iBAAiB,QAAQ,EAAE,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,cAA+B,EAC/B,kBAAkD;IAElD,qDAAqD;IACrD,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,MAAM,2BAA2B,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACxF,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,WAAqB,EAAE,OAAe;IACvE,MAAM,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE/C,wCAAwC;IACxC,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IAExD,6DAA6D;IAC7D,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,UAAU,CAAC,iCAAiC,EAAE,EAAE,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,CAAC,OAAO,KAAK,oBAAoB,EAAE,CAAC;YACzC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;YACzC,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IACD,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,UAAU,CAAC,mCAAmC,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,CAAC,OAAO,KAAK,oBAAoB,EAAE,CAAC;YACzC,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YAC/C,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED,IAAI,aAAa,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE5E,MAAM,cAAc,GAAG,MAAM,wCAAwC,CAAC,WAAW,EAAE;QACjF,MAAM;QACN,KAAK;QACL,KAAK;QACL,MAAM;KACP,CAAC,CAAC;IAEH,4EAA4E;IAC5E,0EAA0E;IAC1E,kBAAkB;IAClB,MAAM,2BAA2B,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACnF,IAAI,2BAA2B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb;YACE,kDAAkD;YAClD,2BAA2B,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YACzD,kEAAkE;YAClE,qCAAqC;YACrC,0EAA0E;SAC3E,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;IACJ,CAAC;IAED,oDAAoD;IACpD,aAAa,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAExE,iDAAiD;IACjD,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAEhE,kDAAkD;IAClD,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,oBAAoB,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAE7F,KAAK,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,mBAAmB,EAAE,CAAC;QACrE,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,iEAAiE;YACjE,MAAM,CAAC,OAAO,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrD,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,YAAY,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YAC9D,MAAM,WAAW,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;YACnD,IAAI,CAAC;gBACH,IAAI,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACtC,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBAC3C,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,CAAC,qBAAqB,CAAC,KAAK,IAAI,EAAE;wBAC3C,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;oBAC3C,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC1C,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;YACpD,MAAM,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC;YAC/C,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,aAAa,QAAQ,qCAAqC,CAAC,CAAC;YAC9E,CAAC;YACD,MAAM,cAAc,EAAE,CAAC;QACzB,CAAC;QAED,wBAAwB;QACxB,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,gBAAgB,EAAE;YAC3C,QAAQ;YACR,SAAS;YACT,OAAO;SACR,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import path from 'path';\n\nimport fs from 'fs-extra';\n\nimport * as error from '@prairielearn/error';\nimport { logger } from '@prairielearn/logger';\nimport * as namedLocks from '@prairielearn/named-locks';\nimport * as sqldb from '@prairielearn/postgres';\n\nimport {\n  MigrationFile,\n  parseAnnotations,\n  readAndValidateMigrationsFromDirectories,\n  sortMigrationFiles,\n} from '../load-migrations.js';\n\nconst sql = sqldb.loadSqlEquiv(import.meta.filename);\n\nexport async function init(directories: string | string[], project: string) {\n  const migrationDirectories = Array.isArray(directories) ? directories : [directories];\n  const lockName = 'migrations';\n  logger.verbose(`Waiting for lock ${lockName}`);\n  await namedLocks.doWithLock(\n    lockName,\n    {\n      // Migrations *might* take a long time to run, so we'll enable automatic\n      // lock renewal so that our lock doesn't get killed by the Postgres\n      // idle session timeout.\n      //\n      // That said, we should generally try to keep migrations executing as\n      // quickly as possible. A long-running migration likely means that\n      // Postgres is locking a whole table, which is unacceptable in production.\n      autoRenew: true,\n    },\n    async () => {\n      logger.verbose(`Acquired lock ${lockName}`);\n      await initWithLock(migrationDirectories, project);\n    },\n  );\n  logger.verbose(`Released lock ${lockName}`);\n}\n\nexport function getMigrationsToExecute(\n  migrationFiles: MigrationFile[],\n  executedMigrations: { timestamp: string | null }[],\n): MigrationFile[] {\n  // If no migrations have ever been run, run them all.\n  if (executedMigrations.length === 0) {\n    return migrationFiles;\n  }\n\n  const executedMigrationTimestamps = new Set(executedMigrations.map((m) => m.timestamp));\n  return migrationFiles.filter((m) => !executedMigrationTimestamps.has(m.timestamp));\n}\n\nexport async function initWithLock(directories: string[], project: string) {\n  logger.verbose('Starting DB schema migration');\n\n  // Create the migrations table if needed\n  await sqldb.queryAsync(sql.create_migrations_table, {});\n\n  // Apply necessary changes to the migrations table as needed.\n  try {\n    await sqldb.queryAsync('SELECT project FROM migrations;', {});\n  } catch (err: any) {\n    if (err.routine === 'errorMissingColumn') {\n      logger.info('Altering migrations table');\n      await sqldb.queryAsync(sql.add_projects_column, {});\n    } else {\n      throw err;\n    }\n  }\n  try {\n    await sqldb.queryAsync('SELECT timestamp FROM migrations;', {});\n  } catch (err: any) {\n    if (err.routine === 'errorMissingColumn') {\n      logger.info('Altering migrations table again');\n      await sqldb.queryAsync(sql.add_timestamp_column, {});\n    } else {\n      throw err;\n    }\n  }\n\n  let allMigrations = await sqldb.queryAsync(sql.get_migrations, { project });\n\n  const migrationFiles = await readAndValidateMigrationsFromDirectories(directories, [\n    '.sql',\n    '.js',\n    '.ts',\n    '.mjs',\n  ]);\n\n  // Validation: if we not all previously-executed migrations have timestamps,\n  // prompt the user to deploy an earlier version that includes both indexes\n  // and timestamps.\n  const migrationsMissingTimestamps = allMigrations.rows.filter((m) => !m.timestamp);\n  if (migrationsMissingTimestamps.length > 0) {\n    throw new Error(\n      [\n        'The following migrations are missing timestamps:',\n        migrationsMissingTimestamps.map((m) => `  ${m.filename}`),\n        // This revision was the most recent commit to `master` before the\n        // code handling indexes was removed.\n        'You must deploy revision 1aa43c7348fa24cf636413d720d06a2fa9e38ef2 first.',\n      ].join('\\n'),\n    );\n  }\n\n  // Refetch the list of migrations from the database.\n  allMigrations = await sqldb.queryAsync(sql.get_migrations, { project });\n\n  // Sort the migration files into execution order.\n  const sortedMigrationFiles = sortMigrationFiles(migrationFiles);\n\n  // Figure out which migrations have to be applied.\n  const migrationsToExecute = getMigrationsToExecute(sortedMigrationFiles, allMigrations.rows);\n\n  for (const { directory, filename, timestamp } of migrationsToExecute) {\n    if (allMigrations.rows.length === 0) {\n      // if we are running all the migrations then log at a lower level\n      logger.verbose(`Running migration ${filename}`);\n    } else {\n      logger.info(`Running migration ${filename}`);\n    }\n\n    const migrationPath = path.join(directory, filename);\n    if (filename.endsWith('.sql')) {\n      const migrationSql = await fs.readFile(migrationPath, 'utf8');\n      const annotations = parseAnnotations(migrationSql);\n      try {\n        if (annotations.has('NO TRANSACTION')) {\n          await sqldb.queryAsync(migrationSql, {});\n        } else {\n          await sqldb.runInTransactionAsync(async () => {\n            await sqldb.queryAsync(migrationSql, {});\n          });\n        }\n      } catch (err) {\n        error.addData(err, { sqlFile: filename });\n        throw err;\n      }\n    } else {\n      const migrationModule = await import(migrationPath);\n      const implementation = migrationModule.default;\n      if (typeof implementation !== 'function') {\n        throw new Error(`Migration ${filename} does not export a default function`);\n      }\n      await implementation();\n    }\n\n    // Record the migration.\n    await sqldb.queryAsync(sql.insert_migration, {\n      filename,\n      timestamp,\n      project,\n    });\n  }\n}\n"]}

package/dist/migrations/migrations.test.js

@@ -1,12 +1,7 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const chai_1 = require("chai");
-const node_path_1 = __importDefault(require("node:path"));
-const postgres_1 = require("@prairielearn/postgres");
-const migrations_1 = require("./migrations");
+import path from 'node:path';
+import { assert } from 'chai';
+import { makePostgresTestUtils, queryAsync } from '@prairielearn/postgres';
+import { getMigrationsToExecute, initWithLock } from './migrations.js';
 describe('migrations', () => {
     describe('getMigrationsToExecute', () => {
         it('handles the case of no executed migrations', () => {
@@ -17,7 +12,7 @@ describe('migrations', () => {
                     timestamp: '20220101010101',
                 },
             ];
-            chai_1.assert.deepEqual((0, migrations_1.getMigrationsToExecute)(migrationFiles, []), migrationFiles);
+            assert.deepEqual(getMigrationsToExecute(migrationFiles, []), migrationFiles);
         });
         it('handles case where subset of migrations have been executed', () => {
             const migrationFiles = [
@@ -45,7 +40,7 @@ describe('migrations', () => {
                     timestamp: '20220101010102',
                 },
             ];
-            chai_1.assert.deepEqual((0, migrations_1.getMigrationsToExecute)(migrationFiles, executedMigrations), [
+            assert.deepEqual(getMigrationsToExecute(migrationFiles, executedMigrations), [
                 {
                     directory: 'migrations',
                     timestamp: '20220101010103',
@@ -55,7 +50,7 @@ describe('migrations', () => {
         });
     });
     describe('initWithLock', () => {
-        const postgresTestUtils = (0, postgres_1.makePostgresTestUtils)({
+        const postgresTestUtils = makePostgresTestUtils({
             database: 'prairielearn_migrations',
         });
         before(async () => {
@@ -65,13 +60,13 @@ describe('migrations', () => {
             await postgresTestUtils.dropDatabase();
         });
         it('runs both SQL and JavaScript migrations', async () => {
-            const migrationDir = node_path_1.default.join(__dirname, 'fixtures');
-            await (0, migrations_1.initWithLock)([migrationDir], 'prairielearn_migrations');
+            const migrationDir = path.join(import.meta.dirname, 'fixtures');
+            await initWithLock([migrationDir], 'prairielearn_migrations');
             // If both migrations ran successfully, there should be a single user
             // in the database.
-            const users = await (0, postgres_1.queryAsync)('SELECT * FROM users', {});
-            chai_1.assert.lengthOf(users.rows, 1);
-            chai_1.assert.equal(users.rows[0].name, 'Test User');
+            const users = await queryAsync('SELECT * FROM users', {});
+            assert.lengthOf(users.rows, 1);
+            assert.equal(users.rows[0].name, 'Test User');
         });
     });
 });

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

@@ -1 +1 @@
-{"version":3,"file":"migrations.test.js","sourceRoot":"","sources":["../../src/migrations/migrations.test.ts"],"names":[],"mappings":";;;;;AAAA,+BAA8B;AAC9B,0DAA6B;AAC7B,qDAA2E;AAE3E,6CAAoE;AAEpE,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,cAAc,GAAG;gBACrB;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,iBAAiB;oBAC3B,SAAS,EAAE,gBAAgB;iBAC5B;aACF,CAAC;YACF,aAAM,CAAC,SAAS,CAAC,IAAA,mCAAsB,EAAC,cAAc,EAAE,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,cAAc,GAAG;gBACrB;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;YACF,MAAM,kBAAkB,GAAG;gBACzB;oBACE,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,gBAAgB;iBAC5B;aACF,CAAC;YACF,aAAM,CAAC,SAAS,CAAC,IAAA,mCAAsB,EAAC,cAAc,EAAE,kBAAkB,CAAC,EAAE;gBAC3E;oBACE,SAAS,EAAE,YAAY;oBACvB,SAAS,EAAE,gBAAgB;oBAC3B,QAAQ,EAAE,8BAA8B;iBACzC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,MAAM,iBAAiB,GAAG,IAAA,gCAAqB,EAAC;YAC9C,QAAQ,EAAE,yBAAyB;SACpC,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,IAAI,EAAE;YAChB,MAAM,iBAAiB,CAAC,cAAc,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,KAAK,IAAI,EAAE;YACf,MAAM,iBAAiB,CAAC,YAAY,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YACtD,MAAM,IAAA,yBAAY,EAAC,CAAC,YAAY,CAAC,EAAE,yBAAyB,CAAC,CAAC;YAE9D,qEAAqE;YACrE,mBAAmB;YACnB,MAAM,KAAK,GAAG,MAAM,IAAA,qBAAU,EAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;YAC1D,aAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAC/B,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert } from 'chai';\nimport path from 'node:path';\nimport { makePostgresTestUtils, queryAsync } from '@prairielearn/postgres';\n\nimport { getMigrationsToExecute, initWithLock } from './migrations';\n\ndescribe('migrations', () => {\n  describe('getMigrationsToExecute', () => {\n    it('handles the case of no executed migrations', () => {\n      const migrationFiles = [\n        {\n          directory: 'migrations',\n          filename: '001_testing.sql',\n          timestamp: '20220101010101',\n        },\n      ];\n      assert.deepEqual(getMigrationsToExecute(migrationFiles, []), migrationFiles);\n    });\n\n    it('handles case where subset of migrations have been executed', () => {\n      const migrationFiles = [\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      const executedMigrations = [\n        {\n          timestamp: '20220101010101',\n        },\n        {\n          timestamp: '20220101010102',\n        },\n      ];\n      assert.deepEqual(getMigrationsToExecute(migrationFiles, executedMigrations), [\n        {\n          directory: 'migrations',\n          timestamp: '20220101010103',\n          filename: '20220101010103_testing_3.sql',\n        },\n      ]);\n    });\n  });\n\n  describe('initWithLock', () => {\n    const postgresTestUtils = makePostgresTestUtils({\n      database: 'prairielearn_migrations',\n    });\n\n    before(async () => {\n      await postgresTestUtils.createDatabase();\n    });\n\n    after(async () => {\n      await postgresTestUtils.dropDatabase();\n    });\n\n    it('runs both SQL and JavaScript migrations', async () => {\n      const migrationDir = path.join(__dirname, 'fixtures');\n      await initWithLock([migrationDir], 'prairielearn_migrations');\n\n      // If both migrations ran successfully, there should be a single user\n      // in the database.\n      const users = await queryAsync('SELECT * FROM users', {});\n      assert.lengthOf(users.rows, 1);\n      assert.equal(users.rows[0].name, 'Test User');\n    });\n  });\n});\n"]}
+{"version":3,"file":"migrations.test.js","sourceRoot":"","sources":["../../src/migrations/migrations.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAE3E,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEvE,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,cAAc,GAAG;gBACrB;oBACE,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,iBAAiB;oBAC3B,SAAS,EAAE,gBAAgB;iBAC5B;aACF,CAAC;YACF,MAAM,CAAC,SAAS,CAAC,sBAAsB,CAAC,cAAc,EAAE,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,cAAc,GAAG;gBACrB;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;YACF,MAAM,kBAAkB,GAAG;gBACzB;oBACE,SAAS,EAAE,gBAAgB;iBAC5B;gBACD;oBACE,SAAS,EAAE,gBAAgB;iBAC5B;aACF,CAAC;YACF,MAAM,CAAC,SAAS,CAAC,sBAAsB,CAAC,cAAc,EAAE,kBAAkB,CAAC,EAAE;gBAC3E;oBACE,SAAS,EAAE,YAAY;oBACvB,SAAS,EAAE,gBAAgB;oBAC3B,QAAQ,EAAE,8BAA8B;iBACzC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;YAC9C,QAAQ,EAAE,yBAAyB;SACpC,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,IAAI,EAAE;YAChB,MAAM,iBAAiB,CAAC,cAAc,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,KAAK,IAAI,EAAE;YACf,MAAM,iBAAiB,CAAC,YAAY,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAChE,MAAM,YAAY,CAAC,CAAC,YAAY,CAAC,EAAE,yBAAyB,CAAC,CAAC;YAE9D,qEAAqE;YACrE,mBAAmB;YACnB,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;YAC1D,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAC/B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import path from 'node:path';\n\nimport { assert } from 'chai';\n\nimport { makePostgresTestUtils, queryAsync } from '@prairielearn/postgres';\n\nimport { getMigrationsToExecute, initWithLock } from './migrations.js';\n\ndescribe('migrations', () => {\n  describe('getMigrationsToExecute', () => {\n    it('handles the case of no executed migrations', () => {\n      const migrationFiles = [\n        {\n          directory: 'migrations',\n          filename: '001_testing.sql',\n          timestamp: '20220101010101',\n        },\n      ];\n      assert.deepEqual(getMigrationsToExecute(migrationFiles, []), migrationFiles);\n    });\n\n    it('handles case where subset of migrations have been executed', () => {\n      const migrationFiles = [\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      const executedMigrations = [\n        {\n          timestamp: '20220101010101',\n        },\n        {\n          timestamp: '20220101010102',\n        },\n      ];\n      assert.deepEqual(getMigrationsToExecute(migrationFiles, executedMigrations), [\n        {\n          directory: 'migrations',\n          timestamp: '20220101010103',\n          filename: '20220101010103_testing_3.sql',\n        },\n      ]);\n    });\n  });\n\n  describe('initWithLock', () => {\n    const postgresTestUtils = makePostgresTestUtils({\n      database: 'prairielearn_migrations',\n    });\n\n    before(async () => {\n      await postgresTestUtils.createDatabase();\n    });\n\n    after(async () => {\n      await postgresTestUtils.dropDatabase();\n    });\n\n    it('runs both SQL and JavaScript migrations', async () => {\n      const migrationDir = path.join(import.meta.dirname, 'fixtures');\n      await initWithLock([migrationDir], 'prairielearn_migrations');\n\n      // If both migrations ran successfully, there should be a single user\n      // in the database.\n      const users = await queryAsync('SELECT * FROM users', {});\n      assert.lengthOf(users.rows, 1);\n      assert.equal(users.rows[0].name, 'Test User');\n    });\n  });\n});\n"]}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@prairielearn/migrations",
-  "version": "2.1.0",
+  "version": "3.0.1",
+  "type": "module",
   "main": "./dist/index.js",
   "repository": {
     "type": "git",
@@ -10,28 +11,28 @@
   "scripts": {
     "build": "tsc && tscp",
     "dev": "tsc --watch --preserveWatchOutput & tscp --watch",
-    "test": "mocha --no-config --require tsx src/**/*.test.ts"
+    "test": "mocha src/**/*.test.ts"
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "^0.0.0",
     "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.12.2",
-    "chai": "^4.4.1",
-    "chai-as-promised": "^7.1.1",
+    "@types/node": "^20.12.11",
+    "chai": "^5.1.1",
+    "chai-as-promised": "^7.1.2",
     "mocha": "^10.4.0",
     "tmp-promise": "^3.0.3",
-    "tsx": "^4.7.2",
-    "typescript": "^5.4.3",
+    "tsx": "^4.10.2",
+    "typescript": "^5.4.5",
     "typescript-cp": "^0.1.9"
   },
   "dependencies": {
-    "@prairielearn/error": "^1.2.0",
-    "@prairielearn/logger": "^1.0.15",
-    "@prairielearn/named-locks": "^2.0.3",
-    "@prairielearn/postgres": "^1.9.4",
+    "@prairielearn/error": "^2.0.1",
+    "@prairielearn/logger": "^2.0.1",
+    "@prairielearn/named-locks": "^3.0.1",
+    "@prairielearn/postgres": "^2.0.1",
     "fs-extra": "^11.2.0",
-    "serialize-error": "^8.1.0",
-    "zod": "^3.22.4"
+    "serialize-error": "^11.0.3",
+    "zod": "^3.23.8"
   }
 }

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

@@ -1,7 +1,8 @@
 import { z } from 'zod';
+
 import { loadSqlEquiv, queryRows } from '@prairielearn/postgres';
 
-const sql = loadSqlEquiv(__filename);
+const sql = loadSqlEquiv(import.meta.filename);
 
 export const BatchedMigrationJobStatusSchema = z.enum(['pending', 'failed', 'succeeded']);
 export type BatchedMigrationJobStatus = z.infer<typeof BatchedMigrationJobStatusSchema>;

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

@@ -1,17 +1,19 @@
 import { assert } from 'chai';
-import { makePostgresTestUtils, queryAsync, queryRow, queryRows } from '@prairielearn/postgres';
-import * as namedLocks from '@prairielearn/named-locks';
+
 import * as error from '@prairielearn/error';
+import * as namedLocks from '@prairielearn/named-locks';
+import { makePostgresTestUtils, queryAsync, queryRow, queryRows } from '@prairielearn/postgres';
+
+import { SCHEMA_MIGRATIONS_PATH, init } from '../index.js';
 
+import { BatchedMigrationJobRowSchema } from './batched-migration-job.js';
+import { BatchedMigrationRunner } from './batched-migration-runner.js';
 import {
   BatchedMigrationRowSchema,
   insertBatchedMigration,
   makeBatchedMigration,
   updateBatchedMigrationStatus,
-} from './batched-migration';
-import { BatchedMigrationJobRowSchema } from './batched-migration-job';
-import { BatchedMigrationRunner } from './batched-migration-runner';
-import { SCHEMA_MIGRATIONS_PATH, init } from '../index';
+} from './batched-migration.js';
 
 const postgresTestUtils = makePostgresTestUtils({
   database: 'prairielearn_migrations',

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

@@ -1,22 +1,23 @@
-import { loadSqlEquiv, queryAsync, queryRow, queryOptionalRow } from '@prairielearn/postgres';
-import { logger } from '@prairielearn/logger';
 import { serializeError } from 'serialize-error';
 import { z } from 'zod';
 
+import { logger } from '@prairielearn/logger';
+import { loadSqlEquiv, queryAsync, queryRow, queryOptionalRow } from '@prairielearn/postgres';
+
+import {
+  BatchedMigrationJobRowSchema,
+  BatchedMigrationJobStatus,
+  BatchedMigrationJobRow,
+} from './batched-migration-job.js';
 import {
   BatchedMigrationStatus,
   BatchedMigrationRow,
   updateBatchedMigrationStatus,
   BatchedMigrationStatusSchema,
   BatchedMigrationImplementation,
-} from './batched-migration';
-import {
-  BatchedMigrationJobRowSchema,
-  BatchedMigrationJobStatus,
-  BatchedMigrationJobRow,
-} from './batched-migration-job';
+} from './batched-migration.js';
 
-const sql = loadSqlEquiv(__filename);
+const sql = loadSqlEquiv(import.meta.filename);
 
 interface BatchedMigrationRunnerOptions {
   logProgress?: boolean;

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

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

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

@@ -1,14 +1,17 @@
-import chai, { assert } from 'chai';
-import chaiAsPromised from 'chai-as-promised';
 import path from 'node:path';
-import { makePostgresTestUtils } from '@prairielearn/postgres';
+
+import { use as chaiUse, assert } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
 import * as namedLocks from '@prairielearn/named-locks';
+import { makePostgresTestUtils } from '@prairielearn/postgres';
+
+import { SCHEMA_MIGRATIONS_PATH, init } from '../index.js';
 
-import { SCHEMA_MIGRATIONS_PATH, init } from '../index';
-import { BatchedMigrationsRunner } from './batched-migrations-runner';
-import { selectAllBatchedMigrations } from './batched-migration';
+import { selectAllBatchedMigrations } from './batched-migration.js';
+import { BatchedMigrationsRunner } from './batched-migrations-runner.js';
 
-chai.use(chaiAsPromised);
+chaiUse(chaiAsPromised);
 
 const postgresTestUtils = makePostgresTestUtils({
   database: 'prairielearn_migrations',
@@ -35,7 +38,7 @@ describe('BatchedMigrationsRunner', () => {
   it('enqueues migrations', async () => {
     const runner = new BatchedMigrationsRunner({
       project: 'test',
-      directories: [path.join(__dirname, 'fixtures')],
+      directories: [path.join(import.meta.dirname, 'fixtures')],
     });
 
     await runner.enqueueBatchedMigration('20230406184103_successful_migration');
@@ -49,7 +52,7 @@ describe('BatchedMigrationsRunner', () => {
     assert.equal(migrations[0].filename, '20230406184103_successful_migration.ts');
     assert.equal(migrations[0].status, 'pending');
     assert.equal(migrations[1].timestamp, '20230406184107');
-    assert.equal(migrations[1].filename, '20230406184107_failing_migration.js');
+    assert.equal(migrations[1].filename, '20230406184107_failing_migration.ts');
     assert.equal(migrations[1].status, 'pending');
     assert.equal(migrations[2].timestamp, '20230407230446');
     assert.equal(migrations[2].filename, '20230407230446_no_rows_migration.ts');
@@ -59,7 +62,7 @@ describe('BatchedMigrationsRunner', () => {
   it('safely enqueues migrations multiple times', async () => {
     const runner = new BatchedMigrationsRunner({
       project: 'test',
-      directories: [path.join(__dirname, 'fixtures')],
+      directories: [path.join(import.meta.dirname, 'fixtures')],
     });
 
     await runner.enqueueBatchedMigration('20230406184103_successful_migration');
@@ -74,7 +77,7 @@ describe('BatchedMigrationsRunner', () => {
   it('finalizes a successful migration', async () => {
     const runner = new BatchedMigrationsRunner({
       project: 'test',
-      directories: [path.join(__dirname, 'fixtures')],
+      directories: [path.join(import.meta.dirname, 'fixtures')],
     });
 
     await runner.enqueueBatchedMigration('20230406184103_successful_migration');
@@ -91,7 +94,7 @@ describe('BatchedMigrationsRunner', () => {
   it('finalizes a failing migration', async () => {
     const runner = new BatchedMigrationsRunner({
       project: 'test',
-      directories: [path.join(__dirname, 'fixtures')],
+      directories: [path.join(import.meta.dirname, 'fixtures')],
     });
 
     await runner.enqueueBatchedMigration('20230406184107_failing_migration');

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

@@ -1,10 +1,13 @@
 import { EventEmitter } from 'node:events';
 import path from 'node:path';
 import { setTimeout as sleep } from 'node:timers/promises';
-import { loadSqlEquiv, queryOptionalRow } from '@prairielearn/postgres';
+
 import { doWithLock } from '@prairielearn/named-locks';
+import { loadSqlEquiv, queryOptionalRow } from '@prairielearn/postgres';
+
+import { MigrationFile, readAndValidateMigrationsFromDirectories } from '../load-migrations.js';
 
-import { MigrationFile, readAndValidateMigrationsFromDirectories } from '../load-migrations';
+import { BatchedMigrationRunner } from './batched-migration-runner.js';
 import {
   BatchedMigrationRowSchema,
   BatchedMigrationRow,
@@ -14,10 +17,9 @@ import {
   updateBatchedMigrationStatus,
   BatchedMigrationImplementation,
   validateBatchedMigrationImplementation,
-} from './batched-migration';
-import { BatchedMigrationRunner } from './batched-migration-runner';
+} from './batched-migration.js';
 
-const sql = loadSqlEquiv(__filename);
+const sql = loadSqlEquiv(import.meta.filename);
 
 const DEFAULT_MIN_VALUE = 1n;
 const DEFAULT_BATCH_SIZE = 1_000;

package/src/batched-migrations/fixtures/20230406184103_successful_migration.ts

@@ -1,4 +1,4 @@
-import { makeBatchedMigration } from '../batched-migration';
+import { makeBatchedMigration } from '../batched-migration.js';
 
 export default makeBatchedMigration({
   async getParameters() {

package/src/batched-migrations/fixtures/{20230406184107_failing_migration.js → 20230406184107_failing_migration.ts}

@@ -1,7 +1,6 @@
-// @ts-check
-const { makeBatchedMigration } = require('../batched-migration');
+import { makeBatchedMigration } from '../batched-migration.js';
 
-module.exports = makeBatchedMigration({
+export default makeBatchedMigration({
   async getParameters() {
     return {
       min: 2n,

package/src/batched-migrations/fixtures/20230407230446_no_rows_migration.ts

@@ -1,4 +1,4 @@
-import { makeBatchedMigration } from '../batched-migration';
+import { makeBatchedMigration } from '../batched-migration.js';
 
 export default makeBatchedMigration({
   async getParameters() {

package/src/batched-migrations/index.ts

@@ -1,21 +1,21 @@
 export {
-  BatchedMigrationRow,
-  BatchedMigrationStatus,
+  type BatchedMigrationRow,
+  type BatchedMigrationStatus,
   makeBatchedMigration,
   selectAllBatchedMigrations,
   selectBatchedMigration,
   selectBatchedMigrationForTimestamp,
   retryFailedBatchedMigrationJobs,
-} from './batched-migration';
+} from './batched-migration.js';
 export {
-  BatchedMigrationJobRow,
-  BatchedMigrationJobStatus,
+  type BatchedMigrationJobRow,
+  type BatchedMigrationJobStatus,
   selectRecentJobsWithStatus,
-} from './batched-migration-job';
+} from './batched-migration-job.js';
 export {
   initBatchedMigrations,
   startBatchedMigrations,
   stopBatchedMigrations,
   enqueueBatchedMigration,
   finalizeBatchedMigration,
-} from './batched-migrations-runner';
+} from './batched-migrations-runner.js';

package/src/index.ts

@@ -1,12 +1,12 @@
 import path from 'path';
 
-export { init } from './migrations';
+export { init } from './migrations/index.js';
 
 export {
-  BatchedMigrationRow,
-  BatchedMigrationStatus,
-  BatchedMigrationJobRow,
-  BatchedMigrationJobStatus,
+  type BatchedMigrationRow,
+  type BatchedMigrationStatus,
+  type BatchedMigrationJobRow,
+  type BatchedMigrationJobStatus,
   makeBatchedMigration,
   initBatchedMigrations,
   startBatchedMigrations,
@@ -18,6 +18,6 @@ export {
   selectBatchedMigrationForTimestamp,
   selectRecentJobsWithStatus,
   retryFailedBatchedMigrationJobs,
-} from './batched-migrations';
+} from './batched-migrations/index.js';
 
-export const SCHEMA_MIGRATIONS_PATH = path.resolve(__dirname, '..', 'schema-migrations');
+export const SCHEMA_MIGRATIONS_PATH = path.resolve(import.meta.dirname, '..', 'schema-migrations');

package/src/load-migrations.test.ts

@@ -1,16 +1,17 @@
-import chai, { assert } from 'chai';
-import chaiAsPromised from 'chai-as-promised';
 import path from 'path';
-import tmp from 'tmp-promise';
+
+import { use as chaiUse, assert } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
 import fs from 'fs-extra';
+import tmp from 'tmp-promise';
 
 import {
   parseAnnotations,
   readAndValidateMigrationsFromDirectory,
   sortMigrationFiles,
-} from './load-migrations';
+} from './load-migrations.js';
 
-chai.use(chaiAsPromised);
+chaiUse(chaiAsPromised);
 
 async function withMigrationFiles(files: string[], fn: (tmpDir: string) => Promise<void>) {
   await tmp.withDir(

package/src/migrations/index.ts

@@ -1 +1 @@
-export { init } from './migrations';
+export { init } from './migrations.js';