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