15718: Adds API revision number from discovery doc to sessions.

[arvados-workbench2.git] / src / common / config.ts

diff --git a/src/common/config.ts b/src/common/config.ts
index 1f668292c32c3a5abfbdefee99dd2b3a7ecee441..58fa13ae62e6ee946ada2ab931ee54064a8c6e8f 100644 (file)
--- a/src/common/config.ts
+++ b/src/common/config.ts
@@ -38,6 +38,12 @@ export interface ClusterConfigJSON {
         }
         WebDAV: {
             ExternalURL: string
+        },
+        WebDAVDownload: {
+            ExternalURL: string
+        },
+        WebShell: {
+            ExternalURL: string
         }
     };
     Workbench: {
@@ -45,6 +51,15 @@ export interface ClusterConfigJSON {
         VocabularyURL: string;
         FileViewersConfigURL: string;
         WelcomePageHTML: string;
+        InactivePageHTML: string;
+        SSHHelpPageHTML: string;
+        SiteName: string;
+    };
+    Login: {
+        LoginCluster: string;
+    };
+    Collections: {
+        ForwardSlashNameSubstitution: string;
     };
 }
 
@@ -61,9 +76,37 @@ export class Config {
     workbench2Url: string;
     vocabularyUrl: string;
     fileViewersConfigUrl: string;
+    loginCluster: string;
     clusterConfig: ClusterConfigJSON;
+    apiRevision: number;
 }
 
+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;
+    config.apiRevision = 0;
+    mapRemoteHosts(clusterConfigJSON, config);
+    return config;
+};
+
+const getApiRevision = async (apiUrl: string) => {
+    try {
+        const dd = (await Axios.get<any>(`${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;
+    }
+};
+
 export const fetchConfig = () => {
     return Axios
         .get<WorkbenchConfig>(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime())
@@ -76,9 +119,10 @@ 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<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(response => {
-                const config = new Config();
+            return Axios.get<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(async response => {
                 const clusterConfigJSON = response.data;
+                const apiRevision = await getApiRevision(clusterConfigJSON.Services.Controller.ExternalURL);
+                const config = {...buildConfig(clusterConfigJSON), 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}`);
@@ -106,16 +150,6 @@ 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;
-                config.clusterConfig = clusterConfigJSON;
-                mapRemoteHosts(clusterConfigJSON, config);
-
                 return { config, apiHost: workbenchConfig.API_HOST };
             });
         });
@@ -137,12 +171,23 @@ export const mockClusterConfigJSON = (config: Partial<ClusterConfigJSON>): Clust
         Workbench2: { ExternalURL: "" },
         Websocket: { ExternalURL: "" },
         WebDAV: { ExternalURL: "" },
+        WebDAVDownload: { ExternalURL: "" },
+        WebShell: { ExternalURL: "" },
     },
     Workbench: {
         ArvadosDocsite: "",
         VocabularyURL: "",
         FileViewersConfigURL: "",
         WelcomePageHTML: "",
+        InactivePageHTML: "",
+        SSHHelpPageHTML: "",
+        SiteName: "",
+    },
+    Login: {
+        LoginCluster: "",
+    },
+    Collections: {
+        ForwardSlashNameSubstitution: "",
     },
     ...config
 });
@@ -158,7 +203,9 @@ export const mockConfig = (config: Partial<Config>): Config => ({
     workbench2Url: "",
     vocabularyUrl: "",
     fileViewersConfigUrl: "",
+    loginCluster: "",
     clusterConfig: mockClusterConfigJSON({}),
+    apiRevision: 0,
     ...config
 });
 
@@ -180,5 +227,6 @@ const getDefaultConfig = (): WorkbenchConfig => {
 };
 
 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()}`;
+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()}`;