// Copyright (C) The Arvados Authors. All rights reserved. // // SPDX-License-Identifier: AGPL-3.0 import { Dispatch } from 'redux'; import { dialogActions } from '~/store/dialog/dialog-actions'; import { RootState } from '~/store/store'; import { ResourceKind, extractUuidKind } from '~/models/resource'; import { getResource } from '~/store/resources/resources'; import { GroupContentsResourcePrefix } from '~/services/groups-service/groups-service'; import { snackbarActions, SnackbarKind } from '~/store/snackbar/snackbar-actions'; import { ContainerRequestResource } from '~/models/container-request'; import { CollectionResource } from '~/models/collection'; import { ProjectResource } from '~/models/project'; import { ServiceRepository } from '~/services/services'; import { FilterBuilder } from '~/services/api/filter-builder'; import { RepositoryResource } from '~/models/repositories'; import { SshKeyResource } from '~/models/ssh-key'; import { VirtualMachinesResource } from '~/models/virtual-machines'; import { UserResource } from '~/models/user'; import { ListResults } from '~/services/common-service/common-resource-service'; import { LinkResource } from '~/models/link'; import { KeepServiceResource } from '~/models/keep-services'; export const ADVANCED_TAB_DIALOG = 'advancedTabDialog'; interface AdvancedTabDialogData { apiResponse: any; metadata: ListResults | string; user: UserResource | string; pythonHeader: string; pythonExample: string; cliGetHeader: string; cliGetExample: string; cliUpdateHeader: string; cliUpdateExample: string; curlHeader: string; curlExample: string; } enum CollectionData { COLLECTION = 'collection', STORAGE_CLASSES_CONFIRMED = 'storage_classes_confirmed' } enum ProcessData { CONTAINER_REQUEST = 'container_request', OUTPUT_NAME = 'output_name' } enum ProjectData { GROUP = 'group', DELETE_AT = 'delete_at' } enum RepositoryData { REPOSITORY = 'repository', CREATED_AT = 'created_at' } enum SshKeyData { SSH_KEY = 'authorized_key', CREATED_AT = 'created_at' } enum VirtualMachineData { VIRTUAL_MACHINE = 'virtual_machine', CREATED_AT = 'created_at' } enum ResourcePrefix { REPOSITORIES = 'repositories', AUTORIZED_KEYS = 'authorized_keys', VIRTUAL_MACHINES = 'virtual_machines', KEEP_SERVICES = 'keep_services' } enum KeepServiceData { KEEP_SERVICE = 'keep_services', CREATED_AT = 'created_at' } type AdvanceResourceKind = CollectionData | ProcessData | ProjectData | RepositoryData | SshKeyData | VirtualMachineData | KeepServiceData; type AdvanceResourcePrefix = GroupContentsResourcePrefix | ResourcePrefix; export const openAdvancedTabDialog = (uuid: string) => async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => { const kind = extractUuidKind(uuid); switch (kind) { case ResourceKind.COLLECTION: const { data: dataCollection, metadata: metaCollection, user: userCollection } = await dispatch(getDataForAdvancedTab(uuid)); const advanceDataCollection: AdvancedTabDialogData = advancedTabData({ uuid, metadata: metaCollection, user: userCollection, apiResponseKind: collectionApiResponse, data: dataCollection, resourceKind: CollectionData.COLLECTION, resourcePrefix: GroupContentsResourcePrefix.COLLECTION, resourceKindProperty: CollectionData.STORAGE_CLASSES_CONFIRMED, property: dataCollection.storageClassesConfirmed }); dispatch(initAdvancedTabDialog(advanceDataCollection)); break; case ResourceKind.PROCESS: const { data: dataProcess, metadata: metaProcess, user: userProcess } = await dispatch(getDataForAdvancedTab(uuid)); const advancedDataProcess: AdvancedTabDialogData = advancedTabData({ uuid, metadata: metaProcess, user: userProcess, apiResponseKind: containerRequestApiResponse, data: dataProcess, resourceKind: ProcessData.CONTAINER_REQUEST, resourcePrefix: GroupContentsResourcePrefix.PROCESS, resourceKindProperty: ProcessData.OUTPUT_NAME, property: dataProcess.outputName }); dispatch(initAdvancedTabDialog(advancedDataProcess)); break; case ResourceKind.PROJECT: const { data: dataProject, metadata: metaProject, user: userProject } = await dispatch(getDataForAdvancedTab(uuid)); const advanceDataProject: AdvancedTabDialogData = advancedTabData({ uuid, metadata: metaProject, user: userProject, apiResponseKind: groupRequestApiResponse, data: dataProject, resourceKind: ProjectData.GROUP, resourcePrefix: GroupContentsResourcePrefix.PROJECT, resourceKindProperty: ProjectData.DELETE_AT, property: dataProject.deleteAt }); dispatch(initAdvancedTabDialog(advanceDataProject)); break; case ResourceKind.REPOSITORY: const dataRepository = getState().repositories.items.find(it => it.uuid === uuid); const advanceDataRepository: AdvancedTabDialogData = advancedTabData({ uuid, metadata: '', user: '', apiResponseKind: repositoryApiResponse, data: dataRepository, resourceKind: RepositoryData.REPOSITORY, resourcePrefix: ResourcePrefix.REPOSITORIES, resourceKindProperty: RepositoryData.CREATED_AT, property: dataRepository!.createdAt }); dispatch(initAdvancedTabDialog(advanceDataRepository)); break; case ResourceKind.SSH_KEY: const dataSshKey = getState().auth.sshKeys.find(it => it.uuid === uuid); const advanceDataSshKey: AdvancedTabDialogData = advancedTabData({ uuid, metadata: '', user: '', apiResponseKind: sshKeyApiResponse, data: dataSshKey, resourceKind: SshKeyData.SSH_KEY, resourcePrefix: ResourcePrefix.AUTORIZED_KEYS, resourceKindProperty: SshKeyData.CREATED_AT, property: dataSshKey!.createdAt }); dispatch(initAdvancedTabDialog(advanceDataSshKey)); break; case ResourceKind.VIRTUAL_MACHINE: const dataVirtualMachine = getState().virtualMachines.virtualMachines.items.find(it => it.uuid === uuid); const advanceDataVirtualMachine: AdvancedTabDialogData = advancedTabData({ uuid, metadata: '', user: '', apiResponseKind: virtualMachineApiResponse, data: dataVirtualMachine, resourceKind: VirtualMachineData.VIRTUAL_MACHINE, resourcePrefix: ResourcePrefix.VIRTUAL_MACHINES, resourceKindProperty: VirtualMachineData.CREATED_AT, property: dataVirtualMachine.createdAt }); dispatch(initAdvancedTabDialog(advanceDataVirtualMachine)); break; case ResourceKind.KEEP_SERVICE: const dataKeepService = getState().keepServices.find(it => it.uuid === uuid); const advanceDataKeepService: AdvancedTabDialogData = advancedTabData({ uuid, metadata: '', user: '', apiResponseKind: keepServiceApiResponse, data: dataKeepService, resourceKind: KeepServiceData.KEEP_SERVICE, resourcePrefix: ResourcePrefix.KEEP_SERVICES, resourceKindProperty: KeepServiceData.CREATED_AT, property: dataKeepService!.createdAt }); dispatch(initAdvancedTabDialog(advanceDataKeepService)); break; default: dispatch(snackbarActions.OPEN_SNACKBAR({ message: "Could not open advanced tab for this resource.", hideDuration: 2000, kind: SnackbarKind.ERROR })); } }; const getDataForAdvancedTab = (uuid: string) => async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => { const { resources } = getState(); const data = getResource(uuid)(resources); const metadata = await services.linkService.list({ filters: new FilterBuilder() .addEqual('headUuid', uuid) .getFilters() }); const user = metadata.itemsAvailable && await services.userService.get(metadata.items[0].tailUuid || ''); return { data, metadata, user }; }; const initAdvancedTabDialog = (data: AdvancedTabDialogData) => dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data }); const advancedTabData = (args: { uuid: string, metadata: ListResults | string, user: UserResource | string, apiResponseKind: any, data: any, resourceKind: AdvanceResourceKind, resourcePrefix: AdvanceResourcePrefix, resourceKindProperty: AdvanceResourceKind, property: any }) => { return { uuid: args.uuid, user: args.user, metadata: args.metadata, apiResponse: args.apiResponseKind(args.data), pythonHeader: pythonHeader(args.resourceKind), pythonExample: pythonExample(args.uuid, args.resourcePrefix), cliGetHeader: cliGetHeader(args.resourceKind), cliGetExample: cliGetExample(args.uuid, args.resourceKind), cliUpdateHeader: cliUpdateHeader(args.resourceKind, args.resourceKindProperty), cliUpdateExample: cliUpdateExample(args.uuid, args.resourceKind, args.property, args.resourceKindProperty), curlHeader: curlHeader(args.resourceKind, args.resourceKindProperty), curlExample: curlExample(args.uuid, args.resourcePrefix, args.property, args.resourceKind, args.resourceKindProperty), }; }; const pythonHeader = (resourceKind: string) => `An example python command to get a ${resourceKind} using its uuid:`; const pythonExample = (uuid: string, resourcePrefix: string) => { const pythonExample = `import arvados x = arvados.api().${resourcePrefix}().get(uuid='${uuid}').execute()`; return pythonExample; }; const cliGetHeader = (resourceKind: string) => `An example arv command to get a ${resourceKind} using its uuid:`; const cliGetExample = (uuid: string, resourceKind: string) => { const cliGetExample = `arv ${resourceKind} get \\ --uuid ${uuid}`; return cliGetExample; }; const cliUpdateHeader = (resourceKind: string, resourceName: string) => `An example arv command to update the "${resourceName}" attribute for the current ${resourceKind}:`; const cliUpdateExample = (uuid: string, resourceKind: string, resource: string | string[], resourceName: string) => { const CLIUpdateCollectionExample = `arv ${resourceKind} update \\ --uuid ${uuid} \\ --${resourceKind} '{"${resourceName}":${resource}}'`; return CLIUpdateCollectionExample; }; const curlHeader = (resourceKind: string, resource: string) => `An example curl command to update the "${resource}" attribute for the current ${resourceKind}:`; const curlExample = (uuid: string, resourcePrefix: string, resource: string | string[], resourceKind: string, resourceName: string) => { const curlExample = `curl -X PUT \\ -H "Authorization: OAuth2 $ARVADOS_API_TOKEN" \\ --data-urlencode ${resourceKind}@/dev/stdin \\ https://$ARVADOS_API_HOST/arvados/v1/${resourcePrefix}/${uuid} \\ < JSON.stringify(item) || 'null'; const stringifyObject = (item: any) => JSON.stringify(item, null, 2) || 'null'; const containerRequestApiResponse = (apiResponse: ContainerRequestResource) => { const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, state, requestingContainerUuid, containerUuid, containerCountMax, mounts, runtimeConstraints, containerImage, environment, cwd, command, outputPath, priority, expiresAt, filters, containerCount, useExisting, schedulingParameters, outputUuid, logUuid, outputName, outputTtl } = apiResponse; const response = `"uuid": "${uuid}", "owner_uuid": "${ownerUuid}", "created_at": "${createdAt}", "modified_at": ${stringify(modifiedAt)}, "modified_by_client_uuid": ${stringify(modifiedByClientUuid)}, "modified_by_user_uuid": ${stringify(modifiedByUserUuid)}, "name": ${stringify(name)}, "description": ${stringify(description)}, "properties": ${stringifyObject(properties)}, "state": ${stringify(state)}, "requesting_container_uuid": ${stringify(requestingContainerUuid)}, "container_uuid": ${stringify(containerUuid)}, "container_count_max": ${stringify(containerCountMax)}, "mounts": ${stringifyObject(mounts)}, "runtime_constraints": ${stringifyObject(runtimeConstraints)}, "container_image": "${stringify(containerImage)}", "environment": ${stringifyObject(environment)}, "cwd": ${stringify(cwd)}, "command": ${stringifyObject(command)}, "output_path": ${stringify(outputPath)}, "priority": ${stringify(priority)}, "expires_at": ${stringify(expiresAt)}, "filters": ${stringify(filters)}, "container_count": ${stringify(containerCount)}, "use_existing": ${stringify(useExisting)}, "scheduling_parameters": ${stringifyObject(schedulingParameters)}, "output_uuid": ${stringify(outputUuid)}, "log_uuid": ${stringify(logUuid)}, "output_name": ${stringify(outputName)}, "output_ttl": ${stringify(outputTtl)}`; return response; }; const collectionApiResponse = (apiResponse: CollectionResource) => { const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, portableDataHash, replicationDesired, replicationConfirmedAt, replicationConfirmed, manifestText, deleteAt, trashAt, isTrashed, storageClassesDesired, storageClassesConfirmed, storageClassesConfirmedAt } = apiResponse; const response = `"uuid": "${uuid}", "owner_uuid": "${ownerUuid}", "created_at": "${createdAt}", "modified_by_client_uuid": ${stringify(modifiedByClientUuid)}, "modified_by_user_uuid": ${stringify(modifiedByUserUuid)}, "modified_at": ${stringify(modifiedAt)}, "portable_data_hash": ${stringify(portableDataHash)}, "replication_desired": ${stringify(replicationDesired)}, "replication_confirmed_at": ${stringify(replicationConfirmedAt)}, "replication_confirmed": ${stringify(replicationConfirmed)}, "manifest_text": ${stringify(manifestText)}, "name": ${stringify(name)}, "description": ${stringify(description)}, "properties": ${stringifyObject(properties)}, "delete_at": ${stringify(deleteAt)}, "trash_at": ${stringify(trashAt)}, "is_trashed": ${stringify(isTrashed)}, "storage_classes_desired": ${JSON.stringify(storageClassesDesired, null, 2)}, "storage_classes_confirmed": ${JSON.stringify(storageClassesConfirmed, null, 2)}, "storage_classes_confirmed_at": ${stringify(storageClassesConfirmedAt)}`; return response; }; const groupRequestApiResponse = (apiResponse: ProjectResource) => { const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, groupClass, trashAt, isTrashed, deleteAt, properties } = apiResponse; const response = `"uuid": "${uuid}", "owner_uuid": "${ownerUuid}", "created_at": "${createdAt}", "modified_by_client_uuid": ${stringify(modifiedByClientUuid)}, "modified_by_user_uuid": ${stringify(modifiedByUserUuid)}, "modified_at": ${stringify(modifiedAt)}, "name": ${stringify(name)}, "description": ${stringify(description)}, "group_class": ${stringify(groupClass)}, "trash_at": ${stringify(trashAt)}, "is_trashed": ${stringify(isTrashed)}, "delete_at": ${stringify(deleteAt)}, "properties": ${stringifyObject(properties)}`; return response; }; const repositoryApiResponse = (apiResponse: RepositoryResource) => { const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name } = apiResponse; const response = `"uuid": "${uuid}", "owner_uuid": "${ownerUuid}", "modified_by_client_uuid": ${stringify(modifiedByClientUuid)}, "modified_by_user_uuid": ${stringify(modifiedByUserUuid)}, "modified_at": ${stringify(modifiedAt)}, "name": ${stringify(name)}, "created_at": "${createdAt}"`; return response; }; const sshKeyApiResponse = (apiResponse: SshKeyResource) => { const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, authorizedUserUuid, expiresAt } = apiResponse; const response = `"uuid": "${uuid}", "owner_uuid": "${ownerUuid}", "authorized_user_uuid": "${authorizedUserUuid}", "modified_by_client_uuid": ${stringify(modifiedByClientUuid)}, "modified_by_user_uuid": ${stringify(modifiedByUserUuid)}, "modified_at": ${stringify(modifiedAt)}, "name": ${stringify(name)}, "created_at": "${createdAt}", "expires_at": "${expiresAt}"`; return response; }; const virtualMachineApiResponse = (apiResponse: VirtualMachinesResource) => { const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, hostname } = apiResponse; const response = `"hostname": ${stringify(hostname)}, "uuid": "${uuid}", "owner_uuid": "${ownerUuid}", "modified_by_client_uuid": ${stringify(modifiedByClientUuid)}, "modified_by_user_uuid": ${stringify(modifiedByUserUuid)}, "modified_at": ${stringify(modifiedAt)}, "modified_at": ${stringify(modifiedAt)}, "created_at": "${createdAt}"`; return response; }; const keepServiceApiResponse = (apiResponse: KeepServiceResource) => { const { uuid, readOnly, serviceHost, servicePort, serviceSslFlag, serviceType, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid } = apiResponse; const response = `"uuid": "${uuid}", "owner_uuid": "${ownerUuid}", "modified_by_client_uuid": ${stringify(modifiedByClientUuid)}, "modified_by_user_uuid": ${stringify(modifiedByUserUuid)}, "modified_at": ${stringify(modifiedAt)}, "service_host": "${serviceHost}", "service_port": "${servicePort}", "service_ssl_flag": "${stringify(serviceSslFlag)}", "service_type": "${serviceType}", "created_at": "${createdAt}", "read_only": "${stringify(readOnly)}"`; return response; };