fix: append /api/v0 to graph IPFS endpoint (#1291)

* fix: append /api/v0 to graph IPFS endpoint

* prettier

Author: saihaj

.changeset/twelve-frogs-walk.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': patch
+---
+
+append /api/v0 automatically to Graph IPFS endpoint

packages/cli/src/command-helpers/compiler.test.ts

@@ -0,0 +1,41 @@
+import { appendApiVersionForGraph } from './compiler';
+
+describe('appendApiVersionForGraph', () => {
+  it('append /api/v0 to Prod URL with trailing slash', () => {
+    expect(appendApiVersionForGraph('https://api.thegraph.com/ipfs/')).toBe(
+      'https://api.thegraph.com/ipfs/api/v0',
+    );
+  });
+
+  it('append /api/v0 to Prod URL without trailing slash', () => {
+    expect(appendApiVersionForGraph('https://api.thegraph.com/ipfs')).toBe(
+      'https://api.thegraph.com/ipfs/api/v0',
+    );
+  });
+
+  it('append /api/v0 to Staging URL without trailing slash', () => {
+    expect(appendApiVersionForGraph('https://staging.api.thegraph.com/ipfs')).toBe(
+      'https://staging.api.thegraph.com/ipfs/api/v0',
+    );
+  });
+
+  it('do nothing if Prod URL has /api/v0', () => {
+    expect(appendApiVersionForGraph('https://api.thegraph.com/ipfs/api/v0')).toBe(
+      'https://api.thegraph.com/ipfs/api/v0',
+    );
+  });
+
+  it('do nothing if Prod URL has no /ipfs', () => {
+    expect(appendApiVersionForGraph('https://api.thegraph.com')).toBe('https://api.thegraph.com');
+  });
+
+  it('do nothing for non-graph endpoint', () => {
+    expect(appendApiVersionForGraph('https://ipfs.saihaj.dev/')).toBe('https://ipfs.saihaj.dev/');
+  });
+
+  it('do nothing for non-graph endpoint ending with /ipfs', () => {
+    expect(appendApiVersionForGraph('https://ipfs.saihaj.dev/ipfs/')).toBe(
+      'https://ipfs.saihaj.dev/ipfs/',
+    );
+  });
+});

packages/cli/src/command-helpers/compiler.ts

@@ -5,15 +5,31 @@ import Compiler from '../compiler';
 import Protocol from '../protocols';
 
 interface CreateCompilerOptions {
-  ipfs: any;
-  headers?: any;
+  ipfs: string | URL | undefined;
+  headers?: Headers | Record<string, string>;
   outputDir: string;
   outputFormat: string;
   skipMigrations: boolean;
   blockIpfsMethods?: RegExpMatchArray;
   protocol: Protocol;
 }
 
+/**
+ * Appends /api/v0 to the end of a The Graph IPFS URL
+ */
+export function appendApiVersionForGraph(inputString: string) {
+  // Check if the input string is a valid The Graph IPFS URL
+  const pattern = /^(https?:\/\/)?([\w-]+\.)+thegraph\.com\/ipfs\/?$/;
+  if (pattern.test(inputString)) {
+    // account for trailing slash
+    if (inputString.endsWith('/')) {
+      return inputString.slice(0, -1) + '/api/v0';
+    }
+    return inputString + '/api/v0';
+  }
+  return inputString;
+}
+
 // Helper function to construct a subgraph compiler
 export function createCompiler(
   manifest: string,
@@ -29,18 +45,20 @@ export function createCompiler(
 ) {
   // Validate the IPFS URL (if a node address was provided)
   try {
-    if (ipfs) new URL(ipfs);
+    if (ipfs && typeof ipfs === 'string') new URL(ipfs);
   } catch (e) {
     toolbox.print.error(`Invalid IPFS URL: ${ipfs}
 The IPFS URL must be of the following format: http(s)://host[:port]/[path]`);
     return null;
   }
 
   // Connect to the IPFS node (if a node address was provided)
-  ipfs = ipfs ? create({ url: ipfs, headers }) : undefined;
+  const ipfsClient = ipfs
+    ? create({ url: appendApiVersionForGraph(ipfs.toString()), headers })
+    : undefined;
 
   return new Compiler({
-    ipfs,
+    ipfs: ipfsClient,
     subgraphManifest: manifest,
     outputDir,
     outputFormat,