@prisma-next/target-mongo 0.4.0-dev.8 → 0.4.0-dev.9

package/src/core/mongo-runner.ts

@@ -1,4 +1,5 @@
 import type { ContractMarkerRecord } from '@prisma-next/contract/types';
+import { errorRunnerFailed } from '@prisma-next/errors/execution';
 import type { TargetBoundComponentDescriptor } from '@prisma-next/framework-components/components';
 import type {
   MigrationOperationPolicy,
@@ -8,13 +9,29 @@ import type {
   MigrationRunnerFailure,
   MigrationRunnerResult,
 } from '@prisma-next/framework-components/control';
+import type { MongoAdapter, MongoDriver } from '@prisma-next/mongo-lowering';
 import type {
+  AnyMongoMigrationOperation,
+  MongoDataTransformCheck,
+  MongoDataTransformOperation,
   MongoDdlCommandVisitor,
   MongoInspectionCommandVisitor,
   MongoMigrationCheck,
   MongoMigrationPlanOperation,
 } from '@prisma-next/mongo-query-ast/control';
 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';
 
@@ -38,6 +55,8 @@ export interface MarkerOperations {
 export interface MongoRunnerDependencies {
   readonly commandExecutor: MongoDdlCommandVisitor<Promise<void>>;
   readonly inspectionExecutor: MongoInspectionCommandVisitor<Promise<Record<string, unknown>[]>>;
+  readonly adapter: MongoAdapter;
+  readonly driver: MongoDriver;
   readonly markerOps: MarkerOperations;
 }
 
@@ -67,7 +86,7 @@ export class MongoMigrationRunner {
     readonly executionChecks?: MigrationRunnerExecutionChecks;
     readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<'mongo', 'mongo'>>;
   }): Promise<MigrationRunnerResult> {
-    const { commandExecutor, inspectionExecutor, markerOps } = this.deps;
+    const { commandExecutor, inspectionExecutor, adapter, driver, markerOps } = this.deps;
     const operations = deserializeMongoOps(options.plan.operations as readonly unknown[]);
 
     const policyCheck = this.enforcePolicyCompatibility(options.policy, operations);
@@ -90,9 +109,26 @@ export class MongoMigrationRunner {
     for (const operation of operations) {
       options.callbacks?.onOperationStart?.(operation);
       try {
+        if (operation.operationClass === 'data') {
+          const result = await this.executeDataTransform(
+            operation as MongoDataTransformOperation,
+            adapter,
+            driver,
+            filterEvaluator,
+            runIdempotency,
+            runPrechecks,
+            runPostchecks,
+          );
+          if (result.failure) return result.failure;
+          if (result.executed) operationsExecuted += 1;
+          continue;
+        }
+
+        const ddlOp = operation as MongoMigrationPlanOperation;
+
         if (runPostchecks && runIdempotency) {
           const allSatisfied = await this.allChecksSatisfied(
-            operation.postcheck,
+            ddlOp.postcheck,
             inspectionExecutor,
             filterEvaluator,
           );
@@ -101,7 +137,7 @@ export class MongoMigrationRunner {
 
         if (runPrechecks) {
           const precheckResult = await this.evaluateChecks(
-            operation.precheck,
+            ddlOp.precheck,
             inspectionExecutor,
             filterEvaluator,
           );
@@ -114,13 +150,13 @@ export class MongoMigrationRunner {
           }
         }
 
-        for (const step of operation.execute) {
+        for (const step of ddlOp.execute) {
           await step.command.accept(commandExecutor);
         }
 
         if (runPostchecks) {
           const postcheckResult = await this.evaluateChecks(
-            operation.postcheck,
+            ddlOp.postcheck,
             inspectionExecutor,
             filterEvaluator,
           );
@@ -140,8 +176,9 @@ export class MongoMigrationRunner {
     }
 
     const destination = options.plan.destination;
-    const contract = options.destinationContract as { profileHash?: string };
-    const profileHash = contract.profileHash ?? destination.storageHash;
+    const profileHash = hasProfileHash(options.destinationContract)
+      ? options.destinationContract.profileHash
+      : destination.storageHash;
 
     if (
       operationsExecuted === 0 &&
@@ -185,6 +222,105 @@ export class MongoMigrationRunner {
     return ok({ operationsPlanned: operations.length, operationsExecuted });
   }
 
+  private async executeDataTransform(
+    op: MongoDataTransformOperation,
+    adapter: MongoAdapter,
+    driver: MongoDriver,
+    filterEvaluator: FilterEvaluator,
+    runIdempotency: boolean,
+    runPrechecks: boolean,
+    runPostchecks: boolean,
+  ): Promise<{ executed: boolean; failure?: MigrationRunnerResult }> {
+    if (runPostchecks && runIdempotency && op.postcheck.length > 0) {
+      const allSatisfied = await this.evaluateDataTransformChecks(
+        op.postcheck,
+        adapter,
+        driver,
+        filterEvaluator,
+      );
+      if (allSatisfied) return { executed: false };
+    }
+
+    if (runPrechecks && op.precheck.length > 0) {
+      const passed = await this.evaluateDataTransformChecks(
+        op.precheck,
+        adapter,
+        driver,
+        filterEvaluator,
+      );
+      if (!passed) {
+        return {
+          executed: false,
+          failure: runnerFailure('PRECHECK_FAILED', `Operation ${op.id} failed during precheck`, {
+            meta: { operationId: op.id, name: op.name },
+          }),
+        };
+      }
+    }
+
+    for (const plan of op.run) {
+      const wireCommand = adapter.lower(plan);
+      for await (const _ of driver.execute(wireCommand)) {
+        /* consume */
+      }
+    }
+
+    if (runPostchecks && op.postcheck.length > 0) {
+      const passed = await this.evaluateDataTransformChecks(
+        op.postcheck,
+        adapter,
+        driver,
+        filterEvaluator,
+      );
+      if (!passed) {
+        return {
+          executed: false,
+          failure: runnerFailure('POSTCHECK_FAILED', `Operation ${op.id} failed during postcheck`, {
+            meta: { operationId: op.id, name: op.name },
+          }),
+        };
+      }
+    }
+
+    return { executed: true };
+  }
+
+  private async evaluateDataTransformChecks(
+    checks: readonly MongoDataTransformCheck[],
+    adapter: MongoAdapter,
+    driver: MongoDriver,
+    filterEvaluator: FilterEvaluator,
+  ): Promise<boolean> {
+    for (const check of checks) {
+      const commandKind = check.source.command.kind;
+      if (!READ_ONLY_CHECK_COMMAND_KINDS.has(commandKind)) {
+        throw errorRunnerFailed(
+          `Data-transform check rejected: command kind "${commandKind}" is not read-only`,
+          {
+            why: 'Data-transform checks must use aggregate or rawAggregate commands so the pre/postcheck path cannot mutate the database.',
+            fix: 'Author the check.source as an aggregate pipeline (or rawAggregate) rather than a DML write command.',
+            meta: {
+              checkDescription: check.description,
+              commandKind,
+              collection: check.source.collection,
+            },
+          },
+        );
+      }
+      const wireCommand = adapter.lower(check.source);
+      let matchFound = false;
+      for await (const row of driver.execute<Record<string, unknown>>(wireCommand)) {
+        if (filterEvaluator.evaluate(check.filter, row)) {
+          matchFound = true;
+          break;
+        }
+      }
+      const passed = check.expect === 'exists' ? matchFound : !matchFound;
+      if (!passed) return false;
+    }
+    return true;
+  }
+
   private async evaluateChecks(
     checks: readonly MongoMigrationCheck[],
     inspectionExecutor: MongoInspectionCommandVisitor<Promise<Record<string, unknown>[]>>,
@@ -212,7 +348,7 @@ export class MongoMigrationRunner {
 
   private enforcePolicyCompatibility(
     policy: MigrationOperationPolicy,
-    operations: readonly MongoMigrationPlanOperation[],
+    operations: readonly AnyMongoMigrationOperation[],
   ): MigrationRunnerResult | undefined {
     const allowedClasses = new Set(policy.allowedOperationClasses);
     for (const operation of operations) {

package/src/exports/migration.ts

@@ -3,6 +3,7 @@ export {
   collMod,
   createCollection,
   createIndex,
+  dataTransform,
   dropCollection,
   dropIndex,
   setValidation,

package/dist/migration-factories-Brzz-QGG.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"migration-factories-Brzz-QGG.mjs","names":[],"sources":["../src/core/migration-factories.ts"],"sourcesContent":["import type { MongoIndexKey } from '@prisma-next/mongo-query-ast/control';\nimport {\n  buildIndexOpId,\n  CollModCommand,\n  type CollModOptions,\n  CreateCollectionCommand,\n  type CreateCollectionOptions,\n  CreateIndexCommand,\n  type CreateIndexOptions,\n  DropCollectionCommand,\n  DropIndexCommand,\n  defaultMongoIndexName,\n  keysToKeySpec,\n  ListCollectionsCommand,\n  ListIndexesCommand,\n  MongoAndExpr,\n  MongoFieldFilter,\n  type MongoMigrationPlanOperation,\n} from '@prisma-next/mongo-query-ast/control';\nimport type { CollModMeta } from './op-factory-call';\n\nfunction formatKeys(keys: ReadonlyArray<MongoIndexKey>): string {\n  return keys.map((k) => `${k.field}:${k.direction}`).join(', ');\n}\n\nfunction isTextIndex(keys: ReadonlyArray<MongoIndexKey>): boolean {\n  return keys.some((k) => k.direction === 'text');\n}\n\nfunction keyFilter(keys: ReadonlyArray<MongoIndexKey>) {\n  return isTextIndex(keys)\n    ? MongoFieldFilter.eq('key._fts', 'text')\n    : MongoFieldFilter.eq('key', keysToKeySpec(keys));\n}\n\nexport function createIndex(\n  collection: string,\n  keys: ReadonlyArray<MongoIndexKey>,\n  options?: CreateIndexOptions,\n): MongoMigrationPlanOperation {\n  const name = defaultMongoIndexName(keys);\n  const filter = keyFilter(keys);\n  const fullFilter = options?.unique\n    ? MongoAndExpr.of([filter, MongoFieldFilter.eq('unique', true)])\n    : filter;\n\n  return {\n    id: buildIndexOpId('create', collection, keys),\n    label: `Create index on ${collection} (${formatKeys(keys)})`,\n    operationClass: 'additive',\n    precheck: [\n      {\n        description: `index does not already exist on ${collection}`,\n        source: new ListIndexesCommand(collection),\n        filter,\n        expect: 'notExists',\n      },\n    ],\n    execute: [\n      {\n        description: `create index on ${collection}`,\n        command: new CreateIndexCommand(collection, keys, {\n          ...options,\n          unique: options?.unique ?? undefined,\n          name,\n        }),\n      },\n    ],\n    postcheck: [\n      {\n        description: `index exists on ${collection}`,\n        source: new ListIndexesCommand(collection),\n        filter: fullFilter,\n        expect: 'exists',\n      },\n    ],\n  };\n}\n\nexport function dropIndex(\n  collection: string,\n  keys: ReadonlyArray<MongoIndexKey>,\n): MongoMigrationPlanOperation {\n  const indexName = defaultMongoIndexName(keys);\n  const filter = keyFilter(keys);\n\n  return {\n    id: buildIndexOpId('drop', collection, keys),\n    label: `Drop index on ${collection} (${formatKeys(keys)})`,\n    operationClass: 'destructive',\n    precheck: [\n      {\n        description: `index exists on ${collection}`,\n        source: new ListIndexesCommand(collection),\n        filter,\n        expect: 'exists',\n      },\n    ],\n    execute: [\n      {\n        description: `drop index on ${collection}`,\n        command: new DropIndexCommand(collection, indexName),\n      },\n    ],\n    postcheck: [\n      {\n        description: `index no longer exists on ${collection}`,\n        source: new ListIndexesCommand(collection),\n        filter,\n        expect: 'notExists',\n      },\n    ],\n  };\n}\n\nexport function createCollection(\n  collection: string,\n  options?: CreateCollectionOptions,\n): MongoMigrationPlanOperation {\n  return {\n    id: `collection.${collection}.create`,\n    label: `Create collection ${collection}`,\n    operationClass: 'additive',\n    precheck: [\n      {\n        description: `collection ${collection} does not exist`,\n        source: new ListCollectionsCommand(),\n        filter: MongoFieldFilter.eq('name', collection),\n        expect: 'notExists',\n      },\n    ],\n    execute: [\n      {\n        description: `create collection ${collection}`,\n        command: new CreateCollectionCommand(collection, options),\n      },\n    ],\n    postcheck: [],\n  };\n}\n\nexport function dropCollection(collection: string): MongoMigrationPlanOperation {\n  return {\n    id: `collection.${collection}.drop`,\n    label: `Drop collection ${collection}`,\n    operationClass: 'destructive',\n    precheck: [],\n    execute: [\n      {\n        description: `drop collection ${collection}`,\n        command: new DropCollectionCommand(collection),\n      },\n    ],\n    postcheck: [],\n  };\n}\n\nexport function setValidation(\n  collection: string,\n  schema: Record<string, unknown>,\n  options?: { validationLevel?: 'strict' | 'moderate'; validationAction?: 'error' | 'warn' },\n): MongoMigrationPlanOperation {\n  return {\n    id: `collection.${collection}.setValidation`,\n    label: `Set validation on ${collection}`,\n    operationClass: 'destructive',\n    precheck: [],\n    execute: [\n      {\n        description: `set validation on ${collection}`,\n        command: new CollModCommand(collection, {\n          validator: { $jsonSchema: schema },\n          validationLevel: options?.validationLevel,\n          validationAction: options?.validationAction,\n        }),\n      },\n    ],\n    postcheck: [],\n  };\n}\n\nexport function collMod(\n  collection: string,\n  options: CollModOptions,\n  meta?: CollModMeta,\n): MongoMigrationPlanOperation {\n  const hasValidator = options.validator != null && Object.keys(options.validator).length > 0;\n\n  return {\n    id: meta?.id ?? `collection.${collection}.collMod`,\n    label: meta?.label ?? `Modify collection ${collection}`,\n    operationClass: meta?.operationClass ?? 'destructive',\n    precheck:\n      options.validator != null\n        ? [\n            {\n              description: `collection ${collection} exists`,\n              source: new ListCollectionsCommand(),\n              filter: MongoFieldFilter.eq('name', collection),\n              expect: 'exists' as const,\n            },\n          ]\n        : [],\n    execute: [\n      {\n        description: `modify ${collection}`,\n        command: new CollModCommand(collection, options),\n      },\n    ],\n    postcheck: hasValidator\n      ? [\n          {\n            description: `validator applied on ${collection}`,\n            source: new ListCollectionsCommand(),\n            filter: MongoAndExpr.of([\n              MongoFieldFilter.eq('name', collection),\n              ...(options.validationLevel\n                ? [MongoFieldFilter.eq('options.validationLevel', options.validationLevel)]\n                : []),\n              ...(options.validationAction\n                ? [MongoFieldFilter.eq('options.validationAction', options.validationAction)]\n                : []),\n            ]),\n            expect: 'exists' as const,\n          },\n        ]\n      : [],\n  };\n}\n\nexport function validatedCollection(\n  name: string,\n  schema: Record<string, unknown>,\n  indexes: ReadonlyArray<{ keys: MongoIndexKey[]; unique?: boolean }>,\n): MongoMigrationPlanOperation[] {\n  return [\n    createCollection(name, {\n      validator: { $jsonSchema: schema },\n      validationLevel: 'strict',\n      validationAction: 'error',\n    }),\n    ...indexes.map((idx) => createIndex(name, idx.keys, { unique: idx.unique })),\n  ];\n}\n"],"mappings":";;;AAqBA,SAAS,WAAW,MAA4C;AAC9D,QAAO,KAAK,KAAK,MAAM,GAAG,EAAE,MAAM,GAAG,EAAE,YAAY,CAAC,KAAK,KAAK;;AAGhE,SAAS,YAAY,MAA6C;AAChE,QAAO,KAAK,MAAM,MAAM,EAAE,cAAc,OAAO;;AAGjD,SAAS,UAAU,MAAoC;AACrD,QAAO,YAAY,KAAK,GACpB,iBAAiB,GAAG,YAAY,OAAO,GACvC,iBAAiB,GAAG,OAAO,cAAc,KAAK,CAAC;;AAGrD,SAAgB,YACd,YACA,MACA,SAC6B;CAC7B,MAAM,OAAO,sBAAsB,KAAK;CACxC,MAAM,SAAS,UAAU,KAAK;CAC9B,MAAM,aAAa,SAAS,SACxB,aAAa,GAAG,CAAC,QAAQ,iBAAiB,GAAG,UAAU,KAAK,CAAC,CAAC,GAC9D;AAEJ,QAAO;EACL,IAAI,eAAe,UAAU,YAAY,KAAK;EAC9C,OAAO,mBAAmB,WAAW,IAAI,WAAW,KAAK,CAAC;EAC1D,gBAAgB;EAChB,UAAU,CACR;GACE,aAAa,mCAAmC;GAChD,QAAQ,IAAI,mBAAmB,WAAW;GAC1C;GACA,QAAQ;GACT,CACF;EACD,SAAS,CACP;GACE,aAAa,mBAAmB;GAChC,SAAS,IAAI,mBAAmB,YAAY,MAAM;IAChD,GAAG;IACH,QAAQ,SAAS,UAAU;IAC3B;IACD,CAAC;GACH,CACF;EACD,WAAW,CACT;GACE,aAAa,mBAAmB;GAChC,QAAQ,IAAI,mBAAmB,WAAW;GAC1C,QAAQ;GACR,QAAQ;GACT,CACF;EACF;;AAGH,SAAgB,UACd,YACA,MAC6B;CAC7B,MAAM,YAAY,sBAAsB,KAAK;CAC7C,MAAM,SAAS,UAAU,KAAK;AAE9B,QAAO;EACL,IAAI,eAAe,QAAQ,YAAY,KAAK;EAC5C,OAAO,iBAAiB,WAAW,IAAI,WAAW,KAAK,CAAC;EACxD,gBAAgB;EAChB,UAAU,CACR;GACE,aAAa,mBAAmB;GAChC,QAAQ,IAAI,mBAAmB,WAAW;GAC1C;GACA,QAAQ;GACT,CACF;EACD,SAAS,CACP;GACE,aAAa,iBAAiB;GAC9B,SAAS,IAAI,iBAAiB,YAAY,UAAU;GACrD,CACF;EACD,WAAW,CACT;GACE,aAAa,6BAA6B;GAC1C,QAAQ,IAAI,mBAAmB,WAAW;GAC1C;GACA,QAAQ;GACT,CACF;EACF;;AAGH,SAAgB,iBACd,YACA,SAC6B;AAC7B,QAAO;EACL,IAAI,cAAc,WAAW;EAC7B,OAAO,qBAAqB;EAC5B,gBAAgB;EAChB,UAAU,CACR;GACE,aAAa,cAAc,WAAW;GACtC,QAAQ,IAAI,wBAAwB;GACpC,QAAQ,iBAAiB,GAAG,QAAQ,WAAW;GAC/C,QAAQ;GACT,CACF;EACD,SAAS,CACP;GACE,aAAa,qBAAqB;GAClC,SAAS,IAAI,wBAAwB,YAAY,QAAQ;GAC1D,CACF;EACD,WAAW,EAAE;EACd;;AAGH,SAAgB,eAAe,YAAiD;AAC9E,QAAO;EACL,IAAI,cAAc,WAAW;EAC7B,OAAO,mBAAmB;EAC1B,gBAAgB;EAChB,UAAU,EAAE;EACZ,SAAS,CACP;GACE,aAAa,mBAAmB;GAChC,SAAS,IAAI,sBAAsB,WAAW;GAC/C,CACF;EACD,WAAW,EAAE;EACd;;AAGH,SAAgB,cACd,YACA,QACA,SAC6B;AAC7B,QAAO;EACL,IAAI,cAAc,WAAW;EAC7B,OAAO,qBAAqB;EAC5B,gBAAgB;EAChB,UAAU,EAAE;EACZ,SAAS,CACP;GACE,aAAa,qBAAqB;GAClC,SAAS,IAAI,eAAe,YAAY;IACtC,WAAW,EAAE,aAAa,QAAQ;IAClC,iBAAiB,SAAS;IAC1B,kBAAkB,SAAS;IAC5B,CAAC;GACH,CACF;EACD,WAAW,EAAE;EACd;;AAGH,SAAgB,QACd,YACA,SACA,MAC6B;CAC7B,MAAM,eAAe,QAAQ,aAAa,QAAQ,OAAO,KAAK,QAAQ,UAAU,CAAC,SAAS;AAE1F,QAAO;EACL,IAAI,MAAM,MAAM,cAAc,WAAW;EACzC,OAAO,MAAM,SAAS,qBAAqB;EAC3C,gBAAgB,MAAM,kBAAkB;EACxC,UACE,QAAQ,aAAa,OACjB,CACE;GACE,aAAa,cAAc,WAAW;GACtC,QAAQ,IAAI,wBAAwB;GACpC,QAAQ,iBAAiB,GAAG,QAAQ,WAAW;GAC/C,QAAQ;GACT,CACF,GACD,EAAE;EACR,SAAS,CACP;GACE,aAAa,UAAU;GACvB,SAAS,IAAI,eAAe,YAAY,QAAQ;GACjD,CACF;EACD,WAAW,eACP,CACE;GACE,aAAa,wBAAwB;GACrC,QAAQ,IAAI,wBAAwB;GACpC,QAAQ,aAAa,GAAG;IACtB,iBAAiB,GAAG,QAAQ,WAAW;IACvC,GAAI,QAAQ,kBACR,CAAC,iBAAiB,GAAG,2BAA2B,QAAQ,gBAAgB,CAAC,GACzE,EAAE;IACN,GAAI,QAAQ,mBACR,CAAC,iBAAiB,GAAG,4BAA4B,QAAQ,iBAAiB,CAAC,GAC3E,EAAE;IACP,CAAC;GACF,QAAQ;GACT,CACF,GACD,EAAE;EACP;;AAGH,SAAgB,oBACd,MACA,QACA,SAC+B;AAC/B,QAAO,CACL,iBAAiB,MAAM;EACrB,WAAW,EAAE,aAAa,QAAQ;EAClC,iBAAiB;EACjB,kBAAkB;EACnB,CAAC,EACF,GAAG,QAAQ,KAAK,QAAQ,YAAY,MAAM,IAAI,MAAM,EAAE,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAC7E"}