src/store/groups-panel/groups-panel-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 { reset, startSubmit, stopSubmit, FormErrors, initialize } from 'redux-form';
   7 import { bindDataExplorerActions } from "store/data-explorer/data-explorer-action";
   8 import { dialogActions } from 'store/dialog/dialog-actions';
   9 import { Participant } from 'views-components/sharing-dialog/participant-select';
  10 import { RootState } from 'store/store';
  11 import { ServiceRepository } from 'services/services';
  12 import { getResource } from 'store/resources/resources';
  13 import { GroupResource, GroupClass } from 'models/group';
  14 import { getCommonResourceServiceError, CommonResourceServiceError } from 'services/common-service/common-resource-service';
  15 import { snackbarActions, SnackbarKind } from 'store/snackbar/snackbar-actions';
  16 import { PermissionLevel } from 'models/permission';
  17 import { PermissionService } from 'services/permission-service/permission-service';
  18 import { FilterBuilder } from 'services/api/filter-builder';
  19 import { ProjectUpdateFormDialogData, PROJECT_UPDATE_FORM_NAME } from 'store/projects/project-update-actions';
  20
  21 export const GROUPS_PANEL_ID = "groupsPanel";
  22
  23 // Create group dialog
  24 export const CREATE_GROUP_DIALOG = "createGroupDialog";
  25 export const CREATE_GROUP_FORM = "createGroupForm";
  26 export const CREATE_GROUP_NAME_FIELD_NAME = 'name';
  27 export const CREATE_GROUP_USERS_FIELD_NAME = 'users';
  28
  29 export const GROUP_ATTRIBUTES_DIALOG = 'groupAttributesDialog';
  30 export const GROUP_REMOVE_DIALOG = 'groupRemoveDialog';
  31
  32 export const GroupsPanelActions = bindDataExplorerActions(GROUPS_PANEL_ID);
  33
  34 export const loadGroupsPanel = () => GroupsPanelActions.REQUEST_ITEMS();
  35
  36 export const openCreateGroupDialog = () =>
  37     (dispatch: Dispatch) => {
  38         dispatch(dialogActions.OPEN_DIALOG({ id: CREATE_GROUP_DIALOG, data: {} }));
  39         dispatch(reset(CREATE_GROUP_FORM));
  40     };
  41
  42 export const openGroupAttributes = (uuid: string) =>
  43     (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  44         const { resources } = getState();
  45         const data = getResource<GroupResource>(uuid)(resources);
  46         dispatch(dialogActions.OPEN_DIALOG({ id: GROUP_ATTRIBUTES_DIALOG, data }));
  47     };
  48
  49 export const removeGroup = (uuid: string) =>
  50     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  51         dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Removing ...', kind: SnackbarKind.INFO }));
  52         await services.groupsService.delete(uuid);
  53         dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Removed.', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
  54         dispatch<any>(loadGroupsPanel());
  55     };
  56
  57 export const openRemoveGroupDialog = (uuid: string) =>
  58     (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  59         dispatch(dialogActions.OPEN_DIALOG({
  60             id: GROUP_REMOVE_DIALOG,
  61             data: {
  62                 title: 'Remove group',
  63                 text: 'Are you sure you want to remove this group?',
  64                 confirmButtonLabel: 'Remove',
  65                 uuid
  66             }
  67         }));
  68     };
  69
  70 // Group edit dialog uses project update dialog with sourcePanel set to reload the appropriate parts
  71 export const openGroupUpdateDialog = (resource: ProjectUpdateFormDialogData) =>
  72     (dispatch: Dispatch, getState: () => RootState) => {
  73         dispatch(initialize(PROJECT_UPDATE_FORM_NAME, resource));
  74         dispatch(dialogActions.OPEN_DIALOG({ id: PROJECT_UPDATE_FORM_NAME, data: {sourcePanel: GroupClass.ROLE} }));
  75     };
  76
  77 export const updateGroup = (project: ProjectUpdateFormDialogData) =>
  78     async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
  79         const uuid = project.uuid || '';
  80         dispatch(startSubmit(PROJECT_UPDATE_FORM_NAME));
  81         try {
  82             const updatedGroup = await services.groupsService.update(uuid, { name: project.name, description: project.description });
  83             dispatch(GroupsPanelActions.REQUEST_ITEMS());
  84             dispatch(reset(PROJECT_UPDATE_FORM_NAME));
  85             dispatch(dialogActions.CLOSE_DIALOG({ id: PROJECT_UPDATE_FORM_NAME }));
  86             return updatedGroup;
  87         } catch (e) {
  88             const error = getCommonResourceServiceError(e);
  89             if (error === CommonResourceServiceError.UNIQUE_NAME_VIOLATION) {
  90                 dispatch(stopSubmit(PROJECT_UPDATE_FORM_NAME, { name: 'Group with the same name already exists.' } as FormErrors));
  91             }
  92             return ;
  93         }
  94     };
  95
  96 export interface CreateGroupFormData {
  97     [CREATE_GROUP_NAME_FIELD_NAME]: string;
  98     [CREATE_GROUP_USERS_FIELD_NAME]?: Participant[];
  99 }
 100
 101 export const createGroup = ({ name, users = [] }: CreateGroupFormData) =>
 102     async (dispatch: Dispatch, _: {}, { groupsService, permissionService }: ServiceRepository) => {
 103         dispatch(startSubmit(CREATE_GROUP_FORM));
 104         try {
 105             const newGroup = await groupsService.create({ name, groupClass: GroupClass.ROLE });
 106             for (const user of users) {
 107                 await addGroupMember({
 108                     user,
 109                     group: newGroup,
 110                     dispatch,
 111                     permissionService,
 112                 });
 113             }
 114             dispatch(dialogActions.CLOSE_DIALOG({ id: CREATE_GROUP_DIALOG }));
 115             dispatch(reset(CREATE_GROUP_FORM));
 116             dispatch(loadGroupsPanel());
 117             dispatch(snackbarActions.OPEN_SNACKBAR({
 118                 message: `${newGroup.name} group has been created`,
 119                 kind: SnackbarKind.SUCCESS
 120             }));
 121             return newGroup;
 122         } catch (e) {
 123             const error = getCommonResourceServiceError(e);
 124             if (error === CommonResourceServiceError.UNIQUE_NAME_VIOLATION) {
 125                 dispatch(stopSubmit(CREATE_GROUP_FORM, { name: 'Group with the same name already exists.' } as FormErrors));
 126             }
 127             return;
 128         }
 129     };
 130
 131 interface AddGroupMemberArgs {
 132     user: { uuid: string, name: string };
 133     group: { uuid: string, name: string };
 134     dispatch: Dispatch;
 135     permissionService: PermissionService;
 136 }
 137
 138 /**
 139  * Group membership is determined by whether the group has can_read permission on an object.
 140  * If a group G can_read an object A, then we say A is a member of G.
 141  *
 142  * [Permission model docs](https://doc.arvados.org/api/permission-model.html)
 143  */
 144 export const addGroupMember = async ({ user, group, ...args }: AddGroupMemberArgs) => {
 145     await createPermission({
 146         head: { ...group },
 147         tail: { ...user },
 148         permissionLevel: PermissionLevel.CAN_READ,
 149         ...args,
 150     });
 151 };
 152
 153 interface CreatePermissionLinkArgs {
 154     head: { uuid: string, name: string };
 155     tail: { uuid: string, name: string };
 156     permissionLevel: PermissionLevel;
 157     dispatch: Dispatch;
 158     permissionService: PermissionService;
 159 }
 160
 161 const createPermission = async ({ head, tail, permissionLevel, dispatch, permissionService }: CreatePermissionLinkArgs) => {
 162     try {
 163         await permissionService.create({
 164             tailUuid: tail.uuid,
 165             headUuid: head.uuid,
 166             name: permissionLevel,
 167         });
 168     } catch (e) {
 169         dispatch(snackbarActions.OPEN_SNACKBAR({
 170             message: `Could not add ${tail.name} -> ${head.name} relation`,
 171             kind: SnackbarKind.ERROR,
 172         }));
 173     }
 174 };
 175
 176 interface DeleteGroupMemberArgs {
 177     link: { uuid: string };
 178     dispatch: Dispatch;
 179     permissionService: PermissionService;
 180 }
 181
 182 export const deleteGroupMember = async ({ link, ...args }: DeleteGroupMemberArgs) => {
 183     await deletePermission({
 184         uuid: link.uuid,
 185         ...args,
 186     });
 187 };
 188
 189 interface DeletePermissionLinkArgs {
 190     uuid: string;
 191     dispatch: Dispatch;
 192     permissionService: PermissionService;
 193 }
 194
 195 export const deletePermission = async ({ uuid, dispatch, permissionService }: DeletePermissionLinkArgs) => {
 196     try {
 197         const permissionsResponse = await permissionService.list({
 198             filters: new FilterBuilder()
 199                 .addEqual('uuid', uuid)
 200                 .getFilters()
 201         });
 202         const [permission] = permissionsResponse.items;
 203         if (permission) {
 204             await permissionService.delete(permission.uuid);
 205         } else {
 206             throw new Error('Permission not found');
 207         }
 208     } catch (e) {
 209         dispatch(snackbarActions.OPEN_SNACKBAR({
 210             message: `Could not delete ${uuid} permission`,
 211             kind: SnackbarKind.ERROR,
 212         }));
 213     }
 214 };