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 440 441 442 443 444 445 446 447
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_LENS_TEST_LENS_OVERLAY_QUERY_CONTROLLER_H_
#define CHROME_BROWSER_UI_LENS_TEST_LENS_OVERLAY_QUERY_CONTROLLER_H_
#include "base/memory/weak_ptr.h"
#include "components/endpoint_fetcher/endpoint_fetcher.h"
#include "lens_overlay_query_controller.h"
namespace lens {
class FakeEndpointFetcher : public endpoint_fetcher::EndpointFetcher {
public:
explicit FakeEndpointFetcher(endpoint_fetcher::EndpointResponse response);
void PerformRequest(
endpoint_fetcher::EndpointFetcherCallback endpoint_fetcher_callback,
const char* key) override;
bool disable_responding_ = false;
private:
endpoint_fetcher::EndpointResponse response_;
};
// Helper for testing features that use the LensOverlayQueryController.
// The only logic in this class should be for setting up fake network responses
// and tracking sent request data to maximize testing coverage.
class TestLensOverlayQueryController : public LensOverlayQueryController {
public:
explicit TestLensOverlayQueryController(
LensOverlayFullImageResponseCallback full_image_callback,
LensOverlayUrlResponseCallback url_callback,
LensOverlayInteractionResponseCallback interaction_callback,
LensOverlaySuggestInputsCallback interaction_data_callback,
LensOverlayThumbnailCreatedCallback thumbnail_created_callback,
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);
~TestLensOverlayQueryController() override;
// Mutators.
void set_fake_cluster_info_response(
lens::LensOverlayServerClusterInfoResponse response) {
fake_cluster_info_response_ = response;
}
void set_fake_objects_response(lens::LensOverlayObjectsResponse response) {
fake_objects_response_ = response;
}
void set_fake_interaction_response(
lens::LensOverlayInteractionResponse response) {
fake_interaction_response_ = response;
}
void set_disable_next_objects_response(bool disable_next_objects_response) {
disable_next_objects_response_ = disable_next_objects_response;
}
void set_next_full_image_request_should_return_error(
bool next_full_image_request_should_return_error) {
next_full_image_request_should_return_error_ =
next_full_image_request_should_return_error;
}
void set_disable_page_upload_response_callback(bool disable) {
disable_page_upload_response_callback = disable;
}
void RunUploadProgressCallback() {
std::move(last_upload_progress_callback_).Run(1, 1);
}
// Accessors.
const GURL& sent_fetch_url() const { return sent_fetch_url_; }
const lens::LensOverlayClientLogs& sent_client_logs() const {
return sent_client_logs_;
}
const lens::LensOverlayRequestId& sent_full_image_request_id() const {
return sent_full_image_request_id_;
}
const lens::LensOverlayRequestId& sent_interaction_request_id() const {
return sent_interaction_request_id_;
}
const lens::LensOverlayRequestId& sent_page_content_request_id() const {
return sent_page_content_request_id_;
}
const lens::LensOverlayObjectsRequest& sent_full_image_objects_request()
const {
return sent_full_image_objects_request_;
}
const lens::LensOverlayObjectsRequest& sent_page_content_objects_request()
const {
return sent_page_content_objects_request_;
}
const lens::LensOverlayObjectsRequest&
sent_partial_page_content_objects_request() const {
return sent_partial_page_content_objects_request_;
}
const lens::LensOverlayInteractionRequest& sent_interaction_request() const {
return sent_interaction_request_;
}
const std::string& last_queried_text() const { return last_queried_text_; }
const lens::LensOverlaySelectionType& last_lens_selection_type() const {
return last_lens_selection_type_;
}
const lens::mojom::CenterRotatedBoxPtr& last_queried_region() const {
return last_queried_region_;
}
const std::optional<SkBitmap>& last_queried_region_bytes() const {
return last_queried_region_bytes_;
}
lens::Payload last_sent_page_content_payload() const {
return last_sent_page_content_payload_;
}
base::span<const uint8_t> last_sent_underlying_content_bytes() const {
return last_sent_underlying_content_bytes_;
}
const lens::MimeType& last_sent_underlying_content_type() const {
return last_sent_underlying_content_type_;
}
const lens::LensOverlayDocument& last_sent_partial_content() const {
return last_sent_partial_content_;
}
const GURL& last_sent_page_url() const { return last_sent_page_url_; }
const std::vector<lens::mojom::CenterRotatedBoxPtr>&
last_sent_significant_region_boxes() const {
return last_sent_significant_region_boxes_;
}
const std::optional<lens::mojom::UserAction>& last_user_action() const {
return last_user_action_;
}
const std::optional<lens::mojom::SemanticEvent>& last_semantic_event() const {
return last_semantic_event_;
}
const int& num_full_image_requests_sent() const {
return num_full_image_requests_sent_;
}
const int& num_interaction_requests_sent() const {
return num_interaction_requests_sent_;
}
const int& num_cluster_info_fetch_requests_sent() const {
return num_cluster_info_fetch_requests_sent_;
}
const int& num_full_page_objects_gen204_pings_sent() const {
return num_full_page_objects_gen204_pings_sent_;
}
const int& num_page_content_update_requests_sent() const {
return num_page_content_update_requests_sent_;
}
const int& num_partial_page_content_requests_sent() const {
return num_partial_page_content_requests_sent_;
}
const int& num_upload_chunk_requests_sent() const {
return num_upload_chunk_requests_sent_;
}
const std::optional<lens::LensOverlayServerClusterInfoRequest>&
last_cluster_info_request() const {
return last_cluster_info_request_;
}
int latency_gen_204_counter(
lens::LensOverlayGen204Controller::LatencyType latency_type) const {
auto it = latency_gen_204_counter_.find(latency_type);
return it == latency_gen_204_counter_.end() ? 0 : it->second;
}
const std::optional<lens::LensOverlayRequestId>&
last_latency_gen204_request_id() const {
return last_latency_gen204_request_id_;
}
const std::optional<std::string>& last_latency_gen204_analytics_id() const {
return last_latency_gen204_analytics_id_;
}
const std::optional<lens::LensOverlayRequestId>&
last_semantic_event_gen204_request_id() const {
return last_semantic_event_gen204_request_id_;
}
const std::optional<std::string>& last_task_completion_gen204_analytics_id()
const {
return last_task_completion_gen204_analytics_id_;
}
const std::optional<lens::LensOverlayRequestId>&
last_task_completion_gen204_request_id() const {
return last_task_completion_gen204_request_id_;
}
void StartQueryFlow(
const SkBitmap& screenshot,
GURL page_url,
std::optional<std::string> page_title,
std::vector<lens::mojom::CenterRotatedBoxPtr> significant_region_boxes,
base::span<const lens::PageContent> underlying_page_contents,
lens::MimeType primary_content_type,
std::optional<uint32_t> pdf_current_page,
float ui_scale_factor,
base::TimeTicks invocation_time) override;
void SendRegionSearch(
base::Time query_start_time,
lens::mojom::CenterRotatedBoxPtr region,
lens::LensOverlaySelectionType selection_type,
std::map<std::string, std::string> additional_search_query_params,
std::optional<SkBitmap> region_bytes) override;
void SendTextOnlyQuery(base::Time query_start_time,
const std::string& query_text,
lens::LensOverlaySelectionType lens_selection_type,
std::map<std::string, std::string>
additional_search_query_params) override;
void SendMultimodalRequest(
base::Time query_start_time,
lens::mojom::CenterRotatedBoxPtr region,
const std::string& query_text,
lens::LensOverlaySelectionType multimodal_selection_type,
std::map<std::string, std::string> additional_search_query_params,
std::optional<SkBitmap> region_bitmap) override;
void SendContextualTextQuery(
base::Time query_start_time,
const std::string& query_text,
lens::LensOverlaySelectionType lens_selection_type,
std::map<std::string, std::string> additional_search_query_params)
override;
// Resets the test state.
void ResetTestingState();
protected:
std::unique_ptr<endpoint_fetcher::EndpointFetcher> CreateEndpointFetcher(
std::string request_string,
const GURL& fetch_url,
endpoint_fetcher::HttpMethod http_method,
base::TimeDelta timeout,
const std::vector<std::string>& request_headers,
const std::vector<std::string>& cors_exempt_headers,
UploadProgressCallback upload_progress_callback) override;
void SendLatencyGen204IfEnabled(
lens::LensOverlayGen204Controller::LatencyType latency_type,
base::TimeTicks start_time_ticks,
std::string vit_query_param_value,
std::optional<base::TimeDelta> cluster_info_latency,
std::optional<std::string> encoded_analytics_id,
std::optional<lens::LensOverlayRequestId> request_id) override;
void SendTaskCompletionGen204IfEnabled(
std::string encoded_analytics_id,
lens::mojom::UserAction user_action,
lens::LensOverlayRequestId request_id) override;
void SendSemanticEventGen204IfEnabled(
lens::mojom::SemanticEvent event,
std::optional<lens::LensOverlayRequestId> request_id) override;
void RunSuggestInputsCallback() override;
// The fake response to return for cluster info requests.
lens::LensOverlayServerClusterInfoResponse fake_cluster_info_response_;
// The fake response to return for objects requests.
lens::LensOverlayObjectsResponse fake_objects_response_;
// The fake response to return for interaction requests.
lens::LensOverlayInteractionResponse fake_interaction_response_;
// If true, the response for the next objects request will not be returned.
bool disable_next_objects_response_ = false;
// If true, the next full image request will return an error.
bool next_full_image_request_should_return_error_ = false;
// If true, the CreateEndpointFetcher will not automatically respond with a
// complete upload to the UploadProgressCallback.
bool disable_page_upload_response_callback = false;
// The last url for which a fetch request was sent by the query controller.
GURL sent_fetch_url_;
// The last client logs sent by the query controller.
lens::LensOverlayClientLogs sent_client_logs_;
// The last request id sent by the query controller for a full image request.
lens::LensOverlayRequestId sent_full_image_request_id_;
// The last request id sent by the query controller for an interaction
// request.
lens::LensOverlayRequestId sent_interaction_request_id_;
// The last request id sent by the query controller for a page content upload
// request.
lens::LensOverlayRequestId sent_page_content_request_id_;
// The last full image objects request sent by the query controller.
lens::LensOverlayObjectsRequest sent_full_image_objects_request_;
// The last page content objects request sent by the query controller.
lens::LensOverlayObjectsRequest sent_page_content_objects_request_;
// The last partial page content objects request sent by the query controller.
lens::LensOverlayObjectsRequest sent_partial_page_content_objects_request_;
// The last interaction request sent by the query controller.
lens::LensOverlayInteractionRequest sent_interaction_request_;
// The last query text sent by the query controller.
std::string last_queried_text_;
// The last lens selection type sent by the query controller.
lens::LensOverlaySelectionType last_lens_selection_type_;
// The last region sent by the query controller.
lens::mojom::CenterRotatedBoxPtr last_queried_region_;
// The last region bytes sent by the query controller.
std::optional<SkBitmap> last_queried_region_bytes_;
// The last page content data sent by the query controller. Used to prevent
// dangling references by the underlying content bytes span.
std::string last_sent_page_content_data_;
// The Payload proto sent in the last page content upload.
// This is deprecated field and will soon be removed. Use
// last_sent_page_content_data_ directly instead.
lens::Payload last_sent_page_content_payload_;
// The last underlying content bytes sent by the query controller.
// This is deprecated field and will soon be removed. Use
// last_sent_page_content_data_ directly instead.
base::raw_span<const uint8_t> last_sent_underlying_content_bytes_;
// The last underlying content type sent by the query controller.
lens::MimeType last_sent_underlying_content_type_ = lens::MimeType::kUnknown;
// The last partial content sent by the query controller.
lens::LensOverlayDocument last_sent_partial_content_;
// The last page url sent by the query controller.
GURL last_sent_page_url_;
// The last significant region boxes sent to the query controller.
std::vector<lens::mojom::CenterRotatedBoxPtr>
last_sent_significant_region_boxes_;
// The last user action sent by the query controller.
std::optional<lens::mojom::UserAction> last_user_action_;
// The last semantic event sent by the query controller.
std::optional<lens::mojom::SemanticEvent> last_semantic_event_;
// The number of full image objects requests sent by the query controller.
int num_full_image_requests_sent_ = 0;
// The number of interaction requests sent by the query controller.
int num_interaction_requests_sent_ = 0;
// The number of cluster info fetch requests sent by the query controller.
int num_cluster_info_fetch_requests_sent_ = 0;
// The number of full page objects gen204 pings sent by the query controller.
int num_full_page_objects_gen204_pings_sent_ = 0;
// The number of full page translate gen204 pings sent by the query
// controller.
int num_full_page_translate_gen204_pings_sent_ = 0;
// The number of page content update requests sent by the query controller.
int num_page_content_update_requests_sent_ = 0;
// The number of partial page content requests sent by the query controller.
int num_partial_page_content_requests_sent_ = 0;
// The number of upload chunk requests sent by the query controller.
int num_upload_chunk_requests_sent_ = 0;
// The last cluster info request received.
std::optional<lens::LensOverlayServerClusterInfoRequest>
last_cluster_info_request_;
// The last encoded request id attached to a latency gen204 ping.
std::optional<lens::LensOverlayRequestId> last_latency_gen204_request_id_;
// The last analytics id attached to a latency gen204 ping.
std::optional<std::string> last_latency_gen204_analytics_id_;
// The last analytics id attached to a task completion gen204 ping.
std::optional<std::string> last_task_completion_gen204_analytics_id_;
// The last encoded request id attached to a task completion gen204 ping.
std::optional<lens::LensOverlayRequestId>
last_task_completion_gen204_request_id_;
// The last encoded request id attached to a semantic event gen204 ping.
std::optional<lens::LensOverlayRequestId>
last_semantic_event_gen204_request_id_;
// Tracker for the number of latency request events sent by the query
// controller.
base::flat_map<lens::LensOverlayGen204Controller::LatencyType, int>
latency_gen_204_counter_;
// The last upload progress callback sent by the query controller.
UploadProgressCallback last_upload_progress_callback_;
};
} // namespace lens
#endif // CHROME_BROWSER_UI_LENS_TEST_LENS_OVERLAY_QUERY_CONTROLLER_H_
|