Add more test cases

Author: cawthorne

test/transports/websocket.test.ts

@@ -1440,7 +1440,12 @@ test.serial(
       })
     })
 
-    // Mimics Tiingo's wsSelectUrl with a 1:1 primary:secondary ratio
+    // This inline URL function is a minimal stand-in for any adapter that uses
+    // the counter to alternate between a primary and secondary URL (e.g. Tiingo's
+    // wsSelectUrl with a 1:1 ratio). The framework test cannot import wsSelectUrl
+    // directly since ea-framework-js has no dependency on external-adapters-js.
+    // The production scenario using the actual wsSelectUrl is covered in:
+    //   packages/sources/tiingo/test/integration/adapter-ws-reconnect.test.ts
     const transport = new WebSocketTransport<WebSocketTypes>({
       url: (_context, _desiredSubs, params) => {
         const counter = params.streamHandlerInvocationsWithNoConnection
@@ -1536,3 +1541,179 @@ test.serial(
     await t.context.clock.runToLastAsync()
   },
 )
+
+test.serial(
+  'does not increment failover counter on normal closure (code 1000)',
+  async (t) => {
+    const base = 'ETH'
+    const quote = 'DOGE'
+
+    const counterValues: number[] = []
+
+    mockWebSocketProvider(WebSocketClassProvider)
+    const mockWsServer = new Server(ENDPOINT_URL, { mock: false })
+    mockWsServer.on('connection', (socket) => {
+      socket.on('message', () => {
+        // Normal closure -- framework should NOT increment the failover counter
+        socket.close()
+      })
+    })
+
+    const transport = new WebSocketTransport<WebSocketTypes>({
+      url: (_context, _desiredSubs, params) => {
+        counterValues.push(params.streamHandlerInvocationsWithNoConnection)
+        return ENDPOINT_URL
+      },
+      handlers: {
+        message(message) {
+          if (!message.pair) {
+            return []
+          }
+          const [curBase, curQuote] = message.pair.split('/')
+          return [
+            {
+              params: { base: curBase, quote: curQuote },
+              response: {
+                data: { result: message.value },
+                result: message.value,
+              },
+            },
+          ]
+        },
+      },
+      builders: {
+        subscribeMessage: (params) => ({
+          request: 'subscribe',
+          pair: `${params.base}/${params.quote}`,
+        }),
+        unsubscribeMessage: (params) => ({
+          request: 'unsubscribe',
+          pair: `${params.base}/${params.quote}`,
+        }),
+      },
+    })
+
+    const webSocketEndpoint = new AdapterEndpoint({
+      name: 'TEST',
+      transport: transport,
+      inputParameters,
+    })
+
+    const config = new AdapterConfig(
+      {},
+      {
+        envDefaultOverrides: {
+          BACKGROUND_EXECUTE_MS_WS,
+          WS_SUBSCRIPTION_UNRESPONSIVE_TTL: 180_000,
+        },
+      },
+    )
+
+    const adapter = new Adapter({
+      name: 'TEST',
+      defaultEndpoint: 'test',
+      config,
+      endpoints: [webSocketEndpoint],
+    })
+
+    const testAdapter = await TestAdapter.startWithMockedCache(adapter, t.context)
+
+    await testAdapter.request({ base, quote })
+
+    // Run through several background execute cycles where the server closes normally each time
+    await runAllUntilTime(t.context.clock, BACKGROUND_EXECUTE_MS_WS * 5 + 100)
+
+    t.true(counterValues.length >= 3, `Expected at least 3 url calls, got ${counterValues.length}`)
+
+    // Counter should remain 0 throughout -- normal closes must not increment it
+    for (const value of counterValues) {
+      t.is(value, 0, `Counter should stay at 0 after normal close, got ${value}`)
+    }
+
+    await testAdapter.api.close()
+    mockWsServer.close()
+    await t.context.clock.runToLastAsync()
+  },
+)
+
+test.serial(
+  'sets ws_connection_failover_count metric on abnormal closure',
+  async (t) => {
+    const base = 'ETH'
+    const quote = 'DOGE'
+    process.env['METRICS_ENABLED'] = 'true'
+    eaMetrics.clear()
+
+    mockWebSocketProvider(WebSocketClassProvider)
+    const mockWsServer = new Server(ENDPOINT_URL, { mock: false })
+    mockWsServer.on('connection', (socket) => {
+      socket.on('message', () => {
+        socket.close({ code: 4000, reason: 'Abnormal', wasClean: false })
+      })
+    })
+
+    const adapter = createAdapter({
+      WS_SUBSCRIPTION_UNRESPONSIVE_TTL: 180_000,
+    })
+
+    const testAdapter = await TestAdapter.startWithMockedCache(adapter, t.context)
+
+    await testAdapter.request({ base, quote })
+
+    // One background execute cycle: connect -> subscribe -> close 4000 -> counter=1
+    await runAllUntilTime(t.context.clock, BACKGROUND_EXECUTE_MS_WS + 100)
+
+    const metrics = await testAdapter.getMetrics()
+    metrics.assert(t, {
+      name: 'ws_connection_failover_count',
+      labels: { transport_name: 'default_single_transport', url: 'wss://test-ws.com/asd' },
+      expectedValue: 1,
+    })
+
+    process.env['METRICS_ENABLED'] = 'false'
+    await testAdapter.api.close()
+    mockWsServer.close()
+    await t.context.clock.runToLastAsync()
+  },
+)
+
+test.serial(
+  'does not set ws_connection_failover_count metric on normal closure (code 1000)',
+  async (t) => {
+    const base = 'ETH'
+    const quote = 'DOGE'
+    process.env['METRICS_ENABLED'] = 'true'
+    eaMetrics.clear()
+
+    mockWebSocketProvider(WebSocketClassProvider)
+    const mockWsServer = new Server(ENDPOINT_URL, { mock: false })
+    mockWsServer.on('connection', (socket) => {
+      socket.on('message', () => {
+        // Normal closure -- metric must not be emitted
+        socket.close()
+      })
+    })
+
+    const adapter = createAdapter({
+      WS_SUBSCRIPTION_UNRESPONSIVE_TTL: 180_000,
+    })
+
+    const testAdapter = await TestAdapter.startWithMockedCache(adapter, t.context)
+
+    await testAdapter.request({ base, quote })
+
+    await runAllUntilTime(t.context.clock, BACKGROUND_EXECUTE_MS_WS + 100)
+
+    const metrics = await testAdapter.getMetrics()
+    // The failover count metric must not appear in the Prometheus output at all
+    const metricPresent = [...metrics.map.keys()].some((k) =>
+      k.startsWith('ws_connection_failover_count'),
+    )
+    t.false(metricPresent, 'ws_connection_failover_count should not be emitted after a normal close')
+
+    process.env['METRICS_ENABLED'] = 'false'
+    await testAdapter.api.close()
+    mockWsServer.close()
+    await t.context.clock.runToLastAsync()
+  },
+)