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 { 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 { serializeResourceTypeFilters, buildProcessStatusFilters } 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 { dataExplorerActions } 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>(dataExplorerActions.SET_IS_NOT_FOUND({ id: this.id, isNotFound: false }));
  56                 if (!background) { api.dispatch(progressIndicatorActions.START_WORKING(this.getId())); }
  57                 const response = await this.services.groupsService.contents(projectUuid, getParams(dataExplorer, !!isProjectTrashed));
  58                 const resourceUuids = [...response.items.map(item => item.uuid), projectUuid];
  59                 api.dispatch<any>(updateFavorites(resourceUuids));
  60                 api.dispatch<any>(updatePublicFavorites(resourceUuids));
  61                 api.dispatch(updateResources(response.items));
  62                 api.dispatch(setItems(response));
  63             } catch (e) {
  64                 api.dispatch(
  65                     projectPanelDataActions.SET_ITEMS({
  66                         items: [],
  67                         itemsAvailable: 0,
  68                         page: 0,
  69                         rowsPerPage: dataExplorer.rowsPerPage,
  70                     })
  71                 );
  72                 if (e.status === 404) {
  73                     api.dispatch<any>(dataExplorerActions.SET_IS_NOT_FOUND({ id: this.id, isNotFound: true}));
  74                 }
  75                 else {
  76                     api.dispatch(couldNotFetchProjectContents());
  77                 }
  78             } finally {
  79                 if (!background) {
  80                     api.dispatch(progressIndicatorActions.PERSIST_STOP_WORKING(this.getId()));
  81                     api.dispatch<any>(removeDisabledButton(ContextMenuActionNames.MOVE_TO_TRASH))
  82                 }
  83             }
  84         }
  85     }
  86 }
  87
  88 export const setItems = (listResults: ListResults<GroupContentsResource>) =>
  89     projectPanelDataActions.SET_ITEMS({
  90         ...listResultsToDataExplorerItemsMeta(listResults),
  91         items: listResults.items.map(resource => resource.uuid),
  92     });
  93
  94 export const getParams = (dataExplorer: DataExplorer, isProjectTrashed: boolean) => ({
  95     ...dataExplorerToListParams(dataExplorer),
  96     order: getOrder(dataExplorer),
  97     filters: getFilters(dataExplorer),
  98     includeTrash: isProjectTrashed,
  99     select: selectedFieldsOfGroup.concat(defaultCollectionSelectedFields),
 100 });
 101
 102 export const getFilters = (dataExplorer: DataExplorer) => {
 103     const columns = dataExplorer.columns as DataColumns<string, ProjectResource>;
 104     const typeFilters = serializeResourceTypeFilters(getDataExplorerColumnFilters(columns, ProjectPanelDataColumnNames.TYPE));
 105     const statusColumnFilters = getDataExplorerColumnFilters(columns, "Status");
 106     const activeStatusFilter = Object.keys(statusColumnFilters).find(filterName => statusColumnFilters[filterName].selected);
 107
 108     // TODO: Extract group contents name filter
 109     const nameFilters = new FilterBuilder()
 110         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.COLLECTION)
 111         .addILike("name", dataExplorer.searchValue, GroupContentsResourcePrefix.PROJECT)
 112         .getFilters();
 113
 114     // Filter by container status
 115     const statusFilters = buildProcessStatusFilters(new FilterBuilder(), activeStatusFilter || "", GroupContentsResourcePrefix.PROCESS).getFilters();
 116
 117     return joinFilters(statusFilters, typeFilters, nameFilters);
 118 };
 119
 120 const getOrder = (dataExplorer: DataExplorer) => {
 121     const sortColumn = getSortColumn<ProjectResource>(dataExplorer);
 122     const order = new OrderBuilder<ProjectResource>();
 123     if (sortColumn && sortColumn.sort) {
 124         const sortDirection = sortColumn.sort.direction === SortDirection.ASC ? OrderDirection.ASC : OrderDirection.DESC;
 125
 126         // Use createdAt as a secondary sort column so we break ties consistently.
 127         return order
 128             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.COLLECTION)
 129             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.PROJECT)
 130             .addOrder(sortDirection, sortColumn.sort.field, GroupContentsResourcePrefix.WORKFLOW)
 131             .addOrder(OrderDirection.DESC, "createdAt")
 132             .getOrder();
 133     } else {
 134         return order.getOrder();
 135     }
 136 };
 137
 138 const projectPanelCurrentUuidIsNotSet = () =>
 139     snackbarActions.OPEN_SNACKBAR({
 140         message: "Project panel is not opened.",
 141         kind: SnackbarKind.ERROR,
 142     });
 143
 144 const couldNotFetchProjectContents = () =>
 145     snackbarActions.OPEN_SNACKBAR({
 146         message: "Could not fetch project contents.",
 147         kind: SnackbarKind.ERROR,
 148     });
 149
 150 const projectPanelDataExplorerIsNotSet = () =>
 151     snackbarActions.OPEN_SNACKBAR({
 152         message: "Project panel is not ready.",
 153         kind: SnackbarKind.ERROR,
 154     });