@sapui5/sap.ushell 1.130.0 → 1.131.0

package/src/main/js/sap/ushell/components/applicationIntegration/application/BlueBoxHandler.js

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview handle all the resources for the different applications.
- * @version 1.130.0
+ * @version 1.131.0
  */
 sap.ui.define([
     "sap/base/util/Deferred",
@@ -23,58 +23,46 @@ sap.ui.define([
     "use strict";
 
     function BlueBoxHandler () {
-        var oBlueBoxContainer = {},
-            oBasicStatefulCapabilities = [
-                {
-                    service: "sap.ushell.services.AppLifeCycle",
-                    action: "create"
-                }, {
-                    service: "sap.ushell.services.AppLifeCycle",
-                    action: "destroy"
-                }
-            ];
+        const aBasicStatefulCapabilities = [{
+            service: "sap.ushell.services.AppLifeCycle",
+            action: "create"
+        }, {
+            service: "sap.ushell.services.AppLifeCycle",
+            action: "destroy"
+        }];
 
         this.STATEFUL_TYPES = {
+            FLP_V2_KEEP_ALIVE: -2,
+            GUI_V1_KEEP_ALIVE: -1,
             NOT_SUPPORTED: 0,
             GUI_V1: 1,
             FLP_V2: 2
         };
 
         this.init = function () {
-            oBlueBoxContainer = {};
+            // contains applicationContainers and manages the state of usage based on iframe properties
             BlueBoxesCache.init();
         };
 
-        this.addNewBlueBox = function (oApplicationContainer, oResolvedHashFragment, oInitialCapabilities) {
-            oBlueBoxContainer[oApplicationContainer] = oApplicationContainer;
-            BlueBoxesCache.add(oResolvedHashFragment.url, oApplicationContainer);
-            if (oApplicationContainer.setBlueBoxCapabilities) {
-                oApplicationContainer.setProperty("blueBoxCapabilities", {}, true);
-            }
-            if (oInitialCapabilities) {
-                this.addCapabilities(oApplicationContainer, oInitialCapabilities);
+        this.addNewBlueBox = function (oApplicationContainer, oResolvedHashFragment) {
+            if (!oApplicationContainer || !oResolvedHashFragment) {
+                return;
             }
+
+            BlueBoxesCache.add(oResolvedHashFragment.url, oApplicationContainer);
+            oApplicationContainer.setProperty("blueBoxCapabilities", {}, true);
         };
 
         this.deleteBlueBoxByUrl = function (sUrl) {
-            if (sUrl) {
-                var oContainer = BlueBoxesCache.get(sUrl);
-                if (oContainer && oBlueBoxContainer[oContainer]) {
-                    delete oBlueBoxContainer[oContainer];
-                }
-                BlueBoxesCache.remove(sUrl);
-            }
+            BlueBoxesCache.remove(sUrl);
         };
 
         this.deleteBlueBoxByContainer = function (oApplicationContainer) {
-            if (oApplicationContainer && oBlueBoxContainer[oApplicationContainer]) {
-                delete oBlueBoxContainer[oApplicationContainer];
-                BlueBoxesCache.removeByContainer(oApplicationContainer);
-            }
+            BlueBoxesCache.removeByContainer(oApplicationContainer);
         };
 
         this.getBlueBoxesCount = function () {
-            return Object.keys(oBlueBoxContainer).length + BlueBoxesCache.getSize(true);
+            return BlueBoxesCache.getLength() + BlueBoxesCache.getPoolLength();
         };
 
         this.getBlueBoxByUrl = function (sUrl) {
@@ -82,41 +70,19 @@ sap.ui.define([
         };
 
         this.getBlueBoxById = function (sId) {
-            return BlueBoxesCache.getById(sId);
-        };
-
-        this.addCapabilities = function (oApplicationContainer, oCapabilities) {
-            if (!oBlueBoxContainer[oApplicationContainer] || !oApplicationContainer.getBlueBoxCapabilities) {
-                return;
-            }
-
-            var oCapMap = oApplicationContainer.getBlueBoxCapabilities();
-            oCapabilities.forEach(function (oCap) {
-                if (oCap.service === "sap.ushell.services.appLifeCycle") {
-                    oCap.service = "sap.ushell.services.AppLifeCycle";
-                }
-                oCapMap[oCap.service + "." + oCap.action] = true;
-            });
-            if (oCapMap["sap.ushell.services.AppLifeCycle.create"]) {
-                oApplicationContainer.setProperty("statefulType", this.STATEFUL_TYPES.FLP_V2, true);
-            }
+            return BlueBoxesCache.getByApplicationContainerId(sId);
         };
 
+        // the second param is only called for the retrieval of regular frames for future keepAlive use
         this.removeCapabilities = function (oApplicationContainer, oCapabilities) {
-            if (!oBlueBoxContainer[oApplicationContainer] || !oApplicationContainer.getBlueBoxCapabilities) {
+            if (!oApplicationContainer || !BlueBoxesCache.isApplicationContainerActive(oApplicationContainer)) {
                 return;
             }
 
-            if (!oCapabilities) {
-                oApplicationContainer.setProperty("blueBoxCapabilities", {}, true);
-            } else {
-                var oCapMap = oApplicationContainer.getBlueBoxCapabilities();
-                oCapabilities.forEach(function (oCap) {
-                    delete oCapMap[oCap.service + "." + oCap.action];
-                    if (oCap.service + "." + oCap.action === "sap.ushell.services.AppLifeCycle.create") {
-                        oApplicationContainer.setProperty("statefulType", 0 - oApplicationContainer.getStatefulType(), true);
-                    }
-                });
+            oApplicationContainer.removeBlueBoxCapabilities(oCapabilities);
+            if (this.isStatefulContainer(oApplicationContainer)) {
+                // todo [FLPCOREANDUX-10024] remove side effect setProperty
+                oApplicationContainer.setProperty("statefulType", this.STATEFUL_TYPES.FLP_V2_KEEP_ALIVE, true);
             }
         };
 
@@ -166,9 +132,28 @@ sap.ui.define([
             }
 
             EventBus.getInstance().publish("launchpad", "appOpening", oResolvedHashFragment);
+
+            // If the iframe is hidden, calls of setTimeout and setInterval are throttled within the iframe for certain browsers
+            // (currently Chrome and Edge) if the iframe content comes from a third-party domain.
+            // This can lead to a delayed app start as the following post message to create the app within the iFrame waits until the app is created.
+            // Currently this is only relevant for the UI5 app runtime when its UI5 bootstrap is not switched to async.
+            // In this case UI5 uses many setTimeouts with a delay of 0 during component creation to simulate async behavior.
+            const bIsHidden = oApplicationContainer.hasStyleClass("hidden");
+            if (bIsHidden) {
+                // With this approach the new app is not visible yet but the iframe is not throttled.
+                oApplicationContainer.addStyleClass("sapUShellApplicationContainerIframeHiddenButActive");
+                oApplicationContainer.removeStyleClass("hidden");
+            }
+
             const oResult = await PostMessageUtils.postMessageToIframeApp(oApplicationContainer, "sap.ushell.services.appLifeCycle", "create", oPostParams, true);
-            const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
 
+            if (bIsHidden) {
+                // Add the hidden class again as the AppContainer relies on its existence to navigate between its content.
+                oApplicationContainer.addStyleClass("hidden");
+                oApplicationContainer.removeStyleClass("sapUShellApplicationContainerIframeHiddenButActive");
+            }
+
+            const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
             if (bNavigationInSameStatefulContainer === true) {
                 AppLifeCycle.prepareCurrentAppObject("URL", undefined, false, oApplicationContainer);
             }
@@ -177,108 +162,142 @@ sap.ui.define([
             return oResult?.body?.result;
         };
 
-        this.statefulDestroyApp = function (oApplicationContainer, sStorageKey) {
-            var oPromise,
-                oAppTarget;
-
+        this.statefulDestroyApp = async function (oApplicationContainer, sStorageKey) {
+            const oAppTarget = oApplicationContainer.getCurrentAppTargetResolution();
             oApplicationContainer.setProperty("currentAppUrl", "", true);
             oApplicationContainer.setProperty("currentAppId", "", true);
-            oAppTarget = oApplicationContainer.getCurrentAppTargetResolution();
             oApplicationContainer.setProperty("currentAppTargetResolution", undefined, true);
             Container.setAsyncDirtyStateProvider(undefined);
-            oPromise = PostMessageUtils.postMessageToIframeApp(oApplicationContainer, "sap.ushell.services.appLifeCycle", "destroy", {
+
+            await PostMessageUtils.postMessageToIframeApp(oApplicationContainer, "sap.ushell.services.appLifeCycle", "destroy", {
                 sCacheId: sStorageKey
             }, true);
 
-            oPromise.then(function () {
-                EventBus.getInstance().publish("sap.ushell", "appClosed", oAppTarget);
-            });
-            return oPromise;
+            EventBus.getInstance().publish("sap.ushell", "appClosed", oAppTarget);
         };
 
-        this.statefulStoreKeepAliveApp = function (oApplicationContainer, sStorageKey) {
-            var oPromise,
-                oAppTarget;
+        this.statefulStoreKeepAliveApp = async function (oApplicationContainer, sStorageKey) {
+            const oAppTarget = oApplicationContainer.getCurrentAppTargetResolution();
 
             oApplicationContainer.setProperty("currentAppUrl", "", true);
             oApplicationContainer.setProperty("currentAppId", "", true);
-            oAppTarget = oApplicationContainer.getCurrentAppTargetResolution();
             oApplicationContainer.setProperty("currentAppTargetResolution", undefined, true);
             Container.setAsyncDirtyStateProvider(undefined);
-            oPromise = PostMessageUtils.postMessageToIframeApp(oApplicationContainer, "sap.ushell.services.appLifeCycle", "store", {
+
+            await PostMessageUtils.postMessageToIframeApp(oApplicationContainer, "sap.ushell.services.appLifeCycle", "store", {
                 sCacheId: sStorageKey
             }, true);
 
-            oPromise.then(function () {
-                EventBus.getInstance().publish("sap.ushell", "appClosed", oAppTarget);
-            });
-            return oPromise;
+            EventBus.getInstance().publish("sap.ushell", "appClosed", oAppTarget);
         };
 
-        this.statefulRestoreKeepAliveApp = function (oApplicationContainer, sUrl, sStorageKey, oResolvedHashFragment, bNavigationInSameStatefullContainer) {
-            return new Promise(function (fnResolve) {
-                oApplicationContainer.setProperty("currentAppUrl", sUrl, true);
-                oApplicationContainer.setProperty("currentAppId", sStorageKey, true);
-                oApplicationContainer.setProperty("currentAppTargetResolution", oResolvedHashFragment, true);
-                EventBus.getInstance().publish("launchpad", "appOpening", oResolvedHashFragment);
-                PostMessageUtils.postMessageToIframeApp(oApplicationContainer, "sap.ushell.services.appLifeCycle", "restore", {
-                    sCacheId: sStorageKey,
-                    sUrl: oResolvedHashFragment.url,
-                    sHash: hasher.getHash()
-                }, true).then(function () {
-                    Container.getServiceAsync("AppLifeCycle").then(function (oAppLifeCycleService) {
-                        if (bNavigationInSameStatefullContainer === true) {
-                            oAppLifeCycleService.prepareCurrentAppObject("URL", undefined, false, oApplicationContainer);
-                        }
-                        EventBus.getInstance().publish("sap.ushell", "appOpened", oResolvedHashFragment);
-                        fnResolve();
-                    });
-                });
-            });
+        this.statefulRestoreKeepAliveApp = async function (oApplicationContainer, sUrl, sStorageKey, oResolvedHashFragment, bNavigationInSameStatefulContainer) {
+            oApplicationContainer.setProperty("currentAppUrl", sUrl, true);
+            oApplicationContainer.setProperty("currentAppId", sStorageKey, true);
+            oApplicationContainer.setProperty("currentAppTargetResolution", oResolvedHashFragment, true);
+
+            EventBus.getInstance().publish("launchpad", "appOpening", oResolvedHashFragment);
+
+            await PostMessageUtils.postMessageToIframeApp(oApplicationContainer, "sap.ushell.services.appLifeCycle", "restore", {
+                sCacheId: sStorageKey,
+                sUrl: oResolvedHashFragment.url,
+                sHash: hasher.getHash()
+            }, true);
+
+            if (bNavigationInSameStatefulContainer) {
+                const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+                AppLifeCycle.prepareCurrentAppObject("URL", undefined, false, oApplicationContainer);
+            }
+
+            EventBus.getInstance().publish("sap.ushell", "appOpened", oResolvedHashFragment);
         };
 
         this.isCapabilitySupported = function (oApplicationContainer, sServiceName, sInterface) {
-            if (oApplicationContainer && oApplicationContainer.getBlueBoxCapabilities && oApplicationContainer.getBlueBoxCapabilities()[sServiceName + "." + sInterface]) {
-                return true;
+            if (!oApplicationContainer) {
+                return false;
             }
-            return false;
+
+            return oApplicationContainer.supportsBlueBoxCapabilities([
+                { service: sServiceName, action: sInterface }
+            ]);
+        };
+
+        this.isReusableContainer = function (oApplicationContainer) {
+            if (!oApplicationContainer) {
+                return false;
+            }
+
+            // todo: [FLPCOREANDUX-10024] when removing the keepAlive enum types this check should be adjusted
+            return oApplicationContainer.getStatefulType() !== this.STATEFUL_TYPES.NOT_SUPPORTED;
         };
 
         this.isStatefulContainer = function (oApplicationContainer) {
-            return this.isCapabilitySupported(oApplicationContainer, "sap.ushell.services.AppLifeCycle", "create");
+            if (!oApplicationContainer) {
+                return false;
+            }
+
+            return oApplicationContainer.supportsBlueBoxCapabilities([
+                { service: "sap.ushell.services.AppLifeCycle", action: "create" },
+                { service: "sap.ushell.services.appLifeCycle", action: "destroy" }
+            ]);
+        };
+
+        this.isStatefulContainerSupportingKeepAlive = function (oApplicationContainer) {
+            if (!oApplicationContainer) {
+                return false;
+            }
+
+            return oApplicationContainer.supportsBlueBoxCapabilities([
+                // stateful capabilities
+                { service: "sap.ushell.services.AppLifeCycle", action: "create" },
+                { service: "sap.ushell.services.appLifeCycle", action: "destroy" },
+                // keep alive capabilities
+                { service: "sap.ushell.services.appLifeCycle", action: "store" },
+                { service: "sap.ushell.services.appLifeCycle", action: "restore" }
+            ]);
         };
 
         this.isIframeIsValidSupported = function (oApplicationContainer) {
-            return this.isCapabilitySupported(oApplicationContainer, "sap.ushell.appRuntime", "iframeIsValid");
+            return oApplicationContainer.supportsBlueBoxCapabilities([
+                { service: "sap.ushell.services.appRuntime", action: "iframeIsValid" }
+            ]);
         };
 
         this.isStatefulContainerInKeepAlivePool = function (oApplicationContainer) {
-            return !!(oApplicationContainer && oApplicationContainer.getStatefulType && oApplicationContainer.getStatefulType() < this.STATEFUL_TYPES.NOT_SUPPORTED);
+            // todo: [FLPCOREANDUX-10024] this is only a marker for the keepAlive application not for pool
+            // maybe this references the scenario: stateful -> reuse for keepAlive
+            return !!(oApplicationContainer && oApplicationContainer.getStatefulType() < this.STATEFUL_TYPES.NOT_SUPPORTED);
         };
 
         this.findFreeContainerForNewKeepAliveApp = function (oResolvedHashFragment) {
             if (!oResolvedHashFragment) {
-                return undefined;
+                return;
             }
-            if (!utils.isSAPLegacyApplicationType(oResolvedHashFragment.applicationType, oResolvedHashFragment.appCapabilities && oResolvedHashFragment.appCapabilities.appFrameworkId)) {
-                return undefined;
+            // todo: [FLPCOREANDUX-10024] this check should come from capabilities
+            if (!utils.isSAPLegacyApplicationType(oResolvedHashFragment.applicationType, oResolvedHashFragment.appCapabilities?.appFrameworkId)) {
+                // do not handle appruntime
+                return;
             }
 
-            var oFreeApplicationContainer;
-            var sTmpUrl = oResolvedHashFragment.url.replaceAll("sap-keep-alive", "sap-temp");
+            // first from KeepAlive pool
+            let oFreeApplicationContainer = BlueBoxesCache.getFromPool(oResolvedHashFragment.url);
+            if (!oFreeApplicationContainer) {
+                // second from stateful container, but change it to keep alive
+                oFreeApplicationContainer = BlueBoxesCache.get(oResolvedHashFragment.url, true);
 
-            oFreeApplicationContainer = BlueBoxesCache.get(sTmpUrl, true);
-            if (oFreeApplicationContainer) {
-                oBlueBoxContainer[oFreeApplicationContainer] = oFreeApplicationContainer;
-            } else {
-                oFreeApplicationContainer = BlueBoxesCache.get(sTmpUrl);
                 if (oFreeApplicationContainer && oFreeApplicationContainer.getStatefulType() > this.STATEFUL_TYPES.NOT_SUPPORTED) {
+                    // only take stateful container and ignore the regular iframes
+                    BlueBoxesCache.removeByContainer(oFreeApplicationContainer);
+
+                    // contract v2 stateful container
                     if (oFreeApplicationContainer.getStatefulType() === this.STATEFUL_TYPES.FLP_V2) {
-                        this.removeCapabilities(oFreeApplicationContainer, oBasicStatefulCapabilities);
+                        oFreeApplicationContainer.removeBlueBoxCapabilities(aBasicStatefulCapabilities);
+                        oFreeApplicationContainer.setProperty("statefulType", this.STATEFUL_TYPES.FLP_V2_KEEP_ALIVE, true);
+                        // now the container is not stateful anymore based on its capabilities
                     } else {
-                        oFreeApplicationContainer.setProperty("statefulType", 0 - oFreeApplicationContainer.getStatefulType(), true);
+                        // v1 stateful container
+                        oFreeApplicationContainer.setProperty("statefulType", this.STATEFUL_TYPES.GUI_V1_KEEP_ALIVE, true);
                     }
-                    BlueBoxesCache.remove(sTmpUrl);
                 }
             }
 
@@ -286,50 +305,45 @@ sap.ui.define([
                 BlueBoxesCache.add(oResolvedHashFragment.url, oFreeApplicationContainer);
                 oFreeApplicationContainer.setProperty("currentAppUrl", "", true);
                 oFreeApplicationContainer.setProperty("isFetchedFromCache", true, true);
+                oFreeApplicationContainer.setProperty("isKeepAlive", true, true);
             }
 
             return oFreeApplicationContainer;
         };
 
-        this.returnUnusedKeepAliveContainer = function (oAppContainer) {
-            if (!oAppContainer) {
-                return false;
+        this.returnUnusedKeepAliveContainer = function (oApplicationContainer) {
+            if (!oApplicationContainer) {
+                return;
             }
-            if (!utils.isSAPLegacyApplicationType(oAppContainer.getApplicationType && oAppContainer.getApplicationType(),
-                oAppContainer.getFrameworkId && oAppContainer.getFrameworkId())) {
-                return false;
+
+            // todo: [FLPCOREANDUX-10024] this check should come from capabilities
+            if (this.isStatefulContainerSupportingKeepAlive(oApplicationContainer)) {
+                // do not handle appruntime or iframes which are capable of keepAlive
+                return;
             }
 
-            if (oAppContainer.getStatefulType() < this.STATEFUL_TYPES.NOT_SUPPORTED) {
-                var sUrl = oAppContainer.getCurrentAppUrl();
-                var sKey = BlueBoxesCache.getBlueBoxCacheKeyValues(sUrl.replaceAll("sap-keep-alive", "sap-temp")).sKey;
-                var oHostMainContainer = BlueBoxesCache.get(sKey);
-                if (oHostMainContainer) {
-                    //If we're here, it means that there's already a stateful container Iframe, so we need to add
-                    //this oAppContainer to the keep alive pool
-                    BlueBoxesCache.add(sUrl.replaceAll("sap-keep-alive", "sap-temp"), oAppContainer, true);
-                    this.deleteBlueBoxByUrl(sUrl);
-                } else {
-                    BlueBoxesCache.remove(sUrl);
-                    BlueBoxesCache.add(sUrl.replaceAll("sap-keep-alive", "sap-temp"), oAppContainer);
-                    if (oAppContainer.getStatefulType() === -this.STATEFUL_TYPES.FLP_V2) {
-                        this.addCapabilities(oAppContainer, oBasicStatefulCapabilities);
+            // keep alive iframe
+            if (oApplicationContainer.getStatefulType() < this.STATEFUL_TYPES.NOT_SUPPORTED) {
+                const bWasMovedToPool = BlueBoxesCache.moveKeepAliveToPool(oApplicationContainer);
+
+                if (!bWasMovedToPool) { // is now stateful container
+                    oApplicationContainer.setProperty("isKeepAlive", false, true);
+
+                    if (oApplicationContainer.getStatefulType() === this.STATEFUL_TYPES.FLP_V2_KEEP_ALIVE) {
+                        oApplicationContainer.addBlueBoxCapabilities(aBasicStatefulCapabilities);
+                        oApplicationContainer.setProperty("statefulType", this.STATEFUL_TYPES.FLP_V2, true);
+
                     } else {
-                        oAppContainer.setProperty("statefulType", this.STATEFUL_TYPES.GUI_V1, true);
+                        oApplicationContainer.setProperty("statefulType", this.STATEFUL_TYPES.GUI_V1, true);
                     }
                 }
-                oAppContainer.setProperty("currentAppUrl", "", true);
-                oAppContainer.setProperty("isFetchedFromCache", false, true);
-                return true;
+                oApplicationContainer.setProperty("currentAppUrl", "", true);
+                oApplicationContainer.setProperty("isFetchedFromCache", false, true);
             }
-            return false;
         };
 
         this.getStatefulContainerType = function (sUrl, bIgnoreKeepAlive) {
-            if (bIgnoreKeepAlive === true) {
-                sUrl = sUrl.replaceAll("sap-keep-alive", "sap-temp");
-            }
-            var oApplicationContainer = BlueBoxesCache.get(sUrl);
+            var oApplicationContainer = BlueBoxesCache.get(sUrl, bIgnoreKeepAlive);
             if (oApplicationContainer) {
                 return oApplicationContainer.getStatefulType();
             }
@@ -337,12 +351,10 @@ sap.ui.define([
         };
 
         this.forEach = function (callback) {
-            Object.keys(oBlueBoxContainer).forEach(function (key) {
-                callback(oBlueBoxContainer[key]);
-            });
             BlueBoxesCache.forEach(callback);
         };
 
+        // todo: [FLPCOREANDUX-10024] the post messages below are async
         this.destroyApp = function (sAppId) {
             PostMessageUtils.postMessageToMultipleIframes("sap.ushell.services.appLifeCycle", "destroy", {
                 appId: sAppId
@@ -365,7 +377,6 @@ sap.ui.define([
 
         this._getStorageForDebug = function () {
             return {
-                oBlueBoxContainer: oBlueBoxContainer,
                 oBlueBoxesCache: BlueBoxesCache._getStorageForDebug()
             };
         };