@sapui5/sap.ushell 1.125.0 → 1.126.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sapui5/sap.ushell",
-    "version": "1.125.0",
+    "version": "1.126.0",
     "description": "SAPUI5 Library sap.ushell",
     "homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
     "keywords": [

package/src/main/js/sap/ushell/.library

@@ -2,7 +2,7 @@
 <library xmlns="http://www.sap.com/sap.ui.library.xsd">
     <name>sap.ushell</name>
     <vendor>SAP SE</vendor>
-    <version>1.125.0</version>
+    <version>1.126.0</version>
     <copyright>Copyright (c) 2009-2023 SAP SE, All Rights Reserved</copyright>
     <documentation>SAP library: sap.ushell</documentation>
 

package/src/main/js/sap/ushell/Container.js

@@ -94,6 +94,7 @@ sap.ui.define([
     var mPlatformPackages;
     var aAsyncLogoutEventFunctions = []; //async logout even functions that return a promise
     var oContainerInstance;
+    let aRegisteredLogoutHandlers = [];
 
     // Try to close window. Note: Most browsers do NOT allow closing windows by JS if they were opened manually.
     function closeWindow () {
@@ -1734,6 +1735,7 @@ sap.ui.define([
 
         /**
          * Logs out the current user from all relevant back-end systems, including the logon system itself.
+         * This method also iterates through all registered logout handlers and calls them before continuing with the default logout.
          *
          * @returns {jQuery.Promise} Resolves when logout is finished, even when it fails.
          *
@@ -1744,77 +1746,79 @@ sap.ui.define([
         this.defaultLogout = function () {
             var oDeferred = new jQuery.Deferred();
 
-            function resolve () {
-                oAdapter.logout(true).always(function () {
-                    oLocalStorage.removeItem(sSessionTerminationKey);
-                    oDeferred.resolve();
-                });
-            }
-
-            function logoutLogonSystem () {
-                var oDeferredAsyncLogoutEvent = new jQuery.Deferred();
-                var oPromiseAsyncLogoutEvent = oDeferredAsyncLogoutEvent.promise();
-                var arrLogoutEventsPromises = [];
+            this.callRegisteredLogoutHandlers().then(() => {
+                function resolve () {
+                    oAdapter.logout(true).always(function () {
+                        oLocalStorage.removeItem(sSessionTerminationKey);
+                        oDeferred.resolve();
+                    });
+                }
 
-                if (aAsyncLogoutEventFunctions.length > 0) {
-                    for (var i = 0; i < aAsyncLogoutEventFunctions.length; i++) {
-                        arrLogoutEventsPromises.push(aAsyncLogoutEventFunctions[i]());
-                    }
-                    Promise.all(arrLogoutEventsPromises).then(oDeferredAsyncLogoutEvent.resolve);
+                function logoutLogonSystem () {
+                    var oDeferredAsyncLogoutEvent = new jQuery.Deferred();
+                    var oPromiseAsyncLogoutEvent = oDeferredAsyncLogoutEvent.promise();
+                    var arrLogoutEventsPromises = [];
 
-                    //if after 4 seconds we did not get all the async callbacks
-                    //promises resolved, we will continue with the logout process
-                    setTimeout(oDeferredAsyncLogoutEvent.resolve, 4000);
-                } else {
-                    oDeferredAsyncLogoutEvent.resolve();
-                }
+                    if (aAsyncLogoutEventFunctions.length > 0) {
+                        for (var i = 0; i < aAsyncLogoutEventFunctions.length; i++) {
+                            arrLogoutEventsPromises.push(aAsyncLogoutEventFunctions[i]());
+                        }
+                        Promise.all(arrLogoutEventsPromises).then(oDeferredAsyncLogoutEvent.resolve);
 
-                oPromiseAsyncLogoutEvent.done(function () {
-                    if (oEventProvider.fireEvent("Logout", true)) {
-                        resolve();
+                        //if after 4 seconds we did not get all the async callbacks
+                        //promises resolved, we will continue with the logout process
+                        setTimeout(oDeferredAsyncLogoutEvent.resolve, 4000);
                     } else {
-                        // defer UShell redirect to let NWBC receive message asynchronously
-                        setTimeout(resolve, 1000);
+                        oDeferredAsyncLogoutEvent.resolve();
                     }
-                });
-            }
-
-            function federatedLogout () {
-                var aRemoteLogoutPromises = [];
 
-                if (fnStorageEventListener) {
-                    // IE sends localStorage events also to the issuing window, -
-                    // this is not needed hence we remove the listener in general at that point
-                    window.removeEventListener("storage", fnStorageEventListener);
+                    oPromiseAsyncLogoutEvent.done(function () {
+                        if (oEventProvider.fireEvent("Logout", true)) {
+                            resolve();
+                        } else {
+                            // defer UShell redirect to let NWBC receive message asynchronously
+                            setTimeout(resolve, 1000);
+                        }
+                    });
                 }
 
-                ushellUtils.localStorageSetItem(sSessionTerminationKey, "pending");
-                that._suppressOData();
-                var mSystems = that._getRemoteSystems();
-                Object.keys(mSystems).forEach(function (sAlias) {
-                    try {
-                        aRemoteLogoutPromises.push(
-                            createAdapter("Container", mSystems[sAlias]).logout(false)
-                        );
-                    } catch (e) {
-                        Log.warning("Could not create adapter for " + sAlias,
-                            e.toString(), "sap.ushell.Container");
+                function federatedLogout () {
+                    var aRemoteLogoutPromises = [];
+
+                    if (fnStorageEventListener) {
+                        // IE sends localStorage events also to the issuing window, -
+                        // this is not needed hence we remove the listener in general at that point
+                        window.removeEventListener("storage", fnStorageEventListener);
                     }
-                    oLocalStorage.removeItem(sRemoteSystemPrefix + sAlias);
-                });
-                // wait for all remote system logouts to be finished
-                // Note: We use done() and not always(), and we require all adapters to resolve their logout(false) in any case.
-                // If we use always() and any adapter's promise is rejected, the deferred object from when() is *immediately* rejected, too.
-                // Then the redirect happens before all remote logouts are finished.
-                // TODO force logoutLogonSystem after timeout?
-                jQuery.when.apply(jQuery, aRemoteLogoutPromises).done(logoutLogonSystem);
-            }
 
-            if (typeof oAdapter.addFurtherRemoteSystems === "function") {
-                oAdapter.addFurtherRemoteSystems().always(federatedLogout);
-            } else {
-                federatedLogout();
-            }
+                    ushellUtils.localStorageSetItem(sSessionTerminationKey, "pending");
+                    that._suppressOData();
+                    var mSystems = that._getRemoteSystems();
+                    Object.keys(mSystems).forEach(function (sAlias) {
+                        try {
+                            aRemoteLogoutPromises.push(
+                                createAdapter("Container", mSystems[sAlias]).logout(false)
+                            );
+                        } catch (e) {
+                            Log.warning("Could not create adapter for " + sAlias,
+                                e.toString(), "sap.ushell.Container");
+                        }
+                        oLocalStorage.removeItem(sRemoteSystemPrefix + sAlias);
+                    });
+                    // wait for all remote system logouts to be finished
+                    // Note: We use done() and not always(), and we require all adapters to resolve their logout(false) in any case.
+                    // If we use always() and any adapter's promise is rejected, the deferred object from when() is *immediately* rejected, too.
+                    // Then the redirect happens before all remote logouts are finished.
+                    // TODO force logoutLogonSystem after timeout?
+                    jQuery.when.apply(jQuery, aRemoteLogoutPromises).done(logoutLogonSystem);
+                }
+
+                if (typeof oAdapter.addFurtherRemoteSystems === "function") {
+                    oAdapter.addFurtherRemoteSystems().always(federatedLogout);
+                } else {
+                    federatedLogout();
+                }
+            });
 
             return oDeferred.promise();
         };
@@ -1839,14 +1843,85 @@ sap.ui.define([
          * with an extended SessionHandler function.
          * This is so that we can logout additional systems before we can logout from the Shell.
          * In this case we will register a substitute logout func from the SessionHandler.
+         * Handlers registered through this API need to return a promise that resolves when the logout process is finished.
+         *
          * @param {function} fnLogout function to be set
+         * @returns {boolean} true if the function was successfully registered, false otherwise
          *
          * @since 1.15.0
          * @private
          * @alias sap.ushell.Container#registerLogout
          */
         this.registerLogout = function (fnLogout) {
-            this.logout = fnLogout;
+            if (typeof fnLogout !== "function") {
+                Log.error("Container.registerLogout - Invalid logout handler function.");
+                return false;
+            }
+
+            if (aRegisteredLogoutHandlers.includes(fnLogout)) {
+                Log.warning("Container.registerLogout - This logout handler is already registered. Ignoring.");
+                return false;
+            }
+
+            aRegisteredLogoutHandlers.push(fnLogout);
+            return true;
+        };
+
+        /**
+         * Deregisters a previously registered logout handler function. If the specified handler is not found
+         * in the list of registered handlers, logs an error and returns false to indicate failure.
+         * This ensures that only registered handlers are removed, maintaining the integrity of the logout process.
+         *
+         * @param {function} fnLogout - The logout handler function to deregister.
+         * @returns {boolean} true if the handler was successfully deregistered, false otherwise.
+         * @since 1.126.0
+         * @private
+         * @alias sap.ushell.Container#deRegisterLogout
+         */
+        this.deRegisterLogout = function (fnLogout) {
+            const iIndex = aRegisteredLogoutHandlers.indexOf(fnLogout);
+            if (iIndex === -1) {
+                Log.error("Container.deRegisterLogout - Attempted to de-register a logout handler that was not registered.");
+                return false;
+            }
+            aRegisteredLogoutHandlers.splice(iIndex, 1);
+            return true;
+        };
+
+        /**
+         * Checks if a given logout handler function is currently registered.
+         * This can be used to verify if a specific logout handler has been added to the list of handlers
+         * that will be called during the logout process.
+         *
+         * @param {function} fnLogout - The logout handler function to check.
+         * @returns {boolean} true if the handler is registered, false otherwise.
+         * @since 1.126.0
+         * @private
+         * @alias sap.ushell.Container#isLogoutRegistered
+         */
+        this.isLogoutRegistered = function (fnLogout) {
+            return aRegisteredLogoutHandlers.includes(fnLogout);
+        };
+
+        /**
+         * Calls all registered logout handlers sequentially. If a logout handler throws an error,
+         * the error is logged, and the execution continues with the next handler. This ensures
+         * that all logout handlers are attempted, regardless of individual failures.
+         *
+         * @since 1.126.0
+         * @private
+         * @alias sap.ushell.Container#callRegisteredLogoutHandlers
+         */
+        this.callRegisteredLogoutHandlers = async function () {
+            if (aRegisteredLogoutHandlers.length > 0) {
+                for (const fnLogout of aRegisteredLogoutHandlers) {
+                    try {
+                        await fnLogout();
+                    } catch (error) {
+                        Log.error("Error executing logout handler:", error);
+                    }
+                }
+            }
         };
 
         /**

package/src/main/js/sap/ushell/Fiori20Adapter.js

@@ -5,7 +5,7 @@
  *
  * The Fiori20 adapter automatically re-styles old (Fiori 1) applications to match Fiori2 design requirements.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ui/base/Object",

package/src/main/js/sap/ushell/Fiori20AdapterTest.js

@@ -4,7 +4,7 @@
  * @fileOverview The purpose Fiori20AdapterTest in this file is to decide whether to load the Fiori20Adapter at all.
  * This file is kept small in size on purpose as it is always required in productive code even when Fiori 2 adaptation is not required.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/NWBCInterface.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview NWBCInterface for NWBC client
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ushell/EventHub",

package/src/main/js/sap/ushell/SessionHandler.js

@@ -844,46 +844,50 @@ sap.ui.define([
          *   2. Clear timeouts
          *   3. Show logout message
          *   4. Perform logout via sap.ushell.Container
+         *
+         * @returns {Promise<undefined>} A promise that resolves when the logout process is complete.
          */
         this.logout = function () {
-            Log.debug("SessionHandler.logout :: Logout initiated", "", "SessionHandler");
+            return new Promise(function (resolve) {
+                Log.debug("SessionHandler.logout :: Logout initiated", "", "SessionHandler");
 
-            function _logout (oLoading) {
-                if (bInitialized === true) {
-                    that.detachUserEvents();
-                    that.detachVisibilityEvents();
-                }
-                if (that.oUserActivityTimer) {
-                    clearTimeout(that.oUserActivityTimer);
-                }
-                if (that.remainingTimer) {
-                    clearTimeout(that.remainingTimer);
-                }
-                if (that.notifyServerTimer) {
-                    clearTimeout(that.notifyServerTimer);
+                function _logout (oLoading) {
+                    if (bInitialized === true) {
+                        that.detachUserEvents();
+                        that.detachVisibilityEvents();
+                    }
+                    if (that.oUserActivityTimer) {
+                        clearTimeout(that.oUserActivityTimer);
+                    }
+                    if (that.remainingTimer) {
+                        clearTimeout(that.remainingTimer);
+                    }
+                    if (that.notifyServerTimer) {
+                        clearTimeout(that.notifyServerTimer);
+                    }
+                    oLoading.openLoadingScreen();
+                    oLoading.showAppInfo(oResources.i18n.getText("beforeLogoutMsg"), null);
+                    Container.setDirtyFlag(false);
+                    resolve();
                 }
-                oLoading.openLoadingScreen();
-                oLoading.showAppInfo(oResources.i18n.getText("beforeLogoutMsg"), null);
-                Container.setDirtyFlag(false);
-                Container.defaultLogout();
-            }
 
-            var oLoading = new LoadingDialog({ text: "" });
-            var oTimeout;
+                var oLoading = new LoadingDialog({ text: "" });
+                var oTimeout;
 
-            // post the logout event to isolated
-            PostMessageUtils.postMessageToMultipleIframes("sap.ushell.sessionHandler", "logout", {}, true).then(function () {
-                if (bIsLogoutProcessStarted === false) {
+                // post the logout event to isolated
+                PostMessageUtils.postMessageToMultipleIframes("sap.ushell.sessionHandler", "logout", {}, true).then(async function () {
+                    if (bIsLogoutProcessStarted === false) {
+                        bIsLogoutProcessStarted = true;
+                        window.clearTimeout(oTimeout);
+                        _logout(oLoading);
+                    }
+                });
+
+                oTimeout = window.setTimeout(async function () {
                     bIsLogoutProcessStarted = true;
-                    window.clearTimeout(oTimeout);
                     _logout(oLoading);
-                }
+                }, 4000);
             });
-
-            oTimeout = window.setTimeout(function () {
-                bIsLogoutProcessStarted = true;
-                _logout(oLoading);
-            }, 4000);
         };
     };
 

package/src/main/js/sap/ushell/TechnicalParameters.js

@@ -42,7 +42,7 @@
  * parameters. If the application tries to access an internal parameter (e.g.,
  * sap-ui-app-id-hint) via the API, the application receives an error message.
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/URLTemplateProcessor.js

@@ -26,7 +26,7 @@
  * The language to define parameters in the URL Template parameter set contains a minimal set of conditionals,
  * logical operators, and functions that allow to define the parameter set with a certain degree of control.
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/Ui5NativeServiceFactory.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Ui5 Native Service Factory
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/Ui5ServiceFactory.js

@@ -6,7 +6,7 @@
  * Exposes methods to create a UI5 Service Factory for a specific Unified Shell
  * Service.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/_URLTemplateProcessor/DefinitionParameterSetBuilder.js

@@ -4,7 +4,7 @@
  * @fileOverview Methods to build the set of parameters used by the URL template.
  *
  *
- * @version 1.125.0
+ * @version 1.126.0
  *
  * @private
  *

package/src/main/js/sap/ushell/_URLTemplateProcessor/DependencyGraph.js

@@ -8,7 +8,7 @@
  * The proper order of evaluation can be determined by creating and visiting a graph that represents parameters and depending parameters
  * as nodes. This graph can be also used to detect cyclic references in the parameter set definition.
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/_URLTemplateProcessor/Functions.js

@@ -2,7 +2,7 @@
 
 /**
  * @file Methods to parse and execute functions defined for the URL Template parameter language.
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/_URLTemplateProcessor/Resolvers.js

@@ -5,7 +5,7 @@
  * For a given context (e.g. the reference to a site, the application section from the site, parameters added during runtime, etc),
  * this module can be used to find the values associated to given URL Template parameter names.
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/_URLTemplateProcessor/TemplateParameterParser.js

@@ -34,7 +34,7 @@
  *     }
  *   }
  *   </pre>
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/_URLTemplateProcessor/utils.js

@@ -2,7 +2,7 @@
 
 /**
  * @file Utility functions for modules of <code>URLTemplateProcessor</code>.
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/ClientSideTargetResolutionAdapter.js

@@ -9,7 +9,7 @@
  * <li>provide the resolveHashFragment function, a fallback method called by ClientSideTargetResolution service.</li>
  * </ul>
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/util/Version",

package/src/main/js/sap/ushell/adapters/cdm/CommonDataModelAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's sap.ushell.adapters.cdm.CommonDataModelAdapter for the 'CDM'
  *               platform.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/adapters/cdm/ConfigurationDefaultsAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ConfigurationDefaults adapter for the CDM platform.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ushell/bootstrap/cdm/cdm.constants",

package/src/main/js/sap/ushell/adapters/cdm/ContainerAdapter.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell"s container adapter for the Common Data Model (CDM) platform.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/adapters/cdm/LaunchPageAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's LaunchPageAdapter for the
  *               'CDM' platform - Version 2 (V2)
  * @deprecated since 1.100
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/_LaunchPage/readHome",

package/src/main/js/sap/ushell/adapters/cdm/PagesCommonDataModelAdapter.js

@@ -5,7 +5,7 @@
  * It combines the page data, tile data, navigation data and personalization into a CDM 3.1 site.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/adapters/cdm/PersonalizationAdapter.js

@@ -5,7 +5,7 @@
  *
  *
  * The CDM personalization adapter can be used to store data in the RA@ABAP platform.
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/_Personalization/internals",

package/src/main/js/sap/ushell/adapters/cdm/PersonalizationV2Adapter.js

@@ -5,7 +5,7 @@
  *
  *
  * The CDM personalization adapter can be used to store data in the RA@ABAP platform.
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "./PersonalizationAdapter"

package/src/main/js/sap/ushell/adapters/cdm/Ui5ComponentLoaderAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Ui5ComponentLoaderAdapter for the CDM platform
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/modifyHome.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Helper of modifying the home page data for the 'CDM' platform.
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/readCatalogs.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Helper of accessing catalog data for the 'CDM' platform.
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/readHome.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Helper of accessing Home Page data for the 'CDM' platform.
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/uri.transform.js

@@ -4,7 +4,7 @@
  * @fileOverview Transforms relative URIs as used e.g. for data sources in the
  * manifest.json
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/URI"

package/src/main/js/sap/ushell/adapters/cdm/util/AppForInbound.js

@@ -5,7 +5,7 @@
  * Creates CDM site entries for apps with the provided data.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/util/cdmSiteUtils.js

@@ -5,7 +5,7 @@
  * Creates CDM site entities with the provided data.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/v3/AdapterBase.js

@@ -4,7 +4,7 @@
  * @fileOverview The Base of Unified Shell's LaunchPageAdapter for the 'CDM' platform - Version 3 (V3)
  *   and StaticGroupsContainer for Featured Group
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readHome",