X-Git-Url: https://git.arvados.org/arvados-workbench2.git/blobdiff_plain/76c84f182253b2b10b570d669589fa576dd8ba81..badcb86fb7d0e2ab87c7dcef230072db2e2ae95e:/src/common/config.ts?ds=inline diff --git a/src/common/config.ts b/src/common/config.ts index 044d7aa9..1f668292 100644 --- a/src/common/config.ts +++ b/src/common/config.ts @@ -8,13 +8,13 @@ export const WORKBENCH_CONFIG_URL = process.env.REACT_APP_ARVADOS_CONFIG_URL || interface WorkbenchConfig { API_HOST: string; - VOCABULARY_URL: string; - FILE_VIEWERS_CONFIG_URL: string; + VOCABULARY_URL?: string; + FILE_VIEWERS_CONFIG_URL?: string; } export interface ClusterConfigJSON { ClusterID: string; - RemoteClusters: { + RemoteClusters: { [key: string]: { ActivateUsers: boolean Host: string @@ -44,6 +44,7 @@ export interface ClusterConfigJSON { ArvadosDocsite: string; VocabularyURL: string; FileViewersConfigURL: string; + WelcomePageHTML: string; }; } @@ -60,30 +61,34 @@ export class Config { workbench2Url: string; vocabularyUrl: string; fileViewersConfigUrl: string; + clusterConfig: ClusterConfigJSON; } export const fetchConfig = () => { return Axios .get(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime()) .then(response => response.data) - .catch(() => Promise.resolve(getDefaultConfig())) - .then(workbenchConfig => Axios - .get(getClusterConfigURL(workbenchConfig.API_HOST)) - .then(response => { - + .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 docsite = clusterConfigJSON.Workbench.ArvadosDocsite; - const warnDeprecation = (varName: string) => console.warn( -`A value for ${varName} was found in ${WORKBENCH_CONFIG_URL}. This configuration is deprecated. \ -Please use the centralized configuration instead. See more at ${docsite}admin/config-migration.html`); + 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 or default values. + // Otherwise, use the cluster config. let fileViewerConfigUrl; if (workbenchConfig.FILE_VIEWERS_CONFIG_URL !== undefined) { - warnDeprecation("FILE_VIEWERS_CONFIG_URL"); + warnLocalConfig("FILE_VIEWERS_CONFIG_URL"); fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL; } else { @@ -93,7 +98,7 @@ Please use the centralized configuration instead. See more at ${docsite}admin/co let vocabularyUrl; if (workbenchConfig.VOCABULARY_URL !== undefined) { - warnDeprecation("VOCABULARY_URL"); + warnLocalConfig("VOCABULARY_URL"); vocabularyUrl = workbenchConfig.VOCABULARY_URL; } else { @@ -107,23 +112,41 @@ Please use the centralized configuration instead. See more at ${docsite}admin/co config.websocketUrl = clusterConfigJSON.Services.Websocket.ExternalURL; config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL; config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL; - config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAV.ExternalURL; + config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAV.ExternalURL; + config.clusterConfig = clusterConfigJSON; mapRemoteHosts(clusterConfigJSON, config); - console.log(config); - return { config, apiHost: workbenchConfig.API_HOST }; - }) - ); + }); + }); }; // 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; }); + Object.keys(clusterConfigJSON.RemoteClusters).forEach(k => { config.remoteHosts[k] = clusterConfigJSON.RemoteClusters[k].Host; }); delete config.remoteHosts["*"]; }; +export const mockClusterConfigJSON = (config: Partial): ClusterConfigJSON => ({ + ClusterID: "", + RemoteClusters: {}, + Services: { + Controller: { ExternalURL: "" }, + Workbench1: { ExternalURL: "" }, + Workbench2: { ExternalURL: "" }, + Websocket: { ExternalURL: "" }, + WebDAV: { ExternalURL: "" }, + }, + Workbench: { + ArvadosDocsite: "", + VocabularyURL: "", + FileViewersConfigURL: "", + WelcomePageHTML: "", + }, + ...config +}); + export const mockConfig = (config: Partial): Config => ({ baseUrl: "", keepWebServiceUrl: "", @@ -134,15 +157,28 @@ export const mockConfig = (config: Partial): Config => ({ workbenchUrl: "", workbench2Url: "", vocabularyUrl: "", - fileViewersConfigUrl: "" + fileViewersConfigUrl: "", + clusterConfig: mockClusterConfigJSON({}), + ...config }); -const getDefaultConfig = (): WorkbenchConfig => ({ - API_HOST: process.env.REACT_APP_ARVADOS_API_HOST || "", - VOCABULARY_URL: "", - FILE_VIEWERS_CONFIG_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 +export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_URL}?nocache=${(new Date()).getTime()}`;