@envelop/core 2.0.0-alpha-2c9f1ce.0 → 2.0.0

package/index.d.ts

@@ -9,4 +9,5 @@ export * from './plugins/use-error-handler';
 export * from './plugins/use-extend-context';
 export * from './plugins/use-payload-formatter';
 export * from './plugins/use-masked-errors';
+export * from './plugins/use-immediate-introspection';
 export * from './enable-if';

package/index.js

@@ -485,16 +485,23 @@ function createEnvelopOrchestrator(plugins) {
             const afterCalls = [];
             try {
                 let context = orchestratorCtx ? { ...initialContext, ...orchestratorCtx } : initialContext;
+                let isBreakingContextBuilding = false;
                 for (const onContext of beforeCallbacks.context) {
                     const afterHookResult = await onContext({
                         context,
                         extendContext: extension => {
                             context = { ...context, ...extension };
                         },
+                        breakContextBuilding: () => {
+                            isBreakingContextBuilding = true;
+                        },
                     });
                     if (typeof afterHookResult === 'function') {
                         afterCalls.push(afterHookResult);
                     }
+                    if (isBreakingContextBuilding === true) {
+                        break;
+                    }
                 }
                 for (const afterCb of afterCalls) {
                     afterCb({
@@ -1185,6 +1192,43 @@ const useMaskedErrors = (opts) => {
     };
 };
 
+const OnNonIntrospectionFieldReachedValidationRule = (onNonIntrospectionField) => () => {
+    return {
+        Field(field) {
+            if (!field.name.value.startsWith('__')) {
+                onNonIntrospectionField();
+            }
+        },
+    };
+};
+const fastIntroSpectionSymbol = Symbol('fastIntrospection');
+/**
+ * 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.
+ */
+const useImmediateIntrospection = () => {
+    return {
+        onValidate({ addValidationRule }) {
+            let isIntrospectionOnly = true;
+            addValidationRule(OnNonIntrospectionFieldReachedValidationRule(() => {
+                isIntrospectionOnly = false;
+            }));
+            return function afterValidate({ extendContext }) {
+                if (isIntrospectionOnly) {
+                    extendContext({ [fastIntroSpectionSymbol]: true });
+                }
+            };
+        },
+        onContextBuilding({ context, breakContextBuilding }) {
+            if (context[fastIntroSpectionSymbol]) {
+                // hijack and skip all other context related stuff.
+                // We dont need a context!
+                breakContextBuilding();
+            }
+        },
+    };
+};
+
 Object.keys(types).forEach(function (k) {
     if (k !== 'default') Object.defineProperty(exports, k, {
         enumerable: true,
@@ -1215,6 +1259,7 @@ exports.useAsyncSchema = useAsyncSchema;
 exports.useEnvelop = useEnvelop;
 exports.useErrorHandler = useErrorHandler;
 exports.useExtendContext = useExtendContext;
+exports.useImmediateIntrospection = useImmediateIntrospection;
 exports.useLazyLoadedSchema = useLazyLoadedSchema;
 exports.useLogger = useLogger;
 exports.useMaskedErrors = useMaskedErrors;

package/index.mjs

@@ -481,16 +481,23 @@ function createEnvelopOrchestrator(plugins) {
             const afterCalls = [];
             try {
                 let context = orchestratorCtx ? { ...initialContext, ...orchestratorCtx } : initialContext;
+                let isBreakingContextBuilding = false;
                 for (const onContext of beforeCallbacks.context) {
                     const afterHookResult = await onContext({
                         context,
                         extendContext: extension => {
                             context = { ...context, ...extension };
                         },
+                        breakContextBuilding: () => {
+                            isBreakingContextBuilding = true;
+                        },
                     });
                     if (typeof afterHookResult === 'function') {
                         afterCalls.push(afterHookResult);
                     }
+                    if (isBreakingContextBuilding === true) {
+                        break;
+                    }
                 }
                 for (const afterCb of afterCalls) {
                     afterCb({
@@ -1181,4 +1188,41 @@ const useMaskedErrors = (opts) => {
     };
 };
 
-export { DEFAULT_ERROR_MESSAGE, EnvelopError, enableIf, envelop, envelopIsIntrospectionSymbol, errorAsyncIterator, finalAsyncIterator, formatError, handleStreamOrSingleExecutionResult, isAsyncIterable, isIntrospectionDocument, isIntrospectionOperation, isIntrospectionOperationString, isOperationDefinition, isPluginEnabled, makeExecute, makeSubscribe, mapAsyncIterator, useAsyncSchema, useEnvelop, useErrorHandler, useExtendContext, useLazyLoadedSchema, useLogger, useMaskedErrors, usePayloadFormatter, useSchema, useTiming };
+const OnNonIntrospectionFieldReachedValidationRule = (onNonIntrospectionField) => () => {
+    return {
+        Field(field) {
+            if (!field.name.value.startsWith('__')) {
+                onNonIntrospectionField();
+            }
+        },
+    };
+};
+const fastIntroSpectionSymbol = Symbol('fastIntrospection');
+/**
+ * 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.
+ */
+const useImmediateIntrospection = () => {
+    return {
+        onValidate({ addValidationRule }) {
+            let isIntrospectionOnly = true;
+            addValidationRule(OnNonIntrospectionFieldReachedValidationRule(() => {
+                isIntrospectionOnly = false;
+            }));
+            return function afterValidate({ extendContext }) {
+                if (isIntrospectionOnly) {
+                    extendContext({ [fastIntroSpectionSymbol]: true });
+                }
+            };
+        },
+        onContextBuilding({ context, breakContextBuilding }) {
+            if (context[fastIntroSpectionSymbol]) {
+                // hijack and skip all other context related stuff.
+                // We dont need a context!
+                breakContextBuilding();
+            }
+        },
+    };
+};
+
+export { DEFAULT_ERROR_MESSAGE, EnvelopError, enableIf, envelop, envelopIsIntrospectionSymbol, errorAsyncIterator, finalAsyncIterator, formatError, handleStreamOrSingleExecutionResult, isAsyncIterable, isIntrospectionDocument, isIntrospectionOperation, isIntrospectionOperationString, isOperationDefinition, isPluginEnabled, makeExecute, makeSubscribe, mapAsyncIterator, useAsyncSchema, useEnvelop, useErrorHandler, useExtendContext, useImmediateIntrospection, useLazyLoadedSchema, useLogger, useMaskedErrors, usePayloadFormatter, useSchema, useTiming };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@envelop/core",
-  "version": "2.0.0-alpha-2c9f1ce.0",
+  "version": "2.0.0",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@envelop/types": "1.5.1"
+    "@envelop/types": "2.0.0"
   },
   "repository": {
     "type": "git",

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

@@ -0,0 +1,6 @@
+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;