sq_mini_racer 0.2.5.0.2 → 0.3.1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 124526376fa9a93ba73fd7205e15abca399022b37b91f5f6fd994ecadaf63714
-  data.tar.gz: 5a20fb645e0fbf6f8da6b4bdfbda258f29c05e6d9861928a28c2f2b0311bf7f1
+  metadata.gz: f5a4f1dcba4f3dd9929c02a63a4ca5e123626c670aec78dd1bd99e045b4406ef
+  data.tar.gz: 162ccdbc01829df6b722e885d6242c17764373b66d5610287a7604d6dcf9dbc1
 SHA512:
-  metadata.gz: b2cb15116b9cda7b82245dee09f93f02cb4634911ef29d2606d084436b7d0d284b6940d69cbc8fd8dc83bfb865b586c943f0c4e13513b8c66ed2437116aaa340
-  data.tar.gz: f09c7e9b3ad2c3a34514bca93b5f209e1f49a2d8b873a0edf4f1ec0ba55c16dad035809a71364b7da1a817a8677342ed63cbd6a8bd0c4e588db6ee10b3b035af
+  metadata.gz: b3182e0f36469dbc4a2d5a254c879f7bfb51d1dd2abe903284cb9aefaecc8743fdd16408dec1ae58ab61e90b1e19c61152dbc80ed4d9c92f550684469c80e2b9
+  data.tar.gz: ab44723c482430200ffc20a127cc27672020de03a22e1edd84a42212166742dbe006173951bd345a0f76437ab6186cb5078faa7de2b5d6d41d27df8a0c2f3109

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,76 @@
+- 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

data/Dockerfile

@@ -20,4 +20,3 @@ RUN bundle exec rake compile
 
 COPY . /code/
 CMD bundle exec irb -rmini_racer
-

data/README.md

@@ -234,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:
@@ -277,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.
 
@@ -314,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:
@@ -451,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,75 +1,57 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 require "rake/extensiontask"
+require "shellwords"
+
+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
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task :default => [:compile, :test]
-
-gem = Gem::Specification.load( File.dirname(__FILE__) + '/sq_mini_racer.gemspec' )
-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
-  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
+  # 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
-  # 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"
+  end
+end
 
-  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
+test_task_cfg = Proc.new do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
   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)
+Rake::TestTask.new(:test, &test_task_cfg)
+ValgrindTestTask.new(:'test:valgrind', &test_task_cfg)
 
-    section = ""
-    stderr.split("\n").each do |line|
+task :default => [:compile, :test]
 
-      if line =~ /==.*==\s*$/
-        if (section =~ /mini_racer|SUMMARY/)
-          puts
-          puts section
-          puts
-        end
-        section = ""
-      else
-        section << line << "\n"
-      end
-    end
-  end
+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
 
 desc 'run clang-tidy linter on mini_racer_extension.cc'

data/azure-pipelines.yml

@@ -64,6 +64,6 @@ jobs:
 
   - template: azure-template.yml
     parameters:
-      name: macos_10_15
-      displayName: MacOS 10.15
-      imageName: 'macos-10.15'
+      name: macos_10_14
+      displayName: MacOS 10.14
+      imageName: 'macos-10.14'

data/azure-template.yml

@@ -66,7 +66,7 @@ jobs:
         displayName: Print logs
         condition: failed()
 
-      - script: $(bundle) exec rake test
+      - script: TESTOPTS=--junit $(bundle) exec rake test
         displayName: Run tests
         env:
           ${{ if eq(parameters.with_mini_racer, true) }}:
@@ -74,6 +74,15 @@ jobs:
           ${{ 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

data/ext/mini_racer_extension/extconf.rb

@@ -26,58 +26,52 @@ def cppflags_add_cpu_extension!
 end
 
 def libv8_gem_name
-  #return "libv8-solaris" if IS_SOLARIS
-  #return "libv8-alpine" if IS_LINUX_MUSL
-
   'libv8-node'
 end
 
-def libv8_requirement
-  '~> 12.18.4.0.beta1'
+def libv8_version
+  '14.14.0.0.beta2'
 end
 
-def libv8_basename(version)
-  "#{libv8_gem_name}-#{version}-#{ruby_platform}"
+def libv8_basename
+  "#{libv8_gem_name}-#{libv8_version}-#{ruby_platform}"
 end
 
-def libv8_gemspec(version)
-  "#{libv8_basename(version)}.gemspec"
+def libv8_gemspec_no_libc
+  platform_no_libc = ruby_platform.to_s.split('-')[0..1].join('-')
+  "#{libv8_gem_name}-#{libv8_version}-#{platform_no_libc}.gemspec"
 end
 
-def libv8_local_path(path=Gem.path)
-  name_glob = "#{libv8_gem_name}-*-#{ruby_platform}"
-
-  puts "looking for #{name_glob} in #{path.inspect}"
-
-  paths = path.map { |p| Dir.glob(File.join(p, 'specifications', name_glob + '.gemspec')) }.flatten
-
-  if paths.empty?
-    puts "#{name_glob} not found in #{path.inspect}"
-    return
-  end
-
-  specs = paths.map { |p| [p, eval(File.read(p))] }
-               .select { |_, spec| Gem::Requirement.new(libv8_requirement).satisfied_by?(spec.version) }
-  found_path, found_spec = specs.sort_by { |_, spec| spec.version }.last
+def libv8_gemspec
+  "#{libv8_basename}.gemspec"
+end
 
-  unless found_path && found_spec
-    puts "not found in specs: no '#{libv8_requirement}' in #{paths.inspect}"
+def libv8_local_path(path=Gem.path)
+  gemspecs = [libv8_gemspec, libv8_gemspec_no_libc].uniq
+  puts "looking for #{gemspecs.join(', ')} in installed gems"
+  candidates = path.product(gemspecs)
+    .map { |(p, gemspec)| File.join(p, 'specifications', gemspec) }
+  p candidates
+  found = candidates.select { |f| File.exist?(f) }.first
+
+  unless found
+    puts "#{gemspecs.join(', ')} not found in installed gems"
     return
   end
 
-  puts "found in specs: #{found_path}"
+  puts "found in installed specs: #{found}"
 
-  gemdir = File.basename(found_path, '.gemspec')
-  dir = File.expand_path(File.join(found_path, '..', '..', 'gems', gemdir))
+  gemdir = File.basename(found, '.gemspec')
+  dir = File.expand_path(File.join(found, '..', '..', 'gems', gemdir))
 
   unless Dir.exist?(dir)
-    puts "not found in gems: #{dir}"
+    puts "not found in installed gems: #{dir}"
     return
   end
 
-  puts "found in gems: #{dir}"
+  puts "found in installed gems: #{dir}"
 
-  [dir, found_spec]
+  dir
 end
 
 def vendor_path
@@ -85,12 +79,25 @@ def vendor_path
 end
 
 def libv8_vendor_path
-  libv8_local_path([vendor_path])
+  puts "looking for #{libv8_basename} in #{vendor_path}"
+  path = Dir.glob("#{vendor_path}/#{libv8_basename}").first
+
+  unless path
+    puts "#{libv8_basename} not found in #{vendor_path}"
+    return
+  end
+
+  puts "looking for #{libv8_basename}/lib/libv8-node.rb in #{vendor_path}"
+  unless Dir.glob(File.join(vendor_path, libv8_basename, 'lib', 'libv8-node.rb')).first
+    puts "#{libv8_basename}/lib/libv8.rb not found in #{vendor_path}"
+    return
+  end
+
+  path
 end
 
 def parse_platform(str)
   Gem::Platform.new(str).tap do |p|
-    p.instance_eval { @version = 'musl' } if str =~ /-musl/ && p.version.nil?
     p.instance_eval { @cpu = 'x86_64' } if str =~ /universal.*darwin/
   end
 end
@@ -114,23 +121,21 @@ def libv8_remote_search
   json = JSON.parse(body)
 
   versions = json.select do |v|
-    Gem::Requirement.new(libv8_requirement).satisfied_by?(Gem::Version.new(v['number']))
+    Gem::Version.new(v['number']) == Gem::Version.new(libv8_version)
   end
   abort(<<-ERROR) if versions.empty?
-  ERROR: could not find #{libv8_gem_name} (requirement #{libv8_requirement}) in rubygems.org
+  ERROR: could not find #{libv8_gem_name} (version #{libv8_version}) in rubygems.org
   ERROR
 
   platform_versions = versions.select do |v|
     parse_platform(v['platform']) == ruby_platform unless v['platform'] =~ /universal.*darwin/
   end
   abort(<<-ERROR) if platform_versions.empty?
-  ERROR: found gems matching #{libv8_gem_name}:'#{libv8_requirement}', but no binary for #{ruby_platform}
-         try "gem install #{libv8_gem_name}:'#{libv8_requirement}'" to attempt to build #{libv8_gem_name} from source
+  ERROR: found #{libv8_gem_name}-#{libv8_version}, but no binary for #{ruby_platform}
+         try "gem install #{libv8_gem_name} -v '#{libv8_version}'" to attempt to build libv8 from source
   ERROR
 
-  puts "found #{libv8_gem_name} for #{ruby_platform} on rubygems: #{platform_versions.map { |v| v['number'] }.join(', ')}"
-
-  platform_versions.sort_by { |v| Gem::Version.new(v['number']) }.last
+  platform_versions.first
 end
 
 def libv8_download_uri(name, version, platform)
@@ -142,19 +147,19 @@ def libv8_downloaded_gem(name, version, platform)
 end
 
 def libv8_download(name, version, platform)
-  FileUtils.mkdir_p(File.join(vendor_path, 'cache'))
+  FileUtils.mkdir_p(vendor_path)
   body = http_get(libv8_download_uri(name, version, platform))
-  File.open(File.join(vendor_path, 'cache', libv8_downloaded_gem(name, version, platform)), 'wb') { |f| f.write(body) }
+  File.open(File.join(vendor_path, libv8_downloaded_gem(name, version, platform)), 'wb') { |f| f.write(body) }
 end
 
 def libv8_install!
-  cmd = "gem install #{libv8_gem_name} --version '#{libv8_requirement}' --install-dir '#{vendor_path}'"
+  cmd = "gem install #{libv8_gem_name} --version '#{libv8_version}' --install-dir '#{vendor_path}'"
   puts "installing #{libv8_gem_name} using `#{cmd}`"
   rc = system(cmd)
 
   abort(<<-ERROR) unless rc
-  ERROR: could not install #{libv8_gem_name}:#{libv8_requirement}
-          try "gem install #{libv8_gem_name} -v '#{libv8_requirement}'" to attempt to build libv8 from source
+  ERROR: could not install #{libv8_gem_name} #{libv8_version}
+          try "gem install #{libv8_gem_name} -v '#{libv8_version}'" to attempt to build libv8 from source
   ERROR
 
   libv8_local_path([vendor_path])
@@ -168,20 +173,18 @@ def libv8_vendor!
   puts "downloading #{libv8_downloaded_gem(libv8_gem_name, version['number'], version['platform'])} to #{vendor_path}"
   libv8_download(libv8_gem_name, version['number'], version['platform'])
 
-  package = Gem::Package.new(File.join(vendor_path, 'cache', libv8_downloaded_gem(libv8_gem_name, version['number'], version['platform'])))
-  package.extract_files(File.join(vendor_path, 'gems', File.basename(libv8_downloaded_gem(libv8_gem_name, version['number'], version['platform']), '.gem')))
-  FileUtils.mkdir_p(File.join(vendor_path, 'specifications'))
-  File.open(File.join(vendor_path, 'specifications', File.basename(libv8_downloaded_gem(libv8_gem_name, version['number'], version['platform']), '.gem') + '.gemspec'), 'wb') { |f| f.write(package.spec.to_ruby) }
+  package = Gem::Package.new(File.join(vendor_path, libv8_downloaded_gem(libv8_gem_name, version['number'], version['platform'])))
+  package.extract_files(File.join(vendor_path, File.basename(libv8_downloaded_gem(libv8_gem_name, version['number'], version['platform']), '.gem')))
 
   libv8_vendor_path
 end
 
 def ensure_libv8_load_path
-  puts "platform ruby:#{RUBY_PLATFORM} rubygems:#{Gem::Platform.new(RUBY_PLATFORM)} detected:#{ruby_platform}"
+  puts "detected platform #{RUBY_PLATFORM} => #{ruby_platform}"
 
-  libv8_path, spec = libv8_local_path
-  if !ENV['ONLY_INSTALLED_LIBV8_GEM'] && !libv8_path
-    libv8_path, spec = libv8_vendor_path || libv8_vendor!
+  libv8_path = libv8_local_path
+  unless ENV['ONLY_INSTALLED_LIBV8_GEM']
+    libv8_path ||= libv8_vendor_path || libv8_vendor!
   end
 
   abort(<<-ERROR) unless libv8_path
@@ -207,6 +210,8 @@ $CPPFLAGS += " -rdynamic" unless $CPPFLAGS.split.include? "-rdynamic"
 $CPPFLAGS += " -fPIC" unless $CPPFLAGS.split.include? "-rdynamic" or IS_DARWIN
 $CPPFLAGS += " -std=c++0x"
 $CPPFLAGS += " -fpermissive"
+$CPPFLAGS += " -DV8_COMPRESS_POINTERS"
+$CPPFLAGS += " -fvisibility=hidden "
 cppflags_add_frame_pointer!
 cppflags_add_cpu_extension!
 
@@ -214,12 +219,14 @@ $CPPFLAGS += " -Wno-reserved-user-defined-literal" if IS_DARWIN
 
 $LDFLAGS.insert(0, " -stdlib=libc++ ") if IS_DARWIN
 $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
+# 1.9 has no $CXXFLAGS
+$CPPFLAGS += " #{ENV['CPPFLAGS']}" if ENV['CPPFLAGS']
+$LDFLAGS  += " #{ENV['LDFLAGS']}" if ENV['LDFLAGS']
 
 CXX11_TEST = <<EOS
 #if __cplusplus <= 199711L