@sapui5/sap.ushell_abap 1.146.0 → 1.147.0

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpad/InitXhrLogon.js

@@ -0,0 +1,148 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+sap.ui.define([
+    "sap/ushell_abap/bootstrap/XhrLogonLibLoader", // triggers loading of the XHR logon lib, once required
+    "sap/ushell_abap/bootstrap/XhrLogonEventHandler",
+    "sap/ushell/bootstrap/Config",
+    "sap/base/Log",
+    "sap/ushell/Container"
+], (
+    XhrLogonLibLoader,
+    XhrLogonEventHandler,
+    BootstrapConfig,
+    Log,
+    Container
+) => {
+    "use strict";
+
+    class InitXhrLogon {
+        async run () {
+            await Promise.all([
+                this.#initXhrLogon(),
+                this.#initFrameLogonManager()
+            ]);
+        }
+
+        /**
+         * Determines the XHR logon mode based on the bootstrap configuration
+         * and the URL parameters sap-ushell-xhrLogon-mode and saml2.
+         * @returns {string} the logon mode
+         */
+        #getLogonMode () {
+            const oUshellConfig = BootstrapConfig.get();
+            const sSearch = this.getWindowLocationSearch();
+            const oUrlParameters = new URLSearchParams(sSearch);
+
+            return oUrlParameters.get("sap-ushell-xhrLogon-mode")
+            || (oUrlParameters.get("saml2")?.toLowerCase() === "disabled" ? "logoffAndRedirect" : undefined)
+            || oUshellConfig?.xhrLogon?.mode
+            || "frame";
+        }
+
+        /**
+         * Initializes and starts XHR logon lib based on a given configuration.
+         * <p>
+         *
+         * @private
+         */
+        async #initXhrLogon () {
+            const oXhrLogonLib = await XhrLogonLibLoader.getLib();
+
+            const sLogonMode = this.#getLogonMode();
+            const oXhrLogonEventHandler = this.createXhrLogonEventHandler(window, sLogonMode);
+            const oLogonManager = oXhrLogonLib.LogonManager.getInstance();
+            const oXHRLogonManager = oXhrLogonLib.XHRLogonManager.getInstance();
+            const oXhrLibConfig = {
+                explicitMatchOnCORS: true // avoids to send XHRLib HTTP headers to thirdparty services
+            };
+
+            oXhrLogonLib.start(oXhrLibConfig);
+
+            if (sLogonMode === "reload" || sLogonMode === "logoffAndRedirect") {
+                oLogonManager.unregisterAllHandlers();
+                oLogonManager.registerAuthHandler("*", (oEvent) => {
+                    oXhrLogonEventHandler.handleEvent(oEvent);
+                });
+            } else if (sLogonMode !== "frame") {
+                Log.warning(`Unknown setting for xhrLogonMode: '${sLogonMode}'. Using default mode 'frame'.`, null, "sap.ushell_abap.bootstrap.XhrLogon");
+            }
+
+            oXhrLogonLib.Log.set(this.#createUi5ConnectedXhrLogger());
+            this.#initXhrLogonIgnoreList(oXHRLogonManager);
+        }
+
+        async #initFrameLogonManager () {
+            const oXhrLogonLib = await XhrLogonLibLoader.getLib();
+            const oFrameLogonManager = oXhrLogonLib.FrameLogonManager.getInstance();
+            Container.oFrameLogonManager = oFrameLogonManager;
+        }
+
+        /**
+         * Creates a logger for XMLHttpRequest(s) that logs errors, warnings, info
+         * and debug messages via Log.
+         *
+         * @returns {object}
+         *    A logger that can be assigned to XMLHttpRequest.
+         *
+         * @private
+         */
+        #createUi5ConnectedXhrLogger () {
+            return ["error", "warning", "info", "debug"].reduce((oXhrLogger, sLevel) => {
+                oXhrLogger[sLevel] = function (sMsg) {
+                    return Log[sLevel](sMsg);
+                };
+                return oXhrLogger;
+            }, {});
+        }
+
+        /**
+         * Initializes the ignore list of the XHR logon manager.
+         * <p>
+         * If the UI5 resources (including the own bootstrap script) are loaded from an absolute URL
+         * (in case CDN is activated),
+         * this URL is added to the ignore list to prevent CORS preflight requests due to the X headers.
+         * We expect that all resources can be loaded without authentication in this case.
+         *
+         * @param {object} oXHRLogonManager
+         *     the logon frame manager instance to use
+         *
+         * @private
+         */
+        #initXhrLogonIgnoreList (oXHRLogonManager) {
+            const sOrigin = this.getLocationOrigin();
+            const sUi5ResourceRootUrl = sap.ui.require.toUrl("");
+
+            // add "/" to origin, as otherwise the following use case will match:
+            //      sUi5ResourceRootUrl: http://sap.com:123
+            //      sOrigin:             http://sap.com
+            if (sUi5ResourceRootUrl && sUi5ResourceRootUrl.indexOf(`${sOrigin}/`) === -1) {
+                // In case UI5 is loaded from a different domain (CDN / AKAMAI), that URL
+                // needs to be ignored for the XHR logon, as we expect that the resources
+                // are not protected.
+                oXHRLogonManager.ignore.add(sUi5ResourceRootUrl);
+            }
+        }
+
+        /**
+         * We expose a factory method for the tests and allow to pass a test double for the window object
+         *
+         * @param {object} oWindow the window object
+         * @param {string} sXhrLogonMode logon mode
+         * @returns {XhrLogonEventHandler} a new XhrLogonEventHandler
+         *
+         * @private
+         */
+        createXhrLogonEventHandler (oWindow, sXhrLogonMode) {
+            return new XhrLogonEventHandler(oWindow, sXhrLogonMode);
+        }
+
+        getWindowLocationSearch () {
+            return window.location.search;
+        }
+
+        getLocationOrigin () {
+            return window.location.origin;
+        }
+    }
+
+    return new InitXhrLogon();
+});

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpad/RequestPages.js

@@ -0,0 +1,86 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+sap.ui.define([
+    "sap/base/util/ObjectPath",
+    "sap/ushell/bootstrap/Config",
+    "sap/ushell/Container",
+    "sap/ushell/components/pages/controller/PagesAndSpaceId",
+    "sap/ushell/resources"
+], (
+    ObjectPath,
+    BootstrapConfig,
+    Container,
+    PagesAndSpaceId,
+    ushellResources
+) => {
+    "use strict";
+
+    class RequestPages {
+        #aInternTargets = [
+            "Shell-home",
+            "Launchpad-openFLPPage"
+        ];
+
+        #isRelevant () {
+            const oUshellConfig = BootstrapConfig.get();
+            if (!ObjectPath.get("ushell.spaces.enabled", oUshellConfig)) {
+                return false;
+            }
+
+            let sHash = this.getLocationHash();
+            sHash = sHash.startsWith("#") ? sHash.slice(1) : sHash;
+
+            return !sHash || this.#aInternTargets.some((sTarget) => sHash.startsWith(sTarget));
+        }
+
+        async run () {
+            if (!this.#isRelevant()) {
+                return;
+            }
+
+            await Promise.all([
+                this.#requestPagesPersonalization(),
+                this.#requestPagesContent()
+            ]);
+        }
+
+        async #requestPagesPersonalization () {
+            const PersonalizationV2 = await Container.getServiceAsync("PersonalizationV2");
+            const oPersId = {
+                container: "sap.ushell.cdm3-1.personalization",
+                item: "data"
+            };
+
+            const oScope = {
+                validity: "Infinity",
+                keyCategory: PersonalizationV2.KeyCategory.GENERATED_KEY,
+                writeFrequency: PersonalizationV2.WriteFrequency.HIGH,
+                clientStorageAllowed: false
+            };
+            const oPersonalizer = await PersonalizationV2.getPersonalizer(oPersId, oScope);
+            return oPersonalizer.getPersData();
+        }
+
+        async #requestPagesContent () {
+            await ushellResources.awaitResourceBundle();
+
+            const pId = PagesAndSpaceId.getPageAndSpaceId(this.getLocationHash());
+            const pPagePersistenceService = Container.getServiceAsync("PagePersistence");
+
+            const [
+                oIds,
+                PagePersistence
+            ] = await Promise.all([
+                pId,
+                pPagePersistenceService
+            ]);
+
+            await PagePersistence.getPage(oIds.pageId);
+        }
+
+        getLocationHash () {
+            return window.location.hash;
+        }
+    }
+
+    return new RequestPages();
+});

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpad.js

@@ -0,0 +1,63 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/base/Log",
+    "sap/ushell_abap/bootstrap/PlatformConfig",
+    "sap/ushell_abap/bootstrap/ThemeHandler",
+    "sap/ushell_abap/bootstrap/SAPCompanionConditionSetter",
+    "sap/ushell_abap/bootstrap/LoadLaunchpad/CreateRenderer",
+    "sap/ushell_abap/bootstrap/LoadLaunchpad/InitXhrLogon",
+    "sap/ushell_abap/bootstrap/LoadLaunchpad/RequestPages",
+    "sap/ushell_abap/bootstrap/DirectAppStart",
+    "sap/ushell/Container",
+    "sap/ushell/iconfonts",
+    "sap/ushell_abap/pbServices/ui2/Contracts"
+], (
+    Log,
+    PlatformConfig,
+    ThemeHandler,
+    SAPCompanionConditionSetter,
+    CreateRenderer,
+    InitXhrLogon,
+    RequestPages,
+    DirectAppStart,
+    Container,
+    IconFonts,
+    Contracts
+) => {
+    "use strict";
+
+    class LoadLaunchpad {
+        async run () {
+            const aParallelPromises = [];
+
+            // Call UI5 Core APIs only after the core is initialized
+            aParallelPromises.push(ThemeHandler.updateUnsafeBootTheme());
+            await PlatformConfig.setUI5Settings();
+
+            await Container.init("abap", {
+                abap: "sap.ushell_abap.adapters.abap",
+                hana: "sap.ushell_abap.adapters.hana"
+            });
+
+            aParallelPromises.push(Contracts.load());
+
+            aParallelPromises.push(CreateRenderer.run());
+
+            IconFonts.registerFiori2IconFont();
+
+            aParallelPromises.push(SAPCompanionConditionSetter.run().catch(() => {
+                Log.info("SAPCompanion conditions could not be set.");
+            }));
+
+            aParallelPromises.push(DirectAppStart.startApp());
+            aParallelPromises.push(RequestPages.run());
+
+            aParallelPromises.push(InitXhrLogon.run());
+
+            await Promise.all(aParallelPromises);
+        }
+    }
+
+    return new LoadLaunchpad();
+});

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpadModule.js

@@ -0,0 +1,11 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ushell_abap/bootstrap/LoadLaunchpad"
+], (
+    LoadLaunchpad
+) => {
+    "use strict";
+
+    LoadLaunchpad.run();
+});

package/src/main/js/sap/ushell_abap/bootstrap/PageSetsRequestHandler.js

@@ -0,0 +1,247 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ushell_abap/bootstrap/XhrFactory",
+    "sap/ui/thirdparty/jquery",
+    "sap/ushell_abap/pbServices/ui2/Utils",
+    "sap/base/Log"
+], (
+    XhrFactory,
+    jQuery,
+    ui2Utils,
+    Log
+) => {
+    "use strict";
+
+    /* global OData */
+
+    const S_PAGE_SETS_FALLBACK_URL_BASE = "/sap/opu/odata/UI2/PAGE_BUILDER_PERS";
+    const S_PAGE_SETS_FALLBACK_EXPAND = "Pages/PageChipInstances/Chip/ChipBags/ChipProperties,"
+            + "Pages/PageChipInstances/RemoteCatalog,"
+            + "Pages/PageChipInstances/ChipInstanceBags/ChipInstanceProperties,"
+            + "AssignedPages,DefaultPage";
+    const S_PAGE_SETS_FALLBACK_URL_RELATIVE = "PageSets('%2FUI2%2FFiori2LaunchpadHome')";
+
+    class PageSetsRequestHandler {
+        // Check (only once for this file) if sap-statistics is set in query parameter or local storage
+        #bSapStatistics = this.#isSapStatisticsSet();
+
+        /**
+         * Determines the URL for the PageSets OData service from the startup service result. If the URL is not set
+         * a hard-coded fallback URL is returned and set in the startupResult.
+         *
+         * @param {object} oStartupCallResult
+         * the startup service result object
+         * @param {string} sServicePropertyName
+         * the name of the service property in the startup result
+         * @param {string} sFallbackBaseUrl
+         * the fallback base URL to be used if the service URL is not set
+         * @param {string} sFallbackRelativeUrl
+         * the fallback relative URL to be used if the service URL is not set
+         * @param {string} sFallbackExpand
+         * the fallback expand parameter to be used if the service URL is not set
+         * @returns {string}
+         * the URL for the service, adjusted with the fallback values if necessary
+         */
+        #getAndAdjustServiceURL (oStartupCallResult, sServicePropertyName, sFallbackBaseUrl, sFallbackRelativeUrl, sFallbackExpand) {
+            let sServiceUrl;
+            let oServiceData; // shortcut for oStartupCallResult.services[sServicePropertyName]
+            let bFallbackApplied = false;
+
+            if (oStartupCallResult.services) {
+                if (oStartupCallResult.services[sServicePropertyName]) {
+                    oServiceData = oStartupCallResult.services[sServicePropertyName];
+                } else {
+                    oServiceData = {};
+                    oStartupCallResult.services[sServicePropertyName] = oServiceData;
+                    bFallbackApplied = true;
+                }
+            } else {
+                oServiceData = {};
+                oStartupCallResult.services = {};
+                oStartupCallResult.services[sServicePropertyName] = oServiceData;
+                bFallbackApplied = true;
+            }
+
+            if (!oServiceData.baseUrl || !oServiceData.relativeUrl) {
+                oServiceData.baseUrl = sFallbackBaseUrl;
+                oServiceData.relativeUrl = sFallbackRelativeUrl;
+                bFallbackApplied = true;
+            }
+
+            if (bFallbackApplied) {
+                Log.warning(
+                    `URL for ${sServicePropertyName} service not found in startup service result; fallback to default; cache invalidation might fail`,
+                    null,
+                    "sap.ushell_abap.bootstrap"
+                );
+            }
+
+            // clean trailing and leading slashes
+            if (oServiceData.baseUrl.lastIndexOf("/") !== oServiceData.baseUrl.length - 1) {
+                // modify the startUpResult, to simplify the adapter code later
+                oServiceData.baseUrl += "/";
+            }
+            if (oServiceData.relativeUrl[0] === "/") {
+                // modify the startUpResult, to simplify the adapter code later
+                oServiceData.relativeUrl = oServiceData.relativeUrl.slice(1);
+            }
+
+            sServiceUrl = oServiceData.baseUrl + oServiceData.relativeUrl;
+
+            // add parameters if needed
+            // Note: order should always be 1. $expand, 2. sap-cache-id=, 3. additional params;
+            // as OData.read.$cache may otherwise not work properly
+            if (!/\$expand=/.test(sServiceUrl) && sFallbackExpand) {
+                // no expand, add fallback expand (if not "")
+                sServiceUrl += `${sServiceUrl.indexOf("?") < 0 ? "?" : "&"}$expand=${sFallbackExpand}`;
+            }
+            if (oServiceData.cacheId) {
+                sServiceUrl += `${sServiceUrl.indexOf("?") < 0 ? "?" : "&"}sap-cache-id=${oServiceData.cacheId}`;
+            }
+            if (oServiceData["sap-ui2-cache-disable"]) {
+                sServiceUrl += `${sServiceUrl.indexOf("?") < 0 ? "?" : "&"}sap-ui2-cache-disable=${oServiceData["sap-ui2-cache-disable"]}`;
+            }
+
+            return sServiceUrl;
+        }
+
+        /**
+         * Processes the OData response.
+         * @param {jQuery.Deferred} oDeferred
+         *     the deferred object updating the cache in OData.read
+         * @param {int} iStatus
+         *     the status code
+         * @param {string} sCsrfToken
+         *    the CSRF token
+         * @param {string} sResponse
+         *    the response message
+         */
+        #processOData (oDeferred, iStatus, sCsrfToken, sResponse) {
+            if (iStatus === 200) {
+                oDeferred.resolve(JSON.parse(sResponse).d, sCsrfToken);
+            } else {
+                // rejecting the deferred will make the request later (in the ushell adapter) fail, so
+                // the error handling there takes effect
+                oDeferred.reject(new Error(`PageSet request failed: ${sResponse}`));
+            }
+        }
+
+        /**
+         * Determines the URL for the PageSets OData service from the startup service result. If the URL is not set
+         * a hard-coded fallback URL is returned and set in the startupResult.
+         *
+         * @param {object} oStartupCallResult
+         * the startup service result object
+         * @returns {string}
+         * the URL for the PageSets OData service
+         */
+        #getAndAdjustPageSetServiceURL (oStartupCallResult) {
+            const sSearch = this.getWindowLocationSearch();
+            const oUrlParameters = new URLSearchParams(sSearch);
+
+            const sUI2CacheDisable = oUrlParameters.get("sap-ui2-cache-disable");
+            if (sUI2CacheDisable && oStartupCallResult && oStartupCallResult.services && oStartupCallResult.services.pbFioriHome) {
+                oStartupCallResult.services.pbFioriHome["sap-ui2-cache-disable"] = sUI2CacheDisable;
+            }
+            return this.#getAndAdjustServiceURL(
+                oStartupCallResult,
+                "pbFioriHome",
+                S_PAGE_SETS_FALLBACK_URL_BASE,
+                S_PAGE_SETS_FALLBACK_URL_RELATIVE,
+                S_PAGE_SETS_FALLBACK_EXPAND
+            );
+        }
+
+        /**
+         * Creates the Deferred in the OData.read cache to keep the result of the request with the
+         * given URL.
+         * @param {string} sUrl
+         * the URL to be requested
+         * @returns {jQuery.Deferred}
+         * the deferred object which will be resolved with the response of the request
+         *
+         * @private
+         */
+        #createODataDeferred (sUrl) {
+            const oDeferred = new jQuery.Deferred();
+            // creating the deferred objects here should ensure that the ushell adapters later read
+            // the responses from the "cache", even if UI5 bootstrap is faster than the
+            // OData requests
+            sap.ui.require(["sap/ui/thirdparty/datajs"], (datajs) => {
+                OData.read.$cache = OData.read.$cache || new ui2Utils.Map();
+                OData.read.$cache.put(sUrl, oDeferred.promise());
+            });
+            return oDeferred;
+        }
+
+        /**
+         * Performs an OData GET request using a plain XHR.
+         * @param {string} sUrl
+         * the url to be requested
+         * @param {object} oStartupResult
+         * the startup result object, containing the base URL and the CSRF token
+         * @param {function(number, object, function)} fnCallback
+         *    callback function to be called when the request finished, taking the status code, the
+         *    CSRF token and the response message
+         */
+        #requestOData (sUrl, oStartupResult, fnCallback) {
+            const oXhr = XhrFactory.createAndOpen(sUrl, oStartupResult);
+            // set sap-statistics header, see
+            // http://help.sap.com/saphelp_nw74/helpdata/de/40/93b81292194d6a926e105c10d5048d/content.htm
+            if (this.#bSapStatistics) {
+                oXhr.setRequestHeader("sap-statistics", "true");
+            }
+            oXhr.onreadystatechange = function () {
+                if (this.readyState !== /* DONE */4) {
+                    return; // not yet DONE
+                }
+                fnCallback(oXhr.status, undefined /* csrf token */, oXhr.responseText);
+            };
+            oXhr.send();
+        }
+
+        requestPageSets (oStartupResult) {
+            const sPageSetServiceUrl = this.#getAndAdjustPageSetServiceURL(oStartupResult);
+            const oDeferred = this.#createODataDeferred(sPageSetServiceUrl);// TODO make as Promise.all
+
+            this.#requestOData(sPageSetServiceUrl, oStartupResult, (iStatus, sCsrfToken, sResponse) => {
+                this.#processOData(oDeferred, iStatus, sCsrfToken, sResponse);
+            });
+        }
+
+        /**
+         * Checks if the sap-statistics setting as query parameter or via local storage, as
+         * UI5 does it in some cases.
+         * @returns {boolean} true if the sap-statistics is set as query parameter or via local storage
+         * @private
+         */
+        #isSapStatisticsSet () {
+            const sWindowLocationSearch = this.getWindowLocationSearch();
+            let bSapStatistics = /sap-statistics=(true|x|X)/.test(sWindowLocationSearch);
+            if (!bSapStatistics) {
+                try {
+                    // UI5's config cannot be used here, so check local storage
+                    bSapStatistics = window.localStorage.getItem("sap-ui-statistics") === "X";
+                } catch (oError) {
+                    Log.warning(
+                        "failed to read sap-statistics setting from local storage",
+                        oError,
+                        "sap.ushell_abap.bootstrap.PageSetsRequestHandler"
+                    );
+                }
+            }
+            return !!bSapStatistics; // needed for tests only
+        }
+
+        getWindowLocationSearch () {
+            return window.location.search;
+        }
+
+        reset () {
+            this.#bSapStatistics = this.#isSapStatisticsSet();
+        }
+    }
+
+    return new PageSetsRequestHandler();
+});