add WS_ENABLED env var support (#3163)

smartcontractkit · Jan 24, 2024 · 8f266fa · 8f266fa
1 parent fdb266e
commit 8f266fa
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 7 deletions.
diff --git a/.changeset/sixty-hairs-ring.md b/.changeset/sixty-hairs-ring.md
@@ -0,0 +1,5 @@
+---
+'@chainlink/coinpaprika-adapter': patch
+---
+
+Added support for WS_ENABLED env var for websocket endpoints
diff --git a/packages/sources/coinpaprika/src/config/index.ts b/packages/sources/coinpaprika/src/config/index.ts
@@ -20,6 +20,11 @@ export const config = new AdapterConfig({
     default: 'wss://streaming.coinpaprika.com/ticks',
     type: 'string',
   },
+  WS_ENABLED: {
+    description: 'Whether data should be returned from websocket or not',
+    type: 'boolean',
+    default: false,
+  },
 })
 
 export const getApiEndpoint = (settings: typeof config.settings): string =>

diff --git a/packages/sources/coinpaprika/src/endpoint/crypto.ts b/packages/sources/coinpaprika/src/endpoint/crypto.ts
@@ -1,7 +1,12 @@
 import { CryptoPriceEndpoint } from '@chainlink/external-adapter-framework/adapter'
 import { TransportRoutes } from '@chainlink/external-adapter-framework/transports'
 import { buildCryptoHttpTransport, buildWebsocketTransport } from '../transport/utils'
-import { BaseEndpointTypes, cryptoInputParameters, customInputValidation } from './utils'
+import {
+  BaseEndpointTypes,
+  cryptoInputParameters,
+  customInputValidation,
+  customRouter,
+} from './utils'
 import overrides from '../config/overrides.json'
 
 export const endpoint = new CryptoPriceEndpoint({
@@ -10,7 +15,7 @@ export const endpoint = new CryptoPriceEndpoint({
   transportRoutes: new TransportRoutes<BaseEndpointTypes>()
     .register('ws', buildWebsocketTransport('p'))
     .register('rest', buildCryptoHttpTransport('price')),
-  defaultTransport: 'rest',
+  customRouter,
   inputParameters: cryptoInputParameters,
   overrides: overrides.coinpaprika,
   customInputValidation,

diff --git a/packages/sources/coinpaprika/src/endpoint/marketcap.ts b/packages/sources/coinpaprika/src/endpoint/marketcap.ts
@@ -2,14 +2,19 @@ import { PriceEndpoint } from '@chainlink/external-adapter-framework/adapter'
 import overrides from '../config/overrides.json'
 import { TransportRoutes } from '@chainlink/external-adapter-framework/transports'
 import { buildCryptoHttpTransport, buildWebsocketTransport } from '../transport/utils'
-import { BaseEndpointTypes, cryptoInputParameters, customInputValidation } from './utils'
+import {
+  BaseEndpointTypes,
+  cryptoInputParameters,
+  customInputValidation,
+  customRouter,
+} from './utils'
 
 export const endpoint = new PriceEndpoint({
   name: 'marketcap',
   transportRoutes: new TransportRoutes<BaseEndpointTypes>()
     .register('ws', buildWebsocketTransport('m'))
     .register('rest', buildCryptoHttpTransport('market_cap')),
-  defaultTransport: 'rest',
+  customRouter,
   inputParameters: cryptoInputParameters,
   overrides: overrides.coinpaprika,
   customInputValidation,

diff --git a/packages/sources/coinpaprika/src/endpoint/utils.ts b/packages/sources/coinpaprika/src/endpoint/utils.ts
@@ -1,6 +1,7 @@
 import { InputParameters } from '@chainlink/external-adapter-framework/validation'
 import {
   AdapterRequest,
+  AdapterRequestData,
   SingleNumberResultResponse,
 } from '@chainlink/external-adapter-framework/util'
 
@@ -81,3 +82,14 @@ export function customInputValidation(
   }
   return
 }
+
+export const customRouter = (
+  req: AdapterRequest<typeof cryptoInputParameters.validated>,
+  adapterConfig: typeof config.settings,
+) => {
+  const rawRequestBody = req.body as unknown as { data: AdapterRequestData }
+  if (rawRequestBody.data?.transport) {
+    return rawRequestBody.data?.transport
+  }
+  return adapterConfig.WS_ENABLED ? 'ws' : 'rest'
+}
diff --git a/packages/sources/coinpaprika/src/endpoint/volume.ts b/packages/sources/coinpaprika/src/endpoint/volume.ts
@@ -2,14 +2,19 @@ import { PriceEndpoint } from '@chainlink/external-adapter-framework/adapter'
 import overrides from '../config/overrides.json'
 import { TransportRoutes } from '@chainlink/external-adapter-framework/transports'
 import { buildCryptoHttpTransport, buildWebsocketTransport } from '../transport/utils'
-import { BaseEndpointTypes, cryptoInputParameters, customInputValidation } from './utils'
+import {
+  BaseEndpointTypes,
+  cryptoInputParameters,
+  customInputValidation,
+  customRouter,
+} from './utils'
 
 export const endpoint = new PriceEndpoint({
   name: 'volume',
   transportRoutes: new TransportRoutes<BaseEndpointTypes>()
     .register('ws', buildWebsocketTransport('v24h'))
     .register('rest', buildCryptoHttpTransport('volume_24h')),
-  defaultTransport: 'rest',
+  customRouter,
   inputParameters: cryptoInputParameters,
   overrides: overrides.coinpaprika,
   customInputValidation,

diff --git a/packages/sources/coinpaprika/test/integration/adapter-ws.test.ts b/packages/sources/coinpaprika/test/integration/adapter-ws.test.ts
@@ -35,7 +35,6 @@ describe('websocket', () => {
     base: 'AAA',
     coinid: 'eth-ethereum',
     quote: 'USD',
-    transport: 'ws',
     endpoint: 'marketcap',
   }
 
@@ -44,6 +43,7 @@ describe('websocket', () => {
     process.env['CACHE_POLLING_MAX_RETRIES'] = process.env['CACHE_POLLING_MAX_RETRIES'] ?? '0'
     process.env['METRICS_ENABLED'] = process.env['METRICS_ENABLED'] ?? 'false'
     process.env['WS_API_ENDPOINT'] = process.env['WS_API_ENDPOINT'] ?? wsEndpoint
+    process.env['WS_ENABLED'] = process.env['WS_ENABLED'] ?? 'true'
 
     mockWebSocketProvider(WebSocketClassProvider)
     mockWsServer = mockCryptoWebSocketServer(wsEndpoint)