Workaround (attempt 2) for firefox bug where the global object for content scripts gets redefined if the content script executes very early

A workaround for this bug was attempted in 721995e however this was not enough for all situations. The new workaround should be more robust

Author: Joris-van-der-Wel

runner-modules/assert/lib/content/index.js

@@ -1,6 +1,7 @@
 'use strict';
+const registerRunnerModule = require('../../../content-register');
 
-openRunnerRegisterRunnerModule('assert', async ({getModule}) => {
+registerRunnerModule('assert', async ({getModule}) => {
     const chai = await getModule('chai');
     return chai.assert;
 });

runner-modules/chai/lib/content/index.js

@@ -1,6 +1,7 @@
 'use strict';
 const chai = require('../chai');
+const registerRunnerModule = require('../../../content-register');
 
-openRunnerRegisterRunnerModule('chai', () => {
+registerRunnerModule('chai', () => {
     return chai();
 });

runner-modules/content-register.js

@@ -0,0 +1,9 @@
+/* global window:false */
+'use strict';
+
+const registerRunnerModule = (...args) => {
+    window.dispatchEvent(new window.Event('openrunnerinitmoduleframework'));
+    return window.openRunnerRegisterRunnerModule(...args);
+};
+
+module.exports = registerRunnerModule;

runner-modules/contentEvents/lib/content/index.js

@@ -1,6 +1,6 @@
 /* global window, document */
 'use strict';
-
+const registerRunnerModule = require('../../../content-register');
 const log = require('../../../../lib/logger')({hostname: 'content', MODULE: 'contentEvents/content/index'});
 
 const SLOW_PAINT_THRESHOLD = 50; // 60hz = 16.6...ms
@@ -10,7 +10,7 @@ const SLOW_PAINT_THRESHOLD = 50; // 60hz = 16.6...ms
 const requestAnimationFrame = callback => window.requestAnimationFrame(callback);
 const timing = () => window.performance.timing;
 
-openRunnerRegisterRunnerModule('contentEvents', async ({getModule}) => {
+registerRunnerModule('contentEvents', async ({getModule}) => {
     const {scriptResult, TimePoint} = await getModule('runResult');
     let lastAnimationFrame = null;
 

runner-modules/eventSimulation/lib/content/index.js

@@ -2,12 +2,13 @@
 const {click} = require('./mouse');
 const {keyboardKeys, keyboardTextInput} = require('./keyboard');
 const {focus} = require('./focus');
+const registerRunnerModule = require('../../../content-register');
 
 const DEFAULT_MOUSE_DOWN_DURATION = 64;
 const DEFAULT_KEY_INTERVAL = 10;
 const DEFAULT_KEY_DOWN_DURATION = 5;
 
-openRunnerRegisterRunnerModule('eventSimulation', async ({getModule}) => {
+registerRunnerModule('eventSimulation', async ({getModule}) => {
     const {scriptResult} = await getModule('runResult');
 
     return Object.freeze({

runner-modules/expect/lib/content/index.js

@@ -1,6 +1,7 @@
 'use strict';
+const registerRunnerModule = require('../../../content-register');
 
-openRunnerRegisterRunnerModule('expect', async ({getModule}) => {
+registerRunnerModule('expect', async ({getModule}) => {
     const chai = await getModule('chai');
     return chai.expect;
 });

runner-modules/mutationEvents/lib/content/index.js

@@ -1,9 +1,9 @@
 'use strict';
 /* global document:false */
-
 const {observeDocument} = require('./mutationEvents');
+const registerRunnerModule = require('../../../content-register');
 
-openRunnerRegisterRunnerModule('mutationEvents', async ({getModule}) => {
+registerRunnerModule('mutationEvents', async ({getModule}) => {
     const {scriptResult} = await getModule('runResult');
     observeDocument(document, scriptResult);
 });

runner-modules/runResult/lib/content/index.js

@@ -1,14 +1,14 @@
 'use strict';
-
 const {transactionAbortedError} = require('../../../../lib/scriptErrors');
 const TimePoint = require('../TimePoint');
 const TimePeriod = require('../TimePeriod');
 const Event = require('../Event');
 const Transaction = require('../Transaction');
 const RunResult = require('../RunResult');
 const log = require('../../../../lib/logger')({hostname: 'content', MODULE: 'runResult/content/index'});
+const registerRunnerModule = require('../../../content-register');
 
-openRunnerRegisterRunnerModule('runResult', ({eventEmitter, rpc}) => {
+registerRunnerModule('runResult', ({eventEmitter, rpc}) => {
     TimePoint.setCounterFunc(() => ({
         backgroundCounter: undefined,
         scriptCounter: undefined,

runner-modules/tabs/lib/content/index.js

@@ -86,12 +86,15 @@ try {
 
     window.openRunnerRegisterRunnerModule = openRunnerRegisterRunnerModule;
     window.addEventListener('message', handleWindowMessage, false);
-    // Workaround for firefox bug (last tested to occur in v57)
+    // Workaround for firefox bug (last tested to occur in v57 and v65)
     // it seems that sometimes this content script is executed so early that firefox still has to perform some kind of house keeping,
     // which causes our global variable to disappear. assigning the global variable again in a microtask works around this bug.
     Promise.resolve().then(() => {
         window.openRunnerRegisterRunnerModule = openRunnerRegisterRunnerModule;
-        window.addEventListener('message', handleWindowMessage, false); // has no effect if already added
+    });
+    window.addEventListener('openrunnerinitmoduleframework', e => {
+        e.stopImmediatePropagation();
+        window.openRunnerRegisterRunnerModule = openRunnerRegisterRunnerModule;
     });
 
     log.debug('Initialized... Notifying the background script');

runner-modules/wait/lib/content/index.js

@@ -4,8 +4,9 @@ const Bluefox = require('bluefox');
 
 const log = require('../../../../lib/logger')({hostname: 'content', MODULE: 'wait/content/index'});
 const trackRunResultEvents = require('./trackRunResultEvents');
+const registerRunnerModule = require('../../../content-register');
 
-openRunnerRegisterRunnerModule('wait', async ({eventEmitter, getModule}) => {
+registerRunnerModule('wait', async ({eventEmitter, getModule}) => {
     const runResultModule = await getModule('runResult');
     const bluefox = new Bluefox();
     const wait = bluefox.target(window);