v0fix: fixed non-default pglite db name not actually changing the db used

Removed default clientPgLitePath from the runtimeConfig, it is now a runtime
only option and has been changed to a function (so it can be passed the db
name).

Author: alanscodelog

README.md

@@ -187,7 +187,7 @@ There are several things to keep in mind when using the client side db:
 
 - While the resolved migrationJson location is added to the public runtime config, it cannot be used to import it dynamically since dynamic imports don't work with variables.
 - **The client options are exposed to the public runtime config.** There is no such thing as the private runtimeConfig client side.
-- `migrate` will try to skip migrations if at all possible. Doing a drizzle migration, even if nothing needs to be done, is expensive (~1500ms), so `migrate` stores a localstorage key `db:lastMigrationHash` (configurable) to prevent unnecessary calls to drizzle's migrate. If the database is configured to use indexedDb, it exists, and the last known hash matches the last migration hash, migration is skipped, reducing the time for non-migrations to around 4-5ms. 
+- `migrate` will try to skip migrations if at all possible. Doing a drizzle migration, even if nothing needs to be done, is expensive (~1500ms), so `migrate` stores a localstorage key `db:lastMigrationHash:[NAME (if  provided)]` (configurable) to prevent unnecessary calls to drizzle's migrate. If the database is configured to use indexedDb, it exists, and the last known hash matches the last migration hash, migration is skipped, reducing the time for non-migrations to around 4-5ms. 
 
 ## Using a Local Server Database for Testing
 
@@ -201,15 +201,15 @@ The client db can be used in electron or other contexts that support it. You wil
 
 Electron example using [@witchcraft/nuxt-electron](TODO):
 ```ts
-const db = await useClientDb("name", {
+const db = await useClientDb("NAME", {
 	schema,
 	clientMigrationOptions: {
 		migrationJson,
 		migrationsLogger: useElectronLogger(),
 	},
 	...STATIC.ELECTRON_RUNTIME_CONFIG.postgres,
 	// we need to override the filepath so it can write to disk
-	clientPgLitePath: path.join(userDataDir, "db.pglite"),
+	clientPgLitePath: (name) => path.join(userDataDir, `${name}.pglite`),
 }, {
 	logger: useElectronLogger(),
 	// import.meta.client is not defined

src/module.ts

@@ -115,12 +115,6 @@ export type ClientPostgresOptions = {
 	 * @default false
 	 */
 	useClientDb: boolean
-	/**
-	 * Where to store the client side PGlite database.
-	 *
-	 * @default "idb://[NAME]" (indexeddb)
-	 */
-	clientPgLitePath: string
 
 	/**
 	 * Whether to generate a client migrations json file for use with the client side PGlite database.
@@ -208,7 +202,6 @@ export default defineNuxtModule<ModuleOptions>({
 		generateDrizzleClientMigrationsJson: undefined as any as boolean,
 		useClientDb: false,
 		devAutoGenerateMigrations: false,
-		clientPgLitePath: "idb://local-pglite",
 		autoMigrateClientDb: true,
 		eventContextKeyName: "$postgres",
 		aliasServerImport: "~~/server/postgres"
@@ -250,7 +243,6 @@ export default defineNuxtModule<ModuleOptions>({
 		delete privateOptions.useClientDb
 		delete privateOptions.useWebWorker
 		delete privateOptions.generateClientMigrationsJson
-		delete privateOptions.clientPgLitePath
 
 		const serverConfig = nuxt.options.runtimeConfig.postgres.serverMigrationConfig
 		serverConfig.migrationsFolder = path.relative(nuxt.options.rootDir, resolveAlias(serverConfig.migrationsFolder, nuxt.options.alias))
@@ -263,7 +255,6 @@ export default defineNuxtModule<ModuleOptions>({
 				nuxt.options.runtimeConfig.public.postgres as any,
 				{
 					clientMigrationConfig: options.clientMigrationConfig,
-					clientPgLitePath: options.clientPgLitePath,
 					autoMigrateClientDb: options.autoMigrateClientDb
 				}
 			)

src/runtime/utils/clientDatabaseManager.ts

@@ -61,6 +61,12 @@ type AllOptions = Partial<Omit<ClientPostgresOptions, "clientMigrationConfig"> &
 	clientPgliteOptions: ClientPostgresOptions["clientPgliteOptions"] & {
 		extensions?: PGliteOptions["extensions"]
 	}
+	/**
+	 * A function that return the filepath for the PGlite database. See {@link https://pglite.dev/docs/filesystems}.
+	 *
+	 * @default "idb://[NAME]" (indexeddb)
+	 */
+	clientPgLitePath?: ((name: string) => string)
 	/** Custom proxy function, in this case a drizzleProxy is created instead of a client, and the database manager passes a wrapper so you can also get the name of the database you're proxying to, the rest of the params are just like the ones in the drizzle proxy docs. */
 	drizzleProxy: (name: string, sql: string, params: any[], method: "all" | "run" | "get" | "values") => Promise<any>
 	/** The schema to use for the client side database. This must be defined unless a proxy is being used. */
@@ -118,18 +124,19 @@ export class ClientDatabaseManager {
 			console.warn("No schema for a client side database was provided. This is not recommended. Drizzle will not be able to do db.query type queries. Schema can only safely not be defined if using drizzleProxy (as it would be defined on the real instance).")
 		}
 
+		const dbPath = opts.clientPgLitePath?.(name) ?? `idb://${name}`
 		const client = opts.drizzleProxy
 			? undefined
 			: (opts.useWebWorker
 					? new PGliteWorker(
 						new Worker(opts.webWorkerUrl ?? new URL("./../worker.js", import.meta.url), { type: "module" }),
 						{
-							dataDir: opts.clientPgLitePath ?? `idb:// ${name}`,
+							dataDir: dbPath,
 							meta: { options: clientPgliteOptions }
 							// extensions
 						}
 					)
-					: new PGlite(opts.clientPgLitePath ?? `idb://${name}`, clientPgliteOptions))
+					: new PGlite(dbPath, clientPgliteOptions))
 
 		const migrationOptions = opts.clientMigrationOptions ?? {}
 
@@ -144,7 +151,7 @@ export class ClientDatabaseManager {
 				...ClientDatabaseManager.defaultMigrationState,
 				storage: migrationOptions.storage ?? ClientDatabaseManager.useDefaultStorage()
 			},
-			path: opts?.clientPgLitePath ?? `idb://${name}`
+			path: dbPath
 
 		}
 		this.databases.set(name, entry)