@prisma-next/sql-runtime 0.3.0-dev.2 → 0.3.0-dev.21

package/src/sql-marker.ts

@@ -0,0 +1,105 @@
+import type { MarkerStatement } from '@prisma-next/runtime-executor';
+
+export interface SqlStatement {
+  readonly sql: string;
+  readonly params: readonly unknown[];
+}
+
+export interface WriteMarkerInput {
+  readonly coreHash: string;
+  readonly profileHash: string;
+  readonly contractJson?: unknown;
+  readonly canonicalVersion?: number;
+  readonly appTag?: string;
+  readonly meta?: Record<string, unknown>;
+}
+
+export const ensureSchemaStatement: SqlStatement = {
+  sql: 'create schema if not exists prisma_contract',
+  params: [],
+};
+
+export const ensureTableStatement: SqlStatement = {
+  sql: `create table if not exists prisma_contract.marker (
+    id smallint primary key default 1,
+    core_hash text not null,
+    profile_hash text not null,
+    contract_json jsonb,
+    canonical_version int,
+    updated_at timestamptz not null default now(),
+    app_tag text,
+    meta jsonb not null default '{}'
+  )`,
+  params: [],
+};
+
+export function readContractMarker(): MarkerStatement {
+  return {
+    sql: `select
+      core_hash,
+      profile_hash,
+      contract_json,
+      canonical_version,
+      updated_at,
+      app_tag,
+      meta
+    from prisma_contract.marker
+    where id = $1`,
+    params: [1],
+  };
+}
+
+export interface WriteContractMarkerStatements {
+  readonly insert: SqlStatement;
+  readonly update: SqlStatement;
+}
+
+export function writeContractMarker(input: WriteMarkerInput): WriteContractMarkerStatements {
+  const baseParams: readonly unknown[] = [
+    1,
+    input.coreHash,
+    input.profileHash,
+    input.contractJson ?? null,
+    input.canonicalVersion ?? null,
+    input.appTag ?? null,
+    JSON.stringify(input.meta ?? {}),
+  ];
+
+  const insert: SqlStatement = {
+    sql: `insert into prisma_contract.marker (
+        id,
+        core_hash,
+        profile_hash,
+        contract_json,
+        canonical_version,
+        updated_at,
+        app_tag,
+        meta
+      ) values (
+        $1,
+        $2,
+        $3,
+        $4::jsonb,
+        $5,
+        now(),
+        $6,
+        $7::jsonb
+      )`,
+    params: baseParams,
+  };
+
+  const update: SqlStatement = {
+    sql: `update prisma_contract.marker set
+        core_hash = $2,
+        profile_hash = $3,
+        contract_json = $4::jsonb,
+        canonical_version = $5,
+        updated_at = now(),
+        app_tag = $6,
+        meta = $7::jsonb
+      where id = $1`,
+    params: baseParams,
+  };
+
+  return { insert, update };
+}

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/sql-context.test.ts

@@ -0,0 +1,217 @@
+import type { SqlContract, SqlStorage } from '@prisma-next/sql-contract/types';
+import type { SqlOperationSignature } from '@prisma-next/sql-operations';
+import type { CodecRegistry, SelectAst } from '@prisma-next/sql-relational-core/ast';
+import { codec, createCodecRegistry } from '@prisma-next/sql-relational-core/ast';
+import { describe, expect, it } from 'vitest';
+import {
+  createRuntimeContext,
+  type SqlRuntimeExtensionDescriptor,
+  type SqlRuntimeExtensionInstance,
+} from '../src/sql-context';
+
+// Minimal test contract
+const testContract: SqlContract<SqlStorage> = {
+  schemaVersion: '1',
+  targetFamily: 'sql',
+  target: 'postgres',
+  coreHash: 'sha256:test',
+  models: {},
+  relations: {},
+  storage: { tables: {} },
+  extensionPacks: {},
+  capabilities: {},
+  meta: {},
+  sources: {},
+  mappings: {
+    codecTypes: {},
+    operationTypes: {},
+  },
+};
+
+// Stub adapter codecs
+function createStubCodecs(): CodecRegistry {
+  const registry = createCodecRegistry();
+  registry.register(
+    codec({
+      typeId: 'pg/int4@1',
+      targetTypes: ['int4'],
+      encode: (v: number) => v,
+      decode: (w: number) => w,
+    }),
+  );
+  return registry;
+}
+
+// Create a test adapter descriptor
+function createTestAdapterDescriptor() {
+  const codecs = createStubCodecs();
+  return {
+    kind: 'adapter' as const,
+    id: 'test-adapter',
+    version: '0.0.1',
+    familyId: 'sql' as const,
+    targetId: 'postgres' as const,
+    create() {
+      return {
+        familyId: 'sql' as const,
+        targetId: 'postgres' as const,
+        profile: {
+          id: 'test-profile',
+          target: 'postgres',
+          capabilities: {},
+          codecs() {
+            return codecs;
+          },
+        },
+        lower(ast: SelectAst) {
+          return {
+            profileId: 'test-profile',
+            body: Object.freeze({ sql: JSON.stringify(ast), params: [] }),
+          };
+        },
+      };
+    },
+  };
+}
+
+// Create a test target descriptor
+function createTestTargetDescriptor() {
+  return {
+    kind: 'target' as const,
+    id: 'postgres',
+    version: '0.0.1',
+    familyId: 'sql' as const,
+    targetId: 'postgres' as const,
+    create() {
+      return { familyId: 'sql' as const, targetId: 'postgres' as const };
+    },
+  };
+}
+
+// Create a test extension descriptor
+function createTestExtensionDescriptor(options?: {
+  hasCodecs?: boolean;
+  hasOperations?: boolean;
+}): SqlRuntimeExtensionDescriptor<'postgres'> {
+  const { hasCodecs = false, hasOperations = false } = options ?? {};
+
+  // Build the codecs function if needed
+  const codecsFn = hasCodecs
+    ? () => {
+        const registry = createCodecRegistry();
+        registry.register(
+          codec({
+            typeId: 'test/ext@1',
+            targetTypes: ['ext'],
+            encode: (v: string) => v,
+            decode: (w: string) => w,
+          }),
+        );
+        return registry;
+      }
+    : undefined;
+
+  // Build the operations function if needed
+  const operationsFn = hasOperations
+    ? (): ReadonlyArray<SqlOperationSignature> => [
+        {
+          forTypeId: 'test/ext@1',
+          method: 'testOp',
+          args: [],
+          returns: { kind: 'builtin', type: 'number' },
+          lowering: { targetFamily: 'sql', strategy: 'function', template: 'test()' },
+        },
+      ]
+    : undefined;
+
+  return {
+    kind: 'extension' as const,
+    id: 'test-extension',
+    version: '0.0.1',
+    familyId: 'sql' as const,
+    targetId: 'postgres' as const,
+    create(): SqlRuntimeExtensionInstance<'postgres'> {
+      // Return object with optional methods only if they exist
+      const instance: SqlRuntimeExtensionInstance<'postgres'> = {
+        familyId: 'sql' as const,
+        targetId: 'postgres' as const,
+      };
+      if (codecsFn) {
+        (instance as { codecs?: () => CodecRegistry }).codecs = codecsFn;
+      }
+      if (operationsFn) {
+        (instance as { operations?: () => ReadonlyArray<SqlOperationSignature> }).operations =
+          operationsFn;
+      }
+      return instance;
+    },
+  };
+}
+
+describe('createRuntimeContext', () => {
+  it('creates context with adapter codecs', () => {
+    const context = createRuntimeContext({
+      contract: testContract,
+      target: createTestTargetDescriptor(),
+      adapter: createTestAdapterDescriptor(),
+    });
+
+    expect(context.contract).toBe(testContract);
+    expect(context.adapter).toBeDefined();
+    expect(context.codecs.has('pg/int4@1')).toBe(true);
+    expect(context.operations).toBeDefined();
+  });
+
+  it('creates context with empty extension packs', () => {
+    const context = createRuntimeContext({
+      contract: testContract,
+      target: createTestTargetDescriptor(),
+      adapter: createTestAdapterDescriptor(),
+      extensionPacks: [],
+    });
+
+    expect(context.codecs.has('pg/int4@1')).toBe(true);
+    // No extension codecs registered
+    expect(context.codecs.has('test/ext@1')).toBe(false);
+  });
+
+  it('registers extension codecs', () => {
+    const context = createRuntimeContext({
+      contract: testContract,
+      target: createTestTargetDescriptor(),
+      adapter: createTestAdapterDescriptor(),
+      extensionPacks: [createTestExtensionDescriptor({ hasCodecs: true })],
+    });
+
+    // Adapter codec
+    expect(context.codecs.has('pg/int4@1')).toBe(true);
+    // Extension codec
+    expect(context.codecs.has('test/ext@1')).toBe(true);
+  });
+
+  it('registers extension operations', () => {
+    const context = createRuntimeContext({
+      contract: testContract,
+      target: createTestTargetDescriptor(),
+      adapter: createTestAdapterDescriptor(),
+      extensionPacks: [createTestExtensionDescriptor({ hasOperations: true })],
+    });
+
+    const ops = context.operations.byType('test/ext@1');
+    expect(ops.length).toBe(1);
+    expect(ops[0]?.method).toBe('testOp');
+  });
+
+  it('handles extension without codecs or operations', () => {
+    const context = createRuntimeContext({
+      contract: testContract,
+      target: createTestTargetDescriptor(),
+      adapter: createTestAdapterDescriptor(),
+      extensionPacks: [createTestExtensionDescriptor({ hasCodecs: false, hasOperations: false })],
+    });
+
+    // Only adapter codec
+    expect(context.codecs.has('pg/int4@1')).toBe(true);
+    expect(context.codecs.has('test/ext@1')).toBe(false);
+  });
+});

package/test/sql-family-adapter.test.ts

@@ -0,0 +1,86 @@
+import type { ExecutionPlan } from '@prisma-next/contract/types';
+import type { SqlContract, SqlStorage } from '@prisma-next/sql-contract/types';
+import { describe, expect, it } from 'vitest';
+import { SqlFamilyAdapter } from '../src/sql-family-adapter';
+
+// Minimal test contract
+const testContract: SqlContract<SqlStorage> = {
+  schemaVersion: '1',
+  targetFamily: 'sql',
+  target: 'postgres',
+  coreHash: 'sha256:test-hash',
+  models: {},
+  relations: {},
+  storage: { tables: {} },
+  extensionPacks: {},
+  capabilities: {},
+  meta: {},
+  sources: {},
+  mappings: {
+    codecTypes: {},
+    operationTypes: {},
+  },
+};
+
+describe('SqlFamilyAdapter', () => {
+  it('creates adapter with contract and marker reader', () => {
+    const adapter = new SqlFamilyAdapter(testContract);
+
+    expect(adapter.contract).toBe(testContract);
+    expect(adapter.markerReader).toBeDefined();
+    expect(adapter.markerReader.readMarkerStatement).toBeDefined();
+  });
+
+  it('validates plan with matching target and hash', () => {
+    const adapter = new SqlFamilyAdapter(testContract);
+    const plan: ExecutionPlan = {
+      meta: {
+        target: 'postgres',
+        coreHash: 'sha256:test-hash',
+        lane: 'sql',
+        paramDescriptors: [],
+      },
+      sql: 'SELECT 1',
+      params: [],
+    };
+
+    // Should not throw
+    expect(() => adapter.validatePlan(plan, testContract)).not.toThrow();
+  });
+
+  it('throws on plan target mismatch', () => {
+    const adapter = new SqlFamilyAdapter(testContract);
+    const plan: ExecutionPlan = {
+      meta: {
+        target: 'mysql', // Wrong target
+        coreHash: 'sha256:test-hash',
+        lane: 'sql',
+        paramDescriptors: [],
+      },
+      sql: 'SELECT 1',
+      params: [],
+    };
+
+    expect(() => adapter.validatePlan(plan, testContract)).toThrow(
+      'Plan target does not match runtime target',
+    );
+  });
+
+  it('throws on plan coreHash mismatch', () => {
+    const adapter = new SqlFamilyAdapter(testContract);
+    const plan: ExecutionPlan = {
+      meta: {
+        target: 'postgres',
+        coreHash: 'sha256:different-hash', // Wrong hash
+        lane: 'sql',
+        paramDescriptors: [],
+      },
+      sql: 'SELECT 1',
+      params: [],
+    };
+
+    expect(() => adapter.validatePlan(plan, testContract)).toThrow(
+      'Plan core hash does not match runtime contract',
+    );
+  });
+});