opbeat 3.0.6 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9afe9302e23fe8be3f93793b4771a7513be7f14
-  data.tar.gz: a5f25103891b82047f3d60ea0d8a87fdbd6ccccf
+  metadata.gz: bf5b5eeb0ede28475a3290ad8fc105b5fbf62db3
+  data.tar.gz: c06e9dabae76fe0a072ebdb5c042339d451eab6f
 SHA512:
-  metadata.gz: 0437ced62e7871333af7bc166c67103750ffe6a7715a9b8543f249f2a0cac78e5715230243ed0ea6155a5f77db9f07e32b476ae9f9f7879b9dffb9401bdcd6a4
-  data.tar.gz: def822d870fcd98952b5890bea29c85dbd50f66d3f515f6a14259a24ce257e5d57799d0f5cf081e08e1b98c25160b0816b2726e48b6f632e9e23be647611ab51
+  metadata.gz: 9d77abf28473b178c296f39ba161514b0d90106801546dafe75a3edef8e3b4dbd7c94ccdbf2797248fea18139b4f4e42d26f733cf2353bf5a22f0e40fef28052
+  data.tar.gz: 3735cf0fc7fb86d5bcab6b590daf82b91a36a9f5f5214b4c913b6f4cb7ff5b5aaab4e8f5338a3f45da85d812fa2355bf3408f562908ecb18a03d8439071d719a

data/HISTORY.md

@@ -1,3 +1,10 @@
+# 3.0.7
+
+**Features**
+
+- Add `config.worker_quit_timeout` (default is 5 secs) ([@jensnockert](https://github.com/jensnockert))
+- Add `Opbeat.with_context` for block-specific contexts ([@jensnockert](https://github.com/jensnockert))
+
 # 3.0.6
 
 **Fixes**

data/README.md

@@ -103,6 +103,14 @@ class DashboardController < ApplicationController
 end
 ```
 
+or by specifying it as a block using `Opbeat.context` eg:
+
+```ruby
+Opbeat.with_context(user_id: @user.id) do
+  UserMailer.welcome_email(@user).deliver_now
+end
+```
+
 ## Background processing
 
 Opbeat automatically catches exceptions in [delayed_job](https://github.com/collectiveidea/delayed_job) or [sidekiq](http://sidekiq.org/).

data/lib/opbeat.rb

@@ -86,6 +86,19 @@ module Opbeat
     client.set_context context
   end
 
+  # Updates context for errors within the block
+  #
+  # @param context [Hash]
+  # @yield [Trace] Block in which the context is used
+  def self.with_context context, &block
+    unless client
+      return yield if block_given?
+      return nil
+    end
+
+    client.context context, &block
+  end
+
   # Send an exception to Opbeat
   #
   # @param exception [Exception]

data/lib/opbeat/client.rb

@@ -173,6 +173,16 @@ module Opbeat
       @context = context
     end
 
+    def with_context context, &block
+      current = @context
+
+      set_context((current || {}).merge(context))
+
+      yield if block_given?
+    ensure
+      set_context(current)
+    end
+
     def report exception, opts = {}
       return if config.disable_errors
       return unless exception
@@ -260,7 +270,7 @@ module Opbeat
     def kill_worker
       return unless worker_running?
       @queue << Worker::StopMessage.new
-      unless @worker_thread.join 5
+      unless @worker_thread.join(config.worker_quit_timeout)
         error "Failed to wait for worker, not all messages sent"
       end
       @worker_thread = nil

data/lib/opbeat/configuration.rb

@@ -16,6 +16,7 @@ module Opbeat
       current_user_method: :current_user,
       environment: ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'default',
       transaction_post_interval: 60,
+      worker_quit_timeout: 5,
 
       disable_performance: false,
       disable_errors: false,
@@ -43,6 +44,7 @@ module Opbeat
     attr_accessor :current_user_method
     attr_accessor :environment
     attr_accessor :transaction_post_interval
+    attr_accessor :worker_quit_timeout
 
     attr_accessor :disable_performance
     attr_accessor :disable_errors

data/lib/opbeat/version.rb

@@ -1,3 +1,3 @@
 module Opbeat
-  VERSION = "3.0.6"
+  VERSION = "3.0.7"
 end

data/spec/opbeat/client_spec.rb

@@ -114,6 +114,51 @@ module Opbeat
         end
       end
 
+      describe "#with_context" do
+        it "sets context for future errors" do
+          subject.with_context(additional_information: 'remember me') do
+            exception = Exception.new('BOOM')
+            subject.report exception
+          end
+
+          expect(subject.queue.length).to be 1
+          expect(subject.queue.pop.data[:extra]).to eq(additional_information: 'remember me')
+        end
+
+        it "supports nested contexts" do
+          subject.with_context(info: 'a') do
+            subject.with_context(more_info: 'b') do
+              exception = Exception.new('BOOM')
+              subject.report exception
+            end
+          end
+
+          expect(subject.queue.length).to be 1
+          expect(subject.queue.pop.data[:extra]).to eq(info: 'a', more_info: 'b')
+        end
+
+        it "restores context for future errors" do
+          subject.set_context(info: 'hello')
+
+          subject.with_context(additional_information: 'remember me') do
+          end
+
+          exception = Exception.new('BOOM')
+          subject.report exception
+
+          expect(subject.queue.length).to be 1
+          expect(subject.queue.pop.data[:extra]).to eq(info: 'hello')
+        end
+
+        it "returns what is yielded" do
+          result = subject.with_context(additional_information: 'remember me') do
+            42
+          end
+
+          expect(result).to be 42
+        end
+      end
+
       describe "#report" do
         it "builds and posts an exception" do
           exception = Exception.new('BOOM')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opbeat
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.7
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-20 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport