nodo 1.5.5 → 1.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cef66bc4b1d53b20500110ac7acbc226ec361b6aaed569874ce8568a6718242
-  data.tar.gz: ab2cae6eef01d53ebc1c471a5e08edfd37a263178adc49aa459c98dfcea4e92f
+  metadata.gz: 650d220075d68a34268a03f2e68587b1caab13f47707c8b44f7cb7d05f5a5588
+  data.tar.gz: 0b73f0cd827a1ab364975d3559f64f2d9c49afe265759715f92d23f133bab10c
 SHA512:
-  metadata.gz: 9bf90e8b56366f2e42039026575db43a0c5a9808a677a533c3e211c9ae211a8f06b2ea0890550e22fca259f9fa416c0e96017a676538a3eb673f2a66caa0996a
-  data.tar.gz: 2573e2dfd199bb9f8e25dc11c5dcb49e0ba6f29796aaa523656fa1020e0d8ce325ab411cf2d60413ac0557407fec4a132ba51d75075585a0e7b56d76bfc42811
+  metadata.gz: 0c1049cd1e574c0a7ec503ef01ae735d7b3ca33d21695a1a76c4c8f5c92f0914db58b59136a7ea0bcf17b83f9c6776817b8b4890061e6c442e414c5476d80037
+  data.tar.gz: d5fd39f74f9ebfabaec0463dbf7234e6da34a73b3167f2580fb6ac276f52f6aef433156ef0917b4a5c9c344f1dfc6d0f28e7c1af1bfe329829c5c87068d932dd

data/README.md

@@ -185,6 +185,29 @@ class Foo < Nodo::Core
   JS
 end
 
-foo.new.sleep(2)
+Foo.new.sleep(2)
 =>  Nodo::TimeoutError raised
 ```
+
+### Logging
+
+By default, JS errors will be logged to `STDOUT`.
+
+To set a custom logger:
+
+```ruby
+Nodo.logger = Logger.new('nodo.log')
+```
+
+In Rails applications, `Rails.logger` will automatically be set.
+
+### Debugging
+
+To get verbose debug output, set
+
+```ruby
+Nodo.debug = true
+```
+
+before instantiating any worker instances. The debug mode will be active during
+the current process run.

data/lib/nodo/core.rb

@@ -63,10 +63,12 @@ module Nodo
       end
 
       def function(name, _code = nil, timeout: 60, code: nil)
-        raise ArgumentError, "reserved method name #{name.inspect}" if Nodo::Core.method_defined?(name) 
+        raise ArgumentError, "reserved method name #{name.inspect}" if Nodo::Core.method_defined?(name) || name.to_s == DEFINE_METHOD
         code = (code ||= _code).strip
         raise ArgumentError, 'function code is required' if '' == code
-        self.functions = functions.merge(name => Function.new(name, _code || code, caller.first, timeout))
+        loc = caller_locations(1, 1)[0]
+        source_location = "#{loc.path}:#{loc.lineno}: in `#{name}'"
+        self.functions = functions.merge(name => Function.new(name, _code || code, source_location, timeout))
         define_method(name) { |*args| call_js_method(name, args) }
       end
       
@@ -94,7 +96,7 @@ module Nodo
             nodo.core.close(() => { process.exit(0) });
           };
 
-          process.on('SIGINT', shutdown);
+          // process.on('SIGINT', shutdown);
           process.on('SIGTERM', shutdown);
 
           nodo.core.run(socket);
@@ -146,6 +148,11 @@ module Nodo
       self.class.clsid
     end
     
+    def log_exception(e)
+      return unless logger = Nodo.logger
+      logger.error "\n#{e.class} (#{e.message}):\n\n#{e.backtrace.join("\n")}"
+    end
+    
     def ensure_process_is_spawned
       return if node_pid
       spawn_process
@@ -160,6 +167,7 @@ module Nodo
     def spawn_process
       @@tmpdir = Pathname.new(Dir.mktmpdir('nodo'))
       env = Nodo.env.merge('NODE_PATH' => Nodo.modules_root.to_s)
+      env['NODO_DEBUG'] = '1' if Nodo.debug
       @@node_pid = Process.spawn(env, Nodo.binary, '-e', self.class.generate_core_code, '--', socket_path.to_s, err: :out)
       at_exit do
         Process.kill(:SIGTERM, node_pid) rescue Errno::ECHILD
@@ -207,9 +215,11 @@ module Nodo
     def handle_error(response, function)
       if response.body
         result = parse_response(response)
-        raise JavaScriptError.new(result['error'], function) if result.is_a?(Hash) && result.key?('error')
+        error = JavaScriptError.new(result['error'], function) if result.is_a?(Hash) && result.key?('error')
       end
-      raise CallError, "Node returned #{response.code}"
+      error ||= CallError.new("Node returned #{response.code}")
+      log_exception(error)
+      raise error
     end
     
     def parse_response(response)

data/lib/nodo/nodo.js

@@ -1,5 +1,6 @@
 module.exports = (function() {
   const DEFINE_METHOD = '__nodo_define_class__';
+  const DEBUG = process.env.NODO_DEBUG;
 
   const vm = require('vm');
   const http = require('http');
@@ -24,7 +25,7 @@ module.exports = (function() {
   function respond_with_error(res, code, name) {
     res.statusCode = code;
     const rendered = render_error(name);
-    log(`Error ${code} ${rendered}`);
+    debug(`Error ${code} ${rendered}`);
     res.end(rendered, 'utf8');
   }
   
@@ -35,22 +36,24 @@ module.exports = (function() {
     if (start) {
       timing = ` in ${(performance.now() - start).toFixed(2)}ms`;
     }
-    log(`Completed 200 OK${timing}`);
+    debug(`Completed 200 OK${timing}\n`);
   }
 
-  function log(message) {
-    // fs.appendFileSync('log/nodo.log', `${message}\n`);
-    // console.log(`[Nodo] ${message}`);
+  function debug(message) {
+    if (DEBUG) {
+      // fs.appendFileSync('log/nodo.log', `${message}\n`);
+      console.log(`[Nodo] ${message}`);
+    }
   }
   
   const core = {
     run: (socket) => {
-      log('Starting up...');
+      debug('Starting up...');
       server = http.createServer((req, res) => {
         const start = performance.now();
         
         res.setHeader('Content-Type', 'application/json');
-        log(`${req.method} ${req.url}`);
+        debug(`${req.method} ${req.url}`);
 
         if (req.method !== 'POST' || !req.url.startsWith('/')) {
           return respond_with_error(res, 405, 'Method Not Allowed');
@@ -103,12 +106,12 @@ module.exports = (function() {
 
       //server.maxConnections = 64;
       server.listen(socket, () => {
-        log(`server ready, listening on ${socket} (max connections: ${server.maxConnections})`);
+        debug(`server ready, listening on ${socket} (max connections: ${server.maxConnections})`);
       });
     },
     
     close: (finalizer) => {
-      log("Shutting down");
+      debug("Shutting down");
       if (!closing) {
         closing = true;
         server.close(finalizer);
@@ -116,5 +119,5 @@ module.exports = (function() {
     }
   };
   
-  return { core: core, log: log };
+  return { core: core, debug: debug };
 })();

data/lib/nodo/railtie.rb

@@ -4,5 +4,7 @@ require 'active_support'
 class Nodo::Railtie < Rails::Railtie
   initializer 'nodo' do |app|
     Nodo.modules_root = Rails.root.join('vendor', 'node_modules')
+    Nodo.env['NODE_ENV'] = Rails.env.to_s
+    Nodo.logger = Rails.logger
   end
 end

data/lib/nodo/version.rb

@@ -1,3 +1,3 @@
 module Nodo
-  VERSION = '1.5.5'
+  VERSION = '1.5.6'
 end

data/lib/nodo.rb

@@ -3,16 +3,19 @@ require 'json'
 require 'fileutils'
 require 'tmpdir'
 require 'tempfile'
+require 'logger'
 require 'socket'
 require 'forwardable'
 
 module Nodo
   class << self
-    attr_accessor :modules_root, :env, :binary
+    attr_accessor :modules_root, :env, :binary, :logger, :debug
   end
   self.modules_root = './node_modules'
   self.env = {}
   self.binary = 'node'
+  self.logger = Logger.new(STDOUT)
+  self.debug  = false
 end
 
 require_relative 'nodo/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nodo
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.5.6
 platform: ruby
 authors:
 - Matthias Grosser