@pezkuwi/rpc-provider 16.5.16 → 16.5.18

package/src/ws/send.spec.ts

@@ -0,0 +1,126 @@
+// Copyright 2017-2025 @pezkuwi/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import type { Request } from '../mock/mockWs.js';
+import type { Global, Mock } from '../mock/types.js';
+
+import { mockWs } from '../mock/mockWs.js';
+import { WsProvider } from './index.js';
+
+declare const global: Global;
+
+const TEST_WS_URL = 'ws://localhost-send.spec.ts:9965';
+
+let provider: WsProvider | null;
+let mock: Mock;
+
+function createMock (requests: Request[]): void {
+  mock = mockWs(requests, TEST_WS_URL);
+}
+
+function createWs (autoConnect = 1000): Promise<WsProvider> {
+  provider = new WsProvider(TEST_WS_URL, autoConnect);
+
+  return provider.isReady;
+}
+
+describe('send', (): void => {
+  let globalWs: typeof WebSocket;
+
+  beforeEach((): void => {
+    globalWs = global.WebSocket;
+  });
+
+  afterEach(async () => {
+    global.WebSocket = globalWs;
+
+    if (mock) {
+      await mock.done();
+    }
+
+    if (provider) {
+      await provider.disconnect();
+      provider = null;
+    }
+  });
+
+  it('handles internal errors', (): Promise<any> => {
+    createMock([{
+      id: 1,
+      method: 'test_body',
+      reply: {
+        result: 'ok'
+      }
+    }]);
+
+    return createWs().then((ws) =>
+      ws
+        .send('test_encoding', [{ error: 'send error' }])
+        .catch((error): void => {
+          // eslint-disable-next-line jest/no-conditional-expect
+          expect((error as Error).message).toEqual('send error');
+        })
+    );
+  });
+
+  it('passes the body through correctly', (): Promise<void> => {
+    createMock([{
+      id: 1,
+      method: 'test_body',
+      reply: {
+        result: 'ok'
+      }
+    }]);
+
+    return createWs().then((ws) =>
+      ws
+        .send('test_body', ['param'])
+        .then((): void => {
+          expect(
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            (mock.body as any).test_body
+          ).toEqual('{"id":1,"jsonrpc":"2.0","method":"test_body","params":["param"]}');
+        })
+    );
+  });
+
+  it('throws error when !response.ok', (): Promise<any> => {
+    createMock([{
+      error: {
+        code: 666,
+        message: 'error'
+      },
+      id: 1,
+      method: 'something'
+    }]);
+
+    return createWs().then((ws) =>
+      ws
+        .send('test_error', [])
+        .catch((error): void => {
+          // eslint-disable-next-line jest/no-conditional-expect
+          expect((error as Error).message).toMatch(/666: error/);
+        })
+    );
+  });
+
+  it('adds subscriptions', (): Promise<void> => {
+    createMock([{
+      id: 1,
+      method: 'test_sub',
+      reply: {
+        result: 1
+      }
+    }]);
+
+    return createWs().then((ws) =>
+      ws
+        .send('test_sub', [])
+        .then((id): void => {
+          expect(id).toEqual(1);
+        })
+    );
+  });
+});

package/src/ws/state.spec.ts

@@ -0,0 +1,20 @@
+// Copyright 2017-2025 @pezkuwi/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import { WsProvider } from './index.js';
+
+describe('state', (): void => {
+  it('requires an ws:// prefixed endpoint', (): void => {
+    expect(
+      () => new WsProvider('http://', 0)
+    ).toThrow(/with 'ws/);
+  });
+
+  it('allows wss:// endpoints', (): void => {
+    expect(
+      () => new WsProvider('wss://', 0)
+    ).not.toThrow();
+  });
+});

package/src/ws/subscribe.spec.ts

@@ -0,0 +1,68 @@
+// Copyright 2017-2025 @pezkuwi/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import type { Request } from '../mock/mockWs.js';
+import type { Global, Mock } from './../mock/types.js';
+
+import { mockWs } from '../mock/mockWs.js';
+import { WsProvider } from './index.js';
+
+declare const global: Global;
+
+const TEST_WS_URL = 'ws://localhost-subscribe.test.ts:9933';
+
+let provider: WsProvider | null;
+let mock: Mock;
+
+function createMock (requests: Request[]): void {
+  mock = mockWs(requests, TEST_WS_URL);
+}
+
+function createWs (autoConnect = 1000): Promise<WsProvider> {
+  provider = new WsProvider(TEST_WS_URL, autoConnect);
+
+  return provider.isReady;
+}
+
+describe('subscribe', (): void => {
+  let globalWs: typeof WebSocket;
+
+  beforeEach((): void => {
+    globalWs = global.WebSocket;
+  });
+
+  afterEach(async () => {
+    global.WebSocket = globalWs;
+
+    if (mock) {
+      await mock.done();
+    }
+
+    if (provider) {
+      await provider.disconnect();
+      provider = null;
+    }
+  });
+
+  it('adds subscriptions', (): Promise<void> => {
+    createMock([{
+      id: 1,
+      method: 'test_sub',
+      reply: {
+        result: 1
+      }
+    }]);
+
+    return createWs().then((ws) =>
+      ws
+        .subscribe('type', 'test_sub', [], (cb): void => {
+          expect(cb).toEqual(expect.anything());
+        })
+        .then((id): void => {
+          expect(id).toEqual(1);
+        })
+    );
+  });
+});

package/src/ws/unsubscribe.spec.ts

@@ -0,0 +1,100 @@
+// Copyright 2017-2025 @pezkuwi/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import type { Request } from '../mock/mockWs.js';
+import type { Global, Mock } from './../mock/types.js';
+
+import { mockWs } from '../mock/mockWs.js';
+import { WsProvider } from './index.js';
+
+declare const global: Global;
+
+const TEST_WS_URL = 'ws://localhost-unsubscribe.test.ts:9933';
+
+let provider: WsProvider | null;
+let mock: Mock;
+
+function createMock (requests: Request[]): void {
+  mock = mockWs(requests, TEST_WS_URL);
+}
+
+function createWs (autoConnect = 1000): Promise<WsProvider> {
+  provider = new WsProvider(TEST_WS_URL, autoConnect);
+
+  return provider.isReady;
+}
+
+describe('subscribe', (): void => {
+  let globalWs: typeof WebSocket;
+
+  beforeEach((): void => {
+    globalWs = global.WebSocket;
+  });
+
+  afterEach(async () => {
+    global.WebSocket = globalWs;
+
+    if (mock) {
+      await mock.done();
+    }
+
+    if (provider) {
+      await provider.disconnect();
+      provider = null;
+    }
+  });
+
+  it('removes subscriptions', async (): Promise<void> => {
+    createMock([
+      {
+        id: 1,
+        method: 'subscribe_test',
+        reply: {
+          result: 1
+        }
+      },
+      {
+        id: 2,
+        method: 'unsubscribe_test',
+        reply: {
+          result: true
+        }
+      }
+    ]);
+
+    await createWs().then((ws) =>
+      ws
+        .subscribe('test', 'subscribe_test', [], (cb): void => {
+          expect(cb).toEqual(expect.anything());
+        })
+        .then((id): Promise<boolean> => {
+          return ws.unsubscribe('test', 'subscribe_test', id);
+        })
+    );
+  });
+
+  it('fails when sub not found', (): Promise<void> => {
+    createMock([{
+      id: 1,
+      method: 'subscribe_test',
+      reply: {
+        result: 1
+      }
+    }]);
+
+    return createWs().then((ws) =>
+      ws
+        .subscribe('test', 'subscribe_test', [], (cb): void => {
+          expect(cb).toEqual(expect.anything());
+        })
+        .then((): Promise<boolean> => {
+          return ws.unsubscribe('test', 'subscribe_test', 111);
+        })
+        .then((result): void => {
+          expect(result).toBe(false);
+        })
+    );
+  });
+});

package/tsconfig.build.json

@@ -0,0 +1,17 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": "..",
+    "outDir": "./build",
+    "rootDir": "./src",
+    "resolveJsonModule": true
+  },
+  "exclude": [
+    "**/*.spec.ts",
+    "**/mod.ts"
+  ],
+  "references": [
+    { "path": "../types/tsconfig.build.json" },
+    { "path": "../types-support/tsconfig.build.json" }
+  ]
+}