v1.3.0 release (#8)

* Added CORS support using NPM cors library (#7)

* Added CORS support using NPM cors library

* Added unit tests, made CORS configurable using environment variable opt

* updated README to reflect new enableCors variable

* bump version to 1.3.0

README.md

@@ -228,6 +228,10 @@ For example extensions, see the following:
 
 [Bool] - enables logging (default `true`)
 
+#### enableCors
+
+[Bool] - enables Cross Origin Resource Sharing (default `true`)
+
 #### peerList
 
 [PeerList](#peerlist) - uses a given peerList implementation instead of creating one

index.js

@@ -5,5 +5,6 @@ const signalRouterCreator = require('./lib')
 const app = express()
 
 app.use(signalRouterCreator({
-    enableLogging: process.env.WEBRTC_SIGNAL_LOGGING || true
+    enableLogging: process.env.WEBRTC_SIGNAL_LOGGING || true,
+    enableCors: process.env.WEBRTC_CORS || true
 })).listen(process.env.PORT || 3000)

lib/index.js

@@ -1,8 +1,10 @@
 const express = require('express')
+const cors = require('cors')
 const bodyParser = require('body-parser')
 const expressBunyan = require('express-bunyan-logger')
 const PeerList = require('./peer-list')
 
+
 module.exports = (opts) => {
     const router = express.Router()
 
@@ -18,6 +20,11 @@ module.exports = (opts) => {
         router.use(expressBunyan())
     }
 
+    if (opts.enableCors) {
+        router.use(cors())
+        router.options("*", cors())
+    }
+
     // abstracted peer message sender logic
     // this will direct send if possible, otherwise
     // it will buffer into the peerList

package.json

@@ -1,6 +1,6 @@
 {
   "name": "webrtc-signal-http",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "opinionated webrtc signal provider using http as a protocol",
   "main": "lib/index.js",
   "directories": {
@@ -22,6 +22,7 @@
   "license": "MIT",
   "dependencies": {
     "body-parser": "^1.18.2",
+    "cors": "^2.8.4",
     "express": "^4.16.2",
     "express-bunyan-logger": "^1.3.2"
   },

test/basic.js

@@ -5,9 +5,10 @@ const signalRouter = require('../lib')
 const PeerList = require('../lib/peer-list')
 const Peer = require('../lib/peer')
 
-const appCreator = (enableLogging) => {
+const appCreator = (enableLogging, enableCors) => {
     const router = signalRouter({
-        enableLogging: enableLogging
+        enableLogging: enableLogging,
+        enableCors: enableCors
     })
     const app = express()
 
@@ -34,17 +35,41 @@ describe('webrtc-signal-http', () => {
         it('should support sign_in', (done) => {
             const expectedPeerName = 'myName'
 
-            request(appCreator(false))
+            request(appCreator(false, false))
                 .get(`/sign_in?peer_name=${expectedPeerName}`)
                 .expect('Content-Type', /text\/plain/)
                 .expect(200, `${expectedPeerName},1,1\n`, done)
         })
 
+        it('should support CORS requests if enabled', (done) => {
+            const expectedPeerName = 'myName'
+
+            request(appCreator(false, true))
+            .get("/")
+            .expect("access-control-allow-origin", "*", done)
+        })
+
+        it('should prevent CORS requests if disabled', (done) => {
+            const expectedPeerName = 'myName'
+
+            request(appCreator(false, false))
+            .get("/")
+            .end(function (error, response) {
+                if (error) {
+                    return done(error)
+                }
+
+                var corsDisabled = response.header["access-control-allow-origin"] == undefined;
+                assert.equal(corsDisabled, true)
+                done()
+            })
+        })
+
         it('should support multiple sign_in', (done) => {
             const expectedPeerName = 'myName'
             const expectedPeerName2 = 'myOtherName'
 
-            const test = request(appCreator(false))
+            const test = request(appCreator(false, false))
 
             test
                 .get(`/sign_in?peer_name=${expectedPeerName}`)
@@ -63,7 +88,7 @@ describe('webrtc-signal-http', () => {
         })
 
         it('should support /message posting (buffered)', (done) => {
-            const app = appCreator(false)
+            const app = appCreator(false, false)
 
             const senderPeerId = app.peerList.addPeer('sendPeer', {})
             const receiverPeerId = app.peerList.addPeer('receivePeer', {})
@@ -83,7 +108,7 @@ describe('webrtc-signal-http', () => {
         })
 
         it('should support /message posting (un-buffered)', (done) => {
-            const app = appCreator(false)
+            const app = appCreator(false, false)
 
             // simulate adding two peers
             const senderPeerId = app.peerList.addPeer('sendPeer', {})
@@ -110,7 +135,7 @@ describe('webrtc-signal-http', () => {
         })
 
         it('should support /sign_out', (done) => {
-            const app = appCreator(false)
+            const app = appCreator(false, false)
 
              // simulate adding two peers
              const firstPeerId = app.peerList.addPeer('firstPeer', {})
@@ -128,7 +153,7 @@ describe('webrtc-signal-http', () => {
         })
 
         it('should support sign_in notifications', (done) => {
-            const app = appCreator(false)
+            const app = appCreator(false, false)
 
             // simulate adding two peers
             const firstPeerId = app.peerList.addPeer('firstPeer', {})
@@ -152,7 +177,7 @@ describe('webrtc-signal-http', () => {
         })
 
         it('should support sign_out notifications', (done) => {
-            const app = appCreator(false)
+            const app = appCreator(false, false)
 
             // simulate adding two peers
             const firstPeerId = app.peerList.addPeer('firstPeer', {})
@@ -175,6 +200,8 @@ describe('webrtc-signal-http', () => {
                 })
             ]).then(() => { /* on success, empty the chainable promise result */ }).then(done, done)
         })
+
+
     })
 
     describe('PeerList', () => {