@graphql-tools/executor 0.0.1-alpha-20221025014654-e3be5659

package/esm/execution/index.js

@@ -0,0 +1,5 @@
+export * from './collectFields.js';
+export * from './execute.js';
+export * from './mapAsyncIterator.js';
+export * from './values.js';
+export { pathToArray as responsePathAsArray } from 'graphql/jsutils/Path.js';

package/esm/execution/mapAsyncIterator.js

@@ -0,0 +1,49 @@
+/**
+ * Given an AsyncIterable and a callback function, return an AsyncIterator
+ * which produces values mapped via calling the callback function.
+ */
+export function mapAsyncIterator(iterable, callback) {
+    const iterator = iterable[Symbol.asyncIterator]();
+    async function mapResult(result) {
+        if (result.done) {
+            return result;
+        }
+        try {
+            return { value: await callback(result.value), done: false };
+        }
+        catch (error) {
+            /* c8 ignore start */
+            // FIXME: add test case
+            if (typeof iterator.return === 'function') {
+                try {
+                    await iterator.return();
+                }
+                catch (_e) {
+                    /* ignore error */
+                }
+            }
+            throw error;
+            /* c8 ignore stop */
+        }
+    }
+    return {
+        async next() {
+            return mapResult(await iterator.next());
+        },
+        async return() {
+            // If iterator.return() does not exist, then type R must be undefined.
+            return typeof iterator.return === 'function'
+                ? mapResult(await iterator.return())
+                : { value: undefined, done: true };
+        },
+        async throw(error) {
+            if (typeof iterator.throw === 'function') {
+                return mapResult(await iterator.throw(error));
+            }
+            throw error;
+        },
+        [Symbol.asyncIterator]() {
+            return this;
+        },
+    };
+}

package/esm/execution/subscribe.js

@@ -0,0 +1,159 @@
+import { GraphQLError, locatedError } from 'graphql';
+import { devAssert } from 'graphql/jsutils/devAssert.js';
+import { inspect } from 'graphql/jsutils/inspect.js';
+import { isAsyncIterable } from 'graphql/jsutils/isAsyncIterable.js';
+import { addPath, pathToArray } from 'graphql/jsutils/Path.js';
+import { collectFields } from './collectFields.js';
+import { assertValidExecutionArguments, buildExecutionContext, buildResolveInfo, execute, getFieldDef, } from './execute.js';
+import { mapAsyncIterator } from './mapAsyncIterator.js';
+import { getArgumentValues } from './values.js';
+/**
+ * Implements the "Subscribe" algorithm described in the GraphQL specification.
+ *
+ * Returns a Promise which resolves to either an AsyncIterator (if successful)
+ * or an ExecutionResult (error). The promise will be rejected if the schema or
+ * other arguments to this function are invalid, or if the resolved event stream
+ * is not an async iterable.
+ *
+ * If the client-provided arguments to this function do not result in a
+ * compliant subscription, a GraphQL Response (ExecutionResult) with
+ * descriptive errors and no data will be returned.
+ *
+ * If the source stream could not be created due to faulty subscription
+ * resolver logic or underlying systems, the promise will resolve to a single
+ * ExecutionResult containing `errors` and no `data`.
+ *
+ * If the operation succeeded, the promise resolves to an AsyncIterator, which
+ * yields a stream of ExecutionResults representing the response stream.
+ *
+ * Accepts either an object with named arguments, or individual arguments.
+ */
+export async function subscribe(args) {
+    // Temporary for v15 to v16 migration. Remove in v17
+    devAssert(arguments.length < 2, 'graphql@16 dropped long-deprecated support for positional arguments, please pass an object instead.');
+    const { schema, document, rootValue, contextValue, variableValues, operationName, fieldResolver, subscribeFieldResolver, } = args;
+    const resultOrStream = await createSourceEventStream(schema, document, rootValue, contextValue, variableValues, operationName, subscribeFieldResolver);
+    if (!isAsyncIterable(resultOrStream)) {
+        return resultOrStream;
+    }
+    // For each payload yielded from a subscription, map it over the normal
+    // GraphQL `execute` function, with `payload` as the rootValue.
+    // This implements the "MapSourceToResponseEvent" algorithm described in
+    // the GraphQL specification. The `execute` function provides the
+    // "ExecuteSubscriptionEvent" algorithm, as it is nearly identical to the
+    // "ExecuteQuery" algorithm, for which `execute` is also used.
+    const mapSourceToResponse = (payload) => execute({
+        schema,
+        document,
+        rootValue: payload,
+        contextValue,
+        variableValues,
+        operationName,
+        fieldResolver,
+    });
+    // Map every source value to a ExecutionResult value as described above.
+    return mapAsyncIterator(resultOrStream, mapSourceToResponse);
+}
+/**
+ * Implements the "CreateSourceEventStream" algorithm described in the
+ * GraphQL specification, resolving the subscription source event stream.
+ *
+ * Returns a Promise which resolves to either an AsyncIterable (if successful)
+ * or an ExecutionResult (error). The promise will be rejected if the schema or
+ * other arguments to this function are invalid, or if the resolved event stream
+ * is not an async iterable.
+ *
+ * If the client-provided arguments to this function do not result in a
+ * compliant subscription, a GraphQL Response (ExecutionResult) with
+ * descriptive errors and no data will be returned.
+ *
+ * If the the source stream could not be created due to faulty subscription
+ * resolver logic or underlying systems, the promise will resolve to a single
+ * ExecutionResult containing `errors` and no `data`.
+ *
+ * If the operation succeeded, the promise resolves to the AsyncIterable for the
+ * event stream returned by the resolver.
+ *
+ * A Source Event Stream represents a sequence of events, each of which triggers
+ * a GraphQL execution for that event.
+ *
+ * This may be useful when hosting the stateful subscription service in a
+ * different process or machine than the stateless GraphQL execution engine,
+ * or otherwise separating these two steps. For more on this, see the
+ * "Supporting Subscriptions at Scale" information in the GraphQL specification.
+ */
+export async function createSourceEventStream(schema, document, rootValue, contextValue, variableValues, operationName, subscribeFieldResolver) {
+    // If arguments are missing or incorrectly typed, this is an internal
+    // developer mistake which should throw an early error.
+    assertValidExecutionArguments(schema, document, variableValues);
+    // If a valid execution context cannot be created due to incorrect arguments,
+    // a "Response" with only errors is returned.
+    const exeContext = buildExecutionContext({
+        schema,
+        document,
+        rootValue,
+        contextValue,
+        variableValues,
+        operationName,
+        subscribeFieldResolver,
+    });
+    // Return early errors if execution context failed.
+    if (!('schema' in exeContext)) {
+        return { errors: exeContext };
+    }
+    try {
+        const eventStream = await executeSubscription(exeContext);
+        // Assert field returned an event stream, otherwise yield an error.
+        if (!isAsyncIterable(eventStream)) {
+            throw new Error('Subscription field must return Async Iterable. ' + `Received: ${inspect(eventStream)}.`);
+        }
+        return eventStream;
+    }
+    catch (error) {
+        // If it GraphQLError, report it as an ExecutionResult, containing only errors and no data.
+        // Otherwise treat the error as a system-class error and re-throw it.
+        if (error instanceof GraphQLError) {
+            return { errors: [error] };
+        }
+        throw error;
+    }
+}
+async function executeSubscription(exeContext) {
+    var _a;
+    const { schema, fragments, operation, variableValues, rootValue } = exeContext;
+    const rootType = schema.getSubscriptionType();
+    if (rootType == null) {
+        throw new GraphQLError('Schema is not configured to execute subscription operation.', { nodes: operation });
+    }
+    const rootFields = collectFields(schema, fragments, variableValues, rootType, operation.selectionSet);
+    const [responseName, fieldNodes] = [...rootFields.entries()][0];
+    const fieldDef = getFieldDef(schema, rootType, fieldNodes[0]);
+    if (!fieldDef) {
+        const fieldName = fieldNodes[0].name.value;
+        throw new GraphQLError(`The subscription field "${fieldName}" is not defined.`, { nodes: fieldNodes });
+    }
+    const path = addPath(undefined, responseName, rootType.name);
+    const info = buildResolveInfo(exeContext, fieldDef, fieldNodes, rootType, path);
+    try {
+        // Implements the "ResolveFieldEventStream" algorithm from GraphQL specification.
+        // It differs from "ResolveFieldValue" due to providing a different `resolveFn`.
+        // Build a JS object of arguments from the field.arguments AST, using the
+        // variables scope to fulfill any variable references.
+        const args = getArgumentValues(fieldDef, fieldNodes[0], variableValues);
+        // The resolve function's optional third argument is a context value that
+        // is provided to every resolve function within an execution. It is commonly
+        // used to represent an authenticated user, or request-specific caches.
+        const contextValue = exeContext.contextValue;
+        // Call the `subscribe()` resolver or the default resolver to produce an
+        // AsyncIterable yielding raw payloads.
+        const resolveFn = (_a = fieldDef.subscribe) !== null && _a !== void 0 ? _a : exeContext.subscribeFieldResolver;
+        const eventStream = await resolveFn(rootValue, args, contextValue, info);
+        if (eventStream instanceof Error) {
+            throw eventStream;
+        }
+        return eventStream;
+    }
+    catch (error) {
+        throw locatedError(error, fieldNodes, pathToArray(path));
+    }
+}

package/esm/execution/values.js

@@ -0,0 +1,162 @@
+import { inspect } from 'graphql/jsutils/inspect.js';
+import { keyMap } from 'graphql/jsutils/keyMap.js';
+import { printPathArray } from 'graphql/jsutils/printPathArray.js';
+import { GraphQLError, Kind, print, isInputType, isNonNullType, coerceInputValue, typeFromAST, valueFromAST, } from 'graphql';
+/**
+ * Prepares an object map of variableValues of the correct type based on the
+ * provided variable definitions and arbitrary input. If the input cannot be
+ * parsed to match the variable definitions, a GraphQLError will be thrown.
+ *
+ * Note: The returned value is a plain Object with a prototype, since it is
+ * exposed to user code. Care should be taken to not pull values from the
+ * Object prototype.
+ */
+export function getVariableValues(schema, varDefNodes, inputs, options) {
+    const errors = [];
+    const maxErrors = options === null || options === void 0 ? void 0 : options.maxErrors;
+    try {
+        const coerced = coerceVariableValues(schema, varDefNodes, inputs, error => {
+            if (maxErrors != null && errors.length >= maxErrors) {
+                throw new GraphQLError('Too many errors processing variables, error limit reached. Execution aborted.');
+            }
+            errors.push(error);
+        });
+        if (errors.length === 0) {
+            return { coerced };
+        }
+    }
+    catch (error) {
+        errors.push(error);
+    }
+    // @ts-expect-error - We know that errors is an array of GraphQLError.
+    return { errors };
+}
+function coerceVariableValues(schema, varDefNodes, inputs, onError) {
+    const coercedValues = {};
+    for (const varDefNode of varDefNodes) {
+        const varName = varDefNode.variable.name.value;
+        const varType = typeFromAST(schema, varDefNode.type);
+        if (!isInputType(varType)) {
+            // Must use input types for variables. This should be caught during
+            // validation, however is checked again here for safety.
+            const varTypeStr = print(varDefNode.type);
+            onError(new GraphQLError(`Variable "$${varName}" expected value of type "${varTypeStr}" which cannot be used as an input type.`, { nodes: varDefNode.type }));
+            continue;
+        }
+        if (!hasOwnProperty(inputs, varName)) {
+            if (varDefNode.defaultValue) {
+                coercedValues[varName] = valueFromAST(varDefNode.defaultValue, varType);
+            }
+            else if (isNonNullType(varType)) {
+                const varTypeStr = inspect(varType);
+                onError(new GraphQLError(`Variable "$${varName}" of required type "${varTypeStr}" was not provided.`, {
+                    nodes: varDefNode,
+                }));
+            }
+            continue;
+        }
+        const value = inputs[varName];
+        if (value === null && isNonNullType(varType)) {
+            const varTypeStr = inspect(varType);
+            onError(new GraphQLError(`Variable "$${varName}" of non-null type "${varTypeStr}" must not be null.`, {
+                nodes: varDefNode,
+            }));
+            continue;
+        }
+        coercedValues[varName] = coerceInputValue(value, varType, (path, invalidValue, error) => {
+            let prefix = `Variable "$${varName}" got invalid value ` + inspect(invalidValue);
+            if (path.length > 0) {
+                prefix += ` at "${varName}${printPathArray(path)}"`;
+            }
+            onError(new GraphQLError(prefix + '; ' + error.message, {
+                nodes: varDefNode,
+                originalError: error.originalError,
+            }));
+        });
+    }
+    return coercedValues;
+}
+/**
+ * Prepares an object map of argument values given a list of argument
+ * definitions and list of argument AST nodes.
+ *
+ * Note: The returned value is a plain Object with a prototype, since it is
+ * exposed to user code. Care should be taken to not pull values from the
+ * Object prototype.
+ */
+export function getArgumentValues(def, node, variableValues) {
+    var _a;
+    const coercedValues = {};
+    // FIXME: https://github.com/graphql/graphql-js/issues/2203
+    /* c8 ignore next */
+    const argumentNodes = (_a = node.arguments) !== null && _a !== void 0 ? _a : [];
+    const argNodeMap = keyMap(argumentNodes, arg => arg.name.value);
+    for (const argDef of def.args) {
+        const name = argDef.name;
+        const argType = argDef.type;
+        const argumentNode = argNodeMap[name];
+        if (!argumentNode) {
+            if (argDef.defaultValue !== undefined) {
+                coercedValues[name] = argDef.defaultValue;
+            }
+            else if (isNonNullType(argType)) {
+                throw new GraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` + 'was not provided.', {
+                    nodes: node,
+                });
+            }
+            continue;
+        }
+        const valueNode = argumentNode.value;
+        let isNull = valueNode.kind === Kind.NULL;
+        if (valueNode.kind === Kind.VARIABLE) {
+            const variableName = valueNode.name.value;
+            if (variableValues == null || !hasOwnProperty(variableValues, variableName)) {
+                if (argDef.defaultValue !== undefined) {
+                    coercedValues[name] = argDef.defaultValue;
+                }
+                else if (isNonNullType(argType)) {
+                    throw new GraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` +
+                        `was provided the variable "$${variableName}" which was not provided a runtime value.`, { nodes: valueNode });
+                }
+                continue;
+            }
+            isNull = variableValues[variableName] == null;
+        }
+        if (isNull && isNonNullType(argType)) {
+            throw new GraphQLError(`Argument "${name}" of non-null type "${inspect(argType)}" ` + 'must not be null.', {
+                nodes: valueNode,
+            });
+        }
+        const coercedValue = valueFromAST(valueNode, argType, variableValues);
+        if (coercedValue === undefined) {
+            // Note: ValuesOfCorrectTypeRule validation should catch this before
+            // execution. This is a runtime check to ensure execution does not
+            // continue with an invalid argument value.
+            throw new GraphQLError(`Argument "${name}" has invalid value ${print(valueNode)}.`, { nodes: valueNode });
+        }
+        coercedValues[name] = coercedValue;
+    }
+    return coercedValues;
+}
+/**
+ * Prepares an object map of argument values given a directive definition
+ * and a AST node which may contain directives. Optionally also accepts a map
+ * of variable values.
+ *
+ * If the directive does not exist on the node, returns undefined.
+ *
+ * Note: The returned value is a plain Object with a prototype, since it is
+ * exposed to user code. Care should be taken to not pull values from the
+ * Object prototype.
+ */
+export function getDirectiveValues(directiveDef, node, variableValues) {
+    var _a;
+    const directiveNode = (_a = node.directives) === null || _a === void 0 ? void 0 : _a.find(directive => directive.name.value === directiveDef.name);
+    if (directiveNode) {
+        return getArgumentValues(directiveDef, directiveNode, variableValues);
+    }
+    return undefined;
+}
+function hasOwnProperty(obj, prop) {
+    return Object.prototype.hasOwnProperty.call(obj, prop);
+}

package/esm/index.js

@@ -0,0 +1 @@
+export * from './execution/index.js';

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@graphql-tools/executor",
+  "version": "0.0.1-alpha-20221025014654-e3be5659",
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ardatan/graphql-tools.git",
+    "directory": "packages/executor"
+  },
+  "keywords": [
+    "gql",
+    "graphql",
+    "typescript"
+  ],
+  "author": "Saihajpreet Singh <saihajpreet.singh@gmail.com>",
+  "license": "MIT",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
+  "typescript": {
+    "definition": "typings/index.d.ts"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./typings/index.d.cts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
+    },
+    "./*": {
+      "require": {
+        "types": "./typings/*.d.cts",
+        "default": "./cjs/*.js"
+      },
+      "import": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      },
+      "default": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      }
+    },
+    "./package.json": "./package.json"
+  }
+}

package/typings/execution/AccumulatorMap.d.cts

@@ -0,0 +1,7 @@
+/**
+ * ES6 Map with additional `add` method to accumulate items.
+ */
+export declare class AccumulatorMap<K, T> extends Map<K, Array<T>> {
+    get [Symbol.toStringTag](): string;
+    add(key: K, item: T): void;
+}

package/typings/execution/AccumulatorMap.d.ts

@@ -0,0 +1,7 @@
+/**
+ * ES6 Map with additional `add` method to accumulate items.
+ */
+export declare class AccumulatorMap<K, T> extends Map<K, Array<T>> {
+    get [Symbol.toStringTag](): string;
+    add(key: K, item: T): void;
+}

package/typings/execution/collectFields.d.cts

@@ -0,0 +1,27 @@
+import type { ObjMap } from 'graphql/jsutils/ObjMap.cjs';
+import { FieldNode, FragmentDefinitionNode, SelectionSetNode, GraphQLObjectType, GraphQLSchema } from 'graphql';
+/**
+ * Given a selectionSet, collects all of the fields and returns them.
+ *
+ * CollectFields requires the "runtime type" of an object. For a field that
+ * returns an Interface or Union type, the "runtime type" will be the actual
+ * object type returned by that field.
+ *
+ * @internal
+ */
+export declare function collectFields(schema: GraphQLSchema, fragments: ObjMap<FragmentDefinitionNode>, variableValues: {
+    [variable: string]: unknown;
+}, runtimeType: GraphQLObjectType, selectionSet: SelectionSetNode): Map<string, ReadonlyArray<FieldNode>>;
+/**
+ * Given an array of field nodes, collects all of the subfields of the passed
+ * in fields, and returns them at the end.
+ *
+ * CollectSubFields requires the "return type" of an object. For a field that
+ * returns an Interface or Union type, the "return type" will be the actual
+ * object type returned by that field.
+ *
+ * @internal
+ */
+export declare function collectSubfields(schema: GraphQLSchema, fragments: ObjMap<FragmentDefinitionNode>, variableValues: {
+    [variable: string]: unknown;
+}, returnType: GraphQLObjectType, fieldNodes: ReadonlyArray<FieldNode>): Map<string, ReadonlyArray<FieldNode>>;

package/typings/execution/collectFields.d.ts

@@ -0,0 +1,27 @@
+import type { ObjMap } from 'graphql/jsutils/ObjMap.js';
+import { FieldNode, FragmentDefinitionNode, SelectionSetNode, GraphQLObjectType, GraphQLSchema } from 'graphql';
+/**
+ * Given a selectionSet, collects all of the fields and returns them.
+ *
+ * CollectFields requires the "runtime type" of an object. For a field that
+ * returns an Interface or Union type, the "runtime type" will be the actual
+ * object type returned by that field.
+ *
+ * @internal
+ */
+export declare function collectFields(schema: GraphQLSchema, fragments: ObjMap<FragmentDefinitionNode>, variableValues: {
+    [variable: string]: unknown;
+}, runtimeType: GraphQLObjectType, selectionSet: SelectionSetNode): Map<string, ReadonlyArray<FieldNode>>;
+/**
+ * Given an array of field nodes, collects all of the subfields of the passed
+ * in fields, and returns them at the end.
+ *
+ * CollectSubFields requires the "return type" of an object. For a field that
+ * returns an Interface or Union type, the "return type" will be the actual
+ * object type returned by that field.
+ *
+ * @internal
+ */
+export declare function collectSubfields(schema: GraphQLSchema, fragments: ObjMap<FragmentDefinitionNode>, variableValues: {
+    [variable: string]: unknown;
+}, returnType: GraphQLObjectType, fieldNodes: ReadonlyArray<FieldNode>): Map<string, ReadonlyArray<FieldNode>>;