src/store/project-panel/project-panel-middleware-service.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import {
   6     DataExplorerMiddlewareService,
   7     dataExplorerToListParams,
   8     getDataExplorerColumnFilters,
   9     listResultsToDataExplorerItemsMeta,
  10 } from "store/data-explorer/data-explorer-middleware-service";
  11 import { ProjectPanelColumnNames } from "views/project-panel/project-panel";
  12 import { RootState } from "store/store";
  13 import { DataColumns } from "components/data-table/data-table";
  14 import { ServiceRepository } from "services/services";
  15 import { SortDirection } from "components/data-table/data-column";
  16 import { OrderBuilder, OrderDirection } from "services/api/order-builder";
  17 import { FilterBuilder, joinFilters } from "services/api/filter-builder";
  18 import { GroupContentsResource, GroupContentsResourcePrefix } from "services/groups-service/groups-service";
  19 import { updateFavorites } from "store/favorites/favorites-actions";
  20 import { IS_PROJECT_PANEL_TRASHED, getProjectPanelCurrentUuid } from "store/project-panel/project-panel-action";
  21 import { projectPanelActions } from "store/project-panel/project-panel-action-bind";
  22 import { Dispatch, MiddlewareAPI } from "redux";
  23 import { ProjectResource } from "models/project";
  24 import { updateResources } from "store/resources/resources-actions";
  25 import { getProperty } from "store/properties/properties";
  26 import { snackbarActions, SnackbarKind } from "store/snackbar/snackbar-actions";
  27 import { progressIndicatorActions } from "store/progress-indicator/progress-indicator-actions";
  28 import { DataExplorer, getDataExplorer } from "store/data-explorer/data-explorer-reducer";
  29 import { ListResults } from "services/common-service/common-service";
  30 import { loadContainers } from "store/processes/processes-actions";
  31 import { ResourceKind } from "models/resource";
  32 import { getSortColumn } from "store/data-explorer/data-explorer-reducer";
  33 import { serializeResourceTypeFilters, buildProcessStatusFilters } from "store/resource-type-filters/resource-type-filters";
  34 import { updatePublicFavorites } from "store/public-favorites/public-favorites-actions";
  35 import { selectedFieldsOfGroup } from "models/group";
  36 import { defaultCollectionSelectedFields } from "models/collection";
  37 import { containerRequestFieldsNoMounts } from "models/container-request";
  38
  39 export class ProjectPanelMiddlewareService extends DataExplorerMiddlewareService {
  40     constructor(private services: ServiceRepository, id: string) {
  41         super(id);
  42     }
  43
  44     async requestItems(api: MiddlewareAPI<Dispatch, RootState>, criteriaChanged?: boolean, background?: boolean) {
  45         const state = api.getState();
  46         const dataExplorer = getDataExplorer(state.dataExplorer, this.getId());
  47         const projectUuid = getProjectPanelCurrentUuid(state);
  48         const isProjectTrashed = getProperty<string>(IS_PROJECT_PANEL_TRASHED)(state.properties);
  49         if (!projectUuid) {
  50             api.dispatch(projectPanelCurrentUuidIsNotSet());
  51         } else if (!dataExplorer) {
  52             api.dispatch(projectPanelDataExplorerIsNotSet());
  53         } else {
  54             try {
  55                 if (!background) { api.dispatch(progressIndicatorActions.START_WORKING(this.getId())); }
  56                 const response = await this.services.groupsService.contents(projectUuid, getParams(dataExplorer, !!isProjectTrashed));
  57                 const resourceUuids = response.items.map(item => item.uuid);
  58                 api.dispatch<any>(updateFavorites(resourceUuids));
  59                 api.dispatch<any>(updatePublicFavorites(resourceUuids));
  60                 api.dispatch(updateResources(response.items));
  61                 await api.dispatch<any>(loadMissingProcessesInformation(response.items));
  62                 api.dispatch(setItems(response));
  63             } catch (e) {
  64                 api.dispatch(
  65                     projectPanelActions.SET_ITEMS({
  66                         items: [],
  67                         itemsAvailable: 0,
  68                         page: 0,
  69                         rowsPerPage: dataExplorer.rowsPerPage,
  70                     })
  71                 );
  72                 if (e.status === 404) {
  73                     // It'll just show up as not found
  74                 }
  75                 else {
  76                     api.dispatch(couldNotFetchProjectContents());
  77                 }
  78             } finally {
  79                 if (!background) { api.dispatch(progressIndicatorActions.PERSIST_STOP_WORKING(this.getId())); }
  80             }
  81         }
  82     }
  83 }
  84
  85 export const loadMissingProcessesInformation = (resources: GroupContentsResource[]) => async (dispatch: Dispatch) => {
  86     const containerUuids = resources.reduce((uuids, resource) => {
  87         return resource.kind === ResourceKind.CONTAINER_REQUEST && resource.containerUuid && !uuids.includes(resource.containerUuid)
  88             ? [...uuids, resource.containerUuid]
  89             : uuids;
  90     }, [] as string[]);
  91     if (containerUuids.length > 0) {
  92         await dispatch<any>(loadContainers(containerUuids, false));
  93     }
  94 };
  95
  96 export const setItems = (listResults: ListResults<GroupContentsResource>) =>
  97     projectPanelActions.SET_ITEMS({
  98         ...listResultsToDataExplorerItemsMeta(listResults),
  99         items: listResults.items.map(resource => resource.uuid),
 100     });
 101
 102 export const getParams = (dataExplorer: DataExplorer, isProjectTrashed: boolean) => ({
 103     ...dataExplorerToListParams(dataExplorer),
 104     order: getOrder(dataExplorer),
 105     filters: getFilters(dataExplorer),
 106     includeTrash: isProjectTrashed,
 107     select: selectedFieldsOfGroup.concat(defaultCollectionSelectedFields, containerRequestFieldsNoMounts),
 108 });
 109
 110 export const getFilters = (dataExplorer: DataExplorer) => {
 111     const columns = dataExplorer.columns as DataColumns<string, ProjectResource>;
 112     const typeFilters = serializeResourceTypeFilters(getDataExplorerColumnFilters(columns, ProjectPanelColumnNames.TYPE));
 113     const statusColumnFilters = getDataExplorerColumnFilters(columns, "Status");
 114     const activeStatusFilter = Object.keys(statusColumnFilters).find(filterName => statusColumnFilters[filterName].selected);
 115
 116     // TODO: Extract group contents name filter
 117     const nameFilters = new FilterBuilder()
 118         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.COLLECTION)
 119         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.PROCESS)
 120         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.PROJECT)
 121         .getFilters();
 122
 123     // Filter by container status
 124     const statusFilters = buildProcessStatusFilters(new FilterBuilder(), activeStatusFilter || "", GroupContentsResourcePrefix.PROCESS).getFilters();
 125
 126     return joinFilters(statusFilters, typeFilters, nameFilters);
 127 };
 128
 129 const getOrder = (dataExplorer: DataExplorer) => {
 130     const sortColumn = getSortColumn<ProjectResource>(dataExplorer);
 131     const order = new OrderBuilder<ProjectResource>();
 132     if (sortColumn && sortColumn.sort) {
 133         const sortDirection = sortColumn.sort.direction === SortDirection.ASC ? OrderDirection.ASC : OrderDirection.DESC;
 134
 135         // Use createdAt as a secondary sort column so we break ties consistently.
 136         return order
 137             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.COLLECTION)
 138             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.PROCESS)
 139             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.PROJECT)
 140             .addOrder(OrderDirection.DESC, "createdAt", GroupContentsResourcePrefix.PROCESS)
 141             .getOrder();
 142     } else {
 143         return order.getOrder();
 144     }
 145 };
 146
 147 const projectPanelCurrentUuidIsNotSet = () =>
 148     snackbarActions.OPEN_SNACKBAR({
 149         message: "Project panel is not opened.",
 150         kind: SnackbarKind.ERROR,
 151     });
 152
 153 const couldNotFetchProjectContents = () =>
 154     snackbarActions.OPEN_SNACKBAR({
 155         message: "Could not fetch project contents.",
 156         kind: SnackbarKind.ERROR,
 157     });
 158
 159 const projectPanelDataExplorerIsNotSet = () =>
 160     snackbarActions.OPEN_SNACKBAR({
 161         message: "Project panel is not ready.",
 162         kind: SnackbarKind.ERROR,
 163     });