src/store/tree-picker/tree-picker-actions.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { unionize, ofType, UnionOf } from "~/common/unionize";
   6 import { TreeNode, initTreeNode, getNodeDescendants, TreeNodeStatus, getNode, TreePickerId, Tree } from '~/models/tree';
   7 import { createCollectionFilesTree } from "~/models/collection-file";
   8 import { Dispatch } from 'redux';
   9 import { RootState } from '~/store/store';
  10 import { getUserUuid } from "~/common/getuser";
  11 import { ServiceRepository } from '~/services/services';
  12 import { FilterBuilder } from '~/services/api/filter-builder';
  13 import { pipe, values } from 'lodash/fp';
  14 import { ResourceKind } from '~/models/resource';
  15 import { GroupContentsResource } from '~/services/groups-service/groups-service';
  16 import { getTreePicker, TreePicker } from './tree-picker';
  17 import { ProjectsTreePickerItem } from '~/views-components/projects-tree-picker/generic-projects-tree-picker';
  18 import { OrderBuilder } from '~/services/api/order-builder';
  19 import { ProjectResource } from '~/models/project';
  20 import { mapTree } from '../../models/tree';
  21 import { LinkResource, LinkClass } from "~/models/link";
  22 import { mapTreeValues } from "~/models/tree";
  23 import { sortFilesTree } from "~/services/collection-service/collection-service-files-response";
  24 import { GroupClass, GroupResource } from "~/models/group";
  25
  26 export const treePickerActions = unionize({
  27     LOAD_TREE_PICKER_NODE: ofType<{ id: string, pickerId: string }>(),
  28     LOAD_TREE_PICKER_NODE_SUCCESS: ofType<{ id: string, nodes: Array<TreeNode<any>>, pickerId: string }>(),
  29     APPEND_TREE_PICKER_NODE_SUBTREE: ofType<{ id: string, subtree: Tree<any>, pickerId: string }>(),
  30     TOGGLE_TREE_PICKER_NODE_COLLAPSE: ofType<{ id: string, pickerId: string }>(),
  31     ACTIVATE_TREE_PICKER_NODE: ofType<{ id: string, pickerId: string, relatedTreePickers?: string[] }>(),
  32     DEACTIVATE_TREE_PICKER_NODE: ofType<{ pickerId: string }>(),
  33     TOGGLE_TREE_PICKER_NODE_SELECTION: ofType<{ id: string, pickerId: string }>(),
  34     SELECT_TREE_PICKER_NODE: ofType<{ id: string | string[], pickerId: string }>(),
  35     DESELECT_TREE_PICKER_NODE: ofType<{ id: string | string[], pickerId: string }>(),
  36     EXPAND_TREE_PICKER_NODES: ofType<{ ids: string[], pickerId: string }>(),
  37     RESET_TREE_PICKER: ofType<{ pickerId: string }>()
  38 });
  39
  40 export type TreePickerAction = UnionOf<typeof treePickerActions>;
  41
  42 export const getProjectsTreePickerIds = (pickerId: string) => ({
  43     home: `${pickerId}_home`,
  44     shared: `${pickerId}_shared`,
  45     favorites: `${pickerId}_favorites`,
  46     publicFavorites: `${pickerId}_publicFavorites`
  47 });
  48
  49 export const getAllNodes = <Value>(pickerId: string, filter = (node: TreeNode<Value>) => true) => (state: TreePicker) =>
  50     pipe(
  51         () => values(getProjectsTreePickerIds(pickerId)),
  52
  53         ids => ids
  54             .map(id => getTreePicker<Value>(id)(state)),
  55
  56         trees => trees
  57             .map(getNodeDescendants(''))
  58             .reduce((allNodes, nodes) => allNodes.concat(nodes), []),
  59
  60         allNodes => allNodes
  61             .reduce((map, node) =>
  62                 filter(node)
  63                     ? map.set(node.id, node)
  64                     : map, new Map<string, TreeNode<Value>>())
  65             .values(),
  66
  67         uniqueNodes => Array.from(uniqueNodes),
  68     )();
  69 export const getSelectedNodes = <Value>(pickerId: string) => (state: TreePicker) =>
  70     getAllNodes<Value>(pickerId, node => node.selected)(state);
  71
  72 export const initProjectsTreePicker = (pickerId: string) =>
  73     async (dispatch: Dispatch, _: () => RootState, services: ServiceRepository) => {
  74         const { home, shared, favorites, publicFavorites } = getProjectsTreePickerIds(pickerId);
  75         dispatch<any>(initUserProject(home));
  76         dispatch<any>(initSharedProject(shared));
  77         dispatch<any>(initFavoritesProject(favorites));
  78         dispatch<any>(initPublicFavoritesProject(publicFavorites));
  79     };
  80
  81 interface ReceiveTreePickerDataParams<T> {
  82     data: T[];
  83     extractNodeData: (value: T) => { id: string, value: T, status?: TreeNodeStatus };
  84     id: string;
  85     pickerId: string;
  86 }
  87
  88 export const receiveTreePickerData = <T>(params: ReceiveTreePickerDataParams<T>) =>
  89     (dispatch: Dispatch) => {
  90         const { data, extractNodeData, id, pickerId, } = params;
  91         dispatch(treePickerActions.LOAD_TREE_PICKER_NODE_SUCCESS({
  92             id,
  93             nodes: data.map(item => initTreeNode(extractNodeData(item))),
  94             pickerId,
  95         }));
  96         dispatch(treePickerActions.TOGGLE_TREE_PICKER_NODE_COLLAPSE({ id, pickerId }));
  97     };
  98
  99 interface LoadProjectParams {
 100     id: string;
 101     pickerId: string;
 102     includeCollections?: boolean;
 103     includeFiles?: boolean;
 104     includeFilterGroups?: boolean;
 105     loadShared?: boolean;
 106 }
 107 export const loadProject = (params: LoadProjectParams) =>
 108     async (dispatch: Dispatch, _: () => RootState, services: ServiceRepository) => {
 109         const { id, pickerId, includeCollections = false, includeFiles = false, includeFilterGroups = false, loadShared = false } = params;
 110
 111         dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id, pickerId }));
 112
 113         const filters = pipe(
 114             (fb: FilterBuilder) => includeCollections
 115                 ? fb.addIsA('uuid', [ResourceKind.PROJECT, ResourceKind.COLLECTION])
 116                 : fb.addIsA('uuid', [ResourceKind.PROJECT]),
 117             fb => fb.getFilters(),
 118         )(new FilterBuilder());
 119
 120         const { items } = await services.groupsService.contents(loadShared ? '' : id, { filters, excludeHomeProject: loadShared || undefined });
 121
 122         dispatch<any>(receiveTreePickerData<GroupContentsResource>({
 123             id,
 124             pickerId,
 125             data: items.filter((item) => {
 126                     if (!includeFilterGroups && (item as GroupResource).groupClass && (item as GroupResource).groupClass === GroupClass.FILTER) {
 127                         return false;
 128                     }
 129                     return true;
 130                 }),
 131             extractNodeData: item => ({
 132                 id: item.uuid,
 133                 value: item,
 134                 status: item.kind === ResourceKind.PROJECT
 135                     ? TreeNodeStatus.INITIAL
 136                     : includeFiles
 137                         ? TreeNodeStatus.INITIAL
 138                         : TreeNodeStatus.LOADED
 139             }),
 140         }));
 141     };
 142
 143 export const loadCollection = (id: string, pickerId: string) =>
 144     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 145         dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id, pickerId }));
 146
 147         const picker = getTreePicker<ProjectsTreePickerItem>(pickerId)(getState().treePicker);
 148         if (picker) {
 149
 150             const node = getNode(id)(picker);
 151             if (node && 'kind' in node.value && node.value.kind === ResourceKind.COLLECTION) {
 152
 153                 const files = await services.collectionService.files(node.value.portableDataHash);
 154                 const tree = createCollectionFilesTree(files);
 155                 const sorted = sortFilesTree(tree);
 156                 const filesTree = mapTreeValues(services.collectionService.extendFileURL)(sorted);
 157
 158                 dispatch(
 159                     treePickerActions.APPEND_TREE_PICKER_NODE_SUBTREE({
 160                         id,
 161                         pickerId,
 162                         subtree: mapTree(node => ({ ...node, status: TreeNodeStatus.LOADED }))(filesTree)
 163                     }));
 164
 165                 dispatch(treePickerActions.TOGGLE_TREE_PICKER_NODE_COLLAPSE({ id, pickerId }));
 166             }
 167         }
 168     };
 169
 170
 171 export const initUserProject = (pickerId: string) =>
 172     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 173         const uuid = getUserUuid(getState());
 174         if (uuid) {
 175             dispatch(receiveTreePickerData({
 176                 id: '',
 177                 pickerId,
 178                 data: [{ uuid, name: 'Projects' }],
 179                 extractNodeData: value => ({
 180                     id: value.uuid,
 181                     status: TreeNodeStatus.INITIAL,
 182                     value,
 183                 }),
 184             }));
 185         }
 186     };
 187 export const loadUserProject = (pickerId: string, includeCollections = false, includeFiles = false) =>
 188     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 189         const uuid = getUserUuid(getState());
 190         if (uuid) {
 191             dispatch(loadProject({ id: uuid, pickerId, includeCollections, includeFiles }));
 192         }
 193     };
 194
 195 export const SHARED_PROJECT_ID = 'Shared with me';
 196 export const initSharedProject = (pickerId: string) =>
 197     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 198         dispatch(receiveTreePickerData({
 199             id: '',
 200             pickerId,
 201             data: [{ uuid: SHARED_PROJECT_ID, name: SHARED_PROJECT_ID }],
 202             extractNodeData: value => ({
 203                 id: value.uuid,
 204                 status: TreeNodeStatus.INITIAL,
 205                 value,
 206             }),
 207         }));
 208     };
 209
 210 export const FAVORITES_PROJECT_ID = 'Favorites';
 211 export const initFavoritesProject = (pickerId: string) =>
 212     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 213         dispatch(receiveTreePickerData({
 214             id: '',
 215             pickerId,
 216             data: [{ uuid: FAVORITES_PROJECT_ID, name: FAVORITES_PROJECT_ID }],
 217             extractNodeData: value => ({
 218                 id: value.uuid,
 219                 status: TreeNodeStatus.INITIAL,
 220                 value,
 221             }),
 222         }));
 223     };
 224
 225 export const PUBLIC_FAVORITES_PROJECT_ID = 'Public Favorites';
 226 export const initPublicFavoritesProject = (pickerId: string) =>
 227     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 228         dispatch(receiveTreePickerData({
 229             id: '',
 230             pickerId,
 231             data: [{ uuid: PUBLIC_FAVORITES_PROJECT_ID, name: PUBLIC_FAVORITES_PROJECT_ID }],
 232             extractNodeData: value => ({
 233                 id: value.uuid,
 234                 status: TreeNodeStatus.INITIAL,
 235                 value,
 236             }),
 237         }));
 238     };
 239
 240 interface LoadFavoritesProjectParams {
 241     pickerId: string;
 242     includeCollections?: boolean;
 243     includeFiles?: boolean;
 244 }
 245
 246 export const loadFavoritesProject = (params: LoadFavoritesProjectParams,
 247     options: { showOnlyOwned: boolean, showOnlyWritable: boolean } = { showOnlyOwned: true, showOnlyWritable: false }) =>
 248     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 249         const { pickerId, includeCollections = false, includeFiles = false } = params;
 250         const uuid = getUserUuid(getState());
 251         if (uuid) {
 252             const filters = pipe(
 253                 (fb: FilterBuilder) => includeCollections
 254                     ? fb.addIsA('head_uuid', [ResourceKind.PROJECT, ResourceKind.COLLECTION])
 255                     : fb.addIsA('head_uuid', [ResourceKind.PROJECT]),
 256                 fb => fb.getFilters(),
 257             )(new FilterBuilder());
 258
 259             const { items } = await services.favoriteService.list(uuid, { filters }, options.showOnlyOwned);
 260
 261             dispatch<any>(receiveTreePickerData<GroupContentsResource>({
 262                 id: 'Favorites',
 263                 pickerId,
 264                 data: items.filter((item) => {
 265                     if (options.showOnlyWritable && (item as GroupResource).writableBy && (item as GroupResource).writableBy.indexOf(uuid) === -1) {
 266                         return false;
 267                     }
 268
 269                     return true;
 270                 }),
 271                 extractNodeData: item => ({
 272                     id: item.uuid,
 273                     value: item,
 274                     status: item.kind === ResourceKind.PROJECT
 275                         ? TreeNodeStatus.INITIAL
 276                         : includeFiles
 277                             ? TreeNodeStatus.INITIAL
 278                             : TreeNodeStatus.LOADED
 279                 }),
 280             }));
 281         }
 282     };
 283
 284 export const loadPublicFavoritesProject = (params: LoadFavoritesProjectParams) =>
 285     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 286         const { pickerId, includeCollections = false, includeFiles = false } = params;
 287         const uuidPrefix = getState().auth.config.uuidPrefix;
 288         const publicProjectUuid = `${uuidPrefix}-j7d0g-publicfavorites`;
 289
 290         const filters = pipe(
 291             (fb: FilterBuilder) => includeCollections
 292                 ? fb.addIsA('head_uuid', [ResourceKind.PROJECT, ResourceKind.COLLECTION])
 293                 : fb.addIsA('head_uuid', [ResourceKind.PROJECT]),
 294             fb => fb
 295                 .addEqual('link_class', LinkClass.STAR)
 296                 .addEqual('owner_uuid', publicProjectUuid)
 297                 .getFilters(),
 298         )(new FilterBuilder());
 299
 300         const { items } = await services.linkService.list({ filters });
 301
 302         dispatch<any>(receiveTreePickerData<LinkResource>({
 303             id: 'Public Favorites',
 304             pickerId,
 305             data: items,
 306             extractNodeData: item => ({
 307                 id: item.headUuid,
 308                 value: item,
 309                 status: item.headKind === ResourceKind.PROJECT
 310                     ? TreeNodeStatus.INITIAL
 311                     : includeFiles
 312                         ? TreeNodeStatus.INITIAL
 313                         : TreeNodeStatus.LOADED
 314             }),
 315         }));
 316     };
 317
 318 export const receiveTreePickerProjectsData = (id: string, projects: ProjectResource[], pickerId: string) =>
 319     (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 320         dispatch(treePickerActions.LOAD_TREE_PICKER_NODE_SUCCESS({
 321             id,
 322             nodes: projects.map(project => initTreeNode({ id: project.uuid, value: project })),
 323             pickerId,
 324         }));
 325
 326         dispatch(treePickerActions.TOGGLE_TREE_PICKER_NODE_COLLAPSE({ id, pickerId }));
 327     };
 328
 329 export const loadProjectTreePickerProjects = (id: string) =>
 330     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 331         dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id, pickerId: TreePickerId.PROJECTS }));
 332
 333
 334         const ownerUuid = id.length === 0 ? getUserUuid(getState()) || '' : id;
 335         const { items } = await services.projectService.list(buildParams(ownerUuid));
 336
 337         dispatch<any>(receiveTreePickerProjectsData(id, items, TreePickerId.PROJECTS));
 338     };
 339
 340 export const loadFavoriteTreePickerProjects = (id: string) =>
 341     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 342         const parentId = getUserUuid(getState()) || '';
 343
 344         if (id === '') {
 345             dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id: parentId, pickerId: TreePickerId.FAVORITES }));
 346             const { items } = await services.favoriteService.list(parentId);
 347             dispatch<any>(receiveTreePickerProjectsData(parentId, items as ProjectResource[], TreePickerId.FAVORITES));
 348         } else {
 349             dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id, pickerId: TreePickerId.FAVORITES }));
 350             const { items } = await services.projectService.list(buildParams(id));
 351             dispatch<any>(receiveTreePickerProjectsData(id, items, TreePickerId.FAVORITES));
 352         }
 353
 354     };
 355
 356 export const loadPublicFavoriteTreePickerProjects = (id: string) =>
 357     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 358         const parentId = getUserUuid(getState()) || '';
 359
 360         if (id === '') {
 361             dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id: parentId, pickerId: TreePickerId.PUBLIC_FAVORITES }));
 362             const { items } = await services.favoriteService.list(parentId);
 363             dispatch<any>(receiveTreePickerProjectsData(parentId, items as ProjectResource[], TreePickerId.PUBLIC_FAVORITES));
 364         } else {
 365             dispatch(treePickerActions.LOAD_TREE_PICKER_NODE({ id, pickerId: TreePickerId.PUBLIC_FAVORITES }));
 366             const { items } = await services.projectService.list(buildParams(id));
 367             dispatch<any>(receiveTreePickerProjectsData(id, items, TreePickerId.PUBLIC_FAVORITES));
 368         }
 369
 370     };
 371
 372 const buildParams = (ownerUuid: string) => {
 373     return {
 374         filters: new FilterBuilder()
 375             .addEqual('owner_uuid', ownerUuid)
 376             .getFilters(),
 377         order: new OrderBuilder<ProjectResource>()
 378             .addAsc('name')
 379             .getOrder()
 380     };
 381 };