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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
// Copyright 2023 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/segmentation_platform/internal/selection/result_refresh_manager.h"
#include "base/memory/raw_ptr.h"
#include "base/metrics/user_metrics.h"
#include "base/run_loop.h"
#include "base/test/gmock_callback_support.h"
#include "base/test/simple_test_clock.h"
#include "base/test/task_environment.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/testing_pref_service.h"
#include "components/segmentation_platform/internal/constants.h"
#include "components/segmentation_platform/internal/data_collection/training_data_collector.h"
#include "components/segmentation_platform/internal/database/client_result_prefs.h"
#include "components/segmentation_platform/internal/metadata/metadata_utils.h"
#include "components/segmentation_platform/internal/metadata/metadata_writer.h"
#include "components/segmentation_platform/internal/post_processor/post_processing_test_utils.h"
#include "components/segmentation_platform/internal/selection/segment_result_provider.h"
#include "components/segmentation_platform/public/config.h"
#include "components/segmentation_platform/public/prediction_options.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using testing::_;
using testing::Invoke;
namespace segmentation_platform {
namespace {
// Test clients.
const char kTestClient1[] = "client_1";
const char kTestClient2[] = "client_2";
// Test Ids.
const proto::SegmentId kSegmentId1 =
proto::SegmentId::OPTIMIZATION_TARGET_SEGMENTATION_SEARCH_USER;
const proto::SegmentId kSegmentId2 =
proto::SegmentId::OPTIMIZATION_TARGET_SEGMENTATION_TABLET_PRODUCTIVITY_USER;
class MockResultProvider : public SegmentResultProvider {
public:
MOCK_METHOD1(GetSegmentResult,
void(std::unique_ptr<GetResultOptions> options));
};
class MockTrainingDataCollector : public TrainingDataCollector {
public:
MOCK_METHOD0(OnModelMetadataUpdated, void());
MOCK_METHOD0(OnServiceInitialized, void());
MOCK_METHOD0(ReportCollectedContinuousTrainingData, void());
MOCK_METHOD5(OnDecisionTime,
TrainingRequestId(proto::SegmentId id,
scoped_refptr<InputContext> input_context,
DecisionType type,
std::optional<ModelProvider::Request> inputs,
bool decision_result_update_trigger));
MOCK_METHOD5(CollectTrainingData,
void(SegmentId segment_id,
TrainingRequestId request_id,
ukm::SourceId ukm_source_id,
const TrainingLabels& param,
SuccessCallback callback));
};
class ResultRefreshManagerTest : public testing::Test {
public:
ResultRefreshManagerTest() = default;
~ResultRefreshManagerTest() override = default;
void SetUp() override {
base::SetRecordActionTaskRunner(
task_environment_.GetMainThreadTaskRunner());
auto training_data_collector =
std::make_unique<MockTrainingDataCollector>();
training_data_collector_ = training_data_collector.get();
execution_service_ = std::make_unique<ExecutionService>();
execution_service_->set_training_data_collector_for_testing(
std::move(training_data_collector));
std::vector<std::unique_ptr<Config>> configs;
configs.emplace_back(
test_utils::CreateTestConfig(kTestClient1, kSegmentId1));
configs.emplace_back(
test_utils::CreateTestConfig(kTestClient2, kSegmentId2));
config_holder_ = std::make_unique<ConfigHolder>(std::move(configs));
cached_result_writer_ = SetupCachedResultWriter();
client1_result_provider_ = std::make_unique<MockResultProvider>();
client2_result_provider_ = std::make_unique<MockResultProvider>();
result_refresh_manager_ = std::make_unique<ResultRefreshManager>(
config_holder_.get(), cached_result_writer_.get(),
PlatformOptions(/*force_refresh_results=*/false,
/*disable_model_execution_delay=*/true));
}
std::unique_ptr<CachedResultWriter> SetupCachedResultWriter() {
pref_service.registry()->RegisterStringPref(kSegmentationClientResultPrefs,
std::string());
std::unique_ptr<ClientResultPrefs> result_prefs =
std::make_unique<ClientResultPrefs>(&pref_service);
client_result_prefs_ = std::make_unique<ClientResultPrefs>(&pref_service);
clock_.SetNow(base::Time::Now());
return std::make_unique<CachedResultWriter>(client_result_prefs_.get(),
&clock_);
}
void ExpectSegmentResult(
const proto::SegmentId segment_id,
MockResultProvider* segment_result_provider,
const proto::PredictionResult& result,
const SegmentResultProvider::ResultState& result_state,
bool ignore_db_scores) {
EXPECT_CALL(*segment_result_provider, GetSegmentResult(_))
.WillOnce(
Invoke([segment_id, result, result_state, ignore_db_scores](
std::unique_ptr<SegmentResultProvider::GetResultOptions>
options) {
EXPECT_EQ(options->ignore_db_scores, ignore_db_scores);
EXPECT_EQ(options->segment_id, segment_id);
auto segment_result =
std::make_unique<SegmentResultProvider::SegmentResult>(
result_state, result, /*rank=*/1);
std::move(options->callback).Run(std::move(segment_result));
}));
}
void VerifyIfResultUpdatedInPrefs(const std::string& segmentation_key,
proto::PredictionResult expected_result) {
const proto::ClientResult* client_result =
client_result_prefs_->ReadClientResultFromPrefs(segmentation_key);
EXPECT_TRUE(client_result);
EXPECT_EQ(expected_result.SerializeAsString(),
client_result->client_result().SerializeAsString());
}
void VerifyIfResultNotUpdatedInPrefs(const std::string& segmentation_key) {
const proto::ClientResult* client_result =
client_result_prefs_->ReadClientResultFromPrefs(segmentation_key);
EXPECT_FALSE(client_result);
}
base::test::TaskEnvironment task_environment_{
base::test::TaskEnvironment::TimeSource::MOCK_TIME};
std::unique_ptr<ExecutionService> execution_service_;
raw_ptr<MockTrainingDataCollector> training_data_collector_;
std::unique_ptr<ConfigHolder> config_holder_;
std::unique_ptr<MockResultProvider> client1_result_provider_;
std::unique_ptr<MockResultProvider> client2_result_provider_;
std::unique_ptr<ResultRefreshManager> result_refresh_manager_;
std::unique_ptr<ClientResultPrefs> client_result_prefs_;
std::unique_ptr<CachedResultWriter> cached_result_writer_;
TestingPrefServiceSimple pref_service;
base::SimpleTestClock clock_;
};
TEST_F(ResultRefreshManagerTest, TestRefreshModelResultsSuccess) {
// Client 1 gets model result from database.
proto::PredictionResult result_from_db_for_client1 =
metadata_utils::CreatePredictionResult(
/*model_scores=*/{0.8},
test_utils::GetTestOutputConfigForBinaryClassifier(),
/*timestamp=*/base::Time::Now(), /*model_version=*/1);
ExpectSegmentResult(
kSegmentId1, client1_result_provider_.get(), result_from_db_for_client1,
SegmentResultProvider::ResultState::kServerModelDatabaseScoreUsed,
/*ignore_db_scores=*/false);
// Client 2 gets model result by running the model.
proto::PredictionResult result_from_model_for_client2 =
metadata_utils::CreatePredictionResult(
/*model_scores=*/{0.8},
test_utils::GetTestOutputConfigForBinaryClassifier(),
/*timestamp=*/base::Time::Now(), /*model_version=*/1);
ExpectSegmentResult(
kSegmentId2, client2_result_provider_.get(),
result_from_model_for_client2,
SegmentResultProvider::ResultState::kServerModelExecutionScoreUsed,
/*ignore_db_scores=*/false);
EXPECT_CALL(
*training_data_collector_,
OnDecisionTime(_, _, proto::TrainingOutputs::TriggerConfig::PERIODIC, _,
true))
.Times(2);
std::map<std::string, std::unique_ptr<SegmentResultProvider>>
result_providers;
result_providers[kTestClient1] = std::move(client1_result_provider_);
result_providers[kTestClient2] = std::move(client2_result_provider_);
result_refresh_manager_->Initialize(std::move(result_providers),
execution_service_.get());
result_refresh_manager_->RefreshModelResults(/*is_startup=*/true);
VerifyIfResultUpdatedInPrefs(kTestClient1, result_from_db_for_client1);
VerifyIfResultUpdatedInPrefs(kTestClient2, result_from_model_for_client2);
}
TEST_F(ResultRefreshManagerTest, TestRefreshModelResultWithNoResult) {
// Client 1 tries to get model result from database, but signal not collected.
proto::PredictionResult result_for_client =
metadata_utils::CreatePredictionResult(
/*model_scores=*/{},
test_utils::GetTestOutputConfigForBinaryClassifier(),
/*timestamp=*/base::Time::Now(), /*model_version=*/1);
ExpectSegmentResult(
kSegmentId1, client1_result_provider_.get(), result_for_client,
SegmentResultProvider::ResultState::kServerModelSignalsNotCollected,
/*ignore_db_scores=*/false);
// Client 2 tries gets model result by running the model and model execution
// fails.
ExpectSegmentResult(
kSegmentId2, client2_result_provider_.get(), result_for_client,
SegmentResultProvider::ResultState::kDefaultModelExecutionFailed,
/*ignore_db_scores=*/false);
EXPECT_CALL(
*training_data_collector_,
OnDecisionTime(_, _, proto::TrainingOutputs::TriggerConfig::PERIODIC, _,
true))
.Times(0);
std::map<std::string, std::unique_ptr<SegmentResultProvider>>
result_providers;
result_providers[kTestClient1] = std::move(client1_result_provider_);
result_providers[kTestClient2] = std::move(client2_result_provider_);
result_refresh_manager_->Initialize(std::move(result_providers),
execution_service_.get());
result_refresh_manager_->RefreshModelResults(/*is_startup=*/true);
VerifyIfResultNotUpdatedInPrefs(kTestClient1);
VerifyIfResultNotUpdatedInPrefs(kTestClient2);
}
TEST_F(ResultRefreshManagerTest, TestOnModelUpdated) {
// Client 1 gets model result from database.
proto::PredictionResult result_from_db_for_client1 =
metadata_utils::CreatePredictionResult(
/*model_scores=*/{0.8},
test_utils::GetTestOutputConfigForBinaryClassifier(),
/*timestamp=*/base::Time::Now(), /*model_version=*/1);
ExpectSegmentResult(
kSegmentId1, client1_result_provider_.get(), result_from_db_for_client1,
SegmentResultProvider::ResultState::kServerModelDatabaseScoreUsed,
/*ignore_db_scores=*/false);
EXPECT_CALL(
*training_data_collector_,
OnDecisionTime(kSegmentId1, _,
proto::TrainingOutputs::TriggerConfig::PERIODIC, _, true))
.Times(1);
std::map<std::string, std::unique_ptr<SegmentResultProvider>>
result_providers;
result_providers[kTestClient1] = std::move(client1_result_provider_);
result_refresh_manager_->Initialize(std::move(result_providers),
execution_service_.get());
proto::SegmentInfo segment_info;
segment_info.set_segment_id(kSegmentId1);
result_refresh_manager_->OnModelUpdated(&segment_info);
VerifyIfResultUpdatedInPrefs(kTestClient1, result_from_db_for_client1);
}
TEST_F(ResultRefreshManagerTest, TestOnModelUpdatedWithDelay) {
result_refresh_manager_ = std::make_unique<ResultRefreshManager>(
config_holder_.get(), cached_result_writer_.get(),
PlatformOptions(/*force_refresh_results=*/false));
std::map<std::string, std::unique_ptr<SegmentResultProvider>>
result_providers;
result_providers[kTestClient1] = std::move(client1_result_provider_);
result_refresh_manager_->Initialize(std::move(result_providers),
execution_service_.get());
proto::SegmentInfo segment_info;
segment_info.set_segment_id(kSegmentId1);
result_refresh_manager_->OnModelUpdated(&segment_info);
VerifyIfResultNotUpdatedInPrefs(kTestClient1);
}
} // namespace
} // namespace segmentation_platform
|
