grafast 0.1.1-beta.19 → 0.1.1-beta.20

package/dist/engine/OperationPlan.d.ts

@@ -1,4 +1,5 @@
 import type { FragmentDefinitionNode, GraphQLFieldMap, GraphQLObjectType, GraphQLSchema, GraphQLUnionType, OperationDefinitionNode } from "graphql";
+import type { Constraint } from "../constraints.js";
 import type { SelectionSetDigest } from "../graphqlCollectFields.js";
 import type { GrafastPlanJSON } from "../index.js";
 import { ExecutableStep } from "../index.js";
@@ -69,11 +70,11 @@ export declare class OperationPlan {
     private scalarPlanInfo;
     constructor(schema: GraphQLSchema, operation: OperationDefinitionNode, fragments: {
         [fragmentName: string]: FragmentDefinitionNode;
-    }, variableValues: {
+    }, variableValuesConstraints: Constraint[], variableValues: {
         [key: string]: any;
-    }, context: {
+    }, contextConstraints: Constraint[], context: {
         [key: string]: any;
-    }, rootValue: any, planningTimeout: number | null);
+    }, rootValueConstraints: Constraint[], rootValue: any, planningTimeout: number | null);
     private lap;
     private checkTimeout;
     private planOperation;
@@ -198,7 +199,7 @@ export declare class OperationPlan {
      *
      * @experimental
      */
-    cacheStep<T extends ExecutableStep>(ownerStep: ExecutableStep, actionKey: string, cacheKey: symbol | string | number, cb: () => T): T;
+    cacheStep<T extends ExecutableStep>(ownerStep: ExecutableStep, actionKey: string, cacheKey: symbol | string | number | boolean | null | undefined, cb: () => T): T;
     /**
      * Clears the cache, typically due to side effects having taken place. Called
      * from setting hasSideEffects on an ExecutableStep, among other places.

package/dist/engine/OperationPlan.js

@@ -62,7 +62,7 @@ const NO_ARGS = {
     },
 };
 class OperationPlan {
-    constructor(schema, operation, fragments, variableValues, context, rootValue, planningTimeout) {
+    constructor(schema, operation, fragments, variableValuesConstraints, variableValues, contextConstraints, context, rootValueConstraints, rootValue, planningTimeout) {
         this.schema = schema;
         this.operation = operation;
         this.fragments = fragments;
@@ -96,12 +96,6 @@ class OperationPlan {
         this.stepTracker = new StepTracker_js_1.StepTracker(this);
         this.maxDeduplicatedStepId = -1;
         this.maxValidatedStepId = -1;
-        /** Constraints based on evaluating variables. @internal */
-        this.variableValuesConstraints = [];
-        /** Constraints based on evaluating context. @internal */
-        this.contextConstraints = [];
-        /** Constraints based on evaluating rootValue. @internal */
-        this.rootValueConstraints = [];
         /**
          * @internal
          */
@@ -138,6 +132,9 @@ class OperationPlan {
             };
         this.polymorphicLayerPlanByPathByLayerPlan = new Map();
         this._cacheStepStoreByLayerPlanAndActionKey = Object.create(null);
+        this.variableValuesConstraints = variableValuesConstraints;
+        this.contextConstraints = contextConstraints;
+        this.rootValueConstraints = rootValueConstraints;
         this.scalarPlanInfo = { schema: this.schema };
         const queryType = schema.getQueryType();
         assert.ok(queryType, "Schema must have a query type");
@@ -1412,6 +1409,16 @@ class OperationPlan {
      */
     getPeers(step) {
         if (step.hasSideEffects) {
+            // Plans with side effects have no peers.
+            return EMPTY_ARRAY;
+        }
+        if (step._stepOptions.stream) {
+            // Streams have no peers - we cannot reference the stream more
+            // than once (and we aim to not cache the stream because we want its
+            // entries to be garbage collected).
+            //
+            // HOWEVER! There may be lifecycle parts that need to be called... So
+            // call the function with an empty array; ignore the result.
             return EMPTY_ARRAY;
         }
         const { dependencies: deps, dependencyForbiddenFlags: flags, dependencyOnReject: onReject, layerPlan: layerPlan, constructor: stepConstructor, peerKey, } = (0, utils_js_1.sudo)(step);
@@ -1868,24 +1875,12 @@ class OperationPlan {
         return step;
     }
     _deduplicateInnerLogic(step) {
-        if (step.hasSideEffects) {
-            // Never deduplicate plans with side effects.
-            return null;
-        }
         if (step instanceof index_js_1.__ItemStep) {
             // __ItemStep cannot be deduplicated
             return null;
         }
-        // OPTIMIZE: Past Benjie thought we might want to revisit this under the
-        // new Grafast system. No idea what he had in mind there though...
-        if (step._stepOptions.stream) {
-            // Never deduplicate streaming plans, we cannot reference the stream more
-            // than once (and we aim to not cache the stream because we want its
-            // entries to be garbage collected).
-            return null;
-        }
         const peers = this.getPeers(step);
-        // Even if there is just one peer, we must still deduplicate because
+        // Even if there are no peers, we must still deduplicate because
         // `deduplicate` is called to indicate that the field is done being
         // planned, which the step class may want to acknowledge by locking certain
         // facets of its functionality (such as adding filters). We'll simplify its
@@ -2633,19 +2628,19 @@ class OperationPlan {
      */
     cacheStep(ownerStep, actionKey, cacheKey, cb) {
         const layerPlan = (0, withGlobalLayerPlan_js_1.currentLayerPlan)();
-        const cache = (this._cacheStepStoreByLayerPlanAndActionKey[`${actionKey}|${layerPlan.id}|${ownerStep.id}`] ??= Object.create(null));
+        const cache = (this._cacheStepStoreByLayerPlanAndActionKey[`${actionKey}|${layerPlan.id}|${ownerStep.id}`] ??= new Map());
         const cacheIt = () => {
             const stepToCache = cb();
             if (!(stepToCache instanceof index_js_1.ExecutableStep)) {
                 throw new Error(`The callback passed to cacheStep must always return an ExecutableStep; but this call from ${ownerStep} returned instead ${(0, inspect_js_1.inspect)(stepToCache)}`);
             }
-            cache[cacheKey] = stepToCache.id;
+            cache.set(cacheKey, stepToCache.id);
             return stepToCache;
         };
-        if (!(cacheKey in cache)) {
+        if (!cache.has(cacheKey)) {
             return cacheIt();
         }
-        const cachedStepId = cache[cacheKey];
+        const cachedStepId = cache.get(cacheKey);
         const cachedStep = this.stepTracker.stepById[cachedStepId];
         return cachedStep ?? cacheIt();
     }

package/dist/establishOperationPlan.js

@@ -50,7 +50,7 @@ const assertFragmentsMatch = !dev_js_1.isDev ? dev_js_1.noop : reallyAssertFragm
  * @remarks Due to the optimisation in `establishOperationPlan`, the schema, document
  * and operationName checks have already been performed.
  */
-function isOperationPlanCompatible(operationPlan, variableValues, context, rootValue) {
+function isOperationPlanResultCompatible(operationPlan, variableValues, context, rootValue) {
     const { variableValuesConstraints, contextConstraints, rootValueConstraints, } = operationPlan;
     if (!(0, constraints_js_1.matchesConstraints)(variableValuesConstraints, variableValues)) {
         return false;
@@ -84,49 +84,54 @@ function establishOperationPlan(schema, operation, fragments, variableValues, co
         let linkedItem = cache.possibleOperationPlans;
         while (linkedItem) {
             const value = linkedItem.value;
-            if (value instanceof index_js_1.SafeError) {
-                if (value.extensions?.[interfaces_js_1.$$timeout] != null) {
-                    if (value.extensions[interfaces_js_1.$$ts] < timeSource_js_1.timeSource.now() - TIMEOUT_TIMEOUT) {
-                        // Remove this out of date timeout
-                        linkedItem = linkedItem.next;
-                        if (previousItem !== null) {
-                            previousItem.next = linkedItem;
+            if (isOperationPlanResultCompatible(value, variableValues, context, rootValue)) {
+                const { error, operationPlan } = value;
+                if (error != null) {
+                    if (error instanceof index_js_1.SafeError) {
+                        if (error.extensions?.[interfaces_js_1.$$timeout] != null) {
+                            if (error.extensions[interfaces_js_1.$$ts] < timeSource_js_1.timeSource.now() - TIMEOUT_TIMEOUT) {
+                                // Remove this out of date timeout
+                                linkedItem = linkedItem.next;
+                                if (previousItem !== null) {
+                                    previousItem.next = linkedItem;
+                                }
+                                else {
+                                    cache.possibleOperationPlans = linkedItem;
+                                }
+                                continue;
+                            }
+                            if (planningTimeout !== null &&
+                                error.extensions[interfaces_js_1.$$timeout] >= planningTimeout) {
+                                // It was a timeout error - do not retry
+                                throw error;
+                            }
+                            else {
+                                // That's Not My Timeout, let's try again.
+                            }
                         }
                         else {
-                            cache.possibleOperationPlans = linkedItem;
+                            // Not a timeout error - this will always fail in the same way?
+                            throw error;
                         }
-                        continue;
-                    }
-                    if (planningTimeout !== null &&
-                        value.extensions[interfaces_js_1.$$timeout] >= planningTimeout) {
-                        // It was a timeout error - do not retry
-                        throw value;
                     }
                     else {
-                        // That's Not My Timeout, let's try again.
+                        // Not a timeout error - this will always fail in the same way?
+                        throw error;
                     }
                 }
                 else {
-                    // Not a timeout error - this will always fail in the same way?
-                    throw value;
-                }
-            }
-            else if (value instanceof Error) {
-                // Not a timeout error - this will always fail in the same way?
-                throw value;
-            }
-            else if (isOperationPlanCompatible(value, variableValues, context, rootValue)) {
-                // Hoist to top of linked list
-                if (previousItem !== null) {
-                    // Remove linkedItem from existing chain
-                    previousItem.next = linkedItem.next;
-                    // Add rest of chain after linkedItem
-                    linkedItem.next = cache.possibleOperationPlans;
-                    // linkedItem is now head of chain
-                    cache.possibleOperationPlans = linkedItem;
+                    // Hoist to top of linked list
+                    if (previousItem !== null) {
+                        // Remove linkedItem from existing chain
+                        previousItem.next = linkedItem.next;
+                        // Add rest of chain after linkedItem
+                        linkedItem.next = cache.possibleOperationPlans;
+                        // linkedItem is now head of chain
+                        cache.possibleOperationPlans = linkedItem;
+                    }
+                    // We found a suitable OperationPlan - use that!
+                    return operationPlan;
                 }
-                // We found a suitable OperationPlan - use that!
-                return value;
             }
             count++;
             lastButOneItem = previousItem;
@@ -137,8 +142,11 @@ function establishOperationPlan(schema, operation, fragments, variableValues, co
     // No suitable OperationPlan found, time to make one.
     let operationPlan;
     let error;
+    const variableValuesConstraints = [];
+    const contextConstraints = [];
+    const rootValueConstraints = [];
     try {
-        operationPlan = new index_js_1.OperationPlan(schema, operation, fragments, variableValues, context, rootValue, planningTimeout);
+        operationPlan = new index_js_1.OperationPlan(schema, operation, fragments, variableValuesConstraints, variableValues, contextConstraints, context, rootValueConstraints, rootValue, planningTimeout);
     }
     catch (e) {
         error = e;
@@ -153,11 +161,19 @@ function establishOperationPlan(schema, operation, fragments, variableValues, co
         });
         schema.extensions.grafast[interfaces_js_1.$$cacheByOperation] = cacheByOperation;
     }
-    const operationPlanOrError = operationPlan ?? error;
+    const establishOperationPlanResult = {
+        variableValuesConstraints,
+        contextConstraints,
+        rootValueConstraints,
+        ...(operationPlan ? { operationPlan } : { error: error }),
+    };
     if (!cache) {
         cache = {
             fragments,
-            possibleOperationPlans: { value: operationPlanOrError, next: null },
+            possibleOperationPlans: {
+                value: establishOperationPlanResult,
+                next: null,
+            },
         };
         cacheByOperation.set(operation, cache);
     }
@@ -171,7 +187,7 @@ function establishOperationPlan(schema, operation, fragments, variableValues, co
         }
         // Add new operationPlan to top of the linked list.
         cache.possibleOperationPlans = {
-            value: operationPlanOrError,
+            value: establishOperationPlanResult,
             next: cache.possibleOperationPlans,
         };
     }

package/dist/inspect.js

@@ -13,7 +13,7 @@ catch {
             !obj ||
             Object.getPrototypeOf(obj) === null ||
             Object.getPrototypeOf(obj) === Object.prototype
-            ? JSON.stringify(obj)
+            ? String(JSON.stringify(obj))
             : String(obj);
     };
 }

package/dist/interfaces.d.ts

@@ -2,6 +2,7 @@ import type EventEmitter from "eventemitter3";
 import type { Middleware } from "graphile-config";
 import type { ASTNode, ExecutionArgs, FragmentDefinitionNode, GraphQLArgs, GraphQLArgument, GraphQLArgumentConfig, GraphQLField, GraphQLFieldConfig, GraphQLInputField, GraphQLInputFieldConfig, GraphQLInputObjectType, GraphQLInputType, GraphQLList, GraphQLNonNull, GraphQLOutputType, GraphQLScalarType, GraphQLSchema, GraphQLType, OperationDefinitionNode, Source, ValueNode, VariableNode } from "graphql";
 import type { ObjMap } from "graphql/jsutils/ObjMap.js";
+import type { Constraint } from "./constraints.js";
 import type { OperationPlan } from "./engine/OperationPlan.js";
 import type { FlaggedValue, SafeError } from "./error.js";
 import type { ExecutableStep, ListCapableStep, ModifierStep, StreamableStep } from "./step.js";
@@ -38,13 +39,26 @@ export declare const $$cacheByOperation: unique symbol;
 export type Fragments = {
     [key: string]: FragmentDefinitionNode;
 };
-export type OperationPlanOrError = OperationPlan | Error | SafeError<{
-    [$$timeout]: number;
-    [$$ts]: number;
-} | {
-    [$$timeout]?: undefined;
-    [$$ts]?: undefined;
-} | undefined>;
+export interface IEstablishOperationPlanResult {
+    variableValuesConstraints: Constraint[];
+    contextConstraints: Constraint[];
+    rootValueConstraints: Constraint[];
+}
+export interface EstablishOperationPlanResultSuccess extends IEstablishOperationPlanResult {
+    error?: never;
+    operationPlan: OperationPlan;
+}
+export interface EstablishOperationPlanResultError extends IEstablishOperationPlanResult {
+    error: Error | SafeError<{
+        [$$timeout]: number;
+        [$$ts]: number;
+    } | {
+        [$$timeout]?: undefined;
+        [$$ts]?: undefined;
+    } | undefined>;
+    operationPlan?: never;
+}
+export type EstablishOperationPlanResult = EstablishOperationPlanResultSuccess | EstablishOperationPlanResultError;
 /**
  * This represents the list of possible operationPlans for a specific document.
  *
@@ -59,7 +73,7 @@ export interface CacheByOperationEntry {
      * list, and if the list grows beyond a maximum size we can drop the last
      * element.
      */
-    possibleOperationPlans: LinkedList<OperationPlanOrError> | null;
+    possibleOperationPlans: LinkedList<EstablishOperationPlanResult> | null;
     fragments: Fragments;
 }
 export interface LinkedList<T> {

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.1.1-beta.19";
+export declare const version = "0.1.1-beta.20";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // This file is autogenerated by /scripts/postversion.mjs
-exports.version = "0.1.1-beta.19";
+exports.version = "0.1.1-beta.20";
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grafast",
-  "version": "0.1.1-beta.19",
+  "version": "0.1.1-beta.20",
   "description": "Cutting edge GraphQL planning and execution engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",