@sapui5/sap.ushell 1.138.1 → 1.139.1

package/src/main/js/sap/ushell/appIntegration/PostMessageManager/LifecycleHandler.js

@@ -5,6 +5,7 @@
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/Deferred",
+    "sap/base/util/deepClone",
     "sap/m/library",
     "sap/ui/thirdparty/hasher",
     "sap/ui/thirdparty/URI",
@@ -18,6 +19,7 @@ sap.ui.define([
 ], (
     Log,
     Deferred,
+    deepClone,
     mobileLibrary,
     hasher,
     URI,
@@ -37,33 +39,41 @@ sap.ui.define([
     const StatefulType = ushellLibrary.appIntegration.contracts.StatefulType;
 
     const aEventPreprocessor = [
-        (oMessageEvent, oMessage) => {
+        (oOriginalMessageEvent, oOriginalMessage) => {
             // Handle messages to AppLifeCycle service
             // Replace calls with old naming convention 'appLifeCycle'
-            if (oMessage.service?.startsWith("sap.ushell.services.appLifeCycle")) {
+            if (oOriginalMessage.service?.startsWith("sap.ushell.services.appLifeCycle")) {
+                const oMessage = deepClone(oOriginalMessage);
                 oMessage.service = oMessage.service.replace(/appLifeCycle/gi, "AppLifeCycle");
+                oMessage.originalMessage = oOriginalMessage;
 
-                return new MessageEvent("message", {
+                const oMessageEvent = new MessageEvent("message", {
                     data: JSON.stringify(oMessage),
-                    origin: oMessageEvent.origin,
-                    source: oMessageEvent.source
+                    origin: oOriginalMessageEvent.origin,
+                    source: oOriginalMessageEvent.source
                 });
+                oMessageEvent.originalMessageEvent = oOriginalMessageEvent;
+
+                return {
+                    event: oMessageEvent,
+                    message: oMessage
+                };
             }
         }
     ];
 
     const oDistributionPolicies = {
-        "sap.ushell.services.AppLifeCycle.create": {
-            activeOnly: true
+        "sap.ushell.services.appLifeCycle.create": {
+            preventBroadcast: true
         },
-        "sap.ushell.services.AppLifeCycle.destroy": {
-            activeOnly: true
+        "sap.ushell.services.appLifeCycle.destroy": {
+            preventBroadcast: true
         },
-        "sap.ushell.services.AppLifeCycle.store": {
-            activeOnly: true
+        "sap.ushell.services.appLifeCycle.store": {
+            preventBroadcast: true
         },
-        "sap.ushell.services.AppLifeCycle.restore": {
-            activeOnly: true
+        "sap.ushell.services.appLifeCycle.restore": {
+            preventBroadcast: true
         },
         "sap.ushell.sessionHandler.extendSessionEvent": {
             ignoreCapabilities: true
@@ -72,9 +82,9 @@ sap.ui.define([
             isValidRequestTarget (oContainer) {
                 // this is a temporary check that will be removed after the issue of the central logout
                 // will be implemented. In the case here, for FLP@ABAP, we do not want to send logout message to
-                // CRM, WebGui and WDA iframes ifames as this is not needed. Sending it will cause an issue with the
+                // CRM, WebGui and WDA iframes as this is not needed. Sending it will cause an issue with the
                 // main FLP logout
-                if (",WCF,GUI,TR,WDA,".includes(oContainer.getApplicationType())) {
+                if (",WCF,TR,WDA,".includes(oContainer.getApplicationType())) {
                     return false;
                 }
                 return true;
@@ -82,15 +92,6 @@ sap.ui.define([
         }
     };
 
-    async function extendSession () {
-        const oShellController = Container.getRenderer().getShellController();
-        const oSessionHandler = oShellController._getSessionHandler();
-
-        if (oSessionHandler?.isInitialized?.()) {
-            oSessionHandler.userActivityHandler();
-        }
-    }
-
     async function sendEmail (sTo = "", sSubject = "", sBody = "", sCc = "", sBcc = "", sIFrameURL, bSetAppStateToPublic) {
         let sFLPUrl = ushellUtils.getDocumentUrl();
 
@@ -135,13 +136,18 @@ sap.ui.define([
         "sap.gui.loadFinished": {
             async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
                 oApplicationContainer.setStatefulType(StatefulType.ContractV1);
+
+                oApplicationContainer.addCapabilities([
+                    "sap.its.startService",
+                    "sap.gui.triggerCloseSession"
+                ]);
             },
             options: {
                 provideApplicationContext: true,
                 allowInactive: true
             }
         },
-        "sap.ushell.services.AppLifeCycle.subscribe": {
+        "sap.ushell.services.AppLifeCycle.subscribe": { // originally "sap.ushell.services.appLifeCycle.subscribe"
             async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
                 const aNewCapabilities = oMessageBody;
 
@@ -161,7 +167,7 @@ sap.ui.define([
                 allowInactive: true
             }
         },
-        "sap.ushell.services.AppLifeCycle.setup": {
+        "sap.ushell.services.AppLifeCycle.setup": { // originally "sap.ushell.services.appLifeCycle.setup"
             async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
                 const oSetup = oMessageBody;
 
@@ -170,14 +176,14 @@ sap.ui.define([
                     if (oSetup.isStateful) {
                         oApplicationContainer.setStatefulType(StatefulType.ContractV2);
 
-                        aNewCapabilities.push("sap.ushell.services.AppLifeCycle.create");
-                        aNewCapabilities.push("sap.ushell.services.AppLifeCycle.destroy");
+                        aNewCapabilities.push("sap.ushell.services.appLifeCycle.create");
+                        aNewCapabilities.push("sap.ushell.services.appLifeCycle.destroy");
 
                         // todo: [FLPCOREANDUX-10024] this is a workaround
                         const bIsAppruntime = !ushellUtils.isSAPLegacyApplicationType(oApplicationContainer.getApplicationType(), oApplicationContainer.getFrameworkId());
                         if (bIsAppruntime) {
-                            aNewCapabilities.push("sap.ushell.services.AppLifeCycle.store");
-                            aNewCapabilities.push("sap.ushell.services.AppLifeCycle.restore");
+                            aNewCapabilities.push("sap.ushell.services.appLifeCycle.store");
+                            aNewCapabilities.push("sap.ushell.services.appLifeCycle.restore");
                         }
                     }
 
@@ -198,10 +204,24 @@ sap.ui.define([
             }
         },
         "sap.ushell.sessionHandler.notifyUserActive": {
-            handler: extendSession
+            async handler (oMessageBody, oMessageEvent) {
+                const oShellController = Container.getRenderer().getShellController();
+                const oSessionHandler = oShellController._getSessionHandler();
+
+                if (oSessionHandler?.isInitialized?.()) {
+                    oSessionHandler.userActivityHandler();
+                }
+            }
         },
         "sap.ushell.sessionHandler.extendSessionEvent": {
-            handler: extendSession
+            async handler (oMessageBody, oMessageEvent) {
+                const oShellController = Container.getRenderer().getShellController();
+                const oSessionHandler = oShellController._getSessionHandler();
+
+                if (oSessionHandler?.isInitialized?.()) {
+                    oSessionHandler.userActivityHandler();
+                }
+            }
         },
         "sap.ushell.ui5service.ShellUIService.setTitle": {
             async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
@@ -221,11 +241,16 @@ sap.ui.define([
                 let fnCallback;
                 if (oMessageBody.callbackMessage?.service) {
                     fnCallback = () => {
+                        // The original message could have been sent from an iframe nested
+                        // within the application container's iframe.
+                        // Therefore the callback has to be sent to the source of
+                        // the original request.
+                        // Example: a Web Dynpro in compatibility mode with an NWBC around
                         PostMessageManager.sendRequest(
                             oMessageBody.callbackMessage.service,
-                            null,
-                            oApplicationContainer.getPostMessageTarget(),
-                            oApplicationContainer.getPostMessageTargetOrigin(),
+                            null, // oMessageBody
+                            oMessageEvent.source,
+                            oMessageEvent.origin,
                             false // bWaitForResponse
                         );
                     };
@@ -314,9 +339,13 @@ sap.ui.define([
                  */ // eslint-disable-next-line no-constant-condition
                 if (true) {
                     const { oParameters, groupId } = oMessageBody;
+
+                    const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+                    const oSystemContext = await AppLifeCycle.getCurrentApplication().getSystemContext();
+
                     const BookmarkV2 = await Container.getServiceAsync("BookmarkV2");
 
-                    return BookmarkV2.addBookmarkByGroupId(oParameters, groupId);
+                    return BookmarkV2.addBookmarkByGroupId(oParameters, groupId, oSystemContext.id);
                 }
 
                 throw new Error("Bookmark.addBookmarkByGroupId is deprecated. Use BookmarkV2.addBookmark instead.");
@@ -407,31 +436,16 @@ sap.ui.define([
         },
         "sap.ushell.services.ShellUIService.processHotKey": {
             async handler (oMessageBody, oMessageEvent) {
-                const oParams = oMessageBody;
-                // IE doesn't support creating the KeyboardEvent object with a the "new" constructor, hence if this will fail, it will be created
-                // using the document object- https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent
-                // This KeyboardEvent has a constructor, so checking for its ecsitaance will not solve this, hence, only solution found is try-catch
-                let oKeyboardEvent;
-                try {
-                    oKeyboardEvent = new KeyboardEvent("keydown", oParams);
-                } catch (err) {
-                    const { altKey, ctrlKey, shiftKey, key, keyCode } = oParams;
-                    const IEevent = document.createEvent("KeyboardEvent");
-
-                    let sSpecialKeys = ""; // https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/initKeyboardEvent
-                    if (altKey) {
-                        sSpecialKeys += "Alt ";
-                    }
-                    if (ctrlKey) {
-                        sSpecialKeys += "Control ";
-                    }
-                    if (shiftKey) {
-                        sSpecialKeys += "Shift ";
-                    }
+                const { altKey, ctrlKey, shiftKey, key, keyCode } = oMessageBody;
+
+                const oKeyboardEvent = new KeyboardEvent("keydown", {
+                    altKey,
+                    ctrlKey,
+                    shiftKey,
+                    key,
+                    keyCode
+                });
 
-                    IEevent.initKeyboardEvent("keydown", false, false, null, key, keyCode, sSpecialKeys, 0, false);
-                    oKeyboardEvent = IEevent;
-                }
                 document.dispatchEvent(oKeyboardEvent);
             }
         },
@@ -445,6 +459,10 @@ sap.ui.define([
             async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
                 const { bRegister } = oMessageBody;
                 if (bRegister) {
+                    oApplicationContainer.addCapabilities([
+                        "sap.ushell.appRuntime.handleDirtyStateProvider"
+                    ]);
+
                     Container.setAsyncDirtyStateProvider(async (oNavigationContext) => {
                         // safety check in case post message does not get result
                         const oNativeDeferred = new Deferred();
@@ -452,18 +470,16 @@ sap.ui.define([
                             oNativeDeferred.resolve(false);
                         }, 2500);
 
-                        PostMessageManager.sendRequest(
+                        oApplicationContainer.sendRequest(
                             "sap.ushell.appRuntime.handleDirtyStateProvider",
                             { oNavigationContext },
-                            oApplicationContainer.getPostMessageTarget(),
-                            oApplicationContainer.getPostMessageTargetOrigin(),
                             true // bWaitForResponse
                         ).then((oResponseMessageBody) => {
                             if (backupTimer) {
                                 clearTimeout(backupTimer);
                             }
 
-                            oNativeDeferred.resolve(oResponseMessageBody.result || false);
+                            oNativeDeferred.resolve(oResponseMessageBody.result ?? false);
                         });
 
                         return oNativeDeferred.promise;
@@ -494,12 +510,14 @@ sap.ui.define([
         },
         "sap.ushell.services.Container.attachLogoutEvent": {
             async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                oApplicationContainer.addCapabilities([
+                    "sap.ushell.appRuntime.executeLogoutFunctions"
+                ]);
+
                 Container.attachLogoutEvent(async () => {
-                    return PostMessageManager.sendRequest(
+                    return oApplicationContainer.sendRequest(
                         "sap.ushell.appRuntime.executeLogoutFunctions",
                         {},
-                        oApplicationContainer.getPostMessageTarget(),
-                        oApplicationContainer.getPostMessageTargetOrigin(),
                         true // bWaitForResponse
                     );
                 }, true);
@@ -518,33 +536,38 @@ sap.ui.define([
                 });
             }
         },
-        "sap.ushell.services.AppLifeCycle.getFullyQualifiedXhrUrl": {
+        "sap.ushell.services.AppLifeCycle.getFullyQualifiedXhrUrl": { // originally "sap.ushell.services.AppLifeCycle.getFullyQualifiedXhrUrl"
             async handler (oMessageBody, oMessageEvent) {
                 const { path } = oMessageBody;
 
-                if (path !== "" && path !== undefined && path !== null) {
-                    const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
-                    const oSystemContext = await AppLifeCycle.getCurrentApplication().getSystemContext();
-                    const sXhrUrl = oSystemContext.getFullyQualifiedXhrUrl(path);
-
-                    let sHostName = "";
-                    let sProtocol = "";
-                    let sPort = "";
-                    const sFlpURL = Container.getFLPUrl(true);
-                    const oURI = new URI(sFlpURL);
-                    if (oURI.protocol() !== null && oURI.protocol() !== undefined && oURI.protocol() !== "") {
-                        sProtocol = `${oURI.protocol()}://`;
-                    }
-                    if (oURI.hostname() !== null && oURI.hostname() !== undefined && oURI.hostname() !== "") {
-                        sHostName = oURI.hostname();
-                    }
-                    if (oURI.port() !== null && oURI.port() !== undefined && oURI.port() !== "") {
-                        sPort = `:${oURI.port()}`;
-                    }
+                if (!path) {
+                    // ignore empty path
+                    return;
+                }
+
+
+                const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+                const oSystemContext = await AppLifeCycle.getCurrentApplication().getSystemContext();
+                const sXhrUrl = oSystemContext.getFullyQualifiedXhrUrl(path);
+
+                let sHostName = "";
+                let sProtocol = "";
+                let sPort = "";
+                const sFlpURL = Container.getFLPUrl(true);
+                const oURI = new URI(sFlpURL);
 
-                    const sResult = sProtocol + sHostName + sPort + sXhrUrl;
-                    return sResult;
+                if (oURI.protocol()) {
+                    sProtocol = `${oURI.protocol()}://`;
+                }
+                if (oURI.hostname()) {
+                    sHostName = oURI.hostname();
                 }
+                if (oURI.port()) {
+                    sPort = `:${oURI.port()}`;
+                }
+
+                const sResult = sProtocol + sHostName + sPort + sXhrUrl;
+                return sResult;
             }
         },
         "sap.ushell.services.AppLifeCycle.getSystemAlias": {
@@ -590,8 +613,8 @@ sap.ui.define([
 
     return {
         register () {
-            aEventPreprocessor.forEach((oEventPreprocessor) => {
-                PostMessageManager.addEventPreprocessor(oEventPreprocessor);
+            aEventPreprocessor.forEach((fnEventPreprocessor) => {
+                PostMessageManager.addEventPreprocessor(fnEventPreprocessor);
             });
 
             Object.keys(oDistributionPolicies).forEach((sServiceRequest) => {

package/src/main/js/sap/ushell/appIntegration/PostMessageManager/NWBCHandler.js

@@ -4,12 +4,14 @@
  */
 sap.ui.define([
     "sap/base/Log",
+    "sap/base/util/deepClone",
     "sap/base/util/uid",
     "sap/ushell/appIntegration/PostMessageManager",
     "sap/ushell/Container",
     "sap/ushell/utils"
 ], (
     Log,
+    deepClone,
     uid,
     PostMessageManager,
     Container,
@@ -18,8 +20,9 @@ sap.ui.define([
     "use strict";
 
     const aEventPreprocessor = [
-        (oEvent, oMessage) => {
-            if (oMessage.action === "pro54_setGlobalDirty") {
+        (oOriginalMessageEvent, oOriginalMessage) => {
+            if (oOriginalMessage.action === "pro54_setGlobalDirty") {
+                const oMessage = deepClone(oOriginalMessage);
                 oMessage.service = "sap.ushell.appIntegration.PostMessageManager.NWBCHandler.pro54_setGlobalDirty";
                 delete oMessage.action;
 
@@ -34,11 +37,16 @@ sap.ui.define([
                     oMessage.type = "request";
                 }
 
-                return new MessageEvent("message", {
+                const oMessageEvent = new MessageEvent("message", {
                     data: JSON.stringify(oMessage),
-                    origin: oEvent.origin,
-                    source: oEvent.source
+                    origin: oOriginalMessageEvent.origin,
+                    source: oOriginalMessageEvent.source
                 });
+
+                return {
+                    event: oMessageEvent,
+                    message: oMessage
+                };
             }
         }
     ];
@@ -64,8 +72,8 @@ sap.ui.define([
 
     return {
         register () {
-            aEventPreprocessor.forEach((oEventPreprocessor) => {
-                PostMessageManager.addEventPreprocessor(oEventPreprocessor);
+            aEventPreprocessor.forEach((fnEventPreprocessor) => {
+                PostMessageManager.addEventPreprocessor(fnEventPreprocessor);
             });
 
             Object.keys(oServiceRequestHandlers).forEach((sServiceRequest) => {