Update IPFS endpoints #2055
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@graphprotocol/graph-cli': patch | ||
| --- | ||
|
|
||
| updated IPFS endpoints, added deprecation notice when using old ones |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,70 @@ | ||
| import { describe, expect, it } from 'vitest'; | ||
| import { getGraphIpfsUrl } from './ipfs.js'; | ||
|
|
||
| const DEFAULT_IPFS_URL = 'https://ipfs.thegraph.com/ipfs/api/v0'; | ||
|
|
||
| describe('getGraphIpfsUrl', { concurrent: true }, () => { | ||
| it('returns default URL when input is undefined', () => { | ||
| expect(getGraphIpfsUrl(undefined)).toEqual({ | ||
| ipfsUrl: DEFAULT_IPFS_URL, | ||
| }); | ||
| }); | ||
|
|
||
| it('returns default URL when input is empty string', () => { | ||
| expect(getGraphIpfsUrl('')).toEqual({ | ||
| ipfsUrl: DEFAULT_IPFS_URL, | ||
| }); | ||
| }); | ||
|
|
||
| it('returns input URL when valid and not deprecated', () => { | ||
| const validUrl = 'https://ipfs.network.example.com'; | ||
| expect(getGraphIpfsUrl(validUrl)).toEqual({ | ||
| ipfsUrl: validUrl, | ||
| }); | ||
| }); | ||
|
|
||
| it('trim trailing slash from valid url', () => { | ||
| const validUrl = 'https://ipfs.network.example.com/ipfs/'; | ||
| expect(getGraphIpfsUrl(validUrl)).toEqual({ | ||
| ipfsUrl: 'https://ipfs.network.example.com/ipfs', | ||
| }); | ||
| }); | ||
|
|
||
| it('returns default URL with warning for deprecated api.thegraph.com URL', () => { | ||
| const result = getGraphIpfsUrl('https://api.thegraph.com/ipfs/api/v0'); | ||
| expect(result.ipfsUrl).toEqual(DEFAULT_IPFS_URL); | ||
| expect(result.warning).toContain('deprecated'); | ||
| }); | ||
|
|
||
| it('returns default URL with warning for deprecated ipfs.testnet.thegraph.com URL', () => { | ||
| const result = getGraphIpfsUrl('https://ipfs.testnet.thegraph.com/abc'); | ||
| expect(result.ipfsUrl).toEqual(DEFAULT_IPFS_URL); | ||
| expect(result.warning).toContain('deprecated'); | ||
| }); | ||
|
|
||
| it('returns default URL with warning for deprecated ipfs.network.thegraph.com URL', () => { | ||
| const result = getGraphIpfsUrl('https://ipfs.network.thegraph.com/xyz'); | ||
| expect(result.ipfsUrl).toEqual(DEFAULT_IPFS_URL); | ||
| expect(result.warning).toContain('deprecated'); | ||
| }); | ||
|
|
||
| it('returns default URL with warning for invalid URL', () => { | ||
| const result = getGraphIpfsUrl('not-a-valid-url'); | ||
| expect(result.ipfsUrl).toEqual(DEFAULT_IPFS_URL); | ||
| expect(result.warning).toContain('Invalid IPFS URL'); | ||
| }); | ||
|
|
||
| it('preserves non-deprecated graph endpoints', () => { | ||
| const url = 'https://ipfs.thegraph.com/ipfs'; | ||
| expect(getGraphIpfsUrl(url)).toEqual({ | ||
| ipfsUrl: DEFAULT_IPFS_URL, | ||
| }); | ||
| }); | ||
|
|
||
| it('preserves third-party IPFS endpoints', () => { | ||
| const url = 'https://ipfs.example.com/api'; | ||
| expect(getGraphIpfsUrl(url)).toEqual({ | ||
| ipfsUrl: url, | ||
| }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,47 @@ | ||
| const DEFAULT_IPFS_URL = 'https://ipfs.thegraph.com/ipfs/api/v0' as const; | ||
|
There was a problem hiding this comment. The IPFS URL should just be https://ipfs.thegraph.com For GET requests (read a file), you'd append For POST requests (adding a file) you'd append |
||
|
|
||
| /** | ||
| * Validates supplied IPFS URL and provides warnings for deprecated/invalid URLs | ||
| * @param ipfsUrl - The IPFS URL to validate, can be undefined | ||
| * @returns An object with the validated URL and optional warning message | ||
| */ | ||
| export function getGraphIpfsUrl(ipfsUrl?: string): { ipfsUrl: string; warning?: string } { | ||
| if (!ipfsUrl) { | ||
| return { ipfsUrl: DEFAULT_IPFS_URL }; | ||
| } | ||
|
|
||
| // trim trailing slash | ||
| ipfsUrl = ipfsUrl.replace(/\/+$/, ''); | ||
|
|
||
| try { | ||
| new URL(ipfsUrl); | ||
|
|
||
| const deprecatedPatterns = [ | ||
| /^https?:\/\/ipfs\.testnet\.thegraph\.com.*/, | ||
| /^https?:\/\/ipfs\.network\.thegraph\.com.*/, | ||
| /^https?:\/\/api\.thegraph\.com\/ipfs.*/, | ||
| ]; | ||
|
|
||
| const isDeprecated = deprecatedPatterns.some(pattern => pattern.test(ipfsUrl)); | ||
| if (isDeprecated) { | ||
| return { | ||
| ipfsUrl: DEFAULT_IPFS_URL, | ||
| warning: `IPFS URL ${ipfsUrl} is deprecated. Using default URL instead: ${DEFAULT_IPFS_URL}`, | ||
| }; | ||
| } | ||
|
|
||
| // if default URL - make sure it ends with /api/v0 | ||
| if (DEFAULT_IPFS_URL.startsWith(ipfsUrl)) { | ||
| return { | ||
| ipfsUrl: DEFAULT_IPFS_URL, | ||
| }; | ||
| } | ||
|
|
||
| return { ipfsUrl }; | ||
| } catch (e) { | ||
| return { | ||
| ipfsUrl: DEFAULT_IPFS_URL, | ||
| warning: `Invalid IPFS URL: ${ipfsUrl}. Using default URL instead: ${DEFAULT_IPFS_URL}`, | ||
| }; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This (and all other package.json's below) should use
--ipfs https://ipfs.thegraph.com