Add migration tests

package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "lint": "npx @biomejs/biome check src/ tests/ || (npx @biomejs/biome check --write src/ tests/; exit 1)",
-    "test": "vitest run",
+    "test": "vitest run --root tests",
     "prepare": "husky install"
   },
   "publishConfig": {

tests/bindings.d.ts

@@ -0,0 +1,7 @@
+export type Env = {
+  DB: D1Database
+}
+
+declare module 'cloudflare:test' {
+  interface ProvidedEnv extends Env {}
+}

tests/integration/crud.test.ts

@@ -0,0 +1,138 @@
+import { env } from 'cloudflare:test'
+import { describe, expect, it } from 'vitest'
+import { D1QB } from '../../src'
+
+describe('Simple operations', () => {
+  it('all operations', async () => {
+    const qb = new D1QB(env.DB)
+
+    await qb
+      .createTable({
+        tableName: 'testTable',
+        schema: `
+      id INTEGER PRIMARY KEY AUTOINCREMENT,
+      name TEXT NOT NULL
+    `,
+      })
+      .execute()
+
+    expect(
+      (
+        await qb
+          .insert({
+            tableName: 'testTable',
+            data: [
+              {
+                name: 'example',
+              },
+              {
+                name: 'test2',
+              },
+            ],
+            returning: '*',
+          })
+          .execute()
+      ).results
+    ).toEqual([
+      {
+        id: 1,
+        name: 'example',
+      },
+      {
+        id: 2,
+        name: 'test2',
+      },
+    ])
+
+    expect((await qb.select('testTable').all()).results).toEqual([
+      {
+        id: 1,
+        name: 'example',
+      },
+      {
+        id: 2,
+        name: 'test2',
+      },
+    ])
+
+    expect(
+      (
+        await qb
+          .update({
+            tableName: 'testTable',
+            where: {
+              conditions: 'name = ?1',
+              params: ['example'],
+            },
+            data: {
+              name: 'newName',
+            },
+            returning: '*',
+          })
+          .execute()
+      ).results
+    ).toEqual([
+      {
+        id: 1,
+        name: 'newName',
+      },
+    ])
+
+    expect(
+      (
+        await qb
+          .delete({
+            tableName: 'testTable',
+            where: {
+              conditions: 'name = ?1',
+              params: ['test2'],
+            },
+            returning: '*',
+          })
+          .execute()
+      ).results
+    ).toEqual([
+      {
+        id: 2,
+        name: 'test2',
+      },
+    ])
+
+    expect(
+      (
+        await qb
+          .delete({
+            tableName: 'testTable',
+            where: {
+              conditions: 'name = ?1',
+              params: ['abc'],
+            },
+            returning: '*',
+          })
+          .execute()
+      ).results
+    ).toEqual([])
+
+    expect((await qb.select('testTable').all()).results).toEqual([
+      {
+        id: 1,
+        name: 'newName',
+      },
+    ])
+
+    await qb
+      .dropTable({
+        tableName: 'testTable',
+      })
+      .execute()
+
+    expect(
+      (
+        await env.DB.prepare(`SELECT name, sql
+                                  FROM sqlite_master
+                                  WHERE type = 'table'
+                                    AND name not in ('_cf_KV', 'sqlite_sequence', '_cf_METADATA')`).all()
+      ).results
+    ).toEqual([])
+  })
+})

tests/integration/migrations.test.ts

@@ -0,0 +1,134 @@
+import { env } from 'cloudflare:test'
+import { describe, expect, it } from 'vitest'
+import { D1QB, Migration } from '../../src'
+
+export const migrations: Migration[] = [
+  {
+    name: '100000000000000_add_logs_table.sql',
+    sql: `
+      create table logs
+      (
+        id   INTEGER PRIMARY KEY AUTOINCREMENT,
+        name TEXT NOT NULL
+      );`,
+  },
+]
+
+describe('Migrations', () => {
+  it('initialize', async () => {
+    const qb = new D1QB(env.DB)
+
+    expect(
+      (
+        await env.DB.prepare(`SELECT name
+                                  FROM sqlite_master
+                                  WHERE type = 'table'`).all()
+      ).results
+    ).toEqual([])
+
+    await qb.migrations({ migrations }).initialize()
+
+    expect(
+      (
+        await env.DB.prepare(`SELECT name
+                                  FROM sqlite_master
+                                  WHERE type = 'table'
+                                    AND name <> 'sqlite_sequence'`).all()
+      ).results
+    ).toEqual([
+      {
+        name: 'migrations',
+      },
+    ])
+  })
+
+  it('apply', async () => {
+    const qb = new D1QB(env.DB)
+
+    expect(
+      (
+        await env.DB.prepare(`SELECT name
+                                  FROM sqlite_master
+                                  WHERE type = 'table'`).all()
+      ).results
+    ).toEqual([])
+
+    const applyResp = await qb.migrations({ migrations }).apply()
+
+    expect(applyResp.length).toEqual(1)
+    expect(applyResp[0]?.name).toEqual('100000000000000_add_logs_table.sql')
+
+    expect(
+      (
+        await env.DB.prepare(`SELECT name
+                                  FROM sqlite_master
+                                  WHERE type = 'table'
+                                    AND name <> 'sqlite_sequence'`).all()
+      ).results
+    ).toEqual([
+      {
+        name: 'migrations',
+      },
+      {
+        name: 'logs',
+      },
+    ])
+
+    const applyResp2 = await qb.migrations({ migrations }).apply()
+    expect(applyResp2.length).toEqual(0)
+  })
+
+  it('incremental migrations', async () => {
+    const qb = new D1QB(env.DB)
+
+    expect(
+      (
+        await env.DB.prepare(`SELECT name
+                                  FROM sqlite_master
+                                  WHERE type = 'table'`).all()
+      ).results
+    ).toEqual([])
+
+    const applyResp = await qb.migrations({ migrations }).apply()
+
+    expect(applyResp.length).toEqual(1)
+    expect(applyResp[0]?.name).toEqual('100000000000000_add_logs_table.sql')
+
+    expect(
+      (
+        await env.DB.prepare(`SELECT name
+                                  FROM sqlite_master
+                                  WHERE type = 'table'
+                                    AND name <> 'sqlite_sequence'`).all()
+      ).results
+    ).toEqual([
+      {
+        name: 'migrations',
+      },
+      {
+        name: 'logs',
+      },
+    ])
+
+    const updatedMigrations = [
+      ...migrations,
+      {
+        name: '100000000000001_add_second_table.sql',
+        sql: `
+      create table logs_two
+      (
+        id   INTEGER PRIMARY KEY AUTOINCREMENT,
+        name TEXT NOT NULL
+      );`,
+      },
+    ]
+
+    const applyResp2 = await qb.migrations({ migrations: updatedMigrations }).apply()
+
+    expect(applyResp2.length).toEqual(1)
+    expect(applyResp2[0]?.name).toEqual('100000000000001_add_second_table.sql')
+
+    const applyResp3 = await qb.migrations({ migrations: updatedMigrations }).apply()
+    expect(applyResp3.length).toEqual(0)
+  })
+})

tests/tsconfig.json

@@ -4,5 +4,5 @@
     "moduleResolution": "bundler",
     "types": ["@cloudflare/workers-types/experimental", "@cloudflare/vitest-pool-workers"]
   },
-  "include": ["./**/*.ts", "../src/env.d.ts"]
+  "include": ["./**/*.ts", "./bindings.d.ts"]
 }

tests/vitest.config.ts

@@ -4,7 +4,13 @@ export default defineWorkersConfig({
   test: {
     poolOptions: {
       workers: {
-        wrangler: { configPath: './wrangler.toml' },
+        miniflare: {
+          compatibilityFlags: ['nodejs_compat'],
+          d1Databases: {
+            DB: '00000000-0000-0000-0000-000000000000',
+          },
+          compatibilityDate: '2024-09-10',
+        },
       },
     },
   },

tsconfig.json

@@ -9,5 +9,5 @@
     "noUncheckedIndexedAccess": true,
     "noEmit": true
   },
-  "include": ["src/*.ts", "src/**/*.ts", "tests/*.ts", "tests/**/*.ts"]
+  "include": ["src/*.ts", "src/**/*.ts"]
 }