services/workbench2/src/store/search-results-panel/search-results-middleware-service.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { ServiceRepository } from 'services/services';
   6 import { MiddlewareAPI, Dispatch } from 'redux';
   7 import { DataExplorerMiddlewareService, dataExplorerToListParams, listResultsToDataExplorerItemsMeta, getDataExplorerColumnFilters } from 'store/data-explorer/data-explorer-middleware-service';
   8 import { RootState } from 'store/store';
   9 import { snackbarActions, SnackbarKind } from 'store/snackbar/snackbar-actions';
  10 import { DataExplorer, getDataExplorer } from 'store/data-explorer/data-explorer-reducer';
  11 import { updateResources } from 'store/resources/resources-actions';
  12 import { SortDirection } from 'components/data-table/data-column';
  13 import { OrderDirection, OrderBuilder } from 'services/api/order-builder';
  14 import { GroupContentsResource, GroupContentsResourcePrefix } from "services/groups-service/groups-service";
  15 import { ListResults } from 'services/common-service/common-service';
  16 import { searchResultsPanelActions } from 'store/search-results-panel/search-results-panel-actions';
  17 import {
  18     getSearchSessions,
  19     queryToFilters,
  20     getAdvancedDataFromQuery,
  21 } from 'store/search-bar/search-bar-actions';
  22 import { getSortColumn } from "store/data-explorer/data-explorer-reducer";
  23 import { FilterBuilder, joinFilters } from 'services/api/filter-builder';
  24 import { DataColumns } from 'components/data-table/data-table';
  25 import { serializeResourceTypeFilters } from 'store//resource-type-filters/resource-type-filters';
  26 import { ProjectPanelColumnNames } from 'views/project-panel/project-panel';
  27 import { ResourceKind } from 'models/resource';
  28 import { ContainerRequestResource } from 'models/container-request';
  29 import { progressIndicatorActions } from 'store/progress-indicator/progress-indicator-actions';
  30 import { dataExplorerActions } from 'store/data-explorer/data-explorer-action';
  31
  32 export class SearchResultsMiddlewareService extends DataExplorerMiddlewareService {
  33     constructor(private services: ServiceRepository, id: string, private responseMap: Record<string, number> = {}) {
  34         super(id);
  35     }
  36
  37     async requestItems(api: MiddlewareAPI<Dispatch, RootState>, criteriaChanged?: boolean) {
  38         const state = api.getState();
  39         const dataExplorer = getDataExplorer(state.dataExplorer, this.getId());
  40         const searchValue = state.searchBar.searchValue;
  41         const { cluster: clusterId } = getAdvancedDataFromQuery(searchValue);
  42         const sessions = getSearchSessions(clusterId, state.auth.sessions);
  43         const recentQueries = this.services.searchService.getRecentQueries();
  44         //the last query is compared to the current query to check if the value has changed
  45         //once the search button is clicked, the value is pushed to the recentQueries array
  46         //therefore, the last query is the second to last element in the array
  47         const lastQuery = recentQueries[recentQueries.length - 2];
  48
  49         if (searchValue.trim() === '') {
  50             return;
  51         }
  52
  53         const initial = {
  54             itemsAvailable: 0,
  55             items: [] as GroupContentsResource[],
  56             kind: '',
  57             offset: 0,
  58             limit: 10
  59         };
  60
  61         if (criteriaChanged) {
  62             api.dispatch(setItems(initial));
  63         }
  64
  65         const numberOfSessions = sessions.length;
  66         let numberOfResolvedResponses = 0;
  67         let totalNumItemsAvailable = 0;
  68         api.dispatch(progressIndicatorActions.START_WORKING(this.id))
  69         api.dispatch(dataExplorerActions.SET_IS_NOT_FOUND({ id: this.id, isNotFound: false }));
  70
  71         //In SearchResultsPanel, if we don't reset the items available, the items available will
  72         //will be added to the previous value every time the 'load more' button is clicked.
  73         api.dispatch(resetItemsAvailable());
  74
  75         sessions.forEach(session => {
  76             const params = getParams(dataExplorer, searchValue, session.apiRevision);
  77             this.services.groupsService.contents('', params, session)
  78                 .then((response) => {
  79                     //if items were added or deleted, we ignore them for "load more" button purposes
  80                     if (lastQuery === searchValue && this.responseMap[session.clusterId] && this.responseMap[session.clusterId] !== response.itemsAvailable) {
  81                         response.itemsAvailable = this.responseMap[session.clusterId];
  82                     }
  83                     this.responseMap[session.clusterId] = response.itemsAvailable;
  84                     api.dispatch(updateResources(response.items));
  85                     api.dispatch(appendItems(response));
  86                     numberOfResolvedResponses++;
  87                     totalNumItemsAvailable += response.itemsAvailable;
  88                     if (numberOfResolvedResponses === numberOfSessions) {
  89                         api.dispatch(progressIndicatorActions.STOP_WORKING(this.id))
  90                         if(totalNumItemsAvailable === 0) api.dispatch(dataExplorerActions.SET_IS_NOT_FOUND({ id: this.id, isNotFound: true }))
  91                     }
  92                     // Request all containers for process status to be available
  93                     const containerRequests = response.items.filter((item) => item.kind === ResourceKind.CONTAINER_REQUEST) as ContainerRequestResource[];
  94                     const containerUuids = containerRequests.map(container => container.containerUuid).filter(uuid => uuid !== null) as string[];
  95                     containerUuids.length && this.services.containerService
  96                         .list({
  97                             filters: new FilterBuilder()
  98                                 .addIn('uuid', containerUuids)
  99                                 .getFilters()
 100                         }, false)
 101                         .then((containers) => {
 102                             api.dispatch(updateResources(containers.items));
 103                         });
 104                     }).catch(() => {
 105                         api.dispatch(couldNotFetchSearchResults(session.clusterId));
 106                         api.dispatch(progressIndicatorActions.STOP_WORKING(this.id))
 107                     });
 108             }
 109         );
 110     }
 111 }
 112
 113 const typeFilters = (columns: DataColumns<string, GroupContentsResource>) => serializeResourceTypeFilters(getDataExplorerColumnFilters(columns, ProjectPanelColumnNames.TYPE));
 114
 115 export const getParams = (dataExplorer: DataExplorer, query: string, apiRevision: number) => ({
 116     ...dataExplorerToListParams(dataExplorer),
 117     filters: joinFilters(
 118         queryToFilters(query, apiRevision),
 119         typeFilters(dataExplorer.columns)
 120     ),
 121     order: getOrder(dataExplorer),
 122     includeTrash: getAdvancedDataFromQuery(query).inTrash,
 123     includeOldVersions: getAdvancedDataFromQuery(query).pastVersions
 124 });
 125
 126 const getOrder = (dataExplorer: DataExplorer) => {
 127     const sortColumn = getSortColumn<GroupContentsResource>(dataExplorer);
 128     const order = new OrderBuilder<GroupContentsResource>();
 129     if (sortColumn && sortColumn.sort) {
 130         const sortDirection = sortColumn.sort.direction === SortDirection.ASC
 131             ? OrderDirection.ASC
 132             : OrderDirection.DESC;
 133
 134         // Use createdAt as a secondary sort column so we break ties consistently.
 135         return order
 136             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.COLLECTION)
 137             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.PROCESS)
 138             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.PROJECT)
 139             .addOrder(OrderDirection.DESC, "createdAt", GroupContentsResourcePrefix.PROCESS)
 140             .getOrder();
 141     } else {
 142         return order.getOrder();
 143     }
 144 };
 145
 146 export const setItems = (listResults: ListResults<GroupContentsResource>) =>
 147     searchResultsPanelActions.SET_ITEMS({
 148         ...listResultsToDataExplorerItemsMeta(listResults),
 149         items: listResults.items.map(resource => resource.uuid),
 150     });
 151
 152 export const resetItemsAvailable = () =>
 153     searchResultsPanelActions.RESET_ITEMS_AVAILABLE();
 154
 155 export const appendItems = (listResults: ListResults<GroupContentsResource>) =>
 156     searchResultsPanelActions.APPEND_ITEMS({
 157         ...listResultsToDataExplorerItemsMeta(listResults),
 158         items: listResults.items.map(resource => resource.uuid),
 159     });
 160
 161 const couldNotFetchSearchResults = (cluster: string) =>
 162     snackbarActions.OPEN_SNACKBAR({
 163         message: `Could not fetch search results from ${cluster}.`,
 164         kind: SnackbarKind.ERROR
 165     });