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