grafast 0.1.1-beta.21 → 0.1.1-beta.22

package/dist/prepare.js

@@ -6,6 +6,7 @@ const graphql = tslib_1.__importStar(require("graphql"));
 const execute_1 = require("graphql/execution/execute");
 const iterall_1 = require("iterall");
 const assert = tslib_1.__importStar(require("./assert.js"));
+const constants_js_1 = require("./constants.js");
 const deferred_js_1 = require("./deferred.js");
 const dev_js_1 = require("./dev.js");
 const executeBucket_js_1 = require("./engine/executeBucket.js");
@@ -13,11 +14,9 @@ const executeOutputPlan_js_1 = require("./engine/executeOutputPlan.js");
 const OperationPlan_js_1 = require("./engine/OperationPlan.js");
 const OutputPlan_js_1 = require("./engine/OutputPlan.js");
 const establishOperationPlan_js_1 = require("./establishOperationPlan.js");
-const interfaces_js_1 = require("./interfaces.js");
 const timeSource_js_1 = require("./timeSource.js");
 const utils_js_1 = require("./utils.js");
 const { GraphQLError } = graphql;
-const $$contextPlanCache = Symbol("contextPlanCache");
 const $$bypassGraphQL = Symbol("bypassGraphQL");
 const bypassGraphQLObj = Object.assign(Object.create(null), {
     [$$bypassGraphQL]: true,
@@ -154,7 +153,7 @@ function outputBucket(outputPlan, rootBucket, rootBucketIndex, requestContext, p
     else {
         const c = (0, OutputPlan_js_1.getChildBucketAndIndex)(outputPlan.layerPlan, null, rootBucket, rootBucketIndex, null);
         if (!c) {
-            throw new Error(`GrafastInternalError<8bbf56c1-8e2a-4ee9-b5fc-724fd0ee222b>: could not find relevant bucket for output plan`);
+            throw new Error(`GrafastInternalError<8bbf56c1-8e2a-4ee9-b5fc-724fd0ee222b>: could not find relevant bucket for output plan ${outputPlan} from ${rootBucket}[${rootBucketIndex}]`);
         }
         [childBucket, childBucketIndex] = c;
     }
@@ -180,14 +179,15 @@ function executePreemptive(args, operationPlan, variableValues, context, rootVal
     store.set(operationPlan.variableValuesStep.id, (0, executeBucket_js_1.unaryExecutionValue)(variableValues));
     store.set(operationPlan.contextStep.id, (0, executeBucket_js_1.unaryExecutionValue)(context));
     store.set(operationPlan.rootValueStep.id, (0, executeBucket_js_1.unaryExecutionValue)(rootValue));
-    const rootBucket = (0, executeBucket_js_1.newBucket)({
+    const rootBucket = (0, executeBucket_js_1.newBucket)(null, {
         layerPlan: operationPlan.rootLayerPlan,
         size,
         store,
         flagUnion: 0,
         polymorphicPathList,
+        polymorphicType: null,
         iterators,
-    }, null);
+    });
     const startTime = timeSource_js_1.timeSource.now();
     const stopTime = executionTimeout !== null ? startTime + executionTimeout : null;
     const requestContext = {
@@ -195,7 +195,7 @@ function executePreemptive(args, operationPlan, variableValues, context, rootVal
         startTime,
         stopTime,
         // toSerialize: [],
-        eventEmitter: rootValue?.[interfaces_js_1.$$eventEmitter],
+        eventEmitter: rootValue?.[constants_js_1.$$eventEmitter],
         insideGraphQL: false,
     };
     const bucketPromise = (0, executeBucket_js_1.executeBucket)(rootBucket, requestContext);
@@ -215,20 +215,21 @@ function executePreemptive(args, operationPlan, variableValues, context, rootVal
             ? (0, executeBucket_js_1.unaryExecutionValue)(payload)
             : (0, executeBucket_js_1.batchExecutionValue)([payload]);
         store.set(rootStep.id, rootExecutionValue);
-        const subscriptionBucket = (0, executeBucket_js_1.newBucket)({
+        const subscriptionBucket = (0, executeBucket_js_1.newBucket)(rootBucket, {
             layerPlan,
             store,
             flagUnion: rootBucket.flagUnion,
             polymorphicPathList: [OperationPlan_js_1.POLYMORPHIC_ROOT_PATH],
+            polymorphicType: null,
             iterators: [new Set()],
             size: 1, //store.size
-        }, rootBucket.metaByMetaKey);
+        });
         const bucketPromise = (0, executeBucket_js_1.executeBucket)(subscriptionBucket, requestContext);
         function outputStreamBucket() {
             const [ctx, result] = outputBucket(operationPlan.rootOutputPlan, subscriptionBucket, ZERO, requestContext, [], rootBucket.store
                 .get(operationPlan.variableValuesStep.id)
                 .at(rootBucketIndex), outputDataAsString);
-            return finalize(result, ctx, index === 0 ? (rootValue[interfaces_js_1.$$extensions] ?? undefined) : undefined, outputDataAsString);
+            return finalize(result, ctx, index === 0 ? (rootValue[constants_js_1.$$extensions] ?? undefined) : undefined, outputDataAsString);
         }
         if ((0, utils_js_1.isPromiseLike)(bucketPromise)) {
             return bucketPromise.then(outputStreamBucket);
@@ -245,8 +246,8 @@ function executePreemptive(args, operationPlan, variableValues, context, rootVal
             ? rootBucket.store.get(rootBucket.layerPlan.rootStep.id)
             : null;
         const bucketRootValue = bucketRootEValue?.at(rootBucketIndex);
-        const bucketRootFlags = bucketRootEValue?._flagsAt(rootBucketIndex) ?? interfaces_js_1.NO_FLAGS;
-        if (bucketRootFlags & interfaces_js_1.FLAG_ERROR) {
+        const bucketRootFlags = bucketRootEValue?._flagsAt(rootBucketIndex) ?? constants_js_1.NO_FLAGS;
+        if (bucketRootFlags & constants_js_1.FLAG_ERROR) {
             releaseUnusedIterators(rootBucket, rootBucketIndex, null);
             // Something major went wrong!
             const errors = [
@@ -259,7 +260,7 @@ function executePreemptive(args, operationPlan, variableValues, context, rootVal
             ];
             const payload = Object.create(null);
             payload.errors = errors;
-            const extensions = bucketRootValue[interfaces_js_1.$$extensions];
+            const extensions = bucketRootValue[constants_js_1.$$extensions];
             if (extensions != null) {
                 payload.extensions = extensions;
             }
@@ -269,11 +270,11 @@ function executePreemptive(args, operationPlan, variableValues, context, rootVal
         if (bucketRootValue != null &&
             subscriptionLayerPlan != null &&
             Array.isArray(bucketRootValue) &&
-            bucketRootValue[interfaces_js_1.$$streamMore]) {
+            bucketRootValue[constants_js_1.$$streamMore]) {
             // We expect exactly one streamable, we should not need to
             // `releaseUnusedIterators(rootBucket, rootBucketIndex, null)` here.
             const arr = bucketRootValue;
-            const stream = arr[interfaces_js_1.$$streamMore];
+            const stream = arr[constants_js_1.$$streamMore];
             // Do the async iterable
             let stopped = false;
             const abort = (0, deferred_js_1.defer)();
@@ -331,7 +332,7 @@ function executePreemptive(args, operationPlan, variableValues, context, rootVal
             return iterator;
         }
         const [ctx, result] = outputBucket(operationPlan.rootOutputPlan, rootBucket, rootBucketIndex, requestContext, [], rootBucket.store.get(operationPlan.variableValuesStep.id).at(0), outputDataAsString);
-        return finalize(result, ctx, rootValue[interfaces_js_1.$$extensions] ?? undefined, outputDataAsString);
+        return finalize(result, ctx, rootValue[constants_js_1.$$extensions] ?? undefined, outputDataAsString);
     }
     if ((0, utils_js_1.isPromiseLike)(bucketPromise)) {
         return bucketPromise.then(output);
@@ -341,12 +342,12 @@ function executePreemptive(args, operationPlan, variableValues, context, rootVal
     }
 }
 function establishOperationPlanFromEvent(event) {
-    return (0, establishOperationPlan_js_1.establishOperationPlan)(event.schema, event.operation, event.fragments, event.variableValues, event.context, event.rootValue, event.planningTimeout);
+    return (0, establishOperationPlan_js_1.establishOperationPlan)(event.schema, event.operation, event.fragments, event.variableValues, event.context, event.rootValue, event.options);
 }
 /**
  * @internal
  */
-function grafastPrepare(args, options = {}) {
+function grafastPrepare(args, options) {
     const { schema, contextValue: context, rootValue = Object.create(null), 
     // operationName,
     // document,
@@ -356,11 +357,10 @@ function grafastPrepare(args, options = {}) {
     if (Array.isArray(exeContext) || "length" in exeContext) {
         return Object.assign(Object.create(bypassGraphQLObj), {
             errors: exeContext,
-            extensions: rootValue[interfaces_js_1.$$extensions],
+            extensions: rootValue[constants_js_1.$$extensions],
         });
     }
     const { operation, fragments, variableValues } = exeContext;
-    const planningTimeout = options.timeouts?.planning;
     let operationPlan;
     try {
         if (middleware != null) {
@@ -371,12 +371,12 @@ function grafastPrepare(args, options = {}) {
                 variableValues,
                 context: context,
                 rootValue,
-                planningTimeout,
                 args,
+                options,
             }, establishOperationPlanFromEvent);
         }
         else {
-            operationPlan = (0, establishOperationPlan_js_1.establishOperationPlan)(schema, operation, fragments, variableValues, context, rootValue, planningTimeout);
+            operationPlan = (0, establishOperationPlan_js_1.establishOperationPlan)(schema, operation, fragments, variableValues, context, rootValue, options);
         }
     }
     catch (error) {
@@ -388,13 +388,13 @@ function grafastPrepare(args, options = {}) {
     if (options.explain === true ||
         (options.explain && options.explain.includes("plan"))) {
         // Only build the plan once
-        if (operationPlan[$$contextPlanCache] == null) {
-            operationPlan[$$contextPlanCache] = operationPlan.generatePlanJSON();
+        if (operationPlan[constants_js_1.$$contextPlanCache] == null) {
+            operationPlan[constants_js_1.$$contextPlanCache] = operationPlan.generatePlanJSON();
         }
-        rootValue[interfaces_js_1.$$extensions]?.explain?.operations.push({
+        rootValue[constants_js_1.$$extensions]?.explain?.operations.push({
             type: "plan",
             title: "Plan",
-            plan: operationPlan[$$contextPlanCache],
+            plan: operationPlan[constants_js_1.$$contextPlanCache],
         });
     }
     const executionTimeout = options.timeouts?.execution ?? null;
@@ -408,6 +408,9 @@ function newIterator(abort) {
         [Symbol.asyncIterator]() {
             return this;
         },
+        async [Symbol.asyncDispose]() {
+            await this.return();
+        },
         push(v) {
             if (done) {
                 // LOGGING: should we raise this as a bigger issue?
@@ -478,7 +481,7 @@ function newIterator(abort) {
                 abort(e);
                 for (const entry of pullQueue) {
                     try {
-                        entry[0]({ done, value: undefined });
+                        entry[1](e);
                     }
                     catch (e) {
                         // ignore
@@ -493,21 +496,14 @@ async function processStream(requestContext, iterator, spec, outputDataAsString)
     /** Resolve this when finished */
     const whenDone = (0, deferred_js_1.defer)();
     let queue = null;
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     let timeout = null;
-    timeout;
     const _processQueue = (entries) => {
         const size = entries.length;
         const store = new Map();
         const polymorphicPathList = [];
         const iterators = [];
-        let directLayerPlanChild = spec.outputPlan.layerPlan;
-        while (directLayerPlanChild.parentLayerPlan !== spec.bucket.layerPlan) {
-            const parent = directLayerPlanChild.parentLayerPlan;
-            if (!parent) {
-                throw new Error(`GrafastInternalError<f6179ee1-ace2-429c-8f30-8fe6cd53ed03>: Invalid heirarchy - could not find direct layerPlan child of ${spec.bucket.layerPlan}`);
-            }
-            directLayerPlanChild = parent;
-        }
+        const directLayerPlanChild = (0, OutputPlan_js_1.getDirectLayerPlanChild)(spec.bucket.layerPlan, spec.outputPlan.layerPlan);
         const { id: listItemStepId, _isUnary: isUnary } = directLayerPlanChild.rootStep;
         for (const copyStepId of directLayerPlanChild.copyStepIds) {
             const executionValue = spec.bucket.store.get(copyStepId);
@@ -537,14 +533,15 @@ async function processStream(requestContext, iterator, spec, outputDataAsString)
         }
         // const childBucket = newBucket(directLayerPlanChild, noDepsList, store);
         // const childBucketIndex = 0;
-        const rootBucket = (0, executeBucket_js_1.newBucket)({
+        const rootBucket = (0, executeBucket_js_1.newBucket)(spec.bucket, {
             layerPlan: directLayerPlanChild,
             size,
             store,
             flagUnion: 0,
             polymorphicPathList,
+            polymorphicType: null,
             iterators,
-        }, spec.bucket.metaByMetaKey);
+        });
         const bucketPromise = (0, executeBucket_js_1.executeBucket)(rootBucket, requestContext);
         const output = () => {
             const promises = [];
@@ -675,14 +672,15 @@ function processSingleDeferred(requestContext, outputPlan, specs, asString) {
     }
     // const childBucket = newBucket(spec.outputPlan.layerPlan, noDepsList, store);
     // const childBucketIndex = 0;
-    const rootBucket = (0, executeBucket_js_1.newBucket)({
+    const rootBucket = (0, executeBucket_js_1.newBucket)(null, {
         layerPlan: outputPlan.layerPlan,
         size,
         store,
         flagUnion: 0,
         polymorphicPathList,
+        polymorphicType: null,
         iterators,
-    }, null);
+    });
     const bucketPromise = (0, executeBucket_js_1.executeBucket)(rootBucket, requestContext);
     const output = () => {
         const promises = [];
@@ -720,21 +718,26 @@ function processSingleDeferred(requestContext, outputPlan, specs, asString) {
     }
 }
 function processBatches(batchesByRequestTools, whenDone, asString) {
-    // Key is only used for batching
-    const promises = [];
-    for (const [requestContext, batches] of batchesByRequestTools.entries()) {
-        for (const [outputPlan, specs] of batches.entries()) {
-            const promise = processSingleDeferred(requestContext, outputPlan, specs, asString);
-            if ((0, utils_js_1.isPromiseLike)(promise)) {
-                promises.push(promise);
+    try {
+        // Key is only used for batching
+        const promises = [];
+        for (const [requestContext, batches] of batchesByRequestTools.entries()) {
+            for (const [outputPlan, specs] of batches.entries()) {
+                const promise = processSingleDeferred(requestContext, outputPlan, specs, asString);
+                if ((0, utils_js_1.isPromiseLike)(promise)) {
+                    promises.push(promise);
+                }
             }
         }
+        if (promises.length > 0) {
+            Promise.all(promises).then(() => whenDone.resolve(), (e) => whenDone.reject(e));
+        }
+        else {
+            whenDone.resolve();
+        }
     }
-    if (promises.length > 0) {
-        Promise.all(promises).then(() => whenDone.resolve(), (e) => whenDone.reject(e));
-    }
-    else {
-        whenDone.resolve();
+    catch (e) {
+        whenDone.reject(e);
     }
 }
 function processBatchAsString() {

package/dist/step.d.ts

@@ -1,8 +1,7 @@
-import type { GraphQLObjectType } from "graphql";
+import { $$subroutine } from "./constants.js";
 import type { LayerPlan, LayerPlanReasonSubroutine } from "./engine/LayerPlan.js";
 import type { OperationPlan } from "./engine/OperationPlan.js";
-import type { AddDependencyOptions, DependencyOptions, ExecutionDetails, ExecutionEntryFlags, ExecutionResults, GrafastResultsList, JSONValue, PromiseOrDirect, StepOptimizeOptions, UnbatchedExecutionExtra } from "./interfaces.js";
-import { $$subroutine } from "./interfaces.js";
+import type { AddDependencyOptions, AddUnaryDependencyOptions, DependencyOptions, ExecutionDetails, ExecutionEntryFlags, ExecutionResults, GrafastResultsList, JSONValue, PromiseOrDirect, StepOptimizeOptions, UnbatchedExecutionExtra } from "./interfaces.js";
 import type { __FlagStep, __ItemStep } from "./steps/index.js";
 declare function reallyAssertFinalized(plan: Step): void;
 export declare const assertFinalized: typeof reallyAssertFinalized;
@@ -105,6 +104,7 @@ export declare class Step<TData = any> {
     withLayerPlan<T>(callback: () => T): T;
     protected getStep(id: number): Step;
     protected getDepOptions<TStep extends Step = Step>(depId: number): DependencyOptions<TStep>;
+    protected _getDepOptions<TStep extends Step = Step>(depId: number): DependencyOptions<TStep>;
     protected getDep<TStep extends Step = Step>(_depId: number): TStep | __FlagStep<TStep>;
     protected getDep<TStep extends Step = Step>(_depId: number, throwOnFlagged: true): TStep;
     protected maybeGetDep<TStep extends Step = Step>(depId: number | null | undefined): TStep | __FlagStep<TStep> | null;
@@ -131,15 +131,45 @@ export declare class Step<TData = any> {
      */
     toStringMeta(): string | null;
     planJSONExtra(): Record<string, JSONValue | undefined> | undefined;
+    /**
+     * **IF IN DOUBT, USE `.addDependency()` INSTEAD!
+     *
+     * This **DANGEROUS** method allows you to create a reference to another
+     * step. A reference is like a dependency except it has no runtime impact -
+     * the data is not passed into execute. In general you should only add
+     * references to steps that you directly or indirectly depend on (e.g. an
+     * ancestor step) so that you may communicate with said step during
+     * `optimize` (for example). Sometimes it's acceptable to reference steps
+     * that you don't transitively depend on; in those cases you're permitted to
+     * pass an `allowIndirectReason` to explain to yourself and others why you
+     * are breaking these rules.
+     *
+     * @experimental
+     */
+    protected addRef(rawStep: Step, allowIndirectReason?: string | null): number | null;
+    /**
+     * Allows you to dereference a reference made via `addRef`. Will resolve to
+     * whatever that step is now (or null if not found). Note that referenced
+     * referenced steps may change to a new step instance due to lifecycle
+     * methods (e.g. deduplicate) or even to an entirely separate class
+     * altogether (e.g. due to optimize). References are not guaranteed to be
+     * honoured.
+     *
+     * @experimental
+     */
+    protected getRef(refIdx: number | null): Step | null;
     protected canAddDependency(step: Step): boolean;
+    protected _addDependency(options: AddDependencyOptions): number;
     protected addDependency(stepOrOptions: Step | AddDependencyOptions): number;
+    protected addDataDependency(stepOrOptions: Step | AddDependencyOptions): number;
+    protected addStrongDependency(stepOrOptions: Step | AddDependencyOptions): number;
     /**
      * Adds "unary" dependencies; in `execute({count, values})` you'll receive a
      * `values[index]` (where `index` is the return value of this function) with
      * `isBatch = false` so you can use the `values[index].value` property
      * directly.
      */
-    protected addUnaryDependency(stepOrOptions: Step | AddDependencyOptions): number;
+    protected addUnaryDependency(stepOrOptions: Step | AddUnaryDependencyOptions): number;
     /**
      * Given a list of "peer" steps, return a list of these `peers` that are
      * equivalent to this step.
@@ -189,6 +219,10 @@ export declare class Step<TData = any> {
      */
     execute(details: ExecutionDetails): ExecutionResults<TData>;
     destroy(): void;
+    toRecord?(): Step;
+    toSpecifier?(): Step;
+    toTypename?(): Step<string>;
+    cursor?(): Step;
 }
 export declare abstract class UnbatchedStep<TData = any> extends Step<TData> {
     static $$export: {
@@ -196,7 +230,7 @@ export declare abstract class UnbatchedStep<TData = any> extends Step<TData> {
         exportName: string;
     };
     finalize(): void;
-    execute({ indexMap, values, extra, }: ExecutionDetails): PromiseOrDirect<GrafastResultsList<TData>>;
+    execute({ indexMap, values, extra, }: ExecutionDetails): GrafastResultsList<TData>;
     abstract unbatchedExecute(extra: UnbatchedExecutionExtra, ...tuple: any[]): PromiseOrDirect<TData>;
 }
 export declare function isStep<TData = any>(step: unknown): step is Step<TData>;
@@ -222,15 +256,17 @@ export type ListLikeStep<TData extends [...Step[]] = [...Step[]]> = Step<{
     at<TKey extends keyof TData>(key: TKey): Step<TData[TKey]>;
 };
 export declare function isListLikeStep<TData extends [...Step[]] = [...Step[]]>(plan: Step): plan is ListLikeStep<TData>;
-export type PolymorphicStep = Step & {
-    planForType(objectType: GraphQLObjectType): Step;
-};
-export declare function isPolymorphicStep(s: Step): s is PolymorphicStep;
 export interface ListCapableStep<TOutputData, TItemStep extends Step<TOutputData> = Step<TOutputData>> extends Step<ReadonlyArray<any>> {
     listItem(itemPlan: __ItemStep<this>): TItemStep;
 }
 export declare function isListCapableStep<TData, TItemStep extends Step<TData>>(plan: Step<ReadonlyArray<TData>>): plan is ListCapableStep<TData, TItemStep>;
 export declare function assertListCapableStep<TData, TItemStep extends Step<TData>>(plan: Step<ReadonlyArray<TData>>, pathDescription: string): asserts plan is ListCapableStep<TData, TItemStep>;
+export declare function stepHasToSpecifier<TStep extends Step>($step: TStep): $step is TStep & {
+    toSpecifier(): Step;
+};
+export declare function stepHasToRecord<TStep extends Step>($step: TStep): $step is TStep & {
+    toRecord(): Step;
+};
 export { 
 /** @deprecated Use ExecutableStep instead */
 Step as ExecutableStep,