Better debugging for the ORM [WIP]

drizzle-orm/src/errors.ts

@@ -13,7 +13,8 @@ export class DrizzleError extends Error {
 export class TransactionRollbackError extends DrizzleError {
 	static override readonly [entityKind]: string = 'TransactionRollbackError';
 
-	constructor() {
-		super({ message: 'Rollback' });
+	constructor(message?: string, readonly details?: Record<string, any>) {
+		super({ message: `Rollback${message ? `: ${message}` : ''}` });
+		this.name = 'TransactionRollbackError';
 	}
 }

drizzle-orm/src/index.ts

@@ -11,5 +11,6 @@ export * from './relations.ts';
 export * from './sql/index.ts';
 export * from './subquery.ts';
 export * from './table.ts';
+export * from './tracer.ts';
 export * from './utils.ts';
 export * from './view-common.ts';

drizzle-orm/src/logger.ts

@@ -1,7 +1,26 @@
 import { entityKind } from '~/entity.ts';
 
-export interface Logger {
-	logQuery(query: string, params: unknown[]): void;
+export abstract class Logger {
+	/** @internal */
+	transaction?: {
+		name: string;
+		type: 'transaction' | 'savepoint';
+	};
+
+	/** @internal */
+	setTransactionDetails(details: {
+		name: string;
+		type: 'transaction' | 'savepoint';
+	}): void {
+		this.transaction = details;
+	}
+
+	abstract logQuery(query: string, params: unknown[], duration: number, failed: boolean, transaction?: {
+		name: string;
+		type: 'transaction' | 'savepoint';
+	} | undefined): void;
+	abstract logTransactionBegin(name: string, type: 'transaction' | 'savepoint'): void;
+	abstract logTransactionEnd(name: string, type: 'transaction' | 'savepoint', status: 'commit' | 'rollback' | 'error', duration: number): void;
 }
 
 export interface LogWriter {
@@ -16,16 +35,20 @@ export class ConsoleLogWriter implements LogWriter {
 	}
 }
 
-export class DefaultLogger implements Logger {
+export class DefaultLogger extends Logger {
 	static readonly [entityKind]: string = 'DefaultLogger';
 
 	readonly writer: LogWriter;
 
 	constructor(config?: { writer: LogWriter }) {
+		super();
 		this.writer = config?.writer ?? new ConsoleLogWriter();
 	}
 
-	logQuery(query: string, params: unknown[]): void {
+	logQuery(query: string, params: unknown[], duration: number, failed: boolean, transaction?: {
+		name: string;
+		type: 'transaction' | 'savepoint';
+	} | undefined): void {
 		const stringifiedParams = params.map((p) => {
 			try {
 				return JSON.stringify(p);
@@ -34,14 +57,35 @@ export class DefaultLogger implements Logger {
 			}
 		});
 		const paramsStr = stringifiedParams.length ? ` -- params: [${stringifiedParams.join(', ')}]` : '';
-		this.writer.write(`Query: ${query}${paramsStr}`);
+		const durationStr = ` [${Math.round(duration)}ms]`;
+		const openingStr = failed ? 'Failed query' : 'Query';
+		const transactionStr = transaction ? ` in ${transaction.type} ${transaction.name}` : '';
+		this.writer.write(`${openingStr}${transactionStr}${durationStr}: ${query}${paramsStr}`);
+	}
+
+	logTransactionBegin(name: string, type: 'transaction' | 'savepoint'): void {
+		this.writer.write(`Begin ${type} ${name}`);
+	}
+
+	logTransactionEnd(name: string, type: 'transaction' | 'savepoint', status: 'commit' | 'rollback' | 'error', duration: number): void {
+		const statusStr = status === 'commit' ? 'Commit' : status === 'rollback' ? 'Rollback' : 'Failed';
+		const durationStr = ` [${Math.round(duration)}ms]`;
+		this.writer.write(`${statusStr} ${type} ${name}${durationStr}`);
 	}
 }
 
-export class NoopLogger implements Logger {
+export class NoopLogger extends Logger {
 	static readonly [entityKind]: string = 'NoopLogger';
 
 	logQuery(): void {
 		// noop
 	}
+
+	logTransactionBegin(): void {
+		// noop
+	}
+
+	logTransactionEnd(): void {
+		// noop
+	}
 }