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
npm 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.
; // OR const mockServer = Server;const socketIO = SocketIO;const mockWebSocket = WebSocket;
Native WebSocket Example
// chat.js { const chatSocket = 'ws://localhost:8080'; thismessages = ; chatSocket { thismessages; };}
// chat-test.js; ;
Socket.IO Example
// chat.js { const chatSocket = 'http://localhost:8080'; thismessages = ; chatSocket
// chat-test.js; ;
Working with the source code
Local builds
The easiest way to work on the project is to clone the repo down via:
git clone git@github.com:TheBrainFamily/mock-socket-with-protocol.gitcd mock-socket-with-protocolyarn
Then to create a local build via:
yarn build
Then create a local npm link via:
yarn link
At this point you can create other projects / apps locally and reference this local build via:
yarn 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-).
yarn test
Linting
This project uses eslint and a rules set from airbnb's javascript style guides. To run linting:
yarn lint
Formatting
This project uses prettier with --single-quote and --print-width 120. To run the formatting:
yarn format
Code Coverage
Code coverage reports are created in /coverage after all of the tests have successfully passed. To run the coverage:
yarn 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