@sapui5/sap.ushell_abap 1.151.0 → 1.152.0

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

@@ -11,8 +11,7 @@ sap.ui.define([
     "sap/ushell_abap/base/Ui2Utils",
     "sap/ushell_abap/pbServices/ui2/ODataService",
     "sap/ushell_abap/base/Ui2Error",
-    "sap/base/Log",
-    "sap/ui/thirdparty/jquery"
+    "sap/base/Log"
 ], (
     datajs,
     Localization,
@@ -20,26 +19,23 @@ sap.ui.define([
     Utils,
     ODataService,
     SrvcError,
-    Log,
-    jQuery
+    Log
 ) => {
     "use strict";
 
-    /* global OData */
-
     function nop () { /* null object pattern */ }
     /**
-     * Reject the given <code>jQuery.Deferred</code> object(s) (array or single one) with the
+     * Reject the given Deferred object(s) (array or single one) with the
      * given error response.
      *
-     * @param {jQuery.Deferred|jQuery.Deferred[]} vDeferred
+     * @param {object|object[]} vDeferred
      *   deferred or array of deferreds to be rejected
      * @param {object} oResponse
      *   parameter of (each) reject call
      */
     function reject (vDeferred, oResponse) {
         if (Array.isArray(vDeferred)) {
-            // a failed change set: reject each single jQuery.Deferred in the same way
+            // a failed change set: reject each single Deferred in the same way
             vDeferred.forEach((oDeferred) => {
                 oDeferred.reject(oResponse);
             });
@@ -355,7 +351,7 @@ sap.ui.define([
             addGlobalSapHeaders(oHeaders);
             addStickySessionHeader(oHeaders);
 
-            OData.request({
+            datajs.request({
                 requestUri: sRequestUrl,
                 method: sMethod,
                 data: oPayload,
@@ -363,9 +359,7 @@ sap.ui.define([
             },
             (oData, oResponse) => {
                 this.detectStickySession((oResponse || {}).headers);
-                Log.debug(`Received OData response for ${sMethod} "${sRequestUrl}"`,
-                    null,
-                    "ODataWrapper");
+                Log.debug(`Received OData response for ${sMethod} "${sRequestUrl}"`, null, "ODataWrapper");
                 // Note: drop excess parameters; try/catch
                 Utils.callHandler(fnSuccess.bind(null, oData), fnFailure);
             },
@@ -382,9 +376,7 @@ sap.ui.define([
                         && oError.response.statusCode === 403
                         && ODataWrapper.csrfTokenValue(oError.response.headers).toLowerCase() === "required") {
                     // refresh CSRF token and repeat original request
-                    Log.debug(`CSRF token required for ${sMethod} "${sRequestUrl
-                    }", refreshing it`, JSON.stringify(oError.response),
-                    "ODataWrapper");
+                    Log.debug(`CSRF token required for ${sMethod} "${sRequestUrl}", refreshing it`, JSON.stringify(oError.response), "ODataWrapper");
 
                     oODataService.refreshCsrfToken(
                         this.doRequest.bind(that, sRequestUrl, sMethod, oPayload, success, failure, oHandler, /* bIsRepeatedRequest */ true),
@@ -395,8 +387,7 @@ sap.ui.define([
                 }
             },
             oHandler);
-            Log.debug(`Sent OData request for ${sMethod} "${sRequestUrl}"`, null,
-                "ODataWrapper");
+            Log.debug(`Sent OData request for ${sMethod} "${sRequestUrl}"`, null, "ODataWrapper");
         };
 
         /**
@@ -414,8 +405,7 @@ sap.ui.define([
         this.toRelativeUrl = function (sRequestUrl) {
             const i = sRequestUrl.indexOf(sBaseUrl);
             if (i < 0) {
-                throw new SrvcError(`Not relative to base URL "${sBaseUrl}": ${sRequestUrl}`,
-                    "ODataWrapper");
+                throw new SrvcError(`Not relative to base URL "${sBaseUrl}": ${sRequestUrl}`, "ODataWrapper");
             }
             return sRequestUrl.slice(i + sBaseUrl.length);
         };
@@ -432,8 +422,7 @@ sap.ui.define([
          */
         this.toRequestUrl = function (sRelativeUrl) {
             if (/^\//.test(sRelativeUrl)) {
-                throw new SrvcError(`Not a relative URL: ${sRelativeUrl}`,
-                    "ODataWrapper");
+                throw new SrvcError(`Not a relative URL: ${sRelativeUrl}`, "ODataWrapper");
             }
             return sBaseUrl + sRelativeUrl;
         };
@@ -460,20 +449,22 @@ sap.ui.define([
             // if sRelativeUrl is empty, we ask for the service document, which is only used for fetching an XSRF token,
             // so we are not taking already queued requests into account.
             if (aBatchQueue && sRelativeUrl !== "") {
-                Log.debug(`Queued OData request for GET "${sRelativeUrl}"`, null,
-                    "ODataWrapper");
+                Log.debug(`Queued OData request for GET "${sRelativeUrl}"`, null, "ODataWrapper");
                 aBatchQueue.push({
                     method: "GET",
                     requestUri: sRelativeUrl,
                     headers: oHeaders
                 });
-                oDeferred = (new jQuery.Deferred()).done(fnRawSuccess).fail(fnRawFailure);
+                oDeferred = Promise.withResolvers();
+                oDeferred.promise
+                    .then(([oData, oResponse]) => fnRawSuccess(oData, oResponse))
+                    .catch(fnRawFailure);
                 aDeferredQueue.push(oDeferred);
                 bChangeSetOpen = false;
                 return;
             }
 
-            // add specifc headers for read request
+            // add specific headers for read request
             oHeaders.Accept = "application/json";
             oHeaders["Accept-Language"] = Localization.getLanguage() || "";
             // always fetch a new token with GET requests;
@@ -481,12 +472,11 @@ sap.ui.define([
             // see internal BCP incident 1570753380
             oHeaders["X-CSRF-Token"] = "Fetch";
 
-            OData.read({
+            datajs.read({
                 requestUri: sRequestUrl,
                 headers: oHeaders
             }, fnRawSuccess, fnRawFailure);
-            Log.debug(`Sent OData request for GET "${sRequestUrl}"`, null,
-                "ODataWrapper");
+            Log.debug(`Sent OData request for GET "${sRequestUrl}"`, null, "ODataWrapper");
         };
 
         /**
@@ -532,14 +522,15 @@ sap.ui.define([
                     bChangeSetOpen = bSupportsChangeSets;
                 }
                 aBatchQueue[aBatchQueue.length - 1].__changeRequests.push(oChangeRequest);
-                oDeferred = (new jQuery.Deferred())
-                    .done((oData, oResponse) => {
+                oDeferred = Promise.withResolvers();
+                oDeferred.promise
+                    .then(([oData]) => {
                         Log.debug(`Received OData response for ${
                             sMethod} "${sRequestUrl}"`, null, "ODataWrapper");
                         // Note: drop excess parameters; try/catch
                         Utils.callHandler(fnSuccess.bind(null, oData), fnFailure);
                     })
-                    .fail(that.onError.bind(that, sMethod, sRequestUrl, fnFailure, /* oDeferred */null));
+                    .catch(that.onError.bind(that, sMethod, sRequestUrl, fnFailure, /* oDeferred */null));
                 aDeferredQueue[aDeferredQueue.length - 1].push(oDeferred);
                 return;
             }
@@ -628,20 +619,16 @@ sap.ui.define([
          */
         this.check = function (fnSuccess, fnFailure) {
             if (!fnSuccess) {
-                throw new SrvcError("Missing success callback",
-                    "ODataWrapper");
+                throw new SrvcError("Missing success callback", "ODataWrapper");
             }
             if (typeof fnSuccess !== "function") {
-                throw new SrvcError("Success callback is not a function",
-                    "ODataWrapper");
+                throw new SrvcError("Success callback is not a function", "ODataWrapper");
             }
             if (!fnFailure) {
-                throw new SrvcError("Missing error callback",
-                    "ODataWrapper");
+                throw new SrvcError("Missing error callback", "ODataWrapper");
             }
             if (typeof fnFailure !== "function") {
-                throw new SrvcError("Error callback is not a function",
-                    "ODataWrapper");
+                throw new SrvcError("Error callback is not a function", "ODataWrapper");
             }
         };
 
@@ -771,9 +758,7 @@ sap.ui.define([
          *   cannot be parsed or is not returned in the OData error response.<br />
          *
          *   <b>NOTE:</b> the second parameter is returned since version 1.28.6.
-         * @param {jQuery.Deferred} [oDeferred]
-         *   a <code>jQuery.Deferred</code> object that will be rejected with the
-         *   same arguments fnFailure is called
+         * @param {object} [oDeferred] Deferred object from Promise.withResolvers
          * @param {object} oError
          *   error object provided by datajs, should contain the response
          *
@@ -814,8 +799,9 @@ sap.ui.define([
             Log.error(sMessage, JSON.stringify(oError.response), "ODataWrapper");
 
             if (oDeferred) {
-                // reject with string as this is used to call the fnFailure
-                oDeferred.reject(sMessage, oParsedErrorInformation);
+                // reject with a tuple as native promises settle with a single value;
+                // the message is later forwarded to fnFailure (see the cache-hit consumer)
+                oDeferred.reject([sMessage, oParsedErrorInformation]);
             }
             fnFailure(sMessage, oParsedErrorInformation);
         };
@@ -896,19 +882,19 @@ sap.ui.define([
                 oODataService.setCsrfToken(
                     ODataWrapper.csrfTokenValue(oResponse.headers) || oODataService.getCsrfToken() // prefer a new token
                 );
-                Log.debug(`Received OData response for GET "${sRequestUrl}"`, null,
-                    "ODataWrapper");
+                Log.debug(`Received OData response for GET "${sRequestUrl}"`, null, "ODataWrapper");
                 // The sap-message header is a Gateway feature used e.g. by the INTEROP service
                 // It returns structured information (as XML). We don't evaluate it, we only log it.
                 // Severity is also part of the structure, but we simply assume warning.
                 sSapMessage = ODataWrapper.headerValue("sap-message", oResponse.headers);
                 if (sSapMessage) {
-                    Log.warning(`SAP message for GET ${sRequestUrl}`, sSapMessage,
-                        "ODataWrapper");
+                    Log.warning(`SAP message for GET ${sRequestUrl}`, sSapMessage, "ODataWrapper");
                 }
                 if (oDeferred) {
                     // put arguments for fnSuccess into cache; clone oData first
-                    oDeferred.resolve(JSON.parse(JSON.stringify(oData)), oODataService.getCsrfToken());
+                    // Note: native promises settle with a single value, so multiple
+                    // values are forwarded as a tuple (see the cache-hit consumer below)
+                    oDeferred.resolve([JSON.parse(JSON.stringify(oData)), oODataService.getCsrfToken()]);
                 }
                 // Note: drop excess parameters; try/catch
                 Utils.callHandler(fnSuccess.bind(null, oData), fnFailure);
@@ -918,22 +904,23 @@ sap.ui.define([
             this.check(fnSuccess, fnFailure);
 
             if (bCache) {
-                OData.read.$cache = OData.read.$cache || new Utils.Map();
-                oDeferred = OData.read.$cache.get(sRequestUrl); // the promise is cached
+                datajs.read.$cache = datajs.read.$cache || new Utils.Map();
+                oDeferred = datajs.read.$cache.get(sRequestUrl); // the (native) promise is cached
                 if (oDeferred) {
-                    Log.debug(`Using cached response for GET "${sRequestUrl}"`, null,
-                        "ODataWrapper");
-                    oDeferred.done((oData, sCachedCsrfToken) => {
-                        // prefer our own token
-                        oODataService.setCsrfToken(oODataService.getCsrfToken() || sCachedCsrfToken);
-                        // clone cached oData before passing to success handler
-                        // Note: try/catch
-                        Utils.callHandler(fnSuccess.bind(null, JSON.parse(JSON.stringify(oData))), fnFailure);
-                    }).fail(fnFailure);
+                    Log.debug(`Using cached response for GET "${sRequestUrl}"`, null, "ODataWrapper");
+                    oDeferred
+                        .then(([oData, sCachedCsrfToken]) => {
+                            // prefer our own token
+                            oODataService.setCsrfToken(oODataService.getCsrfToken() || sCachedCsrfToken);
+                            // clone cached oData before passing to success handler
+                            // Note: try/catch
+                            Utils.callHandler(fnSuccess.bind(null, JSON.parse(JSON.stringify(oData))), fnFailure);
+                        })
+                        .catch(([sMessage, oError]) => fnFailure(sMessage, oError));
                     return;
                 }
-                oDeferred = new jQuery.Deferred();
-                OData.read.$cache.put(sRequestUrl, oDeferred.promise());
+                oDeferred = Promise.withResolvers();
+                datajs.read.$cache.put(sRequestUrl, oDeferred.promise);
             }
 
             this.readOrBatch(
@@ -963,7 +950,7 @@ sap.ui.define([
         this.batch = function (oPayload, fnSuccess, fnFailure) {
             const sRequestUrl = this.toRequestUrl("$batch");
 
-            this.doRequest(sRequestUrl, "POST", oPayload, fnSuccess, fnFailure, OData.batchHandler);
+            this.doRequest(sRequestUrl, "POST", oPayload, fnSuccess, fnFailure, datajs.batchHandler);
         };
 
         /**
@@ -1006,10 +993,13 @@ sap.ui.define([
                 const iExpected = aMyDeferredQueue.length;
 
                 if (iExpected !== iActual) {
-                    that.onError("POST", this.toRequestUrl("$batch"), fnBatchItselfFailed, /* oDeferred */null, {
-                        message: `Protocol error! Expected ${iExpected
-                        } responses, but received ${iActual}`
-                    });
+                    that.onError(
+                        "POST",
+                        this.toRequestUrl("$batch"),
+                        fnBatchItselfFailed,
+                        /* oDeferred */null,
+                        {message: `Protocol error! Expected ${iExpected} responses, but received ${iActual}`}
+                    );
                     return;
                 }
 
@@ -1022,11 +1012,11 @@ sap.ui.define([
                     } else if (oResponse.__changeResponses) {
                         // successful change set
                         oResponse.__changeResponses.forEach((oChangeResponse, j) => {
-                            oDeferred[j].resolve(oChangeResponse.data, oChangeResponse);
+                            oDeferred[j].resolve([oChangeResponse.data, oChangeResponse]);
                         });
                     } else {
                         // successful GET request
-                        oDeferred.resolve(oResponse.data, oResponse);
+                        oDeferred.resolve([oResponse.data, oResponse]);
                     }
                 });
 
@@ -1040,7 +1030,7 @@ sap.ui.define([
             }
 
             if (aBatchQueue.length > 0) {
-                Log.debug("[000] submit batch queue: batch", "ODataWrpper");
+                Log.debug("[000] submit batch queue: batch", "ODataWrapper");
                 this.batch({ __batchRequests: aBatchQueue }, onBatchSuccess.bind(this), fnBatchItselfFailed);
             } else if (fnBatchAccepted) {
                 // call success handler (if given) directly (async) if batchQueue is empty
@@ -1065,8 +1055,6 @@ sap.ui.define([
          */
         this.toString = function (bVerbose) {
             const aResult = ['ODataWrapper({sBaseUrl:"', sBaseUrl, '"'];
-            //      if (bVerbose) {
-            //      }
             aResult.push("})");
             return aResult.join("");
         };
@@ -1155,9 +1143,7 @@ sap.ui.define([
         bSupportsChangeSets = oSettings.supportsChangeSets;
 
         if (typeof ODataWrapper.oStickySessionConfiguration === "undefined") {
-            Log.error("ODataWrapper.oStickySessionConfiguration is not defined!",
-                "the ODataWrapper constructor was called before the static property was defined",
-                "ODataWrapper");
+            Log.error("ODataWrapper.oStickySessionConfiguration is not defined!", "the ODataWrapper constructor was called before the static property was defined", "ODataWrapper");
         } else if (typeof ODataWrapper.oStickySessionConfiguration[sBaseUrl] === "undefined") {
             // Define the sticky session configuration for the base URL managed by
             // this ODataWrapper instance.
@@ -1220,8 +1206,7 @@ sap.ui.define([
             ODataWrapper["sap-statistics"] = Supportability.isStatisticsEnabled();
         } catch {
             // Read sap-statistics directly form query parameter in scenarios without UI5
-            ODataWrapper["sap-statistics"] =
-                /sap-statistics=(true|x|X)/.test(sWindowLocationSearch);
+            ODataWrapper["sap-statistics"] = /sap-statistics=(true|x|X)/.test(sWindowLocationSearch);
         }
     };
     ODataWrapper.checkSapStatisticsSetting(window.location.search);

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

@@ -11,15 +11,13 @@ sap.ui.define([
     "sap/ushell_abap/pbServices/ui2/AllCatalogs",
     "sap/ushell_abap/base/Ui2Utils",
     "sap/ushell_abap/base/Ui2Error",
-    "sap/base/Log",
-    "sap/ui/thirdparty/jquery"
+    "sap/base/Log"
 ], (
     Bag,
     AllCatalogs,
     Utils,
     SrvcError,
-    Log,
-    jQuery
+    Log
 ) => {
     "use strict";
 
@@ -347,28 +345,27 @@ sap.ui.define([
          * @param {string} sBagId
          *   the bag ID
          *
-         * @returns {jQuery.Promise<sap.ushell_abap.pbServices.ui2.Bag>} Resolves the loaded bag.
+         * @returns {Promise<sap.ushell_abap.pbServices.ui2.Bag>} Resolves the loaded bag.
          * @since 1.11.0
          */
         this.loadBag = function (sBagId) {
-            let oDeferred;
-
             if (!sBagId) {
                 throw new SrvcError("Missing bag ID", "Page");
             }
 
             if (mBags.containsKey(sBagId)) {
-                oDeferred = mBags.get(sBagId);
-            } else {
-                oDeferred = new jQuery.Deferred();
-                mBags.put(sBagId, oDeferred);
+                return mBags.get(sBagId);
+            }
+
+            const pBag = new Promise((resolve) => {
                 oFactory.getPageBuildingService().readBag(sId, sBagId, (oRawBag) => {
-                    oDeferred.resolve(new Bag(oFactory, oRawBag));
+                    resolve(new Bag(oFactory, oRawBag));
                 }, () => {
-                    oDeferred.resolve(new Bag(oFactory, { pageId: sId, id: sBagId, $tmp: true }));
+                    resolve(new Bag(oFactory, { pageId: sId, id: sBagId, $tmp: true }));
                 });
-            }
-            return oDeferred.promise();
+            });
+            mBags.put(sBagId, pBag);
+            return pBag;
         };
 
         /**

package/src/main/js/sap/ushell_abap/pbServices/ui2/contracts/configurationUi.js

@@ -4,9 +4,11 @@
  * @fileOverview The <code>configurationUi</code> contract.
  */
 sap.ui.define([
+    "sap/ushell/utils/toDeferred",
     "sap/ushell_abap/pbServices/ui2/Chip",
     "sap/ushell_abap/base/Ui2Error"
 ], (
+    toDeferred,
     Chip,
     SrvcError
 ) => {
@@ -273,7 +275,7 @@ sap.ui.define([
             /**
              * Fires the "save" event on this CHIP instance's configuration UI.
              *
-             * @returns {object}
+             * @returns {jQuery.Promise|undefined}
              *   a <code>jQuery.Deferred</code> object's promise as returned by the "save" event handler
              *
              * @name contract.configurationUi.fireSave
@@ -283,7 +285,13 @@ sap.ui.define([
              * @see chip.configurationUi.attachSave
              */
             fireSave: function () {
-                return fnSaveHandler ? fnSaveHandler() : undefined;
+                if (!fnSaveHandler) {
+                    return;
+                }
+                const vReturnValue = fnSaveHandler();
+                if (vReturnValue) {
+                    return toDeferred(vReturnValue);
+                }
             },
 
             /**

package/src/main/js/sap/ushell_abap/services/NavigationDataProvider.js

@@ -9,15 +9,15 @@
  *
  * Configured with the ClientSideTargetResolutionAdapter.
  *
- * @version 1.151.0
+ * @version 1.152.0
  */
 sap.ui.define([
+    "sap/ushell/base/promisify",
     "sap/ushell/resources",
-    "sap/ushell/utils",
     "sap/ushell/utils/LaunchpadError"
 ], (
+    promisify,
     ushellResources,
-    ushellUtils,
     LaunchpadError
 ) => {
     "use strict";
@@ -99,7 +99,7 @@ sap.ui.define([
         return new Promise((resolve, reject) => {
             const oSystemAliases = (this.oAdapter.getSystemAliases && this.oAdapter.getSystemAliases()) || {};
 
-            ushellUtils.promisify(this.oAdapter.getEnhancedInbounds())
+            promisify(this.oAdapter.getEnhancedInbounds())
                 .then((aInbounds) => {
                     resolve({
                         systemAliases: oSystemAliases,

package/src/main/js/sap/ushell_abap/ui5appruntime/AppInfoAdapter.js

@@ -5,11 +5,13 @@
 sap.ui.define([
     "sap/base/Log",
     "sap/ui/thirdparty/URI",
-    "sap/ui/thirdparty/jquery"
+    "sap/ui/thirdparty/jquery",
+    "sap/ushell/base/promisify"
 ], (
     Log,
     URI,
-    jQuery
+    jQuery,
+    promisify
 ) => {
     "use strict";
 
@@ -38,30 +40,29 @@ sap.ui.define([
         return new Error("Cannot load app info - no app-id provided and URL parameter 'sap-ui-app-id' not set");
     };
 
-    AppInfoAdapter.prototype._loadAppIndexData = function (sServiceUrl, sAppId) {
+    AppInfoAdapter.prototype._loadAppIndexData = async function (sServiceUrl, sAppId) {
         const sUri = new URI(sServiceUrl).query({
             id: sAppId
         }).toString();
 
-        return new Promise((resolve, reject) => {
-            jQuery.ajax({
+        let oResponseData;
+        try {
+            oResponseData = await promisify(jQuery.ajax({
                 type: "GET",
                 dataType: "json",
                 url: sUri
-            }).done((oResponseData) => {
-                const oAppData = oResponseData[sAppId];
+            }));
+        } catch (oError) {
+            oLogger.error(oError.responseText);
+            throw new Error(`Failed to load UI5 app index data loaded from ${sUri}: ${oError.responseText}`);
+        }
 
-                if (oAppData) {
-                    resolve(oResponseData[sAppId]);
-                } else {
-                    // TODO: extract error messages from app index response
-                    reject(new Error(`UI5 app index data loaded from ${sUri} does not contain app ${sAppId}`));
-                }
-            }).fail((oError) => {
-                oLogger.error(oError.responseText);
-                reject(new Error(`Failed to load UI5 app index data loaded from ${sUri}: ${oError.responseText}`));
-            });
-        });
+        const oAppData = oResponseData[sAppId];
+        if (oAppData) {
+            return oAppData;
+        }
+        // TODO: extract error messages from app index response
+        throw new Error(`UI5 app index data loaded from ${sUri} does not contain app ${sAppId}`);
     };
 
     return new AppInfoAdapter();

package/ui5.yaml

@@ -265,7 +265,6 @@ builder:
               - sap/ushell/Container.js
               - sap/ushell/ApplicationType/
               - sap/ushell/Fiori20AdapterTest.js
-              - sap/ushell/SessionHandler.js
               - sap/ushell/System.js
               - sap/ushell/User.js
               - sap/ushell/adapters/cdm/PagesCommonDataModelAdapter.js
@@ -330,12 +329,12 @@ builder:
               - sap/ushell/services/PersonalizationV2.js
               - sap/ushell/services/PluginManager.js
               - sap/ushell/services/ReferenceResolver.js
+              - sap/ushell/services/SessionHandler.js
               - sap/ushell/services/ShellNavigation.js
               - sap/ushell/services/ShellNavigationInternal.js
               - sap/ushell/services/SpaceContent.js
               - sap/ushell/services/SupportTicket.js
               - sap/ushell/services/URLParsing.js
-              - sap/ushell/services/URLShortening.js
               - sap/ushell/services/Ui5ComponentLoader.js
               - sap/ushell/services/UserDefaultParameterPersistence.js
               - sap/ushell/services/UserDefaultParameters.js
@@ -460,7 +459,6 @@ builder:
               - sap/ushell/utils/AppType.js
               # Default ushell modules
               - sap/ushell/components/shell/Notifications/NotificationsModule.js
-              - sap/ushell/components/shell/ProductSwitch/ProductSwitchModule.js
             resolve: false
       bundleOptions:
         optimize: true