Add search query and summary from Brave Search SERP when open Leo chat

- Add search query and summary from Brave Search SERP to conversation
  history when summarizer-key tag is present.
- Also add a new from_brave_SERP property in ConversationTurn to identify the
  conversation entries from Brave Search SERP.
- Modify UI to show the page context toggle when search query and summary are
  staged.
- Staged search query and summary (at the end of the conversation history) will
  be cleared if user opted out, page was unlinked, or navigated to a new page.

Author: yrliou

browser/ai_chat/ai_chat_ui_browsertest.cc

@@ -4,6 +4,7 @@
  * You can obtain one at https://mozilla.org/MPL/2.0/. */
 
 #include <memory>
+#include <optional>
 
 #include "base/files/file_path.h"
 #include "base/memory/raw_ptr.h"
@@ -13,6 +14,7 @@
 #include "base/test/bind.h"
 #include "brave/components/ai_chat/content/browser/ai_chat_tab_helper.h"
 #include "brave/components/ai_chat/core/browser/constants.h"
+#include "brave/components/ai_chat/core/browser/types.h"
 #include "brave/components/constants/brave_paths.h"
 #include "brave/components/l10n/common/test/scoped_default_locale.h"
 #include "brave/components/text_recognition/common/buildflags/buildflags.h"
@@ -32,8 +34,13 @@
 #include "content/public/test/browser_test_utils.h"
 #include "content/public/test/content_mock_cert_verifier.h"
 #include "net/dns/mock_host_resolver.h"
+#include "net/test/embedded_test_server/embedded_test_server.h"
+#include "net/test/embedded_test_server/http_request.h"
+#include "net/test/embedded_test_server/http_response.h"
 #include "printing/buildflags/buildflags.h"
+#include "services/network/public/cpp/network_switches.h"
 #include "ui/compositor/compositor_switches.h"
+#include "url/gurl.h"
 
 #if BUILDFLAG(ENABLE_PRINT_PREVIEW)
 #include "chrome/browser/printing/test_print_preview_observer.h"
@@ -42,6 +49,53 @@
 namespace {
 
 constexpr char kEmbeddedTestServerDirectory[] = "leo";
+
+std::unique_ptr<net::test_server::HttpResponse> HandleSearchQuerySummaryRequest(
+    const net::test_server::HttpRequest& request) {
+  const GURL url = request.GetURL();
+  if (url.path_piece() != "/api/chatllm/raw_data") {
+    return nullptr;
+  }
+
+  auto query = url.query_piece();
+  if (query == "key=%7Btest_key%7D") {
+    auto response = std::make_unique<net::test_server::BasicHttpResponse>();
+    response->set_code(net::HTTP_OK);
+    response->set_content_type("application/json");
+    response->set_content(
+        R"({"conversation": [{"query": "test query",
+                                "answer": [{"text": "test summary"}]}]})");
+    return response;
+  }
+
+  if (query == "key=%7Bnot_object%7D") {
+    auto response = std::make_unique<net::test_server::BasicHttpResponse>();
+    response->set_code(net::HTTP_OK);
+    response->set_content_type("application/json");
+    response->set_content(R"(["not_object"])");
+    return response;
+  }
+
+  if (query == "key=%7Bempty_conversation%7D") {
+    auto response = std::make_unique<net::test_server::BasicHttpResponse>();
+    response->set_code(net::HTTP_OK);
+    response->set_content_type("application/json");
+    response->set_content(R"({"conversation": []})");
+    return response;
+  }
+
+  if (query == "key=%7Bempty_answer%7D") {
+    auto response = std::make_unique<net::test_server::BasicHttpResponse>();
+    response->set_code(net::HTTP_OK);
+    response->set_content_type("application/json");
+    response->set_content(R"({"conversation": [{"query": "test query",
+                                                  "answer": []}])");
+    return response;
+  }
+
+  return nullptr;
+}
+
 }  // namespace
 
 class AIChatUIBrowserTest : public InProcessBrowserTest {
@@ -57,7 +111,9 @@ class AIChatUIBrowserTest : public InProcessBrowserTest {
     test_data_dir = base::PathService::CheckedGet(brave::DIR_TEST_DATA);
     test_data_dir = test_data_dir.AppendASCII(kEmbeddedTestServerDirectory);
     https_server_.ServeFilesFromDirectory(test_data_dir);
-    ASSERT_TRUE(https_server_.Start());
+    https_server_.RegisterRequestHandler(
+        base::BindRepeating(&HandleSearchQuerySummaryRequest));
+    https_server_.StartAcceptingConnections();
 
     // Set a smaller window size so we can have test data with more pages.
     browser()->window()->SetContentsSize(gfx::Size(800, 600));
@@ -71,6 +127,14 @@ class AIChatUIBrowserTest : public InProcessBrowserTest {
 
   void SetUpCommandLine(base::CommandLine* command_line) override {
     InProcessBrowserTest::SetUpCommandLine(command_line);
+
+    ASSERT_TRUE(https_server_.InitializeAndListen());
+    // Add a host resolver rule to map all outgoing requests to the test server.
+    command_line->AppendSwitchASCII(
+        network::switches::kHostResolverRules,
+        "MAP * " + https_server_.host_port_pair().ToString() +
+            ",EXCLUDE localhost");
+
 #if BUILDFLAG(ENABLE_TEXT_RECOGNITION)
     command_line->AppendSwitch(::switches::kEnablePixelOutputInTests);
 #endif
@@ -128,6 +192,20 @@ class AIChatUIBrowserTest : public InProcessBrowserTest {
     run_loop.Run();
   }
 
+  void FetchSearchQuerySummary(const base::Location& location,
+                               const std::optional<ai_chat::SearchQuerySummary>&
+                                   expected_search_query_summary) {
+    SCOPED_TRACE(testing::Message() << location.ToString());
+    base::RunLoop run_loop;
+    chat_tab_helper_->FetchSearchQuerySummary(base::BindLambdaForTesting(
+        [&](const std::optional<ai_chat::SearchQuerySummary>&
+                search_query_summary) {
+          EXPECT_EQ(search_query_summary, expected_search_query_summary);
+          run_loop.Quit();
+        }));
+    run_loop.Run();
+  }
+
  protected:
   net::test_server::EmbeddedTestServer https_server_;
   raw_ptr<ai_chat::AIChatTabHelper> chat_tab_helper_ = nullptr;
@@ -253,3 +331,54 @@ IN_PROC_BROWSER_TEST_F(AIChatUIBrowserTest, PrintPreviewDisabled) {
   NavigateURL(https_server_.GetURL("docs.google.com", "/long_canvas.html"));
   FetchPageContent(FROM_HERE, "");
 }
+
+IN_PROC_BROWSER_TEST_F(AIChatUIBrowserTest, FetchSearchQuerySummary) {
+  NavigateURL(https_server_.GetURL("search.brave.com", "/search?q=query"));
+
+  // Test when meta tag is not present, should return null result.
+  FetchSearchQuerySummary(FROM_HERE, std::nullopt);
+
+  // Test when summarizer-key meta tag is dynamically inserted, should return
+  // the search query summary from the mock response.
+  content::ExecuteScriptAsync(GetActiveWebContents()->GetPrimaryMainFrame(),
+                              "var meta = document.createElement('meta');"
+                              "meta.name = 'summarizer-key';"
+                              "meta.content = '{test_key}';"
+                              "document.head.appendChild(meta);");
+  FetchSearchQuerySummary(
+      FROM_HERE, ai_chat::SearchQuerySummary("test query", "test summary"));
+
+  // Test empty summarizer-key meta tag, should return null result.
+  content::ExecuteScriptAsync(GetActiveWebContents()->GetPrimaryMainFrame(),
+                              "document.querySelector('meta[name=summarizer-"
+                              "key').content = '';");
+  FetchSearchQuerySummary(FROM_HERE, std::nullopt);
+
+  // Mock search query summary response to test parsing.
+  // Replace the meta tag value to another key.
+  content::ExecuteScriptAsync(GetActiveWebContents()->GetPrimaryMainFrame(),
+                              "document.querySelector('meta[name=summarizer-"
+                              "key').content = '{not_object}';");
+  FetchSearchQuerySummary(FROM_HERE, std::nullopt);
+
+  // Replace the meta tag value to error case: conversation empty.
+  content::ExecuteScriptAsync(GetActiveWebContents()->GetPrimaryMainFrame(),
+                              "document.querySelector('meta[name=summarizer-"
+                              "key').content = '{empty_conversation}';");
+  FetchSearchQuerySummary(FROM_HERE, std::nullopt);
+
+  // Replace the meta tag value to error case: answer empty.
+  content::ExecuteScriptAsync(GetActiveWebContents()->GetPrimaryMainFrame(),
+                              "document.querySelector('meta[name=summarizer-"
+                              "key').content = '{empty_answer}';");
+  FetchSearchQuerySummary(FROM_HERE, std::nullopt);
+
+  // Test non-brave search SERP URL, should return null result.
+  NavigateURL(https_server_.GetURL("brave.com", "/search?q=query"));
+  content::ExecuteScriptAsync(GetActiveWebContents()->GetPrimaryMainFrame(),
+                              "var meta = document.createElement('meta');"
+                              "meta.name = 'summarizer-key';"
+                              "meta.content = '{test_key}';"
+                              "document.head.appendChild(meta);");
+  FetchSearchQuerySummary(FROM_HERE, std::nullopt);
+}

browser/ai_chat/android/ai_chat_utils_android.cc

@@ -32,7 +32,7 @@ static void JNI_BraveLeoUtils_OpenLeoQuery(
       mojom::CharacterType::HUMAN, mojom::ActionType::QUERY,
       mojom::ConversationTurnVisibility::VISIBLE,
       base::android::ConvertJavaStringToUTF8(query), std::nullopt, std::nullopt,
-      base::Time::Now(), std::nullopt);
+      base::Time::Now(), std::nullopt, false);
   chat_tab_helper->SubmitHumanConversationEntry(std::move(turn));
 #endif
 }

browser/ai_chat/page_content_fetcher_browsertest.cc

@@ -123,6 +123,20 @@ class PageContentFetcherBrowserTest : public InProcessBrowserTest {
     run_loop.Run();
   }
 
+  void GetSearchSummarizerKey(const base::Location& location,
+                              const std::optional<std::string>& expected_key) {
+    SCOPED_TRACE(testing::Message() << location.ToString());
+    base::RunLoop run_loop;
+    ai_chat::GetSearchSummarizerKey(
+        browser()->tab_strip_model()->GetActiveWebContents(),
+        base::BindLambdaForTesting(
+            [&run_loop, &expected_key](const std::optional<std::string>& key) {
+              EXPECT_EQ(expected_key, key);
+              run_loop.Quit();
+            }));
+    run_loop.Run();
+  }
+
   // Handles returning a .patch file if the user is on a github.com pull request
   void SetGithubInterceptor() {
     GURL expected_patch_url =
@@ -219,3 +233,36 @@ IN_PROC_BROWSER_TEST_F(PageContentFetcherBrowserTest, FetchPageContentPDF) {
   EXPECT_EQ(1, browser()->tab_strip_model()->active_index());
   run_loop->Run();
 }
+
+IN_PROC_BROWSER_TEST_F(PageContentFetcherBrowserTest, GetSearchSummarizerKey) {
+  auto remove_first_summarizer_key = [&]() {
+    content::ExecuteScriptAsync(
+        GetActiveWebContents()->GetPrimaryMainFrame(),
+        "document.getElementsByName('summarizer-key')[0].remove()");
+  };
+
+  NavigateURL(https_server_.GetURL("a.com", "/summarizer_key_meta.html"));
+  GetSearchSummarizerKey(FROM_HERE,
+                         R"({"query":"test","results_hash":"hash"})");
+
+  // Test meta in two other formats.
+  remove_first_summarizer_key();
+  GetSearchSummarizerKey(FROM_HERE,
+                         R"({"query":"test2","results_hash":"hash"})");
+
+  remove_first_summarizer_key();
+  GetSearchSummarizerKey(FROM_HERE,
+                         R"({"query":"test3","results_hash":"hash"})");
+
+  // Test meta with other attribute.
+  remove_first_summarizer_key();
+  GetSearchSummarizerKey(FROM_HERE, R"({"test"})");
+
+  // Test meta with empty key.
+  remove_first_summarizer_key();
+  GetSearchSummarizerKey(FROM_HERE, std::nullopt);
+
+  // Test meta with empty key and other atribute.
+  remove_first_summarizer_key();
+  GetSearchSummarizerKey(FROM_HERE, std::nullopt);
+}

browser/ui/webui/ai_chat/ai_chat_ui_page_handler.cc

@@ -143,7 +143,7 @@ void AIChatUIPageHandler::SubmitHumanConversationEntry(
   mojom::ConversationTurnPtr turn = mojom::ConversationTurn::New(
       CharacterType::HUMAN, mojom::ActionType::UNSPECIFIED,
       ConversationTurnVisibility::VISIBLE, input, std::nullopt, std::nullopt,
-      base::Time::Now(), std::nullopt);
+      base::Time::Now(), std::nullopt, false);
   active_chat_tab_helper_->SubmitHumanConversationEntry(std::move(turn));
 }
 

chromium_src/chrome/browser/autocomplete/chrome_autocomplete_provider_client.cc

@@ -79,7 +79,7 @@ void ChromeAutocompleteProviderClient::OpenLeo(const std::u16string& query) {
           ai_chat::mojom::ConversationTurnVisibility::VISIBLE,
           base::UTF16ToUTF8(query) /* text */, std::nullopt /* selected_text */,
           std::nullopt /* events */, base::Time::Now(),
-          std::nullopt /* edits */);
+          std::nullopt /* edits */, false /* from_brave_search_SERP */);
 
   chat_tab_helper->SubmitHumanConversationEntry(std::move(turn));
 

components/ai_chat/content/browser/BUILD.gn

@@ -5,6 +5,7 @@
 
 import("//brave/components/ai_chat/core/common/buildflags/buildflags.gni")
 import("//brave/components/text_recognition/common/buildflags/buildflags.gni")
+import("//tools/json_schema_compiler/json_schema_api.gni")
 
 assert(enable_ai_chat)
 
@@ -23,7 +24,9 @@ static_library("browser") {
   ]
 
   deps = [
+    ":generated_brave_search_responses",
     "//base",
+    "//brave/brave_domains",
     "//brave/components/ai_chat/core/browser",
     "//brave/components/ai_chat/core/common",
     "//brave/components/ai_chat/core/common/buildflags",
@@ -51,3 +54,10 @@ static_library("browser") {
     "//url",
   ]
 }
+
+generated_types("generated_brave_search_responses") {
+  sources = [ "brave_search_responses.idl" ]
+  deps = [ "//base" ]
+  root_namespace = "ai_chat::%(namespace)s"
+  visibility = [ ":browser" ]
+}