1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/feedback/feedback_uploader.h"
#include <memory>
#include <set>
#include "base/containers/contains.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/run_loop.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "base/task/task_traits.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "build/build_config.h"
#include "components/feedback/features.h"
#include "components/feedback/feedback_report.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_url_loader_factory.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace feedback {
namespace {
constexpr char kReportOne[] = "one";
constexpr char kReportTwo[] = "two";
constexpr char kReportThree[] = "three";
constexpr char kReportFour[] = "four";
constexpr char kReportFive[] = "five";
constexpr base::TimeDelta kRetryDelayForTest = base::Milliseconds(100);
class MockFeedbackUploader final : public FeedbackUploader {
public:
MockFeedbackUploader(
bool is_off_the_record,
const base::FilePath& state_path,
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory)
: FeedbackUploader(is_off_the_record, state_path, url_loader_factory) {}
MockFeedbackUploader(const MockFeedbackUploader&) = delete;
MockFeedbackUploader& operator=(const MockFeedbackUploader&) = delete;
base::WeakPtr<FeedbackUploader> AsWeakPtr() override {
return weak_ptr_factory_.GetWeakPtr();
}
void RunMessageLoop() {
if (ProcessingComplete())
return;
run_loop_ = std::make_unique<base::RunLoop>();
run_loop_->Run();
}
void SimulateLoadingOfflineReports() {
task_runner()->PostTask(
FROM_HERE,
base::BindOnce(
&FeedbackReport::LoadReportsAndQueue, feedback_reports_path(),
base::BindRepeating(&MockFeedbackUploader::QueueSingleReport,
base::SequencedTaskRunner::GetCurrentDefault(),
AsWeakPtr())));
}
const std::map<std::string, unsigned int>& dispatched_reports() const {
return dispatched_reports_;
}
void set_expected_reports(size_t value) { expected_reports_ = value; }
void set_simulate_failure(bool value) { simulate_failure_ = value; }
private:
static void QueueSingleReport(
scoped_refptr<base::SequencedTaskRunner> main_task_runner,
base::WeakPtr<FeedbackUploader> uploader,
scoped_refptr<FeedbackReport> report) {
main_task_runner->PostTask(
FROM_HERE, base::BindOnce(&MockFeedbackUploader::RequeueReport,
std::move(uploader), std::move(report)));
}
// FeedbackUploaderChrome:
void StartDispatchingReport() override {
if (base::Contains(dispatched_reports_, report_being_dispatched()->data()))
dispatched_reports_[report_being_dispatched()->data()]++;
else
dispatched_reports_[report_being_dispatched()->data()] = 1;
dispatched_reports_count_++;
if (simulate_failure_)
OnReportUploadFailure(true /* should_retry */);
else
OnReportUploadSuccess();
if (ProcessingComplete()) {
if (run_loop_)
run_loop_->Quit();
}
}
bool ProcessingComplete() {
return (dispatched_reports_count_ >= expected_reports_);
}
std::unique_ptr<base::RunLoop> run_loop_;
std::map<std::string, unsigned int> dispatched_reports_;
size_t dispatched_reports_count_ = 0;
size_t expected_reports_ = 0;
bool simulate_failure_ = false;
base::WeakPtrFactory<MockFeedbackUploader> weak_ptr_factory_{this};
};
} // namespace
class FeedbackUploaderTest : public testing::Test {
public:
FeedbackUploaderTest() {
FeedbackUploader::SetMinimumRetryDelayForTesting(kRetryDelayForTest);
test_shared_loader_factory_ =
base::MakeRefCounted<network::WeakWrapperSharedURLLoaderFactory>(
&test_url_loader_factory_);
EXPECT_TRUE(scoped_temp_dir_.CreateUniqueTempDir());
RecreateUploader();
}
FeedbackUploaderTest(const FeedbackUploaderTest&) = delete;
FeedbackUploaderTest& operator=(const FeedbackUploaderTest&) = delete;
~FeedbackUploaderTest() override = default;
void RecreateUploader() {
uploader_ = std::make_unique<MockFeedbackUploader>(
/*is_off_the_record=*/false, scoped_temp_dir_.GetPath(),
test_shared_loader_factory_);
}
void QueueReport(const std::string& data,
bool has_email = true,
int product_id = 0) {
uploader_->QueueReport(std::make_unique<std::string>(data), has_email,
product_id);
}
MockFeedbackUploader* uploader() const { return uploader_.get(); }
void SetupTastTestFeature() {
scoped_feature_list_.InitWithFeatures(
{feedback::features::kSkipSendingFeedbackReportInTastTests}, {});
}
private:
network::TestURLLoaderFactory test_url_loader_factory_;
scoped_refptr<network::SharedURLLoaderFactory> test_shared_loader_factory_;
base::test::TaskEnvironment task_environment_;
base::test::ScopedFeatureList scoped_feature_list_;
base::ScopedTempDir scoped_temp_dir_;
std::unique_ptr<MockFeedbackUploader> uploader_;
};
TEST_F(FeedbackUploaderTest, QueueMultiple) {
QueueReport(kReportOne);
QueueReport(kReportTwo);
QueueReport(kReportThree);
QueueReport(kReportFour);
EXPECT_EQ(uploader()->dispatched_reports().size(), 4u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportOne), 1u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportTwo), 1u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportThree), 1u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportFour), 1u);
}
TEST_F(FeedbackUploaderTest, QueueMultipleWithFailures) {
EXPECT_EQ(kRetryDelayForTest, uploader()->retry_delay());
QueueReport(kReportOne);
// Simulate a failure in reports two and three. Make sure the backoff delay
// will be applied twice, and the reports will eventually be sent.
uploader()->set_simulate_failure(true);
QueueReport(kReportTwo);
EXPECT_EQ(kRetryDelayForTest * 2, uploader()->retry_delay());
QueueReport(kReportThree);
EXPECT_EQ(kRetryDelayForTest * 4, uploader()->retry_delay());
uploader()->set_simulate_failure(false);
// Once a successful report is sent, the backoff delay is reset back to its
// minimum value.
QueueReport(kReportFour);
EXPECT_EQ(kRetryDelayForTest, uploader()->retry_delay());
QueueReport(kReportFive);
// Wait for the pending two failed reports to be sent.
uploader()->set_expected_reports(7);
uploader()->RunMessageLoop();
EXPECT_EQ(uploader()->dispatched_reports().size(), 5u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportOne), 1u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportTwo), 2u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportThree), 2u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportFour), 1u);
EXPECT_EQ(uploader()->dispatched_reports().at(kReportFive), 1u);
}
#if BUILDFLAG(IS_MAC) && defined(ARCH_CPU_ARM64)
// https://crbug.com/1222877
#define MAYBE_SimulateOfflineReports DISABLED_SimulateOfflineReports
#else
#define MAYBE_SimulateOfflineReports SimulateOfflineReports
#endif
TEST_F(FeedbackUploaderTest, MAYBE_SimulateOfflineReports) {
// Simulate offline reports by failing to upload three reports.
uploader()->set_simulate_failure(true);
QueueReport(kReportOne);
QueueReport(kReportTwo);
QueueReport(kReportThree);
// All three reports will be attempted to be uploaded, but the uploader queue
// will remain having three reports since they all failed.
uploader()->set_expected_reports(3);
uploader()->RunMessageLoop();
EXPECT_EQ(uploader()->dispatched_reports().size(), 3u);
EXPECT_FALSE(uploader()->QueueEmpty());
// Simulate a sign out / resign in by recreating the uploader. This should not
// clear any pending feedback report files on disk, and hence they can be
// reloaded.
RecreateUploader();
uploader()->SimulateLoadingOfflineReports();
uploader()->set_expected_reports(3);
uploader()->RunMessageLoop();
// The three reports were loaded, successfully uploaded, and the uploader
// queue is now empty.
EXPECT_EQ(uploader()->dispatched_reports().size(), 3u);
EXPECT_TRUE(uploader()->QueueEmpty());
}
TEST_F(FeedbackUploaderTest, TastTestsDontSendReports) {
SetupTastTestFeature();
QueueReport(kReportOne);
EXPECT_EQ(uploader()->dispatched_reports().size(), 0u);
}
} // namespace feedback
|