Skip to content

Commit

Permalink
Initial commit with fastify/fastify-websocket as a template
Browse files Browse the repository at this point in the history
  • Loading branch information
gj committed Oct 18, 2017
0 parents commit d9d5d60
Show file tree
Hide file tree
Showing 8 changed files with 5,525 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Typescript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env

10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
language: node_js
node_js:
- "8"
- "7"
- "6"
- "4"
notifications:
email:
on_success: never
on_failure: always
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 Gabe Jackson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# fastify-ws

<!-- [![Greenkeeper badge](https://badges.greenkeeper.io/fastify/fastify-ws.svg)](https://greenkeeper.io/) -->

WebSocket support for [Fastify](https://github.com/fastify/fastify) built on the blazing fast [ws](http://npm.im/websocket-stream) library.

## Example
In `server.js`:
```js
'use strict'

const fastify = require('fastify')()

fastify.register(require('fastify-ws'), {
pingInterval: 10000 // Keep the connection alive by sending ping every 10 seconds (default: 30 seconds)
})

fastify.ready(err => {
if (err) throw err

fastify.wsServer
.on('connection', ws => {
ws.on('message', msg => ws.send(msg)) // Creates an echo server
})
})

fastify.listen(34567)
```

Then run `node server.js` and navigate to `http://localhost:34567` in your browser. In the browser's JavaScript console, open a client-side WebSocket connection:
```js
const host = location.origin.replace(/^http/, 'ws')
const ws = new WebSocket(host)
ws.onmessage = msg => console.log(msg.data)
```

Then, still in the browser console, send some messages to the server and watch as they're echoed back to you:
```js
ws.send('WebSockets are awesome!')
// => undefined
// LOG: WebSockets are awesome!
```

## TODO

* [ ] Get TAP test suite to finish without resorting to `process.exit()`

## License

Licensed under [MIT](./LICENSE).
30 changes: 30 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
'use strict'

const fp = require('fastify-plugin')

module.exports = fp((fastify, opts, next) => {
const WebSocketServer = require('ws').Server
const wss = new WebSocketServer({
server: fastify.server
})

const keepAlive = ws => {
ws.alive = true
const stayAlive = () => { ws.alive = true }
ws.on('pong', stayAlive)
}

wss.on('connection', keepAlive)

const pingInterval = opts.pingInterval || 30000

setInterval(() => wss.clients.forEach(ws => {
if (ws.alive === false) return ws.terminate()
ws.alive = false
ws.ping('', false, true)
}), pingInterval)

fastify.decorate('wsServer', wss)

next()
})
Loading

0 comments on commit d9d5d60

Please sign in to comment.