@sapui5/sap.ushell 1.120.8 → 1.121.0

package/src/main/js/sap/ushell/services/SearchableContent.js

@@ -2,10 +2,11 @@
 
 /**
  * @fileOverview This module exposes the searchable content.
- * @version 1.120.8
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/Config",
+    "sap/ushell/Container",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readApplications",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readPages",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readUtils",
@@ -14,9 +15,11 @@ sap.ui.define([
     "sap/ushell/library",
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readVisualizations",
     "sap/base/Log",
-    "sap/ushell/utils/UrlParsing"
+    "sap/ushell/utils/UrlParsing",
+    "sap/ushell/utils"
 ], function (
     Config,
+    Container,
     readApplications,
     readPages,
     readUtils,
@@ -25,7 +28,8 @@ sap.ui.define([
     ushellLibrary,
     readVisualizations,
     Log,
-    urlParsing
+    urlParsing,
+    ushellUtils
 ) {
     "use strict";
 
@@ -39,7 +43,7 @@ sap.ui.define([
      *
      * <b>Note:</b> To retrieve a valid instance of this service, it is necessary to call
      * <code>sap.ushell.Container.getServiceAsync("SearchableContent")</code>. For details, see
-     * {@link sap.ushell.services.Container#getServiceAsync}.
+     * {@link sap.ushell.Container#getServiceAsync}.
      *
      * @hideconstructor
      *
@@ -51,7 +55,7 @@ sap.ui.define([
     SearchableContent.COMPONENT_NAME = "sap/ushell/services/SearchableContent";
 
     /**
-     * @typedef appData
+     * @typedef sap.ushell.services.SearchableContent.AppData
      * @type {object}
      * @property {string} id
      * @property {string} title
@@ -64,13 +68,16 @@ sap.ui.define([
      *    Technical attributes in "sap.app" section of the app descriptor
      * @property {object} target
      *    Same format as in CDM RT schema in visualization/vizConfig/sap.flp/target.
-     * @property {vizData[]} visualizations
+     * @property {sap.ushell.services.SearchableContent.VizData[]} visualizations
      *    List of tiles etc.
      * @property {string} [targetURL] the target URL for navigation
+     *
+     * @private
+     * @ui5-restricted sap.esh.search.ui
      */
 
     /**
-     * @typedef vizData
+     * @typedef sap.ushell.services.SearchableContent.VizData
      * @type {object}
      * @property {string} id
      * @property {string} vizId
@@ -86,6 +93,9 @@ sap.ui.define([
      * @property {object} _instantiationData
      *    Platform-specific data for instantiation
      * @property {string} [targetURL] the target URL for navigation
+     *
+     * @private
+     * @ui5-restricted sap.esh.search.ui
      */
 
     /**
@@ -100,7 +110,7 @@ sap.ui.define([
      *      if set to <code>true</code>, will be put into preview mode. This
      *      might include a conversion of the tile type.
      *
-     * @returns {Promise<appData[]>} A list of appData.
+     * @returns {Promise<sap.ushell.services.SearchableContent.AppData[]>} A list of appData.
      *
      * @since 1.77.0
      * @private
@@ -116,32 +126,37 @@ sap.ui.define([
             enableVisualizationPreview: oParameters.enableVisualizationPreview ?? oDefaults.enableVisualizationPreview
         };
 
-        if (Config.last("/core/spaces/enabled")) {
-            return this._getPagesAppData(oOptions)
+        /**
+         * Classic homepage was removed
+         * @deprecated since 1.120
+         */
+        if (!Config.last("/core/spaces/enabled")) {
+            return this._getLaunchPageAppData(oOptions)
                 .then(function (aAppData) {
                     return this._filterGetApps(aAppData, oOptions);
-                }.bind(this));
+                }.bind(this))
+                .then(function (aApps) {
+                    Log.debug("SearchableContent@getApps in classic mode found " + aApps.length + " apps");
+                    return aApps;
+                })
+                .catch(function (oError) {
+                    Log.error("SearchableContent@getApps in classic mode failed", oError);
+                    return Promise.reject(oError);
+                });
         }
-        return this._getLaunchPageAppData(oOptions)
+
+        return this._getPagesAppData(oOptions)
             .then(function (aAppData) {
                 return this._filterGetApps(aAppData, oOptions);
-            }.bind(this))
-            .then(function (aApps) {
-                Log.debug("SearchableContent@getApps in classic mode found " + aApps.length + " apps");
-                return aApps;
-            })
-            .catch(function (oError) {
-                Log.error("SearchableContent@getApps in classic mode failed", oError);
-                return Promise.reject(oError);
-            });
+            }.bind(this));
     };
 
     /**
      * Filters duplicates and appData with empty vizData
-     * @param {appData[]} aAppData An array of appData
+     * @param {sap.ushell.services.SearchableContent.AppData[]} aAppData An array of appData
      * @param {object} oGetAppsOptions Options set from consumer
      * @see #getApps
-     * @returns {appData[]} The filtered array of appData
+     * @returns {sap.ushell.services.SearchableContent.AppData[]} The filtered array of appData
      *
      * @since 1.77.0
      * @private
@@ -173,7 +188,7 @@ sap.ui.define([
                 return oAppData.visualizations.length > 0;
             });
         }
-
+        ushellUtils.setPerformanceMark("FLP-Search-FilterApps", { bUseUniqueMark: true });
         return aResult;
     };
 
@@ -181,13 +196,14 @@ sap.ui.define([
      * Collects all appData occurrences within the classic homepage scenario
      * @param {object} oGetAppsOptions Options set from consumer
      * @see #getApps
-     * @returns {Promise<appData[]>} An array of appData
+     * @returns {Promise<sap.ushell.services.SearchableContent.AppData[]>} An array of appData
      *
      * @since 1.77.0
      * @private
+     * @deprecated since 1.120
      */
     SearchableContent.prototype._getLaunchPageAppData = function (oGetAppsOptions) {
-        return sap.ushell.Container.getServiceAsync("LaunchPage")
+        return Container.getServiceAsync("LaunchPage")
             .then(function (oLaunchPageService) {
                 this._oLaunchPageService = oLaunchPageService;
                 return this._collectLaunchPageTiles();
@@ -288,6 +304,7 @@ sap.ui.define([
      *
      * @since 1.77.0
      * @private
+     * @deprecated since 1.120
      */
     SearchableContent.prototype._collectLaunchPageTiles = function () {
         var oGroupTilesPromise = this._oLaunchPageService.getGroups().then(function (aGroups) {
@@ -327,48 +344,40 @@ sap.ui.define([
      *
      * @param {object} oGetAppsOptions Options set from consumer
      * @see #getApps
-     * @returns {Promise<appData[]>} An array of appData
+     * @returns {Promise<sap.ushell.services.SearchableContent.AppData[]>} An array of appData
      *
      * @since 1.77.0
      * @private
      */
-    SearchableContent.prototype._getPagesAppData = function (oGetAppsOptions) {
-        var oAppData;
-        var oSite;
+    SearchableContent.prototype._getPagesAppData = async function (oGetAppsOptions) {
+        const oCdmService = await Container.getServiceAsync("CommonDataModel");
+        const [
+            aPages,
+            oApplications,
+            oVisualizations,
+            oVizTypes,
+            oCSTRService
+        ] = await Promise.all([
+            oCdmService.getAllPages({ personalizedPages: true }),
+            oCdmService.getApplications(),
+            oCdmService.getVisualizations(),
+            oCdmService.getVizTypes(),
+            Container.getServiceAsync("ClientSideTargetResolution")
+        ]);
 
-        return sap.ushell.Container.getServiceAsync("CommonDataModel")
-            .then(function (oCdmService) {
-                return Promise.all([
-                    oCdmService.getAllPages({ personalizedPages: true }),
-                    oCdmService.getApplications(),
-                    oCdmService.getVisualizations(),
-                    oCdmService.getVizTypes(),
-                    sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")
-                ]);
-            })
-            .then(function (aResult) {
-                var aPages = aResult[0];
-                var oApplications = aResult[1];
-                var oVisualizations = aResult[2];
-                var oVizTypes = aResult[3];
-                var oCSTRService = aResult[4];
-
-                oSite = {
-                    applications: oApplications,
-                    visualizations: oVisualizations,
-                    vizTypes: oVizTypes
-                };
-                oAppData = {};
+        const oSite = {
+            applications: oApplications,
+            visualizations: oVisualizations,
+            vizTypes: oVizTypes
+        };
+        const oAppData = {};
 
-                this._applyCdmVisualizations(oSite, oAppData, oGetAppsOptions);
-                this._applyCdmPages(oSite, aPages, oAppData, oGetAppsOptions);
-                return this._filterAppDataByIntent(oAppData, oCSTRService);
-            }.bind(this))
-            .then(function () {
-                this._applyCdmApplications(oSite, oAppData, oGetAppsOptions);
+        await this._applyCdmVisualizations(oSite, oAppData, oGetAppsOptions);
+        await this._applyCdmPages(oSite, aPages, oAppData, oGetAppsOptions);
+        await this._filterAppDataByIntent(oAppData, oCSTRService);
+        this._applyCdmApplications(oSite, oAppData, oGetAppsOptions);
 
-                return objectValues(oAppData);
-            }.bind(this));
+        return objectValues(oAppData);
     };
 
     /**
@@ -413,6 +422,7 @@ sap.ui.define([
                 return aIntentTargetPackages.reduce(function (oPromiseChain, aIntentTargetPackage) {
                     return oPromiseChain
                         .then(function (aIntents) {
+                            ushellUtils.setPerformanceMark("FLP-Search-IntentPackageStart");
                             return new Promise(function (resolve, reject) {
                                 oCSTRService.isIntentSupported(aIntents).done(resolve).fail(reject);
                             });
@@ -488,22 +498,23 @@ sap.ui.define([
      * @param {object} oSite The cdm site containing at least applications and visualizations
      * @param {object} oAppData The map of appData
      * @param {object} oGetAppsOptions Options set from consumer
+     * @returns {Promise<undefined>} Resolves with undefined.
      * @see #getApps
      *
      * @since 1.78.0
      * @private
      */
-    SearchableContent.prototype._applyCdmVisualizations = function (oSite, oAppData, oGetAppsOptions) {
-        Object.keys(oSite.visualizations).forEach(function (sKey) {
+    SearchableContent.prototype._applyCdmVisualizations = async function (oSite, oAppData, oGetAppsOptions) {
+        for (let sKey in oSite.visualizations) {
             try {
-                var oVizReference = {
+                const oVizReference = {
                     vizId: sKey,
                     // the search should display only standard tiles if possible, never flat tiles or links
                     // some tiles might only support standardWide and not standard. this is handled by getVizData
                     displayFormatHint: DisplayFormat.Standard
                 };
-                var oVizData = readUtils.getVizData(oSite, oVizReference /*, oSystemContext*/);
-                var sTarget = oVizData.targetURL;
+                const oVizData = await readUtils.getVizData(oSite, oVizReference /*, oSystemContext*/);
+                const sTarget = oVizData.targetURL;
 
                 if (oGetAppsOptions.enableVisualizationPreview) {
                     this._changeVizType(oVizData);
@@ -524,7 +535,7 @@ sap.ui.define([
             } catch (oError) {
                 Log.error("Could not get search data from visualization " + sKey, oError);
             }
-        }.bind(this));
+        }
     };
 
     /**
@@ -533,15 +544,17 @@ sap.ui.define([
      * @param {object[]} aPages The list of pages
      * @param {object} oAppData The map of appData
      * @param {object} oGetAppsOptions Options set from consumer
+     *
+     * @returns {Promise<undefined>} Promise which resolves after the pages were applied.
      * @see #getApps
      *
      * @since 1.77.0
      * @private
      */
-    SearchableContent.prototype._applyCdmPages = function (oSite, aPages, oAppData, oGetAppsOptions) {
-        aPages.forEach(function (oPage) {
-            var aVizReferences = readPages.getVisualizationReferences(oPage);
-            aVizReferences.forEach(function (oVizReference) {
+    SearchableContent.prototype._applyCdmPages = async function (oSite, aPages, oAppData, oGetAppsOptions) {
+        for (let oPage of aPages) {
+            const aVizReferences = readPages.getVisualizationReferences(oPage);
+            for (let oVizReference of aVizReferences) {
                 try {
                     // the search should display only standard tiles if possible, never flat tiles or links
                     // some tiles might only support standardWide and not standard. this is handled by getVizData
@@ -551,9 +564,8 @@ sap.ui.define([
                         oVizReference = Object.assign({}, oVizReference);
                         oVizReference.displayFormatHint = DisplayFormat.Standard;
                     }
-
-                    var oVizData = readUtils.getVizData(oSite, oVizReference /*, oSystemContext*/);
-                    var sTarget = oVizData.targetURL;
+                    const oVizData = await readUtils.getVizData(oSite, oVizReference /*, oSystemContext*/);
+                    const sTarget = oVizData.targetURL;
 
                     if (oGetAppsOptions.enableVisualizationPreview) {
                         this._changeVizType(oVizData);
@@ -574,8 +586,8 @@ sap.ui.define([
                 } catch (oError) {
                     Log.error("Could not get search data from vizReference " + oVizReference.id, oError);
                 }
-            }.bind(this));
-        }.bind(this));
+            }
+        }
     };
 
     /**
@@ -603,7 +615,7 @@ sap.ui.define([
      * @param {object} [oInb] An inbound
      * @param {boolean} [bAddTargetURL] if <code>true</code>, the targetURL
      *  is derived from the inbound and set in the result
-     * @returns {appData} The appData object
+     * @returns {sap.ushell.services.SearchableContent.AppData} The appData object
      *
      * @since 1.77.0
      * @private
@@ -633,8 +645,8 @@ sap.ui.define([
 
     /**
      * Constructs an appData object based on vizData
-     * @param {vizData} oVizData The vizData object
-     * @returns {appData} The appData object
+     * @param {sap.ushell.services.SearchableContent.VizData} oVizData The vizData object
+     * @returns {sap.ushell.services.SearchableContent.AppData} The appData object
      *
      * @since 1.77.0
      * @private
@@ -660,10 +672,11 @@ sap.ui.define([
      * @param {object} oLaunchPageTile A LaunchPage tile
      * @param {object} oGetAppsOptions Options set from consumer
      * @see #getApps
-     * @returns {vizData} The vizData object
+     * @returns {sap.ushell.services.SearchableContent.VizData} The vizData object
      *
      * @since 1.77.0
      * @private
+     * @deprecated since 1.120
      */
     SearchableContent.prototype._buildVizDataFromLaunchPageTile = function (oLaunchPageTile, oGetAppsOptions) {
         var oVizData;