@sapui5/sap.ushell 1.132.1 → 1.134.0

package/src/main/js/sap/ushell/services/MessageBroker/MessageBrokerEngine.js

@@ -1,26 +1,30 @@
-// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview This module contains the implementation of the message broker
- * @version 1.132.1
+ * @version 1.134.0
  */
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/deepExtend",
-    "sap/ushell/components/applicationIntegration/application/PostMessageUtils"
-], function (Log, deepExtend, PostMessageUtils) {
+    "sap/ushell/Config"
+], (
+    Log,
+    deepExtend,
+    Config
+) => {
     "use strict";
 
-    var bEnabled = true,
-        oAcceptedOrigins = {},
-        oClientsPerChannel = {},
-        oConnectedClients = {},
-        oSubscribedClients = {};
+    let bEnabled = true;
+    const oAcceptedOrigins = {};
+    const oClientsPerChannel = {};
+    const oConnectedClients = {};
+    const oSubscribedClients = {};
 
     //add default origin
     oAcceptedOrigins[window.location.origin] = true;
 
-    var MessageBrokerEngine = function () {
+    function MessageBrokerEngine () {
 
         this.setEnabled = function (bVal) {
             bEnabled = bVal;
@@ -40,16 +44,16 @@ sap.ui.define([
                 return Promise.reject();
             }
 
-            var oMessageData = oPostMessageData.oMessageData,
-                oMessageDataBody = oMessageData.body,
-                oMessage = oPostMessageData.oMessage,
-                sOrigin = oMessage.origin,
-                oIframe = oMessage.source;
+            const oMessageData = oPostMessageData.oMessageData;
+            const oMessageDataBody = oMessageData.body;
+            const oMessage = oPostMessageData.oMessage;
+            const sOrigin = oMessage.origin;
+            const oIframe = oMessage.source;
 
             oMessageDataBody.requestId = oMessageData.request_id;
 
             if (!oIframe) {
-                var sErrorMsg = "Missing iframe object in PostMessage request";
+                const sErrorMsg = "Missing iframe object in PostMessage request";
                 Log.error(sErrorMsg, null, "sap.ushell.services.MessageBroker");
                 return Promise.reject(sErrorMsg);
             }
@@ -67,7 +71,7 @@ sap.ui.define([
          */
 
         this.connect = function (sClientId) {
-            var sError;
+            let sError;
 
             if (!bEnabled) {
                 return Promise.reject();
@@ -97,7 +101,7 @@ sap.ui.define([
          */
 
         this.disconnect = function (sClientId) {
-            var sError;
+            let sError;
 
             if (!bEnabled) {
                 return Promise.reject();
@@ -109,13 +113,13 @@ sap.ui.define([
                 sError = "Client is already disconnected";
             } else {
 
-                for (var sChannelKey in oClientsPerChannel) {
+                for (const sChannelKey in oClientsPerChannel) {
 
-                    var aChannelClients = oClientsPerChannel[sChannelKey];
+                    const aChannelClients = oClientsPerChannel[sChannelKey];
                     // find client and remove from the channel
-                    for (var oClientKey in aChannelClients) {
+                    for (const oClientKey in aChannelClients) {
 
-                        var oClient = aChannelClients[oClientKey];
+                        const oClient = aChannelClients[oClientKey];
 
                         if (oClient.clientId === sClientId) {
                             aChannelClients.splice(oClientKey, 1);
@@ -155,18 +159,11 @@ sap.ui.define([
          * @private
          */
 
-        this.subscribe = function (
-            sClientId,
-            aSubscribedChannels,
-            fnMessageCallback,
-            fnClientConnectionCallback,
-            oIframe,
-            sOrigin
-        ) {
-            var sError,
-                sMessageName = "clientSubscribed",
-                aOtherSubscribedClients = [],
-                bIsNewClient = false;
+        this.subscribe = function (sClientId, aSubscribedChannels, fnMessageCallback, fnClientConnectionCallback, oIframe, sOrigin) {
+            let sError;
+            const sMessageName = "clientSubscribed";
+            let aOtherSubscribedClients = [];
+            let bIsNewClient = false;
 
             if (!bEnabled) {
                 return Promise.reject();
@@ -181,12 +178,12 @@ sap.ui.define([
             } else if (!oConnectedClients[sClientId]) {
                 sError = "Client is not connected";
             } else {
-                for (var sChannelKey in aSubscribedChannels) {
+                for (const sChannelKey in aSubscribedChannels) {
 
-                    var oChannel = aSubscribedChannels[sChannelKey];
+                    const oChannel = aSubscribedChannels[sChannelKey];
 
                     // add new client to the channel
-                    var oFullClientData = {
+                    const oFullClientData = {
                         clientId: sClientId,
                         subscribedChannels: aSubscribedChannels,
                         messageCallback: fnMessageCallback,
@@ -201,7 +198,7 @@ sap.ui.define([
                         oClientsPerChannel[oChannel.channelId] = [];
                     }
 
-                    var oExistingClient = oClientsPerChannel[oChannel.channelId].find(function (oClient) {
+                    const oExistingClient = oClientsPerChannel[oChannel.channelId].find((oClient) => {
                         return oClient.clientId === sClientId;
                     });
 
@@ -212,7 +209,7 @@ sap.ui.define([
 
                     // if client is already subscribed to any channel
                     if (oSubscribedClients[sClientId]) {
-                        var oExistingChannel = oSubscribedClients[sClientId].channels.find(function (oSubChannel) {
+                        const oExistingChannel = oSubscribedClients[sClientId].channels.find((oSubChannel) => {
                             return oSubChannel.channelId === oChannel.channelId;
                         });
 
@@ -228,14 +225,14 @@ sap.ui.define([
 
                     bIsNewClient = true;
 
-                    var oSubscriptionData = {
+                    const oSubscriptionData = {
                         clientId: sClientId,
                         channels: aSubscribedChannels
                     };
                     // add to subscribed clients
                     oSubscribedClients[sClientId] = oSubscriptionData;
 
-                    aOtherSubscribedClients = Object.values(oSubscribedClients).filter(function (oClient) {
+                    aOtherSubscribedClients = Object.values(oSubscribedClients).filter((oClient) => {
                         return oClient.clientId !== sClientId;
                     });
                 }
@@ -247,25 +244,34 @@ sap.ui.define([
 
                 if (bIsNewClient) {
                     // notify new client of other already subscribed clients
-                    setTimeout(function () {
+                    setTimeout(() => {
                         if (aOtherSubscribedClients.length) {
-                            aOtherSubscribedClients.forEach(function (oClient) {
+                            aOtherSubscribedClients.forEach((oClient) => {
                                 if (!oIframe) {
                                     fnClientConnectionCallback(sMessageName, oClient.clientId, oClient.channels);
                                 } else {
-                                    var oParams = {
+                                    const oParams = {
                                         clientId: oClient.clientId,
                                         channels: oClient.channels,
                                         channelId: "sap.ushell.MessageBroker",
                                         messageName: sMessageName
                                     };
 
-                                    var oMessageBody = this._buildPostMessageObject("event", oParams);
-                                    PostMessageUtils.postMessageToIframeObject(oMessageBody, oIframe, sOrigin, false);
+                                    if (Config.last("/core/navigation/enableAppLifeCycleFallback")) {
+                                        sap.ui.require(["sap/ushell/components/applicationIntegration/application/PostMessageUtils"], (PostMessageUtils) => {
+                                            const oMessageBody = this._buildPostMessageObjectFallback(PostMessageUtils, "event", oParams);
+                                            PostMessageUtils.postMessageToIframeObject(oMessageBody, oIframe, sOrigin);
+                                        });
+                                    } else {
+                                        sap.ui.require(["sap/ushell/components/applicationIntegration/PostMessageManager"], (PostMessageManager) => {
+                                            const oResult = this._buildPostMessageObject("event", oParams);
+                                            this._sendPostMessage(PostMessageManager, oResult, oIframe, sOrigin);
+                                        });
+                                    }
                                 }
-                            }.bind(this));
+                            });
                         }
-                    }.bind(this), 1000);
+                    }, 1000);
                 }
 
                 return Promise.resolve();
@@ -286,7 +292,7 @@ sap.ui.define([
          */
 
         this.unsubscribe = function (sClientId, aUnsubscribedChannels) {
-            var sError;
+            let sError;
 
             if (!bEnabled) {
                 return Promise.reject();
@@ -305,21 +311,21 @@ sap.ui.define([
                 return Promise.reject(sError);
             }
 
-            for (var sChannelIndex in aUnsubscribedChannels) {
+            for (const sChannelIndex in aUnsubscribedChannels) {
 
-                var oChannel = aUnsubscribedChannels[sChannelIndex];
+                const oChannel = aUnsubscribedChannels[sChannelIndex];
 
                 if (oClientsPerChannel[oChannel.channelId]) {
-                    var aChannelClients = oClientsPerChannel[oChannel.channelId];
+                    const aChannelClients = oClientsPerChannel[oChannel.channelId];
                     // find client and remove from the channel
-                    for (var oClientKey in aChannelClients) {
+                    for (const oClientKey in aChannelClients) {
 
-                        var oClient = aChannelClients[oClientKey];
+                        const oClient = aChannelClients[oClientKey];
 
                         if (oClient.clientId === sClientId) {
-                            var aSubscribedChannels = oSubscribedClients[sClientId].channels;
+                            const aSubscribedChannels = oSubscribedClients[sClientId].channels;
 
-                            oSubscribedClients[sClientId].channels = aSubscribedChannels.filter(function (oSubChannel) {
+                            oSubscribedClients[sClientId].channels = aSubscribedChannels.filter((oSubChannel) => {
                                 return oSubChannel.channelId !== oChannel.channelId;
                             });
 
@@ -329,7 +335,7 @@ sap.ui.define([
                     }
                 } else {
                     // if channel does not exist
-                    var sMessage = "Unknown channel Id: " + oChannel.channelId;
+                    const sMessage = `Unknown channel Id: ${oChannel.channelId}`;
                     Log.warning(sMessage, null, "sap.ushell.services.MessageBroker");
                 }
             }
@@ -353,8 +359,8 @@ sap.ui.define([
          */
 
         this.publish = function (sChannelId, sClientId, sMessageId, sMessageName, aTargetClientIds, data) {
-            var sError,
-                aTargetClients = [];
+            let sError;
+            let aTargetClients = [];
 
             if (!bEnabled) {
                 return Promise.reject();
@@ -369,12 +375,12 @@ sap.ui.define([
 
             // if channel does not exist
             if (!oClientsPerChannel[sChannelId]) {
-                sError = "Unknown channel Id: " + sChannelId;
+                sError = `Unknown channel Id: ${sChannelId}`;
                 Log.error(sError, null, "sap.ushell.services.MessageBroker");
                 return Promise.reject(sError);
             }
 
-            var oPubClient = oClientsPerChannel[sChannelId].find(function (oSubClient) {
+            const oPubClient = oClientsPerChannel[sChannelId].find((oSubClient) => {
                 return oSubClient.clientId === sClientId;
             });
 
@@ -385,9 +391,9 @@ sap.ui.define([
                 return Promise.reject(sError);
             }
 
-            for (var sClientKey in aTargetClientIds) {
+            for (const sClientKey in aTargetClientIds) {
 
-                var sTargetClientId = aTargetClientIds[sClientKey];
+                const sTargetClientId = aTargetClientIds[sClientKey];
 
                 // if message is for all clients in the channel
                 if (sTargetClientId === "*") {
@@ -395,7 +401,7 @@ sap.ui.define([
                     break;
                 } else {
                     // check if target client exists
-                    var oTargetClient = oClientsPerChannel[sChannelId].find(function (oClient) {
+                    const oTargetClient = oClientsPerChannel[sChannelId].find((oClient) => {
                         return oClient.clientId === sTargetClientId;
                     });
 
@@ -494,19 +500,19 @@ sap.ui.define([
          */
 
         this._emitEvent = function (sMessageName, sClientId, aChannels) {
-            var oNotifiedClients = {};
+            const oNotifiedClients = {};
 
-            for (var sChannelKey in oClientsPerChannel) {
+            for (const sChannelKey in oClientsPerChannel) {
 
-                var oChannel = oClientsPerChannel[sChannelKey];
+                const oChannel = oClientsPerChannel[sChannelKey];
 
-                for (var sClientKey in oChannel) {
+                for (const sClientKey in oChannel) {
 
-                    var oClient = oChannel[sClientKey];
+                    const oClient = oChannel[sClientKey];
                     // do not notify the same client who initiated the event
                     if (oClient.clientId !== sClientId && !oNotifiedClients[oClient.clientId]) {
 
-                        var oParams = {
+                        const oParams = {
                             clientId: sClientId,
                             channels: aChannels
                         };
@@ -518,8 +524,17 @@ sap.ui.define([
                             oParams.channelId = "sap.ushell.MessageBroker";
                             oParams.messageName = sMessageName;
 
-                            var oMessageBody = this._buildPostMessageObject("event", oParams);
-                            PostMessageUtils.postMessageToIframeObject(oMessageBody, oClient.iframe, oClient.origin, false);
+                            if (Config.last("/core/navigation/enableAppLifeCycleFallback")) {
+                                sap.ui.require(["sap/ushell/components/applicationIntegration/application/PostMessageUtils"], (PostMessageUtils) => {
+                                    const oMessageBody = this._buildPostMessageObjectFallback(PostMessageUtils, "event", oParams);
+                                    PostMessageUtils.postMessageToIframeObject(oMessageBody, oClient.iframe, oClient.origin);
+                                });
+                            } else {
+                                sap.ui.require(["sap/ushell/components/applicationIntegration/PostMessageManager"], (PostMessageManager) => {
+                                    const oResult = this._buildPostMessageObject("event", oParams);
+                                    this._sendPostMessage(PostMessageManager, oResult, oClient.iframe, oClient.origin);
+                                });
+                            }
                         }
 
                         oNotifiedClients[oClient.clientId] = true;
@@ -542,24 +557,33 @@ sap.ui.define([
          */
 
         this._sendMessage = function (aTargetClients, sChannelId, sMessageId, sMessageName, sClientId, data) {
-            for (var sClientKey in aTargetClients) {
+            for (const sClientKey in aTargetClients) {
 
-                var oClient = aTargetClients[sClientKey];
+                const oClient = aTargetClients[sClientKey];
 
                 // do not send message to the same client who requested to send it
                 if (oClient.clientId !== sClientId) {
                     if (oClient.isUI5 !== false) {
                         oClient.messageCallback(sClientId, sChannelId, sMessageName, data);
                     } else {
-                        var oParams = {
+                        const oParams = {
                             clientId: sClientId,
                             channelId: sChannelId,
                             messageName: sMessageName,
                             data: data
                         };
 
-                        var oMessageBody = this._buildPostMessageObject("request", oParams);
-                        PostMessageUtils.postMessageToIframeObject(oMessageBody, oClient.iframe, oClient.origin, false);
+                        if (Config.last("/core/navigation/enableAppLifeCycleFallback")) {
+                            sap.ui.require(["sap/ushell/components/applicationIntegration/application/PostMessageUtils"], (PostMessageUtils) => {
+                                const oMessageBody = this._buildPostMessageObjectFallback(PostMessageUtils, "request", oParams);
+                                PostMessageUtils.postMessageToIframeObject(oMessageBody, oClient.iframe, oClient.origin);
+                            });
+                        } else {
+                            sap.ui.require(["sap/ushell/components/applicationIntegration/PostMessageManager"], (PostMessageManager) => {
+                                const oResult = this._buildPostMessageObject("request", oParams);
+                                this._sendPostMessage(PostMessageManager, oResult, oClient.iframe, oClient.origin);
+                            });
+                        }
                     }
                 }
             }
@@ -590,17 +614,17 @@ sap.ui.define([
          */
 
         this._handlePostMessageRequest = function (oMessageDataBody, oIframe, sOrigin) {
-            return new Promise(function (resolve, reject) {
+            return new Promise((resolve, reject) => {
 
-                var sClientId = oMessageDataBody.clientId,
-                    sChannelId = oMessageDataBody.channelId,
-                    sRequestId = oMessageDataBody.requestId,
-                    sMessageName = oMessageDataBody.messageName,
-                    aSubscribedChannels = oMessageDataBody.subscribedChannels,
-                    aTargetClientIds = oMessageDataBody.targetClientIds,
-                    data = oMessageDataBody.data;
+                const sClientId = oMessageDataBody.clientId;
+                const sChannelId = oMessageDataBody.channelId;
+                const sRequestId = oMessageDataBody.requestId;
+                let sMessageName = oMessageDataBody.messageName;
+                const aSubscribedChannels = oMessageDataBody.subscribedChannels;
+                const aTargetClientIds = oMessageDataBody.targetClientIds;
+                const data = oMessageDataBody.data;
 
-                var oApiParams = {
+                const oApiParams = {
                     connect: [
                         sClientId
                     ],
@@ -629,28 +653,39 @@ sap.ui.define([
                     ]
                 };
 
-                var oPostMessageParams = {
-                        channelId: sChannelId,
-                        clientId: sClientId,
-                        messageName: sMessageName,
-                        requestId: sRequestId
-                    };
-
-                var oResponseObject = this._buildPostMessageObject("response", oPostMessageParams);
+                const oPostMessageParams = {
+                    channelId: sChannelId,
+                    clientId: sClientId,
+                    messageName: sMessageName,
+                    requestId: sRequestId
+                };
 
                 sMessageName = oApiParams[sMessageName] ? sMessageName : "publish";
 
                 this._callApi(sMessageName, oApiParams[sMessageName])
-                    .then(function () {
+                    .then(() => {
                         if (sMessageName !== "publish") {
-                            oResponseObject.body.status = "accepted";
-                            PostMessageUtils.postMessageToIframeObject(oResponseObject, oIframe, sOrigin, false);
+                            if (Config.last("/core/navigation/enableAppLifeCycleFallback")) {
+                                sap.ui.require(["sap/ushell/components/applicationIntegration/application/PostMessageUtils"], (PostMessageUtils) => {
+                                    const oResponseObject = this._buildPostMessageObjectFallback(PostMessageUtils, "response", oPostMessageParams);
+                                    oResponseObject.body.status = "accepted";
+
+                                    PostMessageUtils.postMessageToIframeObject(oResponseObject, oIframe, sOrigin);
+                                });
+                            } else {
+                                sap.ui.require(["sap/ushell/components/applicationIntegration/PostMessageManager"], (PostMessageManager) => {
+                                    const oResult = this._buildPostMessageObject("response", oPostMessageParams);
+                                    oResult.messageBody.status = "accepted";
+
+                                    this._sendPostMessage(PostMessageManager, oResult, oIframe, sOrigin);
+                                });
+                            }
                         }
                         resolve({ _noresponse_: true });
-                    }).catch(function (sError) {
+                    }).catch((sError) => {
                         reject(sError);
                     });
-            }.bind(this));
+            });
         };
 
         /**
@@ -663,57 +698,148 @@ sap.ui.define([
          * @private
          */
 
-        this._buildPostMessageObject = function (sObjectType, oParams) {
-            var sServiceName = "sap.ushell.services.MessageBroker",
-                oMessageBody = {
-                    request: {
-                        channelId: oParams.channelId,
-                        clientId: oParams.clientId,
-                        messageName: oParams.messageName
-                    },
-                    response: {
-                        channelId: oParams.channelId,
-                        clientId: oParams.clientId,
-                        correlationMessageId: oParams.requestId,
-                        messageName: oParams.messageName
-                    },
-                    event: {
-                        channelId: oParams.channelId,
-                        clientId: oParams.clientId,
-                        messageName: oParams.messageName
-                    }
+        this._buildPostMessageObjectFallback = function (PostMessageUtils, sObjectType, oParams) {
+            const sServiceName = "sap.ushell.services.MessageBroker";
+
+            if (sObjectType === "response") {
+                const oMessageBody = {
+                    channelId: oParams.channelId,
+                    clientId: oParams.clientId,
+                    correlationMessageId: oParams.requestId,
+                    messageName: oParams.messageName
                 };
+                const oResponse = PostMessageUtils.createPostMessageResponse(
+                    sServiceName,
+                    oParams.requestId,
+                    oMessageBody,
+                    true
+                );
+                return oResponse;
 
-            switch (sObjectType) {
-                case "event":
-                    oMessageBody.event.channels = oParams.channels;
-                    break;
-                case "request":
-                    if (oParams.data) {
-                        oMessageBody[sObjectType].data = oParams.data;
-                    }
-                    break;
             }
 
-            var oObjectParams = {
-                request: [
-                    sServiceName,
-                    oMessageBody.request
-                ],
-                response: [
+            if (sObjectType === "event") {
+                const oMessageBody = {
+                    channelId: oParams.channelId,
+                    clientId: oParams.clientId,
+                    messageName: oParams.messageName,
+                    channels: oParams.channels
+                };
+                const oRequest = PostMessageUtils.createPostMessageRequest(
                     sServiceName,
-                    oParams.requestId,
-                    oMessageBody.response,
-                    true
-                ],
-                event: [
+                    oMessageBody
+                );
+                return oRequest;
+
+            }
+
+            if (sObjectType === "request") {
+                const oMessageBody = {
+                    channelId: oParams.channelId,
+                    clientId: oParams.clientId,
+                    messageName: oParams.messageName,
+                    data: oParams.data
+                };
+                const oRequest = PostMessageUtils.createPostMessageRequest(
                     sServiceName,
-                    oMessageBody.event
-                ]
+                    oMessageBody
+                );
+                return oRequest;
+            }
+
+            return PostMessageUtils.createPostMessageRequest(
+                sServiceName
+            );
+        };
+
+        /**
+         *
+         * @param {string} sType object type.
+         * @param {object} oParams object properties.
+         * @returns {object} relevant post message object.
+         *
+         * @since 1.134.0
+         * @private
+         */
+
+        this._buildPostMessageObject = function (sObjectType, oParams) {
+            const sServiceName = "sap.ushell.services.MessageBroker";
+
+            if (sObjectType === "response") {
+                const oMessageBody = {
+                    channelId: oParams.channelId,
+                    clientId: oParams.clientId,
+                    correlationMessageId: oParams.requestId,
+                    messageName: oParams.messageName
+                };
+                const oResult = {
+                    isRequest: false,
+                    requestId: oParams.requestId,
+                    isSuccess: true,
+                    serviceRequest: sServiceName,
+                    messageBody: oMessageBody
+                };
+                return oResult;
+
+            }
+
+            if (sObjectType === "event") {
+                const oMessageBody = {
+                    channelId: oParams.channelId,
+                    clientId: oParams.clientId,
+                    messageName: oParams.messageName,
+                    channels: oParams.channels
+                };
+                const oResult = {
+                    isRequest: true,
+                    serviceRequest: sServiceName,
+                    messageBody: oMessageBody
+                };
+                return oResult;
+
+            }
+
+            if (sObjectType === "request") {
+                const oMessageBody = {
+                    channelId: oParams.channelId,
+                    clientId: oParams.clientId,
+                    messageName: oParams.messageName,
+                    data: oParams.data
+                };
+                const oResult = {
+                    isRequest: true,
+                    serviceRequest: sServiceName,
+                    messageBody: oMessageBody
+                };
+                return oResult;
+            }
+
+            const oResult = {
+                isRequest: true,
+                serviceRequest: sServiceName
             };
+            return oResult;
+        };
 
-            var fnMethod = (sObjectType === "response" ? PostMessageUtils.createPostMessageResponse : PostMessageUtils.createPostMessageRequest);
-            return fnMethod.apply(this, oObjectParams[sObjectType]);
+        this._sendPostMessage = function (PostMessageManager, oResult, oContentWindow, sTargetOrigin) {
+            if (oResult.isRequest) {
+                PostMessageManager.sendRequest(
+                    oResult.serviceRequest,
+                    oResult.messageBody,
+                    oContentWindow,
+                    sTargetOrigin,
+                    false // bWaitForResponse
+                );
+            } else {
+                PostMessageManager.sendResponse(
+                    oResult.requestId,
+                    oResult.serviceRequest,
+                    oResult.messageBody,
+                    oResult.isSuccess,
+                    oContentWindow,
+                    sTargetOrigin
+                );
+            }
         };
 
         /**
@@ -743,7 +869,7 @@ sap.ui.define([
         this._deepCopy = function (oEntity) {
             return deepExtend(oEntity);
         };
-    };
+    }
 
     return new MessageBrokerEngine();
 }, false);