From 5a9880e4e414bacc3630c759ed95190029e9adfb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Prunayre?= <fx.prunayre@gmail.com>
Date: Fri, 5 Jan 2024 12:57:15 +0100
Subject: [PATCH] [BP] Search results / Configure related records type
 depending on template. (#7376)

* Search results / Configure related records type depending on template.

The search API provides the possibility to load related records
for each hits. This allows to easily display them in search results
but it also slow down a bit the search.

Currently only the `list.html` template was displaying them based
on the following configuration:

```
resultViewTpls: ...
grid: {
  related: ["parent", "children", "services", "datasets"]
},
```

but user may want to customize this depending on the result template.

This move the configuration to the `resultViewTpls` (and preserve
previous mechanism)

```
resultViewTpls: ...
              {
                tplUrl:
                  "../../catalog/components/" +
                  "search/resultsview/partials/viewtemplates/list.html",
                tooltip: "List",
                icon: "fa-bars",
                related: ["parent", "children", "services", "datasets"]
              },
```

so that user can more easily define which relations to load during
search depending on the result template used.

* Search / Optimize field based on current template

Each search results templates display a specific set of fields.
Add possibility to exclude unused fields from search to speed up search.

At some point, it could be better to declare all required fields for
rendering records on a per template basis on top of required fields
needed for the JS app logic (eg. privileges, status, draft).

* Batch edit / Properly init result template config.

* Search / Optimize field based on current template / Add admin UI config.
---
 .../admin/uiconfig/partials/uiconfig.html     | 25 +++++++++--
 .../components/elasticsearch/EsFacet.js       | 12 ++++-
 .../components/elasticsearch/EsService.js     | 10 ++++-
 .../resultsview/ResultsviewDirective.js       | 22 +++-------
 .../partials/templateswitcher.html            |  4 +-
 .../searchmanager/SearchFormDirective.js      | 44 +++++++++++++++----
 .../viewer/owscontext/OwsContextDirective.js  |  8 ++--
 .../resources/catalog/js/CatController.js     | 27 ++++++++++--
 .../catalog/js/edit/BatchEditController.js    |  2 +-
 .../catalog/js/edit/EditorBoardController.js  |  2 +-
 .../catalog/js/search/SearchController.js     |  2 +-
 .../resources/catalog/locales/en-admin.json   |  5 +++
 .../resources/catalog/views/default/module.js | 10 +++--
 13 files changed, 125 insertions(+), 48 deletions(-)

diff --git a/web-ui/src/main/resources/catalog/components/admin/uiconfig/partials/uiconfig.html b/web-ui/src/main/resources/catalog/components/admin/uiconfig/partials/uiconfig.html
index ee1f2c513f3..786d13aabfc 100644
--- a/web-ui/src/main/resources/catalog/components/admin/uiconfig/partials/uiconfig.html
+++ b/web-ui/src/main/resources/catalog/components/admin/uiconfig/partials/uiconfig.html
@@ -333,21 +333,27 @@ <h2>{{('ui-mod-' + m) | translate}}</h2>
                       <tr data-ng-repeat="opt in mCfg[key] track by $index">
                         <td>
                           <div class="input-group">
-                            <span class="input-group-addon">Icon </span>
+                            <span class="input-group-addon"
+                              >{{('ui-' + key + '-icon') | translate}}</span
+                            >
                             <input
                               type="text"
                               class="form-control"
                               id="ui-tplIcon-{{$index}}"
                               data-ng-model="opt.icon"
                             />
-                            <span class="input-group-addon">Template URL </span>
+                            <span class="input-group-addon"
+                              >{{('ui-' + key + '-tplUrl') | translate}}</span
+                            >
                             <input
                               type="text"
                               class="form-control"
                               id="ui-tplURL-{{$index}}"
                               data-ng-model="opt.tplUrl"
                             />
-                            <span class="input-group-addon">Tooltip </span>
+                            <span class="input-group-addon"
+                              >{{('ui-' + key + '-tooltip') | translate}}</span
+                            >
                             <input
                               type="text"
                               class="form-control"
@@ -355,6 +361,19 @@ <h2>{{('ui-mod-' + m) | translate}}</h2>
                               data-ng-model="opt.tooltip"
                             />
                           </div>
+
+                          <div class="row">
+                            <label class="control-label"
+                              >{{('ui-' + key + '-source') | translate}}</label
+                            >
+                            <gn-json-edit height="300" model="opt.source"></gn-json-edit>
+                          </div>
+                          <div class="row">
+                            <label class="control-label"
+                              >{{('ui-' + key + '-relatedTypes') | translate}}</label
+                            >
+                            <gn-json-edit height="300" model="opt.related"></gn-json-edit>
+                          </div>
                         </td>
                         <td class="w-30-px">
                           <a
diff --git a/web-ui/src/main/resources/catalog/components/elasticsearch/EsFacet.js b/web-ui/src/main/resources/catalog/components/elasticsearch/EsFacet.js
index 73228043964..0a848adfedf 100644
--- a/web-ui/src/main/resources/catalog/components/elasticsearch/EsFacet.js
+++ b/web-ui/src/main/resources/catalog/components/elasticsearch/EsFacet.js
@@ -317,11 +317,19 @@
         };
       };
 
-      this.addSourceConfiguration = function (esParams, type) {
+      this.addSourceConfiguration = function (esParams, type, templateSource) {
         if (type === undefined) {
           type = "simplelist";
         }
-        var source = typeof type === "string" ? this.configs[type].source : type;
+        var source =
+          typeof type === "string" ? angular.copy(this.configs[type].source, {}) : type;
+        if (templateSource) {
+          if (templateSource.exclude) {
+            source.includes = source.includes.filter(function (field) {
+              return templateSource.exclude.indexOf(field) === -1;
+            });
+          }
+        }
         esParams._source = source;
         if (this.configs[type].script_fields) {
           esParams.script_fields = this.configs[type].script_fields;
diff --git a/web-ui/src/main/resources/catalog/components/elasticsearch/EsService.js b/web-ui/src/main/resources/catalog/components/elasticsearch/EsService.js
index b67dcfab780..5aa5fe41d0a 100644
--- a/web-ui/src/main/resources/catalog/components/elasticsearch/EsService.js
+++ b/web-ui/src/main/resources/catalog/components/elasticsearch/EsService.js
@@ -416,7 +416,13 @@
         }
       };
 
-      this.generateEsRequest = function (p, searchState, searchConfigId, filters) {
+      this.generateEsRequest = function (
+        p,
+        searchState,
+        searchConfigId,
+        filters,
+        templateSource
+      ) {
         var params = {};
         var luceneQueryString = gnEsLuceneQueryParser.facetsToLuceneQuery(
           searchState.filters
@@ -482,7 +488,7 @@
         //   "max_concurrent_group_searches": 4
         // };
         gnESFacet.addFacets(params, searchConfigId, searchState.languageConfig);
-        gnESFacet.addSourceConfiguration(params, searchConfigId);
+        gnESFacet.addSourceConfiguration(params, searchConfigId, templateSource);
 
         return params;
       };
diff --git a/web-ui/src/main/resources/catalog/components/search/resultsview/ResultsviewDirective.js b/web-ui/src/main/resources/catalog/components/search/resultsview/ResultsviewDirective.js
index ad65780f064..5ccb5887051 100644
--- a/web-ui/src/main/resources/catalog/components/search/resultsview/ResultsviewDirective.js
+++ b/web-ui/src/main/resources/catalog/components/search/resultsview/ResultsviewDirective.js
@@ -47,11 +47,11 @@
     return {
       require: "^ngSearchForm",
       templateUrl:
-        "../../catalog/components/search/resultsview/partials/" + "templateswitcher.html",
+        "../../catalog/components/search/resultsview/partials/templateswitcher.html",
       restrict: "A",
       link: function ($scope, element, attrs, searchFormCtrl) {
         $scope.setResultTemplate = function (t) {
-          $scope.resultTemplate = t.tplUrl;
+          $scope.resultTemplate = t;
           searchFormCtrl.triggerSearch(true);
         };
       }
@@ -91,18 +91,6 @@
         link: function (scope, element, attrs, controller) {
           scope.mdService = gnMetadataActions;
           scope.map = scope.$eval(attrs.map);
-          //scope.searchResults = scope.$eval(attrs.searchResults);
-
-          /** Display fa icons for categories
-           * TODO: Move to configuration */
-          scope.catIcons = {
-            featureCatalogs: "fa-table",
-            services: "fa-cog",
-            maps: "fa-globe",
-            staticMaps: "fa-globe",
-            datasets: "fa-file",
-            interactiveResources: "fa-rss"
-          };
 
           if (scope.map) {
             scope.hoverOL = new ol.layer.Vector({
@@ -177,13 +165,13 @@
             }
           });
 
-          scope.$watch("resultTemplate", function (templateUrl) {
-            if (angular.isUndefined(templateUrl)) {
+          scope.$watch("resultTemplate", function (templateConfig) {
+            if (angular.isUndefined(templateConfig)) {
               return;
             }
             var template = angular.element(document.createElement("div"));
             template.attr({
-              "ng-include": "resultTemplate"
+              "ng-include": "resultTemplate.tplUrl"
             });
             element.empty();
             element.append(template);
diff --git a/web-ui/src/main/resources/catalog/components/search/resultsview/partials/templateswitcher.html b/web-ui/src/main/resources/catalog/components/search/resultsview/partials/templateswitcher.html
index 4a8f13fc238..e6d22123552 100644
--- a/web-ui/src/main/resources/catalog/components/search/resultsview/partials/templateswitcher.html
+++ b/web-ui/src/main/resources/catalog/components/search/resultsview/partials/templateswitcher.html
@@ -8,7 +8,7 @@
   >
     <i
       data-ng-repeat="t in listOfResultTemplate"
-      data-ng-show="t.tplUrl == resultTemplate"
+      data-ng-show="t.tplUrl == resultTemplate.tplUrl"
       title="{{t.tooltip | translate}}"
       class="fa {{t.icon}}"
     />
@@ -17,7 +17,7 @@
   <ul class="dropdown-menu">
     <li
       data-ng-repeat="t in listOfResultTemplate"
-      data-ng-hide="t.tplUrl == resultTemplate"
+      data-ng-hide="t.tplUrl == resultTemplate.tplUrl"
     >
       <a href="" data-ng-click="setResultTemplate(t);" title="{{t.tooltip | translate}}">
         <i class="fa {{t.icon}}" />&nbsp; {{t.tooltip | translate}}
diff --git a/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js b/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js
index 528734fca26..e25a5e9180e 100644
--- a/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js
+++ b/web-ui/src/main/resources/catalog/components/search/searchmanager/SearchFormDirective.js
@@ -170,7 +170,8 @@
         finalParams,
         $scope.searchObj.state,
         $scope.searchObj.configId,
-        $scope.searchObj.filters
+        $scope.searchObj.filters,
+        $scope.resultTemplate && $scope.resultTemplate.source
       );
 
       function buildSearchKey(esParams) {
@@ -194,14 +195,39 @@
       // console.log(dontComputeAggs, $scope.searchResults.searchKey, searchKey);
       $scope.searchResults.searchKey = searchKey;
 
-      // For now, only the list result template renders related records
-      // based on UI config.
-      var template =
-          $scope.resultTemplate && $scope.resultTemplate.endsWith("list.html")
-            ? "grid"
-            : "",
-        templateConfig = gnGlobalSettings.gnCfg.mods.search[template],
-        types = templateConfig && templateConfig.related ? templateConfig.related : [];
+      // In a search, list of related records can be added
+      // to each hits. This is configured depending
+      // on the current result template.
+      function getRelatedTypesForSearch() {
+        if (!$scope.resultTemplate) {
+          return [];
+        }
+        if ($scope.resultTemplate.related) {
+          if (!angular.isArray($scope.resultTemplate.related)) {
+            console.warn(
+              "Search results configuration error / The list of related type for the type " +
+                $scope.resultTemplate.tplUrl +
+                " must be an array. eg. '[\"children\"]'." +
+                " Current configuration is invalid: ",
+              $scope.resultTemplate.related
+            );
+            return [];
+          }
+          return $scope.resultTemplate.related;
+        } else {
+          // Old way of configuring related types (deprecated)
+          // which was not depending on the current template but
+          // only specific case for the list.html.
+          var template =
+              $scope.resultTemplate.tplUrl &&
+              $scope.resultTemplate.tplUrl.endsWith("list.html")
+                ? "grid"
+                : "",
+            templateConfig = gnGlobalSettings.gnCfg.mods.search[template];
+          return templateConfig && templateConfig.related ? templateConfig.related : [];
+        }
+      }
+      var types = getRelatedTypesForSearch();
 
       gnESClient
         .search(
diff --git a/web-ui/src/main/resources/catalog/components/viewer/owscontext/OwsContextDirective.js b/web-ui/src/main/resources/catalog/components/viewer/owscontext/OwsContextDirective.js
index 6ae08d41b6f..c02aa5d8cac 100644
--- a/web-ui/src/main/resources/catalog/components/viewer/owscontext/OwsContextDirective.js
+++ b/web-ui/src/main/resources/catalog/components/viewer/owscontext/OwsContextDirective.js
@@ -30,9 +30,11 @@
     "$scope",
     "gnRelatedResources",
     function ($scope, gnRelatedResources) {
-      $scope.resultTemplate =
-        "../../catalog/components/" +
-        "search/resultsview/partials/viewtemplates/grid4maps.html";
+      $scope.resultTemplate = {
+        tplUrl:
+          "../../catalog/components/" +
+          "search/resultsview/partials/viewtemplates/grid4maps.html"
+      };
 
       $scope.loadMap = function (map, md) {
         gnRelatedResources.getAction("MAP")(map, md);
diff --git a/web-ui/src/main/resources/catalog/js/CatController.js b/web-ui/src/main/resources/catalog/js/CatController.js
index f5d53b64ce4..3ec45fb9473 100644
--- a/web-ui/src/main/resources/catalog/js/CatController.js
+++ b/web-ui/src/main/resources/catalog/js/CatController.js
@@ -655,23 +655,30 @@
                   "../../catalog/components/" +
                   "search/resultsview/partials/viewtemplates/grid.html",
                 tooltip: "Grid",
-                icon: "fa-th"
+                icon: "fa-th",
+                related: []
               },
               {
                 tplUrl:
                   "../../catalog/components/" +
                   "search/resultsview/partials/viewtemplates/list.html",
                 tooltip: "List",
-                icon: "fa-bars"
+                icon: "fa-bars",
+                related: ["parent", "children", "services", "datasets"]
               },
               {
                 tplUrl:
                   "../../catalog/components/" +
                   "search/resultsview/partials/viewtemplates/table.html",
                 tooltip: "Table",
-                icon: "fa-table"
+                icon: "fa-table",
+                related: [],
+                source: {
+                  exclude: ["resourceAbstract*", "Org*", "contact*"]
+                }
               }
             ],
+            // Optional. If not set, the first resultViewTpls is used.
             resultTemplate:
               "../../catalog/components/" +
               "search/resultsview/partials/viewtemplates/grid.html",
@@ -727,6 +734,7 @@
                 class: "fa-file-code-o"
               }*/
             ],
+            // Deprecated (use configuration on resultViewTpls)
             grid: {
               related: ["parent", "children", "services", "datasets"]
             },
@@ -1418,6 +1426,19 @@
         getProxyUrl: function () {
           return this.proxyUrl;
         },
+        getDefaultResultTemplate: function () {
+          if (this.gnCfg.mods.search.resultTemplate) {
+            for (var i = 0; i < this.gnCfg.mods.search.resultViewTpls.length; i++) {
+              if (
+                this.gnCfg.mods.search.resultViewTpls[i].tplUrl ==
+                this.gnCfg.mods.search.resultTemplate
+              ) {
+                return this.gnCfg.mods.search.resultViewTpls[i];
+              }
+            }
+          }
+          return this.gnCfg.mods.search.resultViewTpls[0];
+        },
         // Removes the proxy path and decodes the layer url,
         // so the layer can be printed with MapFish.
         // Otherwise Mapfish rejects it, due to relative url.
diff --git a/web-ui/src/main/resources/catalog/js/edit/BatchEditController.js b/web-ui/src/main/resources/catalog/js/edit/BatchEditController.js
index 9783dcc5a88..e2dd1f0840c 100644
--- a/web-ui/src/main/resources/catalog/js/edit/BatchEditController.js
+++ b/web-ui/src/main/resources/catalog/js/edit/BatchEditController.js
@@ -264,7 +264,7 @@
           icon: "fa-list"
         }
       ];
-      gnSearchSettings.resultTemplate = gnSearchSettings.resultViewTpls[0].tplUrl;
+      gnSearchSettings.resultTemplate = gnSearchSettings.resultViewTpls[0];
 
       // TODO: Improve for other standards
       // Object used by directory directive
diff --git a/web-ui/src/main/resources/catalog/js/edit/EditorBoardController.js b/web-ui/src/main/resources/catalog/js/edit/EditorBoardController.js
index 6fe2cd18eb9..ae73b5a32ce 100644
--- a/web-ui/src/main/resources/catalog/js/edit/EditorBoardController.js
+++ b/web-ui/src/main/resources/catalog/js/edit/EditorBoardController.js
@@ -184,7 +184,7 @@
         }
       ];
 
-      gnSearchSettings.resultTemplate = gnSearchSettings.resultViewTpls[0].tplUrl;
+      gnSearchSettings.resultTemplate = gnSearchSettings.resultViewTpls[0];
 
       $scope.facetsSummaryType = gnSearchSettings.facetsSummaryType = "manager";
       $scope.facetConfig = gnGlobalSettings.gnCfg.mods.editor.facetConfig;
diff --git a/web-ui/src/main/resources/catalog/js/search/SearchController.js b/web-ui/src/main/resources/catalog/js/search/SearchController.js
index ca50303f319..164b49ea9d8 100644
--- a/web-ui/src/main/resources/catalog/js/search/SearchController.js
+++ b/web-ui/src/main/resources/catalog/js/search/SearchController.js
@@ -107,7 +107,7 @@
 
       /* Default result view template */
       $scope.resultTemplate =
-        gnSearchSettings.resultTemplate || gnSearchSettings.resultViewTpls[0].tplUrl;
+        gnSearchSettings.resultTemplate || gnSearchSettings.resultViewTpls[0];
       /* Default advanced search form template */
       $scope.advancedSearchTemplate =
         gnSearchSettings.advancedSearchTemplate ||
diff --git a/web-ui/src/main/resources/catalog/locales/en-admin.json b/web-ui/src/main/resources/catalog/locales/en-admin.json
index 49163b29f7b..74d47cc9712 100644
--- a/web-ui/src/main/resources/catalog/locales/en-admin.json
+++ b/web-ui/src/main/resources/catalog/locales/en-admin.json
@@ -1071,6 +1071,11 @@
     "ui-createPageTpl-horizontal": "Horizontal",
     "ui-createPageTpl-vertical": "Vertical",
     "ui-createPageTpl-other": "Custom",
+    "ui-resultViewTpls-icon": "Icon",
+    "ui-resultViewTpls-tplUrl": "HTML template URL",
+    "ui-resultViewTpls-tooltip": "Tooltip",
+    "ui-resultViewTpls-relatedTypes": "(optional) Related types to load",
+    "ui-resultViewTpls-source": "(optional) Fields to exclude",
     "ui-languages": "List of languages",
     "ui-filters": "Filters",
     "ui-minUserProfileToCreateTemplate": "Which minimum profile is required to manage/create template?",
diff --git a/web-ui/src/main/resources/catalog/views/default/module.js b/web-ui/src/main/resources/catalog/views/default/module.js
index dd9c5fd4486..f8d0a08dacb 100644
--- a/web-ui/src/main/resources/catalog/views/default/module.js
+++ b/web-ui/src/main/resources/catalog/views/default/module.js
@@ -110,9 +110,11 @@
     "$scope",
     "gnRelatedResources",
     function ($scope, gnRelatedResources) {
-      $scope.resultTemplate =
-        "../../catalog/components/" +
-        "search/resultsview/partials/viewtemplates/grid4maps.html";
+      $scope.resultTemplate = {
+        tplUrl:
+          "../../catalog/components/" +
+          "search/resultsview/partials/viewtemplates/grid4maps.html"
+      };
       $scope.searchObj = {
         permalink: false,
         internal: true,
@@ -212,7 +214,7 @@
       $scope.activeTab = "/home";
       $scope.formatter = gnGlobalSettings.gnCfg.mods.search.formatter;
       $scope.listOfResultTemplate = gnGlobalSettings.gnCfg.mods.search.resultViewTpls;
-      $scope.resultTemplate = gnSearchSettings.resultTemplate;
+      $scope.resultTemplate = gnGlobalSettings.getDefaultResultTemplate();
       $scope.advandedSearchTemplate = gnSearchSettings.advancedSearchTemplate;
       $scope.facetsSummaryType = gnSearchSettings.facetsSummaryType;
       $scope.facetConfig = gnSearchSettings.facetConfig;