getDefaultConfig takes new parameter for required API key

smartcontractkit · Feb 3, 2021 · c6fc972 · c6fc972
1 parent 9ad5695
commit c6fc972
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 21 deletions.
diff --git a/bootstrap/src/lib/util.ts b/bootstrap/src/lib/util.ts
@@ -24,6 +24,14 @@ export const toObjectWithNumbers = (obj: any) => {
   return Object.fromEntries(Object.entries(obj).map(([k, v]) => [k, toNumber(v)]))
 }
 
+// pick a random string from env var after splitting with the delimiter ("a&b&c" "&" -> choice(["a","b","c"]))
+export const getRandomEnv = (name: string, delimiter = ',', prefix = '') => {
+  const val = getEnv(name, prefix)
+  if (!val) return val
+  const items = val.split(delimiter)
+  return items[Math.floor(Math.random() * items.length)]
+}
+
 // pick a random string from env var after splitting with the delimiter ("a&b&c" "&" -> choice(["a","b","c"]))
 export const getRandomRequiredEnv = (name: string, delimiter = ',', prefix = '') => {
   const val = getRequiredEnv(name, prefix)

diff --git a/coinmarketcap/src/config.ts b/coinmarketcap/src/config.ts
@@ -6,7 +6,10 @@ export const DEFAULT_ENDPOINT = 'price'
 const DEFAULT_API_ENDPOINT = 'https://pro-api.coinmarketcap.com/v1/'
 
 export const makeConfig = (prefix?: string): Config => {
-  const config = Requester.getDefaultConfig(prefix)
+  const config = Requester.getDefaultConfig(prefix, true)
   config.api.baseURL = config.api.baseUrl || DEFAULT_API_ENDPOINT
+  config.api.headers = {
+    'X-CMC_PRO_API_KEY': config.apiKey,
+  }
   return config
 }
diff --git a/coinmarketcap/src/endpoint/dominance.ts b/coinmarketcap/src/endpoint/dominance.ts
@@ -1,4 +1,3 @@
-import { util } from '@chainlink/ea-bootstrap'
 import { Requester, Validator } from '@chainlink/external-adapter'
 import { ExecuteWithConfig, Config } from '@chainlink/types'
 
@@ -16,14 +15,9 @@ export const execute: ExecuteWithConfig<Config> = async (request, config) => {
 
   const url = 'global-metrics/quotes/latest'
 
-  const headers = {
-    'X-CMC_PRO_API_KEY': util.getRandomRequiredEnv('API_KEY'),
-  }
-
   const options = {
     ...config.api,
     url,
-    headers,
   }
 
   const symbol = validator.validated.data.market.toLowerCase()

diff --git a/coinmarketcap/src/endpoint/marketcap.ts b/coinmarketcap/src/endpoint/marketcap.ts
@@ -1,4 +1,3 @@
-import { util } from '@chainlink/ea-bootstrap'
 import { Requester, Validator } from '@chainlink/external-adapter'
 import { ExecuteWithConfig, Config } from '@chainlink/types'
 
@@ -18,15 +17,11 @@ export const execute: ExecuteWithConfig<Config> = async (request, config) => {
   const url = '/global-metrics/quotes/latest'
 
   const params = { convert }
-  const headers = {
-    'X-CMC_PRO_API_KEY': util.getRandomRequiredEnv('API_KEY'),
-  }
 
   const options = {
     ...config.api,
     url,
     params,
-    headers,
   }
   const response = await Requester.request(options)
   const result = Requester.validateResultNumber(response.data, [

diff --git a/coinmarketcap/src/endpoint/price.ts b/coinmarketcap/src/endpoint/price.ts
@@ -1,4 +1,3 @@
-import { util } from '@chainlink/ea-bootstrap'
 import { Requester, Validator } from '@chainlink/external-adapter'
 import { ExecuteWithConfig, Config } from '@chainlink/types'
 
@@ -61,9 +60,6 @@ export const execute: ExecuteWithConfig<Config> = async (request, config) => {
   const options = {
     ...config.api,
     url,
-    headers: {
-      'X-CMC_PRO_API_KEY': util.getRandomRequiredEnv('API_KEY'),
-    },
     params,
   }
   const response = await Requester.request(options)

diff --git a/coinmarketcap/test/dominance.test.ts b/coinmarketcap/test/dominance.test.ts
@@ -7,7 +7,7 @@ import { makeExecute } from '../src/adapter'
 describe('execute', () => {
   const jobID = '1'
   const execute = makeExecute()
-  process.env.API_KEY = process.env.API_KEY ?? 'test_api_key'
+  // process.env.API_KEY = process.env.API_KEY ?? 'test_api_key'
 
   context('successful calls @integration', () => {
     const requests = [

diff --git a/coinmarketcap/test/marketcap.test.ts b/coinmarketcap/test/marketcap.test.ts
@@ -7,7 +7,7 @@ import { makeExecute } from '../src/adapter'
 describe('execute', () => {
   const jobID = '1'
   const execute = makeExecute()
-  process.env.API_KEY = process.env.API_KEY ?? 'test_api_key'
+  // process.env.API_KEY = process.env.API_KEY ?? 'test_api_key'
 
   context('successful calls @integration', () => {
     const requests = [

diff --git a/coinmarketcap/test/price.test.ts b/coinmarketcap/test/price.test.ts
@@ -7,7 +7,7 @@ import { makeExecute } from '../src/adapter'
 describe('execute', () => {
   const jobID = '1'
   const execute = makeExecute()
-  process.env.API_KEY = process.env.API_KEY ?? 'test_api_key'
+  // process.env.API_KEY = process.env.API_KEY ?? 'test_api_key'
 
   context('successful calls @integration', () => {
     const requests = [

diff --git a/external-adapter/src/config.ts b/external-adapter/src/config.ts
@@ -19,8 +19,10 @@ export const constants = {
 /* eslint-disable @typescript-eslint/no-unused-vars */
 const cloneNoSecrets = (config: Config): Config => (({ apiKey, ...o }) => o)(config)
 
-export function getDefaultConfig(prefix = ''): Config {
-  const apiKey = util.getEnv(ENV_API_KEY, prefix)
+export function getDefaultConfig(prefix = '', requireKey = false): Config {
+  const apiKey = requireKey
+    ? util.getRandomRequiredEnv(ENV_API_KEY, ',', prefix)
+    : util.getRandomEnv(ENV_API_KEY, ',', prefix)
   const timeout = util.getEnv(ENV_API_TIMEOUT, prefix)
   return {
     apiKey,