lograge 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 90e32e509e2b788089246d22c8755d69d495d54f807a8e52e3e0fee3406a448c
-  data.tar.gz: 1f969f77c0d5b3878e8a090be723888ba037f982d9688b12ace2f672ce450d9f
+SHA1:
+  metadata.gz: e1eb9c940253292149764ed04a37b52b18932e37
+  data.tar.gz: 8f2e6d001d7665291e67f74b20f4d14624f66ce6
 SHA512:
-  metadata.gz: b253f8a2a86557ed264df935b94379f61ef90c426d83d901672c4deef286e40a934c9e596f23ddf22195d8549207ce213ea67a35a039008ace6202c0b131f29b
-  data.tar.gz: 0112025bfd732a2b41a52c8325e5cc090b94c2056f2d819d8afe9491f063d01c7be3950e25a2707de4955d15b5d8ca59368eab5236ef634f9ceb1c3ac301dafe
+  metadata.gz: 6b85d69b8fae8f7dc38526068f9bf7bcd3cc5ba4ca6439e99f0d89acfb3b6851676ac100d1c3d02863a189aa45378e497fe4015a873cecfb389e75d896adc9f0
+  data.tar.gz: dd9aa6804d6737c9e48794e5fc8947fc84884043810835dc29ba26a37b5d986e48251279f2e35e39ad0002a877d79ae106d1c3741142dc5fab770759d517023c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mathias Meyer
+
+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/lograge.rb

@@ -1,4 +1,5 @@
 require 'lograge/version'
+require 'lograge/formatters/helpers/method_and_path'
 require 'lograge/formatters/cee'
 require 'lograge/formatters/json'
 require 'lograge/formatters/graylog2'
@@ -8,11 +9,19 @@ require 'lograge/formatters/lines'
 require 'lograge/formatters/logstash'
 require 'lograge/formatters/ltsv'
 require 'lograge/formatters/raw'
-require 'lograge/log_subscriber'
+require 'lograge/log_subscribers/base'
+require 'lograge/log_subscribers/action_cable'
+require 'lograge/log_subscribers/action_controller'
+require 'lograge/silent_logger'
 require 'lograge/ordered_options'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
 
+if defined?(ActionCable)
+  require 'lograge/rails_ext/action_cable/channel/base'
+  require 'lograge/rails_ext/action_cable/connection/base'
+end
+
 # rubocop:disable ModuleLength
 module Lograge
   module_function
@@ -63,10 +72,14 @@ module Lograge
   def ignore_actions(actions)
     ignore(lambda do |event|
              params = event.payload
-             Array(actions).include?("#{params[:controller]}##{params[:action]}")
+             Array(actions).include?("#{controller_field(params)}##{params[:action]}")
            end)
   end
 
+  def controller_field(params)
+    params[:controller] || params[:channel_class] || params[:connection_class]
+  end
+
   def ignore_tests
     @ignore_tests ||= []
   end
@@ -122,6 +135,8 @@ module Lograge
     keep_original_rails_log
 
     attach_to_action_controller
+    attach_to_action_cable if defined?(ActionCable)
+
     set_lograge_log_options
     setup_custom_payload
     support_deprecated_config # TODO: Remove with version 1.0
@@ -139,24 +154,29 @@ module Lograge
   end
 
   def attach_to_action_controller
-    Lograge::RequestLogSubscriber.attach_to :action_controller
+    Lograge::LogSubscribers::ActionController.attach_to :action_controller
+  end
+
+  def attach_to_action_cable
+    Lograge::LogSubscribers::ActionCable.attach_to :action_cable
   end
 
   def setup_custom_payload
     return unless lograge_config.custom_payload_method.respond_to?(:call)
 
-    base_controller_classes = Array(lograge_config.base_controller_class)
-    base_controller_classes.map! { |klass| klass.try(:constantize) }
-    if base_controller_classes.empty?
-      base_controller_classes << ActionController::Base
+    base_classes = Array(lograge_config.base_controller_class)
+    base_classes.map! { |klass| klass.try(:constantize) }
+    if base_classes.empty?
+      base_classes << ActionController::Base
+      base_classes << ActionCable::Channel::Base if defined?(ActionCable)
     end
 
-    base_controller_classes.each do |base_controller_class|
-      extend_base_controller_class(base_controller_class)
+    base_classes.each do |base_class|
+      extend_base_class(base_class)
     end
   end
 
-  def extend_base_controller_class(klass)
+  def extend_base_class(klass)
     append_payload_method = klass.instance_method(:append_info_to_payload)
     custom_payload_method = lograge_config.custom_payload_method
 
@@ -181,6 +201,9 @@ module Lograge
     return if lograge_config.keep_original_rails_log
 
     require 'lograge/rails_ext/rack/logger'
+
+    require 'lograge/rails_ext/action_cable/server/base' if defined?(ActionCable)
+
     Lograge.remove_existing_log_subscriptions
   end
 

data/lib/lograge/formatters/graylog2.rb

@@ -1,6 +1,8 @@
 module Lograge
   module Formatters
     class Graylog2
+      include Lograge::Formatters::Helpers::MethodAndPath
+
       def call(data)
         # Cloning because we don't want to mess with the original when mutating keys.
         data_clone = data.clone
@@ -23,7 +25,7 @@ module Lograge
       end
 
       def short_message(data)
-        "[#{data[:status]}] #{data[:method]} #{data[:path]} (#{data[:controller]}##{data[:action]})"
+        "[#{data[:status]}]#{method_and_path_string(data)}(#{data[:controller]}##{data[:action]})"
       end
     end
   end

data/lib/lograge/formatters/helpers/method_and_path.rb

@@ -0,0 +1,12 @@
+module Lograge
+  module Formatters
+    module Helpers
+      module MethodAndPath
+        def method_and_path_string(data)
+          method_and_path = [data[:method], data[:path]].compact
+          method_and_path.any?(&:present?) ? " #{method_and_path.join(' ')} " : ' '
+        end
+      end
+    end
+  end
+end

data/lib/lograge/formatters/logstash.rb

@@ -1,11 +1,13 @@
 module Lograge
   module Formatters
     class Logstash
+      include Lograge::Formatters::Helpers::MethodAndPath
+
       def call(data)
         load_dependencies
         event = LogStash::Event.new(data)
 
-        event['message'] = "[#{data[:status]}] #{data[:method]} #{data[:path]} (#{data[:controller]}##{data[:action]})"
+        event['message'] = "[#{data[:status]}]#{method_and_path_string(data)}(#{data[:controller]}##{data[:action]})"
         event.to_json
       end
 

data/lib/lograge/log_subscribers/action_cable.rb

@@ -0,0 +1,32 @@
+module Lograge
+  module LogSubscribers
+    class ActionCable < Base
+      %i(perform_action subscribe unsubscribe connect disconnect).each do |method_name|
+        define_method(method_name) do |event|
+          process_main_event(event)
+        end
+      end
+
+      private
+
+      def initial_data(payload)
+        {
+          method: {},
+          path: {},
+          format: {},
+          params: payload[:data],
+          controller: payload[:channel_class] || payload[:connection_class],
+          action: payload[:action]
+        }
+      end
+
+      def default_status
+        200
+      end
+
+      def extract_runtimes(event, _payload)
+        { duration: event.duration.to_f.round(2) }
+      end
+    end
+  end
+end

data/lib/lograge/log_subscribers/action_controller.rb

@@ -0,0 +1,73 @@
+module Lograge
+  module LogSubscribers
+    class ActionController < Base
+      def process_action(event)
+        process_main_event(event)
+      end
+
+      def redirect_to(event)
+        RequestStore.store[:lograge_location] = event.payload[:location]
+      end
+
+      def unpermitted_parameters(event)
+        RequestStore.store[:lograge_unpermitted_params] ||= []
+        RequestStore.store[:lograge_unpermitted_params].concat(event.payload[:keys])
+      end
+
+      private
+
+      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
+
+      if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR.zero?
+        def extract_format(payload)
+          payload[:formats].first
+        end
+      else
+        def extract_format(payload)
+          payload[:format]
+        end
+      end
+
+      def extract_runtimes(event, payload)
+        data = { duration: event.duration.to_f.round(2) }
+        data[:view] = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
+        data[:db] = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
+        data
+      end
+
+      def extract_location
+        location = RequestStore.store[:lograge_location]
+        return {} unless location
+
+        RequestStore.store[:lograge_location] = nil
+        { location: strip_query_string(location) }
+      end
+
+      def extract_unpermitted_params
+        unpermitted_params = RequestStore.store[:lograge_unpermitted_params]
+        return {} unless unpermitted_params
+
+        RequestStore.store[:lograge_unpermitted_params] = nil
+        { unpermitted_params: unpermitted_params }
+      end
+    end
+  end
+end

data/lib/lograge/log_subscribers/base.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'action_pack'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/log_subscriber'
+require 'request_store'
+
+module Lograge
+  module LogSubscribers
+    class Base < ActiveSupport::LogSubscriber
+      def logger
+        Lograge.logger.presence || super
+      end
+
+      private
+
+      def process_main_event(event)
+        return if Lograge.ignore?(event)
+
+        payload = event.payload
+        data = extract_request(event, payload)
+        data = before_format(data, payload)
+        formatted_message = Lograge.formatter.call(data)
+        logger.send(Lograge.log_level, formatted_message)
+      end
+
+      def extract_request(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
+
+      %i(initial_data extract_status extract_runtimes
+         extract_location extract_unpermitted_params).each do |method_name|
+        define_method(method_name) { |*_arg| {} }
+      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: default_status }
+        end
+      end
+
+      def default_status
+        0
+      end
+
+      def get_error_status_code(exception)
+        status = ActionDispatch::ExceptionWrapper.rescue_responses[exception]
+        Rack::Utils.status_code(status)
+      end
+
+      def custom_options(event)
+        options = Lograge.custom_options(event) || {}
+        options.merge event.payload[:custom_payload] || {}
+      end
+
+      def before_format(data, payload)
+        Lograge.before_format(data, payload)
+      end
+    end
+  end
+end

data/lib/lograge/rails_ext/action_cable/channel/base.rb

@@ -0,0 +1,30 @@
+module ActionCable
+  module Channel
+    class Base
+      def subscribe_to_channel
+        ActiveSupport::Notifications.instrument('subscribe.action_cable', notification_payload('subscribe')) do
+          run_callbacks :subscribe do
+            subscribed
+          end
+
+          reject_subscription if subscription_rejected?
+          ensure_confirmation_sent
+        end
+      end
+
+      def unsubscribe_from_channel
+        ActiveSupport::Notifications.instrument('unsubscribe.action_cable', notification_payload('unsubscribe')) do
+          run_callbacks :unsubscribe do
+            unsubscribed
+          end
+        end
+      end
+
+      private
+
+      def notification_payload(method_name)
+        { channel_class: self.class.name, action: method_name }
+      end
+    end
+  end
+end

data/lib/lograge/rails_ext/action_cable/connection/base.rb

@@ -0,0 +1,42 @@
+module ActionCable
+  module Connection
+    class Base
+      # rubocop:disable Metrics/MethodLength
+      def handle_open
+        ActiveSupport::Notifications.instrument('connect.action_cable', notification_payload('connect')) do
+          begin
+            @protocol = websocket.protocol
+            connect if respond_to?(:connect)
+            subscribe_to_internal_channel
+            send_welcome_message
+
+            message_buffer.process!
+            server.add_connection(self)
+          rescue ActionCable::Connection::Authorization::UnauthorizedError
+            respond_to_invalid_request
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def handle_close
+        ActiveSupport::Notifications.instrument('disconnect.action_cable', notification_payload('disconnect')) do
+          logger.info finished_request_message if Lograge.lograge_config.keep_original_rails_log
+
+          server.remove_connection(self)
+
+          subscriptions.unsubscribe_from_all
+          unsubscribe_from_internal_channel
+
+          disconnect if respond_to?(:disconnect)
+        end
+      end
+
+      private
+
+      def notification_payload(method_name)
+        { connection_class: self.class.name, action: method_name, data: request.params }
+      end
+    end
+  end
+end

data/lib/lograge/rails_ext/action_cable/server/base.rb

@@ -0,0 +1,8 @@
+module ActionCable
+  module Server
+    class Base
+      mattr_accessor :logger
+      self.logger = Lograge::SilentLogger.new(config.logger)
+    end
+  end
+end

data/lib/lograge/silent_logger.rb

@@ -0,0 +1,11 @@
+module Lograge
+  class SilentLogger < SimpleDelegator
+    def initialize(logger)
+      super
+    end
+
+    %i(debug info warn error fatal unknown).each do |method_name|
+      define_method(method_name) { |*_args| }
+    end
+  end
+end

data/lib/lograge/version.rb

@@ -1,3 +1,3 @@
 module Lograge
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.11.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Mathias Meyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -103,9 +103,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - lib/lograge.rb
 - lib/lograge/formatters/cee.rb
 - lib/lograge/formatters/graylog2.rb
+- lib/lograge/formatters/helpers/method_and_path.rb
 - lib/lograge/formatters/json.rb
 - lib/lograge/formatters/key_value.rb
 - lib/lograge/formatters/l2met.rb
@@ -113,10 +115,16 @@ files:
 - lib/lograge/formatters/logstash.rb
 - lib/lograge/formatters/ltsv.rb
 - lib/lograge/formatters/raw.rb
-- lib/lograge/log_subscriber.rb
+- lib/lograge/log_subscribers/action_cable.rb
+- lib/lograge/log_subscribers/action_controller.rb
+- lib/lograge/log_subscribers/base.rb
 - lib/lograge/ordered_options.rb
+- lib/lograge/rails_ext/action_cable/channel/base.rb
+- lib/lograge/rails_ext/action_cable/connection/base.rb
+- lib/lograge/rails_ext/action_cable/server/base.rb
 - lib/lograge/rails_ext/rack/logger.rb
 - lib/lograge/railtie.rb
+- lib/lograge/silent_logger.rb
 - lib/lograge/version.rb
 homepage: https://github.com/roidrage/lograge
 licenses:
@@ -138,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Tame Rails' multi-line logging into a single line per request

data/lib/lograge/log_subscriber.rb

@@ -1,122 +0,0 @@
-require 'json'
-require 'action_pack'
-require 'active_support/core_ext/class/attribute'
-require 'active_support/log_subscriber'
-require 'request_store'
-
-module Lograge
-  class RequestLogSubscriber < ActiveSupport::LogSubscriber
-    def process_action(event)
-      return if Lograge.ignore?(event)
-
-      payload = event.payload
-      data = extract_request(event, payload)
-      data = before_format(data, payload)
-      formatted_message = Lograge.formatter.call(data)
-      logger.send(Lograge.log_level, formatted_message)
-    end
-
-    def redirect_to(event)
-      RequestStore.store[:lograge_location] = event.payload[:location]
-    end
-
-    def unpermitted_parameters(event)
-      RequestStore.store[:lograge_unpermitted_params] ||= []
-      RequestStore.store[:lograge_unpermitted_params].concat(event.payload[:keys])
-    end
-
-    def logger
-      Lograge.logger.presence || super
-    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
-
-    if ::ActionPack::VERSION::MAJOR == 3 && ::ActionPack::VERSION::MINOR.zero?
-      def extract_format(payload)
-        payload[:formats].first
-      end
-    else
-      def extract_format(payload)
-        payload[:format]
-      end
-    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)
-      options = Lograge.custom_options(event) || {}
-      options.merge event.payload[:custom_payload] || {}
-    end
-
-    def before_format(data, payload)
-      Lograge.before_format(data, payload)
-    end
-
-    def extract_runtimes(event, payload)
-      data = { duration: event.duration.to_f.round(2) }
-      data[:view] = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
-      data[:db] = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
-      data
-    end
-
-    def extract_location
-      location = RequestStore.store[:lograge_location]
-      return {} unless location
-
-      RequestStore.store[:lograge_location] = nil
-      { location: strip_query_string(location) }
-    end
-
-    def extract_unpermitted_params
-      unpermitted_params = RequestStore.store[:lograge_unpermitted_params]
-      return {} unless unpermitted_params
-
-      RequestStore.store[:lograge_unpermitted_params] = nil
-      { unpermitted_params: unpermitted_params }
-    end
-  end
-end