File: private_aggregation.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 (124 lines) | stat: -rw-r--r-- 4,809 bytes parent folder | download | duplicates (5)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
// 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 THIRD_PARTY_BLINK_RENDERER_MODULES_SHARED_STORAGE_PRIVATE_AGGREGATION_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_SHARED_STORAGE_PRIVATE_AGGREGATION_H_

#include <stdint.h>

#include "mojo/public/cpp/bindings/pending_remote.h"
#include "third_party/blink/public/mojom/aggregation_service/aggregatable_report.mojom-blink.h"
#include "third_party/blink/public/mojom/private_aggregation/private_aggregation_host.mojom-blink.h"
#include "third_party/blink/public/mojom/shared_storage/shared_storage_worklet_service.mojom-blink-forward.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/modules/shared_storage/util.h"
#include "third_party/blink/renderer/platform/bindings/script_wrappable.h"
#include "third_party/blink/renderer/platform/context_lifecycle_notifier.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_map.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/heap/visitor.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_remote.h"

namespace blink {

class ExceptionState;
class PrivateAggregationDebugModeOptions;
class PrivateAggregationHistogramContribution;
class ScriptState;
class SharedStorageWorkletGlobalScope;

class MODULES_EXPORT PrivateAggregation final : public ScriptWrappable {
  DEFINE_WRAPPERTYPEINFO();

 public:
  struct OperationState : public GarbageCollected<OperationState> {
    explicit OperationState(ContextLifecycleNotifier* notifier,
                            size_t filtering_id_max_bytes)
        : filtering_id_max_bytes(filtering_id_max_bytes),
          private_aggregation_host(notifier) {
      CHECK_LE(filtering_id_max_bytes, kMaximumFilteringIdMaxBytes);
    }

    bool enable_debug_mode_called = false;
    size_t filtering_id_max_bytes;

    // No need to be associated as message ordering (relative to shared storage
    // operations) is unimportant.
    HeapMojoRemote<mojom::blink::PrivateAggregationHost>
        private_aggregation_host;

    // Contributions that should be forwarded if and only if an uncaught
    // exception occurs.
    Vector<mojom::blink::AggregatableReportHistogramContributionPtr>
        contributions_conditional_on_uncaught_error;

    void Trace(Visitor* visitor) const {
      visitor->Trace(private_aggregation_host);
    }
  };

  // Indicates whether the operation was terminated due to an uncaught error or
  // not.
  enum class TerminationStatus {
    kNoUncaughtError,
    kUncaughtError,
  };

  explicit PrivateAggregation(SharedStorageWorkletGlobalScope* global_scope);

  ~PrivateAggregation() override;

  void Trace(Visitor*) const override;

  // PrivateAggregation IDL
  void contributeToHistogram(ScriptState*,
                             const PrivateAggregationHistogramContribution*,
                             ExceptionState&);
  void contributeToHistogramOnEvent(
      ScriptState*,
      const String&,
      const PrivateAggregationHistogramContribution*,
      ExceptionState&);
  void enableDebugMode(ScriptState*, ExceptionState&);
  void enableDebugMode(ScriptState*,
                       const PrivateAggregationDebugModeOptions*,
                       ExceptionState&);

  void OnOperationStarted(
      int64_t operation_id,
      mojom::blink::PrivateAggregationOperationDetailsPtr pa_operation_details);
  void OnOperationFinished(int64_t operation_id,
                           TerminationStatus termination_status);

  void OnWorkletDestroyed();

 private:
  // Returns the parsed contribution. In the case of an exception, throws the
  // exception using `exception_state` and returns `nullpr`.
  mojom::blink::AggregatableReportHistogramContributionPtr ParseContribution(
      const PrivateAggregationHistogramContribution* contribution,
      ExceptionState& exception_state);

  OperationState& GetCurrentOperationState();

  void EnsureGeneralUseCountersAreRecorded();
  void EnsureEnableDebugModeUseCounterIsRecorded();
  void EnsureFilteringIdUseCounterIsRecorded();
  void EnsureErrorReportingUseCounterIsRecorded();

  bool has_recorded_general_use_counters_ = false;
  bool has_recorded_enable_debug_mode_use_counter_ = false;
  bool has_recorded_filtering_id_use_counter_ = false;
  bool has_recorded_error_reporting_use_counter_ = false;

  Member<SharedStorageWorkletGlobalScope> global_scope_;
  HeapHashMap<int64_t,
              Member<OperationState>,
              IntWithZeroKeyHashTraits<int64_t>>
      operation_states_;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_MODULES_SHARED_STORAGE_PRIVATE_AGGREGATION_H_