fix(recovery): 🩹 automatic mode

add-on/src/lib/ipfs-request.js

@@ -149,10 +149,9 @@ export function createRequestModifier (getState, dnslinkResolver, ipfsPathValida
       // to public gateway.
       if (!state.nodeActive && request.type === 'main_frame' && sameGateway(request.url, state.gwURL)) {
         const publicUri = await ipfsPathValidator.resolveToPublicUrl(request.url, state.pubGwURLString)
-        return handleRedirection({
-          originUrl: request.url,
-          redirectUrl: `${dropSlash(runtimeRoot)}${recoveryPagePath}#${encodeURIComponent(publicUri)}`
-        })
+        const redirectUrl = state.automaticMode ? publicUri : `${dropSlash(runtimeRoot)}${recoveryPagePath}#${encodeURIComponent(publicUri)}`
+
+        return handleRedirection({ originUrl: request.url, redirectUrl })
       }
 
       // When Subdomain Proxy is enabled we normalize address bar requests made

add-on/src/lib/redirect-handler/blockOrObserve.ts

@@ -320,10 +320,13 @@ export function addRuleToDynamicRuleSetGenerator (
     const state = getState()
     const redirectIsOrigin = originUrl === redirectUrl
     const redirectIsLocal = isLocalHost(originUrl) && isLocalHost(redirectUrl)
-    const badOriginRedirect = originUrl.includes(state.gwURL.host) && !redirectUrl.includes('recovery')
+    const localOriginRedirect = isLocalHost(originUrl) && !isLocalHost(redirectUrl)
+    // if the redirect is to the gateway and the automatic mode is off, we would like to present the recovery page.
+    // in case automatic mode is on, we would like to redirect to the public gateway.
+    // This rule is added temporarily otherwise it messes up the local redirects.
+    const badOriginRedirect = localOriginRedirect && !state.automaticMode
     // We don't want to redirect to the same URL. Or to the gateway.
-    if (redirectIsOrigin || badOriginRedirect || redirectIsLocal
-    ) {
+    if (redirectIsOrigin || badOriginRedirect || redirectIsLocal) {
       return
     }
 
@@ -339,10 +342,11 @@ export function addRuleToDynamicRuleSetGenerator (
         savedRegexFilters.delete(regexFilter)
       }
 
+      const rule = saveAndGenerateRule(regexFilter, regexSubstitution)
       await browser.declarativeNetRequest.updateDynamicRules(
         {
           // We need to add the new rule.
-          addRules: [saveAndGenerateRule(regexFilter, regexSubstitution)],
+          addRules: [rule],
           // We need to remove the old rules.
           removeRuleIds
         }
@@ -351,6 +355,11 @@ export function addRuleToDynamicRuleSetGenerator (
       // refresh the tab to apply the new rule.
       const tabs = await browser.tabs.query({ url: `${originUrl}*` })
       await Promise.all(tabs.map(async tab => await browser.tabs.reload(tab.id)))
+      if (state.automaticMode && localOriginRedirect) {
+        // Removing the recently added rule as this will mess up the local browsing.
+        await browser.declarativeNetRequest.updateDynamicRules({ removeRuleIds: [rule.id] })
+        savedRegexFilters.delete(regexFilter)
+      }
     }
 
     setupListeners(async (): Promise<void> => await reconcileRulesAndRemoveOld(getState()))

test/functional/lib/ipfs-request-gateway-redirect.test.js

@@ -426,7 +426,7 @@ describe('modifyRequest.onBeforeRequest:', function () {
     })
   })
 
-  describe('Recovers Page if node is unreachable', function () {
+  describe('Recovers Page if node is unreachable and automatic mode is off', function () {
     beforeEach(function () {
       global.browser = browser
       state.ipfsNodeType = 'external'
@@ -436,6 +436,7 @@ describe('modifyRequest.onBeforeRequest:', function () {
       state.gwURL = new URL('http://localhost:8080')
       state.pubGwURLString = 'https://ipfs.io'
       state.pubGwURL = new URL('https://ipfs.io')
+      state.automaticMode = false
     })
     it('should present recovery page if node is offline and redirect is enabled', async function () {
       expect(state.nodeActive).to.be.equal(false)
@@ -465,6 +466,46 @@ describe('modifyRequest.onBeforeRequest:', function () {
     })
   })
 
+  describe('Redirects the Page if node is unreachable and automatic mode is on', function () {
+    beforeEach(function () {
+      global.browser = browser
+      state.ipfsNodeType = 'external'
+      state.redirect = true
+      state.peerCount = -1 // this simulates Kubo RPC being offline
+      state.gwURLString = 'http://localhost:8080'
+      state.gwURL = new URL('http://localhost:8080')
+      state.pubGwURLString = 'https://ipfs.io'
+      state.pubGwURL = new URL('https://ipfs.io')
+      state.automaticMode = true
+    })
+    it('should present recovery page if node is offline and redirect is enabled', async function () {
+      expect(state.nodeActive).to.be.equal(false)
+      state.redirect = true
+      const request = url2request('https://localhost:8080/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR/foo/bar')
+      expect((await modifyRequest.onBeforeRequest(request)).redirectUrl).to.equal('https://ipfs.io/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR/foo/bar')
+    })
+    it('should present recovery page if node is offline and redirect is disabled', async function () {
+      expect(state.nodeActive).to.be.equal(false)
+      state.redirect = false
+      const request = url2request('https://localhost:8080/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR/foo/bar')
+      expect((await modifyRequest.onBeforeRequest(request)).redirectUrl).to.equal('https://ipfs.io/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR/foo/bar')
+    })
+    it('should not show recovery page if node is offline, redirect is enabled, but non-gateway URL failed to load from the same port', async function () {
+      // this covers https://github.com/ipfs/ipfs-companion/issues/1162 and https://twitter.com/unicomp21/status/1626244123102679041
+      state.redirect = true
+      expect(state.nodeActive).to.be.equal(false)
+      const request = url2request('https://localhost:8080/')
+      expect(await modifyRequest.onBeforeRequest(request)).to.equal(undefined)
+    })
+    it('should not show recovery page if extension is disabled', async function () {
+      // allows user to quickly avoid anything similar to https://github.com/ipfs/ipfs-companion/issues/1162
+      state.active = false
+      expect(state.nodeActive).to.be.equal(false)
+      const request = url2request('https://localhost:8080/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR/foo/bar')
+      expect(await modifyRequest.onBeforeRequest(request)).to.equal(undefined)
+    })
+  })
+
   after(function () {
     delete global.URL
     delete global.browser