airbrake-ruby 2.8.3 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f2a54611d3b5e6242dafa75f513058acf49d48b
-  data.tar.gz: 14871f5c3d358fbfa75718c8e1f88f3905657904
+  metadata.gz: 5a9ac80f76081013e1f710824cbe72291d26bda5
+  data.tar.gz: a665035c27cdbbdea9cb7bef43b43931be5266f9
 SHA512:
-  metadata.gz: e849545f4261e4d1136f3de74a2f0179709c5895f2ab52446c64538e4bcf0201b2d747d3d1e5df7730849148f13748dc6f4b6d227a0b30c548359013d58dd7e3
-  data.tar.gz: bf4085ed3db6b3e355a3cbc3b375d47dc74090fa70e20718fb9dac3e701ce3b9d05bf53840193b6fc5b4f75cdbd71916354b0ac0e09a872357bf7b3d5492be9c
+  metadata.gz: bc673d309a343d6b15d533e1feb4e202fcc1bb3ca31f2ef79e9af257fedd831614874c0efcfd32b88155a28448cd04affa4117567843972f594fe7a4dda77a80
+  data.tar.gz: 9e92da2e216c266de65d35c309eed96791eadd6f7e89aca0ebd9e643e49630970b0c41e7da94f15e31cafd65c7f6131668b1a7b41174a44caad94a15eaf665a9

data/lib/airbrake-ruby.rb

@@ -23,6 +23,7 @@ require 'airbrake-ruby/filters/gem_root_filter'
 require 'airbrake-ruby/filters/system_exit_filter'
 require 'airbrake-ruby/filters/root_directory_filter'
 require 'airbrake-ruby/filters/thread_filter'
+require 'airbrake-ruby/filters/context_filter'
 require 'airbrake-ruby/filter_chain'
 require 'airbrake-ruby/notifier'
 require 'airbrake-ruby/code_hunk'
@@ -268,5 +269,54 @@ module Airbrake
     def create_deploy(deploy_params)
       @notifiers[:default].create_deploy(deploy_params)
     end
+
+    ##
+    # Merges +context+ with the current context.
+    #
+    # The context will be attached to the notice object upon a notify call and
+    # cleared after it's attached. The context data is attached to the
+    # `params/airbrake_context` key.
+    #
+    # @example
+    #   class MerryGrocer
+    #     def load_fruits(fruits)
+    #       Airbrake.merge_context(fruits: fruits)
+    #     end
+    #
+    #     def deliver_fruits
+    #       Airbrake.notify('fruitception')
+    #     end
+    #
+    #     def load_veggies
+    #       Airbrake.merge_context(veggies: veggies)
+    #     end
+    #
+    #     def deliver_veggies
+    #       Airbrake.notify('veggieboom!')
+    #     end
+    #   end
+    #
+    #   grocer = MerryGrocer.new
+    #
+    #   # Load some fruits to the context.
+    #   grocer.load_fruits(%w(mango banana apple))
+    #
+    #   # Deliver the fruits. Note that we are not passing anything,
+    #   # `deliver_fruits` knows that we loaded something.
+    #   grocer.deliver_fruits
+    #
+    #   # Load some vegetables and deliver them to Airbrake. Note that the
+    #   # fruits have been delivered and therefore the grocer doesn't have them
+    #   # anymore. We merge veggies with the new context.
+    #   grocer.load_veggies(%w(cabbage carrot onion))
+    #   grocer.deliver_veggies
+    #
+    #   # The context is empty again, feel free to load more.
+    #
+    # @param [Hash{Symbol=>Object}] context
+    # @return [void]
+    def merge_context(context)
+      @notifiers[:default].merge_context(context)
+    end
   end
 end

data/lib/airbrake-ruby/async_sender.rb

@@ -80,14 +80,16 @@ module Airbrake
     # @return [Boolean] true if an instance wasn't closed, but has no workers
     # @see https://goo.gl/oydz8h Example of at_exit that prevents exit
     def has_workers?
-      return false if @closed
+      @mutex.synchronize do
+        return false if @closed
 
-      if @pid != Process.pid && @workers.list.empty?
-        @pid = Process.pid
-        spawn_workers
-      end
+        if @pid != Process.pid && @workers.list.empty?
+          @pid = Process.pid
+          spawn_workers
+        end
 
-      !@closed && @workers.list.any?
+        !@closed && @workers.list.any?
+      end
     end
 
     private

data/lib/airbrake-ruby/filters/context_filter.rb

@@ -0,0 +1,28 @@
+module Airbrake
+  module Filters
+    # Adds user context to the notice object. Clears the context after it's
+    # attached.
+    #
+    # @api private
+    # @since v2.9.0
+    class ContextFilter
+      # @return [Integer]
+      attr_reader :weight
+
+      def initialize(context)
+        @context = context
+        @weight = 119
+        @mutex = Mutex.new
+      end
+
+      def call(notice)
+        @mutex.synchronize do
+          return if @context.empty?
+
+          notice[:params][:airbrake_context] = @context.dup
+          @context.clear
+        end
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/filters/gem_root_filter.rb

@@ -5,7 +5,7 @@ module Airbrake
     class GemRootFilter
       ##
       # @return [String]
-      GEM_ROOT_LABEL = '[GEM_ROOT]'.freeze
+      GEM_ROOT_LABEL = '/GEM_ROOT'.freeze
 
       ##
       # @return [Integer]

data/lib/airbrake-ruby/filters/root_directory_filter.rb

@@ -5,7 +5,7 @@ module Airbrake
     class RootDirectoryFilter
       ##
       # @return [String]
-      PROJECT_ROOT_LABEL = '[PROJECT_ROOT]'.freeze
+      PROJECT_ROOT_LABEL = '/PROJECT_ROOT'.freeze
 
       ##
       # @return [Integer]

data/lib/airbrake-ruby/notifier.rb

@@ -31,6 +31,8 @@ module Airbrake
 
       raise Airbrake::Error, @config.validation_error_message unless @config.valid?
 
+      @context = {}
+
       @filter_chain = FilterChain.new
       add_default_filters
 
@@ -98,6 +100,12 @@ module Airbrake
       @config.valid?
     end
 
+    ##
+    # @macro see_public_api_method
+    def merge_context(context)
+      @context.merge!(context)
+    end
+
     private
 
     def convert_to_exception(ex)
@@ -162,6 +170,8 @@ module Airbrake
         )
       end
 
+      @filter_chain.add_filter(Airbrake::Filters::ContextFilter.new(@context))
+
       return unless (root_directory = @config.root_directory)
       @filter_chain.add_filter(
         Airbrake::Filters::RootDirectoryFilter.new(root_directory)
@@ -190,5 +200,7 @@ module Airbrake
     def configured?
       false
     end
+
+    def merge_context(_context); end
   end
 end

data/lib/airbrake-ruby/version.rb

@@ -4,5 +4,5 @@
 module Airbrake
   ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '2.8.3'.freeze
+  AIRBRAKE_RUBY_VERSION = '2.9.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -81,8 +81,8 @@ RSpec.describe Airbrake do
           # rubocop:disable Metrics/LineLength
           expected_body = %r|
             {"errors":\[{"type":"RuntimeError","message":"bingo","backtrace":\[
-            {"file":"\[PROJECT_ROOT\]/spec/airbrake_spec.rb","line":\d+,"function":"[\w/\s\(\)<>]+","code".+},
-            {"file":"\[GEM_ROOT\]/gems/rspec-core-.+/.+","line":\d+,"function":"[\w/\s\(\)<>]+".+
+            {"file":"/PROJECT_ROOT/spec/airbrake_spec.rb","line":\d+,"function":"[\w/\s\(\)<>]+","code".+},
+            {"file":"/GEM_ROOT/gems/rspec-core-.+/.+","line":\d+,"function":"[\w/\s\(\)<>]+".+
           |x
           # rubocop:enable Metrics/LineLength
 
@@ -163,11 +163,11 @@ RSpec.describe Airbrake do
       filter_chain = notifier.instance_variable_get(:@filter_chain)
       filters = filter_chain.instance_variable_get(:@filters)
 
-      expect(filters.size).to eq(3)
+      expect(filters.size).to eq(4)
 
       described_class.add_filter {}
 
-      expect(filters.size).to eq(4)
+      expect(filters.size).to eq(5)
       expect(filters.last).to be_a(Proc)
     end
   end
@@ -175,4 +175,8 @@ RSpec.describe Airbrake do
   describe ".build_notice" do
     include_examples 'non-configured notifier handling', :build_notice
   end
+
+  describe ".merge_context" do
+    include_examples 'non-configured notifier handling', :merge_context
+  end
 end

data/spec/filters/context_filter_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Filters::ContextFilter do
+  let(:notice) do
+    Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
+  end
+
+  context "when the current context is empty" do
+    it "doesn't merge anything with params" do
+      described_class.new({}).call(notice)
+      expect(notice[:params]).to be_empty
+    end
+  end
+
+  context "when the current context has some data" do
+    it "merges the data with params" do
+      described_class.new(apples: 'oranges').call(notice)
+      expect(notice[:params]).to eq(airbrake_context: { apples: 'oranges' })
+    end
+
+    it "clears the data from the provided context" do
+      context = { apples: 'oranges' }
+      described_class.new(context).call(notice)
+      expect(context).to be_empty
+    end
+  end
+end

data/spec/filters/gem_root_filter_spec.rb

@@ -28,9 +28,9 @@ RSpec.describe Airbrake::Filters::GemRootFilter do
       eq(
         [
           { file: "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb" },
-          { file: "[GEM_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb" },
+          { file: "/GEM_ROOT/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb" },
           { file: "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb" },
-          { file: "[GEM_ROOT]/gems/rspec-core-3.3.2/exe/rspec" }
+          { file: "/GEM_ROOT/gems/rspec-core-3.3.2/exe/rspec" }
         ]
       )
     )

data/spec/filters/root_directory_filter_spec.rb

@@ -26,9 +26,9 @@ RSpec.describe Airbrake::Filters::RootDirectoryFilter do
       eq(
         [
           { file: "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb" },
-          { file: "[PROJECT_ROOT]/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb " },
+          { file: "/PROJECT_ROOT/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb " },
           { file: "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb" },
-          { file: "[PROJECT_ROOT]/gems/rspec-core-3.3.2/exe/rspec" }
+          { file: "/PROJECT_ROOT/gems/rspec-core-3.3.2/exe/rspec" }
         ]
       )
     )

data/spec/notifier_spec.rb

@@ -614,4 +614,15 @@ RSpec.describe Airbrake::Notifier do
     subject { described_class.new(airbrake_params) }
     it { is_expected.to be_configured }
   end
+
+  describe "#merge_context" do
+    it "merges the provided context with the notice object" do
+      @airbrake.merge_context(apples: 'oranges')
+      @airbrake.notify_sync('oops')
+      expect(
+        a_request(:post, endpoint).
+        with(body: /"params":{"airbrake_context":{"apples":"oranges"}/)
+      ).to have_been_made.once
+    end
+  end
 end

data/spec/notifier_spec/options_spec.rb

@@ -75,7 +75,7 @@ RSpec.describe Airbrake::Notifier do
 
         expect(
           a_request(:post, endpoint).
-          with(body: %r|{"file":"\[PROJECT_ROOT\]/airbrake/ruby/spec/airbrake_spec.+|)
+          with(body: %r|{"file":"/PROJECT_ROOT/airbrake/ruby/spec/airbrake_spec.+|)
         ).to have_been_made.once
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.8.3
+  version: 2.9.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -123,6 +123,7 @@ files:
 - lib/airbrake-ruby/config/validator.rb
 - lib/airbrake-ruby/file_cache.rb
 - lib/airbrake-ruby/filter_chain.rb
+- lib/airbrake-ruby/filters/context_filter.rb
 - lib/airbrake-ruby/filters/gem_root_filter.rb
 - lib/airbrake-ruby/filters/keys_blacklist.rb
 - lib/airbrake-ruby/filters/keys_filter.rb
@@ -146,6 +147,7 @@ files:
 - spec/config_spec.rb
 - spec/file_cache.rb
 - spec/filter_chain_spec.rb
+- spec/filters/context_filter_spec.rb
 - spec/filters/gem_root_filter_spec.rb
 - spec/filters/keys_blacklist_spec.rb
 - spec/filters/keys_whitelist_spec.rb
@@ -198,6 +200,7 @@ test_files:
 - spec/filters/keys_whitelist_spec.rb
 - spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
+- spec/filters/context_filter_spec.rb
 - spec/filters/keys_blacklist_spec.rb
 - spec/filters/gem_root_filter_spec.rb
 - spec/spec_helper.rb