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