feat(sdk): specify the usage target endpoint for organization access tokens (#6574)

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

Author: 2 people

.changeset/five-stingrays-search.md

@@ -0,0 +1,19 @@
+---
+'@graphql-hive/envelop': minor
+---
+
+Add support for providing a target for usage reporting with organization access tokens.
+This can either be a slug following the format `$organizationSlug/$projectSlug/$targetSlug` (e.g `the-guild/graphql-hive/staging`)
+or an UUID (e.g. `a0f4c605-6541-4350-8cfe-b31f21a4bf80`)
+
+```ts
+import { useHive } from '@graphql-hive/envelop';
+
+const hivePlugin = useHive({
+  enabled: true,
+  token: "ORGANIZATION_ACCESS_TOKEN",
+  usage: {
+    target: "my-org/my-project/my-target"
+  }
+})
+```

.changeset/good-rocks-appear.md

@@ -0,0 +1,19 @@
+---
+'@graphql-hive/core': minor
+---
+
+Add support for providing a target for usage reporting with organization access tokens.
+This can either be a slug following the format `$organizationSlug/$projectSlug/$targetSlug` (e.g `the-guild/graphql-hive/staging`)
+or an UUID (e.g. `a0f4c605-6541-4350-8cfe-b31f21a4bf80`)
+
+```ts
+import { createHive } from '@graphql-hive/core';
+
+const hive = createHive({
+  enabled: true,
+  token: "ORGANIZATION_ACCESS_TOKEN",
+  usage: {
+    target: "my-org/my-project/my-target"
+  }
+})
+```

.changeset/rotten-hairs-pay.md

@@ -0,0 +1,19 @@
+---
+'@graphql-hive/yoga': minor
+---
+
+Add support for providing a target for usage reporting with organization access tokens.
+This can either be a slug following the format `$organizationSlug/$projectSlug/$targetSlug` (e.g `the-guild/graphql-hive/staging`)
+or an UUID (e.g. `a0f4c605-6541-4350-8cfe-b31f21a4bf80`)
+
+```ts
+import { useHive } from '@graphql-hive/yoga';
+
+const hivePlugin = useHive({
+  enabled: true,
+  token: "ORGANIZATION_ACCESS_TOKEN",
+  usage: {
+    target: "my-org/my-project/my-target"
+  }
+})
+```

.changeset/tame-paws-float.md

@@ -0,0 +1,19 @@
+---
+'@graphql-hive/apollo': minor
+---
+
+Add support for providing a target for usage reporting with organization access tokens.
+This can either be a slug following the format `$organizationSlug/$projectSlug/$targetSlug` (e.g `the-guild/graphql-hive/staging`)
+or an UUID (e.g. `a0f4c605-6541-4350-8cfe-b31f21a4bf80`)
+
+```ts
+import { useHive } from '@graphql-hive/apollo'
+
+const hivePlugin = useHive({
+  enabled: true,
+  token: "ORGANIZATION_ACCESS_TOKEN",
+  usage: {
+    target: "my-org/my-project/my-target"
+  }
+})
+```

deployment/services/graphql.ts

@@ -118,7 +118,7 @@ export function deployGraphQL({
           ...environment.envVars,
           ...apiEnv,
           SENTRY: sentry.enabled ? '1' : '0',
-          REQUEST_LOGGING: '0', // disabled
+          REQUEST_LOGGING: '1', // disabled
           COMMERCE_ENDPOINT: serviceLocalEndpoint(commerce.service),
           TOKENS_ENDPOINT: serviceLocalEndpoint(tokens.service),
           WEBHOOKS_ENDPOINT: serviceLocalEndpoint(webhooks.service),

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

@@ -73,6 +73,12 @@ export interface Logger {
 }
 
 export interface HiveUsagePluginOptions {
+  /**
+   * The target to which the usage data should be reported to.
+   * This can either be a slug following the format `$organizationSlug/$projectSlug/$targetSlug` (e.g `the-guild/graphql-hive/staging`)
+   * or an UUID (e.g. `a0f4c605-6541-4350-8cfe-b31f21a4bf80`).
+   */
+  target?: string;
   /**
    * Custom endpoint to collect schema usage
    *

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

@@ -75,16 +75,18 @@ export function createUsage(pluginOptions: HivePluginOptions): UsageCollector {
   const collector = memo(createCollector, arg => arg.schema);
   const excludeSet = new Set(options.exclude ?? []);
 
+  const baseEndpoint =
+    selfHostingOptions?.usageEndpoint ?? options.endpoint ?? 'https://app.graphql-hive.com/usage';
+
+  const endpoint = baseEndpoint + (options?.target ? `/${options.target}` : '');
+
   const agent = createAgent<AgentAction>(
     {
       ...(pluginOptions.agent ?? {
         maxSize: 1500,
       }),
       logger,
-      endpoint:
-        selfHostingOptions?.usageEndpoint ??
-        options.endpoint ??
-        'https://app.graphql-hive.com/usage',
+      endpoint,
       token: pluginOptions.token,
       enabled: pluginOptions.enabled,
       debug: pluginOptions.debug,

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

@@ -747,3 +747,49 @@ test('retry on non-200', async () => {
     [INF] [hive][usage] Disposing
   `);
 });
+
+test('constructs URL with usage.target', async ({ expect }) => {
+  const logger = createHiveTestingLogger();
+  const token = 'Token';
+  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();
+});