fix(util): add ServerNotReady to list of connection errors

also refactor isConnectionError to check error name instead of message

Author: mkazlauskas

Diff for: packages/cardano-services/test/Program/services/ogmios.test.ts

@@ -514,7 +514,6 @@ describe('Service dependency abstractions', () => {
       const failMockServer = createMockOgmiosServer({
         healthCheck: { response: { networkSynchronization: 0.999, success: true } },
         stateQuery: {
-          eraSummaries: { response: { failWith: { type: 'connectionError' }, success: false } },
           systemStart: { response: { success: true } }
         }
       });
@@ -539,13 +538,15 @@ describe('Service dependency abstractions', () => {
 
       await node.initialize();
       await node.start();
+      for (const socket of failMockServer.wss.clients) {
+        socket.close();
+      }
+      await serverClosePromise(failMockServer);
       await expect(node.eraSummaries()).rejects.toBeInstanceOf(
         CardanoNodeErrors.CardanoClientErrors.UnknownResultError
       );
       expect(dnsResolverMock).toBeCalledTimes(2);
       await node.shutdown();
-
-      await serverClosePromise(failMockServer);
     });
 
     it('should execute a provider operation without to intercept it', async () => {

Diff for: packages/e2e/test/long-running/projector-ogmios-connection.test.ts

@@ -91,20 +91,9 @@ describe('projector ogmios connection', () => {
 
   afterEach(() => removePrevent());
 
-  it.skip('projector reconnects after a short delay', async () => {
+  it('projector reconnects after a short delay', async () => {
     await killContainer(ogmiosContainer);
     await waitProjector();
-    // This throws because is not able to complete HTTP request
-    await checkProjector();
-  });
-
-  // Once the problem which prevent the original test to work is solved
-  // the original test can be un-skipped and this one can be removed
-  it('projector reconnects after a short delay - alternative', async () => {
-    await killContainer(ogmiosContainer);
-    // Add a 10" sleep as a quick workaround for HTTP connection issue
-    await delay(10_000);
-    await waitProjector();
     await checkProjector();
   });
 
@@ -123,10 +112,7 @@ describe('projector ogmios connection', () => {
     await killContainer(stakePoolProjectorContainer);
     await waitProjector(true, true);
     await removePrevent();
-    // Once the 'projector reconnects after a short delay' problem is solved
-    // also remove following line and uncomment next one
-    await waitProjector(false, true);
-    // await waitProjector();
+    await waitProjector();
     await checkProjector();
   });
 });

Diff for: packages/ogmios/test/mocks/mockOgmiosServer.ts

@@ -13,7 +13,7 @@ import {
 } from './types';
 import { HEALTH_RESPONSE_BODY } from './util';
 import { Milliseconds } from '@cardano-sdk/core';
-import { Schema, UnknownResultError } from '@cardano-ogmios/client';
+import { Schema } from '@cardano-ogmios/client';
 import { Server, createServer } from 'http';
 import WebSocket from 'ws';
 import delay from 'delay';
@@ -152,10 +152,6 @@ const handleQuery = async (query: string, config: MockOgmiosServerConfig, send:
         ];
       } else if (config.stateQuery?.eraSummaries?.response.failWith?.type === 'unknownResultError') {
         result = 'unknown';
-      } else if (config.stateQuery?.eraSummaries?.response.failWith?.type === 'connectionError') {
-        // This error is never actually returned by the server,
-        // But is used by cardano-services tests
-        result = new UnknownResultError({ code: 'ECONNREFUSED' });
       } else {
         throw new Error('Unknown mock response');
       }

Diff for: packages/ogmios/test/mocks/types.ts

@@ -17,7 +17,7 @@ export type TxSubmitResponse = {
 export type EraSummariesResponse = {
   success: boolean;
   failWith?: {
-    type: 'unknownResultError' | 'connectionError';
+    type: 'unknownResultError';
   };
 };
 

Diff for: packages/util/src/network.ts

@@ -1,22 +1,21 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
-export const connectionErrorCodes = [
+const connectionErrorCodes = new Set([
   'ETIMEDOUT',
   'ECONNRESET',
   'ECONNREFUSED',
   'EPIPE',
   'ENOTFOUND',
   'ENETUNREACH',
-  'EAI_AGAIN',
-  'WebSocket is closed'
-];
+  'EAI_AGAIN'
+]);
 
-export const isConnectionError = (error: any) => {
-  if (
-    (error?.code && connectionErrorCodes.includes(error.code)) ||
-    (error?.message && connectionErrorCodes.some((err) => error.message.includes(err)))
-  ) {
+const connectionErrorNames = new Set(['WebSocketClosed', 'ServerNotReady']);
+
+export const isConnectionError = (error: any): boolean => {
+  if (!error || typeof error !== 'object') return false;
+  if ((error?.name && connectionErrorNames.has(error.name)) || (error?.code && connectionErrorCodes.has(error.code))) {
     return true;
   }
-  return false;
+  return isConnectionError(error.innerError);
 };

Diff for: packages/util/test/network.test.ts

@@ -0,0 +1,19 @@
+import { isConnectionError } from '../src';
+
+describe('isConnectionError', () => {
+  it('returns false for an object that does not resemble a connection error', () => {
+    expect(isConnectionError({})).toBe(false);
+  });
+
+  it('returns true if "code" indicates that it is a connection error', () => {
+    expect(isConnectionError({ code: 'ECONNREFUSED' })).toBe(true);
+  });
+
+  it('returns true if "name" indicates that it is a connection error', () => {
+    expect(isConnectionError({ name: 'WebSocketClosed' })).toBe(true);
+  });
+
+  it('returns true if "innerError" is a connection error', () => {
+    expect(isConnectionError({ innerError: { name: 'WebSocketClosed' } })).toBe(true);
+  });
+});