bugfix/message-from-before-creation-was-send (#1295)

* FIX got too many messages * FIX node method * CLEAR npm cache * UPDATE deps * FIX missing event * FIX e2e tests * FIX tests
pubkey · Nov 27, 2023 · a278986 · a278986
1 parent 190aeac
commit a278986
Show file tree

Hide file tree

Showing 16 changed files with 8,074 additions and 425 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -32,7 +32,7 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/[email protected]
         with:
-          node-version: '20.9.0'
+          node-version-file: ".nvmrc"
 
       # https://docs.github.com/en/free-pro-team@latest/actions/guides/caching-dependencies-to-speed-up-workflows
       - name: Reuse npm cache folder
@@ -46,10 +46,10 @@ jobs:
             ./node_modules
             ./test-electron/node_modules
           # invalidate cache when any package.json changes
-          key: ${{ runner.os }}-npm-x2-${{ env.cache-name }}-${{ hashFiles('**/package.json') }}
+          key: ${{ runner.os }}-npm-x3-${{ env.cache-name }}-${{ hashFiles('**/package.json') }}
           restore-keys: |
-            ${{ runner.os }}-npm-x2-${{ env.cache-name }}-
-            ${{ runner.os }}-npm-x2-
+            ${{ runner.os }}-npm-x3-${{ env.cache-name }}-
+            ${{ runner.os }}-npm-x3-
             ${{ runner.os }}-
 
       # install
@@ -117,9 +117,9 @@ jobs:
             ./node_modules
             ./test-electron/node_modules
           # invalidate cache when any package.json changes
-          key: ${{ runner.os }}-npm-test-node-x2-${{ matrix.node }}-${{ env.cache-name }}-${{ hashFiles('**/package.json') }}
+          key: ${{ runner.os }}-npm-test-node-x3-${{ matrix.node }}-${{ env.cache-name }}-${{ hashFiles('**/package.json') }}
           restore-keys: |
-            ${{ runner.os }}-npm-test-node-x2-${{ matrix.node }}-${{ env.cache-name }}-
+            ${{ runner.os }}-npm-test-node-x3-${{ matrix.node }}-${{ env.cache-name }}-
             ${{ runner.os }}-npm-test-node
             ${{ runner.os }}-test-node
 
@@ -140,22 +140,22 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/[email protected]
         with:
-          node-version: '20.9.0'
+          node-version-file: ".nvmrc"
 
       # https://docs.github.com/en/free-pro-team@latest/actions/guides/caching-dependencies-to-speed-up-workflows
       - name: Reuse npm cache folder
         uses: actions/cache@v3
         env:
-          cache-name: cache-node-modules
+          cache-name: cache-node-deno-modules
         with:
           path: |
             ~/.npm
             ./node_modules
             ./test-electron/node_modules
           # invalidate cache when any package.json changes
-          key: ${{ runner.os }}-npm-test-deno-x2-${{ env.cache-name }}-${{ hashFiles('**/package.json') }}
+          key: ${{ runner.os }}-npm-test-deno-x3-${{ env.cache-name }}-${{ hashFiles('**/package.json') }}
           restore-keys: |
-            ${{ runner.os }}-npm-test-deno-x2-${{ env.cache-name }}-
+            ${{ runner.os }}-npm-test-deno-x3-${{ env.cache-name }}-
             ${{ runner.os }}-npm-test-deno
             ${{ runner.os }}-test-deno
 
@@ -174,7 +174,7 @@ jobs:
             /home/runner/.cache/deno
           # do not cache based on package.json because deno install randomly fails
           # and it would then never succeed on the first run on dependency updateds
-          key: ${{ runner.os }}-deno-x2-
+          key: ${{ runner.os }}-deno-x3-
 
       - uses: denoland/setup-deno@v1
         with:

diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+20.10.0
diff --git a/docs/e2e.js b/docs/e2e.js
diff --git a/docs/iframe.js b/docs/iframe.js
@@ -238,18 +238,7 @@ function _startListening(channel) {
 
     var listenerFn = function listenerFn(msgObj) {
       channel._addEL[msgObj.type].forEach(function (listenerObject) {
-        /**
-         * Getting the current time in JavaScript has no good precision.
-         * So instead of only listening to events that happened 'after' the listener
-         * was added, we also listen to events that happened 100ms before it.
-         * This ensures that when another process, like a WebWorker, sends events
-         * we do not miss them out because their timestamp is a bit off compared to the main process.
-         * Not doing this would make messages missing when we send data directly after subscribing and awaiting a response.
-         * @link https://johnresig.com/blog/accuracy-of-javascript-time/
-         */
-        var hundredMsInMicro = 100 * 1000;
-        var minMessageTime = listenerObject.time - hundredMsInMicro;
-        if (msgObj.time >= minMessageTime) {
+        if (msgObj.time >= listenerObject.time) {
           listenerObject.fn(msgObj.data);
         }
       });
@@ -1392,14 +1381,15 @@ var microSeconds = exports.microSeconds = _util.microSeconds;
 var type = exports.type = 'native';
 function create(channelName) {
   var state = {
+    time: (0, _util.microSeconds)(),
     messagesCallback: null,
     bc: new BroadcastChannel(channelName),
     subFns: [] // subscriberFunctions
   };
 
-  state.bc.onmessage = function (msg) {
+  state.bc.onmessage = function (msgEvent) {
     if (state.messagesCallback) {
-      state.messagesCallback(msg.data);
+      state.messagesCallback(msgEvent.data);
     }
   };
   return state;
@@ -1455,7 +1445,7 @@ var NativeMethod = exports.NativeMethod = {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SimulateMethod = void 0;
+exports.SimulateMethod = exports.SIMULATE_DELAY_TIME = void 0;
 exports.averageResponseTime = averageResponseTime;
 exports.canBeUsed = canBeUsed;
 exports.close = close;
@@ -1470,30 +1460,36 @@ var type = exports.type = 'simulate';
 var SIMULATE_CHANNELS = new Set();
 function create(channelName) {
   var state = {
+    time: microSeconds(),
     name: channelName,
     messagesCallback: null
   };
+  console.log('created channel ' + state.counter);
   SIMULATE_CHANNELS.add(state);
   return state;
 }
 function close(channelState) {
   SIMULATE_CHANNELS["delete"](channelState);
 }
+var SIMULATE_DELAY_TIME = exports.SIMULATE_DELAY_TIME = 5;
 function postMessage(channelState, messageJson) {
   return new Promise(function (res) {
     return setTimeout(function () {
       var channelArray = Array.from(SIMULATE_CHANNELS);
-      channelArray.filter(function (channel) {
-        return channel.name === channelState.name;
-      }).filter(function (channel) {
-        return channel !== channelState;
-      }).filter(function (channel) {
-        return !!channel.messagesCallback;
-      }).forEach(function (channel) {
-        return channel.messagesCallback(messageJson);
+      channelArray.forEach(function (channel) {
+        if (channel.name === channelState.name &&
+        // has same name
+        channel !== channelState &&
+        // not own channel
+        !!channel.messagesCallback &&
+        // has subscribers
+        channel.time < messageJson.time // channel not created after postMessage() call
+        ) {
+          channel.messagesCallback(messageJson);
+        }
       });
       res();
-    }, 5);
+    }, SIMULATE_DELAY_TIME);
   });
 }
 function onMessage(channelState, fn) {
@@ -1503,7 +1499,7 @@ function canBeUsed() {
   return true;
 }
 function averageResponseTime() {
-  return 5;
+  return SIMULATE_DELAY_TIME;
 }
 var SimulateMethod = exports.SimulateMethod = {
   create: create,
@@ -1596,25 +1592,21 @@ function randomToken() {
   return Math.random().toString(36).substring(2);
 }
 var lastMs = 0;
-var additional = 0;
 
 /**
- * returns the current time in micro-seconds,
+ * Returns the current unix time in micro-seconds,
  * WARNING: This is a pseudo-function
  * Performance.now is not reliable in webworkers, so we just make sure to never return the same time.
  * This is enough in browsers, and this function will not be used in nodejs.
  * The main reason for this hack is to ensure that BroadcastChannel behaves equal to production when it is used in fast-running unit tests.
  */
 function microSeconds() {
-  var ms = Date.now();
-  if (ms === lastMs) {
-    additional++;
-    return ms * 1000 + additional;
-  } else {
-    lastMs = ms;
-    additional = 0;
-    return ms * 1000;
+  var ret = Date.now() * 1000; // milliseconds to microseconds
+  if (ret <= lastMs) {
+    ret = lastMs + 1;
   }
+  lastMs = ret;
+  return ret;
 }
 
 /**

diff --git a/docs/index.js b/docs/index.js
@@ -238,18 +238,7 @@ function _startListening(channel) {
 
     var listenerFn = function listenerFn(msgObj) {
       channel._addEL[msgObj.type].forEach(function (listenerObject) {
-        /**
-         * Getting the current time in JavaScript has no good precision.
-         * So instead of only listening to events that happened 'after' the listener
-         * was added, we also listen to events that happened 100ms before it.
-         * This ensures that when another process, like a WebWorker, sends events
-         * we do not miss them out because their timestamp is a bit off compared to the main process.
-         * Not doing this would make messages missing when we send data directly after subscribing and awaiting a response.
-         * @link https://johnresig.com/blog/accuracy-of-javascript-time/
-         */
-        var hundredMsInMicro = 100 * 1000;
-        var minMessageTime = listenerObject.time - hundredMsInMicro;
-        if (msgObj.time >= minMessageTime) {
+        if (msgObj.time >= listenerObject.time) {
           listenerObject.fn(msgObj.data);
         }
       });
@@ -1392,14 +1381,15 @@ var microSeconds = exports.microSeconds = _util.microSeconds;
 var type = exports.type = 'native';
 function create(channelName) {
   var state = {
+    time: (0, _util.microSeconds)(),
     messagesCallback: null,
     bc: new BroadcastChannel(channelName),
     subFns: [] // subscriberFunctions
   };
 
-  state.bc.onmessage = function (msg) {
+  state.bc.onmessage = function (msgEvent) {
     if (state.messagesCallback) {
-      state.messagesCallback(msg.data);
+      state.messagesCallback(msgEvent.data);
     }
   };
   return state;
@@ -1455,7 +1445,7 @@ var NativeMethod = exports.NativeMethod = {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SimulateMethod = void 0;
+exports.SimulateMethod = exports.SIMULATE_DELAY_TIME = void 0;
 exports.averageResponseTime = averageResponseTime;
 exports.canBeUsed = canBeUsed;
 exports.close = close;
@@ -1470,30 +1460,36 @@ var type = exports.type = 'simulate';
 var SIMULATE_CHANNELS = new Set();
 function create(channelName) {
   var state = {
+    time: microSeconds(),
     name: channelName,
     messagesCallback: null
   };
+  console.log('created channel ' + state.counter);
   SIMULATE_CHANNELS.add(state);
   return state;
 }
 function close(channelState) {
   SIMULATE_CHANNELS["delete"](channelState);
 }
+var SIMULATE_DELAY_TIME = exports.SIMULATE_DELAY_TIME = 5;
 function postMessage(channelState, messageJson) {
   return new Promise(function (res) {
     return setTimeout(function () {
       var channelArray = Array.from(SIMULATE_CHANNELS);
-      channelArray.filter(function (channel) {
-        return channel.name === channelState.name;
-      }).filter(function (channel) {
-        return channel !== channelState;
-      }).filter(function (channel) {
-        return !!channel.messagesCallback;
-      }).forEach(function (channel) {
-        return channel.messagesCallback(messageJson);
+      channelArray.forEach(function (channel) {
+        if (channel.name === channelState.name &&
+        // has same name
+        channel !== channelState &&
+        // not own channel
+        !!channel.messagesCallback &&
+        // has subscribers
+        channel.time < messageJson.time // channel not created after postMessage() call
+        ) {
+          channel.messagesCallback(messageJson);
+        }
       });
       res();
-    }, 5);
+    }, SIMULATE_DELAY_TIME);
   });
 }
 function onMessage(channelState, fn) {
@@ -1503,7 +1499,7 @@ function canBeUsed() {
   return true;
 }
 function averageResponseTime() {
-  return 5;
+  return SIMULATE_DELAY_TIME;
 }
 var SimulateMethod = exports.SimulateMethod = {
   create: create,
@@ -1596,25 +1592,21 @@ function randomToken() {
   return Math.random().toString(36).substring(2);
 }
 var lastMs = 0;
-var additional = 0;
 
 /**
- * returns the current time in micro-seconds,
+ * Returns the current unix time in micro-seconds,
  * WARNING: This is a pseudo-function
  * Performance.now is not reliable in webworkers, so we just make sure to never return the same time.
  * This is enough in browsers, and this function will not be used in nodejs.
  * The main reason for this hack is to ensure that BroadcastChannel behaves equal to production when it is used in fast-running unit tests.
  */
 function microSeconds() {
-  var ms = Date.now();
-  if (ms === lastMs) {
-    additional++;
-    return ms * 1000 + additional;
-  } else {
-    lastMs = ms;
-    additional = 0;
-    return ms * 1000;
+  var ret = Date.now() * 1000; // milliseconds to microseconds
+  if (ret <= lastMs) {
+    ret = lastMs + 1;
   }
+  lastMs = ret;
+  return ret;
 }
 
 /**