@sapui5/sap.ushell 1.140.0 → 1.141.0

package/src/main/js/sap/ushell/adapters/cdm/PagesCommonDataModelAdapter.js

@@ -5,7 +5,7 @@
  * It combines the page data, tile data, navigation data and personalization into a CDM 3.1 site.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -79,9 +79,9 @@ sap.ui.define([
                 return oSite;
             })
             .then(oDeferred.resolve)
-            .catch((error) => {
-                oDeferred.reject(error);
-                this.fnSiteReject(error);
+            .catch((oError) => {
+                oDeferred.reject(oError);
+                this.fnSiteReject(oError);
             });
 
         return oDeferred.promise();
@@ -90,7 +90,7 @@ sap.ui.define([
     /**
      * Retrieves the CDM Site of a specific page id.
      *
-     * @param {string} pageId The ID of the page.
+     * @param {string} sPageId The ID of the page.
      * @returns {Promise}
      *   The Promise resolves with the CDM site object.
      *   The Promise rejects with an error message.
@@ -98,16 +98,16 @@ sap.ui.define([
      *
      * @private
      */
-    PagesCommonDataModelAdapter.prototype.getPage = function (pageId) {
-        if (!pageId) {
+    PagesCommonDataModelAdapter.prototype.getPage = async function (sPageId) {
+        if (!sPageId) {
             const sErrorMessage = "PagesCommonDataModelAdapter: getPage was called without a pageId";
             Log.fatal(sErrorMessage, null, this._sComponent);
-            return Promise.reject(sErrorMessage);
+            throw new Error(sErrorMessage);
         }
 
         return this.oSitePromise.then((oSite) => {
-            if (oSite.pages[pageId]) {
-                return oSite.pages[pageId];
+            if (oSite.pages[sPageId]) {
+                return oSite.pages[sPageId];
             }
 
             return Promise.all([
@@ -118,7 +118,7 @@ sap.ui.define([
                     const oPagePersistenceService = aService[0];
                     const oNavigationDataProviderService = aService[1];
                     return Promise.all([
-                        oPagePersistenceService.getPage(pageId),
+                        oPagePersistenceService.getPage(sPageId),
                         oNavigationDataProviderService.getNavigationData()
                     ]);
                 })
@@ -134,13 +134,13 @@ sap.ui.define([
 
                     return oSite.pages[oPagePersistenceData.page.id];
                 })
-                .catch((vError) => {
+                .catch((oError) => {
                     Log.fatal(
                         "PagesCommonDataModelAdapter encountered an error while fetching required services: ",
-                        vError,
+                        oError,
                         this._sComponent
                     );
-                    return Promise.reject(vError);
+                    throw oError;
                 });
         });
     };
@@ -300,11 +300,11 @@ sap.ui.define([
      *
      * @private
      */
-    PagesCommonDataModelAdapter.prototype.getPages = function (aPageIds) {
+    PagesCommonDataModelAdapter.prototype.getPages = async function (aPageIds) {
         if (!(aPageIds && Array.isArray(aPageIds) && aPageIds.length !== 0)) {
             const sErrorMessage = "PagesCommonDataModelAdapter: getPages is not an array or does not contain any Page id";
             Log.fatal(sErrorMessage, null, this._sComponent);
-            return Promise.reject(sErrorMessage);
+            throw new Error(sErrorMessage);
         }
 
         return this.oSitePromise
@@ -350,13 +350,13 @@ sap.ui.define([
 
                         return oSite.pages;
                     })
-                    .catch((vError) => {
+                    .catch((oError) => {
                         Log.fatal(
                             "PagesCommonDataModelAdapter encountered an error while fetching required services: ",
-                            vError,
+                            oError,
                             this._sComponent
                         );
-                        return Promise.reject(vError);
+                        throw oError;
                     });
             })
             .then((oAllLoadedPages) => {
@@ -419,8 +419,9 @@ sap.ui.define([
                         oDeferred.reject(oError);
                     });
             })
-            .catch(() => {
-                oDeferred.reject("Personalization Service could not be loaded");
+            .catch((oError) => {
+                Log.error("Personalization Service could not be loaded", oError, this._sComponent);
+                oDeferred.reject(oError);
             });
 
         return oDeferred.promise();
@@ -472,8 +473,9 @@ sap.ui.define([
                         oDeferred.reject(oError);
                     });
             })
-            .catch(() => {
-                oDeferred.reject("Personalization Service could not be loaded");
+            .catch((oError) => {
+                Log.error("Personalization Service could not be loaded", oError, this._sComponent);
+                oDeferred.reject(oError);
             });
 
         return oDeferred.promise();

package/src/main/js/sap/ushell/adapters/cdm/PersonalizationAdapter.js

@@ -5,7 +5,7 @@
  *
  *
  * The CDM personalization adapter can be used to store data in the RA@ABAP platform.
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/_Personalization/internals",

package/src/main/js/sap/ushell/adapters/cdm/PersonalizationV2Adapter.js

@@ -5,7 +5,7 @@
  *
  *
  * The CDM personalization adapter can be used to store data in the RA@ABAP platform.
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "./PersonalizationAdapter"

package/src/main/js/sap/ushell/adapters/cdm/Settings/UserLanguageAndRegion/UserLanguageAndRegion.controller.js

@@ -167,16 +167,16 @@ sap.ui.define([
                         return this.onSaveSuccess(oUser);
                     })
                     // in case of failure - return to the original language
-                    .catch((errorMessage) => {
-                        Log.debug("[000] onSave:catch:errorMessage", errorMessage, "UserLanguageAndRegion.controller");
+                    .catch((oError) => {
+                        Log.debug("[000] onSave:catch:errorMessage", oError, "UserLanguageAndRegion.controller");
 
                         oUser.setLanguage(sOriginLanguage);
                         oUser.resetChangedProperty("language");
                         this._updateTextFields(sOriginLanguage);
 
-                        Log.error("Failed to save Language and Region Settings", errorMessage,
+                        Log.error("Failed to save Language and Region Settings", oError,
                             "sap.ushell.adapters.cdm.Settings.cdmUserLanguageRegion.UserLanguageAndRegion.controller");
-                        throw errorMessage;
+                        throw oError;
                     });
             }
 

package/src/main/js/sap/ushell/adapters/cdm/Ui5ComponentLoaderAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Ui5ComponentLoaderAdapter for the CDM platform
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
 ], () => {

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/modifyHome.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Helper of modifying the home page data for the 'CDM' platform.
- * @version 1.140.0
+ * @version 1.141.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/readCatalogs.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Helper of accessing catalog data for the 'CDM' platform.
- * @version 1.140.0
+ * @version 1.141.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/readHome.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Helper of accessing Home Page data for the 'CDM' platform.
  *
- * @version 1.140.0
+ * @version 1.141.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/uri.transform.js

@@ -4,7 +4,7 @@
  * @fileOverview Transforms relative URIs as used e.g. for data sources in the
  * manifest.json
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/URI"

package/src/main/js/sap/ushell/adapters/cdm/_Personalization/internals.js

@@ -137,14 +137,9 @@ sap.ui.define([
                 .then((oResponse) => {
                     oDeferred.resolve();
                 })
-                .catch((vReason) => {
-                    Log.error(
-                        `Failed to save personalization container; response: ${
-                            typeof vReason === "object" ? JSON.stringify(vReason) : vReason}`,
-                        vReason.stack ? vReason.stack : null,
-                        "sap.ushell.adapters.cdm.PersonalizationAdapter"
-                    );
-                    oDeferred.reject(vReason);
+                .catch((oError) => {
+                    Log.error("Failed to save personalization container; response:", oError, "sap.ushell.adapters.cdm.PersonalizationAdapter");
+                    oDeferred.reject(oError);
                 });
         }).promise();
     }
@@ -214,15 +209,15 @@ sap.ui.define([
                     }
                     oDeferred.resolve();
                 })
-                .catch((oResponse) => {
-                    if (oResponse.status === 404) {
+                .catch((oError) => {
+                    if (oError.details?.status === 404) {
                         // not found is not an error, it simply means
                         // there's nothing to load
                         handleNonExistentContainer(oContainerData);
                         oDeferred.resolve();
                     } else {
                         clearContainerData(oContainerData.items);
-                        oDeferred.reject(oResponse);
+                        oDeferred.reject(oError);
                     }
                 });
         }).promise();
@@ -234,8 +229,8 @@ sap.ui.define([
                 .then(() => {
                     oDeferred.resolve();
                 })
-                .catch((vReason) => {
-                    oDeferred.reject(vReason);
+                .catch((oError) => {
+                    oDeferred.reject(oError);
                 });
         }).promise();
     }

package/src/main/js/sap/ushell/adapters/cdm/util/AppForInbound.js

@@ -5,7 +5,7 @@
  * Creates CDM site entries for apps with the provided data.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.140.0
+ * @version 1.141.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/util/cdmSiteUtils.js

@@ -5,7 +5,7 @@
  * Creates CDM site entities with the provided data.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.140.0
+ * @version 1.141.0
  * @private
  */
 sap.ui.define([
@@ -40,9 +40,12 @@ sap.ui.define([
 
             if (oVisualizationData.isCustomTile) {
                 sVizType = oVisualizationData.vizType;
-            } else if (oVisualizationData.indicatorDataSource) {
+            } else if (oVisualizationData.vizType === "X-SAP-UI2-CHIP:/UI2/STATIC_APPLAUNCHER") {
+                sVizType = this._VISUALIZATION_TYPES.STATIC_TILE;
+            } else if (oVisualizationData.vizType === "X-SAP-UI2-CHIP:/UI2/DYNAMIC_APPLAUNCHER") {
                 sVizType = this._VISUALIZATION_TYPES.DYNAMIC_TILE;
             } else {
+                Log.warning(`Visualization with key '${vizKey}' has no known vizType and is not a custom tile. Using fall back instead.`);
                 sVizType = this._VISUALIZATION_TYPES.STATIC_TILE;
             }
 
@@ -101,7 +104,7 @@ sap.ui.define([
             // the navigation data ID becomes the application ID
             try {
                 oApplications[sInboundPermanentKey] = AppForInbound.get(navigationDataId, oInbound);
-            } catch (error) {
+            } catch (oError) {
                 Log.error(`Unable to dereference app '${navigationDataId}' of CDM page.`);
                 oApplications[navigationDataId] = {};
             }

package/src/main/js/sap/ushell/adapters/cdm/v3/AdapterBase.js

@@ -4,7 +4,7 @@
  * @fileOverview The Base of Unified Shell's LaunchPageAdapter for the 'CDM' platform - Version 3 (V3)
  *   and StaticGroupsContainer for Featured Group
  *
- * @version 1.140.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readHome",
@@ -28,7 +28,8 @@ sap.ui.define([
     "sap/base/util/deepClone",
     "sap/base/Log",
     "sap/ushell/UI5ComponentType",
-    "sap/ushell/Container"
+    "sap/ushell/Container",
+    "sap/ushell/utils/LaunchpadError"
 ], (
     oReadHomePageUtils,
     oReadVisualization,
@@ -51,7 +52,8 @@ sap.ui.define([
     deepClone,
     Log,
     UI5ComponentType,
-    Container
+    Container,
+    LaunchpadError
 ) => {
     "use strict";
 
@@ -170,8 +172,8 @@ sap.ui.define([
                             that._logTileResolutionFailures(that._mFailedResolvedTiles);
                         });
                 })
-                .catch((sErrorMessage0) => {
-                    oLogger.error(`Delivering homepage groups failed - ${sErrorMessage0}`);
+                .catch((oError) => {
+                    oLogger.error("Delivering homepage groups failed", oError);
                     fnResolve([]);
                     // ensure that following _ensureLoaded calls get resolved with a new parameter
                     delete that._loaded;
@@ -334,9 +336,20 @@ sap.ui.define([
 
         oResultPromise.done((oResolvedTile) => {
             oDeferred.resolve(updateCaches(oResolvedTile));
-        }).fail((vFailureInfo) => {
-            mFailureCache[oTile.id] = vFailureInfo;
-            oDeferred.reject(vFailureInfo);
+        }).fail((oError) => {
+            if (oError instanceof LaunchpadError) {
+                mFailureCache[oTile.id] = {
+                    logLevel: oError.details?.logLevel || oLogLevel.ERROR,
+                    message: oError.message
+                };
+            } else {
+                mFailureCache[oTile.id] = {
+                    logLevel: oLogLevel.ERROR,
+                    message: oError.toString()
+                };
+            }
+
+            oDeferred.reject(oError);
         });
 
         return oDeferred.promise();
@@ -369,12 +382,11 @@ sap.ui.define([
         let oHarmonizedOutbound;
 
         // Reject tile resolution
-        function reject (iLogLevel, sMessage) {
+        function createdRejectedDeferred (iLogLevel, sMessage) {
+            const oError = new LaunchpadError(sMessage, { logLevel: iLogLevel });
+
             return new jQuery.Deferred()
-                .reject({
-                    logLevel: iLogLevel,
-                    message: sMessage
-                })
+                .reject(oError)
                 .promise();
         }
 
@@ -382,10 +394,10 @@ sap.ui.define([
 
         // Check inputs
         if (!isPlainObject(oSite)) {
-            return reject(oLogLevel.ERROR, "Cannot resolve tile: oSite must be an object");
+            return createdRejectedDeferred(oLogLevel.ERROR, "Cannot resolve tile: oSite must be an object");
         }
         if (!isPlainObject(oTile)) {
-            return reject(oLogLevel.ERROR, "Cannot resolve tile: oTile must be an object");
+            return createdRejectedDeferred(oLogLevel.ERROR, "Cannot resolve tile: oTile must be an object");
         }
 
         // Get visualization and type
@@ -396,7 +408,7 @@ sap.ui.define([
         const sVisualizationTypeId = oTile.vizType || oReadVisualization.getTypeId(oVisualization);
         const oVisualizationType = oReadVisualization.getType(oSite, sVisualizationTypeId);
         if (!oVisualizationType) {
-            return reject(oLogLevel.ERROR, `Cannot resolve tile '${oTile.id}': no visualization type found for vizTypeId '${sVisualizationTypeId}'`);
+            return createdRejectedDeferred(oLogLevel.ERROR, `Cannot resolve tile '${oTile.id}': no visualization type found for vizTypeId '${sVisualizationTypeId}'`);
         }
 
         // Resolve tile via app id in visualization target
@@ -406,12 +418,12 @@ sap.ui.define([
             // Read its target app descriptor and inbound
             oAppDescriptor = oReadVisualization.getAppDescriptor(oSite, sAppId);
             if (!oAppDescriptor) {
-                return reject(oLogLevel.INFO, `Tile '${oTile.id}' filtered from result: no app descriptor found for appId '${sAppId}' (dangling app reference)`);
+                return createdRejectedDeferred(oLogLevel.INFO, `Tile '${oTile.id}' filtered from result: no app descriptor found for appId '${sAppId}' (dangling app reference)`);
             }
 
             oInboundResult = oReadHomePageUtils.getInbound(oAppDescriptor, oReadVisualization.getTarget(oVisualization).inboundId);
             if (!oInboundResult) {
-                return reject(oLogLevel.ERROR, `Cannot resolve tile '${oTile.id}': app '${sAppId}' has no navigation inbound`);
+                return createdRejectedDeferred(oLogLevel.ERROR, `Cannot resolve tile '${oTile.id}': app '${sAppId}' has no navigation inbound`);
             }
 
             // Extract tile information from inbound
@@ -445,7 +457,7 @@ sap.ui.define([
 
         // Device check
         if (!this._isFormFactorSupported(oApp)) {
-            return reject(oLogLevel.INFO, `Tile '${oTile.id}' filtered from result: form factor not supported`);
+            return createdRejectedDeferred(oLogLevel.INFO, `Tile '${oTile.id}' filtered from result: form factor not supported`);
         }
 
         if (sExternalUrl || sHash) {
@@ -1125,7 +1137,7 @@ sap.ui.define([
                 );
 
                 if (!oTileComponentProperties.name) {
-                    return Promise.reject(`Cannot find name of tile component for tile with id: '${oTile.id}'`);
+                    throw new Error(`Cannot find name of tile component for tile with id: '${oTile.id}'`);
                 }
 
                 if (oTileComponentProperties.manifest) {
@@ -1245,14 +1257,14 @@ sap.ui.define([
     AdapterBase.prototype.getTileView = function (oGroupTile) {
         const that = this;
         return new jQuery.Deferred((oDeferred) => {
-            return that._getTileView(oGroupTile, false).then((oTileUI) => {
-                oDeferred.resolve(oTileUI);
-            }, (sReason) => {
-                const sErrorMessage = `Tile with ID '${oGroupTile.id}' could not be initialized${sReason ? `:\n${sReason}` : "."}`;
-
-                Log.error(sErrorMessage, null, oGroupTile.tileType);
-                oDeferred.reject(sErrorMessage);
-            });
+            return that._getTileView(oGroupTile, false)
+                .then((oTileUI) => {
+                    oDeferred.resolve(oTileUI);
+                })
+                .catch((oError) => {
+                    Log.error(`Tile with ID '${oGroupTile.id}' of type '${oGroupTile.tileType}' could not be initialized:`, oError);
+                    oDeferred.reject(oError);
+                });
         }).promise();
     };
 
@@ -1279,14 +1291,14 @@ sap.ui.define([
         if (typeof oGroupTile !== "object" || !oGroupTile.id) {
             sErrorMessage = `Invalid input parameter passed to _getTileView: ${oGroupTile}`;
             Log.error(sErrorMessage);
-            return oDeferred.reject(sErrorMessage).promise();
+            return oDeferred.reject(new Error(sErrorMessage)).promise();
         }
 
         const oResolvedTile = this._mResolvedTiles[oGroupTile.id];
         if (!oResolvedTile) {
             sErrorMessage = `No resolved tile found for tile ID: ${oGroupTile.id}`;
             Log.error(sErrorMessage);
-            return oDeferred.reject(sErrorMessage).promise();
+            return oDeferred.reject(new Error(sErrorMessage)).promise();
         }
 
         return this._getTileUiComponentContainer(oGroupTile, oResolvedTile, false);