@sapui5/sap.ushell 1.115.0 → 1.116.0

package/src/main/js/sap/ushell/services/UITracer.js

@@ -0,0 +1,244 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview The Unified Shell's UI tracing service.
+ *
+ * @version 1.116.0
+ */
+sap.ui.define([
+    "sap/ushell/EventHub",
+    "sap/base/util/isPlainObject",
+    "sap/base/Log"
+],
+    function (
+        EventHub,
+        isPlainObject,
+        Log
+) {
+    ("use strict");
+
+    var MAX_BYTE_SIZE = 0x8000, // 32kB
+        START_BYTE_SIZE = 0x2, // 2 Bytes for an empty array
+        COMMA_SIZE = 1, // 1 Byte to add for size calculation
+        EVENT_NAME = "UITracer.trace";
+
+    /**
+     * This method MUST be called by the Unified Shell's container only, others MUST call
+     * <code>sap.ushell.Container.getServiceAsync("UITracer").then(function (UITracer) {});</code>.
+     * Constructs a new instance of the UITracer service.
+     *
+     * This service adds the capability to pass trace entries from the client to a service endpoint in CEP.
+     * UI traces can be used for metering or usage analysis.
+     * <p>
+     * Besides the trace method the UITracer listens to the EventHub event "UITracerService.trace"
+     * Logging from other modules can be easily done by emitting the event.
+     * <pre>
+     * <code>
+     *  EventHub.emit("UITracerService.trace", {
+     *     thing: "totrace"
+     *  })
+     * </code>
+     * </pre>
+     *
+     * //TODO: For metric relevant trace entries there need to be a special schemaType in the trace entry.
+     *
+     * @namespace sap.ushell.services.UITracer
+     * @class
+     *
+     * @hideconstructor
+     *
+     * @param {object} oContainerInterface Container Interface
+     * @param {string} sParameter Parameter
+     * @param {object} oConfig Config
+     *
+     * @see sap.ushell.services.Container#getServiceAsync
+     * @since 1.116.0
+     * @private
+     */
+    function UITracer (oContainerInterface, sParameter, oConfig) {
+        this._sServiceUrl = oConfig.serviceUrl || "/ui-trace/v1";
+        this._resetTrace();
+        this._attachBrowserEvents();
+        this._attachEventHubEvents();
+    }
+
+    /**
+     * Traces the given object and passes it on to the server
+     * if window is closed or log size limit is reached.
+     *
+     * @param {object} oEntry The trace entry.
+     *
+     * @private
+     * @since 1.116.0
+     */
+    UITracer.prototype.trace = function (oEntry) {
+        this._addEntry(oEntry);
+    };
+
+    /**
+     * Resets the trace list, size and
+     *
+     * @private
+     * @since 1.116.0
+     */
+    UITracer.prototype._resetTrace = function () {
+        this._aTrace = [];
+        this._iSize = START_BYTE_SIZE;
+    };
+
+    /**
+     * Adds a clone of the entry to the trace and calculates the size.
+     * If, by adding, the size of the trace (32kB) would be succeeded, the trace is send.
+     * Additional attributes are added to the clone:
+     *   _ts: Current timestamp.
+     * @param {object} oEntry The trace entry.
+     * @returns {boolean} true if the entry was added, otherwise false.
+     *
+     * @private
+     * @since 1.116.0
+     */
+    UITracer.prototype._addEntry = function (oEntry) {
+        if (isPlainObject(oEntry) && Object.keys(oEntry).length > 0) {
+            try {
+                var oTraceEntry = this._createTraceEntry(oEntry),
+                    iEntrySize =
+                        this._getBlob(oTraceEntry).size + COMMA_SIZE;
+                if (this._iSize + iEntrySize > MAX_BYTE_SIZE) {
+                    this._sendTrace();
+                }
+                this._iSize += iEntrySize;
+                this._aTrace.push(oTraceEntry);
+                Log.debug(
+                    "UITracer: Trace entry added with size " + iEntrySize,
+                    oTraceEntry,
+                    "sap.ushell.services.UITracer"
+                );
+                return true;
+            } catch (ex) {
+                return false;
+            }
+        }
+        return false;
+    };
+
+    /**
+     * Creates a trace entry with additional technical fields in a clone of the given entry.
+     * @param {object} oEntry The original entry
+     * @returns {object} the trace entry with technical fields
+     *
+     * @private
+     * @since 1.116.0
+     */
+    UITracer.prototype._createTraceEntry = function (oEntry) {
+        var oTraceEntry = JSON.parse(JSON.stringify(oEntry));
+        oTraceEntry._ts = Date.now();
+        return oTraceEntry;
+    };
+
+    /**
+     * Sends the trace to the serviceUrl given by the configuration.
+     * Request is only sent if the trace is not empty.
+     *
+     * sendBeacon method of the browser is used to send the request.
+     * Beacon request are POST request and have a size limit of 64kB.
+     * UITracer uses half that size, see MAX_BYTE_SIZE.
+     *
+     * @param {object} oEntry The trace entry.
+     *
+     * @private
+     * @since 1.116.0
+     */
+    UITracer.prototype._sendTrace = function () {
+        if (this._aTrace.length > 0) {
+            var oBlob = this._getBlob(this._aTrace);
+            try {
+                window.navigator.sendBeacon(this._sServiceUrl, oBlob);
+                Log.debug(
+                    "UITracer: Trace sent to " +
+                        this._sServiceUrl +
+                        "with size " +
+                        oBlob.size +
+                        " byte",
+                    this._aTrace,
+                    "sap.ushell.services.UITracer"
+                );
+            } catch (ex) {
+                Log.debug(
+                    "UITracer: Trace could not be sent to " +
+                        this._sServiceUrl +
+                        "with size " +
+                        oBlob.size +
+                        " byte",
+                    this._aTrace,
+                    "sap.ushell.services.UITracer"
+                );
+            }
+        }
+        this._resetTrace();
+    };
+
+    /**
+     * Creates an application/json Blob from a given parameter
+     *
+     * @param {object|string} vValue A serializable js object or string.
+     * @returns {Blob} The Blob representation of oEntry or null
+     *
+     * @private
+     * @since 1.116.0
+     */
+    UITracer.prototype._getBlob = function (vValue) {
+        if (isPlainObject(vValue) || Array.isArray(vValue)) {
+            vValue = JSON.stringify(vValue);
+        }
+        if (typeof vValue === "string") {
+            return new Blob([vValue], {
+                type: "application/json"
+            });
+        }
+        return null;
+    };
+
+    /**
+     * Attaches to handlers to visibilitychange or alternatively to beforeunload browser events.
+     *
+     * @private
+     * @since 1.116.0
+     */
+    UITracer.prototype._attachBrowserEvents = function () {
+        // ensure to send the trace if page is closed
+        if (document.visibilityState) {
+            document.addEventListener(
+                "visibilitychange",
+                function () {
+                    if (document.visibilityState === "hidden") {
+                        this._sendTrace();
+                    }
+                }.bind(this)
+            );
+        } else {
+            window.addEventListener(
+                "beforeunload",
+                function () {
+                    this._sendTrace();
+                }.bind(this)
+            );
+        }
+    };
+
+    /**
+     * Attaches to the EventHub "UITracerService.trace" event
+     *
+     * @private
+     * @since 1.116.0
+     */
+    UITracer.prototype._attachEventHubEvents = function () {
+        EventHub.on(EVENT_NAME).do(
+            function (oEntry) {
+                this.trace(oEntry);
+            }.bind(this)
+        );
+    };
+
+    UITracer.hasNoAdapter = true;
+    return UITracer;
+}, true /* bExport */);

package/src/main/js/sap/ushell/services/URLParsing.js

@@ -31,7 +31,9 @@ sap.ui.define([
     //         etc.
 
     /**
-     * The Unified Shell's internal URL parsing service (platform independent)
+     * @alias sap.ushell.services.URLParsing
+     * @class
+     * @classdesc The Unified Shell's internal URL parsing service (platform independent)
      * This method MUST be called by the Unified Shell's container only, others MUST call
      * <code>sap.ushell.Container.getServiceAsync("URLParsing").then(function (URLParsing) {});</code>.
      * Constructs a new instance of the URL parsing service.
@@ -51,9 +53,8 @@ sap.ui.define([
      * behavior for non-compliant hashes is undefined and subject to change,
      * notably we do not aim do "degrade" nicely or support partial parsing of corrupted urls.
      *
-     * @name sap.ushell.services.URLParsing
-     * @constructor
-     * @class
+     * @hideconstructor
+     *
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.15.0
      * @public
@@ -263,10 +264,8 @@ sap.ui.define([
 
         /**
          * compose a shell Hash from it's respective parts
-         * Note that it also may append an app specific route !
+         * Note that it also may append an app specific route!
          *
-         * @returns {string} the hash part of an URL, e.g. <code>"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH</code>
-         *   returns "" for an undefined object
          * @param {object} oShellHash The action must be a valid action, it may not contain "?" or directly a parameter string
          *   <code>undefined</code> if not a parsable hash
          * <pre>
@@ -284,6 +283,10 @@ sap.ui.define([
          *   xor
          *   <code>{ target: { shellHash } }</code>
          *   Note: in general it is preferred to add an appStateKey directly to the params object
+         *
+         * @returns {string} the hash part of an URL, e.g. <code>"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH</code>
+         *   returns "" for an undefined object
+         *
          * @since 1.16.0
          * @public
          * @alias sap.ushell.services.URLParsing#constructShellHash

package/src/main/js/sap/ushell/services/URLShortening.js

@@ -6,7 +6,7 @@
  * Service wrapper for the sap/ushell/utils/UrlShortening module.
  * Deprecated. Please use the UrlShortening module directly.
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
  sap.ui.define(["sap/ushell/utils/UrlShortening"], function (UrlShortening) {
     "use strict";

package/src/main/js/sap/ushell/services/URLTemplate.js

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview The URLTemplate service provides utilities when working with URL templates
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/services/Ui5ComponentLoader.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's UI5 component loader service.
  * This is a shell-internal service and no public or application facing API!
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/ushell/Config",

package/src/main/js/sap/ushell/services/UsageAnalytics.js

@@ -16,6 +16,9 @@ sap.ui.define([
     "use strict";
 
     /**
+     * @alias sap.ushell.services.UsageAnalytics
+     * @class
+     * @classdesc A UShell service for tracking business flows and user actions.
      * The UsageAnalytics service exposes API for logging custom events and setting custom field values in the logged events.<br>
      * The data is sent via http and recorded on a server, whose URL is defined by the <code>baseUrl</code> service configuration property.<br>
      * The service configuration must also include the site ID from the <code>pubToken</code> attribute.<br>
@@ -32,12 +35,12 @@ sap.ui.define([
      * Each tracked event (either automatic or custom) is represented by a database row, that includes 10 custom attributes named custom1...custom10.<br>
      * Some of these values can be set using UsageAnalytics service API.<br>
      *
-     * @name sap.ushell.services.UsageAnalytics
-     * @class A UShell service for tracking business flows and user actions.
+     * @hideconstructor
+     *
      * @param {object} oContainerInterface The interface provided by the container
      * @param {object} sParameter Not used in this service
      * @param {object} oServiceProperties Service configuration
-     * @constructor
+     *
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.32.0
      * @public

package/src/main/js/sap/ushell/services/UserDefaultParameterPersistence.js

@@ -14,7 +14,7 @@
  *
  * This is *not* an application facing service, but for Shell Internal usage.
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/UserDefaultParameters.js

@@ -7,7 +7,7 @@
  *               This service should be accessed by the application
  *               via the CrossApplicationNavigation service.
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -181,23 +181,26 @@ sap.ui.define([
          *
          * @since 1.32.0
          */
-        this._iterateOverPluginsToGetDefaultValue = function (sParameterName, oStartValue, oSystemContext, oPluginManagerService) {
+        this._iterateOverPluginsToGetDefaultValue = function (sParameterName, oStartValue, oSystemContext) {
             // Main promise chain construction: a plugin will only be called once the previous one's promise has resolved
             // so that we have access to the value returned by that promise.
             return new Promise(function (resolve, reject) {
-                oPluginManagerService.loadPlugins("UserDefaults")
-                    .done(function () {
-                        var oPluginPromiseChain = this._aPlugins.reduce(function (oChain, oPlugin) {
-                            var oExtendedChain = oChain.then(this._getUserDefaultValueFromPlugin.bind(this, oPlugin, sParameterName, oSystemContext /*oValue - resolved value*/));
-                            return oExtendedChain;
-                        }.bind(this), Promise.resolve(oStartValue));
-
-                        oPluginPromiseChain.then(resolve);
-                    }.bind(this))
-                    .fail(function () {
-                        Log.error("Cannot get value for " + sParameterName + ". One or more plugins could not be loaded.");
-                        reject("Initialization of plugins failed");
-                    });
+                sap.ushell.Container.getServiceAsync("PluginManager")
+                .then(function (oPluginManagerService) {
+                    oPluginManagerService.loadPlugins("UserDefaults")
+                        .done(function () {
+                            var oPluginPromiseChain = this._aPlugins.reduce(function (oChain, oPlugin) {
+                                var oExtendedChain = oChain.then(this._getUserDefaultValueFromPlugin.bind(this, oPlugin, sParameterName, oSystemContext /*oValue - resolved value*/));
+                                return oExtendedChain;
+                            }.bind(this), Promise.resolve(oStartValue));
+
+                            oPluginPromiseChain.then(resolve);
+                        }.bind(this))
+                        .fail(function () {
+                            Log.error("Cannot get value for " + sParameterName + ". One or more plugins could not be loaded.");
+                            reject("Initialization of plugins failed");
+                        });
+                    }.bind(this));
             }.bind(this));
         };
 
@@ -499,18 +502,7 @@ sap.ui.define([
                         return;
                     }
 
-                    return Promise.all([
-                        oValueClone,
-                        oPersistedValue,
-                        sap.ushell.Container.getServiceAsync("PluginManager")
-                    ]);
-                }.bind(this))
-                .then(function (aValues) {
-                    var oValueClone = aValues[0];
-                    var oPersistedValue = aValues[1];
-                    var oPluginManagerService = aValues[2];
-
-                    return this._iterateOverPluginsToGetDefaultValue(sParameterName, oPersistedValue, oSystemContext, oPluginManagerService)
+                    return this._iterateOverPluginsToGetDefaultValue(sParameterName, oPersistedValue, oSystemContext)
                         .then(function (oNewValue) {
                             if (!this._oWasParameterPersisted[sParameterName] || !this._haveSameMembersValue(oValueClone, oNewValue, aStoreMembers)) {
                                 // avoid multiple calls result in storing a parameter, as we fire and forget via _storeValue below.

package/src/main/js/sap/ushell/services/UserInfo.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's user information service, which allows you to retrieve
  *     information about the user.
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -17,19 +17,20 @@ sap.ui.define([
 ) {
     "use strict";
     /**
-     * This method MUST be called by the Unified Shell's container only, others MUST call
+     * @alias sap.ushell.services.UserInfo
+     * @class
+     * @classdesc This method MUST be called by the Unified Shell's container only, others MUST call
      * <code>sap.ushell.Container.getServiceAsync("UserInfo").then(function (UserInfo) {});</code>.
      * Constructs a new instance of the user information service.
      *
      * The Unified Shell's user information service, which allows you to retrieve
      *     information about the logged-in user.
      *
-     * @name sap.ushell.services.UserInfo
+     * @hideconstructor
+     *
      * @param {object} oAdapter Adapter
      * @param {object} oContainerInterface interface
      *
-     * @constructor
-     * @class
      * @see sap.ushell.services.Container#getServiceAsync
      * @since 1.16.3
      *

package/src/main/js/sap/ushell/services/UserRecents.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's user activity service.
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/ui/base/Object",

package/src/main/js/sap/ushell/services/VisualizationDataProvider.js

@@ -2,7 +2,7 @@
 
 /**
  * @file deals with the retrieval of visualization data in a platform independent way.
- * @version 1.115.0
+ * @version 1.116.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/services/VisualizationInstantiation.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module deals with the instantiation of visualizations in a platform independent way.
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/ushell/services/_VisualizationInstantiation/VizInstance",

package/src/main/js/sap/ushell/services/_AppState/AppStatePersistencyMethod.js

@@ -1,6 +1,16 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-
-sap.ui.define([], function () {
+/**
+ * Copy of sap/ushell/services/appstate/AppStatePersistencyMethod
+ *
+ * Only used by sap/cf/adapters/AppStateAdapter
+ *
+ * @deprecated since 1.116
+ */
+sap.ui.define([
+    "sap/base/Log"
+], function (
+    Log
+) {
     "use strict";
 
     function AppStatePersistencyMethod () {
@@ -9,6 +19,7 @@ sap.ui.define([], function () {
         this.PublicState = "PublicState";
         this.AuthorizationProtectedState = "AuthorizationProtectedState";
     }
+    Log.error("sap/ushell/services/_AppState/AppStatePersistencyMethod is deprecated and will be removed in an upcoming release!");
 
     return new AppStatePersistencyMethod();
 });

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/Formatter.js

@@ -13,7 +13,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/InboundIndex.js

@@ -27,7 +27,7 @@
  *
  * @private
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
 "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/InboundProvider.js

@@ -34,7 +34,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/ushell/services/_ClientSideTargetResolution/VirtualInbounds",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/PrelaunchOperations.js

@@ -4,7 +4,7 @@
  * @file PrelaunchOperations are executed just before launching the application (post parameter mapping and app state merging) if the
  * <code>sap-prelaunch-operations</code> parameter is specified as a technical parameter.
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/Search.js

@@ -8,7 +8,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/StagedLogger.js

@@ -39,7 +39,7 @@
  *
  * This is a dependency of ClientSideTargetResolution. Interfaces exposed by this module may change at any time without notice.
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/SystemContext.js

@@ -8,7 +8,7 @@
  * <p>This is a dependency of ClientSideTargetResolution. Interfaces exposed
  * by this module may change at any time without notice.</p>
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/Utils.js

@@ -6,7 +6,7 @@
  * This is a dependency of ClientSideTargetResolution.
  * Interfaces exposed by this module may change at any time without notice.
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/base/util/deepExtend"

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/VirtualInbounds.js

@@ -12,7 +12,7 @@
  * <p>This is a dependency of ClientSideTargetResolution.  Interfaces
  * exposed by this module may change at any time without notice.</p>
  *
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([], function () {
     "use strict";

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/XAppStateProcessing.js

@@ -6,7 +6,7 @@
  * Operations in this module are assumed to be executed after the target mapping has been identified (post search).
  *
  * @private
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/services/_CommonDataModel/SiteConverter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Because the personalization processor only works with a CDM 3.0 site, this converter is used to transform a dedicated
  * CDM 3.1 site object into a CDM 3.0 site and backwards.
- * @version 1.115.0
+ * @version 1.116.0
  */
 sap.ui.define([
     "sap/base/Log"

package/src/main/js/sap/ushell/services/_ContentExtensionAdapterFactory/ContentExtensionAdapterConfig.js

@@ -7,7 +7,7 @@
  *  config handler which is called by the factory to generate an explicit
  *  Adapter configuration
  *
- * @version 1.115.0
+ * @version 1.116.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_ContentExtensionAdapterFactory/FeaturedGroupConfig.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Provide mock feature group data
  *
- * @version 1.115.0
+ * @version 1.116.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_CrossApplicationNavigation/utils.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Cross Application Navigation utility functions
  *
- * @version 1.115.0
+ * @version 1.116.0
  */