src/store/workbench/workbench-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 { RootState } from "../store";
   7 import { loadDetailsPanel } from '~/store/details-panel/details-panel-action';
   8 import { loadCollectionPanel } from '~/store/collection-panel/collection-panel-action';
   9 import { snackbarActions } from '../snackbar/snackbar-actions';
  10 import { loadFavoritePanel } from '../favorite-panel/favorite-panel-action';
  11 import { openProjectPanel, projectPanelActions } from '~/store/project-panel/project-panel-action';
  12 import { activateSidePanelTreeItem, initSidePanelTree, SidePanelTreeCategory, loadSidePanelTreeProjects, getSidePanelTreeNodeAncestorsIds } from '../side-panel-tree/side-panel-tree-actions';
  13 import { loadResource, updateResources } from '../resources/resources-actions';
  14 import { favoritePanelActions } from '~/store/favorite-panel/favorite-panel-action';
  15 import { projectPanelColumns } from '~/views/project-panel/project-panel';
  16 import { favoritePanelColumns } from '~/views/favorite-panel/favorite-panel';
  17 import { matchRootRoute } from '~/routes/routes';
  18 import { setCollectionBreadcrumbs, setSidePanelBreadcrumbs, setProcessBreadcrumbs, setSharedWithMeBreadcrumbs, setTrashBreadcrumbs } from '../breadcrumbs/breadcrumbs-actions';
  19 import { navigateToProject } from '../navigation/navigation-action';
  20 import { MoveToFormDialogData } from '~/store/move-to-dialog/move-to-dialog';
  21 import { ServiceRepository } from '~/services/services';
  22 import { getResource } from '../resources/resources';
  23 import { getProjectPanelCurrentUuid } from '../project-panel/project-panel-action';
  24 import * as projectCreateActions from '~/store/projects/project-create-actions';
  25 import * as projectMoveActions from '~/store/projects/project-move-actions';
  26 import * as projectUpdateActions from '~/store/projects/project-update-actions';
  27 import * as collectionCreateActions from '~/store/collections/collection-create-actions';
  28 import * as collectionCopyActions from '~/store/collections/collection-copy-actions';
  29 import * as collectionUpdateActions from '~/store/collections/collection-update-actions';
  30 import * as collectionMoveActions from '~/store/collections/collection-move-actions';
  31 import * as processesActions from '../processes/processes-actions';
  32 import * as processMoveActions from '~/store/processes/process-move-actions';
  33 import * as processUpdateActions from '~/store/processes/process-update-actions';
  34 import * as processCopyActions from '~/store/processes/process-copy-actions';
  35 import { trashPanelColumns } from "~/views/trash-panel/trash-panel";
  36 import { loadTrashPanel, trashPanelActions } from "~/store/trash-panel/trash-panel-action";
  37 import { initProcessLogsPanel } from '../process-logs-panel/process-logs-panel-actions';
  38 import { loadProcessPanel } from '~/store/process-panel/process-panel-actions';
  39 import { sharedWithMePanelActions } from '~/store/shared-with-me-panel/shared-with-me-panel-actions';
  40 import { loadSharedWithMePanel } from '../shared-with-me-panel/shared-with-me-panel-actions';
  41 import { CopyFormDialogData } from '~/store/copy-dialog/copy-dialog';
  42 import { progressIndicatorActions } from '~/store/progress-indicator/progress-indicator-actions';
  43 import { getProgressIndicator } from '../progress-indicator/progress-indicator-reducer';
  44 import { ResourceKind } from '~/models/resource';
  45 import { FilterBuilder } from '~/services/api/filter-builder';
  46 import { ProjectResource } from '~/models/project';
  47
  48
  49 export const WORKBENCH_LOADING_SCREEN = 'workbenchLoadingScreen';
  50
  51 export const isWorkbenchLoading = (state: RootState) => {
  52     const progress = getProgressIndicator(WORKBENCH_LOADING_SCREEN)(state.progressIndicator);
  53     return progress ? progress.working : false;
  54 };
  55
  56 const handleFirstTimeLoad = (action: any) =>
  57     async (dispatch: Dispatch<any>, getState: () => RootState) => {
  58         try {
  59             await dispatch(action);
  60         } finally {
  61             if (isWorkbenchLoading(getState())) {
  62                 dispatch(progressIndicatorActions.STOP_WORKING(WORKBENCH_LOADING_SCREEN));
  63             }
  64         }
  65     };
  66
  67
  68 export const loadWorkbench = () =>
  69     async (dispatch: Dispatch, getState: () => RootState) => {
  70         dispatch(progressIndicatorActions.START_WORKING(WORKBENCH_LOADING_SCREEN));
  71         const { auth, router } = getState();
  72         const { user } = auth;
  73         if (user) {
  74             const userResource = await dispatch<any>(loadResource(user.uuid));
  75             if (userResource) {
  76                 dispatch(projectPanelActions.SET_COLUMNS({ columns: projectPanelColumns }));
  77                 dispatch(favoritePanelActions.SET_COLUMNS({ columns: favoritePanelColumns }));
  78                 dispatch(trashPanelActions.SET_COLUMNS({ columns: trashPanelColumns }));
  79                 dispatch(sharedWithMePanelActions.SET_COLUMNS({ columns: projectPanelColumns }));
  80                 dispatch<any>(initSidePanelTree());
  81                 if (router.location) {
  82                     const match = matchRootRoute(router.location.pathname);
  83                     if (match) {
  84                         dispatch(navigateToProject(userResource.uuid));
  85                     }
  86                 }
  87             } else {
  88                 dispatch(userIsNotAuthenticated);
  89             }
  90         } else {
  91             dispatch(userIsNotAuthenticated);
  92         }
  93     };
  94
  95 export const loadFavorites = () =>
  96     handleFirstTimeLoad(
  97         (dispatch: Dispatch) => {
  98             dispatch<any>(activateSidePanelTreeItem(SidePanelTreeCategory.FAVORITES));
  99             dispatch<any>(loadFavoritePanel());
 100             dispatch<any>(setSidePanelBreadcrumbs(SidePanelTreeCategory.FAVORITES));
 101         });
 102
 103 export const loadTrash = () =>
 104     handleFirstTimeLoad(
 105         (dispatch: Dispatch) => {
 106             dispatch<any>(activateSidePanelTreeItem(SidePanelTreeCategory.TRASH));
 107             dispatch<any>(loadTrashPanel());
 108             dispatch<any>(setSidePanelBreadcrumbs(SidePanelTreeCategory.TRASH));
 109         });
 110
 111 export const loadProject = (uuid: string) =>
 112     handleFirstTimeLoad(
 113         async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 114             const userUuid = services.authService.getUuid();
 115             if (userUuid) {
 116                 let project: ProjectResource | null = null;
 117                 if (userUuid !== uuid) {
 118                     /**
 119                      * Use of /group/contents API is the only way to get trashed item
 120                      * A get method of a service will throw an exception with 404 status for resources that are trashed
 121                      */
 122                     const resource = await loadGroupContentsResource(uuid, userUuid, services);
 123                     if (resource) {
 124                         if (resource.kind === ResourceKind.PROJECT) {
 125                             project = resource;
 126                             if (project.isTrashed) {
 127                                 dispatch<any>(setTrashBreadcrumbs(uuid));
 128                                 dispatch(activateSidePanelTreeItem(SidePanelTreeCategory.TRASH));
 129                             } else {
 130                                 await dispatch(activateSidePanelTreeItem(uuid));
 131                                 dispatch<any>(setSidePanelBreadcrumbs(uuid));
 132                             }
 133                         }
 134                     } else {
 135                         /**
 136                          * If item is not accesible using loadGroupContentsResource,
 137                          * but it can be obtained using the get method of the service
 138                          * then it is shared with the user
 139                          */
 140                         project = await services.projectService.get(uuid);
 141                         if (project) {
 142                             dispatch<any>(setSharedWithMeBreadcrumbs(uuid));
 143                             dispatch(activateSidePanelTreeItem(SidePanelTreeCategory.SHARED_WITH_ME));
 144                         }
 145                     }
 146                     if (project) {
 147                         dispatch(updateResources([project]));
 148                     }
 149                 } else {
 150                     await dispatch(activateSidePanelTreeItem(userUuid));
 151                     dispatch<any>(setSidePanelBreadcrumbs(userUuid));
 152                 }
 153                 if (project) {
 154                     dispatch(openProjectPanel(uuid));
 155                     dispatch(loadDetailsPanel(uuid));
 156                 }
 157             }
 158         });
 159
 160 export const createProject = (data: projectCreateActions.ProjectCreateFormDialogData) =>
 161     async (dispatch: Dispatch) => {
 162         const newProject = await dispatch<any>(projectCreateActions.createProject(data));
 163         if (newProject) {
 164             dispatch(snackbarActions.OPEN_SNACKBAR({
 165                 message: "Project has been successfully created.",
 166                 hideDuration: 2000
 167             }));
 168             await dispatch<any>(loadSidePanelTreeProjects(newProject.ownerUuid));
 169             dispatch<any>(reloadProjectMatchingUuid([newProject.ownerUuid]));
 170         }
 171     };
 172
 173 export const moveProject = (data: MoveToFormDialogData) =>
 174     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 175         try {
 176             const oldProject = getResource(data.uuid)(getState().resources);
 177             const oldOwnerUuid = oldProject ? oldProject.ownerUuid : '';
 178             const movedProject = await dispatch<any>(projectMoveActions.moveProject(data));
 179             if (movedProject) {
 180                 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Project has been moved', hideDuration: 2000 }));
 181                 if (oldProject) {
 182                     await dispatch<any>(loadSidePanelTreeProjects(oldProject.ownerUuid));
 183                 }
 184                 dispatch<any>(reloadProjectMatchingUuid([oldOwnerUuid, movedProject.ownerUuid, movedProject.uuid]));
 185             }
 186         } catch (e) {
 187             dispatch(snackbarActions.OPEN_SNACKBAR({ message: e.message, hideDuration: 2000 }));
 188         }
 189     };
 190
 191 export const updateProject = (data: projectUpdateActions.ProjectUpdateFormDialogData) =>
 192     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 193         const updatedProject = await dispatch<any>(projectUpdateActions.updateProject(data));
 194         if (updatedProject) {
 195             dispatch(snackbarActions.OPEN_SNACKBAR({
 196                 message: "Project has been successfully updated.",
 197                 hideDuration: 2000
 198             }));
 199             await dispatch<any>(loadSidePanelTreeProjects(updatedProject.ownerUuid));
 200             dispatch<any>(reloadProjectMatchingUuid([updatedProject.ownerUuid, updatedProject.uuid]));
 201         }
 202     };
 203
 204 export const loadCollection = (uuid: string) =>
 205     handleFirstTimeLoad(
 206         async (dispatch: Dispatch) => {
 207             const collection = await dispatch<any>(loadCollectionPanel(uuid));
 208             await dispatch<any>(activateSidePanelTreeItem(collection.ownerUuid));
 209             dispatch<any>(setCollectionBreadcrumbs(collection.uuid));
 210             dispatch(loadDetailsPanel(uuid));
 211         });
 212
 213 export const createCollection = (data: collectionCreateActions.CollectionCreateFormDialogData) =>
 214     async (dispatch: Dispatch) => {
 215         const collection = await dispatch<any>(collectionCreateActions.createCollection(data));
 216         if (collection) {
 217             dispatch(snackbarActions.OPEN_SNACKBAR({
 218                 message: "Collection has been successfully created.",
 219                 hideDuration: 2000
 220             }));
 221             dispatch<any>(updateResources([collection]));
 222             dispatch<any>(reloadProjectMatchingUuid([collection.ownerUuid]));
 223         }
 224     };
 225
 226 export const updateCollection = (data: collectionUpdateActions.CollectionUpdateFormDialogData) =>
 227     async (dispatch: Dispatch) => {
 228         const collection = await dispatch<any>(collectionUpdateActions.updateCollection(data));
 229         if (collection) {
 230             dispatch(snackbarActions.OPEN_SNACKBAR({
 231                 message: "Collection has been successfully updated.",
 232                 hideDuration: 2000
 233             }));
 234             dispatch<any>(updateResources([collection]));
 235             dispatch<any>(reloadProjectMatchingUuid([collection.ownerUuid]));
 236         }
 237     };
 238
 239 export const copyCollection = (data: CopyFormDialogData) =>
 240     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 241         try {
 242             const collection = await dispatch<any>(collectionCopyActions.copyCollection(data));
 243             dispatch<any>(updateResources([collection]));
 244             dispatch<any>(reloadProjectMatchingUuid([collection.ownerUuid]));
 245             dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Collection has been copied.', hideDuration: 2000 }));
 246         } catch (e) {
 247             dispatch(snackbarActions.OPEN_SNACKBAR({ message: e.message, hideDuration: 2000 }));
 248         }
 249     };
 250
 251 export const moveCollection = (data: MoveToFormDialogData) =>
 252     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 253         try {
 254             const collection = await dispatch<any>(collectionMoveActions.moveCollection(data));
 255             dispatch<any>(updateResources([collection]));
 256             dispatch<any>(reloadProjectMatchingUuid([collection.ownerUuid]));
 257             dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Collection has been moved.', hideDuration: 2000 }));
 258         } catch (e) {
 259             dispatch(snackbarActions.OPEN_SNACKBAR({ message: e.message, hideDuration: 2000 }));
 260         }
 261     };
 262
 263 export const loadProcess = (uuid: string) =>
 264     handleFirstTimeLoad(
 265         async (dispatch: Dispatch, getState: () => RootState) => {
 266             dispatch<any>(loadProcessPanel(uuid));
 267             const process = await dispatch<any>(processesActions.loadProcess(uuid));
 268             await dispatch<any>(activateSidePanelTreeItem(process.containerRequest.ownerUuid));
 269             dispatch<any>(setProcessBreadcrumbs(uuid));
 270             dispatch(loadDetailsPanel(uuid));
 271         });
 272
 273 export const updateProcess = (data: processUpdateActions.ProcessUpdateFormDialogData) =>
 274     async (dispatch: Dispatch) => {
 275         try {
 276             const process = await dispatch<any>(processUpdateActions.updateProcess(data));
 277             if (process) {
 278                 dispatch(snackbarActions.OPEN_SNACKBAR({
 279                     message: "Process has been successfully updated.",
 280                     hideDuration: 2000
 281                 }));
 282                 dispatch<any>(updateResources([process]));
 283                 dispatch<any>(reloadProjectMatchingUuid([process.ownerUuid]));
 284             }
 285         } catch (e) {
 286             dispatch(snackbarActions.OPEN_SNACKBAR({ message: e.message, hideDuration: 2000 }));
 287         }
 288     };
 289
 290 export const moveProcess = (data: MoveToFormDialogData) =>
 291     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 292         try {
 293             const process = await dispatch<any>(processMoveActions.moveProcess(data));
 294             dispatch<any>(updateResources([process]));
 295             dispatch<any>(reloadProjectMatchingUuid([process.ownerUuid]));
 296             dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Process has been moved.', hideDuration: 2000 }));
 297         } catch (e) {
 298             dispatch(snackbarActions.OPEN_SNACKBAR({ message: e.message, hideDuration: 2000 }));
 299         }
 300     };
 301
 302 export const copyProcess = (data: CopyFormDialogData) =>
 303     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 304         try {
 305             const process = await dispatch<any>(processCopyActions.copyProcess(data));
 306             dispatch<any>(updateResources([process]));
 307             dispatch<any>(reloadProjectMatchingUuid([process.ownerUuid]));
 308             dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Process has been copied.', hideDuration: 2000 }));
 309         } catch (e) {
 310             dispatch(snackbarActions.OPEN_SNACKBAR({ message: e.message, hideDuration: 2000 }));
 311         }
 312     };
 313
 314 export const loadProcessLog = (uuid: string) =>
 315     handleFirstTimeLoad(
 316         async (dispatch: Dispatch) => {
 317             const process = await dispatch<any>(processesActions.loadProcess(uuid));
 318             dispatch<any>(setProcessBreadcrumbs(uuid));
 319             dispatch<any>(initProcessLogsPanel(uuid));
 320             await dispatch<any>(activateSidePanelTreeItem(process.containerRequest.ownerUuid));
 321         });
 322
 323 export const resourceIsNotLoaded = (uuid: string) =>
 324     snackbarActions.OPEN_SNACKBAR({
 325         message: `Resource identified by ${uuid} is not loaded.`
 326     });
 327
 328 export const userIsNotAuthenticated = snackbarActions.OPEN_SNACKBAR({
 329     message: 'User is not authenticated'
 330 });
 331
 332 export const couldNotLoadUser = snackbarActions.OPEN_SNACKBAR({
 333     message: 'Could not load user'
 334 });
 335
 336 export const reloadProjectMatchingUuid = (matchingUuids: string[]) =>
 337     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
 338         const currentProjectPanelUuid = getProjectPanelCurrentUuid(getState());
 339         if (currentProjectPanelUuid && matchingUuids.some(uuid => uuid === currentProjectPanelUuid)) {
 340             dispatch<any>(loadProject(currentProjectPanelUuid));
 341         }
 342     };
 343
 344 export const loadSharedWithMe = handleFirstTimeLoad(async (dispatch: Dispatch) => {
 345     dispatch<any>(loadSharedWithMePanel());
 346     await dispatch<any>(activateSidePanelTreeItem(SidePanelTreeCategory.SHARED_WITH_ME));
 347     await dispatch<any>(setSidePanelBreadcrumbs(SidePanelTreeCategory.SHARED_WITH_ME));
 348 });
 349
 350 const loadGroupContentsResource = async (uuid: string, ownerUuid: string, services: ServiceRepository) => {
 351
 352     const filters = new FilterBuilder()
 353         .addEqual('uuid', uuid)
 354         .getFilters();
 355
 356     const { items } = await services.groupsService.contents(ownerUuid, {
 357         filters,
 358         recursive: true,
 359         includeTrash: true,
 360     });
 361
 362     return items.shift();
 363
 364 };