feat: opt-in for loading webui from dnslink #738
There are no files selected for viewing
This file contains 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 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 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 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 |
|---|---|---|
|
|
@@ -8,6 +8,7 @@ log.error = debug('ipfs-companion:request:error') | |
| const LRU = require('lru-cache') | ||
| const IsIpfs = require('is-ipfs') | ||
| const { pathAtHttpGateway } = require('./ipfs-path') | ||
| const { buildWebuiURLString } = require('./state') | ||
| const redirectOptOutHint = 'x-ipfs-companion-no-redirect' | ||
| const recoverableErrors = new Set([ | ||
| // Firefox | ||
|
|
@@ -34,28 +35,6 @@ function createRequestModifier (getState, dnslinkResolver, ipfsPathValidator, ru | |
| const ignoredRequests = new LRU(requestCacheCfg) | ||
| const ignore = (id) => ignoredRequests.set(id, true) | ||
| const isIgnored = (id) => ignoredRequests.get(id) !== undefined | ||
| const preNormalizationSkip = (state, request) => { | ||
| // skip requests to the custom gateway or API (otherwise we have too much recursion) | ||
| if (request.url.startsWith(state.gwURLString) || request.url.startsWith(state.apiURLString)) { | ||
|
|
@@ -161,46 +140,23 @@ function createRequestModifier (getState, dnslinkResolver, ipfsPathValidator, ru | |
|
|
||
| // Special handling of requests made to API | ||
| if (request.url.startsWith(state.apiURLString)) { | ||
| // '403 - Forbidden' fix for Chrome and Firefox | ||
| // -------------------------------------------- | ||
| // We remove Origin header from requests made to API URL | ||
| // by js-ipfs-http-client running in WebExtension context. | ||
| // This act as unification of CORS behavior across all vendors, | ||
| // where behavior was non-deterministic and changed between releases. | ||
| // Without this, some users would need to do manual CORS whitelisting | ||
| // by adding webExtensionOrigin to API.Access-Control-Allow-Origin at their IPFS node. | ||
| // More info: | ||
| // Firefox: https://github.com/ipfs-shipyard/ipfs-companion/issues/622 | ||
| // Chromium 71: https://github.com/ipfs-shipyard/ipfs-companion/pull/616 | ||
| // Chromium 72: https://github.com/ipfs-shipyard/ipfs-companion/issues/630 | ||
| const isWebExtensionOrigin = (origin) => { | ||
| // console.log(`origin=${origin}, webExtensionOrigin=${webExtensionOrigin}`) | ||
| // Chromium <72 returns opaque Origin as defined in | ||
| // https://html.spec.whatwg.org/multipage/origin.html#ascii-serialisation-of-an-origin | ||
| // TODO: remove this when <72 is not used by users | ||
| if (origin == null || origin === 'null') { | ||
| return true | ||
| } | ||
|
|
@@ -274,39 +230,15 @@ function createRequestModifier (getState, dnslinkResolver, ipfsPathValidator, ru | |
| return | ||
| } | ||
|
|
||
| // Recover from a broken DNSLink webui by redirecting back to CID one | ||
| // TODO: remove when both GO and JS ship support for /ipns/webui.ipfs.io on the API port | ||
| if (request.statusCode === 404 && request.url === state.webuiURLString && state.webuiFromDNSLink) { | ||
|
There was a problem hiding this comment. This means we can ship this feature before ipfs/kubo#6530 lands |
||
| const stableWebui = buildWebuiURLString({ | ||
| apiURLString: state.apiURLString, | ||
| webuiFromDNSLink: false | ||
| }) | ||
| log(`opening webui via ${state.webuiURLString} is not supported yet, opening stable webui from ${stableWebui} instead`) | ||
| return { redirectUrl: stableWebui } | ||
| } | ||
|
|
||
| // Skip if request is marked as ignored | ||
|
|
@@ -317,6 +249,7 @@ function createRequestModifier (getState, dnslinkResolver, ipfsPathValidator, ru | |
| if (state.redirect) { | ||
| // Late redirect as a workaround for edge cases such as: | ||
| // - CORS XHR in Firefox: https://github.com/ipfs-shipyard/ipfs-companion/issues/436 | ||
| // TODO: remove when Firefox with a fix landed in Stable channel | ||
| if (onHeadersReceivedRedirect.has(request.requestId)) { | ||
| onHeadersReceivedRedirect.delete(request.requestId) | ||
| if (state.dnslinkPolicy) { | ||
|
|
@@ -529,6 +462,25 @@ function normalizedUnhandledIpfsProtocol (request, pubGwUrl) { | |
| } | ||
| } | ||
|
|
||
| /* not used at the moment, but this heuristic may be useful in the future | ||
| // Note: Chrome 72+ requires 'extraHeaders' for access to Referer header | ||
| const originUrls = new LRU(requestCacheCfg) // request.originUrl workaround for Chrome | ||
| const originUrl = (request) => { | ||
| // Firefox and Chrome provide relevant value in different fields: | ||
| // (Firefox) request object includes full URL of origin document, return as-is | ||
| if (request.originUrl) return request.originUrl | ||
| // (Chrome) is lacking: `request.initiator` is just the origin (protocol+hostname+port) | ||
| // To reconstruct originUrl we read full URL from Referer header in onBeforeSendHeaders | ||
| // and cache it for short time | ||
| // TODO: when request.originUrl is available in Chrome the `originUrls` cache can be removed | ||
| const cachedUrl = originUrls.get(request.requestId) | ||
| if (cachedUrl) return cachedUrl | ||
| if (request.requestHeaders) { | ||
| const referer = request.requestHeaders.find(h => h.name === 'Referer') | ||
| if (referer) { | ||
| originUrls.set(request.requestId, referer.value) | ||
| return referer.value | ||
| } | ||
| } | ||
| } | ||
| */ | ||
This file contains 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.
@olizilla would appreciate your thoughts on how to name and describe this feature.
My initial stab looks like this: