airbrake-ruby 4.1.0 → 5.0.0

data/spec/fixtures/project_root/code.rb

@@ -10,7 +10,7 @@ module Airbrake
     NOTIFIER = {
       name: 'airbrake-ruby'.freeze,
       version: Airbrake::AIRBRAKE_RUBY_VERSION,
-      url: 'https://github.com/airbrake/airbrake-ruby'.freeze
+      url: 'https://github.com/airbrake/airbrake-ruby'.freeze,
     }.freeze
 
     ##
@@ -19,7 +19,7 @@ module Airbrake
     CONTEXT = {
       os: RUBY_PLATFORM,
       language: "#{RUBY_ENGINE}/#{RUBY_VERSION}".freeze,
-      notifier: NOTIFIER
+      notifier: NOTIFIER,
     }.freeze
 
     ##
@@ -38,7 +38,7 @@ module Airbrake
       IOError,
       NotImplementedError,
       JSON::GeneratorError,
-      Encoding::UndefinedConversionError
+      Encoding::UndefinedConversionError,
     ].freeze
 
     # @return [Array<Symbol>] the list of keys that can be be overwritten with
@@ -71,10 +71,10 @@ module Airbrake
         errors: NestedException.new(config, exception).as_json,
         context: context,
         environment: {
-          program_name: $PROGRAM_NAME
+          program_name: $PROGRAM_NAME,
         },
         session: {},
-        params: params
+        params: params,
       }
       @stash = { exception: exception }
       @truncator = Airbrake::Truncator.new(PAYLOAD_MAX_SIZE)
@@ -170,7 +170,7 @@ module Airbrake
         # Make sure we always send hostname.
         hostname: HOSTNAME,
 
-        severity: DEFAULT_SEVERITY
+        severity: DEFAULT_SEVERITY,
       }.merge(CONTEXT).delete_if { |_key, val| val.nil? || val.empty? }
     end
 
@@ -187,7 +187,7 @@ module Airbrake
         @config.logger.error(
           "#{LOG_LABEL} truncation failed. File an issue at " \
           "https://github.com/airbrake/airbrake-ruby " \
-          "and attach the following payload: #{@payload}"
+          "and attach the following payload: #{@payload}",
         )
       end
 
@@ -202,7 +202,7 @@ module Airbrake
         attributes = exception.to_airbrake
       rescue StandardError => ex
         @config.logger.error(
-          "#{LOG_LABEL} #{exception.class}#to_airbrake failed: #{ex.class}: #{ex}"
+          "#{LOG_LABEL} #{exception.class}#to_airbrake failed: #{ex.class}: #{ex}",
         )
       end
 
@@ -213,7 +213,7 @@ module Airbrake
       rescue TypeError
         @config.logger.error(
           "#{LOG_LABEL} #{exception.class}#to_airbrake failed:" \
-          " #{attributes} must be a Hash"
+          " #{attributes} must be a Hash",
         )
       end
     end

data/spec/loggable_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe Airbrake::Loggable do
+  describe ".instance" do
+    it "returns a logger" do
+      expect(described_class.instance).to be_a(Logger)
+    end
+  end
+
+  describe "#logger" do
+    let(:subject) do
+      Class.new { include Airbrake::Loggable }.new
+    end
+
+    it "returns a logger that has Logger::WARN severity" do
+      expect(subject.logger.level).to eq(Logger::WARN)
+    end
+  end
+end

data/spec/monotonic_time_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe Airbrake::MonotonicTime do
+  describe ".time_in_ms" do
+    it "returns monotonic time in milliseconds" do
+      expect(subject.time_in_ms).to be_a(Float)
+    end
+
+    it "always returns time in the future" do
+      old_time = subject.time_in_ms
+      expect(subject.time_in_ms).to be > old_time
+    end
+  end
+
+  describe ".time_in_s" do
+    it "returns monotonic time in seconds" do
+      expect(subject.time_in_s).to be_a(Float)
+    end
+
+    it "always returns time in the future" do
+      old_time = subject.time_in_s
+      expect(subject.time_in_s).to be > old_time
+    end
+  end
+end

data/spec/{notice_notifier_spec → notice_notifier}/options_spec.rb

@@ -1,8 +1,4 @@
 RSpec.describe Airbrake::NoticeNotifier do
-  def expect_a_request_with_body(body)
-    expect(a_request(:post, endpoint).with(body: body)).to have_been_made.once
-  end
-
   let(:project_id) { 105138 }
   let(:project_key) { 'fd04e13d806a90f96614ad8e529b2822' }
   let(:localhost) { 'http://localhost:8080' }
@@ -19,7 +15,7 @@ RSpec.describe Airbrake::NoticeNotifier do
 
     Airbrake::Config.instance = Airbrake::Config.new(
       project_id: project_id,
-      project_key: project_key
+      project_key: project_key,
     )
   end
 
@@ -67,7 +63,9 @@ RSpec.describe Airbrake::NoticeNotifier do
 
     describe ":root_directory" do
       before do
-        Airbrake::Config.instance.merge(root_directory: '/home/kyrylo/code')
+        subject.add_filter(
+          Airbrake::Filters::RootDirectoryFilter.new('/home/kyrylo/code'),
+        )
       end
 
       it "filters out frames" do
@@ -75,7 +73,7 @@ RSpec.describe Airbrake::NoticeNotifier 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
 
@@ -87,7 +85,7 @@ RSpec.describe Airbrake::NoticeNotifier do
             subject.notify_sync(ex)
             expect(
               a_request(:post, endpoint)
-              .with(body: %r{"rootDirectory":"/bingo/bango"})
+              .with(body: %r{"rootDirectory":"/bingo/bango"}),
             ).to have_been_made.once
           end
         end
@@ -107,7 +105,7 @@ RSpec.describe Airbrake::NoticeNotifier do
         WEBrick::HTTPServer.new(
           Port: 0,
           Logger: WEBrick::Log.new('/dev/null'),
-          AccessLog: []
+          AccessLog: [],
         )
       end
 
@@ -123,7 +121,7 @@ RSpec.describe Airbrake::NoticeNotifier do
       before do
         Airbrake::Config.instance.merge(
           proxy: proxy_params,
-          host: "http://localhost:#{proxy.config[:Port]}"
+          host: "http://localhost:#{proxy.config[:Port]}",
         )
 
         proxy.mount_proc '/' do |req, res|
@@ -141,7 +139,7 @@ RSpec.describe Airbrake::NoticeNotifier do
         if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
           skip(
             "We use Webmock 2, which doesn't support Ruby 2.6+. It's " \
-            "safe to run this test on 2.6+ once we upgrade to Webmock 3.5+"
+            "safe to run this test on 2.6+ once we upgrade to Webmock 3.5+",
           )
         end
         subject.notify_sync(ex)
@@ -151,10 +149,10 @@ RSpec.describe Airbrake::NoticeNotifier do
         expect(proxied_request.header['proxy-authorization'].first)
           .to eq('Basic dXNlcjpwYXNzd29yZA==')
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         expect(proxied_request.request_line)
           .to eq("POST http://localhost:#{proxy.config[:Port]}/api/v3/projects/105138/notices HTTP/1.1\r\n")
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
       end
     end
 
@@ -166,7 +164,7 @@ RSpec.describe Airbrake::NoticeNotifier do
           subject.notify_sync(ex)
           expect(
             a_request(:post, endpoint)
-            .with(body: /"context":{.*"environment":"production".*}/)
+            .with(body: /"context":{.*"environment":"production".*}/),
           ).to have_been_made.once
         end
       end
@@ -194,7 +192,7 @@ RSpec.describe Airbrake::NoticeNotifier do
       context "when env is set and ignore_environments doesn't mention it" do
         params = {
           environment: :development,
-          ignore_environments: [:production]
+          ignore_environments: [:production],
         }
 
         include_examples 'sent notice', params
@@ -203,7 +201,7 @@ RSpec.describe Airbrake::NoticeNotifier do
       context "when the current env and notify envs are the same" do
         params = {
           environment: :development,
-          ignore_environments: %i[production development]
+          ignore_environments: %i[production development],
         }
 
         include_examples 'ignored notice', params
@@ -229,21 +227,21 @@ RSpec.describe Airbrake::NoticeNotifier do
       context "when ignore_environments specifies a Regexp pattern" do
         params = {
           environment: :testing,
-          ignore_environments: ['staging', /test.+/]
+          ignore_environments: ['staging', /test.+/],
         }
 
         include_examples 'ignored notice', params
       end
     end
 
-    describe ":blacklist_keys" do
+    describe ":blocklist_keys" do
       # Fixes https://github.com/airbrake/airbrake-ruby/issues/276
-      context "when specified along with :whitelist_keys" do
+      context "when specified along with :allowlist_keys" do
         context "and when context payload is present" do
           before do
             Airbrake::Config.instance.merge(
-              blacklist_keys: %i[password password_confirmation],
-              whitelist_keys: [:email, /user/i, 'account_id']
+              blocklist_keys: %i[password password_confirmation],
+              allowlist_keys: [:email, /user/i, 'account_id'],
             )
           end
 

data/spec/notice_notifier_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Airbrake::NoticeNotifier do
       project_id: 1,
       project_key: 'abc',
       logger: Logger.new('/dev/null'),
-      performance_stats: true
+      performance_stats: true,
     )
   end
 
@@ -23,62 +23,6 @@ RSpec.describe Airbrake::NoticeNotifier do
           .with(instance_of(Airbrake::Filters::ExceptionAttributesFilter))
         subject
       end
-
-      context "when user config has some whitelist keys" do
-        before { Airbrake::Config.instance.merge(whitelist_keys: %w[foo]) }
-
-        it "appends the whitelist filter" do
-          expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::KeysWhitelist))
-          subject
-        end
-      end
-
-      context "when user config doesn't have any whitelist keys" do
-        it "doesn't append the whitelist filter" do
-          expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::KeysWhitelist))
-          subject
-        end
-      end
-
-      context "when user config has some blacklist keys" do
-        before { Airbrake::Config.instance.merge(blacklist_keys: %w[bar]) }
-
-        it "appends the blacklist filter" do
-          expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::KeysBlacklist))
-          subject
-        end
-      end
-
-      context "when user config doesn't have any blacklist keys" do
-        it "doesn't append the blacklist filter" do
-          expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::KeysBlacklist))
-          subject
-        end
-      end
-
-      context "when user config specifies a root directory" do
-        before { Airbrake::Config.instance.merge(root_directory: '/foo') }
-
-        it "appends the root directory filter" do
-          expect_any_instance_of(Airbrake::FilterChain).to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::RootDirectoryFilter))
-          subject
-        end
-      end
-
-      context "when user config doesn't specify a root directory" do
-        it "doesn't append the root directory filter" do
-          expect_any_instance_of(Airbrake::Config).to receive(:root_directory)
-            .and_return(nil)
-          expect_any_instance_of(Airbrake::FilterChain).not_to receive(:add_filter)
-            .with(instance_of(Airbrake::Filters::RootDirectoryFilter))
-          subject
-        end
-      end
     end
   end
 
@@ -88,7 +32,7 @@ RSpec.describe Airbrake::NoticeNotifier do
     let(:body) do
       {
         'id' => '00054414-b147-6ffa-85d6-1524d83362a6',
-        'url' => 'http://localhost/locate/00054414-b147-6ffa-85d6-1524d83362a6'
+        'url' => 'http://localhost/locate/00054414-b147-6ffa-85d6-1524d83362a6',
       }.to_json
     end
 
@@ -166,7 +110,7 @@ RSpec.describe Airbrake::NoticeNotifier do
       before do
         Airbrake::Config.instance.merge(
           environment: 'test',
-          ignore_environments: %w[test]
+          ignore_environments: %w[test],
         )
       end
 
@@ -185,14 +129,10 @@ RSpec.describe Airbrake::NoticeNotifier do
   describe "#notify_sync" do
     let(:endpoint) { 'https://api.airbrake.io/api/v3/projects/1/notices' }
 
-    let(:user_params) do
-      { project_id: 1, project_key: 'abc', logger: Logger.new('/dev/null') }
-    end
-
     let(:body) do
       {
         'id' => '00054414-b147-6ffa-85d6-1524d83362a6',
-        'url' => 'http://localhost/locate/00054414-b147-6ffa-85d6-1524d83362a6'
+        'url' => 'http://localhost/locate/00054414-b147-6ffa-85d6-1524d83362a6',
       }
     end
 
@@ -213,8 +153,8 @@ RSpec.describe Airbrake::NoticeNotifier do
       subject.notify_sync('foo', bingo: 'bango')
       expect(
         a_request(:post, endpoint).with(
-          body: /"params":{.*"bingo":"bango".*}/
-        )
+          body: /"params":{.*"bingo":"bango".*}/,
+        ),
       ).to have_been_made.once
     end
 
@@ -250,7 +190,7 @@ RSpec.describe Airbrake::NoticeNotifier do
     context "when the provided environment is ignored" do
       before do
         Airbrake::Config.instance.merge(
-          environment: 'test', ignore_environments: %w[test]
+          environment: 'test', ignore_environments: %w[test],
         )
       end
 
@@ -316,7 +256,7 @@ RSpec.describe Airbrake::NoticeNotifier do
           it "returns the full generated backtrace" do
             backtrace = [
               "/lib/airbrake-ruby/a.rb:84:in `build_notice'",
-              "/lib/airbrake-ruby/b.rb:124:in `send_notice'"
+              "/lib/airbrake-ruby/b.rb:124:in `send_notice'",
             ]
             allow(Kernel).to receive(:caller).and_return(backtrace)
 
@@ -325,8 +265,8 @@ RSpec.describe Airbrake::NoticeNotifier do
             expect(notice[:errors].first[:backtrace]).to eq(
               [
                 { file: '/lib/airbrake-ruby/a.rb', line: 84, function: 'build_notice' },
-                { file: '/lib/airbrake-ruby/b.rb', line: 124, function: 'send_notice' }
-              ]
+                { file: '/lib/airbrake-ruby/b.rb', line: 124, function: 'send_notice' },
+              ],
             )
           end
         end
@@ -336,7 +276,7 @@ RSpec.describe Airbrake::NoticeNotifier do
             backtrace = [
               "/airbrake-ruby/lib/airbrake-ruby/a.rb:84:in `b'",
               "/airbrake-ruby/lib/foo/b.rb:84:in `build'",
-              "/airbrake-ruby/lib/bar/c.rb:124:in `send'"
+              "/airbrake-ruby/lib/bar/c.rb:124:in `send'",
             ]
             allow(Kernel).to receive(:caller).and_return(backtrace)
 
@@ -345,8 +285,8 @@ RSpec.describe Airbrake::NoticeNotifier do
             expect(notice[:errors].first[:backtrace]).to eq(
               [
                 { file: '/airbrake-ruby/lib/foo/b.rb', line: 84, function: 'build' },
-                { file: '/airbrake-ruby/lib/bar/c.rb', line: 124, function: 'send' }
-              ]
+                { file: '/airbrake-ruby/lib/bar/c.rb', line: 124, function: 'send' },
+              ],
             )
           end
         end
@@ -363,21 +303,21 @@ RSpec.describe Airbrake::NoticeNotifier do
         backtrace = [
           "org/jruby/RubyKernel.java:998:in `eval'",
           "/ruby/stdlib/irb/workspace.rb:87:in `evaluate'",
-          "/ruby/stdlib/irb.rb:489:in `block in eval_input'"
+          "/ruby/stdlib/irb.rb:489:in `block in eval_input'",
         ]
         allow(Kernel).to receive(:caller).and_return(backtrace)
 
         notice = subject.build_notice(Exception.new)
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         expect(notice[:errors].first[:backtrace]).to eq(
           [
             { file: 'org/jruby/RubyKernel.java', line: 998, function: 'eval' },
             { file: '/ruby/stdlib/irb/workspace.rb', line: 87, function: 'evaluate' },
-            { file: '/ruby/stdlib/irb.rb:489', line: 489, function: 'block in eval_input' }
-          ]
+            { file: '/ruby/stdlib/irb.rb:489', line: 489, function: 'block in eval_input' },
+          ],
         )
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
       end
     end
 
@@ -388,9 +328,9 @@ RSpec.describe Airbrake::NoticeNotifier do
       end
 
       it "raises error" do
-        expect { subject.build_notice(Exception.new) }.to raise_error(
+        expect { subject.build_notice(Exception.new('oops')) }.to raise_error(
           Airbrake::Error,
-          'attempted to build Exception with closed Airbrake instance'
+          "Airbrake is closed; can't build exception: Exception: oops",
         )
       end
     end

data/spec/notice_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe Airbrake::Notice do
         before do
           Airbrake::Config.instance.merge(
             app_version: "1.2.3",
-            root_directory: "/one/two"
+            root_directory: "/one/two",
           )
         end
 
@@ -34,7 +34,7 @@ RSpec.describe Airbrake::Notice do
     context "when versions is empty" do
       it "doesn't set the 'versions' payload" do
         expect(notice.to_json).not_to match(
-          /"context":{"versions":{"dep":"1.2.3"}}/
+          /"context":{"versions":{"dep":"1.2.3"}}/,
         )
       end
     end
@@ -43,7 +43,7 @@ RSpec.describe Airbrake::Notice do
       it "sets the 'versions' payload" do
         notice[:context][:versions] = { 'dep' => '1.2.3' }
         expect(notice.to_json).to match(
-          /"context":{.*"versions":{"dep":"1.2.3"}.*}/
+          /"context":{.*"versions":{"dep":"1.2.3"}.*}/,
         )
       end
     end
@@ -192,7 +192,7 @@ RSpec.describe Airbrake::Notice do
             it "doesn't fail" do
               notice[:params] = { a: { b: { c: ObjectWithIoIvars.new } } }
               expect(notice.to_json).to match(
-                /"params":{"a":{"b":{"c":".+ObjectWithIoIvars.+"}}.*}/
+                /"params":{"a":{"b":{"c":".+ObjectWithIoIvars.+"}}.*}/,
               )
             end
           end
@@ -201,7 +201,7 @@ RSpec.describe Airbrake::Notice do
             it "doesn't fail" do
               notice[:params] = { a: [[ObjectWithIoIvars.new]] }
               expect(notice.to_json).to match(
-                /"params":{"a":\[\[".+ObjectWithIoIvars.+"\]\].*}/
+                /"params":{"a":\[\[".+ObjectWithIoIvars.+"\]\].*}/,
               )
             end
           end
@@ -268,7 +268,7 @@ RSpec.describe Airbrake::Notice do
     it "sets a payload value" do
       hash = { bingo: 'bango' }
       notice[:params] = hash
-      expect(notice[:params]).to equal(hash)
+      expect(notice[:params]).to eq(hash)
     end
 
     it "raises error if notice is ignored" do
@@ -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,11 @@
+RSpec.describe Airbrake::PerformanceBreakdown do
+  describe "#stash" do
+    subject do
+      described_class.new(
+        method: 'GET', route: '/', response_type: '', groups: {},
+      )
+    end
+
+    it { is_expected.to respond_to(:stash) }
+  end
+end