rookout 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a993062399dcf0f6408e5cd2d000227505057a3a2275f71fa9846ba19d428c
-  data.tar.gz: 6c1de8cc013b75819c51bbd0ef9171777805534d78a9d9d35c2a14a8fc8c2b8c
+  metadata.gz: bd5c74f51143ba52e7cda082e0202b1408e90d570f310c36e1669477667931a8
+  data.tar.gz: 0ae53bf98ff8f9c91e159e0e2187a57c4841493874950b43a64731c026fc5d9c
 SHA512:
-  metadata.gz: a11af9b274e600aeb0a8c7625002812a6fcdf039de6090351e019b3627344893475766481858c8cfd102d1bc3e3f468ee86bf4c4bcd90609a2c0bcac40db17bc
-  data.tar.gz: aad7c874a9e5ad677b47c763864fa6ad84794d749d2a087f83d332ede065ac3186192afffc6bfa5c9077c02c6f488c8b9fc59248dfa9c1f1a549e49e45063f6c
+  metadata.gz: 31764b2a5805fdb3063d050c8f20f6b4819132ec432af6e160bcd77fb73a96b1552fede6654a786d2c5f7b67cad3596d85a2ff2150b67fd891c935e313ce0551
+  data.tar.gz: f790ea9db6c948bfc7581f661bb96a6e8300de8b5740e42a9d5d9024a614f2ffc1fc73c7aa04c28e1c48d1593499e6bfbfd0b4ee325da88da5ba05b653784d42

data/ext/mkrf_conf.rb

@@ -0,0 +1,30 @@
+require "rubygems"
+require "rubygems/command.rb"
+require "rubygems/dependency_installer.rb"
+
+# We override platform comparison to only match source gems
+class Gem::Platform
+  def self.match platform
+    platform.nil? || platform == Gem::Platform::RUBY
+  end
+end
+
+inst = Gem::DependencyInstaller.new
+begin
+  puts "[Rookout] installing appropriate google-protobuf gem"
+  if File.exist? "/etc/alpine-release"
+    # Versions from 3.10 onwards don't compile on Alpine
+    installed = inst.install "google-protobuf", [">= 3.0.0", "< 3.10.0"]
+  else
+    installed = inst.install "google-protobuf", ">= 3.0.0"
+  end
+  puts "[Rookout] Installed additional dependencies:"
+  installed.each { |dep| puts dep.name }
+rescue
+  exit 1
+end
+
+# create dummy rakefile to indicate success
+f = File.open(File.join(File.dirname(__FILE__), "Rakefile"), "w")
+f.write("task :default\n")
+f.close

data/lib/rookout/atfork.rb

@@ -0,0 +1,73 @@
+module Rookout
+  class ForkManager
+    require "singleton"
+    include Singleton
+
+    def initialize
+      @active = false
+    end
+
+    def activate!
+      @active = true
+    end
+
+    def disable!
+      @active = false
+    end
+
+    def active?
+      @active
+    end
+
+    def fork_hook original_fork
+      if block_given?
+        original_fork.call do
+          post_fork_child if active?
+          yield
+        end
+      else
+        res = original_fork.call
+        post_fork_child if active? && !res
+        res
+      end
+    end
+
+    def post_fork_child
+      require_relative "rookout_singleton"
+      require_relative "interface"
+
+      RookoutSingleton.instance.post_fork_clean
+      Interface.instance.stop
+      Interface.instance.start post_fork: true
+
+      # Disable fork handler in child process
+      disable!
+    end
+  end
+end
+
+alias _rookout_original_fork fork
+
+def self.fork &block
+  Rookout::ForkManager.instance.fork_hook method(:_rookout_original_fork), &block
+end
+
+def fork &block
+  Rookout::ForkManager.instance.fork_hook method(:_rookout_original_fork), &block
+end
+
+module Kernel
+  alias _rookout_original_fork fork
+
+  def self.fork &block
+    Rookout::ForkManager.instance.fork_hook method(:_rookout_original_fork), &block
+  end
+end
+
+module Process
+  alias _rookout_original_fork fork
+
+  def self.fork &block
+    Rookout::ForkManager.instance.fork_hook method(:_rookout_original_fork), &block
+  end
+end

data/lib/rookout/com_ws/agent_com_ws.rb

@@ -39,7 +39,8 @@ module Rookout
         @info = Information.new labels
         reset_id
 
-        @thread = nil
+        @main_thread = nil
+        @outgoing_thread = nil
         @pending_messages = Queue.new
 
         @running = false
@@ -64,8 +65,17 @@ module Rookout
       def connect
         @running = true
 
-        @thread = Thread.new { connection_thread }
-        @thread.name = "rookout-connection-thread"
+        @main_thread = Thread.new { connection_thread }
+        @main_thread.name = "rookout-connection-thread"
+      end
+
+      def stop
+        @running = false
+
+        # Ask outgoing thread to exit (if running)
+        @pending_messages << ExitMessage.new(@outgoing_thread)
+
+        @main_thread.join
       end
 
       def wait_for_ready
@@ -133,8 +143,8 @@ module Rookout
 
       def connection_pump client
         on_outgoing_exit = proc { client.close }
-        send_thread = Thread.new { outgoing client, on_outgoing_exit }
-        send_thread.name = "rookout-outgoing-thread"
+        @outgoing_thread = Thread.new { outgoing client, on_outgoing_exit }
+        @outgoing_thread.name = "rookout-outgoing-thread"
 
         message_handler = proc do |raw_message|
           envelope = Com::Rookout::Envelope.decode raw_message.pack("c*")
@@ -150,7 +160,8 @@ module Rookout
         Logger.instance.debug "Incoming loop - socket disconnected"
 
         @pending_messages.push ExitMessage.new(send_thread)
-        send_thread.join
+        @outgoing_thread.join
+        @outgoing_thread = nil
       end
 
       def outgoing client, on_exit

data/lib/rookout/exceptions.rb

@@ -105,7 +105,7 @@ module Rookout
     end
 
     class RookInvalidToken < ToolException
-      def initialize token
+      def initialize token = ""
         super "The Rookout token supplied #{token[0..6]} is not valid; please check the token and try again",
               { token: token[0...6] }
       end

data/lib/rookout/interface.rb

@@ -9,6 +9,7 @@ module Rookout
 
     def initialize
       @rook = nil
+      @start_options = nil
     end
 
     def start options = {}
@@ -19,14 +20,20 @@ module Rookout
       begin
         require_relative "rookout_singleton"
 
-        configure_logging options
-        configure_git options
+        # If we are running post fork, use previous start_options
+        if options[:post_fork]
+          # Don't re-enable the fork handler
+          @start_options[:fork] = false
+        else
+          configure_logging options
+          configure_git options
 
-        start_options = configure_start_options options
-        print_config start_options
+          @start_options = configure_start_options options
+          print_config @start_options
+        end
 
         rook = RookoutSingleton.instance
-        rook.connect(**start_options)
+        rook.connect(**@start_options)
       rescue RookMissingToken, RookInvalidToken, RookInvalidOptions, RookVersionNotSupported => e
         raise if throw_errors
         STDERR.puts "[Rookout] Failed to start Rookout: #{e.message}"

data/lib/rookout/processor/namespaces/frame_namespace.rb

@@ -12,6 +12,7 @@ module Rookout
         end
 
         def read_attribute name
+          return RubyObjectNamespace.new @binding.receiver if name == "self"
           raise Exceptions::RookAttributeNotFound, name unless @binding.local_variable_defined? name
           RubyObjectNamespace.new @binding.local_variable_get name
         end

data/lib/rookout/processor/namespaces/ruby_object_serializer.rb

@@ -123,6 +123,7 @@ module Rookout
         end
 
         def dump_string obj, variant, config
+          obj = obj.to_s
           if obj.length > config.max_string
             final_obj = obj[0...config.max_string]
           else

data/lib/rookout/rookout_singleton.rb

@@ -40,9 +40,14 @@ module Rookout
       @services_started = false
     end
 
-    def connect token: nil, host: nil, port: nil, proxy: nil, labels: [], async_start: false, **_
+    def connect token: nil, host: nil, port: nil, proxy: nil, labels: [], async_start: false, fork: false
       raise Exceptions::RookInterfaceException, "Multiple connection attempts not supported!" unless @agent_com.nil?
 
+      if fork
+        require_relative "atfork"
+        Rookout::ForkManager.instance.activate!
+      end
+
       start_trigger_services
 
       Logger.instance.debug "Initiating AgentCom-\t#{host}:#{port}"
@@ -61,6 +66,16 @@ module Rookout
       @output.flush_messages if !@output.nil && !@agent_com.nil?
     end
 
+    def post_fork_clean
+      @agent_com.stop
+      @agent_com = nil
+
+      @command_handler = nil
+
+      # We don't disable services because we will lose all loaded scripts
+      @services.clear_augs
+    end
+
     attr_reader :services
 
     private

data/lib/rookout/version.rb

@@ -1,3 +1,3 @@
 module Rookout
-  VERSION = "0.1.4".freeze
+  VERSION = "0.1.9".freeze
 end

data/rookout.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+require_relative "lib/rookout/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rookout"
+  spec.version       = Rookout::VERSION
+
+  spec.authors       = ["Liran Haimovitch"]
+  spec.email         = ["support@rookout.com"]
+  spec.description   = "rookout is the Ruby SDK for the Rookout Debugging Platform"
+  spec.summary       = "rookout is the Ruby SDK for the Rookout Debugging Platform"
+  spec.homepage      = "https://rookout.com"
+  spec.license       = "Proprietary"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  spec.files         = `git ls-files -- ext/* lib/* bin/*`.split("\n") +
+                      ["lib/rookout/commit.rb", "LICENSE", "rookout.gemspec"]
+  spec.extensions = ["ext/mkrf_conf.rb"]
+  spec.executables = ["rookout"]
+
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.6"
+
+  spec.add_dependency "binding_of_caller", ">= 0.7"
+  spec.add_dependency "concurrent-ruby", ">= 1.1"
+  spec.add_dependency "websocket-driver", ">= 0.5.0"
+  spec.add_dependency "event_emitter", ">= 0.2.6"
+
+  spec.add_development_dependency "google-protobuf", ">= 3.0.0"
+  spec.add_development_dependency "google-style", ">= 1.24.0"
+  spec.add_development_dependency "minitest", ">= 5.14"
+  spec.add_development_dependency "minitest-autotest", ">= 1.0"
+  spec.add_development_dependency "minitest-focus", ">= 1.1"
+  spec.add_development_dependency "minitest-rg", ">= 5.2"
+  spec.add_development_dependency "autotest-suffix", ">= 1.1"
+  spec.add_development_dependency "rake-compiler", ">= 1.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rookout
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Liran Haimovitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: google-protobuf
+  name: event_emitter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 0.2.6
 - !ruby/object:Gem::Dependency
-  name: event_emitter
+  name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.6
-  type: :runtime
+        version: 3.0.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -183,12 +183,15 @@ email:
 - support@rookout.com
 executables:
 - rookout
-extensions: []
+extensions:
+- ext/mkrf_conf.rb
 extra_rdoc_files: []
 files:
 - LICENSE
 - bin/rookout
+- ext/mkrf_conf.rb
 - lib/rookout.rb
+- lib/rookout/atfork.rb
 - lib/rookout/augs/actions/action.rb
 - lib/rookout/augs/actions/action_run_processor.rb
 - lib/rookout/augs/aug.rb
@@ -247,6 +250,7 @@ files:
 - lib/rookout/user_warnings.rb
 - lib/rookout/utils.rb
 - lib/rookout/version.rb
+- rookout.gemspec
 homepage: https://rookout.com
 licenses:
 - Proprietary