rookout 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff23aa23db05a25f0bfa7f20ef0d7969d2b26d1a3480667f6165c95d4530ddc7
-  data.tar.gz: 4e5f6d7b5e9f34aa4cc9cd98c9b73152e7b25f73b49f02ee668d1f676ca8046e
+  metadata.gz: 8e07553e631fcf24cda02a212f87ded60d516f649efe6f610917071e8db7af7e
+  data.tar.gz: 3fecac876939f846a4e98c00956fef5aaba247944e90fb46a03b495316c7759c
 SHA512:
-  metadata.gz: 658f60902cf42a6935b368d96ee466f3f0c2e341bf773961ced22d7a6bf706ccbc64ed91ea52c4bbf3df1a53bfec49f54c5285c99799494b1aca8fcee49c7593
-  data.tar.gz: 641ece8d6554713fa18e1b5c6999cb2b8783cd1e49114bee1ffc4843198cac6f4fca90f3f85a59781485c1d7017ee7047aaaf8c7ed94af0ec78d17d1668e9ba7
+  metadata.gz: fcbc6c8640299f43aaab4cd161200f3454260593839ee8e11c5d593066b65a529410af18ce161e1b5530f8e2d2035c1084998238880314a7ba671ae4d25c09b8
+  data.tar.gz: 8a1d38bae4157be95db520e8195de09938ea25acd5dd8ddbcb1a9b687123c8847e45ff6024ce8920408138986ce34386f010a127dec17e3aa3d615df197142af

data/Rakefile

@@ -0,0 +1,92 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+spec = Gem::Specification.load("rookout.gemspec")
+
+require "rake/testtask"
+desc "Run tests."
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.warning = false
+end
+
+desc "Run the CI build"
+task :ci do
+  header "BUILDING rookout", "#"
+  header "rookout rubocop", "*"
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+  Rake::Task[:rubocop].invoke
+  header "rookout test", "*"
+  Rake::Task[:test].invoke
+end
+
+desc "Set commit hash"
+task :set_commit do
+  header "Setting commit hash in file", "#"
+  write_commit_file read_commit
+  puts "Done!"
+end
+
+desc "Bump gem vesrion"
+task :bump_version do
+  header "Bumpding version", "#"
+
+  version = read_version
+  minor_version = version[0...version.rindex(".")]
+  patch_version = version[version.rindex(".") + 1...version.length]
+  new_patch_version = patch_version.to_i + 1
+  new_version = "#{minor_version}.#{new_patch_version}"
+
+  write_version_file new_version
+
+  puts "Done! New version is #{new_version}"
+end
+
+desc "Print version configuration"
+task :print_version do
+  puts "export ROOK_VERSION=#{read_version}"
+  puts "export ROOK_COMMIT=#{read_commit}"
+end
+
+task :default => :test
+
+def read_version
+  require_relative "lib/rookout/version"
+  Rookout::VERSION
+end
+
+def read_commit
+  `git rev-parse HEAD`.strip
+end
+
+def write_version_file new_version
+  contents = ""
+  contents += "module Rookout\n"
+  contents += "  VERSION = \"#{new_version}\".freeze\n"
+  contents += "end\n"
+
+  f = File.new "lib/rookout/version.rb", "wb"
+  f.write contents
+  f.close
+end
+
+def write_commit_file commit
+  contents = ""
+  contents += "module Rookout\n"
+  contents += "  COMMIT = \"#{commit}\".freeze\n"
+  contents += "end\n"
+
+  f = File.new "lib/rookout/commit.rb", "wb"
+  f.write contents
+  f.close
+end
+
+def header str, token
+  line_length = str.length + 8
+  puts ""
+  puts token * line_length
+  puts "#{token * 3} #{str} #{token * 3}"
+  puts token * line_length
+  puts ""
+end

data/ext/mkrf_conf.rb

@@ -0,0 +1,23 @@
+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"
+    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}"
+rescue
+  exit 1
+end

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/augs/aug.rb

@@ -46,7 +46,8 @@ module Rookout
           "store" => Processor::Namespaces::ContainerNamespace.new,
           "temp" => Processor::Namespaces::ContainerNamespace.new,
           "utils" => Processor::Namespaces::RubyUtilsNamespace.new,
-          "trace" => Processor::Namespaces::NoopNamespace.new
+          "trace" => Processor::Namespaces::NoopNamespace.new,
+          "state" => Processor::Namespaces::NoopNamespace.new
         )
       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/services/position.rb

@@ -18,14 +18,14 @@ module Rookout
       def initialize tracer
         @tracer = tracer
         @augs = {}
-        @iseqs = {}
+        @iseqs = []
         @trace_point = TracePoint.new :script_compiled do |tp|
           begin
             begin
               iseq = tp.instruction_sequence
               # Ignore script without sources
               if iseq.absolute_path
-                @iseqs[tp.path] = iseq
+                @iseqs << iseq
                 evaluate_script iseq
               end
             rescue Exception => e
@@ -83,7 +83,7 @@ module Rookout
 
       def evaluate_all_scripts_to_location location
         positions = []
-        @iseqs.each_value do |iseq|
+        @iseqs.each do |iseq|
           position = evaluate_script_to_location iseq, iseq.absolute_path, location
           next if position.nil?
 

data/lib/rookout/version.rb

@@ -1,3 +1,3 @@
 module Rookout
-  VERSION = "0.1.3".freeze
+  VERSION = "0.1.8".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", "Rakefile", "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.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Liran Haimovitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-08 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,16 @@ email:
 - support@rookout.com
 executables:
 - rookout
-extensions: []
+extensions:
+- ext/mkrf_conf.rb
 extra_rdoc_files: []
 files:
 - LICENSE
+- Rakefile
 - 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 +251,7 @@ files:
 - lib/rookout/user_warnings.rb
 - lib/rookout/utils.rb
 - lib/rookout/version.rb
+- rookout.gemspec
 homepage: https://rookout.com
 licenses:
 - Proprietary