GUI Issue-#3737: faceted search export templates control (#3742)

* GUI Issue-#3737: faceted search export templates control

* GUI Issue-#3737: export template modal text adjustments

* GUI Issue-#3737: export template modal text adjustments

* GUI Issue-#3737: export template modal small fix

Author: AleksandrGorodetskii

client/src/components/search/faceted-search/controls/export-button/index.js

@@ -16,12 +16,17 @@
 
 import React from 'react';
 import PropTypes from 'prop-types';
+import {computed} from 'mobx';
+import {inject, observer} from 'mobx-react';
+import {Link} from 'react-router';
 import {
   Dropdown,
   Icon,
-  message
+  message,
+  Button,
+  Modal
 } from 'antd';
-import Menu, {MenuItem} from 'rc-menu';
+import Menu, {MenuItem, Divider} from 'rc-menu';
 import FileSaver from 'file-saver';
 import ExportConfigurationModal from './configuration-modal';
 import {getSortingPayload} from '../../utilities';
@@ -34,8 +39,14 @@ import {
   CloudPath,
   MountPath
 } from '../../utilities/document-columns';
+import roleModel from '../../../../../utils/roleModel';
 import FacetedSearchExport from '../../../../../models/search/faceted-search-export';
+// eslint-disable-next-line max-len
+import FacetedSearchExportTemplatesSave from '../../../../../models/search/faceted-search-export-templates-save';
+// eslint-disable-next-line max-len
+import FacetedSearchExportTemplates from '../../../../../models/search/faceted-search-export-templates';
 import checkBlob from '../../../../../utils/check-blob';
+import displayDate from '../../../../../utils/displayDate';
 
 const exportVOColumns = {
   [Name.key]: 'includeName',
@@ -47,9 +58,33 @@ const exportVOColumns = {
   [MountPath.key]: 'includeMountPath'
 };
 
-function ExportMenu ({onExport, onConfigure}) {
+function parseExportTemplates (rawTemplates = {}) {
+  return Object.entries(rawTemplates).map(([key, template]) => ({
+    ...template,
+    key
+  }));
+}
+
+function checkTemplatePermissions (userInfo, template) {
+  if (!userInfo) {
+    return false;
+  }
+  const {userName, groups = []} = userInfo;
+  return template.permissions.some(permission => {
+    if (permission.principal) {
+      return permission.name === userName;
+    }
+    return roleModel.userHasRole(
+      userInfo,
+      (permission.name || '').toUpperCase()
+    ) || groups.includes(permission.nzme);
+  });
+}
+
+function ExportMenu ({onExport, onExportTemplate, onConfigure, templates}) {
   const handle = ({key}) => {
-    switch (key) {
+    const [exportType, exportKey] = key.split('|');
+    switch (exportType) {
       case 'export':
         if (typeof onExport === 'function') {
           onExport();
@@ -60,10 +95,24 @@ function ExportMenu ({onExport, onConfigure}) {
           onConfigure();
         }
         break;
+      case 'template':
+        if (typeof onExportTemplate === 'function') {
+          const currentTemplate = templates.find(({key}) => key === exportKey);
+          onExportTemplate(currentTemplate);
+        }
+        break;
       default:
         break;
     }
   };
+  const templatesSection = templates.length ? [
+    <Divider key="divider" />,
+    ...templates.map(template => (
+      <MenuItem key={`template|${template.key}`}>
+        {template['friendly_name'] || template.key}
+      </MenuItem>
+    ))
+  ] : [];
   return (
     <Menu
       onClick={handle}
@@ -78,17 +127,64 @@ function ExportMenu ({onExport, onConfigure}) {
         <Icon type="bars" style={{marginRight: 10}} />
         Custom configuration
       </MenuItem>
+      {templatesSection}
     </Menu>
   );
 }
 
+@inject('preferences', 'authenticatedUserInfo', 'dataStorages')
+@observer
 class ExportButton extends React.Component {
   state = {
     pending: false,
     modalVisible: false,
     dropdownVisible: false
   };
 
+  @computed
+  get exportTemplates () {
+    const {preferences} = this.props;
+    if (preferences?.loaded) {
+      return preferences.searchExportTemplates;
+    }
+    return undefined;
+  }
+
+  @computed
+  get isAdmin () {
+    const {authenticatedUserInfo} = this.props;
+    if (authenticatedUserInfo.loaded) {
+      return authenticatedUserInfo.value.admin;
+    }
+    return false;
+  }
+
+  getFacetedSearchExportPayload = (configuration) => {
+    const {
+      advanced,
+      columns = [],
+      query: currentQuery,
+      filters = {},
+      sorting = [],
+      facets = []
+    } = this.props;
+    const columnsToExport = configuration && configuration.length
+      ? columns.filter((aColumn) => configuration.includes(aColumn.key))
+      : columns.slice();
+    const keys = columnsToExport.map((column) => column.key);
+    const metadataFields = keys.filter((key) => !exportVOColumns[key]);
+    return {
+      query: !advanced && currentQuery
+        ? `*${currentQuery}*`
+        : (currentQuery || '*'),
+      filters,
+      sorts: getSortingPayload(sorting),
+      metadataFields,
+      facets: facets.map((facet) => facet.name),
+      highlight: false
+    };
+  };
+
   openModal = () => {
     this.setState({
       modalVisible: true,
@@ -118,39 +214,22 @@ class ExportButton extends React.Component {
         this.setState(state, () => resolve()));
     const hide = message.loading('Exporting...', 0);
     await setStateAwaited({pending: true});
-    const {
-      advanced,
-      columns = [],
-      query: currentQuery,
-      filters = {},
-      sorting = [],
-      facets = []
-    } = this.props;
+    const {columns = []} = this.props;
     const columnsToExport = configuration && configuration.length
       ? columns.filter((aColumn) => configuration.includes(aColumn.key))
       : columns.slice();
     try {
       const keys = columnsToExport.map((column) => column.key);
-      const metadataFields = keys.filter((key) => !exportVOColumns[key]);
       const facetedSearchExportVO = Object.entries(exportVOColumns)
         .reduce((acc, [key, exportVOKey]) => ({
           ...acc,
           [exportVOKey]: !!keys.includes(key)
         }), {delimiter: ','});
       const csvFileName = 'export.csv';
       const payload = {
-        csvFileName: 'export.csv',
+        csvFileName,
         facetedSearchExportVO,
-        facetedSearchRequest: {
-          query: !advanced && currentQuery
-            ? `*${currentQuery}*`
-            : (currentQuery || '*'),
-          filters,
-          sorts: getSortingPayload(sorting),
-          metadataFields,
-          facets: facets.map((facet) => facet.name),
-          highlight: false
-        }
+        facetedSearchRequest: this.getFacetedSearchExportPayload(configuration)
       };
       const request = new FacetedSearchExport();
       await request.send(payload);
@@ -175,6 +254,89 @@ class ExportButton extends React.Component {
 
   onDefaultExport = () => this.onExport();
 
+  onExportTemplate = async (template, payload) => {
+    const downloadExport = async (template) => {
+      const request = new FacetedSearchExportTemplates(template.key);
+      await request.send(payload);
+      if (request.error) {
+        return message.error(request.error, 5);
+      }
+      if (request.value instanceof Blob) {
+        const error = await checkBlob(request.value, 'Error exporting search results');
+        if (error) {
+          return message.error(error.message, 5);
+        }
+        const fileName = `${template.key}-${displayDate(Date.now(), 'YYYY-MM-DD HH:mm:ss')}.xls`;
+        FileSaver.saveAs(request.value, fileName);
+      }
+    };
+    const saveExport = async (template, payload) => {
+      const request = new FacetedSearchExportTemplatesSave(template.key);
+      await request.send(payload);
+      if (request.error) {
+        return message.error(request.error, 5);
+      }
+      this.setState({savedExport: request.value});
+    };
+    const uploadToBucket = !!template.save_to;
+    this.closeModal();
+    const setStateAwaited = (state) =>
+      new Promise((resolve) =>
+        this.setState(state, () => resolve()));
+    const hide = message.loading(uploadToBucket ? 'Exporting...' : 'Downloading...', 0);
+    await setStateAwaited({pending: true});
+    try {
+      const payload = this.getFacetedSearchExportPayload();
+      if (uploadToBucket) {
+        await saveExport(template, payload);
+      } else {
+        await downloadExport(template, payload);
+      }
+    } catch (e) {
+      message.error(e.message, 5);
+    } finally {
+      hide();
+      this.setState({
+        pending: false
+      });
+    }
+  };
+
+  closeExportResultModal = () => this.setState({savedExport: undefined});
+
+  openExportResultModal = template => this.setState({savedExport: template});
+
+  renderSavedExportContent = () => {
+    const {savedExport} = this.state;
+    const getStorageById = (id) => {
+      const {
+        dataStorages
+      } = this.props;
+      if (dataStorages.loaded) {
+        return (dataStorages.value || []).find(d => Number(d.id) === Number(id));
+      }
+      return undefined;
+    };
+    if (!savedExport) {
+      return null;
+    }
+    const storage = getStorageById(savedExport.storageId);
+    const path = savedExport.storagePath.split('/');
+    const file = path.pop();
+    const folder = path.join('/');
+    return (
+      <div style={{paddingRight: 25}}>
+        Data exported to
+        <Link
+          style={{marginLeft: 5}}
+          to={`storage/${savedExport.storageId}?path=${folder}`}
+        >
+          {`${storage?.name || savedExport.storageId}/${folder}/${file}`}
+        </Link>.
+      </div>
+    );
+  };
+
   render () {
     const {
       columns,
@@ -187,12 +349,25 @@ class ExportButton extends React.Component {
       modalVisible,
       dropdownVisible
     } = this.state;
+    const templates = parseExportTemplates(this.exportTemplates)
+      .filter(template => {
+        if (!template.permissions || this.isAdmin) {
+          return true;
+        }
+        if (!this.props.authenticatedUserInfo.loaded) {
+          return false;
+        }
+        return checkTemplatePermissions(this.props.authenticatedUserInfo.value, template);
+      });
     return (
       <Dropdown.Button
         overlay={(
           <ExportMenu
             onExport={this.onDefaultExport}
+            onExportTemplate={this.onExportTemplate}
             onConfigure={this.onConfigure}
+            templates={templates}
+            storages={this.storages}
           />
         )}
         className={className}
@@ -212,6 +387,25 @@ class ExportButton extends React.Component {
           onExport={this.onExport}
           columns={columns}
         />
+        <Modal
+          title={null}
+          visible={!!this.state.savedExport}
+          onCancel={this.closeExportResultModal}
+          width="fit-content"
+          style={{
+            minWidth: '30vw',
+            maxWidth: '80vw'
+          }}
+          footer={
+            <Button
+              type="primary"
+              onClick={this.closeExportResultModal}>
+              OK
+            </Button>
+          }
+        >
+          {this.renderSavedExportContent()}
+        </Modal>
       </Dropdown.Button>
     );
   }

client/src/models/preferences/PreferencesLoad.js

@@ -104,6 +104,19 @@ class PreferencesLoad extends Remote {
     return !!this.getPreferenceValue('search.elastic.host');
   }
 
+  @computed
+  get searchExportTemplates () {
+    const value = this.getPreferenceValue('search.export.template.mapping');
+    if (value) {
+      try {
+        return JSON.parse(value);
+      } catch (e) {
+        console.warn('Error parsing "search.export.template.mapping:', e);
+      }
+    }
+    return undefined;
+  }
+
   @computed
   get billingEnabled () {
     const value = this.getPreferenceValue('billing.reports.enabled');

client/src/models/search/faceted-search-export-templates-save.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2017-2024 EPAM Systems, Inc. (https://www.epam.com/)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+import RemotePost from '../basic/RemotePost';
+
+// Upload template export result to bucket (template.save_to)
+class FacetSearchExportTemplatesSave extends RemotePost {
+  constructor (templateId) {
+    super();
+    this.url = `/search/facet/export/templates/save?templateId=${templateId}`;
+  }
+}
+
+export default FacetSearchExportTemplatesSave;