Making compiled modules optional

Eliminating wscript
Using explicit 'install.js' script to call node-gyp for building the native modules

Author: nathaniel83

Makefile

@@ -0,0 +1,11 @@
+all:
+	node-gyp configure build
+
+clean:
+	node-gyp clean
+
+autobahn:
+	@NODE_PATH=lib node test/autobahn-test-client.js --host=127.0.0.1 --port=9000
+
+autobahn-server:
+	@NODE_PATH=lib node test/echo-server.js

binding.gyp

@@ -2,10 +2,12 @@
   'targets': [
     {
       'target_name': 'validation',
+      'cflags': [ '-O3' ],
       'sources': [ 'src/validation.cc' ]
     },
     {
       'target_name': 'xor',
+      'cflags': [ '-O3' ],
       'sources': [ 'src/xor.cpp' ]
     }
   ]

install.js

@@ -0,0 +1,28 @@
+var spawn = require('child_process').spawn
+  , exec = require('child_process').exec
+  , fs = require('fs')
+  , version = JSON.parse(fs.readFileSync(__dirname + '/package.json', 'utf8')).version
+  , verbose = process.env['npm_package_config_verbose'] != null ? process.env['npm_package_config_verbose'] === 'true' : false;
+
+console.log('[websocket v%s] Attempting to compile native extensions.', version);
+
+var gyp = exec('node-gyp rebuild', {cwd: __dirname});
+gyp.stdout.on('data', function(data) {
+  if (verbose) process.stdout.write(data);
+});
+gyp.stderr.on('data', function(data) {
+  if (verbose) process.stdout.write(data);
+});
+gyp.on('exit', function(code) {
+    if (code !== 0) {
+        console.log("[websocket v%s]", version);
+        console.log('    Native code compile failed!!');
+        console.log('    On Windows, native extensions require Visual Studio and Python.');
+        console.log('    On Unix, native extensions require Python, make and a C++ compiler.');
+        console.log('    Start npm with --websocket:verbose to show compilation output (if any).');
+    }
+    else {
+        console.log('[websocket v%s] Native extension compilation successful!', version);
+    }
+    process.exit();
+});

lib/Validation.fallback.js

@@ -0,0 +1,12 @@
+/*!
+ * UTF-8 Validation Fallback Code originally from:
+ * ws: a node.js websocket client
+ * Copyright(c) 2011 Einar Otto Stangvik <[email protected]>
+ * MIT Licensed
+ */
+ 
+module.exports.Validation = {
+  isValidUTF8: function(buffer) {
+    return true;
+  }
+};

lib/Validation.js

@@ -4,15 +4,15 @@
  * Copyright(c) 2011 Einar Otto Stangvik <[email protected]>
  * MIT Licensed
  */
-
-/**
- * Node version 0.4 and 0.6 compatibility
- */
 
 try {
-  module.exports = require('../build/Release/validation');
+    module.exports = require('../build/Release/validation');
+} catch (e) { try {
+    module.exports = require('../build/default/validation');
 } catch (e) { try {
-  module.exports = require('../build/default/validation');
+    module.exports = require('./Validation.fallback');
+    console.warn("Warning: Native modules not compiled.  UTF-8 validation disabled.")
 } catch (e) {
-  throw e;
-}}
+    console.error("validation.node seems not to have been built. Run npm install.")
+    throw e;
+}}}

lib/WebSocketFrame.js

@@ -111,7 +111,6 @@ WebSocketFrame.prototype.addData = function(bufferList, fragmentationType) {
             if (bufferList.length >= 4) {
                 bufferList.joinInto(this.maskBytes, 0, 0, 4);
                 bufferList.advance(4);
-                this.maskPos = 0;
                 this.parseState = WAITING_FOR_PAYLOAD;
             }
         }
@@ -137,7 +136,7 @@ WebSocketFrame.prototype.addData = function(bufferList, fragmentationType) {
             this.binaryPayload = bufferList.take(this.length);
             bufferList.advance(this.length);
             if (this.mask) {
-                this.maskPos = xor(this.binaryPayload, this.maskBytes, 0);
+                xor(this.binaryPayload, this.maskBytes, 0);
             }
 
             if (this.opcode === 0x08) { // WebSocketOpcode.CONNECTION_CLOSE
@@ -259,14 +258,13 @@ WebSocketFrame.prototype.toBuffer = function(nullMask) {
                 maskKey = 0x00000000;
             }
             ctio.wuint32(maskKey, 'big', this.maskBytes, 0);
-            this.maskPos = 0;
 
             // write the mask key
             this.maskBytes.copy(output, outputPos);
             outputPos += 4;
 
             data.copy(output, outputPos);
-            this.maskPos = xor(output.slice(outputPos), this.maskBytes, this.maskPos);
+            xor(output.slice(outputPos), this.maskBytes, 0);
         }
         else {
             data.copy(output, outputPos);

lib/xor.fallback.js

@@ -0,0 +1,13 @@
+module.exports = {
+    xor: function (payload, maskBytes, maskPos) {
+        var end = payload.length;
+        if (typeof(maskPos) !== 'number') {
+            maskPos = 0;
+        }
+        for (var i=0; i < end; i++) {
+            payload[i] = payload[i] ^ maskBytes[maskPos];
+            maskPos = (maskPos + 1) & 3;
+        }
+        return maskPos;
+    }
+};

lib/xor.js

@@ -5,15 +5,14 @@
  * Version: 1.0
  */
 
-/**
- * Buffer xor module
- * Node version 0.4 and 0.6 compatibility
- */
-
 try {
-  module.exports = require('../build/Release/xor');
+    module.exports = require('../build/Release/xor');
 } catch (e) { try {
-  module.exports = require('../build/default/xor');
+    module.exports = require('../build/default/xor');
+} catch(e) { try {
+    module.exports = require('./xor.fallback');
+    console.warn("Warning: Native modules not compiled.  XOR performance will be degraded.")
 } catch (e) {
-  throw e;
-}}
+    console.error("xor.node seems not to have been built. Run npm install.")
+    throw e;
+}}}

package.json

@@ -2,7 +2,7 @@
     "name": "websocket",
     "description": "Websocket Client & Server Library implementing the WebSocket protocol as specified in RFC 6455.",
     "keywords": ["websocket", "socket", "networking", "comet", "push"],
-    "author": "Brian McKelvey <[email protected]>",
+    "author": "Brian McKelvey <[email protected]> (https://www.worlize.com/)",
     "version": "1.0.6",
     "repository": {
         "type": "git",
@@ -11,6 +11,12 @@
     "engines": {
         "node": ">=0.6.13"
     },
+    "config": {
+      "verbose" : false
+    },
+    "scripts": {
+        "install": "node install.js"
+    },
     "main": "index",
     "directories": {
         "lib": "./lib"