File: dwa_entry_builder_base.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (63 lines) | stat: -rw-r--r-- 2,272 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
// 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 COMPONENTS_METRICS_DWA_DWA_ENTRY_BUILDER_BASE_H_
#define COMPONENTS_METRICS_DWA_DWA_ENTRY_BUILDER_BASE_H_

#include <cstdint>
#include <optional>
#include <string>
#include <unordered_map>

#include "components/metrics/dwa/dwa_recorder.h"
#include "components/metrics/dwa/mojom/dwa_interface.mojom.h"

namespace dwa::internal {

// An internal base class for the generated DwaEntry builder objects and the
// DwaEntryBuilder class. DwaEntryBuilder is reserved for the case where it is
// not appropriate to use the auto-generated class. This class should not be
// used directly.
class DwaEntryBuilderBase {
 public:
  DwaEntryBuilderBase(const DwaEntryBuilderBase&) = delete;
  DwaEntryBuilderBase(DwaEntryBuilderBase&&);
  DwaEntryBuilderBase& operator=(const DwaEntryBuilderBase&) = delete;
  DwaEntryBuilderBase& operator=(DwaEntryBuilderBase&&);

  virtual ~DwaEntryBuilderBase();

  // Records the complete entry into the recorder. If recorder is null, the
  // entry is simply discarded. The |entry_| is used up by this call so
  // further calls to this will do nothing.
  void Record(metrics::dwa::DwaRecorder* recorder);

  // Return a pointer to internal DwaEntryPtr for testing.
  metrics::dwa::mojom::DwaEntryPtr* GetEntryForTesting();

  // Sanitizes `content` and returns the sanitized content as a string. For
  // contents which are URLs, the eTLD+1 domain is returned. All content URLs
  // logged by DWA are required to be eTLD+1.
  static std::string SanitizeContent(std::string_view content);

 protected:
  explicit DwaEntryBuilderBase(uint64_t event_hash);

  // Sets the content to the entry. The content is represented as a
  // hash.
  void SetContentInternal(uint64_t content_hash);

  // Add metric to the entry. A metric contains a metric hash and value.
  void SetMetricInternal(uint64_t metric_hash, int64_t value);

  // Add study name to the set of studies of interest.
  void AddToStudiesOfInterestInternal(std::string_view study_name);

 private:
  metrics::dwa::mojom::DwaEntryPtr entry_;
};

}  // namespace dwa::internal

#endif  // COMPONENTS_METRICS_DWA_DWA_ENTRY_BUILDER_BASE_H_