meta_request 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: affa40bb2090acdad8e66bec42d66410e6fe480230ee84cf3c58e532f307704d
-  data.tar.gz: 6cda72f790a78045c3bb7a650f0be7ca70d655240a9ff0e29df796074f92a22c
+  metadata.gz: 42d633478998c2f18fc5239e8b17f74338cb9a6252d77faf5f37cb5a05c02e8b
+  data.tar.gz: d68155e564411724fb788235da075aa19480dca3bf64cc862fe05d8bdc530cf9
 SHA512:
-  metadata.gz: 1c906f217af701c7cac7a1193416a782c83f84bdd6828c6bd8bda8f5ab3722c9bbfad5d54bd37a4d3f5c6bc598cd30c5e2a3b08653110bcc9dd1f07646bae0ca
-  data.tar.gz: 62c962edb4da8b6eadcab93708ed55f18388825a5632818ba73b64c437a7d8422116b160f1b8d1748bbafde37d09977f0f665ef8b7173cc11aa8007a85b2307f
+  metadata.gz: b1997459c524ed7de84ba6c5da17b35e88402a72e1c34b121649e64bae5d8f4654481021356e746ee692f4a760f7b986c8a0d0b6a2723f62a6c89eff4f7e1f23
+  data.tar.gz: 55c8bfca434ae490505f30041abb3889361b53447d81b54a5e41ffec98444d24e1a9f67cf99cacfa38ce42cf13442db3c1e35fd649bd49f34b355c212fe9efcb

data/README.md

@@ -1,13 +1,10 @@
-RailsPanel
-===========
+# MetaRequest
 
-RailsPanel is a Chrome extension for Rails development that will end your tailing of development.log. Have all information about your Rails app requests in the browser - in the Developer Tools panel. Provides insight to db/rendering/total times, parameter list, rendered views and more.
-
-<img width="640" alt="rails_panel" src="https://github.com/dejan/rails_panel/assets/4494/f41b18b9-444c-419f-93fb-163481f53f82">
+Supporting gem for [Rails Panel (Google Chrome extension for Rails development)](https://github.com/dejan/rails_panel).
 
 ## Installation
 
-To use this extension you need to add meta_request gem to your app's Gemfile:
+Add meta_request gem to development group in Gemfile:
 
 ```ruby
 group :development do
@@ -15,16 +12,46 @@ group :development do
 end
 ```
 
-After this, install RailsPanel extension for [Chrome](https://chrome.google.com/webstore/detail/railspanel/gjpfobpafnhjhbajcjgccbbdofdckggg). This is recommended way of installing the extension, since it will auto-update on every new version.
+## Usage
+
+See [Rails Panel extension](https://github.com/dejan/rails_panel).
+
+## Compatibility Warnings
+
+If you're using [LiveReload](http://livereload.com/) or
+[Rack::LiveReload](https://github.com/johnbintz/rack-livereload) make sure to
+exclude watching your tmp/ folder because meta_request writes a lot of data there
+and your browser will refresh like a madman.
+
+## Configuration
+
+Gem can be configured using block:
+
+```ruby
+MetaRequest.configure do |config|
+  config.storage_pool_size = 30
+end
+```
+
+List of available attributes and defaults can be found in [lib/meta_request/config.rb](lib/meta_request/config.rb).
 
-## Install unpacked version
+## Docker
+
+Apps running in Docker container will have filepaths of the container so links to editor would not work. To fix this, you need to propagate working directory through environment variable `SOURCE_PATH`. With docker-compose it can be done like this:
+
+```yaml
+services:
+  app:
+    environment:
+      - SOURCE_PATH=$PWD
+    # ...
+```
 
-If you have a problem installing extension from Chrome Store or just want to run latest and hack on it, just clone the repo (say under `~/workspace/rails_panel`) and in "Developer mode" Chrome Extensions page select "Load Unpacked extension..." and select `~/workspace/rails_panel/extension`.
+## Development
 
-## Supported environments
+Run all tests:
 
-* Rails 5, 6, 7 and 8
-* Ruby 3
+    docker-compose up
 
 ## Licence
 

data/lib/meta_request/app_notifications.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  class AppNotifications
+    # these are the specific keys in the cache payload that we display in the
+    # panel view
+    CACHE_KEY_COLUMNS = %i[key hit options type].freeze
+
+    # define this here so we can pass it in to all of our cache subscribe calls
+    CACHE_BLOCK = proc { |*args|
+      name, start, ending, transaction_id, payload = args
+
+      # from http://edgeguides.rubyonrails.org/active_support_instrumentation.html#cache-fetch-hit-active-support
+      #
+      # :super_operation  :fetch is added when a read is used with #fetch
+      #
+      # so if :super_operation is present, we'll use it for the type. otherwise
+      # strip (say) 'cache_delete.active_support' down to 'delete'
+      payload[:type] = payload.delete(:super_operation) || name.sub(/cache_(.*?)\..*$/, '\1')
+
+      # anything that isn't in CACHE_KEY_COLUMNS gets shoved into :options
+      # instead
+      payload[:options] = {}
+      payload.keys.each do |k|
+        payload[:options][k] = payload.delete(k) unless k.in? CACHE_KEY_COLUMNS
+      end
+
+      callsite = Utils.dev_callsite(caller)
+      payload.merge!(callsite) if callsite
+
+      Event.new(name, start, ending, transaction_id, payload)
+    }
+
+    # sql processing block - used for sql.active_record and sql.sequel
+
+    # HACK: we hardcode the event name to 'sql.active_record' so that the ui will
+    # display sequel events without modification. otherwise the ui would need to
+    # be modified to support a sequel tab (or to change the display name on the
+    # active_record tab when necessary - which maybe makes more sense?)
+    SQL_EVENT_NAME = 'sql.active_record'
+
+    SQL_BLOCK = proc { |*args|
+      _name, start, ending, transaction_id, payload = args
+      callsite = Utils.dev_callsite(caller)
+      payload.merge!(callsite) if callsite
+
+      Event.new(SQL_EVENT_NAME, start, ending, transaction_id, payload)
+    }
+
+    VIEW_BLOCK = proc { |*args|
+      name, start, ending, transaction_id, payload = args
+      payload[:identifier] = MetaRequest::Utils.sub_source_path(payload[:identifier])
+
+      Event.new(name, start, ending, transaction_id, payload)
+    }
+
+    # Subscribe to all events relevant to RailsPanel
+    #
+    def self.subscribe
+      new
+        .subscribe('meta_request.log')
+        .subscribe('sql.active_record', &SQL_BLOCK)
+        .subscribe('sql.sequel', &SQL_BLOCK)
+        .subscribe('render_partial.action_view', &VIEW_BLOCK)
+        .subscribe('render_template.action_view', &VIEW_BLOCK)
+        .subscribe('process_action.action_controller.exception')
+        .subscribe('process_action.action_controller') do |*args|
+          name, start, ending, transaction_id, payload = args
+          payload[:status] = '500' if payload[:exception]
+          Event.new(name, start, ending, transaction_id, payload)
+        end
+        .subscribe('cache_read.active_support', &CACHE_BLOCK)
+        .subscribe('cache_generate.active_support', &CACHE_BLOCK)
+        .subscribe('cache_fetch_hit.active_support', &CACHE_BLOCK)
+        .subscribe('cache_write.active_support', &CACHE_BLOCK)
+        .subscribe('cache_delete.active_support', &CACHE_BLOCK)
+        .subscribe('cache_exist?.active_support', &CACHE_BLOCK)
+    end
+
+    def subscribe(event_name)
+      ActiveSupport::Notifications.subscribe(event_name) do |*args|
+        event = block_given? ? yield(*args) : Event.new(*args)
+        AppRequest.current.events << event if AppRequest.current
+      end
+      self
+    end
+  end
+end

data/lib/meta_request/app_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  class AppRequest
+    attr_reader :id, :events
+
+    def initialize(id)
+      @id = id
+      @events = []
+    end
+
+    def self.current
+      Thread.current[:meta_request_id]
+    end
+
+    def current!
+      Thread.current[:meta_request_id] = self
+    end
+  end
+end

data/lib/meta_request/config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  class Config
+    attr_writer :logger, :storage_pool_size, :source_path
+
+    # logger used for reporting gem's fatal errors
+    def logger
+      @logger ||= Logger.new(File.join(Rails.root, 'log', 'meta_request.log'))
+    end
+
+    # Number of files kept in storage.
+    # Increase when using an application loading many simultaneous requests.
+    def storage_pool_size
+      @storage_pool_size ||= 20
+    end
+
+    def source_path
+      @source_path ||= ENV['SOURCE_PATH'] || Rails.root.to_s
+    end
+
+    # List of relative paths inside Rails app. Used in Location calculation.
+    def ignored_paths
+      self.ignored_paths = %w[bin vendor] unless @ignored_paths
+      @ignored_paths
+    end
+
+    def ignored_paths=(paths)
+      @ignored_paths = paths.map do |path|
+        Rails.root.join(path).to_s.freeze
+      end.freeze
+    end
+  end
+end

data/lib/meta_request/event.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/cache'
+require 'active_support/json'
+require 'active_support/core_ext'
+
+module MetaRequest
+  # Subclass of ActiveSupport Event that is JSON encodable
+  #
+  class Event < ActiveSupport::Notifications::Event
+    NOT_JSON_ENCODABLE = 'Not JSON Encodable'
+
+    attr_reader :duration
+
+    def initialize(name, start, ending, transaction_id, payload)
+      @name = name
+      super(name, start, ending, transaction_id, json_encodable(payload))
+      @duration = 1000.0 * (ending - start)
+    end
+
+    def self.events_for_exception(exception_wrapper)
+      if defined?(ActionDispatch::ExceptionWrapper)
+        exception = exception_wrapper.exception
+        trace = exception_wrapper.application_trace
+        trace = exception_wrapper.framework_trace if trace.empty?
+      else
+        exception = exception_wrapper
+        trace = exception.backtrace
+      end
+      trace.unshift "#{exception.class} (#{exception.message})"
+      trace.map do |call|
+        Event.new('process_action.action_controller.exception', 0, 0, nil, call: call)
+      end
+    end
+
+    private
+
+    def json_encodable(payload)
+      return {} unless payload.is_a?(Hash)
+
+      transform_hash(sanitize_hash(payload), deep: true) do |hash, key, value|
+        if value.class.to_s == 'ActionDispatch::Http::Headers'
+          value = value.to_h.select { |k, _| k.upcase == k }
+        elsif not_encodable?(value)
+          value = NOT_JSON_ENCODABLE
+        end
+
+        begin
+          value.to_json(methods: [:duration])
+          new_value = value
+        rescue StandardError
+          new_value = NOT_JSON_ENCODABLE
+        end
+        hash[key] = new_value
+      end.with_indifferent_access
+    end
+
+    def sanitize_hash(payload)
+      if @name =~ /\Acache_\w+\.active_support\z/
+        payload[:key] = ActiveSupport::Cache::Store.new.send(:normalize_key, payload[:key])
+      end
+
+      payload.except(:locals)
+    end
+
+    def not_encodable?(value)
+      return true if defined?(ActiveRecord) && value.is_a?(ActiveRecord::ConnectionAdapters::AbstractAdapter)
+      return true if defined?(ActiveRecord) && defined?(ActiveRecord::Transaction) && value.is_a?(ActiveRecord::Transaction)
+      return true if defined?(ActionDispatch) && (value.is_a?(ActionDispatch::Request) || value.is_a?(ActionDispatch::Response))
+      return true if defined?(ActionView) && value.is_a?(ActionView::Helpers::FormBuilder)
+
+      false
+    end
+
+    # https://gist.github.com/dbenhur/1070399
+    def transform_hash(original, options = {}, &block)
+      options[:safe_descent] ||= {}
+      new_hash = {}
+      options[:safe_descent][original.object_id] = new_hash
+      original.each_with_object(new_hash) do |(key, value), result|
+        if options[:deep] && Hash === value
+          value = options[:safe_descent].fetch(value.object_id) do
+            transform_hash(value, options, &block)
+          end
+        end
+        block.call(result, key, value)
+      end
+    end
+  end
+end

data/lib/meta_request/log_interceptor.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  module LogInterceptor
+    def debug(message = nil, *args)
+      push_event(:debug, message)
+      super
+    end
+
+    def info(message = nil, *args)
+      push_event(:info, message)
+      super
+    end
+
+    def warn(message = nil, *args)
+      push_event(:warn, message)
+      super
+    end
+
+    def error(message = nil, *args)
+      push_event(:error, message)
+      super
+    end
+
+    def fatal(message = nil, *args)
+      push_event(:fatal, message)
+      super
+    end
+
+    def unknown(message = nil, *args)
+      push_event(:unknown, message)
+      super
+    end
+
+    private
+
+    def push_event(level, message)
+      callsite = AppRequest.current && Utils.dev_callsite(caller.drop(1))
+      if callsite
+        payload = callsite.merge(message: message, level: level)
+        AppRequest.current.events << Event.new('meta_request.log', 0, 0, 0, payload)
+      end
+    rescue StandardError => e
+      MetaRequest.config.logger.fatal(e.message + "\n " + e.backtrace.join("\n "))
+    end
+  end
+end

data/lib/meta_request/middlewares/app_request_handler.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module MetaRequest
+  module Middlewares
+    class AppRequestHandler
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        app_request = AppRequest.new env['action_dispatch.request_id']
+        app_request.current!
+        @app.call(env)
+      rescue StandardError => e
+        if defined?(ActionDispatch::ExceptionWrapper)
+          wrapper = if ActionDispatch::ExceptionWrapper.method_defined? :env
+                      ActionDispatch::ExceptionWrapper.new(env, e)
+                    else
+                      ActionDispatch::ExceptionWrapper.new(env['action_dispatch.backtrace_cleaner'], e)
+                    end
+          app_request.events.push(*Event.events_for_exception(wrapper))
+        else
+          app_request.events.push(*Event.events_for_exception(e))
+        end
+        raise
+      ensure
+        Storage.new(app_request.id).write(app_request.events.to_json) unless app_request.events.empty?
+      end
+    end
+  end
+end

data/lib/meta_request/middlewares/headers.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rack/contrib/response_headers'
+
+module MetaRequest
+  module Middlewares
+    class Headers
+      def initialize(app, app_config)
+        @app = app
+        @app_config = app_config
+      end
+
+      def call(env)
+        request_path = env['PATH_INFO']
+        middleware = Rack::ResponseHeaders.new(@app) do |headers|
+          headers['X-Meta-Request-Version'] = MetaRequest::VERSION unless skip?(request_path)
+        end
+        middleware.call(env)
+      end
+
+      private
+
+      # returns true if path should be ignored (not handled by RailsPanel extension)
+      #
+      def skip?(path)
+        asset?(path) || path.start_with?('/__better_errors/')
+      end
+
+      def asset?(path)
+        @app_config.respond_to?(:assets) && path.start_with?(assets_prefix)
+      end
+
+      def assets_prefix
+        "/#{@app_config.assets.prefix[%r{\A/?(.*?)/?\z}, 1]}/"
+      end
+    end
+  end
+end

data/lib/meta_request/middlewares/meta_request_handler.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  module Middlewares
+    class MetaRequestHandler
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request_id = env['PATH_INFO'][%r{/__meta_request/(.+)\.json$}, 1]
+        if request_id
+          events_json(request_id)
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def events_json(request_id)
+        events_json = Storage.new(request_id).read
+        [200, { 'Content-Type' => 'text/plain; charset=utf-8' }, [events_json]]
+      end
+    end
+  end
+end

data/lib/meta_request/middlewares.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  module Middlewares
+    autoload :Headers,            'meta_request/middlewares/headers'
+    autoload :AppRequestHandler,  'meta_request/middlewares/app_request_handler'
+    autoload :MetaRequestHandler, 'meta_request/middlewares/meta_request_handler'
+  end
+end

data/lib/meta_request/railtie.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module MetaRequest
+  class Railtie < ::Rails::Railtie
+    initializer 'meta_request.inject_middlewares' do |app|
+      app.middleware.use Middlewares::MetaRequestHandler
+
+      if defined? ActionDispatch::DebugExceptions
+        app.middleware.insert_before ActionDispatch::DebugExceptions, Middlewares::Headers, app.config
+      else
+        app.middleware.use Middlewares::Headers, app.config
+      end
+
+      app.middleware.use Middlewares::AppRequestHandler
+    end
+
+    initializer 'meta_request.log_interceptor' do
+      Rails.logger&.extend(LogInterceptor)
+    end
+
+    initializer 'meta_request.subscribe_to_notifications' do
+      AppNotifications.subscribe
+    end
+  end
+end

data/lib/meta_request/storage.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  class Storage
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def write(value)
+      FileUtils.mkdir_p dir_path
+      File.open(json_file, 'wb') { |file| file.write(value) }
+      maintain_file_pool(MetaRequest.config.storage_pool_size)
+    end
+
+    def read
+      File.read(json_file)
+    end
+
+    private
+
+    def maintain_file_pool(size)
+      files = Dir["#{dir_path}/*.json"]
+      files = files.sort_by { |f| -file_ctime(f) }
+      (files[size..-1] || []).each do |file|
+        FileUtils.rm_f(file)
+      end
+    end
+
+    def file_ctime(file)
+      File.stat(file).ctime.to_i
+    rescue Errno::ENOENT
+      0
+    end
+
+    def json_file
+      File.join(dir_path, "#{key}.json")
+    end
+
+    def dir_path
+      File.join(Rails.root, 'tmp', 'data', 'meta_request')
+    end
+  end
+end

data/lib/meta_request/utils.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  module Utils
+    module_function
+
+    def dev_callsite(caller)
+      app_line = caller.detect { |c| valid_application_path? c }
+      return nil unless app_line
+
+      _, filename, _, line, _, method = app_line.split(/^(.*?)(:(\d+))(:in `(.*)')?$/)
+
+      {
+        filename: sub_source_path(filename),
+        line: line.to_i,
+        method: method
+      }
+    end
+
+    def sub_source_path(path)
+      rails_root = MetaRequest.rails_root
+      source_path = MetaRequest.config.source_path
+      return path if rails_root == source_path
+
+      path.sub(rails_root, source_path)
+    end
+
+    def valid_application_path?(path)
+      path.start_with?(MetaRequest.rails_root) && !ignored_path?(path)
+    end
+
+    def ignored_path?(path)
+      MetaRequest.config.ignored_paths.any? do |ignored_path|
+        path.start_with?(ignored_path.to_s)
+      end
+    end
+  end
+end

data/lib/meta_request/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  VERSION = Gem.loaded_specs['meta_request'].version.to_s
+end

data/lib/meta_request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MetaRequest
+  autoload :VERSION,          'meta_request/version'
+  autoload :Config,           'meta_request/config'
+  autoload :Event,            'meta_request/event'
+  autoload :AppRequest,       'meta_request/app_request'
+  autoload :Storage,          'meta_request/storage'
+  autoload :Middlewares,      'meta_request/middlewares'
+  autoload :LogInterceptor,   'meta_request/log_interceptor'
+  autoload :AppNotifications, 'meta_request/app_notifications'
+  autoload :Utils,            'meta_request/utils'
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield config
+  end
+
+  # stash a frozen copy away so we're not allocating a new string over and over
+  # again in AppNotifications and LogInterceptor
+  def self.rails_root
+    @rails_root ||= Rails.root.to_s.freeze
+  end
+end
+
+require 'meta_request/railtie'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: meta_request
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Dejan Simic
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-contrib
@@ -85,11 +84,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/meta_request.rb
+- lib/meta_request/app_notifications.rb
+- lib/meta_request/app_request.rb
+- lib/meta_request/config.rb
+- lib/meta_request/event.rb
+- lib/meta_request/log_interceptor.rb
+- lib/meta_request/middlewares.rb
+- lib/meta_request/middlewares/app_request_handler.rb
+- lib/meta_request/middlewares/headers.rb
+- lib/meta_request/middlewares/meta_request_handler.rb
+- lib/meta_request/railtie.rb
+- lib/meta_request/storage.rb
+- lib/meta_request/utils.rb
+- lib/meta_request/version.rb
 homepage: https://github.com/dejan/rails_panel/tree/master/meta_request
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
-signing_key: 
+rubygems_version: 4.0.12
 specification_version: 4
 summary: Request your Rails request
 test_files: []