airbrake-ruby 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6225e22d263a35ca8bc1e40a9b8d9a688738f37e
-  data.tar.gz: d8d9046a0acee6834eb604769ed39d696c2c2325
+  metadata.gz: 0e642b4f41129e726c7f8107ca0d1eeb6880a701
+  data.tar.gz: 01f580af59e4108972b56ea5dd2cc9eb00e40140
 SHA512:
-  metadata.gz: 35a1011b7fcf9380a20b934a04dccfaec4acd83a171060ff6457370e8da90fac83b6ba48d8d60e50b2ed0e21611aa5d0dda3cf210a5d7d6710115cdc0cfcfaeb
-  data.tar.gz: '098415b654116fce90700b9e4f7d540637c98d5712b321eb808c20c386a3100a3e63ba68ab6d514029831e84dab9585e66dc17cafcf271c916dc81ab3ebf6089'
+  metadata.gz: 3fcf97fff4a036e3be64919f31b38c6e195ff71b9e108181026c9a18d11ce89ab32bd59b496563c967d861d89014e60e2d4d84c3d18f81627c916f3628b35c58
+  data.tar.gz: 17923e72b4a4938fff36c4feb68df58fea240a96d957c72866feae53b920c3dcfee5ba3fcf5c3a2354279ef309156c2d7879856035454eccca7e8b0109ff58fc

data/lib/airbrake-ruby.rb

@@ -8,6 +8,7 @@ require 'time'
 
 require 'airbrake-ruby/version'
 require 'airbrake-ruby/loggable'
+require 'airbrake-ruby/stashable'
 require 'airbrake-ruby/config'
 require 'airbrake-ruby/config/validator'
 require 'airbrake-ruby/promise'
@@ -346,11 +347,15 @@ module Airbrake
     #   (optional)
     # @option request_info [Date] :start_time When the request started
     # @option request_info [Time] :end_time When the request ended (optional)
+    # @param [Hash] stash What needs to be appeneded to the stash, so it's
+    #   available in filters
     # @return [void]
     # @since v3.0.0
     # @see Airbrake::PerformanceNotifier#notify
-    def notify_request(request_info)
-      performance_notifier.notify(Request.new(request_info))
+    def notify_request(request_info, stash = {})
+      request = Request.new(request_info)
+      request.stash.merge!(stash)
+      performance_notifier.notify(request)
     end
 
     # Increments SQL statistics of a certain +query+ that was invoked on
@@ -377,11 +382,15 @@ module Airbrake
     # @option request_info [String] :query The query that was executed
     # @option request_info [Date] :start_time When the query started executing
     # @option request_info [Time] :end_time When the query finished (optional)
+    # @param [Hash] stash What needs to be appeneded to the stash, so it's
+    #   available in filters
     # @return [void]
     # @since v3.2.0
     # @see Airbrake::PerformanceNotifier#notify
-    def notify_query(query_info)
-      performance_notifier.notify(Query.new(query_info))
+    def notify_query(query_info, stash = {})
+      query = Query.new(query_info)
+      query.stash.merge!(stash)
+      performance_notifier.notify(query)
     end
 
     # Increments performance breakdown statistics of a certain route.
@@ -402,10 +411,14 @@ module Airbrake
     # @option breakdown_info [String] :response_type
     # @option breakdown_info [Array<Hash{Symbol=>Float}>] :groups
     # @option breakdown_info [Date] :start_time
+    # @param [Hash] stash What needs to be appeneded to the stash, so it's
+    #   available in filters
     # @return [void]
     # @since v4.2.0
-    def notify_performance_breakdown(breakdown_info)
-      performance_notifier.notify(PerformanceBreakdown.new(breakdown_info))
+    def notify_performance_breakdown(breakdown_info, stash = {})
+      performance_breakdown = PerformanceBreakdown.new(breakdown_info)
+      performance_breakdown.stash.merge!(stash)
+      performance_notifier.notify(performance_breakdown)
     end
 
     # Runs a callback before {.notify_request} or {.notify_query} kicks in. This

data/lib/airbrake-ruby/notice.rb

@@ -51,11 +51,7 @@ module Airbrake
 
     include Ignorable
     include Loggable
-
-    # @since v1.7.0
-    # @return [Hash{Symbol=>Object}] the hash with arbitrary objects to be used
-    #   in filters
-    attr_reader :stash
+    include Stashable
 
     # @api private
     def initialize(exception, params = {})
@@ -69,8 +65,9 @@ module Airbrake
         session: {},
         params: params
       }
-      @stash = { exception: exception }
       @truncator = Airbrake::Truncator.new(PAYLOAD_MAX_SIZE)
+
+      stash[:exception] = exception
     end
 
     # Converts the notice to JSON. Calls +to_json+ on each object inside

data/lib/airbrake-ruby/performance_breakdown.rb

@@ -11,6 +11,7 @@ module Airbrake
   ) do
     include HashKeyable
     include Ignorable
+    include Stashable
 
     def initialize(
       method:,

data/lib/airbrake-ruby/query.rb

@@ -10,6 +10,7 @@ module Airbrake
   ) do
     include HashKeyable
     include Ignorable
+    include Stashable
 
     def initialize(
       method:,

data/lib/airbrake-ruby/request.rb

@@ -8,6 +8,7 @@ module Airbrake
   Request = Struct.new(:method, :route, :status_code, :start_time, :end_time) do
     include HashKeyable
     include Ignorable
+    include Stashable
 
     def initialize(
       method:,

data/lib/airbrake-ruby/stashable.rb

@@ -0,0 +1,15 @@
+module Airbrake
+  # Stashable should be included in any class that wants the ability to stash
+  # arbitrary objects. It is mainly used by data objects that users can access
+  # through filters.
+  #
+  # @since v4.4.0
+  # @api private
+  module Stashable
+    # @return [Hash{Symbol=>Object}] the hash with arbitrary objects to be used
+    #   in filters
+    def stash
+      @stash ||= {}
+    end
+  end
+end

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.3.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.4.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -195,6 +195,114 @@ RSpec.describe Airbrake do
     end
   end
 
+  describe "#notify_request" do
+    context "when :stash key is not provided" do
+      it "doesn't add anything to the stash of the request" do
+        expect(described_class.performance_notifier).to receive(:notify) do |request|
+          expect(request.stash).to be_empty
+        end
+
+        described_class.notify_request(
+          method: 'GET',
+          route: '/',
+          status_code: 200,
+          start_time: Time.now
+        )
+      end
+    end
+
+    context "when :stash key is provided" do
+      it "adds the value as the stash of the request" do
+        expect(described_class.performance_notifier).to receive(:notify) do |request|
+          expect(request.stash).to eq(request_id: 1)
+        end
+
+        described_class.notify_request(
+          {
+            method: 'GET',
+            route: '/',
+            status_code: 200,
+            start_time: Time.now
+          },
+          request_id: 1
+        )
+      end
+    end
+  end
+
+  describe "#notify_query" do
+    context "when :stash key is not provided" do
+      it "doesn't add anything to the stash of the query" do
+        expect(described_class.performance_notifier).to receive(:notify) do |query|
+          expect(query.stash).to be_empty
+        end
+
+        described_class.notify_query(
+          method: 'GET',
+          route: '/',
+          query: '',
+          start_time: Time.now
+        )
+      end
+    end
+
+    context "when :stash key is provided" do
+      it "adds the value as the stash of the query" do
+        expect(described_class.performance_notifier).to receive(:notify) do |query|
+          expect(query.stash).to eq(request_id: 1)
+        end
+
+        described_class.notify_query(
+          {
+            method: 'GET',
+            route: '/',
+            query: '',
+            start_time: Time.now
+          },
+          request_id: 1
+        )
+      end
+    end
+  end
+
+  describe "#notify_performance_breakdown" do
+    context "when :stash key is not provided" do
+      it "doesn't add anything to the stash of the performance breakdown" do
+        expect(described_class.performance_notifier).to receive(:notify) do |query|
+          expect(query.stash).to be_empty
+        end
+
+        described_class.notify_query(
+          method: 'GET',
+          route: '/',
+          query: '',
+          start_time: Time.now
+        )
+      end
+    end
+
+    context "when :stash key is provided" do
+      it "adds the value as the stash of the performance breakdown" do
+        expect(
+          described_class.performance_notifier
+        ).to receive(:notify) do |performance_breakdown|
+          expect(performance_breakdown.stash).to eq(request_id: 1)
+        end
+
+        described_class.notify_performance_breakdown(
+          {
+            method: 'GET',
+            route: '/',
+            response_type: :html,
+            groups: {},
+            start_time: Time.now
+          },
+          request_id: 1
+        )
+      end
+    end
+  end
+
   describe ".performance_notifier" do
     it "returns a performance notifier" do
       expect(described_class.performance_notifier)

data/spec/notice_spec.rb

@@ -289,10 +289,8 @@ RSpec.describe Airbrake::Notice do
   end
 
   describe "#stash" do
-    it "returns a hash" do
-      obj = Object.new
-      notice.stash[:bingo_object] = obj
-      expect(notice.stash[:bingo_object]).to eql(obj)
-    end
+    subject { described_class.new(AirbrakeTestError.new) }
+
+    it { is_expected.to respond_to(:stash) }
   end
 end

data/spec/performance_breakdown_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe Airbrake::PerformanceBreakdown do
+  describe "#stash" do
+    subject do
+      described_class.new(
+        method: 'GET', route: '/', response_type: '', groups: {},
+        start_time: Time.now
+      )
+    end
+
+    it { is_expected.to respond_to(:stash) }
+  end
+end

data/spec/query_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Airbrake::Query do
+  describe "#stash" do
+    subject do
+      described_class.new(
+        method: 'GET', route: '/', query: '', start_time: Time.now
+      )
+    end
+
+    it { is_expected.to respond_to(:stash) }
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe Airbrake::Request do
+  describe "#stash" do
+    subject do
+      described_class.new(
+        method: 'GET', route: '/', status_code: 200, start_time: Time.now
+      )
+    end
+
+    it { is_expected.to respond_to(:stash) }
+  end
+end

data/spec/stashable_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe Airbrake::Stashable do
+  let(:klass) do
+    mod = described_class
+    Class.new { include(mod) }
+  end
+
+  describe "#stash" do
+    subject { klass.new }
+
+    it "returns a hash" do
+      expect(subject.stash).to be_a(Hash)
+    end
+
+    it "returns an empty hash" do
+      expect(subject.stash).to be_empty
+    end
+
+    it "remembers what was put in the stash" do
+      subject.stash[:foo] = 1
+      expect(subject.stash[:foo]).to eq(1)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -76,6 +76,7 @@ files:
 - lib/airbrake-ruby/query.rb
 - lib/airbrake-ruby/request.rb
 - lib/airbrake-ruby/response.rb
+- lib/airbrake-ruby/stashable.rb
 - lib/airbrake-ruby/stat.rb
 - lib/airbrake-ruby/sync_sender.rb
 - lib/airbrake-ruby/tdigest.rb
@@ -120,10 +121,14 @@ files:
 - spec/notice_notifier_spec.rb
 - spec/notice_notifier_spec/options_spec.rb
 - spec/notice_spec.rb
+- spec/performance_breakdown_spec.rb
 - spec/performance_notifier_spec.rb
 - spec/promise_spec.rb
+- spec/query_spec.rb
+- spec/request_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
+- spec/stashable_spec.rb
 - spec/stat_spec.rb
 - spec/sync_sender_spec.rb
 - spec/tdigest_spec.rb
@@ -174,6 +179,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/notice_spec.rb
 - spec/config_spec.rb
+- spec/performance_breakdown_spec.rb
 - spec/tdigest_spec.rb
 - spec/async_sender_spec.rb
 - spec/stat_spec.rb
@@ -189,6 +195,7 @@ test_files:
 - spec/airbrake_spec.rb
 - spec/nested_exception_spec.rb
 - spec/timed_trace_spec.rb
+- spec/request_spec.rb
 - spec/filter_chain_spec.rb
 - spec/response_spec.rb
 - spec/file_cache.rb
@@ -201,4 +208,6 @@ test_files:
 - spec/fixtures/project_root/vendor/bundle/ignored_file.rb
 - spec/monotonic_time_spec.rb
 - spec/inspectable_spec.rb
+- spec/stashable_spec.rb
+- spec/query_spec.rb
 - spec/notice_notifier_spec/options_spec.rb