Testing/Coverage

.eslintrc.json

@@ -0,0 +1,27 @@
+{
+  "extends": "airbnb/base",
+  "overrides": [
+    {
+      "files": ["examples/**"],
+      "rules": {
+        "no-console": 0
+      }
+    },
+    {
+      "files": ["test/**"],
+      "env": {
+        "mocha": true
+      },
+      "globals": {
+        "expect": true
+      },
+      "rules": {
+        "no-console": 0
+      }
+    }
+  ],
+  "rules": {
+    "comma-dangle": 0,
+    "no-param-reassign": 0
+  }
+}

.npmignore

@@ -1 +1,2 @@
 src/
+test/

README.md

@@ -13,16 +13,16 @@ __Full documentation can be found in the API section below. This section only sh
 Add this line to your Express application:
 
 ```javascript
-var expressWs = require('express-ws')(app);
+const expressWs = require('express-ws')(app);
 ```
 
 __Important: Make sure to set up the `express-ws` module like above *before* loading or defining your routers!__ Otherwise, `express-ws` won't get a chance to set up support for Express routers, and you might run into an error along the lines of `router.ws is not a function`.
 
 After setting up `express-ws`, you will be able to add WebSocket routes (almost) the same way you add other routes. The following snippet sets up a simple echo server at `/echo`.  The `ws` parameter is an instance of the WebSocket class described [here](https://github.com/websockets/ws/blob/master/doc/ws.md#class-websocket).
 
 ```javascript
-app.ws('/echo', function(ws, req) {
-  ws.on('message', function(msg) {
+app.ws('/echo', (ws, req) => {
+  ws.on('message', (msg) => {
     ws.send(msg);
   });
 });
@@ -31,37 +31,37 @@ app.ws('/echo', function(ws, req) {
 It works with routers, too, this time at `/ws-stuff/echo`:
 
 ```javascript
-var router = express.Router();
+const router = express.Router();
 
-router.ws('/echo', function(ws, req) {
-  ws.on('message', function(msg) {
+router.ws('/echo', (ws, req) => {
+  ws.on('message', (msg) => {
     ws.send(msg);
   });
 });
 
-app.use("/ws-stuff", router);
+app.use('/ws-stuff', router);
 ```
 
 ## Full example
 
 ```javascript
-var express = require('express');
-var app = express();
-var expressWs = require('express-ws')(app);
+const express = require('express');
+const app = express();
+const expressWs = require('express-ws')(app);
 
-app.use(function (req, res, next) {
+app.use((req, res, next) => {
   console.log('middleware');
   req.testing = 'testing';
   return next();
 });
 
-app.get('/', function(req, res, next){
+app.get('/', (req, res, next) => {
   console.log('get route', req.testing);
   res.end();
 });
 
-app.ws('/', function(ws, req) {
-  ws.on('message', function(msg) {
+app.ws('/', (ws, req) => {
+  ws.on('message', (msg) => {
     console.log(msg);
   });
   console.log('socket', req.testing);
@@ -80,26 +80,26 @@ Sets up `express-ws` on the specified `app`. This will modify the global Router
 * __server__: *Optional.* When using a custom `http.Server`, you should pass it in here, so that `express-ws` can use it to set up the WebSocket upgrade handlers. If you don't specify a `server`, you will only be able to use it with the server that is created automatically when you call `app.listen`.
 * __options__: *Optional.* An object containing further options.
   * __leaveRouterUntouched:__ Set this to `true` to keep `express-ws` from modifying the Router prototype. You will have to manually `applyTo` every Router that you wish to make `.ws` available on, when this is enabled.
-  * __wsOptions:__ Options object passed to WebSocketServer constructor. Necessary for any ws specific features.
+  * __wsOptions:__ Options object passed to `ws.Server` constructor. Necessary for any ws specific features.
 
-This function will return a new `express-ws` API object, which will be referred to as `wsInstance` in the rest of the documentation.
+This function will return a new `express-ws` API object, which will be referred to as `expressWsInstance` in the rest of the documentation.
 
-### wsInstance.app
+### expressWsInstance.app
 
 This property contains the `app` that `express-ws` was set up on.
 
-### wsInstance.getWss()
+### expressWsInstance.getWss()
 
-Returns the underlying WebSocket server/handler. You can use `wsInstance.getWss().clients` to obtain a list of all the connected WebSocket clients for this server.
+Returns the underlying WebSocket server/handler. You can use `expressWsInstance.getWss().clients` to obtain a list of all the connected WebSocket clients for this server.
 
 Note that this list will include *all* clients, not just those for a specific route - this means that it's often *not* a good idea to use this for broadcasts, for example.
 
-### wsInstance.applyTo(router)
+### expressWsInstance.applyTo(router)
 
 Sets up `express-ws` on the given `router` (or other Router-like object). You will only need this in two scenarios:
 
 1. You have enabled `options.leaveRouterUntouched`, or
-2. You are using a custom router that is not based on the express.Router prototype.
+2. You are using a custom router that is not based on the `express.Router` prototype.
 
 In most cases, you won't need this at all.
 

examples/broadcast.js

@@ -1,20 +1,20 @@
-var express = require('express');
-var expressWs = require('..')
+const express = require('express');
+let expressWs = require('..');
 
-var expressWs = expressWs(express());
-var app = expressWs.app;
+expressWs = expressWs(express());
+const app = expressWs.app;
 
-app.ws('/a', function(ws, req) {
+app.ws('/a', (/* ws, req */) => {
 });
-var aWss = expressWs.getWss('/a');
+const wss = expressWs.getWss();
 
-app.ws('/b', function(ws, req) {
+app.ws('/b', (/* ws, req */) => {
 });
 
-setInterval(function () {
-  aWss.clients.forEach(function (client) {
+setInterval(() => {
+  wss.clients.forEach((client) => {
     client.send('hello');
   });
 }, 5000);
 
-app.listen(3000)
+app.listen(3000);

examples/https.js

@@ -1,33 +1,33 @@
-var https = require('https');
-var fs = require('fs');
+const https = require('https');
+const fs = require('fs');
 
-var express = require('express');
-var expressWs = require('..');
+const express = require('express');
+const expressWs = require('..');
 
-var options = {
+const options = {
   key: fs.readFileSync('key.pem'),
   cert: fs.readFileSync('cert.pem')
 };
-var app = express();
-var server = https.createServer(options, app);
-var expressWs = expressWs(app, server);
+const app = express();
+const server = https.createServer(options, app);
+expressWs(app, server);
 
-app.use(function (req, res, next) {
+app.use((req, res, next) => {
   console.log('middleware');
   req.testing = 'testing';
   return next();
 });
 
-app.get('/', function(req, res, next){
+app.get('/', (req, res /* , next */) => {
   console.log('get route', req.testing);
   res.end();
 });
 
-app.ws('/', function(ws, req) {
-  ws.on('message', function(msg) {
+app.ws('/', (ws, req) => {
+  ws.on('message', (msg) => {
     console.log(msg);
   });
   console.log('socket', req.testing);
 });
 
-server.listen(3000)
+server.listen(3000);

examples/params.js

@@ -1,26 +1,26 @@
-var express = require('express');
-var expressWs = require('..');
+const express = require('express');
+let expressWs = require('..');
 
-var expressWs = expressWs(express());
-var app = expressWs.app;
+expressWs = expressWs(express());
+const app = expressWs.app;
 
-app.param('world', function (req, res, next, world) {
+app.param('world', (req, res, next, world) => {
   req.world = world || 'world';
   return next();
 });
 
-app.get('/hello/:world', function(req, res, next){
+app.get('/hello/:world', (req, res, next) => {
   console.log('hello', req.world);
   res.end();
   next();
 });
 
-app.ws('/hello/:world', function(ws, req, next) {
-  ws.on('message', function(msg) {
+app.ws('/hello/:world', (ws, req, next) => {
+  ws.on('message', (msg) => {
     console.log(msg);
   });
   console.log('socket hello', req.world);
   next();
 });
 
-app.listen(3000)
+app.listen(3000);

examples/simple.js

@@ -1,25 +1,25 @@
-var express = require('express');
-var expressWs = require('..');
+const express = require('express');
+let expressWs = require('..');
 
-var expressWs = expressWs(express());
-var app = expressWs.app;
+expressWs = expressWs(express());
+const app = expressWs.app;
 
-app.use(function (req, res, next) {
+app.use((req, res, next) => {
   console.log('middleware');
   req.testing = 'testing';
   return next();
 });
 
-app.get('/', function(req, res, next){
+app.get('/', (req, res /* , next */) => {
   console.log('get route', req.testing);
   res.end();
 });
 
-app.ws('/', function(ws, req) {
-  ws.on('message', function(msg) {
+app.ws('/', (ws, req) => {
+  ws.on('message', (msg) => {
     console.log(msg);
   });
   console.log('socket', req.testing);
 });
 
-app.listen(3000)
+app.listen(3000);

package.json

@@ -5,7 +5,9 @@
   "main": "index",
   "module": "src/index",
   "scripts": {
-    "lint": "eslint src/"
+    "mocha": "mocha --require esm --require chai/register-expect --timeout 20000 test",
+    "test": "echo 'Blanking out cache for ESM/nyc that can get corrupted by terminated processes...' && rm -Rf ./node_modules/.cache && nyc npm run mocha",
+    "lint": "eslint ."
   },
   "author": "Henning Morud <[email protected]>",
   "contributors": [
@@ -18,13 +20,6 @@
     "Alexis Tyler <[email protected]>"
   ],
   "license": "BSD-2-Clause",
-  "dependencies": {
-    "esm": "^3.0.84",
-    "ws": "^6.0.0"
-  },
-  "peerDependencies": {
-    "express": "^4.0.0 || ^5.0.0-alpha.1"
-  },
   "engines": {
     "node": ">=4.5.0"
   },
@@ -44,10 +39,21 @@
     "url": "https://github.com/HenningM/express-ws/issues"
   },
   "homepage": "https://github.com/HenningM/express-ws",
+  "dependencies": {
+    "esm": "^3.0.84",
+    "ws": "^6.0.0"
+  },
+  "peerDependencies": {
+    "express": "^4.0.0 || ^5.0.0-alpha.1"
+  },
   "devDependencies": {
+    "chai": "^4.2.0",
     "eslint": "^4.19.0",
-    "eslint-config-airbnb": "^14.1.0",
+    "eslint-config-airbnb": "^15.1.0",
     "eslint-plugin-import": "^2.12.0",
-    "express": "^5.0.0-alpha.6"
+    "express": "^5.0.0-alpha.6",
+    "got": "^11.4.0",
+    "mocha": "^8.0.1",
+    "nyc": "^15.1.0"
   }
 }

src/index.js

@@ -43,10 +43,6 @@ export default function expressWs(app, httpServer, options = {}) {
   const wsServer = new ws.Server(wsOptions);
 
   wsServer.on('connection', (socket, request) => {
-    if ('upgradeReq' in socket) {
-      request = socket.upgradeReq;
-    }
-
     request.ws = socket;
     request.wsHandled = false;
 

src/wrap-middleware.js

@@ -1,4 +1,19 @@
 export default function wrapMiddleware(middleware) {
+  if (middleware.length === 4) {
+    return (error, req, res, next) => {
+      // Not checking for `req.ws` here as error shouldn't be reached if
+      //   no middleware is available to run first (and that would be
+      //   handled below)
+      req.wsHandled = true;
+      try {
+        /* Unpack the `.ws` property and call the actual handler. */
+        middleware(error, req.ws, req, next);
+      } catch (err) {
+        /* If an error is thrown, let's send that on to any error handling */
+        next(err);
+      }
+    };
+  }
   return (req, res, next) => {
     if (req.ws !== null && req.ws !== undefined) {
       req.wsHandled = true;