mini_racer 0.1.15 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6c94af48c76bdd1d4ce6744e81cf812192498d8
-  data.tar.gz: dd14708bbca74f0845ce37310fb4a7679326e7cb
+SHA256:
+  metadata.gz: f868c575c8ed41f4080580b2d09d0d42522d337390f425b3110e38298952a6f4
+  data.tar.gz: 9c2df1f0171dd3ed4bba7a59faa3ea7d87a1976087395da3ec56966aeedd23d8
 SHA512:
-  metadata.gz: 8982f3a4a7aa6c9f89a581099c48a2e694930f9e4f48beaf88cfaf38f9a21004b32fd5093937ffa0096ac4ebb725c7f99402928a0ab4b54153114fa81267d21b
-  data.tar.gz: f9219565baccdea2ce89be3e50012b204e4482296f83084517db0e996a4a6147050230f6afcebc4ba79e1b127aa3dcbe845962c3087c5dd3ec3b2e16970537f0
+  metadata.gz: 7c51ea3a8f4abc4ae458090ce2f37760110ac240f7600e3fd249f07df97725e0b7903884fb90063b3d3140c0337eeae132a6e395b1f74777c85dfddc03b6ad96
+  data.tar.gz: '0948c498cdb9a0767dbe0de9d4b233d2561eb6b72f6603170c3f4d9304083487a03fc395f8803f1d1690ef6f9d06e0faddc86ef694b950c0e95ea4047943c96e'

data/.dockerignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+lib/mini_racer_extension.so
+lib/mini_racer_loader.so
+*.bundle

data/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: Test
+on:
+  - push
+
+jobs:
+  test-darwin:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - '10.15'
+          - '11.0'
+        platform:
+          - x86_64
+          # arm64
+    name: Test (darwin)
+    runs-on: macos-${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Bundle
+        run: bundle install
+      - name: Compile
+        run: bundle exec rake compile
+      - name: Test
+        run: bundle exec rake test
+  test-linux:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+        platform:
+          - amd64
+          - arm64
+          # arm
+          # ppc64le
+          # s390x
+        libc:
+          - gnu
+          - musl
+    name: Test (linux)
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Enable ${{ matrix.platform }} platform
+        id: qemu
+        if: ${{ matrix.platform != 'amd64' }}
+        run: |
+          docker run --privileged --rm tonistiigi/binfmt:latest --install ${{ matrix.platform }} | tee platforms.json
+          echo "::set-output name=platforms::$(cat platforms.json)"
+      - name: Start container
+        id: container
+        run: |
+          case ${{ matrix.libc }} in
+            gnu)
+              echo 'ruby:${{ matrix.ruby }}'
+              ;;
+            musl)
+              echo 'ruby:${{ matrix.ruby }}-alpine'
+              ;;
+          esac > container_image
+          echo "::set-output name=image::$(cat container_image)"
+          docker run --rm -d -v "${PWD}":"${PWD}" -w "${PWD}" --platform linux/${{ matrix.platform }} $(cat container_image) /bin/sleep 64d | tee container_id
+          docker exec -w "${PWD}" $(cat container_id) uname -a
+          echo "::set-output name=id::$(cat container_id)"
+      - name: Install Alpine system dependencies
+        if: ${{ matrix.libc == 'musl' }}
+        run: docker exec -w "${PWD}" ${{ steps.container.outputs.id }} apk add --no-cache build-base linux-headers bash python2 python3 git curl tar clang binutils-gold
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Bundle
+        run: docker exec -w "${PWD}" ${{ steps.container.outputs.id }} bundle install
+      - name: Compile
+        run: docker exec -w "${PWD}" ${{ steps.container.outputs.id }} bundle exec rake compile
+      - name: Test
+        run: docker exec -w "${PWD}" ${{ steps.container.outputs.id }} bundle exec rake test

data/.gitignore

@@ -8,4 +8,6 @@ Gemfile.lock
 /spec/reports/
 /tmp/
 lib/mini_racer_extension.so
+lib/mini_racer_loader.so
 *.bundle
+.vscode/

data/.travis.yml

@@ -1,19 +1,23 @@
 language: ruby
+os: linux
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.3
-  - 2.4.0
-matrix:
+  - 2.6
+  - 2.7
+  - 3.0
+  - ruby-head
+arch:
+  - amd64
+  - arm64
+jobs:
   include:
-    - rvm: 2.4.0
+    - rvm: 2.6
       os: osx
-      osx_image: xcode8.2
-    - rvm: 2.4.0
+      osx_image: xcode11.3
+    - rvm: 2.6
       os: osx
-      osx_image: xcode7.3
-dist: trusty
-sudo: true
-before_install:
-  - gem install bundler -v 1.12.0
+      osx_image: xcode12.2
+    - rvm: 2.7
+      os: osx
+      osx_image: xcode12.2
+dist: xenial
 cache: bundler

data/CHANGELOG

@@ -1,3 +1,138 @@
+- 11-04-2021
+
+- 0.4.0
+
+  - FEATURE: upgrade to libv8 node 15.14.0 (v8 8.6.395.17)
+  - Promote 0.4.0.beta1 to release, using libv8-node release path
+
+- 08-04-2021
+
+- 0.4.0.beta1
+
+  - FIX: on downgrade mkmf was picking the wrong version of libv8, this fix will correct future issues
+  - FEATURE: upgraded libv8 to use node libv8 build which supports M1 and various ARM builds v8 moved to (8.6.395.17)
+
+- 23-07-2020
+
+- 0.3.1
+
+  - FIX: specify that libv8 must be larger than 8.4.255 but smaller than 8.5, this avoids issues going forward
+
+- 22-07-2020
+
+- 0.3.0
+
+  - FEATURE: upgraded to libv8 version 8.4.255.0
+
+- 29-06-2020
+
+- 0.2.15
+
+  - FEATURE: basic wasm support via pump_message_loop
+
+- 15-05-2020
+
+- 0.2.14
+
+  - FIX: ensure_gc_after_idle should take in milliseconds like the rest of the APIs not seconds
+  - FEATURE: strict params on MiniRacer::Context.new
+
+- 15-05-2020
+
+- 0.2.13
+
+   - FIX: edge case around ensure_gc_after_idle possibly firing when context is not idle
+
+- 15-05-2020
+
+- 0.2.12
+
+  - FEATURE: isolate.low_memory_notification which can force a full GC
+  - FEATURE: MiniRacer::Context.new(ensure_gc_after_idle: 2) - to force full GC 2 seconds after context is idle, this allows you to conserve memory on isolates
+
+- 14-05-2020
+
+- 0.2.11
+
+  - FIX: dumping heap snapshots was not flushing the file leading to corrupt snapshots
+  - FIX: a use-after-free shutdown crash
+
+- 0.2.10
+
+- 22-04-2020
+
+  - FEATURE: memory softlimit support for nogvl_context_call
+
+- 0.2.9
+
+- 09-01-2020
+
+  - FIX: correct segfault when JS returns a Symbol and properly cast to ruby symbol
+
+- 0.2.8
+
+- 11-11-2019
+
+  - FIX: ensure thread live cycle is properly accounter for following file descriptor fix
+
+- 0.2.7
+
+- 11-11-2019
+
+  - FIX: release the file descriptor for timeout pipe earlier (this avoids holding too many files open in Ruby 2.7)
+
+- 14-05-2019
+
+- 0.2.6
+
+  - FEATURE: add support for write_heap_snapshot which helps you analyze memory
+
+- 25-04-2019
+
+- 0.2.5
+
+  - FIX: Compatiblity fixes for V8 7 and above @ignisf
+  - FIX: Memory leak in gc_callback @messense
+  - IMPROVEMENT: Added example of sourcemap support @ianks
+  - URGENT: you will need this release for latest version of libv8 to work
+
+- 02-11-2018
+
+- 0.2.4
+
+  - FIX: deadlock releasing context when shared isolates are used
+  - FEATURE: include js backtrace when snapshots do not compile
+
+- 28-09-2018
+
+- 0.2.3
+
+  - Drop all conditional logic from Mini Racer compilation for clang, always
+	  rely on MacOS being High Sierra or up
+
+- 26-09-2018
+
+- 0.2.2
+
+  - WORKAROUND: RUBY_PLATFORM is hardcoded on Ruby compile and can not be
+	trusted for feature detection, use a different technique when checking for
+	macOS Mojave
+
+- 25-09-2018
+
+- 0.2.1
+
+  - FEATURE: Mojave macOS support
+
+- 06-07-2018
+
+- 0.2.0
+  - FEATURE: context#call to allow for cheaper invocation of functions
+  - FIX: rare memory leak when terminating a long running attached function
+  - FIX: rare segfault when terminating a long running attached function
+  - FIX: Reimplement Isolate#idle_notification using idle_notification_deadline, API remains the same @ignisf
+  - Account for changes in the upstream V8 API @ignisf
+  - Support for libv8 6.7
 
 23-08-2017
 

data/Dockerfile

@@ -0,0 +1,21 @@
+ARG RUBY_VERSION=2.7
+FROM ruby:${RUBY_VERSION}
+
+RUN test ! -f /etc/alpine-release || apk add --no-cache build-base git
+
+# without this `COPY .git`, we get the following error:
+#   fatal: not a git repository (or any of the parent directories): .git
+# but with it we need the full gem just to compile the extension because
+# of gemspec's `git --ls-files`
+# COPY .git /code/.git
+COPY Gemfile mini_racer.gemspec /code/
+COPY lib/mini_racer/version.rb /code/lib/mini_racer/version.rb
+WORKDIR /code
+RUN bundle install
+
+COPY Rakefile /code/
+COPY ext /code/ext/
+RUN bundle exec rake compile
+
+COPY . /code/
+CMD bundle exec irb -rmini_racer

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 TODO: Write your name
+Copyright (c) 2016-2019, the mini_racer project authors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # 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.
 
@@ -10,6 +10,12 @@ It was created as an alternative to the excellent [therubyracer](https://github.
 
 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
 
 ### Simple eval for JavaScript
@@ -79,6 +85,19 @@ context.eval 'var a = new Array(10000); while(true) {a = a.concat(new Array(1000
 # => 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
@@ -91,6 +110,27 @@ context.eval('bar()', filename: 'a/bar.js')
 
 ```
 
+### 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
 
@@ -203,12 +243,17 @@ context = MiniRacer::Context.new(isolate: isolate)
 # 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:
@@ -217,7 +262,7 @@ It is possible to set V8 Runtime flags:
 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 alwatys appreciate V8's liberal use of threading:
+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
 ```
@@ -246,7 +291,7 @@ context.eval js
 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/flag-definitions.h).
+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.
 
@@ -283,6 +328,32 @@ context.eval("a = 2")
 # 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.
@@ -324,6 +395,10 @@ Note how the global interpreter lock release leads to 2 threads doing the same w
 
 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:
@@ -341,14 +416,14 @@ 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 4.8) this is included by default in ubuntu trusty based images.
+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 4.8 on precise the simpler approach is to opt for the trusty based image.
+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:
 
@@ -400,7 +475,7 @@ Add this to your .travis.yml file:
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/discourse/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 #$CPPFLAGS", conf)
+end

data/ext/mini_racer_extension/extconf.rb

@@ -1,16 +1,28 @@
 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/
+have_library('objc') if IS_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 += " -fPIC" unless $CPPFLAGS.split.include? "-rdynamic" or IS_DARWIN
+$CPPFLAGS += " -std=c++14"
 $CPPFLAGS += " -fpermissive"
+#$CPPFLAGS += " -DV8_COMPRESS_POINTERS"
+$CPPFLAGS += " -fvisibility=hidden "
+
+$CPPFLAGS += " -Wno-reserved-user-defined-literal" if IS_DARWIN
+
+$LDFLAGS.insert(0, " -stdlib=libc++ ") if IS_DARWIN
 
-$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"
@@ -39,16 +51,21 @@ installing GCC 4.8. See mini_racer's README.md for more information.
 EOS
 end
 
-CONFIG['LDSHARED'] = '$(CXX) -shared' unless RUBY_PLATFORM =~ /darwin/
+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')
+  $CPPFLAGS.insert(0, " -fsanitize=address ")
+  $LDFLAGS.insert(0, " -fsanitize=address ")
+end
 
 create_makefile 'mini_racer_extension'