@storecraft/database-sql-base/migrate.js

Official SQL Database driver for storecraft

/**
 * @import { Database } from './types.sql.tables.js';
 * @import { SqlDialectType } from './types.public.js';
 * @import { Migration } from 'kysely';
 */

import { fileURLToPath, pathToFileURL } from "node:url";
import * as path from "path";
import { promises as fs } from "fs";
import {
  Migrator,
  Kysely,
} from "kysely";
import { SQL } from "./index.js";

// reusing the same provider for all migrations to avoid issues with dynamic imports and file URLs
import { FixedFileMigrationProvider } from "./fix-migration-provider.js";

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

export const current = {
  /** @type {SQL | undefined} */
  driver: undefined
};

export const read_files_in_folder = async (folder = "") => {
  const files = await fs.readdir(folder);
  return files.filter(file => file.endsWith(".js"));
};

/**
 * @param {SqlDialectType} dialect_type
 */
export const get_migrations = async (dialect_type = "SQLITE") => {
  const folder = "migrations." + dialect_type.toLowerCase();
  const files = await fs.readdir(path.join(__dirname, folder));

  /** @type {Record<string, Migration>} */
  const migrations = {};

  for (const file of files) {
    if (file.endsWith(".js")) {
      const file_name = file.split(".").slice(0, -1).join(".");
      const file_path = path.join(__dirname, folder, file);
      const file_url = pathToFileURL(file_path);

      const migration = await import(file_url.href);
      migrations[file_name] = migration;
    }
  }

  return migrations;
};

/**
 * @param {SQL} db_driver
 * @param {boolean} [release_db_upon_completion=true]
 */
export async function migrateToLatest(db_driver, release_db_upon_completion = true) {
  if (!db_driver?.client) {
    throw new Error("No Kysely client found !!!");
  }

  console.log("Resolving migrations. This may take some time...");

  const db = db_driver.client;

  current.driver = db_driver;

  const migrator = new Migrator({
    db,
    provider: new FixedFileMigrationProvider({
      fs,
      path,
      migrationFolder: path.join(
        __dirname,
        `migrations.${db_driver.dialectType.toLowerCase()}`
      ),
    }),
  });

  const { error, results } = await migrator.migrateToLatest();

  results?.forEach((it) => {
    if (it.status === "Success") {
      console.log(`migration "${it.migrationName}" was executed successfully`);
    } else if (it.status === "Error") {
      console.error(`failed to execute migration "${it.migrationName}"`);
    }
  });

  if (error) {
    console.error("failed to migrate");
    console.error(JSON.stringify(error, null, 2));
    console.error(JSON.stringify(results, null, 2));
    process.exit(1);
  }

  console.log("Resolving migrations COMPLETE.");

  if (release_db_upon_completion) {
    await db.destroy();
  }
}