src/common/config.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import Axios from "axios";
   6
   7 export const WORKBENCH_CONFIG_URL = process.env.REACT_APP_ARVADOS_CONFIG_URL || "/config.json";
   8
   9 interface WorkbenchConfig {
  10     API_HOST: string;
  11     VOCABULARY_URL?: string;
  12     FILE_VIEWERS_CONFIG_URL?: string;
  13 }
  14
  15 export interface ClusterConfigJSON {
  16     ClusterID: string;
  17     RemoteClusters: {
  18         [key: string]: {
  19             ActivateUsers: boolean
  20             Host: string
  21             Insecure: boolean
  22             Proxy: boolean
  23             Scheme: string
  24         }
  25     };
  26     Services: {
  27         Controller: {
  28             ExternalURL: string
  29         }
  30         Workbench1: {
  31             ExternalURL: string
  32         }
  33         Workbench2: {
  34             ExternalURL: string
  35         }
  36         Websocket: {
  37             ExternalURL: string
  38         }
  39         WebDAV: {
  40             ExternalURL: string
  41         },
  42         WebDAVDownload: {
  43             ExternalURL: string
  44         },
  45         WebShell: {
  46             ExternalURL: string
  47         }
  48     };
  49     Workbench: {
  50         ArvadosDocsite: string;
  51         VocabularyURL: string;
  52         FileViewersConfigURL: string;
  53         WelcomePageHTML: string;
  54         InactivePageHTML: string;
  55         SSHHelpPageHTML: string;
  56         SSHHelpHostSuffix: string;
  57         SiteName: string;
  58     };
  59     Login: {
  60         LoginCluster: string;
  61         Google: {
  62             Enable: boolean;
  63         }
  64         LDAP: {
  65             Enable: boolean;
  66         }
  67         PAM: {
  68             Enable: boolean;
  69         }
  70         SSO: {
  71             Enable: boolean;
  72         }
  73     };
  74     Collections: {
  75         ForwardSlashNameSubstitution: string;
  76     };
  77 }
  78
  79 export class Config {
  80     baseUrl: string;
  81     keepWebServiceUrl: string;
  82     remoteHosts: {
  83         [key: string]: string
  84     };
  85     rootUrl: string;
  86     uuidPrefix: string;
  87     websocketUrl: string;
  88     workbenchUrl: string;
  89     workbench2Url: string;
  90     vocabularyUrl: string;
  91     fileViewersConfigUrl: string;
  92     loginCluster: string;
  93     clusterConfig: ClusterConfigJSON;
  94     apiRevision: number;
  95 }
  96
  97 export const buildConfig = (clusterConfigJSON: ClusterConfigJSON): Config => {
  98     const config = new Config();
  99     config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL;
 100     config.baseUrl = `${config.rootUrl}/${ARVADOS_API_PATH}`;
 101     config.uuidPrefix = clusterConfigJSON.ClusterID;
 102     config.websocketUrl = clusterConfigJSON.Services.Websocket.ExternalURL;
 103     config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL;
 104     config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL;
 105     config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAVDownload.ExternalURL;
 106     config.loginCluster = clusterConfigJSON.Login.LoginCluster;
 107     config.clusterConfig = clusterConfigJSON;
 108     config.apiRevision = 0;
 109     mapRemoteHosts(clusterConfigJSON, config);
 110     return config;
 111 };
 112
 113 const getApiRevision = async (apiUrl: string) => {
 114     try {
 115         const dd = (await Axios.get<any>(`${apiUrl}/${DISCOVERY_DOC_PATH}`)).data;
 116         return parseInt(dd.revision, 10) || 0;
 117     } catch {
 118         console.warn("Unable to get API Revision number, defaulting to zero. Some features may not work properly.");
 119         return 0;
 120     }
 121 };
 122
 123 export const fetchConfig = () => {
 124     return Axios
 125         .get<WorkbenchConfig>(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime())
 126         .then(response => response.data)
 127         .catch(() => {
 128             console.warn(`There was an exception getting the Workbench config file at ${WORKBENCH_CONFIG_URL}. Using defaults instead.`);
 129             return Promise.resolve(getDefaultConfig());
 130         })
 131         .then(workbenchConfig => {
 132             if (workbenchConfig.API_HOST === undefined) {
 133                 throw new Error(`Unable to start Workbench. API_HOST is undefined in ${WORKBENCH_CONFIG_URL} or the environment.`);
 134             }
 135             return Axios.get<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(async response => {
 136                 const clusterConfigJSON = response.data;
 137                 const apiRevision = await getApiRevision(clusterConfigJSON.Services.Controller.ExternalURL);
 138                 const config = { ...buildConfig(clusterConfigJSON), apiRevision };
 139                 const warnLocalConfig = (varName: string) => console.warn(
 140                     `A value for ${varName} was found in ${WORKBENCH_CONFIG_URL}. To use the Arvados centralized configuration instead, \
 141 remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`);
 142
 143                 // Check if the workbench config has an entry for vocabulary and file viewer URLs
 144                 // If so, use these values (even if it is an empty string), but print a console warning.
 145                 // Otherwise, use the cluster config.
 146                 let fileViewerConfigUrl;
 147                 if (workbenchConfig.FILE_VIEWERS_CONFIG_URL !== undefined) {
 148                     warnLocalConfig("FILE_VIEWERS_CONFIG_URL");
 149                     fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL;
 150                 }
 151                 else {
 152                     fileViewerConfigUrl = clusterConfigJSON.Workbench.FileViewersConfigURL || "/file-viewers-example.json";
 153                 }
 154                 config.fileViewersConfigUrl = fileViewerConfigUrl;
 155
 156                 let vocabularyUrl;
 157                 if (workbenchConfig.VOCABULARY_URL !== undefined) {
 158                     warnLocalConfig("VOCABULARY_URL");
 159                     vocabularyUrl = workbenchConfig.VOCABULARY_URL;
 160                 }
 161                 else {
 162                     vocabularyUrl = clusterConfigJSON.Workbench.VocabularyURL || "/vocabulary-example.json";
 163                 }
 164                 config.vocabularyUrl = vocabularyUrl;
 165
 166                 return { config, apiHost: workbenchConfig.API_HOST };
 167             });
 168         });
 169 };
 170
 171 // Maps remote cluster hosts and removes the default RemoteCluster entry
 172 export const mapRemoteHosts = (clusterConfigJSON: ClusterConfigJSON, config: Config) => {
 173     config.remoteHosts = {};
 174     Object.keys(clusterConfigJSON.RemoteClusters).forEach(k => { config.remoteHosts[k] = clusterConfigJSON.RemoteClusters[k].Host; });
 175     delete config.remoteHosts["*"];
 176 };
 177
 178 export const mockClusterConfigJSON = (config: Partial<ClusterConfigJSON>): ClusterConfigJSON => ({
 179     ClusterID: "",
 180     RemoteClusters: {},
 181     Services: {
 182         Controller: { ExternalURL: "" },
 183         Workbench1: { ExternalURL: "" },
 184         Workbench2: { ExternalURL: "" },
 185         Websocket: { ExternalURL: "" },
 186         WebDAV: { ExternalURL: "" },
 187         WebDAVDownload: { ExternalURL: "" },
 188         WebShell: { ExternalURL: "" },
 189     },
 190     Workbench: {
 191         ArvadosDocsite: "",
 192         VocabularyURL: "",
 193         FileViewersConfigURL: "",
 194         WelcomePageHTML: "",
 195         InactivePageHTML: "",
 196         SSHHelpPageHTML: "",
 197         SSHHelpHostSuffix: "",
 198         SiteName: "",
 199     },
 200     Login: {
 201         LoginCluster: "",
 202         Google: {
 203             Enable: false,
 204         },
 205         LDAP: {
 206             Enable: false,
 207         },
 208         PAM: {
 209             Enable: false,
 210         },
 211         SSO: {
 212             Enable: false,
 213         },
 214     },
 215     Collections: {
 216         ForwardSlashNameSubstitution: "",
 217     },
 218     ...config
 219 });
 220
 221 export const mockConfig = (config: Partial<Config>): Config => ({
 222     baseUrl: "",
 223     keepWebServiceUrl: "",
 224     remoteHosts: {},
 225     rootUrl: "",
 226     uuidPrefix: "",
 227     websocketUrl: "",
 228     workbenchUrl: "",
 229     workbench2Url: "",
 230     vocabularyUrl: "",
 231     fileViewersConfigUrl: "",
 232     loginCluster: "",
 233     clusterConfig: mockClusterConfigJSON({}),
 234     apiRevision: 0,
 235     ...config
 236 });
 237
 238 const getDefaultConfig = (): WorkbenchConfig => {
 239     let apiHost = "";
 240     const envHost = process.env.REACT_APP_ARVADOS_API_HOST;
 241     if (envHost !== undefined) {
 242         console.warn(`Using default API host ${envHost}.`);
 243         apiHost = envHost;
 244     }
 245     else {
 246         console.warn(`No API host was found in the environment. Workbench may not be able to communicate with Arvados components.`);
 247     }
 248     return {
 249         API_HOST: apiHost,
 250         VOCABULARY_URL: undefined,
 251         FILE_VIEWERS_CONFIG_URL: undefined,
 252     };
 253 };
 254
 255 export const ARVADOS_API_PATH = "arvados/v1";
 256 export const CLUSTER_CONFIG_PATH = "arvados/v1/config";
 257 export const DISCOVERY_DOC_PATH = "discovery/v1/apis/arvados/v1/rest";
 258 export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_PATH}?nocache=${(new Date()).getTime()}`;