finnhub-secondary: Add market status endpoint (#3900)

* finnhub-secondary: Add market status endpoint

* Fix test

* Allow lower case market names

* Fix test

Author: martin-cll

.changeset/purple-dryers-fry.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/finnhub-secondary-adapter': minor
+---
+
+Add market-status endpoint

.changeset/shy-cheetahs-marry.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/finnhub-adapter': patch
+---
+
+Export market status endpoint and allow lower case market names

packages/sources/finnhub-secondary/src/endpoint/index.ts

@@ -1 +1,2 @@
+export { endpoint as marketStatus } from './market-status'
 export { endpoint as quote } from './quote'

packages/sources/finnhub-secondary/src/endpoint/market-status.ts

@@ -0,0 +1,3 @@
+import { marketStatusEndpoint } from '@chainlink/finnhub-adapter'
+
+export const endpoint = marketStatusEndpoint

packages/sources/finnhub-secondary/src/index.ts

@@ -1,14 +1,14 @@
 import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
 import { PriceAdapter } from '@chainlink/external-adapter-framework/adapter'
-import { quote } from './endpoint'
 import { config, rateLimiting } from '@chainlink/finnhub-adapter'
 import includes from './config/includes.json'
+import { marketStatus, quote } from './endpoint'
 
 export const adapter = new PriceAdapter({
   defaultEndpoint: quote.name,
   name: 'FINNHUB-SECONDARY',
   config,
-  endpoints: [quote],
+  endpoints: [quote, marketStatus],
   rateLimiting,
   includes,
 })

packages/sources/finnhub-secondary/test/integration/__snapshots__/adapter-market-status.test.ts.snap

@@ -0,0 +1,86 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Market status endpoint should return error for invalid market 1`] = `
+{
+  "error": {
+    "message": "[Param: market] input is not one of valid options (AD,AS,AT,AX,BA,BC,BD,BE,BH,BK,BO,BR,CA,CN,CO,CR,CS,DB,DE,DU,F,HE,HK,HM,IC,IR,IS,JK,JO,KL,KQ,KS,KW,L,LS,MC,ME,MI,MT,MU,MX,NE,NL,NS,NZ,OL,PA,PM,PR,QA,RO,RG,SA,SG,SI,SN,SR,SS,ST,SW,SZ,T,TA,TL,TO,TW,TWO,US,V,VI,VN,VS,WA,HA,SX,TG,SC,NYSE,ad,as,at,ax,ba,bc,bd,be,bh,bk,bo,br,ca,cn,co,cr,cs,db,de,du,f,he,hk,hm,ic,ir,is,jk,jo,kl,kq,ks,kw,l,ls,mc,me,mi,mt,mu,mx,ne,nl,ns,nz,ol,pa,pm,pr,qa,ro,rg,sa,sg,si,sn,sr,ss,st,sw,sz,t,ta,tl,to,tw,two,us,v,vi,vn,vs,wa,ha,sx,tg,sc,nyse)",
+    "name": "AdapterError",
+  },
+  "status": "errored",
+  "statusCode": 400,
+}
+`;
+
+exports[`Market status endpoint should return success with closed 1`] = `
+{
+  "data": {
+    "result": 1,
+  },
+  "result": 1,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 1641035471111,
+    "providerDataRequestedUnixMs": 1641035471111,
+    "providerIndicatedTimeUnixMs": 1697018041000,
+  },
+}
+`;
+
+exports[`Market status endpoint should return success with closed; null status in response 1`] = `
+{
+  "data": {
+    "result": 1,
+  },
+  "result": 1,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 1641035471111,
+    "providerDataRequestedUnixMs": 1641035471111,
+    "providerIndicatedTimeUnixMs": 1697018041000,
+  },
+}
+`;
+
+exports[`Market status endpoint should return success with lower case market 1`] = `
+{
+  "data": {
+    "result": 2,
+  },
+  "result": 2,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 1641035471111,
+    "providerDataRequestedUnixMs": 1641035471111,
+    "providerIndicatedTimeUnixMs": 1697018041000,
+  },
+}
+`;
+
+exports[`Market status endpoint should return success with open 1`] = `
+{
+  "data": {
+    "result": 2,
+  },
+  "result": 2,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 1641035471111,
+    "providerDataRequestedUnixMs": 1641035471111,
+    "providerIndicatedTimeUnixMs": 1697018041000,
+  },
+}
+`;
+
+exports[`Market status endpoint should return success with unknown 1`] = `
+{
+  "data": {
+    "result": 0,
+  },
+  "result": 0,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 1641035471111,
+    "providerDataRequestedUnixMs": 1641035471111,
+  },
+}
+`;

packages/sources/finnhub-secondary/test/integration/adapter-market-status.test.ts

@@ -0,0 +1,109 @@
+import { MarketStatus } from '@chainlink/external-adapter-framework/adapter'
+import {
+  TestAdapter,
+  setEnvVariables,
+} from '@chainlink/external-adapter-framework/util/testing-utils'
+import * as nock from 'nock'
+import process from 'process'
+
+import { mockMarketStatusResponseSuccess } from './fixtures'
+
+describe('Market status endpoint', () => {
+  let spy: jest.SpyInstance
+  let testAdapter: TestAdapter
+  let oldEnv: NodeJS.ProcessEnv
+
+  beforeAll(async () => {
+    oldEnv = JSON.parse(JSON.stringify(process.env))
+    process.env['API_KEY'] = 'fake-api-key'
+    const mockDate = new Date('2022-01-01T11:11:11.111Z')
+    spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
+
+    const adapter = (await import('./../../src')).adapter
+    adapter.rateLimiting = undefined
+    testAdapter = await TestAdapter.startWithMockedCache(adapter, {
+      testAdapter: {} as TestAdapter<never>,
+    })
+  })
+
+  afterAll(async () => {
+    setEnvVariables(oldEnv)
+    await testAdapter.api.close()
+    nock.restore()
+    nock.cleanAll()
+    spy.mockRestore()
+  })
+
+  const openMarket = {
+    endpoint: 'market-status',
+    market: 'NYSE',
+  }
+  const closedMarket = {
+    endpoint: 'market-status',
+    market: 'AD',
+  }
+  const nullMarket = {
+    endpoint: 'market-status',
+    market: 'AS',
+  }
+  const unknownMarket = {
+    endpoint: 'market-status',
+    market: 'AT',
+  }
+  const invalidMarket = {
+    endpoint: 'market-status',
+    market: 'invalid_market',
+  }
+  const lowerCaseMarket = {
+    endpoint: 'market-status',
+    market: 'nyse',
+  }
+
+  it('should return success with open', async () => {
+    mockMarketStatusResponseSuccess()
+
+    const response = await testAdapter.request(openMarket)
+    expect(response.json()).toMatchSnapshot()
+    expect(response.json().result).toEqual(MarketStatus.OPEN)
+  })
+
+  it('should return success with closed', async () => {
+    mockMarketStatusResponseSuccess()
+
+    const response = await testAdapter.request(closedMarket)
+    expect(response.json()).toMatchSnapshot()
+    expect(response.json().result).toEqual(MarketStatus.CLOSED)
+  })
+
+  it('should return success with closed; null status in response', async () => {
+    mockMarketStatusResponseSuccess()
+
+    const response = await testAdapter.request(nullMarket)
+    expect(response.json()).toMatchSnapshot()
+    expect(response.json().result).toEqual(MarketStatus.CLOSED)
+  })
+
+  it('should return success with unknown', async () => {
+    mockMarketStatusResponseSuccess()
+
+    const response = await testAdapter.request(unknownMarket)
+    expect(response.json()).toMatchSnapshot()
+    expect(response.json().result).toEqual(MarketStatus.UNKNOWN)
+  })
+
+  it('should return error for invalid market', async () => {
+    mockMarketStatusResponseSuccess()
+
+    const response = await testAdapter.request(invalidMarket)
+    expect(response.json()).toMatchSnapshot()
+    expect(response.statusCode).toBe(400)
+  })
+
+  it('should return success with lower case market', async () => {
+    mockMarketStatusResponseSuccess()
+
+    const response = await testAdapter.request(lowerCaseMarket)
+    expect(response.json()).toMatchSnapshot()
+    expect(response.json().result).toEqual(MarketStatus.OPEN)
+  })
+})

packages/sources/finnhub-secondary/test/integration/fixtures.ts

@@ -81,3 +81,65 @@ export const mockResponseSuccess = (): nock.Scope => {
       ],
     )
 }
+
+export const mockMarketStatusResponseSuccess = (): nock.Scope =>
+  nock('https://finnhub.io/api/v1', {
+    encodedQueryParams: true,
+  })
+    .persist()
+    .get('/stock/market-status')
+    .query({ token: 'fake-api-key', exchange: 'US' })
+    .reply(
+      200,
+      {
+        exchange: 'US',
+        holiday: null,
+        isOpen: true,
+        session: 'regular',
+        timezone: 'America/New_York',
+        t: 1697018041,
+      },
+      ['Content-Type', 'application/json'],
+    )
+    .get('/stock/market-status')
+    .query({ token: 'fake-api-key', exchange: 'AD' })
+    .reply(
+      200,
+      {
+        exchange: 'AD',
+        holiday: null,
+        isOpen: false,
+        session: 'pre-market',
+        timezone: 'Asia/Dubai',
+        t: 1697018041,
+      },
+      ['Content-Type', 'application/json'],
+    )
+    .get('/stock/market-status')
+    .query({ token: 'fake-api-key', exchange: 'AS' })
+    .reply(
+      200,
+      {
+        exchange: 'AS',
+        holiday: 'Fake Holiday',
+        isOpen: false,
+        session: null,
+        timezone: 'Europe/Amsterdam',
+        t: 1697018041,
+      },
+      ['Content-Type', 'application/json'],
+    )
+    .get('/stock/market-status')
+    .query({ token: 'fake-api-key', exchange: 'AT' })
+    .reply(
+      200,
+      {
+        exchange: '',
+        holiday: null,
+        isOpen: null,
+        session: null,
+        timezone: null,
+        t: null,
+      },
+      ['Content-Type', 'application/json'],
+    )

packages/sources/finnhub/src/endpoint/market-status.ts

@@ -2,18 +2,25 @@ import {
   MarketStatusEndpoint,
   MarketStatusResultResponse,
 } from '@chainlink/external-adapter-framework/adapter'
+import { AdapterRequest } from '@chainlink/external-adapter-framework/util'
 import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { TypeFromDefinition } from '@chainlink/external-adapter-framework/validation/input-params'
 
 import { config } from '../config'
 import { marketAliases, transport } from '../transport/market-status'
 import { validMarkets } from '../transport/utils'
 
+const getAllMarketOptions = (): string[] => {
+  const allMarkets = [...validMarkets, ...marketAliases]
+  return [...allMarkets, ...allMarkets.map((market) => market.toLowerCase())]
+}
+
 const inputParameters = new InputParameters({
   market: {
     aliases: [],
     type: 'string',
     description: 'The name of the market',
-    options: [...validMarkets, ...marketAliases],
+    options: getAllMarketOptions(),
     required: true,
   },
 })
@@ -28,4 +35,11 @@ export const marketStatusEndpoint = new MarketStatusEndpoint({
   name: 'market-status',
   transport,
   inputParameters,
+  requestTransforms: [
+    (req: AdapterRequest<TypeFromDefinition<typeof inputParameters.definition>>) => {
+      const data = req.requestContext.data
+      data.market = data.market.toUpperCase()
+      return req
+    },
+  ],
 })

packages/sources/finnhub/src/index.ts

@@ -27,4 +27,11 @@ const adapter = new PriceAdapter({
 
 const server = (): Promise<ServerInstance | undefined> => expose(adapter)
 
-export { adapter, buildQuoteEndpoint, config, rateLimiting, server }
+export {
+  adapter,
+  buildQuoteEndpoint,
+  config,
+  marketStatus as marketStatusEndpoint,
+  rateLimiting,
+  server,
+}