chrome/browser/preloading/search_preload/search_preload_pipeline_manager.h

// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_PRELOADING_SEARCH_PRELOAD_SEARCH_PRELOAD_PIPELINE_MANAGER_H_
#define CHROME_BROWSER_PRELOADING_SEARCH_PRELOAD_SEARCH_PRELOAD_PIPELINE_MANAGER_H_

#include "base/containers/flat_map.h"
#include "base/memory/weak_ptr.h"
#include "chrome/browser/preloading/search_preload/search_preload_pipeline.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "url/gurl.h"

class AutocompleteResult;
class Profile;
class SearchPreloadService;
class TemplateURLService;
struct AutocompleteMatch;

namespace content {
class WebContents;
}

namespace omnibox::mojom {
enum class NavigationPredictor;
}

// Roles:
//
// - Manages preload pipelines per WebContents.
// - Starts preloads in response to Omnibox events.
class SearchPreloadPipelineManager
    : public content::WebContentsUserData<SearchPreloadPipelineManager>,
      public content::WebContentsObserver {
 public:
  ~SearchPreloadPipelineManager() override;

  // Not movable nor copyable.
  SearchPreloadPipelineManager(const SearchPreloadPipelineManager&&) = delete;
  SearchPreloadPipelineManager& operator=(
      const SearchPreloadPipelineManager&&) = delete;
  SearchPreloadPipelineManager(const SearchPreloadPipelineManager&) = delete;
  SearchPreloadPipelineManager& operator=(const SearchPreloadPipelineManager&) =
      delete;

  base::WeakPtr<SearchPreloadPipelineManager> GetWeakPtr() {
    return weak_factory_.GetWeakPtr();
  }

  // Implements `content::WebContentsObserver`
  void DidFinishNavigation(
      content::NavigationHandle* navigation_handle) override;

  // Clears all preloads.
  void ClearPreloads();

  // Called when autocomplete is updated.
  void OnAutocompleteResultChanged(
      Profile& profile,
      base::WeakPtr<SearchPreloadService> search_preload_service,
      const AutocompleteResult& result,
      const std::optional<net::HttpNoVarySearchData>& no_vary_search_hint);

  // Called when a user is likely to navigate to the match.
  //
  // Returns true iff a new prefetch is triggered by this call. Note that it
  // returns false if a prefetch for the same canonical URL has already
  // triggered.
  bool OnNavigationLikely(
      Profile& profile,
      base::WeakPtr<SearchPreloadService> search_preload_service,
      const AutocompleteMatch& match,
      omnibox::mojom::NavigationPredictor navigation_predictor,
      const std::optional<net::HttpNoVarySearchData>& no_vary_search_hint);

  // Invalidates a pipeline with `canonical_url`.
  //
  // Returns true iff invalidated successfully.
  bool InvalidatePipelineForTesting(GURL canonical_url);

 private:
  friend content::WebContentsUserData<SearchPreloadPipelineManager>;
  WEB_CONTENTS_USER_DATA_KEY_DECL();
  explicit SearchPreloadPipelineManager(content::WebContents* contents);

  void EraseNotAlivePipelines();

  // Returns `(singal_result_prefetch, signal_result_prerender)`.
  std::tuple<std::optional<SearchPreloadSignalResult>,
             std::optional<SearchPreloadSignalResult>>
  OnAutocompleteResultChangedProcessOne(
      Profile& profile,
      base::WeakPtr<SearchPreloadService> search_preload_service,
      TemplateURLService& template_url_service,
      const AutocompleteMatch& match,
      const std::optional<net::HttpNoVarySearchData>& no_vary_search_hint);

  // Manages pipeline per canonical URL.
  base::flat_map<GURL, std::unique_ptr<SearchPreloadPipeline>> pipelines_;

  base::WeakPtrFactory<SearchPreloadPipelineManager> weak_factory_{this};
};

#endif  // CHROME_BROWSER_PRELOADING_SEARCH_PRELOAD_SEARCH_PRELOAD_PIPELINE_MANAGER_H_