src/store/resource-type-filters/resource-type-filters.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { difference, pipe, values, includes, __ } from 'lodash/fp';
   6 import { createTree, setNode, TreeNodeStatus, TreeNode, Tree } from '~/models/tree';
   7 import { DataTableFilterItem, DataTableFilters } from '~/components/data-table-filters/data-table-filters-tree';
   8 import { ResourceKind } from '~/models/resource';
   9 import { FilterBuilder } from '~/services/api/filter-builder';
  10 import { getSelectedNodes } from '~/models/tree';
  11 import { CollectionType } from '~/models/collection';
  12 import { GroupContentsResourcePrefix } from '~/services/groups-service/groups-service';
  13
  14 export enum ProcessStatusFilter {
  15     ALL = 'All',
  16     RUNNING = 'Running',
  17     FAILED = 'Failed',
  18     COMPLETED = 'Completed',
  19     CANCELLED = 'Cancelled',
  20     LOCKED = 'Locked',
  21     QUEUED = 'Queued'
  22 }
  23
  24 export enum ObjectTypeFilter {
  25     PROJECT = 'Project',
  26     PROCESS = 'Process',
  27     COLLECTION = 'Data Collection',
  28 }
  29
  30 export enum CollectionTypeFilter {
  31     GENERAL_COLLECTION = 'General',
  32     OUTPUT_COLLECTION = 'Output',
  33     LOG_COLLECTION = 'Log',
  34 }
  35
  36 export enum ProcessTypeFilter {
  37     MAIN_PROCESS = 'Main',
  38     CHILD_PROCESS = 'Child',
  39 }
  40
  41 const initFilter = (name: string, parent = '', isSelected?: boolean) =>
  42     setNode<DataTableFilterItem>({
  43         id: name,
  44         value: { name },
  45         parent,
  46         children: [],
  47         active: false,
  48         selected: isSelected !== undefined ? isSelected : true,
  49         expanded: false,
  50         status: TreeNodeStatus.LOADED,
  51     });
  52
  53 export const getSimpleObjectTypeFilters = pipe(
  54     (): DataTableFilters => createTree<DataTableFilterItem>(),
  55     initFilter(ObjectTypeFilter.PROJECT),
  56     initFilter(ObjectTypeFilter.PROCESS),
  57     initFilter(ObjectTypeFilter.COLLECTION),
  58 );
  59
  60 // Using pipe() with more tha 7 arguments makes the return type be 'any',
  61 // causing compile issues.
  62 export const getInitialResourceTypeFilters = pipe(
  63     (): DataTableFilters => createTree<DataTableFilterItem>(),
  64     initFilter(ObjectTypeFilter.PROJECT),
  65     pipe(
  66         initFilter(ObjectTypeFilter.PROCESS),
  67         initFilter(ProcessTypeFilter.MAIN_PROCESS, ObjectTypeFilter.PROCESS),
  68         initFilter(ProcessTypeFilter.CHILD_PROCESS, ObjectTypeFilter.PROCESS)
  69     ),
  70     pipe(
  71         initFilter(ObjectTypeFilter.COLLECTION),
  72         initFilter(CollectionTypeFilter.GENERAL_COLLECTION, ObjectTypeFilter.COLLECTION),
  73         initFilter(CollectionTypeFilter.OUTPUT_COLLECTION, ObjectTypeFilter.COLLECTION),
  74         initFilter(CollectionTypeFilter.LOG_COLLECTION, ObjectTypeFilter.COLLECTION),
  75     ),
  76 );
  77
  78 export const getInitialProcessStatusFilters = pipe(
  79     (): DataTableFilters => createTree<DataTableFilterItem>(),
  80     pipe(
  81         initFilter(ProcessStatusFilter.ALL, '', true),
  82         initFilter(ProcessStatusFilter.RUNNING, '', false),
  83         initFilter(ProcessStatusFilter.FAILED, '', false),
  84         initFilter(ProcessStatusFilter.COMPLETED, '', false),
  85         initFilter(ProcessStatusFilter.CANCELLED, '', false),
  86         initFilter(ProcessStatusFilter.QUEUED, '', false),
  87         initFilter(ProcessStatusFilter.LOCKED, '', false),
  88     ),
  89 );
  90
  91 export const getTrashPanelTypeFilters = pipe(
  92     (): DataTableFilters => createTree<DataTableFilterItem>(),
  93     initFilter(ObjectTypeFilter.PROJECT),
  94     initFilter(ObjectTypeFilter.COLLECTION),
  95     initFilter(CollectionTypeFilter.GENERAL_COLLECTION, ObjectTypeFilter.COLLECTION),
  96     initFilter(CollectionTypeFilter.OUTPUT_COLLECTION, ObjectTypeFilter.COLLECTION),
  97     initFilter(CollectionTypeFilter.LOG_COLLECTION, ObjectTypeFilter.COLLECTION),
  98 );
  99
 100 const createFiltersBuilder = (filters: DataTableFilters) =>
 101     ({ fb: new FilterBuilder(), selectedFilters: getSelectedNodes(filters) });
 102
 103 const getMatchingFilters = (values: string[], filters: TreeNode<DataTableFilterItem>[]) =>
 104     filters
 105         .map(f => f.id)
 106         .filter(includes(__, values));
 107
 108 const objectTypeToResourceKind = (type: ObjectTypeFilter) => {
 109     switch (type) {
 110         case ObjectTypeFilter.PROJECT:
 111             return ResourceKind.PROJECT;
 112         case ObjectTypeFilter.PROCESS:
 113             return ResourceKind.PROCESS;
 114         case ObjectTypeFilter.COLLECTION:
 115             return ResourceKind.COLLECTION;
 116     }
 117 };
 118
 119 const serializeObjectTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => {
 120     const collectionFilters = getMatchingFilters(values(CollectionTypeFilter), selectedFilters);
 121     const processFilters = getMatchingFilters(values(ProcessTypeFilter), selectedFilters);
 122     const typeFilters = pipe(
 123         () => new Set(getMatchingFilters(values(ObjectTypeFilter), selectedFilters)),
 124         set => collectionFilters.length > 0
 125             ? set.add(ObjectTypeFilter.COLLECTION)
 126             : set,
 127         set => processFilters.length > 0
 128             ? set.add(ObjectTypeFilter.PROCESS)
 129             : set,
 130         set => Array.from(set)
 131     )();
 132
 133     return {
 134         fb: typeFilters.length > 0
 135             ? fb.addIsA('uuid', typeFilters.map(objectTypeToResourceKind))
 136             : fb,
 137         selectedFilters,
 138     };
 139 };
 140
 141 const collectionTypeToPropertyValue = (type: CollectionTypeFilter) => {
 142     switch (type) {
 143         case CollectionTypeFilter.GENERAL_COLLECTION:
 144             return CollectionType.GENERAL;
 145         case CollectionTypeFilter.OUTPUT_COLLECTION:
 146             return CollectionType.OUTPUT;
 147         case CollectionTypeFilter.LOG_COLLECTION:
 148             return CollectionType.LOG;
 149     }
 150 };
 151
 152 const serializeCollectionTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 153     () => getMatchingFilters(values(CollectionTypeFilter), selectedFilters),
 154     filters => filters.map(collectionTypeToPropertyValue),
 155     mappedFilters => ({
 156         fb: buildCollectionTypeFilters({ fb, filters: mappedFilters }),
 157         selectedFilters
 158     })
 159 )();
 160
 161 const COLLECTION_TYPES = values(CollectionType);
 162
 163 const NON_GENERAL_COLLECTION_TYPES = difference(COLLECTION_TYPES, [CollectionType.GENERAL]);
 164
 165 const COLLECTION_PROPERTIES_PREFIX = `${GroupContentsResourcePrefix.COLLECTION}.properties`;
 166
 167 const buildCollectionTypeFilters = ({ fb, filters }: { fb: FilterBuilder, filters: CollectionType[] }) => {
 168     switch (true) {
 169         case filters.length === 0 || filters.length === COLLECTION_TYPES.length:
 170             return fb;
 171         case includes(CollectionType.GENERAL, filters):
 172             return fb.addNotIn('type', difference(NON_GENERAL_COLLECTION_TYPES, filters), COLLECTION_PROPERTIES_PREFIX);
 173         default:
 174             return fb.addIn('type', filters, COLLECTION_PROPERTIES_PREFIX);
 175     }
 176 };
 177
 178 const serializeProcessTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 179     () => getMatchingFilters(values(ProcessTypeFilter), selectedFilters),
 180     filters => filters,
 181     mappedFilters => ({
 182         fb: buildProcessTypeFilters({ fb, filters: mappedFilters }),
 183         selectedFilters
 184     })
 185 )();
 186
 187 const PROCESS_TYPES = values(ProcessTypeFilter);
 188 const PROCESS_PREFIX = GroupContentsResourcePrefix.PROCESS;
 189
 190 const buildProcessTypeFilters = ({ fb, filters }: { fb: FilterBuilder, filters: string[] }) => {
 191     switch (true) {
 192         case filters.length === 0 || filters.length === PROCESS_TYPES.length:
 193             return fb;
 194         case includes(ProcessTypeFilter.MAIN_PROCESS, filters):
 195             return fb.addEqual('requesting_container_uuid', null, PROCESS_PREFIX);
 196         case includes(ProcessTypeFilter.CHILD_PROCESS, filters):
 197             return fb.addDistinct('requesting_container_uuid', null, PROCESS_PREFIX);
 198         default:
 199             return fb;
 200     }
 201 };
 202
 203 export const serializeResourceTypeFilters = pipe(
 204     createFiltersBuilder,
 205     serializeObjectTypeFilters,
 206     serializeCollectionTypeFilters,
 207     serializeProcessTypeFilters,
 208     ({ fb }) => fb.getFilters(),
 209 );
 210
 211 export const serializeSimpleObjectTypeFilters = (filters: Tree<DataTableFilterItem>) => {
 212     return getSelectedNodes(filters)
 213         .map(f => f.id)
 214         .map(objectTypeToResourceKind);
 215 };