From 38abae47b57af481a8dcdf2393317de6df46920a Mon Sep 17 00:00:00 2001 From: Chris Swithinbank Date: Mon, 11 Mar 2024 20:07:53 +0100 Subject: [PATCH] Fix db for projects without a seed file or with integrations (#10385) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add fixture and tests for integration with no user db config * Create database tables when integration seed files load * Defer running seed function until all modules are loaded * Update package name * Add test & fixture for a project with no seed file * `recreateTables()` from `seedLocal()` (and move it out of main runtime module) * Fix typo after rebase * FREEZE DON’T MOVE * Move `seedLocal` export back to runtime * Simplify seed file normalization * Clean up test files * Add build tests for no-seed and integration-only fixtures * Add changeset --- .changeset/calm-roses-camp.md | 5 ++ .../db/src/core/integration/vite-plugin-db.ts | 43 ++------------ packages/db/src/runtime/index.ts | 37 +----------- packages/db/src/runtime/seed-local.ts | 58 +++++++++++++++++++ .../integration-only/astro.config.mjs | 8 +++ .../integration-only/integration/config.ts | 8 +++ .../integration-only/integration/index.ts | 15 +++++ .../integration-only/integration/seed.ts | 14 +++++ .../integration-only/integration/shared.ts | 9 +++ .../fixtures/integration-only/package.json | 14 +++++ .../integration-only/src/pages/index.astro | 11 ++++ .../db/test/fixtures/no-seed/astro.config.ts | 7 +++ .../db/test/fixtures/no-seed/db/config.ts | 12 ++++ .../db/test/fixtures/no-seed/package.json | 14 +++++ .../fixtures/no-seed/src/pages/index.astro | 21 +++++++ packages/db/test/integration-only.test.js | 47 +++++++++++++++ packages/db/test/no-seed.test.js | 47 +++++++++++++++ pnpm-lock.yaml | 18 ++++++ 18 files changed, 314 insertions(+), 74 deletions(-) create mode 100644 .changeset/calm-roses-camp.md create mode 100644 packages/db/src/runtime/seed-local.ts create mode 100644 packages/db/test/fixtures/integration-only/astro.config.mjs create mode 100644 packages/db/test/fixtures/integration-only/integration/config.ts create mode 100644 packages/db/test/fixtures/integration-only/integration/index.ts create mode 100644 packages/db/test/fixtures/integration-only/integration/seed.ts create mode 100644 packages/db/test/fixtures/integration-only/integration/shared.ts create mode 100644 packages/db/test/fixtures/integration-only/package.json create mode 100644 packages/db/test/fixtures/integration-only/src/pages/index.astro create mode 100644 packages/db/test/fixtures/no-seed/astro.config.ts create mode 100644 packages/db/test/fixtures/no-seed/db/config.ts create mode 100644 packages/db/test/fixtures/no-seed/package.json create mode 100644 packages/db/test/fixtures/no-seed/src/pages/index.astro create mode 100644 packages/db/test/integration-only.test.js create mode 100644 packages/db/test/no-seed.test.js diff --git a/.changeset/calm-roses-camp.md b/.changeset/calm-roses-camp.md new file mode 100644 index 0000000000..f0849a5597 --- /dev/null +++ b/.changeset/calm-roses-camp.md @@ -0,0 +1,5 @@ +--- +"@astrojs/db": patch +--- + +Fixes support for integrations configuring `astro:db` and for projects that use `astro:db` but do not include a seed file. diff --git a/packages/db/src/core/integration/vite-plugin-db.ts b/packages/db/src/core/integration/vite-plugin-db.ts index db376044ee..aae9094cac 100644 --- a/packages/db/src/core/integration/vite-plugin-db.ts +++ b/packages/db/src/core/integration/vite-plugin-db.ts @@ -1,15 +1,6 @@ -import { resolve } from 'node:path'; import { fileURLToPath } from 'node:url'; -import { type SQL, sql } from 'drizzle-orm'; -import { SQLiteAsyncDialect } from 'drizzle-orm/sqlite-core'; import { normalizePath } from 'vite'; -import { createLocalDatabaseClient } from '../../runtime/db-client.js'; -import type { SqliteDB } from '../../runtime/index.js'; -import { - SEED_DEV_FILE_NAME, - getCreateIndexQueries, - getCreateTableQuery, -} from '../../runtime/queries.js'; +import { SEED_DEV_FILE_NAME } from '../../runtime/queries.js'; import { DB_PATH, RUNTIME_CONFIG_IMPORT, RUNTIME_IMPORT, VIRTUAL_MODULE_ID } from '../consts.js'; import type { DBTables } from '../types.js'; import { type VitePlugin, getDbDirectoryUrl, getRemoteDatabaseUrl } from '../utils.js'; @@ -46,9 +37,6 @@ type VitePluginDBParams = export function vitePluginDb(params: VitePluginDBParams): VitePlugin { const srcDirPath = normalizePath(fileURLToPath(params.srcDir)); - const seedFilePaths = SEED_DEV_FILE_NAME.map((name) => - normalizePath(fileURLToPath(new URL(name, getDbDirectoryUrl(params.root)))) - ); return { name: 'astro:db', enforce: 'pre', @@ -67,14 +55,6 @@ export function vitePluginDb(params: VitePluginDBParams): VitePlugin { return resolved.virtual; }, async load(id) { - // Recreate tables whenever a seed file is loaded. - if (seedFilePaths.some((f) => id === f)) { - await recreateTables({ - db: createLocalDatabaseClient({ dbUrl: new URL(DB_PATH, params.root).href }), - tables: params.tables.get(), - }); - } - if (id !== resolved.virtual && id !== resolved.seedVirtual) return; if (params.connectToStudio) { @@ -113,7 +93,8 @@ export function getLocalVirtualModContents({ // for Vite import.meta.glob (name) => new URL(name, getDbDirectoryUrl('file:///')).pathname ); - const resolveId = (id: string) => (id.startsWith('.') ? resolve(fileURLToPath(root), id) : id); + const resolveId = (id: string) => + id.startsWith('.') ? normalizePath(fileURLToPath(new URL(id, root))) : id; // Use top-level imports to correctly resolve `astro:db` within seed files. // Dynamic imports cause a silent build failure, // potentially because of circular module references. @@ -138,6 +119,8 @@ export const db = createLocalDatabaseClient({ dbUrl }); ${ shouldSeed ? `await seedLocal({ + db, + tables: ${JSON.stringify(tables)}, userSeedGlob: import.meta.glob(${JSON.stringify(userSeedFilePaths)}, { eager: true }), integrationSeedFunctions: [${integrationSeedImportNames.join(',')}], });` @@ -180,19 +163,3 @@ function getStringifiedCollectionExports(tables: DBTables) { ) .join('\n'); } - -const sqlite = new SQLiteAsyncDialect(); - -async function recreateTables({ db, tables }: { db: SqliteDB; tables: DBTables }) { - const setupQueries: SQL[] = []; - for (const [name, table] of Object.entries(tables)) { - const dropQuery = sql.raw(`DROP TABLE IF EXISTS ${sqlite.escapeName(name)}`); - const createQuery = sql.raw(getCreateTableQuery(name, table)); - const indexQueries = getCreateIndexQueries(name, table); - setupQueries.push(dropQuery, createQuery, ...indexQueries.map((s) => sql.raw(s))); - } - await db.batch([ - db.run(sql`pragma defer_foreign_keys=true;`), - ...setupQueries.map((q) => db.run(q)), - ]); -} diff --git a/packages/db/src/runtime/index.ts b/packages/db/src/runtime/index.ts index be8ced5469..6463f5f0e0 100644 --- a/packages/db/src/runtime/index.ts +++ b/packages/db/src/runtime/index.ts @@ -1,4 +1,3 @@ -import { LibsqlError } from '@libsql/client'; import { type ColumnBuilderBaseConfig, type ColumnDataType, sql } from 'drizzle-orm'; import type { LibSQLDatabase } from 'drizzle-orm/libsql'; import { @@ -10,7 +9,6 @@ import { sqliteTable, text, } from 'drizzle-orm/sqlite-core'; -import { SEED_DEFAULT_EXPORT_ERROR, SEED_ERROR } from '../core/errors.js'; import { type DBColumn, type DBTable } from '../core/types.js'; import { type SerializedSQL, isSerializedSQL } from './types.js'; @@ -18,40 +16,7 @@ export { sql }; export type SqliteDB = LibSQLDatabase; export type { Table } from './types.js'; export { createRemoteDatabaseClient, createLocalDatabaseClient } from './db-client.js'; - -export async function seedLocal({ - // Glob all potential seed files to catch renames and deletions. - userSeedGlob, - integrationSeedFunctions: integrationSeedFunctions, -}: { - userSeedGlob: Record Promise }>; - integrationSeedFunctions: Array<() => Promise>; -}) { - const seedFilePath = Object.keys(userSeedGlob)[0]; - if (seedFilePath) { - const mod = userSeedGlob[seedFilePath]; - - if (!mod.default) { - throw new Error(SEED_DEFAULT_EXPORT_ERROR(seedFilePath)); - } - try { - await mod.default(); - } catch (e) { - if (e instanceof LibsqlError) { - throw new Error(SEED_ERROR(e.message)); - } - throw e; - } - } - for (const seedFn of integrationSeedFunctions) { - await seedFn().catch((e) => { - if (e instanceof LibsqlError) { - throw new Error(SEED_ERROR(e.message)); - } - throw e; - }); - } -} +export { seedLocal } from './seed-local.js'; export function hasPrimaryKey(column: DBColumn) { return 'primaryKey' in column.schema && !!column.schema.primaryKey; diff --git a/packages/db/src/runtime/seed-local.ts b/packages/db/src/runtime/seed-local.ts new file mode 100644 index 0000000000..e2af06d2e2 --- /dev/null +++ b/packages/db/src/runtime/seed-local.ts @@ -0,0 +1,58 @@ +import { LibsqlError } from '@libsql/client'; +import { sql, type SQL } from 'drizzle-orm'; +import type { LibSQLDatabase } from 'drizzle-orm/libsql'; +import { SQLiteAsyncDialect } from 'drizzle-orm/sqlite-core'; +import { SEED_DEFAULT_EXPORT_ERROR, SEED_ERROR } from '../core/errors.js'; +import { type DBTables } from '../core/types.js'; +import { getCreateIndexQueries, getCreateTableQuery } from './queries.js'; + +const sqlite = new SQLiteAsyncDialect(); + +export async function seedLocal({ + db, + tables, + // Glob all potential seed files to catch renames and deletions. + userSeedGlob, + integrationSeedFunctions, +}: { + db: LibSQLDatabase; + tables: DBTables; + userSeedGlob: Record Promise }>; + integrationSeedFunctions: Array<() => Promise>; +}) { + await recreateTables({ db, tables }); + const seedFunctions: Array<() => Promise> = []; + const seedFilePath = Object.keys(userSeedGlob)[0]; + if (seedFilePath) { + const mod = userSeedGlob[seedFilePath]; + if (!mod.default) throw new Error(SEED_DEFAULT_EXPORT_ERROR(seedFilePath)); + seedFunctions.push(mod.default); + } + for (const seedFn of integrationSeedFunctions) { + seedFunctions.push(seedFn); + } + for (const seed of seedFunctions) { + try { + await seed(); + } catch (e) { + if (e instanceof LibsqlError) { + throw new Error(SEED_ERROR(e.message)); + } + throw e; + } + } +} + +async function recreateTables({ db, tables }: { db: LibSQLDatabase; tables: DBTables }) { + const setupQueries: SQL[] = []; + for (const [name, table] of Object.entries(tables)) { + const dropQuery = sql.raw(`DROP TABLE IF EXISTS ${sqlite.escapeName(name)}`); + const createQuery = sql.raw(getCreateTableQuery(name, table)); + const indexQueries = getCreateIndexQueries(name, table); + setupQueries.push(dropQuery, createQuery, ...indexQueries.map((s) => sql.raw(s))); + } + await db.batch([ + db.run(sql`pragma defer_foreign_keys=true;`), + ...setupQueries.map((q) => db.run(q)), + ]); +} diff --git a/packages/db/test/fixtures/integration-only/astro.config.mjs b/packages/db/test/fixtures/integration-only/astro.config.mjs new file mode 100644 index 0000000000..23f52739e5 --- /dev/null +++ b/packages/db/test/fixtures/integration-only/astro.config.mjs @@ -0,0 +1,8 @@ +import db from '@astrojs/db'; +import { defineConfig } from 'astro/config'; +import testIntegration from './integration'; + +// https://astro.build/config +export default defineConfig({ + integrations: [db(), testIntegration()], +}); diff --git a/packages/db/test/fixtures/integration-only/integration/config.ts b/packages/db/test/fixtures/integration-only/integration/config.ts new file mode 100644 index 0000000000..d1f1aac263 --- /dev/null +++ b/packages/db/test/fixtures/integration-only/integration/config.ts @@ -0,0 +1,8 @@ +import { menu } from './shared'; +import { defineDb } from 'astro:db'; + +export default defineDb({ + tables: { + menu, + }, +}); diff --git a/packages/db/test/fixtures/integration-only/integration/index.ts b/packages/db/test/fixtures/integration-only/integration/index.ts new file mode 100644 index 0000000000..b249cc2538 --- /dev/null +++ b/packages/db/test/fixtures/integration-only/integration/index.ts @@ -0,0 +1,15 @@ +import { defineDbIntegration } from '@astrojs/db/utils'; + +export default function testIntegration() { + return defineDbIntegration({ + name: 'db-test-integration', + hooks: { + 'astro:db:setup'({ extendDb }) { + extendDb({ + configEntrypoint: './integration/config.ts', + seedEntrypoint: './integration/seed.ts', + }); + }, + }, + }); +} diff --git a/packages/db/test/fixtures/integration-only/integration/seed.ts b/packages/db/test/fixtures/integration-only/integration/seed.ts new file mode 100644 index 0000000000..d46b05e1c1 --- /dev/null +++ b/packages/db/test/fixtures/integration-only/integration/seed.ts @@ -0,0 +1,14 @@ +import { asDrizzleTable } from '@astrojs/db/utils'; +import { menu } from './shared'; +import { db } from 'astro:db'; + +export default async function () { + const table = asDrizzleTable('menu', menu); + + await db.insert(table).values([ + { name: 'Pancakes', price: 9.5, type: 'Breakfast' }, + { name: 'French Toast', price: 11.25, type: 'Breakfast' }, + { name: 'Coffee', price: 3, type: 'Beverages' }, + { name: 'Cappuccino', price: 4.5, type: 'Beverages' }, + ]); +} diff --git a/packages/db/test/fixtures/integration-only/integration/shared.ts b/packages/db/test/fixtures/integration-only/integration/shared.ts new file mode 100644 index 0000000000..d46ae65a65 --- /dev/null +++ b/packages/db/test/fixtures/integration-only/integration/shared.ts @@ -0,0 +1,9 @@ +import { column, defineTable } from 'astro:db'; + +export const menu = defineTable({ + columns: { + name: column.text(), + type: column.text(), + price: column.number(), + }, +}); diff --git a/packages/db/test/fixtures/integration-only/package.json b/packages/db/test/fixtures/integration-only/package.json new file mode 100644 index 0000000000..4229f710ae --- /dev/null +++ b/packages/db/test/fixtures/integration-only/package.json @@ -0,0 +1,14 @@ +{ + "name": "@test/db-integration-only", + "version": "0.0.0", + "private": true, + "scripts": { + "dev": "astro dev", + "build": "astro build", + "preview": "astro preview" + }, + "dependencies": { + "@astrojs/db": "workspace:*", + "astro": "workspace:*" + } +} diff --git a/packages/db/test/fixtures/integration-only/src/pages/index.astro b/packages/db/test/fixtures/integration-only/src/pages/index.astro new file mode 100644 index 0000000000..7b204e124f --- /dev/null +++ b/packages/db/test/fixtures/integration-only/src/pages/index.astro @@ -0,0 +1,11 @@ +--- +/// +import { db, menu } from 'astro:db'; + +const menuItems = await db.select().from(menu); +--- + +

Menu

+
    + {menuItems.map((item) =>
  • {item.name}
    • )} +
diff --git a/packages/db/test/fixtures/no-seed/astro.config.ts b/packages/db/test/fixtures/no-seed/astro.config.ts new file mode 100644 index 0000000000..5ff1200e24 --- /dev/null +++ b/packages/db/test/fixtures/no-seed/astro.config.ts @@ -0,0 +1,7 @@ +import db from '@astrojs/db'; +import { defineConfig } from 'astro/config'; + +// https://astro.build/config +export default defineConfig({ + integrations: [db()], +}); diff --git a/packages/db/test/fixtures/no-seed/db/config.ts b/packages/db/test/fixtures/no-seed/db/config.ts new file mode 100644 index 0000000000..b8110406ab --- /dev/null +++ b/packages/db/test/fixtures/no-seed/db/config.ts @@ -0,0 +1,12 @@ +import { column, defineDb, defineTable } from 'astro:db'; + +const Author = defineTable({ + columns: { + name: column.text(), + age2: column.number({ optional: true }), + }, +}); + +export default defineDb({ + tables: { Author }, +}); diff --git a/packages/db/test/fixtures/no-seed/package.json b/packages/db/test/fixtures/no-seed/package.json new file mode 100644 index 0000000000..66a1926978 --- /dev/null +++ b/packages/db/test/fixtures/no-seed/package.json @@ -0,0 +1,14 @@ +{ + "name": "@test/db-no-seed", + "version": "0.0.0", + "private": true, + "scripts": { + "dev": "astro dev", + "build": "astro build", + "preview": "astro preview" + }, + "dependencies": { + "@astrojs/db": "workspace:*", + "astro": "workspace:*" + } +} diff --git a/packages/db/test/fixtures/no-seed/src/pages/index.astro b/packages/db/test/fixtures/no-seed/src/pages/index.astro new file mode 100644 index 0000000000..bacd873e13 --- /dev/null +++ b/packages/db/test/fixtures/no-seed/src/pages/index.astro @@ -0,0 +1,21 @@ +--- +/// +import { Author, db } from 'astro:db'; + +await db + .insert(Author) + .values([ + { name: 'Ben' }, + { name: 'Nate' }, + { name: 'Erika' }, + { name: 'Bjorn' }, + { name: 'Sarah' }, + ]); + +const authors = await db.select().from(Author); +--- + +

Authors

+
    + {authors.map((author) =>
  • {author.name}
    • )} +
diff --git a/packages/db/test/integration-only.test.js b/packages/db/test/integration-only.test.js new file mode 100644 index 0000000000..dd5222f2d6 --- /dev/null +++ b/packages/db/test/integration-only.test.js @@ -0,0 +1,47 @@ +import { expect } from 'chai'; +import { load as cheerioLoad } from 'cheerio'; +import { loadFixture } from '../../astro/test/test-utils.js'; + +describe('astro:db with only integrations, no user db config', () => { + let fixture; + before(async () => { + fixture = await loadFixture({ + root: new URL('./fixtures/integration-only/', import.meta.url), + }); + }); + + describe('development', () => { + let devServer; + before(async () => { + devServer = await fixture.startDevServer(); + }); + + after(async () => { + await devServer.stop(); + }); + + it('Prints the list of menu items from integration-defined table', async () => { + const html = await fixture.fetch('/').then((res) => res.text()); + const $ = cheerioLoad(html); + + const ul = $('ul.menu'); + expect(ul.children()).to.have.a.lengthOf(4); + expect(ul.children().eq(0).text()).to.equal('Pancakes'); + }); + }); + + describe('build', () => { + before(async () => { + await fixture.build(); + }); + + it('Prints the list of menu items from integration-defined table', async () => { + const html = await fixture.readFile('/index.html'); + const $ = cheerioLoad(html); + + const ul = $('ul.menu'); + expect(ul.children()).to.have.a.lengthOf(4); + expect(ul.children().eq(0).text()).to.equal('Pancakes'); + }); + }); +}); diff --git a/packages/db/test/no-seed.test.js b/packages/db/test/no-seed.test.js new file mode 100644 index 0000000000..82e14d3898 --- /dev/null +++ b/packages/db/test/no-seed.test.js @@ -0,0 +1,47 @@ +import { expect } from 'chai'; +import { load as cheerioLoad } from 'cheerio'; +import { loadFixture } from '../../astro/test/test-utils.js'; + +describe('astro:db with no seed file', () => { + let fixture; + before(async () => { + fixture = await loadFixture({ + root: new URL('./fixtures/no-seed/', import.meta.url), + }); + }); + + describe('development', () => { + let devServer; + before(async () => { + devServer = await fixture.startDevServer(); + }); + + after(async () => { + await devServer.stop(); + }); + + it('Prints the list of authors', async () => { + const html = await fixture.fetch('/').then((res) => res.text()); + const $ = cheerioLoad(html); + + const ul = $('.authors-list'); + expect(ul.children()).to.have.a.lengthOf(5); + expect(ul.children().eq(0).text()).to.equal('Ben'); + }); + }); + + describe('build', () => { + before(async () => { + await fixture.build(); + }); + + it('Prints the list of authors', async () => { + const html = await fixture.readFile('/index.html'); + const $ = cheerioLoad(html); + + const ul = $('.authors-list'); + expect(ul.children()).to.have.a.lengthOf(5); + expect(ul.children().eq(0).text()).to.equal('Ben'); + }); + }); +}); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c99cb4531e..11ad15ea52 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -3909,6 +3909,15 @@ importers: specifier: workspace:* version: link:../../../../astro + packages/db/test/fixtures/integration-only: + dependencies: + '@astrojs/db': + specifier: workspace:* + version: link:../../.. + astro: + specifier: workspace:* + version: link:../../../../astro + packages/db/test/fixtures/integrations: dependencies: '@astrojs/db': @@ -3918,6 +3927,15 @@ importers: specifier: workspace:* version: link:../../../../astro + packages/db/test/fixtures/no-seed: + dependencies: + '@astrojs/db': + specifier: workspace:* + version: link:../../.. + astro: + specifier: workspace:* + version: link:../../../../astro + packages/db/test/fixtures/recipes: dependencies: '@astrojs/db':