feat: hive-logger for JS SDK (#7307)

Co-authored-by: Denis Badurina <[email protected]>

Author: n1ru4l

packages/libraries/apollo/tests/apollo.spec.ts

@@ -102,9 +102,9 @@ test('should not interrupt the process', async () => {
   await waitFor(200);
   await apollo.stop();
   clean();
-  expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('[hive][info]'));
-  expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('[hive][usage]'));
-  expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('[hive][reporting]'));
+  expect(logger.info).toHaveBeenCalledWith(expect.stringContaining('[hive][info]'));
+  expect(logger.info).toHaveBeenCalledWith(expect.stringContaining('[hive][usage]'));
+  expect(logger.info).toHaveBeenCalledWith(expect.stringContaining('[hive][reporting]'));
 }, 1_000);
 
 test('should capture client name and version headers', async () => {

packages/libraries/cli/src/commands/artifact/fetch.ts

@@ -69,18 +69,19 @@ export default class ArtifactsFetch extends Command<typeof ArtifactsFetch> {
         retry: {
           retries: 3,
         },
-        logger: {
-          info: (...args) => {
-            if (this.flags.debug) {
-              console.info(...args);
+        logger: this.flags.debug
+          ? {
+              info: (...args: Array<unknown>) => {
+                this.logInfo(...args);
+              },
+              error: (...args: Array<unknown>) => {
+                this.logFailure(...args);
+              },
+              debug: (...args: Array<unknown>) => {
+                this.logInfo(...args);
+              },
             }
-          },
-          error: (...args) => {
-            if (this.flags.debug) {
-              console.error(...args);
-            }
-          },
-        },
+          : undefined,
       });
     } catch (e: any) {
       const sourceError = e?.cause ?? e;

packages/libraries/core/package.json

@@ -46,6 +46,7 @@
     "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
+    "@graphql-hive/logger": "^1.0.9",
     "@graphql-hive/signal": "^2.0.0",
     "@graphql-tools/utils": "^10.0.0",
     "@whatwg-node/fetch": "^0.10.13",

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

@@ -1,8 +1,8 @@
 import CircuitBreaker from '../circuit-breaker/circuit.js';
 import { version } from '../version.js';
 import { http } from './http-client.js';
-import type { Logger } from './types.js';
-import { createHiveLogger } from './utils.js';
+import type { LegacyLogger } from './types.js';
+import { chooseLogger } from './utils.js';
 
 type ReadOnlyResponse = Pick<Response, 'status' | 'text' | 'json' | 'statusText'>;
 
@@ -73,7 +73,7 @@ export interface AgentOptions {
    *
    * @deprecated Instead, provide a logger for the root Hive SDK. If a logger is provided on the root Hive SDK, this one is ignored.
    */
-  logger?: Logger;
+  logger?: LegacyLogger;
   /**
    * Circuit Breaker Configuration.
    * true -> Use default configuration
@@ -123,13 +123,13 @@ export function createAgent<TEvent>(
           ? null
           : pluginOptions.circuitBreaker,
   };
-  const logger = createHiveLogger(pluginOptions.logger ?? console, '[agent]');
+  const logger = chooseLogger(pluginOptions.logger).child('[agent]');
 
   let circuitBreaker: CircuitBreakerInterface<
     Parameters<typeof sendHTTPCall>,
     ReturnType<typeof sendHTTPCall>
   >;
-  const breakerLogger = createHiveLogger(logger, '[circuit breaker]');
+  const breakerLogger = logger.child('[circuit breaker]');
 
   const enabled = options.enabled !== false;
   let timeoutID: ReturnType<typeof setTimeout> | null = null;

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

@@ -4,67 +4,31 @@ import {
   type GraphQLSchema,
   type subscribe as SubscribeImplementation,
 } from 'graphql';
+import { Logger } from '@graphql-hive/logger';
 import { version } from '../version.js';
 import { http } from './http-client.js';
 import { createPersistedDocuments } from './persisted-documents.js';
 import { createReporting } from './reporting.js';
 import type { HiveClient, HiveInternalPluginOptions, HivePluginOptions } from './types.js';
 import { createUsage } from './usage.js';
-import { createHiveLogger, HiveLogger, isLegacyAccessToken } from './utils.js';
-
-function chooseDefaultLogger(options: HivePluginOptions): HiveLogger {
-  if (options.logger === 'debug') {
-    return createHiveLogger(
-      {
-        debug(...args) {
-          console.debug(...args);
-        },
-        info(...args) {
-          console.info(...args);
-        },
-        error(...args) {
-          console.error(...args);
-        },
-      },
-      '[hive]',
-    );
-  }
-  if (options.logger === 'info') {
-    return createHiveLogger(
-      {
-        debug() {},
-        info(...args) {
-          console.info(...args);
-        },
-        error(...args) {
-          console.error(...args);
-        },
-      },
-      '[hive]',
-    );
+import { chooseLogger, isLegacyAccessToken } from './utils.js';
+
+function resolveLoggerFromConfigOptions(options: HivePluginOptions): Logger {
+  if (typeof options.logger == 'string') {
+    return new Logger({
+      level: options.logger,
+    });
   }
-  if (options.logger === 'error') {
-    return createHiveLogger(
-      {
-        debug() {},
-        info() {},
-        error(...args) {
-          console.error(...args);
-        },
-      },
-      '[hive]',
-    );
+
+  if (options.logger instanceof Logger) {
+    return options.logger;
   }
 
-  return createHiveLogger(
-    options?.logger ?? options?.agent?.logger ?? console,
-    '[hive]',
-    options.debug,
-  );
+  return chooseLogger(options.logger ?? options.agent?.logger, options.debug);
 }
 
 export function createHive(options: HivePluginOptions): HiveClient {
-  const logger = chooseDefaultLogger(options);
+  const logger = resolveLoggerFromConfigOptions(options).child('[hive]');
   let enabled = options.enabled ?? true;
 
   if (enabled === false && !options.experimental__persistedDocuments) {
@@ -111,7 +75,7 @@ export function createHive(options: HivePluginOptions): HiveClient {
       ? options.printTokenInfo === true || (!!options.debug && options.printTokenInfo !== false)
       : false;
 
-  const infoLogger = createHiveLogger(logger, '[info]');
+  const infoLogger = logger.child('[info]');
 
   const info = printTokenInfo
     ? async () => {

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

@@ -1,7 +1,7 @@
 import { version } from '../version.js';
 import { http } from './http-client.js';
 import type { SchemaFetcherOptions, ServicesFetcherOptions } from './types.js';
-import { createHash, createHiveLogger, joinUrl } from './utils.js';
+import { chooseLogger, createHash, joinUrl } from './utils.js';
 
 interface Schema {
   sdl: string;
@@ -10,7 +10,7 @@ interface Schema {
 }
 
 function createFetcher(options: SchemaFetcherOptions & ServicesFetcherOptions) {
-  const logger = createHiveLogger(options.logger ?? console, '');
+  const logger = chooseLogger(options.logger ?? console);
   let cacheETag: string | null = null;
   let cached: {
     id: string;

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

@@ -1,7 +1,8 @@
 import asyncRetry from 'async-retry';
+import { Logger } from '@graphql-hive/logger';
 import { abortSignalAny } from '@graphql-hive/signal';
 import { crypto, fetch, URL } from '@whatwg-node/fetch';
-import { Logger } from './types';
+import type { LegacyLogger } from './types';
 
 interface SharedConfig {
   headers: Record<string, string>;
@@ -15,7 +16,7 @@ interface SharedConfig {
   /** custom fetch implementation. */
   fetchImplementation?: typeof fetch;
   /** Logger for HTTP info and request errors. Uses `console` by default. */
-  logger?: Logger;
+  logger?: LegacyLogger;
   /**
    * Function for determining whether the request response is okay.
    * You can override it if you want to accept other status codes as well.
@@ -58,6 +59,39 @@ export const http = {
   post,
 };
 
+function chooseLogger(logger: SharedConfig['logger']): Logger {
+  if (!logger) {
+    return new Logger({
+      writers: [{ write() {} }],
+    });
+  }
+
+  if (logger instanceof Logger) {
+    return logger;
+  }
+
+  return new Logger({
+    level: 'debug',
+    writers: [
+      {
+        write(level, _attrs, msg) {
+          if (level === 'debug' && logger.debug && msg) {
+            logger.debug(msg);
+            return;
+          }
+          if (level === 'info' && msg) {
+            logger.info(msg);
+            return;
+          }
+          if (level === 'error' && msg) {
+            logger.error(msg);
+          }
+        },
+      },
+    ],
+  });
+}
+
 export async function makeFetchCall(
   endpoint: URL | string,
   config: {
@@ -74,7 +108,7 @@ export async function makeFetchCall(
     /** custom fetch implementation. */
     fetchImplementation?: typeof fetch;
     /** Logger for HTTP info and request errors. Uses `console` by default. */
-    logger?: Logger;
+    logger?: LegacyLogger;
     /**
      * Function for determining whether the request response is okay.
      * You can override it if you want to accept other status codes as well.
@@ -85,7 +119,7 @@ export async function makeFetchCall(
     signal?: AbortSignal;
   },
 ): Promise<Response> {
-  const logger = config.logger;
+  const logger = chooseLogger(config.logger);
   const isRequestOk: ResponseAssertFunction = config.isRequestOk ?? (response => response.ok);
   let retries = 0;
   let minTimeout = 200;
@@ -107,7 +141,7 @@ export async function makeFetchCall(
       const isFinalAttempt = attempt > retries;
       const requestId = crypto.randomUUID();
 
-      logger?.debug?.(
+      logger.debug(
         `${config.method} ${endpoint} (x-request-id=${requestId})` +
           (retries > 0 ? ' ' + getAttemptMessagePart(attempt, retries + 1) : ''),
       );
@@ -126,33 +160,16 @@ export async function makeFetchCall(
         },
         signal,
       }).catch((error: unknown) => {
-        const logErrorMessage = () => {
-          const msg =
-            `${config.method} ${endpoint} (x-request-id=${requestId}) failed ${getDuration()}. ` +
-            getErrorMessage(error);
-
-          if (isFinalAttempt) {
-            logger?.error(msg);
-            return;
-          }
-          logger?.debug?.(msg);
-        };
-
-        if (isAggregateError(error)) {
-          for (const err of error.errors) {
-            if (isFinalAttempt) {
-              logger?.error(err);
-              continue;
-            }
-            logger?.debug?.(String(err));
-          }
-
-          logErrorMessage();
-          throw new Error(`Unexpected HTTP error. (x-request-id=${requestId})`, { cause: error });
+        const msg =
+          `${config.method} ${endpoint} (x-request-id=${requestId}) failed ${getDuration()}. ` +
+          getErrorMessage(error);
+
+        if (isFinalAttempt) {
+          logger.error({ error }, msg);
+        } else {
+          logger.debug({ error }, msg);
         }
 
-        logger?.error(error);
-        logErrorMessage();
         throw new Error(`Unexpected HTTP error. (x-request-id=${requestId})`, { cause: error });
       });
 
@@ -171,14 +188,14 @@ export async function makeFetchCall(
       }
 
       if (isFinalAttempt) {
-        logger?.error(
+        logger.error(
           `${config.method} ${endpoint} (x-request-id=${requestId}) failed with status ${response.status} ${getDuration()}: ${(await response.text()) || '<empty response body>'}`,
         );
-        logger?.error(
+        logger.error(
           `${config.method} ${endpoint} (x-request-id=${requestId}) retry limit exceeded after ${attempt} attempts.`,
         );
       } else {
-        logger?.debug?.(
+        logger.debug(
           `${config.method} ${endpoint} (x-request-id=${requestId}) failed with status ${response.status} ${getDuration()}: ${(await response.text()) || '<empty response body>'}`,
         );
       }
@@ -189,7 +206,7 @@ export async function makeFetchCall(
 
       if (response.status >= 400 && response.status < 500) {
         if (retries > 0) {
-          logger?.error(`Abort retry because of status code ${response.status}.`);
+          logger.error(`Abort retry because of status code ${response.status}.`);
         }
         bail(error);
       }
@@ -247,12 +264,4 @@ function formatTimestamp(timestamp: number): string {
   return parts.join(':');
 }
 
-interface AggregateError extends Error {
-  errors: Error[];
-}
-
-function isAggregateError(error: unknown): error is AggregateError {
-  return !!error && typeof error === 'object' && 'errors' in error && Array.isArray(error.errors);
-}
-
 export { URL };

packages/libraries/core/src/client/persisted-documents.ts

@@ -1,16 +1,16 @@
 import type { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue.js';
 import LRU from 'tiny-lru';
+import { Logger } from '@graphql-hive/logger';
 import { http } from './http-client.js';
 import type { PersistedDocumentsConfiguration } from './types';
-import type { HiveLogger } from './utils.js';
 
 type HeadersObject = {
   get(name: string): string | null;
 };
 
 export function createPersistedDocuments(
   config: PersistedDocumentsConfiguration & {
-    logger: HiveLogger;
+    logger: Logger;
     fetch?: typeof fetch;
   },
 ): null | {