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 than 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 getInitialProcessTypeFilters = pipe(
  79     (): DataTableFilters => createTree<DataTableFilterItem>(),
  80     initFilter(ProcessTypeFilter.MAIN_PROCESS),
  81     initFilter(ProcessTypeFilter.CHILD_PROCESS, '', false)
  82 );
  83
  84 export const getInitialProcessStatusFilters = pipe(
  85     (): DataTableFilters => createTree<DataTableFilterItem>(),
  86     pipe(
  87         initFilter(ProcessStatusFilter.ALL, '', true),
  88         initFilter(ProcessStatusFilter.RUNNING, '', false),
  89         initFilter(ProcessStatusFilter.FAILED, '', false),
  90         initFilter(ProcessStatusFilter.COMPLETED, '', false),
  91         initFilter(ProcessStatusFilter.CANCELLED, '', false),
  92         initFilter(ProcessStatusFilter.QUEUED, '', false),
  93         initFilter(ProcessStatusFilter.LOCKED, '', false),
  94     ),
  95 );
  96
  97 export const getTrashPanelTypeFilters = pipe(
  98     (): DataTableFilters => createTree<DataTableFilterItem>(),
  99     initFilter(ObjectTypeFilter.PROJECT),
 100     initFilter(ObjectTypeFilter.COLLECTION),
 101     initFilter(CollectionTypeFilter.GENERAL_COLLECTION, ObjectTypeFilter.COLLECTION),
 102     initFilter(CollectionTypeFilter.OUTPUT_COLLECTION, ObjectTypeFilter.COLLECTION),
 103     initFilter(CollectionTypeFilter.LOG_COLLECTION, ObjectTypeFilter.COLLECTION),
 104 );
 105
 106 const createFiltersBuilder = (filters: DataTableFilters) =>
 107     ({ fb: new FilterBuilder(), selectedFilters: getSelectedNodes(filters) });
 108
 109 const getMatchingFilters = (values: string[], filters: TreeNode<DataTableFilterItem>[]) =>
 110     filters
 111         .map(f => f.id)
 112         .filter(includes(__, values));
 113
 114 const objectTypeToResourceKind = (type: ObjectTypeFilter) => {
 115     switch (type) {
 116         case ObjectTypeFilter.PROJECT:
 117             return ResourceKind.PROJECT;
 118         case ObjectTypeFilter.PROCESS:
 119             return ResourceKind.PROCESS;
 120         case ObjectTypeFilter.COLLECTION:
 121             return ResourceKind.COLLECTION;
 122     }
 123 };
 124
 125 const serializeObjectTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => {
 126     const collectionFilters = getMatchingFilters(values(CollectionTypeFilter), selectedFilters);
 127     const processFilters = getMatchingFilters(values(ProcessTypeFilter), selectedFilters);
 128     const typeFilters = pipe(
 129         () => new Set(getMatchingFilters(values(ObjectTypeFilter), selectedFilters)),
 130         set => collectionFilters.length > 0
 131             ? set.add(ObjectTypeFilter.COLLECTION)
 132             : set,
 133         set => processFilters.length > 0
 134             ? set.add(ObjectTypeFilter.PROCESS)
 135             : set,
 136         set => Array.from(set)
 137     )();
 138
 139     return {
 140         fb: typeFilters.length > 0
 141             ? fb.addIsA('uuid', typeFilters.map(objectTypeToResourceKind))
 142             : fb,
 143         selectedFilters,
 144     };
 145 };
 146
 147 const collectionTypeToPropertyValue = (type: CollectionTypeFilter) => {
 148     switch (type) {
 149         case CollectionTypeFilter.GENERAL_COLLECTION:
 150             return CollectionType.GENERAL;
 151         case CollectionTypeFilter.OUTPUT_COLLECTION:
 152             return CollectionType.OUTPUT;
 153         case CollectionTypeFilter.LOG_COLLECTION:
 154             return CollectionType.LOG;
 155     }
 156 };
 157
 158 const serializeCollectionTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 159     () => getMatchingFilters(values(CollectionTypeFilter), selectedFilters),
 160     filters => filters.map(collectionTypeToPropertyValue),
 161     mappedFilters => ({
 162         fb: buildCollectionTypeFilters({ fb, filters: mappedFilters }),
 163         selectedFilters
 164     })
 165 )();
 166
 167 const COLLECTION_TYPES = values(CollectionType);
 168
 169 const NON_GENERAL_COLLECTION_TYPES = difference(COLLECTION_TYPES, [CollectionType.GENERAL]);
 170
 171 const COLLECTION_PROPERTIES_PREFIX = `${GroupContentsResourcePrefix.COLLECTION}.properties`;
 172
 173 const buildCollectionTypeFilters = ({ fb, filters }: { fb: FilterBuilder, filters: CollectionType[] }) => {
 174     switch (true) {
 175         case filters.length === 0 || filters.length === COLLECTION_TYPES.length:
 176             return fb;
 177         case includes(CollectionType.GENERAL, filters):
 178             return fb.addNotIn('type', difference(NON_GENERAL_COLLECTION_TYPES, filters), COLLECTION_PROPERTIES_PREFIX);
 179         default:
 180             return fb.addIn('type', filters, COLLECTION_PROPERTIES_PREFIX);
 181     }
 182 };
 183
 184 const serializeProcessTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 185     () => getMatchingFilters(values(ProcessTypeFilter), selectedFilters),
 186     filters => filters,
 187     mappedFilters => ({
 188         fb: buildProcessTypeFilters({ fb, filters: mappedFilters, use_prefix: true }),
 189         selectedFilters
 190     })
 191 )();
 192
 193 const PROCESS_TYPES = values(ProcessTypeFilter);
 194 const PROCESS_PREFIX = GroupContentsResourcePrefix.PROCESS;
 195
 196 const buildProcessTypeFilters = ({ fb, filters, use_prefix }: { fb: FilterBuilder, filters: string[], use_prefix: boolean }) => {
 197     switch (true) {
 198         case filters.length === 0 || filters.length === PROCESS_TYPES.length:
 199             return fb;
 200         case includes(ProcessTypeFilter.MAIN_PROCESS, filters):
 201             return fb.addEqual('requesting_container_uuid', null, use_prefix ? PROCESS_PREFIX : '');
 202         case includes(ProcessTypeFilter.CHILD_PROCESS, filters):
 203             return fb.addDistinct('requesting_container_uuid', null, use_prefix ? PROCESS_PREFIX : '');
 204         default:
 205             return fb;
 206     }
 207 };
 208
 209 export const serializeResourceTypeFilters = pipe(
 210     createFiltersBuilder,
 211     serializeObjectTypeFilters,
 212     serializeCollectionTypeFilters,
 213     serializeProcessTypeFilters,
 214     ({ fb }) => fb.getFilters(),
 215 );
 216
 217 export const serializeOnlyProcessTypeFilters = pipe(
 218     createFiltersBuilder,
 219     ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 220         () => getMatchingFilters(values(ProcessTypeFilter), selectedFilters),
 221         filters => filters,
 222         mappedFilters => ({
 223             fb: buildProcessTypeFilters({ fb, filters: mappedFilters, use_prefix: false }),
 224             selectedFilters
 225         })
 226     )(),
 227     ({ fb }) => fb.getFilters(),
 228 );
 229
 230 export const serializeSimpleObjectTypeFilters = (filters: Tree<DataTableFilterItem>) => {
 231     return getSelectedNodes(filters)
 232         .map(f => f.id)
 233         .map(objectTypeToResourceKind);
 234 };
 235
 236 export const buildProcessStatusFilters = ( fb:FilterBuilder, activeStatusFilter:string ): FilterBuilder => {
 237     switch (activeStatusFilter) {
 238         case ProcessStatusFilter.COMPLETED: {
 239             fb.addEqual('container.state', 'Complete');
 240             fb.addEqual('container.exit_code', '0');
 241             break;
 242         }
 243         case ProcessStatusFilter.FAILED: {
 244             fb.addEqual('container.state', 'Complete');
 245             fb.addDistinct('container.exit_code', '0');
 246             break;
 247         }
 248         case ProcessStatusFilter.CANCELLED:
 249         case ProcessStatusFilter.FAILED:
 250         case ProcessStatusFilter.LOCKED:
 251         case ProcessStatusFilter.QUEUED:
 252         case ProcessStatusFilter.RUNNING: {
 253             fb.addEqual('container.state', activeStatusFilter);
 254             break;
 255         }
 256     }
 257     return fb;
 258 };