@prisma-next/sql-runtime 0.3.0-dev.3 → 0.3.0-dev.30

package/src/sql-runtime.ts

@@ -0,0 +1,166 @@
+import type { ExecutionPlan } from '@prisma-next/contract/types';
+import type { OperationRegistry } from '@prisma-next/operations';
+import type {
+  Log,
+  Plugin,
+  RuntimeCore,
+  RuntimeCoreOptions,
+  RuntimeTelemetryEvent,
+  RuntimeVerifyOptions,
+  TelemetryOutcome,
+} from '@prisma-next/runtime-executor';
+import { AsyncIterableResult, createRuntimeCore } from '@prisma-next/runtime-executor';
+import type { SqlContract, SqlStorage } from '@prisma-next/sql-contract/types';
+import type {
+  Adapter,
+  CodecRegistry,
+  LoweredStatement,
+  SelectAst,
+  SqlDriver,
+} from '@prisma-next/sql-relational-core/ast';
+import type { SqlQueryPlan } from '@prisma-next/sql-relational-core/plan';
+import { decodeRow } from './codecs/decoding';
+import { encodeParams } from './codecs/encoding';
+import { validateCodecRegistryCompleteness } from './codecs/validation';
+import { lowerSqlPlan } from './lower-sql-plan';
+import type { RuntimeContext } from './sql-context';
+import { SqlFamilyAdapter } from './sql-family-adapter';
+
+export interface RuntimeOptions<
+  TContract extends SqlContract<SqlStorage> = SqlContract<SqlStorage>,
+> {
+  readonly driver: SqlDriver;
+  readonly verify: RuntimeVerifyOptions;
+  readonly context: RuntimeContext<TContract>;
+  readonly plugins?: readonly Plugin<
+    TContract,
+    Adapter<SelectAst, SqlContract<SqlStorage>, LoweredStatement>,
+    SqlDriver
+  >[];
+  readonly mode?: 'strict' | 'permissive';
+  readonly log?: Log;
+}
+
+export interface Runtime {
+  execute<Row = Record<string, unknown>>(
+    plan: ExecutionPlan<Row> | SqlQueryPlan<Row>,
+  ): AsyncIterableResult<Row>;
+  telemetry(): RuntimeTelemetryEvent | null;
+  close(): Promise<void>;
+  operations(): OperationRegistry;
+}
+
+export type { RuntimeTelemetryEvent, RuntimeVerifyOptions, TelemetryOutcome };
+
+class SqlRuntimeImpl<TContract extends SqlContract<SqlStorage> = SqlContract<SqlStorage>>
+  implements Runtime
+{
+  private readonly core: RuntimeCore<
+    TContract,
+    Adapter<SelectAst, SqlContract<SqlStorage>, LoweredStatement>,
+    SqlDriver
+  >;
+  private readonly contract: TContract;
+  private readonly context: RuntimeContext<TContract>;
+  private readonly codecRegistry: CodecRegistry;
+  private codecRegistryValidated: boolean;
+
+  constructor(options: RuntimeOptions<TContract>) {
+    const { context, driver, verify, plugins, mode, log } = options;
+    this.contract = context.contract;
+    this.context = context;
+    this.codecRegistry = context.codecs;
+    this.codecRegistryValidated = false;
+
+    const familyAdapter = new SqlFamilyAdapter(context.contract);
+
+    const coreOptions: RuntimeCoreOptions<
+      TContract,
+      Adapter<SelectAst, SqlContract<SqlStorage>, LoweredStatement>,
+      SqlDriver
+    > = {
+      familyAdapter,
+      driver,
+      verify,
+      plugins: plugins as readonly Plugin<
+        TContract,
+        Adapter<SelectAst, SqlContract<SqlStorage>, LoweredStatement>,
+        SqlDriver
+      >[],
+      ...(mode !== undefined ? { mode } : {}),
+      ...(log !== undefined ? { log } : {}),
+      operationRegistry: context.operations,
+    };
+
+    this.core = createRuntimeCore(coreOptions);
+
+    if (verify.mode === 'startup') {
+      validateCodecRegistryCompleteness(this.codecRegistry, context.contract);
+      this.codecRegistryValidated = true;
+    }
+  }
+
+  private ensureCodecRegistryValidated(contract: SqlContract<SqlStorage>): void {
+    if (!this.codecRegistryValidated) {
+      validateCodecRegistryCompleteness(this.codecRegistry, contract);
+      this.codecRegistryValidated = true;
+    }
+  }
+
+  execute<Row = Record<string, unknown>>(
+    plan: ExecutionPlan<Row> | SqlQueryPlan<Row>,
+  ): AsyncIterableResult<Row> {
+    this.ensureCodecRegistryValidated(this.contract);
+
+    // Check if plan is SqlQueryPlan (has ast but no sql)
+    const isSqlQueryPlan = (p: ExecutionPlan<Row> | SqlQueryPlan<Row>): p is SqlQueryPlan<Row> => {
+      return 'ast' in p && !('sql' in p);
+    };
+
+    // Lower SqlQueryPlan to Plan if needed
+    const executablePlan: ExecutionPlan<Row> = isSqlQueryPlan(plan)
+      ? lowerSqlPlan(this.context, plan)
+      : plan;
+
+    const iterator = async function* (
+      self: SqlRuntimeImpl<TContract>,
+    ): AsyncGenerator<Row, void, unknown> {
+      const encodedParams = encodeParams(executablePlan, self.codecRegistry);
+      const planWithEncodedParams: ExecutionPlan<Row> = {
+        ...executablePlan,
+        params: encodedParams,
+      };
+
+      const coreIterator = self.core.execute(planWithEncodedParams);
+
+      for await (const rawRow of coreIterator) {
+        const decodedRow = decodeRow(
+          rawRow as Record<string, unknown>,
+          executablePlan,
+          self.codecRegistry,
+        );
+        yield decodedRow as Row;
+      }
+    };
+
+    return new AsyncIterableResult(iterator(this));
+  }
+
+  telemetry(): RuntimeTelemetryEvent | null {
+    return this.core.telemetry();
+  }
+
+  operations(): OperationRegistry {
+    return this.core.operations();
+  }
+
+  close(): Promise<void> {
+    return this.core.close();
+  }
+}
+
+export function createRuntime<TContract extends SqlContract<SqlStorage>>(
+  options: RuntimeOptions<TContract>,
+): Runtime {
+  return new SqlRuntimeImpl(options);
+}

package/test/async-iterable-result.test.ts

@@ -0,0 +1,136 @@
+import type { ExecutionPlan } from '@prisma-next/contract/types';
+import type { AsyncIterableResult } from '@prisma-next/runtime-executor';
+import { describe, expect, it } from 'vitest';
+import { createRuntime } from '../src/exports';
+import { createStubAdapter, createTestContext, createTestContract } from './utils';
+
+// Mock driver that implements SqlDriver interface
+class MockDriver {
+  private rows: ReadonlyArray<Record<string, unknown>> = [];
+
+  setRows(rows: ReadonlyArray<Record<string, unknown>>): void {
+    this.rows = rows;
+  }
+
+  async query(
+    _sql: string,
+    _params: readonly unknown[],
+  ): Promise<{ rows: ReadonlyArray<unknown> }> {
+    // Return empty marker result for contract verification
+    return { rows: [] };
+  }
+
+  async *execute<Row = Record<string, unknown>>(_options: {
+    sql: string;
+    params: readonly unknown[];
+  }): AsyncIterable<Row> {
+    for (const row of this.rows) {
+      yield row as Row;
+    }
+  }
+
+  async connect(): Promise<void> {
+    // No-op
+  }
+
+  async close(): Promise<void> {
+    // No-op
+  }
+}
+
+const fixtureContract = createTestContract({
+  schemaVersion: '1',
+  targetFamily: 'sql',
+  target: 'postgres',
+  coreHash: 'test-hash',
+  profileHash: 'test-profile-hash',
+  storage: {
+    tables: {
+      user: {
+        columns: {
+          id: { nativeType: 'int4', codecId: 'pg/int4@1', nullable: false },
+          email: { nativeType: 'text', codecId: 'pg/text@1', nullable: false },
+        },
+        uniques: [],
+        indexes: [],
+        foreignKeys: [],
+      },
+    },
+  },
+  models: {},
+  relations: {},
+  mappings: { codecTypes: {}, operationTypes: {} },
+});
+
+describe('SqlRuntime AsyncIterableResult integration', () => {
+  it('returns AsyncIterableResult from execute', async () => {
+    const adapter = createStubAdapter();
+    const driver = new MockDriver();
+    driver.setRows([
+      { id: 1, email: 'test1@example.com' },
+      { id: 2, email: 'test2@example.com' },
+    ]);
+    const context = createTestContext(fixtureContract, adapter);
+    const runtime = createRuntime({
+      driver: driver as unknown as Parameters<typeof createRuntime>[0]['driver'],
+      context,
+      verify: { mode: 'onFirstUse', requireMarker: false },
+    });
+
+    const plan: ExecutionPlan<{ id: number; email: string }> = {
+      sql: 'SELECT id, email FROM "user" ORDER BY id',
+      params: [],
+      meta: {
+        target: 'postgres',
+        targetFamily: 'sql',
+        coreHash: 'test-hash',
+        lane: 'sql',
+        paramDescriptors: [],
+      },
+    };
+
+    const result = runtime.execute(plan);
+
+    // Verify it's an AsyncIterableResult
+    expect(result).toBeInstanceOf(Object);
+    expect(typeof result.toArray).toBe('function');
+    expect(typeof result[Symbol.asyncIterator]).toBe('function');
+
+    await runtime.close();
+  });
+
+  it('preserves type information', async () => {
+    const adapter = createStubAdapter();
+    const driver = new MockDriver();
+    driver.setRows([{ id: 1, email: 'test@example.com' }]);
+    const context = createTestContext(fixtureContract, adapter);
+    const runtime = createRuntime({
+      driver: driver as unknown as Parameters<typeof createRuntime>[0]['driver'],
+      context,
+      verify: { mode: 'onFirstUse', requireMarker: false },
+    });
+
+    const plan: ExecutionPlan<{ id: number; email: string }> = {
+      sql: 'SELECT id, email FROM "user" LIMIT 1',
+      params: [],
+      meta: {
+        target: 'postgres',
+        targetFamily: 'sql',
+        coreHash: 'test-hash',
+        lane: 'sql',
+        paramDescriptors: [],
+      },
+    };
+
+    const result: AsyncIterableResult<{ id: number; email: string }> = runtime.execute(plan);
+    const rows = await result.toArray();
+
+    expect(rows.length).toBe(1);
+    if (rows[0]) {
+      expect(typeof rows[0].id).toBe('number');
+      expect(typeof rows[0].email).toBe('string');
+    }
+
+    await runtime.close();
+  });
+});

package/test/context.types.test-d.ts

@@ -0,0 +1,70 @@
+import type { SqlContract, SqlMappings, SqlStorage } from '@prisma-next/sql-contract/types';
+import { expectTypeOf, test } from 'vitest';
+import type { RuntimeContext, TypeHelperRegistry } from '../src/sql-context';
+
+// Contract type with storage.types using literal types (matching emission output)
+type TestContract = SqlContract<
+  {
+    readonly tables: {
+      readonly document: {
+        readonly columns: {
+          readonly id: {
+            readonly nativeType: 'int4';
+            readonly codecId: 'pg/int4@1';
+            nullable: false;
+          };
+        };
+        readonly primaryKey: { readonly columns: readonly ['id'] };
+        readonly uniques: readonly [];
+        readonly indexes: readonly [];
+        readonly foreignKeys: readonly [];
+      };
+    };
+    readonly types: {
+      readonly Vector1536: {
+        readonly codecId: 'pg/vector@1';
+        readonly nativeType: 'vector';
+        readonly typeParams: { readonly length: 1536 };
+      };
+    };
+  },
+  Record<string, never>,
+  Record<string, never>,
+  SqlMappings
+>;
+
+test('RuntimeContext.types is TypeHelperRegistry', () => {
+  // RuntimeContext.types is intentionally loose (Record<string, unknown>)
+  // The strong typing comes from schema(context).types via ExtractSchemaTypes
+  expectTypeOf<RuntimeContext<TestContract>['types']>().toEqualTypeOf<
+    TypeHelperRegistry | undefined
+  >();
+
+  // TypeHelperRegistry allows any values - the actual type depends on init hooks
+  expectTypeOf<TypeHelperRegistry>().toEqualTypeOf<Record<string, unknown>>();
+});
+
+test('RuntimeContext preserves contract type parameter', () => {
+  // Verify the contract type is preserved in RuntimeContext
+  expectTypeOf<RuntimeContext<TestContract>['contract']>().toEqualTypeOf<TestContract>();
+
+  // Verify we can access storage.types through the context's contract
+  type ContractStorageTypes = RuntimeContext<TestContract>['contract']['storage']['types'];
+  expectTypeOf<ContractStorageTypes>().toExtend<
+    | {
+        readonly Vector1536: {
+          readonly codecId: 'pg/vector@1';
+          readonly nativeType: 'vector';
+          readonly typeParams: { readonly length: 1536 };
+        };
+      }
+    | undefined
+  >();
+});
+
+test('RuntimeContext accepts generic SqlContract', () => {
+  // Verify RuntimeContext defaults work
+  type DefaultContext = RuntimeContext;
+  expectTypeOf<DefaultContext['contract']>().toExtend<SqlContract<SqlStorage>>();
+  expectTypeOf<DefaultContext['types']>().toEqualTypeOf<TypeHelperRegistry | undefined>();
+});