sq_mini_racer 0.2.4.sqreen2 → 0.3.1.0.0

data/ext/mini_racer_loader/extconf.rb

@@ -0,0 +1,8 @@
+require 'mkmf'
+
+extension_name = 'sq_mini_racer_loader'
+dir_config extension_name
+
+$CPPFLAGS += " -fvisibility=hidden "
+
+create_makefile extension_name

data/ext/{prv_ext_loader/prv_ext_loader.c → mini_racer_loader/mini_racer_loader.c}

@@ -4,7 +4,11 @@
 #include <stdint.h>
 #include <stdlib.h>
 
-void Init_prv_ext_loader(void);
+// Load a Ruby extension like Ruby does, only with flags that:
+// a) hide symbols from other extensions (RTLD_LOCAL)
+// b) bind symbols tightly (RTLD_DEEPBIND, when available)
+
+void Init_sq_mini_racer_loader(void);
 
 static void *_dln_load(const char *file);
 
@@ -24,6 +28,7 @@ static VALUE _load_shared_lib(VALUE self, volatile VALUE fname)
     return handle ? Qtrue : Qfalse;
 }
 
+// adapted from Ruby's dln.c
 #define INIT_FUNC_PREFIX ((char[]) {'I', 'n', 'i', 't', '_'})
 #define INIT_FUNCNAME(buf, file) do { \
     const char *base = (file); \
@@ -36,6 +41,7 @@ static VALUE _load_shared_lib(VALUE self, volatile VALUE fname)
     *(buf) = tmp; \
 } while(0)
 
+// adapted from Ruby's dln.c
 static size_t _init_funcname(const char **file)
 {
     const char *p = *file,
@@ -55,6 +61,7 @@ static size_t _init_funcname(const char **file)
     return (uintptr_t) ((dot ? dot : p) - base);
 }
 
+// adapted from Ruby's dln.c
 static void *_dln_load(const char *file)
 {
     char *buf;
@@ -108,9 +115,21 @@ failed:
     rb_raise(rb_eLoadError, "%s", error);
 }
 
-void Init_prv_ext_loader()
+__attribute__((visibility("default"))) void Init_sq_mini_racer_loader()
 {
-    VALUE mSqreen = rb_define_module("Sqreen");
-    VALUE mPrvExtLoader = rb_define_module_under(mSqreen, "PrvExtLoader");
-    rb_define_singleton_method(mPrvExtLoader, "load", _load_shared_lib, 1);
+    ID sqreen_id = rb_intern("Sqreen");
+    VALUE mSqreen;
+    if (rb_const_defined(rb_cObject, sqreen_id)) {
+        mSqreen = rb_const_get(rb_cObject, sqreen_id);
+        if (TYPE(mSqreen) != T_MODULE) {
+            rb_raise(rb_eTypeError, "Sqreen is not a module");
+            return;
+        }
+    } else {
+        mSqreen = rb_define_module("Sqreen");
+    }
+
+    VALUE mMiniRacer = rb_define_module_under(mSqreen, "MiniRacer");
+    VALUE mLoader = rb_define_module_under(mMiniRacer, "Loader");
+    rb_define_singleton_method(mLoader, "load", _load_shared_lib, 1);
 }

data/lib/sq_mini_racer.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'sqreen/mini_racer'

data/lib/sqreen/mini_racer.rb

@@ -1,18 +1,18 @@
 require "sqreen/mini_racer/version"
-require "thread"
-require "json"
-require "prv_ext_loader"
+require "sq_mini_racer_loader"
 require "pathname"
 
-module Sqreen
-  name = 'sq_mini_racer_extension.' + RbConfig::CONFIG['DLEXT']
-  shlib = $LOAD_PATH
-    .map { |p| (Pathname.new(p) + name) }
-    .find { |p| p.file? }
+ext_filename = "sq_mini_racer_extension.#{RbConfig::CONFIG['DLEXT']}"
+ext_path = $LOAD_PATH.map { |p| Pathname.new(p) }
+ext_found = ext_path.map { |p| p + ext_filename }.find { |p| p.file? }
 
-  raise LoadError, "could not find #{name}" unless shlib
-  PrvExtLoader.load shlib.to_s
+raise LoadError, "Could not find #{ext_filename} in #{ext_path.map(&:to_s)}" unless ext_found
+Sqreen::MiniRacer::Loader.load(ext_found.to_s)
+
+require "thread"
+require "json"
 
+module Sqreen
 # rubocop:disable IndentationConsistency
 module MiniRacer
 
@@ -141,21 +141,29 @@ module MiniRacer
       end
     end
 
-    def initialize(options = nil)
+    def initialize(max_memory: nil, timeout: nil, isolate: nil, ensure_gc_after_idle: nil, snapshot: nil)
       options ||= {}
 
-      check_init_options!(options)
+      check_init_options!(isolate: isolate, snapshot: snapshot, max_memory: max_memory, ensure_gc_after_idle: ensure_gc_after_idle, timeout: timeout)
 
       @functions = {}
       @timeout = nil
       @max_memory = nil
       @current_exception = nil
-      @timeout = options[:timeout]
-      if options[:max_memory].is_a?(Numeric) && options[:max_memory] > 0
-        @max_memory = options[:max_memory]
-      end
+      @timeout = timeout
+      @max_memory = max_memory
+
       # false signals it should be fetched if requested
-      @isolate = options[:isolate] || false
+      @isolate = isolate || false
+
+      @ensure_gc_after_idle = ensure_gc_after_idle
+
+      if @ensure_gc_after_idle
+        @last_eval = nil
+        @ensure_gc_thread = nil
+        @ensure_gc_mutex = Mutex.new
+      end
+
       @disposed = false
 
       @callback_mutex = Mutex.new
@@ -164,7 +172,7 @@ module MiniRacer
       @eval_thread = nil
 
       # defined in the C class
-      init_unsafe(options[:isolate], options[:snapshot])
+      init_unsafe(isolate, snapshot)
     end
 
     def isolate
@@ -178,6 +186,28 @@ module MiniRacer
       eval(File.read(filename))
     end
 
+    def write_heap_snapshot(file_or_io)
+      f = nil
+      implicit = false
+
+
+      if String === file_or_io
+        f = File.open(file_or_io, "w")
+        implicit = true
+      else
+        f = file_or_io
+      end
+
+      if !(File === f)
+        raise ArgumentError("file_or_io")
+      end
+
+      write_heap_snapshot_unsafe(f)
+
+    ensure
+      f.close if implicit
+    end
+
     def eval(str, options=nil)
       raise(ContextDisposedError, 'attempted to call eval on a disposed context!') if @disposed
 
@@ -192,6 +222,7 @@ module MiniRacer
       end
     ensure
       @eval_thread = nil
+      ensure_gc_thread if @ensure_gc_after_idle
     end
 
     def call(function_name, *arguments)
@@ -205,16 +236,18 @@ module MiniRacer
       end
     ensure
       @eval_thread = nil
+      ensure_gc_thread if @ensure_gc_after_idle
     end
 
     def dispose
       return if @disposed
       isolate_mutex.synchronize do
+        return if @disposed
         dispose_unsafe
-      end
       @disposed = true
       @isolate = nil # allow it to be garbage collected, if set
     end
+    end
 
 
     def attach(name, callback)
@@ -262,6 +295,38 @@ module MiniRacer
 
   private
 
+    def ensure_gc_thread
+      @last_eval = Sqreen::MiniRacer.monotime
+      @ensure_gc_mutex.synchronize do
+        @ensure_gc_thread = nil if !@ensure_gc_thread || !@ensure_gc_thread.alive?
+        @ensure_gc_thread ||= Thread.new do
+          ensure_gc_after_idle_seconds = @ensure_gc_after_idle / 1000.0
+          done = false
+          while !done
+            now = Sqreen::MiniRacer.monotime
+
+            if @disposed
+              @ensure_gc_thread = nil
+              break
+            end
+
+            if !@eval_thread && ensure_gc_after_idle_seconds < now - @last_eval
+              @ensure_gc_mutex.synchronize do
+                isolate_mutex.synchronize do
+                  if !@eval_thread
+                    isolate.low_memory_notification if !@disposed
+                    @ensure_gc_thread = nil
+                    done = true
+                  end
+                end
+              end
+            end
+            sleep ensure_gc_after_idle_seconds if !done
+          end
+        end
+      end
+    end
+
     def stop_attached
       @callback_mutex.synchronize{
         if @callback_running
@@ -302,20 +367,43 @@ module MiniRacer
 
       # ensure we do not leak a thread in state
       t.join
+      t = nil
 
       rval
-
+    ensure
+      # exceptions need to be handled
+      if t && wp
+        wp.write("done")
+        t.join
+      end
+      wp.close if wp
+      rp.close if rp
     end
 
-    def check_init_options!(options)
-      assert_option_is_nil_or_a('isolate', options[:isolate], Isolate)
-      assert_option_is_nil_or_a('snapshot', options[:snapshot], Snapshot)
+    def check_init_options!(isolate: nil, snapshot: nil, max_memory: nil,
+                            ensure_gc_after_idle: nil, timeout: nil)
+      assert_option_is_nil_or_a('isolate', isolate, Isolate)
+      assert_option_is_nil_or_a('snapshot', snapshot, Snapshot)
+
+      assert_numeric_or_nil('max_memory', max_memory, min_value: 10_000)
+      assert_numeric_or_nil('ensure_gc_after_idle', ensure_gc_after_idle, min_value: 1)
+      assert_numeric_or_nil('timeout', timeout, min_value: 1)
 
-      if options[:isolate] && options[:snapshot]
+      if isolate && snapshot
         raise ArgumentError, 'can only pass one of isolate and snapshot options'
       end
     end
 
+    def assert_numeric_or_nil(option_name, object, min_value: nil)
+      if object.is_a?(Numeric) && object < min_value
+        raise ArgumentError, "#{option_name} must be larger than #{min_value}"
+      end
+
+      if !object.nil? && !object.is_a?(Numeric)
+        raise ArgumentError, "#{option_name} must be a number, passed a #{object.inspect}"
+      end
+    end
+
     def assert_option_is_nil_or_a(option_name, object, klass)
       unless object.nil? || object.is_a?(klass)
         raise ArgumentError, "#{option_name} must be a #{klass} object, passed a #{object.inspect}"

data/lib/sqreen/mini_racer/version.rb

@@ -1,7 +1,7 @@
 module Sqreen
 module MiniRacer
-  # part before qualifier is the number of the last upstream release
-  # since we synced with it
-  VERSION = "0.2.4.sqreen2"
+  # first three numbers is the upstream version
+  # that we last merged with
+  VERSION = "0.3.1.0.0"
 end
 end

data/mini_racer.gemspec

@@ -14,21 +14,29 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/sqreen/mini_racer"
   spec.license       = "MIT"
 
-
-  REJECTS            = %r{\A((benchmark|test|spec|features)/|bench\.rb|.+\.sh|Jenkinsfile)}
+  spec.metadata      = {
+    "bug_tracker_uri"   => "https://github.com/discourse/mini_racer/issues",
+    "changelog_uri"     => "https://github.com/discourse/mini_racer/blob/v#{spec.version}/CHANGELOG",
+    "documentation_uri" => "https://www.rubydoc.info/gems/mini_racer/#{spec.version}",
+    "source_code_uri"   => "https://github.com/discourse/mini_racer/tree/v#{spec.version}",
+  } if spec.respond_to?(:metadata=)
+
+  REJECTS            = %r{\A((benchmark|test|spec|features|examples)/|bench\.rb|.+\.sh|Jenkinsfile)}
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(REJECTS) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.0", '< 5.13'
+  spec.add_development_dependency 'minitest-junit', '~> 0.2.0'
+  spec.add_development_dependency "rake-compiler", '< 1.0.3' # avoid https://github.com/rake-compiler/rake-compiler/commit/0dc23504cb03ed2fb3c506e1bb58af48d3851d1e
+  spec.add_development_dependency "m"
 
   spec.require_paths = ["lib", "ext"]
 
-  spec.extensions = ["ext/mini_racer_extension/extconf.rb", "ext/prv_ext_loader/extconf.rb"]
+  spec.extensions = ["ext/mini_racer_loader/extconf.rb", "ext/mini_racer_extension/extconf.rb"]
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 end

data/valgrind.supp

@@ -0,0 +1,74 @@
+{
+   <gc cond>
+   Memcheck:Cond
+   ...
+   fun:gc_*
+   ...
+}
+{
+   <gc_collect cond>
+   Memcheck:Cond
+   ...
+   fun:garbage_collect_*
+   ...
+}
+{
+   <rgeng cond>
+   Memcheck:Cond
+   ...
+   fun:rgengc_*
+   ...
+}
+{
+   <gc value8>
+   Memcheck:Value8
+   ...
+   fun:gc_*
+   ...
+}
+{
+   <rb_gc cond>
+   Memcheck:Cond
+   ...
+   fun:rb_gc_*
+   ...
+}
+{
+   <rb_gc value8>
+   Memcheck:Value8
+   ...
+   fun:rb_gc_*
+   ...
+}
+{
+   <fstr_update_callback cond>
+   Memcheck:Cond
+   fun:fstr_update_callback
+   ...
+}
+{
+   <init_stack>
+   Memcheck:Addr1
+   fun:reserve_stack
+   fun:ruby_init_stack
+   fun:main
+}
+{
+   <unreachable chunk>
+   Memcheck:Cond
+   ...
+   fun:remove_unreachable_chunk
+   ...
+}
+{
+   <fstring_existing_str>
+   Memcheck:Cond
+   fun:fstring_existing_str
+   ...
+}
+{
+   <dsymbol_check>
+   Memcheck:Cond
+   fun:dsymbol_check
+   ...
+}

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sq_mini_racer
 version: !ruby/object:Gem::Version
-  version: 0.2.4.sqreen2
+  version: 0.3.1.0.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +45,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,8 +55,39 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.13'
+- !ruby/object:Gem::Dependency
+  name: minitest-junit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -71,33 +105,42 @@ email:
 - sam.saffron@gmail.com
 executables: []
 extensions:
+- ext/mini_racer_loader/extconf.rb
 - ext/mini_racer_extension/extconf.rb
-- ext/prv_ext_loader/extconf.rb
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- azure-pipelines.yml
+- azure-template.yml
 - bin/console
 - bin/setup
 - ext/mini_racer_extension/compat.hpp
 - ext/mini_racer_extension/extconf.rb
 - ext/mini_racer_extension/mini_racer_extension.cc
 - ext/mini_racer_extension/simdutf8check.h
-- ext/prv_ext_loader/extconf.rb
-- ext/prv_ext_loader/prv_ext_loader.c
+- ext/mini_racer_loader/extconf.rb
+- ext/mini_racer_loader/mini_racer_loader.c
+- lib/sq_mini_racer.rb
 - lib/sqreen/mini_racer.rb
 - lib/sqreen/mini_racer/version.rb
 - mini_racer.gemspec
+- valgrind.supp
 homepage: https://github.com/sqreen/mini_racer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/discourse/mini_racer/issues
+  changelog_uri: https://github.com/discourse/mini_racer/blob/v0.3.1.0.0/CHANGELOG
+  documentation_uri: https://www.rubydoc.info/gems/mini_racer/0.3.1.0.0
+  source_code_uri: https://github.com/discourse/mini_racer/tree/v0.3.1.0.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -107,15 +150,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Minimal embedded v8 for Ruby