@prisma-next/target-mongo 0.5.0-dev.4 → 0.5.0-dev.41

package/src/core/mongo-runner.ts

@@ -8,7 +8,9 @@ import type {
   MigrationRunnerExecutionChecks,
   MigrationRunnerFailure,
   MigrationRunnerResult,
+  OperationContext,
 } from '@prisma-next/framework-components/control';
+import type { MongoContract } from '@prisma-next/mongo-contract';
 import type { MongoAdapter, MongoDriver } from '@prisma-next/mongo-lowering';
 import type {
   AnyMongoMigrationOperation,
@@ -19,31 +21,28 @@ import type {
   MongoMigrationCheck,
   MongoMigrationPlanOperation,
 } from '@prisma-next/mongo-query-ast/control';
+import type { MongoSchemaIR } from '@prisma-next/mongo-schema-ir';
 import { notOk, ok } from '@prisma-next/utils/result';
-
-const READ_ONLY_CHECK_COMMAND_KINDS: ReadonlySet<string> = new Set(['aggregate', 'rawAggregate']);
-
-function hasProfileHash(value: unknown): value is { readonly profileHash: string } {
-  return (
-    typeof value === 'object' &&
-    value !== null &&
-    Object.hasOwn(value, 'profileHash') &&
-    typeof (value as { profileHash: unknown }).profileHash === 'string'
-  );
-}
-
 import { FilterEvaluator } from './filter-evaluator';
 import { deserializeMongoOps } from './mongo-ops-serializer';
+import { verifyMongoSchema } from './schema-verify/verify-mongo-schema';
+
+const READ_ONLY_CHECK_COMMAND_KINDS: ReadonlySet<string> = new Set(['aggregate', 'rawAggregate']);
 
 export interface MarkerOperations {
   readMarker(): Promise<ContractMarkerRecord | null>;
   initMarker(destination: {
     readonly storageHash: string;
     readonly profileHash: string;
+    readonly invariants?: readonly string[];
   }): Promise<void>;
   updateMarker(
     expectedFrom: string,
-    destination: { readonly storageHash: string; readonly profileHash: string },
+    destination: {
+      readonly storageHash: string;
+      readonly profileHash: string;
+      readonly invariants?: readonly string[];
+    },
   ): Promise<boolean>;
   writeLedgerEntry(entry: {
     readonly edgeId: string;
@@ -58,6 +57,21 @@ export interface MongoRunnerDependencies {
   readonly adapter: MongoAdapter;
   readonly driver: MongoDriver;
   readonly markerOps: MarkerOperations;
+  readonly introspectSchema: () => Promise<MongoSchemaIR>;
+}
+
+export interface MongoMigrationRunnerExecuteOptions {
+  readonly plan: MigrationPlan;
+  readonly destinationContract: MongoContract;
+  readonly policy: MigrationOperationPolicy;
+  readonly callbacks?: {
+    onOperationStart?(op: MigrationPlanOperation): void;
+    onOperationComplete?(op: MigrationPlanOperation): void;
+  };
+  readonly executionChecks?: MigrationRunnerExecutionChecks;
+  readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<'mongo', 'mongo'>>;
+  readonly strictVerification?: boolean;
+  readonly context?: OperationContext;
 }
 
 function runnerFailure(
@@ -75,17 +89,7 @@ function runnerFailure(
 export class MongoMigrationRunner {
   constructor(private readonly deps: MongoRunnerDependencies) {}
 
-  async execute(options: {
-    readonly plan: MigrationPlan;
-    readonly destinationContract: unknown;
-    readonly policy: MigrationOperationPolicy;
-    readonly callbacks?: {
-      onOperationStart?(op: MigrationPlanOperation): void;
-      onOperationComplete?(op: MigrationPlanOperation): void;
-    };
-    readonly executionChecks?: MigrationRunnerExecutionChecks;
-    readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<'mongo', 'mongo'>>;
-  }): Promise<MigrationRunnerResult> {
+  async execute(options: MongoMigrationRunnerExecuteOptions): Promise<MigrationRunnerResult> {
     const { commandExecutor, inspectionExecutor, adapter, driver, markerOps } = this.deps;
     const operations = deserializeMongoOps(options.plan.operations as readonly unknown[]);
 
@@ -176,49 +180,84 @@ export class MongoMigrationRunner {
     }
 
     const destination = options.plan.destination;
-    const profileHash = hasProfileHash(options.destinationContract)
-      ? options.destinationContract.profileHash
-      : destination.storageHash;
-
-    if (
-      operationsExecuted === 0 &&
-      existingMarker?.storageHash === destination.storageHash &&
-      existingMarker.profileHash === profileHash
-    ) {
-      return ok({ operationsPlanned: operations.length, operationsExecuted });
-    }
-
-    if (existingMarker) {
-      const updated = await markerOps.updateMarker(existingMarker.storageHash, {
-        storageHash: destination.storageHash,
-        profileHash,
+    const profileHash = options.destinationContract.profileHash ?? destination.storageHash;
+
+    const incomingInvariants = options.plan.providedInvariants ?? [];
+    const existingInvariantSet = new Set(existingMarker?.invariants ?? []);
+    const incomingIsSubsetOfExisting = incomingInvariants.every((id) =>
+      existingInvariantSet.has(id),
+    );
+    const markerAlreadyAtDestination =
+      existingMarker !== null &&
+      existingMarker.storageHash === destination.storageHash &&
+      existingMarker.profileHash === profileHash;
+
+    // Skip marker/ledger writes (and schema verification) only when the apply
+    // is a true no-op: no operations executed, marker already at destination,
+    // and every incoming invariant is already in the stored set.
+    //
+    // Divergence from the SQL runners (postgres/sqlite): those runners gate
+    // the no-op skip on `isSelfEdge` (origin === destination) only, so a
+    // non-self-edge `db update` that introspects-as-no-op still writes a
+    // ledger entry. Mongo skips even those because the runner has no
+    // structural distinction between self-edge and re-apply — invariant-
+    // aware routing here does not yet differentiate between the two
+    // ledger semantics. If the SQL audit-trail behavior should hold for
+    // Mongo too, gate this `isNoOp` on a self-edge check (or, conversely,
+    // align the SQL runners to skip non-self-edge no-ops uniformly).
+    const isNoOp =
+      operationsExecuted === 0 && markerAlreadyAtDestination && incomingIsSubsetOfExisting;
+
+    if (!isNoOp) {
+      const liveSchema = await this.deps.introspectSchema();
+      const verifyResult = verifyMongoSchema({
+        contract: options.destinationContract,
+        schema: liveSchema,
+        strict: options.strictVerification ?? true,
+        frameworkComponents: options.frameworkComponents,
+        ...(options.context ? { context: options.context } : {}),
       });
-      if (!updated) {
-        return runnerFailure(
-          'MARKER_CAS_FAILURE',
-          'Marker was modified by another process during migration execution.',
-          {
-            meta: {
-              expectedStorageHash: existingMarker.storageHash,
-              destinationStorageHash: destination.storageHash,
+      if (!verifyResult.ok) {
+        return runnerFailure('SCHEMA_VERIFY_FAILED', verifyResult.summary, {
+          why: 'The resulting database schema does not satisfy the destination contract.',
+          meta: { issues: verifyResult.schema.issues },
+        });
+      }
+
+      if (existingMarker) {
+        const updated = await markerOps.updateMarker(existingMarker.storageHash, {
+          storageHash: destination.storageHash,
+          profileHash,
+          invariants: incomingInvariants,
+        });
+        if (!updated) {
+          return runnerFailure(
+            'MARKER_CAS_FAILURE',
+            'Marker was modified by another process during migration execution.',
+            {
+              meta: {
+                expectedStorageHash: existingMarker.storageHash,
+                destinationStorageHash: destination.storageHash,
+              },
             },
-          },
-        );
+          );
+        }
+      } else {
+        await markerOps.initMarker({
+          storageHash: destination.storageHash,
+          profileHash,
+          invariants: incomingInvariants,
+        });
       }
-    } else {
-      await markerOps.initMarker({
-        storageHash: destination.storageHash,
-        profileHash,
+
+      const originHash = existingMarker?.storageHash ?? '';
+      await markerOps.writeLedgerEntry({
+        edgeId: `${originHash}->${destination.storageHash}`,
+        from: originHash,
+        to: destination.storageHash,
       });
     }
 
-    const originHash = existingMarker?.storageHash ?? '';
-    await markerOps.writeLedgerEntry({
-      edgeId: `${originHash}->${destination.storageHash}`,
-      from: originHash,
-      to: destination.storageHash,
-    });
-
     return ok({ operationsPlanned: operations.length, operationsExecuted });
   }
 
@@ -259,7 +298,7 @@ export class MongoMigrationRunner {
     }
 
     for (const plan of op.run) {
-      const wireCommand = adapter.lower(plan);
+      const wireCommand = await adapter.lower(plan, {});
       for await (const _ of driver.execute(wireCommand)) {
         /* consume */
       }
@@ -307,7 +346,7 @@ export class MongoMigrationRunner {
           },
         );
       }
-      const wireCommand = adapter.lower(check.source);
+      const wireCommand = await adapter.lower(check.source, {});
       let matchFound = false;
       for await (const row of driver.execute<Record<string, unknown>>(wireCommand)) {
         if (filterEvaluator.evaluate(check.filter, row)) {
@@ -375,13 +414,9 @@ export class MongoMigrationRunner {
   ): MigrationRunnerResult | undefined {
     const origin = plan.origin ?? null;
     if (!origin) {
-      if (marker) {
-        return runnerFailure(
-          'MARKER_ORIGIN_MISMATCH',
-          'Database already has a contract marker but the plan has no origin. This would silently overwrite the existing marker.',
-          { meta: { markerStorageHash: marker.storageHash } },
-        );
-      }
+      // No origin assertion on the plan — the caller has done its own
+      // correctness check (typically `db update` via live-schema
+      // introspection) and does not rely on marker continuity.
       return undefined;
     }
 

package/src/core/planner-produced-migration.ts

@@ -47,7 +47,6 @@ export class PlannerProducedMongoMigration
     return renderCallsToTypeScript(this.calls, {
       from: this.meta.from,
       to: this.meta.to,
-      ...ifDefined('kind', this.meta.kind),
       ...ifDefined('labels', this.meta.labels),
     });
   }

package/src/core/render-typescript.ts

@@ -3,9 +3,8 @@ import { type ImportRequirement, jsonToTsSource, renderImports } from '@prisma-n
 import type { OpFactoryCall } from './op-factory-call';
 
 export interface RenderMigrationMeta {
-  readonly from: string;
+  readonly from: string | null;
   readonly to: string;
-  readonly kind?: string;
   readonly labels?: readonly string[];
 }
 
@@ -36,8 +35,8 @@ const BASE_IMPORTS: readonly ImportRequirement[] = [
  * `Migration` (i.e. `MongoMigration`) from `@prisma-next/family-mongo`, and
  * implements the abstract `operations` and `describe` members. `meta` is
  * always rendered — `describe()` is part of the `Migration` contract, so
- * even an empty stub must satisfy it; callers pass empty strings for a
- * migration-new scaffold.
+ * even an empty stub must satisfy it; callers pass `from: null` for a
+ * baseline `migration-new` scaffold (and a real `to` hash either way).
  *
  * The walk is polymorphic: each call node contributes its own
  * `renderTypeScript()` expression and declares its own
@@ -89,9 +88,6 @@ function buildDescribeMethod(meta: RenderMigrationMeta): string {
   lines.push('    return {');
   lines.push(`      from: ${JSON.stringify(meta.from)},`);
   lines.push(`      to: ${JSON.stringify(meta.to)},`);
-  if (meta.kind) {
-    lines.push(`      kind: ${JSON.stringify(meta.kind)},`);
-  }
   if (meta.labels && meta.labels.length > 0) {
     lines.push(`      labels: ${jsonToTsSource(meta.labels)},`);
   }

package/src/core/schema-diff.ts

@@ -0,0 +1,402 @@
+import type {
+  SchemaIssue,
+  SchemaVerificationNode,
+} from '@prisma-next/framework-components/control';
+import type {
+  MongoSchemaCollection,
+  MongoSchemaIndex,
+  MongoSchemaIR,
+} from '@prisma-next/mongo-schema-ir';
+import { canonicalize, deepEqual } from '@prisma-next/mongo-schema-ir';
+
+export function diffMongoSchemas(
+  live: MongoSchemaIR,
+  expected: MongoSchemaIR,
+  strict: boolean,
+): {
+  root: SchemaVerificationNode;
+  issues: SchemaIssue[];
+  counts: { pass: number; warn: number; fail: number; totalNodes: number };
+} {
+  const issues: SchemaIssue[] = [];
+  const collectionChildren: SchemaVerificationNode[] = [];
+  let pass = 0;
+  let warn = 0;
+  let fail = 0;
+
+  const allNames = new Set([...live.collectionNames, ...expected.collectionNames]);
+
+  for (const name of [...allNames].sort()) {
+    const liveColl = live.collection(name);
+    const expectedColl = expected.collection(name);
+
+    if (!liveColl && expectedColl) {
+      issues.push({
+        kind: 'missing_table',
+        table: name,
+        message: `Collection "${name}" is missing from the database`,
+      });
+      collectionChildren.push({
+        status: 'fail',
+        kind: 'collection',
+        name,
+        contractPath: `storage.collections.${name}`,
+        code: 'MISSING_COLLECTION',
+        message: `Collection "${name}" is missing`,
+        expected: name,
+        actual: null,
+        children: [],
+      });
+      fail++;
+      continue;
+    }
+
+    if (liveColl && !expectedColl) {
+      const status = strict ? 'fail' : 'warn';
+      issues.push({
+        kind: 'extra_table',
+        table: name,
+        message: `Extra collection "${name}" exists in the database but not in the contract`,
+      });
+      collectionChildren.push({
+        status,
+        kind: 'collection',
+        name,
+        contractPath: `storage.collections.${name}`,
+        code: 'EXTRA_COLLECTION',
+        message: `Extra collection "${name}" found`,
+        expected: null,
+        actual: name,
+        children: [],
+      });
+      if (status === 'fail') fail++;
+      else warn++;
+      continue;
+    }
+
+    const lc = liveColl as MongoSchemaCollection;
+    const ec = expectedColl as MongoSchemaCollection;
+    const indexChildren = diffIndexes(name, lc, ec, strict, issues);
+    const validatorChildren = diffValidator(name, lc, ec, strict, issues);
+    const optionsChildren = diffOptions(name, lc, ec, strict, issues);
+    const children = [...indexChildren, ...validatorChildren, ...optionsChildren];
+
+    const worstStatus = children.reduce<'pass' | 'warn' | 'fail'>(
+      (s, c) => (c.status === 'fail' ? 'fail' : c.status === 'warn' && s !== 'fail' ? 'warn' : s),
+      'pass',
+    );
+
+    for (const c of children) {
+      if (c.status === 'pass') pass++;
+      else if (c.status === 'warn') warn++;
+      else fail++;
+    }
+
+    if (children.length === 0) {
+      pass++;
+    }
+
+    collectionChildren.push({
+      status: worstStatus,
+      kind: 'collection',
+      name,
+      contractPath: `storage.collections.${name}`,
+      code: worstStatus === 'pass' ? 'MATCH' : 'DRIFT',
+      message:
+        worstStatus === 'pass' ? `Collection "${name}" matches` : `Collection "${name}" has drift`,
+      expected: name,
+      actual: name,
+      children,
+    });
+  }
+
+  const rootStatus = fail > 0 ? 'fail' : warn > 0 ? 'warn' : 'pass';
+  const totalNodes = pass + warn + fail + collectionChildren.length;
+
+  const root: SchemaVerificationNode = {
+    status: rootStatus,
+    kind: 'root',
+    name: 'mongo-schema',
+    contractPath: 'storage',
+    code: rootStatus === 'pass' ? 'MATCH' : 'DRIFT',
+    message: rootStatus === 'pass' ? 'Schema matches' : 'Schema has drift',
+    expected: null,
+    actual: null,
+    children: collectionChildren,
+  };
+
+  return { root, issues, counts: { pass, warn, fail, totalNodes } };
+}
+
+function buildIndexLookupKey(index: MongoSchemaIndex): string {
+  const keys = index.keys.map((k) => `${k.field}:${k.direction}`).join(',');
+  const opts = [
+    index.unique ? 'unique' : '',
+    index.sparse ? 'sparse' : '',
+    index.expireAfterSeconds != null ? `ttl:${index.expireAfterSeconds}` : '',
+    index.partialFilterExpression ? `pfe:${canonicalize(index.partialFilterExpression)}` : '',
+    index.wildcardProjection ? `wp:${canonicalize(index.wildcardProjection)}` : '',
+    index.collation ? `col:${canonicalize(index.collation)}` : '',
+    index.weights ? `wt:${canonicalize(index.weights)}` : '',
+    index.default_language ? `dl:${index.default_language}` : '',
+    index.language_override ? `lo:${index.language_override}` : '',
+  ]
+    .filter(Boolean)
+    .join(';');
+  return opts ? `${keys}|${opts}` : keys;
+}
+
+function formatIndexName(index: MongoSchemaIndex): string {
+  return index.keys.map((k) => `${k.field}:${k.direction}`).join(', ');
+}
+
+function diffIndexes(
+  collName: string,
+  live: MongoSchemaCollection,
+  expected: MongoSchemaCollection,
+  strict: boolean,
+  issues: SchemaIssue[],
+): SchemaVerificationNode[] {
+  const nodes: SchemaVerificationNode[] = [];
+  const liveLookup = new Map<string, MongoSchemaIndex>();
+  for (const idx of live.indexes) liveLookup.set(buildIndexLookupKey(idx), idx);
+
+  const expectedLookup = new Map<string, MongoSchemaIndex>();
+  for (const idx of expected.indexes) expectedLookup.set(buildIndexLookupKey(idx), idx);
+
+  for (const [key, idx] of expectedLookup) {
+    if (liveLookup.has(key)) {
+      nodes.push({
+        status: 'pass',
+        kind: 'index',
+        name: formatIndexName(idx),
+        contractPath: `storage.collections.${collName}.indexes`,
+        code: 'MATCH',
+        message: `Index ${formatIndexName(idx)} matches`,
+        expected: key,
+        actual: key,
+        children: [],
+      });
+    } else {
+      issues.push({
+        kind: 'index_mismatch',
+        table: collName,
+        indexOrConstraint: formatIndexName(idx),
+        message: `Index ${formatIndexName(idx)} missing on collection "${collName}"`,
+      });
+      nodes.push({
+        status: 'fail',
+        kind: 'index',
+        name: formatIndexName(idx),
+        contractPath: `storage.collections.${collName}.indexes`,
+        code: 'MISSING_INDEX',
+        message: `Index ${formatIndexName(idx)} missing`,
+        expected: key,
+        actual: null,
+        children: [],
+      });
+    }
+  }
+
+  for (const [key, idx] of liveLookup) {
+    if (!expectedLookup.has(key)) {
+      const status = strict ? 'fail' : 'warn';
+      issues.push({
+        kind: 'extra_index',
+        table: collName,
+        indexOrConstraint: formatIndexName(idx),
+        message: `Extra index ${formatIndexName(idx)} on collection "${collName}"`,
+      });
+      nodes.push({
+        status,
+        kind: 'index',
+        name: formatIndexName(idx),
+        contractPath: `storage.collections.${collName}.indexes`,
+        code: 'EXTRA_INDEX',
+        message: `Extra index ${formatIndexName(idx)}`,
+        expected: null,
+        actual: key,
+        children: [],
+      });
+    }
+  }
+
+  return nodes;
+}
+
+function diffValidator(
+  collName: string,
+  live: MongoSchemaCollection,
+  expected: MongoSchemaCollection,
+  strict: boolean,
+  issues: SchemaIssue[],
+): SchemaVerificationNode[] {
+  if (!live.validator && !expected.validator) return [];
+
+  if (expected.validator && !live.validator) {
+    issues.push({
+      kind: 'type_missing',
+      table: collName,
+      message: `Validator missing on collection "${collName}"`,
+    });
+    return [
+      {
+        status: 'fail',
+        kind: 'validator',
+        name: 'validator',
+        contractPath: `storage.collections.${collName}.validator`,
+        code: 'MISSING_VALIDATOR',
+        message: 'Validator missing',
+        expected: canonicalize(expected.validator.jsonSchema),
+        actual: null,
+        children: [],
+      },
+    ];
+  }
+
+  if (!expected.validator && live.validator) {
+    const status = strict ? 'fail' : 'warn';
+    issues.push({
+      kind: 'extra_validator',
+      table: collName,
+      message: `Extra validator on collection "${collName}"`,
+    });
+    return [
+      {
+        status,
+        kind: 'validator',
+        name: 'validator',
+        contractPath: `storage.collections.${collName}.validator`,
+        code: 'EXTRA_VALIDATOR',
+        message: 'Extra validator found',
+        expected: null,
+        actual: canonicalize(live.validator.jsonSchema),
+        children: [],
+      },
+    ];
+  }
+
+  const liveVal = live.validator as NonNullable<typeof live.validator>;
+  const expectedVal = expected.validator as NonNullable<typeof expected.validator>;
+  const liveSchema = canonicalize(liveVal.jsonSchema);
+  const expectedSchema = canonicalize(expectedVal.jsonSchema);
+
+  if (
+    liveSchema !== expectedSchema ||
+    liveVal.validationLevel !== expectedVal.validationLevel ||
+    liveVal.validationAction !== expectedVal.validationAction
+  ) {
+    issues.push({
+      kind: 'type_mismatch',
+      table: collName,
+      expected: expectedSchema,
+      actual: liveSchema,
+      message: `Validator mismatch on collection "${collName}"`,
+    });
+    return [
+      {
+        status: 'fail',
+        kind: 'validator',
+        name: 'validator',
+        contractPath: `storage.collections.${collName}.validator`,
+        code: 'VALIDATOR_MISMATCH',
+        message: 'Validator mismatch',
+        expected: {
+          jsonSchema: expectedVal.jsonSchema,
+          validationLevel: expectedVal.validationLevel,
+          validationAction: expectedVal.validationAction,
+        },
+        actual: {
+          jsonSchema: liveVal.jsonSchema,
+          validationLevel: liveVal.validationLevel,
+          validationAction: liveVal.validationAction,
+        },
+        children: [],
+      },
+    ];
+  }
+
+  return [
+    {
+      status: 'pass',
+      kind: 'validator',
+      name: 'validator',
+      contractPath: `storage.collections.${collName}.validator`,
+      code: 'MATCH',
+      message: 'Validator matches',
+      expected: expectedSchema,
+      actual: liveSchema,
+      children: [],
+    },
+  ];
+}
+
+function diffOptions(
+  collName: string,
+  live: MongoSchemaCollection,
+  expected: MongoSchemaCollection,
+  strict: boolean,
+  issues: SchemaIssue[],
+): SchemaVerificationNode[] {
+  if (!live.options && !expected.options) return [];
+
+  if (!expected.options && live.options) {
+    const status = strict ? 'fail' : 'warn';
+    issues.push({
+      kind: 'type_mismatch',
+      table: collName,
+      actual: canonicalize(live.options),
+      message: `Extra collection options on "${collName}"`,
+    });
+    return [
+      {
+        status,
+        kind: 'options',
+        name: 'options',
+        contractPath: `storage.collections.${collName}.options`,
+        code: 'EXTRA_OPTIONS',
+        message: 'Extra collection options found',
+        expected: null,
+        actual: live.options,
+        children: [],
+      },
+    ];
+  }
+
+  if (deepEqual(live.options, expected.options)) {
+    return [
+      {
+        status: 'pass',
+        kind: 'options',
+        name: 'options',
+        contractPath: `storage.collections.${collName}.options`,
+        code: 'MATCH',
+        message: 'Collection options match',
+        expected: canonicalize(expected.options),
+        actual: canonicalize(live.options),
+        children: [],
+      },
+    ];
+  }
+
+  issues.push({
+    kind: 'type_mismatch',
+    table: collName,
+    expected: canonicalize(expected.options),
+    actual: canonicalize(live.options),
+    message: `Collection options mismatch on "${collName}"`,
+  });
+  return [
+    {
+      status: 'fail',
+      kind: 'options',
+      name: 'options',
+      contractPath: `storage.collections.${collName}.options`,
+      code: 'OPTIONS_MISMATCH',
+      message: 'Collection options mismatch',
+      expected: expected.options,
+      actual: live.options,
+      children: [],
+    },
+  ];
+}