@envelop/core 2.6.0 → 2.6.1-alpha-20220901205925-b1fd44a9

package/esm/plugins/use-masked-errors.js

@@ -1,87 +0,0 @@
-import { GraphQLError } from 'graphql';
-import { handleStreamOrSingleExecutionResult } from '../utils.js';
-export const DEFAULT_ERROR_MESSAGE = 'Unexpected error.';
-export class EnvelopError extends GraphQLError {
-    constructor(message, extensions) {
-        super(message, undefined, undefined, undefined, undefined, undefined, extensions);
-    }
-}
-export const formatError = (err, message, isDev) => {
-    var _a, _b, _c, _d;
-    if (err instanceof GraphQLError) {
-        if (
-        /** execution error */
-        (err.originalError && err.originalError instanceof EnvelopError === false) ||
-            /** validate and parse errors */
-            (err.originalError === undefined && err instanceof EnvelopError === false)) {
-            return new GraphQLError(message, err.nodes, err.source, err.positions, err.path, undefined, isDev
-                ? {
-                    originalError: {
-                        message: (_b = (_a = err.originalError) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : err.message,
-                        stack: (_d = (_c = err.originalError) === null || _c === void 0 ? void 0 : _c.stack) !== null && _d !== void 0 ? _d : err.stack,
-                    },
-                }
-                : undefined);
-        }
-        return err;
-    }
-    return new GraphQLError(message);
-};
-const makeHandleResult = (format, message, isDev) => ({ result, setResult }) => {
-    if (result.errors != null) {
-        setResult({ ...result, errors: result.errors.map(error => format(error, message, isDev)) });
-    }
-};
-export const useMaskedErrors = (opts) => {
-    var _a, _b;
-    const format = (_a = opts === null || opts === void 0 ? void 0 : opts.formatError) !== null && _a !== void 0 ? _a : formatError;
-    const message = (opts === null || opts === void 0 ? void 0 : opts.errorMessage) || DEFAULT_ERROR_MESSAGE;
-    // eslint-disable-next-line dot-notation
-    const isDev = (_b = opts === null || opts === void 0 ? void 0 : opts.isDev) !== null && _b !== void 0 ? _b : (typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false);
-    const handleResult = makeHandleResult(format, message, isDev);
-    return {
-        onParse: (opts === null || opts === void 0 ? void 0 : opts.handleParseErrors) === true
-            ? function onParse() {
-                return function onParseEnd({ result, replaceParseResult }) {
-                    if (result instanceof Error) {
-                        replaceParseResult(format(result, message, isDev));
-                    }
-                };
-            }
-            : undefined,
-        onValidate: (opts === null || opts === void 0 ? void 0 : opts.handleValidationErrors) === true
-            ? function onValidate() {
-                return function onValidateEnd({ valid, result, setResult }) {
-                    if (valid === false) {
-                        setResult(result.map(error => format(error, message, isDev)));
-                    }
-                };
-            }
-            : undefined,
-        onPluginInit(context) {
-            context.registerContextErrorHandler(({ error, setError }) => {
-                if (error instanceof GraphQLError === false && error instanceof Error) {
-                    error = new GraphQLError(error.message, undefined, undefined, undefined, undefined, error);
-                }
-                setError(format(error, message, isDev));
-            });
-        },
-        onExecute() {
-            return {
-                onExecuteDone(payload) {
-                    return handleStreamOrSingleExecutionResult(payload, handleResult);
-                },
-            };
-        },
-        onSubscribe() {
-            return {
-                onSubscribeResult(payload) {
-                    return handleStreamOrSingleExecutionResult(payload, handleResult);
-                },
-                onSubscribeError({ error, setError }) {
-                    setError(format(error, message, isDev));
-                },
-            };
-        },
-    };
-};

package/esm/plugins/use-timing.js

@@ -1,134 +0,0 @@
-import { getOperationAST } from 'graphql';
-import { isIntrospectionOperationString, envelopIsIntrospectionSymbol } from '../utils.js';
-const HR_TO_NS = 1e9;
-const NS_TO_MS = 1e6;
-const DEFAULT_OPTIONS = {
-    onExecutionMeasurement: (args, timing) => console.log(`Operation execution "${args.operationName}" done in ${timing.ms}ms`),
-    onSubscriptionMeasurement: (args, timing) => console.log(`Operation subscription "${args.operationName}" done in ${timing.ms}ms`),
-    onParsingMeasurement: (source, timing) => console.log(`Parsing "${source}" done in ${timing.ms}ms`),
-    onValidationMeasurement: (document, timing) => { var _a, _b; return console.log(`Validation "${((_b = (_a = getOperationAST(document)) === null || _a === void 0 ? void 0 : _a.name) === null || _b === void 0 ? void 0 : _b.value) || '-'}" done in ${timing.ms}ms`); },
-    onResolverMeasurement: (info, timing) => console.log(`\tResolver of "${info.parentType.toString()}.${info.fieldName}" done in ${timing.ms}ms`),
-    onContextBuildingMeasurement: (timing) => console.log(`Context building done in ${timing.ms}ms`),
-};
-const deltaFrom = (hrtime) => {
-    const delta = process.hrtime(hrtime);
-    const ns = delta[0] * HR_TO_NS + delta[1];
-    return {
-        ns,
-        get ms() {
-            return ns / NS_TO_MS;
-        },
-    };
-};
-export const useTiming = (rawOptions) => {
-    const options = {
-        ...DEFAULT_OPTIONS,
-        ...rawOptions,
-    };
-    const result = {};
-    if (options.onContextBuildingMeasurement) {
-        result.onContextBuilding = ({ context }) => {
-            if (context[envelopIsIntrospectionSymbol]) {
-                return;
-            }
-            const contextStartTime = process.hrtime();
-            return () => {
-                options.onContextBuildingMeasurement(deltaFrom(contextStartTime));
-            };
-        };
-    }
-    if (options.onParsingMeasurement) {
-        result.onParse = ({ params, extendContext }) => {
-            if (options.skipIntrospection && isIntrospectionOperationString(params.source)) {
-                extendContext({
-                    [envelopIsIntrospectionSymbol]: true,
-                });
-                return;
-            }
-            const parseStartTime = process.hrtime();
-            return () => {
-                options.onParsingMeasurement(params.source, deltaFrom(parseStartTime));
-            };
-        };
-    }
-    if (options.onValidationMeasurement) {
-        result.onValidate = ({ params, context }) => {
-            if (context[envelopIsIntrospectionSymbol]) {
-                return;
-            }
-            const validateStartTime = process.hrtime();
-            return () => {
-                options.onValidationMeasurement(params.documentAST, deltaFrom(validateStartTime));
-            };
-        };
-    }
-    if (options.onExecutionMeasurement) {
-        if (options.onResolverMeasurement) {
-            result.onExecute = ({ args }) => {
-                if (args.contextValue[envelopIsIntrospectionSymbol]) {
-                    return;
-                }
-                const executeStartTime = process.hrtime();
-                return {
-                    onExecuteDone: () => {
-                        options.onExecutionMeasurement(args, deltaFrom(executeStartTime));
-                    },
-                };
-            };
-            result.onResolverCalled = ({ info }) => {
-                const resolverStartTime = process.hrtime();
-                return () => {
-                    options.onResolverMeasurement(info, deltaFrom(resolverStartTime));
-                };
-            };
-        }
-        else {
-            result.onExecute = ({ args }) => {
-                if (args.contextValue[envelopIsIntrospectionSymbol]) {
-                    return;
-                }
-                const executeStartTime = process.hrtime();
-                return {
-                    onExecuteDone: () => {
-                        options.onExecutionMeasurement(args, deltaFrom(executeStartTime));
-                    },
-                };
-            };
-        }
-    }
-    if (options.onSubscriptionMeasurement) {
-        if (options.onResolverMeasurement) {
-            result.onSubscribe = ({ args }) => {
-                if (args.contextValue[envelopIsIntrospectionSymbol]) {
-                    return;
-                }
-                const subscribeStartTime = process.hrtime();
-                return {
-                    onSubscribeResult: () => {
-                        options.onSubscriptionMeasurement && options.onSubscriptionMeasurement(args, deltaFrom(subscribeStartTime));
-                    },
-                };
-            };
-            result.onResolverCalled = ({ info }) => {
-                const resolverStartTime = process.hrtime();
-                return () => {
-                    options.onResolverMeasurement && options.onResolverMeasurement(info, deltaFrom(resolverStartTime));
-                };
-            };
-        }
-        else {
-            result.onSubscribe = ({ args }) => {
-                if (args.contextValue[envelopIsIntrospectionSymbol]) {
-                    return;
-                }
-                const subscribeStartTime = process.hrtime();
-                return {
-                    onSubscribeResult: () => {
-                        options.onSubscriptionMeasurement && options.onSubscriptionMeasurement(args, deltaFrom(subscribeStartTime));
-                    },
-                };
-            };
-        }
-    }
-    return result;
-};

package/esm/traced-orchestrator.js

@@ -1,132 +0,0 @@
-var _a;
-import { GraphQLSchema, } from 'graphql';
-import { isAsyncIterable } from './utils.js';
-const getTimestamp = typeof globalThis !== 'undefined' && ((_a = globalThis === null || globalThis === void 0 ? void 0 : globalThis.performance) === null || _a === void 0 ? void 0 : _a.now)
-    ? () => globalThis.performance.now()
-    : () => Date.now();
-const measure = () => {
-    const start = getTimestamp();
-    return () => {
-        const end = getTimestamp();
-        return end - start;
-    };
-};
-const tracingSymbol = Symbol('envelopTracing');
-export function traceOrchestrator(orchestrator) {
-    const createTracer = (name, ctx) => {
-        const end = measure();
-        return () => {
-            ctx[tracingSymbol][name] = end();
-        };
-    };
-    return {
-        ...orchestrator,
-        init: (ctx = {}) => {
-            ctx[tracingSymbol] = ctx[tracingSymbol] || {};
-            const done = createTracer('init', ctx || {});
-            try {
-                return orchestrator.init(ctx);
-            }
-            finally {
-                done();
-            }
-        },
-        parse: (ctx = {}) => {
-            ctx[tracingSymbol] = ctx[tracingSymbol] || {};
-            const actualFn = orchestrator.parse(ctx);
-            return (...args) => {
-                const done = createTracer('parse', ctx);
-                try {
-                    return actualFn(...args);
-                }
-                finally {
-                    done();
-                }
-            };
-        },
-        validate: (ctx = {}) => {
-            ctx[tracingSymbol] = ctx[tracingSymbol] || {};
-            const actualFn = orchestrator.validate(ctx);
-            return (...args) => {
-                const done = createTracer('validate', ctx);
-                try {
-                    return actualFn(...args);
-                }
-                finally {
-                    done();
-                }
-            };
-        },
-        execute: async (argsOrSchema, document, rootValue, contextValue, variableValues, operationName, fieldResolver, typeResolver) => {
-            const args = argsOrSchema instanceof GraphQLSchema
-                ? {
-                    schema: argsOrSchema,
-                    document: document,
-                    rootValue,
-                    contextValue,
-                    variableValues,
-                    operationName,
-                    fieldResolver,
-                    typeResolver,
-                }
-                : argsOrSchema;
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore GraphQL.js types contextValue as unknown
-            const done = createTracer('execute', args.contextValue || {});
-            try {
-                const result = await orchestrator.execute(args);
-                done();
-                if (!isAsyncIterable(result)) {
-                    result.extensions = result.extensions || {};
-                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                    // @ts-ignore GraphQL.js types contextValue as unknown
-                    result.extensions.envelopTracing = args.contextValue[tracingSymbol];
-                }
-                else {
-                    // eslint-disable-next-line no-console
-                    console.warn(`"traceOrchestrator" encountered a AsyncIterator which is not supported yet, so tracing data is not available for the operation.`);
-                }
-                return result;
-            }
-            catch (e) {
-                done();
-                throw e;
-            }
-        },
-        subscribe: async (argsOrSchema, document, rootValue, contextValue, variableValues, operationName, fieldResolver, subscribeFieldResolver) => {
-            const args = argsOrSchema instanceof GraphQLSchema
-                ? {
-                    schema: argsOrSchema,
-                    document: document,
-                    rootValue,
-                    contextValue,
-                    variableValues,
-                    operationName,
-                    fieldResolver,
-                    subscribeFieldResolver,
-                }
-                : argsOrSchema;
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore GraphQL.js types contextValue as unknown
-            const done = createTracer('subscribe', args.contextValue || {});
-            try {
-                return await orchestrator.subscribe(args);
-            }
-            finally {
-                done();
-            }
-        },
-        contextFactory: (ctx = {}) => {
-            const actualFn = orchestrator.contextFactory(ctx);
-            return async (childCtx) => {
-                const done = createTracer('contextFactory', ctx);
-                try {
-                    return await actualFn(childCtx);
-                }
-                finally {
-                    done();
-                }
-            };
-        },
-    };
-}

package/typings/plugins/use-immediate-introspection.d.cts

@@ -1,6 +0,0 @@
-import type { Plugin } from '@envelop/types';
-/**
- * In case a GraphQL operation only contains introspection fields the context building can be skipped completely.
- * With this plugin any further context extensions will be skipped.
- */
-export declare const useImmediateIntrospection: () => Plugin;

package/typings/plugins/use-immediate-introspection.d.ts

@@ -1,6 +0,0 @@
-import type { Plugin } from '@envelop/types';
-/**
- * In case a GraphQL operation only contains introspection fields the context building can be skipped completely.
- * With this plugin any further context extensions will be skipped.
- */
-export declare const useImmediateIntrospection: () => Plugin;

package/typings/plugins/use-masked-errors.d.cts

@@ -1,39 +0,0 @@
-import { Plugin } from '@envelop/types';
-import { GraphQLError, GraphQLErrorExtensions } from 'graphql';
-export declare const DEFAULT_ERROR_MESSAGE = "Unexpected error.";
-export declare class EnvelopError extends GraphQLError {
-    constructor(message: string, extensions?: GraphQLErrorExtensions);
-}
-export declare type FormatErrorHandler = (error: GraphQLError | unknown, message: string, isDev: boolean) => GraphQLError;
-export declare const formatError: FormatErrorHandler;
-export declare type UseMaskedErrorsOpts = {
-    /** The function used for format/identify errors. */
-    formatError?: FormatErrorHandler;
-    /** The error message that shall be used for masked errors. */
-    errorMessage?: string;
-    /**
-     * Additional information that is forwarded to the `formatError` function.
-     * The default value is `process.env['NODE_ENV'] === 'development'`
-     */
-    isDev?: boolean;
-    /**
-     * Whether parse errors should be processed by this plugin.
-     * In general it is not recommend to set this flag to `true`
-     * as a `parse` error contains useful information for debugging a GraphQL operation.
-     * A `parse` error never contains any sensitive information.
-     * @default false
-     */
-    handleParseErrors?: boolean;
-    /**
-     * Whether validation errors should processed by this plugin.
-     * In general we recommend against setting this flag to `true`
-     * as a `validate` error contains useful information for debugging a GraphQL operation.
-     * A `validate` error contains "did you mean x" suggestions that make it easier
-     * to reverse-introspect a GraphQL schema whose introspection capabilities got disabled.
-     * Instead of disabling introspection and masking validation errors, using persisted operations
-     * is a safer solution for avoiding the execution of unwanted/arbitrary operations.
-     * @default false
-     */
-    handleValidationErrors?: boolean;
-};
-export declare const useMaskedErrors: (opts?: UseMaskedErrorsOpts) => Plugin;

package/typings/plugins/use-masked-errors.d.ts

@@ -1,39 +0,0 @@
-import { Plugin } from '@envelop/types';
-import { GraphQLError, GraphQLErrorExtensions } from 'graphql';
-export declare const DEFAULT_ERROR_MESSAGE = "Unexpected error.";
-export declare class EnvelopError extends GraphQLError {
-    constructor(message: string, extensions?: GraphQLErrorExtensions);
-}
-export declare type FormatErrorHandler = (error: GraphQLError | unknown, message: string, isDev: boolean) => GraphQLError;
-export declare const formatError: FormatErrorHandler;
-export declare type UseMaskedErrorsOpts = {
-    /** The function used for format/identify errors. */
-    formatError?: FormatErrorHandler;
-    /** The error message that shall be used for masked errors. */
-    errorMessage?: string;
-    /**
-     * Additional information that is forwarded to the `formatError` function.
-     * The default value is `process.env['NODE_ENV'] === 'development'`
-     */
-    isDev?: boolean;
-    /**
-     * Whether parse errors should be processed by this plugin.
-     * In general it is not recommend to set this flag to `true`
-     * as a `parse` error contains useful information for debugging a GraphQL operation.
-     * A `parse` error never contains any sensitive information.
-     * @default false
-     */
-    handleParseErrors?: boolean;
-    /**
-     * Whether validation errors should processed by this plugin.
-     * In general we recommend against setting this flag to `true`
-     * as a `validate` error contains useful information for debugging a GraphQL operation.
-     * A `validate` error contains "did you mean x" suggestions that make it easier
-     * to reverse-introspect a GraphQL schema whose introspection capabilities got disabled.
-     * Instead of disabling introspection and masking validation errors, using persisted operations
-     * is a safer solution for avoiding the execution of unwanted/arbitrary operations.
-     * @default false
-     */
-    handleValidationErrors?: boolean;
-};
-export declare const useMaskedErrors: (opts?: UseMaskedErrorsOpts) => Plugin;

package/typings/plugins/use-timing.d.cts

@@ -1,21 +0,0 @@
-import { Plugin } from '@envelop/types';
-import { DocumentNode, ExecutionArgs, GraphQLResolveInfo, Source, SubscriptionArgs } from 'graphql';
-import { envelopIsIntrospectionSymbol } from '../utils.cjs';
-export declare type ResultTiming = {
-    ms: number;
-    ns: number;
-};
-export declare type TimingPluginOptions = {
-    skipIntrospection?: boolean;
-    onContextBuildingMeasurement?: (timing: ResultTiming) => void;
-    onExecutionMeasurement?: (args: ExecutionArgs, timing: ResultTiming) => void;
-    onSubscriptionMeasurement?: (args: SubscriptionArgs, timing: ResultTiming) => void;
-    onParsingMeasurement?: (source: Source | string, timing: ResultTiming) => void;
-    onValidationMeasurement?: (document: DocumentNode, timing: ResultTiming) => void;
-    onResolverMeasurement?: (info: GraphQLResolveInfo, timing: ResultTiming) => void;
-};
-declare type InternalPluginContext = {
-    [envelopIsIntrospectionSymbol]?: true;
-};
-export declare const useTiming: (rawOptions?: TimingPluginOptions) => Plugin<InternalPluginContext>;
-export {};

package/typings/plugins/use-timing.d.ts

@@ -1,21 +0,0 @@
-import { Plugin } from '@envelop/types';
-import { DocumentNode, ExecutionArgs, GraphQLResolveInfo, Source, SubscriptionArgs } from 'graphql';
-import { envelopIsIntrospectionSymbol } from '../utils.js';
-export declare type ResultTiming = {
-    ms: number;
-    ns: number;
-};
-export declare type TimingPluginOptions = {
-    skipIntrospection?: boolean;
-    onContextBuildingMeasurement?: (timing: ResultTiming) => void;
-    onExecutionMeasurement?: (args: ExecutionArgs, timing: ResultTiming) => void;
-    onSubscriptionMeasurement?: (args: SubscriptionArgs, timing: ResultTiming) => void;
-    onParsingMeasurement?: (source: Source | string, timing: ResultTiming) => void;
-    onValidationMeasurement?: (document: DocumentNode, timing: ResultTiming) => void;
-    onResolverMeasurement?: (info: GraphQLResolveInfo, timing: ResultTiming) => void;
-};
-declare type InternalPluginContext = {
-    [envelopIsIntrospectionSymbol]?: true;
-};
-export declare const useTiming: (rawOptions?: TimingPluginOptions) => Plugin<InternalPluginContext>;
-export {};

package/typings/traced-orchestrator.d.cts

@@ -1,7 +0,0 @@
-import { ArbitraryObject } from '@envelop/types';
-import { EnvelopOrchestrator } from './orchestrator.cjs';
-declare const tracingSymbol: unique symbol;
-export declare function traceOrchestrator<TInitialContext extends ArbitraryObject, TPluginsContext extends ArbitraryObject>(orchestrator: EnvelopOrchestrator<TInitialContext, TPluginsContext>): EnvelopOrchestrator<TInitialContext & {
-    [tracingSymbol]?: {};
-}, TPluginsContext>;
-export {};

package/typings/traced-orchestrator.d.ts

@@ -1,7 +0,0 @@
-import { ArbitraryObject } from '@envelop/types';
-import { EnvelopOrchestrator } from './orchestrator.js';
-declare const tracingSymbol: unique symbol;
-export declare function traceOrchestrator<TInitialContext extends ArbitraryObject, TPluginsContext extends ArbitraryObject>(orchestrator: EnvelopOrchestrator<TInitialContext, TPluginsContext>): EnvelopOrchestrator<TInitialContext & {
-    [tracingSymbol]?: {};
-}, TPluginsContext>;
-export {};