mini_racer 0.2.13 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 420c1d474734931c13f1246154eb045600ce24db66c05904c5df19681a03e41b
-  data.tar.gz: 403320470422a7085305e6139cf769cdd5fe7e0df236830038d412ac2558c961
+  metadata.gz: d31e1517a2d52257af3ecd56079e6fcaed4a569ff2256fba4db7c92f922b6cbd
+  data.tar.gz: 777208a006502e94f375e54f43541273b49ecdc7657ac004bec88515b1e620b7
 SHA512:
-  metadata.gz: ef58b7272a5f641f3dc264241414d45cde6d689a34d3433b5a039dc1caeac054c435150a3b5c2532f7957efad083584fe43d4a6c8b21789c542d611c632ae080
-  data.tar.gz: 74b33249d8141b4d869b3c8f74617e40e271c36e472b32950391a061d27069c9b108a29884acf056ce1467c4bc3c22a6f4f84e022df53153cf30ccae387c69f1
+  metadata.gz: c08eecc3edcc923625a8cd6cd87b4c88a4c4f80d64c9c4edee1f68897b595f5cf02927d1d3268f8bdb1d9e81b170c75dfe3875cc1c436fdeed11ebc40759b64c
+  data.tar.gz: 3d82acdd3ec745bc2467e5429c849f1719bf3c711a454b588db9871b36770df64aa37947103eedc553846a04e0e754752d214c208f9f65a6eae1e35686f3068e

data/CHANGELOG

@@ -1,6 +1,14 @@
 - 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

data/README.md

@@ -239,7 +239,7 @@ This can come in handy to force V8 GC runs for example in between requests if yo
 
 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: 1)`. 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.
+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
 

data/lib/mini_racer.rb

@@ -130,23 +130,22 @@ 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 = options[:ensure_gc_after_idle]
+      @ensure_gc_after_idle = ensure_gc_after_idle
 
       if @ensure_gc_after_idle
         @last_eval = nil
@@ -162,7 +161,7 @@ module MiniRacer
       @eval_thread = nil
 
       # defined in the C class
-      init_unsafe(options[:isolate], options[:snapshot])
+      init_unsafe(isolate, snapshot)
     end
 
     def isolate
@@ -290,6 +289,7 @@ module MiniRacer
       @ensure_gc_mutex.synchronize do
         @ensure_gc_thread = nil if !@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 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
@@ -299,7 +299,7 @@ module MiniRacer
               break
             end
 
-            if !@eval_thread && @ensure_gc_after_idle < now - @last_eval
+            if !@eval_thread && ensure_gc_after_idle_seconds < now - @last_eval
               @ensure_gc_mutex.synchronize do
                 isolate_mutex.synchronize do
                   if !@eval_thread
@@ -310,7 +310,7 @@ module MiniRacer
                 end
               end
             end
-            sleep @ensure_gc_after_idle if !done
+            sleep ensure_gc_after_idle_seconds if !done
           end
         end
       end
@@ -369,15 +369,29 @@ module MiniRacer
       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:, snapshot:, max_memory:, ensure_gc_after_idle:, timeout:)
+      assert_option_is_nil_or_a('isolate', isolate, Isolate)
+      assert_option_is_nil_or_a('snapshot', snapshot, Snapshot)
 
-      if options[:isolate] && options[: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 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:)
+      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/mini_racer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniRacer
-  VERSION = "0.2.13"
+  VERSION = "0.2.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_racer
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.14
 platform: ruby
 authors:
 - Sam Saffron
@@ -108,9 +108,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/discourse/mini_racer/issues
-  changelog_uri: https://github.com/discourse/mini_racer/blob/v0.2.13/CHANGELOG
-  documentation_uri: https://www.rubydoc.info/gems/mini_racer/0.2.13
-  source_code_uri: https://github.com/discourse/mini_racer/tree/v0.2.13
+  changelog_uri: https://github.com/discourse/mini_racer/blob/v0.2.14/CHANGELOG
+  documentation_uri: https://www.rubydoc.info/gems/mini_racer/0.2.14
+  source_code_uri: https://github.com/discourse/mini_racer/tree/v0.2.14
 post_install_message: 
 rdoc_options: []
 require_paths: