![](\"http://imgur.com/Xt9X83M.png\")
\n\n \n
\nJavascript mocking library for websockets and socket.io\n
\n\n## Why?\n\nThis is basically mock-socket made to work with apollo subscriptions-transport-ws.\nThe implementation is not perfect, which was noticed over two years ago by @brian-mann of cypress.io :\nhttps://github.com/thoov/mock-socket/issues/72 . Since two years later this architectural problem is still not fixed,\nI've decided to fork with the tiny change that's just enough to make it work in this specific usecase.\nThanks @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. :)\n\n## Installation\n\n```shell\nnpm install mock-socket-with-protocol --dev\n```\n\n## Usage\n\nTo use within a node environment you can simply import or require the files directly. This\noption is great for phantomjs or CI environments.\n\n```js\nimport { WebSocket, Server, SocketIO } from 'mock-socket-with-protocol';\n\n// OR\n\nconst mockServer = require('mock-socket-with-protocol').Server;\nconst socketIO = require('mock-socket-with-protocol').SocketIO;\nconst mockWebSocket = require('mock-socket-with-protocol').WebSocket;\n```\n\n## Native WebSocket Example\n\n```js\n// chat.js\nfunction Chat() {\n const chatSocket = new WebSocket('ws://localhost:8080');\n this.messages = [];\n\n chatSocket.onmessage = (event) => {\n this.messages.push(event.data);\n };\n}\n```\n\n```js\n// chat-test.js\nimport { Server } from 'mock-socket-with-protocol';\n\ndescribe('Chat Unit Test', () => {\n it('basic test', (done) => {\n const mockServer = new Server('ws://localhost:8080');\n mockServer.on('connection', server => {\n mockServer.send('test message 1');\n mockServer.send('test message 2');\n });\n\n // Now when Chat tries to do new WebSocket() it\n // will create a MockWebSocket object \\\n var chatApp = new Chat();\n\n setTimeout(() => {\n const messageLen = chatApp.messages.length;\n assert.equal(messageLen, 2, '2 messages where sent from the s server');\n\n mockServer.stop(done);\n }, 100);\n });\n});\n```\n\n## Socket.IO Example\n\n```js\n// chat.js\nfunction Chat() {\n const chatSocket = new io('http://localhost:8080');\n this.messages = [];\n\n chatSocket.on('chat-message', data => {\n this.messages.push(data);\n };\n}\n```\n\n```js\n// chat-test.js\nimport { SocketIO, Server } from 'mock-socket-with-protocol';\n\ndescribe('Chat Unit Test', () => {\n it('basic test', (done) => {\n const mockServer = new Server('http://localhost:8080');\n mockServer.on('connection', server => {\n mockServer.emit('chat-message', 'test message 1');\n mockServer.emit('chat-message', 'test message 2');\n });\n\n /*\n This step is very important! It tells our chat app to use the mocked\n websocket object instead of the native one. The great thing\n about this is that our actual code did not need to change and\n thus is agnostic to how we test it.\n */\n window.io = SocketIO;\n\n // Now when Chat tries to do io() or io.connect()\n // it will use MockSocketIO object\n var chatApp = new Chat();\n\n setTimeout(() => {\n const messageLen = chatApp.messages.length;\n assert.equal(messageLen, 2, '2 messages where sent from the server');\n mockServer.stop(done);\n }, 100);\n });\n});\n```\n\n## Working with the source code\n\n### Local builds\nThe easiest way to work on the project is to clone the repo down via:\n\n```shell\ngit clone git@github.com:TheBrainFamily/mock-socket-with-protocol.git\ncd mock-socket-with-protocol\nyarn\n```\nThen to create a local build via:\n\n```shell\nyarn build\n```\n\nThen create a local npm link via:\n\n```shell\nyarn link\n```\n\nAt this point you can create other projects / apps locally and reference this local build via:\n\n```shell\nyarn link mock-socket-with-protocol\n```\n\nfrom within your other projects folder. Make sure that after any changes you run `yarn build`!\n\n### Tests\nThis project uses mocha as its test framework. Tests are located in /test and have 1 of 3 file name prefixes (functional-, issue-#, or unit-).\n\n```shell\nyarn test\n```\n\n### Linting\n\nThis project uses eslint and a rules set from [airbnb's javascript style guides](https://github.com/airbnb/javascript). To run linting:\n\n```shell\nyarn lint\n```\n\n### Formatting\n\nThis project uses prettier with --single-quote and --print-width 120. To run the formatting:\n\n```shell\nyarn format\n```\n\n\n### Code Coverage\n\nCode coverage reports are created in /coverage after all of the tests have successfully passed. To run the coverage:\n\n```shell\nyarn test:coverage\n```\n\n## Feedback / Issues\n\nIf you have any feedback, encounter any bugs, or just have a question, please feel free to create a [github issue](https://github.com/thoov/mock-socket-with-protocol/issues/new)\n","readmeFilename":"README.md"}