rack-reqorder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e5ee5c3b78608fb23c33eccc40fad318829ee7a
-  data.tar.gz: 878a3139311546392b38b6ab1d7efff7cd320db9
+  metadata.gz: d32d460562301fbe8a9891e17ec80ca6e77f35f2
+  data.tar.gz: 052269bec34d67bcf99b03cdb8856fc2c8c40412
 SHA512:
-  metadata.gz: 608cd0e963785bc88d375272189556c062a1140b9b287ecd4ba4248e76487d44066244c317460734824eb3309397d78fa4d77be826aa56d738062921951b224d
-  data.tar.gz: 317dbb6df532175889814c2dae12c83910ce81eadf9ec4ab6f97d1f04dc5ed593045743d9df02f17595b0e942e5d9a3a5b8f8c46caaef9d064eb5f029ace19f5
+  metadata.gz: 65255514d36099c7935d2043bdb2f518fcac3a0cc2f6d1ec6e08747220d58c152174119c58f7bd8d858e0359d8ccf012ebdc88e911e5499abdbacd1c7fa8898d
+  data.tar.gz: 2ddbddc83cbda7f5a7c2de83e092c30dff99e2f7cd77d64bce9248a6878e37160c9ffdecde52ef59377c64d5f7cc4431906125a8b13b39320f96e39c04b4f3d9

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+mongoid.yml

data/Gemfile

@@ -1,5 +1,8 @@
 source 'https://rubygems.org'
 
+gem 'mongoid_hash_query', path: '../mongoid_hash_query'
+gem 'pry'
+
 # Specify your gem's dependencies in rack-reqorder.gemspec
 gemspec
 

data/Rakefile

@@ -1,2 +1,12 @@
 require "bundler/gem_tasks"
+require 'rack/reqorder/api/api'
+
+namespace :grape do
+  desc 'Print compiled grape routes'
+  task :routes do
+    Rack::Reqorder::Api.routes.each do |route|
+      puts route
+    end
+  end
+end
 

data/lib/rack/reqorder/config.ru

@@ -0,0 +1,9 @@
+require_relative '../reqorder'
+
+Rack::Reqorder.configure do |config|
+  config.mongoid_yml = "#{File.dirname(__FILE__)}/../../../mongoid.yml"
+end
+
+Rack::Reqorder.boot!
+
+run Rack::Reqorder::Monitor::Api

data/lib/rack/reqorder/logger.rb

@@ -1,47 +1,100 @@
-module Rack
-  module Reqorder
-    class Logger
-      include Rack::Reqorder::Models
+module Rack::Reqorder
+  class Logger
+    include Rack::Reqorder::Models
 
-      def initialize(app)
-        @app = app
-      end
+    def initialize(app)
+      @app = app
+    end
+
+    def call(environment)
+      http_request = save_http_request(environment)
 
-      def call(environment)
-        #api_session = ApiSession.create(created_at: Time.now)
-        request = Rack::Request.new(environment)
-        #api_session.request
-
-        HttpRequest.create(
-          path: request.path,
-          full_path: request.fullpath,
-          headers: extract_all_headers(request),
-          parameters: request.params,
-        )
-
-        status, headers, body = @app.call(request.env)
-
-        response = Rack::Response.new(body, status, headers)
-
-        HttpResponse.create(
-          headers: response.headers,
-          #body: response.body.first,
-          status: response.status.to_i
-        )
-=begin
-        response.finish
-=end
-        return [status, headers, body]
+      begin
+        status, headers, body = @app.call(environment)
+      rescue => exception
+        log_exception(exception, http_request)
+        raise exception
       end
 
-      def extract_all_headers(request)
-        Hash[
-          request.env.select{|k,v|
-            k.start_with? 'HTTP_'
-          }.map{|k,v|
-            [k.gsub('HTTP_','').upcase, v]
-          }
-        ]
+      save_http_response(body, status, headers, http_request)
+
+      return [status, headers, body]
+    end
+
+  private
+
+    def extract_all_headers(request)
+      Hash[
+        request.env.select{|k,v|
+          k.start_with? 'HTTP_'
+        }.map{|k,v|
+          [k.gsub('HTTP_','').upcase, v]
+        }.select{|k,v|
+          k != 'COOKIE'
+        }
+      ]
+    end
+
+    def save_http_request(environment)
+      request = Rack::Request.new(environment)
+
+      return HttpRequest.create(
+        ip: request.ip,
+        url: request.url,
+        scheme: request.scheme,
+        base_url: request.base_url,
+        port: request.port,
+        path: request.path,
+        full_path: request.fullpath,
+        http_method: request.request_method,
+        headers: extract_all_headers(request),
+        params: request.params,
+        ssl: request.ssl?,
+        xhr: request.xhr?
+      )
+    end
+
+    def save_http_response(body, status, headers, http_request)
+      response = Rack::Response.new(body, status, headers)
+
+      HttpResponse.create(
+        headers: response.headers,
+        #body: response.body.first,
+        status: response.status.to_i,
+        http_request: http_request
+      )
+    end
+
+    def log_exception(exception, http_request)
+      bc = BacktraceCleaner.new
+      bc.add_filter   { |line| line.gsub(Rails.root.to_s, '') }
+      bc.add_silencer { |line| line =~ /gems/ }
+
+      application_trace = bc.clean(exception.backtrace)
+
+      path, line, _ = application_trace.first.split(':')
+
+      AppException.create(
+        message: exception.message,
+        application_trace: application_trace,
+        full_trace: exception.backtrace,
+        line: line.to_i,
+        path: path[1..-1],
+        source_extract: source_fragment(path[1..-1], line.to_i),
+        http_request: http_request
+      )
+    end
+
+    def source_fragment(path, line)
+      return unless Rails.respond_to?(:root) && Rails.root
+
+      full_path = Rails.root.join(path)
+      if File.exist?(full_path)
+        File.open(full_path, "r") do |file|
+          start = [line - 3, 0].max
+          lines = file.each_line.drop(start).take(6)
+          Hash[*(start+1..(lines.count+start)).zip(lines).flatten]
+        end
       end
     end
   end

data/lib/rack/reqorder/models/app_exception.rb

@@ -0,0 +1,19 @@
+#Heavy influenced by ActionDispatch::DebugExceptions
+
+module Rack::Reqorder::Models
+  class AppException
+    include ::Mongoid::Document
+    include ::Kaminari::MongoidExtension::Document
+
+    field :message, type: String
+    field :application_trace, type: Array
+    #field :framework_trace, type: Array
+    field :full_trace, type: Array
+    field :line, type: Integer
+    field :path, type: String
+    field :source_extract, type: Hash
+    field :created_at, type: Time, default: ->{ Time.now }
+
+    belongs_to :http_request
+  end
+end

data/lib/rack/reqorder/models/http_request.rb

@@ -1,20 +1,24 @@
 module Rack::Reqorder::Models
   class HttpRequest
     include ::Mongoid::Document
+    include ::Kaminari::MongoidExtension::Document
 
+    field :ip, type: String
+    field :url, type: String
+    field :scheme, type: String
+    field :base_url, type: String
+    field :port, type: Integer
     field :path, type: String
     field :full_path, type: String
+    field :http_method, type: String
     field :headers, type: Hash
-    field :parameters, type: Hash
-    field :created_at, type: DateTime
+    field :params, type: Hash
+    field :ssl, type: Boolean
+    field :xhr, type: Boolean
+    field :created_at, type: Time, default: ->{ Time.now }
 
     has_one :http_response
-
-    before_create :set_created_at
-
-    def set_created_at
-      self.created_at = DateTime.now.utc
-    end
+    has_one :app_exception
 
   end
 end

data/lib/rack/reqorder/models/http_response.rb

@@ -1,16 +1,21 @@
 module Rack::Reqorder::Models
   class HttpResponse
     include ::Mongoid::Document
+    include ::Kaminari::MongoidExtension::Document
 
     field :headers, type: Hash
     field :status, type: Integer
     #field :body, type: String
-    field :created_at, type: DateTime
+    field :created_at, type: Time, default: ->{ Time.now }, pre_processed: true
+    field :response_time, type: Float
 
-    before_create :set_created_at
+    belongs_to :http_request
 
-    def set_created_at
-      self.created_at = DateTime.now.utc
+    before_create :set_response_time
+
+  private
+    def set_response_time
+      self.response_time = self.created_at - self.http_request.created_at
     end
   end
 end

data/lib/rack/reqorder/monitor/entities.rb

@@ -0,0 +1,74 @@
+module Rack::Reqorder::Monitor
+  module Entities
+    class BaseEntity < Grape::Entity
+      expose :_id, documentation: { type: 'String', desc: 'BSON::ObjectId String' }, :format_with => :to_string, as: :id
+      format_with(:to_string) { |foo| foo.to_s }
+      format_with(:iso_timestamp) { |dt| dt.utc.iso8601 if dt }
+
+      format_with(:association_id) {|a| a.id.to_s if a}
+    end
+
+    class RequestEntity < BaseEntity
+      root :requests, :request
+
+      expose :ip
+      expose :url
+      expose :scheme
+      expose :base_url
+      expose :port
+      expose :path
+      expose :full_path
+      expose :http_method
+      expose :headers
+      expose :params
+      expose :ssl
+      expose :xhr
+
+      with_options(format_with: :iso_timestamp) do
+        expose :created_at
+      end
+
+      with_options(format_with: :association_id) do
+        expose :http_response, as: :response_id
+      end
+
+    end
+
+    class ResponseEntity < BaseEntity
+      root :responses, :response
+
+      expose :headers
+      expose :status
+      expose :response_time
+
+      with_options(format_with: :iso_timestamp) do
+        expose :created_at
+      end
+
+      with_options(format_with: :association_id) do
+        expose :http_request, as: :request_id
+      end
+    end
+
+
+    class ExceptionEntity < BaseEntity
+      root :exceptions, :exception
+
+      expose :message
+      expose :application_trace
+      expose :full_trace
+      expose :line
+      expose :path
+      expose :source_extract
+
+      with_options(format_with: :iso_timestamp) do
+        expose :created_at
+      end
+
+      with_options(format_with: :association_id) do
+        expose :http_request, as: :request_id
+      end
+
+    end
+  end
+end

data/lib/rack/reqorder/monitor.rb

@@ -0,0 +1,120 @@
+require 'grape'
+require 'grape-entity'
+require 'rack/reqorder/monitor/entities'
+require 'mongoid_hash_query'
+require 'pry'
+
+module Rack::Reqorder
+  module Monitor
+  end
+end
+
+module Rack::Reqorder::Monitor
+  class Api < Grape::API
+    include Rack::Reqorder::Models
+    include Rack::Reqorder::Monitor::Entities
+
+    helpers do
+      include MongoidHashQuery
+    end
+
+    version 'v1', using: :path, vendor: 'foobar'
+    format :json
+    prefix :api
+
+    #collection routes
+    resource :requests do
+      get do
+        requests = apply_filters(HttpRequest.all, params)
+
+        meta_aggregations = aggregations(requests, params)
+
+        requests = paginate(requests, params)
+
+        present_with_meta(
+          requests,
+          present(requests, with: RequestEntity),
+          meta_aggregations
+        )
+      end
+
+      #element routes
+      route_param :id do
+        get do
+          present(HttpRequest.find(params[:id]), with: RequestEntity)
+        end
+      end
+    end
+
+    #collection routes
+    resource :responses do
+      get do
+        responses = HttpResponse.all
+
+        responses = apply_filters(responses, params)
+
+        meta_aggregations = aggregations(exceptions, params)
+
+        responses = paginate(responses, params)
+
+        present_with_meta(
+          responses,
+          present(responses, with: ResponseEntity),
+          meta_aggregations
+        )
+      end
+
+      #element routes
+      route_param :id do
+        get do
+          present(HttpResponse.find(params[:id]), with: ResponseEntity)
+        end
+      end
+    end
+
+    #collection routes
+    resource :exceptions do
+      get do
+        exceptions = AppException.all
+
+        exceptions = apply_filters(exceptions, params)
+
+        meta_aggregations = aggregations(exceptions, params)
+
+        exceptions = paginate(exceptions, params)
+
+        present_with_meta(
+          exceptions,
+          present(exceptions, with: ExceptionEntity),
+          meta_aggregations
+        )
+      end
+
+      #element routes
+      route_param :id do
+        get do
+          present(AppException.find(params[:id]), with: ExceptionEntity)
+        end
+      end
+    end
+
+    helpers do
+      def present_with_meta(object, hash, extra_meta)
+        hash[:meta] = {
+          current_page: object.current_page,
+          next_page: object.next_page,
+          prev_page: object.prev_page,
+          total_pages: object.total_pages,
+          total_count: object.total_count
+        }.merge(extra_meta)
+
+        return hash
+      end
+
+      def paginate(object, params)
+        return object.page(params[:page] || 1).per(params[:per_page] || 30)
+      end
+    end
+
+  end
+end

data/lib/rack/reqorder/services/backtrace_cleaner.rb

@@ -0,0 +1,76 @@
+module Rack::Reqorder
+  class BacktraceCleaner
+    def initialize
+      @filters, @silencers = [], []
+    end
+
+    # Returns the backtrace after all filters and silencers have been run
+    # against it. Filters run first, then silencers.
+    def clean(backtrace, kind = :silent)
+      filtered = filter_backtrace(backtrace)
+
+      case kind
+      when :silent
+        silence(filtered)
+      when :noise
+        noise(filtered)
+      else
+        filtered
+      end
+    end
+    alias :filter :clean
+
+    # Adds a filter from the block provided. Each line in the backtrace will be
+    # mapped against this filter.
+    #
+    #   # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
+    #   backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
+    def add_filter(&block)
+      @filters << block
+    end
+
+    # Adds a silencer from the block provided. If the silencer returns +true+
+    # for a given line, it will be excluded from the clean backtrace.
+    #
+    #   # Will reject all lines that include the word "mongrel", like "/gems/mongrel/server.rb" or "/app/my_mongrel_server/rb"
+    #   backtrace_cleaner.add_silencer { |line| line =~ /mongrel/ }
+    def add_silencer(&block)
+      @silencers << block
+    end
+
+    # Removes all silencers, but leaves in the filters. Useful if your
+    # context of debugging suddenly expands as you suspect a bug in one of
+    # the libraries you use.
+    def remove_silencers!
+      @silencers = []
+    end
+
+    # Removes all filters, but leaves in the silencers. Useful if you suddenly
+    # need to see entire filepaths in the backtrace that you had already
+    # filtered out.
+    def remove_filters!
+      @filters = []
+    end
+
+    private
+      def filter_backtrace(backtrace)
+        @filters.each do |f|
+          backtrace = backtrace.map { |line| f.call(line) }
+        end
+
+        backtrace
+      end
+
+      def silence(backtrace)
+        @silencers.each do |s|
+          backtrace = backtrace.reject { |line| s.call(line) }
+        end
+
+        backtrace
+      end
+
+      def noise(backtrace)
+        backtrace - silence(backtrace)
+      end
+  end
+end

data/lib/rack/reqorder/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Reqorder
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/rack/reqorder.rb

@@ -1,6 +1,8 @@
 require 'rack/reqorder/version'
 require 'active_support/inflector'
 require 'mongoid'
+require 'kaminari'
+require 'kaminari/models/mongoid_extension'
 
 module Rack
   module Reqorder
@@ -39,6 +41,20 @@ module Rack
   end
 end
 
+Kaminari.configure do |config|
+  # config.default_per_page = 25
+  # config.max_per_page = nil
+  # config.window = 4
+  # config.outer_window = 0
+  # config.left = 0
+  # config.right = 0
+  # config.page_method_name = :page
+  # config.param_name = :page
+end
+
 require 'rack/reqorder/models/http_request'
 require 'rack/reqorder/models/http_response'
+require 'rack/reqorder/models/app_exception'
+require 'rack/reqorder/services/backtrace_cleaner'
 require 'rack/reqorder/logger'
+require 'rack/reqorder/monitor'

data/rack-reqorder.gemspec

@@ -22,4 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_dependency "mongoid", "~> 4.0.0"
   spec.add_dependency "activesupport", "~> 4.1.6"
+  spec.add_dependency "grape"
+  spec.add_dependency "grape-entity"
+  spec.add_dependency "kaminari"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-reqorder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Filippos Vasilakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.6
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Request recorder and analyzer for rack apps
 email:
 - vasilakisfil@gmail.com
@@ -84,10 +126,14 @@ files:
 - bin/console
 - bin/setup
 - lib/rack/reqorder.rb
+- lib/rack/reqorder/config.ru
 - lib/rack/reqorder/logger.rb
+- lib/rack/reqorder/models/app_exception.rb
 - lib/rack/reqorder/models/http_request.rb
 - lib/rack/reqorder/models/http_response.rb
-- lib/rack/reqorder/services/request_saver.rb
+- lib/rack/reqorder/monitor.rb
+- lib/rack/reqorder/monitor/entities.rb
+- lib/rack/reqorder/services/backtrace_cleaner.rb
 - lib/rack/reqorder/version.rb
 - rack-reqorder.gemspec
 homepage: ''
@@ -110,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Request recorder and analyzer for rack apps

data/lib/rack/reqorder/services/request_saver.rb

@@ -1,6 +0,0 @@
-class NewRequestService
-  class << self
-    def save(request)
-    end
-  end
-end