1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import Axios from "axios";
7 export const WORKBENCH_CONFIG_URL = process.env.REACT_APP_ARVADOS_CONFIG_URL || "/config.json";
9 interface WorkbenchConfig {
11 VOCABULARY_URL?: string;
12 FILE_VIEWERS_CONFIG_URL?: string;
15 export interface ClusterConfigJSON {
19 ActivateUsers: boolean
44 ArvadosDocsite: string;
45 VocabularyURL: string;
46 FileViewersConfigURL: string;
47 WelcomePageHTML: string;
48 InactivePageHTML: string;
54 keepWebServiceUrl: string;
62 workbench2Url: string;
63 vocabularyUrl: string;
64 fileViewersConfigUrl: string;
65 clusterConfig: ClusterConfigJSON;
68 export const fetchConfig = () => {
70 .get<WorkbenchConfig>(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime())
71 .then(response => response.data)
73 console.warn(`There was an exception getting the Workbench config file at ${WORKBENCH_CONFIG_URL}. Using defaults instead.`);
74 return Promise.resolve(getDefaultConfig());
76 .then(workbenchConfig => {
77 if (workbenchConfig.API_HOST === undefined) {
78 throw new Error(`Unable to start Workbench. API_HOST is undefined in ${WORKBENCH_CONFIG_URL} or the environment.`);
80 return Axios.get<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(response => {
81 const config = new Config();
82 const clusterConfigJSON = response.data;
83 const warnLocalConfig = (varName: string) => console.warn(
84 `A value for ${varName} was found in ${WORKBENCH_CONFIG_URL}. To use the Arvados centralized configuration instead, \
85 remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`);
87 // Check if the workbench config has an entry for vocabulary and file viewer URLs
88 // If so, use these values (even if it is an empty string), but print a console warning.
89 // Otherwise, use the cluster config.
90 let fileViewerConfigUrl;
91 if (workbenchConfig.FILE_VIEWERS_CONFIG_URL !== undefined) {
92 warnLocalConfig("FILE_VIEWERS_CONFIG_URL");
93 fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL;
96 fileViewerConfigUrl = clusterConfigJSON.Workbench.FileViewersConfigURL || "/file-viewers-example.json";
98 config.fileViewersConfigUrl = fileViewerConfigUrl;
101 if (workbenchConfig.VOCABULARY_URL !== undefined) {
102 warnLocalConfig("VOCABULARY_URL");
103 vocabularyUrl = workbenchConfig.VOCABULARY_URL;
106 vocabularyUrl = clusterConfigJSON.Workbench.VocabularyURL || "/vocabulary-example.json";
108 config.vocabularyUrl = vocabularyUrl;
110 config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL;
111 config.baseUrl = `${config.rootUrl}/${ARVADOS_API_PATH}`;
112 config.uuidPrefix = clusterConfigJSON.ClusterID;
113 config.websocketUrl = clusterConfigJSON.Services.Websocket.ExternalURL;
114 config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL;
115 config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL;
116 config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAV.ExternalURL;
117 config.clusterConfig = clusterConfigJSON;
118 mapRemoteHosts(clusterConfigJSON, config);
120 return { config, apiHost: workbenchConfig.API_HOST };
125 // Maps remote cluster hosts and removes the default RemoteCluster entry
126 export const mapRemoteHosts = (clusterConfigJSON: ClusterConfigJSON, config: Config) => {
127 config.remoteHosts = {};
128 Object.keys(clusterConfigJSON.RemoteClusters).forEach(k => { config.remoteHosts[k] = clusterConfigJSON.RemoteClusters[k].Host; });
129 delete config.remoteHosts["*"];
132 export const mockClusterConfigJSON = (config: Partial<ClusterConfigJSON>): ClusterConfigJSON => ({
136 Controller: { ExternalURL: "" },
137 Workbench1: { ExternalURL: "" },
138 Workbench2: { ExternalURL: "" },
139 Websocket: { ExternalURL: "" },
140 WebDAV: { ExternalURL: "" },
145 FileViewersConfigURL: "",
147 InactivePageHTML: "",
152 export const mockConfig = (config: Partial<Config>): Config => ({
154 keepWebServiceUrl: "",
162 fileViewersConfigUrl: "",
163 clusterConfig: mockClusterConfigJSON({}),
167 const getDefaultConfig = (): WorkbenchConfig => {
169 const envHost = process.env.REACT_APP_ARVADOS_API_HOST;
170 if (envHost !== undefined) {
171 console.warn(`Using default API host ${envHost}.`);
175 console.warn(`No API host was found in the environment. Workbench may not be able to communicate with Arvados components.`);
179 VOCABULARY_URL: undefined,
180 FILE_VIEWERS_CONFIG_URL: undefined,
184 export const ARVADOS_API_PATH = "arvados/v1";
185 export const CLUSTER_CONFIG_URL = "arvados/v1/config";
186 export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_URL}?nocache=${(new Date()).getTime()}`;