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 import { VirtualMachinesResource } from '~/models/virtual-machines';
  20 import { UserResource } from '~/models/user';
  21 import { ListResults } from '~/services/common-service/common-resource-service';
  22 import { LinkResource } from '~/models/link';
  23 import { KeepServiceResource } from '~/models/keep-services';
  24 import { NodeResource } from '~/models/node';
  25
  26 export const ADVANCED_TAB_DIALOG = 'advancedTabDialog';
  27
  28 interface AdvancedTabDialogData {
  29     apiResponse: any;
  30     metadata: ListResults<LinkResource> | string;
  31     user: UserResource | string;
  32     pythonHeader: string;
  33     pythonExample: string;
  34     cliGetHeader: string;
  35     cliGetExample: string;
  36     cliUpdateHeader: string;
  37     cliUpdateExample: string;
  38     curlHeader: string;
  39     curlExample: string;
  40 }
  41
  42 enum CollectionData {
  43     COLLECTION = 'collection',
  44     STORAGE_CLASSES_CONFIRMED = 'storage_classes_confirmed'
  45 }
  46
  47 enum ProcessData {
  48     CONTAINER_REQUEST = 'container_request',
  49     OUTPUT_NAME = 'output_name'
  50 }
  51
  52 enum ProjectData {
  53     GROUP = 'group',
  54     DELETE_AT = 'delete_at'
  55 }
  56
  57 enum RepositoryData {
  58     REPOSITORY = 'repository',
  59     CREATED_AT = 'created_at'
  60 }
  61
  62 enum SshKeyData {
  63     SSH_KEY = 'authorized_key',
  64     CREATED_AT = 'created_at'
  65 }
  66
  67 enum VirtualMachineData {
  68     VIRTUAL_MACHINE = 'virtual_machine',
  69     CREATED_AT = 'created_at'
  70 }
  71
  72 enum ResourcePrefix {
  73     REPOSITORIES = 'repositories',
  74     AUTORIZED_KEYS = 'authorized_keys',
  75     VIRTUAL_MACHINES = 'virtual_machines',
  76     KEEP_SERVICES = 'keep_services',
  77     COMPUTE_NODES = 'nodes'
  78 }
  79
  80 enum KeepServiceData {
  81     KEEP_SERVICE = 'keep_services',
  82     CREATED_AT = 'created_at'
  83 }
  84
  85 enum ComputeNodeData {
  86     COMPUTE_NODE = 'node',
  87     PROPERTIES = 'properties'
  88 }
  89
  90 type AdvanceResourceKind = CollectionData | ProcessData | ProjectData | RepositoryData | SshKeyData | VirtualMachineData | KeepServiceData | ComputeNodeData;
  91 type AdvanceResourcePrefix = GroupContentsResourcePrefix | ResourcePrefix;
  92 type AdvanceResponseData = ContainerRequestResource | ProjectResource | CollectionResource | RepositoryResource | SshKeyResource | VirtualMachinesResource | KeepServiceResource | NodeResource | undefined;
  93
  94 export const openAdvancedTabDialog = (uuid: string) =>
  95     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
  96         const kind = extractUuidKind(uuid);
  97         switch (kind) {
  98             case ResourceKind.COLLECTION:
  99                 const { data: dataCollection, metadata: metaCollection, user: userCollection } = await dispatch<any>(getDataForAdvancedTab(uuid));
 100                 const advanceDataCollection = advancedTabData({
 101                     uuid,
 102                     metadata: metaCollection,
 103                     user: userCollection,
 104                     apiResponseKind: collectionApiResponse,
 105                     data: dataCollection,
 106                     resourceKind: CollectionData.COLLECTION,
 107                     resourcePrefix: GroupContentsResourcePrefix.COLLECTION,
 108                     resourceKindProperty: CollectionData.STORAGE_CLASSES_CONFIRMED,
 109                     property: dataCollection.storageClassesConfirmed
 110                 });
 111                 dispatch<any>(initAdvancedTabDialog(advanceDataCollection));
 112                 break;
 113             case ResourceKind.PROCESS:
 114                 const { data: dataProcess, metadata: metaProcess, user: userProcess } = await dispatch<any>(getDataForAdvancedTab(uuid));
 115                 const advancedDataProcess = advancedTabData({
 116                     uuid,
 117                     metadata: metaProcess,
 118                     user: userProcess,
 119                     apiResponseKind: containerRequestApiResponse,
 120                     data: dataProcess,
 121                     resourceKind: ProcessData.CONTAINER_REQUEST,
 122                     resourcePrefix: GroupContentsResourcePrefix.PROCESS,
 123                     resourceKindProperty: ProcessData.OUTPUT_NAME,
 124                     property: dataProcess.outputName
 125                 });
 126                 dispatch<any>(initAdvancedTabDialog(advancedDataProcess));
 127                 break;
 128             case ResourceKind.PROJECT:
 129                 const { data: dataProject, metadata: metaProject, user: userProject } = await dispatch<any>(getDataForAdvancedTab(uuid));
 130                 const advanceDataProject = advancedTabData({
 131                     uuid,
 132                     metadata: metaProject,
 133                     user: userProject,
 134                     apiResponseKind: groupRequestApiResponse,
 135                     data: dataProject,
 136                     resourceKind: ProjectData.GROUP,
 137                     resourcePrefix: GroupContentsResourcePrefix.PROJECT,
 138                     resourceKindProperty: ProjectData.DELETE_AT,
 139                     property: dataProject.deleteAt
 140                 });
 141                 dispatch<any>(initAdvancedTabDialog(advanceDataProject));
 142                 break;
 143             case ResourceKind.REPOSITORY:
 144                 const dataRepository = getState().repositories.items.find(it => it.uuid === uuid);
 145                 const advanceDataRepository = advancedTabData({
 146                     uuid,
 147                     metadata: '',
 148                     user: '',
 149                     apiResponseKind: repositoryApiResponse,
 150                     data: dataRepository,
 151                     resourceKind: RepositoryData.REPOSITORY,
 152                     resourcePrefix: ResourcePrefix.REPOSITORIES,
 153                     resourceKindProperty: RepositoryData.CREATED_AT,
 154                     property: dataRepository!.createdAt
 155                 });
 156                 dispatch<any>(initAdvancedTabDialog(advanceDataRepository));
 157                 break;
 158             case ResourceKind.SSH_KEY:
 159                 const dataSshKey = getState().auth.sshKeys.find(it => it.uuid === uuid);
 160                 const advanceDataSshKey = advancedTabData({
 161                     uuid,
 162                     metadata: '',
 163                     user: '',
 164                     apiResponseKind: sshKeyApiResponse,
 165                     data: dataSshKey,
 166                     resourceKind: SshKeyData.SSH_KEY,
 167                     resourcePrefix: ResourcePrefix.AUTORIZED_KEYS,
 168                     resourceKindProperty: SshKeyData.CREATED_AT,
 169                     property: dataSshKey!.createdAt
 170                 });
 171                 dispatch<any>(initAdvancedTabDialog(advanceDataSshKey));
 172                 break;
 173             case ResourceKind.VIRTUAL_MACHINE:
 174                 const dataVirtualMachine = getState().virtualMachines.virtualMachines.items.find(it => it.uuid === uuid);
 175                 const advanceDataVirtualMachine = advancedTabData({
 176                     uuid,
 177                     metadata: '',
 178                     user: '',
 179                     apiResponseKind: virtualMachineApiResponse,
 180                     data: dataVirtualMachine,
 181                     resourceKind: VirtualMachineData.VIRTUAL_MACHINE,
 182                     resourcePrefix: ResourcePrefix.VIRTUAL_MACHINES,
 183                     resourceKindProperty: VirtualMachineData.CREATED_AT,
 184                     property: dataVirtualMachine.createdAt
 185                 });
 186                 dispatch<any>(initAdvancedTabDialog(advanceDataVirtualMachine));
 187                 break;
 188             case ResourceKind.KEEP_SERVICE:
 189                 const dataKeepService = getState().keepServices.find(it => it.uuid === uuid);
 190                 const advanceDataKeepService = advancedTabData({
 191                     uuid,
 192                     metadata: '',
 193                     user: '',
 194                     apiResponseKind: keepServiceApiResponse,
 195                     data: dataKeepService,
 196                     resourceKind: KeepServiceData.KEEP_SERVICE,
 197                     resourcePrefix: ResourcePrefix.KEEP_SERVICES,
 198                     resourceKindProperty: KeepServiceData.CREATED_AT,
 199                     property: dataKeepService!.createdAt
 200                 });
 201                 dispatch<any>(initAdvancedTabDialog(advanceDataKeepService));
 202                 break;
 203             case ResourceKind.NODE:
 204                 const dataComputeNode = getState().computeNodes.find(node => node.uuid === uuid);
 205                 const advanceDataComputeNode = advancedTabData({
 206                     uuid,
 207                     metadata: '',
 208                     user: '',
 209                     apiResponseKind: computeNodeApiResponse,
 210                     data: dataComputeNode,
 211                     resourceKind: ComputeNodeData.COMPUTE_NODE,
 212                     resourcePrefix: ResourcePrefix.COMPUTE_NODES,
 213                     resourceKindProperty: ComputeNodeData.PROPERTIES,
 214                     property: dataComputeNode!.properties
 215                 });
 216                 dispatch<any>(initAdvancedTabDialog(advanceDataComputeNode));
 217                 break;
 218             default:
 219                 dispatch(snackbarActions.OPEN_SNACKBAR({ message: "Could not open advanced tab for this resource.", hideDuration: 2000, kind: SnackbarKind.ERROR }));
 220         }
 221     };
 222
 223 const getDataForAdvancedTab = (uuid: string) =>
 224     async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
 225         const { resources } = getState();
 226         const data = getResource<any>(uuid)(resources);
 227         const metadata = await services.linkService.list({
 228             filters: new FilterBuilder()
 229                 .addEqual('headUuid', uuid)
 230                 .getFilters()
 231         });
 232         const user = metadata.itemsAvailable && await services.userService.get(metadata.items[0].tailUuid || '');
 233         return { data, metadata, user };
 234     };
 235
 236 const initAdvancedTabDialog = (data: AdvancedTabDialogData) => dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data });
 237
 238 interface AdvancedTabData {
 239     uuid: string;
 240     metadata: ListResults<LinkResource> | string;
 241     user: UserResource | string;
 242     apiResponseKind: (apiResponse: AdvanceResponseData) => string;
 243     data: AdvanceResponseData;
 244     resourceKind: AdvanceResourceKind;
 245     resourcePrefix: AdvanceResourcePrefix;
 246     resourceKindProperty: AdvanceResourceKind;
 247     property: any;
 248 }
 249
 250 const advancedTabData = ({ uuid, user, metadata, apiResponseKind, data, resourceKind, resourcePrefix, resourceKindProperty, property }: AdvancedTabData) => {
 251     return {
 252         uuid,
 253         user,
 254         metadata,
 255         apiResponse: apiResponseKind(data),
 256         pythonHeader: pythonHeader(resourceKind),
 257         pythonExample: pythonExample(uuid, resourcePrefix),
 258         cliGetHeader: cliGetHeader(resourceKind),
 259         cliGetExample: cliGetExample(uuid, resourceKind),
 260         cliUpdateHeader: cliUpdateHeader(resourceKind, resourceKindProperty),
 261         cliUpdateExample: cliUpdateExample(uuid, resourceKind, property, resourceKindProperty),
 262         curlHeader: curlHeader(resourceKind, resourceKindProperty),
 263         curlExample: curlExample(uuid, resourcePrefix, property, resourceKind, resourceKindProperty),
 264     };
 265 };
 266
 267 const pythonHeader = (resourceKind: string) =>
 268     `An example python command to get a ${resourceKind} using its uuid:`;
 269
 270 const pythonExample = (uuid: string, resourcePrefix: string) => {
 271     const pythonExample = `import arvados
 272
 273 x = arvados.api().${resourcePrefix}().get(uuid='${uuid}').execute()`;
 274
 275     return pythonExample;
 276 };
 277
 278 const cliGetHeader = (resourceKind: string) =>
 279     `An example arv command to get a ${resourceKind} using its uuid:`;
 280
 281 const cliGetExample = (uuid: string, resourceKind: string) => {
 282     const cliGetExample = `arv ${resourceKind} get \\
 283   --uuid ${uuid}`;
 284
 285     return cliGetExample;
 286 };
 287
 288 const cliUpdateHeader = (resourceKind: string, resourceName: string) =>
 289     `An example arv command to update the "${resourceName}" attribute for the current ${resourceKind}:`;
 290
 291 const cliUpdateExample = (uuid: string, resourceKind: string, resource: string | string[], resourceName: string) => {
 292     const CLIUpdateCollectionExample = `arv ${resourceKind} update \\
 293   --uuid ${uuid} \\
 294   --${resourceKind} '{"${resourceName}":${JSON.stringify(resource)}}'`;
 295
 296     return CLIUpdateCollectionExample;
 297 };
 298
 299 const curlHeader = (resourceKind: string, resource: string) =>
 300     `An example curl command to update the "${resource}" attribute for the current ${resourceKind}:`;
 301
 302 const curlExample = (uuid: string, resourcePrefix: string, resource: string | string[], resourceKind: string, resourceName: string) => {
 303     const curlExample = `curl -X PUT \\
 304   -H "Authorization: OAuth2 $ARVADOS_API_TOKEN" \\
 305   --data-urlencode ${resourceKind}@/dev/stdin \\
 306   https://$ARVADOS_API_HOST/arvados/v1/${resourcePrefix}/${uuid} \\
 307   <<EOF
 308 {
 309   "${resourceName}": ${JSON.stringify(resource, null, 4)}
 310 }
 311 EOF`;
 312
 313     return curlExample;
 314 };
 315
 316 const stringify = (item: string | null | number | boolean) =>
 317     JSON.stringify(item) || 'null';
 318
 319 const stringifyObject = (item: any) =>
 320     JSON.stringify(item, null, 2) || 'null';
 321
 322 const containerRequestApiResponse = (apiResponse: ContainerRequestResource) => {
 323     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, state, requestingContainerUuid, containerUuid,
 324         containerCountMax, mounts, runtimeConstraints, containerImage, environment, cwd, command, outputPath, priority, expiresAt, filters, containerCount,
 325         useExisting, schedulingParameters, outputUuid, logUuid, outputName, outputTtl } = apiResponse;
 326     const response = `"uuid": "${uuid}",
 327 "owner_uuid": "${ownerUuid}",
 328 "created_at": "${createdAt}",
 329 "modified_at": ${stringify(modifiedAt)},
 330 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 331 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 332 "name": ${stringify(name)},
 333 "description": ${stringify(description)},
 334 "properties": ${stringifyObject(properties)},
 335 "state": ${stringify(state)},
 336 "requesting_container_uuid": ${stringify(requestingContainerUuid)},
 337 "container_uuid": ${stringify(containerUuid)},
 338 "container_count_max": ${stringify(containerCountMax)},
 339 "mounts": ${stringifyObject(mounts)},
 340 "runtime_constraints": ${stringifyObject(runtimeConstraints)},
 341 "container_image": "${stringify(containerImage)}",
 342 "environment": ${stringifyObject(environment)},
 343 "cwd": ${stringify(cwd)},
 344 "command": ${stringifyObject(command)},
 345 "output_path": ${stringify(outputPath)},
 346 "priority": ${stringify(priority)},
 347 "expires_at": ${stringify(expiresAt)},
 348 "filters": ${stringify(filters)},
 349 "container_count": ${stringify(containerCount)},
 350 "use_existing": ${stringify(useExisting)},
 351 "scheduling_parameters": ${stringifyObject(schedulingParameters)},
 352 "output_uuid": ${stringify(outputUuid)},
 353 "log_uuid": ${stringify(logUuid)},
 354 "output_name": ${stringify(outputName)},
 355 "output_ttl": ${stringify(outputTtl)}`;
 356
 357     return response;
 358 };
 359
 360 const collectionApiResponse = (apiResponse: CollectionResource) => {
 361     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, portableDataHash, replicationDesired,
 362         replicationConfirmedAt, replicationConfirmed, manifestText, deleteAt, trashAt, isTrashed, storageClassesDesired,
 363         storageClassesConfirmed, storageClassesConfirmedAt } = apiResponse;
 364     const response = `"uuid": "${uuid}",
 365 "owner_uuid": "${ownerUuid}",
 366 "created_at": "${createdAt}",
 367 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 368 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 369 "modified_at": ${stringify(modifiedAt)},
 370 "portable_data_hash": ${stringify(portableDataHash)},
 371 "replication_desired": ${stringify(replicationDesired)},
 372 "replication_confirmed_at": ${stringify(replicationConfirmedAt)},
 373 "replication_confirmed": ${stringify(replicationConfirmed)},
 374 "manifest_text": ${stringify(manifestText)},
 375 "name": ${stringify(name)},
 376 "description": ${stringify(description)},
 377 "properties": ${stringifyObject(properties)},
 378 "delete_at": ${stringify(deleteAt)},
 379 "trash_at": ${stringify(trashAt)},
 380 "is_trashed": ${stringify(isTrashed)},
 381 "storage_classes_desired": ${JSON.stringify(storageClassesDesired, null, 2)},
 382 "storage_classes_confirmed": ${JSON.stringify(storageClassesConfirmed, null, 2)},
 383 "storage_classes_confirmed_at": ${stringify(storageClassesConfirmedAt)}`;
 384
 385     return response;
 386 };
 387
 388 const groupRequestApiResponse = (apiResponse: ProjectResource) => {
 389     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, groupClass, trashAt, isTrashed, deleteAt, properties } = apiResponse;
 390     const response = `"uuid": "${uuid}",
 391 "owner_uuid": "${ownerUuid}",
 392 "created_at": "${createdAt}",
 393 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 394 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 395 "modified_at": ${stringify(modifiedAt)},
 396 "name": ${stringify(name)},
 397 "description": ${stringify(description)},
 398 "group_class": ${stringify(groupClass)},
 399 "trash_at": ${stringify(trashAt)},
 400 "is_trashed": ${stringify(isTrashed)},
 401 "delete_at": ${stringify(deleteAt)},
 402 "properties": ${stringifyObject(properties)}`;
 403
 404     return response;
 405 };
 406
 407 const repositoryApiResponse = (apiResponse: RepositoryResource) => {
 408     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name } = apiResponse;
 409     const response = `"uuid": "${uuid}",
 410 "owner_uuid": "${ownerUuid}",
 411 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 412 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 413 "modified_at": ${stringify(modifiedAt)},
 414 "name": ${stringify(name)},
 415 "created_at": "${createdAt}"`;
 416
 417     return response;
 418 };
 419
 420 const sshKeyApiResponse = (apiResponse: SshKeyResource) => {
 421     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, authorizedUserUuid, expiresAt } = apiResponse;
 422     const response = `"uuid": "${uuid}",
 423 "owner_uuid": "${ownerUuid}",
 424 "authorized_user_uuid": "${authorizedUserUuid}",
 425 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 426 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 427 "modified_at": ${stringify(modifiedAt)},
 428 "name": ${stringify(name)},
 429 "created_at": "${createdAt}",
 430 "expires_at": "${expiresAt}"`;
 431     return response;
 432 };
 433
 434 const virtualMachineApiResponse = (apiResponse: VirtualMachinesResource) => {
 435     const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, hostname } = apiResponse;
 436     const response = `"hostname": ${stringify(hostname)},
 437 "uuid": "${uuid}",
 438 "owner_uuid": "${ownerUuid}",
 439 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 440 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 441 "modified_at": ${stringify(modifiedAt)},
 442 "modified_at": ${stringify(modifiedAt)},
 443 "created_at": "${createdAt}"`;
 444
 445     return response;
 446 };
 447
 448 const keepServiceApiResponse = (apiResponse: KeepServiceResource) => {
 449     const {
 450         uuid, readOnly, serviceHost, servicePort, serviceSslFlag, serviceType,
 451         ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid
 452     } = apiResponse;
 453     const response = `"uuid": "${uuid}",
 454 "owner_uuid": "${ownerUuid}",
 455 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 456 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 457 "modified_at": ${stringify(modifiedAt)},
 458 "service_host": "${serviceHost}",
 459 "service_port": "${servicePort}",
 460 "service_ssl_flag": "${stringify(serviceSslFlag)}",
 461 "service_type": "${serviceType}",
 462 "created_at": "${createdAt}",
 463 "read_only": "${stringify(readOnly)}"`;
 464
 465     return response;
 466 };
 467
 468 const computeNodeApiResponse = (apiResponse: NodeResource) => {
 469     const {
 470         uuid, slotNumber, hostname, domain, ipAddress, firstPingAt, lastPingAt, jobUuid,
 471         ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid,
 472         properties, info
 473     } = apiResponse;
 474     const response = `"uuid": "${uuid}",
 475 "owner_uuid": "${ownerUuid}",
 476 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
 477 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
 478 "modified_at": ${stringify(modifiedAt)},
 479 "created_at": "${createdAt}",
 480 "slot_number": "${stringify(slotNumber)}",
 481 "hostname": "${stringify(hostname)}",
 482 "domain": "${stringify(domain)}",
 483 "ip_address": "${stringify(ipAddress)}",
 484 "first_ping_at": "${stringify(firstPingAt)}",
 485 "last_ping_at": "${stringify(lastPingAt)}",
 486 "job_uuid": "${stringify(jobUuid)}",
 487 "properties": "${JSON.stringify(properties, null, 4)}",
 488 "info": "${JSON.stringify(info, null, 4)}"`;
 489
 490     return response;
 491 };