heavylog 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47ec6ffc41672ed7c9adc52d297a917fb29b2b97c0a5f241b82a0dfa2805cfed
-  data.tar.gz: e1163732c1c138707a90ef2cb7254a93f6891358468247768236ef2411c79663
+  metadata.gz: f65df3243c6174d917b13395981eac25a835eff5a9a646ccb35b598a669f1141
+  data.tar.gz: b06dc2293064ae86a433fc29a7947dd03b403cfa248d8b8e57280c146cca51b3
 SHA512:
-  metadata.gz: 732bda484d52d363aa20b25f4c19b636c47393e568161309af5e2f72925dd933ea4c6f3999ce0924ebcd1010dee09ca5e108dbd696f6f8402ead135b4470f844
-  data.tar.gz: 42ad2287596556ef8664b7208ab382241fe60701f0aa85912dcdc7047c596c9fc5d2ec64c38a71617498a77696895665fedb1773e1d281fa9079ec11ebf65325
+  metadata.gz: 4fa777d8823ffb829c9b447e37efeae2034dedab05f3b7104057ce183ecf5d92acac833a01565825b1c28303c7e2360c62c938e01ceabbd6a7cb3780dbd92b95
+  data.tar.gz: 1e2da843ff2352d326b311da106644c0a765233217a2798f2b929717369556ea57fb43602b2e463b9e3f5feea9861e18e5ac675542df47c53500d42acc529ff5

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    heavylog (0.0.2)
+      actionpack (>= 5)
+      activesupport (>= 5)
+      railties (>= 5)
+      request_store (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.6)
+      actionview (= 5.1.6)
+      activesupport (= 5.1.6)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.6)
+      activesupport (= 5.1.6)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.1.6)
+      actionpack (= 5.1.6)
+      activesupport (= 5.1.6)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    request_store (1.4.1)
+      rack (>= 1.4)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  heavylog!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/heavylog.gemspec

@@ -24,4 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency 'activesupport', '>= 5'
+  spec.add_runtime_dependency 'actionpack',    '>= 5'
+  spec.add_runtime_dependency 'railties',      '>= 5'
+  spec.add_runtime_dependency 'request_store', '~> 1.4'
 end

data/lib/heavylog/formatters/json.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+module Heavylog
+  module Formatters
+    class Json
+      def call(data)
+        ::JSON.dump(data)
+      end
+    end
+  end
+end

data/lib/heavylog/formatters/raw.rb

@@ -0,0 +1,9 @@
+module Heavylog
+  module Formatters
+    class Raw
+      def call(data)
+        data
+      end
+    end
+  end
+end

data/lib/heavylog/log_subscriber.rb

@@ -0,0 +1,104 @@
+require 'json'
+require 'action_pack'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/log_subscriber'
+require 'request_store'
+
+module Heavylog
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def process_action(event)
+      payload = event.payload
+      data = extract_request(event, payload)
+      RequestStore.store[:heavylog_request_data] = data
+    end
+
+    def redirect_to(event)
+      RequestStore.store[:heavylog_location] = event.payload[:location]
+    end
+
+    def unpermitted_parameters(event)
+      RequestStore.store[:heavylog_unpermitted_params] ||= []
+      RequestStore.store[:heavylog_unpermitted_params].concat(event.payload[:keys])
+    end
+
+    private
+
+    def extract_request(event, payload)
+      payload = event.payload
+      data = initial_data(payload)
+      data.merge!(extract_status(payload))
+      data.merge!(extract_runtimes(event, payload))
+      data.merge!(extract_location)
+      data.merge!(extract_unpermitted_params)
+      data.merge!(custom_options(event))
+    end
+
+    def initial_data(payload)
+      {
+        method: payload[:method],
+        path: extract_path(payload),
+        format: extract_format(payload),
+        controller: payload[:controller],
+        action: payload[:action]
+      }
+    end
+
+    def extract_path(payload)
+      path = payload[:path]
+      strip_query_string(path)
+    end
+
+    def strip_query_string(path)
+      index = path.index('?')
+      index ? path[0, index] : path
+    end
+
+    def extract_format(payload)
+      payload[:format]
+    end
+
+    def extract_status(payload)
+      if (status = payload[:status])
+        { status: status.to_i }
+      elsif (error = payload[:exception])
+        exception, message = error
+        { status: get_error_status_code(exception), error: "#{exception}: #{message}" }
+      else
+        { status: 0 }
+      end
+    end
+
+    def get_error_status_code(exception)
+      status = ActionDispatch::ExceptionWrapper.rescue_responses[exception]
+      Rack::Utils.status_code(status)
+    end
+
+    def custom_options(event)
+      event.payload[:custom_payload] || {}
+    end
+
+    def extract_runtimes(event, payload)
+      data = { duration: event.duration.to_f.round(2) }
+      [:view_runtime, :db_runtime].each do |key|
+        data[key] = payload[key].to_f.round(2) if payload.key?(key)
+      end
+      data
+    end
+
+    def extract_location
+      location = RequestStore.store[:heavylog_location]
+      return {} unless location
+
+      RequestStore.store[:heavylog_location] = nil
+      { location: strip_query_string(location) }
+    end
+
+    def extract_unpermitted_params
+      unpermitted_params = RequestStore.store[:heavylog_unpermitted_params]
+      return {} unless unpermitted_params
+
+      RequestStore.store[:heavylog_unpermitted_params] = nil
+      { unpermitted_params: unpermitted_params }
+    end
+  end
+end

data/lib/heavylog/middleware.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'rack/body_proxy'
+
+module Heavylog
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new(env)
+      RequestStore.store[:heavylog_request_id] = request.uuid
+
+      @app.call(env)
+    ensure
+      Heavylog.finish
+    end
+  end
+end

data/lib/heavylog/ordered_options.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'active_support/ordered_options'
+
+module Heavylog
+  class OrderedOptions < ActiveSupport::OrderedOptions
+    def custom_payload(&block)
+      self.custom_payload_method = block
+    end
+  end
+end

data/lib/heavylog/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Heavylog
+  class Railtie < Rails::Railtie
+    config.heavylog = Heavylog::OrderedOptions.new
+    config.heavylog.enabled = false
+    config.heavylog.path = 'log/heavylog.log'
+
+    initializer "heavylog.insert_middleware" do |app|
+      app.config.middleware.insert_before Rails::Rack::Logger, Heavylog::Middleware
+    end
+
+    config.after_initialize do |app|
+      Heavylog.setup(app) if app.config.heavylog.enabled
+    end
+  end
+end

data/lib/heavylog/request_logger.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Heavylog
+  module RequestLogger
+    def add(severity, message = nil, progname = nil, &block)
+      super
+      Heavylog.log(severity, message, progname, &block)
+    end
+  end
+end

data/lib/heavylog/version.rb

@@ -1,3 +1,3 @@
 module Heavylog
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/heavylog.rb

@@ -1,5 +1,98 @@
-require "heavylog/version"
+# frozen_string_literal: true
+require 'heavylog/version'
+require 'heavylog/formatters/raw'
+require 'heavylog/formatters/json'
+require 'heavylog/log_subscriber'
+require 'heavylog/middleware'
+require 'heavylog/ordered_options'
+require 'heavylog/request_logger'
 
 module Heavylog
-  # Your code goes here...
+  module_function
+
+  mattr_accessor :logger, :application, :formatter, :log_level
+
+  def setup(app)
+    self.application = app
+    patch_loggers
+    attach_to_action_controller
+    setup_custom_payload
+    set_options
+  end
+
+  def patch_loggers
+    Rails.logger.extend(RequestLogger)
+  end
+
+  def set_options
+    f = File.open(config.path, 'a')
+    f.binmode
+    f.sync = true
+
+    Heavylog.logger = ActiveSupport::Logger.new(f)
+    Heavylog.formatter = config.formatter || Heavylog::Formatters::Raw.new
+    Heavylog.log_level = config.log_level || :info
+  end
+
+  def attach_to_action_controller
+    Heavylog::LogSubscriber.attach_to :action_controller
+  end
+
+  def setup_custom_payload
+    return unless config.custom_payload_method.respond_to?(:call)
+
+    klasses = Array(config.base_controller_class)
+    klasses.map! { |klass| klass.try(:constantize) }
+    klasses.push(ActionController::Base) if klasses.empty?
+    klasses.each { |klass| extend_base_controller_class(klass) }
+  end
+
+  def extend_base_controller_class(klass)
+    append_payload_method = klass.instance_method(:append_info_to_payload)
+    custom_payload_method = config.custom_payload_method
+
+    klass.send(:define_method, :append_info_to_payload) do |payload|
+      append_payload_method.bind(self).call(payload)
+      payload[:custom_payload] = custom_payload_method.call(self)
+    end
+  end
+
+  def log(severity, message = nil, progname = nil, &block)
+    return if !config.enabled
+
+    uuid = RequestStore.store[:heavylog_request_id]
+    return if !uuid
+
+    if message.nil?
+      if block_given?
+        message = yield
+      else
+        message = progname
+      end
+    end
+
+    RequestStore.store[:heavylog_buffer] ||= StringIO.new
+    RequestStore.store[:heavylog_buffer].puts(message)
+  end
+
+  def finish
+    return if !config.enabled
+
+    buffer = RequestStore.store[:heavylog_buffer]
+    return if !buffer
+
+    request = {
+      request_id: RequestStore.store[:heavylog_request_id],
+      messages: buffer.string.dup
+    }.merge(RequestStore.store[:heavylog_request_data] || {})
+
+    formatted = Heavylog.formatter.call(request)
+    Heavylog.logger.send(Heavylog.log_level, formatted)
+  end
+
+  def config
+    application.config.heavylog
+  end
 end
+
+require 'heavylog/railtie' if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heavylog
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kristjan Rang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-31 00:00:00.000000000 Z
+date: 2018-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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'
+- !ruby/object:Gem::Dependency
+  name: railties
+  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'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: Format all Rails logging per request
 email:
 - mail@rang.ee
@@ -63,6 +119,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -70,6 +127,13 @@ files:
 - bin/setup
 - heavylog.gemspec
 - lib/heavylog.rb
+- lib/heavylog/formatters/json.rb
+- lib/heavylog/formatters/raw.rb
+- lib/heavylog/log_subscriber.rb
+- lib/heavylog/middleware.rb
+- lib/heavylog/ordered_options.rb
+- lib/heavylog/railtie.rb
+- lib/heavylog/request_logger.rb
 - lib/heavylog/version.rb
 homepage: https://github.com/krisrang/heavylog
 licenses: