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     };
  43     Workbench: {
  44         ArvadosDocsite: string;
  45         VocabularyURL: string;
  46         FileViewersConfigURL: string;
  47         WelcomePageHTML: string;
  48         InactivePageHTML: string;
  49         SiteName: string;
  50     };
  51     Login: {
  52         LoginCluster: string;
  53     };
  54 }
  55
  56 export class Config {
  57     baseUrl: string;
  58     keepWebServiceUrl: string;
  59     remoteHosts: {
  60         [key: string]: string
  61     };
  62     rootUrl: string;
  63     uuidPrefix: string;
  64     websocketUrl: string;
  65     workbenchUrl: string;
  66     workbench2Url: string;
  67     vocabularyUrl: string;
  68     fileViewersConfigUrl: string;
  69     loginCluster: string;
  70     clusterConfig: ClusterConfigJSON;
  71 }
  72
  73 export const buildConfig = (clusterConfigJSON: ClusterConfigJSON): Config => {
  74     const config = new Config();
  75     config.rootUrl = clusterConfigJSON.Services.Controller.ExternalURL;
  76     config.baseUrl = `${config.rootUrl}/${ARVADOS_API_PATH}`;
  77     config.uuidPrefix = clusterConfigJSON.ClusterID;
  78     config.websocketUrl = clusterConfigJSON.Services.Websocket.ExternalURL;
  79     config.workbench2Url = clusterConfigJSON.Services.Workbench2.ExternalURL;
  80     config.workbenchUrl = clusterConfigJSON.Services.Workbench1.ExternalURL;
  81     config.keepWebServiceUrl = clusterConfigJSON.Services.WebDAV.ExternalURL;
  82     config.loginCluster = clusterConfigJSON.Login.LoginCluster;
  83     config.clusterConfig = clusterConfigJSON;
  84     mapRemoteHosts(clusterConfigJSON, config);
  85     return config;
  86 };
  87
  88 export const fetchConfig = () => {
  89     return Axios
  90         .get<WorkbenchConfig>(WORKBENCH_CONFIG_URL + "?nocache=" + (new Date()).getTime())
  91         .then(response => response.data)
  92         .catch(() => {
  93             console.warn(`There was an exception getting the Workbench config file at ${WORKBENCH_CONFIG_URL}. Using defaults instead.`);
  94             return Promise.resolve(getDefaultConfig());
  95         })
  96         .then(workbenchConfig => {
  97             if (workbenchConfig.API_HOST === undefined) {
  98                 throw new Error(`Unable to start Workbench. API_HOST is undefined in ${WORKBENCH_CONFIG_URL} or the environment.`);
  99             }
 100             return Axios.get<ClusterConfigJSON>(getClusterConfigURL(workbenchConfig.API_HOST)).then(response => {
 101                 const clusterConfigJSON = response.data;
 102                 const config = buildConfig(clusterConfigJSON);
 103                 const warnLocalConfig = (varName: string) => console.warn(
 104                     `A value for ${varName} was found in ${WORKBENCH_CONFIG_URL}. To use the Arvados centralized configuration instead, \
 105 remove the entire ${varName} entry from ${WORKBENCH_CONFIG_URL}`);
 106
 107                 // Check if the workbench config has an entry for vocabulary and file viewer URLs
 108                 // If so, use these values (even if it is an empty string), but print a console warning.
 109                 // Otherwise, use the cluster config.
 110                 let fileViewerConfigUrl;
 111                 if (workbenchConfig.FILE_VIEWERS_CONFIG_URL !== undefined) {
 112                     warnLocalConfig("FILE_VIEWERS_CONFIG_URL");
 113                     fileViewerConfigUrl = workbenchConfig.FILE_VIEWERS_CONFIG_URL;
 114                 }
 115                 else {
 116                     fileViewerConfigUrl = clusterConfigJSON.Workbench.FileViewersConfigURL || "/file-viewers-example.json";
 117                 }
 118                 config.fileViewersConfigUrl = fileViewerConfigUrl;
 119
 120                 let vocabularyUrl;
 121                 if (workbenchConfig.VOCABULARY_URL !== undefined) {
 122                     warnLocalConfig("VOCABULARY_URL");
 123                     vocabularyUrl = workbenchConfig.VOCABULARY_URL;
 124                 }
 125                 else {
 126                     vocabularyUrl = clusterConfigJSON.Workbench.VocabularyURL || "/vocabulary-example.json";
 127                 }
 128                 config.vocabularyUrl = vocabularyUrl;
 129
 130                 return { config, apiHost: workbenchConfig.API_HOST };
 131             });
 132         });
 133 };
 134
 135 // Maps remote cluster hosts and removes the default RemoteCluster entry
 136 export const mapRemoteHosts = (clusterConfigJSON: ClusterConfigJSON, config: Config) => {
 137     config.remoteHosts = {};
 138     Object.keys(clusterConfigJSON.RemoteClusters).forEach(k => { config.remoteHosts[k] = clusterConfigJSON.RemoteClusters[k].Host; });
 139     delete config.remoteHosts["*"];
 140 };
 141
 142 export const mockClusterConfigJSON = (config: Partial<ClusterConfigJSON>): ClusterConfigJSON => ({
 143     ClusterID: "",
 144     RemoteClusters: {},
 145     Services: {
 146         Controller: { ExternalURL: "" },
 147         Workbench1: { ExternalURL: "" },
 148         Workbench2: { ExternalURL: "" },
 149         Websocket: { ExternalURL: "" },
 150         WebDAV: { ExternalURL: "" },
 151     },
 152     Workbench: {
 153         ArvadosDocsite: "",
 154         VocabularyURL: "",
 155         FileViewersConfigURL: "",
 156         WelcomePageHTML: "",
 157         InactivePageHTML: "",
 158         SiteName: "",
 159     },
 160     Login: {
 161         LoginCluster: "",
 162     },
 163     ...config
 164 });
 165
 166 export const mockConfig = (config: Partial<Config>): Config => ({
 167     baseUrl: "",
 168     keepWebServiceUrl: "",
 169     remoteHosts: {},
 170     rootUrl: "",
 171     uuidPrefix: "",
 172     websocketUrl: "",
 173     workbenchUrl: "",
 174     workbench2Url: "",
 175     vocabularyUrl: "",
 176     fileViewersConfigUrl: "",
 177     loginCluster: "",
 178     clusterConfig: mockClusterConfigJSON({}),
 179     ...config
 180 });
 181
 182 const getDefaultConfig = (): WorkbenchConfig => {
 183     let apiHost = "";
 184     const envHost = process.env.REACT_APP_ARVADOS_API_HOST;
 185     if (envHost !== undefined) {
 186         console.warn(`Using default API host ${envHost}.`);
 187         apiHost = envHost;
 188     }
 189     else {
 190         console.warn(`No API host was found in the environment. Workbench may not be able to communicate with Arvados components.`);
 191     }
 192     return {
 193         API_HOST: apiHost,
 194         VOCABULARY_URL: undefined,
 195         FILE_VIEWERS_CONFIG_URL: undefined,
 196     };
 197 };
 198
 199 export const ARVADOS_API_PATH = "arvados/v1";
 200 export const CLUSTER_CONFIG_PATH = "arvados/v1/config";
 201 export const DISCOVERY_DOC_PATH = "discovery/v1/apis/arvados/v1/rest";
 202 export const getClusterConfigURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${CLUSTER_CONFIG_PATH}?nocache=${(new Date()).getTime()}`;