X-Git-Url: https://git.arvados.org/arvados-workbench2.git/blobdiff_plain/ccec2628805e5eab520425aa8489b20ce80acf2b..172ba18e43743d90b8a1110d62209be2ab7627d1:/src/common/config.ts diff --git a/src/common/config.ts b/src/common/config.ts index 23faaf91..2518c95e 100644 --- a/src/common/config.ts +++ b/src/common/config.ts @@ -23,6 +23,9 @@ export interface ClusterConfigJSON { Scheme: string } }; + Mail?: { + SupportEmailAddress: string; + }; Services: { Controller: { ExternalURL: string @@ -48,39 +51,76 @@ export interface ClusterConfigJSON { }; Workbench: { ArvadosDocsite: string; - VocabularyURL: string; FileViewersConfigURL: string; WelcomePageHTML: string; InactivePageHTML: string; SSHHelpPageHTML: string; + SSHHelpHostSuffix: string; SiteName: string; + IdleTimeout: string; }; Login: { LoginCluster: string; + Google: { + Enable: boolean; + } + LDAP: { + Enable: boolean; + } + OpenIDConnect: { + Enable: boolean; + } + PAM: { + Enable: boolean; + } + SSO: { + Enable: boolean; + } + Test: { + Enable: boolean; + } }; Collections: { ForwardSlashNameSubstitution: string; + ManagedProperties?: { + [key: string]: { + Function: string, + Value: string, + Protected?: boolean, + } + }, + TrustAllContent: boolean + }; + Volumes: { + [key: string]: { + StorageClasses: { + [key: string]: boolean; + } + } }; } export class Config { - baseUrl: string; - keepWebServiceUrl: string; - remoteHosts: { + baseUrl!: string; + keepWebServiceUrl!: string; + keepWebInlineServiceUrl!: string; + remoteHosts!: { [key: string]: string }; - rootUrl: string; - uuidPrefix: string; - websocketUrl: string; - workbenchUrl: string; - workbench2Url: string; - vocabularyUrl: string; - fileViewersConfigUrl: string; - loginCluster: string; - clusterConfig: ClusterConfigJSON; + rootUrl!: string; + uuidPrefix!: string; + websocketUrl!: string; + workbenchUrl!: string; + workbench2Url!: string; + vocabularyUrl!: string; + fileViewersConfigUrl!: string; + loginCluster!: string; + clusterConfig!: ClusterConfigJSON; + apiRevision!: number; } -export const buildConfig = (clusterConfigJSON: ClusterConfigJSON): Config => { +export const buildConfig = (clusterConfig: ClusterConfigJSON): Config => { + const clusterConfigJSON = removeTrailingSlashes(clusterConfig); const config = new Config(); config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL; config.baseUrl = `${config.rootUrl}/${ARVADOS_API_PATH}`; @@ -89,12 +129,48 @@ export const buildConfig = (clusterConfigJSON: ClusterConfigJSON): Config => { config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL; config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL; config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAVDownload.ExternalURL; + config.keepWebInlineServiceUrl = clusterConfigJSON.Services.WebDAV.ExternalURL; config.loginCluster = clusterConfigJSON.Login.LoginCluster; config.clusterConfig = clusterConfigJSON; + config.apiRevision = 0; mapRemoteHosts(clusterConfigJSON, config); return config; }; +export const getStorageClasses = (config: Config): string[] => { + const classes: Set = new Set(['default']); + const volumes = config.clusterConfig.Volumes; + Object.keys(volumes).forEach(v => { + Object.keys(volumes[v].StorageClasses || {}).forEach(sc => { + if (volumes[v].StorageClasses[sc]) { + classes.add(sc); + } + }); + }); + return Array.from(classes); +}; + +const getApiRevision = async (apiUrl: string) => { + try { + const dd = (await Axios.get(`${apiUrl}/${DISCOVERY_DOC_PATH}`)).data; + return parseInt(dd.revision, 10) || 0; + } catch { + console.warn("Unable to get API Revision number, defaulting to zero. Some features may not work properly."); + return 0; + } +}; + +const removeTrailingSlashes = (config: ClusterConfigJSON): ClusterConfigJSON => { + const svcs: any = {}; + Object.keys(config.Services).forEach((s) => { + svcs[s] = config.Services[s]; + if (svcs[s].hasOwnProperty('ExternalURL')) { + svcs[s].ExternalURL = svcs[s].ExternalURL.replace(/\/+$/, ''); + } + }); + return { ...config, Services: svcs }; +}; + export const fetchConfig = () => { return Axios .get(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime()) @@ -107,9 +183,9 @@ export const fetchConfig = () => { 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 config = buildConfig(clusterConfigJSON); + return Axios.get(getClusterConfigURL(workbenchConfig.API_HOST)).then(async response => { + const apiRevision = await getApiRevision(response.data.Services.Controller.ExternalURL.replace(/\/+$/, '')); + const config = { ...buildConfig(response.data), apiRevision }; 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}`); @@ -123,19 +199,14 @@ remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`); fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL; } else { - fileViewerConfigUrl = clusterConfigJSON.Workbench.FileViewersConfigURL || "/file-viewers-example.json"; + fileViewerConfigUrl = config.clusterConfig.Workbench.FileViewersConfigURL || "/file-viewers-example.json"; } config.fileViewersConfigUrl = fileViewerConfigUrl; - let vocabularyUrl; if (workbenchConfig.VOCABULARY_URL !== undefined) { - warnLocalConfig("VOCABULARY_URL"); - vocabularyUrl = workbenchConfig.VOCABULARY_URL; + console.warn(`A value for VOCABULARY_URL was found in ${WORKBENCH_CONFIG_URL}. It will be ignored as the cluster already provides its own endpoint, you can safely remove it.`) } - else { - vocabularyUrl = clusterConfigJSON.Workbench.VocabularyURL || "/vocabulary-example.json"; - } - config.vocabularyUrl = vocabularyUrl; + config.vocabularyUrl = getVocabularyURL(workbenchConfig.API_HOST); return { config, apiHost: workbenchConfig.API_HOST }; }); @@ -163,25 +234,47 @@ export const mockClusterConfigJSON = (config: Partial): Clust }, Workbench: { ArvadosDocsite: "", - VocabularyURL: "", FileViewersConfigURL: "", WelcomePageHTML: "", InactivePageHTML: "", SSHHelpPageHTML: "", + SSHHelpHostSuffix: "", SiteName: "", + IdleTimeout: "0s", }, Login: { LoginCluster: "", + Google: { + Enable: false, + }, + LDAP: { + Enable: false, + }, + OpenIDConnect: { + Enable: false, + }, + PAM: { + Enable: false, + }, + SSO: { + Enable: false, + }, + Test: { + Enable: false, + }, }, Collections: { ForwardSlashNameSubstitution: "", + TrustAllContent: false, }, + Volumes: {}, ...config }); export const mockConfig = (config: Partial): Config => ({ baseUrl: "", keepWebServiceUrl: "", + keepWebInlineServiceUrl: "", remoteHosts: {}, rootUrl: "", uuidPrefix: "", @@ -192,6 +285,7 @@ export const mockConfig = (config: Partial): Config => ({ fileViewersConfigUrl: "", loginCluster: "", clusterConfig: mockClusterConfigJSON({}), + apiRevision: 0, ...config }); @@ -214,5 +308,7 @@ const getDefaultConfig = (): WorkbenchConfig => { export const ARVADOS_API_PATH = "arvados/v1"; export const CLUSTER_CONFIG_PATH = "arvados/v1/config"; +export const VOCABULARY_PATH = "arvados/v1/vocabulary"; 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()}`; +export const getClusterConfigURL = (apiHost: string) => `https://${apiHost}/${CLUSTER_CONFIG_PATH}?nocache=${(new Date()).getTime()}`; +export const getVocabularyURL = (apiHost: string) => `https://${apiHost}/${VOCABULARY_PATH}?nocache=${(new Date()).getTime()}`;