mini_racer 0.1.0 → 0.6.0

data/README.md

@@ -1,14 +1,20 @@
 # MiniRacer
 
-[![Build Status](https://travis-ci.org/discourse/mini_racer.svg?branch=master)](https://travis-ci.org/discourse/mini_racer)
+[![Build Status](https://travis-ci.org/rubyjs/mini_racer.svg?branch=master)](https://travis-ci.org/rubyjs/mini_racer)
 
 Minimal, modern embedded V8 for Ruby.
 
 MiniRacer provides a minimal two way bridge between the V8 JavaScript engine and Ruby.
 
-It was created as an alternative to the excellent [therubyracer](https://github.com/cowboyd/therubyracer). Unlike therubyracer, mini_racer only implements a minimal bridge. This reduces the surface area making upgrading v8 much simpler and exahustive testing simpler.
+It was created as an alternative to the excellent [therubyracer](https://github.com/cowboyd/therubyracer). Unlike therubyracer, mini_racer only implements a minimal bridge. This reduces the surface area making upgrading v8 much simpler and exhaustive testing simpler.
 
-MiniRacer has an adapter for [execjs](https://github.com/sstephenson/execjs) so it can be used directly with Rails projects to minify assets, run babel or compile CoffeeScript.
+MiniRacer has an adapter for [execjs](https://github.com/rails/execjs) so it can be used directly with Rails projects to minify assets, run babel or compile CoffeeScript.
+
+### A note about Ruby version Support
+
+MiniRacer only supports non-EOL versions of Ruby. See [Ruby](https://www.ruby-lang.org/en/downloads) to see the list of non-EOL Rubies.
+
+If you require support for older versions of Ruby install an older version of the gem.
 
 ## Features
 
@@ -29,11 +35,18 @@ You can attach one or many ruby proc that can be accessed via JavaScript
 
 ```ruby
 context = MiniRacer::Context.new
-context.attach("adder", proc{|a,b| a+b})
-puts context.eval 'adder(20,22)'
+context.attach("math.adder", proc{|a,b| a+b})
+puts context.eval 'math.adder(20,22)'
 # => 42
 ```
 
+```ruby
+context = MiniRacer::Context.new
+context.attach("array_and_hash", proc{{a: 1, b: [1, {a: 1}]}})
+puts context.eval 'array_and_hash()'
+# => {"a" => 1, "b" => [1, {"a" => 1}]}
+```
+
 ### GIL free JavaScript execution
 
 The Ruby Global interpreter lock is released when scripts are executing
@@ -61,6 +74,64 @@ context.eval 'while(true){}'
 # => exception is raised
 ```
 
+### Memory softlimit support
+
+Contexts can specify a memory softlimit for scripts
+
+```ruby
+# terminates script if heap usage exceeds 200mb after V8 garbage collection has run
+context = MiniRacer::Context.new(max_memory: 200000000)
+context.eval 'var a = new Array(10000); while(true) {a = a.concat(new Array(10000)); print("loop " + a.length);}'
+# => V8OutOfMemoryError is raised
+```
+
+### Object marshal max stackdepth support
+
+Contexts can specify a stack depth limit for object marshalling. Max depth is unbounded by default.
+
+```ruby
+# terminates script if stack depth exceeds max during marshal
+context = MiniRacer::Context.new(marshal_stack_depth: 500)
+context.attach("a", proc{|a| a})
+
+context.eval("let arr = []; arr.push(arr); a(arr)")
+# => RuntimeError is raised
+```
+
+### Rich debugging with "filename" support
+
+```ruby
+
+context = MiniRacer::Context.new
+context.eval('var foo = function() {bar();}', filename: 'a/foo.js')
+context.eval('bar()', filename: 'a/bar.js')
+
+# MiniRacer::RuntimeError is raised containing the filenames you specified for evals in backtrace
+
+```
+
+### Fork safety
+
+Some Ruby web servers employ forking (for example unicorn or puma in clustered mode). V8 is not fork safe.
+Sadly Ruby does not have support for fork notifications per [#5446](https://bugs.ruby-lang.org/issues/5446).
+
+If you want to ensure your application does not leak memory after fork either:
+
+1. Ensure no MiniRacer::Context objects are created in the master process
+
+Or
+
+2. Dispose manually of all MiniRacer::Context objects prior to forking
+
+```ruby
+# before fork
+
+require 'objspace'
+ObjectSpace.each_object(MiniRacer::Context){|c| c.dispose}
+
+# fork here
+```
+
 ### Threadsafe
 
 Context usage is threadsafe
@@ -81,28 +152,239 @@ puts context.eval("counter")
 
 ```
 
+### Snapshots
+
+Contexts can be created with pre-loaded snapshots:
+
+```ruby
+
+snapshot = MiniRacer::Snapshot.new('function hello() { return "world!"; }')
+
+context = MiniRacer::Context.new(snapshot: snapshot)
+
+context.eval("hello()")
+# => "world!"
+
+```
+
+Snapshots can come in handy for example if you want your contexts to be pre-loaded for effiency. It uses [V8 snapshots](http://v8project.blogspot.com/2015/09/custom-startup-snapshots.html) under the hood; see [this link](http://v8project.blogspot.com/2015/09/custom-startup-snapshots.html) for caveats using these, in particular:
+
+```
+There is an important limitation to snapshots: they can only capture V8’s
+heap. Any interaction from V8 with the outside is off-limits when creating the
+snapshot. Such interactions include:
+
+ * defining and calling API callbacks (i.e. functions created via v8::FunctionTemplate)
+ * creating typed arrays, since the backing store may be allocated outside of V8
+
+And of course, values derived from sources such as `Math.random` or `Date.now`
+are fixed once the snapshot has been captured. They are no longer really random
+nor reflect the current time.
+```
+
+Also note that snapshots can be warmed up, using the `warmup!` method, which allows you to call functions which are otherwise lazily compiled to get them to compile right away; any side effect of your warm up code being then dismissed. [More details on warming up here](https://github.com/electron/electron/issues/169#issuecomment-76783481), and a small example:
+
+```ruby
+
+snapshot = MiniRacer::Snapshot.new('var counter = 0; function hello() { counter++; return "world! "; }')
+
+snapshot.warmup!('hello()')
+
+context = MiniRacer::Context.new(snapshot: snapshot)
+
+context.eval('hello()')
+# => "world! 1"
+context.eval('counter')
+# => 1
+
+```
+
+### Shared isolates
+
+By default, MiniRacer's contexts each have their own isolate (V8 runtime). For efficiency, it is possible to re-use an isolate across contexts:
+
+```ruby
+
+isolate = MiniRacer::Isolate.new
+
+context1 = MiniRacer::Context.new(isolate: isolate)
+context2 = MiniRacer::Context.new(isolate: isolate)
+
+context1.isolate == context2.isolate
+# => true
+```
+
+The main benefit of this is avoiding creating/destroying isolates when not needed (for example if you use a lot of contexts).
+
+The caveat with this is that a given isolate can only execute one context at a time, so don't share isolates across contexts that you want to run concurrently.
+
+Also, note that if you want to use shared isolates together with snapshots, you need to first create an isolate with that snapshot, and then create contexts from that isolate:
+
+```ruby
+snapshot = MiniRacer::Snapshot.new('function hello() { return "world!"; }')
+
+isolate = MiniRacer::Isolate.new(snapshot)
+
+context = MiniRacer::Context.new(isolate: isolate)
+
+context.eval("hello()")
+# => "world!"
+```
+
+Re-using the same isolate over and over again means V8's garbage collector will have to run to clean it up every now and then; it's possible to trigger a _blocking_ V8 GC run inside your isolate by running the `idle_notification` method on it, which takes a single argument: the amount of time (in milliseconds) that V8 should use at most for garbage collecting:
+
+```ruby
+isolate = MiniRacer::Isolate.new
+
+context = MiniRacer::Context.new(isolate: isolate)
+
+# do stuff with that context...
+
+# give up to 100ms for V8 garbage collection
+isolate.idle_notification(100)
+
+# force V8 to perform a full GC
+isolate.low_memory_notification
+
+```
+
+This can come in handy to force V8 GC runs for example in between requests if you use MiniRacer on a web application.
+
+Note that this method maps directly to [`v8::Isolate::IdleNotification`](http://bespin.cz/~ondras/html/classv8_1_1Isolate.html#aea16cbb2e351de9a3ae7be2b7cb48297), and that in particular its return value is the same (true if there is no further garbage to collect, false otherwise) and the same caveats apply, in particular that `there is no guarantee that the [call will return] within the time limit.`
+
+Additionally you may automate this process on a context by defining it with `MiniRacer::Content.new(ensure_gc_after_idle: 1000)`. Using this will ensure V8 will run a full GC using `context.isolate.low_memory_notification` 1 second after the last eval on the context. Low memory notification is both slower and more aggressive than an idle_notification and will ensure long living isolates use minimal amounts of memory.
+
+### V8 Runtime flags
+
+It is possible to set V8 Runtime flags:
+
+```ruby
+MiniRacer::Platform.set_flags! :noconcurrent_recompilation, max_inlining_levels: 10
+```
+
+This can come in handy if you want to use MiniRacer with Unicorn, which doesn't seem to always appreciate V8's liberal use of threading:
+```ruby
+MiniRacer::Platform.set_flags! :noconcurrent_recompilation, :noconcurrent_sweeping
+```
+
+Or else to unlock experimental features in V8, for example tail recursion optimization:
+```ruby
+MiniRacer::Platform.set_flags! :harmony
+
+js = <<-JS
+'use strict';
+var f = function f(n){
+  if (n <= 0) {
+    return  'foo';
+  }
+  return f(n - 1);
+}
+
+f(1e6);
+JS
+
+context = MiniRacer::Context.new
+
+context.eval js
+# => "foo"
+```
+The same code without the harmony runtime flag results in a `MiniRacer::RuntimeError: RangeError: Maximum call stack size exceeded` exception.
+Please refer to http://node.green/ as a reference on other harmony features.
+
+A list of all V8 runtime flags can be found using `node --v8-options`, or else by perusing [the V8 source code for flags (make sure to use the right version of V8)](https://github.com/v8/v8/blob/master/src/flags/flag-definitions.h).
+
+Note that runtime flags must be set before any other operation (e.g. creating a context, a snapshot or an isolate), otherwise an exception will be thrown.
+
+Flags:
+
+- :expose_gc : Will expose `gc()` which you can run in JavaScript to issue a gc
+- :max_old_space_size : defaults to 1400 (megs) on 64 bit, you can restric memory usage by limiting this.
+- **NOTE TO READER** our documentation could be awesome we could be properly documenting all the flags, they are hugely useful, if you feel like documenting a few more, PLEASE DO, PRs are welcome.
+
+## Controlling memory
+
+When hosting v8 you may want to keep track of memory usage, use #heap_stats to get memory usage:
+
+```ruby
+context = MiniRacer::Context.new(timeout: 5)
+context.eval("let a='testing';")
+p context.heap_stats
+# {:total_physical_size=>1280640,
+#  :total_heap_size_executable=>4194304,
+#  :total_heap_size=>3100672,
+#  :used_heap_size=>1205376,
+#  :heap_size_limit=>1501560832}
+```
+
+If you wish to dispose of a context before waiting on the GC use
+
+```ruby
+context = MiniRacer::Context.new(timeout: 5)
+context.eval("let a='testing';")
+context.dispose
+context.eval("a = 2")
+# MiniRacer::ContextDisposedError
+
+# nothing works on the context from now on, its a shell waiting to be disposed
+```
+
+A MiniRacer context can also be dumped in a heapsnapshot file using `#write_heap_snapshot(file_or_io)`
+
+```ruby
+context = MiniRacer::Context.new(timeout: 5)
+context.eval("let a='testing';")
+context.write_heap_snapshot("test.heapsnapshot")
+```
+
+This file can then be loaded in the memory tab of the chrome dev console.
+
+### Function call
+
+This calls the function passed as first argument:
+
+```ruby
+context = MiniRacer::Context.new
+context.eval('function hello(name) { return "Hello, " + name + "!" }')
+context.call('hello', 'George')
+# "Hello, George!"
+```
+
+Performance is slightly better than running `eval('hello("George")')` since:
+
+ - compilation of eval'd string is avoided
+ - function arguments don't need to be converted to JSON
+
 ## Performance
 
 The `bench` folder contains benchmark.
 
 ### Benchmark minification of Discourse application.js (both minified and unminified)
 
-- MiniRacer version 0.1 (unreleased)
+MiniRacer outperforms node when minifying assets via execjs.
+
+- MiniRacer version 0.1.9
+- node version 6.10
 - therubyracer version 0.12.2
 
-```
-$ ruby bench_uglify.rb
-Benching with MiniRacer
-MiniRacer minify discourse_app.js 13813.36ms
-MiniRacer minify discourse_app_minified.js 18271.19ms
-MiniRacer minify discourse_app.js twice (2 threads) 13587.21ms
 ```
 
-```
+$ bundle exec ruby bench.rb mini_racer
+Benching with mini_racer
+mini_racer minify discourse_app.js 9292.72063ms
+mini_racer minify discourse_app_minified.js 11799.850171ms
+mini_racer minify discourse_app.js twice (2 threads) 10269.570797ms
+
+sam@ubuntu exec_js_uglify % bundle exec ruby bench.rb node
+Benching with node
+node minify discourse_app.js 13302.715484ms
+node minify discourse_app_minified.js 18100.761243ms
+node minify discourse_app.js twice (2 threads) 14383.600207000001ms
+
+sam@ubuntu exec_js_uglify % bundle exec ruby bench.rb therubyracer
 Benching with therubyracer
-MiniRacer minify discourse_app.js 151467.164ms
-MiniRacer minify discourse_app_minified.js 158172.097ms
-MiniRacer minify discourse_app.js twice (2 threads) - DOES NOT FINISH
+therubyracer minify discourse_app.js 171683.01867700001ms
+therubyracer minify discourse_app_minified.js 143138.88492ms
+therubyracer minify discourse_app.js twice (2 threads) NEVER FINISH
 
 Killed: 9
 ```
@@ -111,6 +393,12 @@ The huge performance disparity (MiniRacer is 10x faster) is due to MiniRacer run
 
 Note how the global interpreter lock release leads to 2 threads doing the same work taking the same wall time as 1 thread.
 
+As a rule MiniRacer strives to always support and depend on the latest stable version of libv8.
+
+## Source Maps
+
+MiniRacer can fully support source maps but must be configured correctly to do so. [Check out this example](./examples/source-map-support/) for a working implementation.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -128,18 +416,32 @@ Or install it yourself as:
     $ gem install mini_racer
 
 
-**Note** using v8.h and compiling MiniRacer requires a C++11 standard compiler, more specifically clang 3.5 (or later) or gcc 4.8 (or later).
+**Note** using v8.h and compiling MiniRacer requires a C++11 standard compiler, more specifically clang 3.5 (or later) or GCC 6.3 (or later).
+
+
+## Travis-ci
+
+To install `mini-racer` you will need a version of GCC that supports C++11 (GCC 6.3) this is included by default in ubuntu trusty based images.
+
+Travis today ships by default with a precise based image. Precise Pangolin (12.04 LTS) was first released in August 2012. Even though you can install GCC 6.3 on precise the simpler approach is to opt for the trusty based image.
+
+Add this to your .travis.yml file:
+
+```
+- sudo: required
+- dist: trusty
+```
 
 ## Similar Projects
 
-###therubyracer
+### therubyracer
 
 - https://github.com/cowboyd/therubyracer
 - Most comprehensive bridge available
 - Provides the ability to "eval" JavaScript
 - Provides the ability to invoke Ruby code from JavaScript
-- Hold refrences to JavaScript objects and methods in your Ruby code
-- Hold refrences to Ruby objects and methods in JavaScript code
+- Hold references to JavaScript objects and methods in your Ruby code
+- Hold references to Ruby objects and methods in JavaScript code
 - Uses libv8, so installation is fast
 - Supports timeouts for JavaScript execution
 - Does not release global interpreter lock, so performance is constrained to a single thread
@@ -147,7 +449,7 @@ Or install it yourself as:
 - Supports execjs
 
 
-###v8eval
+### v8eval
 
 - https://github.com/sony/v8eval
 - Provides the ability to "eval" JavaScript using the latest V8 engine
@@ -160,7 +462,7 @@ Or install it yourself as:
 - No support for execjs (can not be used with Rails uglifier and coffeescript gems)
 
 
-###therubyrhino
+### therubyrhino
 
 - https://github.com/cowboyd/therubyrhino
 - API compatible with therubyracer
@@ -173,7 +475,7 @@ Or install it yourself as:
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mini_racer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyjs/mini_racer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/Rakefile

@@ -11,11 +11,28 @@ end
 task :default => [:compile, :test]
 
 gem = Gem::Specification.load( File.dirname(__FILE__) + '/mini_racer.gemspec' )
+Rake::ExtensionTask.new( 'mini_racer_loader', gem )
 Rake::ExtensionTask.new( 'mini_racer_extension', gem )
 
 
 # via http://blog.flavorjon.es/2009/06/easily-valgrind-gdb-your-ruby-c.html
 namespace :test do
+  desc "run test suite with Address Sanitizer"
+  task :asan do
+    ENV["CONFIGURE_ARGS"] = [ENV["CONFIGURE_ARGS"], '--enable-asan'].compact.join(' ')
+    Rake::Task['compile'].invoke
+
+    asan_path = `ldconfig -N -p |grep libasan | grep -v 32 | sed 's/.* => \\(.*\\)$/\\1/'`.chomp.split("\n")[-1]
+
+
+    cmdline = "env LD_PRELOAD=\"#{asan_path}\" ruby test/test_leak.rb"
+    puts cmdline
+    system cmdline
+
+    cmdline = "env LD_PRELOAD=\"#{asan_path}\" rake test"
+    puts cmdline
+    system cmdline
+  end
   # partial-loads-ok and undef-value-errors necessary to ignore
   # spurious (and eminently ignorable) warnings from the ruby
   # interpreter
@@ -52,3 +69,28 @@ namespace :test do
     end
   end
 end
+
+desc 'run clang-tidy linter on mini_racer_extension.cc'
+task :lint do
+  require 'mkmf'
+  require 'libv8'
+
+  Libv8.configure_makefile
+
+  conf = RbConfig::CONFIG.merge('hdrdir' => $hdrdir.quote, 'srcdir' => $srcdir.quote,
+                                'arch_hdrdir' => $arch_hdrdir.quote,
+                                'top_srcdir' => $top_srcdir.quote)
+  if $universal and (arch_flag = conf['ARCH_FLAG']) and !arch_flag.empty?
+    conf['ARCH_FLAG'] = arch_flag.gsub(/(?:\G|\s)-arch\s+\S+/, '')
+  end
+
+  checks = %W(bugprone-*
+              cert-*
+              cppcoreguidelines-*
+              clang-analyzer-*
+              performance-*
+              portability-*
+              readability-*).join(',')
+
+  sh RbConfig::expand("clang-tidy -checks='#{checks}' ext/mini_racer_extension/mini_racer_extension.cc -- #$INCFLAGS #$CXXFLAGS", conf)
+end

data/ext/mini_racer_extension/extconf.rb

@@ -1,32 +1,78 @@
 require 'mkmf'
-require 'libv8'
+require_relative '../../lib/mini_racer/version'
+gem 'libv8-node', MiniRacer::LIBV8_NODE_VERSION
+require 'libv8-node'
+
+IS_DARWIN = RUBY_PLATFORM =~ /darwin/
 
 have_library('pthread')
-have_library('objc') if RUBY_PLATFORM =~ /darwin/
-$CPPFLAGS += " -Wall" unless $CPPFLAGS.split.include? "-Wall"
-$CPPFLAGS += " -g" unless $CPPFLAGS.split.include? "-g"
-$CPPFLAGS += " -rdynamic" unless $CPPFLAGS.split.include? "-rdynamic"
-$CPPFLAGS += " -fPIC" unless $CPPFLAGS.split.include? "-rdynamic" or RUBY_PLATFORM =~ /darwin/
-$CPPFLAGS += " -std=c++0x"
-$CPPFLAGS += " -fpermissive"
+have_library('objc') if IS_DARWIN
+$CXXFLAGS += " -Wall" unless $CXXFLAGS.split.include? "-Wall"
+$CXXFLAGS += " -g" unless $CXXFLAGS.split.include? "-g"
+$CXXFLAGS += " -rdynamic" unless $CXXFLAGS.split.include? "-rdynamic"
+$CXXFLAGS += " -fPIC" unless $CXXFLAGS.split.include? "-rdynamic" or IS_DARWIN
+$CXXFLAGS += " -std=c++14"
+$CXXFLAGS += " -fpermissive"
+#$CXXFLAGS += " -DV8_COMPRESS_POINTERS"
+$CXXFLAGS += " -fvisibility=hidden "
+
+# __declspec gets used by clang via ruby 3.x headers...
+$CXXFLAGS += " -fms-extensions"
+
+$CXXFLAGS += " -Wno-reserved-user-defined-literal" if IS_DARWIN
+
+if IS_DARWIN
+  $LDFLAGS.insert(0, " -stdlib=libc++ ")
+else
+  $LDFLAGS.insert(0, " -lstdc++ ")
+end
 
-$LDFLAGS.insert 0, " -stdlib=libstdc++ " if RUBY_PLATFORM =~ /darwin/
+# check for missing symbols at link time
+# $LDFLAGS += " -Wl,--no-undefined " unless IS_DARWIN
+# $LDFLAGS += " -Wl,-undefined,error " if IS_DARWIN
 
 if ENV['CXX']
   puts "SETTING CXX"
   CONFIG['CXX'] = ENV['CXX']
 end
 
-CONFIG['LDSHARED'] = '$(CXX) -shared' unless RUBY_PLATFORM =~ /darwin/
+CXX11_TEST = <<EOS
+#if __cplusplus <= 199711L
+#   error A compiler that supports at least C++11 is required in order to compile this project.
+#endif
+EOS
+
+`echo "#{CXX11_TEST}" | #{CONFIG['CXX']} -std=c++0x -x c++ -E -`
+unless $?.success?
+  warn <<EOS
+
+
+WARNING: C++11 support is required for compiling mini_racer. Please make sure
+you are using a compiler that supports at least C++11. Examples of such
+compilers are GCC 4.7+ and Clang 3.2+.
+
+If you are using Travis, consider either migrating your build to Ubuntu Trusty or
+installing GCC 4.8. See mini_racer's README.md for more information.
+
+
+EOS
+end
+
+CONFIG['LDSHARED'] = '$(CXX) -shared' unless IS_DARWIN
 if CONFIG['warnflags']
   CONFIG['warnflags'].gsub!('-Wdeclaration-after-statement', '')
   CONFIG['warnflags'].gsub!('-Wimplicit-function-declaration', '')
 end
 
-if enable_config('debug')
+if enable_config('debug') || enable_config('asan')
   CONFIG['debugflags'] << ' -ggdb3 -O0'
 end
 
-Libv8.configure_makefile
+Libv8::Node.configure_makefile
+
+if enable_config('asan')
+  $CXXFLAGS.insert(0, " -fsanitize=address ")
+  $LDFLAGS.insert(0, " -fsanitize=address ")
+end
 
 create_makefile 'mini_racer_extension'