isomorfeus-speednode 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f788c1d82c38e1e5a842398250da97e42d3e03a8cee5ab7c4f7930e6bf988728
-  data.tar.gz: 84c32ebeaaf0a77dd977af21934e29f1fdfd4d0491ccb2a9dc38710148520bb5
+  metadata.gz: 5a1b8da4a29439d529c0645ee7d9e6c324bd0d586331555798f98e8cf45edc46
+  data.tar.gz: 9a86b8a8f18b96b0a0f4f8ac4ad7991ada4e5833ff59ba6b18fdc99a4ccc38cc
 SHA512:
-  metadata.gz: 3019227cb051d16b25886c6e597ef69dd34f6382a1b6ec4a52c84249b2c71848073cdd60bdb23dfafffde0c03c90cf87ca2df74674feeea5d71903ea731804ed
-  data.tar.gz: 4b0884b00f062d3d2f8f6579d2d72368f2cc045c3ec352e50b45f43300f4e7b02b2ce8098d79b338951f1d26eb9eda48de681bc755e299c046de356f0f0184c3
+  metadata.gz: a4d35cd84a7371e9e255af034e42f26b384fcc19a7e5b9210b6df74cab5193e1f136be71fcc3cb228479952c7ed085bd7a5848df338b0b695a942a79d760986f
+  data.tar.gz: f312e192470c867709f8b7f120f1979e949f330c9a83cf5433613bda55f5e51ad913762430700e67bd669d64e130bb9b155b195f44db06811e0af71aa5ec2981

data/README.md

@@ -13,20 +13,43 @@ In Gemfile:
 
 ### Configuration
 
-Isomorfeus-speednode provides 2 runtimes:
-- `CompatibleSpeednode` - is compatible with the minimalistic execjs approach. Mainly intended for production/development usage.
-- `PermissiveSpeednode` - allows for the usage of javascript commonjs 'require' and can handle circular objects from javascript world, to some extend.
-Best used in spec/test environments.
-
-`CompatibleSpeednode` is the default. The permissive runtime can be chosen by:
+Isomorfeus-speednode provides one node based runtime `Speednode` which runs scripts in node vms.
+The runtime can be chosen by:
 
 ```ruby
-ExecJS.runtime = ExecJS::Runtimes::PermissiveSpeednode
+ExecJS.runtime = ExecJS::Runtimes::Speednode
 ```
-If node cant find node modules, uts possible to set the load path before assigning the runtime:
+If node cant find node modules for the permissive contexts (see below), its possible to set the load path before assigning the runtime:
 ```ruby
 ENV['NODE_PATH'] = './node_modules'
 ```
+### Contexts
+
+Each ExecJS context runs in a node vm. Speednode offers two kinds of contexts:
+- a compatible context, which is compatible with default ExecJS behavior.
+- a permissive context, which is more permissive and allows to `require` node modules.
+
+#### Compatible
+A compatible context can be created with the standard `ExecJS.compile` or code can be executed within a compatible context by using the standard 
+`ExecJS.eval` or `ExecJS.exec`.
+Example for a compatible context:
+```ruby
+compat_context = ExecJS.compile('Test = "test"')
+compat_context.eval('1+1')
+```
+#### Permissive 
+A permissive context can be created with `ExecJS.permissive_compile` or code can be executed within a permissive context by using  
+`ExecJS.permissive_eval` or `ExecJS.permissive_exec`.
+Example for a permissive context:
+```ruby
+perm_context = ExecJS.permissive_compile('Test = "test"')
+perm_context.eval('1+1')
+```
+Evaluation in a permissive context:
+```ruby
+ExecJS.permissive_eval('1+1')
+```
+
 ### Benchmarks
 
 Highly scientific, maybe.
@@ -45,7 +68,13 @@ Node.js (V8) fast                              0.191454   0.081396   0.272850 (
 mini_racer (V8)                                0.017091   0.002494   0.019585 (  0.019584)
 ```
 
-To run benchmark:
+To run benchmarks:
+- clone repo
+- `bundle install`
+- `bundle exec rake bench`
+
+### Tests
+To run tests:
 - clone repo
 - `bundle install`
-- `ruby bench.rb`
+- `bundle exec rake test`

data/lib/isomorfeus-speednode.rb

@@ -6,5 +6,7 @@ require 'isomorfeus/speednode/node_command'
 require 'execjs/runtime'
 require 'isomorfeus/speednode/runtime'
 require "execjs/runtimes"
-require 'isomorfeus/speednode'
+require 'isomorfeus/execjs_runtime'
+require 'isomorfeus/execjs_module'
+require 'isomorfeus/execjs_runtimes'
 require 'execjs'

data/lib/isomorfeus/execjs_module.rb

@@ -0,0 +1,15 @@
+module ExecJS
+  class << self
+    def permissive_exec(source, options = {})
+      runtime.permissive_exec(source, options)
+    end
+
+    def permissive_eval(source, options = {})
+      runtime.permissive_eval(source, options)
+    end
+
+    def permissive_compile(source, options = {})
+      runtime.permissive_compile(source, options)
+    end
+  end
+end

data/lib/isomorfeus/execjs_runtime.rb

@@ -0,0 +1,18 @@
+module ExecJS
+  # Abstract base class for runtimes
+  class Runtime
+    def permissive_exec(source, options = {})
+      context = permissive_compile("", options)
+      context.exec(source, options)
+    end
+
+    def permissive_eval(source, options = {})
+      context = permissive_compile("", options)
+      context.eval(source, options)
+    end
+
+    def permissive_compile(source, options = {})
+      context_class.new(self, source, options.merge({permissive: true}))
+    end
+  end
+end

data/lib/isomorfeus/execjs_runtimes.rb

@@ -0,0 +1,11 @@
+module ExecJS
+  module Runtimes
+    Speednode = Isomorfeus::Speednode::Runtime.new(
+      name: 'Isomorfeus Speednode Node.js (V8)',
+      command: %w[nodejs node],
+      runner_path: File.join(File.dirname(__FILE__), 'speednode', 'runner.js'),
+      encoding: 'UTF-8'
+    )
+    runtimes.unshift(Speednode)
+  end
+end

data/lib/isomorfeus/speednode/{permissive_runner.js → runner.js}

@@ -134,72 +134,85 @@ CircularJSON.stringify = function stringify(value, replacer, space, doNotResolve
  * these versions.
  */
 function massageStackTrace(stack) {
-  if (stack && stack.indexOf("SyntaxError") == 0) {
-    return "(execjs):1\n" + stack;
-  } else {
-    return stack;
-  }
+    if (stack && stack.indexOf("SyntaxError") == 0) {
+        return "(execjs):1\n" + stack;
+    } else {
+        return stack;
+    }
+}
+
+function createCompatibleContext() {
+    var c = vm.createContext();
+    vm.runInContext('delete this.console', c, "(execjs)");
+    return c;
 }
 
-function getContext(uuid) {
-  return contexts[uuid] || (contexts[uuid] = vm.createContext({ require, setTimeout }));
+function createPermissiveContext() {
+    return vm.createContext({ require, setTimeout });
+}
+
+function getCompatibleContext(uuid) {
+    return contexts[uuid] || (contexts[uuid] = createCompatibleContext());
+}
+function getPermissiveContext(uuid) {
+    return contexts[uuid] || (contexts[uuid] = createPermissiveContext());
 }
 
 var commands = {
-  deleteContext: function(uuid) {
-    delete contexts[uuid];
-    return [1];
-  },
-  exit: function(code) {
-    process_exit = code;
-    return ['ok'];
-  },
-  exec: function execJS(input) {
-    var context = getContext(input.context);
-    var source = input.source;
-    try {
-      var program = function(){
-        return vm.runInContext(source, context, "(execjs)");
-      };
-      var result = program();
-      if (typeof result == 'undefined' && result !== null) {
+    deleteContext: function(uuid) {
+        delete contexts[uuid];
+        return [1];
+    },
+    exit: function(code) {
+        process_exit = code;
         return ['ok'];
-      } else {
+    },
+    execp: function execJS(input) {
+        var context = getPermissiveContext(input.context);
         try {
-          return ['ok', result];
-        } catch (err) {
-          return ['err', '' + err, err.stack];
-        }
-      }
-    } catch (err) {
-      return ['err', '' + err, massageStackTrace(err.stack)];
+            var program = function(){ return vm.runInContext(input.source, context, "(execjs)"); };
+            var 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, massageStackTrace(err.stack)]; }
+    },
+    exec: function execJS(input) {
+        var context = getCompatibleContext(input.context);
+        try {
+            var program = function(){ return vm.runInContext(input.source, context, "(execjs)"); };
+            var 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, massageStackTrace(err.stack)]; }
     }
-  }
 };
 
 var server = net.createServer(function(s) {
-  var received_data = '';
+    var received_data = '';
 
-  s.on('data', function (data) {
-    received_data += data;
+    s.on('data', function (data) {
+        received_data += data;
 
-    if (received_data[received_data.length - 1] !== "\n") { return; }
+        if (received_data[received_data.length - 1] !== "\n") { return; }
 
-    var request = received_data;
-    received_data = '';
+        var request = received_data;
+        received_data = '';
 
-    var input = JSON.parse(request);
-    var result = commands[input.cmd].apply(null, input.args);
-    var outputJSON = '';
+        var input = JSON.parse(request);
+        var result = commands[input.cmd].apply(null, input.args);
+        var outputJSON = '';
 
-    try {
-      outputJSON = JSON.stringify(result);
-    } catch(err) {
-      if (err.message.includes('circular')) {
-        outputJSON = CircularJSON.stringify(result);
-      } else {
-        outputJSON = JSON.stringify(['err', '' + err, err.stack]);
-      }
+        try { outputJSON = JSON.stringify(result); }
+        catch(err) {
+            if (err.message.includes('circular')) {
+            outputJSON = CircularJSON.stringify(result);
+        } else { outputJSON = JSON.stringify(['err', '' + err, err.stack]); }
     }
     s.write(outputJSON + '\n');
     if (process_exit !== false) { process.exit(process_exit); }

data/lib/isomorfeus/speednode/runtime.rb

@@ -43,6 +43,10 @@ module Isomorfeus
           command("exec", {'context' => context, 'source' => source})
         end
 
+        def execp(context, source)
+          command("execp", {'context' => context, 'source' => source})
+        end
+
         def delete_context(context)
           command("deleteContext", context)
         end
@@ -89,18 +93,23 @@ module Isomorfeus
         def initialize(runtime, source = "", options = {})
           @runtime = runtime
           @uuid = SecureRandom.uuid
+          @permissive = !!options[:permissive]
 
           ObjectSpace.define_finalizer(self, self.class.finalize(@runtime, @uuid))
 
           source = encode(source)
 
-          raw_exec(source)
+          @permissive ? raw_execp(source) : raw_exec(source)
         end
 
         def self.finalize(runtime, uuid)
           proc { runtime.vm.delete_context(uuid) }
         end
 
+        def call(identifier, *args)
+          eval "#{identifier}.apply(this, #{::Oj.dump(args)})"
+        end
+
         def eval(source, options = {})
           if /\S/ =~ source
             raw_exec("(#{source})")
@@ -111,15 +120,32 @@ module Isomorfeus
           raw_exec("(function(){#{source}})()")
         end
 
-        def raw_exec(source, options = {})
+        def permissive?
+          @permissive
+        end
+
+        def permissive_eval(source, options = {})
+          if /\S/ =~ source
+            raw_execp("(#{source})")
+          end
+        end
+
+        def permissive_exec(source, options = {})
+          raw_execp("(function(){#{source}})()")
+        end
+
+        def raw_exec(source)
           source = encode(source)
 
           result = @runtime.vm.exec(@uuid, source)
           extract_result(result)
         end
 
-        def call(identifier, *args)
-          eval "#{identifier}.apply(this, #{::Oj.dump(args)})"
+        def raw_execp(source)
+          source = encode(source)
+
+          result = @runtime.vm.execp(@uuid, source)
+          extract_result(result)
         end
 
         protected

data/lib/isomorfeus/speednode/version.rb

@@ -1,5 +1,5 @@
 module Isomorfeus
   module Speednode
-    VERSION = '0.1.5'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-speednode
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -89,10 +89,11 @@ files:
 - LICENSE
 - README.md
 - lib/isomorfeus-speednode.rb
-- lib/isomorfeus/speednode.rb
-- lib/isomorfeus/speednode/compatible_runner.js
+- lib/isomorfeus/execjs_module.rb
+- lib/isomorfeus/execjs_runtime.rb
+- lib/isomorfeus/execjs_runtimes.rb
 - lib/isomorfeus/speednode/node_command.rb
-- lib/isomorfeus/speednode/permissive_runner.js
+- lib/isomorfeus/speednode/runner.js
 - lib/isomorfeus/speednode/runtime.rb
 - lib/isomorfeus/speednode/version.rb
 homepage: http://isomorfeus.com

data/lib/isomorfeus/speednode.rb

@@ -1,27 +0,0 @@
-module Isomorfeus
-  module Speednode
-    PermissiveRuntime = Isomorfeus::Speednode::Runtime.new(
-      name: 'Isomorfeus Speednode Permissive Node.js (V8)',
-      command: %w[nodejs node],
-      runner_path: File.join(File.dirname(__FILE__), 'speednode', 'permissive_runner.js'),
-      encoding: 'UTF-8'
-    )
-    CompatibleRuntime = Isomorfeus::Speednode::Runtime.new(
-      name: 'Isomorfeus Speednode Compatible Node.js (V8)',
-      command: %w[nodejs node],
-      runner_path: File.join(File.dirname(__FILE__), 'speednode', 'compatible_runner.js'),
-      encoding: 'UTF-8'
-    )
-  end
-end
-
-module ExecJS
-  module Runtimes
-    PermissiveSpeednode = Isomorfeus::Speednode::PermissiveRuntime
-
-    CompatibleSpeednode = Isomorfeus::Speednode::CompatibleRuntime
-
-    runtimes << PermissiveSpeednode
-    runtimes.unshift(CompatibleSpeednode)
-  end
-end

data/lib/isomorfeus/speednode/compatible_runner.js

@@ -1,92 +0,0 @@
-var vm = require('vm');
-const net = require('net');
-var contexts = {};
-var process_exit = false;
-
-/*
- * 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;
-  }
-}
-function createCompatibleContext() {
-  var c = vm.createContext();
-  vm.runInContext('delete this.console', c, "(execjs)");
-  return c;
-}
-function getContext(uuid) {
-  return contexts[uuid] || (contexts[uuid] = createCompatibleContext());
-}
-
-var commands = {
-  deleteContext: function(uuid) {
-    delete contexts[uuid];
-    return [1];
-  },
-  exit: function(code) {
-    process_exit = code;
-    return ['ok'];
-  },
-  exec: function execJS(input) {
-    var context = getContext(input.context);
-    var source = input.source;
-    try {
-      var program = function(){
-        return vm.runInContext(source, context, "(execjs)");
-      }
-      var 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, massageStackTrace(err.stack)];
-    }
-  }
-}
-
-var server = net.createServer(function(s) {
-  var received_data = '';
-
-  s.on('data', function (data) {
-    received_data += data;
-
-    if (received_data[received_data.length - 1] !== "\n") { return; }
-
-    var request = received_data;
-    received_data = '';
-
-    var input = JSON.parse(request);
-    var result = commands[input.cmd].apply(null, input.args);
-    var outputJSON = '';
-
-    try {
-      outputJSON = JSON.stringify(result);
-    } catch(err) {
-      outputJSON = JSON.stringify(['err', '' + err, err.stack]);
-    }
-    s.write(outputJSON + '\n');
-    if (process_exit) { process.exit(process_exit); }
-  });
-});
-
-var socket_path = process.env.SOCKET_PATH;
-if (!socket_path) { throw 'No SOCKET_PATH given!'; };
-server.listen(socket_path);