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;
56 keepWebServiceUrl: string;
64 workbench2Url: string;
65 vocabularyUrl: string;
66 fileViewersConfigUrl: string;
68 clusterConfig: ClusterConfigJSON;
71 export const fetchConfig = () => {
73 .get<WorkbenchConfig>(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime())
74 .then(response => response.data)
76 console.warn(`There was an exception getting the Workbench config file at ${WORKBENCH_CONFIG_URL}. Using defaults instead.`);
77 return Promise.resolve(getDefaultConfig());
79 .then(workbenchConfig => {
80 if (workbenchConfig.API_HOST === undefined) {
81 throw new Error(`Unable to start Workbench. API_HOST is undefined in ${WORKBENCH_CONFIG_URL} or the environment.`);
83 return Axios.get<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(response => {
84 const config = new Config();
85 const clusterConfigJSON = response.data;
86 const warnLocalConfig = (varName: string) => console.warn(
87 `A value for ${varName} was found in ${WORKBENCH_CONFIG_URL}. To use the Arvados centralized configuration instead, \
88 remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`);
90 // Check if the workbench config has an entry for vocabulary and file viewer URLs
91 // If so, use these values (even if it is an empty string), but print a console warning.
92 // Otherwise, use the cluster config.
93 let fileViewerConfigUrl;
94 if (workbenchConfig.FILE_VIEWERS_CONFIG_URL !== undefined) {
95 warnLocalConfig("FILE_VIEWERS_CONFIG_URL");
96 fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL;
99 fileViewerConfigUrl = clusterConfigJSON.Workbench.FileViewersConfigURL || "/file-viewers-example.json";
101 config.fileViewersConfigUrl = fileViewerConfigUrl;
104 if (workbenchConfig.VOCABULARY_URL !== undefined) {
105 warnLocalConfig("VOCABULARY_URL");
106 vocabularyUrl = workbenchConfig.VOCABULARY_URL;
109 vocabularyUrl = clusterConfigJSON.Workbench.VocabularyURL || "/vocabulary-example.json";
111 config.vocabularyUrl = vocabularyUrl;
113 config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL;
114 config.baseUrl = `${config.rootUrl}/${ARVADOS_API_PATH}`;
115 config.uuidPrefix = clusterConfigJSON.ClusterID;
116 config.websocketUrl = clusterConfigJSON.Services.Websocket.ExternalURL;
117 config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL;
118 config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL;
119 config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAV.ExternalURL;
120 config.loginCluster = clusterConfigJSON.Login.LoginCluster;
121 config.clusterConfig = clusterConfigJSON;
122 mapRemoteHosts(clusterConfigJSON, config);
124 return { config, apiHost: workbenchConfig.API_HOST };
129 // Maps remote cluster hosts and removes the default RemoteCluster entry
130 export const mapRemoteHosts = (clusterConfigJSON: ClusterConfigJSON, config: Config) => {
131 config.remoteHosts = {};
132 Object.keys(clusterConfigJSON.RemoteClusters).forEach(k => { config.remoteHosts[k] = clusterConfigJSON.RemoteClusters[k].Host; });
133 delete config.remoteHosts["*"];
136 export const mockClusterConfigJSON = (config: Partial<ClusterConfigJSON>): ClusterConfigJSON => ({
140 Controller: { ExternalURL: "" },
141 Workbench1: { ExternalURL: "" },
142 Workbench2: { ExternalURL: "" },
143 Websocket: { ExternalURL: "" },
144 WebDAV: { ExternalURL: "" },
149 FileViewersConfigURL: "",
158 export const mockConfig = (config: Partial<Config>): Config => ({
160 keepWebServiceUrl: "",
168 fileViewersConfigUrl: "",
170 clusterConfig: mockClusterConfigJSON({}),
174 const getDefaultConfig = (): WorkbenchConfig => {
176 const envHost = process.env.REACT_APP_ARVADOS_API_HOST;
177 if (envHost !== undefined) {
178 console.warn(`Using default API host ${envHost}.`);
182 console.warn(`No API host was found in the environment. Workbench may not be able to communicate with Arvados components.`);
186 VOCABULARY_URL: undefined,
187 FILE_VIEWERS_CONFIG_URL: undefined,
191 export const ARVADOS_API_PATH = "arvados/v1";
192 export const CLUSTER_CONFIG_URL = "arvados/v1/config";
193 export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_URL}?nocache=${(new Date()).getTime()}`;