Do not merge yet: Make ExecutionContext opt-in

.changeset/tame-oranges-exercise.md

@@ -0,0 +1,5 @@
+---
+'graphql-modules': major
+---
+
+Make ExecutionContext opt-in and graphql-modules platform agnostic

.github/workflows/tests.yml

@@ -39,7 +39,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest] # remove windows to speed up the tests
-        node-version: [12, 16, 18]
+        node-version: [16, 18]
         graphql_version:
           - 15
           - 16

benchmark/basic.case.ts

@@ -41,6 +41,7 @@ const app = createApplication({
       },
     }),
   ],
+  executionContext: false,
 });
 
 class Posts {
@@ -76,6 +77,7 @@ const appWithDI = createApplication({
       },
     }),
   ],
+  executionContext: false,
 });
 
 const pureSchema = makeExecutableSchema({

examples/apollo-subscriptions/src/app/index.ts

@@ -5,4 +5,5 @@ import { PostModule } from './post/post.module';
 export const graphqlApplication = createApplication({
   modules: [PostModule],
   providers: [PubSub],
+  executionContext: false,
 });

examples/basic-with-dependency-injection/src/index.ts

@@ -7,6 +7,7 @@ import { graphqlHTTP } from 'express-graphql';
 
 const app = createApplication({
   modules: [BlogModule, UserModule],
+  executionContext: false,
 });
 
 const server = express();

examples/basic/src/index.ts

@@ -17,6 +17,7 @@ import { SocialNetworkModule } from './app/social-network/social-network.module'
 const server = express();
 const app = createApplication({
   modules: [UserModule, AuthModule, SocialNetworkModule],
+  executionContext: false,
 });
 const execute = app.createExecution();
 

examples/graphql-yoga/src/app/index.ts

@@ -3,4 +3,5 @@ import { PostModule } from './post/post.module';
 
 export const app = createApplication({
   modules: [PostModule],
+  executionContext: false,
 });

examples/subscriptions/src/app/index.ts

@@ -5,4 +5,5 @@ import { PostModule } from './post/post.module';
 export const app = createApplication({
   providers: [PubSub],
   modules: [PostModule],
+  executionContext: false,
 });

packages/graphql-modules/src/application/application.ts

@@ -19,6 +19,7 @@ import {
   instantiateSingletonProviders,
 } from './di';
 import { createContextBuilder } from './context';
+import { enableExecutionContext } from './execution-context';
 import { executionCreator } from './execution';
 import { subscriptionCreator } from './subscription';
 import { apolloSchemaCreator, apolloExecutorCreator } from './apollo';
@@ -45,6 +46,7 @@ export interface InternalAppContext {
  *
  * ```typescript
  * import { createApplication } from 'graphql-modules';
+ * import { createHook, executionAsyncId } from 'async_hooks';
  * import { usersModule } from './users';
  * import { postsModule } from './posts';
  * import { commentsModule } from './comments';
@@ -54,7 +56,8 @@ export interface InternalAppContext {
  *     usersModule,
  *     postsModule,
  *     commentsModule
- *   ]
+ *   ],
+ *   executionContext: { createHook, executionAsyncId },
  * })
  * ```
  */
@@ -63,6 +66,11 @@ export function createApplication(
 ): Application {
   function applicationFactory(cfg?: ApplicationConfig): Application {
     const config = cfg || applicationConfig;
+
+    if (config.executionContext) {
+      enableExecutionContext(config.executionContext);
+    }
+
     const providers =
       config.providers && typeof config.providers === 'function'
         ? config.providers()

packages/graphql-modules/src/application/execution-context.ts

@@ -1,4 +1,10 @@
-import { createHook, executionAsyncId } from 'async_hooks';
+export interface ExecutionContextConfig {
+  executionAsyncId: () => number;
+  createHook(config: {
+    init(asyncId: number, _: string, triggerAsyncId: number): void;
+    destroy(asyncId: number): void;
+  }): void;
+}
 
 export interface ExecutionContextPicker {
   getModuleContext(moduleId: string): GraphQLModules.ModuleContext;
@@ -8,26 +14,7 @@ export interface ExecutionContextPicker {
 const executionContextStore = new Map<number, ExecutionContextPicker>();
 const executionContextDependencyStore = new Map<number, Set<number>>();
 
-const executionContextHook = createHook({
-  init(asyncId, _, triggerAsyncId) {
-    // Store same context data for child async resources
-    const ctx = executionContextStore.get(triggerAsyncId);
-    if (ctx) {
-      const dependencies =
-        executionContextDependencyStore.get(triggerAsyncId) ??
-        executionContextDependencyStore
-          .set(triggerAsyncId, new Set())
-          .get(triggerAsyncId)!;
-      dependencies.add(asyncId);
-      executionContextStore.set(asyncId, ctx);
-    }
-  },
-  destroy(asyncId) {
-    if (executionContextStore.has(asyncId)) {
-      executionContextStore.delete(asyncId);
-    }
-  },
-});
+let executionAsyncId: () => number = () => 0;
 
 function destroyContextAndItsChildren(id: number) {
   if (executionContextStore.has(id)) {
@@ -44,33 +31,72 @@ function destroyContextAndItsChildren(id: number) {
   }
 }
 
+let executionContextEnabled = false;
+
 export const executionContext: {
   create(picker: ExecutionContextPicker): () => void;
   getModuleContext: ExecutionContextPicker['getModuleContext'];
   getApplicationContext: ExecutionContextPicker['getApplicationContext'];
 } = {
   create(picker) {
+    if (!executionContextEnabled) {
+      return function destroyContextNoop() {
+        // noop
+      };
+    }
+
     const id = executionAsyncId();
     executionContextStore.set(id, picker);
     return function destroyContext() {
       destroyContextAndItsChildren(id);
     };
   },
   getModuleContext(moduleId) {
+    assertExecutionContext();
+
     const picker = executionContextStore.get(executionAsyncId())!;
     return picker.getModuleContext(moduleId);
   },
   getApplicationContext() {
+    assertExecutionContext();
+
     const picker = executionContextStore.get(executionAsyncId())!;
     return picker.getApplicationContext();
   },
 };
 
-let executionContextEnabled = false;
+export function enableExecutionContext(config: ExecutionContextConfig) {
+  if (!executionContextEnabled) {
+    config.createHook({
+      init(asyncId, _, triggerAsyncId) {
+        // Store same context data for child async resources
+        const ctx = executionContextStore.get(triggerAsyncId);
+        if (ctx) {
+          const dependencies =
+            executionContextDependencyStore.get(triggerAsyncId) ??
+            executionContextDependencyStore
+              .set(triggerAsyncId, new Set())
+              .get(triggerAsyncId)!;
+          dependencies.add(asyncId);
+          executionContextStore.set(asyncId, ctx);
+        }
+      },
+      destroy(asyncId) {
+        if (executionContextStore.has(asyncId)) {
+          executionContextStore.delete(asyncId);
+        }
+      },
+    });
+    executionAsyncId = config.executionAsyncId;
+    executionContextEnabled = true;
+  }
+}
 
-export function enableExecutionContext() {
+export function assertExecutionContext(): void | never {
   if (!executionContextEnabled) {
-    executionContextHook.enable();
+    throw new Error(
+      'Execution Context is not enabled. Please set `executionContext` option in `createApplication`'
+    );
   }
 }
 

packages/graphql-modules/src/application/types.ts

@@ -8,6 +8,7 @@ import {
 import type { Provider, Injector } from '../di';
 import type { Resolvers, Module, MockedModule } from '../module/types';
 import type { MiddlewareMap } from '../shared/middleware';
+import type { ExecutionContextConfig } from './execution-context';
 import type { ApolloRequestContext } from './apollo';
 import type { Single } from '../shared/types';
 import type { InternalAppContext } from './application';
@@ -139,4 +140,20 @@ export interface ApplicationConfig {
     typeDefs: DocumentNode[];
     resolvers: Record<string, any>[];
   }): GraphQLSchema;
+
+  /**
+   * Enables ExecutionContext
+   *
+   * @example
+   *
+   * ```typescript
+   * import { createHook, executionAsyncId } from 'async_hooks';
+   *
+   * const app = createApplication({
+   *  modules: [],
+   *  executionContext: { createHook, executionAsyncId }
+   * });
+   * ```
+   */
+  executionContext: ExecutionContextConfig | false;
 }

packages/graphql-modules/src/di/decorators.ts

@@ -6,7 +6,6 @@ import {
   ensureInjectableMetadata,
 } from './metadata';
 import { Injector } from './injector';
-import { enableExecutionContext } from '../application/execution-context';
 
 function ensureReflect() {
   if (!(Reflect && Reflect.getOwnMetadata)) {
@@ -17,7 +16,6 @@ function ensureReflect() {
 export function Injectable(options?: ProviderOptions): ClassDecorator {
   return (target) => {
     ensureReflect();
-    enableExecutionContext();
 
     const params: Type<any>[] = (
       Reflect.getMetadata('design:paramtypes', target) || []

packages/graphql-modules/src/testing/test-module.ts

@@ -71,6 +71,7 @@ export function testModule(testedModule: Module, config?: TestModuleConfig) {
     modules,
     providers: config?.providers,
     middlewares: config?.middlewares,
+    executionContext: false,
   });
 }
 

packages/graphql-modules/tests/bootstrap.spec.ts

@@ -25,6 +25,7 @@ test('fail when modules have non-unique ids', async () => {
   expect(() => {
     createApplication({
       modules: [modFoo, modBar],
+      executionContext: false,
     });
   }).toThrow(`Modules with non-unique ids: foo`);
 });
@@ -57,6 +58,7 @@ test('should allow multiple type extensions in the same module', async () => {
 
   const app = createApplication({
     modules: [m1],
+    executionContext: false,
   });
 
   const schema = app.schema;
@@ -97,6 +99,7 @@ test('should not thrown when isTypeOf is used', async () => {
 
   const app = createApplication({
     modules: [m1],
+    executionContext: false,
   });
 
   const result = await testkit.execute(app, {
@@ -152,6 +155,7 @@ test('should allow to add __isTypeOf to type resolvers', () => {
   expect(() => {
     createApplication({
       modules: [m1],
+      executionContext: false,
     });
   }).not.toThrow();
 });
@@ -209,6 +213,7 @@ test('should support __resolveType', async () => {
 
   const app = createApplication({
     modules: [m1],
+    executionContext: false,
   });
 
   const result = await testkit.execute(app, {
@@ -296,6 +301,7 @@ test('allow field resolvers in an interface without objects inheriting them', as
 
   const app = createApplication({
     modules: [mod],
+    executionContext: false,
   });
 
   const result = await testkit.execute(app, {
@@ -362,6 +368,7 @@ test('pass field resolvers of an interface to schemaBuilder', async () => {
         inheritResolversFromInterfaces: true,
       });
     },
+    executionContext: false,
   });
 
   const result = await testkit.execute(app, {

packages/graphql-modules/tests/context.spec.ts

@@ -77,6 +77,7 @@ test('Global context and module context should be reachable', async () => {
 
   const app = createApplication({
     modules: [postsModule],
+    executionContext: false,
   });
 
   const contextValue = () => ({

packages/graphql-modules/tests/di-errors.spec.ts

@@ -176,6 +176,7 @@ test('No error in case of module without providers', async () => {
   const app = createApplication({
     modules: [mod],
     providers: [Data],
+    executionContext: false,
   });
 
   const contextValue = { request: {}, response: {} };
@@ -238,7 +239,9 @@ test('Make sure we have readable error', async () => {
     },
   });
 
-  expect(() => createApplication({ modules: [m2, m1] })).toThrowError(
+  expect(() =>
+    createApplication({ modules: [m2, m1], executionContext: false })
+  ).toThrowError(
     'No provider for P1! (P2 -> P1) - in Module "m2" (Singleton Scope)'
   );
 });
@@ -311,6 +314,7 @@ test('Detect collision of two identical global providers (singleton)', async ()
     createApplication({
       modules: [fooModule, barModule],
       providers: [AppData],
+      executionContext: false,
     });
   }).toThrowError(
     `Failed to define 'Data' token as global. Token provided by two modules: 'bar', 'foo'`
@@ -385,6 +389,7 @@ test('Detect collision of two identical global providers (operation)', async ()
     createApplication({
       modules: [fooModule, barModule],
       providers: [AppData],
+      executionContext: false,
     });
   }).toThrowError(
     `Failed to define 'Data' token as global. Token provided by two modules: 'bar', 'foo'`

packages/graphql-modules/tests/di-hooks.spec.ts

@@ -1,4 +1,5 @@
 import 'reflect-metadata';
+import { createHook, executionAsyncId } from 'async_hooks';
 import {
   createApplication,
   createModule,
@@ -79,6 +80,7 @@ test('OnDestroy hook', async () => {
 
   const app = createApplication({
     modules: [postsModule],
+    executionContext: { createHook, executionAsyncId },
   });
 
   const createContext = () => ({ request: {}, response: {} });