fix(client): send the correct version for integration packages (#7253)

Author: ardatan

.changeset/fifty-shirts-strive.md

@@ -0,0 +1,7 @@
+---
+'@graphql-hive/envelop': patch
+'@graphql-hive/yoga': patch
+'@graphql-hive/apollo': patch
+---
+
+Send correct version of the client packages, previously they were sending the version of `@graphql-hive/core` package.

.changeset/five-spiders-serve.md

@@ -0,0 +1,17 @@
+---
+'@graphql-hive/core': patch
+---
+
+Allow to provide `version` to `AgentOptions` in Hive Client integrations.
+
+```ts
+createHive({
+    agent: {
+        name: 'my-custom-agent',
+        version: '1.2.3', // new field
+    },
+})
+```
+
+Currently you can provide `name` but not `version`. This change allows to provide both `name` and `version` to better identify the clients connecting to Hive Console.
+Previously the dependent libraries like Yoga, Envelop and Hive Gateway integrations were incorrectly sending their names with the version of `@graphql-hive/core` package. Now they will be able to send their own versions.

.changeset/spotty-beans-report.md

@@ -0,0 +1,6 @@
+---
+'@graphql-hive/core': patch
+---
+
+Accept `name` and `version` to `createSupergraphSDLFetcher` to build a more accurate user agent
+instead of passing `hive-client` with `@graphql-hive/core`'s version

packages/libraries/apollo/src/index.ts

@@ -9,6 +9,7 @@ import {
   isHiveClient,
   SupergraphSDLFetcherOptions,
 } from '@graphql-hive/core';
+import { version } from './version.js';
 
 export {
   atLeastOnceSampler,
@@ -78,6 +79,7 @@ export function createHive(clientOrOptions: HivePluginOptions) {
     ...clientOrOptions,
     agent: {
       name: 'hive-client-yoga',
+      version,
       ...clientOrOptions.agent,
     },
   });

packages/libraries/core/src/client/agent.ts

@@ -7,6 +7,7 @@ type ReadOnlyResponse = Pick<Response, 'status' | 'text' | 'json' | 'statusText'
 export interface AgentOptions {
   enabled?: boolean;
   name?: string;
+  version?: string;
   /**
    * Hive endpoint or proxy
    */
@@ -76,6 +77,7 @@ export function createAgent<TEvent>(
     maxSize: 25,
     logger: console,
     name: 'hive-client',
+    version,
     ...pluginOptions,
   };
 
@@ -164,7 +166,7 @@ export function createAgent<TEvent>(
           accept: 'application/json',
           'content-type': 'application/json',
           Authorization: `Bearer ${options.token}`,
-          'User-Agent': `${options.name}/${version}`,
+          'User-Agent': `${options.name}/${options.version}`,
           ...headers(),
         },
         timeout: options.timeout,

packages/libraries/core/src/client/client.ts

@@ -110,6 +110,7 @@ export function createHive(options: HivePluginOptions): HiveClient {
 
           infoLogger.info('Fetching token details...');
 
+          const clientVersionForDetails = options.agent?.version || version;
           const response = await http.post(
             endpoint,
             JSON.stringify({
@@ -120,9 +121,9 @@ export function createHive(options: HivePluginOptions): HiveClient {
               headers: {
                 'content-type': 'application/json',
                 Authorization: `Bearer ${options.token}`,
-                'user-agent': `hive-client/${version}`,
-                'graphql-client-name': 'Hive Client',
-                'graphql-client-version': version,
+                'user-agent': `${options.agent?.name || 'hive-client'}/${clientVersionForDetails}`,
+                'graphql-client-name': `${options.agent?.name || 'Hive Client'}`,
+                'graphql-client-version': clientVersionForDetails,
               },
               timeout: 30_000,
               fetchImplementation: options?.agent?.fetch,

packages/libraries/core/src/client/gateways.ts

@@ -27,7 +27,7 @@ function createFetcher(options: SchemaFetcherOptions & ServicesFetcherOptions) {
     } = {
       'X-Hive-CDN-Key': options.key,
       accept: 'application/json',
-      'User-Agent': `hive-client/${version}`,
+      'User-Agent': `${options?.name || 'hive-client'}/${options?.version || version}`,
     };
 
     if (cacheETag) {

packages/libraries/core/src/client/reporting.ts

@@ -75,8 +75,8 @@ export function createReporting(pluginOptions: HivePluginOptions): SchemaReporte
           }),
           {
             headers: {
-              'graphql-client-name': 'Hive Client',
-              'graphql-client-version': version,
+              'graphql-client-name': pluginOptions.agent?.name ?? 'Hive Client',
+              'graphql-client-version': pluginOptions.agent?.version ?? version,
               authorization: `Bearer ${token}`,
               'content-type': 'application/json',
             },

packages/libraries/core/src/client/supergraph.ts

@@ -8,6 +8,8 @@ export interface SupergraphSDLFetcherOptions {
   key: string;
   logger?: Logger;
   fetchImplementation?: typeof fetch;
+  name?: string;
+  version?: string;
 }
 
 export function createSupergraphSDLFetcher(options: SupergraphSDLFetcherOptions) {
@@ -25,7 +27,7 @@ export function createSupergraphSDLFetcher(options: SupergraphSDLFetcherOptions)
       [key: string]: string;
     } = {
       'X-Hive-CDN-Key': options.key,
-      'User-Agent': `hive-client/${version}`,
+      'User-Agent': `${options?.name || 'hive-client'}/${options?.version || version}`,
     };
 
     if (cacheETag) {

packages/libraries/core/src/client/types.ts

@@ -270,6 +270,8 @@ export interface SchemaFetcherOptions {
   endpoint: string;
   key: string;
   logger?: Logger;
+  name?: string;
+  version?: string;
 }
 
 export interface ServicesFetcherOptions {