lograge 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e1eb9c940253292149764ed04a37b52b18932e37
-  data.tar.gz: 8f2e6d001d7665291e67f74b20f4d14624f66ce6
+SHA256:
+  metadata.gz: a8dc3fd38bfe24b9f1816ac75fa2d600037fd308b1b355de309d81deae032cd9
+  data.tar.gz: f3627f7956278364545987b845a16011463592a78dbf9ae0a409b0c8640b63e4
 SHA512:
-  metadata.gz: 6b85d69b8fae8f7dc38526068f9bf7bcd3cc5ba4ca6439e99f0d89acfb3b6851676ac100d1c3d02863a189aa45378e497fe4015a873cecfb389e75d896adc9f0
-  data.tar.gz: dd9aa6804d6737c9e48794e5fc8947fc84884043810835dc29ba26a37b5d986e48251279f2e35e39ad0002a877d79ae106d1c3741142dc5fab770759d517023c
+  metadata.gz: 5787201d587cee662987f2aef1db3b971a60b7feec4dc630d509520713e2c746aee9a1249817f0d1bb8752d22eadcf5e79259c73213e75ce7127e49115795b95
+  data.tar.gz: 055daf5493eb1a053a8b995d5037973587782c8edf9a48fd0d860f3d5e5c2bb419957c0df8610eda6e0cc26c54bdcf7bd900ba0113c780c4569fb22330e9b00e

data/lib/lograge/formatters/cee.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Cee

data/lib/lograge/formatters/graylog2.rb

@@ -1,23 +1,15 @@
+# frozen_string_literal: true
+
 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
-
-        base = {
-          short_message: short_message(data_clone)
-        }
-
         # Add underscore to every key to follow GELF additional field syntax.
-        data_clone.keys.each do |key|
-          data_clone[underscore_prefix(key)] = data_clone[key]
-          data_clone.delete(key)
-        end
-
-        data_clone.merge(base)
+        data.transform_keys { |k| underscore_prefix(k) }.merge(
+          short_message: short_message(data)
+        )
       end
 
       def underscore_prefix(key)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     module Helpers

data/lib/lograge/formatters/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 module Lograge
   module Formatters

data/lib/lograge/formatters/key_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class KeyValue

data/lib/lograge/formatters/l2met.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 require 'lograge/formatters/key_value'
 
 module Lograge
   module Formatters
     class L2met < KeyValue
-      L2MET_FIELDS = [
-        :method,
-        :path,
-        :format,
-        :source,
-        :status,
-        :error,
-        :duration,
-        :view,
-        :db,
-        :location
+      L2MET_FIELDS = %i[
+        method
+        path
+        format
+        source
+        status
+        error
+        duration
+        view
+        db
+        location
       ].freeze
 
-      UNWANTED_FIELDS = [
-        :controller,
-        :action
+      UNWANTED_FIELDS = %i[
+        controller
+        action
       ].freeze
 
       def call(data)

data/lib/lograge/formatters/lines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Lines

data/lib/lograge/formatters/logstash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Logstash

data/lib/lograge/formatters/ltsv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class LTSV

data/lib/lograge/formatters/raw.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Raw

data/lib/lograge/log_subscribers/action_cable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Lograge
   module LogSubscribers
     class ActionCable < Base
-      %i(perform_action subscribe unsubscribe connect disconnect).each do |method_name|
+      %i[perform_action subscribe unsubscribe connect disconnect].each do |method_name|
         define_method(method_name) do |event|
           process_main_event(event)
         end
@@ -11,9 +13,9 @@ module Lograge
 
       def initial_data(payload)
         {
-          method: {},
-          path: {},
-          format: {},
+          method: nil,
+          path: nil,
+          format: nil,
           params: payload[:data],
           controller: payload[:channel_class] || payload[:connection_class],
           action: payload[:action]

data/lib/lograge/log_subscribers/action_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module LogSubscribers
     class ActionController < Base

data/lib/lograge/log_subscribers/base.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'action_pack'
+require 'active_support'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/log_subscriber'
 require 'request_store'
@@ -32,8 +35,8 @@ module Lograge
         data.merge!(custom_options(event))
       end
 
-      %i(initial_data extract_status extract_runtimes
-         extract_location extract_unpermitted_params).each do |method_name|
+      %i[initial_data extract_status extract_runtimes
+         extract_location extract_unpermitted_params].each do |method_name|
         define_method(method_name) { |*_arg| {} }
       end
 
@@ -52,9 +55,8 @@ module Lograge
         0
       end
 
-      def get_error_status_code(exception)
-        status = ActionDispatch::ExceptionWrapper.rescue_responses[exception]
-        Rack::Utils.status_code(status)
+      def get_error_status_code(exception_class_name)
+        ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
       end
 
       def custom_options(event)

data/lib/lograge/ordered_options.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_support'
 require 'active_support/ordered_options'
 
 module Lograge

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

@@ -1,22 +1,15 @@
-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
+# frozen_string_literal: true
 
-          reject_subscription if subscription_rejected?
-          ensure_confirmation_sent
-        end
+module Lograge
+  module ActionCable
+    module ChannelInstrumentation
+      def subscribe_to_channel
+        ActiveSupport::Notifications.instrument('subscribe.action_cable', notification_payload('subscribe')) { super }
       end
 
       def unsubscribe_from_channel
         ActiveSupport::Notifications.instrument('unsubscribe.action_cable', notification_payload('unsubscribe')) do
-          run_callbacks :unsubscribe do
-            unsubscribed
-          end
+          super
         end
       end
 
@@ -28,3 +21,5 @@ module ActionCable
     end
   end
 end
+
+ActionCable::Channel::Base.prepend(Lograge::ActionCable::ChannelInstrumentation)

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

@@ -1,42 +1,21 @@
-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
+# frozen_string_literal: true
 
-            message_buffer.process!
-            server.add_connection(self)
-          rescue ActionCable::Connection::Authorization::UnauthorizedError
-            respond_to_invalid_request
-          end
-        end
+module Lograge
+  module ActionCable
+    module ConnectionInstrumentation
+      def handle_open
+        ActiveSupport::Notifications.instrument('connect.action_cable', notification_payload('connect')) { super }
       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
+        ActiveSupport::Notifications.instrument('disconnect.action_cable', notification_payload('disconnect')) { super }
       end
 
-      private
-
       def notification_payload(method_name)
         { connection_class: self.class.name, action: method_name, data: request.params }
       end
     end
   end
 end
+
+ActionCable::Connection::Base.prepend(Lograge::ActionCable::ConnectionInstrumentation)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Server
     class Base

data/lib/lograge/rails_ext/rack/logger.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_support'
 require 'active_support/concern'
 require 'rails/rack/logger'
 
@@ -9,17 +12,19 @@ module Rails
     # that say:
     # Started GET / for 192.168.2.1...
     class Logger
-      # Overwrites Rails 3.2 code that logs new requests
+      # Overwrites Rails code that logs new requests
       def call_app(*args)
         env = args.last
-        @app.call(env)
+        status, headers, body = @app.call(env)
+        # needs to have same return type as the Rails builtins being overridden, see https://github.com/roidrage/lograge/pull/333
+        # https://github.com/rails/rails/blob/be9d34b9bcb448b265114ebc28bef1a5b5e4c272/railties/lib/rails/rack/logger.rb#L37
+        [status, headers, ::Rack::BodyProxy.new(body) {}] # rubocop:disable Lint/EmptyBlock
       ensure
         ActiveSupport::LogSubscriber.flush_all!
       end
 
       # Overwrites Rails 3.0/3.1 code that logs new requests
-      def before_dispatch(_env)
-      end
+      def before_dispatch(_env); end
     end
   end
 end

data/lib/lograge/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 require 'action_view/log_subscriber'
 require 'action_controller/log_subscriber'

data/lib/lograge/silent_logger.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
 module Lograge
   class SilentLogger < SimpleDelegator
-    def initialize(logger)
-      super
-    end
-
-    %i(debug info warn error fatal unknown).each do |method_name|
+    %i[debug info warn error fatal unknown].each do |method_name|
+      # rubocop:disable Lint/EmptyBlock
       define_method(method_name) { |*_args| }
+      # rubocop:enable Lint/EmptyBlock
     end
   end
 end

data/lib/lograge/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.12.0'
 end

data/lib/lograge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lograge/version'
 require 'lograge/formatters/helpers/method_and_path'
 require 'lograge/formatters/cee'
@@ -14,15 +16,11 @@ require 'lograge/log_subscribers/action_cable'
 require 'lograge/log_subscribers/action_controller'
 require 'lograge/silent_logger'
 require 'lograge/ordered_options'
+require 'active_support'
 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
+# rubocop:disable Metrics/ModuleLength
 module Lograge
   module_function
 
@@ -122,9 +120,7 @@ module Lograge
     events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
     events.each do |event|
       ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
-        if listener.instance_variable_get('@delegate') == subscriber
-          ActiveSupport::Notifications.unsubscribe listener
-        end
+        ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get('@delegate') == subscriber
       end
     end
   end
@@ -158,6 +154,9 @@ module Lograge
   end
 
   def attach_to_action_cable
+    require 'lograge/rails_ext/action_cable/channel/base'
+    require 'lograge/rails_ext/action_cable/connection/base'
+
     Lograge::LogSubscribers::ActionCable.attach_to :action_cable
   end
 
@@ -166,10 +165,7 @@ module Lograge
 
     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_classes << ActionController::Base if base_classes.empty?
 
     base_classes.each do |base_class|
       extend_base_class(base_class)
@@ -208,7 +204,7 @@ module Lograge
   end
 
   def rack_cache_hashlike?(app)
-    app.config.action_dispatch.rack_cache && app.config.action_dispatch.rack_cache.respond_to?(:[]=)
+    app.config.action_dispatch.rack_cache&.respond_to?(:[]=)
   end
   private_class_method :rack_cache_hashlike?
 
@@ -228,5 +224,6 @@ module Lograge
     application.config.lograge
   end
 end
+# rubocop:enable Metrics/ModuleLength
 
 require 'lograge/railtie' if defined?(Rails)

metadata

@@ -1,46 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Mathias Meyer
 - Ben Lovell
-autorequire: 
+- Michael Bianco
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-15 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: '1.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: '1.23'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -99,6 +114,7 @@ description: Tame Rails' multi-line logging into a single line per request
 email:
 - meyer@paperplanes.de
 - benjamin.lovell@gmail.com
+- mike@mikebian.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -129,8 +145,9 @@ files:
 homepage: https://github.com/roidrage/lograge
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,16 +155,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Tame Rails' multi-line logging into a single line per request
 test_files: []