meta_request 0.4.3 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: da748cd9fc506e4b7cc1e68f30865deae9336a86
-  data.tar.gz: 470db6a2e4d06255893feb7a4f56966788d3f6e8
+SHA256:
+  metadata.gz: 40d50e7981aca25dd87449d817b7a6e223491be3cb2155ad3ee82e081afce02f
+  data.tar.gz: 8fa75570b5c5b41b546f71aa883bd9df3bdf9b76e4a6a38f5498aa3af641e0fd
 SHA512:
-  metadata.gz: 05ce90206c87350bb4df4ff803eac40d5a99f5c7d4b62931482989a61f826645d0c88f6eb8491405cb6ff32c2c76a4e860a9cf551bb86be9d69049908b85eddc
-  data.tar.gz: f8fd03350144072577690fa5808791aad5da180d4ed3d7d6eddd058c7af25c82d6939b405084414daad22b49675e19eb7b7d5cf6de69d9372e842e955d611544
+  metadata.gz: 22764f1ec9e723a596e56993c802e541263ce1c7902b88c30902d69701a4b47705c404ce85fd3d2240f5fda7f5d1e85f0512f192647d181e10f30a5f13c6e6a0
+  data.tar.gz: 4c62d0983519f5ae3779759aeba06354e6cb9d4c920feb42f9966be91d0615ca8439c7749109435c3d916f1a40d3718b7c9c5dc99d88b50a04ee44b243b74374

data/README.md

@@ -23,6 +23,36 @@ If you're using [LiveReload](http://livereload.com/) or
 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).
+
+## Docker
+
+Apps runing 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 enviroment variable `SOURCE_PATH`. With docker-compose it can be done like this:
+
+```yaml
+services:
+  app:
+    environment:
+      - SOURCE_PATH=$PWD
+    # ...
+```
+
+## Development
+
+Run all tests:
+
+    docker-compose up
+
 ## Licence
 
 Copyright (c) 2012 Dejan Simic

data/lib/meta_request.rb

@@ -1,20 +1,26 @@
 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.logger
-    @@logger ||= Logger.new(File.join(Rails.root, 'log', 'meta_request.log'))
+  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
+    @rails_root ||= Rails.root.to_s.freeze
   end
 end
 

data/lib/meta_request/app_notifications.rb

@@ -24,34 +24,47 @@ module MetaRequest
         payload[:options][k] = payload.delete(k) unless k.in? CACHE_KEY_COLUMNS
       end
 
-      dev_caller = caller.detect { |c| c.include? MetaRequest.rails_root }
-      if dev_caller
-        c = Callsite.parse(dev_caller)
-        payload.merge!(:line => c.line, :filename => c.filename, :method => c.method)
-      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.new {|*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.new {|*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") do |*args|
-          name, start, ending, transaction_id, payload = args
-          dev_caller = caller.detect { |c| c.include? MetaRequest.rails_root }
-          if dev_caller
-            c = Callsite.parse(dev_caller)
-            payload.merge!(:line => c.line, :filename => c.filename, :method => c.method)
-          end
-          Event.new(name, start, ending, transaction_id, payload)
-        end.
-        subscribe("render_partial.action_view").
-        subscribe("render_template.action_view").
+        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[:format] ||= (payload[:formats]||[]).first # Rails 3.0.x Support
           payload[:status] = '500' if payload[:exception]
           Event.new(name, start, ending, transaction_id, payload)
         end.

data/lib/meta_request/config.rb

@@ -0,0 +1,20 @@
+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
+  end
+end

data/lib/meta_request/event.rb

@@ -7,6 +7,8 @@ module MetaRequest
   # Subclass of ActiveSupport Event that is JSON encodable
   #
   class Event < ActiveSupport::Notifications::Event
+    NOT_JSON_ENCODABLE = 'Not JSON Encodable'.freeze
+
     attr_reader :duration
 
     def initialize(name, start, ending, transaction_id, payload)
@@ -34,11 +36,17 @@ module MetaRequest
     def json_encodable(payload)
       return {} unless payload.is_a?(Hash)
       transform_hash(payload, :deep => true) { |hash, key, value|
+        if value.class.to_s == 'ActionDispatch::Http::Headers'
+          value = value.to_h.select { |k, _| k.upcase == k }
+        elsif defined?(ActiveRecord) && value.is_a?(ActiveRecord::ConnectionAdapters::AbstractAdapter)
+          value = NOT_JSON_ENCODABLE
+        end
+
         begin
           value.to_json(:methods => [:duration])
           new_value = value
         rescue
-          new_value = 'Not JSON Encodable'
+          new_value = NOT_JSON_ENCODABLE
         end
         hash[key] = new_value
       }.with_indifferent_access

data/lib/meta_request/log_interceptor.rb

@@ -1,5 +1,3 @@
-require 'callsite'
-
 module MetaRequest
   module LogInterceptor
 
@@ -33,17 +31,15 @@ module MetaRequest
       super
     end
 
-
     private
     def push_event(level, message)
-      dev_log = AppRequest.current && caller[1].include?(MetaRequest.rails_root)
-      if dev_log
-        c = Callsite.parse(caller[1])
-        payload = {:message => message, :level => level, :line => c.line, :filename => c.filename, :method => c.method}
+      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 Exception => e
-      MetaRequest.logger.fatal(e.message + "\n " + e.backtrace.join("\n "))
+      MetaRequest.config.logger.fatal(e.message + "\n " + e.backtrace.join("\n "))
     end
   end
 end

data/lib/meta_request/middlewares.rb

@@ -3,6 +3,5 @@ module MetaRequest
     autoload :Headers,            "meta_request/middlewares/headers"
     autoload :AppRequestHandler,  "meta_request/middlewares/app_request_handler"
     autoload :MetaRequestHandler, "meta_request/middlewares/meta_request_handler"
-    autoload :RequestId,          "meta_request/middlewares/request_id"
   end
 end

data/lib/meta_request/railtie.rb

@@ -4,7 +4,6 @@ module MetaRequest
   class Railtie < ::Rails::Railtie
 
     initializer 'meta_request.inject_middlewares' do |app|
-      app.middleware.use Middlewares::RequestId unless defined?(ActionDispatch::RequestId)
       app.middleware.use Middlewares::MetaRequestHandler
 
       if defined? ActionDispatch::DebugExceptions

data/lib/meta_request/storage.rb

@@ -9,7 +9,7 @@ module MetaRequest
     def write(value)
       FileUtils.mkdir_p dir_path
       File.open(json_file, 'wb') { |file| file.write(value) }
-      maintain_file_pool(10)
+      maintain_file_pool(MetaRequest.config.storage_pool_size)
     end
 
     def read
@@ -27,7 +27,7 @@ module MetaRequest
     end
 
     def file_ctime(file)
-      File.stat(file).ctime.to_i 
+      File.stat(file).ctime.to_i
     rescue Errno::ENOENT
       0
     end

data/lib/meta_request/utils.rb

@@ -0,0 +1,25 @@
+module MetaRequest
+  module Utils
+    extend self
+
+    def dev_callsite(caller)
+      app_line = caller.detect { |c| c.start_with? MetaRequest.rails_root }
+      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
+  end
+end

data/lib/meta_request/version.rb

@@ -1,3 +1,3 @@
 module MetaRequest
-  VERSION = '0.4.3'
+  VERSION = Gem.loaded_specs["meta_request"].version.to_s
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meta_request
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.7.2
 platform: ruby
 authors:
 - Dejan Simic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2019-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,7 +19,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rack-contrib
   requirement: !ruby/object:Gem::Requirement
@@ -50,26 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: callsite
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.11
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.11
 description: Supporting gem for Rails Panel (Google Chrome extension for Rails development)
 email: desimic@gmail.com
 executables: []
@@ -80,15 +60,16 @@ files:
 - 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/middlewares/request_id.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:
@@ -109,8 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Request your Rails request

data/lib/meta_request/middlewares/request_id.rb

@@ -1,42 +0,0 @@
-require 'securerandom'
-require 'active_support/core_ext/string/access'
-require 'active_support/core_ext/object/blank'
-
-# Backported from Rails 3.2 (ActionDispatch::RequestId)
-module MetaRequest
-  module Middlewares
-    # Makes a unique request id available to the action_dispatch.request_id env variable (which is then accessible through
-    # ActionDispatch::Request#uuid) and sends the same id to the client via the X-Request-Id header.
-    #
-    # The unique request id is either based off the X-Request-Id header in the request, which would typically be generated
-    # by a firewall, load balancer, or the web server, or, if this header is not available, a random uuid. If the
-    # header is accepted from the outside world, we sanitize it to a max of 255 chars and alphanumeric and dashes only.
-    #
-    # The unique request id can be used to trace a request end-to-end and would typically end up being part of log files
-    # from multiple pieces of the stack.
-    class RequestId
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        env["action_dispatch.request_id"] = external_request_id(env) || internal_request_id
-        status, headers, body = @app.call(env)
-
-        headers["X-Request-Id"] = env["action_dispatch.request_id"]
-        [ status, headers, body ]
-      end
-
-      private
-        def external_request_id(env)
-          if request_id = env["HTTP_X_REQUEST_ID"].presence
-            request_id.gsub(/[^\w\-]/, "").first(255)
-          end
-        end
-
-        def internal_request_id
-          SecureRandom.hex(16)
-        end
-    end
-  end
-end