execjs-fastnode 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13794e0f836dc1cc7c7eb16a23391df25a556e99
-  data.tar.gz: 66e77b96d13a3bd2be1fd42e249f89e9c832aafb
+  metadata.gz: f5fe8728df68607be57c58f5207618c5e19d967f
+  data.tar.gz: 36f90d80531ea43e2a7c5ef9686d2459c081bf1b
 SHA512:
-  metadata.gz: 017acad49287c35d0cf4c573939ddbdad3af1e55413d041ec024a71d76b7444286fa9794515fa18b395934e7f75e033100b393b52d3ade132b2e9ec1c85f8b0e
-  data.tar.gz: af736abba04aeb15cae84a798f2556d9ebb052ae12c76329de34e2c3f65073c26bec5f4e9616a0420b8cb3cd109ffe6e73c0b8e2560f01bcdc15a26084d13f8f
+  metadata.gz: f55e3aba398c6221eed47a33ffb15829808f974172e144ce82a6168bead521e5cae15e71f76b8313603cba894ff89c017ffdd7b4f01676b532a7848e0c993a36
+  data.tar.gz: a08c714d6f3c56a55aaac58657c8d01645c42f3271af1ee4d1973363a587de3a2811abe4218fca502b6a9377d9072c38ecca3693a0a9d379fd280dfb72d7acc3

data/.travis.yml

@@ -3,11 +3,23 @@ cache: bundler
 sudo: false
 before_script:
   - node --version
-matrix:
-  include:
-    - rvm: 2.0.0
-    - rvm: 2.1
-    - rvm: 2.2
-    - rvm: 2.3.1
-    - rvm: jruby-19mode
-    - os: osx
+env:
+  global:
+    EXECJS_RUNTIME: FastNode
+  matrix:
+    - NODE_VERSION=v0.10
+    - NODE_VERSION=v0.12
+    - NODE_VERSION=v4
+    - NODE_VERSION=v6
+rvm:
+  - 2.0.0
+  - 2.3.1
+  - jruby-head
+before_install:
+  - gem install bundler
+  - gem update bundler
+  - . $HOME/.nvm/nvm.sh
+  - nvm install $NODE_VERSION
+os:
+  - osx
+  - linux

data/Gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
-
-gem 'therubyracer'
+gem 'therubyracer', platforms: :mri
 
 gemspec

data/README.md

@@ -1,5 +1,7 @@
 # ExecJS FastNode
 
+[![Build Status](https://travis-ci.org/jhawthorn/execjs-fastnode.svg?branch=master)](https://travis-ci.org/jhawthorn/execjs-fastnode)
+
 ## What's this?
 
 An alternative implementation of ExecJS's Node.js integration. This aims to speed up sprockets compilation without needing to embed a javascript interpreter inside of ruby like [therubyracer](cowboyd/therubyracer).
@@ -11,10 +13,10 @@ Much.
 ```
 $ rake bench
 ...
-                               user     system      total        real
-Node.js (V8) fast   0.000000   0.000000   0.000000 (  0.069723)
-therubyracer (V8)   0.020000   0.000000   0.020000 (  0.018010)
-Node.js (V8)        0.000000   0.010000   1.470000 (  1.487579)
+                    user       system     total      real
+Node.js (V8) fast   0.000000   0.000000   0.000000   (0.069723)
+therubyracer (V8)   0.020000   0.000000   0.020000   (0.018010)
+Node.js (V8)        0.000000   0.010000   1.470000   (1.487579)
 ```
 
 Okay, so it's not as fast as `therubyracer`, but it's 20x faster than the standard ExecJS Node.js implementation.
@@ -25,17 +27,17 @@ The benchmark measures the time to compile the javascript CoffeeScript compiler
 
 The existing ExecJS runtime has to run a new Node.js process each time any JS is to be run. This means that if you are loading up the CoffeeScript compiler in order to compile some sprockets assets, it needs to reload the node executable and the entire coffeescript compiler for each file it is compiling.
 
-This implementation avoids this by starting an always running Node.js process connected by pipes to STDIN and STDOUT. The JS to execute is piped into the process and the results are recieved from its output. Isolation between different ExecJS contexts is achieved through Node's [vm.Script](https://nodejs.org/api/vm.html).
+This implementation avoids this by starting a persistently running Node.js process connected through a UNIX socket. Isolation between different ExecJS contexts is achieved through Node's [vm.Script](https://nodejs.org/api/vm.html).
 
-| Old | New |
+| ExecJS FastNode | Standard ExecJS Node |
 | --- | --- |
-| ![](docs/example_old.png) | ![](docs/example_new.png) |
+| ![](docs/example_new.png) | ![](docs/example_old.png) |
 
 ## Is this production ready?
 
 Maybe? It needs more testing to be labeled as such. If you encounter any troubles please [file an issue](https://github.com/jhawthorn/execjs-fastnode/issues/new).
 
-Currently minimal effort is made to handle catastrophic errors: Node.js crashing, running out of memory, being killed. All of which result in `Errno::EPIPE: Broken pipe` for future ExecJS calls.
+Currently minimal effort is made to handle catastrophic errors: Node.js crashing, running out of memory, being killed.
 
 It's probably fine for development.
 
@@ -78,9 +80,14 @@ I haven't seen any benchmarks or bug reports that demonstrate this, so I conside
 
 [mini_racer](https://github.com/discourse/mini_racer) is another option.
 
-The ExecJS Node runtime has its benefits as well. It should works on jRuby and other non-MRI runtimes.
+The ExecJS Node runtime has its benefits as well. It should work on jRuby and other non-MRI runtimes.
 If this were merged upstream it would give developers fast javascript execution without needing an extra gem or configuration, just a working `node` somewhere in `$PATH`.
 
+## Limitations
+
+* Syntax errors on Node.js versions 0.10.x and 4.x can't report the exact line number of the error. Instead they will always display `(execjs):1`.
+* This only runs a single node process, so javascript execution can only make use of a single processor. This isn't much of an issue because sprockets doesn't parallelize builds. This runtime is so much faster than the original that this would only be an issue with very specific use cases.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -91,8 +98,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/execjs-fastnode.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/execjs/fastnode/external_piped_runtime.rb

@@ -1,28 +1,70 @@
+require "net/http"
+require "socket"
+require "thread"
 require "tmpdir"
 require 'json'
-require "open3"
-require "thread"
 require "execjs/runtime"
 require "execjs/fastnode/command"
 
 module ExecJS
   module FastNode
     class ExternalPipedRuntime < ExecJS::Runtime
-      class VM
-        attr_reader :stdin, :stdout
+      class VMCommand
+        def initialize(socket_path, cmd, arguments)
+          @socket_path = socket_path.to_s
+          @cmd = cmd
+          @arguments = arguments
+        end
+
+        def execute
+          sock = Net::BufferedIO.new(socket)
+
+          request = Net::HTTP::Post.new("/")
+          request['Connection'] = 'close'
+          request['Content-Type'] = 'application/json'
+          request.body = contents
+          request.exec(sock, "1.1", "/")
+
+          begin
+            response = Net::HTTPResponse.read_new(sock)
+          end while response.kind_of?(Net::HTTPContinue)
+
+          response.reading_body(sock, request.response_body_permitted?) { }
+          sock.close
+
+          parse(response.body)
+        end
+
+        private
+
+        def socket
+          UNIXSocket.new(@socket_path)
+        end
+
+        def contents
+          ::JSON.generate({cmd: @cmd, args: @arguments})
+        end
+
+        def parse(body)
+          ::JSON.parse(body, create_additions: false)
+        end
+      end
 
+      class VM
         def initialize(options)
           @mutex = Mutex.new
-          @stdin = @stdout = @wait_thr = nil
+          @socket_path = nil
           @options = options
         end
 
         def started?
-          !!@stdin
+          !!@socket_path
         end
 
-        def self.finalize(stdin)
-          proc { stdin.puts('{"cmd": "exit", "arguments": [0]}') }
+        def self.finalize(socket_path)
+          proc {
+            VMCommand.new(socket_path, "exit", [0]).execute
+          }
         end
 
         def exec(context, source)
@@ -34,9 +76,7 @@ module ExecJS
         end
 
         def start
-          return if started?
           @mutex.synchronize do
-            # will double check started? with the lock held
             start_without_synchronization
           end
         end
@@ -45,15 +85,27 @@ module ExecJS
 
         def start_without_synchronization
           return if started?
-          @stdin, @stdout, @wait_thr = Open3.popen2(@options[:binary], @options[:runner_path])
-          ObjectSpace.define_finalizer(self, self.class.finalize(@stdin))
+          dir = Dir.mktmpdir("execjs-fastnode-")
+          @socket_path = File.join(dir, "socket")
+          @pid = Process.spawn({"PORT" => @socket_path.to_s}, @options[:binary], @options[:runner_path])
+
+          retries = 20
+          while !File.exists?(@socket_path)
+            sleep 0.05
+            retries -= 1
+
+            if retries == 0
+              raise "Unable to start nodejs process"
+            end
+          end
+
+          ObjectSpace.define_finalizer(self, self.class.finalize(@socket_path))
         end
 
         def command(cmd, *arguments)
-          start
           @mutex.synchronize do
-            @stdin.puts(::JSON.generate({cmd: cmd, args: arguments}))
-            result = ::JSON.parse(@stdout.gets, create_additions: false)
+            start_without_synchronization
+            VMCommand.new(@socket_path, cmd, arguments).execute
           end
         end
       end
@@ -126,18 +178,16 @@ module ExecJS
         @deprecated  = !!options[:deprecated]
         @binary      = nil
 
+        @vm = VM.new(
+          binary: binary,
+          runner_path: @runner_path
+        )
+
         @popen_options = {}
         @popen_options[:external_encoding] = @encoding if @encoding
         @popen_options[:internal_encoding] = ::Encoding.default_internal || 'UTF-8'
       end
 
-      def vm
-        @vm ||= VM.new(
-          binary: @binary,
-          runner_path: @runner_path
-        )
-      end
-
       def available?
         binary ? true : false
       end

data/lib/execjs/fastnode/node_piped_runner.js

@@ -1,72 +1,84 @@
-(function(){
-  var stdin = process.stdin
-  var stdout = process.stdout
-  var buf = ""
+var stdin = process.stdin
+var stdout = process.stdout
+var buf = ""
 
-  stdin.setEncoding('utf8')
+stdin.setEncoding('utf8')
 
-  var vm = require('vm');
-  var contexts = {};
+var vm = require('vm');
+var contexts = {};
 
-  function getContext(uuid) {
-    return contexts[uuid] || (contexts[uuid] = vm.createContext())
+/*
+ * Versions of node before 0.12 (notably 0.10) didn't properly propagate
+ * syntax errors.
+ * This also regressed in the node 4.0 releases.
+ *
+ * To get around this, if it looks like we are missing the location of the
+ * error, we guess it is (execjs):1
+ *
+ * This is obviously not ideal, but only affects syntax errors, and only on
+ * these versions.
+ */
+function massageStackTrace(stack) {
+  if (stack && stack.indexOf("SyntaxError") == 0) {
+    return "(execjs):1\n" + stack;
+  } else {
+    return stack;
   }
+}
 
-  var commands = {
-    deleteContext: function(uuid) {
-      delete contexts[uuid];
-      return 1;
-    },
-    exit: function(code) {
-      process.exit(code)
-    },
-    exec: function execJS(input) {
-      var context = getContext(input.context);
-      var source = input.source;
-      try {
-        var program = function(){
-          return vm.runInContext(source, context, "(execjs)");
-        }
-        result = program();
-        if (typeof result == 'undefined' && result !== null) {
-          return ['ok'];
-        } else {
-          try {
-            return ['ok', result];
-          } catch (err) {
-            return ['err', '' + err, err.stack];
-          }
+function getContext(uuid) {
+  return contexts[uuid] || (contexts[uuid] = vm.createContext())
+}
+
+var commands = {
+  deleteContext: function(uuid) {
+    delete contexts[uuid];
+    return 1;
+  },
+  exit: function(code) {
+    process.exit(code)
+  },
+  exec: function execJS(input) {
+    var context = getContext(input.context);
+    var source = input.source;
+    try {
+      var program = function(){
+        return vm.runInContext(source, context, "(execjs)");
+      }
+      result = program();
+      if (typeof result == 'undefined' && result !== null) {
+        return ['ok'];
+      } else {
+        try {
+          return ['ok', result];
+        } catch (err) {
+          return ['err', '' + err, err.stack];
         }
-      } catch (err) {
-        return ['err', '' + err, err.stack];
       }
+    } catch (err) {
+      return ['err', '' + err, massageStackTrace(err.stack)];
     }
   }
+}
 
-  function processLine(line){
-    var input = JSON.parse(line)
-    var result = commands[input.cmd].apply(null, input.args)
+var http = require('http')
+var server = http.createServer(function(req, res) {
+  var contents = '';
 
-    var outputJSON = JSON.stringify(result)
-    stdout.write(outputJSON)
-    stdout.write('\n')
-  }
+  req.on('data', function (dataIn) {
+    contents += dataIn;
+  });
 
-  function processBuffer(){
-    if(buf.indexOf('\n') >= 0){
-      var lines = buf.split('\n')
-      for(var i = 0; i < lines.length - 1; i++) {
-        processLine(lines[i]);
-      }
-      buf = lines[lines.length - 1]
-    }
-  }
+  req.on('end', function () {
+    var input = JSON.parse(contents)
+    var result = commands[input.cmd].apply(null, input.args)
+    var outputJSON = JSON.stringify(result)
 
-  process.stdin.on('readable', function(){
-    var chunk = process.stdin.read();
-    if (chunk !== null) {
-      buf += chunk
-      processBuffer()
-    }
+    res.statusCode = 200;
+    res.setHeader('Content-Type', 'application/json');
+    res.end(outputJSON);
   });
-})();
+});
+
+var port = process.env.PORT || 3001;
+server.listen(port);

data/lib/execjs/fastnode/version.rb

@@ -1,5 +1,5 @@
 module ExecJS
   module FastNode
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: execjs-fastnode
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2016-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -77,7 +77,7 @@ files:
 - ".gitmodules"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console