isolator 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6416346eed42fd67e5cc8e6801f983fee64666e21547e603e0c137f9e6fffad6
-  data.tar.gz: b8e18e6b741c1fb19726957e99f4e04b83cb70e008cf1100db9c4fab5737250f
+  metadata.gz: d5c027f6c2e795b8aeb009340efd8a920556cfb47553a06d93f4feab8d7c79de
+  data.tar.gz: 3ae481ffdf7eba4d080402d44c7355c558363b0228053091ca96edc55bd26847
 SHA512:
-  metadata.gz: 821a71fc3afe8425b7eb7aef194c43213de681b7b2f9b468968a6dcb8479a114797451894e49ff9ea4da40f1594957e555a9c752ade26b7b76c8a80cc3eba653
-  data.tar.gz: 6440b717a3caa57454f1a6c6a5803717641e9dc32e7ef397572f131acf37f716d9f3f573ce3796c0b064fac2f0edcbdfd60ea3dec8e4b8712eca225782a9ba4d
+  metadata.gz: '008f26a3b4e3d059332e25a0b193dcec4586a17b6d6df9259b8b13e94a85e214e2c16aa37197a5490e92ba3cc288ce656c3ae1e1061e7ae7968ff4b967d327f1'
+  data.tar.gz: 2a4237282734486458d04f45474eee2a75367724808f8079801645ffe978981725f6d46e6db1de041d8c36d2cd1a5832b7f09f44e2773c609013560bd9ee5904

data/.rubocop.yml

@@ -41,6 +41,9 @@ Style/StringLiterals:
 Style/RegexpLiteral:
   Enabled: false
 
+Style/Lambda:
+  Enabled: false
+
 Style/BlockDelimiters:
   Exclude:
     - 'spec/**/*.rb'
@@ -56,6 +59,8 @@ Lint/AmbiguousRegexpLiteral:
 
 Metrics/LineLength:
   Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
 
 Metrics/BlockLength:
   Exclude:

data/.travis.yml

@@ -1,11 +1,16 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.5.0
+  - 2.5.3
 
 notifications:
   email: false
 
+before_install:
+  - (ruby -v | grep '2.2.2') || gem update --system
+  - gem install bundler -v '< 2'
+
 matrix:
   fast_finish: true
   include:
@@ -13,6 +18,8 @@ matrix:
       gemfile: gemfiles/railsmaster.gemfile
     - rvm: jruby-9.1.0.0
       gemfile: gemfiles/jruby.gemfile
+    - rvm: 2.6.1
+      gemfile: gemfiles/rails6.gemfile
     - rvm: 2.5.0
       gemfile: Gemfile
     - rvm: 2.4.3

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## master
 
+## 0.6.0 (2019-04-12) 🚀
+
+- Add support for exceptions message details. ([@palkan][])
+
+  Make it possible to provide more information about the cause of the failure
+  (for example, job class and arguments for background jobs, URL for HTTP).
+
+- Change backtrace filtering behaviour. ([@palkan][])
+
+  The default behaviour is to take the top five lines.
+  You can customize it via `Isolator.config.backtrace_filter`.
+
 ## 0.5.0 (2018-08-29)
 
 - [PR [#19](https://github.com/palkan/isolator/pull/19)] Adding support for ruby version 2.2.2. ([@shivanshgaur][])

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 
 gem "pry-byebug"
 
-gem "sqlite3"
+gem "sqlite3", "~> 1.3.0"
 
 local_gemfile = File.join(__dir__, "Gemfile.local")
 

data/README.md

@@ -91,6 +91,10 @@ Isolator.configure do |config|
 
   # Send notifications to uniform_notifier
   config.send_notifications = false
+
+  # Customize backtrace filtering (provide a callable)
+  # By default, just takes the top-5 lines
+  config.backtrace_filter = ->(backtrace) { backtrace.take(5) }
 end
 ```
 
@@ -186,6 +190,17 @@ Isolator.isolate :danger, Danger.singleton_class, :explode, options
 Possible `options` are:
 - `exception_class` – an exception class to raise in case of offense
 - `exception_message` – custom exception message (could be specified without a class)
+- `details_message` – a block to generate additional exceptin message information:
+
+```ruby
+Isolator.isolate :active_job,
+                 target: ActiveJob::Base,
+                 method_name: :enqueue,
+                 exception_class: Isolator::BackgroundJobError,
+                 details_message: ->(obj, _args) {
+                   "#{obj.class.name}(#{obj.arguments})"
+                 }
+```
 
 You can also add some callbacks to be run before and after the transaction:
 

data/gemfiles/activerecord42.gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.2"
-gem "sqlite3"
+gem "sqlite3", "~> 1.3.0"
 gem 'uniform_notifier', '~> 1.11'
 
 gemspec path: ".."

data/gemfiles/rails6.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "rails", "6.0.0.beta3"
+gem "sqlite3", "~> 1.3"
+gem 'uniform_notifier', '~> 1.11'
+
+gemspec path: ".."

data/gemfiles/railsmaster.gemfile

@@ -1,6 +1,5 @@
 source "https://rubygems.org"
 
-gem "arel", github: "rails/arel"
 gem "rails", github: "rails/rails"
 gem "sqlite3"
 gem 'uniform_notifier', '~> 1.11'

data/gemfiles/ruby_2.2.2.gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.2"
-gem "sqlite3"
+gem "sqlite3", "~> 1.3.0"
 gem 'uniform_notifier', '1.11'
 gem 'anyway_config', '1.2'
 

data/isolator.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "sniffer", "~> 0.3.1"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "bundler", ">= 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-rails", "~> 3.0"

data/lib/isolator/adapter_builder.rb

@@ -11,6 +11,7 @@ module Isolator
 
         self.exception_class = options[:exception_class] if options.key?(:exception_class)
         self.exception_message = options[:exception_message] if options.key?(:exception_message)
+        self.details_message = options[:details_message] if options.key?(:details_message)
       end
 
       add_patch_method(adapter, target, method_name) if
@@ -21,7 +22,7 @@ module Isolator
     def self.add_patch_method(adapter, base, method_name)
       mod = Module.new do
         define_method method_name do |*args, &block|
-          adapter.notify(caller, *args)
+          adapter.notify(caller, self, *args)
           super(*args, &block)
         end
       end

data/lib/isolator/adapters/background_jobs/active_job.rb

@@ -3,4 +3,8 @@
 Isolator.isolate :active_job,
                  target: ActiveJob::Base,
                  method_name: :enqueue,
-                 exception_class: Isolator::BackgroundJobError
+                 exception_class: Isolator::BackgroundJobError,
+                 details_message: ->(obj, _args) {
+                   "#{obj.class.name}" \
+                   "#{obj.arguments.any? ? " (#{obj.arguments.join(', ')})" : ''}"
+                 }

data/lib/isolator/adapters/background_jobs/resque.rb

@@ -3,4 +3,7 @@
 Isolator.isolate :resque,
                  target: Resque.singleton_class,
                  method_name: :enqueue,
-                 exception_class: Isolator::BackgroundJobError
+                 exception_class: Isolator::BackgroundJobError,
+                 details_message: ->(_obj, args) {
+                   args.join(", ")
+                 }

data/lib/isolator/adapters/background_jobs/resque_scheduler.rb

@@ -3,4 +3,7 @@
 Isolator.isolate :resque_scheduler,
                  target: Resque.singleton_class,
                  method_name: :enqueue_at,
-                 exception_class: Isolator::BackgroundJobError
+                 exception_class: Isolator::BackgroundJobError,
+                 details_message: ->(_obj, (ts, *args)) {
+                   "#{args.join(', ')} (at #{ts})"
+                 }

data/lib/isolator/adapters/background_jobs/sidekiq.rb

@@ -3,4 +3,9 @@
 Isolator.isolate :sidekiq,
                  target: Sidekiq::Client,
                  method_name: :raw_push,
-                 exception_class: Isolator::BackgroundJobError
+                 exception_class: Isolator::BackgroundJobError,
+                 details_message: ->(_obj, args) {
+                   args.first.map do |job|
+                     "#{job['class']} (#{job['args']})"
+                   end.join("\n")
+                 }

data/lib/isolator/adapters/background_jobs/sucker_punch.rb

@@ -3,4 +3,7 @@
 Isolator.isolate :sucker_punch,
                  target: SuckerPunch::Queue.singleton_class,
                  method_name: :find_or_create,
-                 exception_class: Isolator::BackgroundJobError
+                 exception_class: Isolator::BackgroundJobError,
+                 details_message: ->(_obj, args) {
+                   args.compact.join(", ")
+                 }

data/lib/isolator/adapters/base.rb

@@ -4,7 +4,7 @@ module Isolator
   module Adapters
     # Used as a "template" for adapters
     module Base
-      attr_accessor :exception_class, :exception_message
+      attr_accessor :exception_class, :exception_message, :details_message
 
       def disable!
         @disabled = true
@@ -22,9 +22,9 @@ module Isolator
         @disabled == true
       end
 
-      def notify(backtrace, *args)
+      def notify(backtrace, obj, *args)
         return unless notify?(*args)
-        Isolator.notify(exception: build_exception, backtrace: backtrace)
+        Isolator.notify(exception: build_exception(obj, args), backtrace: backtrace)
       end
 
       def notify?(*args)
@@ -45,9 +45,10 @@ module Isolator
 
       private
 
-      def build_exception
+      def build_exception(obj, args)
         klass = exception_class || Isolator::UnsafeOperationError
-        klass.new(exception_message)
+        details = details_message.call(obj, args) if details_message
+        klass.new(exception_message, details: details)
       end
     end
   end

data/lib/isolator/adapters/http/sniffer.rb

@@ -7,7 +7,11 @@ Sniffer::Config.defaults["logger"] = nil
 
 Isolator.isolate :http, target: Sniffer.singleton_class,
                         method_name: :store,
-                        exception_class: Isolator::HTTPError
+                        exception_class: Isolator::HTTPError,
+                        details_message: ->(_obj, args) {
+                          req = args.first.request
+                          "#{req[:method]} #{req[:host]}/#{req[:query]}"
+                        }
 
 Isolator.before_isolate do
   next if Isolator.adapters.http.disabled?

data/lib/isolator/adapters/http/webmock.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
-adapter = Isolator.isolate :webmock, exception_class: Isolator::HTTPError
+adapter = Isolator.isolate :webmock,
+                           exception_class: Isolator::HTTPError,
+                           details_message: ->(obj, _args) {
+                                              "#{obj.method.to_s.upcase} #{obj.uri}"
+                                            }
 
 WebMock.after_request do |*args|
   adapter.notify(caller, *args)

data/lib/isolator/adapters/mailers/mail.rb

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 
-Isolator.isolate :mailer, target: Mail::Message, method_name: :deliver,
-                          exception_class: Isolator::MailerError
+Isolator.isolate :mailer, target: Mail::Message,
+                          method_name: :deliver,
+                          exception_class: Isolator::MailerError,
+                          details_message: ->(obj, _args) {
+                            "From: #{obj.from}\n" \
+                            "To: #{obj.to}\n" \
+                            "Subject: #{obj.subject}"
+                          }

data/lib/isolator/configuration.rb

@@ -12,12 +12,14 @@ module Isolator
   # - `send_notifications` - whether to send notifications (through uniform_notifier);
   #   defauls to false
   class Configuration
-    attr_accessor :raise_exceptions, :logger, :send_notifications
+    attr_accessor :raise_exceptions, :logger, :send_notifications,
+                  :backtrace_filter
 
     def initialize
       @logger = nil
       @raise_exceptions = test_env?
       @send_notifications = false
+      @backtrace_filter = ->(backtrace) { backtrace.take(5) }
     end
 
     alias raise_exceptions? raise_exceptions

data/lib/isolator/errors.rb

@@ -4,9 +4,9 @@ module Isolator # :nodoc: all
   class UnsafeOperationError < StandardError
     MESSAGE = "You are trying to do unsafe operation inside db transaction"
 
-    def initialize(msg = nil)
+    def initialize(msg = nil, details: nil)
       msg ||= self.class::MESSAGE
-      super
+      super(details ? "#{msg}\nDetails: #{details}" : msg)
     end
   end
 

data/lib/isolator/notifier.rb

@@ -48,7 +48,7 @@ module Isolator
     end
 
     def filtered_backtrace
-      backtrace.reject { |line| line =~ /\/(gems|ruby)/ }.take_while { |line| line !~ /ruby/ }
+      Isolator.config.backtrace_filter.call(backtrace)
     end
 
     def uniform_notifier_loaded?

data/lib/isolator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Isolator
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isolator
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-02 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -253,6 +253,7 @@ files:
 - bin/setup
 - gemfiles/activerecord42.gemfile
 - gemfiles/jruby.gemfile
+- gemfiles/rails6.gemfile
 - gemfiles/railsmaster.gemfile
 - gemfiles/ruby_2.2.2.gemfile
 - isolator.gemspec
@@ -306,8 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Detect non-atomic interactions within DB transactions