npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@relaycorp/ws-mock

v5.2.13

Published

Mock client and server to unit test the NPM package 'ws'

Downloads

7,501

Readme

@relaycorp/ws-mock

Mock client and server to unit test servers and clients powered by ws.

Install

npm install @relaycorp/ws-mock

Using the mock client

You'd use a mock client when you need to test a server. You should initialise MockClient by passing the ws server to be tested and then call client.connect() to initiate the connection. From that point you can interact with the server. For example:

test('Challenge should be sent as soon as client connects', async () => {
  const client = new MockClient(wsServer);
  await client.connect();

  const challengeSerialized = await client.receive();
  expect(challengeSerialized).toBeInstanceOf(ArrayBuffer);
});

You'll find real-world examples in relaycorp/relaynet-internet-gateway and relaycorp/awala-gateway-desktop.

Using the mock server

You'd use a mock server when you need to test a client. You basically need to initialise MockServer and replace the default export from ws with a mock WebSocket. Here's an example with Jest:

let mockServer: MockServer;
beforeEach(() => {
  mockServer = new MockServer();
});
jest.mock('ws', () => ({
  __esModule: true,
  default: jest.fn().mockImplementation(() => mockServer.client),
}));

test('Server message should be played back', async () => {
  const clientUnderTest = new ClientUnderTest();
  const messageToEcho = 'foo';

  await mockServer.use(
    clientUnderTest.connectToServerAndInteractWithIt(),
    async () => {
      await mockServer.send(messageToEcho);

      // Check that the client sent the message back to the server:
      const clientResponse = await mockServer.receive();
      expect(clientResponse).toEqual(messageToEcho);
    },
  );
});

You'll find real-world examples in relaycorp/relaynet-poweb-js.

Using streams

When using streams in the unit under test, make sure to mock the createWebSocketStream function in ws. Here's an example with Jest:

import { createMockWebSocketStream } from '@relaycorp/ws-mock';
import WebSocket from 'ws';

jest
  .spyOn(WebSocket, 'createWebSocketStream')
  .mockImplementation(createMockWebSocketStream);