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 { 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';
25 export const ADVANCED_TAB_DIALOG = 'advancedTabDialog';
27 interface AdvancedTabDialogData {
29 metadata: ListResults<LinkResource> | string;
30 user: UserResource | string;
32 pythonExample: string;
34 cliGetExample: string;
35 cliUpdateHeader: string;
36 cliUpdateExample: string;
42 COLLECTION = 'collection',
43 STORAGE_CLASSES_CONFIRMED = 'storage_classes_confirmed'
47 CONTAINER_REQUEST = 'container_request',
48 OUTPUT_NAME = 'output_name'
53 DELETE_AT = 'delete_at'
57 REPOSITORY = 'repository',
58 CREATED_AT = 'created_at'
62 SSH_KEY = 'authorized_key',
63 CREATED_AT = 'created_at'
66 enum VirtualMachineData {
67 VIRTUAL_MACHINE = 'virtual_machine',
68 CREATED_AT = 'created_at'
72 REPOSITORIES = 'repositories',
73 AUTORIZED_KEYS = 'authorized_keys',
74 VIRTUAL_MACHINES = 'virtual_machines',
75 KEEP_SERVICES = 'keep_services'
78 enum KeepServiceData {
79 KEEP_SERVICE = 'keep_services',
80 CREATED_AT = 'created_at'
83 type AdvanceResourceKind = CollectionData | ProcessData | ProjectData | RepositoryData | SshKeyData | VirtualMachineData | KeepServiceData;
84 type AdvanceResourcePrefix = GroupContentsResourcePrefix | ResourcePrefix;
85 type AdvanceResponseData = ContainerRequestResource | ProjectResource | CollectionResource | RepositoryResource | SshKeyResource | VirtualMachinesResource | KeepServiceResource | undefined;
87 export const openAdvancedTabDialog = (uuid: string) =>
88 async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
89 const kind = extractUuidKind(uuid);
91 case ResourceKind.COLLECTION:
92 const { data: dataCollection, metadata: metaCollection, user: userCollection } = await dispatch<any>(getDataForAdvancedTab(uuid));
93 const advanceDataCollection = advancedTabData({
95 metadata: metaCollection,
97 apiResponseKind: collectionApiResponse,
99 resourceKind: CollectionData.COLLECTION,
100 resourcePrefix: GroupContentsResourcePrefix.COLLECTION,
101 resourceKindProperty: CollectionData.STORAGE_CLASSES_CONFIRMED,
102 property: dataCollection.storageClassesConfirmed
104 dispatch<any>(initAdvancedTabDialog(advanceDataCollection));
106 case ResourceKind.PROCESS:
107 const { data: dataProcess, metadata: metaProcess, user: userProcess } = await dispatch<any>(getDataForAdvancedTab(uuid));
108 const advancedDataProcess = advancedTabData({
110 metadata: metaProcess,
112 apiResponseKind: containerRequestApiResponse,
114 resourceKind: ProcessData.CONTAINER_REQUEST,
115 resourcePrefix: GroupContentsResourcePrefix.PROCESS,
116 resourceKindProperty: ProcessData.OUTPUT_NAME,
117 property: dataProcess.outputName
119 dispatch<any>(initAdvancedTabDialog(advancedDataProcess));
121 case ResourceKind.PROJECT:
122 const { data: dataProject, metadata: metaProject, user: userProject } = await dispatch<any>(getDataForAdvancedTab(uuid));
123 const advanceDataProject = advancedTabData({
125 metadata: metaProject,
127 apiResponseKind: groupRequestApiResponse,
129 resourceKind: ProjectData.GROUP,
130 resourcePrefix: GroupContentsResourcePrefix.PROJECT,
131 resourceKindProperty: ProjectData.DELETE_AT,
132 property: dataProject.deleteAt
134 dispatch<any>(initAdvancedTabDialog(advanceDataProject));
136 case ResourceKind.REPOSITORY:
137 const dataRepository = getState().repositories.items.find(it => it.uuid === uuid);
138 const advanceDataRepository = advancedTabData({
142 apiResponseKind: repositoryApiResponse,
143 data: dataRepository,
144 resourceKind: RepositoryData.REPOSITORY,
145 resourcePrefix: ResourcePrefix.REPOSITORIES,
146 resourceKindProperty: RepositoryData.CREATED_AT,
147 property: dataRepository!.createdAt
149 dispatch<any>(initAdvancedTabDialog(advanceDataRepository));
151 case ResourceKind.SSH_KEY:
152 const dataSshKey = getState().auth.sshKeys.find(it => it.uuid === uuid);
153 const advanceDataSshKey = advancedTabData({
157 apiResponseKind: sshKeyApiResponse,
159 resourceKind: SshKeyData.SSH_KEY,
160 resourcePrefix: ResourcePrefix.AUTORIZED_KEYS,
161 resourceKindProperty: SshKeyData.CREATED_AT,
162 property: dataSshKey!.createdAt
164 dispatch<any>(initAdvancedTabDialog(advanceDataSshKey));
166 case ResourceKind.VIRTUAL_MACHINE:
167 const dataVirtualMachine = getState().virtualMachines.virtualMachines.items.find(it => it.uuid === uuid);
168 const advanceDataVirtualMachine = advancedTabData({
172 apiResponseKind: virtualMachineApiResponse,
173 data: dataVirtualMachine,
174 resourceKind: VirtualMachineData.VIRTUAL_MACHINE,
175 resourcePrefix: ResourcePrefix.VIRTUAL_MACHINES,
176 resourceKindProperty: VirtualMachineData.CREATED_AT,
177 property: dataVirtualMachine.createdAt
179 dispatch<any>(initAdvancedTabDialog(advanceDataVirtualMachine));
181 case ResourceKind.KEEP_SERVICE:
182 const dataKeepService = getState().keepServices.find(it => it.uuid === uuid);
183 const advanceDataKeepService = advancedTabData({
187 apiResponseKind: keepServiceApiResponse,
188 data: dataKeepService,
189 resourceKind: KeepServiceData.KEEP_SERVICE,
190 resourcePrefix: ResourcePrefix.KEEP_SERVICES,
191 resourceKindProperty: KeepServiceData.CREATED_AT,
192 property: dataKeepService!.createdAt
194 dispatch<any>(initAdvancedTabDialog(advanceDataKeepService));
197 dispatch(snackbarActions.OPEN_SNACKBAR({ message: "Could not open advanced tab for this resource.", hideDuration: 2000, kind: SnackbarKind.ERROR }));
201 const getDataForAdvancedTab = (uuid: string) =>
202 async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
203 const { resources } = getState();
204 const data = getResource<any>(uuid)(resources);
205 const metadata = await services.linkService.list({
206 filters: new FilterBuilder()
207 .addEqual('headUuid', uuid)
210 const user = metadata.itemsAvailable && await services.userService.get(metadata.items[0].tailUuid || '');
211 return { data, metadata, user };
214 const initAdvancedTabDialog = (data: AdvancedTabDialogData) => dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data });
216 interface AdvancedTabData {
218 metadata: ListResults<LinkResource> | string;
219 user: UserResource | string;
220 apiResponseKind: (apiResponse: AdvanceResponseData) => string;
221 data: AdvanceResponseData;
222 resourceKind: AdvanceResourceKind;
223 resourcePrefix: AdvanceResourcePrefix;
224 resourceKindProperty: AdvanceResourceKind;
228 const advancedTabData = ({ uuid, user, metadata, apiResponseKind, data, resourceKind, resourcePrefix, resourceKindProperty, property }: AdvancedTabData) => {
233 apiResponse: apiResponseKind(data),
234 pythonHeader: pythonHeader(resourceKind),
235 pythonExample: pythonExample(uuid, resourcePrefix),
236 cliGetHeader: cliGetHeader(resourceKind),
237 cliGetExample: cliGetExample(uuid, resourceKind),
238 cliUpdateHeader: cliUpdateHeader(resourceKind, resourceKindProperty),
239 cliUpdateExample: cliUpdateExample(uuid, resourceKind, property, resourceKindProperty),
240 curlHeader: curlHeader(resourceKind, resourceKindProperty),
241 curlExample: curlExample(uuid, resourcePrefix, property, resourceKind, resourceKindProperty),
245 const pythonHeader = (resourceKind: string) =>
246 `An example python command to get a ${resourceKind} using its uuid:`;
248 const pythonExample = (uuid: string, resourcePrefix: string) => {
249 const pythonExample = `import arvados
251 x = arvados.api().${resourcePrefix}().get(uuid='${uuid}').execute()`;
253 return pythonExample;
256 const cliGetHeader = (resourceKind: string) =>
257 `An example arv command to get a ${resourceKind} using its uuid:`;
259 const cliGetExample = (uuid: string, resourceKind: string) => {
260 const cliGetExample = `arv ${resourceKind} get \\
263 return cliGetExample;
266 const cliUpdateHeader = (resourceKind: string, resourceName: string) =>
267 `An example arv command to update the "${resourceName}" attribute for the current ${resourceKind}:`;
269 const cliUpdateExample = (uuid: string, resourceKind: string, resource: string | string[], resourceName: string) => {
270 const CLIUpdateCollectionExample = `arv ${resourceKind} update \\
272 --${resourceKind} '{"${resourceName}":${resource}}'`;
274 return CLIUpdateCollectionExample;
277 const curlHeader = (resourceKind: string, resource: string) =>
278 `An example curl command to update the "${resource}" attribute for the current ${resourceKind}:`;
280 const curlExample = (uuid: string, resourcePrefix: string, resource: string | string[], resourceKind: string, resourceName: string) => {
281 const curlExample = `curl -X PUT \\
282 -H "Authorization: OAuth2 $ARVADOS_API_TOKEN" \\
283 --data-urlencode ${resourceKind}@/dev/stdin \\
284 https://$ARVADOS_API_HOST/arvados/v1/${resourcePrefix}/${uuid} \\
287 "${resourceName}": ${resource}
294 const stringify = (item: string | null | number | boolean) =>
295 JSON.stringify(item) || 'null';
297 const stringifyObject = (item: any) =>
298 JSON.stringify(item, null, 2) || 'null';
300 const containerRequestApiResponse = (apiResponse: ContainerRequestResource) => {
301 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, state, requestingContainerUuid, containerUuid,
302 containerCountMax, mounts, runtimeConstraints, containerImage, environment, cwd, command, outputPath, priority, expiresAt, filters, containerCount,
303 useExisting, schedulingParameters, outputUuid, logUuid, outputName, outputTtl } = apiResponse;
304 const response = `"uuid": "${uuid}",
305 "owner_uuid": "${ownerUuid}",
306 "created_at": "${createdAt}",
307 "modified_at": ${stringify(modifiedAt)},
308 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
309 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
310 "name": ${stringify(name)},
311 "description": ${stringify(description)},
312 "properties": ${stringifyObject(properties)},
313 "state": ${stringify(state)},
314 "requesting_container_uuid": ${stringify(requestingContainerUuid)},
315 "container_uuid": ${stringify(containerUuid)},
316 "container_count_max": ${stringify(containerCountMax)},
317 "mounts": ${stringifyObject(mounts)},
318 "runtime_constraints": ${stringifyObject(runtimeConstraints)},
319 "container_image": "${stringify(containerImage)}",
320 "environment": ${stringifyObject(environment)},
321 "cwd": ${stringify(cwd)},
322 "command": ${stringifyObject(command)},
323 "output_path": ${stringify(outputPath)},
324 "priority": ${stringify(priority)},
325 "expires_at": ${stringify(expiresAt)},
326 "filters": ${stringify(filters)},
327 "container_count": ${stringify(containerCount)},
328 "use_existing": ${stringify(useExisting)},
329 "scheduling_parameters": ${stringifyObject(schedulingParameters)},
330 "output_uuid": ${stringify(outputUuid)},
331 "log_uuid": ${stringify(logUuid)},
332 "output_name": ${stringify(outputName)},
333 "output_ttl": ${stringify(outputTtl)}`;
338 const collectionApiResponse = (apiResponse: CollectionResource) => {
339 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, portableDataHash, replicationDesired,
340 replicationConfirmedAt, replicationConfirmed, manifestText, deleteAt, trashAt, isTrashed, storageClassesDesired,
341 storageClassesConfirmed, storageClassesConfirmedAt } = apiResponse;
342 const response = `"uuid": "${uuid}",
343 "owner_uuid": "${ownerUuid}",
344 "created_at": "${createdAt}",
345 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
346 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
347 "modified_at": ${stringify(modifiedAt)},
348 "portable_data_hash": ${stringify(portableDataHash)},
349 "replication_desired": ${stringify(replicationDesired)},
350 "replication_confirmed_at": ${stringify(replicationConfirmedAt)},
351 "replication_confirmed": ${stringify(replicationConfirmed)},
352 "manifest_text": ${stringify(manifestText)},
353 "name": ${stringify(name)},
354 "description": ${stringify(description)},
355 "properties": ${stringifyObject(properties)},
356 "delete_at": ${stringify(deleteAt)},
357 "trash_at": ${stringify(trashAt)},
358 "is_trashed": ${stringify(isTrashed)},
359 "storage_classes_desired": ${JSON.stringify(storageClassesDesired, null, 2)},
360 "storage_classes_confirmed": ${JSON.stringify(storageClassesConfirmed, null, 2)},
361 "storage_classes_confirmed_at": ${stringify(storageClassesConfirmedAt)}`;
366 const groupRequestApiResponse = (apiResponse: ProjectResource) => {
367 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, groupClass, trashAt, isTrashed, deleteAt, properties } = apiResponse;
368 const response = `"uuid": "${uuid}",
369 "owner_uuid": "${ownerUuid}",
370 "created_at": "${createdAt}",
371 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
372 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
373 "modified_at": ${stringify(modifiedAt)},
374 "name": ${stringify(name)},
375 "description": ${stringify(description)},
376 "group_class": ${stringify(groupClass)},
377 "trash_at": ${stringify(trashAt)},
378 "is_trashed": ${stringify(isTrashed)},
379 "delete_at": ${stringify(deleteAt)},
380 "properties": ${stringifyObject(properties)}`;
385 const repositoryApiResponse = (apiResponse: RepositoryResource) => {
386 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name } = apiResponse;
387 const response = `"uuid": "${uuid}",
388 "owner_uuid": "${ownerUuid}",
389 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
390 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
391 "modified_at": ${stringify(modifiedAt)},
392 "name": ${stringify(name)},
393 "created_at": "${createdAt}"`;
398 const sshKeyApiResponse = (apiResponse: SshKeyResource) => {
399 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, authorizedUserUuid, expiresAt } = apiResponse;
400 const response = `"uuid": "${uuid}",
401 "owner_uuid": "${ownerUuid}",
402 "authorized_user_uuid": "${authorizedUserUuid}",
403 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
404 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
405 "modified_at": ${stringify(modifiedAt)},
406 "name": ${stringify(name)},
407 "created_at": "${createdAt}",
408 "expires_at": "${expiresAt}"`;
412 const virtualMachineApiResponse = (apiResponse: VirtualMachinesResource) => {
413 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, hostname } = apiResponse;
414 const response = `"hostname": ${stringify(hostname)},
416 "owner_uuid": "${ownerUuid}",
417 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
418 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
419 "modified_at": ${stringify(modifiedAt)},
420 "modified_at": ${stringify(modifiedAt)},
421 "created_at": "${createdAt}"`;
426 const keepServiceApiResponse = (apiResponse: KeepServiceResource) => {
428 uuid, readOnly, serviceHost, servicePort, serviceSslFlag, serviceType,
429 ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid
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 "service_host": "${serviceHost}",
437 "service_port": "${servicePort}",
438 "service_ssl_flag": "${stringify(serviceSslFlag)}",
439 "service_type": "${serviceType}",
440 "created_at": "${createdAt}",
441 "read_only": "${stringify(readOnly)}"`;