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