refactor: move migrations to scripts/migrations package (#36)

package.json

@@ -17,8 +17,8 @@
         "lint": "turbo run lint",
         "lint:fix": "turbo run lint:fix",
         "prepare": "husky",
-        "script:db:migrate": "pnpm run --filter @grants-stack-indexer/scripts script:db:migrate",
-        "script:db:reset": "pnpm run --filter @grants-stack-indexer/scripts script:db:reset",
+        "script:db:migrate": "pnpm run --filter @grants-stack-indexer/migrations script:db:migrate",
+        "script:db:reset": "pnpm run --filter @grants-stack-indexer/migrations script:db:reset",
         "start": "turbo run start",
         "test": "turbo run test",
         "test:cov": "turbo run test:cov",

packages/repository/src/db/index.ts

@@ -1,2 +1 @@
 export * from "./connection.js";
-export * from "./provider.js";

packages/repository/src/external.ts

@@ -60,6 +60,3 @@ export {
 } from "./internal.js";
 
 export { createKyselyPostgresDb as createKyselyDatabase } from "./internal.js";
-
-export { migrateToLatest, resetDatabase } from "./db/index.js";
-export type { MigrationConfig } from "./db/index.js";

packages/repository/src/internal.ts

@@ -2,5 +2,4 @@ export * from "./types/index.js";
 export * from "./interfaces/index.js";
 export * from "./db/connection.js";
 export * from "./repositories/kysely/index.js";
-export * from "./db/helpers.js";
 export * from "./exceptions/index.js";

pnpm-workspace.yaml

@@ -1,3 +1,4 @@
 packages:
     - "apps/*"
     - "packages/*"
+    - "scripts/*"

apps/scripts/README.md → scripts/migrations/README.md

@@ -1,4 +1,4 @@
-# grants-stack-indexer: scripts
+# grants-stack-indexer: migrations scripts
 
 This package contains scripts for managing the database schema and migrations.
 
@@ -110,3 +110,7 @@ export async function down(db: Kysely<any>): Promise<void> {
     - Verify schema consistency
 
 TODO: add E2E tests for the scripts
+
+## References
+
+-   [Kysely](https://kysely.dev/)

apps/scripts/package.json → scripts/migrations/package.json

@@ -1,5 +1,5 @@
 {
-    "name": "@grants-stack-indexer/scripts",
+    "name": "@grants-stack-indexer/migrations",
     "version": "0.0.1",
     "private": true,
     "description": "",
@@ -28,6 +28,7 @@
     "dependencies": {
         "@grants-stack-indexer/repository": "workspace:*",
         "dotenv": "16.4.5",
+        "kysely": "0.27.4",
         "zod": "3.23.8"
     },
     "devDependencies": {

apps/scripts/src/migrateDb.script.ts → scripts/migrations/src/migrateDb.script.ts

@@ -1,8 +1,10 @@
+import path from "path";
 import { configDotenv } from "dotenv";
 
-import { createKyselyDatabase, migrateToLatest } from "@grants-stack-indexer/repository";
+import { createKyselyDatabase } from "@grants-stack-indexer/repository";
 
 import { getDatabaseConfigFromEnv } from "./schemas/index.js";
+import { migrateToLatest } from "./utils/index.js";
 
 configDotenv();
 
@@ -41,6 +43,10 @@ export const main = async (): Promise<void> => {
     const migrationResults = await migrateToLatest({
         db,
         schema: DATABASE_SCHEMA,
+        migrationsFolder: path.join(
+            path.dirname(new URL(import.meta.url).pathname),
+            "./migrations",
+        ),
     });
 
     if (migrationResults && migrationResults?.length > 0) {

packages/repository/src/migrations/20241029T120000_initial.ts → scripts/migrations/src/migrations/20241029T120000_initial.ts

@@ -1,6 +1,6 @@
 import { Kysely, sql } from "kysely";
 
-import { getSchemaName } from "../db/helpers.js";
+import { getSchemaName } from "../utils/index.js";
 
 /**
  * The up function is called when you update your database schema to the next version and down when you go back to previous version.

apps/scripts/src/resetDb.script.ts → scripts/migrations/src/resetDb.script.ts

@@ -1,8 +1,10 @@
+import path from "path";
 import { configDotenv } from "dotenv";
 
-import { createKyselyDatabase, resetDatabase } from "@grants-stack-indexer/repository";
+import { createKyselyDatabase } from "@grants-stack-indexer/repository";
 
 import { getDatabaseConfigFromEnv } from "./schemas/index.js";
+import { resetDatabase } from "./utils/index.js";
 
 configDotenv();
 
@@ -44,6 +46,10 @@ const main = async (): Promise<void> => {
     const resetResults = await resetDatabase({
         db,
         schema: DATABASE_SCHEMA,
+        migrationsFolder: path.join(
+            path.dirname(new URL(import.meta.url).pathname),
+            "./migrations",
+        ),
     });
 
     if (resetResults && resetResults?.length > 0) {

scripts/migrations/src/utils/index.ts

@@ -0,0 +1 @@
+export * from "./kysely.js";

packages/repository/src/db/provider.ts → scripts/migrations/src/utils/kysely.ts

@@ -1,14 +1,32 @@
 import { promises as fs } from "fs";
 import * as path from "path";
-import { FileMigrationProvider, Kysely, MigrationResult, Migrator, NO_MIGRATIONS } from "kysely";
+import {
+    FileMigrationProvider,
+    Kysely,
+    MigrationResult,
+    Migrator,
+    NO_MIGRATIONS,
+    SchemaModule,
+} from "kysely";
 
-import { Database } from "./connection.js";
-
-export interface MigrationConfig {
-    db: Kysely<Database>;
+export interface MigrationConfig<T> {
+    db: Kysely<T>;
     schema: string;
+    migrationsFolder: string;
 }
 
+/**
+ * Since WithSchemaPlugin doesn't work with `sql.table`, we need to get the schema name manually.
+ * ref: https://github.com/kysely-org/kysely/issues/761
+ */
+export const getSchemaName = (schema: SchemaModule): string => {
+    let name = "public";
+    schema.createTable("test").$call((b) => {
+        name = b.toOperationNode().table.table.schema?.name ?? "public";
+    });
+    return name;
+};
+
 /**
  * Applies all migrations to the database up to the latest version.
  *
@@ -17,8 +35,8 @@ export interface MigrationConfig {
  * @param config.schema - The schema to use for the migrations. Should be the same as the schema used in the Kysely database instance.
  * @returns The migration results.
  */
-export async function migrateToLatest(
-    config: MigrationConfig,
+export async function migrateToLatest<T>(
+    config: MigrationConfig<T>,
 ): Promise<MigrationResult[] | undefined> {
     await config.db.schema.createSchema(config.schema).ifNotExists().execute();
 
@@ -27,10 +45,7 @@ export async function migrateToLatest(
         provider: new FileMigrationProvider({
             fs,
             path,
-            migrationFolder: path.join(
-                path.dirname(new URL(import.meta.url).pathname),
-                "../migrations",
-            ),
+            migrationFolder: config.migrationsFolder,
         }),
         migrationTableSchema: config.schema,
     });
@@ -62,18 +77,15 @@ export async function migrateToLatest(
  * @param config.schema - The schema to use for the migrations. Should be the same as the schema used in the Kysely database instance.
  * @returns The migration results.
  */
-export async function resetDatabase(
-    config: MigrationConfig,
+export async function resetDatabase<T>(
+    config: MigrationConfig<T>,
 ): Promise<MigrationResult[] | undefined> {
     const migrator = new Migrator({
         db: config.db,
         provider: new FileMigrationProvider({
             fs,
             path,
-            migrationFolder: path.join(
-                path.dirname(new URL(import.meta.url).pathname),
-                "../migrations",
-            ),
+            migrationFolder: config.migrationsFolder,
         }),
     });