refactor: hoist ws provider to cardano-services-client package

Author: iccicci

packages/cardano-services-client/src/WebSocket.ts

@@ -5,14 +5,15 @@ import {
   Cardano,
   EpochInfo,
   EraSummary,
+  HealthCheckResponse,
   NetworkInfoMethods,
   NetworkInfoProvider,
+  Provider,
   ProviderError,
   ProviderFailure,
   StakeSummary,
   SupplySummary,
   WSMessage,
-  WsProvider,
   createSlotEpochInfoCalc
 } from '@cardano-sdk/core';
 import { Logger } from 'ts-log';
@@ -54,6 +55,35 @@ const isEventError = (error: unknown): error is { error: Error } =>
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   typeof error === 'object' && !!error && (error as any).error instanceof Error;
 
+export class WsProvider implements Provider {
+  /** Emits the health state. */
+  public health$: Observable<HealthCheckResponse>;
+
+  private healthSubject$: ReplaySubject<HealthCheckResponse>;
+  private reason?: string;
+
+  constructor() {
+    this.health$ = this.healthSubject$ = new ReplaySubject<HealthCheckResponse>(1);
+    this.healthSubject$.next({ ok: false, reason: 'starting' });
+  }
+
+  protected emitHealth(reason?: string, overwrite?: boolean) {
+    if (!reason) {
+      this.reason = undefined;
+
+      return this.healthSubject$.next({ ok: true });
+    }
+
+    if (overwrite || !this.reason) this.reason = reason;
+
+    this.healthSubject$.next({ ok: false, reason: this.reason });
+  }
+
+  public healthCheck() {
+    return firstValueFrom(this.health$);
+  }
+}
+
 export class CardanoWsClient extends WsProvider {
   /** The client id, assigned by the server. */
   clientId = NOT_CONNECTED_ID;

packages/cardano-services/src/WsServer/server.ts

@@ -4,14 +4,14 @@ import {
   NetworkInfoResponses,
   Seconds,
   WSMessage,
-  WsProvider,
   createSlotEpochInfoCalc
 } from '@cardano-sdk/core';
 import { GenesisData } from '..';
 import { Logger } from 'ts-log';
 import { Notification, Pool } from 'pg';
 import { Server, createServer } from 'http';
 import { WebSocket, WebSocketServer } from 'ws';
+import { WsProvider } from '@cardano-sdk/cardano-services-client';
 import { getLovelaceSupply, getProtocolParameters, getStake } from './requests';
 import { initDB } from './db';
 import { toGenesisParams } from '../NetworkInfo/DbSyncNetworkInfoProvider/mappers';

packages/core/src/WebSocket.ts

@@ -1,5 +1,4 @@
-import { HealthCheckResponse, NetworkInfoProvider, Provider } from './Provider';
-import { Observable, ReplaySubject, firstValueFrom } from 'rxjs';
+import { NetworkInfoProvider } from './Provider';
 
 export type AsyncReturnType<F extends () => unknown> = F extends () => Promise<infer R> ? R : never;
 
@@ -13,32 +12,3 @@ export interface WSMessage {
   /** Latest value(s) for the `NetworkInfoProvider` methods.*/
   networkInfo?: Partial<NetworkInfoResponses>;
 }
-
-export class WsProvider implements Provider {
-  /** Emits the health state. */
-  public health$: Observable<HealthCheckResponse>;
-
-  private healthSubject$: ReplaySubject<HealthCheckResponse>;
-  private reason?: string;
-
-  constructor() {
-    this.health$ = this.healthSubject$ = new ReplaySubject<HealthCheckResponse>(1);
-    this.healthSubject$.next({ ok: false, reason: 'starting' });
-  }
-
-  protected emitHealth(reason?: string, overwrite?: boolean) {
-    if (!reason) {
-      this.reason = undefined;
-
-      return this.healthSubject$.next({ ok: true });
-    }
-
-    if (overwrite || !this.reason) this.reason = reason;
-
-    this.healthSubject$.next({ ok: false, reason: this.reason });
-  }
-
-  public healthCheck() {
-    return firstValueFrom(this.health$);
-  }
-}

packages/e2e/test/ws-server/webSocket.test.ts

@@ -1,12 +1,12 @@
-import { CardanoWsClient } from '@cardano-sdk/cardano-services-client';
+import { CardanoWsClient, WsProvider } from '@cardano-sdk/cardano-services-client';
 import {
   CardanoWsServer,
   GenesisData,
   createDnsResolver,
   getOgmiosCardanoNode,
   util
 } from '@cardano-sdk/cardano-services';
-import { HealthCheckResponse, WsProvider } from '@cardano-sdk/core';
+import { HealthCheckResponse } from '@cardano-sdk/core';
 import { OgmiosCardanoNode } from '@cardano-sdk/ogmios';
 import { Pool } from 'pg';
 import { filter, firstValueFrom } from 'rxjs';