sq_mini_racer 0.2.4.sqreen2 → 0.3.1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e20539790e64f4295e6e1e09a4e1acf6b4220b7c706886fb8411f4aa27318ba
-  data.tar.gz: d8e1504d61888f9fbc486362b497540b4f8d2ecb97e568039dd2ad221d5ff44a
+  metadata.gz: f5a4f1dcba4f3dd9929c02a63a4ca5e123626c670aec78dd1bd99e045b4406ef
+  data.tar.gz: 162ccdbc01829df6b722e885d6242c17764373b66d5610287a7604d6dcf9dbc1
 SHA512:
-  metadata.gz: 80df85cc03fd5ce85da08699bdc9e7d384b0be879c5cce96044a35db5e63e11483b8e60808d3433e6734573458477ac432a7abe347d816ef38049f36818adc25
-  data.tar.gz: cd5d54e082237ee0b06b6d98bff69a9f671a94d8ab827550b691d0edf5c4e4a932a173b1b7b5f4dde9f4cc6b89aafeda8f36f8b70a28bb0ebaac1390f101da40
+  metadata.gz: b3182e0f36469dbc4a2d5a254c879f7bfb51d1dd2abe903284cb9aefaecc8743fdd16408dec1ae58ab61e90b1e19c61152dbc80ed4d9c92f550684469c80e2b9
+  data.tar.gz: ab44723c482430200ffc20a127cc27672020de03a22e1edd84a42212166742dbe006173951bd345a0f76437ab6186cb5078faa7de2b5d6d41d27df8a0c2f3109

data/.dockerignore

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

data/.gitignore

@@ -11,3 +11,12 @@ lib/*.so
 /lib/sq_mini_racer/
 /ext/mini_racer_extension/mini_racer.creator.*
 *.bundle
+/mini_racer.config
+/mini_racer.creator
+/mini_racer.creator.user
+/mini_racer.files
+/mini_racer.includes
+/compile_commands.json
+/.vscode/
+/.clangd/
+/.idea/

data/CHANGELOG

@@ -1,3 +1,91 @@
+- Unreleased
+
+  - FIX: on downgrade mkmf was picking the wrong version of libv8, this fix will correct future issues
+
+- 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

data/Dockerfile

@@ -0,0 +1,22 @@
+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/sqreen/mini_racer/version.rb /code/lib/sqreen/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

@@ -101,6 +101,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
 
@@ -213,12 +234,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:
@@ -256,7 +282,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.
 
@@ -293,6 +319,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:
@@ -350,6 +386,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:
@@ -426,7 +466,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

@@ -1,57 +1,80 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 require "rake/extensiontask"
+require "shellwords"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+class ValgrindTestTask < Rake::TestTask
+  VALGRIND_EXEC = 'valgrind'
+  DEFAULT_VALGRIND_OPTS = %w{
+    --trace-children=yes
+    --partial-loads-ok=yes
+    --error-limit=no
+    --error-exitcode=33
+    --num-callers=100
+    --suppressions=valgrind.supp
+    --gen-suppressions=all
+  }
+
+  attr_accessor :valgrind_args
+
+  def initialize(name=:valgrind_test)
+    @valgrind_args = DEFAULT_VALGRIND_OPTS
+    super
+  end
+
+  # see original def in fileutils.rb
+  def ruby(*args, &block)
+    options = (Hash === args.last) ? args.pop : {}
+    if args.length > 1
+      sh(*([VALGRIND_EXEC] + valgrind_args + [RUBY] + args + [options]), &block)
+    else
+      # if the size is 1 it's assumed the arguments are already escaped
+      non_escaped_args = [VALGRIND_EXEC] + valgrind_args + [RUBY]
+      sh("#{non_escaped_args.map { |s| Shellwords.escape(s) }.join(' ')} #{args.first}", options, &block)
+  end
+  end
 end
 
+test_task_cfg = Proc.new do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  end
+
+Rake::TestTask.new(:test, &test_task_cfg)
+ValgrindTestTask.new(:'test:valgrind', &test_task_cfg)
+
 task :default => [:compile, :test]
 
-gem = Gem::Specification.load( File.dirname(__FILE__) + '/sq_mini_racer.gemspec' )
+gem = Gem::Specification.load( File.dirname(__FILE__) + '/mini_racer.gemspec' )
+Rake::ExtensionTask.new( 'mini_racer_loader', gem ) do |ext|
+  ext.name = 'sq_mini_racer_loader'
+end
 Rake::ExtensionTask.new( 'mini_racer_extension', gem ) do |ext|
   ext.name = 'sq_mini_racer_extension'
 end
-Rake::ExtensionTask.new('prv_ext_loader', gem)
-
-
-# via http://blog.flavorjon.es/2009/06/easily-valgrind-gdb-your-ruby-c.html
-namespace :test do
-  # partial-loads-ok and undef-value-errors necessary to ignore
-  # spurious (and eminently ignorable) warnings from the ruby
-  # interpreter
-  VALGRIND_BASIC_OPTS = "--num-callers=50 --error-limit=no \
-                         --partial-loads-ok=yes --undef-value-errors=no"
-
-  desc "run test suite under valgrind with basic ruby options"
-  task :valgrind => :compile do
-    cmdline = "valgrind #{VALGRIND_BASIC_OPTS} ruby test/test_leak.rb"
-    puts cmdline
-    system cmdline
-  end
 
-  desc "run test suite under valgrind with leak-check=full"
-  task :valgrind_leak_check => :compile do
-    cmdline = "valgrind #{VALGRIND_BASIC_OPTS} --leak-check=full ruby test/test_leak.rb"
-    puts cmdline
-    require 'open3'
-    _, stderr = Open3.capture3(cmdline)
-
-    section = ""
-    stderr.split("\n").each do |line|
-
-      if line =~ /==.*==\s*$/
-        if (section =~ /mini_racer|SUMMARY/)
-          puts
-          puts section
-          puts
-        end
-        section = ""
-      else
-        section << line << "\n"
-      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/azure-pipelines.yml

@@ -0,0 +1,69 @@
+jobs:
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_0
+      displayName: Linux Ruby 2.0
+      rubyVersion: '2.0'
+      publishCoverage: true
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_1
+      displayName: Linux Ruby 2.1
+      rubyVersion: '2.1'
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_2
+      displayName: Linux Ruby 2.2
+      rubyVersion: '2.2'
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_3
+      displayName: Linux Ruby 2.3
+      rubyVersion: '2.3'
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_4
+      displayName: Linux Ruby 2.4
+      rubyVersion: '2.4'
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_5
+      displayName: Linux Ruby 2.5
+      rubyVersion: '2.5'
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_6
+      displayName: Linux Ruby 2.6
+      rubyVersion: '2.6'
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_7
+      displayName: Linux Ruby 2.7
+      rubyVersion: '2.7'
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_7_mini_racer
+      displayName: Linux Ruby 2.7 (with mini_racer)
+      rubyVersion: '2.7'
+      with_mini_racer: true
+
+  - template: azure-template.yml
+    parameters:
+      name: linux_2_7_therubyracer
+      displayName: Linux Ruby 2.7 (with therubyracer)
+      rubyVersion: '2.7'
+      with_therubyracer: true
+
+  - template: azure-template.yml
+    parameters:
+      name: macos_10_14
+      displayName: MacOS 10.14
+      imageName: 'macos-10.14'

data/azure-template.yml

@@ -0,0 +1,101 @@
+parameters:
+  name: ~
+  displayName: ~
+  rubyVersion: bundled
+  imageName: ubuntu-18.04
+  publishCoverage: false
+  with_mini_racer: false
+  with_therubyracer: false
+
+jobs:
+  - job: ${{ parameters.name }}
+    displayName: ${{ parameters.displayName }}
+    pool:
+      vmImage: ${{ parameters.imageName }}
+
+    variables:
+      TESTOPTS: -v
+      ${{ if eq(parameters.publishCoverage, true) }}:
+        CPPFLAGS: --coverage
+        LDFLAGS: --coverage
+      ${{ if eq(parameters.rubyVersion, 'bundled') }}:
+        gem: gem
+        bundle: bundle
+      ${{ if ne(parameters.rubyVersion, 'bundled') }}:
+        gem: /opt/ruby/${{ parameters.rubyVersion }}/bin/gem
+        bundle: /opt/ruby/${{ parameters.rubyVersion }}/bin/bundle
+        GEM_HOME: /opt/ruby/${{ parameters.rubyVersion }}/lib/ruby/gems/${{ parameters.rubyVersion }}.0
+
+    steps:
+      - checkout: self
+        displayName: Checkout
+        clean: true
+        submodules: recursive
+
+      - ${{ if ne(parameters.rubyVersion, 'bundled') }}:
+        - script: |
+            sudo apt-get install -y gnupg
+            sudo apt-key adv --keyserver keyserver.ubuntu.com --recv 5D98E7264E3F3D89463B314B12229434A9F003C9
+            echo deb [arch=amd64] http://sqreen-download-private.s3.amazonaws.com/deb bionic main | sudo tee -a /etc/apt/sources.list
+            sudo apt-get update
+            sudo apt-get install -y sq-ruby${{ parameters.rubyVersion }} ruby-
+          displayName: Install Ruby
+
+      - ${{ if eq(parameters.rubyVersion, 'bundled') }}:
+        - script: sudo $(gem) install bundler --version '< 2.0' --no-document
+          displayName: Install bundler
+
+      - ${{ if eq(parameters.imageName, 'ubuntu-18.04') }}:
+        - script: |
+            sudo apt-get install -y build-essential git curl valgrind g++ make
+          displayName: Install Linux packages
+
+      - script: $(bundle) install --path vendor/bundle
+        displayName: Install gem dependencies
+        env:
+          ${{ if eq(parameters.with_mini_racer, true) }}:
+            LOAD_MINI_RACER: 1
+          ${{ if eq(parameters.with_therubyracer, true) }}:
+            LOAD_THERUBYRACER: 1
+
+      - script: PATH=`dirname $(bundle)`:$PATH CPPFLAGS=$(CPPFLAGS) LDFLAGS=$(LDFLAGS) $(bundle) exec rake compile
+        displayName: Compile extension
+
+      - script: |
+          find . -name '*.log' -exec cat '{}' \;
+        displayName: Print logs
+        condition: failed()
+
+      - script: TESTOPTS=--junit $(bundle) exec rake test
+        displayName: Run tests
+        env:
+          ${{ if eq(parameters.with_mini_racer, true) }}:
+            LOAD_MINI_RACER: 1
+          ${{ if eq(parameters.with_therubyracer, true) }}:
+            LOAD_THERUBYRACER: 1
+
+      - task: PublishTestResults@2
+        displayName: Publish test results
+        condition: succeededOrFailed()
+        inputs:
+          testResultsFormat: 'JUnit'
+          testResultsFiles: '**/report.xml'
+          searchFolder: '$(System.DefaultWorkingDirectory)'
+          mergeTestResults: true
+
+      - ${{ if and(eq(parameters.imageName, 'ubuntu-18.04'), eq(parameters.with_mini_racer, false), eq(parameters.with_therubyracer, false)) }}:
+        - script: $(bundle) exec rake test:valgrind
+          displayName: Run tests w/ valgrind
+
+      - script: |
+          PATH=$PATH:$(dirname $(which $(gem)))
+          $(bundle) exec rake build
+          sudo PATH=$PATH $(gem) install pkg/*.gem
+        displayName: Check that the gem is installable
+
+      - ${{ if eq(parameters.publishCoverage, true) }}:
+          - bash: >
+              test -z "$CODECOV_TOKEN" || bash <(curl -s https://codecov.io/bash)
+            displayName: "Publish coverage (Codecov)"
+            env:
+              CODECOV_TOKEN: $(CODECOV_TOKEN)