rails_watcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8df209f203deec625e15a9826fe1a1a922150501df153d359b2a6f7b807f524
+  data.tar.gz: 4c6dcb7f591660a6c181e833c86081b96bc8264440cde3fc39d3539849570477
+SHA512:
+  metadata.gz: 2fc3665f568e9c19ed8de9b1ddb5c7646095fbf21db7617971e41250ed24197b5a435e1c976f818744e2f2bf65baa1ab32697444d13ba7c0b52299f0f2edfd63
+  data.tar.gz: b495b98b57ce2f8f29b3176b619ae0d8a3db6bfebe7b696140579913d2a831a3cf7fecd0f946f7f596fa491c1eafeb1a395ffd2be02247095eca962828d24d7b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Zhang Kang
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Rails Watcher
+Help you benchmark / analyze / understand your Rails application.
+
+## Usage
+Add `rails_watcher` to your `Gemfile`.
+
+```ruby
+# rails_watcher will slow down your application, suggest only enable on development environment.
+gem 'rails_watcher', require: ENV['RAILS_WATCHER'], group: :development
+```
+
+Start your Rails application with `RAILS_WATCHER`.
+```sh
+$ RAILS_WATCHER=true rails s
+```
+
+Then make some requests to your application, if the response time slow than 10 ms (could be configured), `Rails Watcher` will capture the all details for your request.
+
+By default, `Rails Watcher` will save captured data to `#{Rails.root}/tmp/rails_watcher`.
+
+## View Result
+If you use default configuration of `Rails Watcher`, you could use `rails_watcher_viewer` to view result:
+```sh
+$ gem install -N rails_watcher_viewer
+$ cd application_folder/tmp/rails_watcher
+$ rails_watcher_viewer
+```
+View `localhost:4567`, you could see the list of your requests:
+[!list]()
+You can navigate to details page, the `Expensive methods` table show the slow methods ordered by `net cost`:
+[!detail1]()
+### How to calculate `net cost`
+```ruby
+@a = 1
+def sample_method
+  sleep @a
+  inner_method()
+  @a += 1
+end
+
+def inner_method
+  sleep @a * 3
+end
+
+sample_method() # will take 1 + 3 = 4 seconds
+sample_method() # will take 2 + 6 = 8 seconds
+```
+The net cost of sample_method should be 1 + 2 = 3 seconds, the total cost of sample_method should be 4 + 8 = 12 seconds.
+
+[!detail2]()
+The `Call Stack` section show the call stacks of your application.
+Please notice that, it only show the methods inside your application plus any methods you want to watch, which means the Ruby build-in methods and methods inside any gem will not be captured by default. It is great helpful for trouble shooting.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsWatcher'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/rails_watcher.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'rails_watcher/engine'
+require 'rails_watcher/configuration'
+require 'rails_watcher/const_modifier'
+require 'rails_watcher/call_stack'
+require 'rails_watcher/patches'
+require 'rails_watcher/watcher_middleware'
+
+module RailsWatcher
+
+  autoload :DefaultInstanceHandler, 'rails_watcher/default_instance_handler'
+
+  def self.my_watch_begins
+    Kernel.singleton_class.prepend Patches::KernelLoad
+  end
+end

data/lib/rails_watcher/call_stack.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+module RailsWatcher
+  class CallStack
+    class << self
+      def get_instance
+        Thread.current[:rails_watcher_call_stack_instance]
+      end
+
+      def set_instance request_path
+        Thread.current[:rails_watcher_call_stack_instance] = self.new request_path
+      end
+
+      def clear_instance_and_log duration
+        instance = self.get_instance
+        if duration > RailsWatcher.configuration.request_duration_threshold &&
+            RailsWatcher.configuration.ignored_request_path.all? { |path| path !~ instance.request_path }
+
+          if instance.stack.present?
+            instance.duration = duration
+            handler = RailsWatcher.configuration.instance_handler
+            handler = handler.constantize if handler.is_a? String
+
+            handler.log instance
+          end
+        end
+        Thread.current[:rails_watcher_call_stack_instance] = nil
+      end
+    end
+
+    attr_reader :request_path, :stack, :method_call_table
+    attr_reader :db_query_table, :read_cache_table, :render_stack
+    attr_accessor :duration
+
+    def initialize request_path
+      @request_path = request_path
+      @stack = []
+      @current_stack = []
+      @method_call_table = {}
+      @db_query_table = {}
+      @read_cache_table = {}
+      @render_stack = []
+    end
+
+    # def save
+    #   folder_name = "#{Time.now.strftime("%Y%m%d_%H%M%S")}|#{@duration}|#{@request_path.gsub("/", "\\")}"
+    #   path = File.join(RailsWatcher.configuration.output_path, folder_name)
+    #   FileUtils.mkdir_p path
+    #   %w[stack method_call_table db_query_table read_cache_table render_stack].each do |var|
+    #     filename = File.join path, "#{var}.json"
+    #     File.open(filename, 'w') { |f| f.puts instance_variable_get(:"@#{var}").to_json }
+    #   end
+    # end
+
+    def log_method_call tag, &blk
+      id = SecureRandom.hex(10)
+
+      @method_call_table[id] = { tag: tag, children: [] }
+      parent_method_call = @current_stack.last
+      if parent_method_call
+        @method_call_table[parent_method_call][:children] << id
+      else
+        @stack << id
+      end
+
+      @current_stack.push id
+      duration = Benchmark.ms &blk
+      @method_call_table[id][:duration] = duration
+      @current_stack.delete id
+    end
+
+    def log_render_stack event_type, duration, payload
+      @render_stack << [event_type, duration, payload]
+    end
+
+    def log_db_query duration, payload
+      current_method_call = @current_stack.last
+      @db_query_table[current_method_call] ||= []
+      payload[:duration] = duration
+      @db_query_table[current_method_call] << payload
+    end
+
+    def log_catche_read duration, payload
+      current_method_call = @current_stack.last
+      @read_cache_table[current_method_call] ||= []
+      payload[:duration] = duration
+      @read_cache_table[current_method_call] << payload
+    end
+  end
+end

data/lib/rails_watcher/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module RailsWatcher
+
+  class Configuration
+    attr_accessor *%i[
+      ignored_files
+      ignored_constants
+      ignored_paths
+      ignored_methods
+      ignored_request_path
+      file_constant_mapping
+      request_duration_threshold
+      rails_methods_i_want_to_watch
+      instance_handler
+    ]
+
+    def initialize
+      @ignored_files = []
+      @ignored_constants = []
+      @ignored_paths = []
+      @ignored_methods = {}
+      @file_constant_mapping = {}
+      @ignored_request_path = []
+      @request_duration_threshold = 10 # ms
+      @rails_methods_i_want_to_watch = {}
+      @instance_handler = "RailsWatcher::DefaultInstanceHandler"
+    end
+  end
+
+  def self.configuration
+    @@configuration ||= RailsWatcher::Configuration.new
+    if block_given?
+      yield @@configuration
+    else
+      @@configuration
+    end
+  end
+
+end

data/lib/rails_watcher/const_modifier.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+module RailsWatcher
+  class ConstModifier
+
+    def self.modify const_name, file_path
+      @instance ||= self.new
+      @instance.modify const_name, file_path
+    end
+
+    def modify const_name, file_path
+      const = const_name.constantize rescue return
+      configuration = RailsWatcher.configuration
+
+      ignored_methods = configuration.ignored_methods.with_indifferent_access
+
+      instance_methods_module = Module.new do
+        %w[public private protected].each do |method_type|
+          const.send(:"#{method_type}_instance_methods", false).each do |method_name|
+            source_code_file_path, _line_no = const.instance_method(method_name).source_location
+            next unless source_code_file_path == file_path
+            next if ignored_methods.dig(const_name, method_type)&.include?(method_name)
+            next if ignored_methods["WeirdMethods"]&.include?(method_name)
+
+            define_method method_name do |*args, &blk|
+              call_stack = RailsWatcher::CallStack.get_instance
+              if call_stack
+                ret = nil
+                method_tag = "#{const_name}##{method_name}"
+                call_stack.log_method_call method_tag do
+                  ret = super(*args, &blk)
+                end
+                ret
+              else
+                super(*args, &blk)
+              end
+            end
+            __send__(method_type, method_name)
+          end
+        end       # %w[public private protected].each do |method_type|
+      end         # instance_methods_module = Module.new do
+
+      const.prepend instance_methods_module
+
+      # modifiy class methodes
+      private_class_methods = []
+
+      const.singleton_class.class_eval do
+        %w[public private].each do |method_type|
+          const.send(:"#{method_type}_methods", false).each do |method_name|
+            source_code_file_path, _line_no = const.method(method_name).source_location
+            next unless source_code_file_path == file_path
+            next if ignored_methods.dig(const_name, :"class_#{method_type}")&.include?(method_name)
+            next if ignored_methods["WeirdMethods"]&.include?(method_name)
+
+            aliased_method_name = :"origin_#{method_name}__rails_watcher"
+            alias_method aliased_method_name ,method_name
+
+            define_method method_name do |*args, &blk|
+              call_stack = RailsWatcher::CallStack.get_instance
+              if call_stack
+                ret = nil
+                method_tag = "#{const_name}.#{method_name}"
+                call_stack.log_method_call method_tag do
+                  ret = __send__(aliased_method_name, *args, &blk)
+                end
+                return ret
+              else
+                __send__(aliased_method_name, *args, &blk)
+              end
+            end
+            private_class_methods << method_name if method_type == :private
+
+          end
+        end
+      end
+
+      const.class_eval { private_class_method *private_class_methods } if private_class_methods.present?
+    end
+  end
+
+end

data/lib/rails_watcher/default_instance_handler.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module RailsWatcher
+  module DefaultInstanceHandler
+    def self.log call_stack_instacne
+      # save files in a new thread
+      # so that won't slow down the main thread
+      Thread.new do
+        @output_path ||= File.join(Rails.root, "tmp/rails_watcher")
+        now = Time.now
+        folder_name = "#{now.strftime("%Y%m%d_%H%M%S")}|#{call_stack_instacne.request_path.gsub("/", "_")}"
+
+        path = File.join(@output_path, folder_name)
+        FileUtils.mkdir_p path
+
+        %w[stack method_call_table db_query_table read_cache_table render_stack].each do |var|
+          filename = File.join path, "#{var}.json"
+          File.open(filename, 'w') do |f|
+            f.puts call_stack_instacne.instance_variable_get(:"@#{var}").to_json
+          end
+        end
+
+        summary_file = File.join path, "summary.json"
+        File.open(summary_file, 'w') do |f|
+          summary = {
+            duration:     call_stack_instacne.duration,
+            request_path: call_stack_instacne.request_path,
+            logged_time:  now
+          }
+          f.puts summary.to_json
+        end
+      end
+    end
+  end
+end

data/lib/rails_watcher/engine.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+module RailsWatcher
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsWatcher
+
+    if ENV["RAILS_WATCHER"] == 'true'
+
+      initializer "rails_watcher.middleware" do |app|
+        app.config.app_middleware.use RailsWatcher::WatcherMiddleware
+      end
+
+      initializer "rails_watcher.modify_rails_methods" do
+        ActiveSupport.on_load(:action_controller) do
+          prepend Patches::ActionControllerRender
+        end
+
+        ActiveSupport.on_load(:action_view) do
+          prepend Patches::ActionViewRender
+        end
+      end
+
+      config.after_initialize do
+        RailsWatcher.my_watch_begins
+
+        %w[render_template.action_view render_partial.action_view render_collection.action_view].each do |event_type|
+          ActiveSupport::Notifications.subscribe(event_type) do |*args|
+            call_stack = RailsWatcher::CallStack.get_instance
+            next unless call_stack
+            event = ActiveSupport::Notifications::Event.new *args
+            payload = event.payload
+            payload[:identifier] = payload[:identifier].sub(Rails.root.to_s, "")
+            call_stack.log_render_stack event_type, event.duration, payload
+          end
+        end
+
+        ActiveSupport::Notifications.subscribe('cache_read.active_support') do |*args|
+          call_stack = RailsWatcher::CallStack.get_instance
+          next unless call_stack
+          event = ActiveSupport::Notifications::Event.new *args
+
+          call_stack.log_catche_read event.duration, event.payload
+        end
+
+        ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+          call_stack = RailsWatcher::CallStack.get_instance
+          next unless call_stack
+          event = ActiveSupport::Notifications::Event.new *args
+
+          call_stack.log_db_query event.duration, event.payload
+        end
+
+        RailsWatcher.configuration.rails_methods_i_want_to_watch.each do |component, instance_methods|
+          ActiveSupport.on_load(component) do
+            patch = Module.new do
+              instance_methods.each do |method_name|
+                define_method(method_name) do |*args, &blk|
+                  call_stack = RailsWatcher::CallStack.get_instance
+                  return super(*args, &blk) unless call_stack
+
+                  ret = nil
+                  call_stack.log_method_call("#{component}##{method_name}") do
+                    ret = super(*args, &blk)
+                  end
+                  ret
+                end
+              end
+            end
+            prepend patch
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_watcher/patches.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+module RailsWatcher
+  module Patches
+    module KernelLoad
+      def load filename, wrap=false
+        ret = super
+
+        relative_path = begin
+                          pn = Pathname.new filename
+                          pn.relative_path_from(Rails.root).to_s
+                        end
+
+        if !RailsWatcher.configuration.ignored_files.include?(relative_path) &&
+            !RailsWatcher.configuration.ignored_paths.any? { |ignored_path| relative_path.start_with?(ignored_path) }
+
+          const_name = RailsWatcher.configuration.file_constant_mapping[relative_path] ||
+                            RailsWatcher.guess_const_name(relative_path)
+
+          return ret if RailsWatcher.configuration.ignored_constants.include? const_name
+
+          if (Object.const_defined?(const_name) rescue return ret)
+            ConstModifier.modify const_name, filename
+          elsif Object.const_defined? const_name.upcase
+            ConstModifier.modify const_name.upcase, filename
+          else
+            warn <<~WARNING
+            ============== Rails Watcher Warning ==============
+            Find constant failed:
+            File path:            "#{relative_path}"
+            Guessed const name:   "#{const_name}"
+            ============== Rails Watcher Warning ==============
+            WARNING
+          end
+        end
+
+        ret
+      end
+    end # module KernelLoad
+
+    module ActionControllerRender
+      def render *args
+        call_stack = RailsWatcher::CallStack.get_instance
+        if call_stack
+          ret = nil
+          method_tag = "render"
+          call_stack.log_method_call method_tag do
+            ret = super
+          end
+          ret
+        else
+          super
+        end
+      end
+    end
+
+    module ActionViewRender
+      def render options = {}, locals = {}, &block
+        call_stack = RailsWatcher::CallStack.get_instance
+        if call_stack
+          ret = nil
+          method_tag = "render_partial (#{options.to_s[0, 70]})"
+          call_stack.log_method_call method_tag do
+            ret = super
+          end
+          ret
+        else
+          super
+        end
+      end
+    end
+  end
+
+
+  def self.guess_const_name file_path
+    @@load_paths ||=  (
+                        Rails.application.config.autoload_paths +
+                        Rails.application.config.eager_load_paths
+                      ).map do |autoload_path|
+                        pn = Pathname.new autoload_path
+                        pn.relative_path_from(Rails.root).to_s + "/"
+                      end.to_set
+
+    @@load_paths.reduce(file_path) do |truncated_file_path, load_path|
+      truncated_file_path
+        .sub(/^#{load_path}/, "")
+        .sub(/^concerns/, "")
+        .sub(/\.rb$/, "")
+    end.camelize
+  end
+end

data/lib/rails_watcher/version.rb

@@ -0,0 +1,3 @@
+module RailsWatcher
+  VERSION = '0.1.0'
+end

data/lib/rails_watcher/watcher_middleware.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module RailsWatcher
+  class WatcherMiddleware
+    def initialize app
+      @app = app
+    end
+
+    def call env
+      CallStack.set_instance env["REQUEST_PATH"]
+      status, headers, response = nil, nil, nil
+      duration = Benchmark.ms { status, headers, response = @app.call env }
+      CallStack.clear_instance_and_log duration
+      return status, headers, response
+    end
+  end
+end

data/lib/tasks/configuration.rb.tmp

@@ -0,0 +1,68 @@
+if ENV["RAILS_WATCHER"]
+  RailsWatcher.configuration do |config|
+
+    #
+    # ignored_files : files don't want to watch, default is `[]`
+    #
+    # config.ignored_files = ['app/articles_controller.rb']
+    #
+
+
+    #
+    # ignored_constants: Constants don't want to watch, default is `[]`
+    #
+    # config.ignored_constants = ['ArticlesController']
+    #
+
+
+    #
+    # ignored_paths: Paths don't want to watch, default is `[]`
+    #
+    # config.ignored_constants = ['vendor']
+    #
+
+    #
+    # ignored_methods: Methods don't want to watch, default is `{}`
+    #
+    # config.ignored_methods = {
+    #   "UsersController" => {
+    #     public: %i[method_1, method_2]
+    #   },
+    #   "WeirdMethods" => %i[some_method_in_any_file]
+    # }
+    #
+
+    #
+    # ignored_request_path: Request pathes don't want to watch, default is `[]`
+    #
+    # config.ignored_request_path = []
+    #
+
+
+    #
+    # request_duration_threshold: don't watch request fast then `request_duration_threshold`ms, default is `10` (ms)
+    #
+    # config.request_duration_threshold = 10 # ms
+    #
+
+    #
+    # rails_methods_i_want_to_watch: rails methods want to watch, default is `{}`
+    #                                key: rails component, value: array of methods
+    #
+    # config.rails_methods_i_want_to_watch = {
+    #   action_view: %i[
+    #     javascript_include_tag
+    #     stylesheet_link_tag
+    #     javascript_tag
+    #     content_for
+    #   ]
+    # }
+    #
+
+    #
+    # instance_handler: how to handle result, default is `"RailsWatcher::DefaultInstanceHandler"`, see `rails_watcher/default_instance_handler.rb` for details.
+    #
+    # config.instance_handler = "RailsWatcher::DefaultInstanceHandler"
+    #
+  end
+end

data/lib/tasks/rails_watcher_tasks.rake

@@ -0,0 +1,9 @@
+namespace :rails_watcher do
+  desc "Initialize rails watcher configuration file"
+  task :install do
+    template = File.join(__dir__, 'configuration.rb.tmp')
+    target_file = File.join(Rails.root, "config/initializers/rails_watcher_config.rb")
+    FileUtils.cp template, target_file
+    puts "Done: generated #{target_file}"
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rails_watcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- piecehealth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Help developers to understand, analyze your Rails application.
+email:
+- piecehealth@sina.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails_watcher.rb
+- lib/rails_watcher/call_stack.rb
+- lib/rails_watcher/configuration.rb
+- lib/rails_watcher/const_modifier.rb
+- lib/rails_watcher/default_instance_handler.rb
+- lib/rails_watcher/engine.rb
+- lib/rails_watcher/patches.rb
+- lib/rails_watcher/version.rb
+- lib/rails_watcher/watcher_middleware.rb
+- lib/tasks/configuration.rb.tmp
+- lib/tasks/rails_watcher_tasks.rake
+homepage: https://github.com/piecehealth/rails_watcher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A profiling tool for Rails application.
+test_files: []