fix queued requests in JS tracker and add possibility to disable it (m…

…atomo-org#14146) * fix queued requests in JS tracker and add possibility to disable it * Regenerate core tracker JS. * Fix jslint error. * trying to fix and debug failing js test * fix js test * trying to fix test * debugging failing test * fix JS tests * fix jslint
fdellwing · Mar 4, 2019 · 9241966 · 9241966
1 parent 637871b
commit 9241966
Show file tree

Hide file tree

Showing 6 changed files with 188 additions and 150 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,8 @@ The Product Changelog at **[matomo.org/changelog](https://matomo.org/changelog)*
 ### New Features
 * It is now possible to use monolog's FingersCrossedHandler which buffers all logs and logs all of them in case of warning or error.
 
-### Deprecations
+### New APIs
+* A new tracker method `disableQueueRequest` has been added to disable queued requests which may be useful when logs are imported.
 * The event `LanguageManager.getAvailableLanguages` has been deprecated. Use `LanguagesManager.getAvailableLanguages` instead.
 
 ## Matomo 3.8.0

diff --git a/js/piwik.js b/js/piwik.js
@@ -998,7 +998,7 @@ if (typeof JSON_PIWIK !== 'object' && typeof window.JSON === 'object' && window.
     addListener, enableLinkTracking, enableJSErrorTracking, setLinkTrackingTimer, getLinkTrackingTimer,
     enableHeartBeatTimer, disableHeartBeatTimer, killFrame, redirectFile, setCountPreRendered,
     trackGoal, trackLink, trackPageView, getNumTrackedPageViews, trackRequest, queueRequest, trackSiteSearch, trackEvent,
-    requests, timeout, sendRequests, queueRequest,
+    requests, timeout, enabled, sendRequests, queueRequest, disableQueueRequest,getRequestQueue, unsetPageIsUnloading,
     setEcommerceView, getEcommerceItems, addEcommerceItem, removeEcommerceItem, clearEcommerceCart, trackEcommerceOrder, trackEcommerceCartUpdate,
     deleteCookie, deleteCookies, offsetTop, offsetLeft, offsetHeight, offsetWidth, nodeType, defaultView,
     innerHTML, scrollLeft, scrollTop, currentStyle, getComputedStyle, querySelectorAll, splice,
@@ -5656,29 +5656,32 @@ if (typeof window.Piwik !== 'object') {
                 return hookObj;
             }
 
+            /*</DEBUG>*/
+
             var requestQueue = {
+                enabled: true,
                 requests: [],
                 timeout: null,
                 sendRequests: function () {
                     var requestsToTrack = this.requests;
                     this.requests = [];
                     if (requestsToTrack.length === 1) {
-                        sendRequest(requestsToTrack[0]);
+                        sendRequest(requestsToTrack[0], configTrackerPause);
                     } else {
-                        sendBulkRequest(requestsToTrack);
+                        sendBulkRequest(requestsToTrack, configTrackerPause);
                     }
                 },
                 push: function (requestUrl) {
                     if (!requestUrl) {
                         return;
                     }
-                    if (isPageUnloading) {
+                    if (isPageUnloading || !this.enabled) {
                         // we don't queue as we need to ensure the request will be sent when the page is unloading...
-                        trackerInstance.trackRequest(requestUrl);
+                        sendRequest(requestUrl, configTrackerPause);
                         return;
                     }
 
-                    this.requests.push(requestUrl);
+                    requestQueue.requests.push(requestUrl);
 
                     if (this.timeout) {
                         clearTimeout(this.timeout);
@@ -5706,9 +5709,6 @@ if (typeof window.Piwik !== 'object') {
                     }
                 }
             };
-
-            /*</DEBUG>*/
-
             /************************************************************
              * Constructor
              ************************************************************/
@@ -5801,6 +5801,12 @@ if (typeof window.Piwik !== 'object') {
             this.getConsentRequestsQueue = function () {
                 return consentRequestsQueue;
             };
+            this.getRequestQueue = function () {
+                return requestQueue;
+            };
+            this.unsetPageIsUnloading = function () {
+                isPageUnloading = false;
+            };
             this.hasConsent = function () {
                 return configHasConsent;
             };
@@ -7347,6 +7353,13 @@ if (typeof window.Piwik !== 'object') {
                 });
             };
 
+            /**
+             * Disables sending requests queued
+             */
+            this.disableQueueRequest = function () {
+                requestQueue.enabled = false;
+            };
+
             /**
              * Won't send the tracking request directly but wait for a short time to possibly send this tracking request
              * along with other tracking requests in one go. This can reduce the number of requests send to your server.