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