@prisma/client-engine-runtime 6.7.0-dev.2 → 6.7.0-dev.20

package/dist/index.mjs

@@ -1,3 +1,173 @@
+// src/interpreter/QueryInterpreter.ts
+import { SpanKind } from "@opentelemetry/api";
+
+// src/utils.ts
+function assertNever(_, message) {
+  throw new Error(message);
+}
+
+// src/tracing.ts
+var noopTracingHelper = {
+  runInChildSpan(_, callback) {
+    return callback();
+  }
+};
+function providerToOtelSystem(provider) {
+  switch (provider) {
+    case "postgres":
+      return "postgresql";
+    case "mysql":
+      return "mysql";
+    case "sqlite":
+      return "sqlite";
+    default:
+      assertNever(provider, `Unknown provider: ${provider}`);
+  }
+}
+
+// src/UserFacingError.ts
+import { isDriverAdapterError } from "@prisma/driver-adapter-utils";
+var UserFacingError = class extends Error {
+  name = "UserFacingError";
+  code;
+  meta;
+  constructor(message, code, meta) {
+    super(message);
+    this.code = code;
+    this.meta = meta;
+  }
+  toQueryResponseErrorObject() {
+    return {
+      error: this.message,
+      user_facing_error: {
+        is_panic: false,
+        message: this.message,
+        meta: this.meta,
+        error_code: this.code
+      }
+    };
+  }
+};
+function rethrowAsUserFacing(error) {
+  if (!isDriverAdapterError(error)) {
+    throw error;
+  }
+  const code = getErrorCode(error);
+  const message = renderErrorMessage(error);
+  if (!code || !message) {
+    throw error;
+  }
+  throw new UserFacingError(message, code, error);
+}
+function getErrorCode(err) {
+  switch (err.cause.kind) {
+    case "AuthenticationFailed":
+      return "P1000";
+    case "DatabaseDoesNotExist":
+      return "P1003";
+    case "SocketTimeout":
+      return "P1008";
+    case "DatabaseAlreadyExists":
+      return "P1009";
+    case "DatabaseAccessDenied":
+      return "P1010";
+    case "LengthMismatch":
+      return "P2000";
+    case "UniqueConstraintViolation":
+      return "P2002";
+    case "ForeignKeyConstraintViolation":
+      return "P2003";
+    case "UnsupportedNativeDataType":
+      return "P2010";
+    case "NullConstraintViolation":
+      return "P2011";
+    case "TableDoesNotExist":
+      return "P2021";
+    case "ColumnNotFound":
+      return "P2022";
+    case "InvalidIsolationLevel":
+      return "P2023";
+    case "TransactionWriteConflict":
+      return "P2034";
+    case "GenericJs":
+      return "P2036";
+    case "TooManyConnections":
+      return "P2037";
+    case "postgres":
+    case "sqlite":
+    case "mysql":
+      return;
+    default:
+      assertNever(err.cause, `Unknown error: ${err.cause}`);
+  }
+}
+function renderErrorMessage(err) {
+  switch (err.cause.kind) {
+    case "AuthenticationFailed": {
+      const user = err.cause.user ?? "(not available)";
+      return `Authentication failed against the database server, the provided database credentials for \`${user}\` are not valid`;
+    }
+    case "DatabaseDoesNotExist": {
+      const db = err.cause.db ?? "(not available)";
+      return `Database \`${db}\` does not exist on the database server`;
+    }
+    case "SocketTimeout":
+      return `Operation has timed out`;
+    case "DatabaseAlreadyExists": {
+      const db = err.cause.db ?? "(not available)";
+      return `Database \`${db}\` already exists on the database server`;
+    }
+    case "DatabaseAccessDenied": {
+      const db = err.cause.db ?? "(not available)";
+      return `User was denied access on the database \`${db}\``;
+    }
+    case "LengthMismatch": {
+      const column = err.cause.column ?? "(not available)";
+      return `The provided value for the column is too long for the column's type. Column: ${column}`;
+    }
+    case "UniqueConstraintViolation":
+      return `Unique constraint failed on the ${renderConstraint({ fields: err.cause.fields })}`;
+    case "ForeignKeyConstraintViolation":
+      return `Foreign key constraint violated on the ${renderConstraint(err.cause.constraint)}`;
+    case "UnsupportedNativeDataType":
+      return `Failed to deserialize column of type '${err.cause.type}'. If you're using $queryRaw and this column is explicitly marked as \`Unsupported\` in your Prisma schema, try casting this column to any supported Prisma type such as \`String\`.`;
+    case "NullConstraintViolation":
+      return `Null constraint violation on the ${renderConstraint({ fields: err.cause.fields })}`;
+    case "TableDoesNotExist": {
+      const table = err.cause.table ?? "(not available)";
+      return `The table \`${table}\` does not exist in the current database.`;
+    }
+    case "ColumnNotFound": {
+      const column = err.cause.column ?? "(not available)";
+      return `The column \`${column}\` does not exist in the current database.`;
+    }
+    case "InvalidIsolationLevel":
+      return `Invalid isolation level \`${err.cause.level}\``;
+    case "TransactionWriteConflict":
+      return `Transaction failed due to a write conflict or a deadlock. Please retry your transaction`;
+    case "GenericJs":
+      return `Error in external connector (id ${err.cause.id})`;
+    case "TooManyConnections":
+      return `Too many database connections opened: ${err.cause.cause}`;
+    case "sqlite":
+    case "postgres":
+    case "mysql":
+      return;
+    default:
+      assertNever(err.cause, `Unknown error: ${err.cause}`);
+  }
+}
+function renderConstraint(constraint) {
+  if (constraint && "fields" in constraint) {
+    return `fields: (${constraint.fields.map((field) => `\`${field}\``).join(", ")})`;
+  } else if (constraint && "index" in constraint) {
+    return `constraint: \`${constraint.index}\``;
+  } else if (constraint && "foreignKey" in constraint) {
+    return `foreign key`;
+  }
+  return "(not available)";
+}
+
 // src/interpreter/generators.ts
 import cuid1 from "@bugsnag/cuid";
 import { createId as cuid2 } from "@paralleldrive/cuid2";
@@ -12,6 +182,7 @@ var GeneratorRegistry = class {
     this.register("cuid", new CuidGenerator());
     this.register("ulid", new UlidGenerator());
     this.register("nanoid", new NanoIdGenerator());
+    this.register("product", new ProductGenerator());
   }
   /**
    * Returns a snapshot of the generator registry. It's 'frozen' in time at the moment of this
@@ -74,6 +245,22 @@ var NanoIdGenerator = class {
     }
   }
 };
+var ProductGenerator = class {
+  generate(lhs, rhs) {
+    if (lhs === void 0 || rhs === void 0) {
+      throw new Error("Invalid Product generator arguments");
+    }
+    if (Array.isArray(lhs) && Array.isArray(rhs)) {
+      return lhs.flatMap((l) => rhs.map((r) => [l, r]));
+    } else if (Array.isArray(lhs)) {
+      return lhs.map((l) => [l, rhs]);
+    } else if (Array.isArray(rhs)) {
+      return rhs.map((r) => [lhs, r]);
+    } else {
+      return [[lhs, rhs]];
+    }
+  }
+};
 
 // src/QueryPlan.ts
 function isPrismaValuePlaceholder(value) {
@@ -83,46 +270,49 @@ function isPrismaValueGenerator(value) {
   return typeof value === "object" && value !== null && value["prisma__type"] === "generatorCall";
 }
 
-// src/utils.ts
-function assertNever(_, message) {
-  throw new Error(message);
-}
-
 // src/interpreter/renderQuery.ts
 function renderQuery(dbQuery, scope, generators) {
   const queryType = dbQuery.type;
   switch (queryType) {
     case "rawSql":
-      return renderRawSql(dbQuery.sql, substituteParams(dbQuery.params, scope, generators));
+      return renderRawSql(dbQuery.sql, evaluateParams(dbQuery.params, scope, generators));
     case "templateSql":
       return renderTemplateSql(
         dbQuery.fragments,
         dbQuery.placeholderFormat,
-        substituteParams(dbQuery.params, scope, generators)
+        evaluateParams(dbQuery.params, scope, generators)
       );
     default:
       assertNever(queryType, `Invalid query type`);
   }
 }
-function substituteParams(params, scope, generators) {
-  return params.map((param) => {
-    if (isPrismaValueGenerator(param)) {
-      const { name, args } = param.prisma__value;
+function evaluateParams(params, scope, generators) {
+  return params.map((param) => evaluateParam(param, scope, generators));
+}
+function evaluateParam(param, scope, generators) {
+  let value = param;
+  while (doesRequireEvaluation(value)) {
+    if (isPrismaValuePlaceholder(value)) {
+      const found = scope[value.prisma__value.name];
+      if (found === void 0) {
+        throw new Error(`Missing value for query variable ${value.prisma__value.name}`);
+      }
+      value = found;
+    } else if (isPrismaValueGenerator(value)) {
+      const { name, args } = value.prisma__value;
       const generator = generators[name];
       if (!generator) {
         throw new Error(`Encountered an unknown generator '${name}'`);
       }
-      return generator.generate(...args);
-    }
-    if (!isPrismaValuePlaceholder(param)) {
-      return param;
-    }
-    const value = scope[param.prisma__value.name];
-    if (value === void 0) {
-      throw new Error(`Missing value for query variable ${param.prisma__value.name}`);
+      value = generator.generate(...args.map((arg) => evaluateParam(arg, scope, generators)));
+    } else {
+      assertNever(value, `Unexpected unevaluated value type: ${value}`);
     }
-    return value;
-  });
+  }
+  if (Array.isArray(value)) {
+    value = value.map((el) => evaluateParam(el, scope, generators));
+  }
+  return value;
 }
 function renderTemplateSql(fragments, placeholderFormat, params) {
   let paramIndex = 0;
@@ -151,6 +341,29 @@ function renderTemplateSql(fragments, placeholderFormat, params) {
         }).join(",");
         return `(${placeholders})`;
       }
+      case "parameterTupleList": {
+        if (paramIndex >= params.length) {
+          throw new Error(`Malformed query template. Fragments attempt to read over ${params.length} parameters.`);
+        }
+        const paramValue = params[paramIndex++];
+        if (!Array.isArray(paramValue)) {
+          throw new Error(`Malformed query template. Tuple list expected.`);
+        }
+        if (paramValue.length === 0) {
+          throw new Error(`Malformed query template. Tuple list cannot be empty.`);
+        }
+        const tupleList = paramValue.map((tuple) => {
+          if (!Array.isArray(tuple)) {
+            throw new Error(`Malformed query template. Tuple expected.`);
+          }
+          const elements = tuple.map((value) => {
+            flattenedParams.push(value);
+            return formatPlaceholder(placeholderFormat, placeholderNumber++);
+          }).join(",");
+          return `(${elements})`;
+        }).join(",");
+        return tupleList;
+      }
       default:
         assertNever(fragmentType, "Invalid fragment type");
     }
@@ -209,6 +422,9 @@ function placeholderTypeToArgType(type) {
   }
   return mappedType;
 }
+function doesRequireEvaluation(param) {
+  return isPrismaValuePlaceholder(param) || isPrismaValueGenerator(param);
+}
 
 // src/interpreter/serialize.ts
 function serialize(resultSet) {
@@ -238,13 +454,17 @@ var QueryInterpreter = class {
   #placeholderValues;
   #onQuery;
   #generators = new GeneratorRegistry();
-  constructor({ transactionManager, placeholderValues, onQuery }) {
+  #tracingHelper;
+  constructor({ transactionManager, placeholderValues, onQuery, tracingHelper }) {
     this.#transactionManager = transactionManager;
     this.#placeholderValues = placeholderValues;
     this.#onQuery = onQuery;
+    this.#tracingHelper = tracingHelper;
   }
   async run(queryPlan, queryable) {
-    return this.interpretNode(queryPlan, queryable, this.#placeholderValues, this.#generators.snapshot());
+    return this.interpretNode(queryPlan, queryable, this.#placeholderValues, this.#generators.snapshot()).catch(
+      (e) => rethrowAsUserFacing(e)
+    );
   }
   async interpretNode(node, queryable, scope, generators) {
     switch (node.type) {
@@ -283,13 +503,13 @@ var QueryInterpreter = class {
       }
       case "execute": {
         const query = renderQuery(node.args, scope, generators);
-        return this.#withQueryEvent(query, async () => {
+        return this.#withQueryEvent(query, queryable, async () => {
           return await queryable.executeRaw(query);
         });
       }
       case "query": {
         const query = renderQuery(node.args, scope, generators);
-        return this.#withQueryEvent(query, async () => {
+        return this.#withQueryEvent(query, queryable, async () => {
           return serialize(await queryable.queryRaw(query));
         });
       }
@@ -350,24 +570,34 @@ var QueryInterpreter = class {
           throw e;
         }
       }
-      default: {
-        node;
-        throw new Error(`Unexpected node type: ${node.type}`);
-      }
+      default:
+        assertNever(node, `Unexpected node type: ${node.type}`);
     }
   }
-  async #withQueryEvent(query, execute) {
-    const timestamp = /* @__PURE__ */ new Date();
-    const startInstant = performance.now();
-    const result = await execute();
-    const endInstant = performance.now();
-    this.#onQuery?.({
-      timestamp,
-      duration: endInstant - startInstant,
-      query: query.sql,
-      params: query.args
-    });
-    return result;
+  #withQueryEvent(query, queryable, execute) {
+    return this.#tracingHelper.runInChildSpan(
+      {
+        name: "db_query",
+        kind: SpanKind.CLIENT,
+        attributes: {
+          "db.query.text": query.sql,
+          "db.system.name": providerToOtelSystem(queryable.provider)
+        }
+      },
+      async () => {
+        const timestamp = /* @__PURE__ */ new Date();
+        const startInstant = performance.now();
+        const result = await execute();
+        const endInstant = performance.now();
+        this.#onQuery?.({
+          timestamp,
+          duration: endInstant - startInstant,
+          query: query.sql,
+          params: query.args
+        });
+        return result;
+      }
+    );
   }
 };
 function isEmpty(value) {
@@ -412,6 +642,8 @@ function attachChildrenToParent(parentRecord, children) {
 function filterChildRecords(records, parentRecord, joinExpr) {
   if (Array.isArray(records)) {
     return records.filter((record) => childRecordMatchesParent(asRecord(record), parentRecord, joinExpr));
+  } else if (records === null) {
+    return null;
   } else {
     const record = asRecord(records);
     return childRecordMatchesParent(record, parentRecord, joinExpr) ? record : null;
@@ -446,11 +678,6 @@ var TransactionManagerError = class extends Error {
   }
   code = "P2028";
 };
-var TransactionDriverAdapterError = class extends TransactionManagerError {
-  constructor(message, errorParams) {
-    super(`Error from Driver Adapter: ${message}`, { ...errorParams.driverAdapterError });
-  }
-};
 var TransactionNotFoundError = class extends TransactionManagerError {
   constructor() {
     super(
@@ -468,7 +695,7 @@ var TransactionRolledBackError = class extends TransactionManagerError {
     super(`Transaction already closed: A ${operation} cannot be executed on a committed transaction`);
   }
 };
-var TransactionStartTimoutError = class extends TransactionManagerError {
+var TransactionStartTimeoutError = class extends TransactionManagerError {
   constructor() {
     super("Unable to start a transaction in the given time.");
   }
@@ -505,11 +732,20 @@ var TransactionManager = class {
   closedTransactions = [];
   driverAdapter;
   transactionOptions;
-  constructor({ driverAdapter, transactionOptions }) {
+  tracingHelper;
+  constructor({
+    driverAdapter,
+    transactionOptions,
+    tracingHelper
+  }) {
     this.driverAdapter = driverAdapter;
     this.transactionOptions = transactionOptions;
+    this.tracingHelper = tracingHelper;
   }
   async startTransaction(options) {
+    return await this.tracingHelper.runInChildSpan("start_transaction", () => this.#startTransactionImpl(options));
+  }
+  async #startTransactionImpl(options) {
     const validatedOptions = options !== void 0 ? this.validateOptions(options) : this.transactionOptions;
     const transaction = {
       id: await randomUUID(),
@@ -521,14 +757,7 @@ var TransactionManager = class {
     };
     this.transactions.set(transaction.id, transaction);
     transaction.timer = this.startTransactionTimeout(transaction.id, validatedOptions.maxWait);
-    let startedTransaction;
-    try {
-      startedTransaction = await this.driverAdapter.startTransaction(validatedOptions.isolationLevel);
-    } catch (error) {
-      throw new TransactionDriverAdapterError("Failed to start transaction.", {
-        driverAdapterError: error
-      });
-    }
+    const startedTransaction = await this.driverAdapter.startTransaction(validatedOptions.isolationLevel);
     switch (transaction.status) {
       case "waiting":
         transaction.transaction = startedTransaction;
@@ -538,7 +767,7 @@ var TransactionManager = class {
         transaction.timer = this.startTransactionTimeout(transaction.id, validatedOptions.timeout);
         return { id: transaction.id };
       case "timed_out":
-        throw new TransactionStartTimoutError();
+        throw new TransactionStartTimeoutError();
       case "running":
       case "committed":
       case "rolled_back":
@@ -550,12 +779,16 @@ var TransactionManager = class {
     }
   }
   async commitTransaction(transactionId) {
-    const txw = this.getActiveTransaction(transactionId, "commit");
-    await this.closeTransaction(txw, "committed");
+    return await this.tracingHelper.runInChildSpan("commit_transaction", async () => {
+      const txw = this.getActiveTransaction(transactionId, "commit");
+      await this.closeTransaction(txw, "committed");
+    });
   }
   async rollbackTransaction(transactionId) {
-    const txw = this.getActiveTransaction(transactionId, "rollback");
-    await this.closeTransaction(txw, "rolled_back");
+    return await this.tracingHelper.runInChildSpan("rollback_transaction", async () => {
+      const txw = this.getActiveTransaction(transactionId, "rollback");
+      await this.closeTransaction(txw, "rolled_back");
+    });
   }
   getTransaction(txInfo, operation) {
     const tx = this.getActiveTransaction(txInfo.id, operation);
@@ -611,24 +844,12 @@ var TransactionManager = class {
     debug("Closing transaction.", { transactionId: tx.id, status });
     tx.status = status;
     if (tx.transaction && status === "committed") {
-      try {
-        await tx.transaction.commit();
-      } catch (error) {
-        throw new TransactionDriverAdapterError("Failed to commit transaction.", {
-          driverAdapterError: error
-        });
-      }
+      await tx.transaction.commit();
       if (!tx.transaction.options.usePhantomQuery) {
         await tx.transaction.executeRaw(COMMIT_QUERY());
       }
     } else if (tx.transaction) {
-      try {
-        await tx.transaction.rollback();
-      } catch (error) {
-        throw new TransactionDriverAdapterError("Failed to rollback transaction.", {
-          driverAdapterError: error
-        });
-      }
+      await tx.transaction.rollback();
       if (!tx.transaction.options.usePhantomQuery) {
         await tx.transaction.executeRaw(ROLLBACK_QUERY());
       }
@@ -656,6 +877,8 @@ export {
   QueryInterpreter,
   TransactionManager,
   TransactionManagerError,
+  UserFacingError,
   isPrismaValueGenerator,
-  isPrismaValuePlaceholder
+  isPrismaValuePlaceholder,
+  noopTracingHelper
 };

package/dist/interpreter/QueryInterpreter.d.ts

@@ -1,6 +1,7 @@
 import { SqlQueryable } from '@prisma/driver-adapter-utils';
 import { QueryEvent } from '../events';
 import { QueryPlanNode } from '../QueryPlan';
+import { type TracingHelper } from '../tracing';
 import { type TransactionManager } from '../transactionManager/TransactionManager';
 export type QueryInterpreterTransactionManager = {
     enabled: true;
@@ -12,10 +13,11 @@ export type QueryInterpreterOptions = {
     transactionManager: QueryInterpreterTransactionManager;
     placeholderValues: Record<string, unknown>;
     onQuery?: (event: QueryEvent) => void;
+    tracingHelper: TracingHelper;
 };
 export declare class QueryInterpreter {
     #private;
-    constructor({ transactionManager, placeholderValues, onQuery }: QueryInterpreterOptions);
+    constructor({ transactionManager, placeholderValues, onQuery, tracingHelper }: QueryInterpreterOptions);
     run(queryPlan: QueryPlanNode, queryable: SqlQueryable): Promise<unknown>;
     private interpretNode;
 }

package/dist/tracing.d.ts

@@ -0,0 +1,11 @@
+import type { Context, Span, SpanOptions } from '@opentelemetry/api';
+import type { Provider } from '@prisma/driver-adapter-utils';
+export type SpanCallback<R> = (span?: Span, context?: Context) => R;
+export type ExtendedSpanOptions = SpanOptions & {
+    name: string;
+};
+export interface TracingHelper {
+    runInChildSpan<R>(nameOrOptions: string | ExtendedSpanOptions, callback: SpanCallback<R>): R;
+}
+export declare const noopTracingHelper: TracingHelper;
+export declare function providerToOtelSystem(provider: Provider): string;

package/dist/transactionManager/TransactionManager.d.ts

@@ -1,13 +1,17 @@
 import { SqlDriverAdapter, Transaction } from '@prisma/driver-adapter-utils';
+import { TracingHelper } from '../tracing';
 import { Options, TransactionInfo } from './Transaction';
 export declare class TransactionManager {
+    #private;
     private transactions;
     private closedTransactions;
     private readonly driverAdapter;
     private readonly transactionOptions;
-    constructor({ driverAdapter, transactionOptions }: {
+    private readonly tracingHelper;
+    constructor({ driverAdapter, transactionOptions, tracingHelper, }: {
         driverAdapter: SqlDriverAdapter;
         transactionOptions: Options;
+        tracingHelper: TracingHelper;
     });
     startTransaction(options?: Options): Promise<TransactionInfo>;
     commitTransaction(transactionId: string): Promise<void>;

package/dist/transactionManager/TransactionManagerErrors.d.ts

@@ -1,14 +1,8 @@
-import { Error as DriverAdapterError } from '@prisma/driver-adapter-utils';
 export declare class TransactionManagerError extends Error {
     meta?: Record<string, unknown> | undefined;
     code: string;
     constructor(message: string, meta?: Record<string, unknown> | undefined);
 }
-export declare class TransactionDriverAdapterError extends TransactionManagerError {
-    constructor(message: string, errorParams: {
-        driverAdapterError: DriverAdapterError;
-    });
-}
 export declare class TransactionNotFoundError extends TransactionManagerError {
     constructor();
 }
@@ -18,7 +12,7 @@ export declare class TransactionClosedError extends TransactionManagerError {
 export declare class TransactionRolledBackError extends TransactionManagerError {
     constructor(operation: string);
 }
-export declare class TransactionStartTimoutError extends TransactionManagerError {
+export declare class TransactionStartTimeoutError extends TransactionManagerError {
     constructor();
 }
 export declare class TransactionExecutionTimeoutError extends TransactionManagerError {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prisma/client-engine-runtime",
-  "version": "6.7.0-dev.2",
+  "version": "6.7.0-dev.20",
   "description": "This package is intended for Prisma's internal use",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -25,12 +25,13 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@bugsnag/cuid": "3.2.1",
+    "@opentelemetry/api": "1.9.0",
     "@paralleldrive/cuid2": "2.2.2",
     "nanoid": "5.1.5",
     "ulid": "3.0.0",
     "uuid": "11.1.0",
-    "@prisma/debug": "6.7.0-dev.2",
-    "@prisma/driver-adapter-utils": "6.7.0-dev.2"
+    "@prisma/debug": "6.7.0-dev.20",
+    "@prisma/driver-adapter-utils": "6.7.0-dev.20"
   },
   "devDependencies": {
     "@types/jest": "29.5.14",