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
  18 export const ADVANCED_TAB_DIALOG = 'advancedTabDialog';
  19
  20 export interface AdvancedTabDialogData {
  21     apiResponse: any;
  22     metadata: any;
  23     uuid: string;
  24     pythonHeader: string;
  25     pythonExample: string;
  26     cliGetHeader: string;
  27     cliGetExample: string;
  28     cliUpdateHeader: string;
  29     cliUpdateExample: string;
  30     curlHeader: string;
  31     curlExample: string;
  32 }
  33
  34 enum CollectionData {
  35     COLLECTION = 'collection',
  36     STORAGE_CLASSES_CONFIRMED = 'storage_classes_confirmed'
  37 }
  38
  39 enum ProcessData {
  40     CONTAINER_REQUEST = 'container_request',
  41     OUTPUT_NAME = 'output_name'
  42 }
  43
  44 enum ProjectData {
  45     GROUP = 'group',
  46     DELETE_AT = 'delete_at'
  47 }
  48
  49 export const openAdvancedTabDialog = (uuid: string) =>
  50     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
  51         const { resources } = getState();
  52         const kind = extractUuidKind(uuid);
  53         const data = getResource<any>(uuid)(resources);
  54         const user = await services.userService.get(data.ownerUuid);
  55         const metadata = await services.linkService.list({
  56             filters: new FilterBuilder()
  57                 .addEqual('headUuid', uuid)
  58                 .getFilters()
  59         });
  60         if (data) {
  61             if (kind === ResourceKind.COLLECTION) {
  62                 const dataCollection: AdvancedTabDialogData = advancedTabData(uuid, metadata, user, collectionApiResponse, data, CollectionData.COLLECTION, GroupContentsResourcePrefix.COLLECTION, CollectionData.STORAGE_CLASSES_CONFIRMED, data.storageClassesConfirmed);
  63                 dispatch(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: dataCollection }));
  64             } else if (kind === ResourceKind.PROCESS) {
  65                 const dataProcess: AdvancedTabDialogData = advancedTabData(uuid, metadata, user, containerRequestApiResponse, data, ProcessData.CONTAINER_REQUEST, GroupContentsResourcePrefix.PROCESS, ProcessData.OUTPUT_NAME, data.outputName);
  66                 dispatch(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: dataProcess }));
  67             } else if (kind === ResourceKind.PROJECT) {
  68                 const dataProject: AdvancedTabDialogData = advancedTabData(uuid, metadata, user, groupRequestApiResponse, data, ProjectData.GROUP, GroupContentsResourcePrefix.PROJECT, ProjectData.DELETE_AT, data.deleteAt);
  69                 dispatch(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: dataProject }));
  70             }
  71         } else {
  72             dispatch(snackbarActions.OPEN_SNACKBAR({ message: "Could not open advanced tab for this resource.", hideDuration: 2000, kind: SnackbarKind.ERROR }));
  73         }
  74     };
  75
  76 const advancedTabData = (uuid: string, metadata: any, user: any, apiResponseKind: any, data: any, resourceKind: CollectionData | ProcessData | ProjectData, resourcePrefix: GroupContentsResourcePrefix, resourceKindProperty: CollectionData | ProcessData | ProjectData, property: any) => {
  77     return {
  78         uuid,
  79         user,
  80         metadata,
  81         apiResponse: apiResponseKind(data),
  82         pythonHeader: pythonHeader(resourceKind),
  83         pythonExample: pythonExample(uuid, resourcePrefix),
  84         cliGetHeader: cliGetHeader(resourceKind),
  85         cliGetExample: cliGetExample(uuid, resourcePrefix),
  86         cliUpdateHeader: cliUpdateHeader(resourceKind, resourceKindProperty),
  87         cliUpdateExample: cliUpdateExample(uuid, resourceKind, property, resourceKind),
  88         curlHeader: curlHeader(resourceKind, resourceKindProperty),
  89         curlExample: curlExample(uuid, resourcePrefix, property, resourceKind, resourceKindProperty),
  90     };
  91 };
  92
  93 const pythonHeader = (resourceKind: string) =>
  94     `An example python command to get a ${resourceKind} using its uuid:`;
  95
  96 const pythonExample = (uuid: string, resourcePrefix: string) => {
  97     const pythonExample = `import arvados
  98
  99  x = arvados.api().${resourcePrefix}().get(uuid='${uuid}').execute()`;
 100
 101     return pythonExample;
 102 };
 103
 104 const cliGetHeader = (resourceKind: string) =>
 105     `An example arv command to get a ${resourceKind} using its uuid:`;
 106
 107 const cliGetExample = (uuid: string, resourcePrefix: string) => {
 108     const cliGetExample = `arv ${resourcePrefix} get \\
 109  --uuid ${uuid}`;
 110
 111     return cliGetExample;
 112 };
 113
 114 const cliUpdateHeader = (resourceKind: string, resourceName: string) =>
 115     `An example arv command to update the "${resourceName}" attribute for the current ${resourceKind}:`;
 116
 117 const cliUpdateExample = (uuid: string, resourceKind: string, resource: string | string[], resourceName: string) => {
 118     const CLIUpdateCollectionExample = `arv ${resourceKind} update \\
 119  --uuid ${uuid} \\
 120  --${resourceKind} '{"${resourceName}":${resource}}'`;
 121
 122     return CLIUpdateCollectionExample;
 123 };
 124
 125 const curlHeader = (resourceKind: string, resource: string) =>
 126     `An example curl command to update the "${resource}" attribute for the current ${resourceKind}:`;
 127
 128 const curlExample = (uuid: string, resourcePrefix: string, resource: string | string[], resourceKind: string, resourceName: string) => {
 129     const curlExample = `curl -X PUT \\
 130  -H "Authorization: OAuth2 $ARVADOS_API_TOKEN" \\
 131  --data-urlencode ${resourceKind}@/dev/stdin \\
 132  https://$ARVADOS_API_HOST/arvados/v1/${resourcePrefix}/${uuid} \\
 133  <<EOF
 134 {
 135   "${resourceName}": ${resource}
 136 }
 137 EOF`;
 138
 139     return curlExample;
 140 };
 141
 142 const stringify = (item: string | null | number | boolean) =>
 143     JSON.stringify(item) || 'null';
 144
 145 const stringifyObject = (item: any) =>
 146     JSON.stringify(item, null, 2) || 'null';
 147
 148 const containerRequestApiResponse = (apiResponse: ContainerRequestResource) => {
 149     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, state, requestingContainerUuid, containerUuid,
 150         containerCountMax, mounts, runtimeConstraints, containerImage, environment, cwd, command, outputPath, priority, expiresAt, filters, containerCount,
 151         useExisting, schedulingParameters, outputUuid, logUuid, outputName, outputTtl } = apiResponse;
 152     const response = `"uuid": "${uuid}",
 153 "owner_uuid": "${ownerUuid}",
 154 "created_at": "${createdAt}",
 155 "modified_at": ${stringify(modifiedAt)},
 156 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 157 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 158 "name": ${stringify(name)},
 159 "description": ${stringify(description)},
 160 "properties": ${stringifyObject(properties)},
 161 "state": ${stringify(state)},
 162 "requesting_container_uuid": ${stringify(requestingContainerUuid)},
 163 "container_uuid": ${stringify(containerUuid)},
 164 "container_count_max": ${stringify(containerCountMax)},
 165 "mounts": ${stringifyObject(mounts)},
 166 "runtime_constraints": ${stringifyObject(runtimeConstraints)},
 167 "container_image": "${stringify(containerImage)}",
 168 "environment": ${stringifyObject(environment)},
 169 "cwd": ${stringify(cwd)},
 170 "command": ${stringifyObject(command)},
 171 "output_path": ${stringify(outputPath)},
 172 "priority": ${stringify(priority)},
 173 "expires_at": ${stringify(expiresAt)},
 174 "filters": ${stringify(filters)},
 175 "container_count": ${stringify(containerCount)},
 176 "use_existing": ${stringify(useExisting)},
 177 "scheduling_parameters": ${stringifyObject(schedulingParameters)},
 178 "output_uuid": ${stringify(outputUuid)},
 179 "log_uuid": ${stringify(logUuid)},
 180 "output_name": ${stringify(outputName)},
 181 "output_ttl": ${stringify(outputTtl)}`;
 182
 183     return response;
 184 };
 185
 186 const collectionApiResponse = (apiResponse: CollectionResource) => {
 187     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, portableDataHash, replicationDesired,
 188         replicationConfirmedAt, replicationConfirmed, manifestText, deleteAt, trashAt, isTrashed, storageClassesDesired,
 189         storageClassesConfirmed, storageClassesConfirmedAt } = apiResponse;
 190     const response = `"uuid": "${uuid}",
 191 "owner_uuid": "${ownerUuid}",
 192 "created_at": "${createdAt}",
 193 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 194 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 195 "modified_at": ${stringify(modifiedAt)},
 196 "portable_data_hash": ${stringify(portableDataHash)},
 197 "replication_desired": ${stringify(replicationDesired)},
 198 "replication_confirmed_at": ${stringify(replicationConfirmedAt)},
 199 "replication_confirmed": ${stringify(replicationConfirmed)},
 200 "manifest_text": ${stringify(manifestText)},
 201 "name": ${stringify(name)},
 202 "description": ${stringify(description)},
 203 "properties": ${stringifyObject(properties)},
 204 "delete_at": ${stringify(deleteAt)},
 205 "trash_at": ${stringify(trashAt)},
 206 "is_trashed": ${stringify(isTrashed)},
 207 "storage_classes_desired": ${JSON.stringify(storageClassesDesired, null, 2)},
 208 "storage_classes_confirmed": ${JSON.stringify(storageClassesConfirmed, null, 2)},
 209 "storage_classes_confirmed_at": ${stringify(storageClassesConfirmedAt)}`;
 210
 211     return response;
 212 };
 213
 214 const groupRequestApiResponse = (apiResponse: ProjectResource) => {
 215     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, groupClass, trashAt, isTrashed, deleteAt, properties } = apiResponse;
 216     const response = `"uuid": "${uuid}",
 217 "owner_uuid": "${ownerUuid}",
 218 "created_at": "${createdAt}",
 219 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 220 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 221 "modified_at": ${stringify(modifiedAt)},
 222 "name": ${stringify(name)},
 223 "description": ${stringify(description)},
 224 "group_class": ${stringify(groupClass)},
 225 "trash_at": ${stringify(trashAt)},
 226 "is_trashed": ${stringify(isTrashed)},
 227 "delete_at": ${stringify(deleteAt)},
 228 "properties": ${stringifyObject(properties)}`;
 229
 230     return response;
 231 };