chrome/browser/optimization_guide/prediction/prediction_model_fetcher_unittest.cc

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

#include <memory>
#include <string>
#include <vector>

#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/scoped_refptr.h"
#include "base/optional.h"
#include "base/run_loop.h"
#include "base/strings/string_number_conversions.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "chrome/browser/optimization_guide/prediction/prediction_model_fetcher.h"
#include "components/optimization_guide/optimization_guide_features.h"
#include "components/optimization_guide/proto/models.pb.h"
#include "net/base/url_util.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/network/public/cpp/weak_wrapper_shared_url_loader_factory.h"
#include "services/network/test/test_network_connection_tracker.h"
#include "services/network/test/test_url_loader_factory.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace optimization_guide {

constexpr char optimization_guide_service_url[] =
    "https://optimizationguideservice.com/";

class PredictionModelFetcherTest : public testing::Test {
 public:
  PredictionModelFetcherTest()
      : task_environment_(base::test::TaskEnvironment::MainThreadType::UI),
        shared_url_loader_factory_(
            base::MakeRefCounted<network::WeakWrapperSharedURLLoaderFactory>(
                &test_url_loader_factory_)) {
    prediction_model_fetcher_ = std::make_unique<PredictionModelFetcher>(
        shared_url_loader_factory_, GURL(optimization_guide_service_url));
  }

  ~PredictionModelFetcherTest() override {}

  void OnModelsFetched(
      base::Optional<
          std::unique_ptr<optimization_guide::proto::GetModelsResponse>>
          get_models_response) {
    if (get_models_response)
      models_fetched_ = true;
  }

  bool models_fetched() { return models_fetched_; }

  void SetConnectionOffline() {
    network_tracker_ = network::TestNetworkConnectionTracker::GetInstance();
    network_tracker_->SetConnectionType(
        network::mojom::ConnectionType::CONNECTION_NONE);
  }

  void SetConnectionOnline() {
    network_tracker_ = network::TestNetworkConnectionTracker::GetInstance();
    network_tracker_->SetConnectionType(
        network::mojom::ConnectionType::CONNECTION_4G);
  }

 protected:
  bool FetchModels(
      const std::vector<optimization_guide::proto::ModelInfo>
          models_request_info,
      const std::vector<std::string>& hosts,
      const optimization_guide::proto::RequestContext& request_context) {
    bool status =
        prediction_model_fetcher_->FetchOptimizationGuideServiceModels(
            models_request_info, hosts, request_context,
            base::BindOnce(&PredictionModelFetcherTest::OnModelsFetched,
                           base::Unretained(this)));
    RunUntilIdle();
    return status;
  }

  // Return a 200 response with provided content to any pending requests.
  bool SimulateResponse(const std::string& content,
                        net::HttpStatusCode http_status) {
    return test_url_loader_factory_.SimulateResponseForPendingRequest(
        optimization_guide_service_url, content, http_status,
        network::TestURLLoaderFactory::kUrlMatchPrefix);
  }

  void VerifyHasPendingFetchRequests() {
    EXPECT_GE(test_url_loader_factory_.NumPending(), 1);
    std::string key_value;
    for (const auto& pending_request :
         *test_url_loader_factory_.pending_requests()) {
      EXPECT_EQ(pending_request.request.method, "POST");
      EXPECT_TRUE(net::GetValueForKeyInQuery(pending_request.request.url, "key",
                                             &key_value));
    }
  }

 private:
  void RunUntilIdle() {
    task_environment_.RunUntilIdle();
    base::RunLoop().RunUntilIdle();
  }

  bool models_fetched_ = false;
  base::test::TaskEnvironment task_environment_;

  std::unique_ptr<PredictionModelFetcher> prediction_model_fetcher_;

  scoped_refptr<network::SharedURLLoaderFactory> shared_url_loader_factory_;
  network::TestURLLoaderFactory test_url_loader_factory_;
  network::TestNetworkConnectionTracker* network_tracker_;

  DISALLOW_COPY_AND_ASSIGN(PredictionModelFetcherTest);
};

TEST_F(PredictionModelFetcherTest, FetchOptimizationGuideServiceModels) {
  base::HistogramTester histogram_tester;
  std::string response_content;
  std::vector<std::string> hosts = {"foo.com", "bar.com"};
  std::vector<optimization_guide::proto::ModelInfo> models_request_info({});
  EXPECT_TRUE(FetchModels(
      models_request_info, hosts,
      optimization_guide::proto::RequestContext::CONTEXT_BATCH_UPDATE));
  VerifyHasPendingFetchRequests();

  histogram_tester.ExpectUniqueSample(
      "OptimizationGuide.PredictionModelFetcher.GetModelsRequest.HostCount", 2,
      1);

  EXPECT_TRUE(SimulateResponse(response_content, net::HTTP_OK));
  EXPECT_TRUE(models_fetched());

  // No HostModelFeatures are returned.
  histogram_tester.ExpectUniqueSample(
      "OptimizationGuide.PredictionModelFetcher.GetModelsResponse."
      "HostModelFeatureCount",
      0, 1);
}

TEST_F(PredictionModelFetcherTest,
       FetchOptimizationGuideServiceModelsLimitHosts) {
  base::HistogramTester histogram_tester;
  std::string response_content;
  std::vector<std::string> hosts;
  for (size_t i = 0;
       i <= features::MaxHostsForOptimizationGuideServiceModelsFetch() + 1; i++)
    hosts.push_back("host" + base::NumberToString(i) + ".com");
  std::vector<optimization_guide::proto::ModelInfo> models_request_info({});
  EXPECT_TRUE(FetchModels(
      models_request_info, hosts,
      optimization_guide::proto::RequestContext::CONTEXT_BATCH_UPDATE));
  VerifyHasPendingFetchRequests();

  histogram_tester.ExpectUniqueSample(
      "OptimizationGuide.PredictionModelFetcher.GetModelsRequest.HostCount",
      features::MaxHostsForOptimizationGuideServiceModelsFetch(), 1);

  EXPECT_TRUE(SimulateResponse(response_content, net::HTTP_OK));
  EXPECT_TRUE(models_fetched());

  // No HostModelFeatures are returned.
  histogram_tester.ExpectUniqueSample(
      "OptimizationGuide.PredictionModelFetcher.GetModelsResponse."
      "HostModelFeatureCount",
      0, 1);
}

TEST_F(PredictionModelFetcherTest, FetchFilterInvalidHosts) {
  base::HistogramTester histogram_tester;
  std::string response_content;
  std::vector<std::string> hosts = {"192.168.1.1", "_abc", "localhost",
                                    "foo.com"};
  std::vector<optimization_guide::proto::ModelInfo> models_request_info({});
  EXPECT_TRUE(FetchModels(
      models_request_info, hosts,
      optimization_guide::proto::RequestContext::CONTEXT_BATCH_UPDATE));
  VerifyHasPendingFetchRequests();

  histogram_tester.ExpectUniqueSample(
      "OptimizationGuide.PredictionModelFetcher.GetModelsRequest.HostCount", 1,
      1);

  EXPECT_TRUE(SimulateResponse(response_content, net::HTTP_OK));
  EXPECT_TRUE(models_fetched());

  // No HostModelFeatures are returned.
  histogram_tester.ExpectUniqueSample(
      "OptimizationGuide.PredictionModelFetcher.GetModelsResponse."
      "HostModelFeatureCount",
      0, 1);
}

// Tests 404 response from request.
TEST_F(PredictionModelFetcherTest, FetchReturned404) {
  base::HistogramTester histogram_tester;
  std::string response_content;

  std::vector<std::string> hosts = {"foo.com", "bar.com"};
  std::vector<optimization_guide::proto::ModelInfo> models_request_info({});
  EXPECT_TRUE(FetchModels(
      models_request_info, hosts,
      optimization_guide::proto::RequestContext::CONTEXT_BATCH_UPDATE));
  // Send a 404 to HintsFetcher.
  SimulateResponse(response_content, net::HTTP_NOT_FOUND);
  EXPECT_FALSE(models_fetched());
  histogram_tester.ExpectUniqueSample(
      "OptimizationGuide.PredictionModelFetcher.GetModelsResponse.Status",
      net::HTTP_NOT_FOUND, 1);

  // Net error codes are negative but UMA histograms require positive values.
  histogram_tester.ExpectUniqueSample(
      "OptimizationGuide.PredictionModelFetcher.GetModelsResponse.NetErrorCode",
      -net::ERR_HTTP_RESPONSE_CODE_FAILURE, 1);
}

TEST_F(PredictionModelFetcherTest, FetchReturnBadResponse) {
  std::string response_content = "not proto";

  std::vector<std::string> hosts = {"foo.com", "bar.com"};
  std::vector<optimization_guide::proto::ModelInfo> models_request_info({});
  EXPECT_TRUE(FetchModels(
      models_request_info, hosts,
      optimization_guide::proto::RequestContext::CONTEXT_BATCH_UPDATE));
  VerifyHasPendingFetchRequests();
  EXPECT_TRUE(SimulateResponse(response_content, net::HTTP_OK));
  EXPECT_FALSE(models_fetched());
}

TEST_F(PredictionModelFetcherTest, FetchAttemptWhenNetworkOffline) {
  SetConnectionOffline();
  std::string response_content;
  std::vector<std::string> hosts = {"foo.com", "bar.com"};
  std::vector<optimization_guide::proto::ModelInfo> models_request_info({});
  EXPECT_FALSE(FetchModels(
      models_request_info, hosts,
      optimization_guide::proto::RequestContext::CONTEXT_BATCH_UPDATE));
  EXPECT_FALSE(models_fetched());

  SetConnectionOnline();
  EXPECT_TRUE(FetchModels(
      models_request_info, hosts,
      optimization_guide::proto::RequestContext::CONTEXT_BATCH_UPDATE));
  VerifyHasPendingFetchRequests();
  EXPECT_TRUE(SimulateResponse(response_content, net::HTTP_OK));
  EXPECT_TRUE(models_fetched());
}

TEST_F(PredictionModelFetcherTest, EmptyModelInfoAndHosts) {
  base::HistogramTester histogram_tester;
  std::string response_content;
  std::vector<std::string> hosts = {};
  std::vector<optimization_guide::proto::ModelInfo> models_request_info({});
  EXPECT_FALSE(FetchModels(
      models_request_info, hosts,
      optimization_guide::proto::RequestContext::CONTEXT_BATCH_UPDATE));

  EXPECT_FALSE(models_fetched());
}

}  // namespace optimization_guide