@graphql-hive/gateway 1.15.5-rc-020510da536b00af88be78943e8e6e1c8647df25 → 1.16.0-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1

package/CHANGELOG.md

@@ -1,16 +1,82 @@
 # @graphql-hive/gateway
 
-## 1.15.5-rc-020510da536b00af88be78943e8e6e1c8647df25
+## 1.16.0-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1
+
+### Minor Changes
+
+- [#1310](https://github.com/graphql-hive/gateway/pull/1310) [`c8ff573`](https://github.com/graphql-hive/gateway/commit/c8ff573391fdb1e3cf75e49cd6416879353050a1) Thanks [@EmrysMyrddin](https://github.com/EmrysMyrddin)! - Added new `withState` plugin utility for easy data sharing between hooks.
+
+  ## New plugin utility to ease data sharing between hooks
+
+  Sometimes, plugins can grow in complexity and need to share data between its hooks.
+
+  A way to solve this can be to mutate the graphql context, but this context is not always available
+  in all hooks in Yoga or Hive Gateway plugins. Moreover, mutating the context gives access to your
+  internal data to all other plugins and graphql resolvers, without mentioning performance impact on
+  field access on this object.
+
+  The recommended approach to this problem was to use a `WeakMap` with a stable key (often the
+  `context` or `request` object). While it works, it's not very convenient for plugin developers, and
+  is prone to error with the choice of key.
+
+  The new `withState` utility solves this DX issue by providing an easy and straightforward API for
+  data sharing between hooks.
+
+  ```ts
+  import { withState } from '@graphql-hive/gateway';
+
+  type State = { foo: string };
+
+  const myPlugin = () =>
+    withState<Plugin, State>(() => ({
+      onParse({ state }) {
+        state.forOperation.foo = 'foo';
+      },
+      onValidate({ state }) {
+        const { foo } = state.forOperation;
+        console.log('foo', foo);
+      },
+    }));
+  ```
+
+  The `state` payload field will be available in all relevant hooks, making it easy to access shared
+  data. It also forces the developer to choose the scope for the data:
+
+  - `forOperation` for a data scoped to GraphQL operation (Envelop, Yoga and Hive Gateway)
+  - `forRequest` for a data scoped to HTTP request (Yoga and Hive Gateway)
+  - `forSubgraphExecution` for a data scoped to the subgraph execution (Hive Gateway)
+
+  Not all scopes are available in all hooks, the type reflects which scopes are available
+
+  Under the hood, those states are kept in memory using `WeakMap`, which avoid any memory leaks.
+
+  It is also possible to manually retrieve the state with the `getState` function:
+
+  ```ts
+  const myPlugin = () =>
+    withState((getState) => ({
+      onParse({ context }) {
+        // You can provide a payload, which will dictate which scope you have access to.
+        // The scope can contain `context`, `request` and `executionRequest` fields.
+        const state = getState({ context });
+        // Use the state elsewhere.
+      },
+    }));
+  ```
 
 ### Patch Changes
 
-- Updated dependencies [[`9b230f3`](https://github.com/graphql-hive/gateway/commit/9b230f35b47afbf3b253e4c21720e836c5a2a8d1)]:
-  - @graphql-hive/gateway-runtime@1.10.0-rc-020510da536b00af88be78943e8e6e1c8647df25
-  - @graphql-hive/plugin-aws-sigv4@1.0.15
+- [#1310](https://github.com/graphql-hive/gateway/pull/1310) [`82d3f6d`](https://github.com/graphql-hive/gateway/commit/82d3f6df10744eecf65f91ad73717c3c7a131aef) Thanks [@EmrysMyrddin](https://github.com/EmrysMyrddin)! - dependencies updates:
+
+  - Updated dependency [`graphql-yoga@^5.14.0` ↗︎](https://www.npmjs.com/package/graphql-yoga/v/5.14.0) (from `^5.13.5`, in `dependencies`)
+
+- Updated dependencies [[`82d3f6d`](https://github.com/graphql-hive/gateway/commit/82d3f6df10744eecf65f91ad73717c3c7a131aef), [`c8ff573`](https://github.com/graphql-hive/gateway/commit/c8ff573391fdb1e3cf75e49cd6416879353050a1)]:
+  - @graphql-hive/gateway-runtime@1.10.0-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1
+  - @graphql-hive/plugin-aws-sigv4@1.0.16-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1
   - @graphql-hive/plugin-deduplicate-request@1.0.1
   - @graphql-mesh/hmac-upstream-signature@1.2.28
-  - @graphql-mesh/plugin-opentelemetry@1.3.63-rc-020510da536b00af88be78943e8e6e1c8647df25
-  - @graphql-mesh/plugin-prometheus@1.3.51-rc-020510da536b00af88be78943e8e6e1c8647df25
+  - @graphql-mesh/plugin-opentelemetry@1.3.63-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1
+  - @graphql-mesh/plugin-prometheus@1.3.51-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1
 
 ## 1.15.4
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-hive/gateway",
-  "version": "1.15.5-rc-020510da536b00af88be78943e8e6e1c8647df25",
+  "version": "1.16.0-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1",
   "type": "module",
   "repository": {
     "type": "git",
@@ -53,9 +53,9 @@
     "@escape.tech/graphql-armor-block-field-suggestions": "^3.0.0",
     "@escape.tech/graphql-armor-max-depth": "^2.4.0",
     "@escape.tech/graphql-armor-max-tokens": "^2.5.0",
-    "@graphql-hive/gateway-runtime": "1.10.0-rc-020510da536b00af88be78943e8e6e1c8647df25",
+    "@graphql-hive/gateway-runtime": "1.10.0-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1",
     "@graphql-hive/importer": "^1.1.0",
-    "@graphql-hive/plugin-aws-sigv4": "^1.0.15",
+    "@graphql-hive/plugin-aws-sigv4": "1.0.16-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1",
     "@graphql-hive/plugin-deduplicate-request": "^1.0.1",
     "@graphql-hive/pubsub": "^1.0.0",
     "@graphql-mesh/cache-cfw-kv": "^0.105.5",
@@ -68,8 +68,8 @@
     "@graphql-mesh/plugin-jit": "^0.2.5",
     "@graphql-mesh/plugin-jwt-auth": "^1.5.6",
     "@graphql-mesh/plugin-mock": "^0.105.6",
-    "@graphql-mesh/plugin-opentelemetry": "1.3.63-rc-020510da536b00af88be78943e8e6e1c8647df25",
-    "@graphql-mesh/plugin-prometheus": "1.3.51-rc-020510da536b00af88be78943e8e6e1c8647df25",
+    "@graphql-mesh/plugin-opentelemetry": "1.3.63-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1",
+    "@graphql-mesh/plugin-prometheus": "1.3.51-alpha-c8ff573391fdb1e3cf75e49cd6416879353050a1",
     "@graphql-mesh/plugin-rate-limit": "^0.104.5",
     "@graphql-mesh/plugin-snapshot": "^0.104.5",
     "@graphql-mesh/transport-http": "^0.6.43",
@@ -85,7 +85,7 @@
     "commander": "^13.1.0",
     "dotenv": "^16.4.7",
     "graphql-ws": "^6.0.4",
-    "graphql-yoga": "^5.13.5",
+    "graphql-yoga": "^5.14.0",
     "tslib": "^2.8.1",
     "ws": "^8.18.0"
   },