nodo 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e46009bcd3e3e8e5fd0f0a6f624c3f263caa09c64225878011e557333ffb8e64
-  data.tar.gz: 98eed61321bae14d89725f6884a16d2c3fccc2eb20f808781b10842e2f22ae25
+  metadata.gz: 421dba598b565369d200c90c8b095786f7b0a98de7c97e88c6927b59b64591a0
+  data.tar.gz: c6ba40e8873c90713edf4cc0887dcf64c3e7b9ea4629f4d97e3fc3c8c58218b9
 SHA512:
-  metadata.gz: ce0e598a9e6cffb816b53ce802a1a412746d195e387424b3362cc765d1fbd03931322c734a3ee6817487151f9969f414e1d99cfc1a4e9bddce99a7d6c7d95e26
-  data.tar.gz: a628c3765b94bd32600f554c1e973703e90a9dbcb06764b3d3256eb6ceb519997b2241f1f7c02474b8859aa2b4ff0049c863bcf047d38fbeeb8ed1be5e1bedb2
+  metadata.gz: 58410d1f53c78f40314ae24ea5f6e7d2aeca99f37aeeb6495ccdf0ee8a1fe903c956ad23462cba48ad38132df5614b3f354ee6c09638f52d47fe78e1e90d3064
+  data.tar.gz: 8374444cbbc7257b206fb17abd3470df3488885ae843e414bca3e645cf6c9f9e9d91d6de6f354e5f7fe4a1a98d780f04562df89752286851f8727d86e3c88aa9

data/README.md

@@ -1,4 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/nodo.svg)](http://badge.fury.io/rb/nodo)  [![build](https://github.com/mtgrosser/nodo/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/nodo/actions/workflows/build.yml)
+[![Gem Version](https://badge.fury.io/rb/nodo.svg)](http://badge.fury.io/rb/nodo)
+[![build](https://github.com/mtgrosser/nodo/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/nodo/actions/workflows/build.yml)
 
 # Nōdo – call Node.js from Ruby
 
@@ -39,13 +40,13 @@ In Nodo, you define JS functions as you would define Ruby methods:
 
 ```ruby
 class Foo < Nodo::Core
-  
+
   function :say_hi, <<~JS
     (name) => {
       return `Hello ${name}!`;
     }
   JS
-  
+
 end
 
 foo = Foo.new
@@ -90,6 +91,14 @@ class FooBar < Nodo::Core
 end
 ```
 
+### Alternate function definition syntax
+
+JS code can also be supplied using the `code:` keyword argument:
+
+```ruby
+function :hello, code: "() => 'world'"
+```
+
 ### Setting NODE_PATH
 
 By default, `./node_modules` is used as the `NODE_PATH`.
@@ -99,13 +108,7 @@ To set a custom path:
 Nodo.modules_root = 'path/to/node_modules'
 ```
 
-For Rails applications, it will be set to `vendor/node_modules`. 
-To use the Rails 6 default of putting `node_modules` to `RAILS_ROOT`:
-
-```ruby
-# config/initializers/nodo.rb
-Nodo.modules_root = Rails.root.join('node_modules')
-```
+Also see: [Clean your Rails root](#Clean-your-Rails-root)
 
 ### Defining JS constants
 
@@ -130,7 +133,8 @@ end
 
 ### Inheritance
 
-Subclasses will inherit functions, constants, dependencies and scripts from their superclasses, while only functions can be overwritten.
+Subclasses will inherit functions, constants, dependencies and scripts from
+their superclasses, while only functions can be overwritten.
 
 ```ruby
 class Foo < Nodo::Core
@@ -153,7 +157,8 @@ SubSubFoo.new.bar => "callingsubsubclass"
 ### Async functions
 
 `Nodo` supports calling `async` functions from Ruby. 
-The Ruby call will happen synchronously, i.e. it will block until the JS function resolves:
+The Ruby call will happen synchronously, i.e. it will block until the JS
+function resolves:
 
 ```ruby
 class SyncFoo < Nodo::Core
@@ -162,3 +167,63 @@ class SyncFoo < Nodo::Core
   JS
 end
 ```
+
+### Limiting function execution time
+
+The default timeout for a single JS function call is 60 seconds due to the
+`Net::HTTP` default. It can be overridden on a per-function basis:
+
+```ruby
+class Foo < Nodo::Core
+  function :sleep, timeout: 1, code: <<~'JS'
+    async (sec) => await new Promise(resolve => setTimeout(resolve, sec * 1000))
+  JS
+end
+
+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.
+
+
+#### Clean your Rails root
+
+For Rails applications, Nodo enables you to move `node_modules`, `package.json` and
+`yarn.lock` into your application's `vendor` folder by setting the `NODE_PATH` in
+an initializer:
+
+```ruby
+# config/initializers/nodo.rb
+Nodo.modules_root = Rails.root.join('vendor', 'node_modules')
+```
+
+The rationale behind this is NPM modules being external vendor dependencies, which
+should not clutter the application root directory.
+
+With this new default, all `yarn` operations should be done after `cd`ing to `vendor`.
+
+This repo provides an [adapted version](https://github.com/mtgrosser/nodo/blob/master/install/yarn.rake)
+of the `yarn:install` rake task which will automatically take care of the vendored module location.

data/lib/nodo/core.rb

@@ -12,6 +12,8 @@ module Nodo
     @@mutex = Mutex.new
     
     class << self
+      extend Forwardable
+      
       attr_accessor :class_defined
       
       def inherited(subclass)
@@ -24,6 +26,10 @@ module Nodo
         @instance ||= new
       end
       
+      def class_function(*methods)
+        singleton_class.def_delegators(:instance, *methods)
+      end
+      
       def class_defined?
         !!class_defined
       end
@@ -56,8 +62,13 @@ module Nodo
         self.dependencies = dependencies + mods.merge(deps).map { |name, package| Dependency.new(name, package) }
       end
 
-      def function(name, code)
-        self.functions = functions.merge(name => Function.new(name, code, caller.first))
+      def function(name, _code = nil, timeout: 60, code: nil)
+        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
+        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
       
@@ -85,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);
@@ -137,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
@@ -151,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
@@ -166,7 +183,7 @@ module Nodo
         begin
           break if socket = UNIXSocket.new(socket_path)
         rescue Errno::ENOENT, Errno::ECONNREFUSED, Errno::ENOTDIR
-          sleep 0.2
+          Kernel.sleep(0.2)
         end
       end
       socket.close if socket
@@ -181,12 +198,15 @@ module Nodo
       request = Net::HTTP::Post.new("/#{clsid}/#{method}", 'Content-Type': 'application/json')
       request.body = JSON.dump(args)
       client = Client.new("unix://#{socket_path}")
+      client.read_timeout = function.timeout if function
       response = client.request(request)
       if response.is_a?(Net::HTTPOK)
         parse_response(response)
       else
         handle_error(response, function)
       end
+    rescue Net::ReadTimeout
+      raise TimeoutError, "function call #{self.class}##{method} timed out"
     rescue Errno::EPIPE, IOError
       # TODO: restart or something? If this happens the process is completely broken
       raise Error, 'Node process failed'
@@ -195,13 +215,16 @@ 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)
-      JSON.parse(response.body.force_encoding('UTF-8'))
+      data = response.body.force_encoding('UTF-8')
+      JSON.parse(data) unless data == ''
     end
     
     def with_tempfile(name)

data/lib/nodo/function.rb

@@ -1,9 +1,9 @@
 module Nodo
   class Function
-    attr_reader :name, :code, :source_location
+    attr_reader :name, :code, :source_location, :timeout
   
-    def initialize(name, code, source_location)
-      @name, @code, @source_location = name, code, source_location
+    def initialize(name, code, source_location, timeout)
+      @name, @code, @source_location, @timeout = name, code, source_location, timeout
     end
   
     def to_js

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

@@ -3,6 +3,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.3'
+  VERSION = '1.6.0'
 end

data/lib/nodo.rb

@@ -3,15 +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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nodo
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Matthias Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler