1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import { dialogActions } from '~/store/dialog/dialog-actions';
6 import { RootState } from '~/store/store';
7 import { Dispatch } from 'redux';
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';
19 export const ADVANCED_TAB_DIALOG = 'advancedTabDialog';
21 export interface AdvancedTabDialogData {
26 pythonExample: string;
28 cliGetExample: string;
29 cliUpdateHeader: string;
30 cliUpdateExample: string;
36 COLLECTION = 'collection',
37 STORAGE_CLASSES_CONFIRMED = 'storage_classes_confirmed'
41 CONTAINER_REQUEST = 'container_request',
42 OUTPUT_NAME = 'output_name'
47 DELETE_AT = 'delete_at'
51 REPOSITORY = 'repository',
52 CREATED_AT = 'created_at'
55 export const openAdvancedTabDialog = (uuid: string, index?: number) =>
56 async (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
57 const { resources } = getState();
58 const kind = extractUuidKind(uuid);
59 const data = getResource<any>(uuid)(resources);
60 const repositoryData = getState().repositories.items[index!];
61 if (data || repositoryData) {
63 const user = await services.userService.get(data.ownerUuid);
64 const metadata = await services.linkService.list({
65 filters: new FilterBuilder()
66 .addEqual('headUuid', uuid)
69 if (kind === ResourceKind.COLLECTION) {
70 const dataCollection: AdvancedTabDialogData = advancedTabData(uuid, metadata, user, collectionApiResponse, data, CollectionData.COLLECTION, GroupContentsResourcePrefix.COLLECTION, CollectionData.STORAGE_CLASSES_CONFIRMED, data.storageClassesConfirmed);
71 dispatch(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: dataCollection }));
72 } else if (kind === ResourceKind.PROCESS) {
73 const dataProcess: AdvancedTabDialogData = advancedTabData(uuid, metadata, user, containerRequestApiResponse, data, ProcessData.CONTAINER_REQUEST, GroupContentsResourcePrefix.PROCESS, ProcessData.OUTPUT_NAME, data.outputName);
74 dispatch(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: dataProcess }));
75 } else if (kind === ResourceKind.PROJECT) {
76 const dataProject: AdvancedTabDialogData = advancedTabData(uuid, metadata, user, groupRequestApiResponse, data, ProjectData.GROUP, GroupContentsResourcePrefix.PROJECT, ProjectData.DELETE_AT, data.deleteAt);
77 dispatch(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: dataProject }));
80 } else if (kind === ResourceKind.REPOSITORY) {
81 const dataRepository: AdvancedTabDialogData = advancedTabData(uuid, '', '', repositoryApiResponse, repositoryData, RepositoryData.REPOSITORY, 'repositories', RepositoryData.CREATED_AT, repositoryData.createdAt);
82 dispatch(dialogActions.OPEN_DIALOG({ id: ADVANCED_TAB_DIALOG, data: dataRepository }));
85 dispatch(snackbarActions.OPEN_SNACKBAR({ message: "Could not open advanced tab for this resource.", hideDuration: 2000, kind: SnackbarKind.ERROR }));
89 const advancedTabData = (uuid: string, metadata: any, user: any, apiResponseKind: any, data: any, resourceKind: CollectionData | ProcessData | ProjectData | RepositoryData, resourcePrefix: GroupContentsResourcePrefix | 'repositories', resourceKindProperty: CollectionData | ProcessData | ProjectData | RepositoryData, property: any) => {
94 apiResponse: apiResponseKind(data),
95 pythonHeader: pythonHeader(resourceKind),
96 pythonExample: pythonExample(uuid, resourcePrefix),
97 cliGetHeader: cliGetHeader(resourceKind),
98 cliGetExample: cliGetExample(uuid, resourceKind),
99 cliUpdateHeader: cliUpdateHeader(resourceKind, resourceKindProperty),
100 cliUpdateExample: cliUpdateExample(uuid, resourceKind, property, resourceKindProperty),
101 curlHeader: curlHeader(resourceKind, resourceKindProperty),
102 curlExample: curlExample(uuid, resourcePrefix, property, resourceKind, resourceKindProperty),
106 const pythonHeader = (resourceKind: string) =>
107 `An example python command to get a ${resourceKind} using its uuid:`;
109 const pythonExample = (uuid: string, resourcePrefix: string) => {
110 const pythonExample = `import arvados
112 x = arvados.api().${resourcePrefix}().get(uuid='${uuid}').execute()`;
114 return pythonExample;
117 const cliGetHeader = (resourceKind: string) =>
118 `An example arv command to get a ${resourceKind} using its uuid:`;
120 const cliGetExample = (uuid: string, resourceKind: string) => {
121 const cliGetExample = `arv ${resourceKind} get \\
124 return cliGetExample;
127 const cliUpdateHeader = (resourceKind: string, resourceName: string) =>
128 `An example arv command to update the "${resourceName}" attribute for the current ${resourceKind}:`;
130 const cliUpdateExample = (uuid: string, resourceKind: string, resource: string | string[], resourceName: string) => {
131 const CLIUpdateCollectionExample = `arv ${resourceKind} update \\
133 --${resourceKind} '{"${resourceName}":${resource}}'`;
135 return CLIUpdateCollectionExample;
138 const curlHeader = (resourceKind: string, resource: string) =>
139 `An example curl command to update the "${resource}" attribute for the current ${resourceKind}:`;
141 const curlExample = (uuid: string, resourcePrefix: string, resource: string | string[], resourceKind: string, resourceName: string) => {
142 const curlExample = `curl -X PUT \\
143 -H "Authorization: OAuth2 $ARVADOS_API_TOKEN" \\
144 --data-urlencode ${resourceKind}@/dev/stdin \\
145 https://$ARVADOS_API_HOST/arvados/v1/${resourcePrefix}/${uuid} \\
148 "${resourceName}": ${resource}
155 const stringify = (item: string | null | number | boolean) =>
156 JSON.stringify(item) || 'null';
158 const stringifyObject = (item: any) =>
159 JSON.stringify(item, null, 2) || 'null';
161 const containerRequestApiResponse = (apiResponse: ContainerRequestResource) => {
162 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, state, requestingContainerUuid, containerUuid,
163 containerCountMax, mounts, runtimeConstraints, containerImage, environment, cwd, command, outputPath, priority, expiresAt, filters, containerCount,
164 useExisting, schedulingParameters, outputUuid, logUuid, outputName, outputTtl } = apiResponse;
165 const response = `"uuid": "${uuid}",
166 "owner_uuid": "${ownerUuid}",
167 "created_at": "${createdAt}",
168 "modified_at": ${stringify(modifiedAt)},
169 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
170 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
171 "name": ${stringify(name)},
172 "description": ${stringify(description)},
173 "properties": ${stringifyObject(properties)},
174 "state": ${stringify(state)},
175 "requesting_container_uuid": ${stringify(requestingContainerUuid)},
176 "container_uuid": ${stringify(containerUuid)},
177 "container_count_max": ${stringify(containerCountMax)},
178 "mounts": ${stringifyObject(mounts)},
179 "runtime_constraints": ${stringifyObject(runtimeConstraints)},
180 "container_image": "${stringify(containerImage)}",
181 "environment": ${stringifyObject(environment)},
182 "cwd": ${stringify(cwd)},
183 "command": ${stringifyObject(command)},
184 "output_path": ${stringify(outputPath)},
185 "priority": ${stringify(priority)},
186 "expires_at": ${stringify(expiresAt)},
187 "filters": ${stringify(filters)},
188 "container_count": ${stringify(containerCount)},
189 "use_existing": ${stringify(useExisting)},
190 "scheduling_parameters": ${stringifyObject(schedulingParameters)},
191 "output_uuid": ${stringify(outputUuid)},
192 "log_uuid": ${stringify(logUuid)},
193 "output_name": ${stringify(outputName)},
194 "output_ttl": ${stringify(outputTtl)}`;
199 const collectionApiResponse = (apiResponse: CollectionResource) => {
200 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, properties, portableDataHash, replicationDesired,
201 replicationConfirmedAt, replicationConfirmed, manifestText, deleteAt, trashAt, isTrashed, storageClassesDesired,
202 storageClassesConfirmed, storageClassesConfirmedAt } = apiResponse;
203 const response = `"uuid": "${uuid}",
204 "owner_uuid": "${ownerUuid}",
205 "created_at": "${createdAt}",
206 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
207 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
208 "modified_at": ${stringify(modifiedAt)},
209 "portable_data_hash": ${stringify(portableDataHash)},
210 "replication_desired": ${stringify(replicationDesired)},
211 "replication_confirmed_at": ${stringify(replicationConfirmedAt)},
212 "replication_confirmed": ${stringify(replicationConfirmed)},
213 "manifest_text": ${stringify(manifestText)},
214 "name": ${stringify(name)},
215 "description": ${stringify(description)},
216 "properties": ${stringifyObject(properties)},
217 "delete_at": ${stringify(deleteAt)},
218 "trash_at": ${stringify(trashAt)},
219 "is_trashed": ${stringify(isTrashed)},
220 "storage_classes_desired": ${JSON.stringify(storageClassesDesired, null, 2)},
221 "storage_classes_confirmed": ${JSON.stringify(storageClassesConfirmed, null, 2)},
222 "storage_classes_confirmed_at": ${stringify(storageClassesConfirmedAt)}`;
227 const groupRequestApiResponse = (apiResponse: ProjectResource) => {
228 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name, description, groupClass, trashAt, isTrashed, deleteAt, properties } = apiResponse;
229 const response = `"uuid": "${uuid}",
230 "owner_uuid": "${ownerUuid}",
231 "created_at": "${createdAt}",
232 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
233 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
234 "modified_at": ${stringify(modifiedAt)},
235 "name": ${stringify(name)},
236 "description": ${stringify(description)},
237 "group_class": ${stringify(groupClass)},
238 "trash_at": ${stringify(trashAt)},
239 "is_trashed": ${stringify(isTrashed)},
240 "delete_at": ${stringify(deleteAt)},
241 "properties": ${stringifyObject(properties)}`;
246 const repositoryApiResponse = (apiResponse: RepositoryResource) => {
247 const { uuid, ownerUuid, createdAt, modifiedAt, modifiedByClientUuid, modifiedByUserUuid, name } = apiResponse;
248 const response = `"uuid": "${uuid}",
249 "owner_uuid": "${ownerUuid}",
250 "modified_by_client_uuid": ${stringify(modifiedByClientUuid)},
251 "modified_by_user_uuid": ${stringify(modifiedByUserUuid)},
252 "modified_at": ${stringify(modifiedAt)},
253 "name": ${stringify(name)},
254 "created_at": "${createdAt}"`;