File: background_sync_metrics.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 (94 lines) | stat: -rw-r--r-- 3,258 bytes parent folder | download | duplicates (6)
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
89
90
91
92
93
94
// Copyright 2019 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_BACKGROUND_SYNC_BACKGROUND_SYNC_METRICS_H_
#define COMPONENTS_BACKGROUND_SYNC_BACKGROUND_SYNC_METRICS_H_

#include <optional>

#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "third_party/blink/public/common/service_worker/service_worker_status_code.h"

namespace {
// Exponential bucket spacing for UKM event data.
constexpr double kUkmEventDataBucketSpacing = 2.0;
}  // namespace

namespace background_sync {
class BackgroundSyncDelegate;
}  // namespace background_sync

namespace url {
class Origin;
}  // namespace url

// Lives entirely on the UI thread.
class BackgroundSyncMetrics {
 public:
  using RecordCallback = base::OnceCallback<void(ukm::SourceId)>;

  explicit BackgroundSyncMetrics(
      background_sync::BackgroundSyncDelegate* delegate);

  BackgroundSyncMetrics(const BackgroundSyncMetrics&) = delete;
  BackgroundSyncMetrics& operator=(const BackgroundSyncMetrics&) = delete;

  ~BackgroundSyncMetrics();

  void MaybeRecordOneShotSyncRegistrationEvent(const url::Origin& origin,
                                               bool can_fire,
                                               bool is_reregistered);

  void MaybeRecordPeriodicSyncRegistrationEvent(const url::Origin& origin,
                                                int min_interval,
                                                bool is_reregistered);

  void MaybeRecordOneShotSyncCompletionEvent(
      const url::Origin& origin,
      blink::ServiceWorkerStatusCode status_code,
      int num_attempts,
      int max_attempts);

  void MaybeRecordPeriodicSyncEventCompletion(
      const url::Origin& origin,
      blink::ServiceWorkerStatusCode status_code,
      int num_attempts,
      int max_attempts);

 private:
  friend class BackgroundSyncMetricsBrowserTest;

  void DidGetBackgroundSourceId(RecordCallback record_callback,
                                std::optional<ukm::SourceId> source_id);

  void RecordOneShotSyncRegistrationEvent(bool can_fire,
                                          bool is_reregistered,
                                          ukm::SourceId source_id);
  void RecordPeriodicSyncRegistrationEvent(int min_interval,
                                           bool is_reregistered,
                                           ukm::SourceId source_id);

  void RecordOneShotSyncCompletionEvent(
      blink::ServiceWorkerStatusCode status_code,
      int num_attempts,
      int max_attempts,
      ukm::SourceId source_id);
  void RecordPeriodicSyncEventCompletion(
      blink::ServiceWorkerStatusCode status_code,
      int num_attempts,
      int max_attempts,
      ukm::SourceId source_id);

  raw_ptr<background_sync::BackgroundSyncDelegate, DanglingUntriaged> delegate_;

  // Used to signal tests that a UKM event has been recorded.
  base::OnceClosure ukm_event_recorded_for_testing_;

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

#endif  // COMPONENTS_BACKGROUND_SYNC_BACKGROUND_SYNC_METRICS_H_