stepwise-migrations 1.0.14 → 1.0.15

package/src/utils.ts

@@ -1,6 +1,11 @@
 import fs from "fs/promises";
 import path from "path";
-import { MigrationRow } from "./types";
+import {
+  AppliedMigration,
+  MigrationFile,
+  MigrationState,
+  MigrationType,
+} from "./types";
 
 export const usage = `
 Usage: stepwise-migrations [command] [options]
@@ -20,13 +25,13 @@ Options:
   --schema <schema>          The schema to use for the migrations
   --path <path>              The path to the migrations directory
   --ssl true/false           Whether to use SSL for the connection (default: false)
-  --nup                      Number of up migrations to apply (default: all)
-  --ndown                    Number of down migrations to apply (default: 1)
+  --napply                      Number of up migrations to apply (default: all)
+  --nundo                    Number of down migrations to apply (default: 1)
 
 Example:
-  npx stepwise-migrations migrate \
-    --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydatabase \
-    --schema=myschema \
+  npx stepwise-migrations migrate \\
+    --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydatabase \\
+    --schema=myschema \\
     --path=./db/migration/
 `;
 
@@ -47,67 +52,117 @@ export const validateArgs = (argv: any) => {
   }
 };
 
-export const readMigrationFiles = async (directory: string) => {
+export const filenameToType = (filename: string): MigrationType => {
+  if (filename.endsWith(".undo.sql")) {
+    return "undo";
+  } else if (filename.endsWith(".repeatable.sql")) {
+    return "repeatable";
+  }
+  return "versioned";
+};
+
+export const readMigrationFiles = async (
+  directory: string,
+  appliedVersionedMigrations: AppliedMigration[]
+) => {
+  let errors: string[] = [];
   const files = await fs.readdir(directory, { withFileTypes: true });
   const migrationFiles = files
-    .filter(
-      (file) =>
-        file.isFile() &&
-        file.name.endsWith(".sql") &&
-        !file.name.endsWith(".down.sql")
-    )
+    .filter((file) => file.isFile() && file.name.endsWith(".sql"))
     .map((file) => path.join(directory, file.name));
   migrationFiles.sort();
-  const results: {
-    type: "up";
-    fullFilePath: string;
-    filename: string;
-    script: string;
-  }[] = [];
-  for (const fullFilePath of migrationFiles) {
-    const script = await fs.readFile(fullFilePath, "utf8");
-
+  const results: MigrationFile[] = [];
+  for (const fullFileName of migrationFiles) {
+    const script = await fs.readFile(fullFileName, "utf8");
     results.push({
-      type: "up",
-      fullFilePath,
-      filename: path.basename(fullFilePath),
+      type: filenameToType(path.basename(fullFileName)),
+      filename: path.basename(fullFileName),
       script,
     });
   }
-  return results;
+
+  for (const appliedMigration of appliedVersionedMigrations) {
+    const file = results.find((f) => f.filename === appliedMigration.filename);
+    if (
+      file &&
+      file.type === "versioned" &&
+      file.script !== appliedMigration.script
+    ) {
+      errors.push(
+        `Versioned migration ${appliedMigration.filename} has been altered. Cannot migrate in current state.`
+      );
+    }
+  }
+
+  return { files: results, errors };
 };
 
 export const printMigrationHistoryAndUnappliedMigrations = (
-  migrationFiles: { filename: string }[],
-  migrationHistory: MigrationRow[]
+  state: MigrationState
 ) => {
-  console.log("Migration history:");
+  console.log("All applied versioned migrations:");
   console.table(
-    migrationHistory.map((h) => ({
+    state.current.appliedVersionedMigrations.map((h) => ({
       id: h.id,
-      name: h.name,
+      type: h.type,
+      filename: h.filename,
       applied_by: h.applied_by,
       applied_at: h.applied_at,
     }))
   );
-  console.log("Unapplied migrations:");
+  if (state.current.appliedRepeatableMigrations.length > 0) {
+    console.log("All applied repeatable migrations:");
+    console.table(
+      state.current.appliedRepeatableMigrations.map((h) => ({
+        id: h.id,
+        type: h.type,
+        filename: h.filename,
+        applied_by: h.applied_by,
+        applied_at: h.applied_at,
+      }))
+    );
+  }
+  console.log("Unapplied versioned migrations:");
   console.table(
-    migrationFiles.slice(migrationHistory.length).map((m) => ({
-      filename: m.filename,
+    state.files.unappliedVersionedFiles.map((h) => ({
+      type: h.type,
+      filename: h.filename,
     }))
   );
+  if (state.files.unappliedRepeatableFiles.length > 0) {
+    console.log("Unapplied repeatable migrations:");
+    console.table(
+      state.files.unappliedRepeatableFiles.map((h) => ({
+        type: h.type,
+        filename: h.filename,
+      }))
+    );
+  }
 };
 
-export const printMigrationHistory = (migrationHistory: MigrationRow[]) => {
-  console.log("Migration history:");
+export const printMigrationHistory = (state: MigrationState) => {
+  console.log("All applied versioned migrations:");
   console.table(
-    migrationHistory.map((h) => ({
+    state.current.appliedVersionedMigrations.map((h) => ({
       id: h.id,
-      name: h.name,
+      type: h.type,
+      filename: h.filename,
       applied_by: h.applied_by,
       applied_at: h.applied_at,
     }))
   );
+  if (state.current.appliedRepeatableMigrations.length > 0) {
+    console.log("All applied repeatable migrations:");
+    console.table(
+      state.current.appliedRepeatableMigrations.map((h) => ({
+        id: h.id,
+        type: h.type,
+        filename: h.filename,
+        applied_by: h.applied_by,
+        applied_at: h.applied_at,
+      }))
+    );
+  }
 };
 
 export const fileExists = async (path: string) => {
@@ -118,35 +173,36 @@ export const fileExists = async (path: string) => {
   }
 };
 
-export const readDownMigrationFiles = async (
-  directory: string,
-  migrationHistory: MigrationRow[]
+export const abortIfErrors = (state: MigrationState) => {
+  if (state.errors.length > 0) {
+    console.error(
+      `There were errors loading the migration state. Please fix the errors and try again.`
+    );
+    console.error(state.errors.map((e) => "  - " + e).join("\n"));
+    process.exit(1);
+  }
+};
+
+export const exitIfNotInitialized = (
+  schemaExists: boolean,
+  tableExists: boolean
 ) => {
-  const results: {
-    type: "down";
-    fullFilePath: string;
-    filename: string;
-    upFilename: string;
-
-    script: string;
-  }[] = [];
-  for (const migration of migrationHistory) {
-    const fullFilePath = path.join(
-      directory,
-      `${migration.name.split(".sql")[0]}.down.sql`
+  if (!schemaExists) {
+    console.log("Schema does not exist. Run migrate to begin.");
+    process.exit(1);
+  }
+
+  if (!tableExists) {
+    console.log(
+      "Migration table has not been initialised. Run migrate to begin."
     );
-    if (!(await fileExists(fullFilePath))) {
-      console.error(`Down migration file not found: ${fullFilePath}`);
-      process.exit(1);
-    }
-    const script = await fs.readFile(fullFilePath, "utf8");
-    results.push({
-      type: "down",
-      fullFilePath,
-      filename: path.basename(fullFilePath),
-      upFilename: migration.name,
-      script,
-    });
+    process.exit(1);
   }
-  return results;
+};
+
+export const sliceFromFirstNull = <T>(array: (T | undefined)[]): T[] => {
+  const indexOfFirstNull = array.findIndex((x) => x == null);
+  return indexOfFirstNull < 0
+    ? (array as T[])
+    : (array.slice(0, indexOfFirstNull) as T[]);
 };

package/test/index.test.ts

@@ -0,0 +1,166 @@
+import assert from "node:assert";
+import fs from "node:fs";
+import { beforeEach, describe, it } from "node:test";
+import { assertIncludesAll, assertIncludesExcludesAll, execute } from "./utils";
+const connection = "postgresql://postgres:postgres@127.0.0.1:5432/stepwise-db";
+const schema = "stepwise";
+
+const paths = {
+  valid: "./test/migrations-valid",
+  invalid: "./test/migrations-invalid",
+};
+
+const executeCommand = (
+  command: string,
+  path: string = "",
+  extraArgs: string = ""
+) =>
+  execute(`npm exec stepwise-migrations ${command} -- \\
+    --connection=${connection} \\
+    --schema=${schema} \\
+    --path=${path} ${extraArgs}
+  `);
+
+describe("valid migrations", async () => {
+  beforeEach(async () => {
+    const { output, error, exitCode } = await executeCommand("drop", "");
+    assert.ok(
+      output.includes(
+        "Dropping the tables, schema and migration history table... done!"
+      )
+    );
+    assert.ok(exitCode === 0);
+
+    fs.rmSync(paths.valid, { recursive: true, force: true });
+    fs.cpSync("./test/migrations-template", paths.valid, {
+      recursive: true,
+    });
+  });
+
+  it("migrate without params", async () => {
+    assertIncludesAll(await execute("npm exec stepwise-migrations"), ["Usage"]);
+  });
+
+  it("migrate one versioned and undo, redo, undo", async () => {
+    assertIncludesAll(await executeCommand("migrate", paths.valid), [
+      "All done! Applied 4 migrations",
+    ]);
+    assertIncludesAll(await executeCommand("status"), [
+      "v0_get_number.repeatable.sql",
+      "v1_first.sql",
+      "v2_second.sql",
+      "v3_third.sql",
+    ]);
+
+    assertIncludesAll(await executeCommand("undo", paths.valid), [
+      "All done! Performed 1 undo migration",
+    ]);
+    assertIncludesExcludesAll(
+      await executeCommand("status"),
+      ["v0_get_number.repeatable.sql", "v1_first.sql", "v2_second.sql"],
+      ["v3_third.sql"]
+    );
+
+    assertIncludesAll(await executeCommand("migrate", paths.valid), [
+      "All done! Applied 1 migration",
+    ]);
+    assertIncludesAll(await executeCommand("status"), [
+      "v0_get_number.repeatable.sql",
+      "v1_first.sql",
+      "v2_second.sql",
+      "v3_third.sql",
+    ]);
+
+    assertIncludesAll(await executeCommand("undo", paths.valid, "--nundo=2"), [
+      "All done! Performed 2 undo migrations",
+    ]);
+    assertIncludesExcludesAll(
+      await executeCommand("status"),
+      ["v0_get_number.repeatable.sql", "v1_first.sql"],
+      ["v2_second.sql", "v3_third.sql"]
+    );
+
+    assertIncludesAll(await executeCommand("migrate", paths.valid), [
+      "All done! Applied 2 migrations",
+    ]);
+    assertIncludesAll(await executeCommand("status"), [
+      "v0_get_number.repeatable.sql",
+      "v1_first.sql",
+      "v2_second.sql",
+      "v3_third.sql",
+    ]);
+  });
+
+  it("migrate with altered repeatable migration", async () => {
+    assertIncludesAll(await executeCommand("migrate", paths.valid), [
+      "All done! Applied 4 migrations",
+    ]);
+    assertIncludesAll(await executeCommand("status"), [
+      "v0_get_number.repeatable.sql",
+      "v1_first.sql",
+      "v2_second.sql",
+      "v3_third.sql",
+    ]);
+
+    fs.writeFileSync(
+      "./test/migrations-valid/v0_get_number.repeatable.sql",
+      `
+      CREATE OR REPLACE FUNCTION get_number()
+      RETURNS integer AS $$
+      BEGIN
+          RETURN 2;
+      END; $$
+      LANGUAGE plpgsql;
+      `
+    );
+
+    assertIncludesAll(await executeCommand("migrate", paths.valid), [
+      "All done! Applied 1 migration",
+    ]);
+  });
+});
+
+describe.only("invalid migrations", async () => {
+  beforeEach(async () => {
+    const { output, error, exitCode } = await executeCommand("drop", "");
+    assert.ok(
+      output.includes(
+        "Dropping the tables, schema and migration history table... done!"
+      )
+    );
+    assert.ok(exitCode === 0);
+
+    fs.rmSync(paths.invalid, { recursive: true, force: true });
+    fs.cpSync("./test/migrations-template", paths.invalid, {
+      recursive: true,
+    });
+  });
+
+  it.only("missing undo migration", async () => {
+    assertIncludesAll(await executeCommand("migrate", paths.invalid), [
+      "All done!",
+    ]);
+
+    fs.unlinkSync("./test/migrations-invalid/v3_third.undo.sql");
+
+    assertIncludesAll(
+      await executeCommand("undo", paths.invalid, "--nundos=2"),
+      ["Error: not enough sequential (from last) undo migrations to apply"]
+    );
+  });
+
+  it("alter migration", async () => {
+    assertIncludesAll(await executeCommand("migrate", paths.invalid), [
+      "All done!",
+    ]);
+
+    fs.writeFileSync(
+      "./test/migrations-invalid/v1_first.sql",
+      "ALTER TABLE test ADD COLUMN test_column TEXT;"
+    );
+
+    assertIncludesAll(await executeCommand("migrate", paths.invalid), [
+      "Versioned migration v1_first.sql has been altered. Cannot migrate in current state.",
+    ]);
+  });
+});

package/test/migrations-invalid/v0_get_number.repeatable.sql

@@ -0,0 +1,6 @@
+CREATE OR REPLACE FUNCTION get_number()
+RETURNS integer AS $$
+BEGIN
+    RETURN 1;
+END; $$
+LANGUAGE plpgsql;

package/test/migrations-invalid/v1_first.sql

@@ -0,0 +1 @@
+ALTER TABLE test ADD COLUMN test_column TEXT;

package/test/migrations-invalid/v2_second.sql

@@ -0,0 +1,4 @@
+create table second (
+  id serial primary key,
+  name text not null
+);

package/test/migrations-invalid/v2_second.undo.sql

@@ -0,0 +1 @@
+drop table second;

package/test/migrations-invalid/v3_third.sql

@@ -0,0 +1,4 @@
+create table third (
+  id serial primary key,
+  name text not null
+);

package/test/migrations-invalid/v3_third.undo.sql

@@ -0,0 +1 @@
+drop table third;

package/test/migrations-template/v0_get_number.repeatable.sql

@@ -0,0 +1,6 @@
+CREATE OR REPLACE FUNCTION get_number()
+RETURNS integer AS $$
+BEGIN
+    RETURN 1;
+END; $$
+LANGUAGE plpgsql;

package/test/migrations-template/v1_first.sql

@@ -0,0 +1,4 @@
+create table first (
+  id serial primary key,
+  name text not null
+);

package/test/migrations-template/v2_second.sql

@@ -0,0 +1,4 @@
+create table second (
+  id serial primary key,
+  name text not null
+);

package/test/migrations-template/v2_second.undo.sql

@@ -0,0 +1 @@
+drop table second;

package/test/migrations-template/v3_third.sql

@@ -0,0 +1,4 @@
+create table third (
+  id serial primary key,
+  name text not null
+);

package/test/migrations-template/v3_third.undo.sql

@@ -0,0 +1 @@
+drop table third;

package/test/migrations-valid/v0_get_number.repeatable.sql

@@ -0,0 +1,8 @@
+
+      CREATE OR REPLACE FUNCTION get_number()
+      RETURNS integer AS $$
+      BEGIN
+          RETURN 2;
+      END; $$
+      LANGUAGE plpgsql;
+      

package/test/migrations-valid/v1_first.sql

@@ -0,0 +1,4 @@
+create table first (
+  id serial primary key,
+  name text not null
+);

package/test/migrations-valid/v2_second.sql

@@ -0,0 +1,4 @@
+create table second (
+  id serial primary key,
+  name text not null
+);

package/test/migrations-valid/v2_second.undo.sql

@@ -0,0 +1 @@
+drop table second;

package/test/migrations-valid/v3_third.sql

@@ -0,0 +1,4 @@
+create table third (
+  id serial primary key,
+  name text not null
+);

package/test/migrations-valid/v3_third.undo.sql

@@ -0,0 +1 @@
+drop table third;

package/test/utils.ts

@@ -0,0 +1,69 @@
+import { exec } from "node:child_process";
+
+export const execute = (cmd: string) => {
+  const child = exec(cmd);
+  let scriptOutput = "";
+  let scriptError = "";
+
+  if (!child.stdout || !child.stderr) {
+    return { output: "", error: "", exitCode: 1 };
+  }
+
+  child.stdout.setEncoding("utf8");
+  child.stdout.on("data", (data) => {
+    scriptOutput += data.toString();
+  });
+
+  child.stderr.setEncoding("utf8");
+  child.stderr.on("data", (data) => {
+    scriptError += data.toString();
+  });
+
+  return new Promise((res, rej) =>
+    child.on("close", function (code) {
+      res({ output: scriptOutput, error: scriptError, exitCode: code ?? 1 });
+    })
+  ) as Promise<{ output: string; error: string; exitCode: number }>;
+};
+
+export const includesAll = (output: string, expected: string[]) =>
+  expected.every((x) => output.includes(x));
+
+export const excludesAll = (output: string, expected: string[]) =>
+  expected.every((x) => !output.includes(x));
+
+export const includesExcludesAll = (
+  output: string,
+  includes: string[],
+  excludes: string[]
+) => includesAll(output, includes) && excludesAll(output, excludes);
+
+export const assertIncludesAll = (
+  { output, error }: { output: string; error: string },
+  expected: string[]
+) => {
+  if (!includesAll(output + error, expected)) {
+    console.log(output);
+    console.error(error);
+    throw new Error(`Expected ${expected} to be in output.`);
+  }
+};
+export const assertExcludesAll = (
+  { output, error }: { output: string; error: string },
+  expected: string[]
+) => {
+  if (!excludesAll(output + error, expected)) {
+    console.log(output);
+    console.error(error);
+    throw new Error(`Expected ${expected} to be be excluded from output.`);
+  }
+};
+
+export const assertIncludesExcludesAll = (
+  { output, error }: { output: string; error: string },
+  includes: string[],
+  excludes: string[]
+) => {
+  assertIncludesAll({ output, error }, includes);
+  assertExcludesAll({ output, error }, excludes);
+};

package/tsconfig.json

@@ -26,7 +26,7 @@
 
     /* Modules */
     "module": "commonjs",                                /* Specify what module code is generated. */
-    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    "rootDir": "./",                                  /* Specify the root folder within your source files. */
     // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */