@graphcommerce/graphql-mesh 9.0.0-canary.57 → 9.0.0-canary.58

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 9.0.0-canary.58
+
+### Minor Changes
+
+- [#2330](https://github.com/graphcommerce-org/graphcommerce/pull/2330) [`bc3ec5e`](https://github.com/graphcommerce-org/graphcommerce/commit/bc3ec5e439b97cea4a2cef23e4008c7e0cfd6797) - Created a new @graphql-mesh plugin to forward headers from backends as forwardedHeaders in extensions ([@paales](https://github.com/paales))
+
 ## 9.0.0-canary.57
 
 ## 9.0.0-canary.56

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/graphql-mesh",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "9.0.0-canary.57",
+  "version": "9.0.0-canary.58",
   "main": "index.ts",
   "dependencies": {
     "@graphql-mesh/apollo-link": "latest",
@@ -26,9 +26,9 @@
   },
   "peerDependencies": {
     "@apollo/client": "^3",
-    "@graphcommerce/eslint-config-pwa": "^9.0.0-canary.57",
-    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.57",
-    "@graphcommerce/typescript-config-pwa": "^9.0.0-canary.57",
+    "@graphcommerce/eslint-config-pwa": "^9.0.0-canary.58",
+    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.58",
+    "@graphcommerce/typescript-config-pwa": "^9.0.0-canary.58",
     "graphql": "^16.7.1"
   },
   "devDependencies": {

package/plugin/forward-headers.ts

@@ -0,0 +1,73 @@
+import { isAsyncIterable } from '@envelop/core'
+import { MeshPlugin, MeshPluginOptions } from '@graphql-mesh/types'
+import type { MeshContext } from '../.mesh'
+
+interface ForwardHeaderConfig {
+  forwardHeaders?: string[]
+}
+
+/**
+ * Configure in your meshrc.yaml:
+ *
+ * ```yaml
+ * plugins:
+ *   - '@graphcommerce/graphql-mesh/plugin/forward-headers':
+ *     forwardHeaders:
+ *       - X-Magento-Cache-Id
+ * ```
+ *
+ * On your GraphQL response, you will have a new `forwardedHeaders` field in the `extensions` object (always lower case).
+ *
+ * ```json
+ * {
+ *   "data": {},
+ *   "extensions": {
+ *     "forwardedHeaders": {
+ *       "x-magento-cache-id": "homeHash"
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export default function useForwardHeadersPlugin(
+  config: MeshPluginOptions<ForwardHeaderConfig>,
+): MeshPlugin<MeshContext> {
+  const forwardHeaders = config.forwardHeaders?.map((header) => header.toLowerCase())
+
+  const store = new WeakMap<any, Map<string, string>>()
+  function getStoredForContext(context: MeshContext) {
+    let stored = store.get(context)
+    if (!stored) {
+      stored = new Map()
+      store.set(context, stored)
+    }
+    return stored
+  }
+
+  return {
+    onFetch({ context }) {
+      if (!context) return undefined
+      return ({ response }) => {
+        const stored = getStoredForContext(context)
+        response.headers.forEach((value, headerName) => {
+          if (forwardHeaders?.includes(headerName)) stored.set(headerName, value)
+        })
+      }
+    },
+
+    onExecute({ args: { contextValue } }) {
+      return {
+        onExecuteDone({ result, setResult }) {
+          if (isAsyncIterable(result)) return
+          const stored = store.get(contextValue)
+          if (stored) {
+            setResult({
+              ...result,
+              extensions: { ...result.extensions, forwardedHeaders: Object.fromEntries(stored) },
+            })
+          }
+        },
+      }
+    },
+  }
+}