From de9713360b5bc04dc3586b332bc98db5d97650a5 Mon Sep 17 00:00:00 2001 From: Eric Biagiotti Date: Wed, 31 Jul 2019 10:49:14 -0400 Subject: [PATCH] 14813: Fix to use cluster config when local config values aren't defined Also updates readme to describe how to use the cluster config and softens the warning language. Arvados-DCO-1.1-Signed-off-by: Eric Biagiotti --- README.md | 4 ++++ src/common/config.ts | 26 +++++++++++++------------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 425d1787..bca04b1e 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,8 @@ Currently this configuration schema is supported: Local path, or any URL that allows cross-origin requests. See [Vocabulary JSON file example](public/vocabulary-example.json). +To use the URL defined in the Arvados cluster configuration, remove the entire VOCABULARY_URL entry from the runtime configuration. Found in `/config.json` by default. + ### FILE_VIEWERS_CONFIG_URL Local path, or any URL that allows cross-origin requests. See: @@ -57,6 +59,8 @@ Local path, or any URL that allows cross-origin requests. See: [File viewers config scheme](src/models/file-viewers-config.ts) +To use the URL defined in the Arvados cluster configuration, remove the entire FILE_VIEWERS_CONFIG_URL entry from the runtime configuration. Found in `/config.json` by default. + ### Licensing Arvados is Free Software. See COPYING for information about Arvados Free diff --git a/src/common/config.ts b/src/common/config.ts index 975928e3..36fda624 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 @@ -74,16 +74,16 @@ export const fetchConfig = () => { 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 +93,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,7 +107,7 @@ 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; mapRemoteHosts(clusterConfigJSON, config); return { config, apiHost: workbenchConfig.API_HOST }; @@ -118,7 +118,7 @@ Please use the centralized configuration instead. See more at ${docsite}admin/co // 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["*"]; }; @@ -137,8 +137,8 @@ export const mockConfig = (config: Partial): Config => ({ const getDefaultConfig = (): WorkbenchConfig => ({ API_HOST: process.env.REACT_APP_ARVADOS_API_HOST || "", - VOCABULARY_URL: "", - FILE_VIEWERS_CONFIG_URL: "", + VOCABULARY_URL: undefined, + FILE_VIEWERS_CONFIG_URL: undefined, }); export const ARVADOS_API_PATH = "arvados/v1"; -- 2.30.2