services/workbench2/src/store/side-panel-tree/side-panel-tree-actions.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { Dispatch } from 'redux';
   6 import { treePickerActions } from "store/tree-picker/tree-picker-actions";
   7 import { RootState } from 'store/store';
   8 import { getUserUuid } from "common/getuser";
   9 import { ServiceRepository } from 'services/services';
  10 import { FilterBuilder } from 'services/api/filter-builder';
  11 import { resourcesActions } from 'store/resources/resources-actions';
  12 import { getTreePicker, TreePicker } from 'store/tree-picker/tree-picker';
  13 import { getNodeAncestors, getNodeAncestorsIds, getNode, TreeNode, initTreeNode, TreeNodeStatus } from 'models/tree';
  14 import { ProjectResource } from 'models/project';
  15 import { OrderBuilder } from 'services/api/order-builder';
  16 import { ResourceKind } from 'models/resource';
  17 import { CategoriesListReducer } from 'common/plugintypes';
  18 import { pluginConfig } from 'plugins';
  19 import { LinkClass, LinkResource } from 'models/link';
  20 import { verifyAndUpdateLinks } from 'common/link-update-name';
  21
  22 export enum SidePanelTreeCategory {
  23     PROJECTS = 'Home Projects',
  24     FAVORITES = 'My Favorites',
  25     PUBLIC_FAVORITES = 'Public Favorites',
  26     SHARED_WITH_ME = 'Shared with me',
  27     ALL_PROCESSES = 'All Processes',
  28     INSTANCE_TYPES = 'Instance Types',
  29     SHELL_ACCESS = 'Shell Access',
  30     GROUPS = 'Groups',
  31     TRASH = 'Trash',
  32 }
  33
  34 export const SIDE_PANEL_TREE = 'sidePanelTree';
  35 const SIDEPANEL_TREE_NODE_LIMIT = 50
  36
  37 export const getSidePanelTree = (treePicker: TreePicker) =>
  38     getTreePicker<ProjectResource | string>(SIDE_PANEL_TREE)(treePicker);
  39
  40 export const getSidePanelTreeBranch = (uuid: string) => (treePicker: TreePicker): Array<TreeNode<ProjectResource | string>> => {
  41     const tree = getSidePanelTree(treePicker);
  42     if (tree) {
  43         const ancestors = getNodeAncestors(uuid)(tree);
  44         const node = getNode(uuid)(tree);
  45         if (node) {
  46             return [...ancestors, node];
  47         }
  48     }
  49     return [];
  50 };
  51
  52 let SIDE_PANEL_CATEGORIES: string[] = [
  53     SidePanelTreeCategory.PROJECTS,
  54     SidePanelTreeCategory.FAVORITES,
  55     SidePanelTreeCategory.PUBLIC_FAVORITES,
  56     SidePanelTreeCategory.SHARED_WITH_ME,
  57     SidePanelTreeCategory.ALL_PROCESSES,
  58     SidePanelTreeCategory.INSTANCE_TYPES,
  59     SidePanelTreeCategory.SHELL_ACCESS,
  60     SidePanelTreeCategory.GROUPS,
  61     SidePanelTreeCategory.TRASH
  62 ];
  63
  64 const reduceCatsFn: (a: string[],
  65     b: CategoriesListReducer) => string[] = (a, b) => b(a);
  66
  67 SIDE_PANEL_CATEGORIES = pluginConfig.sidePanelCategories.reduce(reduceCatsFn, SIDE_PANEL_CATEGORIES);
  68
  69 export const isSidePanelTreeCategory = (id: string) => SIDE_PANEL_CATEGORIES.some(category => category === id);
  70
  71
  72 export const initSidePanelTree = () =>
  73     (dispatch: Dispatch, getState: () => RootState, { authService }: ServiceRepository) => {
  74         const rootProjectUuid = getUserUuid(getState());
  75         if (!rootProjectUuid) { return; }
  76         const nodes = SIDE_PANEL_CATEGORIES.map(id => {
  77             if (id === SidePanelTreeCategory.PROJECTS) {
  78                 return initTreeNode({ id: rootProjectUuid, value: SidePanelTreeCategory.PROJECTS });
  79             } else {
  80                 return initTreeNode({ id, value: id });
  81             }
  82         });
  83         dispatch(treePickerActions.LOAD_TREE_PICKER_NODE_SUCCESS({
  84             id: '',
  85             pickerId: SIDE_PANEL_TREE,
  86             nodes
  87         }));
  88         SIDE_PANEL_CATEGORIES.forEach(category => {
  89                 if (category !== SidePanelTreeCategory.PROJECTS && category !== SidePanelTreeCategory.FAVORITES && category !== SidePanelTreeCategory.PUBLIC_FAVORITES ) {
  90                 dispatch(treePickerActions.LOAD_TREE_PICKER_NODE_SUCCESS({
  91                     id: category,
  92                     pickerId: SIDE_PANEL_TREE,
  93                     nodes: []
  94                 }));
  95             }
  96         });
  97     };
  98
  99 export const loadSidePanelTreeProjects = (projectUuid: string) =>
 100     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 101         const treePicker = getTreePicker(SIDE_PANEL_TREE)(getState().treePicker);
 102         const node = treePicker ? getNode(projectUuid)(treePicker) : undefined;
 103         if (projectUuid === SidePanelTreeCategory.PUBLIC_FAVORITES) {
 104             const unverifiedPubFaves = await dispatch<any>(loadPublicFavoritesTree());
 105             verifyAndUpdateLinkNames(unverifiedPubFaves, dispatch, getState, services);
 106         } else if (projectUuid === SidePanelTreeCategory.FAVORITES) {
 107             const unverifiedFaves = await dispatch<any>(loadFavoritesTree());
 108             await setFaves(unverifiedFaves, dispatch, getState, services);
 109             verifyAndUpdateLinkNames(unverifiedFaves, dispatch, getState, services);
 110         } else if (node || projectUuid !== '') {
 111             await dispatch<any>(loadProject(projectUuid));
 112         }
 113     };
 114
 115 const loadProject = (projectUuid: string) =>
 116     async (dispatch: Dispatch, _: () => RootState, services: ServiceRepository) => {
 117         dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id: projectUuid, pickerId: SIDE_PANEL_TREE }));
 118         const params = {
 119             filters: new FilterBuilder()
 120                 .addEqual('owner_uuid', projectUuid)
 121                 .getFilters(),
 122             order: new OrderBuilder<ProjectResource>()
 123                 .addDesc('createdAt')
 124                 .getOrder(),
 125             limit: SIDEPANEL_TREE_NODE_LIMIT,
 126         };
 127
 128         const { items } = await services.projectService.list(params);
 129
 130         dispatch(treePickerActions.LOAD_TREE_PICKER_NODE_SUCCESS({
 131             id: projectUuid,
 132             pickerId: SIDE_PANEL_TREE,
 133             nodes: items.map(item => initTreeNode({ id: item.uuid, value: item })),
 134         }));
 135         dispatch(resourcesActions.SET_RESOURCES(items));
 136     };
 137
 138 export const loadFavoritesTree = () => async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 139     dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id: SidePanelTreeCategory.FAVORITES, pickerId: SIDE_PANEL_TREE }));
 140
 141     const params = {
 142         filters: new FilterBuilder()
 143             .addEqual('link_class', LinkClass.STAR)
 144             .addEqual('tail_uuid', getUserUuid(getState()))
 145             .addEqual('tail_kind', ResourceKind.USER)
 146             .getFilters(),
 147         order: new OrderBuilder<ProjectResource>().addDesc('createdAt').getOrder(),
 148         limit: SIDEPANEL_TREE_NODE_LIMIT,
 149     };
 150
 151     const { items } = await services.linkService.list(params);
 152
 153     dispatch(
 154         treePickerActions.LOAD_TREE_PICKER_NODE_SUCCESS({
 155             id: SidePanelTreeCategory.FAVORITES,
 156             pickerId: SIDE_PANEL_TREE,
 157             nodes: items.map(item => initTreeNode({ id: item.headUuid, value: item })),
 158         })
 159     );
 160
 161     return items;
 162 };
 163
 164 const setFaves = async(links: LinkResource[], dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 165
 166     const uuids = links.map(it => it.headUuid);
 167     const groupItems: any = await services.groupsService.list({
 168         select: ['uuid', 'name'],
 169         filters: new FilterBuilder()
 170             .addIn("uuid", uuids)
 171             .getFilters()
 172     });
 173     const collectionItems: any = await services.collectionService.list({
 174         select: ['uuid', 'name'],
 175         filters: new FilterBuilder()
 176             .addIn("uuid", uuids)
 177             .getFilters()
 178     });
 179     const processItems: any = await services.containerRequestService.list({
 180         select: ['uuid', 'name'],
 181         filters: new FilterBuilder()
 182             .addIn("uuid", uuids)
 183             .getFilters()
 184     });
 185     const responseItems = groupItems.items.concat(collectionItems.items).concat(processItems.items);
 186
 187     //setting resources here so they won't be re-fetched in validation step
 188     dispatch(resourcesActions.SET_RESOURCES(responseItems));
 189 };
 190
 191 const verifyAndUpdateLinkNames = async (links: LinkResource[], dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 192     const verfifiedLinks = await verifyAndUpdateLinks(links, dispatch, getState, services);
 193
 194     dispatch(
 195         treePickerActions.LOAD_TREE_PICKER_NODE_SUCCESS({
 196             id: SidePanelTreeCategory.FAVORITES,
 197             pickerId: SIDE_PANEL_TREE,
 198             nodes: verfifiedLinks.map(item => initTreeNode({ id: item.headUuid, value: item })),
 199         })
 200     );
 201 };
 202
 203 export const loadPublicFavoritesTree = () => async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 204     dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id: SidePanelTreeCategory.PUBLIC_FAVORITES, pickerId: SIDE_PANEL_TREE }));
 205
 206     const uuidPrefix = getState().auth.config.uuidPrefix;
 207     const publicProjectUuid = `${uuidPrefix}-j7d0g-publicfavorites`;
 208     const typeFilters = [ResourceKind.COLLECTION, ResourceKind.CONTAINER_REQUEST, ResourceKind.GROUP, ResourceKind.WORKFLOW];
 209
 210     const params = {
 211         filters: new FilterBuilder()
 212             .addEqual('link_class', LinkClass.STAR)
 213             .addEqual('owner_uuid', publicProjectUuid)
 214             .addIsA('head_uuid', typeFilters)
 215             .getFilters(),
 216         order: new OrderBuilder<ProjectResource>().addDesc('createdAt').getOrder(),
 217         limit: SIDEPANEL_TREE_NODE_LIMIT,
 218     };
 219
 220     const { items } = await services.linkService.list(params);
 221
 222     const uuids = items.map(it => it.headUuid);
 223     const groupItems: any = await services.groupsService.list({
 224         select: ['uuid', 'name'],
 225         filters: new FilterBuilder()
 226             .addIn("uuid", uuids)
 227             .addIsA("uuid", typeFilters)
 228             .getFilters()
 229     });
 230     const collectionItems: any = await services.collectionService.list({
 231         select: ['uuid', 'name'],
 232         filters: new FilterBuilder()
 233             .addIn("uuid", uuids)
 234             .addIsA("uuid", typeFilters)
 235             .getFilters()
 236     });
 237     const processItems: any = await services.containerRequestService.list({
 238         select: ['uuid', 'name'],
 239         filters: new FilterBuilder()
 240             .addIn("uuid", uuids)
 241             .addIsA("uuid", typeFilters)
 242             .getFilters()
 243     });
 244
 245     const responseItems = groupItems.items.concat(collectionItems.items).concat(processItems.items);
 246
 247     const filteredItems = items.filter(item => responseItems.some(responseItem => responseItem.uuid === item.headUuid));
 248
 249     dispatch(
 250         treePickerActions.LOAD_TREE_PICKER_NODE_SUCCESS({
 251             id: SidePanelTreeCategory.PUBLIC_FAVORITES,
 252             pickerId: SIDE_PANEL_TREE,
 253             nodes: filteredItems.map(item => initTreeNode({ id: item.headUuid, value: item })),
 254         })
 255     );
 256
 257     //setting resources here so they won't be re-fetched in validation step
 258     dispatch(resourcesActions.SET_RESOURCES(responseItems));
 259
 260     return filteredItems;
 261 };
 262
 263 export const activateSidePanelTreeItem = (id: string) =>
 264     async (dispatch: Dispatch, getState: () => RootState) => {
 265         const node = getSidePanelTreeNode(id)(getState().treePicker);
 266         if (node && !node.active) {
 267         dispatch(treePickerActions.ACTIVATE_TREE_PICKER_NODE({ id, pickerId: SIDE_PANEL_TREE }));
 268     }
 269     if (!isSidePanelTreeCategory(id)) {
 270             await dispatch<any>(activateSidePanelTreeProject(id));
 271         }
 272     };
 273
 274 export const activateSidePanelTreeProject = (id: string) =>
 275     async (dispatch: Dispatch, getState: () => RootState) => {
 276         const { treePicker } = getState();
 277         const node = getSidePanelTreeNode(id)(treePicker);
 278         if (node && node.status !== TreeNodeStatus.LOADED) {
 279             await dispatch<any>(loadSidePanelTreeProjects(id));
 280         } else if (node === undefined) {
 281             await dispatch<any>(activateSidePanelTreeBranch(id));
 282         }
 283         dispatch(treePickerActions.EXPAND_TREE_PICKER_NODES({
 284             ids: getSidePanelTreeNodeAncestorsIds(id)(treePicker),
 285             pickerId: SIDE_PANEL_TREE
 286         }));
 287         dispatch<any>(expandSidePanelTreeItem(id));
 288     };
 289
 290 export const activateSidePanelTreeBranch = (id: string) =>
 291     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 292         const userUuid = getUserUuid(getState());
 293         if (!userUuid) { return; }
 294         const ancestors = await services.ancestorsService.ancestors(id, userUuid);
 295         for (const ancestor of ancestors) {
 296             await dispatch<any>(loadSidePanelTreeProjects(ancestor.uuid));
 297         }
 298         dispatch(treePickerActions.EXPAND_TREE_PICKER_NODES({
 299             ids: ancestors.map(ancestor => ancestor.uuid),
 300             pickerId: SIDE_PANEL_TREE
 301         }));
 302         dispatch(treePickerActions.ACTIVATE_TREE_PICKER_NODE({ id, pickerId: SIDE_PANEL_TREE }));
 303     };
 304
 305 export const toggleSidePanelTreeItemCollapse = (id: string) =>
 306     async (dispatch: Dispatch, getState: () => RootState) => {
 307         const node = getSidePanelTreeNode(id)(getState().treePicker);
 308         if (node && node.status === TreeNodeStatus.INITIAL) {
 309             await dispatch<any>(loadSidePanelTreeProjects(node.id));
 310         }
 311             dispatch(treePickerActions.TOGGLE_TREE_PICKER_NODE_COLLAPSE({ id, pickerId: SIDE_PANEL_TREE }));
 312     };
 313
 314 export const expandSidePanelTreeItem = (id: string) =>
 315     async (dispatch: Dispatch, getState: () => RootState) => {
 316         const node = getSidePanelTreeNode(id)(getState().treePicker);
 317         if (node && !node.expanded) {
 318             dispatch(treePickerActions.TOGGLE_TREE_PICKER_NODE_COLLAPSE({ id, pickerId: SIDE_PANEL_TREE }));
 319         }
 320     };
 321
 322 export const getSidePanelTreeNode = (id: string) => (treePicker: TreePicker) => {
 323     const sidePanelTree = getTreePicker(SIDE_PANEL_TREE)(treePicker);
 324     return sidePanelTree
 325         ? getNode(id)(sidePanelTree)
 326         : undefined;
 327 };
 328
 329 export const getSidePanelTreeNodeAncestorsIds = (id: string) => (treePicker: TreePicker) => {
 330     const sidePanelTree = getTreePicker(SIDE_PANEL_TREE)(treePicker);
 331     return sidePanelTree
 332         ? getNodeAncestorsIds(id)(sidePanelTree)
 333         : [];
 334 };