fix: send graph cli version in header of cli (#1461)

saihaj · web-flow · commit cbbb0fc20500 · 2023-11-14T21:21:43.000-05:00
* fix: send graph cli version as user agent

* fix: send graph cli version as user agent

* remove json import
diff --git a/.changeset/beige-mails-turn.md b/.changeset/beige-mails-turn.md
@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': patch
+---
+
+include user agent for CLI fetch calls
diff --git a/.changeset/rare-goats-crash.md b/.changeset/rare-goats-crash.md
@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': patch
+---
+
+send graph cli version as user agent for all third party API calls
diff --git a/.changeset/rotten-islands-love.md b/.changeset/rotten-islands-love.md
@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': patch
+---
+
+send graph cli version as user agent for all ipfs requests
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -29,7 +29,23 @@ module.exports = {
         'sonarjs/no-inverted-boolean-check': 'warn',
         // TODO: warning for now, clean up
         '@typescript-eslint/no-loss-of-precision': 'warn',
-        // AssemblyScript types are different from TS and in cases we want to use what TS may think we should not
+        // AssemblyScript types are different from TS and in cases we want to use what TS may think we should not,
+      },
+    },
+    {
+      files: ['packages/cli/**'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          {
+            patterns: [
+              {
+                group: ['@whatwg-node/fetch'],
+                message: 'Please use `fetch` from `./packages/cli/src/fetch.ts`.',
+              },
+            ],
+          },
+        ],
       },
     },
   ],
diff --git a/packages/cli/src/command-helpers/abi.ts b/packages/cli/src/command-helpers/abi.ts
@@ -1,5 +1,6 @@
 import immutable from 'immutable';
-import { fetch } from '@whatwg-node/fetch';
+import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
+import fetch from '../fetch';
 import ABI from '../protocols/ethereum/abi';
 import { withSpinner } from './spinner';
 
@@ -87,6 +88,7 @@ export const fetchTransactionByHashFromRPC = async (
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
+        ...GRAPH_CLI_SHARED_HEADERS,
       },
       body: JSON.stringify({
         jsonrpc: '2.0',
diff --git a/packages/cli/src/command-helpers/compiler.ts b/packages/cli/src/command-helpers/compiler.ts
@@ -2,6 +2,7 @@ import { URL } from 'url';
 import * as toolbox from 'gluegun';
 import { create } from 'ipfs-http-client';
 import Compiler from '../compiler';
+import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
 import Protocol from '../protocols';
 
 interface CreateCompilerOptions {
@@ -54,7 +55,13 @@ The IPFS URL must be of the following format: http(s)://host[:port]/[path]`);
 
   // Connect to the IPFS node (if a node address was provided)
   const ipfsClient = ipfs
-    ? create({ url: appendApiVersionForGraph(ipfs.toString()), headers })
+    ? create({
+        url: appendApiVersionForGraph(ipfs.toString()),
+        headers: {
+          ...headers,
+          ...GRAPH_CLI_SHARED_HEADERS,
+        },
+      })
     : undefined;
 
   return new Compiler({
diff --git a/packages/cli/src/command-helpers/node.ts b/packages/cli/src/command-helpers/node.ts
@@ -1,5 +1,6 @@
 import { URL } from 'url';
 import { print } from 'gluegun';
+import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
 
 const SUBGRAPH_STUDIO_URL = 'https://api.studio.thegraph.com/deploy/';
 const HOSTED_SERVICE_URL = 'https://api.thegraph.com/deploy/';
@@ -73,7 +74,7 @@ export async function getHostedServiceSubgraphId({
     }),
     headers: {
       'content-type': 'application/json',
-      'User-Agent': '@graphprotocol/graph-cli',
+      ...GRAPH_CLI_SHARED_HEADERS,
     },
   });
 
diff --git a/packages/cli/src/commands/create.ts b/packages/cli/src/commands/create.ts
@@ -4,6 +4,7 @@ import { Args, Command, Flags } from '@oclif/core';
 import { identifyDeployKey as identifyAccessToken } from '../command-helpers/auth';
 import { createJsonRpcClient } from '../command-helpers/jsonrpc';
 import { validateNodeUrl } from '../command-helpers/node';
+import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
 
 export default class CreateCommand extends Command {
   static description = 'Registers a subgraph name';
@@ -54,7 +55,10 @@ export default class CreateCommand extends Command {
     const accessToken = await identifyAccessToken(node, accessTokenFlag);
     if (accessToken !== undefined && accessToken !== null) {
       // @ts-expect-error options property seems to exist
-      client.options.headers = { Authorization: `Bearer ${accessToken}` };
+      client.options.headers = {
+        ...GRAPH_CLI_SHARED_HEADERS,
+        Authorization: `Bearer ${accessToken}`,
+      };
     }
 
     const spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
diff --git a/packages/cli/src/commands/deploy.ts b/packages/cli/src/commands/deploy.ts
@@ -12,6 +12,7 @@ import { updateSubgraphNetwork } from '../command-helpers/network';
 import { chooseNodeUrl, getHostedServiceSubgraphId } from '../command-helpers/node';
 import { validateStudioNetwork } from '../command-helpers/studio';
 import { assertGraphTsVersion, assertManifestApiVersion } from '../command-helpers/version';
+import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
 import Protocol from '../protocols';
 
 const headersFlag = Flags.custom<Record<string, string>>({
@@ -170,7 +171,10 @@ export default class DeployCommand extends Command {
       }
 
       // @ts-expect-error options property seems to exist
-      client.options.headers = { Authorization: 'Bearer ' + deployKey };
+      client.options.headers = {
+        ...GRAPH_CLI_SHARED_HEADERS,
+        Authorization: 'Bearer ' + deployKey,
+      };
 
       const subgraphName = await ux.prompt('What is the name of the subgraph you want to deploy?', {
         required: true,
@@ -299,7 +303,10 @@ export default class DeployCommand extends Command {
     deployKey = await identifyDeployKey(node, deployKey);
     if (deployKey !== undefined && deployKey !== null) {
       // @ts-expect-error options property seems to exist
-      client.options.headers = { Authorization: 'Bearer ' + deployKey };
+      client.options.headers = {
+        ...GRAPH_CLI_SHARED_HEADERS,
+        Authorization: 'Bearer ' + deployKey,
+      };
     }
 
     // Ask for label if not on hosted service
@@ -384,7 +391,10 @@ export default class DeployCommand extends Command {
       // Connect to the IPFS node (if a node address was provided)
       const ipfsClient = create({
         url: appendApiVersionForGraph(ipfs.toString()),
-        headers,
+        headers: {
+          ...headers,
+          ...GRAPH_CLI_SHARED_HEADERS,
+        },
       });
 
       // Fetch the manifest from IPFS
diff --git a/packages/cli/src/commands/remove.ts b/packages/cli/src/commands/remove.ts
@@ -4,6 +4,7 @@ import { Args, Command, Flags } from '@oclif/core';
 import { identifyDeployKey as identifyAccessToken } from '../command-helpers/auth';
 import { createJsonRpcClient } from '../command-helpers/jsonrpc';
 import { validateNodeUrl } from '../command-helpers/node';
+import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
 
 export default class RemoveCommand extends Command {
   static description = 'Unregisters a subgraph name';
@@ -54,7 +55,10 @@ export default class RemoveCommand extends Command {
     const accessToken = await identifyAccessToken(node, accessTokenFlag);
     if (accessToken !== undefined && accessToken !== null) {
       // @ts-expect-error options property seems to exist
-      client.options.headers = { Authorization: `Bearer ${accessToken}` };
+      client.options.headers = {
+        ...GRAPH_CLI_SHARED_HEADERS,
+        Authorization: `Bearer ${accessToken}`,
+      };
     }
 
     const spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
diff --git a/packages/cli/src/commands/test.ts b/packages/cli/src/commands/test.ts
@@ -6,7 +6,8 @@ import { filesystem, patching, print, system } from 'gluegun';
 import yaml from 'js-yaml';
 import semver from 'semver';
 import { Args, Command, Flags } from '@oclif/core';
-import { fetch } from '@whatwg-node/fetch';
+import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
+import fetch from '../fetch';
 
 export default class TestCommand extends Command {
   static description = 'Runs rust binary for subgraph testing.';
@@ -94,7 +95,7 @@ export default class TestCommand extends Command {
         'https://api.github.com/repos/LimeChain/matchstick/releases/latest',
         {
           headers: {
-            'User-Agent': '@graphprotocol/graph-cli',
+            ...GRAPH_CLI_SHARED_HEADERS,
           },
         },
       );
diff --git a/packages/cli/src/constants.ts b/packages/cli/src/constants.ts
@@ -0,0 +1,5 @@
+import { version } from './version';
+
+export const GRAPH_CLI_SHARED_HEADERS = {
+  'User-Agent': `@graphprotocol/graph-cli@${version}` as const,
+};
diff --git a/packages/cli/src/fetch.ts b/packages/cli/src/fetch.ts
@@ -0,0 +1,16 @@
+// eslint-disable-next-line no-restricted-imports
+import { fetch } from '@whatwg-node/fetch';
+import { GRAPH_CLI_SHARED_HEADERS } from './constants';
+
+export default function fetchWrapper(
+  input: Parameters<typeof fetch>[0],
+  init?: Parameters<typeof fetch>[1],
+) {
+  return fetch(input, {
+    ...init,
+    headers: {
+      ...init?.headers,
+      ...GRAPH_CLI_SHARED_HEADERS,
+    },
+  });
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphprotocol/graph-cli': patch
 +---
++
 +include user agent for CLI fetch calls