net/url_request/report_sender_unittest.cc

// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "net/url_request/report_sender.h"

#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/run_loop.h"
#include "net/base/load_flags.h"
#include "net/base/network_delegate_impl.h"
#include "net/base/upload_bytes_element_reader.h"
#include "net/base/upload_data_stream.h"
#include "net/base/upload_element_reader.h"
#include "net/http/http_response_headers.h"
#include "net/http/http_status_code.h"
#include "net/test/test_with_task_environment.h"
#include "net/test/url_request/url_request_failed_job.h"
#include "net/test/url_request/url_request_mock_data_job.h"
#include "net/test/url_request/url_request_mock_http_job.h"
#include "net/traffic_annotation/network_traffic_annotation_test_helper.h"
#include "net/url_request/url_request_context.h"
#include "net/url_request/url_request_context_builder.h"
#include "net/url_request/url_request_filter.h"
#include "net/url_request/url_request_test_util.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace net {
namespace {

const char kDummyReport[] = "foo.test";
const char kSecondDummyReport[] = "foo2.test";
const char kServerErrorHostname[] = "mock.server.error";

void MarkURLRequestDestroyed(bool* url_request_destroyed) {
  *url_request_destroyed = true;
}

// Checks that data uploaded in the request matches the test report
// data. Erases the sent reports from |expect_reports|.
void CheckUploadData(const URLRequest& request,
                     std::set<std::string>* expect_reports) {
  const UploadDataStream* upload = request.get_upload_for_testing();
  ASSERT_TRUE(upload);
  ASSERT_TRUE(upload->GetElementReaders());
  ASSERT_EQ(1u, upload->GetElementReaders()->size());

  const UploadBytesElementReader* reader =
      (*upload->GetElementReaders())[0]->AsBytesReader();
  ASSERT_TRUE(reader);
  std::string upload_data(reader->bytes(), reader->length());

  EXPECT_EQ(1u, expect_reports->erase(upload_data));
}

// Error callback for a report with a net error.
void ErrorCallback(bool* called,
                   const GURL& report_uri,
                   int net_error,
                   int http_response_code) {
  EXPECT_NE(OK, net_error);
  EXPECT_EQ(-1, http_response_code);
  *called = true;
}

// Error callback for a report with a non-200 HTTP response code and no net
// errors.
void ServerErrorResponseCallback(bool* called,
                                 const GURL& report_uri,
                                 int net_error,
                                 int http_response_code) {
  EXPECT_EQ(OK, net_error);
  EXPECT_EQ(HTTP_INTERNAL_SERVER_ERROR, http_response_code);
  *called = true;
}

void SuccessCallback(bool* called) {
  *called = true;
}

// URLRequestJob that returns an HTTP 500 response.
class MockServerErrorJob : public URLRequestJob {
 public:
  explicit MockServerErrorJob(URLRequest* request) : URLRequestJob(request) {}

  MockServerErrorJob(const MockServerErrorJob&) = delete;
  MockServerErrorJob& operator=(const MockServerErrorJob&) = delete;

  ~MockServerErrorJob() override = default;

 protected:
  void GetResponseInfo(HttpResponseInfo* info) override {
    info->headers = base::MakeRefCounted<HttpResponseHeaders>(
        "HTTP/1.1 500 Internal Server Error\n"
        "Content-type: text/plain\n"
        "Content-Length: 0\n");
  }
  void Start() override { NotifyHeadersComplete(); }
};

class MockServerErrorJobInterceptor : public URLRequestInterceptor {
 public:
  MockServerErrorJobInterceptor() = default;

  MockServerErrorJobInterceptor(const MockServerErrorJobInterceptor&) = delete;
  MockServerErrorJobInterceptor& operator=(
      const MockServerErrorJobInterceptor&) = delete;

  ~MockServerErrorJobInterceptor() override = default;

  std::unique_ptr<URLRequestJob> MaybeInterceptRequest(
      URLRequest* request) const override {
    return std::make_unique<MockServerErrorJob>(request);
  }
};

// A network delegate that lets tests check that a report
// was sent. It counts the number of requests and lets tests register a
// callback to run when the request is destroyed. It also checks that
// the uploaded data is as expected.
class TestReportSenderNetworkDelegate : public NetworkDelegateImpl {
 public:
  TestReportSenderNetworkDelegate()
      : url_request_destroyed_callback_(base::DoNothing()),
        all_url_requests_destroyed_callback_(base::DoNothing()) {}

  TestReportSenderNetworkDelegate(const TestReportSenderNetworkDelegate&) =
      delete;
  TestReportSenderNetworkDelegate& operator=(
      const TestReportSenderNetworkDelegate&) = delete;

  void ExpectReport(const std::string& report) {
    expect_reports_.insert(report);
  }

  void set_all_url_requests_destroyed_callback(
      base::RepeatingClosure callback) {
    all_url_requests_destroyed_callback_ = std::move(callback);
  }

  void set_url_request_destroyed_callback(base::RepeatingClosure callback) {
    url_request_destroyed_callback_ = std::move(callback);
  }

  void set_expect_url(const GURL& expect_url) { expect_url_ = expect_url; }

  size_t num_requests() const { return num_requests_; }

  void set_expected_content_type(const std::string& content_type) {
    expected_content_type_ = content_type;
  }

  void set_expected_network_anonymization_key(
      const NetworkAnonymizationKey& expected_network_anonymization_key) {
    expected_network_anonymization_key_ = expected_network_anonymization_key;
  }

  // NetworkDelegateImpl implementation.
  int OnBeforeURLRequest(URLRequest* request,
                         CompletionOnceCallback callback,
                         GURL* new_url) override {
    num_requests_++;
    EXPECT_EQ(expect_url_, request->url());
    EXPECT_STRCASEEQ("POST", request->method().data());
    EXPECT_FALSE(request->allow_credentials());
    EXPECT_TRUE(request->load_flags() & LOAD_DO_NOT_SAVE_COOKIES);

    EXPECT_EQ(expected_network_anonymization_key_,
              request->isolation_info().network_anonymization_key());
    EXPECT_EQ(IsolationInfo::RequestType::kOther,
              request->isolation_info().request_type());
    EXPECT_TRUE(request->site_for_cookies().IsNull());

    const HttpRequestHeaders& extra_headers = request->extra_request_headers();
    std::string content_type;
    EXPECT_TRUE(extra_headers.GetHeader(HttpRequestHeaders::kContentType,
                                        &content_type));
    EXPECT_EQ(expected_content_type_, content_type);

    CheckUploadData(*request, &expect_reports_);

    // Unconditionally return OK, since the sender ignores the results
    // anyway.
    return OK;
  }

  void OnURLRequestDestroyed(URLRequest* request) override {
    url_request_destroyed_callback_.Run();
    if (expect_reports_.empty())
      all_url_requests_destroyed_callback_.Run();
  }

 private:
  base::RepeatingClosure url_request_destroyed_callback_;
  base::RepeatingClosure all_url_requests_destroyed_callback_;
  size_t num_requests_ = 0;
  GURL expect_url_;
  std::set<std::string> expect_reports_;
  std::string expected_content_type_;
  NetworkAnonymizationKey expected_network_anonymization_key_;
};

class ReportSenderTest : public TestWithTaskEnvironment {
 public:
  ReportSenderTest() {
    auto builder = CreateTestURLRequestContextBuilder();
    builder->set_network_delegate(
        std::make_unique<TestReportSenderNetworkDelegate>());
    context_ = builder->Build();
  }

  void SetUp() override {
    URLRequestFailedJob::AddUrlHandler();
    URLRequestMockDataJob::AddUrlHandler();
    URLRequestFilter::GetInstance()->AddHostnameInterceptor(
        "http", kServerErrorHostname,
        std::make_unique<MockServerErrorJobInterceptor>());
  }

  void TearDown() override { URLRequestFilter::GetInstance()->ClearHandlers(); }

  URLRequestContext* context() { return context_.get(); }

  TestReportSenderNetworkDelegate& network_delegate() {
    // This cast is safe because we set a TestReportSenderNetworkDelegate in the
    // constructor.
    return *static_cast<TestReportSenderNetworkDelegate*>(
        context_->network_delegate());
  }

 protected:
  void SendReport(
      ReportSender* reporter,
      const std::string& report,
      const GURL& url,
      size_t request_sequence_number,
      base::OnceCallback<void()> success_callback,
      base::OnceCallback<void(const GURL&, int, int)> error_callback) {
    NetworkAnonymizationKey network_anonymization_key =
        NetworkAnonymizationKey::CreateTransient();

    base::RunLoop run_loop;
    network_delegate().set_url_request_destroyed_callback(
        run_loop.QuitClosure());

    network_delegate().set_expect_url(url);
    network_delegate().ExpectReport(report);
    network_delegate().set_expected_content_type("application/foobar");
    network_delegate().set_expected_network_anonymization_key(
        network_anonymization_key);

    EXPECT_EQ(request_sequence_number, network_delegate().num_requests());

    reporter->Send(url, "application/foobar", report, network_anonymization_key,
                   std::move(success_callback), std::move(error_callback));

    // The report is sent asynchronously, so wait for the report's
    // URLRequest to be destroyed before checking that the report was
    // sent.
    run_loop.Run();

    EXPECT_EQ(request_sequence_number + 1, network_delegate().num_requests());
  }

  void SendReport(ReportSender* reporter,
                  const std::string& report,
                  const GURL& url,
                  size_t request_sequence_number) {
    SendReport(reporter, report, url, request_sequence_number,
               base::OnceCallback<void()>(),
               base::OnceCallback<void(const GURL&, int, int)>());
  }

 private:
  std::unique_ptr<URLRequestContext> context_;
};

// Test that ReportSender::Send creates a URLRequest for the
// endpoint and sends the expected data.
TEST_F(ReportSenderTest, SendsRequest) {
  GURL url = URLRequestMockDataJob::GetMockHttpsUrl("dummy data", 1);
  ReportSender reporter(context(), TRAFFIC_ANNOTATION_FOR_TESTS);
  SendReport(&reporter, kDummyReport, url, 0);
}

TEST_F(ReportSenderTest, SendMultipleReportsSequentially) {
  GURL url = URLRequestMockDataJob::GetMockHttpsUrl("dummy data", 1);
  ReportSender reporter(context(), TRAFFIC_ANNOTATION_FOR_TESTS);
  SendReport(&reporter, kDummyReport, url, 0);
  SendReport(&reporter, kDummyReport, url, 1);
}

TEST_F(ReportSenderTest, SendMultipleReportsSimultaneously) {
  base::RunLoop run_loop;
  network_delegate().set_all_url_requests_destroyed_callback(
      run_loop.QuitClosure());

  GURL url = URLRequestMockDataJob::GetMockHttpsUrl("dummy data", 1);
  network_delegate().set_expect_url(url);
  network_delegate().ExpectReport(kDummyReport);
  network_delegate().ExpectReport(kSecondDummyReport);
  network_delegate().set_expected_content_type("application/foobar");

  ReportSender reporter(context(), TRAFFIC_ANNOTATION_FOR_TESTS);

  EXPECT_EQ(0u, network_delegate().num_requests());

  reporter.Send(url, "application/foobar", kDummyReport,
                NetworkAnonymizationKey(), base::OnceCallback<void()>(),
                base::OnceCallback<void(const GURL&, int, int)>());
  reporter.Send(url, "application/foobar", kSecondDummyReport,
                NetworkAnonymizationKey(), base::OnceCallback<void()>(),
                base::OnceCallback<void(const GURL&, int, int)>());

  run_loop.Run();

  EXPECT_EQ(2u, network_delegate().num_requests());
}

// Test that pending URLRequests get cleaned up when the report sender
// is deleted.
TEST_F(ReportSenderTest, PendingRequestGetsDeleted) {
  bool url_request_destroyed = false;
  network_delegate().set_url_request_destroyed_callback(base::BindRepeating(
      &MarkURLRequestDestroyed, base::Unretained(&url_request_destroyed)));

  GURL url = URLRequestFailedJob::GetMockHttpUrlWithFailurePhase(
      URLRequestFailedJob::START, ERR_IO_PENDING);
  network_delegate().set_expect_url(url);
  network_delegate().ExpectReport(kDummyReport);
  network_delegate().set_expected_content_type("application/foobar");

  EXPECT_EQ(0u, network_delegate().num_requests());

  auto reporter =
      std::make_unique<ReportSender>(context(), TRAFFIC_ANNOTATION_FOR_TESTS);
  reporter->Send(url, "application/foobar", kDummyReport,
                 NetworkAnonymizationKey(), base::OnceCallback<void()>(),
                 base::OnceCallback<void(const GURL&, int, int)>());
  reporter.reset();

  EXPECT_EQ(1u, network_delegate().num_requests());
  EXPECT_TRUE(url_request_destroyed);
}

// Test that a request that returns an error gets cleaned up.
TEST_F(ReportSenderTest, ErroredRequestGetsDeleted) {
  GURL url = URLRequestFailedJob::GetMockHttpsUrl(ERR_FAILED);
  ReportSender reporter(context(), TRAFFIC_ANNOTATION_FOR_TESTS);
  // SendReport will block until the URLRequest is destroyed.
  SendReport(&reporter, kDummyReport, url, 0);
}

// Test that the error callback, if provided, gets called when a request
// returns an error and the success callback doesn't get called.
TEST_F(ReportSenderTest, ErroredRequestCallsErrorCallback) {
  bool error_callback_called = false;
  bool success_callback_called = false;
  const GURL url = URLRequestFailedJob::GetMockHttpsUrl(ERR_FAILED);
  ReportSender reporter(context(), TRAFFIC_ANNOTATION_FOR_TESTS);
  // SendReport will block until the URLRequest is destroyed.
  SendReport(&reporter, kDummyReport, url, 0,
             base::BindOnce(SuccessCallback, &success_callback_called),
             base::BindOnce(ErrorCallback, &error_callback_called));
  EXPECT_TRUE(error_callback_called);
  EXPECT_FALSE(success_callback_called);
}

// Test that the error callback, if provided, gets called when a request
// finishes successfully but results in a server error, and the success callback
// doesn't get called.
TEST_F(ReportSenderTest, BadResponseCodeCallsErrorCallback) {
  bool error_callback_called = false;
  bool success_callback_called = false;
  const GURL url(std::string("http://") + kServerErrorHostname);
  ReportSender reporter(context(), TRAFFIC_ANNOTATION_FOR_TESTS);
  // SendReport will block until the URLRequest is destroyed.
  SendReport(
      &reporter, kDummyReport, url, 0,
      base::BindOnce(SuccessCallback, &success_callback_called),
      base::BindOnce(ServerErrorResponseCallback, &error_callback_called));
  EXPECT_TRUE(error_callback_called);
  EXPECT_FALSE(success_callback_called);
}

// Test that the error callback does not get called and the success callback
/// gets called when a request does not return an error.
TEST_F(ReportSenderTest, SuccessfulRequestCallsSuccessCallback) {
  bool error_callback_called = false;
  bool success_callback_called = false;
  const GURL url = URLRequestMockDataJob::GetMockHttpsUrl("dummy data", 1);
  ReportSender reporter(context(), TRAFFIC_ANNOTATION_FOR_TESTS);
  SendReport(&reporter, kDummyReport, url, 0,
             base::BindOnce(SuccessCallback, &success_callback_called),
             base::BindOnce(ErrorCallback, &error_callback_called));
  EXPECT_FALSE(error_callback_called);
  EXPECT_TRUE(success_callback_called);
}

}  // namespace
}  // namespace net