grafast 0.1.1-beta.2 → 0.1.1-beta.21

package/README.md

@@ -51,11 +51,10 @@ And please give some love to our featured sponsors 🤩:
 <table><tr>
 <td align="center"><a href="https://www.the-guild.dev/"><img src="https://graphile.org/images/sponsors/theguild.png" width="90" height="90" alt="The Guild" /><br />The Guild</a> *</td>
 <td align="center"><a href="https://dovetailapp.com/"><img src="https://graphile.org/images/sponsors/dovetail.png" width="90" height="90" alt="Dovetail" /><br />Dovetail</a> *</td>
-<td align="center"><a href="https://www.netflix.com/"><img src="https://graphile.org/images/sponsors/Netflix.png" width="90" height="90" alt="Netflix" /><br />Netflix</a> *</td>
 <td align="center"><a href="https://stellate.co/"><img src="https://graphile.org/images/sponsors/Stellate.png" width="90" height="90" alt="Stellate" /><br />Stellate</a> *</td>
+<td align="center"><a href="https://gosteelhead.com/"><img src="https://graphile.org/images/sponsors/steelhead.svg" width="90" height="90" alt="Steelhead" /><br />Steelhead</a> *</td>
 </tr><tr>
-<td align="center"><a href="https://www.accenture.com/"><img src="https://graphile.org/images/sponsors/accenture.svg" width="90" height="90" alt="Accenture" /><br />Accenture</a> *</td>
-<td align="center"><a href="https://microteam.io/"><img src="https://graphile.org/images/sponsors/micro.png" width="90" height="90" alt="We Love Micro" /><br />We Love Micro</a> *</td>
+<td align="center"><a href=""><img src="https://graphile.org/images/sponsors/latchbio.jpg" width="90" height="90" alt="LatchBio" /><br />LatchBio</a> *</td>
 </tr></table>
 
 <em>\* Sponsors the entire Graphile suite</em>

package/dist/args.d.ts

@@ -1,9 +1,6 @@
 import type { ExecutionArgs } from "graphql";
-/**
- * Applies Graphile Config hooks to your GraphQL request, e.g. to
- * populate context or similar.
- *
- * @experimental
- */
-export declare function hookArgs(rawArgs: ExecutionArgs, resolvedPreset: GraphileConfig.ResolvedPreset, ctx: Partial<Grafast.RequestContext>): Grafast.ExecutionArgs | PromiseLike<Grafast.ExecutionArgs>;
+import type { GrafastExecutionArgs, PromiseOrDirect } from "./interfaces.js";
+/** @deprecated Pass `resolvedPreset` and `requestContext` via args directly */
+export declare function hookArgs(rawArgs: ExecutionArgs, resolvedPreset: GraphileConfig.ResolvedPreset, ctx: Partial<Grafast.RequestContext>): PromiseOrDirect<Grafast.ExecutionArgs>;
+export declare function hookArgs(rawArgs: GrafastExecutionArgs): PromiseOrDirect<Grafast.ExecutionArgs>;
 //# sourceMappingURL=args.d.ts.map

package/dist/args.js

@@ -1,62 +1,77 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hookArgs = void 0;
-const config_js_1 = require("./config.js");
+exports.hookArgs = hookArgs;
 const interfaces_js_1 = require("./interfaces.js");
+const middleware_js_1 = require("./middleware.js");
 const utils_js_1 = require("./utils.js");
+const EMPTY_OBJECT = Object.freeze(Object.create(null));
+const $$writeTest = Symbol("grafastWriteTest");
 /**
  * Applies Graphile Config hooks to your GraphQL request, e.g. to
  * populate context or similar.
  *
  * @experimental
  */
-function hookArgs(rawArgs, resolvedPreset, ctx) {
+function hookArgs(rawArgs, legacyResolvedPreset, legacyCtx) {
+    if (legacyResolvedPreset !== undefined) {
+        rawArgs.resolvedPreset = legacyResolvedPreset;
+    }
+    if (legacyCtx !== undefined) {
+        rawArgs.requestContext = rawArgs.requestContext ?? legacyCtx;
+    }
+    const { middleware: rawMiddleware, resolvedPreset, contextValue: rawContextValue, } = rawArgs;
+    try {
+        rawContextValue[$$writeTest] = true;
+    }
+    catch (e) {
+        // Make context mutable
+        rawArgs.contextValue = Object.assign(Object.create(null), rawContextValue);
+    }
+    const middleware = rawMiddleware === undefined && resolvedPreset != null
+        ? (0, middleware_js_1.getGrafastMiddleware)(resolvedPreset)
+        : (rawMiddleware ?? null);
+    if (rawMiddleware === undefined) {
+        rawArgs.middleware = middleware;
+    }
     const args = rawArgs;
     // Assert that args haven't already been hooked
     if (args[interfaces_js_1.$$hooked]) {
         throw new Error("Must not call hookArgs twice!");
     }
     args[interfaces_js_1.$$hooked] = true;
-    // Make context mutable
-    args.contextValue = Object.assign(Object.create(null), args.contextValue);
-    // finalize(args): args is deliberately shadowed
-    const finalize = (args) => {
-        const userContext = resolvedPreset.grafast?.context;
-        if (typeof userContext === "function") {
-            const result = userContext(ctx, args);
-            if ((0, utils_js_1.isPromiseLike)(result)) {
-                // Deliberately shadowed 'result'
-                return result.then((result) => {
-                    Object.assign(args.contextValue, result);
-                    return args;
-                });
-            }
-            else {
-                Object.assign(args.contextValue, result);
+    if (middleware != null) {
+        return middleware.run("prepareArgs", { args }, finalizeWithEvent);
+    }
+    else {
+        return finalize(args);
+    }
+}
+function finalize(args) {
+    const userContext = args.resolvedPreset?.grafast?.context;
+    const contextValue = args.contextValue;
+    if (typeof userContext === "function") {
+        const result = userContext(args.requestContext ?? EMPTY_OBJECT, args);
+        if ((0, utils_js_1.isPromiseLike)(result)) {
+            // Deliberately shadowed 'result'
+            return result.then((result) => {
+                Object.assign(contextValue, result);
                 return args;
-            }
-        }
-        else if (typeof userContext === "object" && userContext !== null) {
-            Object.assign(args.contextValue, userContext);
-            return args;
+            });
         }
         else {
+            Object.assign(contextValue, result);
             return args;
         }
-    };
-    if (resolvedPreset !== config_js_1.NULL_PRESET &&
-        resolvedPreset.plugins &&
-        resolvedPreset.plugins.length > 0) {
-        const event = { args, ctx, resolvedPreset };
-        const result = (0, config_js_1.hook)(resolvedPreset, "args", event);
-        if ((0, utils_js_1.isPromiseLike)(result)) {
-            return result.then(() => finalize(event.args));
-        }
-        else {
-            return finalize(event.args);
-        }
     }
-    return finalize(args);
+    else if (typeof userContext === "object" && userContext !== null) {
+        Object.assign(contextValue, userContext);
+        return args;
+    }
+    else {
+        return args;
+    }
+}
+function finalizeWithEvent(event) {
+    return finalize(event.args);
 }
-exports.hookArgs = hookArgs;
 //# sourceMappingURL=args.js.map

package/dist/assert.js

@@ -6,19 +6,18 @@
  * https://github.com/facebook/jest/issues/2549
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.strictEqual = exports.ok = void 0;
+exports.ok = ok;
+exports.strictEqual = strictEqual;
 /** Equivalent to `assert.ok(...)` */
 function ok(val, message) {
     if (!val) {
         throw new Error(message);
     }
 }
-exports.ok = ok;
 /** Equivalent to `assert.strictEqual(...)` */
 function strictEqual(actual, expected, message) {
     if (actual !== expected) {
         throw new Error(message + ` (${actual} !== ${expected})`);
     }
 }
-exports.strictEqual = strictEqual;
 //# sourceMappingURL=assert.js.map

package/dist/bucket.d.ts

@@ -1,90 +1,2 @@
-import type { LayerPlan } from "./engine/LayerPlan";
-import type { MetaByMetaKey } from "./engine/OperationPlan";
-import type { ExecutionEventEmitter } from "./interfaces.js";
-/**
- * @internal
- */
-export interface RequestTools {
-    /** The `timeSource.now()` at which the request started executing */
-    startTime: number;
-    /** The `timeSource.now()` at which the request should stop executing (if a timeout was configured) */
-    stopTime: number | null;
-    readonly eventEmitter: ExecutionEventEmitter | undefined;
-    /**
-     * If we're running inside GraphQL then we should not serialize scalars,
-     * otherwise we'll face the double-serialization problem.
-     */
-    insideGraphQL: false;
-}
-/**
- * A "bucket" is where the results from plans are stored so that other plans
- * can retrieve them, it may take on different forms depending on the mode of
- * execution. A "LayerPlan" is used to both identify the bucket and to specify
- * why it exists and how it behaves.
- *
- * Every `ExecutableStep` belongs to exactly one LayerPlan (and thus bucket),
- * specified by `plan.layerPlan`.
- *
- * @internal
- */
-export interface Bucket {
-    /**
-     * The LayerPlan definition this bucket adheres to
-     */
-    layerPlan: LayerPlan;
-    /**
-     * How many entries are there in the bucket?
-     */
-    size: number;
-    /**
-     * The polymorphic path through which each of the entries (respectively) has
-     * travelled. This influences the steps that will be executed using the
-     * related inputs.
-     */
-    polymorphicPathList: readonly (string | null)[];
-    /**
-     * These are the iterators the bucket (or its descendents, without crossing a
-     * stream/defer boundary) have created (if any). Each of these must either be
-     * processed via `processRoot`, or must be manually released (via
-     * `releaseUnusedIterators`) otherwise a memory leak could occur.
-     */
-    iterators: Array<Set<AsyncIterator<any> | Iterator<any>>>;
-    /**
-     * `metaByMetaKey` belongs to the bucket rather than the request context
-     * because mutations and subscriptions shouldn't re-use caches.
-     *
-     * TODO: `inheritMeta: boolean`?
-     */
-    metaByMetaKey: MetaByMetaKey;
-    /**
-     * Every entry in the store is a list with the same length as the bucket has
-     * `size`.
-     *
-     * The entry for '-1' is the request indexes, so we can associate the results
-     * back to the request that triggered them.
-     */
-    store: Map<number, any[]>;
-    /**
-     * Set this true when the bucket is fully executed.
-     *
-     * Initialize it to false.
-     */
-    isComplete: boolean;
-    /**
-     * If an error occurred at any stage we need to drop down to more careful
-     * (and slower) handling.
-     *
-     * Initialize it to false.
-     */
-    hasErrors: boolean;
-    /**
-     * The child buckets of this bucket.
-     */
-    children: {
-        [layerPlanId: number]: {
-            bucket: Bucket;
-            map: Map<number, number | number[]>;
-        };
-    };
-}
+export {};
 //# sourceMappingURL=bucket.d.ts.map

package/dist/config.d.ts

@@ -1,19 +1,2 @@
-import type { AsyncHooks, PluginHook } from "graphile-config";
 export declare const NULL_PRESET: GraphileConfig.ResolvedPreset;
-type GraphileConfigModule = typeof import("graphile-config");
-type PromiseOrValue<T> = T | Promise<T>;
-export declare function withGraphileConfig<T>(callback: (graphileConfig: GraphileConfigModule | null) => PromiseOrValue<T>): PromiseOrValue<T>;
-declare const $$skipHooks: unique symbol;
-declare const $$hooksForPreset: unique symbol;
-declare global {
-    namespace GraphileConfig {
-        interface ResolvedPreset {
-            [$$hooksForPreset]?: null | AsyncHooks<GraphileConfig.GrafastHooks>;
-            [$$skipHooks]?: Record<string, boolean>;
-        }
-    }
-}
-export declare function withHooks<TResult>(resolvedPreset: GraphileConfig.ResolvedPreset, callback: (hooks: AsyncHooks<GraphileConfig.GrafastHooks> | null) => PromiseOrValue<TResult>): PromiseOrValue<TResult>;
-export declare function hook<THookName extends keyof GraphileConfig.GrafastHooks>(resolvedPreset: GraphileConfig.ResolvedPreset, hookName: THookName, ...args: Parameters<GraphileConfig.GrafastHooks[THookName] extends PluginHook<infer U> ? U : never>): PromiseOrValue<void>;
-export {};
 //# sourceMappingURL=config.d.ts.map

package/dist/config.js

@@ -1,99 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hook = exports.withHooks = exports.withGraphileConfig = exports.NULL_PRESET = void 0;
+exports.NULL_PRESET = void 0;
 exports.NULL_PRESET = Object.freeze(Object.create(null));
-let graphileConfig = undefined;
-let graphileConfigLoaded = false;
-function withGraphileConfig(callback) {
-    if (graphileConfig === undefined) {
-        // ESM:
-        // This should be
-        //     graphileConfig = import("graphile-config").then(
-        // but that causes a segfault in jest/node when testing third party
-        // modules. So we had to convert everything to CommonJS.
-        graphileConfig = new Promise((resolve, reject) => {
-            try {
-                resolve(require("graphile-config"));
-            }
-            catch (e) {
-                if (e.code === "ERR_REQUIRE_ESM") {
-                    return import("graphile-config").then(resolve, reject);
-                }
-                else {
-                    reject(e);
-                }
-            }
-        }).then((GC) => {
-            graphileConfig = GC;
-            graphileConfigLoaded = true;
-            return GC;
-        }, () => {
-            graphileConfig = null;
-            graphileConfigLoaded = true;
-            return null;
-        });
-    }
-    if (graphileConfigLoaded) {
-        return callback(graphileConfig);
-    }
-    else {
-        return graphileConfig.then(callback);
-    }
-}
-exports.withGraphileConfig = withGraphileConfig;
-const $$skipHooks = Symbol("skipHooks");
-const $$hooksForPreset = Symbol("grafastHooks");
-function withHooks(resolvedPreset, callback) {
-    const existing = resolvedPreset[$$hooksForPreset];
-    if (existing !== undefined) {
-        return callback(existing);
-    }
-    if (!resolvedPreset.plugins || resolvedPreset.plugins.length === 0) {
-        resolvedPreset[$$hooksForPreset] = null;
-        return callback(null);
-    }
-    const plugins = resolvedPreset.plugins;
-    return withGraphileConfig((gc) => {
-        if (gc !== null) {
-            const hooks = new gc.AsyncHooks();
-            gc.applyHooks(plugins, (p) => p.grafast?.hooks, (name, fn, _plugin) => {
-                hooks.hook(name, fn);
-            });
-            resolvedPreset[$$hooksForPreset] = hooks;
-            return callback(hooks);
-        }
-        else {
-            resolvedPreset[$$hooksForPreset] = null;
-            return callback(null);
-        }
-    });
-}
-exports.withHooks = withHooks;
-function hook(resolvedPreset, hookName, ...args) {
-    if (resolvedPreset[$$skipHooks]?.[hookName]) {
-        return;
-    }
-    return withHooks(resolvedPreset, (hooks) => {
-        if (hooks !== null) {
-            if (hooks.callbacks[hookName] !== undefined) {
-                return hooks.process(hookName, ...args);
-            }
-            else {
-                if (!resolvedPreset[$$skipHooks]) {
-                    resolvedPreset[$$skipHooks] = Object.create(null);
-                }
-                resolvedPreset[$$skipHooks][hookName] = true;
-                return;
-            }
-        }
-        else {
-            if (!resolvedPreset[$$skipHooks]) {
-                resolvedPreset[$$skipHooks] = Object.create(null);
-            }
-            resolvedPreset[$$skipHooks][hookName] = true;
-            return;
-        }
-    });
-}
-exports.hook = hook;
 //# sourceMappingURL=config.js.map

package/dist/constraints.d.ts

@@ -27,6 +27,20 @@ interface ExistsConstraint {
     path: (string | number)[];
     exists: boolean;
 }
+/**
+ * If `keys` is null: asserts that there is no value at the given
+ * path.
+ *
+ * Otherwise: asserts that the value at the given path has the exact same keys.
+ */
+interface KeysConstraint {
+    type: "keys";
+    path: (string | number)[];
+    /**
+     * If this is null it implies that the object did not exist.
+     */
+    keys: ReadonlyArray<string> | null;
+}
 /**
  * If `expectedLength` is null: asserts that there is no value at the given
  * path.
@@ -52,7 +66,7 @@ interface IsEmptyConstraint {
     path: (string | number)[];
     isEmpty: boolean;
 }
-export type Constraint = ValueConstraint | EqualityConstraint | ExistsConstraint | LengthConstraint | IsEmptyConstraint;
+export type Constraint = ValueConstraint | EqualityConstraint | ExistsConstraint | LengthConstraint | IsEmptyConstraint | KeysConstraint;
 /**
  * Implements the `MatchesConstraints` algorithm.
  */

package/dist/constraints.js

@@ -3,7 +3,7 @@
 // and then compiling (JIT-style) remaining constraints into a function using
 // tamedevil
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.matchesConstraints = void 0;
+exports.matchesConstraints = matchesConstraints;
 function valueAtPath(object, path) {
     let value = object;
     for (let i = 0, l = path.length; i < l; i++) {
@@ -32,7 +32,8 @@ function matchesConstraint(constraint, object) {
     const value = valueAtPath(object, constraint.path);
     switch (constraint.type) {
         case "length": {
-            return Array.isArray(value) && value.length === constraint.expectedLength;
+            const actualLength = Array.isArray(value) ? value.length : null;
+            return actualLength === constraint.expectedLength;
         }
         case "exists": {
             return (value !== undefined) === constraint.exists;
@@ -49,6 +50,44 @@ function matchesConstraint(constraint, object) {
                 Object.keys(value).length === 0;
             return isEmpty === constraint.isEmpty;
         }
+        case "keys": {
+            const { keys: expectedKeys } = constraint;
+            if (expectedKeys === null) {
+                return value == null || typeof value !== "object";
+            }
+            else if (value == null || typeof value !== "object") {
+                return false;
+            }
+            else {
+                // keys are always in order of the gql type; see coerceInputValue and __InputObjectStep ctor
+                const valueKeys = Object.keys(value);
+                const valueKeyCount = valueKeys.length;
+                const expectedKeyCount = expectedKeys.length;
+                // Optimization: early bail
+                if (valueKeyCount < expectedKeyCount) {
+                    return false;
+                }
+                /**
+                 * This is `i` but adjusted so that `undefined` doesn't increment it.
+                 * Should match index in `expectedKeys`.
+                 */
+                let definedRawKeyCount = 0;
+                for (let i = 0; i < valueKeyCount; i++) {
+                    const valueKey = valueKeys[i];
+                    if (value[valueKey] !== undefined) {
+                        if (valueKey !== expectedKeys[definedRawKeyCount]) {
+                            return false;
+                        }
+                        definedRawKeyCount++;
+                    }
+                }
+                // Make sure there aren't any additional expected keys
+                if (definedRawKeyCount !== expectedKeyCount) {
+                    return false;
+                }
+                return true;
+            }
+        }
         default: {
             const never = constraint;
             throw new Error(`Unsupported constraint type '${never.type}'`);
@@ -68,5 +107,4 @@ function matchesConstraints(constraints, object) {
     }
     return true;
 }
-exports.matchesConstraints = matchesConstraints;
 //# sourceMappingURL=constraints.js.map

package/dist/deferred.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defer = void 0;
+exports.defer = defer;
 function NOOP() { }
 /**
  * Returns a promise that can be `.resolve()`-ed or `.reject()`-ed at a later
@@ -21,5 +21,4 @@ function defer() {
     promise.then(null, NOOP);
     return promise;
 }
-exports.defer = defer;
 //# sourceMappingURL=deferred.js.map

package/dist/dev.d.ts

@@ -1,6 +1,3 @@
-/**
- * @internal
- */
-export declare const isDev: boolean;
+export declare const isTest: boolean;
 export declare function noop(): void;
 //# sourceMappingURL=dev.d.ts.map

package/dist/dev.js

@@ -1,10 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.noop = exports.isDev = void 0;
+exports.isTest = exports.isDev = void 0;
+exports.noop = noop;
 /**
  * @internal
  */
-exports.isDev = typeof process !== "undefined" && process.env.GRAPHILE_ENV === "development";
+const graphileEnv = typeof process !== "undefined" ? process.env.GRAPHILE_ENV : undefined;
+const nodeEnv = typeof process !== "undefined" ? process.env.NODE_ENV : undefined;
+const mode = graphileEnv !== undefined ? graphileEnv : nodeEnv;
+/**
+ * @internal
+ */
+exports.isDev = mode === "development" || mode === "test";
+exports.isTest = mode === "test";
 function noop() { }
-exports.noop = noop;
+if (typeof process !== "undefined" &&
+    typeof graphileEnv === "undefined" &&
+    typeof nodeEnv === "undefined") {
+    console.warn(`The GRAPHILE_ENV environmental variable is not set; Grafast will run in production mode. In your development environments, it's recommended that you set \`GRAPHILE_ENV=development\` to opt in to additional checks that will provide guidance and help you to catch issues in your code earlier, and other changes such as formatting to improve your development experience.`);
+}
+else if (exports.isDev && !exports.isTest && typeof graphileEnv === "undefined") {
+    console.warn(`Grafast is running in development mode due to \`NODE_ENV=${nodeEnv}\`; this is recommended for development environments (and strongly discouraged in production), but will impact on performance - in particular, planning will be significantly more expensive. To remove this warning, make this explicit with \`GRAPHILE_ENV=development\` envvar.`);
+}
 //# sourceMappingURL=dev.js.map