feat(mv3): Redirection Tests

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

@@ -181,7 +181,7 @@ export function createRequestModifier (getState, dnslinkResolver, ipfsPathValida
       }
       // poor-mans protocol handlers - https://github.com/ipfs/ipfs-companion/issues/164#issuecomment-328374052
       if (state.catchUnhandledProtocols && mayContainUnhandledIpfsProtocol(request)) {
-        const fix = normalizedUnhandledIpfsProtocol(request, state.pubGwURLString)
+        const fix = await normalizedUnhandledIpfsProtocol(request, state.pubGwURLString)
         if (fix) {
           return fix
         }
@@ -478,14 +478,14 @@ export function createRequestModifier (getState, dnslinkResolver, ipfsPathValida
  * @param {object} input contains originUrl and redirectUrl.
  * @returns
  */
-function handleRedirection ({ originUrl, redirectUrl }) {
+async function handleRedirection ({ originUrl, redirectUrl }) {
   if (redirectUrl !== '' && originUrl !== '' && redirectUrl !== originUrl) {
-    if (supportsBlock) {
+    if (supportsBlock()) {
       return { redirectUrl }
     }
 
     // Let browser handle redirection MV3 style.
-    addRuleToDynamicRuleSet({ originUrl, redirectUrl })
+    await addRuleToDynamicRuleSet({ originUrl, redirectUrl })
   }
 }
 

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

@@ -24,7 +24,11 @@ interface messageToSelf {
 // We need to check if the browser supports the declarativeNetRequest API.
 // TODO: replace with check for `Blocking` in `chrome.webRequest.OnBeforeRequestOptions`
 // which is currently a bug https://bugs.chromium.org/p/chromium/issues/detail?id=1427952
-export const supportsBlock = !(browser.declarativeNetRequest?.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES === 5000)
+// this needs to be a function call, because in tests we mock browser.declarativeNetRequest
+// the way sinon ends up stubbing it, it's not directly available in the global scope on import
+// rather it gets replaced dynamically when the module is imported. Which means, we can't
+// just check for the existence of the property, we need to call the browser instance at that point.
+export const supportsBlock = (): boolean => !(browser.declarativeNetRequest?.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES === 5000)
 export const GLOBAL_STATE_CHANGE = 'GLOBAL_STATE_CHANGE'
 export const GLOBAL_STATE_OPTION_CHANGE = 'GLOBAL_STATE_OPTION_CHANGE'
 
@@ -51,7 +55,7 @@ export async function notifyOptionChange (): Promise<void> {
  */
 async function sendMessageToSelf (msg: typeof GLOBAL_STATE_CHANGE | typeof GLOBAL_STATE_OPTION_CHANGE): Promise<void> {
   // this check ensures we don't send messages to ourselves if blocking mode is enabled.
-  if (!supportsBlock) {
+  if (!supportsBlock()) {
     const message: messageToSelf = { type: msg }
     await browser.runtime.sendMessage(message)
   }
@@ -90,7 +94,7 @@ export function isLocalHost (url: string): boolean {
 function escapeURLRegex (str: string): string {
   // these characters are allowed in the URL, but not in the regex.
   // eslint-disable-next-line no-useless-escape
-  const ALLOWED_CHARS_URL_REGEX = /([:\/\?#\[\]@!$&'\(\ )\*\+,;=-_\.~])/g
+  const ALLOWED_CHARS_URL_REGEX = /([:\/\?#\[\]@!$&'\(\ )\*\+,;=\-_\.~])/g
   return str.replace(ALLOWED_CHARS_URL_REGEX, '\\$1')
 }
 
@@ -137,7 +141,7 @@ function constructRegexFilter ({ originUrl, redirectUrl }: redirectHandlerInput)
 
 // If the browser supports the declarativeNetRequest API, we can block the request.
 export function getExtraInfoSpec<T> (additionalParams: T[] = []): T[] {
-  if (supportsBlock) {
+  if (supportsBlock()) {
     return ['blocking' as T, ...additionalParams]
   }
   return additionalParams
@@ -222,7 +226,7 @@ async function reconcileRulesAndRemoveOld (state: CompanionState): Promise<void>
     if (rules.length === 0) {
       // we need to populate old rules.
       for (const [regexFilter, { regexSubstitution, id }] of savedRegexFilters.entries()) {
-        addRules.push(generateRule(id, regexFilter, regexSubstitution))
+        addRules.push(generateAddRule(id, regexFilter, regexSubstitution))
       }
     }
 
@@ -259,7 +263,7 @@ function saveAndGenerateRule (
   const id = Math.floor(Math.random() * 29999)
   // We need to save the regex filter and ID to check if the rule already exists later.
   savedRegexFilters.set(regexFilter, { id, regexSubstitution })
-  return generateRule(id, regexFilter, regexSubstitution, excludedInitiatorDomains)
+  return generateAddRule(id, regexFilter, regexSubstitution, excludedInitiatorDomains)
 }
 
 /**
@@ -270,7 +274,7 @@ function saveAndGenerateRule (
  * @param excludedInitiatorDomains - The domains that are excluded from the rule.
  * @returns
  */
-function generateRule (
+export function generateAddRule (
   id: number,
   regexFilter: string,
   regexSubstitution: string,

package.json

@@ -46,8 +46,9 @@
     "watch:js:webpack": "webpack --watch --mode development --devtool inline-source-map  --config ./webpack.config.js",
     "test": "run-s test:*",
     "test:e2e": "mocha --timeout 300000 \"test/e2e/**/*.test.js\"",
-    "test:functional": "c8 mocha --timeout 5000 \"test/functional/**/*.test.js\" \"test/functional/**/*.test.ts\"",
+    "test:functional": "c8 mocha --timeout 5000 --file \"test/setup/mocha-setup.js\" \"test/functional/**/*.test.js\" \"test/functional/**/*.test.ts\"",
     "lint": "run-s lint:*",
+    "test:functional_MV3": "cross-env TEST_MV3=true npm run test:functional",
     "lint:standard": "ts-standard -v \"*.js\" \"add-on/src/**/*.js\" \"add-on/src/**/*.ts\" \"test/**/*.js\" \"scripts/**/*.js\"",
     "lint:web-ext": "shx cat add-on/manifest.common.json add-on/manifest.chromium.json add-on/manifest.firefox-beta.json | json --deep-merge > add-on/manifest.json && web-ext lint --firefox-preview",
     "fix:lint": "run-s fix:lint:*",

test/functional/lib/ipfs-companion.test.js

@@ -1,26 +1,16 @@
-import { describe, it, before, after } from 'mocha'
 import { expect } from 'chai'
+import { after, before, describe, it } from 'mocha'
 import browser from 'sinon-chrome'
-import AbortController from 'abort-controller'
 import { URL } from 'url'
 import { optionDefaults } from '../../../add-on/src/lib/options.js'
-browser.runtime.id = 'testid'
-global.browser = browser
-global.AbortController = AbortController
-global.chrome = browser
-global.navigator = {
-  clipboard: {
-    writeText: () => {}
-  }
-}
+
 // We need to do this because global is not mapped otherwise, we need to stub browser and chrome runtime
 // so that the webextension-polyfill does not complain about the test runner not being a browser instance.
 const init = async () => (await import('../../../add-on/src/lib/ipfs-companion.js')).default()
 
 describe('lib/ipfs-companion.js', function () {
   describe('init', function () {
     before(function () {
-      global.localStorage = global.localStorage || {}
       global.URL = global.URL || URL
       global.screen = { width: 1024, height: 720 }
       global.addEventListener = () => { }
@@ -44,12 +34,6 @@ describe('lib/ipfs-companion.js', function () {
   })
 
   describe.skip('onStorageChange()', function () {
-    before(function () {
-      global.window = {}
-      global.browser = browser
-      global.URL = URL
-    })
-
     it('should update ipfs API instance on IPFS API URL change', async function () {
       browser.storage.local.get.resolves(optionDefaults)
       browser.storage.local.set.resolves()

test/functional/lib/ipfs-import.test.js

@@ -1,24 +1,9 @@
 'use strict'
-import { describe, it, before, after } from 'mocha'
 import { expect } from 'chai'
-import { useFakeTimers } from 'sinon'
-import browser from 'sinon-chrome'
+import { describe, it } from 'mocha'
 import { formatImportDirectory } from '../../../add-on/src/lib/ipfs-import.js'
 
 describe('ipfs-import.js', function () {
-  before(function () {
-    browser.runtime.id = 'testid'
-    global.document = {}
-    global.browser = browser
-    // ipfs-import depends on webextension/polyfill which can't be imported
-    // in a non-browser environment unless global.browser is stubbed
-
-    // need to force Date to return a particular date
-    global.clock = useFakeTimers({
-      now: new Date(2017, 10, 5, 12, 1, 1)
-    })
-  })
-
   describe('formatImportDirectory', function () {
     it('should change nothing if path is properly formatted and date wildcards are not provided', function () {
       const path = '/ipfs-companion-imports/my-directory/'
@@ -45,20 +30,4 @@ describe('ipfs-import.js', function () {
       expect(formatImportDirectory(path)).to.equal('/ipfs-companion-imports/2017-11-05_120101/')
     })
   })
-  // TODO: complete tests
-  // describe('openFilesAtWebUI', function () {
-  // })
-  //
-  // describe('openFilesAtGateway', function () {
-  // })
-  //
-  // describe('importFiles', function () {
-  // })
-
-  after(function () {
-    global.browser.flush()
-    global.clock.restore()
-    delete global.document
-    delete global.browser
-  })
 })