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