@prisma-next/sql-runtime 0.4.1 → 0.4.3

package/src/codecs/decoding.ts

@@ -1,221 +1,342 @@
-import type { ExecutionPlan } from '@prisma-next/contract/types';
-import type { Codec, CodecRegistry } from '@prisma-next/sql-relational-core/ast';
+import {
+  checkAborted,
+  isRuntimeError,
+  raceAgainstAbort,
+  runtimeError,
+} from '@prisma-next/framework-components/runtime';
+import type {
+  AnyQueryAst,
+  Codec,
+  CodecRegistry,
+  ContractCodecRegistry,
+  ProjectionItem,
+  SqlCodecCallContext,
+} from '@prisma-next/sql-relational-core/ast';
+import type { SqlExecutionPlan } from '@prisma-next/sql-relational-core/plan';
 import type { JsonSchemaValidatorRegistry } from '@prisma-next/sql-relational-core/query-lane-context';
 import { validateJsonValue } from './json-schema-validation';
 
-function resolveRowCodec(
-  alias: string,
-  plan: ExecutionPlan,
+type ColumnRef = { table: string; column: string };
+
+interface DecodeContext {
+  readonly aliases: ReadonlyArray<string> | undefined;
+  readonly codecs: ReadonlyMap<string, Codec>;
+  readonly columnRefs: ReadonlyMap<string, ColumnRef>;
+  readonly includeAliases: ReadonlySet<string>;
+}
+
+const WIRE_PREVIEW_LIMIT = 100;
+const EMPTY_INCLUDE_ALIASES: ReadonlySet<string> = new Set<string>();
+
+function isAstBackedPlan(
+  plan: SqlExecutionPlan,
+): plan is SqlExecutionPlan & { readonly ast: AnyQueryAst } {
+  return plan.ast !== undefined;
+}
+
+function projectionListFromAst(ast: AnyQueryAst): ReadonlyArray<ProjectionItem> | undefined {
+  if (ast.kind === 'select') {
+    return ast.projection;
+  }
+  return ast.returning;
+}
+
+/**
+ * Resolve the per-cell codec for a projection item.
+ *
+ * Phase B: when a `(table, column)` ref is available for the projection,
+ * prefer `contractCodecs.forColumn(table, column)` — that's the per-
+ * instance resolved codec materialized from the codec descriptor's
+ * factory at context-construction time (carries any per-instance state
+ * such as the compiled JSON-Schema validator). When the projection
+ * resolves to a non-`column-ref` expression (computed projections, raw
+ * SQL aliases) but still carries a codec id (ADR 205 stamps every
+ * `ProjectionItem` with the producer's codec id), fall back to the
+ * codec-id-keyed `forCodecId(codecId)` lookup, which itself falls back
+ * to the legacy `CodecRegistry` for codec ids the contract walk
+ * couldn't resolve.
+ *
+ * Codec-registry-unification spec § AC-4.
+ */
+function resolveProjectionCodec(
+  item: ProjectionItem,
+  registry: CodecRegistry,
+  contractCodecs: ContractCodecRegistry | undefined,
+): Codec | undefined {
+  if (item.expr.kind === 'column-ref' && contractCodecs) {
+    const byColumn = contractCodecs.forColumn(item.expr.table, item.expr.column);
+    if (byColumn) return byColumn;
+  }
+  if (item.codecId) {
+    const fromContract = contractCodecs?.forCodecId(item.codecId);
+    if (fromContract) return fromContract;
+    return registry.get(item.codecId);
+  }
+  return undefined;
+}
+
+function buildDecodeContext(
+  plan: SqlExecutionPlan,
   registry: CodecRegistry,
-): Codec | null {
-  const planCodecId = plan.meta.annotations?.codecs?.[alias] as string | undefined;
-  if (planCodecId) {
-    const codec = registry.get(planCodecId);
+  contractCodecs: ContractCodecRegistry | undefined,
+): DecodeContext {
+  if (!isAstBackedPlan(plan)) {
+    return {
+      aliases: undefined,
+      codecs: new Map(),
+      columnRefs: new Map(),
+      includeAliases: EMPTY_INCLUDE_ALIASES,
+    };
+  }
+
+  const projection = projectionListFromAst(plan.ast);
+  if (!projection) {
+    return {
+      aliases: undefined,
+      codecs: new Map(),
+      columnRefs: new Map(),
+      includeAliases: EMPTY_INCLUDE_ALIASES,
+    };
+  }
+
+  const aliases: string[] = [];
+  const codecs = new Map<string, Codec>();
+  const columnRefs = new Map<string, ColumnRef>();
+  const includeAliases = new Set<string>();
+
+  for (const item of projection) {
+    aliases.push(item.alias);
+
+    const codec = resolveProjectionCodec(item, registry, contractCodecs);
     if (codec) {
-      return codec;
+      codecs.set(item.alias, codec);
     }
-  }
 
-  if (plan.meta.projectionTypes) {
-    const typeId = plan.meta.projectionTypes[alias];
-    if (typeId) {
-      const codec = registry.get(typeId);
-      if (codec) {
-        return codec;
-      }
+    if (item.expr.kind === 'column-ref') {
+      columnRefs.set(item.alias, { table: item.expr.table, column: item.expr.column });
+    } else if (item.expr.kind === 'subquery' || item.expr.kind === 'json-array-agg') {
+      includeAliases.add(item.alias);
     }
   }
 
-  return null;
+  return { aliases, codecs, columnRefs, includeAliases };
 }
 
-type ColumnRefIndex = Map<string, { table: string; column: string }>;
+function previewWireValue(wireValue: unknown): string {
+  if (typeof wireValue === 'string') {
+    return wireValue.length > WIRE_PREVIEW_LIMIT
+      ? `${wireValue.substring(0, WIRE_PREVIEW_LIMIT)}...`
+      : wireValue;
+  }
+  return String(wireValue).substring(0, WIRE_PREVIEW_LIMIT);
+}
 
-/**
- * Builds a lookup index from column name → { table, column } ref.
- * Called once per decodeRow invocation to avoid O(aliases × refs) linear scans.
- */
-function buildColumnRefIndex(plan: ExecutionPlan): ColumnRefIndex | null {
-  const columns = plan.meta.refs?.columns;
-  if (!columns) return null;
+function isJsonSchemaValidationError(error: unknown): boolean {
+  return isRuntimeError(error) && error.code === 'RUNTIME.JSON_SCHEMA_VALIDATION_FAILED';
+}
+
+function wrapDecodeFailure(
+  error: unknown,
+  alias: string,
+  ref: ColumnRef | undefined,
+  codec: Codec,
+  wireValue: unknown,
+): never {
+  const message = error instanceof Error ? error.message : String(error);
+  const target = ref ? `${ref.table}.${ref.column}` : alias;
+  const wrapped = runtimeError(
+    'RUNTIME.DECODE_FAILED',
+    `Failed to decode column ${target} with codec '${codec.id}': ${message}`,
+    {
+      ...(ref ? { table: ref.table, column: ref.column } : { alias }),
+      codec: codec.id,
+      wirePreview: previewWireValue(wireValue),
+    },
+  );
+  wrapped.cause = error;
+  throw wrapped;
+}
+
+function wrapIncludeAggregateFailure(error: unknown, alias: string, wireValue: unknown): never {
+  const message = error instanceof Error ? error.message : String(error);
+  const wrapped = runtimeError(
+    'RUNTIME.DECODE_FAILED',
+    `Failed to parse JSON array for include alias '${alias}': ${message}`,
+    {
+      alias,
+      wirePreview: previewWireValue(wireValue),
+    },
+  );
+  wrapped.cause = error;
+  throw wrapped;
+}
+
+function decodeIncludeAggregate(alias: string, wireValue: unknown): unknown {
+  if (wireValue === null || wireValue === undefined) {
+    return [];
+  }
+
+  try {
+    let parsed: unknown;
+    if (typeof wireValue === 'string') {
+      parsed = JSON.parse(wireValue);
+    } else if (Array.isArray(wireValue)) {
+      parsed = wireValue;
+    } else {
+      parsed = JSON.parse(String(wireValue));
+    }
 
-  const index: ColumnRefIndex = new Map();
-  for (const ref of columns) {
-    index.set(ref.column, ref);
+    if (!Array.isArray(parsed)) {
+      throw new Error(`Expected array for include alias '${alias}', got ${typeof parsed}`);
+    }
+
+    return parsed;
+  } catch (error) {
+    wrapIncludeAggregateFailure(error, alias, wireValue);
   }
-  return index;
 }
 
-function parseProjectionRef(value: string): { table: string; column: string } | null {
-  if (value.startsWith('include:') || value.startsWith('operation:')) {
+/**
+ * Decodes a single field. Single-armed: every cell takes the same path —
+ * `codec.decode → await → JSON-Schema validate → return plain value` — so
+ * sync- and async-authored codecs are indistinguishable to callers.
+ *
+ * The row-level `rowCtx` is repackaged into a per-cell
+ * `SqlCodecCallContext` whose `column = { table, name }` is a structural
+ * projection of the per-cell `ColumnRef = { table, column }` resolved from
+ * the AST-backed `DecodeContext` (the same resolution `wrapDecodeFailure`
+ * uses for envelope construction — one resolution per cell, two consumers).
+ * Cells the runtime cannot resolve to a single underlying column (aggregate
+ * aliases, computed projections without a simple ref) get
+ * `column: undefined`, matching the spec contract that the runtime never
+ * silently defaults this field.
+ */
+async function decodeField(
+  alias: string,
+  wireValue: unknown,
+  decodeCtx: DecodeContext,
+  jsonValidators: JsonSchemaValidatorRegistry | undefined,
+  rowCtx: SqlCodecCallContext,
+): Promise<unknown> {
+  if (wireValue === null) {
     return null;
   }
 
-  const separatorIndex = value.indexOf('.');
-  if (separatorIndex <= 0 || separatorIndex === value.length - 1) {
-    return null;
+  const codec = decodeCtx.codecs.get(alias);
+  if (!codec) {
+    return wireValue;
   }
 
-  return {
-    table: value.slice(0, separatorIndex),
-    column: value.slice(separatorIndex + 1),
-  };
-}
+  const ref = decodeCtx.columnRefs.get(alias);
 
-function resolveColumnRefForAlias(
-  alias: string,
-  projection: ExecutionPlan['meta']['projection'],
-  fallbackColumnRefIndex: ColumnRefIndex | null,
-): { table: string; column: string } | undefined {
-  if (projection && !Array.isArray(projection)) {
-    const mappedRef = (projection as Record<string, string>)[alias];
-    if (typeof mappedRef !== 'string') {
-      return undefined;
+  // Per-cell ctx: the cell-level `column` is a `SqlColumnRef = { table, name }`
+  // projection of the resolved `ColumnRef = { table, column }` (same
+  // resolution `wrapDecodeFailure` uses below — no double work). Cells the
+  // runtime cannot resolve (aggregate aliases, computed projections without
+  // a simple ref) drop the `column` field entirely — explicitly cleared so
+  // a previously-populated `rowCtx.column` cannot leak through to unrelated
+  // cells. Destructuring (rather than `column: undefined`) is required
+  // because `SqlCodecCallContext.column` is declared `column?: SqlColumnRef`
+  // under `exactOptionalPropertyTypes`.
+  let cellCtx: SqlCodecCallContext;
+  if (ref) {
+    cellCtx = { ...rowCtx, column: { table: ref.table, name: ref.column } };
+  } else {
+    const { column: _drop, ...rowCtxWithoutColumn } = rowCtx;
+    cellCtx = rowCtxWithoutColumn;
+  }
+
+  let decoded: unknown;
+  try {
+    decoded = await codec.decode(wireValue, cellCtx);
+  } catch (error) {
+    wrapDecodeFailure(error, alias, ref, codec, wireValue);
+  }
+
+  if (jsonValidators && ref) {
+    try {
+      validateJsonValue(jsonValidators, ref.table, ref.column, decoded, 'decode', codec.id);
+    } catch (error) {
+      if (isJsonSchemaValidationError(error)) throw error;
+      wrapDecodeFailure(error, alias, ref, codec, wireValue);
     }
-    return parseProjectionRef(mappedRef) ?? undefined;
   }
 
-  return fallbackColumnRefIndex?.get(alias);
+  return decoded;
 }
 
-export function decodeRow(
+/**
+ * Decodes a row by dispatching all per-cell codec calls concurrently via
+ * `Promise.all`. Each cell follows the single-armed `decodeField` path.
+ * Failures are wrapped in `RUNTIME.DECODE_FAILED` with `{ table, column,
+ * codec }` (or `{ alias, codec }` when no column ref is resolvable) and the
+ * original error attached on `cause`.
+ *
+ * When `rowCtx.signal` is provided:
+ *
+ * - **Already-aborted at entry** short-circuits with `RUNTIME.ABORTED`
+ *   (`{ phase: 'decode' }`) before any `codec.decode` call is made.
+ * - **Mid-flight aborts** race the per-cell `Promise.all` against the
+ *   signal so the runtime returns promptly even when codec bodies ignore
+ *   it. In-flight bodies that ignore the signal complete in the
+ *   background (cooperative cancellation).
+ * - Existing `RUNTIME.DECODE_FAILED` envelopes from codec bodies pass
+ *   through unchanged (no double wrap).
+ */
+export async function decodeRow(
   row: Record<string, unknown>,
-  plan: ExecutionPlan,
+  plan: SqlExecutionPlan,
   registry: CodecRegistry,
-  jsonValidators?: JsonSchemaValidatorRegistry,
-): Record<string, unknown> {
-  const decoded: Record<string, unknown> = {};
-  const projection = plan.meta.projection;
+  jsonValidators: JsonSchemaValidatorRegistry | undefined,
+  rowCtx: SqlCodecCallContext,
+  contractCodecs?: ContractCodecRegistry,
+): Promise<Record<string, unknown>> {
+  checkAborted(rowCtx, 'decode');
+  const signal = rowCtx.signal;
 
-  // Fallback for plans that do not provide projection alias -> table.column mapping.
-  const fallbackColumnRefIndex =
-    jsonValidators && (!projection || Array.isArray(projection)) ? buildColumnRefIndex(plan) : null;
+  const decodeCtx = buildDecodeContext(plan, registry, contractCodecs);
 
-  let aliases: readonly string[];
-  if (projection && !Array.isArray(projection)) {
-    aliases = Object.keys(projection);
-  } else if (projection && Array.isArray(projection)) {
-    aliases = projection;
-  } else {
-    aliases = Object.keys(row);
-  }
-
-  for (const alias of aliases) {
-    const wireValue = row[alias];
-
-    const projectionValue =
-      projection && typeof projection === 'object' && !Array.isArray(projection)
-        ? (projection as Record<string, string>)[alias]
-        : undefined;
-
-    if (typeof projectionValue === 'string' && projectionValue.startsWith('include:')) {
-      if (wireValue === null || wireValue === undefined) {
-        decoded[alias] = [];
-        continue;
-      }
+  const aliases = decodeCtx.aliases ?? Object.keys(row);
 
-      try {
-        let parsed: unknown;
-        if (typeof wireValue === 'string') {
-          parsed = JSON.parse(wireValue);
-        } else if (Array.isArray(wireValue)) {
-          parsed = wireValue;
-        } else {
-          parsed = JSON.parse(String(wireValue));
-        }
-
-        if (!Array.isArray(parsed)) {
-          throw new Error(`Expected array for include alias '${alias}', got ${typeof parsed}`);
-        }
-
-        decoded[alias] = parsed;
-      } catch (error) {
-        const decodeError = new Error(
-          `Failed to parse JSON array for include alias '${alias}': ${error instanceof Error ? error.message : String(error)}`,
-        ) as Error & {
-          code: string;
-          category: string;
-          severity: string;
-          details?: Record<string, unknown>;
-        };
-        decodeError.code = 'RUNTIME.DECODE_FAILED';
-        decodeError.category = 'RUNTIME';
-        decodeError.severity = 'error';
-        decodeError.details = {
+  if (decodeCtx.aliases !== undefined) {
+    for (const alias of decodeCtx.aliases) {
+      if (!Object.hasOwn(row, alias)) {
+        throw runtimeError('RUNTIME.DECODE_FAILED', `Row missing projection alias "${alias}"`, {
           alias,
-          wirePreview:
-            typeof wireValue === 'string' && wireValue.length > 100
-              ? `${wireValue.substring(0, 100)}...`
-              : String(wireValue).substring(0, 100),
-        };
-        throw decodeError;
+          expectedAliases: decodeCtx.aliases,
+          presentKeys: Object.keys(row),
+        });
       }
-      continue;
     }
+  }
 
-    if (wireValue === null || wireValue === undefined) {
-      decoded[alias] = wireValue;
-      continue;
-    }
+  const tasks: Promise<unknown>[] = [];
+  const includeIndices: { index: number; alias: string; value: unknown }[] = [];
 
-    const codec = resolveRowCodec(alias, plan, registry);
+  for (let i = 0; i < aliases.length; i++) {
+    const alias = aliases[i] as string;
+    const wireValue = row[alias];
 
-    if (!codec) {
-      decoded[alias] = wireValue;
+    if (decodeCtx.includeAliases.has(alias)) {
+      includeIndices.push({ index: i, alias, value: wireValue });
+      tasks.push(Promise.resolve(undefined));
       continue;
     }
 
-    try {
-      const decodedValue = codec.decode(wireValue);
-
-      // Validate decoded JSON value against schema
-      if (jsonValidators) {
-        const ref = resolveColumnRefForAlias(alias, projection, fallbackColumnRefIndex);
-        if (ref) {
-          validateJsonValue(
-            jsonValidators,
-            ref.table,
-            ref.column,
-            decodedValue,
-            'decode',
-            codec.id,
-          );
-        }
-      }
+    tasks.push(decodeField(alias, wireValue, decodeCtx, jsonValidators, rowCtx));
+  }
 
-      decoded[alias] = decodedValue;
-    } catch (error) {
-      // Re-throw JSON schema validation errors as-is
-      if (
-        error instanceof Error &&
-        'code' in error &&
-        (error as Error & { code: string }).code === 'RUNTIME.JSON_SCHEMA_VALIDATION_FAILED'
-      ) {
-        throw error;
-      }
+  const settled = await raceAgainstAbort(Promise.all(tasks), signal, 'decode');
 
-      const decodeError = new Error(
-        `Failed to decode row alias '${alias}' with codec '${codec.id}': ${error instanceof Error ? error.message : String(error)}`,
-      ) as Error & {
-        code: string;
-        category: string;
-        severity: string;
-        details?: Record<string, unknown>;
-      };
-      decodeError.code = 'RUNTIME.DECODE_FAILED';
-      decodeError.category = 'RUNTIME';
-      decodeError.severity = 'error';
-      decodeError.details = {
-        alias,
-        codec: codec.id,
-        wirePreview:
-          typeof wireValue === 'string' && wireValue.length > 100
-            ? `${wireValue.substring(0, 100)}...`
-            : String(wireValue).substring(0, 100),
-      };
-      throw decodeError;
-    }
+  // Include aggregates are decoded synchronously after concurrent codec
+  // dispatch settles, so any decode failures upstream propagate first.
+  for (const entry of includeIndices) {
+    settled[entry.index] = decodeIncludeAggregate(entry.alias, entry.value);
   }
 
+  const decoded: Record<string, unknown> = {};
+  for (let i = 0; i < aliases.length; i++) {
+    decoded[aliases[i] as string] = settled[i];
+  }
   return decoded;
 }