Add option to set headers when using Turso/libSQL

drizzle-kit/package.json

@@ -56,6 +56,7 @@
 		"@hono/node-server": "^1.9.0",
 		"@hono/zod-validator": "^0.2.1",
 		"@libsql/client": "^0.10.0",
+		"@libsql/isomorphic-fetch": "^0.3.1",
 		"@neondatabase/serverless": "^0.9.1",
 		"@originjs/vite-plugin-commonjs": "^1.0.3",
 		"@planetscale/database": "^1.16.0",

drizzle-kit/src/cli/connections.ts

@@ -7,7 +7,7 @@ import { assertUnreachable } from '../global';
 import type { ProxyParams } from '../serializer/studio';
 import {
 	type DB,
-	LibSQLDB,
+	type LibSQLDB,
 	normalisePGliteUrl,
 	normaliseSQLiteUrl,
 	type Proxy,
@@ -16,7 +16,7 @@ import {
 } from '../utils';
 import { assertPackages, checkPackage } from './utils';
 import { GelCredentials } from './validations/gel';
-import { LibSQLCredentials } from './validations/libsql';
+import type { LibSQLCredentials } from './validations/libsql';
 import type { MysqlCredentials } from './validations/mysql';
 import { withStyle } from './validations/outputs';
 import type { PostgresCredentials } from './validations/postgres';
@@ -1209,12 +1209,21 @@ export const connectToLibSQL = async (credentials: LibSQLCredentials): Promise<
 > => {
 	if (await checkPackage('@libsql/client')) {
 		const { createClient } = await import('@libsql/client');
+		const { fetch: libsqlFetch } = await import('@libsql/isomorphic-fetch');
 		const { drizzle } = await import('drizzle-orm/libsql');
 		const { migrate } = await import('drizzle-orm/libsql/migrator');
 
 		const client = createClient({
 			url: normaliseSQLiteUrl(credentials.url, 'libsql'),
 			authToken: credentials.authToken,
+			...(credentials.headers && {
+				fetch: async (request: Request) => {
+					for (const [key, value] of Object.entries(credentials.headers!)) {
+						request.headers.set(key, value);
+					}
+					return libsqlFetch(request);
+				},
+			}),
 		});
 		const drzl = drizzle(client);
 		const migrateFn = async (config: MigrationConfig) => {

drizzle-kit/src/cli/validations/libsql.ts

@@ -1,16 +1,18 @@
 import { softAssertUnreachable } from 'src/global';
-import { object, string, TypeOf } from 'zod';
+import { object, record, string, TypeOf } from 'zod';
 import { error } from '../views';
 import { wrapParam } from './common';
 
 export const libSQLCredentials = object({
 	url: string().min(1),
 	authToken: string().min(1).optional(),
+	headers: record(string().min(1)).optional(),
 });
 
 export type LibSQLCredentials = {
 	url: string;
 	authToken?: string;
+	headers?: Record<string, string>;
 };
 
 const _: LibSQLCredentials = {} as TypeOf<typeof libSQLCredentials>;
@@ -23,5 +25,6 @@ export const printConfigConnectionIssues = (
 	console.log(error(text));
 	console.log(wrapParam('url', options.url));
 	console.log(wrapParam('authToken', options.authToken, true, 'secret'));
+	console.log(wrapParam('headers', options.headers, true));
 	process.exit(1);
 };

drizzle-kit/src/cli/validations/sqlite.ts

@@ -1,5 +1,5 @@
 import { softAssertUnreachable } from 'src/global';
-import { literal, object, string, TypeOf, undefined, union } from 'zod';
+import { literal, object, record, string, type TypeOf, undefined, union } from 'zod';
 import { error } from '../views';
 import { sqliteDriver, wrapParam } from './common';
 
@@ -8,6 +8,7 @@ export const sqliteCredentials = union([
 		driver: literal('turso'),
 		url: string().min(1),
 		authToken: string().min(1).optional(),
+		headers: record(string()).optional(),
 	}),
 	object({
 		driver: literal('d1-http'),

drizzle-kit/src/index.ts

@@ -136,6 +136,7 @@ export type Config =
 			dbCredentials: {
 				url: string;
 				authToken?: string;
+				headers?: Record<string, string>;
 			};
 		}
 		| {

drizzle-kit/tests/validations.test.ts

@@ -22,6 +22,18 @@ test('turso #2', () => {
 });
 
 test('turso #3', () => {
+	sqliteCredentials.parse({
+		dialect: 'sqlite',
+		driver: 'turso',
+		url: 'https://turso.tech',
+		authToken: 'token',
+		headers: {
+			'x-namespace': 'prod',
+		},
+	});
+});
+
+test('turso #4', () => {
 	expect(() =>
 		sqliteCredentials.parse({
 			dialect: 'sqlite',
@@ -32,7 +44,7 @@ test('turso #3', () => {
 	).toThrowError();
 });
 
-test('turso #4', () => {
+test('turso #5', () => {
 	expect(() => {
 		sqliteCredentials.parse({
 			dialect: 'sqlite',
@@ -43,13 +55,25 @@ test('turso #4', () => {
 	}).toThrowError();
 });
 
-test('turso #5', () => {
+test('turso #6', () => {
+	expect(() => {
+		sqliteCredentials.parse({
+			dialect: 'sqlite',
+			driver: 'turso',
+			url: '',
+			authToken: '',
+		});
+	}).toThrowError();
+});
+
+test('turso #7', () => {
 	expect(() => {
 		sqliteCredentials.parse({
 			dialect: 'sqlite',
 			driver: 'turso',
 			url: '',
 			authToken: '',
+			headers: {},
 		});
 	}).toThrowError();
 });