[db] Fix duplicate calls to recreate tables on startup (#10919)

* fix: move recreateTables() to integration hooks * feat: recreate and seed at load, not in virtual runtime * feat: eager build db on startup and seed file change * fix: respect database_file in dbUrl * chore: remove duplicate recreateTables call * chore: remove now self-explanatory comments * fix: remove invalidateModule call for eager loading * feat: respect seed package paths * fix: remove duplicate recreateTables() call * refactor: move recreateTables() to vite-plugin-db * refactor: move queries.ts from runtime/ to core/ * fix: update test import to core/queries * refactor: move executeSeedFile to vite-plugin-db * refactor: extract seeding and recreating to helper fns * chore: changeset * chore: revert connectToStudio refactor * wip: log db url * fix(test): normalize astro_database_file flag for windows * Revert "wip: log db url" This reverts commit 558e2de. * Revert "Revert "wip: log db url"" This reverts commit ffd004e. * fix: correctly resolve relative paths with unit test * chore: remove unused dbDirPath Co-authored-by: Chris Swithinbank <[email protected]> * chore: remove unused import Co-authored-by: Chris Swithinbank <[email protected]> * chore: remove unused type Co-authored-by: Chris Swithinbank <[email protected]> * fix: remove bad import * [db] Load seed files with vite dev server (#10941) * feat: load seed files with full vite dev server * chore: remove unused export --------- Co-authored-by: Chris Swithinbank <[email protected]>
withastro · May 3, 2024 · 44bafa9 · 44bafa9
1 parent 9a231a4
commit 44bafa9
Show file tree

Hide file tree

Showing 14 changed files with 211 additions and 182 deletions.
diff --git a/.changeset/young-pots-brake.md b/.changeset/young-pots-brake.md
@@ -0,0 +1,6 @@
+---
+"@astrojs/db": minor
+---
+
+- Fix duplicate table recreations when you start your dev server.
+- Remove eager re-seeding when updating your seed file in development. Seeding still runs on dev server startup for SQLite inspector tools.
diff --git a/packages/db/src/core/cli/commands/execute/index.ts b/packages/db/src/core/cli/commands/execute/index.ts
@@ -15,7 +15,7 @@ import {
 } from '../../../integration/vite-plugin-db.js';
 import { bundleFile, importBundledFile } from '../../../load-file.js';
 import { getManagedAppTokenOrExit } from '../../../tokens.js';
-import { type DBConfig } from '../../../types.js';
+import type { DBConfig } from '../../../types.js';
 
 export async function cmd({
 	astroConfig,
@@ -51,8 +51,6 @@ export async function cmd({
 		virtualModContents = getLocalVirtualModContents({
 			tables: dbConfig.tables ?? {},
 			root: astroConfig.root,
-			shouldSeed: false,
-			seedFiles: [],
 		});
 	}
 	const { code } = await bundleFile({ virtualModContents, root: astroConfig.root, fileUrl });

diff --git a/packages/db/src/core/cli/commands/shell/index.ts b/packages/db/src/core/cli/commands/shell/index.ts
@@ -9,7 +9,8 @@ import { DB_PATH } from '../../../consts.js';
 import { SHELL_QUERY_MISSING_ERROR } from '../../../errors.js';
 import { getManagedAppTokenOrExit } from '../../../tokens.js';
 import type { DBConfigInput } from '../../../types.js';
-import { getRemoteDatabaseUrl } from '../../../utils.js';
+import { getAstroEnv, getRemoteDatabaseUrl } from '../../../utils.js';
+import { normalizeDatabaseUrl } from '../../../../runtime/index.js';
 
 export async function cmd({
 	flags,
@@ -31,7 +32,12 @@ export async function cmd({
 		await appToken.destroy();
 		console.log(result);
 	} else {
-		const db = createLocalDatabaseClient({ dbUrl: new URL(DB_PATH, astroConfig.root).href });
+		const { ASTRO_DATABASE_FILE } = getAstroEnv();
+		const dbUrl = normalizeDatabaseUrl(
+			ASTRO_DATABASE_FILE,
+			new URL(DB_PATH, astroConfig.root).href
+		);
+		const db = createLocalDatabaseClient({ dbUrl });
 		const result = await db.run(sql.raw(query));
 		console.log(result);
 	}

diff --git a/packages/db/src/core/cli/migration-queries.ts b/packages/db/src/core/cli/migration-queries.ts
@@ -12,7 +12,7 @@ import {
 	getReferencesConfig,
 	hasDefault,
 	schemaTypeToSqlType,
-} from '../../runtime/queries.js';
+} from '../queries.js';
 import { isSerializedSQL } from '../../runtime/types.js';
 import { safeFetch } from '../../runtime/utils.js';
 import { MIGRATION_VERSION } from '../consts.js';

diff --git a/packages/db/src/core/integration/index.ts b/packages/db/src/core/integration/index.ts
@@ -4,24 +4,41 @@ import { fileURLToPath } from 'url';
 import type { AstroConfig, AstroIntegration } from 'astro';
 import { mkdir, writeFile } from 'fs/promises';
 import { blue, yellow } from 'kleur/colors';
-import { loadEnv } from 'vite';
+import {
+	createServer,
+	loadEnv,
+	mergeConfig,
+	type HMRPayload,
+	type UserConfig,
+	type ViteDevServer,
+} from 'vite';
 import parseArgs from 'yargs-parser';
-import { SEED_DEV_FILE_NAME } from '../../runtime/queries.js';
+import { SEED_DEV_FILE_NAME } from '../queries.js';
 import { AstroDbError } from '../../runtime/utils.js';
 import { CONFIG_FILE_NAMES, DB_PATH } from '../consts.js';
 import { resolveDbConfig } from '../load-file.js';
 import { type ManagedAppToken, getManagedAppTokenOrExit } from '../tokens.js';
 import { type VitePlugin, getDbDirectoryUrl } from '../utils.js';
 import { fileURLIntegration } from './file-url.js';
 import { typegenInternal } from './typegen.js';
-import { type LateSeedFiles, type LateTables, resolved, vitePluginDb } from './vite-plugin-db.js';
+import {
+	type LateSeedFiles,
+	type LateTables,
+	vitePluginDb,
+	type SeedHandler,
+	resolved,
+} from './vite-plugin-db.js';
 import { vitePluginInjectEnvTs } from './vite-plugin-inject-env-ts.js';
+import { LibsqlError } from '@libsql/client';
+import { EXEC_DEFAULT_EXPORT_ERROR, EXEC_ERROR } from '../errors.js';
 
 function astroDBIntegration(): AstroIntegration {
 	let connectToStudio = false;
 	let configFileDependencies: string[] = [];
 	let root: URL;
 	let appToken: ManagedAppToken | undefined;
+	// Used during production builds to load seed files.
+	let tempViteServer: ViteDevServer | undefined;
 
 	// Make table loading "late" to pass to plugins from `config:setup`,
 	// but load during `config:done` to wait for integrations to settle.
@@ -35,6 +52,13 @@ function astroDBIntegration(): AstroIntegration {
 			throw new Error('[astro:db] INTERNAL Seed files not loaded yet');
 		},
 	};
+	let seedHandler: SeedHandler = {
+		execute: () => {
+			throw new Error('[astro:db] INTERNAL Seed handler not loaded yet');
+		},
+		inProgress: false,
+	};
+
 	let command: 'dev' | 'build' | 'preview';
 	let output: AstroConfig['output'] = 'server';
 	return {
@@ -60,6 +84,7 @@ function astroDBIntegration(): AstroIntegration {
 						root: config.root,
 						srcDir: config.srcDir,
 						output: config.output,
+						seedHandler,
 					});
 				} else {
 					dbPlugin = vitePluginDb({
@@ -69,6 +94,8 @@ function astroDBIntegration(): AstroIntegration {
 						root: config.root,
 						srcDir: config.srcDir,
 						output: config.output,
+						logger,
+						seedHandler,
 					});
 				}
 
@@ -98,6 +125,9 @@ function astroDBIntegration(): AstroIntegration {
 				await typegenInternal({ tables: tables.get() ?? {}, root: config.root });
 			},
 			'astro:server:setup': async ({ server, logger }) => {
+				seedHandler.execute = async (fileUrl) => {
+					await executeSeedFile({ fileUrl, viteServer: server });
+				};
 				const filesToWatch = [
 					...CONFIG_FILE_NAMES.map((c) => new URL(c, getDbDirectoryUrl(root))),
 					...configFileDependencies.map((c) => new URL(c, root)),
@@ -118,46 +148,11 @@ function astroDBIntegration(): AstroIntegration {
 					const localSeedPaths = SEED_DEV_FILE_NAME.map(
 						(name) => new URL(name, getDbDirectoryUrl(root))
 					);
-					let seedInFlight = false;
-					// Load seed file on dev server startup.
+					// Eager load astro:db module on startup
 					if (seedFiles.get().length || localSeedPaths.find((path) => existsSync(path))) {
-						loadSeedModule();
-					}
-					const eagerReloadIntegrationSeedPaths = seedFiles
-						.get()
-						// Map integration seed paths to URLs, if possible.
-						// Module paths like `@example/seed` will be ignored
-						// from eager reloading.
-						.map((s) => (typeof s === 'string' && s.startsWith('.') ? new URL(s, root) : s))
-						.filter((s): s is URL => s instanceof URL);
-					const eagerReloadSeedPaths = [...eagerReloadIntegrationSeedPaths, ...localSeedPaths];
-					server.watcher.on('all', (event, relativeEntry) => {
-						if (event === 'unlink' || event === 'unlinkDir') return;
-						// When a seed file changes, load manually
-						// to track when seeding finishes and log a message.
-						const entry = new URL(relativeEntry, root);
-						if (eagerReloadSeedPaths.find((path) => entry.href === path.href)) {
-							loadSeedModule();
-						}
-					});
-
-					function loadSeedModule() {
-						if (seedInFlight) return;
-
-						seedInFlight = true;
-						const mod = server.moduleGraph.getModuleById(resolved.seedVirtual);
-						if (mod) server.moduleGraph.invalidateModule(mod);
-						server
-							.ssrLoadModule(resolved.seedVirtual)
-							.then(() => {
-								logger.info('Seeded database.');
-							})
-							.catch((e) => {
-								logger.error(e instanceof Error ? e.message : String(e));
-							})
-							.finally(() => {
-								seedInFlight = false;
-							});
+						server.ssrLoadModule(resolved.module).catch((e) => {
+							logger.error(e instanceof Error ? e.message : String(e));
+						});
 					}
 				}, 100);
 			},
@@ -175,8 +170,15 @@ function astroDBIntegration(): AstroIntegration {
 
 				logger.info('database: ' + (connectToStudio ? yellow('remote') : blue('local database.')));
 			},
+			'astro:build:setup': async ({ vite }) => {
+				tempViteServer = await getTempViteServer({ viteConfig: vite });
+				seedHandler.execute = async (fileUrl) => {
+					await executeSeedFile({ fileUrl, viteServer: tempViteServer! });
+				};
+			},
 			'astro:build:done': async ({}) => {
 				await appToken?.destroy();
+				await tempViteServer?.close();
 			},
 		},
 	};
@@ -190,3 +192,48 @@ function databaseFileEnvDefined() {
 export function integration(): AstroIntegration[] {
 	return [astroDBIntegration(), fileURLIntegration()];
 }
+
+async function executeSeedFile({
+	fileUrl,
+	viteServer,
+}: {
+	fileUrl: URL;
+	viteServer: ViteDevServer;
+}) {
+	const mod = await viteServer.ssrLoadModule(fileUrl.pathname);
+	if (typeof mod.default !== 'function') {
+		throw new AstroDbError(EXEC_DEFAULT_EXPORT_ERROR(fileURLToPath(fileUrl)));
+	}
+	try {
+		await mod.default();
+	} catch (e) {
+		if (e instanceof LibsqlError) {
+			throw new AstroDbError(EXEC_ERROR(e.message));
+		}
+		throw e;
+	}
+}
+
+/**
+ * Inspired by Astro content collection config loader.
+ */
+async function getTempViteServer({ viteConfig }: { viteConfig: UserConfig }) {
+	const tempViteServer = await createServer(
+		mergeConfig(viteConfig, {
+			server: { middlewareMode: true, hmr: false, watch: null },
+			optimizeDeps: { noDiscovery: true },
+			ssr: { external: [] },
+			logLevel: 'silent',
+		})
+	);
+
+	const hotSend = tempViteServer.hot.send;
+	tempViteServer.hot.send = (payload: HMRPayload) => {
+		if (payload.type === 'error') {
+			throw payload.err;
+		}
+		return hotSend(payload);
+	};
+
+	return tempViteServer;
+}