1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
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 { ListResults } from '~/services/common-service/common-service';
18 import { RepositoryResource } from '~/models/repositories';
19 import { SshKeyResource } from '~/models/ssh-key';
20 import { VirtualMachinesResource } from '~/models/virtual-machines';
21 import { UserResource } from '~/models/user';
22 import { LinkResource } from '~/models/link';
23 import { KeepServiceResource } from '~/models/keep-services';
24 import { NodeResource } from '~/models/node';
25 import { ApiClientAuthorization } from '~/models/api-client-authorization';
27 export const ADVANCED_TAB_DIALOG = 'advancedTabDialog';
29 interface AdvancedTabDialogData {
31 metadata: ListResults<LinkResource> | string;
32 user: UserResource | string;
34 pythonExample: string;
36 cliGetExample: string;
37 cliUpdateHeader: string;
38 cliUpdateExample: string;
44 COLLECTION = 'collection',
45 STORAGE_CLASSES_CONFIRMED = 'storage_classes_confirmed'
49 CONTAINER_REQUEST = 'container_request',
50 OUTPUT_NAME = 'output_name'
55 DELETE_AT = 'delete_at'
59 REPOSITORY = 'repository',
60 CREATED_AT = 'created_at'
64 SSH_KEY = 'authorized_key',
65 CREATED_AT = 'created_at'
68 enum VirtualMachineData {
69 VIRTUAL_MACHINE = 'virtual_machine',
70 CREATED_AT = 'created_at'
74 REPOSITORIES = 'repositories',
75 AUTORIZED_KEYS = 'authorized_keys',
76 VIRTUAL_MACHINES = 'virtual_machines',
77 KEEP_SERVICES = 'keep_services',
78 COMPUTE_NODES = 'nodes',
79 API_CLIENT_AUTHORIZATIONS = 'api_client_authorizations'
82 enum KeepServiceData {
83 KEEP_SERVICE = 'keep_services',
84 CREATED_AT = 'created_at'
87 enum ComputeNodeData {
88 COMPUTE_NODE = 'node',
89 PROPERTIES = 'properties'
92 enum ApiClientAuthorizationsData {
93 API_CLIENT_AUTHORIZATION = 'api_client_authorization',
94 DEFAULT_OWNER_UUID = 'default_owner_uuid'
97 type AdvanceResourceKind = CollectionData | ProcessData | ProjectData | RepositoryData | SshKeyData | VirtualMachineData | KeepServiceData | ComputeNodeData | ApiClientAuthorizationsData;
98 type AdvanceResourcePrefix = GroupContentsResourcePrefix | ResourcePrefix;
99 type AdvanceResponseData = ContainerRequestResource | ProjectResource | CollectionResource | RepositoryResource | SshKeyResource | VirtualMachinesResource | KeepServiceResource | NodeResource | ApiClientAuthorization | undefined;
101 export const openAdvancedTabDialog = (uuid: string) =>
102 async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
103 const kind = extractUuidKind(uuid);
105 case ResourceKind.COLLECTION:
106 const { data: dataCollection, metadata: metaCollection, user: userCollection } = await dispatch<any>(getDataForAdvancedTab(uuid));
107 const advanceDataCollection = advancedTabData({
109 metadata: metaCollection,
110 user: userCollection,
111 apiResponseKind: collectionApiResponse,
112 data: dataCollection,
113 resourceKind: CollectionData.COLLECTION,
114 resourcePrefix: GroupContentsResourcePrefix.COLLECTION,
115 resourceKindProperty: CollectionData.STORAGE_CLASSES_CONFIRMED,
116 property: dataCollection.storageClassesConfirmed
118 dispatch<any>(initAdvancedTabDialog(advanceDataCollection));
120 case ResourceKind.PROCESS:
121 const { data: dataProcess, metadata: metaProcess, user: userProcess } = await dispatch<any>(getDataForAdvancedTab(uuid));
122 const advancedDataProcess = advancedTabData({
124 metadata: metaProcess,
126 apiResponseKind: containerRequestApiResponse,
128 resourceKind: ProcessData.CONTAINER_REQUEST,
129 resourcePrefix: GroupContentsResourcePrefix.PROCESS,
130 resourceKindProperty: ProcessData.OUTPUT_NAME,
131 property: dataProcess.outputName
133 dispatch<any>(initAdvancedTabDialog(advancedDataProcess));
135 case ResourceKind.PROJECT:
136 const { data: dataProject, metadata: metaProject, user: userProject } = await dispatch<any>(getDataForAdvancedTab(uuid));
137 const advanceDataProject = advancedTabData({
139 metadata: metaProject,
141 apiResponseKind: groupRequestApiResponse,
143 resourceKind: ProjectData.GROUP,
144 resourcePrefix: GroupContentsResourcePrefix.PROJECT,
145 resourceKindProperty: ProjectData.DELETE_AT,
146 property: dataProject.deleteAt
148 dispatch<any>(initAdvancedTabDialog(advanceDataProject));
150 case ResourceKind.REPOSITORY:
151 const dataRepository = getState().repositories.items.find(it => it.uuid === uuid);
152 const advanceDataRepository = advancedTabData({
156 apiResponseKind: repositoryApiResponse,
157 data: dataRepository,
158 resourceKind: RepositoryData.REPOSITORY,
159 resourcePrefix: ResourcePrefix.REPOSITORIES,
160 resourceKindProperty: RepositoryData.CREATED_AT,
161 property: dataRepository!.createdAt
163 dispatch<any>(initAdvancedTabDialog(advanceDataRepository));
165 case ResourceKind.SSH_KEY:
166 const dataSshKey = getState().auth.sshKeys.find(it => it.uuid === uuid);
167 const advanceDataSshKey = advancedTabData({
171 apiResponseKind: sshKeyApiResponse,
173 resourceKind: SshKeyData.SSH_KEY,
174 resourcePrefix: ResourcePrefix.AUTORIZED_KEYS,
175 resourceKindProperty: SshKeyData.CREATED_AT,
176 property: dataSshKey!.createdAt
178 dispatch<any>(initAdvancedTabDialog(advanceDataSshKey));
180 case ResourceKind.VIRTUAL_MACHINE:
181 const dataVirtualMachine = getState().virtualMachines.virtualMachines.items.find(it => it.uuid === uuid);
182 const advanceDataVirtualMachine = advancedTabData({
186 apiResponseKind: virtualMachineApiResponse,
187 data: dataVirtualMachine,
188 resourceKind: VirtualMachineData.VIRTUAL_MACHINE,
189 resourcePrefix: ResourcePrefix.VIRTUAL_MACHINES,
190 resourceKindProperty: VirtualMachineData.CREATED_AT,
191 property: dataVirtualMachine.createdAt
193 dispatch<any>(initAdvancedTabDialog(advanceDataVirtualMachine));
195 case ResourceKind.KEEP_SERVICE:
196 const dataKeepService = getState().keepServices.find(it => it.uuid === uuid);
197 const advanceDataKeepService = advancedTabData({
201 apiResponseKind: keepServiceApiResponse,
202 data: dataKeepService,
203 resourceKind: KeepServiceData.KEEP_SERVICE,
204 resourcePrefix: ResourcePrefix.KEEP_SERVICES,
205 resourceKindProperty: KeepServiceData.CREATED_AT,
206 property: dataKeepService!.createdAt
208 dispatch<any>(initAdvancedTabDialog(advanceDataKeepService));
210 case ResourceKind.NODE:
211 const dataComputeNode = getState().computeNodes.find(node => node.uuid === uuid);
212 const advanceDataComputeNode = advancedTabData({
216 apiResponseKind: computeNodeApiResponse,
217 data: dataComputeNode,
218 resourceKind: ComputeNodeData.COMPUTE_NODE,
219 resourcePrefix: ResourcePrefix.COMPUTE_NODES,
220 resourceKindProperty: ComputeNodeData.PROPERTIES,
221 property: dataComputeNode!.properties
223 dispatch<any>(initAdvancedTabDialog(advanceDataComputeNode));
225 case ResourceKind.API_CLIENT_AUTHORIZATION:
226 const dataApiClientAuthorization = getState().apiClientAuthorizations.find(item => item.uuid === uuid);
227 const advanceDataApiClientAuthorization = advancedTabData({
231 apiResponseKind: apiClientAuthorizationApiResponse,
232 data: dataApiClientAuthorization,
233 resourceKind: ApiClientAuthorizationsData.API_CLIENT_AUTHORIZATION,
234 resourcePrefix: ResourcePrefix.API_CLIENT_AUTHORIZATIONS,
235 resourceKindProperty: ApiClientAuthorizationsData.DEFAULT_OWNER_UUID,
236 property: dataApiClientAuthorization!.defaultOwnerUuid
238 dispatch<any>(initAdvancedTabDialog(advanceDataApiClientAuthorization));
241 dispatch(snackbarActions.OPEN_SNACKBAR({ message: "Could not open advanced tab for this resource.", hideDuration: 2000, kind: SnackbarKind.ERROR }));
245 const getDataForAdvancedTab = (uuid: string) =>
246 async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
247 const { resources } = getState();
248 const data = getResource<any>(uuid)(resources);
249 const metadata = await services.linkService.list({
250 filters: new FilterBuilder()
251 .addEqual('headUuid', uuid)
254 const user = metadata.itemsAvailable && await services.userService.get(metadata.items[0].tailUuid || '');
255 return { data, metadata, user };
258 const initAdvancedTabDialog = (data: AdvancedTabDialogData) => dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data });
260 interface AdvancedTabData {
262 metadata: ListResults<LinkResource> | string;
263 user: UserResource | string;
264 apiResponseKind: (apiResponse: AdvanceResponseData) => string;
265 data: AdvanceResponseData;
266 resourceKind: AdvanceResourceKind;
267 resourcePrefix: AdvanceResourcePrefix;
268 resourceKindProperty: AdvanceResourceKind;
272 const advancedTabData = ({ uuid, user, metadata, apiResponseKind, data, resourceKind, resourcePrefix, resourceKindProperty, property }: AdvancedTabData) => {
277 apiResponse: apiResponseKind(data),
278 pythonHeader: pythonHeader(resourceKind),
279 pythonExample: pythonExample(uuid, resourcePrefix),
280 cliGetHeader: cliGetHeader(resourceKind),
281 cliGetExample: cliGetExample(uuid, resourceKind),
282 cliUpdateHeader: cliUpdateHeader(resourceKind, resourceKindProperty),
283 cliUpdateExample: cliUpdateExample(uuid, resourceKind, property, resourceKindProperty),
284 curlHeader: curlHeader(resourceKind, resourceKindProperty),
285 curlExample: curlExample(uuid, resourcePrefix, property, resourceKind, resourceKindProperty),
289 const pythonHeader = (resourceKind: string) =>
290 `An example python command to get a ${resourceKind} using its uuid:`;
292 const pythonExample = (uuid: string, resourcePrefix: string) => {
293 const pythonExample = `import arvados
295 x = arvados.api().${resourcePrefix}().get(uuid='${uuid}').execute()`;
297 return pythonExample;
300 const cliGetHeader = (resourceKind: string) =>
301 `An example arv command to get a ${resourceKind} using its uuid:`;
303 const cliGetExample = (uuid: string, resourceKind: string) => {
304 const cliGetExample = `arv ${resourceKind} get \\
307 return cliGetExample;
310 const cliUpdateHeader = (resourceKind: string, resourceName: string) =>
311 `An example arv command to update the "${resourceName}" attribute for the current ${resourceKind}:`;
313 const cliUpdateExample = (uuid: string, resourceKind: string, resource: string | string[], resourceName: string) => {
314 const CLIUpdateCollectionExample = `arv ${resourceKind} update \\
316 --${resourceKind} '{"${resourceName}":${JSON.stringify(resource)}}'`;
318 return CLIUpdateCollectionExample;
321 const curlHeader = (resourceKind: string, resource: string) =>
322 `An example curl command to update the "${resource}" attribute for the current ${resourceKind}:`;
324 const curlExample = (uuid: string, resourcePrefix: string, resource: string | string[], resourceKind: string, resourceName: string) => {
325 const curlExample = `curl -X PUT \\
326 -H "Authorization: OAuth2 $ARVADOS_API_TOKEN" \\
327 --data-urlencode ${resourceKind}@/dev/stdin \\
328 https://$ARVADOS_API_HOST/arvados/v1/${resourcePrefix}/${uuid} \\
331 "${resourceName}": ${JSON.stringify(resource, null, 4)}
338 const stringify = (item: string | null | number | boolean) =>
339 JSON.stringify(item) || 'null';
341 const stringifyObject = (item: any) =>
342 JSON.stringify(item, null, 2) || 'null';
344 const containerRequestApiResponse = (apiResponse: ContainerRequestResource) => {
345 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, state, requestingContainerUuid, containerUuid,
346 containerCountMax, mounts, runtimeConstraints, containerImage, environment, cwd, command, outputPath, priority, expiresAt, filters, containerCount,
347 useExisting, schedulingParameters, outputUuid, logUuid, outputName, outputTtl } = apiResponse;
348 const response = `"uuid": "${uuid}",
349 "owner_uuid": "${ownerUuid}",
350 "created_at": "${createdAt}",
351 "modified_at": ${stringify(modifiedAt)},
352 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
353 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
354 "name": ${stringify(name)},
355 "description": ${stringify(description)},
356 "properties": ${stringifyObject(properties)},
357 "state": ${stringify(state)},
358 "requesting_container_uuid": ${stringify(requestingContainerUuid)},
359 "container_uuid": ${stringify(containerUuid)},
360 "container_count_max": ${stringify(containerCountMax)},
361 "mounts": ${stringifyObject(mounts)},
362 "runtime_constraints": ${stringifyObject(runtimeConstraints)},
363 "container_image": "${stringify(containerImage)}",
364 "environment": ${stringifyObject(environment)},
365 "cwd": ${stringify(cwd)},
366 "command": ${stringifyObject(command)},
367 "output_path": ${stringify(outputPath)},
368 "priority": ${stringify(priority)},
369 "expires_at": ${stringify(expiresAt)},
370 "filters": ${stringify(filters)},
371 "container_count": ${stringify(containerCount)},
372 "use_existing": ${stringify(useExisting)},
373 "scheduling_parameters": ${stringifyObject(schedulingParameters)},
374 "output_uuid": ${stringify(outputUuid)},
375 "log_uuid": ${stringify(logUuid)},
376 "output_name": ${stringify(outputName)},
377 "output_ttl": ${stringify(outputTtl)}`;
382 const collectionApiResponse = (apiResponse: CollectionResource) => {
383 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, portableDataHash, replicationDesired,
384 replicationConfirmedAt, replicationConfirmed, manifestText, deleteAt, trashAt, isTrashed, storageClassesDesired,
385 storageClassesConfirmed, storageClassesConfirmedAt } = apiResponse;
386 const response = `"uuid": "${uuid}",
387 "owner_uuid": "${ownerUuid}",
388 "created_at": "${createdAt}",
389 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
390 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
391 "modified_at": ${stringify(modifiedAt)},
392 "portable_data_hash": ${stringify(portableDataHash)},
393 "replication_desired": ${stringify(replicationDesired)},
394 "replication_confirmed_at": ${stringify(replicationConfirmedAt)},
395 "replication_confirmed": ${stringify(replicationConfirmed)},
396 "manifest_text": ${stringify(manifestText)},
397 "name": ${stringify(name)},
398 "description": ${stringify(description)},
399 "properties": ${stringifyObject(properties)},
400 "delete_at": ${stringify(deleteAt)},
401 "trash_at": ${stringify(trashAt)},
402 "is_trashed": ${stringify(isTrashed)},
403 "storage_classes_desired": ${JSON.stringify(storageClassesDesired, null, 2)},
404 "storage_classes_confirmed": ${JSON.stringify(storageClassesConfirmed, null, 2)},
405 "storage_classes_confirmed_at": ${stringify(storageClassesConfirmedAt)}`;
410 const groupRequestApiResponse = (apiResponse: ProjectResource) => {
411 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, groupClass, trashAt, isTrashed, deleteAt, properties } = apiResponse;
412 const response = `"uuid": "${uuid}",
413 "owner_uuid": "${ownerUuid}",
414 "created_at": "${createdAt}",
415 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
416 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
417 "modified_at": ${stringify(modifiedAt)},
418 "name": ${stringify(name)},
419 "description": ${stringify(description)},
420 "group_class": ${stringify(groupClass)},
421 "trash_at": ${stringify(trashAt)},
422 "is_trashed": ${stringify(isTrashed)},
423 "delete_at": ${stringify(deleteAt)},
424 "properties": ${stringifyObject(properties)}`;
429 const repositoryApiResponse = (apiResponse: RepositoryResource) => {
430 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name } = apiResponse;
431 const response = `"uuid": "${uuid}",
432 "owner_uuid": "${ownerUuid}",
433 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
434 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
435 "modified_at": ${stringify(modifiedAt)},
436 "name": ${stringify(name)},
437 "created_at": "${createdAt}"`;
442 const sshKeyApiResponse = (apiResponse: SshKeyResource) => {
443 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, authorizedUserUuid, expiresAt } = apiResponse;
444 const response = `"uuid": "${uuid}",
445 "owner_uuid": "${ownerUuid}",
446 "authorized_user_uuid": "${authorizedUserUuid}",
447 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
448 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
449 "modified_at": ${stringify(modifiedAt)},
450 "name": ${stringify(name)},
451 "created_at": "${createdAt}",
452 "expires_at": "${expiresAt}"`;
456 const virtualMachineApiResponse = (apiResponse: VirtualMachinesResource) => {
457 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, hostname } = apiResponse;
458 const response = `"hostname": ${stringify(hostname)},
460 "owner_uuid": "${ownerUuid}",
461 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
462 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
463 "modified_at": ${stringify(modifiedAt)},
464 "modified_at": ${stringify(modifiedAt)},
465 "created_at": "${createdAt}"`;
470 const keepServiceApiResponse = (apiResponse: KeepServiceResource) => {
472 uuid, readOnly, serviceHost, servicePort, serviceSslFlag, serviceType,
473 ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid
475 const response = `"uuid": "${uuid}",
476 "owner_uuid": "${ownerUuid}",
477 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
478 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
479 "modified_at": ${stringify(modifiedAt)},
480 "service_host": "${serviceHost}",
481 "service_port": "${servicePort}",
482 "service_ssl_flag": "${stringify(serviceSslFlag)}",
483 "service_type": "${serviceType}",
484 "created_at": "${createdAt}",
485 "read_only": "${stringify(readOnly)}"`;
490 const computeNodeApiResponse = (apiResponse: NodeResource) => {
492 uuid, slotNumber, hostname, domain, ipAddress, firstPingAt, lastPingAt, jobUuid,
493 ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid,
496 const response = `"uuid": "${uuid}",
497 "owner_uuid": "${ownerUuid}",
498 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
499 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
500 "modified_at": ${stringify(modifiedAt)},
501 "created_at": "${createdAt}",
502 "slot_number": "${stringify(slotNumber)}",
503 "hostname": "${stringify(hostname)}",
504 "domain": "${stringify(domain)}",
505 "ip_address": "${stringify(ipAddress)}",
506 "first_ping_at": "${stringify(firstPingAt)}",
507 "last_ping_at": "${stringify(lastPingAt)}",
508 "job_uuid": "${stringify(jobUuid)}",
509 "properties": "${JSON.stringify(properties, null, 4)}",
510 "info": "${JSON.stringify(info, null, 4)}"`;
515 const apiClientAuthorizationApiResponse = (apiResponse: ApiClientAuthorization) => {
517 uuid, ownerUuid, apiToken, apiClientId, userId, createdByIpAddress, lastUsedByIpAddress,
518 lastUsedAt, expiresAt, defaultOwnerUuid, scopes, updatedAt, createdAt
520 const response = `"uuid": "${uuid}",
521 "owner_uuid": "${ownerUuid}",
522 "api_token": "${stringify(apiToken)}",
523 "api_client_id": "${stringify(apiClientId)}",
524 "user_id": "${stringify(userId)}",
525 "created_by_ip_address": "${stringify(createdByIpAddress)}",
526 "last_used_by_ip_address": "${stringify(lastUsedByIpAddress)}",
527 "last_used_at": "${stringify(lastUsedAt)}",
528 "expires_at": "${stringify(expiresAt)}",
529 "created_at": "${stringify(createdAt)}",
530 "updated_at": "${stringify(updatedAt)}",
531 "default_owner_uuid": "${stringify(defaultOwnerUuid)}",
532 "scopes": "${JSON.stringify(scopes, null, 4)}"`;