@envelop/execute-subscription-event 2.4.0-alpha-26c4ae2.0 → 2.4.0

package/README.md

@@ -0,0 +1,51 @@
+## `@envelop/execute-subscription-event`
+
+Utilities for hooking into the [ExecuteSubscriptionEvent](<https://spec.graphql.org/draft/#ExecuteSubscriptionEvent()>) phase.
+
+### `useContextValuePerExecuteSubscriptionEvent`
+
+Create a new context object per `ExecuteSubscriptionEvent` phase, allowing to bypass common issues with context objects such as [`DataLoader`](https://github.com/n1ru4l/envelop/issues/80) [caching](https://github.com/graphql/graphql-js/issues/894) [issues](https://github.com/apollographql/subscriptions-transport-ws/issues/330).
+
+```ts
+import { envelop } from '@envelop/core';
+import { useContextValuePerExecuteSubscriptionEvent } from '@envelop/execute-subscription-event';
+import { createContext, createDataLoaders } from './context';
+
+const getEnveloped = envelop({
+  plugins: [
+    useContext(() => createContext())
+    useContextValuePerExecuteSubscriptionEvent(() => ({
+      // Existing context is merged with this context partial
+      // By recreating the DataLoader we ensure no DataLoader caches from the previous event/initial field subscribe call are are hit
+      contextPartial: {
+        dataLoaders: createDataLoaders()
+      },
+    })),
+    // ... other plugins ...
+  ],
+});
+```
+
+Alternatively, you can also provide a callback that is invoked after each [`ExecuteSubscriptionEvent`](<https://spec.graphql.org/draft/#ExecuteSubscriptionEvent()>) phase.
+
+```ts
+import { envelop } from '@envelop/core';
+import { useContextValuePerExecuteSubscriptionEvent } from '@envelop/execute-subscription-event';
+import { createContext, createDataLoaders } from './context';
+
+const getEnveloped = envelop({
+  plugins: [
+    useContext(() => createContext())
+    useContextValuePerExecuteSubscriptionEvent(({ args }) => ({
+      onEnd: () => {
+        // Note that onEnd is invoked only after each ExecuteSubscriptionEvent phase
+        // This means the initial event will still use the cache from potential subscribe dataloader calls
+        // If you use this to clear DataLoader caches it is recommended to not do any DataLoader calls within your field subscribe function.
+        args.contextValue.dataLoaders.users.clearAll()
+        args.contextValue.dataLoaders.posts.clearAll()
+      }
+    })),
+    // ... other plugins ...
+  ],
+});
+```

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/execute-subscription-event",
-  "version": "2.4.0-alpha-26c4ae2.0",
+  "version": "2.4.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-26c4ae2.0",
+    "@envelop/core": "^2.4.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {},