@sapui5/sap.ushell 1.115.1 → 1.117.0

package/src/main/js/sap/ushell/renderers/fiori2/Shell.controller.js

@@ -19,7 +19,6 @@ sap.ui.define([
     "sap/ui/thirdparty/hasher",
     "sap/ui/thirdparty/jquery",
     "sap/ui/util/Storage",
-    "sap/ushell/ApplicationType",
     "sap/ushell/bootstrap/SchedulingAgent",
     "sap/ushell/components/_HeaderManager/ControlManager",
     "sap/ushell/components/applicationIntegration/AppLifeCycle",
@@ -35,7 +34,9 @@ sap.ui.define([
     "sap/ushell/UserActivityLog",
     "sap/ushell/utils",
     "sap/ushell/utils/WindowUtils",
-    "sap/ushell/renderers/fiori2/ShellLayout"
+    "sap/ushell/renderers/fiori2/ShellLayout",
+    "sap/ushell/renderers/fiori2/utils",
+    "sap/base/util/ObjectPath"
 ], function (
     History,
     Log,
@@ -55,7 +56,6 @@ sap.ui.define([
     hasher,
     jQuery,
     Storage,
-    ApplicationType,
     SchedulingAgent,
     HeaderControlManager,
     AppLifeCycleAI,
@@ -71,7 +71,9 @@ sap.ui.define([
     UserActivityLog,
     utils,
     WindowUtils,
-    ShellLayout
+    ShellLayout,
+    RendererUtils,
+    ObjectPath
 ) {
     "use strict";
 
@@ -213,8 +215,6 @@ sap.ui.define([
         },
 
         onInit: function () {
-            var that = this;
-
             var oRouter = Component.getOwnerComponentFor(this.getView()).getRouter();
 
             // TODO We still need to think about implementing a custom router to move the display handler from
@@ -248,10 +248,6 @@ sap.ui.define([
             var mediaQ = window.matchMedia("(min-width: 600px)");
             var oViewConfig = oViewData.config || {};
 
-            // The configuration is set by modifying the target `Shell-bootConfig` in the respective system,
-            // such that if GUI applications (of type 'TR') should reuse an existing container if any,
-            // then the parameter `renderers/fiori2/componentData/config/statefulApplicationContainer/GUI` must be set to `true`.
-            AppLifeCycleAI.parseStatefulContainerConfiguration(oViewConfig.statefulApplicationContainer);
             var oApplicationModel = AppLifeCycleAI.shellElements().model();
             HeaderManager.init(oViewConfig, oApplicationModel);
 
@@ -311,26 +307,7 @@ sap.ui.define([
 
                 this.oShellNavigation.registerNavigationFilter(this.handleDataLoss.bind(this));
 
-                this.oShellNavigation.hashChanger.attachEvent("hashChanged", function (oHashChange) {
-                    //FIX for internal incident #1980317281 - In general, hash structure in FLP is splitted into 3 parts:
-                    //A - application identification & B - Application parameters & C - Internal application area
-                    // Now, when an IFrame changes its hash, it sends PostMessage up to the FLP. The FLP does 2 things: Change its URL
-                    // and send a PostMessage back to the IFrame. This fix, initiated in the PostMessageAPI.js, blocks only
-                    // the message back to the IFrame.
-                    if (window.hasher.disableBlueBoxHashChangeTrigger === true) {
-                        return;
-                    }
-                    if (oHashChange.mParameters && that.oShellNavigation.hashChanger.isInnerAppNavigation(oHashChange.mParameters.newHash, oHashChange.mParameters.oldHash)) {
-                        AppLifeCycleAI.postMessageToIframeApp("sap.ushell.appRuntime", "innerAppRouteChange", {
-                            oHash: oHashChange.mParameters
-                        });
-                    }
-
-                    AppLifeCycleAI.postMessageToIframeApp("sap.ushell.appRuntime", "hashChange", {
-                        sHash: oHashChange.mParameters.fullHash
-                    });
-                });
-
+                AppLifeCycleAI.registerHandleHashChange(this.oShellNavigation);
                 // enable the direct app start and tests to wait for the initialization
                 EventHub.emit("ShellNavigationInitialized");
             }.bind(this);
@@ -360,7 +337,7 @@ sap.ui.define([
                 if (sap.ushell.Container && sap.ushell.Container.getDirtyFlag()
                     // workaround: skip data-loss-warning in IE when app is NWBC-based (as there is a separate implementation)
                     && !(Device.browser.name === Device.browser.BROWSER.INTERNET_EXPLORER
-                        && AppLifeCycleAI.getCurrentApplication().container.getApplicationType() === ApplicationType.NWBC.type)
+                        && AppLifeCycleAI.getCurrentApplication().container.getApplicationType() === "NWBC")
                 ) {
                     if (!ushellResources.browserI18n) {
                         ushellResources.browserI18n = ushellResources.getTranslationModel(window.navigator.language).getResourceBundle();
@@ -636,7 +613,6 @@ sap.ui.define([
             UserActivityLog.deactivate();
             oShellModel.destroy();
             AppLifeCycleAI.shellElements().clean();
-            AppLifeCycleAI.destroy();
             oShellModel = undefined;
         },
 
@@ -863,11 +839,6 @@ sap.ui.define([
             // eslint-disable-next-line no-alert
             if (window.confirm(ushellResources.i18n.getText("dataLossInternalMessage"))) {
                 sap.ushell.Container.setDirtyFlag(false);
-
-                AppLifeCycleAI.postMessageToIframeApp("sap.ushell.appRuntime", "setDirtyFlag", {
-                    bIsDirty: false
-                });
-
                 if (RelatedServices.isBackNavigation() === true) {
                     RelatedServices.resetBackNavigationFlag();
                 }
@@ -1200,15 +1171,9 @@ sap.ui.define([
                             }
                             if (bComponentLoaded || !sTargetUi5ComponentName) {
                                 var oDeferredAppDestroy = new jQuery.Deferred();
-                                if ((oResolvedHashFragment.applicationType === "URL"
-                                    || oResolvedHashFragment.applicationType === "GUI"
-                                    || oResolvedHashFragment.applicationType === "TR"
-                                    || oResolvedHashFragment.applicationType === "NWBC"
-                                    || oResolvedHashFragment.applicationType === "WDA"
-                                    || oResolvedHashFragment.applicationType === "WCF")
-                                    //&& oResolvedHashFragment.appCapabilities && oResolvedHashFragment.appCapabilities.appFrameworkId === "UI5" &&
+                                if ((oResolvedHashFragment.applicationType === "URL" || utils.isSAPLegacyApplicationType(oResolvedHashFragment.applicationType))
                                     && oInMemoryApplicationInstance.isInstanceSupported === false && oInMemoryApplicationInstance.appId) {
-                                    AppLifeCycleAI.destroy(
+                                    AppLifeCycleAI.destroyApplication(
                                         oInMemoryApplicationInstance.appId, oInMemoryApplicationInstance.container, oDeferredAppDestroy
                                     );
                                 } else {
@@ -1223,8 +1188,7 @@ sap.ui.define([
                                 });
                                 return;
                             }
-                            AppLifeCycleAI.destroy(oInMemoryApplicationInstance.appId, oInMemoryApplicationInstance.container);
-
+                            AppLifeCycleAI.destroyApplication(oInMemoryApplicationInstance.appId, oInMemoryApplicationInstance.container);
                             AppLifeCycleAI.removeApplication(sIntent);
                             AppConfiguration.setApplicationInInitMode();
 
@@ -1261,9 +1225,9 @@ sap.ui.define([
                                             message: ushellResources.i18n.getText("failed_to_open_ui5_component"),
                                             technicalMessage: sErrorReasonEnglish
                                         }, {
-                                        info: sErrorReason,
-                                        technicalMessage: vError.message + "\n" + vError.stack
-                                    },
+                                            info: sErrorReason,
+                                            technicalMessage: vError.message + "\n" + vError.stack
+                                        },
                                         "sap.ushell.renderers.fiori2.Shell.controller",
                                         false);
                                 });
@@ -1433,12 +1397,12 @@ sap.ui.define([
             if (window["sap-ushell-async-libs-promise-directstart"]) {
                 window["sap-ushell-async-libs-promise-directstart"]
                     .then(function (oDirectstartPromiseResult) {
-                        oDeferred.resolve(
-                            oDirectstartPromiseResult.resolvedHashFragment,
-                            oParsedShellHash
-                        );
-                        delete window["sap-ushell-async-libs-promise-directstart"];
-                    },
+                            oDeferred.resolve(
+                                oDirectstartPromiseResult.resolvedHashFragment,
+                                oParsedShellHash
+                            );
+                            delete window["sap-ushell-async-libs-promise-directstart"];
+                        },
                         function (sMsg) {
                             oDeferred.reject(sMsg);
                             delete window["sap-ushell-async-libs-promise-directstart"];
@@ -1721,8 +1685,7 @@ sap.ui.define([
                                 return aAppStateKeysArray;
                             };
 
-                            if (sAppType === "GUI" || sAppType === "TR" || sAppType === "NWBC" || sAppType === "WDA" || sAppType === "WCF" ||
-                                sFrameworkId === "GUI" || sFrameworkId === "WDA" || sFrameworkId === "NWBC" || sFrameworkId === "WCF") {
+                            if (utils.isSAPLegacyApplicationType(sAppType, sFrameworkId)) {
                                 sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then(function (oCrossAppNavService) {
                                     aKeysArray = getParamKeys(sUrlWithSapUserAndShellParam, aInfoArray);
                                     if (aKeysArray.length > 0) {
@@ -1861,7 +1824,8 @@ sap.ui.define([
         _handleEmbeddedNavMode: function (sFixedShellHash, oParsedShellHash, oMetadata, oResolvedHashFragment, sOldFixedShellHash) {
             // Performance Debug
             Measurement.start("FLP:ShellController._handleEmbeddedNavMode", "_handleEmbeddedNavMode", "FLP");
-            var oConfig = this._getConfig();
+            var that = this,
+                oConfig = this._getConfig();
 
             this.resetShellUIServiceHandlers();
 
@@ -1891,6 +1855,9 @@ sap.ui.define([
                 AppLifeCycleAI.getShellUIService().setBackNavigation();
             }
 
+            // adding intent as this published application info is required for the contact-support scenario
+            oResolvedHashFragment.sFixedShellHash = sFixedShellHash;
+
             var oHandlerPromise = AppLifeCycleAI.handleControl(
                 sIntent,
                 sAppId,
@@ -1902,10 +1869,16 @@ sap.ui.define([
             );
 
             if (this.currentAppBeforeNav) {
-                var oPreviousStatefulContainer;
-                oPreviousStatefulContainer = AppLifeCycleAI.getWebGuiV1StatefulContainer(this.currentAppBeforeNav.url);
-                if (oPreviousStatefulContainer) {
-                    oPreviousStatefulContainer.onApplicationOpened(oResolvedHashFragment.applicationType);
+                if (utils.isTRApplicationType(this.currentAppBeforeNav.applicationType, ObjectPath.get("appCapabilities.appFrameworkId", this.currentAppBeforeNav)) &&
+                    !utils.isTRApplicationType(oResolvedHashFragment.applicationType)) {
+                    sap.ui.require([
+                        "sap/ushell/components/applicationIntegration/application/BlueBoxHandler",
+                        "sap/ushell/components/applicationIntegration/application/WebGUIStatefulHandler"], function (BlueBoxHandler, WebGUIStatefulHandler) {
+                        var oPreviousStatefulContainer = BlueBoxHandler.getBlueBoxByUrl(that.currentAppBeforeNav.url);
+                        if (oPreviousStatefulContainer && oPreviousStatefulContainer.getStatefulType() === BlueBoxHandler.STATEFUL_TYPES.GUI_V1) {
+                            WebGUIStatefulHandler.guiStatefulCloseCurrentApp(oPreviousStatefulContainer);
+                        }
+                    });
                 }
             }
 
@@ -1952,35 +1925,36 @@ sap.ui.define([
             }
 
             var oAppContainer = AppLifeCycleAI.getAppContainer(sAppId, oResolvedNavigationTarget, this._isColdStart(), oShellHash, sFixedShellHash);
+            var bContainerFromCachePool = false;
+            if (oAppContainer.getIsFetchedFromCache && oAppContainer.getIsFetchedFromCache()) {
+                bContainerFromCachePool = true;
+            }
 
-            // adding intent as this published application info is required for the contact-support scenario
-            oResolvedNavigationTarget.sFixedShellHash = sFixedShellHash;
-            AppLifeCycleAI.publishNavigationStateEvents(oAppContainer, oResolvedNavigationTarget, this.onAppAfterRendering.bind(this, oResolvedNavigationTarget));
+            if (!bContainerFromCachePool) {
+                AppLifeCycleAI.publishNavigationStateEvents(oAppContainer, oResolvedNavigationTarget, this.onAppAfterRendering.bind(this, oResolvedNavigationTarget));
 
-            var sAppType = oAppContainer.getApplicationType();
-            var sFrameworkId = oAppContainer.getFrameworkId();
-            if (sAppType === "GUI" || sAppType === "TR" || sAppType === "WDA" || sAppType === "NWBC" || sAppType === "WCF" ||
-                sFrameworkId === "GUI" || sFrameworkId === "WDA" || sFrameworkId === "NWBC" || sFrameworkId === "WCF") {
-                oAppContainer.addStyleClass("sapUShellApplicationContainerShiftedIframe");
-            }
+                if (utils.isSAPLegacyApplicationType(oAppContainer.getApplicationType(), oAppContainer.getFrameworkId())) {
+                    oAppContainer.addStyleClass("sapUShellApplicationContainerShiftedIframe");
+                }
 
-            if (!bFullWidth) {
-                oAppContainer.addStyleClass("sapUShellApplicationContainerLimitedWidth");
-            }
+                if (!bFullWidth) {
+                    oAppContainer.addStyleClass("sapUShellApplicationContainerLimitedWidth");
+                }
 
-            if (this._isFloatingContainerDocked() && window.matchMedia("(min-width: 106.4rem)").matches) {
-                oAppContainer.addStyleClass("sapUShellDockingContainer");
-                oAppContainer.removeStyleClass("sapUShellApplicationContainerLimitedWidth");
-            } else if (this._isFloatingContainerDocked()) {
-                oAppContainer.removeStyleClass("sapUShellApplicationContainerLimitedWidth");
-            }
+                if (this._isFloatingContainerDocked() && window.matchMedia("(min-width: 106.4rem)").matches) {
+                    oAppContainer.addStyleClass("sapUShellDockingContainer");
+                    oAppContainer.removeStyleClass("sapUShellApplicationContainerLimitedWidth");
+                } else if (this._isFloatingContainerDocked()) {
+                    oAppContainer.removeStyleClass("sapUShellApplicationContainerLimitedWidth");
+                }
 
-            oAppContainer.toggleStyleClass("sapUshellDefaultBackground", !oMetadata.hideLightBackground);
+                oAppContainer.toggleStyleClass("sapUshellDefaultBackground", !oMetadata.hideLightBackground);
 
-            AppLifeCycleAI.getAppMeta()._applyContentDensityByPriority();
+                AppLifeCycleAI.getAppMeta()._applyContentDensityByPriority();
 
-            // Add inner control for next request
-            AppLifeCycleAI.addControl(oAppContainer);
+                // Add inner control for next request
+                AppLifeCycleAI.addControl(oAppContainer);
+            }
 
             utils.setPerformanceMark("FLP - addAppContainer");
 
@@ -2008,7 +1982,7 @@ sap.ui.define([
 
             // Event is emitted internally (EventHub) _and_ externally (for compatibility reasons)
             EventHub.emit("AppRendered", oAppOpenedEventData, true);
-            sap.ushell.renderers.fiori2.utils.publishExternalEvent("appOpened", oAppOpenedEventData);
+            RendererUtils.publishExternalEvent("appOpened", oAppOpenedEventData);
             utils.setPerformanceMark("FLP.appOpened");
 
             // Call setHierarchy, setTitle, setRelatedApps with default values in case handlers were not called yet
@@ -2081,9 +2055,6 @@ sap.ui.define([
                 // navigate to the previous URL since in this state the hash that has failed to load is in the URL.
                 this.bEnableHashChange = bEnableHashChange;
                 sap.ushell.Container.setDirtyFlag(bPreviousPageDirty);
-                AppLifeCycleAI.postMessageToIframeApp("sap.ushell.appRuntime", "setDirtyFlag", {
-                    bIsDirty: bPreviousPageDirty
-                });
                 this._windowHistoryBack(1);
             }
         },
@@ -2164,6 +2135,8 @@ sap.ui.define([
             var sAppPart = sAppHash ? "&/" + sAppHash : null;
 
             this.logOpenAppAction(oResolvedHashFragment, sAppPart);
+
+            this._notifyUITracer(oResolvedHashFragment);
         },
 
         externalSearchTriggered: function (sChannelId, sEventId, oData) {
@@ -2244,13 +2217,44 @@ sap.ui.define([
             }
 
             // The recent activity for searches is done in a different way, see this._logSearchActivity
-            if (sFixedShellHash && sFixedShellHash.indexOf("#Action-search") === -1) {
+            if (sFixedShellHash && sFixedShellHash.indexOf("#Action-search") === -1 && sFixedShellHash.indexOf("#Shell-startIntent") === -1) {
                 window.setTimeout(function () {
                     this._logRecentActivity(oRecentEntry);
                 }.bind(this), 1500);
             }
         },
 
+        /**
+         * Notifies the UITracer service about the navigation (app launch) by emitting
+         * a corresponding event on the event hub.
+         *
+         * @param {object} oResolvedHashFragment - the result of the NavTargetResolution service
+         */
+        _notifyUITracer: function (oResolvedHashFragment) {
+            try {
+                var sApplicationId = oResolvedHashFragment.ui5ComponentName;
+                if (oResolvedHashFragment.reservedParameters) {
+                    sApplicationId =
+                        oResolvedHashFragment.reservedParameters["sap-fiori-id"] ||
+                        oResolvedHashFragment.reservedParameters["sap-ui-app-id-hint"];
+                }
+                EventHub.emit("UITracer.trace", {
+                    reason: "NavigateApp",
+                    source: "Intent",
+                    data: {
+                        applicationId: sApplicationId || "",
+                        applicationType: oResolvedHashFragment.applicationType || "",
+                        hash: oResolvedHashFragment.sFixedShellHash || "",
+                        targetNavigationMode: oResolvedHashFragment.targetNavigationMode || "",
+                        providerId: oResolvedHashFragment.contentProviderId || "",
+                        targetUrl: oResolvedHashFragment.url || ""
+                    }
+                });
+            } catch (ex) {
+                Log.warning("Could not emit UITracer.trace event", ex, "sap.ushell.renderers.fiori2.Shell.controller");
+            }
+        },
+
         // Special logic for Search.
         // The search activity must be logged even after a user makes different searches in a single #Action-search session.
         // Therefore, the logging should occur on the search event and not by the navigation to the search application.

package/src/main/js/sap/ushell/renderers/fiori2/Shell.view.js

@@ -1,6 +1,11 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
-sap.ui.define([
+/**
+ * @fileOverview Sync Shell View
+ *
+ * @deprecated since 1.110
+ */
+ sap.ui.define([
     "sap/base/Log",
     "sap/ui/Device",
     "sap/ushell/components/_HeaderManager/ControlManager",
@@ -109,9 +114,9 @@ sap.ui.define([
                 var oDomRef = document.getElementById(ShellLayoutMapping.BackgroundImage);
                 var sBackgroundHtml = [
                     // "Shell Canvas" category in ThemeDesigner
-                    "<div class='sapUiShellBackgroundImage sapUiGlobalBackgroundImageForce sapUshellShellBG sapContrastPlus'></div>",
+                    "<div class='sapUiShellBackgroundImage sapUiGlobalBackgroundImageForce sapContrastPlus'></div>",
                     // "Application Background" category in ThemeDesigner
-                    "<div class='sapUshellShellBGsapMShellBG sapUiGlobalBackgroundImage'></div>"
+                    "<div class='sapMShellBG sapUiGlobalBackgroundImage'></div>"
                 ].join("\n");
                 oDomRef.insertAdjacentHTML("afterbegin", sBackgroundHtml);
             });

package/src/main/js/sap/ushell/renderers/fiori2/ShellAsync.view.js

@@ -113,7 +113,7 @@ sap.ui.define([
                     // "Shell Canvas" category in ThemeDesigner
                     "<div class='sapUiShellBackgroundImage sapUiGlobalBackgroundImageForce sapUshellShellBG sapContrastPlus'></div>",
                     // "Application Background" category in ThemeDesigner
-                    "<div class='sapUshellShellBGsapMShellBG sapUiGlobalBackgroundImage'></div>"
+                    "<div class='sapMShellBG sapUiGlobalBackgroundImage'></div>"
                 ].join("\n");
                 oDomRef.insertAdjacentHTML("afterbegin", sBackgroundHtml);
             });

package/src/main/js/sap/ushell/renderers/fiori2/ShellLayout.js

@@ -45,7 +45,7 @@ sap.ui.define([
             "            <div id='header-shellArea' data-sap-ui-root-content=true></div>",
             "            <div id='subHeader-shellArea' data-sap-ui-root-content=true></div>",
             "            <div class='sapUshellFlexGrowShrink sapUshellFlexRow'>",
-            "                <aside id='toolArea-shellArea' class='sapUshellPositionRelative' data-sap-ui-root-content=true></aside>",
+            "                <div id='toolArea-shellArea' class='sapUshellPositionRelative' data-sap-ui-root-content=true></div>",
             "                <div id='sidePane-shellArea' data-sap-ui-root-content=true></div>",
             "                <div class='sapUshellFlexGrowShrink sapUshellFlexColumn'>",
             "                    <div id='navigationBar-shellArea' data-sap-ui-root-content=true></div>",