gem_footprint_analyzer 0.1.4 → 0.1.5

data/lib/gem_footprint_analyzer.rb

@@ -1,9 +1,15 @@
 require 'gem_footprint_analyzer/version'
 require 'gem_footprint_analyzer/transport'
-require 'gem_footprint_analyzer/require_spy'
+require 'gem_footprint_analyzer/child_process'
 require 'gem_footprint_analyzer/analyzer'
 require 'gem_footprint_analyzer/average_runner'
 require 'gem_footprint_analyzer/cli'
+require 'gem_footprint_analyzer/core_ext/array'
+require 'gem_footprint_analyzer/core_ext/hash'
+require 'gem_footprint_analyzer/core_ext/file'
+require 'gem_footprint_analyzer/formatters/text_base'
+require 'gem_footprint_analyzer/formatters/tree'
+require 'gem_footprint_analyzer/formatters/json'
 
 module GemFootprintAnalyzer
 end

data/lib/gem_footprint_analyzer/analyzer.rb

@@ -1,9 +1,9 @@
 module GemFootprintAnalyzer
   # A class that faciliates sampling of the original require and subsequent require calls from
   # within the library.
-  # It forks the original process and runs the first require in that fork explicitly.
+  # It initializes ChildProcess and uses it to start the require cycle in a controlled environment.
   # Require calls are interwoven with RSS checks done from the parent process, require timing
-  # is gathered in the fork and passed along to the parent.
+  # is gathered in the child process and passed along to the parent.
   class Analyzer
     # @param library [String] name of the library or parameter for the gem method
     #   (ex. 'activerecord', 'activesupport')
@@ -11,16 +11,15 @@ module GemFootprintAnalyzer
     #   (ex. 'active_record', 'active_support/time')
     # @return [Array<Hash>] list of require-data-hashes, first element contains base level RSS,
     #   last element can be treated as a summary as effectively it consists of all the previous.
-    def test_library(library, require_string = nil)
-      try_activate_gem(library)
-
-      child_transport, parent_transport = init_transports
-
-      process_id = fork_and_require(require_string || library, child_transport)
-      fail 'Unable to fork' unless process_id
+    def initialize(fifos)
+      @fifos = fifos
+    end
 
-      detach_process(process_id)
-      requires = collect_requires(parent_transport, process_id)
+    def test_library(library, require_string = nil)
+      child = ChildProcess.new(library, require_string, fifos)
+      child.start_child
+      parent_transport = init_transport
+      requires = collect_requires(parent_transport, child.pid)
 
       parent_transport.ack
       requires
@@ -28,22 +27,7 @@ module GemFootprintAnalyzer
 
     private
 
-    def fork_and_require(require_string, child_transport)
-      fork do
-        RequireSpy.spy_require(child_transport)
-        begin
-          require(require_string)
-        rescue LoadError => e
-          child_transport.exit_with_error(e)
-          exit
-        end
-        child_transport.done_and_wait_for_ack
-      end
-    end
-
-    def detach_process(pid)
-      Process.detach(pid)
-    end
+    attr_reader :fifos
 
     def collect_requires(transport, process_id)
       requires_context = {base_rss: nil, requires: [], process_id: process_id, transport: transport}
@@ -89,30 +73,15 @@ module GemFootprintAnalyzer
       context[:requires] << {base: true, rss: context[:base_rss]}
     end
 
-    def try_activate_gem(library)
-      return unless Kernel.respond_to?(:gem)
-
-      gem(library)
-    rescue Gem::LoadError
-      nil
-    end
-
-    def pkill(process_id)
-      Process.kill('TERM', process_id)
-    end
-
     def rss(process_id)
       `ps -o rss -p #{process_id}`.split.last.strip.to_i
     end
 
-    def init_transports
-      child_reader, parent_writer = IO.pipe
-      parent_reader, child_writer = IO.pipe
-
-      child_transport = GemFootprintAnalyzer::Transport.new(child_reader, child_writer)
-      parent_transport = GemFootprintAnalyzer::Transport.new(parent_reader, parent_writer)
+    def init_transport
+      reader = File.open(fifos[:child], 'r')
+      writer = File.open(fifos[:parent], 'w')
 
-      [child_transport, parent_transport]
+      Transport.new(read_stream: reader, write_stream: writer)
     end
   end
 end

data/lib/gem_footprint_analyzer/child_context.rb

@@ -0,0 +1,58 @@
+require_relative 'require_spy'
+require_relative 'transport'
+
+module GemFootprintAnalyzer
+  # A class that is loaded by the child process to faciliate require tracing.
+  # When `start_child_context` env is passed, it is instantiated and start is called automatically
+  # on require.
+  class ChildContext
+    PARENT_FIFO = '/tmp/parent'.freeze
+    CHILD_FIFO = '/tmp/child'.freeze
+
+    def initialize
+      output Process.pid
+      init_transport
+    end
+
+    # Installs the require-spying code and starts requiring
+    def start
+      RequireSpy.spy_require(transport)
+      begin
+        require(require_string)
+      rescue LoadError => e
+        transport.exit_with_error(e)
+      end
+      transport.done_and_wait_for_ack
+    end
+
+    private
+
+    attr_reader :transport
+
+    def child_fifo
+      ENV['child_fifo']
+    end
+
+    def parent_fifo
+      ENV['parent_fifo']
+    end
+
+    def require_string
+      ENV['require_string']
+    end
+
+    def init_transport
+      write_stream = File.open(child_fifo, 'w')
+      read_stream = File.open(parent_fifo, 'r')
+
+      @transport = Transport.new(read_stream: read_stream, write_stream: write_stream)
+    end
+
+    def output(message)
+      STDOUT.puts(message)
+      STDOUT.flush
+    end
+  end
+end
+
+GemFootprintAnalyzer::ChildContext.new.start if ENV['start_child_context']

data/lib/gem_footprint_analyzer/child_process.rb

@@ -0,0 +1,55 @@
+require 'open3'
+require 'rbconfig'
+
+module GemFootprintAnalyzer
+  # A class for starting the child process that does actual requires.
+  class ChildProcess
+    RUBY_CMD = [RbConfig.ruby, '--disable=did_you_mean', '--disable=gem'].freeze
+
+    def initialize(library, require_string, fifos)
+      @library = library
+      @require_string = require_string || library
+      @fifos = fifos
+      @pid = nil
+    end
+
+    def start_child
+      @child_thread ||= Thread.new do # rubocop:disable Naming/MemoizedInstanceVariableName
+        Open3.popen3(child_env_vars, *RUBY_CMD, context_file) do |_, stdout, stderr|
+          @pid = stdout.gets.strip.to_i
+
+          while (line = stderr.gets)
+            puts "!! #{line.strip}"
+          end
+        end
+      end
+    end
+
+    def pid
+      return unless child_thread
+
+      sleep 0.01 while @pid.nil?
+
+      @pid
+    end
+
+    private
+
+    attr_reader :require_string, :child_thread, :fifos
+
+    def child_env_vars
+      {
+        'require_string' => require_string,
+        'start_child_context' => 'true',
+        'child_fifo' => fifos[:child],
+        'parent_fifo' => fifos[:parent],
+        'RUBYOPT' => '', # Stop bundler from requiring bundler/setup
+        'RUBYLIB' => $LOAD_PATH.join(':') # Include bundler-provided paths and paths passed by user
+      }
+    end
+
+    def context_file
+      File.join(__dir__, 'child_context.rb')
+    end
+  end
+end

data/lib/gem_footprint_analyzer/cli.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'tmpdir'
 
 module GemFootprintAnalyzer
   # A command line interface class for the gem.
@@ -9,7 +10,8 @@ module GemFootprintAnalyzer
       @options[:runs] = 10
       @options[:debug] = false
       @options[:formatter] = 'tree'
-      @options[:skip_rubygems] = false
+
+      try_require_bundler
     end
 
     # @param args [Array<String>] runs the analyzer with parsed args taken as options
@@ -21,7 +23,6 @@ module GemFootprintAnalyzer
         puts opts_parser
         exit 1
       end
-      require 'rubygems' unless options[:skip_rubygems]
 
       print_requires(options, args)
     end
@@ -39,15 +40,31 @@ module GemFootprintAnalyzer
 
     def capture_requires(options, args)
       GemFootprintAnalyzer::AverageRunner.new(options[:runs]) do
-        GemFootprintAnalyzer::Analyzer.new.test_library(*args)
+        fifos = init_fifos
+
+        GemFootprintAnalyzer::Analyzer.new(fifos).test_library(*args).tap do
+          clean_up_fifos(fifos)
+        end
       end.run
     end
 
-    def formatter_instance(options)
-      require 'gem_footprint_analyzer/formatters/text_base'
-      require 'gem_footprint_analyzer/formatters/tree'
-      require 'gem_footprint_analyzer/formatters/json'
+    def init_fifos
+      dir = Dir.mktmpdir
+      parent_name = File.join(dir, 'parent.fifo')
+      child_name = File.join(dir, 'child.fifo')
+
+      File.mkfifo(parent_name)
+      File.mkfifo(child_name)
+
+      {parent: parent_name, child: child_name}
+    end
+
+    def clean_up_fifos(fifos)
+      fifos.each { |_, name| File.unlink(name) if File.exist?(name) }
+      Dir.unlink(File.dirname(fifos[:parent]))
+    end
 
+    def formatter_instance(options)
       GemFootprintAnalyzer::Formatters.const_get(options[:formatter].capitalize)
     end
 
@@ -72,14 +89,6 @@ module GemFootprintAnalyzer
           options[:debug] = debug
         end
 
-        opts.on(
-          '-g', '--disable-gems',
-          'Don\'t require rubygems (recommended for standard library analyses)'
-        ) do |skip_rubygems|
-
-          options[:skip_rubygems] = skip_rubygems
-        end
-
         opts.on_tail('-h', '--help', 'Show this message') do
           puts opts
           exit
@@ -100,7 +109,19 @@ module GemFootprintAnalyzer
 
     def clean_up
       fork_waiters = Thread.list.select { |th| th.is_a?(Process::Waiter) }
-      fork_waiters.each { |waiter| Process.kill('TERM', waiter.pid) }
+      fork_waiters.each do |waiter|
+        begin
+          Process.kill('TERM', waiter.pid)
+        rescue Errno::ESRCH
+          nil
+        end
+      end
+    end
+
+    def try_require_bundler
+      require 'bundler/setup'
+    rescue LoadError
+      nil
     end
   end
 end

data/lib/gem_footprint_analyzer/core_ext/array.rb

@@ -0,0 +1,16 @@
+module GemFootprintAnalyzer
+  module CoreExt
+    # Provides Array#sum, missing in Ruby 2.2.0
+    module Array
+      def sum(init = 0, &block)
+        if block
+          reduce(init) { |acc, el| acc + yield(el) }
+        else
+          reduce(init) { |acc, el| acc + el }
+        end
+      end
+    end
+  end
+end
+
+Array.include(GemFootprintAnalyzer::CoreExt::Array) unless [].respond_to?(:sum)

data/lib/gem_footprint_analyzer/core_ext/file.rb

@@ -0,0 +1,11 @@
+module GemFootprintAnalyzer
+  module CoreExt
+    # Provides File#mkfifo, missing in Ruby 2.2.0
+    module File
+      def mkfifo(name)
+        system("mkfifo #{name}")
+      end
+    end
+  end
+end
+File.extend(GemFootprintAnalyzer::CoreExt::File) unless File.respond_to?(:mkfifo)

data/lib/gem_footprint_analyzer/core_ext/hash.rb

@@ -0,0 +1,18 @@
+module GemFootprintAnalyzer
+  module CoreExt
+    # Provides Hash#dig, missing in Ruby 2.2.0
+    module Hash
+      def dig(*keys)
+        value = self
+        keys.each do |key|
+          return nil if !value.respond_to?(:key) || !value.key?(key)
+
+          value = value[key]
+        end
+        value
+      end
+    end
+  end
+end
+
+Hash.include(GemFootprintAnalyzer::CoreExt::Hash) unless {}.respond_to?(:dig)

data/lib/gem_footprint_analyzer/transport.rb

@@ -4,7 +4,7 @@ module GemFootprintAnalyzer
   class Transport
     # @param read_stream [IO] stream that will be used to read from by this {Transport} instance
     # @param write_stream [IO] stream that will be used to write to by this {Transport} instance
-    def initialize(read_stream, write_stream)
+    def initialize(read_stream:, write_stream:)
       @read_stream = read_stream
       @write_stream = write_stream
     end
@@ -33,7 +33,7 @@ module GemFootprintAnalyzer
 
     # Sends a done command and blocks until ack command is received
     def done_and_wait_for_ack
-      @write_stream.puts 'done'
+      write_raw_command 'done'
       while (cmd = read_one_command)
         msg, = cmd
         break if msg == :ack
@@ -42,38 +42,43 @@ module GemFootprintAnalyzer
 
     # Sends a ready command
     def ready
-      @write_stream.puts 'ready'
+      write_raw_command 'ready'
     end
 
     # Sends a start command
     def start
-      @write_stream.puts 'start'
+      write_raw_command 'start'
     end
 
     # Sends an ack command
     def ack
-      @write_stream.puts 'ack'
+      write_raw_command 'ack'
     end
 
     # @param library [String] Name of the library that was required
     # @param source [String] Name of the source file that required the library
     # @param duration [Float] Time which it took to complete the require
     def report_require(library, source, duration)
-      @write_stream.puts "rq: #{library.inspect},#{source.inspect},#{duration.inspect}"
+      write_raw_command "rq: #{library.inspect},#{source.inspect},#{duration.inspect}"
     end
 
     # @param library [String] Name of the library that was required, but was already required before
     def report_already_required(library)
-      @write_stream.puts "arq: #{library.inspect}"
+      write_raw_command "arq: #{library.inspect}"
     end
 
     # @param error [Exception] Exception object that should halt the program
     def exit_with_error(error)
-      @write_stream.puts "exit: #{error.to_s.inspect}"
+      write_raw_command "exit: #{error.to_s.inspect}"
     end
 
     private
 
+    def write_raw_command(command)
+      @write_stream.puts(command)
+      @write_stream.flush
+    end
+
     def read_raw_command
       @read_stream.gets.strip
     end

data/lib/gem_footprint_analyzer/version.rb

@@ -1,3 +1,3 @@
 module GemFootprintAnalyzer
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_footprint_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Maciek Dubiński
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-28 00:00:00.000000000 Z
+date: 2018-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,7 +104,12 @@ files:
 - lib/gem_footprint_analyzer.rb
 - lib/gem_footprint_analyzer/analyzer.rb
 - lib/gem_footprint_analyzer/average_runner.rb
+- lib/gem_footprint_analyzer/child_context.rb
+- lib/gem_footprint_analyzer/child_process.rb
 - lib/gem_footprint_analyzer/cli.rb
+- lib/gem_footprint_analyzer/core_ext/array.rb
+- lib/gem_footprint_analyzer/core_ext/file.rb
+- lib/gem_footprint_analyzer/core_ext/hash.rb
 - lib/gem_footprint_analyzer/formatters/json.rb
 - lib/gem_footprint_analyzer/formatters/text_base.rb
 - lib/gem_footprint_analyzer/formatters/tree.rb