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 export const getInitialResourceTypeFilters = pipe(
  61     (): DataTableFilters => createTree<DataTableFilterItem>(),
  62     initFilter(ObjectTypeFilter.PROJECT),
  63     initFilter(ObjectTypeFilter.PROCESS),
  64     initFilter(ProcessTypeFilter.MAIN_PROCESS, ObjectTypeFilter.PROCESS),
  65     initFilter(ProcessTypeFilter.CHILD_PROCESS, ObjectTypeFilter.PROCESS),
  66     initFilter(ObjectTypeFilter.COLLECTION),
  67     initFilter(CollectionTypeFilter.GENERAL_COLLECTION, ObjectTypeFilter.COLLECTION),
  68     initFilter(CollectionTypeFilter.OUTPUT_COLLECTION, ObjectTypeFilter.COLLECTION),
  69     initFilter(CollectionTypeFilter.LOG_COLLECTION, ObjectTypeFilter.COLLECTION),
  70 );
  71
  72 export const getInitialProcessStatusFilters = pipe(
  73     (): DataTableFilters => createTree<DataTableFilterItem>(),
  74     initFilter(ProcessStatusFilter.ALL, '', true),
  75     initFilter(ProcessStatusFilter.RUNNING, '', false),
  76     initFilter(ProcessStatusFilter.FAILED, '', false),
  77     initFilter(ProcessStatusFilter.COMPLETED, '', false),
  78     initFilter(ProcessStatusFilter.CANCELLED, '', false),
  79     initFilter(ProcessStatusFilter.QUEUED, '', false),
  80     initFilter(ProcessStatusFilter.LOCKED, '', false),
  81 );
  82
  83 export const getTrashPanelTypeFilters = pipe(
  84     (): DataTableFilters => createTree<DataTableFilterItem>(),
  85     initFilter(ObjectTypeFilter.PROJECT),
  86     initFilter(ObjectTypeFilter.COLLECTION),
  87     initFilter(CollectionTypeFilter.GENERAL_COLLECTION, ObjectTypeFilter.COLLECTION),
  88     initFilter(CollectionTypeFilter.OUTPUT_COLLECTION, ObjectTypeFilter.COLLECTION),
  89     initFilter(CollectionTypeFilter.LOG_COLLECTION, ObjectTypeFilter.COLLECTION),
  90 );
  91
  92 const createFiltersBuilder = (filters: DataTableFilters) =>
  93     ({ fb: new FilterBuilder(), selectedFilters: getSelectedNodes(filters) });
  94
  95 const getMatchingFilters = (values: string[], filters: TreeNode<DataTableFilterItem>[]) =>
  96     filters
  97         .map(f => f.id)
  98         .filter(includes(__, values));
  99
 100 const objectTypeToResourceKind = (type: ObjectTypeFilter) => {
 101     switch (type) {
 102         case ObjectTypeFilter.PROJECT:
 103             return ResourceKind.PROJECT;
 104         case ObjectTypeFilter.PROCESS:
 105             return ResourceKind.PROCESS;
 106         case ObjectTypeFilter.COLLECTION:
 107             return ResourceKind.COLLECTION;
 108     }
 109 };
 110
 111 const serializeObjectTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => {
 112     const collectionFilters = getMatchingFilters(values(CollectionTypeFilter), selectedFilters);
 113     const processFilters = getMatchingFilters(values(ProcessTypeFilter), selectedFilters);
 114     const typeFilters = pipe(
 115         () => new Set(getMatchingFilters(values(ObjectTypeFilter), selectedFilters)),
 116         set => collectionFilters.length > 0
 117             ? set.add(ObjectTypeFilter.COLLECTION)
 118             : set,
 119         set => processFilters.length > 0
 120             ? set.add(ObjectTypeFilter.PROCESS)
 121             : set,
 122         set => Array.from(set)
 123     )();
 124
 125     return {
 126         fb: typeFilters.length > 0
 127             ? fb.addIsA('uuid', typeFilters.map(objectTypeToResourceKind))
 128             : fb,
 129         selectedFilters,
 130     };
 131 };
 132
 133 const collectionTypeToPropertyValue = (type: CollectionTypeFilter) => {
 134     switch (type) {
 135         case CollectionTypeFilter.GENERAL_COLLECTION:
 136             return CollectionType.GENERAL;
 137         case CollectionTypeFilter.OUTPUT_COLLECTION:
 138             return CollectionType.OUTPUT;
 139         case CollectionTypeFilter.LOG_COLLECTION:
 140             return CollectionType.LOG;
 141     }
 142 };
 143
 144 const serializeCollectionTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 145     () => getMatchingFilters(values(CollectionTypeFilter), selectedFilters),
 146     filters => filters.map(collectionTypeToPropertyValue),
 147     mappedFilters => ({
 148         fb: buildCollectionTypeFilters({ fb, filters: mappedFilters }),
 149         selectedFilters
 150     })
 151 )();
 152
 153 const COLLECTION_TYPES = values(CollectionType);
 154
 155 const NON_GENERAL_COLLECTION_TYPES = difference(COLLECTION_TYPES, [CollectionType.GENERAL]);
 156
 157 const COLLECTION_PROPERTIES_PREFIX = `${GroupContentsResourcePrefix.COLLECTION}.properties`;
 158
 159 const buildCollectionTypeFilters = ({ fb, filters }: { fb: FilterBuilder, filters: CollectionType[] }) => {
 160     switch (true) {
 161         case filters.length === 0 || filters.length === COLLECTION_TYPES.length:
 162             return fb;
 163         case includes(CollectionType.GENERAL, filters):
 164             return fb.addNotIn('type', difference(NON_GENERAL_COLLECTION_TYPES, filters), COLLECTION_PROPERTIES_PREFIX);
 165         default:
 166             return fb.addIn('type', filters, COLLECTION_PROPERTIES_PREFIX);
 167     }
 168 };
 169
 170 const serializeProcessTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 171     () => getMatchingFilters(values(ProcessTypeFilter), selectedFilters),
 172     filters => filters,
 173     mappedFilters => ({
 174         fb: buildProcessTypeFilters({ fb, filters: mappedFilters }),
 175         selectedFilters
 176     })
 177 )();
 178
 179 const PROCESS_TYPES = values(ProcessTypeFilter);
 180 const PROCESS_PREFIX = GroupContentsResourcePrefix.PROCESS;
 181
 182 const buildProcessTypeFilters = ({ fb, filters }: { fb: FilterBuilder, filters: string[] }) => {
 183     switch (true) {
 184         case filters.length === 0 || filters.length === PROCESS_TYPES.length:
 185             return fb;
 186         case includes(ProcessTypeFilter.MAIN_PROCESS, filters):
 187             return fb.addEqual('requesting_container_uuid', null, PROCESS_PREFIX);
 188         case includes(ProcessTypeFilter.CHILD_PROCESS, filters):
 189             return fb.addDistinct('requesting_container_uuid', null, PROCESS_PREFIX);
 190         default:
 191             return fb;
 192     }
 193 };
 194
 195 export const serializeResourceTypeFilters = pipe(
 196     createFiltersBuilder,
 197     serializeObjectTypeFilters,
 198     serializeCollectionTypeFilters,
 199     serializeProcessTypeFilters,
 200     ({ fb }) => fb.getFilters(),
 201 );
 202
 203 export const serializeSimpleObjectTypeFilters = (filters: Tree<DataTableFilterItem>) => {
 204     return getSelectedNodes(filters)
 205         .map(f => f.id)
 206         .map(objectTypeToResourceKind);
 207 };