15019: Adds Status filtering to project panel.
[arvados-workbench2.git] / 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, projectPanelActions, getProjectPanelCurrentUuid } from '~/store/project-panel/project-panel-action';
21 import { Dispatch, MiddlewareAPI } from "redux";
22 import { ProjectResource } from "~/models/project";
23 import { updateResources } from "~/store/resources/resources-actions";
24 import { getProperty } from "~/store/properties/properties";
25 import { snackbarActions, SnackbarKind } from '~/store/snackbar/snackbar-actions';
26 import { progressIndicatorActions } from '~/store/progress-indicator/progress-indicator-actions.ts';
27 import { DataExplorer, getDataExplorer } from '~/store/data-explorer/data-explorer-reducer';
28 import { ListResults } from '~/services/common-service/common-service';
29 import { loadContainers } from '~/store/processes/processes-actions';
30 import { ResourceKind } from '~/models/resource';
31 import { getSortColumn } from "~/store/data-explorer/data-explorer-reducer";
32 import { serializeResourceTypeFilters, ProcessStatusFilter } from '~/store/resource-type-filters/resource-type-filters';
33 import { updatePublicFavorites } from '~/store/public-favorites/public-favorites-actions';
34
35 export class ProjectPanelMiddlewareService extends DataExplorerMiddlewareService {
36     constructor(private services: ServiceRepository, id: string) {
37         super(id);
38     }
39
40     async requestItems(api: MiddlewareAPI<Dispatch, RootState>) {
41         const state = api.getState();
42         const dataExplorer = getDataExplorer(state.dataExplorer, this.getId());
43         const projectUuid = getProjectPanelCurrentUuid(state);
44         const isProjectTrashed = getProperty<string>(IS_PROJECT_PANEL_TRASHED)(state.properties);
45         if (!projectUuid) {
46             api.dispatch(projectPanelCurrentUuidIsNotSet());
47         } else if (!dataExplorer) {
48             api.dispatch(projectPanelDataExplorerIsNotSet());
49         } else {
50             try {
51                 api.dispatch(progressIndicatorActions.START_WORKING(this.getId()));
52                 const response = await this.services.groupsService.contents(projectUuid, getParams(dataExplorer, !!isProjectTrashed));
53                 api.dispatch(progressIndicatorActions.PERSIST_STOP_WORKING(this.getId()));
54                 const resourceUuids = response.items.map(item => item.uuid);
55                 api.dispatch<any>(updateFavorites(resourceUuids));
56                 api.dispatch<any>(updatePublicFavorites(resourceUuids));
57                 api.dispatch(updateResources(response.items));
58                 await api.dispatch<any>(loadMissingProcessesInformation(response.items));
59                 api.dispatch(setItems(response));
60             } catch (e) {
61                 api.dispatch(progressIndicatorActions.PERSIST_STOP_WORKING(this.getId()));
62                 api.dispatch(projectPanelActions.SET_ITEMS({
63                     items: [],
64                     itemsAvailable: 0,
65                     page: 0,
66                     rowsPerPage: dataExplorer.rowsPerPage
67                 }));
68                 api.dispatch(couldNotFetchProjectContents());
69             }
70         }
71     }
72 }
73
74 export const loadMissingProcessesInformation = (resources: GroupContentsResource[]) =>
75     async (dispatch: Dispatch) => {
76         const containerUuids = resources.reduce((uuids, resource) => {
77             return resource.kind === ResourceKind.CONTAINER_REQUEST
78                 ? resource.containerUuid
79                     ? [...uuids, resource.containerUuid]
80                     : uuids
81                 : uuids;
82         }, []);
83         if (containerUuids.length > 0) {
84             await dispatch<any>(loadContainers(
85                 new FilterBuilder().addIn('uuid', containerUuids).getFilters()
86             ));
87         }
88     };
89
90 export const setItems = (listResults: ListResults<GroupContentsResource>) =>
91     projectPanelActions.SET_ITEMS({
92         ...listResultsToDataExplorerItemsMeta(listResults),
93         items: listResults.items.map(resource => resource.uuid),
94     });
95
96 export const getParams = (dataExplorer: DataExplorer, isProjectTrashed: boolean) => ({
97     ...dataExplorerToListParams(dataExplorer),
98     order: getOrder(dataExplorer),
99     filters: getFilters(dataExplorer),
100     includeTrash: isProjectTrashed
101 });
102
103 export const getFilters = (dataExplorer: DataExplorer) => {
104     const columns = dataExplorer.columns as DataColumns<string>;
105     const typeFilters = serializeResourceTypeFilters(getDataExplorerColumnFilters(columns, ProjectPanelColumnNames.TYPE));
106     const statusColumnFilters = getDataExplorerColumnFilters(columns, 'Status');
107     const activeStatusFilter = Object.keys(statusColumnFilters).find(
108         filterName => statusColumnFilters[filterName].selected
109     );
110
111     // TODO: Extract group contents name filter
112     const nameFilters = new FilterBuilder()
113         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.COLLECTION)
114         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.PROCESS)
115         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.PROJECT)
116         .getFilters();
117
118     // Filter by container status
119     const fb = new FilterBuilder();
120     switch (activeStatusFilter) {
121         case ProcessStatusFilter.COMPLETED: {
122             fb.addEqual('container.state', 'Complete', GroupContentsResourcePrefix.PROCESS);
123             fb.addEqual('container.exit_code', '0', GroupContentsResourcePrefix.PROCESS);
124             break;
125         }
126         case ProcessStatusFilter.FAILED: {
127             fb.addEqual('container.state', 'Complete', GroupContentsResourcePrefix.PROCESS);
128             fb.addDistinct('container.exit_code', '0', GroupContentsResourcePrefix.PROCESS);
129             break;
130         }
131         case ProcessStatusFilter.CANCELLED:
132         case ProcessStatusFilter.FAILED:
133         case ProcessStatusFilter.LOCKED:
134         case ProcessStatusFilter.QUEUED:
135         case ProcessStatusFilter.RUNNING: {
136             fb.addEqual('container.state', activeStatusFilter, GroupContentsResourcePrefix.PROCESS);
137             break;
138         }
139     }
140     const statusFilters = fb.getFilters();
141
142     return joinFilters(
143         statusFilters,
144         typeFilters,
145         nameFilters,
146     );
147 };
148
149 export const getOrder = (dataExplorer: DataExplorer) => {
150     const sortColumn = getSortColumn(dataExplorer);
151     const order = new OrderBuilder<ProjectResource>();
152     if (sortColumn) {
153         const sortDirection = sortColumn && sortColumn.sortDirection === SortDirection.ASC
154             ? OrderDirection.ASC
155             : OrderDirection.DESC;
156
157         const columnName = sortColumn && sortColumn.name === ProjectPanelColumnNames.NAME ? "name" : "createdAt";
158         return order
159             .addOrder(sortDirection, columnName, GroupContentsResourcePrefix.COLLECTION)
160             .addOrder(sortDirection, columnName, GroupContentsResourcePrefix.PROCESS)
161             .addOrder(sortDirection, columnName, GroupContentsResourcePrefix.PROJECT)
162             .getOrder();
163     } else {
164         return order.getOrder();
165     }
166 };
167
168 const projectPanelCurrentUuidIsNotSet = () =>
169     snackbarActions.OPEN_SNACKBAR({
170         message: 'Project panel is not opened.',
171         kind: SnackbarKind.ERROR
172     });
173
174 const couldNotFetchProjectContents = () =>
175     snackbarActions.OPEN_SNACKBAR({
176         message: 'Could not fetch project contents.',
177         kind: SnackbarKind.ERROR
178     });
179
180 const projectPanelDataExplorerIsNotSet = () =>
181     snackbarActions.OPEN_SNACKBAR({
182         message: 'Project panel is not ready.',
183         kind: SnackbarKind.ERROR
184     });