services/workbench2/src/store/project-panel/project-panel-data-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 { ProjectPanelDataColumnNames } from "views/project-panel/project-panel-data";
  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 { ContentsArguments, 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 { projectPanelDataActions } 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 { getSortColumn } from "store/data-explorer/data-explorer-reducer";
  31 import { buildProcessStatusFilters, serializeDataResourceTypeFilters } from "store/resource-type-filters/resource-type-filters";
  32 import { updatePublicFavorites } from "store/public-favorites/public-favorites-actions";
  33 import { selectedFieldsOfGroup } from "models/group";
  34 import { defaultCollectionSelectedFields } from "models/collection";
  35 import { ContextMenuActionNames } from "views-components/context-menu/context-menu-action-set";
  36 import { removeDisabledButton } from "store/multiselect/multiselect-actions";
  37 import { couldNotFetchItemsAvailable } from "store/data-explorer/data-explorer-action";
  38
  39 export class ProjectPanelDataMiddlewareService 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                 api.dispatch<any>(projectPanelDataActions.SET_IS_NOT_FOUND({ isNotFound: false }));
  56                 if (!background) { api.dispatch(progressIndicatorActions.START_WORKING(this.getId())); }
  57
  58                 // Get items
  59                 const response = await this.services.groupsService.contents(projectUuid, getParams(dataExplorer, !!isProjectTrashed));
  60                 const resourceUuids = [...response.items.map(item => item.uuid), projectUuid];
  61                 api.dispatch<any>(updateFavorites(resourceUuids));
  62                 api.dispatch<any>(updatePublicFavorites(resourceUuids));
  63                 api.dispatch(updateResources(response.items));
  64                 api.dispatch(setItems(response));
  65             } catch (e) {
  66                 api.dispatch(
  67                     projectPanelDataActions.SET_ITEMS({
  68                         items: [],
  69                         itemsAvailable: 0,
  70                         page: 0,
  71                         rowsPerPage: dataExplorer.rowsPerPage,
  72                     })
  73                 );
  74                 if (e.status === 404) {
  75                     api.dispatch<any>(projectPanelDataActions.SET_IS_NOT_FOUND({ isNotFound: true}));
  76                 }
  77                 else {
  78                     api.dispatch(couldNotFetchProjectContents());
  79                 }
  80             } finally {
  81                 if (!background) {
  82                     api.dispatch(progressIndicatorActions.PERSIST_STOP_WORKING(this.getId()));
  83                     api.dispatch<any>(removeDisabledButton(ContextMenuActionNames.MOVE_TO_TRASH))
  84                 }
  85             }
  86         }
  87     }
  88
  89     async requestCount(api: MiddlewareAPI<Dispatch, RootState>, criteriaChanged?: boolean, background?: boolean) {
  90         const state = api.getState();
  91         const dataExplorer = getDataExplorer(state.dataExplorer, this.getId());
  92         const projectUuid = getProjectPanelCurrentUuid(state);
  93         const isProjectTrashed = getProperty<string>(IS_PROJECT_PANEL_TRASHED)(state.properties);
  94
  95         if (criteriaChanged && projectUuid) {
  96             // Get itemsAvailable
  97             return this.services.groupsService.contents(projectUuid, getCountParams(dataExplorer, !!isProjectTrashed))
  98                 .then((results: ListResults<GroupContentsResource>) => {
  99                     if (results.itemsAvailable !== undefined) {
 100                         api.dispatch<any>(projectPanelDataActions.SET_ITEMS_AVAILABLE(results.itemsAvailable));
 101                     } else {
 102                         couldNotFetchItemsAvailable();
 103                     }
 104                 });
 105         }
 106     }
 107 }
 108
 109 export const setItems = (listResults: ListResults<GroupContentsResource>) =>
 110     projectPanelDataActions.SET_ITEMS({
 111         ...listResultsToDataExplorerItemsMeta(listResults),
 112         items: listResults.items.map(resource => resource.uuid),
 113     });
 114
 115 export const getParams = (dataExplorer: DataExplorer, isProjectTrashed: boolean): ContentsArguments => ({
 116     ...dataExplorerToListParams(dataExplorer),
 117     order: getOrder(dataExplorer),
 118     filters: getFilters(dataExplorer),
 119     includeTrash: isProjectTrashed,
 120     select: selectedFieldsOfGroup.concat(defaultCollectionSelectedFields),
 121     count: 'none',
 122 });
 123
 124 const getCountParams = (dataExplorer: DataExplorer, isProjectTrashed: boolean): ContentsArguments => ({
 125     filters: getFilters(dataExplorer),
 126     includeTrash: isProjectTrashed,
 127     limit: 0,
 128     count: 'exact',
 129 });
 130
 131 export const getFilters = (dataExplorer: DataExplorer) => {
 132     const columns = dataExplorer.columns as DataColumns<string, ProjectResource>;
 133     const typeFilters = serializeDataResourceTypeFilters(getDataExplorerColumnFilters(columns, ProjectPanelDataColumnNames.TYPE));
 134     const statusColumnFilters = getDataExplorerColumnFilters(columns, "Status");
 135     const activeStatusFilter = Object.keys(statusColumnFilters).find(filterName => statusColumnFilters[filterName].selected);
 136
 137     // TODO: Extract group contents name filter
 138     const nameFilters = new FilterBuilder()
 139         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.COLLECTION)
 140         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.PROJECT)
 141         .getFilters();
 142
 143     // Filter by container status
 144     const statusFilters = buildProcessStatusFilters(new FilterBuilder(), activeStatusFilter || "", GroupContentsResourcePrefix.PROCESS).getFilters();
 145
 146     return joinFilters(statusFilters, typeFilters, nameFilters);
 147 };
 148
 149 const getOrder = (dataExplorer: DataExplorer) => {
 150     const sortColumn = getSortColumn<ProjectResource>(dataExplorer);
 151     const order = new OrderBuilder<ProjectResource>();
 152     if (sortColumn && sortColumn.sort) {
 153         const sortDirection = sortColumn.sort.direction === SortDirection.ASC ? OrderDirection.ASC : OrderDirection.DESC;
 154
 155         // Use createdAt as a secondary sort column so we break ties consistently.
 156         return order
 157             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.COLLECTION)
 158             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.PROJECT)
 159             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.WORKFLOW)
 160             .addOrder(OrderDirection.DESC, "createdAt")
 161             .getOrder();
 162     } else {
 163         return order.getOrder();
 164     }
 165 };
 166
 167 const projectPanelCurrentUuidIsNotSet = () =>
 168     snackbarActions.OPEN_SNACKBAR({
 169         message: "Project panel is not opened.",
 170         kind: SnackbarKind.ERROR,
 171     });
 172
 173 const couldNotFetchProjectContents = () =>
 174     snackbarActions.OPEN_SNACKBAR({
 175         message: "Could not fetch project contents.",
 176         kind: SnackbarKind.ERROR,
 177     });
 178
 179 const projectPanelDataExplorerIsNotSet = () =>
 180     snackbarActions.OPEN_SNACKBAR({
 181         message: "Project panel is not ready.",
 182         kind: SnackbarKind.ERROR,
 183     });