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 { KeepServiceResource } from '~/models/keep-services';
21 export const ADVANCED_TAB_DIALOG = 'advancedTabDialog';
23 interface AdvancedTabDialogData {
28 pythonExample: string;
30 cliGetExample: string;
31 cliUpdateHeader: string;
32 cliUpdateExample: string;
38 COLLECTION = 'collection',
39 STORAGE_CLASSES_CONFIRMED = 'storage_classes_confirmed'
43 CONTAINER_REQUEST = 'container_request',
44 OUTPUT_NAME = 'output_name'
49 DELETE_AT = 'delete_at'
53 REPOSITORY = 'repository',
54 CREATED_AT = 'created_at'
58 SSH_KEY = 'authorized_keys',
59 CREATED_AT = 'created_at'
62 enum KeepServiceData {
63 KEEP_SERVICE = 'keep_services',
64 CREATED_AT = 'created_at'
67 type AdvanceResourceKind = CollectionData | ProcessData | ProjectData | RepositoryData | SshKeyData | KeepServiceData;
68 type AdvanceResourcePrefix = GroupContentsResourcePrefix | 'repositories' | 'authorized_keys' | 'keep_services';
70 export const openAdvancedTabDialog = (uuid: string, index?: number) =>
71 async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
72 const kind = extractUuidKind(uuid);
74 case ResourceKind.COLLECTION:
75 const { data: dataCollection, metadata: metaCollection, user: userCollection } = await dispatch<any>(getDataForAdvancedTab(uuid));
76 const advanceDataCollection: AdvancedTabDialogData = advancedTabData(uuid, metaCollection, userCollection, collectionApiResponse, dataCollection, CollectionData.COLLECTION, GroupContentsResourcePrefix.COLLECTION, CollectionData.STORAGE_CLASSES_CONFIRMED, dataCollection.storageClassesConfirmed);
77 dispatch<any>(initAdvancedTabDialog(advanceDataCollection));
79 case ResourceKind.PROCESS:
80 const { data: dataProcess, metadata: metaProcess, user: userProcess } = await dispatch<any>(getDataForAdvancedTab(uuid));
81 const advancedDataProcess: AdvancedTabDialogData = advancedTabData(uuid, metaProcess, userProcess, containerRequestApiResponse, dataProcess, ProcessData.CONTAINER_REQUEST, GroupContentsResourcePrefix.PROCESS, ProcessData.OUTPUT_NAME, dataProcess.outputName);
82 dispatch<any>(initAdvancedTabDialog(advancedDataProcess));
84 case ResourceKind.PROJECT:
85 const { data: dataProject, metadata: metaProject, user: userProject } = await dispatch<any>(getDataForAdvancedTab(uuid));
86 const advanceDataProject: AdvancedTabDialogData = advancedTabData(uuid, metaProject, userProject, groupRequestApiResponse, dataProject, ProjectData.GROUP, GroupContentsResourcePrefix.PROJECT, ProjectData.DELETE_AT, dataProject.deleteAt);
87 dispatch<any>(initAdvancedTabDialog(advanceDataProject));
89 case ResourceKind.REPOSITORY:
90 const dataRepository = getState().repositories.items[index!];
91 const advanceDataRepository: AdvancedTabDialogData = advancedTabData(uuid, '', '', repositoryApiResponse, dataRepository, RepositoryData.REPOSITORY, 'repositories', RepositoryData.CREATED_AT, dataRepository.createdAt);
92 dispatch<any>(initAdvancedTabDialog(advanceDataRepository));
94 case ResourceKind.SSH_KEY:
95 const dataSshKey = getState().auth.sshKeys[index!];
96 const advanceDataSshKey: AdvancedTabDialogData = advancedTabData(uuid, '', '', sshKeyApiResponse, dataSshKey, SshKeyData.SSH_KEY, 'authorized_keys', SshKeyData.CREATED_AT, dataSshKey.createdAt);
97 dispatch<any>(initAdvancedTabDialog(advanceDataSshKey));
99 case ResourceKind.KEEP_SERVICE:
100 const dataKeepService = getState().keepServices[index!];
101 const advanceDataKeepService: AdvancedTabDialogData = advancedTabData(uuid, '', '', keepServiceApiResponse, dataKeepService, KeepServiceData.KEEP_SERVICE, 'keep_services', KeepServiceData.CREATED_AT, dataKeepService.createdAt);
102 dispatch<any>(initAdvancedTabDialog(advanceDataKeepService));
105 dispatch(snackbarActions.OPEN_SNACKBAR({ message: "Could not open advanced tab for this resource.", hideDuration: 2000, kind: SnackbarKind.ERROR }));
109 const getDataForAdvancedTab = (uuid: string) =>
110 async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
111 const { resources } = getState();
112 const data = getResource<any>(uuid)(resources);
113 const metadata = await services.linkService.list({
114 filters: new FilterBuilder()
115 .addEqual('headUuid', uuid)
118 const user = metadata.itemsAvailable && await services.userService.get(metadata.items[0].tailUuid || '');
119 return { data, metadata, user };
122 const initAdvancedTabDialog = (data: AdvancedTabDialogData) => dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data });
124 const advancedTabData = (uuid: string, metadata: any, user: any, apiResponseKind: any, data: any, resourceKind: AdvanceResourceKind,
125 resourcePrefix: AdvanceResourcePrefix, resourceKindProperty: AdvanceResourceKind, property: any) => {
130 apiResponse: apiResponseKind(data),
131 pythonHeader: pythonHeader(resourceKind),
132 pythonExample: pythonExample(uuid, resourcePrefix),
133 cliGetHeader: cliGetHeader(resourceKind),
134 cliGetExample: cliGetExample(uuid, resourceKind),
135 cliUpdateHeader: cliUpdateHeader(resourceKind, resourceKindProperty),
136 cliUpdateExample: cliUpdateExample(uuid, resourceKind, property, resourceKindProperty),
137 curlHeader: curlHeader(resourceKind, resourceKindProperty),
138 curlExample: curlExample(uuid, resourcePrefix, property, resourceKind, resourceKindProperty),
142 const pythonHeader = (resourceKind: string) =>
143 `An example python command to get a ${resourceKind} using its uuid:`;
145 const pythonExample = (uuid: string, resourcePrefix: string) => {
146 const pythonExample = `import arvados
148 x = arvados.api().${resourcePrefix}().get(uuid='${uuid}').execute()`;
150 return pythonExample;
153 const cliGetHeader = (resourceKind: string) =>
154 `An example arv command to get a ${resourceKind} using its uuid:`;
156 const cliGetExample = (uuid: string, resourceKind: string) => {
157 const cliGetExample = `arv ${resourceKind} get \\
160 return cliGetExample;
163 const cliUpdateHeader = (resourceKind: string, resourceName: string) =>
164 `An example arv command to update the "${resourceName}" attribute for the current ${resourceKind}:`;
166 const cliUpdateExample = (uuid: string, resourceKind: string, resource: string | string[], resourceName: string) => {
167 const CLIUpdateCollectionExample = `arv ${resourceKind} update \\
169 --${resourceKind} '{"${resourceName}":${resource}}'`;
171 return CLIUpdateCollectionExample;
174 const curlHeader = (resourceKind: string, resource: string) =>
175 `An example curl command to update the "${resource}" attribute for the current ${resourceKind}:`;
177 const curlExample = (uuid: string, resourcePrefix: string, resource: string | string[], resourceKind: string, resourceName: string) => {
178 const curlExample = `curl -X PUT \\
179 -H "Authorization: OAuth2 $ARVADOS_API_TOKEN" \\
180 --data-urlencode ${resourceKind}@/dev/stdin \\
181 https://$ARVADOS_API_HOST/arvados/v1/${resourcePrefix}/${uuid} \\
184 "${resourceName}": ${resource}
191 const stringify = (item: string | null | number | boolean) =>
192 JSON.stringify(item) || 'null';
194 const stringifyObject = (item: any) =>
195 JSON.stringify(item, null, 2) || 'null';
197 const containerRequestApiResponse = (apiResponse: ContainerRequestResource) => {
198 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, state, requestingContainerUuid, containerUuid,
199 containerCountMax, mounts, runtimeConstraints, containerImage, environment, cwd, command, outputPath, priority, expiresAt, filters, containerCount,
200 useExisting, schedulingParameters, outputUuid, logUuid, outputName, outputTtl } = apiResponse;
201 const response = `"uuid": "${uuid}",
202 "owner_uuid": "${ownerUuid}",
203 "created_at": "${createdAt}",
204 "modified_at": ${stringify(modifiedAt)},
205 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
206 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
207 "name": ${stringify(name)},
208 "description": ${stringify(description)},
209 "properties": ${stringifyObject(properties)},
210 "state": ${stringify(state)},
211 "requesting_container_uuid": ${stringify(requestingContainerUuid)},
212 "container_uuid": ${stringify(containerUuid)},
213 "container_count_max": ${stringify(containerCountMax)},
214 "mounts": ${stringifyObject(mounts)},
215 "runtime_constraints": ${stringifyObject(runtimeConstraints)},
216 "container_image": "${stringify(containerImage)}",
217 "environment": ${stringifyObject(environment)},
218 "cwd": ${stringify(cwd)},
219 "command": ${stringifyObject(command)},
220 "output_path": ${stringify(outputPath)},
221 "priority": ${stringify(priority)},
222 "expires_at": ${stringify(expiresAt)},
223 "filters": ${stringify(filters)},
224 "container_count": ${stringify(containerCount)},
225 "use_existing": ${stringify(useExisting)},
226 "scheduling_parameters": ${stringifyObject(schedulingParameters)},
227 "output_uuid": ${stringify(outputUuid)},
228 "log_uuid": ${stringify(logUuid)},
229 "output_name": ${stringify(outputName)},
230 "output_ttl": ${stringify(outputTtl)}`;
235 const collectionApiResponse = (apiResponse: CollectionResource) => {
236 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, portableDataHash, replicationDesired,
237 replicationConfirmedAt, replicationConfirmed, manifestText, deleteAt, trashAt, isTrashed, storageClassesDesired,
238 storageClassesConfirmed, storageClassesConfirmedAt } = apiResponse;
239 const response = `"uuid": "${uuid}",
240 "owner_uuid": "${ownerUuid}",
241 "created_at": "${createdAt}",
242 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
243 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
244 "modified_at": ${stringify(modifiedAt)},
245 "portable_data_hash": ${stringify(portableDataHash)},
246 "replication_desired": ${stringify(replicationDesired)},
247 "replication_confirmed_at": ${stringify(replicationConfirmedAt)},
248 "replication_confirmed": ${stringify(replicationConfirmed)},
249 "manifest_text": ${stringify(manifestText)},
250 "name": ${stringify(name)},
251 "description": ${stringify(description)},
252 "properties": ${stringifyObject(properties)},
253 "delete_at": ${stringify(deleteAt)},
254 "trash_at": ${stringify(trashAt)},
255 "is_trashed": ${stringify(isTrashed)},
256 "storage_classes_desired": ${JSON.stringify(storageClassesDesired, null, 2)},
257 "storage_classes_confirmed": ${JSON.stringify(storageClassesConfirmed, null, 2)},
258 "storage_classes_confirmed_at": ${stringify(storageClassesConfirmedAt)}`;
263 const groupRequestApiResponse = (apiResponse: ProjectResource) => {
264 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, groupClass, trashAt, isTrashed, deleteAt, properties } = apiResponse;
265 const response = `"uuid": "${uuid}",
266 "owner_uuid": "${ownerUuid}",
267 "created_at": "${createdAt}",
268 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
269 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
270 "modified_at": ${stringify(modifiedAt)},
271 "name": ${stringify(name)},
272 "description": ${stringify(description)},
273 "group_class": ${stringify(groupClass)},
274 "trash_at": ${stringify(trashAt)},
275 "is_trashed": ${stringify(isTrashed)},
276 "delete_at": ${stringify(deleteAt)},
277 "properties": ${stringifyObject(properties)}`;
282 const repositoryApiResponse = (apiResponse: RepositoryResource) => {
283 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name } = apiResponse;
284 const response = `"uuid": "${uuid}",
285 "owner_uuid": "${ownerUuid}",
286 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
287 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
288 "modified_at": ${stringify(modifiedAt)},
289 "name": ${stringify(name)},
290 "created_at": "${createdAt}"`;
295 const sshKeyApiResponse = (apiResponse: SshKeyResource) => {
296 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, authorizedUserUuid, expiresAt } = apiResponse;
297 const response = `"uuid": "${uuid}",
298 "owner_uuid": "${ownerUuid}",
299 "authorized_user_uuid": "${authorizedUserUuid}",
300 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
301 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
302 "modified_at": ${stringify(modifiedAt)},
303 "name": ${stringify(name)},
304 "created_at": "${createdAt}",
305 "expires_at": "${expiresAt}"`;
309 const keepServiceApiResponse = (apiResponse: KeepServiceResource) => {
311 uuid, readOnly, serviceHost, servicePort, serviceSslFlag, serviceType,
312 ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid
314 const response = `"uuid": "${uuid}",
315 "owner_uuid": "${ownerUuid}",
316 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
317 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
318 "modified_at": ${stringify(modifiedAt)},
319 "service_host": "${serviceHost}",
320 "service_port": "${servicePort}",
321 "service_ssl_flag": "${stringify(serviceSslFlag)}",
322 "service_type": "${serviceType}",
323 "created_at": "${createdAt}",
324 "read_only": "${stringify(readOnly)}"`;