@fragno-dev/db 0.1.3 → 0.1.6

package/src/adapters/kysely/migration/kysely-migrator.test.ts

@@ -1,7 +1,7 @@
-import { Kysely, PostgresDialect } from "kysely";
+import { Kysely, PostgresDialect, SqliteDialect } from "kysely";
 import { describe, expect, beforeAll, test } from "vitest";
 import { KyselyAdapter } from "../kysely-adapter";
-import { column, idColumn, schema } from "../../../schema/create";
+import { column, idColumn, referenceColumn, schema } from "../../../schema/create";
 
 describe("KyselyMigrator", () => {
   const testSchema = schema((s) => {
@@ -177,3 +177,85 @@ describe("KyselyMigrator", () => {
     ).rejects.toThrow("schema only has version 4");
   });
 });
+
+describe("KyselyMigrator - SQLite Foreign Key Merging", () => {
+  // Test the user's exact example schema
+  const userExampleSchema = schema((s) => {
+    return s
+      .addTable("users", (t) => {
+        return t.addColumn("id", idColumn());
+      })
+      .addTable("posts", (t) => {
+        return t.addColumn("id", idColumn()).addColumn("authorId", referenceColumn());
+      })
+      .addReference("author", {
+        type: "one",
+        from: { table: "posts", column: "authorId" },
+        to: { table: "users", column: "id" },
+      });
+  });
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let db: Kysely<any>;
+  let adapter: KyselyAdapter;
+
+  beforeAll(async () => {
+    // Create a Kysely instance with SQLite dialect
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    db = new Kysely({ dialect: new SqliteDialect({} as any) });
+    adapter = new KyselyAdapter({ db, provider: "sqlite" });
+  });
+
+  test("SQLite should merge foreign keys into create-table operations", async () => {
+    const migrator = adapter.createMigrationEngine(userExampleSchema, "test");
+
+    // Migrate from 0 -> 3 (all tables + FK in one batch)
+    const preparedMigration = await migrator.prepareMigrationTo(3, {
+      updateSettings: true,
+      fromVersion: 0,
+    });
+
+    expect(preparedMigration.operations.length).toBeGreaterThan(0);
+    const sql = preparedMigration.getSQL?.();
+    expect(sql).toBeDefined();
+
+    // The SQL should have PRAGMA defer_foreign_keys
+    expect(sql).toContain("PRAGMA defer_foreign_keys = ON");
+
+    // Should create users table
+    expect(sql).toContain('create table "users_test"');
+
+    // Should create posts table WITH inline foreign key constraint
+    expect(sql).toContain('create table "posts_test"');
+    expect(sql).toContain("foreign key");
+    expect(sql).toContain("authorId");
+    expect(sql).toContain('references "users_test"');
+
+    // Should NOT have a separate ALTER TABLE ADD FOREIGN KEY
+    // (SQLite doesn't support it, and we've merged it into create-table)
+    expect(sql).not.toMatch(/alter table.*add.*foreign key/i);
+  });
+
+  test("SQLite FK merging full schema verification", async () => {
+    const migrator = adapter.createMigrationEngine(userExampleSchema, "test");
+
+    const preparedMigration = await migrator.prepareMigrationTo(3, {
+      updateSettings: true,
+      fromVersion: 0,
+    });
+
+    const sql = preparedMigration.getSQL?.();
+    expect(sql).toBeDefined();
+
+    // Verify the complete SQL snapshot
+    expect(sql).toMatchInlineSnapshot(`
+      "PRAGMA defer_foreign_keys = ON;
+
+      create table "users_test" ("id" text not null unique, "_internalId" integer not null primary key autoincrement, "_version" integer default 0 not null);
+
+      create table "posts_test" ("id" text not null unique, "authorId" integer not null, "_internalId" integer not null primary key autoincrement, "_version" integer default 0 not null, constraint "posts_users_author_fk" foreign key ("authorId") references "users_test" ("_internalId") on delete restrict on update restrict);
+
+      insert into "fragno_db_settings" ("id", "key", "value") values ('BflimUWc1NbCMMDD9SM3gQ', 'test.schema_version', '3');"
+    `);
+  });
+});

package/src/migration-engine/shared.ts

@@ -5,6 +5,22 @@ export interface ForeignKeyInfo {
   referencedColumns: string[];
 }
 
+/**
+ * Provider-specific metadata that can be attached to operations during preprocessing.
+ * This allows providers to add additional context without polluting the core operation types.
+ */
+export interface MigrationOperationMetadata {
+  [key: string]: unknown;
+}
+
+/**
+ * SQLite-specific metadata for create-table operations.
+ * Includes foreign keys that should be created inline with the table.
+ */
+export interface SqliteCreateTableMetadata extends MigrationOperationMetadata {
+  inlineForeignKeys?: ForeignKeyInfo[];
+}
+
 export interface ColumnInfo {
   name: string;
   type:
@@ -23,33 +39,35 @@ export interface ColumnInfo {
   default?: { value: unknown } | { dbSpecial: "now" } | { runtime: "cuid" | "now" };
 }
 
-export type MigrationOperation =
-  | TableOperation
-  | {
+export type MigrationOperation<
+  TMeta extends MigrationOperationMetadata = MigrationOperationMetadata,
+> =
+  | (TableOperation & { metadata?: TMeta })
+  | ({
       // warning: not supported by SQLite
       type: "add-foreign-key";
       table: string;
       value: ForeignKeyInfo;
-    }
-  | {
+    } & { metadata?: TMeta })
+  | ({
       // warning: not supported by SQLite
       type: "drop-foreign-key";
       table: string;
       name: string;
-    }
-  | {
+    } & { metadata?: TMeta })
+  | ({
       type: "drop-index";
       table: string;
       name: string;
-    }
-  | {
+    } & { metadata?: TMeta })
+  | ({
       type: "add-index";
       table: string;
       columns: string[];
       name: string;
       unique: boolean;
-    }
-  | CustomOperation;
+    } & { metadata?: TMeta })
+  | (CustomOperation & { metadata?: TMeta });
 
 export type CustomOperation = {
   type: "custom";

package/tsdown.config.ts

@@ -6,6 +6,7 @@ export default defineConfig({
     "./src/id.ts",
     "./src/schema/create.ts",
     "./src/query/query.ts",
+    "./src/adapters/adapters.ts",
     "./src/adapters/kysely/kysely-adapter.ts",
     "./src/adapters/drizzle/drizzle-adapter.ts",
     "./src/query/unit-of-work.ts",