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 import { ContainerState } from 'models/container';
  14 import { ContainerRequestState } from 'models/container-request';
  15
  16 export enum ProcessStatusFilter {
  17     ALL = 'All',
  18     RUNNING = 'Running',
  19     FAILED = 'Failed',
  20     COMPLETED = 'Completed',
  21     CANCELLED = 'Cancelled',
  22     ONHOLD = 'On hold',
  23     QUEUED = 'Queued'
  24 }
  25
  26 export enum ObjectTypeFilter {
  27     PROJECT = 'Project',
  28     PROCESS = 'Process',
  29     COLLECTION = 'Data collection',
  30 }
  31
  32 export enum GroupTypeFilter {
  33     PROJECT = 'Project (normal)',
  34     FILTER_GROUP = 'Filter group',
  35 }
  36
  37 export enum CollectionTypeFilter {
  38     GENERAL_COLLECTION = 'General',
  39     OUTPUT_COLLECTION = 'Output',
  40     LOG_COLLECTION = 'Log',
  41 }
  42
  43 export enum ProcessTypeFilter {
  44     MAIN_PROCESS = 'Main',
  45     CHILD_PROCESS = 'Child',
  46 }
  47
  48 const initFilter = (name: string, parent = '', isSelected?: boolean) =>
  49     setNode<DataTableFilterItem>({
  50         id: name,
  51         value: { name },
  52         parent,
  53         children: [],
  54         active: false,
  55         selected: isSelected !== undefined ? isSelected : true,
  56         expanded: false,
  57         status: TreeNodeStatus.LOADED,
  58     });
  59
  60 export const getSimpleObjectTypeFilters = pipe(
  61     (): DataTableFilters => createTree<DataTableFilterItem>(),
  62     initFilter(ObjectTypeFilter.PROJECT),
  63     initFilter(ObjectTypeFilter.PROCESS),
  64     initFilter(ObjectTypeFilter.COLLECTION),
  65 );
  66
  67 // Using pipe() with more than 7 arguments makes the return type be 'any',
  68 // causing compile issues.
  69 export const getInitialResourceTypeFilters = pipe(
  70     (): DataTableFilters => createTree<DataTableFilterItem>(),
  71     pipe(
  72         initFilter(ObjectTypeFilter.PROJECT),
  73         initFilter(GroupTypeFilter.PROJECT, ObjectTypeFilter.PROJECT),
  74         initFilter(GroupTypeFilter.FILTER_GROUP, ObjectTypeFilter.PROJECT),
  75     ),
  76     pipe(
  77         initFilter(ObjectTypeFilter.PROCESS),
  78         initFilter(ProcessTypeFilter.MAIN_PROCESS, ObjectTypeFilter.PROCESS),
  79         initFilter(ProcessTypeFilter.CHILD_PROCESS, ObjectTypeFilter.PROCESS)
  80     ),
  81     pipe(
  82         initFilter(ObjectTypeFilter.COLLECTION),
  83         initFilter(CollectionTypeFilter.GENERAL_COLLECTION, ObjectTypeFilter.COLLECTION),
  84         initFilter(CollectionTypeFilter.OUTPUT_COLLECTION, ObjectTypeFilter.COLLECTION),
  85         initFilter(CollectionTypeFilter.LOG_COLLECTION, ObjectTypeFilter.COLLECTION),
  86     ),
  87 );
  88
  89 export const getInitialProcessTypeFilters = pipe(
  90     (): DataTableFilters => createTree<DataTableFilterItem>(),
  91     initFilter(ProcessTypeFilter.MAIN_PROCESS),
  92     initFilter(ProcessTypeFilter.CHILD_PROCESS, '', false)
  93 );
  94
  95 export const getInitialProcessStatusFilters = pipe(
  96     (): DataTableFilters => createTree<DataTableFilterItem>(),
  97     pipe(
  98         initFilter(ProcessStatusFilter.ALL, '', true),
  99         initFilter(ProcessStatusFilter.ONHOLD, '', false),
 100         initFilter(ProcessStatusFilter.QUEUED, '', false),
 101         initFilter(ProcessStatusFilter.RUNNING, '', false),
 102         initFilter(ProcessStatusFilter.COMPLETED, '', false),
 103         initFilter(ProcessStatusFilter.CANCELLED, '', false),
 104         initFilter(ProcessStatusFilter.FAILED, '', false),
 105     ),
 106 );
 107
 108 export const getTrashPanelTypeFilters = pipe(
 109     (): DataTableFilters => createTree<DataTableFilterItem>(),
 110     initFilter(ObjectTypeFilter.PROJECT),
 111     initFilter(ObjectTypeFilter.COLLECTION),
 112     initFilter(CollectionTypeFilter.GENERAL_COLLECTION, ObjectTypeFilter.COLLECTION),
 113     initFilter(CollectionTypeFilter.OUTPUT_COLLECTION, ObjectTypeFilter.COLLECTION),
 114     initFilter(CollectionTypeFilter.LOG_COLLECTION, ObjectTypeFilter.COLLECTION),
 115 );
 116
 117 const createFiltersBuilder = (filters: DataTableFilters) =>
 118     ({ fb: new FilterBuilder(), selectedFilters: getSelectedNodes(filters) });
 119
 120 const getMatchingFilters = (values: string[], filters: TreeNode<DataTableFilterItem>[]) =>
 121     filters
 122         .map(f => f.id)
 123         .filter(includes(__, values));
 124
 125 const objectTypeToResourceKind = (type: ObjectTypeFilter) => {
 126     switch (type) {
 127         case ObjectTypeFilter.PROJECT:
 128             return ResourceKind.PROJECT;
 129         case ObjectTypeFilter.PROCESS:
 130             return ResourceKind.PROCESS;
 131         case ObjectTypeFilter.COLLECTION:
 132             return ResourceKind.COLLECTION;
 133     }
 134 };
 135
 136 const serializeObjectTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => {
 137     const groupFilters = getMatchingFilters(values(GroupTypeFilter), selectedFilters);
 138     const collectionFilters = getMatchingFilters(values(CollectionTypeFilter), selectedFilters);
 139     const processFilters = getMatchingFilters(values(ProcessTypeFilter), selectedFilters);
 140     const typeFilters = pipe(
 141         () => new Set(getMatchingFilters(values(ObjectTypeFilter), selectedFilters)),
 142         set => groupFilters.length > 0
 143             ? set.add(ObjectTypeFilter.PROJECT)
 144             : set,
 145         set => collectionFilters.length > 0
 146             ? set.add(ObjectTypeFilter.COLLECTION)
 147             : set,
 148         set => processFilters.length > 0
 149             ? set.add(ObjectTypeFilter.PROCESS)
 150             : set,
 151         set => Array.from(set)
 152     )();
 153
 154     return {
 155         fb: typeFilters.length > 0
 156             ? fb.addIsA('uuid', typeFilters.map(objectTypeToResourceKind))
 157             : fb,
 158         selectedFilters,
 159     };
 160 };
 161
 162 const collectionTypeToPropertyValue = (type: CollectionTypeFilter) => {
 163     switch (type) {
 164         case CollectionTypeFilter.GENERAL_COLLECTION:
 165             return CollectionType.GENERAL;
 166         case CollectionTypeFilter.OUTPUT_COLLECTION:
 167             return CollectionType.OUTPUT;
 168         case CollectionTypeFilter.LOG_COLLECTION:
 169             return CollectionType.LOG;
 170     }
 171 };
 172
 173 const serializeCollectionTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 174     () => getMatchingFilters(values(CollectionTypeFilter), selectedFilters),
 175     filters => filters.map(collectionTypeToPropertyValue),
 176     mappedFilters => ({
 177         fb: buildCollectionTypeFilters({ fb, filters: mappedFilters }),
 178         selectedFilters
 179     })
 180 )();
 181
 182 const COLLECTION_TYPES = values(CollectionType);
 183
 184 const NON_GENERAL_COLLECTION_TYPES = difference(COLLECTION_TYPES, [CollectionType.GENERAL]);
 185
 186 const COLLECTION_PROPERTIES_PREFIX = `${GroupContentsResourcePrefix.COLLECTION}.properties`;
 187
 188 const buildCollectionTypeFilters = ({ fb, filters }: { fb: FilterBuilder, filters: CollectionType[] }) => {
 189     switch (true) {
 190         case filters.length === 0 || filters.length === COLLECTION_TYPES.length:
 191             return fb;
 192         case includes(CollectionType.GENERAL, filters):
 193             return fb.addNotIn('type', difference(NON_GENERAL_COLLECTION_TYPES, filters), COLLECTION_PROPERTIES_PREFIX);
 194         default:
 195             return fb.addIn('type', filters, COLLECTION_PROPERTIES_PREFIX);
 196     }
 197 };
 198
 199 const serializeGroupTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 200     () => getMatchingFilters(values(GroupTypeFilter), selectedFilters),
 201     filters => filters,
 202     mappedFilters => ({
 203         fb: buildGroupTypeFilters({ fb, filters: mappedFilters, use_prefix: true }),
 204         selectedFilters
 205     })
 206 )();
 207
 208 const GROUP_TYPES = values(GroupTypeFilter);
 209
 210 const buildGroupTypeFilters = ({ fb, filters, use_prefix }: { fb: FilterBuilder, filters: string[], use_prefix: boolean }) => {
 211     switch (true) {
 212         case filters.length === 0 || filters.length === GROUP_TYPES.length:
 213             return fb;
 214         case includes(GroupTypeFilter.PROJECT, filters):
 215             return fb.addEqual('groups.group_class', 'project');
 216         case includes(GroupTypeFilter.FILTER_GROUP, filters):
 217             return fb.addEqual('groups.group_class', 'filter');
 218         default:
 219             return fb;
 220     }
 221 };
 222
 223 const serializeProcessTypeFilters = ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 224     () => getMatchingFilters(values(ProcessTypeFilter), selectedFilters),
 225     filters => filters,
 226     mappedFilters => ({
 227         fb: buildProcessTypeFilters({ fb, filters: mappedFilters, use_prefix: true }),
 228         selectedFilters
 229     })
 230 )();
 231
 232 const PROCESS_TYPES = values(ProcessTypeFilter);
 233 const PROCESS_PREFIX = GroupContentsResourcePrefix.PROCESS;
 234
 235 const buildProcessTypeFilters = ({ fb, filters, use_prefix }: { fb: FilterBuilder, filters: string[], use_prefix: boolean }) => {
 236     switch (true) {
 237         case filters.length === 0 || filters.length === PROCESS_TYPES.length:
 238             return fb;
 239         case includes(ProcessTypeFilter.MAIN_PROCESS, filters):
 240             return fb.addEqual('requesting_container_uuid', null, use_prefix ? PROCESS_PREFIX : '');
 241         case includes(ProcessTypeFilter.CHILD_PROCESS, filters):
 242             return fb.addDistinct('requesting_container_uuid', null, use_prefix ? PROCESS_PREFIX : '');
 243         default:
 244             return fb;
 245     }
 246 };
 247
 248 export const serializeResourceTypeFilters = pipe(
 249     createFiltersBuilder,
 250     serializeObjectTypeFilters,
 251     serializeGroupTypeFilters,
 252     serializeCollectionTypeFilters,
 253     serializeProcessTypeFilters,
 254     ({ fb }) => fb.getFilters(),
 255 );
 256
 257 export const serializeOnlyProcessTypeFilters = pipe(
 258     createFiltersBuilder,
 259     ({ fb, selectedFilters }: ReturnType<typeof createFiltersBuilder>) => pipe(
 260         () => getMatchingFilters(values(ProcessTypeFilter), selectedFilters),
 261         filters => filters,
 262         mappedFilters => ({
 263             fb: buildProcessTypeFilters({ fb, filters: mappedFilters, use_prefix: false }),
 264             selectedFilters
 265         })
 266     )(),
 267     ({ fb }) => fb.getFilters(),
 268 );
 269
 270 export const serializeSimpleObjectTypeFilters = (filters: Tree<DataTableFilterItem>) => {
 271     return getSelectedNodes(filters)
 272         .map(f => f.id)
 273         .map(objectTypeToResourceKind);
 274 };
 275
 276 export const buildProcessStatusFilters = ( fb: FilterBuilder, activeStatusFilter: string, resourcePrefix?: string ): FilterBuilder => {
 277     switch (activeStatusFilter) {
 278         case ProcessStatusFilter.ONHOLD: {
 279             fb.addDistinct('state', ContainerRequestState.FINAL, resourcePrefix);
 280             fb.addEqual('priority', '0', resourcePrefix);
 281             fb.addIn('container.state', [ContainerState.QUEUED, ContainerState.LOCKED], resourcePrefix);
 282             break;
 283         }
 284         case ProcessStatusFilter.COMPLETED: {
 285             fb.addEqual('container.state', ContainerState.COMPLETE, resourcePrefix);
 286             fb.addEqual('container.exit_code', '0', resourcePrefix);
 287             break;
 288         }
 289         case ProcessStatusFilter.FAILED: {
 290             fb.addEqual('container.state', ContainerState.COMPLETE, resourcePrefix);
 291             fb.addDistinct('container.exit_code', '0', resourcePrefix);
 292             break;
 293         }
 294         case ProcessStatusFilter.QUEUED: {
 295             fb.addEqual('container.state', ContainerState.QUEUED, resourcePrefix);
 296             fb.addDistinct('priority', '0', resourcePrefix);
 297             break;
 298         }
 299         case ProcessStatusFilter.CANCELLED:
 300         case ProcessStatusFilter.RUNNING: {
 301             fb.addEqual('container.state', activeStatusFilter, resourcePrefix);
 302             break;
 303         }
 304     }
 305     return fb;
 306 };