npmpackage.info

Gathering detailed insights and metrics for mock-socket-with-protocol

Other packages similar to mock-socket-with-protocol

hot-shots

10.2.1

Node.js client for StatsD, DogStatsD, and Telegraf

websocket-driver

0.7.4

WebSocket protocol handler with pluggable I/O

mock-socket

9.3.1

Javascript mocking library for websockets and socket.io

@figma/hot-shots

9.0.0-figma.1

Node.js client for StatsD, DogStatsD, and Telegraf

Gathering detailed insights and metrics for mock-socket-with-protocol

mock-socket-with-protocol

Javascript mocking library for websockets and socket.io

7.1.1

MIT

JavaScript

5.50 kB

361,287 1.7

Installations

npm install mock-socket-with-protocol

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Developer

TheBrainFamily

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= 4

Typescript Support

No

Node Version

9.3.0

NPM Version

5.6.0 Statistics

2 Stars

401 Commits

2 Watching

9 Branches

9 Contributors

Updated on 22 Sept 2022

Bundle Size

19.05 kB

Minified

5.50 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (99.78%)

HTML (0.22%)

Total Downloads

Cumulative downloads

Total Downloads

361,287

Last day

-28.9%

Compared to previous day

Last week

-1.9%

356

Compared to previous week

Last month

-13.8%

1,714

Compared to previous month

Last year

-55.3%

27,441

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Javascript mocking library for websockets and socket.io

Why?

This is basically mock-socket made to work with apollo subscriptions-transport-ws. The implementation is not perfect, which was noticed over two years ago by @brian-mann of cypress.io : https://github.com/thoov/mock-socket/issues/72 . Since two years later this architectural problem is still not fixed, I've decided to fork with the tiny change that's just enough to make it work in this specific usecase. Thanks @thoov for the amazing work on this package! I actually started writing my own websocket server implementation, when, after a half day of happy hacking I came to realization "this is nodejs.. someone had to got this to work before me", and there it was. :)

Installation

1npm install mock-socket-with-protocol --dev

Usage

To use within a node environment you can simply import or require the files directly. This option is great for phantomjs or CI environments.

1import { WebSocket, Server, SocketIO } from 'mock-socket-with-protocol';
2
3// OR
4
5const mockServer = require('mock-socket-with-protocol').Server;
6const socketIO = require('mock-socket-with-protocol').SocketIO;
7const mockWebSocket = require('mock-socket-with-protocol').WebSocket;

Native WebSocket Example

1// chat.js
2function Chat() {
3  const chatSocket = new WebSocket('ws://localhost:8080');
4  this.messages = [];
5
6  chatSocket.onmessage = (event) => {
7    this.messages.push(event.data);
8  };
9}

1// chat-test.js
2import { Server } from 'mock-socket-with-protocol';
3
4describe('Chat Unit Test', () => {
5  it('basic test', (done) => {
6    const mockServer = new Server('ws://localhost:8080');
7    mockServer.on('connection', server => {
8      mockServer.send('test message 1');
9      mockServer.send('test message 2');
10    });
11
12    // Now when Chat tries to do new WebSocket() it
13    // will create a MockWebSocket object \
14    var chatApp = new Chat();
15
16    setTimeout(() => {
17      const messageLen = chatApp.messages.length;
18      assert.equal(messageLen, 2, '2 messages where sent from the s server');
19
20      mockServer.stop(done);
21    }, 100);
22  });
23});

Socket.IO Example

1// chat.js
2function Chat() {
3  const chatSocket = new io('http://localhost:8080');
4  this.messages = [];
5
6  chatSocket.on('chat-message', data => {
7    this.messages.push(data);
8  };
9}

1// chat-test.js
2import { SocketIO, Server } from 'mock-socket-with-protocol';
3
4describe('Chat Unit Test', () => {
5  it('basic test', (done) => {
6    const mockServer = new Server('http://localhost:8080');
7    mockServer.on('connection', server => {
8      mockServer.emit('chat-message', 'test message 1');
9      mockServer.emit('chat-message', 'test message 2');
10    });
11
12    /*
13      This step is very important! It tells our chat app to use the mocked
14      websocket object instead of the native one. The great thing
15      about this is that our actual code did not need to change and
16      thus is agnostic to how we test it.
17    */
18    window.io = SocketIO;
19
20    // Now when Chat tries to do io() or io.connect()
21    // it will use MockSocketIO object
22    var chatApp = new Chat();
23
24    setTimeout(() => {
25      const messageLen = chatApp.messages.length;
26      assert.equal(messageLen, 2, '2 messages where sent from the server');
27      mockServer.stop(done);
28    }, 100);
29  });
30});

Working with the source code

Local builds

The easiest way to work on the project is to clone the repo down via:

1git clone git@github.com:TheBrainFamily/mock-socket-with-protocol.git
2cd mock-socket-with-protocol
3yarn

Then to create a local build via:

1yarn build

Then create a local npm link via:

1yarn link

At this point you can create other projects / apps locally and reference this local build via:

1yarn link mock-socket-with-protocol

from within your other projects folder. Make sure that after any changes you run yarn build!

Tests

This project uses mocha as its test framework. Tests are located in /test and have 1 of 3 file name prefixes (functional-, issue-#, or unit-).

1yarn test

Linting

This project uses eslint and a rules set from airbnb's javascript style guides. To run linting:

1yarn lint

Formatting

This project uses prettier with --single-quote and --print-width 120. To run the formatting:

1yarn format

Code Coverage

Code coverage reports are created in /coverage after all of the tests have successfully passed. To run the coverage:

1yarn test:coverage

Feedback / Issues

If you have any feedback, encounter any bugs, or just have a question, please feel free to create a github issue

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

89 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-832h-xg76-4gv6
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-p9w8-2mpq-49h9
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-2m96-9w4j-wgv7
Warn: Project is vulnerable to: GHSA-h726-x36v-rx45
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-6394-6h9h-cfjg
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-gqgv-6jq5-jjj9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-hxcm-v35h-mg2x
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472
Warn: Project is vulnerable to: GHSA-pv4c-p2j5-38j4
Warn: Project is vulnerable to: GHSA-46c4-8wrp-j99v
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to mock-socket-with-protocol

Other packages similar to mock-socket-with-protocol

mock-socket-with-protocol

Installations

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Developer

TheBrainFamily

Developer Guide

CommonJS

>= 4

No

9.3.0

5.6.0

Statistics

Bundle Size

19.05 kB

5.50 kB

Languages

Total Downloads

361,287

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Why?

Installation

Usage

Native WebSocket Example

Socket.IO Example

Working with the source code

Local builds

Tests

Linting

Formatting

Code Coverage

Feedback / Issues

10

10

0

0

0

0

0

0

0

0

1.7

/10