fix: treat personal and project access tokens as new access tokens (#7248)

Author: n1ru4l

.changeset/empty-rice-follow.md

@@ -0,0 +1,9 @@
+---
+'@graphql-hive/core': patch
+'@graphql-hive/apollo': patch
+'@graphql-hive/envelop': patch
+'@graphql-hive/yoga': patch
+'hive-console-sdk-rs': patch
+---
+
+Support project and personal access tokens (`hvp1/` and `hvu1/`).

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

@@ -10,7 +10,7 @@ import { createPersistedDocuments } from './persisted-documents.js';
 import { createReporting } from './reporting.js';
 import type { HiveClient, HivePluginOptions } from './types.js';
 import { createUsage } from './usage.js';
-import { createHiveLogger, logIf } from './utils.js';
+import { createHiveLogger, isLegacyAccessToken, logIf } from './utils.js';
 
 export function createHive(options: HivePluginOptions): HiveClient {
   const logger = createHiveLogger(options?.agent?.logger ?? console, '[hive]');
@@ -53,7 +53,7 @@ export function createHive(options: HivePluginOptions): HiveClient {
     await Promise.all([schemaReporter.dispose(), usage.dispose()]);
   }
 
-  const isOrganizationAccessToken = options.token?.startsWith('hvo1/') === true;
+  const isOrganizationAccessToken = !isLegacyAccessToken(options.token ?? '');
 
   // enabledOnly when `printTokenInfo` is `true` or `debug` is true and `printTokenInfo` is not `false`
   const printTokenInfo =

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

@@ -24,6 +24,7 @@ import {
   cache,
   cacheDocumentKey,
   createHiveLogger,
+  isLegacyAccessToken,
   logIf,
   measureDuration,
   memo,
@@ -78,15 +79,15 @@ export function createUsage(pluginOptions: HivePluginOptions): UsageCollector {
   const excludeSet = new Set(options.exclude ?? []);
 
   /** Access tokens using the `hvo1/` require a target. */
-  if (!options.target && pluginOptions.token.startsWith('hvo1/')) {
+  if (!options.target && !isLegacyAccessToken(pluginOptions.token)) {
     logger.error(
-      "Using an organization access token (starting with 'hvo1/') requires providing the 'target' option." +
+      "Your access token requires providing the 'target' option." +
         '\nUsage reporting is disabled.',
     );
     return noopUsageCollector;
   }
 
-  if (options.target && !pluginOptions.token.startsWith('hvo1/')) {
+  if (options.target && isLegacyAccessToken(pluginOptions.token)) {
     logger.error(
       "Using the 'target' option requires using an organization access token (starting with 'hvo1/')." +
         '\nUsage reporting is disabled.',

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

@@ -214,3 +214,15 @@ export function createHiveLogger(baseLogger: Logger, prefix: string): HiveLogger
     },
   };
 }
+
+export function isLegacyAccessToken(accessToken: string): boolean {
+  if (
+    !accessToken.startsWith('hvo1/') &&
+    !accessToken.startsWith('hvp1/') &&
+    !accessToken.startsWith('hvu1/')
+  ) {
+    return true;
+  }
+
+  return false;
+}

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

@@ -748,7 +748,7 @@ test('retry on non-200', async () => {
   `);
 });
 
-test('constructs URL with usage.target', async ({ expect }) => {
+test('constructs URL with usage.target (hvo1/)', async ({ expect }) => {
   const logger = createHiveTestingLogger();
   const token = 'hvo1/brrrrt';
   const dUrl = Promise.withResolvers<string>();
@@ -793,3 +793,95 @@ test('constructs URL with usage.target', async ({ expect }) => {
   expect(url).toEqual('http://localhost/the-guild/graphql-hive/staging');
   await hive.dispose();
 });
+
+test('constructs URL with usage.target (hvp1/)', async ({ expect }) => {
+  const logger = createHiveTestingLogger();
+  const token = 'hvp1/brrrrt';
+  const dUrl = Promise.withResolvers<string>();
+
+  const hive = createHive({
+    enabled: true,
+    debug: true,
+    agent: {
+      timeout: 500,
+      maxRetries: 0,
+      sendInterval: 1,
+      maxSize: 1,
+      async fetch(url) {
+        dUrl.resolve(url.toString());
+        return new Response('', {
+          status: 200,
+        });
+      },
+      logger,
+    },
+    token,
+    selfHosting: {
+      graphqlEndpoint: 'http://localhost:2/graphql',
+      applicationUrl: 'http://localhost:1',
+      usageEndpoint: 'http://localhost',
+    },
+    usage: {
+      target: 'the-guild/graphql-hive/staging',
+    },
+  });
+
+  await hive.collectUsage()(
+    {
+      schema,
+      document: op,
+      operationName: 'asd',
+    },
+    {},
+  );
+
+  const url = await dUrl.promise;
+  expect(url).toEqual('http://localhost/the-guild/graphql-hive/staging');
+  await hive.dispose();
+});
+
+test('constructs URL with usage.target (hvu1/)', async ({ expect }) => {
+  const logger = createHiveTestingLogger();
+  const token = 'hvu1/brrrrt';
+  const dUrl = Promise.withResolvers<string>();
+
+  const hive = createHive({
+    enabled: true,
+    debug: true,
+    agent: {
+      timeout: 500,
+      maxRetries: 0,
+      sendInterval: 1,
+      maxSize: 1,
+      async fetch(url) {
+        dUrl.resolve(url.toString());
+        return new Response('', {
+          status: 200,
+        });
+      },
+      logger,
+    },
+    token,
+    selfHosting: {
+      graphqlEndpoint: 'http://localhost:2/graphql',
+      applicationUrl: 'http://localhost:1',
+      usageEndpoint: 'http://localhost',
+    },
+    usage: {
+      target: 'the-guild/graphql-hive/staging',
+    },
+  });
+
+  await hive.collectUsage()(
+    {
+      schema,
+      document: op,
+      operationName: 'asd',
+    },
+    {},
+  );
+
+  const url = await dUrl.promise;
+  expect(url).toEqual('http://localhost/the-guild/graphql-hive/staging');
+  await hive.dispose();
+});

packages/libraries/sdk-rs/src/agent.rs

@@ -165,7 +165,7 @@ impl UsageAgent {
 
         let mut endpoint = endpoint;
 
-        if token.starts_with("hvo1/") {
+        if token.starts_with("hvo1/") || token.starts_with("hvu1/") || token.starts_with("hvp1/") {
             if let Some(target_id) = target_id {
                 endpoint.push_str(&format!("/{}", target_id));
             }