|
| 1 | +import { CardanoWsClient } from '@cardano-sdk/cardano-services-client'; |
| 2 | +import { |
| 3 | + CardanoWsServer, |
| 4 | + GenesisData, |
| 5 | + createDnsResolver, |
| 6 | + getOgmiosCardanoNode, |
| 7 | + util |
| 8 | +} from '@cardano-sdk/cardano-services'; |
| 9 | +import { HealthCheckResponse, WsProvider } from '@cardano-sdk/core'; |
| 10 | +import { OgmiosCardanoNode } from '@cardano-sdk/ogmios'; |
| 11 | +import { Pool } from 'pg'; |
| 12 | +import { filter, firstValueFrom } from 'rxjs'; |
| 13 | +import { getEnv, walletVariables } from '../../src'; |
| 14 | +import { getPort } from 'get-port-please'; |
| 15 | +import { logger } from '@cardano-sdk/util-dev'; |
| 16 | + |
| 17 | +const env = getEnv([...walletVariables, 'DB_SYNC_CONNECTION_STRING', 'OGMIOS_URL']); |
| 18 | + |
| 19 | +const wsProviderReady = (provider: WsProvider) => |
| 20 | + new Promise<void>((resolve, reject) => { |
| 21 | + // eslint-disable-next-line prefer-const |
| 22 | + let timeout: NodeJS.Timeout | undefined; |
| 23 | + |
| 24 | + const subscription = provider.health$.subscribe(({ ok }) => { |
| 25 | + if (ok) { |
| 26 | + if (timeout) clearTimeout(timeout); |
| 27 | + subscription.unsubscribe(); |
| 28 | + resolve(); |
| 29 | + } |
| 30 | + }); |
| 31 | + |
| 32 | + timeout = setTimeout(() => { |
| 33 | + subscription.unsubscribe(); |
| 34 | + reject(new Error('WsProvider timeout')); |
| 35 | + }, 10_000); |
| 36 | + |
| 37 | + timeout.unref(); |
| 38 | + }); |
| 39 | + |
| 40 | +const wsProviderReadyAgain = (provider: WsProvider, close: () => Promise<unknown>) => |
| 41 | + new Promise<void>(async (resolve, reject) => { |
| 42 | + const oks: boolean[] = []; |
| 43 | + let closed = false; |
| 44 | + // eslint-disable-next-line prefer-const |
| 45 | + let timeout: NodeJS.Timeout | undefined; |
| 46 | + |
| 47 | + const subscription = provider.health$.subscribe(({ ok }) => { |
| 48 | + oks.push(ok); |
| 49 | + |
| 50 | + if (closed && ok) { |
| 51 | + if (timeout) clearTimeout(timeout); |
| 52 | + subscription.unsubscribe(); |
| 53 | + |
| 54 | + try { |
| 55 | + const [, ...last] = oks; |
| 56 | + |
| 57 | + // The first emitted event is the ok buffered one |
| 58 | + // next we expect at least one not ok event i.e. the close function had the desired effect |
| 59 | + // last we expect one more ok event when provider is operational once again |
| 60 | + expect(oks.length).toBeGreaterThanOrEqual(3); |
| 61 | + expect(oks[0]).toBeTruthy(); |
| 62 | + expect(oks[1]).toBeFalsy(); |
| 63 | + expect(last.some((result) => result)); |
| 64 | + |
| 65 | + resolve(); |
| 66 | + } catch (error) { |
| 67 | + reject(error); |
| 68 | + } |
| 69 | + } |
| 70 | + }); |
| 71 | + |
| 72 | + try { |
| 73 | + await close(); |
| 74 | + } catch (error) { |
| 75 | + reject(error); |
| 76 | + } |
| 77 | + |
| 78 | + closed = true; |
| 79 | + |
| 80 | + timeout = setTimeout(() => { |
| 81 | + subscription.unsubscribe(); |
| 82 | + reject(new Error('WsProvider timeout')); |
| 83 | + }, 10_000); |
| 84 | + |
| 85 | + timeout.unref(); |
| 86 | + }); |
| 87 | + |
| 88 | +describe('Web Socket', () => { |
| 89 | + let db: Pool; |
| 90 | + let cardanoNode: OgmiosCardanoNode; |
| 91 | + let genesisData: GenesisData; |
| 92 | + let port: number; |
| 93 | + |
| 94 | + let client: CardanoWsClient; |
| 95 | + let server: CardanoWsServer; |
| 96 | + |
| 97 | + const openClient = (heartbeatInterval = 55) => |
| 98 | + (client = new CardanoWsClient({ logger }, { heartbeatInterval, url: new URL(`ws://localhost:${port}/ws`) })); |
| 99 | + |
| 100 | + const openServer = (heartbeatTimeout = 60) => |
| 101 | + (server = new CardanoWsServer( |
| 102 | + { cardanoNode, db, genesisData, logger }, |
| 103 | + { dbCacheTtl: 120, heartbeatTimeout, port } |
| 104 | + )); |
| 105 | + |
| 106 | + const closeClient = () => (client ? client.close() : Promise.resolve()); |
| 107 | + const closeServer = () => (server ? new Promise<void>((resolve) => server.close(resolve)) : Promise.resolve()); |
| 108 | + |
| 109 | + const listenToClientHealthFor15Seconds = async () => { |
| 110 | + const health: HealthCheckResponse[] = []; |
| 111 | + const subscription = client.health$.subscribe((value) => health.push(value)); |
| 112 | + |
| 113 | + // Listen on client.health$ for 15" |
| 114 | + await new Promise((resolve) => setTimeout(resolve, 15_000)); |
| 115 | + |
| 116 | + subscription.unsubscribe(); |
| 117 | + |
| 118 | + return health; |
| 119 | + }; |
| 120 | + |
| 121 | + beforeAll(async () => { |
| 122 | + const dnsResolver = createDnsResolver({ factor: 1.1, maxRetryTime: 1000 }, logger); |
| 123 | + |
| 124 | + cardanoNode = await getOgmiosCardanoNode(dnsResolver, logger, { ogmiosUrl: new URL(env.OGMIOS_URL) }); |
| 125 | + db = new Pool({ connectionString: env.DB_SYNC_CONNECTION_STRING }); |
| 126 | + genesisData = await util.loadGenesisData('local-network/config/network/cardano-node/config.json'); |
| 127 | + port = await getPort(); |
| 128 | + |
| 129 | + await cardanoNode.initialize(); |
| 130 | + await cardanoNode.start(); |
| 131 | + }); |
| 132 | + |
| 133 | + afterAll(() => Promise.all([cardanoNode.shutdown(), db.end()])); |
| 134 | + |
| 135 | + afterEach(() => Promise.all([closeClient(), closeServer()])); |
| 136 | + |
| 137 | + it('Server can re-connect to DB if NOTIFY connection drops', async () => { |
| 138 | + // Close server db connection from DB server side |
| 139 | + const query = |
| 140 | + "SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE pid <> pg_backend_pid() AND query = 'LISTEN sdk_tip'"; |
| 141 | + |
| 142 | + openServer(); |
| 143 | + await wsProviderReady(server); |
| 144 | + |
| 145 | + await wsProviderReadyAgain(server, () => db.query(query)); |
| 146 | + }); |
| 147 | + |
| 148 | + it('Client can re-connect to server if web socket connection drops', async () => { |
| 149 | + openServer(); |
| 150 | + await wsProviderReady(server); |
| 151 | + |
| 152 | + openClient(); |
| 153 | + await wsProviderReady(client); |
| 154 | + |
| 155 | + await wsProviderReadyAgain(client, async () => { |
| 156 | + // Close the server and open a new one |
| 157 | + await closeServer(); |
| 158 | + openServer(); |
| 159 | + }); |
| 160 | + }); |
| 161 | + |
| 162 | + it('Server disconnects clients on heartbeat timeout', async () => { |
| 163 | + // Open a server with 3" heartbeat timeout |
| 164 | + openServer(3); |
| 165 | + await wsProviderReady(server); |
| 166 | + |
| 167 | + openClient(); |
| 168 | + await wsProviderReady(client); |
| 169 | + |
| 170 | + const health = await listenToClientHealthFor15Seconds(); |
| 171 | + |
| 172 | + // Considering the server performs timeouts check every 10" |
| 173 | + // We expect the heath state of the client goes up and down more time |
| 174 | + expect(health.length).toBeGreaterThanOrEqual(3); |
| 175 | + // We expect the heath state of the client goes up at least twice |
| 176 | + expect(health.filter(({ ok }) => ok).length).toBeGreaterThanOrEqual(2); |
| 177 | + // We expect the heath state of the client goes down at least once |
| 178 | + expect(health.some(({ ok }) => !ok)).toBeTruthy(); |
| 179 | + }); |
| 180 | + |
| 181 | + it("Server doesn't disconnects clients without heartbeat timeouts", async () => { |
| 182 | + // Open a server with 3" heartbeat timeout |
| 183 | + openServer(3); |
| 184 | + await wsProviderReady(server); |
| 185 | + |
| 186 | + // Open a client with 2" heartbeat interval |
| 187 | + openClient(2); |
| 188 | + await wsProviderReady(client); |
| 189 | + |
| 190 | + const health = await listenToClientHealthFor15Seconds(); |
| 191 | + |
| 192 | + // We expect only the buffered ok heath state |
| 193 | + expect(health.length).toBe(1); |
| 194 | + expect(health[0].ok).toBeTruthy(); |
| 195 | + }); |
| 196 | + |
| 197 | + describe('CardanoWsClient.networkInfoProvider', () => { |
| 198 | + it('It throws when disconnected but when starting', async () => { |
| 199 | + openServer(); |
| 200 | + await wsProviderReady(server); |
| 201 | + |
| 202 | + openClient(); |
| 203 | + |
| 204 | + // This test doesn't calls wsProviderReady(client) |
| 205 | + // to check the provider doesn't throw if called before its init sequence completed |
| 206 | + await expect(client.networkInfoProvider.ledgerTip()).resolves.toHaveProperty('blockNo'); |
| 207 | + |
| 208 | + await closeServer(); |
| 209 | + await firstValueFrom(client.health$.pipe(filter(({ ok }) => !ok))); |
| 210 | + |
| 211 | + await expect(client.networkInfoProvider.ledgerTip()).rejects.toThrowError('CONNECTION_FAILURE'); |
| 212 | + }); |
| 213 | + |
| 214 | + it('If called when still starting, it throws on connect error', async () => { |
| 215 | + openClient(); |
| 216 | + |
| 217 | + await expect(client.networkInfoProvider.ledgerTip()).rejects.toThrowError('CONNECTION_FAILURE'); |
| 218 | + }); |
| 219 | + }); |
| 220 | +}); |
0 commit comments