MAGE-899 refactor insights for flexibile loading and mixin support

Author: cammonro

view/frontend/web/js/autocomplete.js

@@ -18,10 +18,8 @@ define([
     'algoliaAutocompleteSuggestionsHtml',
     'algoliaAutocompleteAdditionalHtml',
 
-    // TODO: Refactor legacy global object dependencies
     'algoliaInsights',
     'algoliaHooks',
-
     'domReady!'
 ], function (
     Component,
@@ -35,7 +33,8 @@ define([
     categoriesHtml,
     pagesHtml,
     suggestionsHtml,
-    additionalHtml
+    additionalHtml,
+    algoliaInsights
 ) {
     const DEFAULT_HITS_PER_SECTION = 2;
     const DEBOUNCE_MS = algoliaConfig.autocomplete.debounceMilliseconds;

view/frontend/web/js/insights.js

@@ -4,14 +4,24 @@ define([
     'algoliaCommon',
     'mage/cookies',
 ], function ($, algoliaAnalyticsWrapper, algoliaCommon) {
+    const USE_GLOBALS = true;
+
     algoliaAnalytics = algoliaAnalyticsWrapper.default;
 
-    window.algoliaInsights = {
+    const algoliaInsights = {
         config            : null,
         defaultIndexName  : null,
         isTracking        : false,
         hasAddedParameters: false,
 
+        initialize() {
+            if (!window.algoliaConfig) return;
+
+            this.addSearchParameters();
+            this.bindConsentButtonClick(algoliaConfig);
+            this.track(algoliaConfig);            
+        },
+
         useCookie() {
             return !this.config.cookieConfiguration.cookieRestrictionModeEnabled
                 || !!algoliaCommon.getCookie(this.config.cookieConfiguration.consentCookieName);
@@ -95,7 +105,7 @@ define([
                 (allWidgetConfiguration) => {
 
                     allWidgetConfiguration.configure =
-                        algoliaInsights.applyInsightsToSearchParams(allWidgetConfiguration.configure);
+                        this.applyInsightsToSearchParams(allWidgetConfiguration.configure);
 
                     return allWidgetConfiguration;
                 }
@@ -104,7 +114,7 @@ define([
             algoliaCommon.registerHook(
                 'afterAutocompleteProductSourceOptions',
                 (options) => {
-                    return algoliaInsights.applyInsightsToSearchParams(options);
+                    return this.applyInsightsToSearchParams(options);
                 }
             );
 
@@ -343,20 +353,19 @@ define([
                 algoliaConfig.cookieConfiguration.cookieAllowButtonSelector,
                 (event) => {
                     event.preventDefault();
-                    algoliaInsights.initializeAnalytics(algoliaConfig, true);
+                    this.initializeAnalytics(algoliaConfig, true);
                 }
             );
         }
     };
 
-    algoliaInsights.addSearchParameters();
-
     $(function ($) {
-        if (window.algoliaConfig) {
-            algoliaInsights.bindConsentButtonClick(algoliaConfig);
-            algoliaInsights.track(algoliaConfig);
-        }
+        algoliaInsights.initialize()
     });
 
+    if (USE_GLOBALS) {
+        window.algoliaInsights = algoliaInsights;
+    }
+
     return algoliaInsights;
 });

view/frontend/web/js/instantsearch.js

@@ -14,7 +14,6 @@ define([
     // Magento core libs
     'Magento_Catalog/js/price-utils',
 
-    // TODO: Refactor legacy global object dependencies
     'algoliaInsights',
     'algoliaHooks',
 ], function (Component, $, algoliasearch, instantsearch, algoliaCommon, algoliaBase64, templateEngine, priceUtils) {
@@ -793,7 +792,7 @@ define([
                         (facet.label ? facet.label : facet.attribute) +
                         '</div>',
                 },
-                hidden   : function (options) {
+                hidden: (options) => {
                     if (
                         options.results.nbPages <= 1 &&
                         algoliaConfig.instant.hidePagination === true