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 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463
|
// 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.
#include "chrome/browser/ui/lens/lens_overlay_query_controller.h"
#include <optional>
#include "base/base64url.h"
#include "base/containers/span.h"
#include "base/containers/span_reader.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/logging.h"
#include "base/notreached.h"
#include "base/rand_util.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/bind_post_task.h"
#include "base/task/thread_pool.h"
#include "base/time/time.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/lens/core/mojom/geometry.mojom.h"
#include "chrome/browser/lens/core/mojom/overlay_object.mojom-forward.h"
#include "chrome/browser/lens/core/mojom/text.mojom-forward.h"
#include "chrome/browser/lens/core/mojom/text.mojom.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/lens/lens_overlay_gen204_controller.h"
#include "chrome/browser/ui/lens/lens_overlay_image_helper.h"
#include "chrome/browser/ui/lens/lens_overlay_proto_converter.h"
#include "chrome/browser/ui/lens/lens_overlay_url_builder.h"
#include "chrome/browser/ui/lens/lens_search_feature_flag_utils.h"
#include "chrome/common/channel_info.h"
#include "components/base32/base32.h"
#include "components/endpoint_fetcher/endpoint_fetcher.h"
#include "components/lens/lens_features.h"
#include "components/lens/lens_overlay_mime_type.h"
#include "components/lens/lens_request_construction.h"
#include "components/lens/proto/server/lens_overlay_response.pb.h"
#include "components/lens/ref_counted_lens_overlay_client_logs.h"
#include "components/metrics_services_manager/metrics_services_manager.h"
#include "components/signin/public/base/consent_level.h"
#include "components/signin/public/identity_manager/access_token_info.h"
#include "components/signin/public/identity_manager/identity_manager.h"
#include "components/version_info/channel.h"
#include "google_apis/common/api_error_codes.h"
#include "google_apis/gaia/gaia_constants.h"
#include "google_apis/gaia/gaia_urls.h"
#include "google_apis/google_api_keys.h"
#include "net/base/url_util.h"
#include "net/http/http_request_headers.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/network/public/cpp/simple_url_loader.h"
#include "third_party/icu/source/common/unicode/locid.h"
#include "third_party/icu/source/common/unicode/unistr.h"
#include "third_party/icu/source/i18n/unicode/timezone.h"
#include "third_party/lens_server_proto/lens_overlay_client_platform.pb.h"
#include "third_party/lens_server_proto/lens_overlay_document.pb.h"
#include "third_party/lens_server_proto/lens_overlay_filters.pb.h"
#include "third_party/lens_server_proto/lens_overlay_platform.pb.h"
#include "third_party/lens_server_proto/lens_overlay_polygon.pb.h"
#include "third_party/lens_server_proto/lens_overlay_request_id.pb.h"
#include "third_party/lens_server_proto/lens_overlay_request_type.pb.h"
#include "third_party/lens_server_proto/lens_overlay_service_deps.pb.h"
#include "third_party/lens_server_proto/lens_overlay_surface.pb.h"
#include "third_party/lens_server_proto/lens_overlay_visual_search_interaction_data.pb.h"
#include "third_party/zstd/src/lib/zstd.h"
#include "ui/gfx/geometry/rect.h"
using endpoint_fetcher::CredentialsMode;
using endpoint_fetcher::EndpointFetcher;
using endpoint_fetcher::EndpointFetcherCallback;
using endpoint_fetcher::EndpointResponse;
using endpoint_fetcher::HttpMethod;
namespace lens {
using LatencyType = LensOverlayGen204Controller::LatencyType;
namespace {
// The name string for the header for variations information.
constexpr char kContentTypeKey[] = "Content-Type";
constexpr char kContentType[] = "application/x-protobuf";
constexpr char kSessionIdQueryParameterKey[] = "gsessionid";
constexpr char kOAuthConsumerName[] = "LensOverlayQueryController";
constexpr char kGen204IdentifierQueryParameter[] = "plla";
constexpr char kVisualSearchInteractionDataQueryParameterKey[] = "vsint";
constexpr char kPdfMimeType[] = "application/pdf";
constexpr char kPlainTextMimeType[] = "text/plain";
constexpr char kHtmlMimeType[] = "text/html";
constexpr char kVisualInputTypeQueryParameterKey[] = "vit";
constexpr char kPdfVisualInputTypeQueryParameterValue[] = "pdf";
constexpr char kWebpageVisualInputTypeQueryParameterValue[] = "wp";
constexpr char kImageVisualInputTypeQueryParameterValue[] = "img";
constexpr char kContextualVisualInputTypeQueryParameterValue[] = "video";
constexpr net::NetworkTrafficAnnotationTag kTrafficAnnotationTag =
net::DefineNetworkTrafficAnnotation("lens_overlay", R"(
semantics {
sender: "Lens"
description: "A request to the service handling the Lens "
"Overlay feature in Chrome."
trigger: "The user triggered a Lens Overlay Flow by entering "
"the experience via the right click menu option for "
"searching images on the page."
data: "If the contextual searchbox is enabled, the viewport "
"screenshot, page content, page URL and user interaction data are "
"sent to the server. Page content refers to the page the user is "
"on, extracted, and sent to the server as bytes. If the contextual "
"searchbox is disabled, only the screenshot of the current webpage "
"viewport (image bytes) and user interaction data (coordinates of "
"a box within the screenshot or tapped object-id) are sent."
destination: GOOGLE_OWNED_SERVICE
internal {
contacts {
email: "hujasonx@google.com"
}
contacts {
email: "lens-chrome@google.com"
}
}
user_data {
type: USER_CONTENT
type: WEB_CONTENT
}
last_reviewed: "2024-11-06"
}
policy {
cookies_allowed: YES
cookies_store: "user"
setting: "This feature is only shown in menus by default and does "
"nothing without explicit user action, so there is no setting to "
"disable the feature."
chrome_policy {
GenAiLensOverlaySettings {
GenAiLensOverlaySettings: 1
}
}
}
)");
// Creates a request id with an invalid (negative) sequence id. This is used to
// indicate that the request id is invalid, e.g. to indicate that there is no
// valid interaction data associated with a text-only query in
// IsCurrentInteractionSequence.
std::unique_ptr<lens::LensOverlayRequestId> CreateInvalidRequestId() {
auto request_id = std::make_unique<lens::LensOverlayRequestId>();
request_id->set_sequence_id(-1);
return request_id;
}
lens::CoordinateType ConvertToServerCoordinateType(
lens::mojom::CenterRotatedBox_CoordinateType type) {
switch (type) {
case lens::mojom::CenterRotatedBox_CoordinateType::kNormalized:
return lens::CoordinateType::NORMALIZED;
case lens::mojom::CenterRotatedBox_CoordinateType::kImage:
return lens::CoordinateType::IMAGE;
case lens::mojom::CenterRotatedBox_CoordinateType::kUnspecified:
return lens::CoordinateType::COORDINATE_TYPE_UNSPECIFIED;
}
}
lens::CenterRotatedBox ConvertToServerCenterRotatedBox(
lens::mojom::CenterRotatedBoxPtr box) {
lens::CenterRotatedBox out_box;
out_box.set_center_x(box->box.x());
out_box.set_center_y(box->box.y());
out_box.set_width(box->box.width());
out_box.set_height(box->box.height());
out_box.set_coordinate_type(
ConvertToServerCoordinateType(box->coordinate_type));
return out_box;
}
std::string VitQueryParamValueForMimeType(lens::MimeType mime_type) {
// Default contextual visual input type.
std::string vitValue = kContextualVisualInputTypeQueryParameterValue;
switch (mime_type) {
case lens::MimeType::kPdf:
if (lens::features::UsePdfVitParam()) {
vitValue = kPdfVisualInputTypeQueryParameterValue;
}
break;
case lens::MimeType::kHtml:
case lens::MimeType::kPlainText:
case lens::MimeType::kAnnotatedPageContent:
if (lens::features::UseWebpageVitParam()) {
vitValue = kWebpageVisualInputTypeQueryParameterValue;
}
break;
case lens::MimeType::kUnknown:
break;
case lens::MimeType::kImage:
case lens::MimeType::kVideo:
case lens::MimeType::kAudio:
case lens::MimeType::kJson:
// These content types are not supported for the page content upload flow.
NOTREACHED() << "Unsupported option in page content upload";
}
return vitValue;
}
std::map<std::string, std::string> AddVisualInputTypeQueryParam(
std::map<std::string, std::string> additional_search_query_params,
lens::MimeType content_type) {
std::string vitValue = VitQueryParamValueForMimeType(content_type);
additional_search_query_params.insert(
{kVisualInputTypeQueryParameterKey, vitValue});
return additional_search_query_params;
}
std::string ContentTypeToString(lens::MimeType content_type) {
switch (content_type) {
case lens::MimeType::kPdf:
return kPdfMimeType;
case lens::MimeType::kHtml:
return kHtmlMimeType;
case lens::MimeType::kPlainText:
return kPlainTextMimeType;
case lens::MimeType::kUnknown:
return "";
case lens::MimeType::kAnnotatedPageContent:
// Upload annotated page content should only be done in the new request
// flow which does not use string for content type.
NOTREACHED() << "APC not supported in this flow";
case lens::MimeType::kImage:
case lens::MimeType::kVideo:
case lens::MimeType::kAudio:
case lens::MimeType::kJson:
// These content types are not supported for the page content upload flow.
NOTREACHED() << "Unsupported option in page content upload";
}
}
lens::LensOverlayInteractionRequestMetadata::Type ContentTypeToInteractionType(
lens::MimeType content_type) {
switch (content_type) {
case lens::MimeType::kPdf:
if (lens::features::UsePdfInteractionType()) {
return lens::LensOverlayInteractionRequestMetadata::PDF_QUERY;
}
break;
case lens::MimeType::kHtml:
case lens::MimeType::kPlainText:
case lens::MimeType::kAnnotatedPageContent:
if (lens::features::UseWebpageInteractionType()) {
return lens::LensOverlayInteractionRequestMetadata::WEBPAGE_QUERY;
}
break;
case lens::MimeType::kUnknown:
break;
case lens::MimeType::kImage:
case lens::MimeType::kVideo:
case lens::MimeType::kAudio:
case lens::MimeType::kJson:
// These content types are not supported for the page content upload flow.
NOTREACHED() << "Unsupported option in page content upload";
}
return lens::LensOverlayInteractionRequestMetadata::CONTEXTUAL_SEARCH_QUERY;
}
lens::ContentData::ContentType MimeTypeToContentType(
lens::MimeType content_type) {
switch (content_type) {
case lens::MimeType::kPdf:
return lens::ContentData::CONTENT_TYPE_PDF;
case lens::MimeType::kHtml:
return lens::ContentData::CONTENT_TYPE_INNER_HTML;
case lens::MimeType::kPlainText:
return lens::ContentData::CONTENT_TYPE_INNER_TEXT;
case lens::MimeType::kUnknown:
return lens::ContentData::CONTENT_TYPE_UNSPECIFIED;
case lens::MimeType::kAnnotatedPageContent:
return lens::ContentData::CONTENT_TYPE_ANNOTATED_PAGE_CONTENT;
case lens::MimeType::kImage:
case lens::MimeType::kVideo:
case lens::MimeType::kAudio:
case lens::MimeType::kJson:
// These content types are not supported for the page content upload flow.
NOTREACHED() << "Unsupported option in page content upload";
}
}
lens::LensOverlayClientLogs::LensOverlayEntryPoint
LenOverlayEntryPointFromInvocationSource(
lens::LensOverlayInvocationSource invocation_source) {
switch (invocation_source) {
case lens::LensOverlayInvocationSource::kAppMenu:
return lens::LensOverlayClientLogs::APP_MENU;
case lens::LensOverlayInvocationSource::kContentAreaContextMenuPage:
return lens::LensOverlayClientLogs::PAGE_CONTEXT_MENU;
case lens::LensOverlayInvocationSource::kContentAreaContextMenuImage:
return lens::LensOverlayClientLogs::IMAGE_CONTEXT_MENU;
case lens::LensOverlayInvocationSource::kOmnibox:
return lens::LensOverlayClientLogs::OMNIBOX_BUTTON;
case lens::LensOverlayInvocationSource::kOmniboxContextualSuggestion:
return lens::LensOverlayClientLogs::OMNIBOX_CONTEXTUAL_SUGGESTION;
case lens::LensOverlayInvocationSource::kOmniboxPageAction:
return lens::LensOverlayClientLogs::OMNIBOX_PAGE_ACTION;
case lens::LensOverlayInvocationSource::kHomeworkActionChip:
return lens::LensOverlayClientLogs::HOMEWORK_ACTION_CHIP;
case lens::LensOverlayInvocationSource::kToolbar:
return lens::LensOverlayClientLogs::TOOLBAR_BUTTON;
case lens::LensOverlayInvocationSource::kFindInPage:
return lens::LensOverlayClientLogs::FIND_IN_PAGE;
case lens::LensOverlayInvocationSource::kLVFShutterButton:
case lens::LensOverlayInvocationSource::kLVFGallery:
case lens::LensOverlayInvocationSource::kContextMenu:
case lens::LensOverlayInvocationSource::kAIHub:
case lens::LensOverlayInvocationSource::kFREPromo:
NOTREACHED() << "Invocation source not supported.";
}
return lens::LensOverlayClientLogs::UNKNOWN_ENTRY_POINT;
}
// Compresses the given bytes using Zstd and store them into `dst_bytes`.
// Returns true if the compression is successful.
bool ZstdCompressBytes(base::span<const uint8_t> src_bytes,
std::string* dst_bytes) {
CHECK(dst_bytes);
size_t uncompressed_size = src_bytes.size();
size_t buffer_bounds = ZSTD_compressBound(uncompressed_size);
// Resize the output buffer to the upper bound of the compressed size.
dst_bytes->resize(buffer_bounds);
// Do the compression.
const size_t compressed_size = ZSTD_compress(
dst_bytes->data(), buffer_bounds, src_bytes.data(), uncompressed_size,
lens::features::GetZstdCompressionLevel());
if (ZSTD_isError(compressed_size)) {
return false;
}
// Resize the output vector to the actual compressed size.
dst_bytes->resize(compressed_size);
return true;
}
// Divides the content_bytes into small chunks, which are then compressed.
std::vector<std::string> MakeChunks(base::span<const uint8_t> content_bytes) {
base::SpanReader reader(content_bytes);
size_t max_chunk_size = lens::features::GetLensOverlayChunkSizeBytes();
std::vector<std::string> chunks;
while (reader.remaining() > 0) {
size_t chunk_size = std::min(reader.remaining(), max_chunk_size);
auto current_chunk = reader.Read(chunk_size);
CHECK(current_chunk.has_value());
std::string chunk;
const bool success = ZstdCompressBytes(current_chunk.value(), &chunk);
if (!success) {
// If any of the chunks fail to compress, then the request should fail.
return std::vector<std::string>();
}
chunks.push_back(chunk);
}
return chunks;
}
// Creates the lens::LensOverlayUploadChunkRequest for the given chunk.
lens::LensOverlayUploadChunkRequest CreateUploadChunkRequest(
int64_t chunk_id,
int64_t total_chunks,
std::string chunk,
lens::LensOverlayRequestContext request_context) {
lens::LensOverlayUploadChunkRequest request;
request.mutable_request_context()->CopyFrom(request_context);
if (lens::features::IsLensOverlayUploadChunkingUseDebugOptionsEnabled()) {
// Only the first chunk should have this value set.
if (chunk_id == 0) {
request.mutable_debug_options()->set_total_chunks(total_chunks);
}
// Only the last chunk should set query chunks.
if (chunk_id == (total_chunks - 1)) {
request.mutable_debug_options()->set_query_chunks(true);
}
}
request.set_chunk_id(chunk_id);
request.mutable_chunk_bytes()->assign(chunk.begin(), chunk.end());
return request;
}
// Returns the lens::Payload to be sent after uploading chunked data using the
// repeated Content field instead of the deprecated payload fields.
lens::Payload CreatePageContentPayloadWithUpdatedContentFieldsForChunks(
base::span<const lens::PageContent> page_content,
lens::MimeType primary_content_type,
GURL page_url,
std::optional<std::string> page_title,
int64_t total_stored_chunks) {
lens::Payload payload;
auto* content = payload.mutable_content();
if (!page_url.is_empty() &&
lens::features::SendPageUrlForContextualization()) {
content->set_webpage_url(page_url.spec());
}
if (page_title.has_value() && !page_title.value().empty() &&
lens::features::SendPageTitleForContextualization()) {
content->set_webpage_title(page_title.value());
}
auto* content_data = content->add_content_data();
content_data->set_content_type(MimeTypeToContentType(primary_content_type));
content_data->mutable_stored_chunk_options()->set_read_stored_chunks(true);
content_data->mutable_stored_chunk_options()->set_total_stored_chunks(
total_stored_chunks);
content_data->set_compression_type(lens::CompressionType::ZSTD);
return payload;
}
// Returns the lens::Payload to be sent after uploading chunked data.
lens::Payload CreatePageContentPayloadForChunks(
base::span<const lens::PageContent> page_content,
lens::MimeType primary_content_type,
GURL page_url,
std::optional<std::string> page_title,
int64_t total_stored_chunks) {
if (lens::features::UseUpdatedContextFields()) {
return CreatePageContentPayloadWithUpdatedContentFieldsForChunks(
page_content, primary_content_type, page_url, page_title,
total_stored_chunks);
}
lens::Payload payload;
payload.set_content_type(ContentTypeToString(primary_content_type));
if (!page_url.is_empty() &&
lens::features::SendPageUrlForContextualization()) {
payload.set_page_url(page_url.spec());
}
payload.mutable_stored_chunk_options()->set_read_stored_chunks(true);
payload.mutable_stored_chunk_options()->set_total_stored_chunks(
total_stored_chunks);
payload.set_compression_type(lens::CompressionType::ZSTD);
return payload;
}
// Returns the lens::Payload using the repeated Content field instead of the
// deprecated payload fields.
lens::Payload CreatePageContentPayloadWithUpdatedContentFields(
base::span<const lens::PageContent> page_contents,
GURL page_url,
std::optional<std::string> page_title) {
lens::Payload payload;
auto* content = payload.mutable_content();
if (!page_url.is_empty() &&
lens::features::SendPageUrlForContextualization()) {
content->set_webpage_url(page_url.spec());
}
if (page_title.has_value() && !page_title.value().empty() &&
lens::features::SendPageTitleForContextualization()) {
content->set_webpage_title(page_title.value());
}
for (const lens::PageContent& page_content : page_contents) {
auto* content_data = content->add_content_data();
content_data->set_content_type(
MimeTypeToContentType(page_content.content_type_));
if (page_content.content_type_ == lens::MimeType::kPdf &&
lens::features::ShouldZstdCompressPdfBytes()) {
// If compression is successful, set the compression type and return.
// Otherwise, fall back to the original bytes.
if (ZstdCompressBytes(page_content.bytes_,
content_data->mutable_data())) {
content_data->set_compression_type(lens::CompressionType::ZSTD);
continue;
}
}
// Add non compressed bytes. This happens if compression fails or its not
// a PDF.
content_data->mutable_data()->assign(page_content.bytes_.begin(),
page_content.bytes_.end());
}
return payload;
}
lens::Payload CreatePageContentPayload(
base::span<const lens::PageContent> page_content,
lens::MimeType primary_content_type,
GURL page_url,
std::optional<std::string> page_title) {
if (lens::features::UseUpdatedContextFields()) {
return CreatePageContentPayloadWithUpdatedContentFields(
page_content, page_url, page_title);
}
CHECK_EQ(page_content.size(), 1u);
auto content_type = page_content.front().content_type_;
auto content_bytes = page_content.front().bytes_;
CHECK_EQ(content_type, primary_content_type);
lens::Payload payload;
payload.set_content_type(ContentTypeToString(content_type));
if (!page_url.is_empty() &&
lens::features::SendPageUrlForContextualization()) {
payload.set_page_url(page_url.spec());
}
// Compress the PDF bytes if the feature flag is enabled and the bytes are for
// a PDF.
if (content_type == lens::MimeType::kPdf &&
lens::features::ShouldZstdCompressPdfBytes()) {
// If compression is successful, set the compression type and return.
// Otherwise, fall back to the original bytes.
if (ZstdCompressBytes(content_bytes, payload.mutable_content_data())) {
payload.set_compression_type(lens::CompressionType::ZSTD);
return payload;
}
}
payload.mutable_content_data()->assign(content_bytes.begin(),
content_bytes.end());
return payload;
}
std::string Base64EncodeRequestId(lens::LensOverlayRequestId request_id) {
std::string serialized_request_id;
CHECK(request_id.SerializeToString(&serialized_request_id));
std::string encoded_request_id;
base::Base64UrlEncode(serialized_request_id,
base::Base64UrlEncodePolicy::OMIT_PADDING,
&encoded_request_id);
return encoded_request_id;
}
} // namespace
PageContent::PageContent() : content_type_(lens::MimeType::kUnknown) {}
PageContent::PageContent(std::vector<uint8_t> bytes,
lens::MimeType content_type)
: bytes_(bytes), content_type_(content_type) {}
PageContent::PageContent(const PageContent& other) = default;
PageContent::~PageContent() = default;
LensOverlayQueryController::LensOverlayQueryController(
LensOverlayFullImageResponseCallback full_image_callback,
LensOverlayUrlResponseCallback url_callback,
LensOverlayInteractionResponseCallback interaction_response_callback,
LensOverlaySuggestInputsCallback suggest_inputs_callback,
LensOverlayThumbnailCreatedCallback thumbnail_created_callback,
UploadProgressCallback page_content_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)
: full_image_callback_(std::move(full_image_callback)),
interaction_response_callback_(std::move(interaction_response_callback)),
suggest_inputs_callback_(std::move(suggest_inputs_callback)),
thumbnail_created_callback_(std::move(thumbnail_created_callback)),
page_content_upload_progress_callback_(
std::move(page_content_upload_progress_callback)),
request_id_generator_(
std::make_unique<lens::LensOverlayRequestIdGenerator>()),
url_callback_(std::move(url_callback)),
variations_client_(variations_client),
identity_manager_(identity_manager),
profile_(profile),
invocation_source_(invocation_source),
use_dark_mode_(use_dark_mode),
gen204_controller_(gen204_controller) {
encoding_task_runner_ = base::ThreadPool::CreateTaskRunner(
{base::TaskPriority::USER_VISIBLE,
base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN});
compression_task_runner_ = base::ThreadPool::CreateTaskRunner(
{base::TaskPriority::USER_VISIBLE,
base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN});
encoding_task_tracker_ = std::make_unique<base::CancelableTaskTracker>();
compression_task_tracker_ = std::make_unique<base::CancelableTaskTracker>();
}
LensOverlayQueryController::~LensOverlayQueryController() {
EndQuery();
}
void LensOverlayQueryController::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) {
original_screenshot_ = screenshot;
page_url_ = page_url;
page_title_ = page_title;
significant_region_boxes_ = std::move(significant_region_boxes);
underlying_page_contents_ = underlying_page_contents;
primary_content_type_ = primary_content_type;
pdf_current_page_ = pdf_current_page;
ui_scale_factor_ = ui_scale_factor;
invocation_time_ = invocation_time;
gen204_id_ = base::RandUint64();
gen204_controller_->OnQueryFlowStart(invocation_source_, profile_,
gen204_id_);
if (primary_content_type_ != lens::MimeType::kUnknown) {
suggest_inputs_.set_contextual_visual_input_type(
VitQueryParamValueForMimeType(primary_content_type_));
RunSuggestInputsCallback();
}
// Reset translation languages in case they were set in a previous request.
translate_options_.reset();
PrepareAndFetchFullImageRequest();
}
void LensOverlayQueryController::EndQuery() {
ResetPageContentData();
gen204_controller_->OnQueryFlowEnd();
full_image_endpoint_fetcher_.reset();
interaction_endpoint_fetcher_.reset();
pending_interaction_callback_.Reset();
cluster_info_access_token_fetcher_.reset();
full_image_access_token_fetcher_.reset();
interaction_access_token_fetcher_.reset();
page_url_ = GURL();
page_title_.reset();
translate_options_.reset();
cluster_info_.reset();
encoding_task_tracker_->TryCancelAll();
compression_task_tracker_->TryCancelAll();
query_controller_state_ = QueryControllerState::kOff;
}
void LensOverlayQueryController::MaybeRestartQueryFlow() {
if (query_controller_state_ == QueryControllerState::kClusterInfoExpired) {
PrepareAndFetchFullImageRequest();
}
}
void LensOverlayQueryController::SendFullPageTranslateQuery(
const std::string& source_language,
const std::string& target_language) {
CHECK(query_controller_state_ != QueryControllerState::kOff)
<< "SendFullPageTranslateQuery called when query controller is off";
translate_options_ = TranslateOptions(source_language, target_language);
// Send a normal full image request. The parameters to make it a translate
// request will be set when the actual request is sent based on the instance
// variables.
PrepareAndFetchFullImageRequest();
}
void LensOverlayQueryController::SendEndTranslateModeQuery() {
CHECK(query_controller_state_ != QueryControllerState::kOff)
<< "SendEndTranslateModeQuery called when query controller is off";
translate_options_.reset();
PrepareAndFetchFullImageRequest();
}
void LensOverlayQueryController::ResetPageContentData() {
underlying_page_contents_ = base::span<const lens::PageContent>();
primary_content_type_ = lens::MimeType::kUnknown;
pdf_current_page_ = std::nullopt;
page_url_ = GURL();
page_title_ = std::nullopt;
partial_content_ = base::span<const std::u16string>();
}
void LensOverlayQueryController::SendUpdatedPageContent(
std::optional<base::span<const lens::PageContent>> underlying_page_content,
std::optional<lens::MimeType> primary_content_type,
std::optional<GURL> new_page_url,
std::optional<std::string> new_page_title,
std::optional<uint32_t> pdf_current_page,
const SkBitmap& screenshot) {
CHECK(query_controller_state_ != QueryControllerState::kOff)
<< "SendUpdatedPageContent called when query controller is off";
if (underlying_page_content.has_value()) {
underlying_page_contents_ = underlying_page_content.value();
primary_content_type_ = primary_content_type.value();
page_url_ = new_page_url.value();
page_title_ = new_page_title;
}
pdf_current_page_ = pdf_current_page;
if (!screenshot.drawsNothing()) {
original_screenshot_ = screenshot;
}
suggest_inputs_.set_contextual_visual_input_type(
VitQueryParamValueForMimeType(primary_content_type_));
RunSuggestInputsCallback();
if (query_controller_state_ ==
QueryControllerState::kAwaitingClusterInfoResponse) {
// If we are waiting for the cluster info response, we should not send the
// page content update request immediately. Instead, the cluster info
// response handler will call PrepareAndFetchFullImageRequest and
// PrepareAndFetchPageContentRequest.
return;
}
if (!screenshot.drawsNothing()) {
PrepareAndFetchFullImageRequest();
}
if (underlying_page_content.has_value()) {
PrepareAndFetchPageContentRequest();
}
}
void LensOverlayQueryController::SendPartialPageContentRequest(
base::span<const std::u16string> partial_content) {
CHECK(query_controller_state_ != QueryControllerState::kOff)
<< "SendPartialPageContentRequest called when query controller is off";
partial_content_ = partial_content;
PrepareAndFetchPartialPageContentRequest();
}
void LensOverlayQueryController::SendRegionSearch(
base::Time query_start_time,
lens::mojom::CenterRotatedBoxPtr region,
lens::LensOverlaySelectionType lens_selection_type,
std::map<std::string, std::string> additional_search_query_params,
std::optional<SkBitmap> region_bytes) {
CHECK(query_controller_state_ != QueryControllerState::kOff)
<< "SendRegionSearch called when query controller is off";
SendInteraction(query_start_time, /*region=*/std::move(region),
/*query_text=*/std::nullopt,
/*object_id=*/std::nullopt, lens_selection_type,
additional_search_query_params, region_bytes);
}
void LensOverlayQueryController::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) {
CHECK(query_controller_state_ != QueryControllerState::kOff)
<< "SendContextualTextQuery called when query controller is off";
if (underlying_page_contents_.empty()) {
SendTextOnlyQuery(query_start_time, query_text, lens_selection_type,
additional_search_query_params);
return;
}
// If the contextual search query shouldn't be sent now, hold it until the
// full page content upload is finished and/or the full image query for an
// updated screenshot is finished.
if (!ShouldSendContextualSearchQuery()) {
pending_contextual_query_callback_ = base::BindOnce(
&LensOverlayQueryController::SendContextualTextQuery,
weak_ptr_factory_.GetWeakPtr(), query_start_time, query_text,
lens_selection_type, additional_search_query_params);
return;
}
// Include the vit to get contextualized results.
additional_search_query_params = AddVisualInputTypeQueryParam(
additional_search_query_params, primary_content_type_);
SendInteraction(query_start_time, /*region=*/nullptr, query_text,
/*object_id=*/std::nullopt, lens_selection_type,
additional_search_query_params, std::nullopt);
}
void LensOverlayQueryController::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) {
CHECK(query_controller_state_ != QueryControllerState::kOff)
<< "SendTextOnlyQuery called when query controller is off";
// Although the text only flow might not send an interaction request, we
// should replace any in-flight interaction requests to cancel previously
// issued fetches.
latest_interaction_request_data_ = std::make_unique<LensServerFetchRequest>(
CreateInvalidRequestId(),
/*query_start_time_ms=*/base::TimeTicks::Now());
// The visual search interaction log data should be added as late as possible,
// so that is_parent_query can be accurately set if the user issues multiple
// interactions in quick succession.
if (lens::features::SendVisualSearchInteractionParamForLensTextQueries() &&
IsLensTextSelectionType(lens_selection_type)) {
std::string encoded_vsint =
GetEncodedVisualSearchInteractionLogData(lens_selection_type);
suggest_inputs_.set_encoded_visual_search_interaction_log_data(
encoded_vsint);
additional_search_query_params.insert(
{kVisualSearchInteractionDataQueryParameterKey, encoded_vsint});
} else {
suggest_inputs_.clear_encoded_visual_search_interaction_log_data();
}
suggest_inputs_.clear_encoded_image_signals();
RunSuggestInputsCallback();
lens::proto::LensOverlayUrlResponse lens_overlay_url_response;
lens_overlay_url_response.set_url(
lens::BuildTextOnlySearchURL(query_start_time, query_text, page_url_,
page_title_, additional_search_query_params,
invocation_source_, lens_selection_type,
use_dark_mode_)
.spec());
lens_overlay_url_response.set_page_url(page_url_.spec());
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(url_callback_, lens_overlay_url_response));
}
void LensOverlayQueryController::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_bytes) {
CHECK(query_controller_state_ != QueryControllerState::kOff)
<< "SendMultimodalRequest called when query controller is off";
if (base::TrimWhitespaceASCII(query_text, base::TRIM_ALL).empty()) {
return;
}
SendInteraction(query_start_time, /*region=*/std::move(region), query_text,
/*object_id=*/std::nullopt, multimodal_selection_type,
additional_search_query_params, region_bytes);
}
void LensOverlayQueryController::SendTaskCompletionGen204IfEnabled(
lens::mojom::UserAction user_action) {
SendTaskCompletionGen204IfEnabled(latest_encoded_analytics_id_, user_action,
latest_request_id_);
}
void LensOverlayQueryController::SendSemanticEventGen204IfEnabled(
lens::mojom::SemanticEvent event) {
std::optional<lens::LensOverlayRequestId> request_id = std::nullopt;
if (event == lens::mojom::SemanticEvent::kTextGleamsViewStart) {
request_id = std::make_optional(latest_request_id_);
}
SendSemanticEventGen204IfEnabled(event, request_id);
}
void LensOverlayQueryController::RunSuggestInputsCallback() {
suggest_inputs_.set_send_gsession_vsrid_for_contextual_suggest(
lens::features::GetLensOverlaySendLensInputsForContextualSuggest());
suggest_inputs_.set_send_gsession_vsrid_vit_for_lens_suggest(
lens::features::GetLensOverlaySendLensInputsForLensSuggest());
suggest_inputs_.set_send_vsint_for_lens_suggest(
lens::features::
GetLensOverlaySendLensVisualInteractionDataForLensSuggest());
if (cluster_info_.has_value()) {
suggest_inputs_.set_search_session_id(cluster_info_->search_session_id());
} else {
suggest_inputs_.clear_search_session_id();
}
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(suggest_inputs_callback_, suggest_inputs_));
}
void LensOverlayQueryController::ResetRequestClusterInfoStateForTesting() {
ResetRequestClusterInfoState();
}
std::unique_ptr<EndpointFetcher>
LensOverlayQueryController::CreateEndpointFetcher(
std::string request_string,
const GURL& fetch_url,
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) {
return std::make_unique<EndpointFetcher>(
/*url_loader_factory=*/profile_
? profile_->GetURLLoaderFactory().get()
: g_browser_process->shared_url_loader_factory(),
/*url=*/fetch_url,
/*content_type=*/kContentType,
/*timeout=*/timeout,
/*post_data=*/std::move(request_string),
/*headers=*/request_headers,
/*cors_exempt_headers=*/cors_exempt_headers, chrome::GetChannel(),
/*request_params=*/
EndpointFetcher::RequestParams::Builder(http_method,
kTrafficAnnotationTag)
.SetCredentialsMode(CredentialsMode::kInclude)
.SetSetSiteForCookies(true)
.SetUploadProgressCallback(std::move(upload_progress_callback))
.Build());
}
void LensOverlayQueryController::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) {
base::TimeDelta latency_duration = base::TimeTicks::Now() - start_time_ticks;
gen204_controller_->SendLatencyGen204IfEnabled(
latency_type, latency_duration, vit_query_param_value,
cluster_info_latency, encoded_analytics_id, request_id);
}
void LensOverlayQueryController::SendTaskCompletionGen204IfEnabled(
std::string encoded_analytics_id,
lens::mojom::UserAction user_action,
lens::LensOverlayRequestId request_id) {
gen204_controller_->SendTaskCompletionGen204IfEnabled(
encoded_analytics_id, user_action, request_id);
}
void LensOverlayQueryController::SendSemanticEventGen204IfEnabled(
lens::mojom::SemanticEvent event,
std::optional<lens::LensOverlayRequestId> request_id) {
gen204_controller_->SendSemanticEventGen204IfEnabled(event, request_id);
}
LensOverlayQueryController::LensServerFetchRequest::LensServerFetchRequest(
std::unique_ptr<lens::LensOverlayRequestId> request_id,
base::TimeTicks query_start_time)
: request_id_(std::move(request_id)), query_start_time_(query_start_time) {}
LensOverlayQueryController::LensServerFetchRequest::~LensServerFetchRequest() =
default;
std::string LensOverlayQueryController::GetVsridForNewTab() {
std::unique_ptr<lens::LensOverlayRequestId> request_id =
request_id_generator_->GetNextRequestId(
RequestIdUpdateMode::kOpenInNewTab);
return Base64EncodeRequestId(*request_id);
}
std::unique_ptr<lens::LensOverlayRequestId>
LensOverlayQueryController::GetNextRequestId(RequestIdUpdateMode update_mode) {
std::unique_ptr<lens::LensOverlayRequestId> request_id =
request_id_generator_->GetNextRequestId(update_mode);
latest_request_id_ = *request_id.get();
latest_encoded_analytics_id_ =
request_id_generator_->GetBase32EncodedAnalyticsId();
std::string encoded_request_id = Base64EncodeRequestId(*request_id);
suggest_inputs_.set_encoded_request_id(encoded_request_id);
RunSuggestInputsCallback();
return request_id;
}
void LensOverlayQueryController::FetchClusterInfoRequest() {
query_controller_state_ = QueryControllerState::kAwaitingClusterInfoResponse;
// There should not be any in-flight cluster info request.
CHECK(!cluster_info_access_token_fetcher_);
cluster_info_access_token_fetcher_ =
CreateOAuthHeadersAndContinue(base::BindOnce(
&LensOverlayQueryController::PerformClusterInfoFetchRequest,
weak_ptr_factory_.GetWeakPtr(),
/*query_start_time=*/base::TimeTicks::Now()));
}
void LensOverlayQueryController::PerformClusterInfoFetchRequest(
base::TimeTicks query_start_time,
std::vector<std::string> request_headers) {
cluster_info_access_token_fetcher_.reset();
// Add protobuf content type to the request headers.
request_headers.push_back(kContentTypeKey);
request_headers.push_back(kContentType);
// Get client experiment variations to include in the request.
std::vector<std::string> cors_exempt_headers =
CreateVariationsHeaders(variations_client_);
// Generate the URL to fetch.
GURL fetch_url = GURL(lens::features::GetLensOverlayClusterInfoEndpointUrl());
HttpMethod request_method;
std::string request_string;
if (lens::features::
SendClientContextToClusterInfoRequestForContextualSuggest()) {
request_method = HttpMethod::kPost;
// Create the client context to include in the request.
lens::LensOverlayClientContext client_context = CreateClientContext();
lens::LensOverlayServerClusterInfoRequest request;
request.set_enable_search_session_id(true);
request.set_surface(client_context.surface());
request.set_platform(client_context.platform());
request.mutable_rendering_context()->CopyFrom(
client_context.rendering_context());
CHECK(request.SerializeToString(&request_string));
} else {
request_method = HttpMethod::kGet;
}
// Create the EndpointFetcher, responsible for making the request using our
// given params. Store in class variable to keep endpoint fetcher alive until
// the request is made.
cluster_info_endpoint_fetcher_ = CreateEndpointFetcher(
std::move(request_string), fetch_url, request_method,
base::Milliseconds(lens::features::GetLensOverlayServerRequestTimeout()),
request_headers, cors_exempt_headers, base::DoNothing());
// Finally, perform the request.
cluster_info_endpoint_fetcher_->PerformRequest(
base::BindOnce(
&LensOverlayQueryController::ClusterInfoFetchResponseHandler,
weak_ptr_factory_.GetWeakPtr(), query_start_time),
google_apis::GetAPIKey().c_str());
SendInitialLatencyGen204IfNotAlreadySent(
LatencyType::kInvocationToInitialClusterInfoRequestSent,
VitQueryParamValueForMimeType(primary_content_type_),
/*request_id=*/std::nullopt);
}
void LensOverlayQueryController::ClusterInfoFetchResponseHandler(
base::TimeTicks query_start_time,
std::unique_ptr<EndpointResponse> response) {
cluster_info_endpoint_fetcher_.reset();
query_controller_state_ = QueryControllerState::kReceivedClusterInfoResponse;
if (response->http_status_code != google_apis::ApiErrorCode::HTTP_SUCCESS) {
// If there was an error with the cluster info request, we should still try
// and send the full image request as a fallback.
PrepareAndFetchFullImageRequest();
return;
}
lens::LensOverlayServerClusterInfoResponse server_response;
const std::string response_string = response->response;
bool parse_successful = server_response.ParseFromArray(
response_string.data(), response_string.size());
if (!parse_successful) {
// If there was an error with the cluster info request, we should still try
// and send the full image request as a fallback.
PrepareAndFetchFullImageRequest();
return;
}
// Store the cluster info.
cluster_info_ = std::make_optional<lens::LensOverlayClusterInfo>();
cluster_info_->set_server_session_id(server_response.server_session_id());
cluster_info_->set_search_session_id(server_response.search_session_id());
// If routing info is enabled, store the routing info to be included in
// followup requests.
if (lens::features::IsLensOverlayRoutingInfoEnabled() &&
server_response.has_routing_info() &&
!request_id_generator_->HasRoutingInfo()) {
std::unique_ptr<lens::LensOverlayRequestId> request_id =
request_id_generator_->SetRoutingInfo(server_response.routing_info());
suggest_inputs_.set_encoded_request_id(Base64EncodeRequestId(*request_id));
}
// Update the suggest inputs with the cluster info's search session id.
RunSuggestInputsCallback();
// Clear the cluster info after its lifetime expires.
base::SequencedTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&LensOverlayQueryController::ResetRequestClusterInfoState,
weak_ptr_factory_.GetWeakPtr()),
base::Seconds(
lens::features::GetLensOverlayClusterInfoLifetimeSeconds()));
// Store the fetch response time.
cluster_info_fetch_response_time_ = base::TimeTicks::Now() - query_start_time;
// Continue with the full image request which will use the session id from the
// cluster info we just received.
PrepareAndFetchFullImageRequest();
PrepareAndFetchPageContentRequest();
PrepareAndFetchPartialPageContentRequest();
}
void LensOverlayQueryController::PrepareAndFetchFullImageRequest() {
if (query_controller_state_ ==
QueryControllerState::kAwaitingClusterInfoResponse) {
// If we are still waiting for the cluster info response, we can't send the
// full image request yet. Once the cluster info response is received,
// PrepareAndFetchFullImageRequest will be called again.
return;
}
// If the cluster info optimization is enabled, request the cluster info prior
// to making the full image request. Also do this for the contextual search
// flow since the request flow for contextual searchbox will fail without the
// cluster info handshake.
if (!cluster_info_ &&
(lens::features::IsLensOverlayClusterInfoOptimizationEnabled() ||
lens::IsLensOverlayContextualSearchboxEnabled())) {
FetchClusterInfoRequest();
return;
}
// If the screenshot draws nothing, return.
if (original_screenshot_.drawsNothing()) {
return;
}
// There can be multiple full image requests that are called. For example,
// when translate mode is enabled after opening the overlay or when turning
// translate mode back off after enabling. Reset if there is one pending.
full_image_endpoint_fetcher_.reset();
query_controller_state_ = QueryControllerState::kAwaitingFullImageResponse;
// Create the client logs needed throughout the async process to attach to
// the full image request.
scoped_refptr<lens::RefCountedLensOverlayClientLogs> ref_counted_logs =
base::MakeRefCounted<lens::RefCountedLensOverlayClientLogs>();
ref_counted_logs->client_logs().set_metrics_collection_disabled(
!g_browser_process->GetMetricsServicesManager() ||
!g_browser_process->GetMetricsServicesManager()->IsMetricsConsentGiven());
ref_counted_logs->client_logs().set_lens_overlay_entry_point(
LenOverlayEntryPointFromInvocationSource(invocation_source_));
// Initialize latest_full_image_request_data_ with a next request id to
// ensure once the async processes finish, no new full image request has
// started.
latest_full_image_request_data_ = std::make_unique<LensServerFetchRequest>(
GetNextRequestId(initial_request_id_
? RequestIdUpdateMode::kFullImageRequest
: RequestIdUpdateMode::kInitialRequest),
/*query_start_time=*/base::TimeTicks::Now());
int current_sequence_id = latest_full_image_request_data_->sequence_id();
// If this is the first full image request, store the request id for all the
// other first batch of requests to use.
if (initial_request_id_ == nullptr) {
initial_request_id_ = std::make_unique<lens::LensOverlayRequestId>();
initial_request_id_->CopyFrom(
*latest_full_image_request_data_->request_id_);
}
// If there is a pending interaction, we can create and issue it now that the
// cluster info and full-image request id are available.
if (cluster_info_.has_value() && pending_interaction_callback_) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, std::move(pending_interaction_callback_));
}
// Preparing for the full image request requires multiple async flows to
// complete before the request is ready to be send to the server. We start
// these flows here, and each flow completes by calling
// FullImageRequestDataReady() with its data. FullImageRequestDataReady() will
// handle waiting for all necessary flows to complete before performing the
// request.
//
// Async Flow 1: Creating the full image request.
// Do the image encoding asynchronously to prevent the main thread from
// blocking on the encoding.
encoding_task_runner_->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&lens::DownscaleAndEncodeBitmap, original_screenshot_,
ui_scale_factor_, ref_counted_logs),
base::BindOnce(&LensOverlayQueryController::
CreateFullImageRequestAndTryPerformFullImageRequest,
weak_ptr_factory_.GetWeakPtr(), current_sequence_id,
ref_counted_logs));
// Async Flow 2: Retrieve the OAuth headers.
CreateOAuthHeadersAndTryPerformFullPageRequest(current_sequence_id);
}
void LensOverlayQueryController::PrepareImageDataForFullImageRequest(
scoped_refptr<lens::RefCountedLensOverlayClientLogs> ref_counted_logs,
lens::ImageData image_data) {
ref_counted_logs->client_logs().set_paella_id(gen204_id_);
resized_bitmap_size_ = gfx::Size(image_data.image_metadata().width(),
image_data.image_metadata().height());
AddSignificantRegions(image_data, std::move(significant_region_boxes_));
}
void LensOverlayQueryController::
CreateFullImageRequestAndTryPerformFullImageRequest(
int sequence_id,
scoped_refptr<lens::RefCountedLensOverlayClientLogs> ref_counted_logs,
lens::ImageData image_data) {
DCHECK_EQ(query_controller_state_,
QueryControllerState::kAwaitingFullImageResponse);
PrepareImageDataForFullImageRequest(ref_counted_logs, image_data);
// Create the request.
lens::LensOverlayServerRequest request;
request.mutable_client_logs()->CopyFrom(ref_counted_logs->client_logs());
lens::LensOverlayRequestContext request_context;
// The request ID is guaranteed to exist since it is set in the constructor
// of latest_full_image_request_data_.
DCHECK(latest_full_image_request_data_->request_id_);
request_context.mutable_request_id()->CopyFrom(
*latest_full_image_request_data_->request_id_);
request_context.mutable_client_context()->CopyFrom(CreateClientContext());
request.mutable_objects_request()->mutable_request_context()->CopyFrom(
request_context);
request.mutable_objects_request()->mutable_image_data()->CopyFrom(image_data);
if (pdf_current_page_.has_value()) {
request.mutable_objects_request()
->mutable_viewport_request_context()
->set_pdf_page_number(pdf_current_page_.value());
}
FullImageRequestDataReady(sequence_id, request);
}
void LensOverlayQueryController::CreateOAuthHeadersAndTryPerformFullPageRequest(
int sequence_id) {
DCHECK_EQ(query_controller_state_,
QueryControllerState::kAwaitingFullImageResponse);
// If there is already a pending access token fetcher, we purposefully
// override it since we no longer care about the previous request.
full_image_access_token_fetcher_ =
CreateOAuthHeadersAndContinue(base::BindOnce(
static_cast<void (LensOverlayQueryController::*)(
int, std::vector<std::string>)>(
&LensOverlayQueryController::FullImageRequestDataReady),
weak_ptr_factory_.GetWeakPtr(), sequence_id));
}
void LensOverlayQueryController::FullImageRequestDataReady(
int sequence_id,
lens::LensOverlayServerRequest request) {
if (!IsCurrentFullImageSequence(sequence_id)) {
// Ignore superseded request.
return;
}
latest_full_image_request_data_->request_ =
std::make_unique<lens::LensOverlayServerRequest>(request);
FullImageRequestDataHelper(sequence_id);
}
void LensOverlayQueryController::FullImageRequestDataReady(
int sequence_id,
std::vector<std::string> headers) {
if (!IsCurrentFullImageSequence(sequence_id)) {
// Ignore superseded request.
return;
}
full_image_access_token_fetcher_.reset();
latest_full_image_request_data_->request_headers_ =
std::make_unique<std::vector<std::string>>(headers);
FullImageRequestDataHelper(sequence_id);
}
void LensOverlayQueryController::FullImageRequestDataHelper(int sequence_id) {
CHECK(latest_full_image_request_data_->sequence_id() == sequence_id);
if (latest_full_image_request_data_->request_ &&
latest_full_image_request_data_->request_headers_) {
PerformFullImageRequest();
}
}
bool LensOverlayQueryController::IsCurrentFullImageSequence(int sequence_id) {
CHECK(latest_full_image_request_data_);
return latest_full_image_request_data_->sequence_id() == sequence_id;
}
void LensOverlayQueryController::PerformFullImageRequest() {
PerformFetchRequest(
latest_full_image_request_data_->request_.get(),
latest_full_image_request_data_->request_headers_.get(),
base::Milliseconds(lens::features::GetLensOverlayServerRequestTimeout()),
base::BindOnce(
&LensOverlayQueryController::OnFullImageEndpointFetcherCreated,
weak_ptr_factory_.GetWeakPtr(),
*latest_full_image_request_data_->request_id_.get()),
base::BindOnce(&LensOverlayQueryController::FullImageFetchResponseHandler,
weak_ptr_factory_.GetWeakPtr(),
latest_full_image_request_data_->sequence_id()));
}
void LensOverlayQueryController::FullImageFetchResponseHandler(
int request_sequence_id,
std::unique_ptr<EndpointResponse> response) {
// If this request sequence ID does not match the latest sent then we should
// ignore the response.
if (latest_full_image_request_data_->sequence_id() != request_sequence_id) {
return;
}
DCHECK_EQ(query_controller_state_,
QueryControllerState::kAwaitingFullImageResponse);
CHECK(full_image_endpoint_fetcher_);
full_image_endpoint_fetcher_.reset();
query_controller_state_ = QueryControllerState::kReceivedFullImageResponse;
if (response->http_status_code != google_apis::ApiErrorCode::HTTP_SUCCESS) {
RunFullImageCallbackForError();
return;
}
lens::LensOverlayServerResponse server_response;
const std::string response_string = response->response;
bool parse_successful = server_response.ParseFromArray(
response_string.data(), response_string.size());
if (!parse_successful) {
RunFullImageCallbackForError();
return;
}
if (!server_response.has_objects_response()) {
RunFullImageCallbackForError();
return;
}
if (!cluster_info_.has_value()) {
if (!server_response.objects_response().has_cluster_info()) {
RunFullImageCallbackForError();
return;
}
cluster_info_ = std::make_optional<lens::LensOverlayClusterInfo>();
cluster_info_->CopyFrom(server_response.objects_response().cluster_info());
// Clear the cluster info after its lifetime expires.
base::SequencedTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(
&LensOverlayQueryController::ResetRequestClusterInfoState,
weak_ptr_factory_.GetWeakPtr()),
base::Seconds(
lens::features::GetLensOverlayClusterInfoLifetimeSeconds()));
// If routing info is enabled, store the routing info to be included in
// followup requests.
if (lens::features::IsLensOverlayRoutingInfoEnabled() &&
cluster_info_->has_routing_info() &&
!request_id_generator_->HasRoutingInfo()) {
std::unique_ptr<lens::LensOverlayRequestId> new_request_id =
request_id_generator_->SetRoutingInfo(cluster_info_->routing_info());
suggest_inputs_.set_encoded_request_id(
Base64EncodeRequestId(*new_request_id));
}
}
SendFullImageLatencyGen204IfEnabled(
latest_full_image_request_data_->query_start_time_,
translate_options_.has_value(), kImageVisualInputTypeQueryParameterValue);
// Image signals and vsint are only valid after an interaction request.
suggest_inputs_.clear_encoded_image_signals();
suggest_inputs_.clear_encoded_visual_search_interaction_log_data();
RunSuggestInputsCallback();
if (pending_interaction_callback_) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, std::move(pending_interaction_callback_));
}
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(full_image_callback_,
lens::CreateObjectsMojomArrayFromServerResponse(
server_response),
lens::CreateTextMojomFromServerResponse(
server_response, resized_bitmap_size_),
/*is_error=*/false));
}
void LensOverlayQueryController::RunFullImageCallbackForError() {
ResetRequestClusterInfoState();
// Needs to be set to received response so this query can be retried on the
// next interaction request.
query_controller_state_ =
QueryControllerState::kReceivedFullImageErrorResponse;
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(full_image_callback_,
std::vector<lens::mojom::OverlayObjectPtr>(),
/*text=*/nullptr, /*is_error=*/true));
}
void LensOverlayQueryController::PrepareAndFetchPageContentRequest() {
if (query_controller_state_ == QueryControllerState::kClusterInfoExpired) {
// If the cluster info has expired, we need to refetch the cluster info. The
// full image request will recall this method once the cluster info is
// fetched.
MaybeRestartQueryFlow();
return;
}
if (underlying_page_contents_.empty() ||
underlying_page_contents_.front().bytes_.empty()) {
// No need to send the request without underlying content bytes.
return;
}
compression_task_tracker_->TryCancelAll();
page_contents_request_start_time_ = base::TimeTicks::Now();
page_content_request_in_progress_ = true;
remaining_upload_chunk_responses_ = 0;
// The initial request id should be set by the time we get here. If not, call
// below will crash.
CHECK(initial_request_id_);
// Send a chunk request if the upload is a PDF larger than the chunk size.
// If not, send a normal page content request.
if (lens::features::IsLensOverlayUploadChunkingEnabled() &&
primary_content_type_ == lens::MimeType::kPdf &&
underlying_page_contents_.front().bytes_.size() >
lens::features::GetLensOverlayChunkSizeBytes()) {
// Post MakeChunks to a task off the main thread so compression does not
// throttle the main thread.
compression_task_tracker_->PostTaskAndReplyWithResult(
compression_task_runner_.get(), FROM_HERE,
base::BindOnce(&MakeChunks, underlying_page_contents_.front().bytes_),
base::BindOnce(
&LensOverlayQueryController::PrepareAndFetchUploadChunkRequests,
weak_ptr_factory_.GetWeakPtr(),
is_first_page_contents_request_
? *initial_request_id_
: *GetNextRequestId(
lens::RequestIdUpdateMode::kPageContentRequest)));
} else {
// Post CreatePageContentPayload to a task off the main thread so
// compression does not throttle the main thread.
compression_task_tracker_->PostTaskAndReplyWithResult(
compression_task_runner_.get(), FROM_HERE,
base::BindOnce(&CreatePageContentPayload, underlying_page_contents_,
primary_content_type_, page_url_, page_title_),
base::BindOnce(
&LensOverlayQueryController::PrepareAndFetchPageContentRequestPart2,
weak_ptr_factory_.GetWeakPtr(),
is_first_page_contents_request_
? *initial_request_id_
: *GetNextRequestId(
lens::RequestIdUpdateMode::kPageContentRequest)));
}
// If this is the second or later page content request, the partial page
// content should no longer be considered first.
if (!is_first_page_contents_request_) {
is_first_partial_page_contents_request_ = false;
}
// Any subsequent page content requests will be considered non-first.
is_first_page_contents_request_ = false;
}
void LensOverlayQueryController::PrepareAndFetchUploadChunkRequests(
lens::LensOverlayRequestId request_id,
std::vector<std::string> chunks) {
if (!chunks.size()) {
return;
}
lens::LensOverlayRequestContext request_context;
request_context.mutable_request_id()->CopyFrom(request_id);
request_context.mutable_client_context()->CopyFrom(CreateClientContext());
std::vector<lens::LensOverlayUploadChunkRequest> requests;
for (size_t i = 0; i < chunks.size(); i++) {
requests.push_back(
CreateUploadChunkRequest(i, chunks.size(), chunks[i], request_context));
}
pending_upload_chunk_requests_ = requests;
upload_chunk_sequence_id = request_id.sequence_id();
chunk_upload_access_token_fetcher_ =
CreateOAuthHeadersAndContinue(base::BindOnce(
&LensOverlayQueryController::PrepareAndFetchUploadChunkRequestsPart2,
weak_ptr_factory_.GetWeakPtr()));
}
void LensOverlayQueryController::PrepareAndFetchUploadChunkRequestsPart2(
std::vector<std::string> headers) {
chunk_upload_access_token_fetcher_.reset();
pending_upload_chunk_headers_ = headers;
remaining_upload_chunk_responses_ = pending_upload_chunk_requests_.size();
for (size_t i = 0; i < pending_upload_chunk_requests_.size(); i++) {
FetchUploadChunkRequest(i);
}
}
void LensOverlayQueryController::FetchUploadChunkRequest(
size_t chunk_request_index) {
auto& request = pending_upload_chunk_requests_[chunk_request_index];
std::string request_string;
CHECK(request.SerializeToString(&request_string));
PerformFetchRequest(
std::move(request_string), &pending_upload_chunk_headers_,
base::Milliseconds(
lens::features::GetLensOverlayUploadChunkRequestTimeoutMs()),
base::BindOnce(
&LensOverlayQueryController::OnChunkUploadEndpointFetcherCreated,
weak_ptr_factory_.GetWeakPtr(),
request.request_context().request_id()),
base::BindOnce(&LensOverlayQueryController::UploadChunkResponseHandler,
weak_ptr_factory_.GetWeakPtr(),
request.request_context().request_id(),
pending_upload_chunk_requests_.size(),
/*is_last=*/chunk_request_index ==
pending_upload_chunk_requests_.size() - 1),
base::NullCallback(),
GURL(lens::features::GetLensOverlayUploadChunkEndpointURL()));
}
void LensOverlayQueryController::UploadChunkResponseHandler(
lens::LensOverlayRequestId request_id,
size_t total_chunks,
bool is_last,
std::unique_ptr<EndpointResponse> response) {
// If there is a newer sequence id, a new request has been initiated before
// this one has completed. Do nothing and return.
if (request_id.sequence_id() != upload_chunk_sequence_id) {
return;
}
remaining_upload_chunk_responses_--;
// If this is the last chunk in sequence, perform the page content request.
// Note: in the case that this is also the last chunk to receive a response,
// PrepareAndFetchPageContentRequestPart2() is expected to send the gen204
// ping.
if (is_last) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&CreatePageContentPayloadForChunks,
underlying_page_contents_, primary_content_type_,
page_url_, page_title_, total_chunks),
base::BindOnce(
&LensOverlayQueryController::PrepareAndFetchPageContentRequestPart2,
weak_ptr_factory_.GetWeakPtr(), request_id));
return;
}
// If the page content request has already finished, and this is the last
// chunk to receive a response, this will send the gen204 ping and clear the
// endpoint fetchers.
MaybeSendPageContentUploadLatencyGen204(request_id);
}
void LensOverlayQueryController::PrepareAndFetchPageContentRequestPart2(
lens::LensOverlayRequestId request_id,
lens::Payload payload) {
// Create the request.
lens::LensOverlayServerRequest request;
lens::LensOverlayRequestContext request_context;
request_context.mutable_request_id()->CopyFrom(request_id);
request_context.mutable_client_context()->CopyFrom(CreateClientContext());
request.mutable_objects_request()->mutable_request_context()->CopyFrom(
request_context);
request.mutable_objects_request()->mutable_payload()->CopyFrom(payload);
page_content_access_token_fetcher_ = CreateOAuthHeadersAndContinue(
base::BindOnce(&LensOverlayQueryController::PerformPageContentRequest,
weak_ptr_factory_.GetWeakPtr(), std::move(request)));
}
void LensOverlayQueryController::PerformPageContentRequest(
lens::LensOverlayServerRequest request,
std::vector<std::string> headers) {
page_content_access_token_fetcher_.reset();
PerformFetchRequest(
&request, &headers,
base::Milliseconds(
lens::features::GetLensOverlayPageContentRequestTimeoutMs()),
base::BindOnce(
&LensOverlayQueryController::OnPageContentEndpointFetcherCreated,
weak_ptr_factory_.GetWeakPtr(),
request.objects_request().request_context().request_id()),
base::BindOnce(&LensOverlayQueryController::PageContentResponseHandler,
weak_ptr_factory_.GetWeakPtr(),
request.objects_request().request_context().request_id()),
base::BindRepeating(
&LensOverlayQueryController::PageContentUploadProgressHandler,
weak_ptr_factory_.GetWeakPtr()));
}
void LensOverlayQueryController::PageContentResponseHandler(
lens::LensOverlayRequestId request_id,
std::unique_ptr<EndpointResponse> response) {
page_content_endpoint_fetcher_.reset();
// The upload progress handler is not guaranteed to execute, so if a response
// is received, mark the request as no longer in progress to allow the
// interaction request to be sent.
PageContentUploadFinished();
// If the chunk uploads have already completed, or if upload chunking was not
// done, this will send the gen204 ping and clear the endpoint fetchers.
MaybeSendPageContentUploadLatencyGen204(request_id);
}
void LensOverlayQueryController::MaybeSendPageContentUploadLatencyGen204(
lens::LensOverlayRequestId request_id) {
if (!page_content_request_in_progress_ &&
remaining_upload_chunk_responses_ == 0) {
chunk_upload_endpoint_fetchers_.clear();
SendLatencyGen204IfEnabled(
LatencyType::kPageContentUploadLatency,
page_contents_request_start_time_,
VitQueryParamValueForMimeType(primary_content_type_),
/*cluster_info_latency=*/std::nullopt,
/*encoded_analytics_id=*/std::nullopt,
std::make_optional<lens::LensOverlayRequestId>(request_id));
}
}
void LensOverlayQueryController::PageContentUploadProgressHandler(
uint64_t position,
uint64_t total) {
if (page_content_upload_progress_callback_) {
page_content_upload_progress_callback_.Run(position, total);
}
if (lens::features::ShouldHoldContextualQueriesUntilAck()) {
return;
}
if (position == total) {
PageContentUploadFinished();
}
}
void LensOverlayQueryController::PageContentUploadFinished() {
page_content_request_in_progress_ = false;
if (pending_contextual_query_callback_) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, std::move(pending_contextual_query_callback_));
}
}
void LensOverlayQueryController::PrepareAndFetchPartialPageContentRequest() {
if (!cluster_info_ || !IsPartialPageContentSubstantial()) {
// Cannot send this request without cluster info. Do not send the request
// if the partial page content is not substantial enough to yield deatialed
// results.
return;
}
partial_page_contents_request_start_time_ = base::TimeTicks::Now();
// Create the request.
lens::LensOverlayServerRequest request;
lens::LensOverlayRequestContext request_context;
// If this is the first partial page content request, use the initial request
// id. Otherwise, use the request id generator.
if (is_first_partial_page_contents_request_) {
CHECK(initial_request_id_);
request_context.mutable_request_id()->CopyFrom(*initial_request_id_);
} else {
request_context.mutable_request_id()->CopyFrom(*GetNextRequestId(
lens::RequestIdUpdateMode::kPartialPageContentRequest));
}
request_context.mutable_client_context()->CopyFrom(CreateClientContext());
request.mutable_objects_request()->mutable_request_context()->CopyFrom(
request_context);
// Create the partial page content payload.
lens::Payload payload;
payload.set_request_type(lens::RequestType::REQUEST_TYPE_EARLY_PARTIAL_PDF);
// Add the partial page content to the payload.
lens::LensOverlayDocument partial_pdf_document;
for (size_t i = 0; i < partial_content_.size(); ++i) {
const auto& page_text = partial_content_[i];
auto* page = partial_pdf_document.add_pages();
page->set_page_number(i + 1);
page->add_text_segments(base::UTF16ToUTF8(page_text));
}
if (lens::features::UseUpdatedContextFields()) {
auto* content = payload.mutable_content();
auto* content_data = content->add_content_data();
content_data->set_content_type(
lens::ContentData::CONTENT_TYPE_EARLY_PARTIAL_PDF);
partial_pdf_document.SerializeToString(content_data->mutable_data());
// Add the page url to the payload if it is available.
if (!page_url_.is_empty() &&
lens::features::SendPageUrlForContextualization()) {
content->set_webpage_url(page_url_.spec());
}
if (page_title_.has_value() && !page_title_.value().empty() &&
lens::features::SendPageTitleForContextualization()) {
content->set_webpage_title(page_title_.value());
}
} else {
payload.mutable_partial_pdf_document()->CopyFrom(partial_pdf_document);
// Add the page url to the payload if it is available.
if (!page_url_.is_empty() &&
lens::features::SendPageUrlForContextualization()) {
payload.set_page_url(page_url_.spec());
}
}
request.mutable_objects_request()->mutable_payload()->CopyFrom(payload);
partial_page_content_access_token_fetcher_ =
CreateOAuthHeadersAndContinue(base::BindOnce(
&LensOverlayQueryController::PerformPartialPageContentRequest,
weak_ptr_factory_.GetWeakPtr(), std::move(request)));
is_first_partial_page_contents_request_ = false;
}
void LensOverlayQueryController::PerformPartialPageContentRequest(
lens::LensOverlayServerRequest request,
std::vector<std::string> headers) {
partial_page_content_access_token_fetcher_.reset();
PerformFetchRequest(
&request, &headers,
base::Milliseconds(
lens::features::GetLensOverlayPageContentRequestTimeoutMs()),
base::BindOnce(&LensOverlayQueryController::
OnPartialPageContentEndpointFetcherCreated,
weak_ptr_factory_.GetWeakPtr(),
request.objects_request().request_context().request_id()),
base::BindOnce(
&LensOverlayQueryController::PartialPageContentResponseHandler,
weak_ptr_factory_.GetWeakPtr(),
request.objects_request().request_context().request_id()));
}
void LensOverlayQueryController::PartialPageContentResponseHandler(
lens::LensOverlayRequestId request_id,
std::unique_ptr<EndpointResponse> response) {
partial_page_content_endpoint_fetcher_.reset();
SendLatencyGen204IfEnabled(
LatencyType::kPartialPageContentUploadLatency,
partial_page_contents_request_start_time_,
VitQueryParamValueForMimeType(primary_content_type_),
/*cluster_info_latency=*/std::nullopt,
/*encoded_analytics_id=*/std::nullopt,
std::make_optional<lens::LensOverlayRequestId>(request_id));
}
void LensOverlayQueryController::SendInteraction(
base::Time query_start_time,
lens::mojom::CenterRotatedBoxPtr region,
std::optional<std::string> query_text,
std::optional<std::string> object_id,
lens::LensOverlaySelectionType selection_type,
std::map<std::string, std::string> additional_search_query_params,
std::optional<SkBitmap> region_bytes) {
// Cancel any pending encoding from previous SendInteraction requests.
encoding_task_tracker_->TryCancelAll();
// Reset any pending interaction requests that will get fired via the full
// image request / response handlers.
pending_interaction_callback_.Reset();
// If the cluster info is missing add the interaction to the pending callback
// to be sent once the cluster info is available.
if (!cluster_info_.has_value()) {
pending_interaction_callback_ =
base::BindOnce(&LensOverlayQueryController::SendInteraction,
weak_ptr_factory_.GetWeakPtr(), query_start_time,
std::move(region), query_text, object_id, selection_type,
additional_search_query_params, region_bytes);
// If the cluster info is expired, restart a new query flow so the pending
// interaction request will be sent once the cluster info is available.
MaybeRestartQueryFlow();
return;
}
if (!latest_full_image_request_data_) {
// The request id sequence for the interaction request must follow a full
// image request. If we have not yet created a full image request id, the
// request id generator will not be ready to create the interaction request
// id. In that case, save the interaction data to create the request after
// the full image request id sequence has been incremented.
pending_interaction_callback_ =
base::BindOnce(&LensOverlayQueryController::SendInteraction,
weak_ptr_factory_.GetWeakPtr(), query_start_time,
std::move(region), query_text, object_id, selection_type,
additional_search_query_params, region_bytes);
return;
}
// Create the logs used across the async.
scoped_refptr<lens::RefCountedLensOverlayClientLogs> ref_counted_logs =
base::MakeRefCounted<lens::RefCountedLensOverlayClientLogs>();
ref_counted_logs->client_logs().set_lens_overlay_entry_point(
LenOverlayEntryPointFromInvocationSource(invocation_source_));
ref_counted_logs->client_logs().set_paella_id(gen204_id_);
ref_counted_logs->client_logs().set_metrics_collection_disabled(
!g_browser_process->GetMetricsServicesManager() ||
!g_browser_process->GetMetricsServicesManager()->IsMetricsConsentGiven());
// Initialize latest_interaction_request_data_ with a new request ID to
// ensure once the async processes finish, no new interaction request has
// started.
latest_interaction_request_data_ = std::make_unique<LensServerFetchRequest>(
GetNextRequestId(RequestIdUpdateMode::kInteractionRequest),
/*query_start_time_ms=*/base::TimeTicks::Now());
int current_sequence_id = latest_interaction_request_data_->sequence_id();
// Add the create URL callback to be run after the request is sent.
latest_interaction_request_data_->request_sent_callback_ = base::BindOnce(
&LensOverlayQueryController::CreateSearchUrlAndSendToCallback,
weak_ptr_factory_.GetWeakPtr(), query_start_time, query_text,
additional_search_query_params, selection_type,
GetNextRequestId(RequestIdUpdateMode::kSearchUrl));
// The interaction request requires multiple async flows to complete before
// the request is ready to be send to the server. We start these flows here,
// and each flow completes by calling InteractionRequestDataReady() with its
// data. InteractionRequestDataReady() will handle waiting for all necessary
// flows to complete before performing the request.
//
// Async Flow 1: Downscale the image region for the interaction request.
// Do the image encoding asynchronously to prevent the main thread from
// blocking on the encoding.
encoding_task_tracker_->PostTaskAndReplyWithResult(
encoding_task_runner_.get(), FROM_HERE,
base::BindOnce(&lens::DownscaleAndEncodeBitmapRegionIfNeeded,
original_screenshot_, region.Clone(), region_bytes,
ref_counted_logs),
base::BindOnce(
&LensOverlayQueryController::
CreateInteractionRequestAndTryPerformInteractionRequest,
weak_ptr_factory_.GetWeakPtr(), current_sequence_id, region.Clone(),
query_text, object_id, ref_counted_logs));
// Async Flow 2: Retrieve the OAuth headers.
CreateOAuthHeadersAndTryPerformInteractionRequest(current_sequence_id);
}
void LensOverlayQueryController::
CreateInteractionRequestAndTryPerformInteractionRequest(
int sequence_id,
lens::mojom::CenterRotatedBoxPtr region,
std::optional<std::string> query_text,
std::optional<std::string> object_id,
scoped_refptr<lens::RefCountedLensOverlayClientLogs> ref_counted_logs,
std::optional<lens::ImageCropAndBitmap> image_crop_and_bitmap) {
// The request index should match our counter after encoding finishes.
CHECK(sequence_id == latest_interaction_request_data_->sequence_id());
// Pass the image crop and region bitmap for this request to the thumbnail
// created callback.
if (image_crop_and_bitmap.has_value()) {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(
thumbnail_created_callback_,
image_crop_and_bitmap->image_crop.image().image_content(),
image_crop_and_bitmap->region_bitmap));
}
// Create the interaction request.
lens::LensOverlayServerRequest server_request = CreateInteractionRequest(
std::move(region), query_text, object_id,
image_crop_and_bitmap
? std::make_optional(image_crop_and_bitmap->image_crop)
: std::nullopt,
ref_counted_logs->client_logs());
// Continue the async process.
InteractionRequestDataReady(sequence_id, std::move(server_request));
}
void LensOverlayQueryController::
CreateOAuthHeadersAndTryPerformInteractionRequest(int sequence_id) {
// If there is already a pending access token fetcher, we purposefully
// override it to cancel the old request.
interaction_access_token_fetcher_ =
CreateOAuthHeadersAndContinue(base::BindOnce(
static_cast<void (LensOverlayQueryController::*)(
int, std::vector<std::string>)>(
&LensOverlayQueryController::InteractionRequestDataReady),
weak_ptr_factory_.GetWeakPtr(), sequence_id));
}
void LensOverlayQueryController::InteractionRequestDataReady(
int sequence_id,
lens::LensOverlayServerRequest request) {
if (!IsCurrentInteractionSequence(sequence_id)) {
// Ignore superseded request.
return;
}
latest_interaction_request_data_->request_ =
std::make_unique<lens::LensOverlayServerRequest>(request);
TryPerformInteractionRequest(sequence_id);
}
void LensOverlayQueryController::InteractionRequestDataReady(
int sequence_id,
std::vector<std::string> headers) {
if (!IsCurrentInteractionSequence(sequence_id)) {
// Ignore superseded request.
return;
}
interaction_access_token_fetcher_.reset();
latest_interaction_request_data_->request_headers_ =
std::make_unique<std::vector<std::string>>(headers);
TryPerformInteractionRequest(sequence_id);
}
void LensOverlayQueryController::TryPerformInteractionRequest(int sequence_id) {
if (!IsCurrentInteractionSequence(sequence_id)) {
// Ignore superseded request.
return;
}
if (!latest_interaction_request_data_->request_ ||
!latest_interaction_request_data_->request_headers_) {
// Exit early since not all request data is ready.
return;
}
// Allow the query controller to perform the interaction request before the
// full image response is received if the early interaction optimization is
// enabled.
if (lens::features::IsLensOverlayEarlyInteractionOptimizationEnabled() &&
query_controller_state_ ==
QueryControllerState::kAwaitingFullImageResponse &&
cluster_info_.has_value()) {
PerformInteractionRequest();
return;
}
// If a full image request is in flight, wait for the full image response
// before sending the request.
if (query_controller_state_ ==
QueryControllerState::kAwaitingClusterInfoResponse ||
query_controller_state_ ==
QueryControllerState::kAwaitingFullImageResponse) {
pending_interaction_callback_ = base::BindOnce(
&LensOverlayQueryController::TryPerformInteractionRequest,
weak_ptr_factory_.GetWeakPtr(), sequence_id);
return;
}
// All elements needed are ready so perform the request.
PerformInteractionRequest();
}
bool LensOverlayQueryController::IsCurrentInteractionSequence(int sequence_id) {
CHECK(latest_interaction_request_data_);
return latest_interaction_request_data_->sequence_id() == sequence_id;
}
void LensOverlayQueryController::PerformInteractionRequest() {
// The interaction request is composed of two steps, sending the request to
// the server, and creating the URL to load in the side panel.
PerformFetchRequest(
latest_interaction_request_data_->request_.get(),
latest_interaction_request_data_->request_headers_.get(),
base::Milliseconds(lens::features::GetLensOverlayServerRequestTimeout()),
base::BindOnce(
&LensOverlayQueryController::OnInteractionEndpointFetcherCreated,
weak_ptr_factory_.GetWeakPtr(),
*latest_interaction_request_data_->request_id_.get()),
base::BindOnce(
&LensOverlayQueryController::InteractionFetchResponseHandler,
weak_ptr_factory_.GetWeakPtr(),
latest_interaction_request_data_->sequence_id()));
// Run the callback to create the search URL and pass it to the side panel.
CHECK(latest_interaction_request_data_->request_sent_callback_.has_value());
std::move(latest_interaction_request_data_->request_sent_callback_.value())
.Run();
}
void LensOverlayQueryController::CreateSearchUrlAndSendToCallback(
base::Time query_start_time,
std::optional<std::string> query_text,
std::map<std::string, std::string> additional_search_query_params,
lens::LensOverlaySelectionType selection_type,
std::unique_ptr<lens::LensOverlayRequestId> request_id) {
// Cluster info must be set already.
CHECK(cluster_info_.has_value());
additional_search_query_params.insert(
{kGen204IdentifierQueryParameter,
base::NumberToString(gen204_id_).c_str()});
// The visual search interaction log data should be added as late as possible,
// so that is_parent_query can be accurately set if the user issues multiple
// interactions in quick succession.
std::string encoded_vsint =
GetEncodedVisualSearchInteractionLogData(selection_type);
additional_search_query_params.insert(
{kVisualSearchInteractionDataQueryParameterKey, encoded_vsint});
suggest_inputs_.set_encoded_visual_search_interaction_log_data(encoded_vsint);
RunSuggestInputsCallback();
// Generate and send the Lens search url.
lens::proto::LensOverlayUrlResponse lens_overlay_url_response;
lens_overlay_url_response.set_url(
lens::BuildLensSearchURL(
query_start_time, query_text, page_url_, page_title_,
std::move(request_id), cluster_info_.value(),
additional_search_query_params, invocation_source_, use_dark_mode_)
.spec());
lens_overlay_url_response.set_page_url(page_url_.spec());
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(url_callback_, lens_overlay_url_response));
}
void LensOverlayQueryController::InteractionFetchResponseHandler(
int sequence_id,
std::unique_ptr<EndpointResponse> response) {
// If this request sequence ID does not match the latest sent then we should
// ignore the response.
if (latest_interaction_request_data_->sequence_id() != sequence_id) {
return;
}
if (response->http_status_code != google_apis::ApiErrorCode::HTTP_SUCCESS) {
RunInteractionCallbackForError();
return;
}
lens::LensOverlayServerResponse server_response;
const std::string response_string = response->response;
bool parse_successful = server_response.ParseFromArray(
response_string.data(), response_string.size());
if (!parse_successful) {
RunInteractionCallbackForError();
return;
}
if (!server_response.has_interaction_response()) {
RunInteractionCallbackForError();
return;
}
// Attach the analytics id associated with the interaction request to the
// latency gen204 ping. This may differ from latest_encoded_analytics_id_ if
// the user makes an objects request while the interaction request is in
// flight.
std::string encoded_analytics_id = base32::Base32Encode(
base::as_byte_span(
latest_interaction_request_data_->request_id_.get()->analytics_id()),
base32::Base32EncodePolicy::OMIT_PADDING);
SendLatencyGen204IfEnabled(
LatencyType::kInteractionRequestFetchLatency,
latest_interaction_request_data_->query_start_time_,
VitQueryParamValueForMimeType(primary_content_type_),
/*cluster_info_latency=*/std::nullopt,
std::make_optional(encoded_analytics_id),
*latest_interaction_request_data_->request_id_.get());
if (!(lens::IsLensOverlayContextualSearchboxEnabled() &&
!lens::features::GetLensOverlaySendImageSignalsForLensSuggest())) {
// Always include the image signals unless the contextual searchbox is
// enabled and the image signals feature flag is disabled.
suggest_inputs_.set_encoded_image_signals(
server_response.interaction_response().encoded_response());
RunSuggestInputsCallback();
}
if (lens::features::IsSimplifiedSelectionEnabled() &&
server_response.interaction_response().has_text()) {
interaction_response_callback_.Run(CreateTextMojomFromInteractionResponse(
server_response.interaction_response(),
latest_interaction_request_data_.get()
->request_->interaction_request()
.image_crop()
.zoomed_crop(),
resized_bitmap_size_));
}
RunSuggestInputsCallback();
}
void LensOverlayQueryController::RunInteractionCallbackForError() {
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(suggest_inputs_callback_,
lens::proto::LensOverlaySuggestInputs()));
}
void LensOverlayQueryController::SendFullImageLatencyGen204IfEnabled(
base::TimeTicks start_time_ticks,
bool is_translate_query,
std::string vit_query_param_value) {
SendInitialLatencyGen204IfNotAlreadySent(
LatencyType::kInvocationToInitialFullPageObjectsResponseReceived,
vit_query_param_value,
*latest_full_image_request_data_->request_id_.get());
SendLatencyGen204IfEnabled(
is_translate_query ? lens::LensOverlayGen204Controller::LatencyType::
kFullPageTranslateRequestFetchLatency
: lens::LensOverlayGen204Controller::LatencyType::
kFullPageObjectsRequestFetchLatency,
start_time_ticks, vit_query_param_value,
cluster_info_fetch_response_time_,
/*encoded_analytics_id=*/std::nullopt,
*latest_full_image_request_data_->request_id_.get());
cluster_info_fetch_response_time_.reset();
}
void LensOverlayQueryController::SendInitialLatencyGen204IfNotAlreadySent(
lens::LensOverlayGen204Controller::LatencyType latency_type,
std::string vit_query_param_value,
std::optional<lens::LensOverlayRequestId> request_id) {
if (sent_initial_latency_request_events_.contains(latency_type)) {
return;
}
SendLatencyGen204IfEnabled(latency_type, invocation_time_,
vit_query_param_value,
/*cluster_info_latency=*/std::nullopt,
/*encoded_analytics_id=*/std::nullopt, request_id);
sent_initial_latency_request_events_.insert(latency_type);
}
void LensOverlayQueryController::PerformFetchRequest(
lens::LensOverlayServerRequest* request,
std::vector<std::string>* request_headers,
base::TimeDelta timeout,
base::OnceCallback<void(std::unique_ptr<EndpointFetcher>)>
fetcher_created_callback,
EndpointFetcherCallback response_received_callback,
UploadProgressCallback upload_progress_callback) {
CHECK(request);
std::string request_string;
CHECK(request->SerializeToString(&request_string));
GURL fetch_url = GURL(lens::features::GetLensOverlayEndpointURL());
PerformFetchRequest(std::move(request_string), request_headers, timeout,
std::move(fetcher_created_callback),
std::move(response_received_callback),
std::move(upload_progress_callback), fetch_url);
}
void LensOverlayQueryController::PerformFetchRequest(
std::string request_string,
std::vector<std::string>* request_headers,
base::TimeDelta timeout,
base::OnceCallback<void(std::unique_ptr<EndpointFetcher>)>
fetcher_created_callback,
EndpointFetcherCallback response_received_callback,
UploadProgressCallback upload_progress_callback,
GURL fetch_url) {
CHECK(request_headers);
// Get client experiment variations to include in the request.
std::vector<std::string> cors_exempt_headers =
CreateVariationsHeaders(variations_client_);
// Generate the URL to fetch to and include the server session id if present.
if (cluster_info_.has_value()) {
// The endpoint fetches should use the server session id from the cluster
// info.
fetch_url = net::AppendOrReplaceQueryParameter(
fetch_url, kSessionIdQueryParameterKey,
cluster_info_->server_session_id());
}
// Create the EndpointFetcher, responsible for making the request using our
// given params.
std::unique_ptr<EndpointFetcher> endpoint_fetcher = CreateEndpointFetcher(
std::move(request_string), fetch_url, HttpMethod::kPost, timeout,
*request_headers, cors_exempt_headers,
std::move(upload_progress_callback));
EndpointFetcher* fetcher = endpoint_fetcher.get();
// Run callback that the fetcher was created. This is used to keep the
// endpoint_fetcher alive while the request is made.
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(std::move(fetcher_created_callback),
std::move(endpoint_fetcher)));
// Finally, perform the request.
fetcher->PerformRequest(std::move(response_received_callback),
google_apis::GetAPIKey().c_str());
}
lens::LensOverlayClientContext
LensOverlayQueryController::CreateClientContext() {
lens::LensOverlayClientContext context;
if (lens::features::IsUpdatedClientContextEnabled()) {
context.set_surface(lens::SURFACE_LENS_OVERLAY);
context.set_platform(lens::PLATFORM_LENS_OVERLAY);
} else {
context.set_surface(lens::SURFACE_CHROMIUM);
context.set_platform(lens::PLATFORM_WEB);
context.mutable_rendering_context()->set_rendering_environment(
lens::RENDERING_ENV_LENS_OVERLAY);
}
context.mutable_client_filters()->add_filter()->set_filter_type(
lens::AUTO_FILTER);
context.mutable_locale_context()->set_language(
g_browser_process->GetApplicationLocale());
context.mutable_locale_context()->set_region(
icu::Locale(g_browser_process->GetApplicationLocale().c_str())
.getCountry());
// Add the appropriate context filters. If source and target languages have
// been set, this should add translate.
if (translate_options_.has_value()) {
context.mutable_client_filters()->clear_filter();
lens::AppliedFilter* translate_filter =
context.mutable_client_filters()->add_filter();
translate_filter->set_filter_type(lens::TRANSLATE);
translate_filter->mutable_translate()->set_source_language(
translate_options_->source_language);
translate_filter->mutable_translate()->set_target_language(
translate_options_->target_language);
}
std::unique_ptr<icu::TimeZone> zone(icu::TimeZone::createDefault());
icu::UnicodeString time_zone_id, time_zone_canonical_id;
zone->getID(time_zone_id);
UErrorCode status = U_ZERO_ERROR;
icu::TimeZone::getCanonicalID(time_zone_id, time_zone_canonical_id, status);
if (status == U_ZERO_ERROR) {
std::string zone_id_str;
time_zone_canonical_id.toUTF8String(zone_id_str);
context.mutable_locale_context()->set_time_zone(zone_id_str);
}
return context;
}
std::unique_ptr<signin::PrimaryAccountAccessTokenFetcher>
LensOverlayQueryController::CreateOAuthHeadersAndContinue(
OAuthHeadersCreatedCallback callback) {
// Use OAuth if the flag is enabled and the user is logged in.
if (lens::features::UseOauthForLensOverlayRequests() && identity_manager_ &&
identity_manager_->HasPrimaryAccount(signin::ConsentLevel::kSignin)) {
signin::AccessTokenFetcher::TokenCallback token_callback =
base::BindOnce(&lens::CreateOAuthHeader).Then(std::move(callback));
signin::ScopeSet oauth_scopes;
oauth_scopes.insert(GaiaConstants::kLensOAuth2Scope);
// If an access token fetcher is already in flight, it is intentionally
// replaced by this newer one.
return std::make_unique<signin::PrimaryAccountAccessTokenFetcher>(
kOAuthConsumerName, identity_manager_, oauth_scopes,
std::move(token_callback),
signin::PrimaryAccountAccessTokenFetcher::Mode::kWaitUntilAvailable,
signin::ConsentLevel::kSignin);
}
// Fall back to fetching the endpoint directly using API key.
std::move(callback).Run(std::vector<std::string>());
return nullptr;
}
std::string
LensOverlayQueryController::GetEncodedVisualSearchInteractionLogData(
lens::LensOverlaySelectionType selection_type) {
lens::LensOverlayVisualSearchInteractionData interaction_data;
interaction_data.mutable_log_data()->mutable_filter_data()->set_filter_type(
lens::AUTO_FILTER);
interaction_data.mutable_log_data()
->mutable_user_selection_data()
->set_selection_type(selection_type);
interaction_data.mutable_log_data()->set_is_parent_query(!parent_query_sent_);
interaction_data.mutable_log_data()->set_client_platform(
lens::CLIENT_PLATFORM_LENS_OVERLAY);
// If there was an interaction request made, then the selection type, region
// and object id should be set if they exist. The interaction request may not
// exist if the user made a text-selection query.
if (latest_interaction_request_data_->request_ &&
latest_interaction_request_data_->request_->has_interaction_request()) {
auto sent_interaction_request =
latest_interaction_request_data_->request_->interaction_request();
interaction_data.set_interaction_type(
sent_interaction_request.interaction_request_metadata().type());
if (sent_interaction_request.has_interaction_request_metadata() &&
sent_interaction_request.interaction_request_metadata()
.has_selection_metadata() &&
sent_interaction_request.interaction_request_metadata()
.selection_metadata()
.has_object()) {
interaction_data.set_object_id(
sent_interaction_request.interaction_request_metadata()
.selection_metadata()
.object()
.object_id());
} else if (sent_interaction_request.has_image_crop()) {
// The zoomed crop field should only be set if the object id is not set.
interaction_data.mutable_zoomed_crop()->CopyFrom(
sent_interaction_request.image_crop().zoomed_crop());
}
} else {
// If there was no interaction request, then the selection type should be
// set to text selection.
interaction_data.set_interaction_type(
lens::LensOverlayInteractionRequestMetadata::TEXT_SELECTION);
}
parent_query_sent_ = true;
std::string serialized_proto;
CHECK(interaction_data.SerializeToString(&serialized_proto));
std::string encoded_proto;
base::Base64UrlEncode(serialized_proto,
base::Base64UrlEncodePolicy::OMIT_PADDING,
&encoded_proto);
return encoded_proto;
}
lens::LensOverlayServerRequest
LensOverlayQueryController::CreateInteractionRequest(
lens::mojom::CenterRotatedBoxPtr region,
std::optional<std::string> query_text,
std::optional<std::string> object_id,
std::optional<lens::ImageCrop> image_crop,
lens::LensOverlayClientLogs client_logs) {
lens::LensOverlayServerRequest server_request;
server_request.mutable_client_logs()->CopyFrom(client_logs);
// The request ID is guaranteed to exist since it is set in the constructor
// of latest_interaction_request_data_.
DCHECK(latest_interaction_request_data_->request_id_);
lens::LensOverlayRequestContext request_context;
request_context.mutable_request_id()->CopyFrom(
*latest_interaction_request_data_->request_id_);
request_context.mutable_client_context()->CopyFrom(CreateClientContext());
server_request.mutable_interaction_request()
->mutable_request_context()
->CopyFrom(request_context);
lens::LensOverlayInteractionRequestMetadata interaction_request_metadata;
if (!region.is_null() && image_crop.has_value()) {
// Add the region for region search and multimodal requests.
server_request.mutable_interaction_request()
->mutable_image_crop()
->CopyFrom(*image_crop);
interaction_request_metadata.set_type(
lens::LensOverlayInteractionRequestMetadata::REGION_SEARCH);
interaction_request_metadata.mutable_selection_metadata()
->mutable_region()
->mutable_region()
->CopyFrom(ConvertToServerCenterRotatedBox(region.Clone()));
// Add the text, for multimodal requests.
if (query_text.has_value()) {
interaction_request_metadata.mutable_query_metadata()
->mutable_text_query()
->set_query(*query_text);
}
} else if (object_id.has_value()) {
// Add object request details.
interaction_request_metadata.set_type(
lens::LensOverlayInteractionRequestMetadata::TAP);
interaction_request_metadata.mutable_selection_metadata()
->mutable_object()
->set_object_id(*object_id);
} else if (query_text.has_value()) {
// If there is only `query_text`, this is a contextual flow.
interaction_request_metadata.set_type(
ContentTypeToInteractionType(primary_content_type_));
interaction_request_metadata.mutable_query_metadata()
->mutable_text_query()
->set_query(*query_text);
} else {
// There should be a region or an object id in the request.
NOTREACHED();
}
server_request.mutable_interaction_request()
->mutable_interaction_request_metadata()
->CopyFrom(interaction_request_metadata);
return server_request;
}
void LensOverlayQueryController::ResetRequestClusterInfoState() {
pending_interaction_callback_.Reset();
interaction_endpoint_fetcher_.reset();
cluster_info_.reset();
query_controller_state_ = QueryControllerState::kClusterInfoExpired;
request_id_generator_->ResetRequestId();
suggest_inputs_.Clear();
RunSuggestInputsCallback();
parent_query_sent_ = false;
is_first_page_contents_request_ = true;
is_first_partial_page_contents_request_ = true;
}
void LensOverlayQueryController::OnFullImageEndpointFetcherCreated(
lens::LensOverlayRequestId request_id,
std::unique_ptr<EndpointFetcher> endpoint_fetcher) {
SendInitialLatencyGen204IfNotAlreadySent(
LatencyType::kInvocationToInitialFullPageObjectsRequestSent,
VitQueryParamValueForMimeType(primary_content_type_), request_id);
full_image_endpoint_fetcher_ = std::move(endpoint_fetcher);
}
void LensOverlayQueryController::OnPageContentEndpointFetcherCreated(
lens::LensOverlayRequestId request_id,
std::unique_ptr<EndpointFetcher> endpoint_fetcher) {
SendInitialLatencyGen204IfNotAlreadySent(
LatencyType::kInvocationToInitialPageContentRequestSent,
VitQueryParamValueForMimeType(primary_content_type_), request_id);
page_content_endpoint_fetcher_ = std::move(endpoint_fetcher);
}
void LensOverlayQueryController::OnPartialPageContentEndpointFetcherCreated(
lens::LensOverlayRequestId request_id,
std::unique_ptr<EndpointFetcher> endpoint_fetcher) {
SendInitialLatencyGen204IfNotAlreadySent(
LatencyType::kInvocationToInitialPartialPageContentRequestSent,
VitQueryParamValueForMimeType(primary_content_type_), request_id);
partial_page_content_endpoint_fetcher_ = std::move(endpoint_fetcher);
}
void LensOverlayQueryController::OnInteractionEndpointFetcherCreated(
lens::LensOverlayRequestId request_id,
std::unique_ptr<EndpointFetcher> endpoint_fetcher) {
SendInitialLatencyGen204IfNotAlreadySent(
LatencyType::kInvocationToInitialInteractionRequestSent,
VitQueryParamValueForMimeType(primary_content_type_), request_id);
interaction_endpoint_fetcher_ = std::move(endpoint_fetcher);
}
void LensOverlayQueryController::OnChunkUploadEndpointFetcherCreated(
lens::LensOverlayRequestId request_id,
std::unique_ptr<EndpointFetcher> endpoint_fetcher) {
SendInitialLatencyGen204IfNotAlreadySent(
LatencyType::kInvocationToInitialPageContentRequestSent,
VitQueryParamValueForMimeType(primary_content_type_), request_id);
chunk_upload_endpoint_fetchers_.push_back(std::move(endpoint_fetcher));
}
bool LensOverlayQueryController::ShouldSendContextualSearchQuery() {
// Can send the query if the page content request has finished.
return !page_content_request_in_progress_ && cluster_info_.has_value();
}
bool LensOverlayQueryController::IsPartialPageContentSubstantial() {
// If the partial page content is empty, exit early.
if (partial_content_.empty()) {
return false;
}
// Get the average number of characters per page.
int total_characters = 0;
for (const std::u16string& page_text : partial_content_) {
total_characters += page_text.size();
}
const int characters_per_page = total_characters / partial_content_.size();
// If the average is over the scanned pdf character per page heuristic, the
// query is considered substantial.
return characters_per_page >
lens::features::GetScannedPdfCharacterPerPageHeuristic();
}
} // namespace lens
|