X-Git-Url: https://git.arvados.org/arvados-workbench2.git/blobdiff_plain/f0d519637c997df11d5b1a1b32b3d9e4a2872325..646e1d88d8aac461e0a13b6c0f1aa1b198e3659c:/src/common/config.ts diff --git a/src/common/config.ts b/src/common/config.ts index 492328d9..496b0b78 100644 --- a/src/common/config.ts +++ b/src/common/config.ts @@ -4,30 +4,157 @@ import Axios from "axios"; -export const CONFIG_URL = process.env.REACT_APP_ARVADOS_CONFIG_URL || "/config.json"; +export const WORKBENCH_CONFIG_URL = process.env.REACT_APP_ARVADOS_CONFIG_URL || "/config.json"; -export interface Config { - apiHost: string; - keepWebHost: string; +interface WorkbenchConfig { + API_HOST: string; + VOCABULARY_URL?: string; + FILE_VIEWERS_CONFIG_URL?: string; +} + +export interface ClusterConfigJSON { + ClusterID: string; + RemoteClusters: { + [key: string]: { + ActivateUsers: boolean + Host: string + Insecure: boolean + Proxy: boolean + Scheme: string + } + }; + Services: { + Controller: { + ExternalURL: string + } + Workbench1: { + ExternalURL: string + } + Workbench2: { + ExternalURL: string + } + Websocket: { + ExternalURL: string + } + WebDAV: { + ExternalURL: string + } + }; + Workbench: { + ArvadosDocsite: string; + VocabularyURL: string; + FileViewersConfigURL: string; + }; +} + +export class Config { + baseUrl: string; + keepWebServiceUrl: string; + remoteHosts: { + [key: string]: string + }; + rootUrl: string; + uuidPrefix: string; + websocketUrl: string; + workbenchUrl: string; + workbench2Url: string; + vocabularyUrl: string; + fileViewersConfigUrl: string; } export const fetchConfig = () => { return Axios - .get(CONFIG_URL + "?nocache=" + (new Date()).getTime()) + .get(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime()) .then(response => response.data) - .catch(() => Promise.resolve(getDefaultConfig())) - .then(mapConfig); + .catch(() => { + console.warn(`There was an exception getting the Workbench config file at ${WORKBENCH_CONFIG_URL}. Using defaults instead.`); + return Promise.resolve(getDefaultConfig()); + }) + .then(workbenchConfig => { + if (workbenchConfig.API_HOST === undefined) { + throw new Error(`Unable to start Workbench. API_HOST is undefined in ${WORKBENCH_CONFIG_URL} or the environment.`); + } + return Axios.get(getClusterConfigURL(workbenchConfig.API_HOST)).then(response => { + const config = new Config(); + const clusterConfigJSON = response.data; + const warnLocalConfig = (varName: string) => console.warn( + `A value for ${varName} was found in ${WORKBENCH_CONFIG_URL}. To use the Arvados centralized configuration instead, \ +remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`); + + // Check if the workbench config has an entry for vocabulary and file viewer URLs + // If so, use these values (even if it is an empty string), but print a console warning. + // Otherwise, use the cluster config. + let fileViewerConfigUrl; + if (workbenchConfig.FILE_VIEWERS_CONFIG_URL !== undefined) { + warnLocalConfig("FILE_VIEWERS_CONFIG_URL"); + fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL; + } + else { + fileViewerConfigUrl = clusterConfigJSON.Workbench.FileViewersConfigURL || "/file-viewers-example.json"; + } + config.fileViewersConfigUrl = fileViewerConfigUrl; + + let vocabularyUrl; + if (workbenchConfig.VOCABULARY_URL !== undefined) { + warnLocalConfig("VOCABULARY_URL"); + vocabularyUrl = workbenchConfig.VOCABULARY_URL; + } + else { + vocabularyUrl = clusterConfigJSON.Workbench.VocabularyURL || "/vocabulary-example.json"; + } + config.vocabularyUrl = vocabularyUrl; + + config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL; + config.baseUrl = `${config.rootUrl}/${ARVADOS_API_PATH}`; + config.uuidPrefix = clusterConfigJSON.ClusterID; + config.websocketUrl = clusterConfigJSON.Services.Websocket.ExternalURL; + config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL; + config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL; + config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAV.ExternalURL; + mapRemoteHosts(clusterConfigJSON, config); + + return { config, apiHost: workbenchConfig.API_HOST }; + }); + }); }; -const mapConfig = (config: Config): Config => ({ - ...config, - apiHost: addProtocol(config.apiHost), - keepWebHost: addProtocol(config.keepWebHost) -}); +// Maps remote cluster hosts and removes the default RemoteCluster entry +export const mapRemoteHosts = (clusterConfigJSON: ClusterConfigJSON, config: Config) => { + config.remoteHosts = {}; + Object.keys(clusterConfigJSON.RemoteClusters).forEach(k => { config.remoteHosts[k] = clusterConfigJSON.RemoteClusters[k].Host; }); + delete config.remoteHosts["*"]; +}; -const getDefaultConfig = (): Config => ({ - apiHost: process.env.REACT_APP_ARVADOS_API_HOST || "", - keepWebHost: process.env.REACT_APP_ARVADOS_KEEP_WEB_HOST || "" +export const mockConfig = (config: Partial): Config => ({ + baseUrl: "", + keepWebServiceUrl: "", + remoteHosts: {}, + rootUrl: "", + uuidPrefix: "", + websocketUrl: "", + workbenchUrl: "", + workbench2Url: "", + vocabularyUrl: "", + fileViewersConfigUrl: "" }); -const addProtocol = (url: string) => `${window.location.protocol}//${url}`; +const getDefaultConfig = (): WorkbenchConfig => { + let apiHost = ""; + const envHost = process.env.REACT_APP_ARVADOS_API_HOST; + if (envHost !== undefined) { + console.warn(`Using default API host ${envHost}.`); + apiHost = envHost; + } + else { + console.warn(`No API host was found in the environment. Workbench may not be able to communicate with Arvados components.`); + } + return { + API_HOST: apiHost, + VOCABULARY_URL: undefined, + FILE_VIEWERS_CONFIG_URL: undefined, + }; +}; + +export const ARVADOS_API_PATH = "arvados/v1"; +export const CLUSTER_CONFIG_URL = "arvados/v1/config"; +export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_URL}?nocache=${(new Date()).getTime()}`; \ No newline at end of file