airbrake-ruby 4.15.0 → 5.0.2

data/spec/backtrace_spec.rb

@@ -2,7 +2,7 @@ RSpec.describe Airbrake::Backtrace do
   describe ".parse" do
     context "UNIX backtrace" do
       let(:parsed_backtrace) do
-        # rubocop:disable Metrics/LineLength, Style/HashSyntax, Layout/SpaceAroundOperators, Layout/SpaceInsideHashLiteralBraces
+        # rubocop:disable Layout/LineLength, Style/HashSyntax, Layout/SpaceAroundOperators, Layout/SpaceInsideHashLiteralBraces
         [{:file=>"/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb", :line=>23, :function=>"<top (required)>"},
          {:file=>"/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb", :line=>54, :function=>"require"},
          {:file=>"/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb", :line=>54, :function=>"require"},
@@ -16,7 +16,7 @@ RSpec.describe Airbrake::Backtrace do
          {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb", :line=>73, :function=>"run"},
          {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/lib/rspec/core/runner.rb", :line=>41, :function=>"invoke"},
          {:file=>"/home/kyrylo/.gem/ruby/2.2.2/gems/rspec-core-3.3.2/exe/rspec", :line=>4, :function=>"<main>"}]
-        # rubocop:enable Metrics/LineLength, Style/HashSyntax, Layout/SpaceAroundOperators, Layout/SpaceInsideHashLiteralBraces
+        # rubocop:enable Layout/LineLength, Style/HashSyntax, Layout/SpaceAroundOperators, Layout/SpaceInsideHashLiteralBraces
       end
 
       it "returns a properly formatted array of hashes" do
@@ -34,10 +34,10 @@ RSpec.describe Airbrake::Backtrace do
       let(:ex) { AirbrakeTestError.new.tap { |e| e.set_backtrace(windows_bt) } }
 
       let(:parsed_backtrace) do
-        # rubocop:disable Metrics/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
+        # rubocop:disable Layout/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
         [{:file=>"C:/Program Files/Server/app/models/user.rb", :line=>13, :function=>"magic"},
          {:file=>"C:/Program Files/Server/app/controllers/users_controller.rb", :line=>8, :function=>"index"}]
-        # rubocop:enable Metrics/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
+        # rubocop:enable Layout/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
       end
 
       it "returns a properly formatted array of hashes" do
@@ -47,7 +47,7 @@ RSpec.describe Airbrake::Backtrace do
 
     context "JRuby Java exceptions" do
       let(:backtrace_array) do
-        # rubocop:disable Metrics/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
+        # rubocop:disable Layout/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
         [{:file=>"InstanceMethodInvoker.java", :line=>26, :function=>"org.jruby.java.invokers.InstanceMethodInvoker.call"},
          {:file=>"Interpreter.java", :line=>126, :function=>"org.jruby.ir.interpreter.Interpreter.INTERPRET_EVAL"},
          {:file=>"RubyKernel$INVOKER$s$0$3$eval19.gen", :line=>nil, :function=>"org.jruby.RubyKernel$INVOKER$s$0$3$eval19.call"},
@@ -59,7 +59,7 @@ RSpec.describe Airbrake::Backtrace do
          {:file=>"Compiler.java", :line=>111, :function=>"org.jruby.ir.Compiler$1.load"},
          {:file=>"Main.java", :line=>225, :function=>"org.jruby.Main.run"},
          {:file=>"Main.java", :line=>197, :function=>"org.jruby.Main.main"}]
-        # rubocop:enable Metrics/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
+        # rubocop:enable Layout/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
       end
 
       it "returns a properly formatted array of hashes" do
@@ -72,21 +72,21 @@ RSpec.describe Airbrake::Backtrace do
 
     context "JRuby classloader exceptions" do
       let(:backtrace) do
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         ['uri_3a_classloader_3a_.META_minus_INF.jruby_dot_home.lib.ruby.stdlib.net.protocol.rbuf_fill(uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/net/protocol.rb:158)',
          'bin.processors.image_uploader.block in make_streams(bin/processors/image_uploader.rb:21)',
          'uri_3a_classloader_3a_.gems.faye_minus_websocket_minus_0_dot_10_dot_5.lib.faye.websocket.api.invokeOther13:dispatch_event(uri_3a_classloader_3a_/gems/faye_minus_websocket_minus_0_dot_10_dot_5/lib/faye/websocket/uri:classloader:/gems/faye-websocket-0.10.5/lib/faye/websocket/api.rb:109)',
          'tmp.jruby9022301782566983632extract.$dot.META_minus_INF.rails.file(/tmp/jruby9022301782566983632extract/./META-INF/rails.rb:13)']
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
       end
 
       let(:parsed_backtrace) do
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         [{ file: 'uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/net/protocol.rb', line: 158, function: 'uri_3a_classloader_3a_.META_minus_INF.jruby_dot_home.lib.ruby.stdlib.net.protocol.rbuf_fill' },
          { file: 'bin/processors/image_uploader.rb', line: 21, function: 'bin.processors.image_uploader.block in make_streams' },
          { file: 'uri_3a_classloader_3a_/gems/faye_minus_websocket_minus_0_dot_10_dot_5/lib/faye/websocket/uri:classloader:/gems/faye-websocket-0.10.5/lib/faye/websocket/api.rb', line: 109, function: 'uri_3a_classloader_3a_.gems.faye_minus_websocket_minus_0_dot_10_dot_5.lib.faye.websocket.api.invokeOther13:dispatch_event' },
          { file: '/tmp/jruby9022301782566983632extract/./META-INF/rails.rb', line: 13, function: 'tmp.jruby9022301782566983632extract.$dot.META_minus_INF.rails.file' }]
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
       end
 
       let(:ex) { JavaAirbrakeTestError.new.tap { |e| e.set_backtrace(backtrace) } }
@@ -99,19 +99,19 @@ RSpec.describe Airbrake::Backtrace do
 
     context "JRuby non-throwable exceptions" do
       let(:backtrace) do
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         ['org.postgresql.core.v3.ConnectionFactoryImpl.openConnectionImpl(org/postgresql/core/v3/ConnectionFactoryImpl.java:257)',
          'org.postgresql.core.ConnectionFactory.openConnection(org/postgresql/core/ConnectionFactory.java:65)',
          'org.postgresql.jdbc2.AbstractJdbc2Connection.<init>(org/postgresql/jdbc2/AbstractJdbc2Connection.java:149)']
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
       end
 
       let(:parsed_backtrace) do
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         [{ file: 'org/postgresql/core/v3/ConnectionFactoryImpl.java', line: 257, function: 'org.postgresql.core.v3.ConnectionFactoryImpl.openConnectionImpl' },
          { file: 'org/postgresql/core/ConnectionFactory.java', line: 65, function: 'org.postgresql.core.ConnectionFactory.openConnection' },
          { file: 'org/postgresql/jdbc2/AbstractJdbc2Connection.java', line: 149, function: 'org.postgresql.jdbc2.AbstractJdbc2Connection.<init>' }]
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
       end
 
       let(:ex) { AirbrakeTestError.new.tap { |e| e.set_backtrace(backtrace) } }
@@ -123,22 +123,22 @@ RSpec.describe Airbrake::Backtrace do
 
     context "generic backtrace" do
       context "when function is absent" do
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         let(:generic_bt) do
           ["/home/bingo/bango/assets/stylesheets/error_pages.scss:139:in `animation'",
            "/home/bingo/bango/assets/stylesheets/error_pages.scss:139",
            "/home/bingo/.gem/ruby/2.2.2/gems/sass-3.4.20/lib/sass/tree/visitors/perform.rb:349:in `block in visit_mixin'"]
         end
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
 
         let(:ex) { AirbrakeTestError.new.tap { |e| e.set_backtrace(generic_bt) } }
 
         let(:parsed_backtrace) do
-          # rubocop:disable Metrics/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
+          # rubocop:disable Layout/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
           [{:file=>"/home/bingo/bango/assets/stylesheets/error_pages.scss", :line=>139, :function=>"animation"},
            {:file=>"/home/bingo/bango/assets/stylesheets/error_pages.scss", :line=>139, :function=>nil},
            {:file=>"/home/bingo/.gem/ruby/2.2.2/gems/sass-3.4.20/lib/sass/tree/visitors/perform.rb", :line=>349, :function=>"block in visit_mixin"}]
-          # rubocop:enable Metrics/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
+          # rubocop:enable Layout/LineLength, Style/HashSyntax, Layout/SpaceInsideHashLiteralBraces, Layout/SpaceAroundOperators
         end
 
         it "returns a properly formatted array of hashes" do
@@ -277,9 +277,9 @@ RSpec.describe Airbrake::Backtrace do
                 93 => '        begin',
                 94 => '          json = @payload.to_json',
                 95 => '        rescue *JSON_EXCEPTIONS => ex',
-                # rubocop:disable Metrics/LineLength,Lint/InterpolationCheck
+                # rubocop:disable Layout/LineLength,Lint/InterpolationCheck
                 96 => '          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")',
-                # rubocop:enable Metrics/LineLength,Lint/InterpolationCheck
+                # rubocop:enable Layout/LineLength,Lint/InterpolationCheck
               },
             },
             {
@@ -325,9 +325,9 @@ RSpec.describe Airbrake::Backtrace do
                 93 => '        begin',
                 94 => '          json = @payload.to_json',
                 95 => '        rescue *JSON_EXCEPTIONS => ex',
-                # rubocop:disable Metrics/LineLength,Lint/InterpolationCheck
+                # rubocop:disable Layout/LineLength,Lint/InterpolationCheck
                 96 => '          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")',
-                # rubocop:enable Metrics/LineLength,Lint/InterpolationCheck
+                # rubocop:enable Layout/LineLength,Lint/InterpolationCheck
               },
             },
           ]
@@ -357,9 +357,9 @@ RSpec.describe Airbrake::Backtrace do
                 93 => '        begin',
                 94 => '          json = @payload.to_json',
                 95 => '        rescue *JSON_EXCEPTIONS => ex',
-                # rubocop:disable Metrics/LineLength,Lint/InterpolationCheck
+                # rubocop:disable Layout/LineLength,Lint/InterpolationCheck
                 96 => '          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")',
-                # rubocop:enable Metrics/LineLength,Lint/InterpolationCheck
+                # rubocop:enable Layout/LineLength,Lint/InterpolationCheck
               },
             },
             {
@@ -370,9 +370,9 @@ RSpec.describe Airbrake::Backtrace do
                 93 => '        begin',
                 94 => '          json = @payload.to_json',
                 95 => '        rescue *JSON_EXCEPTIONS => ex',
-                # rubocop:disable Metrics/LineLength,Lint/InterpolationCheck
+                # rubocop:disable Layout/LineLength,Lint/InterpolationCheck
                 96 => '          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")',
-                # rubocop:enable Metrics/LineLength,Lint/InterpolationCheck
+                # rubocop:enable Layout/LineLength,Lint/InterpolationCheck
                 97 => '        else',
               },
             },

data/spec/code_hunk_spec.rb

@@ -34,9 +34,9 @@ RSpec.describe Airbrake::CodeHunk do
           eq(
             1 => 'module Airbrake',
             2 => '  ##',
-            # rubocop:disable Metrics/LineLength
+            # rubocop:disable Layout/LineLength
             3 => '  # Represents a chunk of information that is meant to be either sent to',
-            # rubocop:enable Metrics/LineLength
+            # rubocop:enable Layout/LineLength
           ),
         )
       end

data/spec/config/processor_spec.rb

@@ -0,0 +1,125 @@
+RSpec.describe Airbrake::Config::Processor do
+  let(:notifier) { Airbrake::NoticeNotifier.new }
+
+  describe "#process_blocklist" do
+    let(:config) { Airbrake::Config.new(blocklist_keys: %w[a b c]) }
+
+    context "when there ARE blocklist keys" do
+      it "adds the blocklist filter" do
+        described_class.new(config).process_blocklist(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::KeysBlocklist)).to eq(true)
+      end
+    end
+
+    context "when there are NO blocklist keys" do
+      let(:config) { Airbrake::Config.new(blocklist_keys: %w[]) }
+
+      it "doesn't add the blocklist filter" do
+        described_class.new(config).process_blocklist(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::KeysBlocklist))
+          .to eq(false)
+      end
+    end
+  end
+
+  describe "#process_allowlist" do
+    let(:config) { Airbrake::Config.new(allowlist_keys: %w[a b c]) }
+
+    context "when there ARE allowlist keys" do
+      it "adds the allowlist filter" do
+        described_class.new(config).process_allowlist(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::KeysAllowlist)).to eq(true)
+      end
+    end
+
+    context "when there are NO allowlist keys" do
+      let(:config) { Airbrake::Config.new(allowlist_keys: %w[]) }
+
+      it "doesn't add the allowlist filter" do
+        described_class.new(config).process_allowlist(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::KeysAllowlist))
+          .to eq(false)
+      end
+    end
+  end
+
+  describe "#process_remote_configuration" do
+    context "when the config doesn't define a project_id" do
+      let(:config) { Airbrake::Config.new(project_id: nil) }
+
+      it "doesn't set remote settings" do
+        expect(Airbrake::RemoteSettings).not_to receive(:poll)
+        described_class.new(config).process_remote_configuration
+      end
+    end
+
+    context "when the config defines a project_id" do
+      let(:config) do
+        Airbrake::Config.new(project_id: 123)
+      end
+
+      it "sets remote settings" do
+        expect(Airbrake::RemoteSettings).to receive(:poll)
+        described_class.new(config).process_remote_configuration
+      end
+    end
+  end
+
+  describe "#add_filters" do
+    context "when there's a root directory" do
+      let(:config) { Airbrake::Config.new(root_directory: '/abc') }
+
+      it "adds RootDirectoryFilter" do
+        described_class.new(config).add_filters(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::RootDirectoryFilter))
+          .to eq(true)
+      end
+
+      it "adds GitRevisionFilter" do
+        described_class.new(config).add_filters(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::GitRevisionFilter))
+          .to eq(true)
+      end
+
+      it "adds GitRepositoryFilter" do
+        described_class.new(config).add_filters(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::GitRepositoryFilter))
+          .to eq(true)
+      end
+
+      it "adds GitLastCheckoutFilter" do
+        described_class.new(config).add_filters(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::GitLastCheckoutFilter))
+          .to eq(true)
+      end
+    end
+
+    context "when there's NO root directory" do
+      let(:config) { Airbrake::Config.new(root_directory: nil) }
+
+      it "doesn't add RootDirectoryFilter" do
+        described_class.new(config).add_filters(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::RootDirectoryFilter))
+          .to eq(false)
+      end
+
+      it "doesn't add GitRevisionFilter" do
+        described_class.new(config).add_filters(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::GitRevisionFilter))
+          .to eq(false)
+      end
+
+      it "doesn't add GitRepositoryFilter" do
+        described_class.new(config).add_filters(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::GitRepositoryFilter))
+          .to eq(false)
+      end
+
+      it "doesn't add GitLastCheckoutFilter" do
+        described_class.new(config).add_filters(notifier)
+        expect(notifier.has_filter?(Airbrake::Filters::GitLastCheckoutFilter))
+          .to eq(false)
+      end
+    end
+  end
+end

data/spec/config/validator_spec.rb

@@ -169,7 +169,7 @@ RSpec.describe Airbrake::Config::Validator do
         }
       end
 
-      it "returns a rejected promise" do
+      it "returns a resolved promise" do
         promise = described_class.check_notify_ability(config)
         expect(promise).to be_resolved
       end
@@ -180,5 +180,22 @@ RSpec.describe Airbrake::Config::Validator do
         described_class.check_notify_ability(config)
       end
     end
+
+    context "when the error_notifications option is false" do
+      let(:config_params) do
+        {
+          project_id: valid_id,
+          project_key: valid_key,
+          error_notifications: false,
+        }
+      end
+
+      it "returns a rejected promise" do
+        promise = described_class.check_notify_ability(config)
+        expect(promise.value).to eq(
+          'error' => "error notifications are disabled",
+        )
+      end
+    end
   end
 end

data/spec/config_spec.rb

@@ -10,7 +10,9 @@ RSpec.describe Airbrake::Config do
   its(:app_version) { is_expected.to be_nil }
   its(:versions) { is_expected.to be_empty }
   its(:host) { is_expected.to eq('https://api.airbrake.io') }
-  its(:endpoint) { is_expected.not_to be_nil }
+  its(:error_host) { is_expected.to eq('https://api.airbrake.io') }
+  its(:apm_host) { is_expected.to eq('https://api.airbrake.io') }
+  its(:error_endpoint) { is_expected.not_to be_nil }
   its(:workers) { is_expected.to eq(1) }
   its(:queue_size) { is_expected.to eq(100) }
   its(:root_directory) { is_expected.to eq(Bundler.root.realpath.to_s) }
@@ -23,6 +25,11 @@ RSpec.describe Airbrake::Config do
   its(:performance_stats_flush_period) { is_expected.to eq(15) }
   its(:query_stats) { is_expected.to eq(true) }
   its(:job_stats) { is_expected.to eq(true) }
+  its(:error_notifications) { is_expected.to eq(true) }
+
+  its(:remote_config_host) do
+    is_expected.to eq('https://v1-production-notifier-configs.s3.amazonaws.com')
+  end
 
   describe "#new" do
     context "when user config is passed" do
@@ -63,13 +70,13 @@ RSpec.describe Airbrake::Config do
     end
   end
 
-  describe "#endpoint" do
+  describe "#error_endpoint" do
     subject { described_class.new(valid_params.merge(user_config)) }
 
     context "when host ends with a URL with a slug with a trailing slash" do
       let(:user_config) { { host: 'https://localhost/bingo/' } }
 
-      its(:endpoint) do
+      its(:error_endpoint) do
         is_expected.to eq(URI('https://localhost/bingo/api/v3/projects/1/notices'))
       end
     end
@@ -77,7 +84,7 @@ RSpec.describe Airbrake::Config do
     context "when host ends with a URL with a slug without a trailing slash" do
       let(:user_config) { { host: 'https://localhost/bingo' } }
 
-      its(:endpoint) do
+      its(:error_endpoint) do
         is_expected.to eq(URI('https://localhost/api/v3/projects/1/notices'))
       end
     end
@@ -169,32 +176,4 @@ RSpec.describe Airbrake::Config do
       expect(subject.logger.level).to eq(Logger::WARN)
     end
   end
-
-  describe "#blacklist_keys=" do
-    before { allow(Kernel).to receive(:warn) }
-
-    it "sets blocklist_keys instead" do
-      subject.blacklist_keys = [1, 2, 3]
-      expect(subject.blocklist_keys).to eq([1, 2, 3])
-    end
-
-    it "prints a warning" do
-      expect(Kernel).to receive(:warn).with(/use blocklist_keys= instead/)
-      subject.blacklist_keys = [1, 2, 3]
-    end
-  end
-
-  describe "#whitelist_keys=" do
-    before { allow(Kernel).to receive(:warn) }
-
-    it "sets allowlist_keys instead" do
-      subject.whitelist_keys = [1, 2, 3]
-      expect(subject.allowlist_keys).to eq([1, 2, 3])
-    end
-
-    it "prints a warning" do
-      expect(Kernel).to receive(:warn).with(/use allowlist_keys= instead/)
-      subject.whitelist_keys = [1, 2, 3]
-    end
-  end
 end

data/spec/filters/gem_root_filter_spec.rb

@@ -7,18 +7,18 @@ RSpec.describe Airbrake::Filters::GemRootFilter do
   after { 2.times { Gem.path.pop } }
 
   it "replaces gem root in the backtrace with a label" do
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     notice[:errors].first[:backtrace] = [
       { file: "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb" },
       { file: "#{root1}/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: "#{root2}/gems/rspec-core-3.3.2/exe/rspec" },
     ]
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
 
     subject.call(notice)
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     expect(notice[:errors].first[:backtrace]).to(
       eq(
         [
@@ -29,7 +29,7 @@ RSpec.describe Airbrake::Filters::GemRootFilter do
         ],
       ),
     )
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   it "does not filter file when it is nil" do