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
50 ArvadosDocsite: string;
51 VocabularyURL: string;
52 FileViewersConfigURL: string;
53 WelcomePageHTML: string;
54 InactivePageHTML: string;
55 SSHHelpPageHTML: string;
56 SSHHelpHostSuffix: string;
64 ForwardSlashNameSubstitution: string;
70 keepWebServiceUrl: string;
78 workbench2Url: string;
79 vocabularyUrl: string;
80 fileViewersConfigUrl: string;
82 clusterConfig: ClusterConfigJSON;
86 export const buildConfig = (clusterConfigJSON: ClusterConfigJSON): Config => {
87 const config = new Config();
88 config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL;
89 config.baseUrl = `${config.rootUrl}/${ARVADOS_API_PATH}`;
90 config.uuidPrefix = clusterConfigJSON.ClusterID;
91 config.websocketUrl = clusterConfigJSON.Services.Websocket.ExternalURL;
92 config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL;
93 config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL;
94 config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAVDownload.ExternalURL;
95 config.loginCluster = clusterConfigJSON.Login.LoginCluster;
96 config.clusterConfig = clusterConfigJSON;
97 config.apiRevision = 0;
98 mapRemoteHosts(clusterConfigJSON, config);
102 const getApiRevision = async (apiUrl: string) => {
104 const dd = (await Axios.get<any>(`${apiUrl}/${DISCOVERY_DOC_PATH}`)).data;
105 return parseInt(dd.revision, 10) || 0;
107 console.warn("Unable to get API Revision number, defaulting to zero. Some features may not work properly.");
112 export const fetchConfig = () => {
114 .get<WorkbenchConfig>(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime())
115 .then(response => response.data)
117 console.warn(`There was an exception getting the Workbench config file at ${WORKBENCH_CONFIG_URL}. Using defaults instead.`);
118 return Promise.resolve(getDefaultConfig());
120 .then(workbenchConfig => {
121 if (workbenchConfig.API_HOST === undefined) {
122 throw new Error(`Unable to start Workbench. API_HOST is undefined in ${WORKBENCH_CONFIG_URL} or the environment.`);
124 return Axios.get<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(async response => {
125 const clusterConfigJSON = response.data;
126 const apiRevision = await getApiRevision(clusterConfigJSON.Services.Controller.ExternalURL);
127 const config = { ...buildConfig(clusterConfigJSON), apiRevision };
128 const warnLocalConfig = (varName: string) => console.warn(
129 `A value for ${varName} was found in ${WORKBENCH_CONFIG_URL}. To use the Arvados centralized configuration instead, \
130 remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`);
132 // Check if the workbench config has an entry for vocabulary and file viewer URLs
133 // If so, use these values (even if it is an empty string), but print a console warning.
134 // Otherwise, use the cluster config.
135 let fileViewerConfigUrl;
136 if (workbenchConfig.FILE_VIEWERS_CONFIG_URL !== undefined) {
137 warnLocalConfig("FILE_VIEWERS_CONFIG_URL");
138 fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL;
141 fileViewerConfigUrl = clusterConfigJSON.Workbench.FileViewersConfigURL || "/file-viewers-example.json";
143 config.fileViewersConfigUrl = fileViewerConfigUrl;
146 if (workbenchConfig.VOCABULARY_URL !== undefined) {
147 warnLocalConfig("VOCABULARY_URL");
148 vocabularyUrl = workbenchConfig.VOCABULARY_URL;
151 vocabularyUrl = clusterConfigJSON.Workbench.VocabularyURL || "/vocabulary-example.json";
153 config.vocabularyUrl = vocabularyUrl;
155 return { config, apiHost: workbenchConfig.API_HOST };
160 // Maps remote cluster hosts and removes the default RemoteCluster entry
161 export const mapRemoteHosts = (clusterConfigJSON: ClusterConfigJSON, config: Config) => {
162 config.remoteHosts = {};
163 Object.keys(clusterConfigJSON.RemoteClusters).forEach(k => { config.remoteHosts[k] = clusterConfigJSON.RemoteClusters[k].Host; });
164 delete config.remoteHosts["*"];
167 export const mockClusterConfigJSON = (config: Partial<ClusterConfigJSON>): ClusterConfigJSON => ({
171 Controller: { ExternalURL: "" },
172 Workbench1: { ExternalURL: "" },
173 Workbench2: { ExternalURL: "" },
174 Websocket: { ExternalURL: "" },
175 WebDAV: { ExternalURL: "" },
176 WebDAVDownload: { ExternalURL: "" },
177 WebShell: { ExternalURL: "" },
182 FileViewersConfigURL: "",
184 InactivePageHTML: "",
186 SSHHelpHostSuffix: "",
194 ForwardSlashNameSubstitution: "",
199 export const mockConfig = (config: Partial<Config>): Config => ({
201 keepWebServiceUrl: "",
209 fileViewersConfigUrl: "",
211 clusterConfig: mockClusterConfigJSON({}),
216 const getDefaultConfig = (): WorkbenchConfig => {
218 const envHost = process.env.REACT_APP_ARVADOS_API_HOST;
219 if (envHost !== undefined) {
220 console.warn(`Using default API host ${envHost}.`);
224 console.warn(`No API host was found in the environment. Workbench may not be able to communicate with Arvados components.`);
228 VOCABULARY_URL: undefined,
229 FILE_VIEWERS_CONFIG_URL: undefined,
233 export const ARVADOS_API_PATH = "arvados/v1";
234 export const CLUSTER_CONFIG_PATH = "arvados/v1/config";
235 export const DISCOVERY_DOC_PATH = "discovery/v1/apis/arvados/v1/rest";
236 export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_PATH}?nocache=${(new Date()).getTime()}`;