emigrate/packages/cli/src/commands/up.test.ts

import { describe, it, mock, type Mock } from 'node:test';
import assert from 'node:assert';
import path from 'node:path';
import {
  type EmigrateReporter,
  type MigrationHistoryEntry,
  type MigrationMetadata,
  type Storage,
  type Plugin,
  type SerializedError,
  type FailedMigrationHistoryEntry,
  type NonFailedMigrationHistoryEntry,
  type MigrationMetadataFinished,
} from '@emigrate/types';
import { deserializeError } from 'serialize-error';
import { version } from '../get-package-info.js';
import { BadOptionError, MigrationHistoryError, MigrationRunError, StorageInitError } from '../errors.js';
import upCommand from './up.js';

type Mocked<T> = {
  // @ts-expect-error - This is a mock
  [K in keyof T]: Mock<T[K]>;
};

describe('up', () => {
  it("returns 1 and finishes with an error when the storage couldn't be initialized", async () => {
    const { reporter, run } = getUpCommand(['some_migration.js']);

    const exitCode = await run();

    assert.strictEqual(exitCode, 1, 'Exit code');
    assertPreconditionsFailed({ dry: false }, reporter, StorageInitError.fromError(new Error('No storage configured')));
  });

  it('returns 0 and finishes without an error when there are no migrations to run', async () => {
    const { reporter, run } = getUpCommand([], getStorage([]));

    const exitCode = await run();

    assert.strictEqual(exitCode, 0, 'Exit code');
    assertPreconditionsFulfilled({ dry: false }, reporter, []);
  });

  it('returns 0 and finishes without an error when all migrations have already been run', async () => {
    const { reporter, run } = getUpCommand(['my_migration.js'], getStorage(['my_migration.js']));

    const exitCode = await run();

    assert.strictEqual(exitCode, 0, 'Exit code');
    assertPreconditionsFulfilled({ dry: false }, reporter, []);
  });

  it('returns 0 and finishes without an error when all migrations have already been run even when the history responds without file extensions', async () => {
    const { reporter, run } = getUpCommand(['my_migration.js'], getStorage(['my_migration']));

    const exitCode = await run();

    assert.strictEqual(exitCode, 0, 'Exit code');
    assertPreconditionsFulfilled({ dry: false }, reporter, []);
  });

  it('returns 0 and finishes without an error when all pending migrations are run successfully', async () => {
    const migration = mock.fn(async () => {
      // Success
    });
    const { reporter, run } = getUpCommand(
      ['some_already_run_migration.js', 'some_migration.js', 'some_other_migration.js'],
      getStorage(['some_already_run_migration.js']),
      [
        {
          loadableExtensions: ['.js'],
          async loadMigration() {
            return migration;
          },
        },
      ],
    );

    const exitCode = await run();

    assert.strictEqual(exitCode, 0, 'Exit code');
    assertPreconditionsFulfilled({ dry: false }, reporter, [
      { name: 'some_migration.js', status: 'done', started: true },
      { name: 'some_other_migration.js', status: 'done', started: true },
    ]);
    assert.strictEqual(migration.mock.calls.length, 2);
  });

  it('returns 1 and finishes with an error when a pending migration throw when run', async () => {
    const { reporter, run } = getUpCommand(
      ['some_already_run_migration.js', 'some_migration.js', 'fail.js', 'some_other_migration.js'],
      getStorage(['some_already_run_migration.js']),
      [
        {
          loadableExtensions: ['.js'],
          async loadMigration(migration) {
            return async () => {
              if (migration.name === 'fail.js') {
                throw new Error('Oh noes!');
              }
            };
          },
        },
      ],
    );

    const exitCode = await run();

    assert.strictEqual(exitCode, 1, 'Exit code');
    assertPreconditionsFulfilled(
      { dry: false },
      reporter,
      [
        { name: 'some_migration.js', status: 'done', started: true },
        { name: 'fail.js', status: 'failed', started: true, error: new Error('Oh noes!') },
        { name: 'some_other_migration.js', status: 'skipped' },
      ],
      new MigrationRunError('Failed to run migration: migrations/fail.js', { cause: new Error('Oh noes!') }),
    );
  });

  describe('each migration file extension needs a corresponding loader plugin', () => {
    it('returns 1 and finishes with an error when there are migration file extensions without a corresponding loader plugin', async () => {
      const { reporter, run } = getUpCommand(['some_other.js', 'some_file.sql'], getStorage([]));

      const exitCode = await run();

      assert.strictEqual(exitCode, 1, 'Exit code');
      assertPreconditionsFulfilled(
        { dry: false },
        reporter,
        [
          { name: 'some_other.js', status: 'skipped' },
          {
            name: 'some_file.sql',
            status: 'failed',
            error: BadOptionError.fromOption('plugin', 'No loader plugin found for file extension: .sql'),
          },
        ],
        BadOptionError.fromOption('plugin', 'No loader plugin found for file extension: .sql'),
      );
    });

    it('returns 1 and finishes with an error when there are migration file extensions without a corresponding loader plugin in dry-run mode as well', async () => {
      const { reporter, run } = getUpCommand(['some_other.js', 'some_file.sql'], getStorage([]));

      const exitCode = await run({ dry: true });

      assert.strictEqual(exitCode, 1, 'Exit code');
      assertPreconditionsFulfilled(
        { dry: true },
        reporter,
        [
          { name: 'some_other.js', status: 'skipped' },
          {
            name: 'some_file.sql',
            status: 'failed',
            error: BadOptionError.fromOption('plugin', 'No loader plugin found for file extension: .sql'),
          },
        ],
        BadOptionError.fromOption('plugin', 'No loader plugin found for file extension: .sql'),
      );
    });
  });

  describe('failed migrations in the history are blocking', () => {
    it('returns 1 and finishes with an error when there are failed migrations in the history', async () => {
      const failedEntry = toEntry('some_failed_migration.js', 'failed');
      const { reporter, run } = getUpCommand([failedEntry.name, 'some_file.js'], getStorage([failedEntry]));

      const exitCode = await run();

      assert.strictEqual(exitCode, 1, 'Exit code');
      assertPreconditionsFulfilled(
        { dry: false },
        reporter,
        [
          {
            name: 'some_failed_migration.js',
            status: 'failed',
            error: new MigrationHistoryError(
              'Migration some_failed_migration.js is in a failed state, it should be fixed and removed',
              { cause: failedEntry.error },
            ),
          },
          { name: 'some_file.js', status: 'skipped' },
        ],
        new MigrationHistoryError(
          'Migration some_failed_migration.js is in a failed state, it should be fixed and removed',
          { cause: failedEntry.error },
        ),
      );
    });

    it('returns 1 and finishes with an error when there are failed migrations in the history in dry-run mode as well', async () => {
      const failedEntry = toEntry('some_failed_migration.js', 'failed');
      const { reporter, run } = getUpCommand([failedEntry.name, 'some_file.js'], getStorage([failedEntry]));

      const exitCode = await run({ dry: true });

      assert.strictEqual(exitCode, 1, 'Exit code');
      assertPreconditionsFulfilled(
        { dry: true },
        reporter,
        [
          {
            name: 'some_failed_migration.js',
            status: 'failed',
            error: new MigrationHistoryError(
              'Migration some_failed_migration.js is in a failed state, it should be fixed and removed',
              { cause: failedEntry.error },
            ),
          },
          { name: 'some_file.js', status: 'skipped' },
        ],
        new MigrationHistoryError(
          'Migration some_failed_migration.js is in a failed state, it should be fixed and removed',
          { cause: failedEntry.error },
        ),
      );
    });

    it('returns 0 and finishes without an error when the failed migrations in the history are not part of the current set of migrations', async () => {
      const failedEntry = toEntry('some_failed_migration.js', 'failed');
      const { reporter, run } = getUpCommand([], getStorage([failedEntry]));

      const exitCode = await run();

      assert.strictEqual(exitCode, 0, 'Exit code');
      assertPreconditionsFulfilled({ dry: false }, reporter, []);
    });
  });

  it('returns 0 and finishes without an error when the given number of pending migrations are run successfully', async () => {
    const migration = mock.fn(async () => {
      // Success
    });
    const { reporter, run } = getUpCommand(
      ['some_already_run_migration.js', 'some_migration.js', 'some_other_migration.js'],
      getStorage(['some_already_run_migration.js']),
      [
        {
          loadableExtensions: ['.js'],
          async loadMigration() {
            return migration;
          },
        },
      ],
    );

    const exitCode = await run({ limit: 1 });

    assert.strictEqual(exitCode, 0, 'Exit code');
    assertPreconditionsFulfilled({ dry: false }, reporter, [
      { name: 'some_migration.js', status: 'done', started: true },
      { name: 'some_other_migration.js', status: 'skipped' },
    ]);
    assert.strictEqual(migration.mock.calls.length, 1);
  });

  describe('limiting which pending migrations to run', () => {
    it('returns 0 and finishes without an error with the given number of pending migrations are validated and listed successfully in dry-mode', async () => {
      const { reporter, run } = getUpCommand(
        ['some_already_run_migration.js', 'some_migration.js', 'some_other_migration.js'],
        getStorage(['some_already_run_migration.js']),
      );

      const exitCode = await run({ dry: true, limit: 1 });

      assert.strictEqual(exitCode, 0, 'Exit code');
      assertPreconditionsFulfilled({ dry: true }, reporter, [
        { name: 'some_migration.js', status: 'pending' },
        { name: 'some_other_migration.js', status: 'skipped' },
      ]);
    });

    it('returns 0 and finishes without an error when pending migrations after given "from" parameter are run successfully, even when the "from" is not an existing migration', async () => {
      const migration = mock.fn(async () => {
        // Success
      });
      const { reporter, run } = getUpCommand(
        ['1_some_already_run_migration.js', '2_some_migration.js', '4_some_other_migration.js'],
        getStorage(['1_some_already_run_migration.js']),
        [
          {
            loadableExtensions: ['.js'],
            async loadMigration() {
              return migration;
            },
          },
        ],
      );

      const exitCode = await run({ from: '3_non_existing_migration.js' });

      assert.strictEqual(exitCode, 0, 'Exit code');
      assertPreconditionsFulfilled({ dry: false }, reporter, [
        { name: '2_some_migration.js', status: 'skipped' },
        { name: '4_some_other_migration.js', status: 'done', started: true },
      ]);
      assert.strictEqual(migration.mock.calls.length, 1);
    });

    it('returns 0 and finishes without an error when pending migrations after given "from" parameter are validated and listed successfully in dry-mode, even when the "from" is not an existing migration', async () => {
      const { reporter, run } = getUpCommand(
        ['1_some_already_run_migration.js', '2_some_migration.js', '4_some_other_migration.js'],
        getStorage(['1_some_already_run_migration.js']),
      );

      const exitCode = await run({ dry: true, from: '3_non_existing_migration.js' });

      assert.strictEqual(exitCode, 0, 'Exit code');
      assertPreconditionsFulfilled({ dry: true }, reporter, [
        { name: '2_some_migration.js', status: 'skipped' },
        { name: '4_some_other_migration.js', status: 'pending' },
      ]);
    });

    it('returns 0 and finishes without an error when pending migrations before given "to" parameter are run successfully, even when the "to" is not an existing migration', async () => {
      const migration = mock.fn(async () => {
        // Success
      });
      const { reporter, run } = getUpCommand(
        ['1_some_already_run_migration.js', '2_some_migration.js', '4_some_other_migration.js'],
        getStorage(['1_some_already_run_migration.js']),
        [
          {
            loadableExtensions: ['.js'],
            async loadMigration() {
              return migration;
            },
          },
        ],
      );

      const exitCode = await run({ to: '3_non_existing_migration.js' });

      assert.strictEqual(exitCode, 0, 'Exit code');
      assertPreconditionsFulfilled({ dry: false }, reporter, [
        { name: '2_some_migration.js', status: 'done', started: true },
        { name: '4_some_other_migration.js', status: 'skipped' },
      ]);
      assert.strictEqual(migration.mock.calls.length, 1);
    });

    it('returns 0 and finishes without an error when pending migrations after given "to" parameter are validated and listed successfully in dry-mode, even when the "to" is not an existing migration', async () => {
      const { reporter, run } = getUpCommand(
        ['1_some_already_run_migration.js', '2_some_migration.js', '4_some_other_migration.js'],
        getStorage(['1_some_already_run_migration.js']),
      );

      const exitCode = await run({ dry: true, to: '3_non_existing_migration.js' });

      assert.strictEqual(exitCode, 0, 'Exit code');
      assertPreconditionsFulfilled({ dry: true }, reporter, [
        { name: '2_some_migration.js', status: 'pending' },
        { name: '4_some_other_migration.js', status: 'skipped' },
      ]);
    });

    it('returns 0 and finishes without an error when the pending migrations fulfilling "from", "to" and "limit" are run successfully', async () => {
      const migration = mock.fn(async () => {
        // Success
      });
      const { reporter, run } = getUpCommand(
        [
          '1_some_already_run_migration.js',
          '2_some_migration.js',
          '3_another_migration.js',
          '4_some_other_migration.js',
          '5_yet_another_migration.js',
          '6_some_more_migration.js',
        ],
        getStorage(['1_some_already_run_migration.js']),
        [
          {
            loadableExtensions: ['.js'],
            async loadMigration() {
              return migration;
            },
          },
        ],
      );

      const exitCode = await run({ from: '3_another_migration.js', to: '5_yet_another_migration.js', limit: 2 });

      assert.strictEqual(exitCode, 0, 'Exit code');
      assertPreconditionsFulfilled({ dry: false }, reporter, [
        { name: '2_some_migration.js', status: 'skipped' },
        { name: '3_another_migration.js', status: 'done', started: true },
        { name: '4_some_other_migration.js', status: 'done', started: true },
        { name: '5_yet_another_migration.js', status: 'skipped' },
        { name: '6_some_more_migration.js', status: 'skipped' },
      ]);
      assert.strictEqual(migration.mock.calls.length, 2);
    });
  });

  describe('marking migrations as successful without running them', () => {
    it('returns 0 and finishes without an error when the pending migrations have been marked as successful without executing them', async () => {
      const migration = mock.fn(async () => {
        // Success
      });
      const { reporter, run } = getUpCommand(
        [
          '1_some_already_run_migration.js',
          '2_some_migration.js',
          '3_another_migration.js',
          '4_some_other_migration.js',
          '5_yet_another_migration.js',
          '6_some_more_migration.js',
        ],
        getStorage(['1_some_already_run_migration.js']),
        [
          {
            loadableExtensions: ['.js'],
            async loadMigration() {
              return migration;
            },
          },
        ],
      );

      const exitCode = await run({
        from: '3_another_migration.js',
        to: '5_yet_another_migration.js',
        limit: 2,
        noExecution: true,
      });

      assert.strictEqual(exitCode, 0, 'Exit code');
      assertPreconditionsFulfilled({ dry: false }, reporter, [
        { name: '2_some_migration.js', status: 'skipped' },
        { name: '3_another_migration.js', status: 'done', started: true },
        { name: '4_some_other_migration.js', status: 'done', started: true },
        { name: '5_yet_another_migration.js', status: 'skipped' },
        { name: '6_some_more_migration.js', status: 'skipped' },
      ]);
      assert.strictEqual(migration.mock.calls.length, 0);
    });
  });

  it('returns 0 and finishes without an error when the pending migrations have been marked as successful without executing them even though they have no corresponding loader', async () => {
    const migration = mock.fn(async () => {
      // Success
    });
    const { reporter, run } = getUpCommand(
      [
        '1_some_already_run_migration.js',
        '2_some_migration.js',
        '3_another_migration.js',
        '4_some_other_migration.sql',
        '5_yet_another_migration.js',
        '6_some_more_migration.js',
      ],
      getStorage(['1_some_already_run_migration.js']),
      [
        {
          loadableExtensions: ['.js'],
          async loadMigration() {
            return migration;
          },
        },
      ],
    );

    const exitCode = await run({
      from: '3_another_migration.js',
      to: '5_yet_another_migration.js',
      limit: 2,
      noExecution: true,
    });

    assert.strictEqual(exitCode, 0, 'Exit code');
    assertPreconditionsFulfilled({ dry: false }, reporter, [
      { name: '2_some_migration.js', status: 'skipped' },
      { name: '3_another_migration.js', status: 'done', started: true },
      { name: '4_some_other_migration.sql', status: 'done', started: true },
      { name: '5_yet_another_migration.js', status: 'skipped' },
      { name: '6_some_more_migration.js', status: 'skipped' },
    ]);
    assert.strictEqual(migration.mock.calls.length, 0);
  });
});

function getErrorCause(error: Error | undefined): Error | SerializedError | undefined {
  if (error?.cause instanceof Error) {
    return error.cause;
  }

  if (typeof error?.cause === 'object' && error.cause !== null) {
    return error.cause as unknown as SerializedError;
  }

  return undefined;
}

function toMigration(cwd: string, directory: string, name: string): MigrationMetadata {
  return {
    name,
    filePath: `${cwd}/${directory}/${name}`,
    relativeFilePath: `${directory}/${name}`,
    extension: path.extname(name),
    directory,
    cwd,
  };
}

function toMigrations(cwd: string, directory: string, names: string[]): MigrationMetadata[] {
  return names.map((name) => toMigration(cwd, directory, name));
}

function toEntry(name: MigrationHistoryEntry): MigrationHistoryEntry;
function toEntry<S extends MigrationHistoryEntry['status']>(
  name: string,
  status?: S,
): S extends 'failed' ? FailedMigrationHistoryEntry : NonFailedMigrationHistoryEntry;

function toEntry(name: string | MigrationHistoryEntry, status?: 'done' | 'failed'): MigrationHistoryEntry {
  if (typeof name !== 'string') {
    return name.status === 'failed' ? name : name;
  }

  if (status === 'failed') {
    return {
      name,
      status,
      date: new Date(),
      error: { name: 'Error', message: 'Failed' },
    };
  }

  return {
    name,
    status: status ?? 'done',
    date: new Date(),
  };
}

function toEntries(
  names: Array<string | MigrationHistoryEntry>,
  status?: MigrationHistoryEntry['status'],
): MigrationHistoryEntry[] {
  return names.map((name) => (typeof name === 'string' ? toEntry(name, status) : name));
}

async function noop() {
  // noop
}

function getStorage(historyEntries: Array<string | MigrationHistoryEntry>) {
  const storage: Mocked<Storage> = {
    lock: mock.fn(async (migrations) => migrations),
    unlock: mock.fn(async () => {
      // void
    }),
    getHistory: mock.fn(async function* () {
      yield* toEntries(historyEntries);
    }),
    remove: mock.fn(),
    onSuccess: mock.fn(),
    onError: mock.fn(),
    end: mock.fn(),
  };

  return storage;
}

function getUpCommand(migrationFiles: string[], storage?: Mocked<Storage>, plugins?: Plugin[]) {
  const reporter: Mocked<Required<EmigrateReporter>> = {
    onFinished: mock.fn(noop),
    onInit: mock.fn(noop),
    onCollectedMigrations: mock.fn(noop),
    onLockedMigrations: mock.fn(noop),
    onNewMigration: mock.fn(noop),
    onMigrationRemoveStart: mock.fn(noop),
    onMigrationRemoveSuccess: mock.fn(noop),
    onMigrationRemoveError: mock.fn(noop),
    onMigrationStart: mock.fn(noop),
    onMigrationSuccess: mock.fn(noop),
    onMigrationError: mock.fn(noop),
    onMigrationSkip: mock.fn(noop),
  };

  const run = async (
    options?: Omit<
      Parameters<typeof upCommand>[0],
      'cwd' | 'directory' | 'storage' | 'reporter' | 'plugins' | 'getMigrations'
    >,
  ) => {
    return upCommand({
      cwd: '/emigrate',
      directory: 'migrations',
      storage: {
        async initializeStorage() {
          if (!storage) {
            throw new Error('No storage configured');
          }

          return storage;
        },
      },
      reporter,
      plugins: plugins ?? [],
      async getMigrations(cwd, directory) {
        return toMigrations(cwd, directory, migrationFiles);
      },
      ...options,
    });
  };

  return {
    reporter,
    storage,
    run,
  };
}

function assertPreconditionsFulfilled(
  options: { dry: boolean },
  reporter: Mocked<Required<EmigrateReporter>>,
  expected: Array<{ name: string; status: MigrationMetadataFinished['status']; started?: boolean; error?: Error }>,
  finishedError?: Error,
) {
  assert.strictEqual(reporter.onInit.mock.calls.length, 1);
  assert.deepStrictEqual(reporter.onInit.mock.calls[0]?.arguments, [
    {
      command: 'up',
      cwd: '/emigrate',
      version,
      dry: options.dry,
      color: undefined,
      directory: 'migrations',
    },
  ]);

  let started = 0;
  let done = 0;
  let failed = 0;
  let skipped = 0;
  let pending = 0;
  const failedEntries: typeof expected = [];

  for (const entry of expected) {
    if (entry.started) {
      started++;
    }

    // eslint-disable-next-line default-case
    switch (entry.status) {
      case 'done': {
        done++;
        break;
      }

      case 'failed': {
        failed++;
        failedEntries.push(entry);
        break;
      }

      case 'skipped': {
        skipped++;
        break;
      }

      case 'pending': {
        pending++;
        break;
      }
    }
  }

  assert.strictEqual(reporter.onCollectedMigrations.mock.calls.length, 1, 'Collected call');
  assert.strictEqual(reporter.onLockedMigrations.mock.calls.length, 1, 'Locked call');
  assert.strictEqual(reporter.onMigrationStart.mock.calls.length, started, 'Started migrations');
  assert.strictEqual(reporter.onMigrationSuccess.mock.calls.length, done, 'Successful migrations');
  assert.strictEqual(reporter.onMigrationError.mock.calls.length, failed, 'Failed migrations');

  for (const [index, entry] of failedEntries.entries()) {
    if (entry.status === 'failed') {
      const error = reporter.onMigrationError.mock.calls[index]?.arguments[1];
      assert.deepStrictEqual(error, entry.error, 'Error');
      const cause = entry.error?.cause;
      assert.deepStrictEqual(error?.cause, cause ? deserializeError(cause) : cause, 'Error cause');
    }
  }

  assert.strictEqual(reporter.onMigrationSkip.mock.calls.length, pending + skipped, 'Total pending and skipped');
  assert.strictEqual(reporter.onFinished.mock.calls.length, 1, 'Finished called once');
  const [entries, error] = reporter.onFinished.mock.calls[0]?.arguments ?? [];
  assert.deepStrictEqual(error, finishedError, 'Finished error');
  const cause = getErrorCause(error);
  const expectedCause = finishedError?.cause;
  assert.deepStrictEqual(
    cause,
    expectedCause ? deserializeError(expectedCause) : expectedCause,
    'Finished error cause',
  );
  assert.strictEqual(entries?.length, expected.length, 'Finished entries length');
  assert.deepStrictEqual(
    entries.map((entry) => `${entry.name} (${entry.status})`),
    expected.map((entry) => `${entry.name} (${entry.status})`),
    'Finished entries',
  );
}

function assertPreconditionsFailed(
  options: { dry: boolean },
  reporter: Mocked<Required<EmigrateReporter>>,
  finishedError?: Error,
) {
  assert.strictEqual(reporter.onInit.mock.calls.length, 1);
  assert.deepStrictEqual(reporter.onInit.mock.calls[0]?.arguments, [
    {
      command: 'up',
      cwd: '/emigrate',
      version,
      dry: options.dry,
      color: undefined,
      directory: 'migrations',
    },
  ]);
  assert.strictEqual(reporter.onCollectedMigrations.mock.calls.length, 0, 'Collected call');
  assert.strictEqual(reporter.onLockedMigrations.mock.calls.length, 0, 'Locked call');
  assert.strictEqual(reporter.onMigrationStart.mock.calls.length, 0, 'Started migrations');
  assert.strictEqual(reporter.onMigrationSuccess.mock.calls.length, 0, 'Successful migrations');
  assert.strictEqual(reporter.onMigrationError.mock.calls.length, 0, 'Failed migrations');
  assert.strictEqual(reporter.onMigrationSkip.mock.calls.length, 0, 'Total pending and skipped');
  assert.strictEqual(reporter.onFinished.mock.calls.length, 1, 'Finished called once');
  const [entries, error] = reporter.onFinished.mock.calls[0]?.arguments ?? [];
  assert.deepStrictEqual(error, finishedError, 'Finished error');
  const cause = getErrorCause(error);
  const expectedCause = finishedError?.cause;
  assert.deepStrictEqual(
    cause,
    expectedCause ? deserializeError(expectedCause) : expectedCause,
    'Finished error cause',
  );
  assert.strictEqual(entries?.length, 0, 'Finished entries length');
}