feat: reload failed IPFS tabs when API becomes available (#1092)

Author: whizzzkid

.editorconfig

@@ -0,0 +1,8 @@
+root=true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

add-on/src/lib/ipfs-client/index.js

@@ -10,6 +10,7 @@ const external = require('./external')
 const embedded = require('./embedded')
 const brave = require('./brave')
 const { precache } = require('../precache')
+const { prepareReloadExtensions, WebUiReloader, LocalGatewayReloader, InternalTabReloader } = require('./reloaders')
 
 // ensure single client at all times, and no overlap between init and destroy
 let client
@@ -61,40 +62,54 @@ async function destroyIpfsClient (browser) {
   }
 }
 
-function _isWebuiTab (url) {
-  const bundled = !url.startsWith('http') && url.includes('/webui/index.html#/')
-  const ipns = url.includes('/webui.ipfs.io/#/')
-  return bundled || ipns
-}
-
-function _isInternalTab (url, extensionOrigin) {
-  return url.startsWith(extensionOrigin)
-}
-
-async function _reloadIpfsClientDependents (browser, instance, opts) {
+/**
+ * Reloads pages dependant on ipfs to be online
+ *
+ * @typedef {embedded|brave|external} Browser
+ * @param {Browser} browser
+ * @param {import('ipfs-http-client').default} instance
+ * @param {Object} opts
+ * @param {Array.[InternalTabReloader|LocalGatewayReloader|WebUiReloader]=} reloadExtensions
+ * @returns {void}
+ */
+async function _reloadIpfsClientDependents (
+  browser, instance, opts, reloadExtensions = [WebUiReloader, LocalGatewayReloader, InternalTabReloader]) {
   // online || offline
   if (browser.tabs && browser.tabs.query) {
     const tabs = await browser.tabs.query({})
     if (tabs) {
-      const extensionOrigin = browser.runtime.getURL('/')
-      tabs.forEach((tab) => {
-        // detect bundled webui in any of open tabs
-        if (_isWebuiTab(tab.url)) {
-          log(`reloading webui at ${tab.url}`)
-          browser.tabs.reload(tab.id)
-        } else if (_isInternalTab(tab.url, extensionOrigin)) {
-          log(`reloading internal extension page at ${tab.url}`)
-          browser.tabs.reload(tab.id)
-        }
-      })
+      try {
+        const reloadExtensionInstances = await prepareReloadExtensions(reloadExtensions, browser, log)
+        // the reload process is async, fire and forget.
+        reloadExtensionInstances.forEach(ext => ext.reload(tabs))
+      } catch (e) {
+        log('Failed to trigger reloaders')
+      }
     }
   }
+
   // online only
   if (client && instance && opts) {
     // add important data to local ipfs repo for instant load
     setTimeout(() => precache(instance, opts), 5000)
   }
 }
 
-exports.initIpfsClient = initIpfsClient
-exports.destroyIpfsClient = destroyIpfsClient
+/**
+ * Reloads local gateway pages dependant on ipfs to be online
+ *
+ * @typedef {embedded|brave|external} Browser
+ * @param {Browser} browser
+ * @param {import('ipfs-http-client').default} instance
+ * @param {Object} opts
+ * @returns {void}
+ */
+function reloadIpfsClientOfflinePages (browser, instance, opts) {
+  _reloadIpfsClientDependents(browser, instance, opts, [LocalGatewayReloader])
+}
+
+module.exports = {
+  initIpfsClient,
+  destroyIpfsClient,
+  reloadIpfsClientOfflinePages
+}

add-on/src/lib/ipfs-client/reloaders/index.js

@@ -0,0 +1,33 @@
+const { InternalTabReloader } = require('./internalTabReloader')
+const { LocalGatewayReloader } = require('./localGatewayReloader')
+const { WebUiReloader } = require('./webUiReloader')
+
+/**
+ * Prepares extension by creating an instance and awaiting for init.
+ *
+ * @param {Array.[InternalTabReloader|LocalGatewayReloader|WebUiReloader]} extensions
+ * @param {Browser} browserInstance
+ * @param {Logger} loggerInstance
+ * @returns {Promise<Array.[InternalTabReloader|LocalGatewayReloader|WebUiReloader]>}
+ */
+function prepareReloadExtensions (extensions, browserInstance, loggerInstance) {
+  const reloadExtensions = Array.isArray(extensions) ? extensions : [extensions]
+  return Promise.all(reloadExtensions
+    .map(async Ext => {
+      try {
+        const ext = new Ext(browserInstance, loggerInstance)
+        await ext.init()
+        return ext
+      } catch (e) {
+        loggerInstance(`Extension Instance Failed to Initialize with error: ${e}. Extension: ${Ext}`)
+      }
+    })
+  )
+}
+
+module.exports = {
+  InternalTabReloader,
+  LocalGatewayReloader,
+  WebUiReloader,
+  prepareReloadExtensions
+}

add-on/src/lib/ipfs-client/reloaders/internalTabReloader.js

@@ -0,0 +1,37 @@
+const { ReloaderBase } = require('./reloaderBase')
+
+class InternalTabReloader extends ReloaderBase {
+  /**
+   * Setting up the extension origin.
+   */
+  init () {
+    this.extensionOrigin = this._browserInstance.runtime.getURL('/')
+    this._log('InternalTabReloader Ready for use.')
+  }
+
+  /**
+   * Performs url validation for the tab. If tab is a WebUI tab.
+   *
+   * @param {Object} tab
+   * @param {string} tab.url
+   * @returns {boolean}
+   */
+  validation ({ url }) {
+    return url.startsWith(this.extensionOrigin)
+  }
+
+  /**
+   * Returns message when reloading the tab.
+   *
+   * @param {Object} tab
+   * @param {string} tab.url
+   * @returns {string} message.
+   */
+  message ({ url }) {
+    return `reloading internal extension page at ${url}`
+  }
+}
+
+module.exports = {
+  InternalTabReloader
+}

add-on/src/lib/ipfs-client/reloaders/localGatewayReloader.js

@@ -0,0 +1,42 @@
+const { ReloaderBase } = require('./reloaderBase')
+const isIPFS = require('is-ipfs')
+
+class LocalGatewayReloader extends ReloaderBase {
+  /**
+   * Performs url validation for the tab. If tab is loaded via local gateway.
+   *
+   * @param {Object} tab
+   * @param {string} tab.url
+   * @param {string} tab.url
+   * @returns {boolean}
+   */
+  validation ({ url, title }) {
+    /**
+     * Check if the url is the local gateway url and if the title is contained within the url then it was not loaded.
+     * - This assumes that the title of most pages on the web will be set and hence when not reachable, the browser
+     *   will set title to the url/host (both chrome and brave) and 'problem loading page' for firefox.
+     * - There is probability that this might be true in case the <title> tag is omitted, but worst case it only reloads
+     *   those pages.
+     * - The benefit we get from this approach is the static nature of just observing the tabs in their current state
+     *   which reduces the overhead of injecting content scripts to track urls that were loaded after the connection
+     *   was offline, it may also need extra permissions to inject code on error pages.
+     */
+    return (isIPFS.url(url) || isIPFS.subdomain(url)) &&
+      (url.includes(title) || title.toLowerCase() === 'problem loading page')
+  }
+
+  /**
+   * Returns message when reloading the tab.
+   *
+   * @param {Object} tab
+   * @param {string} tab.url
+   * @returns {string} message.
+   */
+  message ({ url }) {
+    return `reloading local gateway at ${url}`
+  }
+}
+
+module.exports = {
+  LocalGatewayReloader
+}

add-on/src/lib/ipfs-client/reloaders/reloaderBase.js

@@ -0,0 +1,53 @@
+class ReloaderBase {
+  /**
+   * Constructor for reloader base class.
+   *
+   * @param {Browser} browser
+   * @param {Logger} log
+   */
+  constructor (browser, log) {
+    if (!browser || !log) {
+      throw new Error('Instances of browser and logger are needed!')
+    }
+    this._browserInstance = browser
+    this._log = log
+  };
+
+  /**
+   * Initializes the instance.
+   */
+  init () {
+    this._log('Initialized without additional config.')
+  }
+
+  /**
+   * To be implemented in child class.
+   */
+  validation () {
+    throw new Error('Validation: Method Not Implemented')
+  }
+
+  /**
+   * To be implemented in child class.
+   */
+  message () {
+    throw new Error('Message: Method Not Implemented')
+  }
+
+  /**
+   * Handles reload for all tabs.
+   * params {Array<tabs>}
+   */
+  reload (tabs) {
+    tabs
+      .filter(tab => this.validation(tab))
+      .forEach(tab => {
+        this._log(this.message(tab))
+        this._browserInstance.tabs.reload(tab.id)
+      })
+  }
+}
+
+module.exports = {
+  ReloaderBase
+}

add-on/src/lib/ipfs-client/reloaders/webUiReloader.js

@@ -0,0 +1,30 @@
+const { ReloaderBase } = require('./reloaderBase')
+
+class WebUiReloader extends ReloaderBase {
+  /**
+   * Performs url validation for the tab. If tab is a WebUI tab.
+   *
+   * @param {Object} tab
+   * @returns {boolean}
+   */
+  validation ({ url }) {
+    const bundled = !url.startsWith('http') && url.includes('/webui/index.html#/')
+    const ipns = url.includes('/webui.ipfs.io/#/')
+    return bundled || ipns
+  }
+
+  /**
+   * Returns message when reloading the tab.
+   *
+   * @param {Object} tab
+   * @param {string} tab.url
+   * @returns {string} message.
+   */
+  message ({ url }) {
+    return `reloading webui at ${url}`
+  }
+}
+
+module.exports = {
+  WebUiReloader
+}

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

@@ -15,7 +15,7 @@ const { initState, offlinePeerCount } = require('./state')
 const { createIpfsPathValidator, sameGateway, safeHostname } = require('./ipfs-path')
 const createDnslinkResolver = require('./dnslink')
 const { createRequestModifier } = require('./ipfs-request')
-const { initIpfsClient, destroyIpfsClient } = require('./ipfs-client')
+const { initIpfsClient, destroyIpfsClient, reloadIpfsClientOfflinePages } = require('./ipfs-client')
 const { braveNodeType, useBraveEndpoint, releaseBraveEndpoint } = require('./ipfs-client/brave')
 const { createIpfsImportHandler, formatImportDirectory, browserActionFilesCpImportCurrentTab } = require('./ipfs-import')
 const createNotifier = require('./notifier')
@@ -595,6 +595,7 @@ module.exports = async function init () {
       if (oldPeerCount === offlinePeerCount && newPeerCount > offlinePeerCount && !state.redirect) {
         await browser.storage.local.set({ useCustomGateway: true })
         await notify('notify_apiOnlineTitle', 'notify_apiOnlineAutomaticModeMsg')
+        reloadIpfsClientOfflinePages(browser, ipfs, state)
       } else if (newPeerCount === offlinePeerCount && state.redirect) {
         await browser.storage.local.set({ useCustomGateway: false })
         await notify('notify_apiOfflineTitle', 'notify_apiOfflineAutomaticModeMsg')

package.json

@@ -141,7 +141,7 @@
     "webextension-polyfill": "0.7.0"
   },
   "engines": {
-    "node": ">=14.15.0",
+    "node": ">=14.15.0 <17",
     "npm": ">=6.14.0"
   }
 }