@sapui5/sap.ushell_abap 1.150.1 → 1.152.0

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

@@ -14,6 +14,7 @@ sap.ui.define([
     "sap/ushell_abap/pbServices/ui2/Contracts",
     "sap/ushell/Container",
     "sap/ushell/iconfonts",
+    "sap/ushell/utils/LogScope",
     "sap/ushell_abap/integration/WebSsoBridge"
 ], (
     Log,
@@ -27,6 +28,7 @@ sap.ui.define([
     Contracts,
     Container,
     IconFonts,
+    LogScope,
     WebSsoBridge
 ) => {
     "use strict";
@@ -48,6 +50,10 @@ sap.ui.define([
          * @private
          */
         async run () {
+            // Apply targeted log-level scopes before the Container starts up any service.
+            // Lets ?sap-ushell-xx-log-scope=navigation,fesr lift just those components to DEBUG without flooding DevTools.
+            LogScope.applyFromUrl();
+
             const aParallelPromises = [];
 
             // Call UI5 Core APIs only after the core is initialized

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

@@ -5,19 +5,17 @@
  */
 sap.ui.define([
     "sap/base/Log",
-    "sap/ui/thirdparty/jquery",
+    "sap/ushell/base/requireAsync",
     "sap/ushell_abap/bootstrap/XhrFactory",
-    "sap/ushell_abap/pbServices/ui2/Utils"
+    "sap/ushell_abap/base/Ui2Utils"
 ], (
     Log,
-    jQuery,
+    requireAsync,
     XhrFactory,
     ui2Utils
 ) => {
     "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,"
@@ -114,25 +112,6 @@ sap.ui.define([
             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
-         *
-         * @private
-         */
-        #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.
@@ -160,35 +139,24 @@ sap.ui.define([
         }
 
         /**
-         * 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
+         * 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
+         * @returns {Promise<object>} Resolves the response
          *
          * @private
          */
-        #createODataDeferred (sUrl) {
-            const oDeferred = new jQuery.Deferred();
+        #sendODataRequest (sUrl, oStartupResult) {
+            const oDeferred = Promise.withResolvers();
+
             // 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());
+            requireAsync(["sap/ui/thirdparty/datajs"]).then(([datajs]) => {
+                datajs.read.$cache = datajs.read.$cache || new ui2Utils.Map();
+                datajs.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
-         *
-         * @private
-         */
-        #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
@@ -199,18 +167,25 @@ sap.ui.define([
                 if (this.readyState !== /* DONE */4) {
                     return; // not yet DONE
                 }
-                fnCallback(oXhr.status, undefined /* csrf token */, oXhr.responseText);
+
+                if (oXhr.status === 200) {
+                    oDeferred.resolve([JSON.parse(oXhr.responseText).d, undefined /* 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: ${oXhr.responseText}`));
+                }
             };
+
             oXhr.send();
+
+            return oDeferred.promise;
         }
 
-        requestPageSets (oStartupResult) {
+        async 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);
-            });
+            await this.#sendODataRequest(sPageSetServiceUrl, oStartupResult);
         }
 
         /**

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

@@ -7,11 +7,9 @@
  */
 sap.ui.define([
     "sap/base/Log",
-    "sap/base/util/Deferred",
     "sap/ushell/bootstrap/Config"
 ], (
     Log,
-    Deferred,
     BootstrapConfig
 ) => {
     "use strict";
@@ -43,7 +41,7 @@ sap.ui.define([
         }
 
         run () {
-            const oDeferred = new Deferred();
+            const oDeferred = Promise.withResolvers();
 
             function fnKeepTrying () {
                 if (this.#counter < this.#timeoutCounter) {

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

@@ -4,16 +4,16 @@
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",
-    "sap/ushell_abap/bootstrap/XhrFactory",
-    "sap/ushell_abap/pbServices/ui2/Utils",
     "sap/ushell/base/SAPBusinessClientEnablement",
-    "sap/ushell/bootstrap/Config"
+    "sap/ushell/bootstrap/Config",
+    "sap/ushell_abap/base/Ui2Utils",
+    "sap/ushell_abap/bootstrap/XhrFactory"
 ], (
     ObjectPath,
-    XhrFactory,
-    ui2Utils,
     SAPBusinessClientEnablement,
-    BootstrapConfig
+    BootstrapConfig,
+    ui2Utils,
+    XhrFactory
 ) => {
     "use strict";
 

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

@@ -171,6 +171,7 @@ sap.ui.define([
                     }
                 },
                 NavigationDataProvider: {
+                    module: "sap.ushell_abap.services.NavigationDataProvider",
                     adapter: {
                         module: "sap.ushell_abap.adapters.abap.ClientSideTargetResolutionAdapter"
                     }

package/src/main/js/sap/ushell_abap/integration/fileshares/NavTargetResolutionFileShareSupport.js

@@ -3,10 +3,12 @@
 sap.ui.define([
     "sap/base/Log",
     "sap/ui/core/Manifest",
+    "sap/ushell/base/promisify",
     "sap/ushell/Container"
 ], (
     Log,
     Manifest,
+    promisify,
     Container
 ) => {
     "use strict";
@@ -46,7 +48,7 @@ sap.ui.define([
     NavTargetResolutionFileShareSupport.getDataSource = function () {
         if (!NavTargetResolutionFileShareSupport._getDataSourcePromise) {
             NavTargetResolutionFileShareSupport._getDataSourcePromise = Container.getServiceAsync("NavTargetResolutionInternal").then((oNavTargetResolutionService) => {
-                return oNavTargetResolutionService.resolveHashFragment(FILE_SHARE_INTENT); // jQuery promise is implicitly converted to native
+                return promisify(oNavTargetResolutionService.resolveHashFragment(FILE_SHARE_INTENT));
             }).then((oResolvedHashFragment) => {
                 const sManifestUrl = oResolvedHashFragment && oResolvedHashFragment.applicationDependencies && oResolvedHashFragment.applicationDependencies.manifest;
                 if (sManifestUrl) {

package/src/main/js/sap/ushell_abap/library.js

@@ -32,7 +32,7 @@ sap.ui.define([
     const ushellAbapLib = Library.init({
         name: "sap.ushell_abap",
         apiVersion: 2,
-        version: "1.150.1",
+        version: "1.152.0",
         dependencies: [
             "sap.ui.core",
             "sap.m",

package/src/main/js/sap/ushell_abap/pbServices/ui2/AllCatalogs.js

@@ -6,7 +6,7 @@
  */
 
 sap.ui.define([
-    "sap/ushell_abap/pbServices/ui2/Error",
+    "sap/ushell_abap/base/Ui2Error",
     "sap/base/Log"
 ], (
     SrvcError,

package/src/main/js/sap/ushell_abap/pbServices/ui2/Bag.js

@@ -5,8 +5,8 @@
  */
 
 sap.ui.define([
-    "sap/ushell_abap/pbServices/ui2/Utils",
-    "sap/ushell_abap/pbServices/ui2/Error",
+    "sap/ushell_abap/base/Ui2Utils",
+    "sap/ushell_abap/base/Ui2Error",
     "sap/base/Log"
 ], (
     Utils,

package/src/main/js/sap/ushell_abap/pbServices/ui2/Catalog.js

@@ -6,16 +6,14 @@
 
 sap.ui.define([
     "sap/ui/core/EventBus",
-    "sap/ushell_abap/pbServices/ui2/Error",
-    "sap/ushell_abap/pbServices/ui2/Utils",
-    "sap/base/Log",
-    "sap/ui/thirdparty/jquery"
+    "sap/ushell_abap/base/Ui2Error",
+    "sap/ushell_abap/base/Ui2Utils",
+    "sap/base/Log"
 ], (
     EventBus,
-    SrvcError,
-    Utils,
-    Log,
-    jQuery
+    Ui2Error,
+    Ui2Utils,
+    Log
 ) => {
     "use strict";
 
@@ -53,11 +51,13 @@ sap.ui.define([
         let oAlterEgo; // catalog's representation with all relations removed
         let oCatalogPage;
         let aChips = [];
-        let oReadPromise; // if existing and in state "pending", a load/refresh is running; see read
+        let oReadPromise; // shared in-flight promise; see read
+        let bReadPending = false; // true while oReadPromise is in flight
         let bIsStub = true; // TODO replace by aChips === undefined
         let oCachedRemoteErrorArgs;
         let sId;
         let oReadRegisteredChipsPromise; // see readRegisteredChips
+        let bReadRegisteredChipsPending = false; // true while oReadRegisteredChipsPromise is in flight
         let aRegisteredChipIds = [];
         const that = this;
 
@@ -71,7 +71,7 @@ sap.ui.define([
          */
         function checkStub () {
             if (bIsStub) {
-                throw new SrvcError(`${that}: page is just a stub`, "Page");
+                throw new Ui2Error(`${that}: page is just a stub`, "Page");
             }
         }
 
@@ -82,7 +82,7 @@ sap.ui.define([
          */
         function checkAlterEgo () {
             if (!oAlterEgo) {
-                throw new SrvcError(`${that}: catalog is just an ID`, "Catalog");
+                throw new Ui2Error(`${that}: catalog is just an ID`, "Catalog");
             }
         }
 
@@ -106,7 +106,9 @@ sap.ui.define([
             aChips = [];
             bIsStub = true;
             oReadPromise = undefined;
+            bReadPending = false;
             oReadRegisteredChipsPromise = undefined;
+            bReadRegisteredChipsPending = false;
             aRegisteredChipIds = [];
 
             // delete methods on deleted catalog to prevent wrong behavior
@@ -141,11 +143,10 @@ sap.ui.define([
         this.getRemoteCatalogService = function () {
             return oFactory.getRemoteCatalogService(oAlterEgo) || {
                 readChips: function (sBaseUrl, sCatalogId, aChipIds, fnSuccess, fnFailure) {
-                    Log.error(`Catalog '${oAlterEgo.id}', type '${oAlterEgo.type
-                        }' not supported`, null, "Catalog");
+                    Log.error(`Catalog '${oAlterEgo.id}', type '${oAlterEgo.type}' not supported`, null, "Catalog");
                     // fake an empty response to make the catalog valid
                     // When created with alterEgo, we're still synchronous, so make it async
-                    Utils.callHandler(fnSuccess.bind(null, { results: [] }), undefined, /* async=*/true);
+                    Ui2Utils.callHandler(fnSuccess.bind(null, { results: [] }), undefined, /* async=*/true);
                 }
             };
         };
@@ -199,7 +200,8 @@ sap.ui.define([
          * @private
          */
         this.read = function (bRefresh, fnSuccess, fnFailure) {
-            let oDeferred;
+            // only relevant when no read is already in progress
+            const oReadDeferred = Promise.withResolvers();
 
             /**
              * @param {object} oResult
@@ -208,7 +210,8 @@ sap.ui.define([
             function onCatalogLoaded (oResult) {
                 oAlterEgo = oResult;
                 initialize();
-                oDeferred.resolve();
+                bReadPending = false;
+                oReadDeferred.resolve();
             }
 
             /**
@@ -218,7 +221,8 @@ sap.ui.define([
             function onChipsLoaded (oResult) {
                 oAlterEgo.Chips = oResult;
                 initialize();
-                oDeferred.resolve();
+                bReadPending = false;
+                oReadDeferred.resolve();
             }
 
             /**
@@ -244,10 +248,12 @@ sap.ui.define([
              *   delivered by the ODataService. See fnFailure parameter of {@link sap.ushell_abap.pbServices.ui2.ODataWrapper#onError}
              *   for more details.
              */
-            function couldNotLoadRemoteChips () {
+            function couldNotLoadRemoteChips (sErrMsg, oErrDetails) {
                 initialize(); // fail gracefully
-                oCachedRemoteErrorArgs = arguments;
-                oDeferred.reject.apply(this, arguments);
+                // Store as array so getCachedRemoteFailureArguments()[0] and [1] work correctly
+                oCachedRemoteErrorArgs = [sErrMsg, oErrDetails];
+                bReadPending = false;
+                oReadDeferred.reject(oCachedRemoteErrorArgs);
             }
 
             /**
@@ -275,21 +281,29 @@ sap.ui.define([
                 }
             }
 
-            if (!oReadPromise || oReadPromise.state() !== "pending") {
-                oDeferred = new jQuery.Deferred();
-                oReadPromise = oDeferred.promise();
+            if (!bReadPending) {
+                bReadPending = true;
+                // No in-flight read — start a new one
+                oReadPromise = oReadDeferred.promise;
                 if (!oAlterEgo || (bRefresh && !oAlterEgo.remoteId)) {
                     // read the local catalog if it is unknown yet or if refreshing a non-remote catalog
-                    oFactory.getPageBuildingService().readCatalog(sId, processLocalResponse,
-                        oDeferred.reject.bind(oDeferred));
+                    oFactory.getPageBuildingService().readCatalog(
+                        sId,
+                        processLocalResponse,
+                        (sErrMsg, oErrDetails) => {
+                            bReadPending = false;
+                            oReadDeferred.reject([sErrMsg, oErrDetails]);
+                        }
+                    );
                 } else {
                     processLocalResponse.bind(this)(oAlterEgo);
                 }
             }
             fnFailure = fnFailure || oFactory.getPageBuildingService().getDefaultErrorHandler();
             // TODO this needs "sap.ushell_abap.pbServices.ui2.utils" which is never required!
-            oReadPromise.done(Utils.callHandler.bind(null, fnSuccess, fnFailure));
-            oReadPromise.fail(fnFailure);
+            oReadPromise
+                .then(() => { Ui2Utils.callHandler(fnSuccess, fnFailure); })
+                .catch((aRejectArgs) => { fnFailure(aRejectArgs[0], aRejectArgs[1]); });
         };
 
         // "public" methods ----------------------------------------------------------
@@ -334,7 +348,7 @@ sap.ui.define([
         this.addSystemToServiceUrl = function (sServiceUrl, sSystem) {
             /* jslint regexp:true */
             if (sServiceUrl.indexOf("/") !== 0 || sServiceUrl.indexOf("//") === 0) {
-                throw new SrvcError(`addSystemToServiceUrl: Invalid URL: ${sServiceUrl}`,
+                throw new Ui2Error(`addSystemToServiceUrl: Invalid URL: ${sServiceUrl}`,
                     "Catalog");
             }
             sSystem = sSystem || this.getSystemAlias();
@@ -495,7 +509,7 @@ sap.ui.define([
          */
         this.getChips = function () {
             if (bIsStub) {
-                throw new SrvcError(`${that}: catalog is just a stub`, "Catalog");
+                throw new Ui2Error(`${that}: catalog is just a stub`, "Catalog");
             }
             return aChips.slice();
         };
@@ -657,7 +671,7 @@ sap.ui.define([
          */
         this.load = function (fnSuccess, fnFailure) {
             if (!bIsStub) {
-                throw new SrvcError("Catalog is not a stub anymore", "Catalog");
+                throw new Ui2Error("Catalog is not a stub anymore", "Catalog");
             }
             this.read(false, fnSuccess, fnFailure);
         };
@@ -686,7 +700,7 @@ sap.ui.define([
                     oFactory.createChip(oRawChipData);
                 });
                 // TODO this needs "utils" which is never required!
-                Utils.callHandler(fnSuccess, fnFailure);
+                Ui2Utils.callHandler(fnSuccess, fnFailure);
             }
 
             function createRemoteChips (oRawData) {
@@ -734,26 +748,38 @@ sap.ui.define([
          */
         this.readRegisteredChips = function (fnSuccess, fnFailure) {
             function start () {
-                const oDeferred = new jQuery.Deferred();
+                const oReadDeferred = Promise.withResolvers();
                 const aChipIds = aRegisteredChipIds;
 
                 aRegisteredChipIds = [];
+                bReadRegisteredChipsPending = true;
                 if (aChipIds.length) {
-                    that.readChips(aChipIds, oDeferred.resolve.bind(oDeferred),
-                        oDeferred.reject.bind(oDeferred));
+                    that.readChips(
+                        aChipIds,
+                        () => {
+                            bReadRegisteredChipsPending = false;
+                            oReadDeferred.resolve();
+                        },
+                        (sErrMsg, oErrDetails) => {
+                            bReadRegisteredChipsPending = false;
+                            oReadDeferred.reject([sErrMsg, oErrDetails]);
+                        }
+                    );
                 } else {
-                    oDeferred.resolve();
+                    bReadRegisteredChipsPending = false;
+                    oReadDeferred.resolve();
                 }
-                return oDeferred.promise();
+                return oReadDeferred.promise;
             }
 
-            if (!oReadRegisteredChipsPromise || oReadRegisteredChipsPromise.state() !== "pending") {
+            if (!oReadRegisteredChipsPromise || !bReadRegisteredChipsPending) {
                 oReadRegisteredChipsPromise = start();
             }
             fnFailure = fnFailure || oFactory.getPageBuildingService().getDefaultErrorHandler();
             // TODO this needs "utils" which is never required!
-            oReadRegisteredChipsPromise.fail(fnFailure)
-                .done(Utils.callHandler.bind(null, fnSuccess, fnFailure));
+            oReadRegisteredChipsPromise
+                .then(() => { Ui2Utils.callHandler(fnSuccess, fnFailure); })
+                .catch((aRejectArgs) => { fnFailure(aRejectArgs[0], aRejectArgs[1]); });
         };
 
         /**
@@ -788,8 +814,8 @@ sap.ui.define([
          * @private
          */
         this.registerChip = function (oChip) {
-            if (oReadRegisteredChipsPromise && oReadRegisteredChipsPromise.state() === "pending") {
-                throw new SrvcError(
+            if (bReadRegisteredChipsPending) {
+                throw new Ui2Error(
                     "Invalid state: registerChip while readRegisteredChips pending",
                     "Catalog"
                 );
@@ -821,8 +847,8 @@ sap.ui.define([
          */
         this.remove = function (fnSuccess, fnFailure) {
             checkAlterEgo();
-            if (oReadPromise && oReadPromise.state() === "pending") {
-                throw new SrvcError(`Catalog is being refreshed: ${this}`,
+            if (bReadPending) {
+                throw new Ui2Error(`Catalog is being refreshed: ${this}`,
                     "Catalog");
             }
 
@@ -897,7 +923,7 @@ sap.ui.define([
             checkAlterEgo();
             if (Object.hasOwnProperty.call(oCatalogData, "__metadata")) {
                 // ODataWrapper#update() relies on __metadata!
-                throw new SrvcError("Unsupported __metadata update", "Catalog");
+                throw new Ui2Error("Unsupported __metadata update", "Catalog");
             }
             const oNewAlterEgo = JSON.parse(JSON.stringify(oAlterEgo));
             Object.keys(oCatalogData).forEach((sName) => {
@@ -931,7 +957,7 @@ sap.ui.define([
             sId = vCatalogData;
         }
         if (!sId) {
-            throw new SrvcError("Missing ID", "Catalog");
+            throw new Ui2Error("Missing ID", "Catalog");
         }
         Log.debug(`Created: ${this}`, null, "Catalog");
     }