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 CONFIG_URL = process.env.REACT_APP_ARVADOS_CONFIG_URL || "/config.json";
   8
   9 export interface Config {
  10     auth: {};
  11     basePath: string;
  12     baseUrl: string;
  13     batchPath: string;
  14     blobSignatureTtl: number;
  15     crunchLimitLogBytesPerJob: number;
  16     crunchLogBytesPerEvent: number;
  17     crunchLogPartialLineThrottlePeriod: number;
  18     crunchLogSecondsBetweenEvents: number;
  19     crunchLogThrottleBytes: number;
  20     crunchLogThrottleLines: number;
  21     crunchLogThrottlePeriod: number;
  22     defaultCollectionReplication: number;
  23     defaultTrashLifetime: number;
  24     description: string;
  25     discoveryVersion: string;
  26     dockerImageFormats: string[];
  27     documentationLink: string;
  28     generatedAt: string;
  29     gitUrl: string;
  30     id: string;
  31     keepWebServiceUrl: string;
  32     kind: string;
  33     maxRequestSize: number;
  34     name: string;
  35     packageVersion: string;
  36     parameters: {};
  37     protocol: string;
  38     remoteHosts: {
  39         [key: string]: string
  40     };
  41     remoteHostsViaDNS: boolean;
  42     resources: {};
  43     revision: string;
  44     rootUrl: string;
  45     schemas: {};
  46     servicePath: string;
  47     sourceVersion: string;
  48     source_version: string;
  49     title: string;
  50     uuidPrefix: string;
  51     version: string;
  52     websocketUrl: string;
  53     workbenchUrl: string;
  54     vocabularyUrl: string;
  55     origin: string;
  56 }
  57
  58 export const fetchConfig = () => {
  59     return Axios
  60         .get<ConfigJSON>(CONFIG_URL + "?nocache=" + (new Date()).getTime())
  61         .then(response => response.data)
  62         .catch(() => Promise.resolve(getDefaultConfig()))
  63         .then(config => Axios
  64             .get<Config>(getDiscoveryURL(config.API_HOST))
  65             .then(response => ({
  66                 // TODO: After tests delete `|| '/vocabulary-example.json'`
  67                 config: {...response.data, vocabularyUrl: config.VOCABULARY_URL || '/vocabulary-example.json' },
  68                 apiHost: config.API_HOST,
  69             })));
  70
  71 };
  72
  73 export const mockConfig = (config: Partial<Config>): Config => ({
  74     auth: {},
  75     basePath: '',
  76     baseUrl: '',
  77     batchPath: '',
  78     blobSignatureTtl: 0,
  79     crunchLimitLogBytesPerJob: 0,
  80     crunchLogBytesPerEvent: 0,
  81     crunchLogPartialLineThrottlePeriod: 0,
  82     crunchLogSecondsBetweenEvents: 0,
  83     crunchLogThrottleBytes: 0,
  84     crunchLogThrottleLines: 0,
  85     crunchLogThrottlePeriod: 0,
  86     defaultCollectionReplication: 0,
  87     defaultTrashLifetime: 0,
  88     description: '',
  89     discoveryVersion: '',
  90     dockerImageFormats: [],
  91     documentationLink: '',
  92     generatedAt: '',
  93     gitUrl: '',
  94     id: '',
  95     keepWebServiceUrl: '',
  96     kind: '',
  97     maxRequestSize: 0,
  98     name: '',
  99     packageVersion: '',
 100     parameters: {},
 101     protocol: '',
 102     remoteHosts: {},
 103     remoteHostsViaDNS: false,
 104     resources: {},
 105     revision: '',
 106     rootUrl: '',
 107     schemas: {},
 108     servicePath: '',
 109     sourceVersion: '',
 110     source_version: '',
 111     title: '',
 112     uuidPrefix: '',
 113     version: '',
 114     websocketUrl: '',
 115     workbenchUrl: '',
 116     vocabularyUrl: '',
 117     origin: '',
 118     ...config
 119 });
 120
 121 interface ConfigJSON {
 122     API_HOST: string;
 123     VOCABULARY_URL: string;
 124 }
 125
 126 const getDefaultConfig = (): ConfigJSON => ({
 127     API_HOST: process.env.REACT_APP_ARVADOS_API_HOST || "",
 128     VOCABULARY_URL: "",
 129 });
 130
 131 export const DISCOVERY_URL = 'discovery/v1/apis/arvados/v1/rest';
 132 const getDiscoveryURL = (apiHost: string) => `${window.location.protocol}//${apiHost}/${DISCOVERY_URL}`;