Rename instruments to instrumentation (#3865)

* Rename instruments to instrumentation

* Bump

* FIx

* chore(dependencies): updated changesets for modified dependencies

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ardatan

.changeset/@graphql-yoga_nestjs-federation-3865-dependencies.md

@@ -0,0 +1,6 @@
+---
+"@graphql-yoga/nestjs-federation": patch
+---
+dependencies updates:
+  - Updated dependency [`@envelop/apollo-federation@^6.1.3` ↗︎](https://www.npmjs.com/package/@envelop/apollo-federation/v/6.1.3) (from `^6.1.1`, in `dependencies`)
+  - Updated dependency [`@envelop/core@^5.2.3` ↗︎](https://www.npmjs.com/package/@envelop/core/v/5.2.3) (from `^5.2.1`, in `dependencies`)

.changeset/@graphql-yoga_plugin-apollo-inline-trace-3865-dependencies.md

@@ -0,0 +1,5 @@
+---
+"@graphql-yoga/plugin-apollo-inline-trace": patch
+---
+dependencies updates:
+  - Updated dependency [`@envelop/on-resolve@^5.1.3` ↗︎](https://www.npmjs.com/package/@envelop/on-resolve/v/5.1.3) (from `^5.1.1`, in `dependencies`)

.changeset/@graphql-yoga_plugin-prometheus-3865-dependencies.md

@@ -0,0 +1,5 @@
+---
+"@graphql-yoga/plugin-prometheus": patch
+---
+dependencies updates:
+  - Updated dependency [`@envelop/prometheus@^12.1.3` ↗︎](https://www.npmjs.com/package/@envelop/prometheus/v/12.1.3) (from `^12.1.1`, in `dependencies`)

.changeset/@graphql-yoga_plugin-response-cache-3865-dependencies.md

@@ -0,0 +1,6 @@
+---
+"@graphql-yoga/plugin-response-cache": patch
+---
+dependencies updates:
+  - Updated dependency [`@envelop/core@^5.2.3` ↗︎](https://www.npmjs.com/package/@envelop/core/v/5.2.3) (from `^5.2.1`, in `dependencies`)
+  - Updated dependency [`@envelop/response-cache@^7.1.3` ↗︎](https://www.npmjs.com/package/@envelop/response-cache/v/7.1.3) (from `^7.1.1`, in `dependencies`)

.changeset/graphql-yoga-3865-dependencies.md

@@ -0,0 +1,8 @@
+---
+"graphql-yoga": patch
+---
+dependencies updates:
+  - Updated dependency [`@envelop/core@^5.2.3` ↗︎](https://www.npmjs.com/package/@envelop/core/v/5.2.3) (from `^5.2.1`, in `dependencies`)
+  - Updated dependency [`@whatwg-node/server@^0.10.1` ↗︎](https://www.npmjs.com/package/@whatwg-node/server/v/0.10.1) (from `^0.10.0`, in `dependencies`)
+  - Added dependency [`@envelop/instrumentation@^1.0.0` ↗︎](https://www.npmjs.com/package/@envelop/instrumentation/v/1.0.0) (to `dependencies`)
+  - Removed dependency [`@envelop/instruments@^1.0.0` ↗︎](https://www.npmjs.com/package/@envelop/instruments/v/1.0.0) (from `dependencies`)

import-map.json

@@ -9,7 +9,7 @@
     "@graphql-tools/executor": "npm:@graphql-tools/executor",
     "graphql": "npm:graphql",
     "dset": "npm:dset",
-    "@envelop/core": "npm:@envelop/core@3",
+    "@envelop/core": "npm:@envelop/core@5",
     "@envelop/parser-cache": "npm:@envelop/parser-cache",
     "@whatwg-node/fetch": "npm:@whatwg-node/fetch",
     "@whatwg-node/events": "npm:@whatwg-node/[email protected]",

packages/graphql-yoga/CHANGELOG.md

@@ -6,13 +6,13 @@
 
 - [#3793](https://github.com/dotansimha/graphql-yoga/pull/3793)
   [`63b78d5`](https://github.com/dotansimha/graphql-yoga/commit/63b78d5a7f6f7fd1d5939e92ede2574fda9d08dd)
-  Thanks [@EmrysMyrddin](https://github.com/EmrysMyrddin)! - Add new Instruments API
+  Thanks [@EmrysMyrddin](https://github.com/EmrysMyrddin)! - Add new Instrumentation API
 
   Introduction of a new API allowing to instrument the graphql pipeline.
 
   This new API differs from already existing Hooks by not having access to input/output of phases.
-  The goal of `Instruments` is to run allow running code before, after or around the **whole process
-  of a phase**, including plugins hooks executions.
+  The goal of `Instrumentation` is to run allow running code before, after or around the **whole
+  process of a phase**, including plugins hooks executions.
 
   The main use case of this new API is observability (monitoring, tracing, etc...).
 
@@ -27,7 +27,7 @@
     schema,
     plugins: [
       {
-        instruments: {
+        instrumentation: {
           request: ({ request }, wrapped) =>
             Sentry.startSpan({ name: 'Graphql Operation' }, async () => {
               try {
@@ -42,11 +42,11 @@
   })
   ```
 
-  ### Multiple instruments plugins
+  ### Multiple instrumentation plugins
 
-  It is possible to have multiple instruments plugins (Prometheus and Sentry for example), they will
-  be automatically composed by envelop in the same order than the plugin array (first is outermost,
-  last is inner most).
+  It is possible to have multiple instrumentation plugins (Prometheus and Sentry for example), they
+  will be automatically composed by envelop in the same order than the plugin array (first is
+  outermost, last is inner most).
 
   ```ts
   import { createYoga } from 'graphql-yoga'
@@ -58,22 +58,22 @@
   })
   ```
 
-  ### Custom instruments ordering
+  ### Custom instrumentation ordering
 
-  If the default composition ordering doesn't suite your need, you can manually compose instruments.
-  This allows to have a different execution order of hooks and instruments.
+  If the default composition ordering doesn't suite your need, you can manually compose
+  instrumentation. This allows to have a different execution order of hooks and instrumentation.
 
   ```ts
-  import { composeInstruments, createYoga } from 'graphql-yoga'
+  import { composeInstrumentation, createYoga } from 'graphql-yoga'
   import schema from './schema'
 
-  const { instruments: sentryInstruments, ...sentryPlugin } = useSentry()
-  const { instruments: otelInstruments, ...otelPlugin } = useOpentelemetry()
-  const instruments = composeInstruments([otelInstruments, sentryInstruments])
+  const { instrumentation: sentryInstrumentation, ...sentryPlugin } = useSentry()
+  const { instrumentation: otelInstrumentation, ...otelPlugin } = useOpentelemetry()
+  const instrumentation = composeInstrumentation([otelInstrumentation, sentryInstrumentation])
 
   const server = createYoga({
     schema,
-    plugins: [{ instruments }, useSentry(), useOpentelemetry()]
+    plugins: [{ instrumentation }, useSentry(), useOpentelemetry()]
   })
   ```
 
@@ -87,7 +87,7 @@
     [`@envelop/core@^5.2.1` ↗︎](https://www.npmjs.com/package/@envelop/core/v/5.2.1) (from
     `^5.0.2`, in `dependencies`)
   - Added dependency
-    [`@envelop/instruments@^1.0.0` ↗︎](https://www.npmjs.com/package/@envelop/instruments/v/1.0.0)
+    [`@envelop/instrumentation@^1.0.0` ↗︎](https://www.npmjs.com/package/@envelop/instrumentation/v/1.0.0)
     (to `dependencies`)
   - Added dependency
     [`@whatwg-node/promise-helpers@^1.2.4` ↗︎](https://www.npmjs.com/package/@whatwg-node/promise-helpers/v/1.2.4)

packages/graphql-yoga/__tests__/instruments.spec.ts

@@ -1,6 +1,6 @@
 import { createSchema, createYoga, Plugin } from '../src';
 
-describe('instruments', () => {
+describe('instrumentation', () => {
   const schema = createSchema({
     typeDefs: /* GraphQL */ `
       type Query {
@@ -27,7 +27,7 @@ describe('instruments', () => {
   it('should wrap all the phases with the default composition order', async () => {
     const result: string[] = [];
     const make = (name: string): Plugin => ({
-      instruments: {
+      instrumentation: {
         context: (_, w) => {
           result.push(`pre-context-${name}`);
           w();

packages/graphql-yoga/package.json

@@ -49,24 +49,24 @@
     "graphql": "^15.2.0 || ^16.0.0"
   },
   "dependencies": {
-    "@envelop/core": "^5.2.1",
-    "@envelop/instruments": "^1.0.0",
+    "@envelop/core": "^5.2.3",
+    "@envelop/instrumentation": "^1.0.0",
     "@graphql-tools/executor": "^1.4.0",
     "@graphql-tools/schema": "^10.0.11",
     "@graphql-tools/utils": "^10.6.2",
     "@graphql-yoga/logger": "workspace:^",
     "@graphql-yoga/subscription": "workspace:^",
     "@whatwg-node/fetch": "^0.10.5",
     "@whatwg-node/promise-helpers": "^1.2.4",
-    "@whatwg-node/server": "^0.10.0",
+    "@whatwg-node/server": "^0.10.1",
     "dset": "^3.1.4",
     "lru-cache": "^10.0.0",
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@envelop/disable-introspection": "7.1.2",
+    "@envelop/disable-introspection": "7.1.3",
     "@envelop/graphql-jit": "9.1.2",
-    "@envelop/live-query": "8.1.2",
+    "@envelop/live-query": "8.1.3",
     "@graphql-yoga/render-graphiql": "workspace:*",
     "@jest/globals": "^29.2.1",
     "@n1ru4l/in-memory-live-query-store": "0.10.0",

packages/graphql-yoga/src/index.ts

@@ -8,7 +8,7 @@ export * from './server.js';
 export * from './subscription.js';
 export * from './types.js';
 export { maskError } from './utils/mask-error.js';
-export { type OnParamsEventPayload, type Plugin, type Instruments } from './plugins/types.js';
+export { type OnParamsEventPayload, type Plugin, type Instrumentation } from './plugins/types.js';
 export { _createLRUCache, createLRUCache } from './utils/create-lru-cache.js';
 export { mergeSchemas } from '@graphql-tools/schema';
 export {
@@ -35,7 +35,11 @@ export {
   useLogger,
   usePayloadFormatter,
 } from '@envelop/core';
-export { getInstrumentsAndPlugins, chain, composeInstruments } from '@envelop/instruments';
+export {
+  getInstrumentationAndPlugin,
+  chain,
+  composeInstrumentation,
+} from '@envelop/instrumentation';
 export { createGraphQLError, isPromise, mapMaybePromise } from '@graphql-tools/utils';
 export { getSSEProcessor } from './plugins/result-processor/sse.js';
 export { processRegularResult } from './plugins/result-processor/regular.js';
@@ -45,4 +49,4 @@ export {
   type LandingPageRendererOpts,
 } from './plugins/use-unhandled-route.js';
 export { DisposableSymbols } from '@whatwg-node/server';
-export * from '@envelop/instruments';
+export * from '@envelop/instrumentation';

packages/graphql-yoga/src/plugins/types.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import {
-  Instruments as EnvelopInstruments,
+  Instrumentation as EnvelopInstrumentation,
   Plugin as EnvelopPlugin,
   OnExecuteHook,
   OnSubscribeHook,
@@ -13,7 +13,7 @@ import { MaybePromise } from '@whatwg-node/promise-helpers';
 import {
   ServerAdapterPlugin,
   type ServerAdapterInitialContext,
-  type Instruments as ServerAdapterInstruments,
+  type Instrumentation as ServerAdapterInstrumentation,
 } from '@whatwg-node/server';
 import { YogaServer } from '../server.js';
 import {
@@ -51,7 +51,7 @@ export type Plugin<
      * A Tracer instance that will wrap each phases of the request pipeline.
      * This should be used primarly as an observability tool (for monitoring, tracing, etc...).
      */
-    instruments?: Instruments<YogaInitialContext & PluginContext & TUserContext>;
+    instrumentation?: Instrumentation<YogaInitialContext & PluginContext & TUserContext>;
     /**
      * This hook is invoked at Yoga Server initialization, before it starts.
      * Here you can setup long running resources (like monitoring or caching clients)
@@ -92,21 +92,22 @@ export type Plugin<
     onResultProcess?: OnResultProcess<TServerContext>;
   };
 
-export type Instruments<TContext extends Record<string, any>> = EnvelopInstruments<TContext> &
-  ServerAdapterInstruments & {
-    operation?: (
-      payload: { context: TContext },
-      wrapped: () => PromiseOrValue<void>,
-    ) => PromiseOrValue<void>;
-    requestParse?: (
-      payload: { request: Request },
-      wrapped: () => MaybePromise<void>,
-    ) => MaybePromise<void>;
-    resultProcess?: (
-      payload: { request: Request },
-      wrapped: () => MaybePromise<void>,
-    ) => MaybePromise<void>;
-  };
+export type Instrumentation<TContext extends Record<string, any>> =
+  EnvelopInstrumentation<TContext> &
+    ServerAdapterInstrumentation & {
+      operation?: (
+        payload: { context: TContext },
+        wrapped: () => PromiseOrValue<void>,
+      ) => PromiseOrValue<void>;
+      requestParse?: (
+        payload: { request: Request },
+        wrapped: () => MaybePromise<void>,
+      ) => MaybePromise<void>;
+      resultProcess?: (
+        payload: { request: Request },
+        wrapped: () => MaybePromise<void>,
+      ) => MaybePromise<void>;
+    };
 
 export type OnYogaInitHook<TServerContext extends Record<string, any>> = (
   payload: OnYogaInitEventPayload<TServerContext>,

packages/graphql-yoga/src/server.ts

@@ -9,7 +9,7 @@ import {
   useExtendContext,
   useMaskedErrors,
 } from '@envelop/core';
-import { chain, getInstrumented } from '@envelop/instruments';
+import { chain, getInstrumented } from '@envelop/instrumentation';
 import { normalizedExecutor } from '@graphql-tools/executor';
 import { mapAsyncIterator } from '@graphql-tools/utils';
 import { createLogger, LogLevel, YogaLogger } from '@graphql-yoga/logger';
@@ -51,7 +51,7 @@ import { useHTTPValidationError } from './plugins/request-validation/use-http-va
 import { useLimitBatching } from './plugins/request-validation/use-limit-batching.js';
 import { usePreventMutationViaGET } from './plugins/request-validation/use-prevent-mutation-via-get.js';
 import {
-  Instruments,
+  Instrumentation,
   OnExecutionResultHook,
   OnParamsHook,
   OnRequestParseDoneHook,
@@ -224,7 +224,9 @@ export class YogaServer<
   protected plugins: Array<
     Plugin<TUserContext & TServerContext & YogaInitialContext, TServerContext, TUserContext>
   >;
-  private instruments: Instruments<TUserContext & TServerContext & YogaInitialContext> | undefined;
+  private instrumentation:
+    | Instrumentation<TUserContext & TServerContext & YogaInitialContext>
+    | undefined;
   private onRequestParseHooks: OnRequestParseHook<TServerContext>[];
   private onParamsHooks: OnParamsHook<TServerContext>[];
   private onExecutionResultHooks: OnExecutionResultHook<TServerContext>[];
@@ -468,10 +470,10 @@ export class YogaServer<
         if (plugin.onResultProcess) {
           this.onResultProcessHooks.push(plugin.onResultProcess);
         }
-        if (plugin.instruments) {
-          this.instruments = this.instruments
-            ? chain(this.instruments, plugin.instruments)
-            : plugin.instruments;
+        if (plugin.instrumentation) {
+          this.instrumentation = this.instrumentation
+            ? chain(this.instrumentation, plugin.instrumentation)
+            : plugin.instrumentation;
         }
       }
     }
@@ -674,10 +676,10 @@ export class YogaServer<
     request: Request,
     serverContext: TServerContext & ServerAdapterInitialContext,
   ) => {
-    const instrumented = this.instruments && getInstrumented({ request });
+    const instrumented = this.instrumentation && getInstrumented({ request });
 
-    const parseRequest = this.instruments?.requestParse
-      ? instrumented!.asyncFn(this.instruments?.requestParse, this.parseRequest)
+    const parseRequest = this.instrumentation?.requestParse
+      ? instrumented!.asyncFn(this.instrumentation?.requestParse, this.parseRequest)
       : this.parseRequest;
 
     return handleMaybePromise(
@@ -686,11 +688,11 @@ export class YogaServer<
         if (response) {
           return response;
         }
-        const getResultForParams = this.instruments?.operation
+        const getResultForParams = this.instrumentation?.operation
           ? (payload: { request: Request; params: GraphQLParams }, context: any) => {
               const instrumented = getInstrumented({ context });
               const tracedHandler = instrumented.asyncFn(
-                this.instruments?.operation,
+                this.instrumentation?.operation,
                 this.getResultForParams,
               );
               return tracedHandler(payload, context);
@@ -718,8 +720,11 @@ export class YogaServer<
                   serverContext,
                 )) as ResultProcessorInput,
           result => {
-            const tracedProcessResult = this.instruments?.resultProcess
-              ? instrumented!.asyncFn(this.instruments.resultProcess, processResult<TServerContext>)
+            const tracedProcessResult = this.instrumentation?.resultProcess
+              ? instrumented!.asyncFn(
+                  this.instrumentation.resultProcess,
+                  processResult<TServerContext>,
+                )
               : processResult<TServerContext>;
 
             return tracedProcessResult({

packages/nestjs-federation/package.json

@@ -55,8 +55,8 @@
   "dependencies": {
     "@apollo/gateway": "^2.4.0",
     "@apollo/subgraph": "^2.4.0",
-    "@envelop/apollo-federation": "^6.1.1",
-    "@envelop/core": "^5.2.1",
+    "@envelop/apollo-federation": "^6.1.3",
+    "@envelop/core": "^5.2.3",
     "@graphql-yoga/nestjs": "workspace:*",
     "@graphql-yoga/plugin-apollo-inline-trace": "workspace:*"
   },

packages/plugins/apollo-inline-trace/package.json

@@ -42,17 +42,17 @@
   },
   "dependencies": {
     "@apollo/usage-reporting-protobuf": "^4.1.1",
-    "@envelop/on-resolve": "^5.1.1",
+    "@envelop/on-resolve": "^5.1.3",
     "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@apollo/gateway": "^2.9.3",
     "@apollo/subgraph": "^2.9.3",
-    "@envelop/core": "^5.2.1",
+    "@envelop/core": "^5.2.3",
     "@graphql-tools/delegate": "^10.1.1",
     "@graphql-tools/federation": "^3.0.0",
     "@whatwg-node/fetch": "^0.10.1",
-    "@whatwg-node/server": "^0.10.0",
+    "@whatwg-node/server": "^0.10.1",
     "graphql": "16.10.0",
     "graphql-yoga": "workspace:*"
   },

packages/plugins/apollo-managed-federation/package.json

@@ -56,7 +56,7 @@
   },
   "devDependencies": {
     "@whatwg-node/fetch": "^0.10.1",
-    "@whatwg-node/server": "^0.10.0",
+    "@whatwg-node/server": "^0.10.1",
     "graphql": "16.10.0",
     "graphql-yoga": "workspace:^",
     "typescript": "5.8.2"