src/store/advanced-tab/advanced-tab.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { dialogActions } from '~/store/dialog/dialog-actions';
   6 import { RootState } from '~/store/store';
   7 import { Dispatch } from 'redux';
   8 import { ResourceKind, extractUuidKind } from '~/models/resource';
   9 import { getResource } from '~/store/resources/resources';
  10 import { GroupContentsResourcePrefix } from '~/services/groups-service/groups-service';
  11 import { snackbarActions, SnackbarKind } from '~/store/snackbar/snackbar-actions';
  12 import { ContainerRequestResource } from '~/models/container-request';
  13 import { CollectionResource } from '~/models/collection';
  14 import { ProjectResource } from '~/models/project';
  15 import { ServiceRepository } from '~/services/services';
  16 import { FilterBuilder } from '~/services/api/filter-builder';
  17 import { RepositoryResource } from '~/models/repositories';
  18 import { SshKeyResource } from '../../models/ssh-key';
  19
  20 export const ADVANCED_TAB_DIALOG = 'advancedTabDialog';
  21
  22 interface AdvancedTabDialogData {
  23     apiResponse: any;
  24     metadata: any;
  25     user: string;
  26     pythonHeader: string;
  27     pythonExample: string;
  28     cliGetHeader: string;
  29     cliGetExample: string;
  30     cliUpdateHeader: string;
  31     cliUpdateExample: string;
  32     curlHeader: string;
  33     curlExample: string;
  34 }
  35
  36 enum CollectionData {
  37     COLLECTION = 'collection',
  38     STORAGE_CLASSES_CONFIRMED = 'storage_classes_confirmed'
  39 }
  40
  41 enum ProcessData {
  42     CONTAINER_REQUEST = 'container_request',
  43     OUTPUT_NAME = 'output_name'
  44 }
  45
  46 enum ProjectData {
  47     GROUP = 'group',
  48     DELETE_AT = 'delete_at'
  49 }
  50
  51 enum RepositoryData {
  52     REPOSITORY = 'repository',
  53     CREATED_AT = 'created_at'
  54 }
  55
  56 enum SshKeyData {
  57     SSH_KEY = 'authorized_keys',
  58     CREATED_AT = 'created_at'
  59 }
  60
  61 export const openAdvancedTabDialog = (uuid: string, index?: number) =>
  62     (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
  63         const kind = extractUuidKind(uuid);
  64         switch (kind) {
  65             case ResourceKind.COLLECTION:
  66                 const { data: dataCollection, metadata: metaCollection, user: userCollection } = dispatch<any>(getDataForAdvancedTab(uuid));
  67                 const advanceDataCollection: AdvancedTabDialogData = advancedTabData(uuid, metaCollection, userCollection, collectionApiResponse, dataCollection, CollectionData.COLLECTION, GroupContentsResourcePrefix.COLLECTION, CollectionData.STORAGE_CLASSES_CONFIRMED, dataCollection.storageClassesConfirmed);
  68                 dispatch<any>(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: advanceDataCollection }));
  69                 break;
  70             case ResourceKind.PROCESS:
  71                 const { data: dataProcess, metadata: metaProcess, user: userProcess } = dispatch<any>(getDataForAdvancedTab(uuid));
  72                 const advancedDataProcess: AdvancedTabDialogData = advancedTabData(uuid, metaProcess, userProcess, containerRequestApiResponse, dataProcess, ProcessData.CONTAINER_REQUEST, GroupContentsResourcePrefix.PROCESS, ProcessData.OUTPUT_NAME, dataProcess.outputName);
  73                 dispatch<any>(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: advancedDataProcess }));
  74                 break;
  75             case ResourceKind.PROJECT:
  76                 const { data: dataProject, metadata: metaProject, user: userProject } = dispatch<any>(getDataForAdvancedTab(uuid));
  77                 const advanceDataProject: AdvancedTabDialogData = advancedTabData(uuid, metaProject, userProject, groupRequestApiResponse, dataProject, ProjectData.GROUP, GroupContentsResourcePrefix.PROJECT, ProjectData.DELETE_AT, dataProject.deleteAt);
  78                 dispatch<any>(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: advanceDataProject }));
  79                 break;
  80             case ResourceKind.REPOSITORY:
  81                 const dataRepository = getState().repositories.items[index!];
  82                 const advanceDataRepository: AdvancedTabDialogData = advancedTabData(uuid, '', '', repositoryApiResponse, dataRepository, RepositoryData.REPOSITORY, 'repositories', RepositoryData.CREATED_AT, dataRepository.createdAt);
  83                 dispatch<any>(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: advanceDataRepository }));
  84                 break;
  85             case ResourceKind.SSH_KEY:
  86                 const dataSshKey = getState().auth.sshKeys[index!];
  87                 const advanceDataSshKey: AdvancedTabDialogData = advancedTabData(uuid, '', '', sshKeyApiResponse, dataSshKey, SshKeyData.SSH_KEY, 'authorized_keys', SshKeyData.CREATED_AT, dataSshKey.createdAt);
  88                 dispatch<any>(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: advanceDataSshKey }));
  89                 break;
  90             default:
  91                 dispatch(snackbarActions.OPEN_SNACKBAR({ message: "Could not open advanced tab for this resource.", hideDuration: 2000, kind: SnackbarKind.ERROR }));
  92         }
  93     };
  94
  95 const getDataForAdvancedTab = (uuid: string) =>
  96     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
  97         const { resources } = getState();
  98         const data = getResource<any>(uuid)(resources);
  99         const metadata = await services.linkService.list({
 100             filters: new FilterBuilder()
 101                 .addEqual('headUuid', uuid)
 102                 .getFilters()
 103         });
 104         const user = metadata.itemsAvailable && await services.userService.get(metadata.items[0].tailUuid);
 105         return { data, metadata, user };
 106     };
 107
 108 type AdvanceResourceKind = CollectionData | ProcessData | ProjectData | RepositoryData | SshKeyData;
 109 type AdvanceResourcePrefix = GroupContentsResourcePrefix | 'repositories' | 'authorized_keys';
 110
 111 const advancedTabData = (uuid: string, metadata: any, user: any, apiResponseKind: any, data: any, resourceKind: AdvanceResourceKind, resourcePrefix: AdvanceResourcePrefix, resourceKindProperty: AdvanceResourceKind, property: any) => {
 112     return {
 113         uuid,
 114         user,
 115         metadata,
 116         apiResponse: apiResponseKind(data),
 117         pythonHeader: pythonHeader(resourceKind),
 118         pythonExample: pythonExample(uuid, resourcePrefix),
 119         cliGetHeader: cliGetHeader(resourceKind),
 120         cliGetExample: cliGetExample(uuid, resourceKind),
 121         cliUpdateHeader: cliUpdateHeader(resourceKind, resourceKindProperty),
 122         cliUpdateExample: cliUpdateExample(uuid, resourceKind, property, resourceKindProperty),
 123         curlHeader: curlHeader(resourceKind, resourceKindProperty),
 124         curlExample: curlExample(uuid, resourcePrefix, property, resourceKind, resourceKindProperty),
 125     };
 126 };
 127
 128 const pythonHeader = (resourceKind: string) =>
 129     `An example python command to get a ${resourceKind} using its uuid:`;
 130
 131 const pythonExample = (uuid: string, resourcePrefix: string) => {
 132     const pythonExample = `import arvados
 133
 134 x = arvados.api().${resourcePrefix}().get(uuid='${uuid}').execute()`;
 135
 136     return pythonExample;
 137 };
 138
 139 const cliGetHeader = (resourceKind: string) =>
 140     `An example arv command to get a ${resourceKind} using its uuid:`;
 141
 142 const cliGetExample = (uuid: string, resourceKind: string) => {
 143     const cliGetExample = `arv ${resourceKind} get \\
 144   --uuid ${uuid}`;
 145
 146     return cliGetExample;
 147 };
 148
 149 const cliUpdateHeader = (resourceKind: string, resourceName: string) =>
 150     `An example arv command to update the "${resourceName}" attribute for the current ${resourceKind}:`;
 151
 152 const cliUpdateExample = (uuid: string, resourceKind: string, resource: string | string[], resourceName: string) => {
 153     const CLIUpdateCollectionExample = `arv ${resourceKind} update \\
 154   --uuid ${uuid} \\
 155   --${resourceKind} '{"${resourceName}":${resource}}'`;
 156
 157     return CLIUpdateCollectionExample;
 158 };
 159
 160 const curlHeader = (resourceKind: string, resource: string) =>
 161     `An example curl command to update the "${resource}" attribute for the current ${resourceKind}:`;
 162
 163 const curlExample = (uuid: string, resourcePrefix: string, resource: string | string[], resourceKind: string, resourceName: string) => {
 164     const curlExample = `curl -X PUT \\
 165   -H "Authorization: OAuth2 $ARVADOS_API_TOKEN" \\
 166   --data-urlencode ${resourceKind}@/dev/stdin \\
 167   https://$ARVADOS_API_HOST/arvados/v1/${resourcePrefix}/${uuid} \\
 168   <<EOF
 169 {
 170   "${resourceName}": ${resource}
 171 }
 172 EOF`;
 173
 174     return curlExample;
 175 };
 176
 177 const stringify = (item: string | null | number | boolean) =>
 178     JSON.stringify(item) || 'null';
 179
 180 const stringifyObject = (item: any) =>
 181     JSON.stringify(item, null, 2) || 'null';
 182
 183 const containerRequestApiResponse = (apiResponse: ContainerRequestResource) => {
 184     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, state, requestingContainerUuid, containerUuid,
 185         containerCountMax, mounts, runtimeConstraints, containerImage, environment, cwd, command, outputPath, priority, expiresAt, filters, containerCount,
 186         useExisting, schedulingParameters, outputUuid, logUuid, outputName, outputTtl } = apiResponse;
 187     const response = `"uuid": "${uuid}",
 188 "owner_uuid": "${ownerUuid}",
 189 "created_at": "${createdAt}",
 190 "modified_at": ${stringify(modifiedAt)},
 191 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 192 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 193 "name": ${stringify(name)},
 194 "description": ${stringify(description)},
 195 "properties": ${stringifyObject(properties)},
 196 "state": ${stringify(state)},
 197 "requesting_container_uuid": ${stringify(requestingContainerUuid)},
 198 "container_uuid": ${stringify(containerUuid)},
 199 "container_count_max": ${stringify(containerCountMax)},
 200 "mounts": ${stringifyObject(mounts)},
 201 "runtime_constraints": ${stringifyObject(runtimeConstraints)},
 202 "container_image": "${stringify(containerImage)}",
 203 "environment": ${stringifyObject(environment)},
 204 "cwd": ${stringify(cwd)},
 205 "command": ${stringifyObject(command)},
 206 "output_path": ${stringify(outputPath)},
 207 "priority": ${stringify(priority)},
 208 "expires_at": ${stringify(expiresAt)},
 209 "filters": ${stringify(filters)},
 210 "container_count": ${stringify(containerCount)},
 211 "use_existing": ${stringify(useExisting)},
 212 "scheduling_parameters": ${stringifyObject(schedulingParameters)},
 213 "output_uuid": ${stringify(outputUuid)},
 214 "log_uuid": ${stringify(logUuid)},
 215 "output_name": ${stringify(outputName)},
 216 "output_ttl": ${stringify(outputTtl)}`;
 217
 218     return response;
 219 };
 220
 221 const collectionApiResponse = (apiResponse: CollectionResource) => {
 222     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, portableDataHash, replicationDesired,
 223         replicationConfirmedAt, replicationConfirmed, manifestText, deleteAt, trashAt, isTrashed, storageClassesDesired,
 224         storageClassesConfirmed, storageClassesConfirmedAt } = apiResponse;
 225     const response = `"uuid": "${uuid}",
 226 "owner_uuid": "${ownerUuid}",
 227 "created_at": "${createdAt}",
 228 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 229 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 230 "modified_at": ${stringify(modifiedAt)},
 231 "portable_data_hash": ${stringify(portableDataHash)},
 232 "replication_desired": ${stringify(replicationDesired)},
 233 "replication_confirmed_at": ${stringify(replicationConfirmedAt)},
 234 "replication_confirmed": ${stringify(replicationConfirmed)},
 235 "manifest_text": ${stringify(manifestText)},
 236 "name": ${stringify(name)},
 237 "description": ${stringify(description)},
 238 "properties": ${stringifyObject(properties)},
 239 "delete_at": ${stringify(deleteAt)},
 240 "trash_at": ${stringify(trashAt)},
 241 "is_trashed": ${stringify(isTrashed)},
 242 "storage_classes_desired": ${JSON.stringify(storageClassesDesired, null, 2)},
 243 "storage_classes_confirmed": ${JSON.stringify(storageClassesConfirmed, null, 2)},
 244 "storage_classes_confirmed_at": ${stringify(storageClassesConfirmedAt)}`;
 245
 246     return response;
 247 };
 248
 249 const groupRequestApiResponse = (apiResponse: ProjectResource) => {
 250     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, groupClass, trashAt, isTrashed, deleteAt, properties } = apiResponse;
 251     const response = `"uuid": "${uuid}",
 252 "owner_uuid": "${ownerUuid}",
 253 "created_at": "${createdAt}",
 254 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 255 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 256 "modified_at": ${stringify(modifiedAt)},
 257 "name": ${stringify(name)},
 258 "description": ${stringify(description)},
 259 "group_class": ${stringify(groupClass)},
 260 "trash_at": ${stringify(trashAt)},
 261 "is_trashed": ${stringify(isTrashed)},
 262 "delete_at": ${stringify(deleteAt)},
 263 "properties": ${stringifyObject(properties)}`;
 264
 265     return response;
 266 };
 267
 268 const repositoryApiResponse = (apiResponse: RepositoryResource) => {
 269     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name } = apiResponse;
 270     const response = `"uuid": "${uuid}",
 271 "owner_uuid": "${ownerUuid}",
 272 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 273 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 274 "modified_at": ${stringify(modifiedAt)},
 275 "name": ${stringify(name)},
 276 "created_at": "${createdAt}"`;
 277
 278     return response;
 279 };
 280
 281 const sshKeyApiResponse = (apiResponse: SshKeyResource) => {
 282     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, authorizedUserUuid, expiresAt } = apiResponse;
 283     const response = `"uuid": "${uuid}",
 284 "owner_uuid": "${ownerUuid}",
 285 "authorized_user_uuid": "${authorizedUserUuid}",
 286 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 287 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 288 "modified_at": ${stringify(modifiedAt)},
 289 "name": ${stringify(name)},
 290 "created_at": "${createdAt}",
 291 "expires_at": "${expiresAt}"`;
 292     return response;
 293 };