feat: add migrate-cli.ts

Author: hi-ogawa

package.json

@@ -13,6 +13,8 @@
     "tsc": "tsc -b tsconfig.all.json",
     "dev:tsc": "pnpm tsc --watch --preserveWatchOutput",
     "test-e2e": "playwright test",
+    "repl": "tsx ./src/db/repl.ts",
+    "migrate": "tsx ./src/db/migrate-cli.ts",
     "lint": "run-s lint:*",
     "lint-check": "run-s lint-check:*",
     "lint:isort": "pnpm lint-check:isort --fix",
@@ -52,6 +54,7 @@
     "@types/react-dom": "^18.2.6",
     "@vavite/connect": "^1.8.1",
     "@vitejs/plugin-react": "^4.0.2",
+    "consola": "^3.2.3",
     "esbuild": "^0.18.11",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.0.0",

pnpm-lock.yaml

@@ -1 +1,117 @@
-// TODO
+import fs from "node:fs";
+import process from "node:process";
+import { tinyassert } from "@hiogawa/utils";
+import { consola } from "consola";
+import {
+  type Migration,
+  type MigrationProvider,
+  type MigrationResultSet,
+  Migrator,
+  sql,
+} from "kysely";
+import { db, initializeDb } from ".";
+import { setWorkerEnvDev } from "../utils/worker-env-dev";
+
+// based on https://github.com/hi-ogawa/vite-fullstack-example/blob/e7bb3b71ea4746a4817e040fc87d9ea171328396/src/db/migrate-cli.ts#L16-L23
+//
+// usage:
+//   pnpm migrate
+
+async function mainCli() {
+  const args = process.argv.slice(2);
+  const command = args[0] ?? "";
+
+  const migrator = new Migrator({
+    db,
+    provider: new RawSqlMigrationProvider({
+      directory: "./src/db/migrations",
+    }),
+  });
+
+  switch (command) {
+    case "":
+    case "status": {
+      const result = await migrator.getMigrations();
+      for (const info of result) {
+        console.log(
+          `${info.name}: ${info.executedAt?.toISOString() ?? "(pending)"}`,
+        );
+      }
+      return;
+    }
+    case "up": {
+      const result = await migrator.migrateUp();
+      handleResult(result);
+      return;
+    }
+    case "down": {
+      const result = await migrator.migrateDown();
+      handleResult(result);
+      return;
+    }
+    case "latest": {
+      const result = await migrator.migrateToLatest();
+      handleResult(result);
+      return;
+    }
+    default: {
+      throw new Error("unkonwn command", { cause: command });
+    }
+  }
+}
+
+function handleResult(result: MigrationResultSet) {
+  console.log(":: executed migrations");
+  console.log(result.results);
+  if (result.error) {
+    throw result.error;
+  }
+}
+
+//
+// RawSqlMigrationProvider
+//
+
+class RawSqlMigrationProvider implements MigrationProvider {
+  constructor(private options: { directory: string }) {}
+
+  async getMigrations(): Promise<Record<string, Migration>> {
+    const migrations: Record<string, Migration> = {};
+    const baseDir = this.options.directory;
+    const nameDirs = await fs.promises.readdir(baseDir);
+    for (const name of nameDirs) {
+      const upFile = `${baseDir}/${name}/up.sql`;
+      const downFile = `${baseDir}/${name}/down.sql`;
+      tinyassert(fs.existsSync(upFile));
+      migrations[name] = {
+        up: await readSqlFile(upFile),
+        down: fs.existsSync(downFile) ? await readSqlFile(downFile) : undefined,
+      };
+    }
+    return migrations;
+  }
+}
+
+async function readSqlFile(filepath: string): Promise<Migration["up"]> {
+  const content = await fs.promises.readFile(filepath, "utf-8");
+  return async (db) => {
+    await sql.raw(content).execute(db);
+  };
+}
+
+//
+// main
+//
+
+async function main() {
+  await setWorkerEnvDev();
+  await initializeDb();
+  try {
+    await mainCli();
+  } catch (e) {
+    consola.error(e);
+    process.exitCode = 1;
+  }
+}
+
+main();

src/db/migrate-cli.ts

@@ -4,7 +4,7 @@ import { db, initializeDb } from ".";
 import { setWorkerEnvDev } from "../utils/worker-env-dev";
 
 // usage
-// D1_DATABASE_ID=b7ae526e-5a2b-4c16-8d7d-4a5983c4f1f1 npx tsx ./src/db/repl.ts
+// D1_DATABASE_ID=b7ae526e-5a2b-4c16-8d7d-4a5983c4f1f1 pnpm repl
 // > await sql`SELECT 1 + 1`.execute(db)
 // > await sql`PRAGMA table_list`.execute(db)