@sapui5/sap.ushell_abap 1.145.1 → 1.147.0

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();
+});