File: site_manifest_metrics_task.h

package info (click to toggle)
chromium 135.0.7049.95-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 5,959,392 kB
  • sloc: cpp: 34,198,526; ansic: 7,100,035; javascript: 3,985,800; python: 1,395,489; asm: 896,754; xml: 722,891; pascal: 180,504; sh: 94,909; perl: 88,388; objc: 79,739; sql: 53,020; cs: 41,358; fortran: 24,137; makefile: 22,501; php: 13,699; tcl: 10,142; yacc: 8,822; ruby: 7,350; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; awk: 197; sed: 36
file content (70 lines) | stat: -rw-r--r-- 2,640 bytes parent folder | download | duplicates (10)
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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_WEBAPPS_BROWSER_INSTALLABLE_METRICS_SITE_MANIFEST_METRICS_TASK_H_
#define COMPONENTS_WEBAPPS_BROWSER_INSTALLABLE_METRICS_SITE_MANIFEST_METRICS_TASK_H_

#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ref.h"
#include "base/memory/weak_ptr.h"
#include "components/webapps/browser/installable/installable_data.h"
#include "mojo/public/cpp/bindings/struct_ptr.h"
#include "third_party/blink/public/mojom/manifest/manifest.mojom.h"

namespace content {
class WebContents;
}  // namespace content

namespace webapps {

// This class is responsible for gathing metrics for the given site on the given
// web contents to emit the "Site.Manifest" UKM events. To stop collection,
// simply destroy this object.
//
// Invariants:
// - `WebContents` is alive during its lifetime of this class.
// - `WebContents` is not navigated during the lifetime of this class and the
//   metrics gathered from it are valid for the `GetLastCommittedURL()`
//   retrieved on construction of this class.
//
// Browsertests are located in
// chrome/browser/web_applications/ml_promotion_browsertest.cc

class InstallableManager;
struct InstallableData;

class SiteManifestMetricsTask {
 public:
  using ResultCallback = base::OnceCallback<void(blink::mojom::ManifestPtr)>;
  ~SiteManifestMetricsTask();

  // Create the task, start collecting the manifest from the web_contents and
  // pass the task back to the MLInstallabilityPromoter. If the result of
  // fetching the manifest is that the URL changed, then we return an empty
  // manifest and the MLInstallabilityPromoter handles manifest URL changes.
  // If there is no manifest present, the callback runs with a nullptr.
  static std::unique_ptr<SiteManifestMetricsTask> CreateAndStart(
      content::WebContents& web_contents,
      ResultCallback collect_data_and_self_destruct_callback);

 private:
  SiteManifestMetricsTask(
      content::WebContents& web_contents,
      ResultCallback collect_data_and_self_destruct_callback);

  void Start();
  void OnDidFetchManifest(const InstallableData& data);

  blink::mojom::ManifestPtr manifest_;
  const raw_ref<content::WebContents> web_contents_;
  ResultCallback collect_data_and_self_destruct_callback_;
  raw_ptr<InstallableManager> manager_;

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

}  // namespace webapps

#endif  // COMPONENTS_WEBAPPS_BROWSER_INSTALLABLE_METRICS_SITE_MANIFEST_METRICS_TASK_H_