Merge "[FIX] DemoKit: Sequence of tracked events corrected"

Author: kineticjs

src/sap.ui.documentation/src/sap/ui/documentation/sdk/controller/App.controller.js

@@ -255,9 +255,11 @@ sap.ui.define([
 			}.bind(this));
 			this._oCookiesConsentManager.checkUserAcceptsUsageTracking(function(bAccepts) {
 				if (bAccepts) {
-					// start tracking, including the route visited at app-startup (before the check of the persisted consent-decision completed)
-					this.getOwnerComponent().getUsageTracker().start(this._aRouterCachedEventDetails);
-					this._aRouterCachedEventDetails = []; // clear the already logged route visits
+					this._getVersionName().then(function(sVersionName) {
+						// start tracking, including the route visited at app-startup (before the check of the persisted consent-decision completed)
+						this.getOwnerComponent().getUsageTracker().start(sVersionName, this._aRouterCachedEventDetails);
+						this._aRouterCachedEventDetails = []; // clear the already logged route visits
+					}.bind(this));
 				}
 			}.bind(this));
 

src/sap.ui.documentation/src/sap/ui/documentation/sdk/controller/BaseController.js

@@ -286,17 +286,21 @@ sap.ui.define([
 			},
 
 			onEditCookiePreferencesRequest: function () {
-				var oConsentManager = this.getOwnerComponent().getCookiesConsentManager();
+				var oConsentManager = this.getOwnerComponent().getCookiesConsentManager(),
+					oTracker;
+
 				oConsentManager.showPreferencesDialog(this.getView());
 				if (!oConsentManager.supportsWaitForPreferencesSubmission()) {
 					return;
 				}
+				oTracker = this.getOwnerComponent().getUsageTracker();
+
 				oConsentManager.waitForPreferencesSubmission().then(function () {
 					oConsentManager.checkUserAcceptsUsageTracking(function(bAcceptsUsageTracking) {
 						if (bAcceptsUsageTracking) {
-							this.getOwnerComponent().getUsageTracker().start();
+							this._getVersionName().then(oTracker.start.bind(oTracker));
 						} else {
-							this.getOwnerComponent().getUsageTracker().stop();
+							oTracker.stop();
 						}
 					}.bind(this));
 				}.bind(this));
@@ -306,6 +310,13 @@ sap.ui.define([
 				this.getRouter().navTo("PrivacyStatement");
 			},
 
+			_getVersionName: function () {
+				var oComponent = this.getOwnerComponent();
+				return oComponent.loadVersionInfo().then(function() {
+					return oComponent.getModel("versionData").getProperty("/versionName");
+				});
+			},
+
 			_isRouteBypassedEvent: function (oEvent) {
 				return typeof oEvent?.getId === "function" && oEvent.getId() === "bypassed";
 			},

src/sap.ui.documentation/src/sap/ui/documentation/sdk/controller/util/UsageTracker.js

@@ -70,11 +70,11 @@ sap.ui.define(
                     this._oLastRouteParameters = null;
                     this._isStarted = false;
                 },
-                start: function(aRouterEventsToLog) {
+                start: function(sVersionName, aRouterEventsToLog) {
                     if (this._isStarted) {
                         return;
                     }
-                    this._initRemoteServiceConnector();
+                    this._initRemoteServiceConnector(sVersionName);
 
                     this._attachListenersForUserNavigations();
 
@@ -91,10 +91,12 @@ sap.ui.define(
                     this._detachListenersForUserNavigations();
                     Localization.detachChange(this._updateLanguageTag);
                     this._isStarted = false;
+                    this._oLastRouteParameters = null;
                 },
-                _initRemoteServiceConnector: function() {
+                _initRemoteServiceConnector: function(sVersionName) {
                     window.adobeDataLayer = window.adobeDataLayer || [];
-                    this._getSiteName().then(this._logSessionStarted);
+                    var sSiteName = this._getSiteName(sVersionName);
+                    this._logSessionStarted(sSiteName);
                 },
                 _logPrecedingRouteVisits: function(aRouterEventsToLog) {
                     if (aRouterEventsToLog) {
@@ -222,7 +224,7 @@ sap.ui.define(
                     });
                 },
                 _logSessionStarted: function (sSiteName) {
-                    window.adobeDataLayer.push({
+                    this._addToLogs({
                         event: "globalDL",
                         site: {
                             name: sSiteName
@@ -232,8 +234,11 @@ sap.ui.define(
                         }
                     });
                 },
+                _addToLogs: function (oLog) {
+                    window.adobeDataLayer.push(oLog);
+                },
                 _logPageVisit: function (oPageInfo) {
-                    window.adobeDataLayer.push({
+                    this._addToLogs({
                         event: "pageView",
                         page: oPageInfo.toObject()
                     });
@@ -242,7 +247,7 @@ sap.ui.define(
                  * Triggered when router does not find the route
                  */
                 _logPageNotFound: function (sHash) {
-                    window.adobeDataLayer.push({
+                    this._addToLogs({
                         event: "errorPage",
                         page: {
                             name: "notFound",
@@ -273,7 +278,7 @@ sap.ui.define(
                         };
                     }
 
-                    window.adobeDataLayer.push({
+                    this._addToLogs({
                         event: "errorPage",
                         page: {
                             name: "notFound",
@@ -290,7 +295,7 @@ sap.ui.define(
                     this._oLastRouteParameters = null; // clear last route parameters after logging
                 },
                 _publishLoggedInfo: function (bIncrementPageCount) {
-                    window.adobeDataLayer.push({
+                    this._addToLogs({
                         event: bIncrementPageCount
                             ? "stBeaconReady"
                             : "stlBeaconReady"
@@ -299,17 +304,7 @@ sap.ui.define(
                 _updateLanguageTag: function () {
                     oUserLanguageTag = Localization.getLanguageTag();
                 },
-                _getSiteName: function () {
-                    return this._getVersionName().then(function(sVersionName) {
-                        return this._getSiteNameFromVersion(sVersionName);
-                    }.bind(this));
-                },
-                _getVersionName: function () {
-                    return this._oComponent.loadVersionInfo().then(function() {
-                        return this._oComponent.getModel("versionData").getProperty("/versionName");
-                    }.bind(this));
-                },
-                _getSiteNameFromVersion: function (sVersionName) {
+                _getSiteName: function (sVersionName) {
                     if (sVersionName.toLowerCase().startsWith("openui5")) {
                         return SITE_NAME.openui5;
                     } else if (sVersionName.toLowerCase().startsWith("sapui5")) {