sqreen 1.18.2-java → 1.19.0-java

data/lib/sqreen/{dependency → graft}/hook_point.rb

@@ -1,12 +1,26 @@
+# typed: false
+
 # Copyright (c) 2015 Sqreen. All Rights Reserved.
 # Please refer to our terms for more information: https://www.sqreen.com/terms.html
 
 require 'sqreen/dependency'
 require 'sqreen/backport/original_name'
+require 'sqreen/graft'
+require 'sqreen/graft/hook_point_error'
 
 module Sqreen
-  module Dependency
-    class HookPointError < StandardError; end
+  module Graft
+    class HookSpot < Module
+      def initialize(key)
+        @key = key
+      end
+
+      attr_reader :key
+
+      def inspect
+        "#<#{self.class.name}: #{@key.inspect}>"
+      end
+    end
 
     class HookPoint
       def self.parse(hook_point)
@@ -22,8 +36,9 @@ module Sqreen
 
       attr_reader :klass_name, :method_kind, :method_name
 
-      def initialize(hook_point)
-        @klass_name, @method_kind, @method_name = Sqreen::Dependency::HookPoint.parse(hook_point)
+      def initialize(hook_point, strategy = :chain)
+        @klass_name, @method_kind, @method_name = Sqreen::Graft::HookPoint.parse(hook_point)
+        @strategy = strategy
       end
 
       def to_s
@@ -34,11 +49,12 @@ module Sqreen
         return false unless Sqreen::Dependency.const_exist?(@klass_name)
 
         if klass_method?
-          (klass.methods + klass.protected_methods + klass.private_methods).include?(@method_name)
+          (klass.singleton_class.public_instance_methods(false) + klass.singleton_class.protected_instance_methods(false) + klass.singleton_class.private_instance_methods(false)).include?(@method_name)
         elsif instance_method?
-          (klass.instance_methods + klass.protected_instance_methods + klass.private_instance_methods).include?(@method_name)
+          (klass.public_instance_methods(false) + klass.protected_instance_methods(false) + klass.private_instance_methods(false)).include?(@method_name)
         else
-          raise HookPointError, 'unknown hook point kind'
+          Sqreen::Graft.logger.error { "[#{Process.pid}] #{self} unknown hook point kind" }
+          raise HookPointError, "#{self} unknown hook point kind"
         end
       end
 
@@ -56,7 +72,8 @@ module Sqreen
         elsif instance_method?
           klass.private_instance_methods.include?(@method_name)
         else
-          raise HookPointError, 'unknown hook point kind'
+          Sqreen::Graft.logger.error { "[#{Process.pid}] #{self} unknown hook point kind" }
+          raise HookPointError, "#{self} unknown hook point kind"
         end
       end
 
@@ -66,7 +83,8 @@ module Sqreen
         elsif instance_method?
           klass.protected_instance_methods.include?(@method_name)
         else
-          raise HookPointError, 'unknown hook point kind'
+          Sqreen::Graft.logger.error { "[#{Process.pid}] #{self} unknown hook point kind" }
+          raise HookPointError, "#{self} unknown hook point kind"
         end
       end
 
@@ -74,58 +92,159 @@ module Sqreen
         @method_kind == :instance_method
       end
 
-      def installed?(suffix)
-        if klass_method?
-          (klass.methods + klass.protected_methods + klass.private_methods).include?(:"#{method_name}_with_#{suffix}")
-        elsif instance_method?
-          (klass.instance_methods + klass.protected_instance_methods + klass.private_instance_methods).include?(:"#{method_name}_with_#{suffix}")
-        else
-          raise HookPointError, 'unknown hook point kind'
+      def installed?(key)
+        case @strategy
+        when :chain then defined(key)
+        when :prepend then prepended?(key) && overridden?(key)
         end
       end
 
+      def super?
+        @strategy == :prepend
+      end
+
       def apply(obj, suffix, *args, &block)
+        raise 'use super' if super?
+
         obj.send("#{method_name}_without_#{suffix}", *args, &block)
       end
 
-      def install(suffix, &block)
-        if installed?(suffix)
-          Sqreen.log.debug "[#{Process.pid}] #{self} already installed"
+      def install(key, &block)
+        if installed?(key)
+          Sqreen::Graft.logger.debug { "[#{Process.pid}] #{self} already installed" }
+          return
         end
         unless exist?
-          Sqreen.log.debug "[#{Process.pid}] #{self} hook point not found"
+          Sqreen::Graft.logger.debug { "[#{Process.pid}] #{self} hook point not found" }
+          return
         end
 
-        define(suffix, &block)
-        enable(suffix)
+        case @strategy
+        when :chain
+          define(key, &block)
+          chain(key)
+        when :prepend
+          prepend(key)
+          override(key, &block)
+        end
       end
 
-      def uninstall(suffix)
-        disable(suffix)
-        remove(suffix)
+      def uninstall(key)
+        unless installed?(key)
+          Sqreen::Graft.logger.debug { "[#{Process.pid}] #{self} not installed" }
+          return
+        end
+        unless exist?
+          Sqreen::Graft.logger.debug { "[#{Process.pid}] #{self} hook point not found" }
+          return
+        end
+
+        case @strategy
+        when :chain
+          disable(key)
+          remove(key)
+        when :prepend
+          unoverride(key) if overridden?(key)
+        end
       end
 
-      def enable(suffix)
-        chain(suffix)
+      def enable(key)
+        case @strategy
+        when :chain
+          chain(key)
+        when :prepend
+          raise HookPointError, "enable called on prepend mode"
+        end
       end
 
-      def disable(suffix)
-        unchain(suffix)
+      def disable(key)
+        case @strategy
+        when :chain
+          unchain(key)
+        when :prepend
+          unoverride(key)
+        end
       end
 
-      def disabled?(suffix)
-        !chained?(suffix)
+      def disabled?(key)
+        case @strategy
+        when :chain
+          !chained?(key)
+        when :prepend
+          !overridden?(key)
+        end
       end
 
       private
 
+      def prepend(key)
+        target = klass_method? ? klass.singleton_class : klass
+        mod = target.ancestors.each { |e| break if e == target; break(e) if e.class == HookSpot && e.key == key }
+        mod ||= HookSpot.new(key)
+        target.instance_eval { prepend(mod) }
+      end
+
+      def prepended?(key)
+        target = klass_method? ? klass.singleton_class : klass
+        mod = target.ancestors.each { |e| break if e == target; break(e) if e.class == HookSpot && e.key == key }
+
+        mod != nil
+      end
+
+      def overridden?(key)
+        target = klass_method? ? klass.singleton_class : klass
+        mod = target.ancestors.each { |e| break if e == target; break(e) if e.class == HookSpot && e.key == key }
+
+        (mod.instance_methods(false) + mod.protected_instance_methods(false) + mod.private_instance_methods(false)).include?(method_name)
+      end
+
+      def override(key, &block)
+        hook_point = self
+        method_name = @method_name
+
+        target = klass_method? ? klass.singleton_class : klass
+        mod = target.ancestors.each { |e| break if e == target; break(e) if e.class == HookSpot && e.key == key }
+
+        mod.instance_eval do
+          if hook_point.private_method?
+            private
+          elsif hook_point.protected_method?
+            protected
+          else
+            public
+          end
+
+          define_method(:"#{method_name}", &block)
+        end
+      end
+
+      def unoverride(key)
+        method_name = @method_name
+
+        target = klass_method? ? klass.singleton_class : klass
+        mod = target.ancestors.each { |e| break if e == target; break(e) if e.class == HookSpot && e.key == key }
+
+        mod.instance_eval { remove_method(method_name) }
+      end
+
+      def defined(suffix)
+        if klass_method?
+          (klass.methods + klass.protected_methods + klass.private_methods).include?(:"#{method_name}_with_#{suffix}")
+        elsif instance_method?
+          (klass.instance_methods + klass.protected_instance_methods + klass.private_instance_methods).include?(:"#{method_name}_with_#{suffix}")
+        else
+          Sqreen::Graft.logger.error { "[#{Process.pid}] #{self} unknown hook point kind" }
+          raise HookPointError, "#{self} unknown hook point kind"
+        end
+      end
+
       def define(suffix, &block)
         hook_point = self
         method_name = @method_name
 
         if klass_method?
           klass.singleton_class.instance_eval do
-            if hook_point.protected_method?
+            if hook_point.private_method?
               private
             elsif hook_point.protected_method?
               protected
@@ -137,7 +256,7 @@ module Sqreen
           end
         elsif instance_method?
           klass.class_eval do
-            if hook_point.protected_method?
+            if hook_point.private_method?
               private
             elsif hook_point.protected_method?
               protected

data/lib/sqreen/graft/hook_point_error.rb

@@ -0,0 +1,10 @@
+# typed: strong
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+module Sqreen
+  module Graft
+    class HookPointError < StandardError; end
+  end
+end

data/lib/sqreen/invalid_signature_exception.rb

@@ -0,0 +1,10 @@
+# typed: strong
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+require 'sqreen/exception'
+
+module Sqreen
+  class InvalidSignatureException < Sqreen::Exception; end
+end

data/lib/sqreen/js.rb

@@ -0,0 +1,11 @@
+# typed: strong
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+# TODO: case JS/Js?
+
+module Sqreen
+  module Js
+  end
+end

data/lib/sqreen/js/call_context.rb

@@ -0,0 +1,12 @@
+# typed: true
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+# TODO: useless?
+
+module Sqreen
+  module Js
+    CallContext = Struct.new(:inst, :args, :rv)
+  end
+end

data/lib/sqreen/js/context_pool.rb

@@ -0,0 +1,62 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+# TODO: => Sqreen::JS:MiniRacer ?
+
+module Sqreen
+  module Js
+    class ContextPool
+      def initialize
+        @mutex = Mutex.new
+        @total_ctxs = 0
+        @contexts = []
+      end
+
+      def with_context(&block)
+        isolate = context
+        begin
+          block[isolate]
+        ensure
+          give_back_context isolate
+        end
+      end
+
+      private
+
+      def context
+        @mutex.synchronize do
+          if @contexts.empty?
+            @total_ctxs += 1
+            Sqreen.log.debug "Creating new V8 context (#{@total_ctxs})"
+            SqreenContext.new
+          else
+            @contexts.pop
+          end
+        end
+      end
+
+      def give_back_context(context)
+        context.possibly_gc
+
+        if context.gc_load > 30
+          if context.gc_threshold_in_bytes == DEFAULT_GC_THRESHOLD
+            context.gc_threshold_in_bytes *= 2
+            Sqreen.log.warn("Context #{context} had too many close garbage " \
+                            'collections; doubling the threshold to ' \
+                            "#{context.gc_threshold_in_bytes} bytes")
+            context.gc_load = 0
+          else
+            Sqreen.log.warn("Context #{context} had too many close garbage " \
+                            'collections; discarding it')
+            context.dispose
+            return
+          end
+        end
+
+        @mutex.synchronize { @contexts.push(context); }
+      end
+    end
+  end
+end

data/lib/sqreen/js/exec_js_runnable.rb

@@ -0,0 +1,22 @@
+# typed: true
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+# TODO: => Sqreen::JS:ExecJS
+
+require 'sqreen/js/executable_js'
+
+module Sqreen
+  module Js
+    class ExecJsRunnable < ExecutableJs
+      def initialize(compiled)
+        @compiled = compiled
+      end
+
+      def run_js_cb(cbname, _budget, arguments)
+        @compiled.call(cbname, *arguments)
+      end
+    end
+  end
+end

data/lib/sqreen/js/execjs_adapter.rb

@@ -1,8 +1,16 @@
+# typed: true
+
 # Copyright (c) 2015 Sqreen. All Rights Reserved.
 # Please refer to our terms for more information: https://www.sqreen.com/terms.html
 
+# TODO: => Sqreen::JS:ExecJS
+
 require 'execjs'
 require 'weakref'
+require 'sqreen/js/executable_js'
+require 'sqreen/js/js_service_adapter'
+require 'sqreen/js/exec_js_runnable'
+require 'sqreen/js/thread_local_exec_js_runnable'
 
 module Sqreen
   module Js
@@ -25,52 +33,5 @@ module Sqreen
         ExecJS.runtime.name != 'therubyrhino (Rhino)'
       end
     end
-
-    class ExecJsRunnable < ExecutableJs
-      def initialize(compiled)
-        @compiled = compiled
-      end
-
-      def run_js_cb(cbname, _budget, arguments)
-        @compiled.call(cbname, *arguments)
-      end
-    end
-
-    class ThreadLocalExecJsRunnable < ExecutableJs
-      def initialize(code)
-        @code = code
-        @tl_key = "SQREEN_EXECJS_CONTEXT_#{object_id}".freeze
-        @runtimes = [] # place where to keep strong references
-        @runtimes_mutex = Mutex.new
-      end
-
-      def run_js_cb(cbname, _budget, arguments)
-        tl_exec_js_runnable.call(cbname, *arguments)
-      end
-
-      def with_runtimes_mutex
-        @runtimes_mutex.synchronize { yield }
-      end
-
-      private
-
-      def dispose_from_dead_threads
-        with_runtimes_mutex do
-          @runtimes.delete_if { |th, _runtime| !th.alive? }
-        end
-      end
-
-      def tl_exec_js_runnable
-        runnable = Thread.current[@tl_key]
-        return runnable if runnable && runnable.weakref_alive?
-
-        dispose_from_dead_threads
-        runtime = ExecJS.compile(@code)
-        with_runtimes_mutex do
-          @runtimes << [Thread.current, runtime]
-        end
-        Thread.current[@tl_key] = WeakRef.new(runtime)
-      end
-    end
   end
 end