# frozen_string_literal: true RSpec.describe QA::Support::PageErrorChecker do let(:test_path) { '/test/path' } let(:page) { double(Capybara.page) } describe '.report!' do context 'reports errors' do let(:expected_chrome_error) do <<~MSG Error Code: 500 chrome errors Path: #{test_path} Logging: foo123 MSG end let(:expected_basic_error) do <<~MSG Error Code: 500 foo status Path: #{test_path} Logging: foo123 MSG end let(:expected_basic_404) do <<~MSG Error Code: 404 foo status Path: #{test_path} MSG end it 'reports error message on chrome browser' do allow(QA::Support::PageErrorChecker).to receive(:parse_five_c_page_request_id).and_return('foo123') allow(QA::Support::Loglinking).to receive(:failure_metadata).with('foo123').and_return('Logging: foo123') allow(QA::Support::PageErrorChecker).to receive(:return_chrome_errors).and_return('chrome errors') allow(page).to receive(:current_path).and_return(test_path) allow(QA::Runtime::Env).to receive(:browser).and_return(:chrome) expect { QA::Support::PageErrorChecker.report!(page, 500) }.to raise_error( QA::Support::PageErrorChecker::PageError, expected_chrome_error ) end it 'reports basic message on non-chrome browser' do allow(QA::Support::PageErrorChecker).to receive(:parse_five_c_page_request_id).and_return('foo123') allow(QA::Support::Loglinking).to receive(:failure_metadata).with('foo123').and_return('Logging: foo123') allow(QA::Support::PageErrorChecker).to receive(:status_code_report).and_return('foo status') allow(page).to receive(:current_path).and_return(test_path) allow(QA::Runtime::Env).to receive(:browser).and_return(:firefox) expect { QA::Support::PageErrorChecker.report!(page, 500) }.to raise_error( QA::Support::PageErrorChecker::PageError, expected_basic_error ) end it 'does not report failure metadata on non 500 error' do allow(QA::Support::PageErrorChecker).to receive(:parse_five_c_page_request_id).and_return('foo123') expect(QA::Support::Loglinking).not_to receive(:failure_metadata) allow(QA::Support::PageErrorChecker).to receive(:status_code_report).and_return('foo status') allow(page).to receive(:current_path).and_return(test_path) allow(QA::Runtime::Env).to receive(:browser).and_return(:firefox) expect { QA::Support::PageErrorChecker.report!(page, 404) }.to raise_error( QA::Support::PageErrorChecker::PageError, expected_basic_404 ) end end end describe '.parse_five_c_page_request_id' do context 'parse correlation ID' do require 'nokogiri' before do nokogiri_parse = Class.new do def self.parse(str) Nokogiri::HTML.parse(str) end end stub_const('NokogiriParse', nokogiri_parse) end let(:error_500_str) do "

" \ "req678" \ "

" end let(:error_500_no_code_str) do "" \ "The code you are looking for is not here" \ "" end it 'returns code is present' do allow(page).to receive(:html).and_return(error_500_str) allow(Nokogiri::HTML).to receive(:parse).with(error_500_str).and_return(NokogiriParse.parse(error_500_str)) expect(QA::Support::PageErrorChecker.parse_five_c_page_request_id(page).to_str).to eq('req678') end it 'returns nil if not present' do allow(page).to receive(:html).and_return(error_500_no_code_str) allow(Nokogiri::HTML).to receive(:parse).with(error_500_no_code_str).and_return(NokogiriParse.parse(error_500_no_code_str)) expect(QA::Support::PageErrorChecker.parse_five_c_page_request_id(page)).to be_nil end end end describe '.return_chrome_errors' do context 'returns error message' do before do single_log = Class.new do def level 'SEVERE' end end stub_const('SingleLog', single_log) one_error_mocked_logs = Class.new do def self.select [SingleLog] end end stub_const('OneErrorMockedLogs', one_error_mocked_logs) three_errors_mocked_logs = Class.new do def self.select [SingleLog, SingleLog, SingleLog] end end stub_const('ThreeErrorsMockedLogs', three_errors_mocked_logs) no_error_mocked_logs = Class.new do def self.select [] end end stub_const('NoErrorMockedLogs', no_error_mocked_logs) end let(:expected_single_error) do "There was 1 SEVERE level error:\n\n" \ "bar foo" end let(:expected_multiple_error) do "There were 3 SEVERE level errors:\n\n" \ "bar foo\n" \ "foo\n" \ "bar" end it 'returns status code report on no severe errors found' do allow(QA::Support::PageErrorChecker).to receive(:logs).with(page).and_return(NoErrorMockedLogs) allow(QA::Support::PageErrorChecker).to receive(:status_code_report).with('123').and_return('Test Status Code return 123') expect(QA::Support::PageErrorChecker.return_chrome_errors(page, '123')).to eq('Test Status Code return 123') end it 'returns report on 1 severe error found' do allow(QA::Support::PageErrorChecker).to receive(:error_report_for).with([SingleLog]).and_return('bar foo') allow(QA::Support::PageErrorChecker).to receive(:logs).with(page).and_return(OneErrorMockedLogs) allow(page).to receive(:current_path).and_return(test_path) expect(QA::Support::PageErrorChecker.return_chrome_errors(page, '123')).to eq(expected_single_error) end it 'returns report on multiple severe errors found' do allow(QA::Support::PageErrorChecker).to receive(:error_report_for) .with([SingleLog, SingleLog, SingleLog]).and_return("bar foo\nfoo\nbar") allow(QA::Support::PageErrorChecker).to receive(:logs).with(page).and_return(ThreeErrorsMockedLogs) allow(page).to receive(:current_path).and_return(test_path) expect(QA::Support::PageErrorChecker.return_chrome_errors(page, '123')).to eq(expected_multiple_error) end end end describe '.check_page_for_error_code' do require 'nokogiri' before do nokogiri_parse = Class.new do def self.parse(str) Nokogiri::HTML.parse(str) end end stub_const('NokogiriParse', nokogiri_parse) end let(:error_404_str) do "
" \ "\"404" \ "

404: Page not found

" \ "

Make sure the address is correct and the page has not moved.

" \ "

Please contact your GitLab administrator if you think this is a mistake.

" \ "
" end let(:error_500_str) { 'Something went wrong (500)500 error

500: We\'re sorry, something went wrong on our end

' } let(:project_name_500_str) { "Project

qa-test-2022-05-25-12-12-16-d4500c2e79c37289

" } let(:backtrace_str) { "Error::Backtrace
foo
" } let(:no_error_str) { "Nothing wrong hereno 404 or 500 or backtrace" } it 'calls report with 404 if 404 found' do allow(page).to receive(:html).and_return(error_404_str) allow(Nokogiri::HTML).to receive(:parse).with(error_404_str).and_return(NokogiriParse.parse(error_404_str)) expect(QA::Support::PageErrorChecker).to receive(:report!).with(page, 404) QA::Support::PageErrorChecker.check_page_for_error_code(page) end it 'calls report with 500 if 500 found' do allow(page).to receive(:html).and_return(error_500_str) allow(Nokogiri::HTML).to receive(:parse).with(error_500_str).and_return(NokogiriParse.parse(error_500_str)) expect(QA::Support::PageErrorChecker).to receive(:report!).with(page, 500) QA::Support::PageErrorChecker.check_page_for_error_code(page) end it 'calls report with 500 if GDK backtrace found' do allow(page).to receive(:html).and_return(backtrace_str) allow(Nokogiri::HTML).to receive(:parse).with(backtrace_str).and_return(NokogiriParse.parse(backtrace_str)) expect(QA::Support::PageErrorChecker).to receive(:report!).with(page, 500) QA::Support::PageErrorChecker.check_page_for_error_code(page) end it 'does not call report if 500 found in project name' do allow(page).to receive(:html).and_return(project_name_500_str) allow(Nokogiri::HTML).to receive(:parse).with(project_name_500_str).and_return(NokogiriParse.parse(project_name_500_str)) expect(QA::Support::PageErrorChecker).not_to receive(:report!) QA::Support::PageErrorChecker.check_page_for_error_code(page) end it 'does not call report if no 404, 500 or backtrace found' do allow(page).to receive(:html).and_return(no_error_str) allow(Nokogiri::HTML).to receive(:parse).with(no_error_str).and_return(NokogiriParse.parse(no_error_str)) expect(QA::Support::PageErrorChecker).not_to receive(:report!) QA::Support::PageErrorChecker.check_page_for_error_code(page) end end describe '.error_report_for' do before do logs_class_one = Class.new do def self.message 'foo\\n' end end stub_const('LogOne', logs_class_one) logs_class_two = Class.new do def self.message 'bar' end end stub_const('LogTwo', logs_class_two) end it 'returns error report array of log messages' do expect(QA::Support::PageErrorChecker.error_report_for([LogOne, LogTwo])) .to eq(%W[foo\n bar]) end end describe '::log_request_errors' do let(:page_url) { 'https://baz.foo' } let(:browser) { double('browser', current_url: page_url) } let(:driver) { double('driver', browser: browser) } let(:session) { double('session', driver: driver) } before do allow(Capybara).to receive(:current_session).and_return(session) allow(QA::Runtime::Env).to receive(:can_intercept?).and_return(true) end it 'logs from the error cache' do error = { 'url' => 'https://foo.bar', 'status' => 500, 'method' => 'GET', 'headers' => { 'x-request-id' => '12345' } } expect(page).to receive(:driver).and_return(driver) expect(page).to receive(:execute_script).and_return({ 'errors' => [error] }) expect(page).to receive(:execute_script) expect(QA::Runtime::Logger).to receive(:debug).with("Fetching API error cache for #{page_url}") expect(QA::Runtime::Logger).to receive(:warn).with(<<~ERROR) Interceptor Api Errors [500] GET https://foo.bar -- Correlation Id: 12345 ERROR QA::Support::PageErrorChecker.log_request_errors(page) end it 'removes duplicates' do error = { 'url' => 'https://foo.bar', 'status' => 500, 'method' => 'GET', 'headers' => { 'x-request-id' => '12345' } } expect(page).to receive(:driver).and_return(driver) expect(page).to receive(:execute_script).and_return({ 'errors' => [error, error, error] }) expect(page).to receive(:execute_script) expect(QA::Runtime::Logger).to receive(:debug).with("Fetching API error cache for #{page_url}") expect(QA::Runtime::Logger).to receive(:warn).with(<<~ERROR).exactly(1).time Interceptor Api Errors [500] GET https://foo.bar -- Correlation Id: 12345 ERROR QA::Support::PageErrorChecker.log_request_errors(page) end it 'chops the url query string' do error = { 'url' => 'https://foo.bar?query={ sensitive-data: 12345 }', 'status' => 500, 'method' => 'GET', 'headers' => { 'x-request-id' => '12345' } } expect(page).to receive(:driver).and_return(driver) expect(page).to receive(:execute_script).and_return({ 'errors' => [error] }) expect(page).to receive(:execute_script) expect(QA::Runtime::Logger).to receive(:debug).with("Fetching API error cache for #{page_url}") expect(QA::Runtime::Logger).to receive(:warn).with(<<~ERROR) Interceptor Api Errors [500] GET https://foo.bar -- Correlation Id: 12345 ERROR QA::Support::PageErrorChecker.log_request_errors(page) end it 'logs graphql errors if any exist' do error = { 'url' => 'https://foo.bar?query={ sensitive-data: 12345 }', 'status' => 200, 'method' => 'POST', 'errorData' => 'error-messages: Something bad happened', 'headers' => { 'x-request-id' => '12345' } } expect(page).to receive(:driver).and_return(driver) expect(page).to receive(:execute_script).and_return({ 'errors' => [error] }) expect(page).to receive(:execute_script) expect(QA::Runtime::Logger).to receive(:debug).with("Fetching API error cache for #{page_url}") expect(QA::Runtime::Logger).to receive(:warn).with(<<~ERROR.chomp) Interceptor Api Errors [200] POST https://foo.bar -- Correlation Id: 12345 error-messages: Something bad happened ERROR QA::Support::PageErrorChecker.log_request_errors(page) end it 'returns if cache is nil' do expect(page).to receive(:driver).and_return(driver) expect(page).to receive(:execute_script).and_return(nil) expect(QA::Runtime::Logger).to receive(:debug).with("Fetching API error cache for #{page_url}") expect(QA::Runtime::Logger).not_to receive(:error) QA::Support::PageErrorChecker.log_request_errors(page) end end describe '.logs' do before do logs_class = Class.new do def self.get(level) "logs at #{level} level" end end stub_const('Logs', logs_class) browser_class = Class.new do def self.logs Logs end end stub_const('Browser', browser_class) driver_class = Class.new do def self.browser Browser end end stub_const('Driver', driver_class) end it 'gets driver browser logs' do allow(page).to receive(:driver).and_return(Driver) expect(QA::Support::PageErrorChecker.logs(page)).to eq('logs at browser level') end end describe '.status_code_report' do it 'returns a string message containing the status code' do expect(QA::Support::PageErrorChecker.status_code_report(1234)).to eq('Status code 1234 found') end end end