mini_racer 0.2.10 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a50c6aea93635efc351ce95def252df6edb3fbede6a0372272f8c9cd58f9aaed
-  data.tar.gz: b01cd6a98eca13db18d539ed259e4acd968eb073582979ff06f78a5df54a4207
+  metadata.gz: e832863760637f983976194ebef263d8815c149d48ff26c7200367ab33640dda
+  data.tar.gz: 7c1c393ae6403a75d2a413395d56e7d5f3affe706b81c121273b4c6b5d471bf4
 SHA512:
-  metadata.gz: cac0258ac9f1f93245b00b313d004504d770e9dce3eb5ac9a8d547a1b24cd3649ec9039d9c7429ff7871f9f8d3c07e260997d86647905ba433688f361bd72611
-  data.tar.gz: b054a38013e7bcffe689c3732d7d95abbaf61c350dab275ff7e04e667bc5f15ae9863a706beb2848681b8d69cc1194c0bb87014a4c49e2f49d14a4289b1f6436
+  metadata.gz: 4504cb3a564e5b311b65de74bac321b058995af17df47f9f3dc01fcb589a87eebfda55497e0ddb135a2ab15ef1818760652561d434d3f497c0dbd036451934c6
+  data.tar.gz: b83df123a61092ab4041212bb6e4f15b276d5e32e8be8d2b5cbc014988b8cf20ed0e0b3b30595de53ca4c0d599a86112d695009cda13891fe177742aff7d911e

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,24 +1,23 @@
 language: ruby
+os: linux
 rvm:
-  - 2.4
-  - 2.5
   - 2.6
   - 2.7
+  - 3.0
   - ruby-head
-matrix:
+arch:
+  - amd64
+  - arm64
+jobs:
   include:
-    - rvm: 2.5.1
+    - rvm: 2.6
       os: osx
-      osx_image: xcode9.4
-    - rvm: 2.4.0
+      osx_image: xcode11.3
+    - rvm: 2.6
       os: osx
-      osx_image: xcode8.3
-    - rvm: 2.4.0
+      osx_image: xcode12.2
+    - rvm: 2.7
       os: osx
-      osx_image: xcode7.3
-dist: trusty
-sudo: true
-before_install:
-  - gem update --system
-  - gem install bundler -v 1.16.2
+      osx_image: xcode12.2
+dist: xenial
 cache: bundler

data/CHANGELOG

@@ -1,3 +1,92 @@
+- 17-01-2021
+
+- 0.6.2
+
+  - Fix support for compilation on 2.6, llvm compiles
+  - Stability patches to handle rare memory leaks
+  - Corrected re-raising of exceptions to support strings
+  - During early termination of context under certain conditions MiniRacer could crash
+
+
+- 31-12-2021
+
+- 0.6.1
+
+  - Added support for single threaded platform: `MiniRacer::Platform.set_flags! :single_threaded`
+  must be called prior to booting ANY MiniRacer::Context
+
+- 0.6.0
+
+   - Ruby 3.1 support
+   - Fixes memory leak in heap snapshotting
+   - Improved compilation ergonomics in clang
+   - Migrated internal storage in c extension to TypedData
+
+- 11-04-2021
+
+- 0.5.0
+  - Fixes issues on aarch (Apple M1)
+  - Update to use libv8-node 16.x (#210) [Loic Nageleisen]
+  - FEATURE: Configurable max marshal stack depth (#202) [seanmakesgames]
+  - Ruby 2.3 and 2.4 are EOL, we no longer support them
+
+- 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

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/README.md

@@ -85,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
@@ -230,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:
@@ -244,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
 ```
@@ -310,6 +328,16 @@ 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:
@@ -388,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:
 

data/Rakefile

@@ -11,6 +11,7 @@ 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 )
 
 
@@ -91,5 +92,5 @@ task :lint do
               portability-*
               readability-*).join(',')
 
-  sh RbConfig::expand("clang-tidy -checks='#{checks}' ext/mini_racer_extension/mini_racer_extension.cc -- #$INCFLAGS #$CPPFLAGS", conf)
+  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,20 +1,35 @@
 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 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 IS_DARWIN
-$CPPFLAGS += " -std=c++0x"
-$CPPFLAGS += " -fpermissive"
-
-$CPPFLAGS += " -Wno-reserved-user-defined-literal" 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=libc++ ") if IS_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"
@@ -53,11 +68,16 @@ 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 ")
+  $CXXFLAGS.insert(0, " -fsanitize=address ")
   $LDFLAGS.insert(0, " -fsanitize=address ")
 end
 
+# there doesn't seem to be a CPP macro for this in Ruby 2.6:
+if RUBY_ENGINE == 'ruby'
+  $CPPFLAGS += ' -DENGINE_IS_CRUBY '
+end
+
 create_makefile 'mini_racer_extension'