X-Git-Url: https://git.arvados.org/arvados-workbench2.git/blobdiff_plain/de9713360b5bc04dc3586b332bc98db5d97650a5..e62c661a8de391ae269a0170901c6b0290970620:/src/common/config.ts diff --git a/src/common/config.ts b/src/common/config.ts index 36fda624..23faaf91 100644 --- a/src/common/config.ts +++ b/src/common/config.ts @@ -38,12 +38,28 @@ export interface ClusterConfigJSON { } WebDAV: { ExternalURL: string + }, + WebDAVDownload: { + ExternalURL: string + }, + WebShell: { + ExternalURL: string } }; Workbench: { ArvadosDocsite: string; VocabularyURL: string; FileViewersConfigURL: string; + WelcomePageHTML: string; + InactivePageHTML: string; + SSHHelpPageHTML: string; + SiteName: string; + }; + Login: { + LoginCluster: string; + }; + Collections: { + ForwardSlashNameSubstitution: string; }; } @@ -60,20 +76,40 @@ export class Config { workbench2Url: string; vocabularyUrl: string; fileViewersConfigUrl: string; + loginCluster: string; + clusterConfig: ClusterConfigJSON; } +export const buildConfig = (clusterConfigJSON: ClusterConfigJSON): Config => { + const config = new Config(); + 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.WebDAVDownload.ExternalURL; + config.loginCluster = clusterConfigJSON.Login.LoginCluster; + config.clusterConfig = clusterConfigJSON; + mapRemoteHosts(clusterConfigJSON, config); + return config; +}; + 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 => { - - const config = new Config(); + .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 clusterConfigJSON = response.data; - const docsite = clusterConfigJSON.Workbench.ArvadosDocsite; + const config = buildConfig(clusterConfigJSON); 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}`); @@ -101,18 +137,9 @@ remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`); } 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 }; - }) - ); + }); + }); }; // Maps remote cluster hosts and removes the default RemoteCluster entry @@ -122,6 +149,36 @@ export const mapRemoteHosts = (clusterConfigJSON: ClusterConfigJSON, config: Con delete config.remoteHosts["*"]; }; +export const mockClusterConfigJSON = (config: Partial): ClusterConfigJSON => ({ + ClusterID: "", + RemoteClusters: {}, + Services: { + Controller: { ExternalURL: "" }, + Workbench1: { ExternalURL: "" }, + Workbench2: { ExternalURL: "" }, + Websocket: { ExternalURL: "" }, + WebDAV: { ExternalURL: "" }, + WebDAVDownload: { ExternalURL: "" }, + WebShell: { ExternalURL: "" }, + }, + Workbench: { + ArvadosDocsite: "", + VocabularyURL: "", + FileViewersConfigURL: "", + WelcomePageHTML: "", + InactivePageHTML: "", + SSHHelpPageHTML: "", + SiteName: "", + }, + Login: { + LoginCluster: "", + }, + Collections: { + ForwardSlashNameSubstitution: "", + }, + ...config +}); + export const mockConfig = (config: Partial): Config => ({ baseUrl: "", keepWebServiceUrl: "", @@ -132,15 +189,30 @@ export const mockConfig = (config: Partial): Config => ({ workbenchUrl: "", workbench2Url: "", vocabularyUrl: "", - fileViewersConfigUrl: "" + fileViewersConfigUrl: "", + loginCluster: "", + clusterConfig: mockClusterConfigJSON({}), + ...config }); -const getDefaultConfig = (): WorkbenchConfig => ({ - API_HOST: process.env.REACT_APP_ARVADOS_API_HOST || "", - VOCABULARY_URL: undefined, - FILE_VIEWERS_CONFIG_URL: undefined, -}); +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 CLUSTER_CONFIG_PATH = "arvados/v1/config"; +export const DISCOVERY_DOC_PATH = "discovery/v1/apis/arvados/v1/rest"; +export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_PATH}?nocache=${(new Date()).getTime()}`;