fix: no misleading log message when client is used only for experimental persisted documents (#6606)

Author: enisdenjo

.changeset/chatty-pandas-clean.md

@@ -0,0 +1,5 @@
+---
+'@graphql-hive/core': patch
+---
+
+Client can be used only for experimental persisted documents

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

@@ -17,7 +17,14 @@ export function createHive(options: HivePluginOptions): HiveClient {
   let enabled = options.enabled ?? true;
 
   if (enabled === false) {
-    logIf(options.debug === true, 'plugin is not enabled.', logger.info);
+    logIf(
+      options.debug === true &&
+        // hive client can be used only for persisted documents, without the cdn or usage reporting.
+        // hence, we dont want a misleading log message below saying that the plugin is disabled
+        !options.experimental__persistedDocuments,
+      'Plugin is not enabled.',
+      logger.info,
+    );
   }
 
   if (!options.token && enabled) {

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

@@ -199,7 +199,7 @@ type OptionalWhenFalse<T, KCond extends keyof T, KExcluded extends keyof T> =
 export type HivePluginOptions = OptionalWhenFalse<
   {
     /**
-     * Enable/Disable Hive
+     * Enable/Disable Hive usage reporting
      *
      * Default: true
      */
@@ -211,7 +211,7 @@ export type HivePluginOptions = OptionalWhenFalse<
      */
     debug?: boolean;
     /**
-     * Access Token
+     * Access Token for usage reporting
      */
     token: string;
     /**

packages/libraries/core/tests/enabled.spec.ts

@@ -20,7 +20,7 @@ test("should log that it's not enabled", async () => {
     .catch(() => 'ERROR');
 
   expect(logger.info).toHaveBeenCalledWith(
-    expect.stringContaining(`[hive] plugin is not enabled.`),
+    expect.stringContaining(`[hive] Plugin is not enabled.`),
   );
   expect(result).toBe('OK');
 });