airbrake 8.1.4 → 8.2.0

data/spec/integration/rails/rake_spec.rb

@@ -1,173 +1,98 @@
 require 'spec_helper'
 
 RSpec.describe "Rake integration" do
-  let(:endpoint) { 'https://api.airbrake.io/api/v3/projects/113743/notices' }
+  let(:task) { Rake::Task['bingo:bango'] }
 
-  let(:routes_endpoint) do
-    'https://api.airbrake.io/api/v5/projects/113743/routes-stats'
-  end
+  before { Rails.application.load_tasks }
 
-  let(:queries_endpoint) do
-    'https://api.airbrake.io/api/v5/projects/113743/queries-stats'
-  end
+  after do
+    expect { task.invoke }.to raise_error(AirbrakeTestError)
 
-  def wait_for_a_request_with_body(body)
-    wait_for(a_request(:post, endpoint).with(body: body)).to have_been_made.once
+    # Rake ensures that each task is executed only once per session. For testing
+    # purposes, we run the task multiple times.
+    task.reenable
   end
 
-  def expect_no_requests_with_body(body)
-    sleep 1
-    expect(a_request(:post, endpoint).with(body: body)).not_to have_been_made
+  it "sends the exception to Airbrake" do
+    expect(Airbrake).to receive(:notify_sync)
+      .with(an_instance_of(Airbrake::Notice))
   end
 
-  before do
-    stub_request(:post, endpoint).to_return(status: 201, body: '{}')
-
-    # Airbrake Ruby has a background thread that sends performance requests
-    # periodically. We don't want this to get in the way.
-    [routes_endpoint, queries_endpoint].each do |e|
-      stub_request(:put, e).to_return(status: 200, body: '')
+  describe "contains the context payload, which" do
+    it "includes correct component" do
+      expect(Airbrake).to receive(:notify_sync)
+        .with(a_notice_with(%i[context component], 'rake'))
     end
 
-    Rails.application.load_tasks
-
-    expect { faulty_task.invoke }.to raise_error(AirbrakeTestError)
-  end
-
-  after do
-    # Rake ensures that each task is executed only once per session. For testing
-    # purposes, we run the task multiple times.
-    faulty_task.reenable
+    it "includes correct action" do
+      expect(Airbrake).to receive(:notify_sync)
+        .with(a_notice_with(%i[context action], 'bingo:bango'))
+    end
   end
 
-  describe "a task with maximum information, which raises an exception" do
-    let(:faulty_task) { Rake::Task['bingo:bango'] }
-
-    it "sends the exception to Airbrake" do
-      wait_for_a_request_with_body(/"errors":\[{"type":"AirbrakeTestError"/)
+  describe "contains the params payload, which" do
+    it "includes a task name" do
+      expect(Airbrake).to receive(:notify_sync)
+        .with(a_notice_with(%i[params rake_task name], 'bingo:bango'))
     end
 
-    describe "contains the context payload, which" do
-      it "includes correct component" do
-        wait_for_a_request_with_body(/"context":{.*"component":"rake".*}/)
-      end
-
-      it "includes correct action" do
-        wait_for_a_request_with_body(
-          /"context":{.*"action":"bingo:bango".*/
-        )
-      end
+    it "includes a timestamp" do
+      expected_notice = a_notice_with(
+        %i[params rake_task timestamp], /20\d\d\-\d\d-\d\d.+/
+      )
+      expect(Airbrake).to receive(:notify_sync).with(expected_notice)
     end
 
-    describe "contains the params payload, which" do
-      it "includes a task name" do
-        wait_for_a_request_with_body(
-          /"params":{.*"rake_task":{.*"name":"bingo:bango".*}.*}/
-        )
-      end
-
-      it "includes a timestamp" do
-        wait_for_a_request_with_body(
-          /"params":{.*"rake_task":{.*"timestamp":"201\d\-\d\d-\d\d.+".*}.*}/
-        )
-      end
-
-      it "includes investigation" do
-        # rubocop:disable Metrics/LineLength
-        wait_for_a_request_with_body(
-          /"params":{.*"rake_task":{.*"investigation":".+Investigating bingo:bango.+".*}.*}/
-        )
-        # rubocop:enable Metrics/LineLength
-      end
-
-      it "includes full comment" do
-        wait_for_a_request_with_body(
-          /"params":{.*"rake_task":{.*"full_comment":"Dummy description".*}.*}/
-        )
-      end
-
-      it "includes arg names" do
-        wait_for_a_request_with_body(
-          /"params":{.*"rake_task":{.*"arg_names":\["dummy_arg"\].*}.*}/
-        )
-      end
-
-      it "includes arg description" do
-        wait_for_a_request_with_body(
-          /"params":{.*"rake_task":{.*"arg_description":"\[dummy_arg\]".*}.*}/
-        )
-      end
-
-      it "includes locations" do
-        # rubocop:disable Metrics/LineLength
-        wait_for_a_request_with_body(
-          %r("params":{.*"rake_task":{.*"locations":\[".+spec/apps/rails/dummy_task.rake:\d+:in.+"\].*}.*})
-        )
-        # rubocop:enable Metrics/LineLength
-      end
-
-      it "includes sources" do
-        wait_for_a_request_with_body(
-          /"params":{.*"rake_task":{.*"sources":\["environment"\].*}.*}/
-        )
-      end
-
-      it "includes prerequisite tasks" do
-        # rubocop:disable Metrics/LineLength
-        wait_for_a_request_with_body(
-          /"params":{.*"rake_task":{.*"prerequisite_tasks":\[{"name":"bingo:environment".+\].*}.*}/
-        )
-        # rubocop:enable Metrics/LineLength
-      end
+    it "includes investigation" do
+      expected_notice = a_notice_with(
+        %i[params rake_task investigation], /Investigating bingo:bango/
+      )
+      expect(Airbrake).to receive(:notify_sync).with(expected_notice)
+    end
 
-      it "includes argv info" do
-        wait_for_a_request_with_body(
-          %r("params":{.*"argv":".*spec/integration/rails/.+_spec.rb".*})
-        )
-      end
+    it "includes full comment" do
+      expect(Airbrake).to receive(:notify_sync)
+        .with(a_notice_with(%i[params rake_task full_comment], 'Dummy description'))
+    end
 
-      it "includes #execute args" do
-        wait_for_a_request_with_body(
-          /"params":{.*"execute_args":\[\].*}/
-        )
-      end
+    it "includes arg names" do
+      expect(Airbrake).to receive(:notify_sync)
+        .with(a_notice_with(%i[params rake_task arg_names], [:dummy_arg]))
     end
-  end
 
-  describe "a task with minimum information, which raises an exception" do
-    let(:faulty_task) { Rake::Task['bingo:bongo'] }
+    it "includes arg description" do
+      expect(Airbrake).to receive(:notify_sync)
+        .with(a_notice_with(%i[params rake_task arg_description], '[dummy_arg]'))
+    end
 
-    describe "doesn't contain in the params payload" do
-      it "full comment" do
-        expect_no_requests_with_body(
-          /"params":{.*"rake_task":{.*"full_comment":"Dummy description".*}.*}/
-        )
+    it "includes locations" do
+      expect(Airbrake).to receive(:notify_sync) do |notice|
+        expect(notice[:params][:rake_task][:locations])
+          .to match(array_including(%r{spec/apps/rails/dummy_task.rake:\d+:in}))
       end
+    end
 
-      it "arg names" do
-        expect_no_requests_with_body(
-          /"params":{.*"rake_task":{.*"arg_names":\["dummy_arg"\].*}.*}/
-        )
-      end
+    it "includes sources" do
+      expect(Airbrake).to receive(:notify_sync)
+        .with(a_notice_with(%i[params rake_task sources], ['environment']))
+    end
 
-      it "arg description" do
-        expect_no_requests_with_body(
-          /"params":{.*"rake_task":{.*"arg_description":"\[dummy_arg\]".*}.*}/
-        )
+    it "includes prerequisite tasks" do
+      expect(Airbrake).to receive(:notify_sync) do |notice|
+        expect(notice[:params][:rake_task][:prerequisite_tasks])
+          .to match(array_including(hash_including(name: 'bingo:environment')))
       end
+    end
 
-      it "sources" do
-        expect_no_requests_with_body(
-          /"params":{.*"rake_task":{.*"sources":\["environment"\].*}.*}/
-        )
-      end
+    it "includes argv info" do
+      expect(Airbrake).to receive(:notify_sync)
+        .with(a_notice_with(%i[params argv], %r{spec/integration/rails/.+_spec.rb}))
+    end
 
-      it "prerequisite tasks" do
-        # rubocop:disable Metrics/LineLength
-        expect_no_requests_with_body(
-          /"params":{.*"rake_task":{.*"prerequisite_tasks":\[{"name":"bingo:environment".+\].*}.*}/
-        )
-        # rubocop:enable Metrics/LineLength
+    it "includes execute args" do
+      expect(Airbrake).to receive(:notify_sync) do |notice|
+        expect(notice[:params][:execute_args])
+          .to be_an_instance_of(Rake::TaskArguments)
       end
     end
   end

data/spec/integration/shared_examples/rack_examples.rb

@@ -1,139 +1,110 @@
 RSpec.shared_examples 'rack examples' do
   include Warden::Test::Helpers
 
-  after { Warden.test_reset! }
-
   let(:endpoint) { 'https://api.airbrake.io/api/v3/projects/113743/notices' }
 
-  let(:routes_endpoint) do
-    'https://api.airbrake.io/api/v5/projects/113743/routes-stats'
-  end
-
-  let(:queries_endpoint) do
-    'https://api.airbrake.io/api/v5/projects/113743/queries-stats'
-  end
-
-  def wait_for_a_request_with_body(body)
-    allow(Airbrake.notifiers[:performance][:default]).
-      to receive(:notify).and_return(nil)
-    wait_for(a_request(:post, endpoint).with(body: body)).
-      to have_been_made.at_least_once
-  end
-
   before do
-    # Make sure the Logger integration doesn't get in the way.
-    allow_any_instance_of(Logger).to receive(:airbrake_notifier).and_return(nil)
-
-    allow(Airbrake.notifiers[:performance][:default]).
-      to receive(:notify).and_return(nil)
     stub_request(:post, endpoint).to_return(status: 200, body: '')
-    [routes_endpoint, queries_endpoint].each do |endpoint|
-      stub_request(:put, endpoint).to_return(status: 200, body: '')
-    end
+    Airbrake::Config.instance.merge(performance_stats: false)
   end
 
+  after { Warden.test_reset! }
+
   describe "application routes" do
     describe "/index" do
       it "successfully returns 200 and body" do
+        expect(Airbrake).not_to receive(:notify)
+
         get '/'
 
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Hello from index')
-
-        wait_for(a_request(:post, endpoint)).not_to have_been_made
       end
     end
 
     describe "/crash" do
       it "returns 500 and sends a notice to Airbrake" do
-        get '/crash'
+        expect(Airbrake).to receive(:notify).with(
+          an_instance_of(Airbrake::Notice)
+        ) do |notice|
+          expect(notice[:errors].first[:type]).to eq('AirbrakeTestError')
+        end
 
-        expect(last_response.status).to eq(500)
-        wait_for_a_request_with_body(/"errors":\[{"type":"AirbrakeTestError"/)
+        get '/crash'
       end
     end
   end
 
-  describe "context payload" do
-    context "when the user is present" do
-      let(:common_user_params) do
-        { id: 1, email: 'qa@example.com', username: 'qa-dept' }
-      end
-
-      before do
-        login_as(OpenStruct.new(user_params))
-        get '/crash'
-        sleep 2
-      end
-
-      context "when the user has first and last names" do
-        let(:user_params) do
-          common_user_params.merge(first_name: 'Bingo', last_name: 'Bongo')
-        end
-
-        it "reports the user's first and last names" do
-          wait_for_a_request_with_body(/
-            "context":{.*
-              "user":{
-                "id":"1",
-                "name":"Bingo\sBongo",
-                "username":"qa-dept",
-                "email":"qa@example.com"}
-          /x)
-        end
-      end
-
-      context "when the user has only name" do
-        let(:user_params) do
-          common_user_params.merge(name: 'Bingo')
-        end
+  describe "user payload" do
+    let(:user) do
+      OpenStruct.new(
+        id: 1,
+        email: 'qa@example.com',
+        username: 'qa-dept',
+        first_name: 'John',
+        last_name: 'Doe'
+      )
+    end
 
-        it "reports the user's name" do
-          wait_for_a_request_with_body(/
-            "context":{.*
-              "user":{
-                "id":"1",
-                "name":"Bingo",
-                "username":"qa-dept",
-                "email":"qa@example.com"}
-          /x)
-        end
-      end
+    before { login_as(user) }
+
+    it "reports user info" do
+      get '/crash'
+      sleep 2
+
+      body = /
+        "context":{.*
+          "user":{
+            "id":"1",
+            "name":"John\sDoe",
+            "username":"qa-dept",
+            "email":"qa@example.com"}
+      /x
+      expect(a_request(:post, endpoint).with(body: body))
+        .to have_been_made.at_least_once
     end
+  end
 
-    context "when additional parameters present" do
-      before do
-        get '/crash', nil, 'HTTP_USER_AGENT' => 'Bot', 'HTTP_REFERER' => 'bingo.com'
-        sleep 2
-      end
+  context "when additional parameters are present" do
+    before do
+      get '/crash', nil, 'HTTP_USER_AGENT' => 'Bot', 'HTTP_REFERER' => 'bingo.com'
+      sleep 2
+    end
 
-      it "contains url" do
-        wait_for_a_request_with_body(
-          %r("context":{.*"url":"http://example\.org/crash".*})
-        )
-      end
+    it "contains url" do
+      body = %r("context":{.*"url":"http://example\.org/crash".*})
+      expect(a_request(:post, endpoint).with(body: body))
+        .to have_been_made.at_least_once
+    end
 
-      it "contains hostname" do
-        wait_for_a_request_with_body(/"context":{.*"hostname":".+".*}/)
-      end
+    it "contains hostname" do
+      body = /"context":{.*"hostname":".+".*}/
+      expect(a_request(:post, endpoint).with(body: body))
+        .to have_been_made.at_least_once
+    end
 
-      it "contains userAgent" do
-        wait_for_a_request_with_body(/"context":{.*"userAgent":"Bot".*}/)
-      end
+    it "contains userAgent" do
+      body = /"context":{.*"userAgent":"Bot".*}/
+      expect(a_request(:post, endpoint).with(body: body))
+        .to have_been_made.at_least_once
+    end
 
-      it "contains referer" do
-        wait_for_a_request_with_body(/"context":{.*"referer":"bingo.com".*}/)
-      end
+    it "contains referer" do
+      body = /"context":{.*"referer":"bingo.com".*}/
+      expect(a_request(:post, endpoint).with(body: body))
+        .to have_been_made.at_least_once
+    end
 
-      it "contains HTTP headers" do
-        wait_for_a_request_with_body(
-          /"context":{.*"headers":{.*"CONTENT_LENGTH":"0".*}/
-        )
-      end
+    it "contains HTTP headers" do
+      body = /"context":{.*"headers":{.*"CONTENT_LENGTH":"0".*}/
+      expect(a_request(:post, endpoint).with(body: body))
+        .to have_been_made.at_least_once
+    end
 
-      it "contains HTTP method" do
-        wait_for_a_request_with_body(/"context":{.*"httpMethod":"GET".*}/)
-      end
+    it "contains HTTP method" do
+      body = /"context":{.*"httpMethod":"GET".*}/
+      expect(a_request(:post, endpoint).with(body: body))
+        .to have_been_made.at_least_once
     end
   end
 end