epilog 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c182e5b6fad45d60dcbf0e37843e075e6775d76e3888a632056cef356235768
-  data.tar.gz: bb7095818994ab3532c70c691180fe1018089e587cc7819faf1441bb6532acf9
+  metadata.gz: 32a54d6c7ea304907eb4dc22c25c9929b3da12567229bff59011e71d9beb6657
+  data.tar.gz: 6368c2823685e10c8f599e0b2a38fbe51d815276427d7678de23438cb91967f2
 SHA512:
-  metadata.gz: 07552c37f2ebcc5febb7d94f227801c8f89e15eae7904e493c6575bd83819a1989b7229a9d1559ffc9f4651884611160b77779cfce11fa1abcf48c71bd484612
-  data.tar.gz: 5664a1841cdd95b1af21e8796a374f30d5ddfd26faf6ef4782abc9de435098d351f3e29d2b778358e74c1af5ae55b9cb4d4155c0cba776201ed9d350286abc41
+  metadata.gz: 9c7043de6697ddd6ec8c5b9bd5e9c4b4f6514ac294832778df3001cee5b33095d9da4ba98c94a4d9719a543774211bd0451c9648274833b78c17acab1d06778c
+  data.tar.gz: b0c7afa816aafe154ac47d944baa5398c692d2c5b33f4c014460486daae83f280c070d63f8a09b67b2025f4bf9e153878b84aad848b6ce1780699e9ed75ae00d

data/.gitignore

@@ -9,3 +9,4 @@
 
 /spec/rails_app/log/
 /spec/rails_app/db/test.sqlite
+/.idea

data/.travis.yml

@@ -4,10 +4,12 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 env:
   matrix:
-    - RAILS_VERSION=4.2
     - RAILS_VERSION=5.2
+    - RAILS_VERSION=6.0
+    - RAILS_VERSION=6.1
   global:
     - COVERAGE=1
     - secure: 'nm0AJBULqunzS//h26lblqWHV4Kl0Ij9OPVHMI761TNeFFjP2+KKUVh4qYEKrdUDp7pk9Wa4CdAB9EFLYTJMwyK8RlSkdMLaHGT9xdOqbycBS6vkW2symvdu58SSdsNmnnFV4ebOwEmEcDhAh8SyT0ZkUVhyzGntdzOOZmULi57kOwm8QGrrr4/4xaTmDleZlTDS404nD28wJctaBT8Xa33inaYYrHLKz4xbvFFtptrPb+Arav9enljqiqOu4XjXCIP2eOSP7PHkDPuRn0JKDFT3zKmj0MIUbYkoheQL6R3tMF9zx5gm4GKbd7iunuIsjbFweiveZwZhfNGDPCICuw76UWZCrN4PpomA7XDNjbs0JVRJvnBxLZk5X3w3Sacb4zBTd+U8WH7uAb9qdD7m4xUswox4tPZDPXYObw2PDqtLlsSRn3WDKsnG0/Tt0D+kFsx43MbrvspdOzjarJsIXzU9aJqfE97nM4ZrNcktsW4PrqGflhcDVTKg+kLQj4bO0csR1W/JhGHN0JsVNUmNFN9QqpuRxxI/AmnPBtKR29DDy3BUv1b/kCZbsqq4+wbgCKDJng5VBgpG4VekOiTT2xmlwoxNK4IUAISbu7G/eyCcp33jb+27QE74a13xQsMLvh/wjh1sFEfzJvQzXFL+gjkVP4Z/+uSbc2+8/p+FKm8='
@@ -28,7 +30,7 @@ after_script:
 jobs:
   include:
     - stage: release
-      rvm: 2.3
+      rvm: 2.6
       script: skip
       deploy:
         provider: rubygems

data/{CHANGLOG.md → CHANGELOG.md}

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.7.0
+
+- Add support for Rails 6 [#18](https://github.com/machinima/epilog/pull/18)
+
+## 0.6.0
+
+- Add support for Rails 5 API-only controllers [#17](https://github.com/machinima/epilog/pull/17)
+
+## 0.5.0
+
+- Add options to enable/disable start and end logs [#15](https://github.com/machinima/epilog/pull/15)
+- Fix with_context to use ensure [#16](https://github.com/machinima/epilog/pull/16)
+
 ## 0.4.0
 
 - Add context support to Logger [#12](https://github.com/machinima/epilog/pull/12)

data/Gemfile

@@ -5,4 +5,9 @@ gemspec
 
 group :test do
   gem 'rails', "~> #{ENV.fetch('RAILS_VERSION', '5.2')}"
+  if ENV.fetch('RAILS_VERSION', '5.2').to_f >= 5
+    gem 'sqlite3', '~> 1.4'
+  else
+    gem 'sqlite3', '= 1.3.10' # rubocop:disable Bundler/DuplicatedGem
+  end
 end

data/epilog.gemspec

@@ -21,15 +21,15 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.12'
   spec.add_development_dependency 'byebug', '~> 11.0'
-  spec.add_development_dependency 'combustion', '~> 1.1.0'
+  spec.add_development_dependency 'combustion', '~> 1.3'
   spec.add_development_dependency 'irb'
-  spec.add_development_dependency 'rails', '>= 4.2', '< 6'
+  spec.add_development_dependency 'rails', '>= 4.2', '< 7'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.5'
   spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'rspec-rails', '~> 3.8.1'
   spec.add_development_dependency 'rubocop', '0.75'
   spec.add_development_dependency 'simplecov', '~> 0.17'
-  spec.add_development_dependency 'sqlite3', '~> 1.3', '< 1.4'
+  spec.add_development_dependency 'sqlite3', '~> 1.3', '< 1.5'
   spec.add_development_dependency 'yard', '~> 0.9.11'
 end

data/lib/epilog/context_logging.rb

@@ -5,6 +5,7 @@ module Epilog
     def with_context(context)
       push_context(context)
       yield
+    ensure
       pop_context
     end
 

data/lib/epilog/rails/action_controller_subscriber.rb

@@ -12,25 +12,11 @@ module Epilog
           .merge(event.payload[:context])
         )
 
-        info do
-          {
-            message: "#{request_string(event)} started",
-            request: request_hash(event)
-          }
-        end
+        log_start(event) if config.double_request_logs
       end
 
       def process_request(event)
-        info do
-          {
-            message: response_string(event),
-            request: short_request_hash(event),
-            response: response_hash(event),
-            metrics: process_metrics(event.payload[:metrics]
-              .merge(request_runtime: event.duration.round(2)))
-          }
-        end
-
+        log_end(event)
         pop_context
       end
 
@@ -84,6 +70,33 @@ module Epilog
 
       private
 
+      def log_start(event)
+        info do
+          {
+            message: "#{request_string(event)} started",
+            request: request_hash(event)
+          }
+        end
+      end
+
+      def log_end(event) # rubocop:disable MethodLength
+        request = if config.double_request_logs
+          short_request_hash(event)
+        else
+          request_hash(event)
+        end
+
+        info do
+          {
+            message: response_string(event),
+            request: request,
+            response: response_hash(event),
+            metrics: process_metrics(event.payload[:metrics]
+              .merge(request_runtime: event.duration.round(2)))
+          }
+        end
+      end
+
       def request_hash(event) # rubocop:disable AbcSize, MethodLength
         request = event.payload[:request]
         param_filter = request.send(:parameter_filter)

data/lib/epilog/rails/action_mailer_subscriber.rb

@@ -13,6 +13,8 @@ module Epilog
         end
       end
 
+      # Method `receive` removed in Rails 6.1
+      # https://github.com/rails/rails/commit/d5fa9569a0d401893d54ee47fe43fd87b6155fb7
       def receive(event)
         info do
           hash(

data/lib/epilog/rails/active_job_subscriber.rb

@@ -3,9 +3,27 @@
 module Epilog
   module Rails
     class ActiveJobSubscriber < LogSubscriber
+      # rubocop:disable Metrics/MethodLength
       def enqueue(event)
-        info { event_hash('Enqueued job', event) }
+        ex = event.payload[:exception_object]
+
+        if ex
+          error do
+            event_hash('Failed enqueuing job', event)
+          end
+        elsif event.payload[:aborted]
+          info do
+            event_hash(
+              'Failed enqueuing job, a before_enqueue callback' \
+              ' halted the enqueuing execution.',
+              event
+            )
+          end
+        else
+          info { event_hash('Enqueued job', event) }
+        end
       end
+      # rubocop:enable Metrics/MethodLength
 
       def enqueue_at(event)
         enqueue(event)
@@ -13,19 +31,49 @@ module Epilog
 
       def perform_start(event)
         push_context(job: short_job_hash(event.payload[:job]))
+        return unless config.double_job_logs
+
         info { event_hash('Performing job', event) }
       end
 
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
       def perform(event)
-        info do
-          event_hash('Performed job', event).merge(
-            metrics: {
-              job_runtime: event.duration
-            }
-          )
+        ex = event.payload[:exception_object]
+        if ex
+          error do
+            event_hash('Error performing job', event).merge(
+              metrics: {
+                job_runtime: event.duration
+              }
+            )
+          end
+        elsif event.payload[:aborted]
+          error do
+            event_hash(
+              'Error performing job, a before_perform ' \
+              'callback halted the job execution',
+              event
+            ).merge(
+              metrics: {
+                job_runtime: event.duration
+              }
+            )
+          end
+        else
+          info do
+            event_hash('Performed job', event).merge(
+              metrics: {
+                job_runtime: event.duration
+              }
+            )
+          end
         end
+
         pop_context
       end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       private
 

data/lib/epilog/rails/epilog_ext.rb

@@ -2,10 +2,15 @@
 
 module Epilog
   class Logger
-    include LoggerSilence
-
     def silencer
       false
     end
   end
 end
+
+logger_silencer = if Rails::VERSION::MAJOR >= 6
+  ActiveSupport::LoggerSilence
+else
+  ::LoggerSilence
+end
+Epilog::Logger.send(:include, logger_silencer)

data/lib/epilog/rails/ext/action_controller.rb

@@ -47,4 +47,17 @@ module Epilog
   end
 end
 
-ActionController::Base.prepend(Epilog::ActionControllerExt)
+def prepend_controller_ext
+  ActionController::Base.prepend(Epilog::ActionControllerExt)
+  return unless defined? ActionController::API
+
+  ActionController::API.prepend(Epilog::ActionControllerExt)
+end
+
+if ::Rails::VERSION::MAJOR < 5
+  prepend_controller_ext
+else
+  ActiveSupport.on_load(:action_controller_base) do
+    prepend_controller_ext
+  end
+end

data/lib/epilog/rails/log_subscriber.rb

@@ -17,6 +17,10 @@ module Epilog
       def pop_context
         @logger.try(:pop_context)
       end
+
+      def config
+        ::Rails.application.config.epilog
+      end
     end
   end
 end

data/lib/epilog/rails/railtie.rb

@@ -3,6 +3,15 @@
 module Epilog
   module Rails
     class Railtie < ::Rails::Railtie
+      def self.rails_6_1_higher?
+        Gem::Version.new(::Rails::VERSION::STRING) >= Gem::Version.new('6.1.0')
+      end
+
+      # We need this in Rails 6.
+      # Without this line `ActiveJob::LogSubscriber` fails
+      # with unknown contant error
+      ActiveSupport.run_load_hooks(:active_job, ActiveJob::Base)
+
       SUBSCRIBERS = {
         action_controller: ActionControllerSubscriber,
         action_mailer: ActionMailerSubscriber,
@@ -16,10 +25,16 @@ module Epilog
         ActionMailer::LogSubscriber,
         ActionView::LogSubscriber,
         ActiveRecord::LogSubscriber,
-        ActiveJob::Logging::LogSubscriber
+        if rails_6_1_higher?
+          ActiveJob::LogSubscriber
+        else
+          ActiveJob::Logging::LogSubscriber
+        end
       ].freeze
 
       config.epilog = ActiveSupport::OrderedOptions.new
+      config.epilog.double_request_logs = true
+      config.epilog.double_job_logs = true
       config.epilog.subscriptions = %i[
         action_controller
         action_mailer
@@ -54,7 +69,7 @@ module Epilog
 
       def unsubscribe_listeners(subscriber, pattern)
         notifier = ActiveSupport::Notifications.notifier
-        notifier.listeners_for(pattern).each do |listener|
+        notifier.listeners_for(Array.wrap(pattern).first).each do |listener|
           if listener.delegates_to?(subscriber)
             ActiveSupport::Notifications.unsubscribe(listener)
           end

data/lib/epilog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Epilog
-  VERSION = '0.4.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epilog
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Howard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: irb
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,7 @@ dependencies:
         version: '1.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -189,7 +189,7 @@ dependencies:
         version: '1.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -204,7 +204,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.11
-description: 
+description:
 email:
 - jmhoward0@gmail.com
 executables: []
@@ -216,7 +216,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
-- CHANGLOG.md
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -258,7 +258,7 @@ homepage: https://github.com/machinima/epilog
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -273,9 +273,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A JSON logger with Rails support
 test_files: []