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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
|
// Copyright 2025 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/passage_embeddings/internal/scheduling_embedder.h"
#include <initializer_list>
#include <memory>
#include <optional>
#include <tuple>
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/task/sequenced_task_runner.h"
#include "base/test/bind.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "base/test/test_future.h"
#include "components/passage_embeddings/passage_embeddings_service_controller.h"
#include "components/passage_embeddings/passage_embeddings_test_util.h"
#include "components/passage_embeddings/passage_embeddings_types.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace passage_embeddings {
namespace {
using testing::ElementsAre;
using testing::Invoke;
using ComputePassagesEmbeddingsFuture =
base::test::TestFuture<std::vector<std::string>,
std::vector<Embedding>,
SchedulingEmbedder::TaskId,
ComputeEmbeddingsStatus>;
std::vector<mojom::PassageEmbeddingsResultPtr> GenerateExpectedServiceOutput(
std::initializer_list<std::string> passages) {
std::vector<mojom::PassageEmbeddingsResultPtr> results;
for (size_t i = 0; i < passages.size(); ++i) {
results.push_back(
mojom::PassageEmbeddingsResult::New(std::vector<float>{1.0f}));
}
return results;
}
void IgnoreResults(std::vector<std::string>,
std::vector<Embedding>,
SchedulingEmbedder::TaskId,
ComputeEmbeddingsStatus) {}
} // namespace
class GetEmbeddingsStub {
public:
MOCK_METHOD(void,
GetEmbeddings,
(std::vector<std::string> passages,
PassagePriority priority,
SchedulingEmbedder::GetEmbeddingsResultCallback callback));
};
class SchedulingEmbedderTest : public testing::Test {
public:
void SetUp() override {
embedder_metadata_provider_ =
std::make_unique<TestEmbedderMetadataProvider>();
}
void TearDown() override { embedder_metadata_provider_.reset(); }
protected:
base::test::TaskEnvironment task_environment_{
base::test::TaskEnvironment::TimeSource::MOCK_TIME};
std::unique_ptr<EmbedderMetadataProvider> embedder_metadata_provider_;
GetEmbeddingsStub get_embeddings_stub_;
};
TEST_F(SchedulingEmbedderTest, InvokesService) {
auto embedder = std::make_unique<SchedulingEmbedder>(
embedder_metadata_provider_.get(),
base::BindRepeating(&GetEmbeddingsStub::GetEmbeddings,
base::Unretained(&get_embeddings_stub_)),
/*max_jobs=*/4u,
/*max_batch_size=*/1u,
/*use_performance_scenario=*/false);
std::vector<std::string> requested_passages;
std::optional<PassagePriority> passage_priority;
SchedulingEmbedder::GetEmbeddingsResultCallback result_callback;
EXPECT_CALL(get_embeddings_stub_, GetEmbeddings)
.WillOnce(Invoke(
[&](std::vector<std::string> passages, PassagePriority priority,
SchedulingEmbedder::GetEmbeddingsResultCallback callback) {
requested_passages = std::move(passages);
passage_priority = priority;
result_callback = std::move(callback);
}));
embedder->ComputePassagesEmbeddings(PassagePriority::kPassive,
{"test passage 1"},
base::BindOnce(&IgnoreResults));
EXPECT_THAT(requested_passages, ElementsAre("test passage 1"));
EXPECT_EQ(passage_priority, PassagePriority::kPassive);
ASSERT_FALSE(result_callback.is_null());
// Run the callback to notify the SchedulingEmbedder of the processed output.
std::move(result_callback)
.Run(GenerateExpectedServiceOutput({"test passage 1"}),
ComputeEmbeddingsStatus::kSuccess);
}
TEST_F(SchedulingEmbedderTest, TranslatesServiceOutput) {
auto embedder = std::make_unique<SchedulingEmbedder>(
embedder_metadata_provider_.get(),
base::BindRepeating(&GetEmbeddingsStub::GetEmbeddings,
base::Unretained(&get_embeddings_stub_)),
/*max_jobs=*/4u,
/*max_batch_size=*/2u,
/*use_performance_scenario=*/false);
EXPECT_CALL(get_embeddings_stub_, GetEmbeddings)
.WillOnce(
Invoke([](std::vector<std::string> passages, PassagePriority priority,
SchedulingEmbedder::GetEmbeddingsResultCallback callback) {
std::vector<mojom::PassageEmbeddingsResultPtr> results;
results.push_back(mojom::PassageEmbeddingsResult::New(
std::vector<float>{1.0f, 0.0f}));
results.push_back(mojom::PassageEmbeddingsResult::New(
std::vector<float>{0.0f, 1.0f}));
std::move(callback).Run(std::move(results),
ComputeEmbeddingsStatus::kSuccess);
}));
ComputePassagesEmbeddingsFuture future;
Embedder::TaskId task_id = embedder->ComputePassagesEmbeddings(
PassagePriority::kPassive, {"test passage 1", "test passage 2"},
future.GetCallback());
auto [passages, embeddings, received_task_id, status] = future.Take();
EXPECT_THAT(passages, ElementsAre("test passage 1", "test passage 2"));
ASSERT_EQ(embeddings.size(), 2u);
EXPECT_THAT(embeddings[0].GetData(), ElementsAre(1.0f, 0.0f));
EXPECT_THAT(embeddings[1].GetData(), ElementsAre(0.0f, 1.0f));
EXPECT_EQ(task_id, received_task_id);
EXPECT_EQ(status, ComputeEmbeddingsStatus::kSuccess);
}
TEST_F(SchedulingEmbedderTest, UserInitiatedJobTakesPriority) {
auto embedder = std::make_unique<SchedulingEmbedder>(
embedder_metadata_provider_.get(),
base::BindRepeating(&GetEmbeddingsStub::GetEmbeddings,
base::Unretained(&get_embeddings_stub_)),
/*max_jobs=*/4u,
/*max_batch_size=*/1u,
/*use_performance_scenario=*/false);
struct Call {
std::vector<std::string> passages;
PassagePriority priority;
SchedulingEmbedder::GetEmbeddingsResultCallback callback;
};
std::vector<Call> calls;
const auto save_call_parameters =
[&calls](std::vector<std::string> passages, PassagePriority priority,
SchedulingEmbedder::GetEmbeddingsResultCallback callback) {
calls.emplace_back(std::move(passages), priority, std::move(callback));
};
EXPECT_CALL(get_embeddings_stub_, GetEmbeddings)
.WillOnce(Invoke(save_call_parameters))
.WillOnce(Invoke(save_call_parameters))
.WillOnce(Invoke(save_call_parameters));
// Submit a passive priority task.
embedder->ComputePassagesEmbeddings(PassagePriority::kPassive,
{"test passage 1", "test passage 2"},
base::BindOnce(&IgnoreResults));
// Submit a user-initiated priority task. This will suspend the partially
// completed passive priority task.
embedder->ComputePassagesEmbeddings(PassagePriority::kUserInitiated,
{"query"},
base::BindOnce(&IgnoreResults));
ASSERT_EQ(calls.size(), 1u);
EXPECT_THAT(calls.back().passages, ElementsAre("test passage 1"));
EXPECT_EQ(calls.back().priority, PassagePriority::kPassive);
// Running the callback should kick off the next round of processing.
ASSERT_FALSE(calls.back().callback.is_null());
std::move(calls.back().callback)
.Run(GenerateExpectedServiceOutput({"test passage 1"}),
ComputeEmbeddingsStatus::kSuccess);
ASSERT_EQ(calls.size(), 2u);
EXPECT_THAT(calls.back().passages, ElementsAre("query"));
EXPECT_EQ(calls.back().priority, PassagePriority::kUserInitiated);
ASSERT_FALSE(calls.back().callback.is_null());
std::move(calls.back().callback)
.Run(GenerateExpectedServiceOutput({"query"}),
ComputeEmbeddingsStatus::kSuccess);
ASSERT_EQ(calls.size(), 3u);
EXPECT_THAT(calls.back().passages, ElementsAre("test passage 2"));
EXPECT_EQ(calls.back().priority, PassagePriority::kPassive);
ASSERT_FALSE(calls.back().callback.is_null());
std::move(calls.back().callback)
.Run(GenerateExpectedServiceOutput({"test passage 2"}),
ComputeEmbeddingsStatus::kSuccess);
}
TEST_F(SchedulingEmbedderTest, TryCancel) {
auto embedder = std::make_unique<SchedulingEmbedder>(
embedder_metadata_provider_.get(),
base::BindRepeating(&GetEmbeddingsStub::GetEmbeddings,
base::Unretained(&get_embeddings_stub_)),
/*max_jobs=*/4u,
/*max_batch_size=*/1u,
/*use_performance_scenario=*/false);
std::vector<std::string> requested_passages;
SchedulingEmbedder::GetEmbeddingsResultCallback result_callback;
EXPECT_CALL(get_embeddings_stub_, GetEmbeddings)
.WillOnce(Invoke(
[&requested_passages, &result_callback](
std::vector<std::string> passages, PassagePriority priority,
SchedulingEmbedder::GetEmbeddingsResultCallback callback) {
requested_passages = std::move(passages);
result_callback = std::move(callback);
}));
embedder->ComputePassagesEmbeddings(PassagePriority::kPassive,
{"test passage 1"},
base::BindOnce(&IgnoreResults));
Embedder::TaskId second_task_id = embedder->ComputePassagesEmbeddings(
PassagePriority::kPassive, {"test passage 2"},
base::BindOnce(&IgnoreResults));
embedder->TryCancel(second_task_id);
EXPECT_THAT(requested_passages, ElementsAre("test passage 1"));
// Running the callback should not kick off any further processing. This is
// validated by the WillOnce expectation above.
ASSERT_FALSE(result_callback.is_null());
std::move(result_callback)
.Run(GenerateExpectedServiceOutput({"test passage 1"}),
ComputeEmbeddingsStatus::kSuccess);
}
TEST_F(SchedulingEmbedderTest, RecordsHistograms) {
base::HistogramTester histogram_tester;
auto embedder = std::make_unique<SchedulingEmbedder>(
embedder_metadata_provider_.get(),
base::BindRepeating(&GetEmbeddingsStub::GetEmbeddings,
base::Unretained(&get_embeddings_stub_)),
/*max_jobs=*/4u,
/*max_batch_size=*/1u,
/*use_performance_scenario=*/false);
std::vector<SchedulingEmbedder::GetEmbeddingsResultCallback> callbacks;
const auto record_callback =
[&callbacks](std::vector<std::string> passages, PassagePriority priority,
SchedulingEmbedder::GetEmbeddingsResultCallback callback) {
callbacks.push_back(std::move(callback));
};
EXPECT_CALL(get_embeddings_stub_, GetEmbeddings)
.WillOnce(Invoke(record_callback))
.WillOnce(Invoke(record_callback));
ComputePassagesEmbeddingsFuture future1;
embedder->ComputePassagesEmbeddings(
PassagePriority::kPassive, {"test passage 1"}, future1.GetCallback());
ComputePassagesEmbeddingsFuture future2;
Embedder::TaskId task_id = embedder->ComputePassagesEmbeddings(
PassagePriority::kUserInitiated, {"test passage 2a", "test passage 2b"},
future2.GetCallback());
ComputePassagesEmbeddingsFuture future3;
embedder->ComputePassagesEmbeddings(
PassagePriority::kPassive, {"test passage 3"}, future3.GetCallback());
embedder->TryCancel(task_id);
ASSERT_EQ(callbacks.size(), 1u);
ASSERT_FALSE(callbacks.back().is_null());
std::move(callbacks.back())
.Run(GenerateExpectedServiceOutput({"test passage 1"}),
ComputeEmbeddingsStatus::kSuccess);
ASSERT_EQ(callbacks.size(), 2u);
ASSERT_FALSE(callbacks.back().is_null());
std::move(callbacks.back())
.Run(GenerateExpectedServiceOutput({"test passage 3"}),
ComputeEmbeddingsStatus::kSuccess);
ASSERT_TRUE(future1.Wait());
ASSERT_TRUE(future2.Wait());
ASSERT_TRUE(future3.Wait());
// Only the two "passive priority" jobs successfully completed; the "user
// initiate priority" one was canceled. So only two duration histogram samples
// are logged, but three counts histograms samples and three status histogram
// samples are logged as the all jobs were enqueued and completed in some way.
histogram_tester.ExpectTotalCount("History.Embeddings.ScheduledJobDuration",
2);
histogram_tester.ExpectTotalCount(
"History.Embeddings.ScheduledJobDuration.Passive", 2);
histogram_tester.ExpectTotalCount("History.Embeddings.ScheduledJobStatus", 3);
histogram_tester.ExpectTotalCount(
"History.Embeddings.ScheduledJobStatus.Passive", 2);
histogram_tester.ExpectBucketCount(
"History.Embeddings.ScheduledJobStatus.Passive",
ComputeEmbeddingsStatus::kSuccess, 2);
histogram_tester.ExpectTotalCount(
"History.Embeddings.ScheduledJobStatus.UserInitiated", 1);
histogram_tester.ExpectBucketCount(
"History.Embeddings.ScheduledJobStatus.UserInitiated",
ComputeEmbeddingsStatus::kCanceled, 1);
histogram_tester.ExpectTotalCount("History.Embeddings.ScheduledJobCount", 3);
histogram_tester.ExpectBucketCount("History.Embeddings.ScheduledJobCount", 0,
1);
histogram_tester.ExpectBucketCount("History.Embeddings.ScheduledJobCount", 1,
1);
histogram_tester.ExpectBucketCount("History.Embeddings.ScheduledJobCount", 2,
1);
histogram_tester.ExpectTotalCount("History.Embeddings.ScheduledPassageCount",
3);
histogram_tester.ExpectBucketCount("History.Embeddings.ScheduledPassageCount",
0, 1);
histogram_tester.ExpectBucketCount("History.Embeddings.ScheduledPassageCount",
1, 1);
// When the third job is enqueued, 1 + 2 = 3 passages are waiting in the
// previous two jobs.
histogram_tester.ExpectBucketCount("History.Embeddings.ScheduledPassageCount",
3, 1);
}
TEST_F(SchedulingEmbedderTest, LimitsJobCount) {
auto embedder = std::make_unique<SchedulingEmbedder>(
embedder_metadata_provider_.get(),
base::BindRepeating(&GetEmbeddingsStub::GetEmbeddings,
base::Unretained(&get_embeddings_stub_)),
/*max_jobs=*/2u,
/*max_batch_size=*/1u,
/*use_performance_scenario=*/false);
std::vector<SchedulingEmbedder::GetEmbeddingsResultCallback> callbacks;
const auto record_callback =
[&callbacks](std::vector<std::string> passages, PassagePriority priority,
SchedulingEmbedder::GetEmbeddingsResultCallback callback) {
callbacks.push_back(std::move(callback));
};
EXPECT_CALL(get_embeddings_stub_, GetEmbeddings)
.WillOnce(Invoke(record_callback))
.WillOnce(Invoke(record_callback));
ComputePassagesEmbeddingsFuture future1;
embedder->ComputePassagesEmbeddings(
PassagePriority::kPassive, {"test passage 1"}, future1.GetCallback());
ComputePassagesEmbeddingsFuture future2;
embedder->ComputePassagesEmbeddings(
PassagePriority::kPassive, {"test passage 2"}, future2.GetCallback());
ComputePassagesEmbeddingsFuture future3;
embedder->ComputePassagesEmbeddings(
PassagePriority::kPassive, {"test passage 3"}, future3.GetCallback());
ASSERT_EQ(callbacks.size(), 1u);
ASSERT_FALSE(callbacks.back().is_null());
std::move(callbacks.back())
.Run(GenerateExpectedServiceOutput({"test passage 1"}),
ComputeEmbeddingsStatus::kSuccess);
ASSERT_EQ(callbacks.size(), 2u);
ASSERT_FALSE(callbacks.back().is_null());
std::move(callbacks.back())
.Run(GenerateExpectedServiceOutput({"test passage 3"}),
ComputeEmbeddingsStatus::kSuccess);
// Final job interrupts the job at back of line when the limit is reached.
EXPECT_EQ(std::get<3>(future1.Take()), ComputeEmbeddingsStatus::kSuccess);
EXPECT_EQ(std::get<3>(future2.Take()), ComputeEmbeddingsStatus::kCanceled);
EXPECT_EQ(std::get<3>(future3.Take()), ComputeEmbeddingsStatus::kSuccess);
}
} // namespace passage_embeddings
|