meta_request 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 685c2846348d63d6afcda0e5b9ac26862830d471
+  data.tar.gz: 7bcf29fded9fba0b8a87c4bd06b5c7c1ca955560
+SHA512:
+  metadata.gz: 6f56ed8974498e5aae4fcf4b96cac36f34524c9e9e1e8f60ce901cbe847aacc75e3db95444627b574b547316200ae9f1e8e75fb1523ad3dc0146bcef42c9f119
+  data.tar.gz: 26336064cfd832cbc3ba5b522d7e0daec80fcf39162bc6f07f1464c181cd0e71dcf933d59a56681f29a1550e260a2b54cafae9ad12ab82b416ee66c6f4a128f4

data/README.md

@@ -0,0 +1,49 @@
+# MetaRequest
+
+Supporting gem for [Rails Panel (Google Chrome extension for Rails development)](https://github.com/dejan/rails_panel).
+
+## Installation
+
+Add meta_request gem to development group in Gemfile:
+
+```ruby
+group :development do
+  gem 'meta_request'
+end
+```
+
+## 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.
+
+## Licence
+
+Copyright (c) 2012 Dejan Simic
+
+MIT License
+
+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/lib/meta_request/app_notifications.rb

@@ -0,0 +1,76 @@
+module MetaRequest
+  class AppNotifications
+
+    # these are the specific keys in the cache payload that we display in the
+    # panel view
+    CACHE_KEY_COLUMNS = [:key, :hit, :options, :type]
+
+    # define this here so we can pass it in to all of our cache subscribe calls
+    CACHE_BLOCK = Proc.new {|*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
+
+      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)
+    }
+    # 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("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.
+        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,19 @@
+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/event.rb

@@ -0,0 +1,64 @@
+require 'active_support'
+require 'active_support/json'
+require 'active_support/core_ext'
+
+module MetaRequest
+
+  # Subclass of ActiveSupport Event that is JSON encodable
+  #
+  class Event < ActiveSupport::Notifications::Event
+    attr_reader :duration
+
+    def initialize(name, start, ending, transaction_id, payload)
+      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(payload, :deep => true) { |hash, key, value|
+        begin
+          value.to_json(:methods => [:duration])
+          new_value = value
+        rescue
+          new_value = 'Not JSON Encodable'
+        end
+        hash[key] = new_value
+      }.with_indifferent_access
+    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.inject(new_hash) { |result, (key,value)|
+        if (options[:deep] && Hash === value)
+          value = options[:safe_descent].fetch( value.object_id ) {
+            transform_hash(value, options, &block)
+          }
+        end
+        block.call(result,key,value)
+        result
+      }
+    end
+
+  end
+end

data/lib/meta_request/log_interceptor.rb

@@ -0,0 +1,49 @@
+require 'callsite'
+
+module MetaRequest
+  module LogInterceptor
+
+    def debug(message = nil, &block)
+      push_event(:debug, message)
+      super
+    end
+
+    def info(message = nil, &block)
+      push_event(:info, message)
+      super
+    end
+
+    def warn(message = nil, &block)
+      push_event(:warn, message)
+      super
+    end
+
+    def error(message = nil, &block)
+      push_event(:error, message)
+      super
+    end
+
+    def fatal(message = nil, &block)
+      push_event(:fatal, message)
+      super
+    end
+
+    def unknown(message = nil, &block)
+      push_event(:unknown, message)
+      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}
+        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 "))
+    end
+  end
+end

data/lib/meta_request/middlewares/app_request_handler.rb

@@ -0,0 +1,32 @@
+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 Exception => exception
+        if defined?(ActionDispatch::ExceptionWrapper)
+          wrapper = if ActionDispatch::ExceptionWrapper.method_defined? :env
+                      ActionDispatch::ExceptionWrapper.new(env, exception)
+                    else
+                      ActionDispatch::ExceptionWrapper.new(env['action_dispatch.backtrace_cleaner'], exception)
+                    end
+          app_request.events.push(*Event.events_for_exception(wrapper))
+        else
+          app_request.events.push(*Event.events_for_exception(exception))
+        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,37 @@
+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[/\A\/?(.*?)\/?\z/, 1]}/"
+      end
+
+    end
+  end
+end

data/lib/meta_request/middlewares/meta_request_handler.rb

@@ -0,0 +1,25 @@
+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/request_id.rb

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

data/lib/meta_request/middlewares.rb

@@ -0,0 +1,8 @@
+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"
+    autoload :RequestId,          "meta_request/middlewares/request_id"
+  end
+end

data/lib/meta_request/railtie.rb

@@ -0,0 +1,30 @@
+require 'rails/railtie'
+
+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
+        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) if Rails.logger
+    end
+
+    initializer 'meta_request.subscribe_to_notifications' do
+      AppNotifications.subscribe
+    end
+
+  end
+end
+
+

data/lib/meta_request/storage.rb

@@ -0,0 +1,43 @@
+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(10)
+    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/version.rb

@@ -0,0 +1,3 @@
+module MetaRequest
+  VERSION = '0.4.0'
+end

data/lib/meta_request.rb

@@ -0,0 +1,21 @@
+module MetaRequest
+  autoload :VERSION,          "meta_request/version"
+  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"
+
+  def self.logger
+    @@logger ||= Logger.new(File.join(Rails.root, 'log', 'meta_request.log'))
+  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

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: meta_request
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Dejan Simic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: []
+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/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/version.rb
+homepage: https://github.com/dejan/rails_panel/tree/master/meta_request
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Request your Rails request
+test_files: []