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
27 SupportEmailAddress: string;
53 ArvadosDocsite: string;
54 VocabularyURL: string;
55 FileViewersConfigURL: string;
56 WelcomePageHTML: string;
57 InactivePageHTML: string;
58 SSHHelpPageHTML: string;
59 SSHHelpHostSuffix: string;
85 ForwardSlashNameSubstitution: string;
91 keepWebServiceUrl: string;
92 keepWebInlineServiceUrl: string;
100 workbench2Url: string;
101 vocabularyUrl: string;
102 fileViewersConfigUrl: string;
103 loginCluster: string;
104 clusterConfig: ClusterConfigJSON;
108 export const buildConfig = (clusterConfig: ClusterConfigJSON): Config => {
109 const clusterConfigJSON = removeTrailingSlashes(clusterConfig);
110 const config = new Config();
111 config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL;
112 config.baseUrl = `${config.rootUrl}/${ARVADOS_API_PATH}`;
113 config.uuidPrefix = clusterConfigJSON.ClusterID;
114 config.websocketUrl = clusterConfigJSON.Services.Websocket.ExternalURL;
115 config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL;
116 config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL;
117 config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAVDownload.ExternalURL;
118 config.keepWebInlineServiceUrl = clusterConfigJSON.Services.WebDAV.ExternalURL;
119 config.loginCluster = clusterConfigJSON.Login.LoginCluster;
120 config.clusterConfig = clusterConfigJSON;
121 config.apiRevision = 0;
122 mapRemoteHosts(clusterConfigJSON, config);
126 const getApiRevision = async (apiUrl: string) => {
128 const dd = (await Axios.get<any>(`${apiUrl}/${DISCOVERY_DOC_PATH}`)).data;
129 return parseInt(dd.revision, 10) || 0;
131 console.warn("Unable to get API Revision number, defaulting to zero. Some features may not work properly.");
136 const removeTrailingSlashes = (config: ClusterConfigJSON): ClusterConfigJSON => {
137 const svcs: any = {};
138 Object.keys(config.Services).map((s) => {
139 svcs[s] = config.Services[s];
140 if (svcs[s].hasOwnProperty('ExternalURL')) {
141 svcs[s].ExternalURL = svcs[s].ExternalURL.replace(/\/+$/, '');
144 return { ...config, Services: svcs };
147 export const fetchConfig = () => {
149 .get<WorkbenchConfig>(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime())
150 .then(response => response.data)
152 console.warn(`There was an exception getting the Workbench config file at ${WORKBENCH_CONFIG_URL}. Using defaults instead.`);
153 return Promise.resolve(getDefaultConfig());
155 .then(workbenchConfig => {
156 if (workbenchConfig.API_HOST === undefined) {
157 throw new Error(`Unable to start Workbench. API_HOST is undefined in ${WORKBENCH_CONFIG_URL} or the environment.`);
159 return Axios.get<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(async response => {
160 const apiRevision = await getApiRevision(response.data.Services.Controller.ExternalURL.replace(/\/+$/, ''));
161 const config = { ...buildConfig(response.data), apiRevision };
162 const warnLocalConfig = (varName: string) => console.warn(
163 `A value for ${varName} was found in ${WORKBENCH_CONFIG_URL}. To use the Arvados centralized configuration instead, \
164 remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`);
166 // Check if the workbench config has an entry for vocabulary and file viewer URLs
167 // If so, use these values (even if it is an empty string), but print a console warning.
168 // Otherwise, use the cluster config.
169 let fileViewerConfigUrl;
170 if (workbenchConfig.FILE_VIEWERS_CONFIG_URL !== undefined) {
171 warnLocalConfig("FILE_VIEWERS_CONFIG_URL");
172 fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL;
175 fileViewerConfigUrl = config.clusterConfig.Workbench.FileViewersConfigURL || "/file-viewers-example.json";
177 config.fileViewersConfigUrl = fileViewerConfigUrl;
180 if (workbenchConfig.VOCABULARY_URL !== undefined) {
181 warnLocalConfig("VOCABULARY_URL");
182 vocabularyUrl = workbenchConfig.VOCABULARY_URL;
185 vocabularyUrl = config.clusterConfig.Workbench.VocabularyURL || "/vocabulary-example.json";
187 config.vocabularyUrl = vocabularyUrl;
189 return { config, apiHost: workbenchConfig.API_HOST };
194 // Maps remote cluster hosts and removes the default RemoteCluster entry
195 export const mapRemoteHosts = (clusterConfigJSON: ClusterConfigJSON, config: Config) => {
196 config.remoteHosts = {};
197 Object.keys(clusterConfigJSON.RemoteClusters).forEach(k => { config.remoteHosts[k] = clusterConfigJSON.RemoteClusters[k].Host; });
198 delete config.remoteHosts["*"];
201 export const mockClusterConfigJSON = (config: Partial<ClusterConfigJSON>): ClusterConfigJSON => ({
205 Controller: { ExternalURL: "" },
206 Workbench1: { ExternalURL: "" },
207 Workbench2: { ExternalURL: "" },
208 Websocket: { ExternalURL: "" },
209 WebDAV: { ExternalURL: "" },
210 WebDAVDownload: { ExternalURL: "" },
211 WebShell: { ExternalURL: "" },
216 FileViewersConfigURL: "",
218 InactivePageHTML: "",
220 SSHHelpHostSuffix: "",
246 ForwardSlashNameSubstitution: "",
251 export const mockConfig = (config: Partial<Config>): Config => ({
253 keepWebServiceUrl: "",
254 keepWebInlineServiceUrl: "",
262 fileViewersConfigUrl: "",
264 clusterConfig: mockClusterConfigJSON({}),
269 const getDefaultConfig = (): WorkbenchConfig => {
271 const envHost = process.env.REACT_APP_ARVADOS_API_HOST;
272 if (envHost !== undefined) {
273 console.warn(`Using default API host ${envHost}.`);
277 console.warn(`No API host was found in the environment. Workbench may not be able to communicate with Arvados components.`);
281 VOCABULARY_URL: undefined,
282 FILE_VIEWERS_CONFIG_URL: undefined,
286 export const ARVADOS_API_PATH = "arvados/v1";
287 export const CLUSTER_CONFIG_PATH = "arvados/v1/config";
288 export const DISCOVERY_DOC_PATH = "discovery/v1/apis/arvados/v1/rest";
289 export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_PATH}?nocache=${(new Date()).getTime()}`;