File: glic_page_context_eligibility_observer.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (88 lines) | stat: -rw-r--r-- 3,197 bytes parent folder | download | duplicates (2)
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
// 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_GLIC_HOST_CONTEXT_GLIC_PAGE_CONTEXT_ELIGIBILITY_OBSERVER_H_
#define CHROME_BROWSER_GLIC_HOST_CONTEXT_GLIC_PAGE_CONTEXT_ELIGIBILITY_OBSERVER_H_

#include <optional>
#include <variant>

#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "components/optimization_guide/core/optimization_guide_decision.h"
#include "content/public/browser/web_contents_observer.h"

namespace content {
class WebContents;
}  // namespace content

namespace optimization_guide {
class OptimizationMetadata;
}  // namespace optimization_guide

class OptimizationGuideKeyedService;

namespace glic {

// A class to handle whether a page is eligible for context sharing with GLIC.
class GlicPageContextEligibilityObserver : public content::WebContentsObserver {
 public:
  ~GlicPageContextEligibilityObserver() override;
  GlicPageContextEligibilityObserver(
      const GlicPageContextEligibilityObserver&) = delete;
  GlicPageContextEligibilityObserver& operator=(
      const GlicPageContextEligibilityObserver&) = delete;

  // Creates a `GlicPageContextEligibilityObserver` if eligible.
  static std::unique_ptr<GlicPageContextEligibilityObserver>
  MaybeCreateForWebContents(content::WebContents* web_contents);

  // Gets eligibility for `web_contents` if allowed. Returns whether callback
  // was actually registered. If registered, `eligibility_callback` is
  // guaranteed to be invoked.
  static bool MaybeGetEligibilityForWebContents(
      content::WebContents* web_contents,
      base::OnceCallback<void(bool)> eligibility_callback);

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

  // Gets the eligibility for the current page.
  void GetEligibility(base::OnceCallback<void(bool)> eligibility_callback);

 private:
  GlicPageContextEligibilityObserver(
      content::WebContents* web_contents,
      OptimizationGuideKeyedService* optimization_guide_keyed_service);

  // Callback invoked when eligibility result has returned.
  void OnEligibilityResult(
      const GURL& url,
      optimization_guide::OptimizationGuideDecision decision,
      const optimization_guide::OptimizationMetadata& metadata);

  // Notifies callbacks with `is_eligible`.
  void NotifyCallbacks(bool is_eligible);

  // Tracks whether the current main-frame navigation is eligible.
  std::optional<bool> is_eligible_;
  bool is_currently_waiting_ = false;

  // Tracks any outstanding requests for eligibility.
  // Note that we do not use a `base::CallbackList` here to have some more
  // control since CallbackList does not have a Reset function.
  std::vector<base::OnceCallback<void(bool)>> eligibility_callbacks_;

  // Not owned.
  raw_ptr<OptimizationGuideKeyedService> optimization_guide_keyed_service_;

  base::WeakPtrFactory<GlicPageContextEligibilityObserver> weak_ptr_factory_{
      this};
};

}  // namespace glic

#endif  // CHROME_BROWSER_GLIC_HOST_CONTEXT_GLIC_PAGE_CONTEXT_ELIGIBILITY_OBSERVER_H_