From c8c5fc13ef57812800fb6ba4553d009ba8c5c7be Mon Sep 17 00:00:00 2001
From: Eric Biagiotti <ebiagiotti@veritasgenetics.com>
Date: Thu, 1 Aug 2019 14:34:24 -0400
Subject: [PATCH] 14813: Improves config error handling and logging

Arvados-DCO-1.1-Signed-off-by: Eric Biagiotti <ebiagiotti@veritasgenetics.com>
---
 README.md            | 10 ++++++++--
 src/common/config.ts | 40 +++++++++++++++++++++++++++-------------
 2 files changed, 35 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index bca04b1e..e2e14ce4 100644
--- a/README.md
+++ b/README.md
@@ -46,11 +46,17 @@ Currently this configuration schema is supported:
 }
 ```
 
+#### API_HOST
+
+The Arvados base URL. 
+
+The `REACT_APP_ARVADOS_API_HOST` environment variable can be used to set the default URL if the run time configuration is unreachable.
+
 #### VOCABULARY_URL
 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.
+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:
@@ -59,7 +65,7 @@ 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.
+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
 
diff --git a/src/common/config.ts b/src/common/config.ts
index 36fda624..7363b95d 100644
--- a/src/common/config.ts
+++ b/src/common/config.ts
@@ -66,14 +66,17 @@ export const fetchConfig = () => {
     return Axios
         .get<WorkbenchConfig>(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime())
         .then(response => response.data)
-        .catch(() => Promise.resolve(getDefaultConfig()))
-        .then(workbenchConfig => Axios
-            .get<ClusterConfigJSON>(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}.`);
+            }
+            return Axios.get<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(response => {
                 const config = new Config();
                 const clusterConfigJSON = response.data;
-                const docsite = clusterConfigJSON.Workbench.ArvadosDocsite;
                 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}`);
@@ -111,8 +114,8 @@ remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`);
                 mapRemoteHosts(clusterConfigJSON, config);
 
                 return { config, apiHost: workbenchConfig.API_HOST };
-            })
-        );
+            });
+        });
 };
 
 // Maps remote cluster hosts and removes the default RemoteCluster entry
@@ -135,11 +138,22 @@ export const mockConfig = (config: Partial<Config>): Config => ({
     fileViewersConfigUrl: ""
 });
 
-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";
-- 
2.30.2