Allow hyphen in override adapter name (#442)

Author: dskloetc

src/adapter/endpoint.ts

@@ -1,7 +1,14 @@
 import { ResponseCache } from '../cache/response'
 import { AdapterSettings } from '../config'
 import { TransportRoutes } from '../transports'
-import { AdapterRequest, AdapterRequestData, Overrides, makeLogger } from '../util'
+import {
+  AdapterRequest,
+  AdapterRequestData,
+  Overrides,
+  makeLogger,
+  getCanonicalAdapterName,
+  canonicalizeAdapterNameKeys,
+} from '../util'
 import { InputParameters } from '../validation'
 import { AdapterError } from '../validation/error'
 import { TypeFromDefinition } from '../validation/input-params'
@@ -111,8 +118,10 @@ export class AdapterEndpoint<T extends EndpointGenerics> implements AdapterEndpo
   }
 
   getRequestOverrides(data: Record<string, string>, overrides?: Overrides) {
-    const overrideAdapterName = data['adapterNameOverride']
-    return overrides?.[overrideAdapterName] || overrides?.[this.adapterName.toLowerCase()]
+    const overrideAdapterName = getCanonicalAdapterName(data['adapterNameOverride'])
+    const adapterName = getCanonicalAdapterName(this.adapterName)
+    const canonicalOverrides: Overrides | undefined = canonicalizeAdapterNameKeys(overrides)
+    return canonicalOverrides?.[overrideAdapterName] || canonicalOverrides?.[adapterName]
   }
 
   /**
@@ -185,8 +194,11 @@ export class AdapterEndpoint<T extends EndpointGenerics> implements AdapterEndpo
    * @returns the transport param or override if present
    */
   private defaultRouter(req: AdapterRequest<TypeFromDefinition<T['Parameters']>>) {
+    // DefaultRouter is called before customInputValidation, so we don't have
+    // the validation data on the requestContext yet.
+    const data: Record<string, string> = {}
     const rawRequestBody = req.body as unknown as { data: AdapterRequestData }
-    const requestOverrides = rawRequestBody.data?.overrides?.[this.adapterName.toLowerCase()]
+    const requestOverrides = this.getRequestOverrides(data, rawRequestBody.data?.overrides)
     // Transport override
     if (requestOverrides?.['transport']) {
       return requestOverrides['transport']

src/util/index.ts

@@ -176,3 +176,34 @@ export const groupArrayByKey = <T extends Record<string, string>, K extends keyo
     {} as Record<T[K], T[]>,
   )
 }
+
+/**
+ * Returns adapter name in lower case and with hyphens replaced by underscores.
+ * Types are declared such that the output type is defined iff the input type
+ * is defined.
+ * @param  name - The name to canonicalize
+ * @returns The canonical name
+ */
+export function getCanonicalAdapterName(name: string): string
+export function getCanonicalAdapterName(name: undefined): undefined
+export function getCanonicalAdapterName(name: string | undefined): string | undefined {
+  return name?.toLowerCase().replace(/-/g, '_')
+}
+
+type StringKeys<T> = { [key: string]: T }
+
+/**
+ * Returns the record with adapter names as keys after canonicalizing the keys.
+ * @param  obj - The record with adapter names as keys
+ * @returns The record with canonicalized adapter names as keys
+ */
+export const canonicalizeAdapterNameKeys = <T>(
+  obj: StringKeys<T> | undefined,
+): StringKeys<T> | undefined => {
+  if (obj === undefined) {
+    return undefined
+  }
+  return Object.fromEntries(
+    Object.entries(obj).map(([key, value]) => [getCanonicalAdapterName(key), value]),
+  )
+}

test/overrides.test.ts

@@ -68,7 +68,7 @@ class OverrideTestTransport implements Transport<TestTransportGenerics> {
 
 test.beforeEach(async (t) => {
   const adapter = new Adapter({
-    name: 'TEST',
+    name: 'TEST_ADAPTER',
     defaultEndpoint: 'test-endpoint',
     endpoints: [
       new AdapterEndpoint({
@@ -103,7 +103,7 @@ test('request overrides are respected', async (t) => {
     base: 'OVER2',
     quote: 'USD',
     overrides: {
-      test: {
+      test_adapter: {
         OVER2: 'qweqwe',
       },
     },
@@ -137,7 +137,7 @@ test('request overrides take precedence over adapter hardcoded ones', async (t)
     base: 'OVER1',
     quote: 'USD',
     overrides: {
-      test: {
+      test_adapter: {
         OVER1: 'priority',
       },
     },
@@ -154,7 +154,7 @@ test('request overrides that resolve field to overridable symbol are not overrid
     base: 'OVER2',
     quote: 'USD',
     overrides: {
-      test: {
+      test_adapter: {
         OVER2: 'OVER1',
       },
     },
@@ -204,13 +204,34 @@ test('adapter with overrideAdapterName uses overrideAdapterName', async (t) => {
   })
 })
 
+test('adapterNameOverride can use hyphen', async (t) => {
+  const response = await t.context.testAdapter.request({
+    base: 'OVER2',
+    quote: 'USD',
+    adapterNameOverride: 'override-test',
+    overrides: {
+      override_test: {
+        OVER2: 'valid',
+      },
+      test: {
+        OVER2: 'invalid',
+      },
+    },
+  })
+
+  t.deepEqual(response.json().data, {
+    base: 'valid',
+    quote: 'USD',
+  })
+})
+
 test('adapter with overrideAdapterName uses original name if no override specified for overrideAdapterName', async (t) => {
   const response = await t.context.testAdapter.request({
     base: 'OVER2',
     quote: 'USD',
     adapterNameOverride: 'overridetest',
     overrides: {
-      test: {
+      test_adapter: {
         OVER2: 'overridden',
       },
     },
@@ -221,3 +242,37 @@ test('adapter with overrideAdapterName uses original name if no override specifi
     quote: 'USD',
   })
 })
+
+test('adapter name in overrides can have hyphen', async (t) => {
+  const response = await t.context.testAdapter.request({
+    base: 'OVER2',
+    quote: 'USD',
+    overrides: {
+      'test-adapter': {
+        OVER2: 'qweqwe',
+      },
+    },
+  })
+
+  t.deepEqual(response.json().data, {
+    base: 'qweqwe',
+    quote: 'USD',
+  })
+})
+
+test('adapter name in overrides can use upper case', async (t) => {
+  const response = await t.context.testAdapter.request({
+    base: 'OVER2',
+    quote: 'USD',
+    overrides: {
+      TEST_ADAPTER: {
+        OVER2: 'qweqwe',
+      },
+    },
+  })
+
+  t.deepEqual(response.json().data, {
+    base: 'qweqwe',
+    quote: 'USD',
+  })
+})

test/transports/routing.test.ts

@@ -291,7 +291,7 @@ test.beforeEach(async (t) => {
   })
 
   const sampleAdapter = new Adapter({
-    name: 'TEST',
+    name: 'TEST_ADAPTER',
     defaultEndpoint: 'price',
     config: customConfig,
     endpoints: [sampleEndpoint],
@@ -704,7 +704,42 @@ test.serial('transport override routes to correct Transport', async (t) => {
     to,
     transport: 'websocket',
     overrides: {
-      test: {
+      test_adapter: {
+        transport: 'batch',
+      },
+    },
+  })
+
+  t.is(error.statusCode, 504)
+  const internalTransport = transports.get('batch') as unknown as MockHttpTransport
+  t.assert(internalTransport.registerRequestCalls > 0)
+})
+
+test.serial('transport override adapter name can use hyphen', async (t) => {
+  axiosMock
+    .onPost(`${restUrl}/price`, {
+      pairs: [
+        {
+          base: from,
+          quote: to,
+        },
+      ],
+    })
+    .reply(200, {
+      prices: [
+        {
+          pair: `${from}/${to}`,
+          price,
+        },
+      ],
+    })
+
+  const error = await t.context.testAdapter.request({
+    from,
+    to,
+    transport: 'websocket',
+    overrides: {
+      'test-adapter': {
         transport: 'batch',
       },
     },

test/utils.test.ts

@@ -1,4 +1,9 @@
-import { groupArrayByKey, splitArrayIntoChunks } from '../src/util'
+import {
+  groupArrayByKey,
+  splitArrayIntoChunks,
+  getCanonicalAdapterName,
+  canonicalizeAdapterNameKeys,
+} from '../src/util'
 import test from 'ava'
 
 test('Test splitArrayIntoChunks function', async (t) => {
@@ -37,3 +42,32 @@ test('Test groupArrayByKey function', async (t) => {
     DASH: [{ base: 'LTC', quote: 'DASH' }],
   })
 })
+
+test('Test getCanonicalAdapterName', async (t) => {
+  t.is(getCanonicalAdapterName(undefined), undefined)
+  t.is(getCanonicalAdapterName('test'), 'test')
+  t.is(getCanonicalAdapterName('TEST'), 'test')
+  t.is(getCanonicalAdapterName('TEST-adapter'), 'test_adapter')
+  t.is(getCanonicalAdapterName('TEST_ADAPTER'), 'test_adapter')
+  t.is(getCanonicalAdapterName('A-B-C-D-e-f'), 'a_b_c_d_e_f')
+})
+
+test('Test canonicalizeAdapterNameKeys', async (t) => {
+  t.deepEqual(canonicalizeAdapterNameKeys(undefined), undefined)
+  t.deepEqual(
+    canonicalizeAdapterNameKeys({
+      test: 1,
+      TEST2: 2,
+      'TEST-adapter': 3,
+      TEST_ADAPTER2: 4,
+      'A-B-C-D-e-f': 5,
+    }),
+    {
+      test: 1,
+      test2: 2,
+      test_adapter: 3,
+      test_adapter2: 4,
+      a_b_c_d_e_f: 5,
+    },
+  )
+})