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 completion event 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, conversation became inactive,
  or user navigated away to other page.

Author: yrliou

browser/ai_chat/ai_chat_render_view_context_menu_browsertest.cc

@@ -130,7 +130,7 @@ class AIChatRenderViewContextMenuBrowserTest : public InProcessBrowserTest {
           ASSERT_TRUE(data_callback);
           for (const auto& data : received_data) {
             auto event = mojom::ConversationEntryEvent::NewCompletionEvent(
-                mojom::CompletionEvent::New(data));
+                mojom::CompletionEvent::New(data, false));
             data_callback.Run(std::move(event));
           }
           std::move(callback).Run(completed_result);

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=test_key") {
+    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=not_object") {
+    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=empty_conversation") {
+    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=empty_answer") {
+    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,48 @@ 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"));
+
+  // 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);
+}

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,6 +24,7 @@ static_library("browser") {
   ]
 
   deps = [
+    ":generated_brave_search_responses",
     "//base",
     "//brave/components/ai_chat/core/browser",
     "//brave/components/ai_chat/core/common",
@@ -51,3 +53,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" ]
+}

components/ai_chat/content/browser/ai_chat_tab_helper.cc

@@ -17,11 +17,15 @@
 #include "base/notreached.h"
 #include "base/ranges/algorithm.h"
 #include "base/strings/string_util.h"
+#include "base/values.h"
+#include "brave/components/ai_chat/content/browser/brave_search_responses.h"
 #include "brave/components/ai_chat/content/browser/model_service_factory.h"
 #include "brave/components/ai_chat/content/browser/page_content_fetcher.h"
 #include "brave/components/ai_chat/content/browser/pdf_utils.h"
 #include "brave/components/ai_chat/core/browser/ai_chat_metrics.h"
 #include "brave/components/ai_chat/core/browser/constants.h"
+#include "brave/components/ai_chat/core/browser/types.h"
+#include "brave/components/ai_chat/core/browser/utils.h"
 #include "brave/components/ai_chat/core/common/features.h"
 #include "brave/components/ai_chat/core/common/mojom/page_content_extractor.mojom.h"
 #include "brave/components/ai_chat/core/common/pref_names.h"
@@ -37,6 +41,8 @@
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents.h"
 #include "mojo/public/cpp/bindings/self_owned_receiver.h"
+#include "net/base/url_util.h"
+#include "net/traffic_annotation/network_traffic_annotation.h"
 #include "pdf/buildflags.h"
 #include "ui/accessibility/ax_mode.h"
 #include "ui/accessibility/ax_updates_and_events.h"
@@ -45,8 +51,46 @@
 namespace ai_chat {
 
 namespace {
+
 std::optional<uint32_t> g_max_page_content_length_for_testing;
 
+net::NetworkTrafficAnnotationTag
+GetSearchQuerySummaryNetworkTrafficAnnotationTag() {
+  return net::DefineNetworkTrafficAnnotation("ai_chat_tab_helper", R"(
+      semantics {
+        sender: "Brave Leo AI Chat"
+        description:
+          "This sender is used to get search query summary from Brave search."
+        trigger:
+          "Triggered by uses of Brave Leo AI Chat on Brave Search SERP."
+        data:
+          "User's search query and the corresponding summary."
+        destination: WEBSITE
+      }
+      policy {
+        cookies_allowed: NO
+        policy_exception_justification:
+          "Not implemented."
+      }
+    )");
+}
+
+std::optional<SearchQuerySummary> ParseSearchQuerySummaryResponse(
+    const base::Value& value) {
+  auto search_query_response =
+      brave_search_responses::QuerySummaryResponse::FromValue(value);
+  if (!search_query_response || search_query_response->conversation.empty()) {
+    return std::nullopt;
+  }
+
+  const auto& query_summary = search_query_response->conversation[0];
+  if (query_summary.answer.empty()) {
+    return std::nullopt;
+  }
+
+  return SearchQuerySummary(query_summary.query, query_summary.answer[0].text);
+}
+
 }  // namespace
 
 AIChatTabHelper::PDFA11yInfoLoadObserver::PDFA11yInfoLoadObserver(
@@ -345,6 +389,58 @@ void AIChatTabHelper::CheckPDFA11yTree() {
   OnPDFA11yInfoLoaded();
 }
 
+void AIChatTabHelper::FetchSearchQuerySummary(
+    FetchSearchQuerySummaryCallback callback) {
+  if (!IsBraveSearchSERP(GetPageURL())) {
+    std::move(callback).Run(std::nullopt);
+    return;
+  }
+
+  auto internal_callback =
+      base::BindOnce(&AIChatTabHelper::OnSearchSummarizerKeyFetched,
+                     weak_ptr_factory_.GetWeakPtr(), std::move(callback));
+  GetSearchSummarizerKey(web_contents(), std::move(internal_callback));
+}
+
+void AIChatTabHelper::OnSearchSummarizerKeyFetched(
+    FetchSearchQuerySummaryCallback callback,
+    const std::optional<std::string>& key) {
+  if (!key) {
+    std::move(callback).Run(std::nullopt);
+    return;
+  }
+
+  if (!api_request_helper_) {
+    api_request_helper_ =
+        std::make_unique<api_request_helper::APIRequestHelper>(
+            GetSearchQuerySummaryNetworkTrafficAnnotationTag(),
+            web_contents()
+                ->GetBrowserContext()
+                ->GetDefaultStoragePartition()
+                ->GetURLLoaderFactoryForBrowserProcess());
+  }
+
+  GURL base_url("https://search.brave.com/api/chatllm/raw_data");
+  GURL url = net::AppendQueryParameter(base_url, "key", *key);
+
+  auto internal_callback =
+      base::BindOnce(&AIChatTabHelper::OnSearchQuerySummaryFetched,
+                     weak_ptr_factory_.GetWeakPtr(), std::move(callback));
+  api_request_helper_->Request("GET", url, "", "application/json",
+                               std::move(internal_callback), {}, {});
+}
+
+void AIChatTabHelper::OnSearchQuerySummaryFetched(
+    FetchSearchQuerySummaryCallback callback,
+    api_request_helper::APIRequestResult result) {
+  if (!result.Is2XXResponseCode()) {
+    std::move(callback).Run(std::nullopt);
+    return;
+  }
+
+  std::move(callback).Run(ParseSearchQuerySummaryResponse(result.value_body()));
+}
+
 WEB_CONTENTS_USER_DATA_KEY_IMPL(AIChatTabHelper);
 
 }  // namespace ai_chat

components/ai_chat/content/browser/ai_chat_tab_helper.h

@@ -7,6 +7,7 @@
 #define BRAVE_COMPONENTS_AI_CHAT_CONTENT_BROWSER_AI_CHAT_TAB_HELPER_H_
 
 #include <memory>
+#include <optional>
 #include <string>
 #include <vector>
 
@@ -16,6 +17,7 @@
 #include "brave/components/ai_chat/core/browser/engine/engine_consumer.h"
 #include "brave/components/ai_chat/core/common/mojom/ai_chat.mojom.h"
 #include "brave/components/ai_chat/core/common/mojom/page_content_extractor.mojom.h"
+#include "brave/components/api_request_helper/api_request_helper.h"
 #include "components/favicon/core/favicon_driver_observer.h"
 #include "components/prefs/pref_change_registrar.h"
 #include "content/public/browser/navigation_handle.h"
@@ -124,6 +126,13 @@ class AIChatTabHelper : public content::WebContentsObserver,
                       std::string_view invalidation_token) override;
   void PrintPreviewFallback(GetPageContentCallback callback) override;
   std::u16string GetPageTitle() const override;
+  void FetchSearchQuerySummary(
+      FetchSearchQuerySummaryCallback callback) override;
+
+  void OnSearchSummarizerKeyFetched(FetchSearchQuerySummaryCallback callback,
+                                    const std::optional<std::string>& key);
+  void OnSearchQuerySummaryFetched(FetchSearchQuerySummaryCallback callback,
+                                   api_request_helper::APIRequestResult result);
 
   void BindPageContentExtractorReceiver(
       mojo::PendingAssociatedReceiver<mojom::PageContentExtractorHost>
@@ -146,6 +155,9 @@ class AIChatTabHelper : public content::WebContentsObserver,
   // A scoper only used for PDF viewing.
   std::unique_ptr<content::ScopedAccessibilityMode> scoped_accessibility_mode_;
 
+  // Used for fetching search query summary.
+  std::unique_ptr<api_request_helper::APIRequestHelper> api_request_helper_;
+
   mojo::AssociatedReceiver<mojom::PageContentExtractorHost>
       page_content_extractor_receiver_{this};