Merge pull request #189 from seznam/novinky-713

Improved visibility scroll listener performance by making it passive

Author: SVO404

.changeset/fuzzy-waves-pretend.md

@@ -0,0 +1,6 @@
+---
+"@ima/plugin-script-loader": patch
+"@ima/plugin-analytic": patch
+---
+
+Updated to latest @ima/core

.changeset/new-rice-fry.md

@@ -0,0 +1,5 @@
+---
+"@ima/plugin-atoms": minor
+---
+
+Improved visibility scroll listener performance by making it passive

package-lock.json

@@ -154,6 +154,6 @@ export abstract class AbstractAnalytic {
    * @param eventType
    */
   _fireLifecycleEvent(eventType: AnalyticEvents) {
-    this.#dispatcher.fire(eventType, { type: this._analyticScriptName }, true);
+    this.#dispatcher.fire(eventType, { type: this._analyticScriptName });
   }
 }

packages/plugin-analytic/src/AbstractAnalytic.ts

@@ -74,11 +74,9 @@ describe('AbstractAnalytic', () => {
       jest.spyOn(dispatcher, 'fire');
 
       abstractAnalytic.init();
-      expect(dispatcher.fire).toHaveBeenCalledWith(
-        AnalyticEvents.INITIALIZED,
-        { type: 'dummy' },
-        true
-      );
+      expect(dispatcher.fire).toHaveBeenCalledWith(AnalyticEvents.INITIALIZED, {
+        type: 'dummy',
+      });
     });
   });
 
@@ -104,11 +102,9 @@ describe('AbstractAnalytic', () => {
 
       expect(scriptLoader.load).toHaveBeenCalled();
       expect(abstractAnalytic._configuration).toHaveBeenCalled();
-      expect(dispatcher.fire).toHaveBeenCalledWith(
-        AnalyticEvents.LOADED,
-        { type: 'dummy' },
-        true
-      );
+      expect(dispatcher.fire).toHaveBeenCalledWith(AnalyticEvents.LOADED, {
+        type: 'dummy',
+      });
     });
 
     it('should load analytic script, call configuration method and fire loaded event only once.', async () => {
@@ -117,11 +113,9 @@ describe('AbstractAnalytic', () => {
 
       expect(scriptLoader.load.mock.calls).toHaveLength(1);
       expect(abstractAnalytic._configuration.mock.calls).toHaveLength(1);
-      expect(dispatcher.fire).toHaveBeenCalledWith(
-        AnalyticEvents.LOADED,
-        { type: 'dummy' },
-        true
-      );
+      expect(dispatcher.fire).toHaveBeenCalledWith(AnalyticEvents.LOADED, {
+        type: 'dummy',
+      });
       expect(dispatcher.fire.mock.calls).toHaveLength(1);
     });
   });

packages/plugin-analytic/src/__tests__/AbstractAnalyticSpec.js

@@ -34,9 +34,9 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@ima/core": ">=18.0.0",
-    "@ima/react-page-renderer": ">=18.0.0",
-    "@ima/plugin-useragent": ">=5.0.0"
+    "@ima/core": ">=19.6.3",
+    "@ima/plugin-useragent": ">=5.0.0",
+    "@ima/react-page-renderer": ">=18.0.0"
   },
   "dependencies": {
     "infinite-circle": "^0.3.0"

packages/plugin-atoms/package.json

@@ -137,7 +137,12 @@ export default class Visibility {
       this
     );
     this._window.bindEventListener(this._window.getWindow()!, 'resize', notify);
-    this._window.bindEventListener(this._window.getWindow()!, 'scroll', notify);
+    this._window.bindEventListener(
+      this._window.getWindow()!,
+      'scroll',
+      notify,
+      { passive: true }
+    );
   }
 
   /**

packages/plugin-atoms/src/Visibility.ts

@@ -93,7 +93,7 @@ export class ScriptLoader {
    */
   _handleOnLoad(url: string) {
     const data = { url };
-    this._dispatcher.fire(Events.LOADED, data, true);
+    this._dispatcher.fire(Events.LOADED, data);
 
     return data;
   }
@@ -112,7 +112,7 @@ export class ScriptLoader {
       error,
     };
 
-    this._dispatcher.fire(Events.LOADED, data, true);
+    this._dispatcher.fire(Events.LOADED, data);
     throw error;
   }
 }

packages/plugin-script-loader/src/ScriptLoader.ts

@@ -66,11 +66,7 @@ describe('ScriptLoader', () => {
 
       await scriptLoaderPlugin.load(url, template);
 
-      expect(dispatcher.fire).toHaveBeenCalledWith(
-        Events.LOADED,
-        { url },
-        true
-      );
+      expect(dispatcher.fire).toHaveBeenCalledWith(Events.LOADED, { url });
     });
 
     it('the dispatcher fire loaded event for scripts loaded by url', async () => {
@@ -81,11 +77,7 @@ describe('ScriptLoader', () => {
 
       await scriptLoaderPlugin.load(url);
 
-      expect(dispatcher.fire).toHaveBeenCalledWith(
-        Events.LOADED,
-        { url },
-        true
-      );
+      expect(dispatcher.fire).toHaveBeenCalledWith(Events.LOADED, { url });
     });
 
     it('the dispatcher fire loaded event with errors', async () => {
@@ -97,11 +89,10 @@ describe('ScriptLoader', () => {
       try {
         await scriptLoaderPlugin.load(url);
       } catch (error) {
-        expect(dispatcher.fire).toHaveBeenCalledWith(
-          Events.LOADED,
-          { url, error },
-          true
-        );
+        expect(dispatcher.fire).toHaveBeenCalledWith(Events.LOADED, {
+          url,
+          error,
+        });
       }
     });
 
@@ -113,11 +104,7 @@ describe('ScriptLoader', () => {
 
       await scriptLoaderPlugin.load(url);
 
-      expect(dispatcher.fire).toHaveBeenCalledWith(
-        Events.LOADED,
-        { url },
-        true
-      );
+      expect(dispatcher.fire).toHaveBeenCalledWith(Events.LOADED, { url });
 
       jest.clearAllMocks();
       await scriptLoaderPlugin.load(url);
@@ -126,11 +113,7 @@ describe('ScriptLoader', () => {
 
       await scriptLoaderPlugin.load(url, null, true);
 
-      expect(dispatcher.fire).toHaveBeenCalledWith(
-        Events.LOADED,
-        { url },
-        true
-      );
+      expect(dispatcher.fire).toHaveBeenCalledWith(Events.LOADED, { url });
     });
   });
 });