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 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
|
// 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 "chrome/browser/ui/lens/lens_composebox_controller.h"
#include "base/test/bind.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/run_until.h"
#include "chrome/browser/lens/core/mojom/lens.mojom.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/signin/identity_manager_factory.h"
#include "chrome/browser/sync/sync_service_factory.h"
#include "chrome/browser/themes/theme_service.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/lens/lens_composebox_handler.h"
#include "chrome/browser/ui/lens/lens_overlay_controller.h"
#include "chrome/browser/ui/lens/lens_overlay_side_panel_coordinator.h"
#include "chrome/browser/ui/lens/lens_search_controller.h"
#include "chrome/browser/ui/lens/test_lens_overlay_controller.h"
#include "chrome/browser/ui/lens/test_lens_overlay_query_controller.h"
#include "chrome/browser/ui/lens/test_lens_overlay_side_panel_coordinator.h"
#include "chrome/browser/ui/lens/test_lens_search_contextualization_controller.h"
#include "chrome/browser/ui/lens/test_lens_search_controller.h"
#include "chrome/browser/ui/tabs/public/tab_features.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chrome/test/base/ui_test_utils.h"
#include "components/lens/lens_composebox_user_action.h"
#include "components/lens/lens_features.h"
#include "components/lens/lens_overlay_dismissal_source.h"
#include "components/lens/lens_overlay_invocation_source.h"
#include "components/lens/lens_overlay_permission_utils.h"
#include "components/lens/proto/server/lens_overlay_response.pb.h"
#include "content/public/test/browser_test.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/lens_server_proto/aim_communication.pb.h"
#include "ui/base/unowned_user_data/user_data_factory.h"
namespace {
using State = LensOverlayController::State;
constexpr char kTestSearchSessionId[] = "test_search_session_id";
constexpr char kTestServerSessionId[] = "test_server_session_id";
const lens::mojom::CenterRotatedBoxPtr kTestRegion =
lens::mojom::CenterRotatedBox::New(
gfx::RectF(0.5, 0.5, 0.8, 0.8),
0.0,
lens::mojom::CenterRotatedBox_CoordinateType::kNormalized);
const SkBitmap CreateNonEmptyBitmap(int width, int height) {
SkBitmap bitmap;
bitmap.allocN32Pixels(width, height);
bitmap.eraseColor(SK_ColorGREEN);
return bitmap;
}
// A fake LensSearchController to inject fake controllers.
class LensSearchControllerFake : public lens::TestLensSearchController {
public:
explicit LensSearchControllerFake(tabs::TabInterface* tab)
: lens::TestLensSearchController(tab) {}
~LensSearchControllerFake() override = default;
protected:
std::unique_ptr<LensOverlayController> CreateLensOverlayController(
tabs::TabInterface* tab,
LensSearchController* lens_search_controller,
variations::VariationsClient* variations_client,
signin::IdentityManager* identity_manager,
PrefService* pref_service,
syncer::SyncService* sync_service,
ThemeService* theme_service) override {
return std::make_unique<lens::TestLensOverlayController>(
tab, lens_search_controller, variations_client, identity_manager,
pref_service, sync_service, theme_service);
}
std::unique_ptr<lens::LensOverlayQueryController> CreateLensQueryController(
lens::LensOverlayFullImageResponseCallback full_image_callback,
lens::LensOverlayUrlResponseCallback url_callback,
lens::LensOverlayInteractionResponseCallback interaction_callback,
lens::LensOverlaySuggestInputsCallback suggest_inputs_callback,
lens::LensOverlayThumbnailCreatedCallback thumbnail_created_callback,
lens::UploadProgressCallback upload_progress_callback,
variations::VariationsClient* variations_client,
signin::IdentityManager* identity_manager,
Profile* profile,
lens::LensOverlayInvocationSource invocation_source,
bool use_dark_mode,
lens::LensOverlayGen204Controller* gen204_controller) override {
auto fake_query_controller =
std::make_unique<lens::TestLensOverlayQueryController>(
full_image_callback, url_callback, interaction_callback,
suggest_inputs_callback, thumbnail_created_callback,
upload_progress_callback, variations_client, identity_manager,
profile, invocation_source, use_dark_mode, gen204_controller);
// Set up the cluster info to test the search session ID is propagated.
lens::LensOverlayServerClusterInfoResponse cluster_info_response;
cluster_info_response.set_server_session_id(kTestServerSessionId);
cluster_info_response.set_search_session_id(kTestSearchSessionId);
fake_query_controller->set_fake_cluster_info_response(
cluster_info_response);
return fake_query_controller;
}
std::unique_ptr<lens::LensOverlaySidePanelCoordinator>
CreateLensOverlaySidePanelCoordinator() override {
return std::make_unique<lens::TestLensOverlaySidePanelCoordinator>(this);
}
};
ui::UserDataFactory::ScopedOverride UseFakeLensSearchController() {
return tabs::TabFeatures::GetUserDataFactoryForTesting()
.AddOverrideForTesting(base::BindRepeating([](tabs::TabInterface& tab) {
return std::make_unique<LensSearchControllerFake>(&tab);
}));
}
} // namespace
class LensComposeboxControllerBrowserTest : public InProcessBrowserTest {
protected:
LensComposeboxControllerBrowserTest() {
lens_search_controller_override_ = UseFakeLensSearchController();
}
void SetUp() override {
ASSERT_TRUE(embedded_test_server()->InitializeAndListen());
feature_list_.InitWithFeaturesAndParameters(
{
{lens::features::kLensOverlay,
/*params=*/{}},
{lens::features::kLensSearchAimM3, /*params=*/{}},
{lens::features::kLensOverlayContextualSearchbox,
{
// Updating the viewport each query can cause flakiness
// when checking the sequence ids.
{"update-viewport-each-query", "false"},
}},
},
/*disabled_features=*/{});
InProcessBrowserTest::SetUp();
}
void SetUpOnMainThread() override {
InProcessBrowserTest::SetUpOnMainThread();
embedded_test_server()->StartAcceptingConnections();
// Permits sharing the page screenshot by default.
PrefService* prefs = browser()->profile()->GetPrefs();
prefs->SetBoolean(lens::prefs::kLensSharingPageScreenshotEnabled, true);
prefs->SetBoolean(lens::prefs::kLensSharingPageContentEnabled, true);
}
void TearDownOnMainThread() override {
EXPECT_TRUE(embedded_test_server()->ShutdownAndWaitUntilComplete());
InProcessBrowserTest::TearDownOnMainThread();
// Disallow sharing the page screenshot by default.
PrefService* prefs = browser()->profile()->GetPrefs();
prefs->SetBoolean(lens::prefs::kLensSharingPageScreenshotEnabled, false);
prefs->SetBoolean(lens::prefs::kLensSharingPageContentEnabled, false);
}
void WaitForPaint(std::string_view relative_url = "/select.html") {
const GURL url = embedded_test_server()->GetURL(relative_url);
ASSERT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
}
LensSearchController* GetLensSearchController() {
return LensSearchController::From(browser()->GetActiveTabInterface());
}
LensOverlayController* GetLensOverlayController() {
return GetLensSearchController()->lens_overlay_controller();
}
lens::LensComposeboxController* GetLensComposeboxController() {
return GetLensSearchController()->lens_composebox_controller();
}
lens::TestLensOverlaySidePanelCoordinator* GetLensSidePanelCoordinator() {
return static_cast<lens::TestLensOverlaySidePanelCoordinator*>(
GetLensSearchController()->lens_overlay_side_panel_coordinator());
}
void MockAimToClientMessage(lens::AimToClientMessage aim_to_client_message) {
auto* lens_side_panel_coordinator = GetLensSidePanelCoordinator();
;
ASSERT_TRUE(lens_side_panel_coordinator);
// Serialize the message and pass it to the side panel coordinator.
std::vector<uint8_t> serialized_message(
aim_to_client_message.ByteSizeLong());
aim_to_client_message.SerializeToArray(&serialized_message[0],
serialized_message.size());
lens_side_panel_coordinator->OnAimMessage(serialized_message);
}
base::test::ScopedFeatureList feature_list_;
private:
ui::UserDataFactory::ScopedOverride lens_search_controller_override_;
};
IN_PROC_BROWSER_TEST_F(LensComposeboxControllerBrowserTest,
HandshakeResponseHandling) {
WaitForPaint();
auto* lens_controller = GetLensSearchController();
ASSERT_TRUE(lens_controller);
// Open the overlay directly to the side panel so composebox is visible.
SkBitmap initial_bitmap = CreateNonEmptyBitmap(100, 100);
GetLensSearchController()->OpenLensOverlayWithPendingRegion(
lens::LensOverlayInvocationSource::kContentAreaContextMenuImage,
kTestRegion->Clone(), initial_bitmap);
auto* overlay_controller = GetLensOverlayController();
ASSERT_TRUE(base::test::RunUntil([&]() {
return overlay_controller->state() == State::kOverlayAndResults;
}));
// Wait for the composebox handler to be set and then send a fake AIM query
// via mojo.
ASSERT_TRUE(base::test::RunUntil([&]() {
return GetLensComposeboxController()->composebox_handler_for_testing() !=
nullptr;
}));
// Mock a handshake response.
lens::AimToClientMessage aim_to_client_message;
aim_to_client_message.mutable_handshake_response()->add_capabilities(
lens::FeatureCapability::DEFAULT);
MockAimToClientMessage(aim_to_client_message);
// Verify the handshake is sent to the side panel.
auto* test_side_panel_coordinator = GetLensSidePanelCoordinator();
ASSERT_TRUE(test_side_panel_coordinator);
ASSERT_EQ(test_side_panel_coordinator->aim_handshake_received_call_count_, 1);
}
IN_PROC_BROWSER_TEST_F(LensComposeboxControllerBrowserTest,
IssueComposeboxQuerySendsPostMessage) {
WaitForPaint();
auto* lens_controller = GetLensSearchController();
ASSERT_TRUE(lens_controller);
// Open the overlay directly to the side panel so composebox is visible.
SkBitmap initial_bitmap = CreateNonEmptyBitmap(100, 100);
lens_controller->OpenLensOverlayWithPendingRegion(
lens::LensOverlayInvocationSource::kContentAreaContextMenuImage,
kTestRegion->Clone(), initial_bitmap);
auto* overlay_controller = GetLensOverlayController();
ASSERT_TRUE(base::test::RunUntil([&]() {
return overlay_controller->state() == State::kOverlayAndResults;
}));
// Wait for the composebox handler to be set and then send a fake AIM query
// via mojo.
ASSERT_TRUE(base::test::RunUntil([&]() {
return GetLensComposeboxController()->composebox_handler_for_testing() !=
nullptr;
}));
// Also need to run until the query controller has send all requests to avoid
// flakiness.
auto* fake_query_controller =
static_cast<lens::TestLensOverlayQueryController*>(
lens_controller->lens_overlay_query_controller());
ASSERT_TRUE(base::test::RunUntil([&]() {
return fake_query_controller->num_full_image_requests_sent() == 1 &&
fake_query_controller->num_page_content_update_requests_sent() ==
1 &&
fake_query_controller->num_interaction_requests_sent() == 1;
}));
// Mock a handshake call so the composebox controller can send query messages.
lens::AimToClientMessage aim_to_client_message;
aim_to_client_message.mutable_handshake_response()->add_capabilities(
lens::FeatureCapability::DEFAULT);
MockAimToClientMessage(aim_to_client_message);
// Send a query.
GetLensComposeboxController()->composebox_handler_for_testing()->SubmitQuery(
"test query", /*mouse_button=*/0, /*alt_key=*/false, /*ctrl_key=*/false,
/*meta_key=*/false,
/*shift_key=*/false);
// Verify the client message sent.
auto* test_side_panel_coordinator = GetLensSidePanelCoordinator();
ASSERT_TRUE(test_side_panel_coordinator);
ASSERT_TRUE(test_side_panel_coordinator->last_sent_client_message_to_aim_
.has_submit_query());
// Verify the submit query message.
auto submit_query = test_side_panel_coordinator
->last_sent_client_message_to_aim_.submit_query();
ASSERT_EQ(submit_query.payload().query_text(), "test query");
ASSERT_EQ(submit_query.payload().query_text_source(),
lens::QueryPayload::QUERY_TEXT_SOURCE_KEYBOARD_INPUT);
ASSERT_EQ(submit_query.payload().lens_image_query_data_size(), 1);
auto lens_image_query_data = submit_query.payload().lens_image_query_data(0);
ASSERT_EQ(lens_image_query_data.search_session_id(), kTestSearchSessionId);
ASSERT_EQ(lens_image_query_data.request_id().sequence_id(), 4);
ASSERT_EQ(lens_image_query_data.request_id().long_context_id(), 1);
ASSERT_EQ(lens_image_query_data.request_id().image_sequence_id(), 1);
}
IN_PROC_BROWSER_TEST_F(LensComposeboxControllerBrowserTest,
LogsComposeboxMetrics) {
base::HistogramTester histogram_tester;
WaitForPaint();
auto* lens_controller = GetLensSearchController();
ASSERT_TRUE(lens_controller);
// Open the overlay directly to the side panel so composebox is visible.
SkBitmap initial_bitmap = CreateNonEmptyBitmap(100, 100);
lens_controller->OpenLensOverlayWithPendingRegion(
lens::LensOverlayInvocationSource::kContentAreaContextMenuImage,
kTestRegion->Clone(), initial_bitmap);
auto* overlay_controller = GetLensOverlayController();
ASSERT_TRUE(base::test::RunUntil([&]() {
return overlay_controller->state() == State::kOverlayAndResults;
}));
// Wait for the composebox handler to be set and then send a fake AIM query
// via mojo.
ASSERT_TRUE(base::test::RunUntil([&]() {
return GetLensComposeboxController()->composebox_handler_for_testing() !=
nullptr;
}));
auto* composebox_handler =
GetLensComposeboxController()->composebox_handler_for_testing();
ASSERT_TRUE(composebox_handler);
// Mock a focus of the composebox. Should be logged.
composebox_handler->FocusChanged(true);
histogram_tester.ExpectBucketCount("Lens.Composebox.UserAction",
lens::LensComposeboxUserAction::kFocused,
1);
// Mock a focus out of the composebox. Should not be logged.
composebox_handler->FocusChanged(false);
histogram_tester.ExpectBucketCount("Lens.Composebox.UserAction",
lens::LensComposeboxUserAction::kFocused,
1);
// A new focus should be logged.
composebox_handler->FocusChanged(true);
histogram_tester.ExpectBucketCount("Lens.Composebox.UserAction",
lens::LensComposeboxUserAction::kFocused,
2);
// Mock a handshake response for the session end metrics.
lens::AimToClientMessage aim_to_client_message;
aim_to_client_message.mutable_handshake_response()->add_capabilities(
lens::FeatureCapability::DEFAULT);
MockAimToClientMessage(aim_to_client_message);
// Send a query.
GetLensComposeboxController()->composebox_handler_for_testing()->SubmitQuery(
"test query", /*mouse_button=*/0, /*alt_key=*/false, /*ctrl_key=*/false,
/*meta_key=*/false,
/*shift_key=*/false);
histogram_tester.ExpectBucketCount(
"Lens.Composebox.UserAction",
lens::LensComposeboxUserAction::kQuerySubmitted, 1);
// Send another query.
GetLensComposeboxController()->composebox_handler_for_testing()->SubmitQuery(
"test query 2", /*mouse_button=*/0, /*alt_key=*/false, /*ctrl_key=*/false,
/*meta_key=*/false,
/*shift_key=*/false);
histogram_tester.ExpectBucketCount(
"Lens.Composebox.UserAction",
lens::LensComposeboxUserAction::kQuerySubmitted, 2);
// Close the overlay to trigger session end metrics.
lens_controller->CloseLensSync(
lens::LensOverlayDismissalSource::kOverlayCloseButton);
ASSERT_TRUE(base::test::RunUntil(
[&]() { return overlay_controller->state() == State::kOff; }));
// Verify session end metrics are logged once.
histogram_tester.ExpectUniqueSample("Lens.Composebox.ShownInSession", true,
1);
histogram_tester.ExpectUniqueSample(
"Lens.Composebox.HandshakeCompletedInSession", true, 1);
histogram_tester.ExpectBucketCount("Lens.Composebox.UserActionInSession",
lens::LensComposeboxUserAction::kFocused,
1);
histogram_tester.ExpectBucketCount(
"Lens.Composebox.UserActionInSession",
lens::LensComposeboxUserAction::kQuerySubmitted, 1);
// Start a new session.
lens_controller->OpenLensOverlayWithPendingRegion(
lens::LensOverlayInvocationSource::kContentAreaContextMenuImage,
kTestRegion->Clone(), initial_bitmap);
ASSERT_TRUE(base::test::RunUntil([&]() {
return overlay_controller->state() == State::kOverlayAndResults;
}));
// Wait for the composebox handler to be set.
ASSERT_TRUE(base::test::RunUntil([&]() {
return GetLensComposeboxController()->composebox_handler_for_testing() !=
nullptr;
}));
// Close the overlay to trigger session end metrics again.
lens_controller->CloseLensSync(
lens::LensOverlayDismissalSource::kSidePanelCloseButton);
ASSERT_TRUE(base::test::RunUntil(
[&]() { return overlay_controller->state() == State::kOff; }));
// Verify session end metrics totals.
histogram_tester.ExpectUniqueSample("Lens.Composebox.ShownInSession", true,
2);
histogram_tester.ExpectBucketCount(
"Lens.Composebox.HandshakeCompletedInSession", true, 1);
histogram_tester.ExpectBucketCount(
"Lens.Composebox.HandshakeCompletedInSession", false, 1);
histogram_tester.ExpectBucketCount("Lens.Composebox.UserActionInSession",
lens::LensComposeboxUserAction::kFocused,
1);
histogram_tester.ExpectBucketCount(
"Lens.Composebox.UserActionInSession",
lens::LensComposeboxUserAction::kQuerySubmitted, 1);
}
|