File: notice_service.cc

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 (229 lines) | stat: -rw-r--r-- 7,364 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
// 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.

#include "chrome/browser/privacy_sandbox/notice/notice_service.h"

#include "chrome/browser/privacy_sandbox/notice/notice_catalog.h"
#include "chrome/browser/privacy_sandbox/notice/notice_model.h"
#include "chrome/browser/privacy_sandbox/notice/notice_storage.h"
#include "chrome/browser/profiles/profile.h"

namespace privacy_sandbox {

namespace {

using ::privacy_sandbox::notice::mojom::PrivacySandboxNotice;
using ::privacy_sandbox::notice::mojom::PrivacySandboxNoticeEvent;

using GroupKey = std::variant<std::monostate, NoticeViewGroup, NoticeId>;

size_t CountTargetApis(base::span<Notice*> notices) {
  return std::accumulate(notices.begin(), notices.end(), 0,
                         [](size_t total, Notice* notice) {
                           return total + notice->target_apis().size();
                         });
}

int CompareNoticeGroups(base::span<Notice*> lhs, base::span<Notice*> rhs) {
  size_t lhs_api_count = CountTargetApis(lhs);
  size_t rhs_api_count = CountTargetApis(rhs);

  // 1: The group targeting more APIs wins.
  if (lhs_api_count != rhs_api_count) {
    return (lhs_api_count > rhs_api_count) ? 1 : -1;
  }

  // 2: If unique API counts are the same, the group with fewer
  // notices wins.
  if (lhs.size() != rhs.size()) {
    return (lhs.size() < rhs.size()) ? 1 : -1;
  }

  // Otherwise, the groups are considered equal by these criteria.
  return 0;
}

std::set<NoticeApi*> GetEligibleApis(base::span<NoticeApi*> apis) {
  // Consider only APIs that are Enabled, have some level of
  // eligibility, and weren't already fulfilled in the past.
  std::set<NoticeApi*> filtered_apis;
  for (auto api : apis) {
    // TODO(crbug.com/417725558) Right now, we assume that all APIs are their
    // latest versions. Add support for getting the latest enabled API version
    // when versions are supported.
    if (!api->IsEnabled()) {
      continue;
    }
    if (api->GetEligibilityLevel() == EligibilityLevel::kNotEligible) {
      continue;
    }

    // TODO(crbug.com/417733694) This actually does some redundant work:
    // Refetches the eligibility, Ideally, this should be pushed once by the ps
    // service, and should be cached here.
    if (api->IsFulfilled()) {
      continue;
    }
    filtered_apis.insert(api);
  }
  return filtered_apis;
}

std::map<GroupKey, std::vector<Notice*>> GetEligibleNotices(
    SurfaceType surface,
    std::set<NoticeApi*> filtered_apis,
    base::span<Notice*> notices) {
  // From all of the available Notices, keep only ones that
  //    - Target the requested surface
  //    - Haven't yet been fulfilled
  //    - Are Enabled
  //    - Based on the eligibility, can fulfill all of its target APIs
  //    - Do not contain any target APIs not present in the filtered list.
  // The Notices are grouped if they have an assigned group. Otherwise, they are
  // in their own group.
  std::map<GroupKey, std::vector<Notice*>> grouped_notices;
  for (Notice* notice : notices) {
    if (auto [_, s] = notice->notice_id(); s != surface) {
      continue;
    }
    if (notice->was_fulfilled()) {
      continue;
    }
    if (!notice->IsEnabled()) {
      continue;
    }

    // TODO(crbug.com/417727236) Run the exclusion callback that each notice
    // defines.

    // Check that ALL target APIs are fulfillable by the notice.
    if (!notice->CanFulfillAllTargetApis()) {
      continue;
    }

    // Check if all target APIs are in the filtered list.
    if (std::ranges::any_of(notice->target_apis(),
                            [&filtered_apis](NoticeApi* target_api) {
                              return !filtered_apis.contains(target_api);
                            })) {
      continue;
    }

    // Notice is eligible at this point. Add it to its group.
    if (notice->view_group().first != NoticeViewGroup::kNotSet) {
      grouped_notices[{notice->view_group().first}].push_back(notice);
    } else {
      grouped_notices[{notice->notice_id()}].push_back(notice);
    }
  }
  return grouped_notices;
}

GroupKey GetBestGroupKey(
    std::map<GroupKey, std::vector<Notice*>>& grouped_notices) {
  // Choosing the best group based on the which group covers the most apis with
  // the least number of notices.
  GroupKey best_group_key;
  for (auto& [group, notices] : grouped_notices) {
    if (best_group_key.index() == 0 ||
        CompareNoticeGroups(notices, grouped_notices[best_group_key]) > 0) {
      best_group_key = group;
    }
  }

  return best_group_key;
}

}  // namespace

PrivacySandboxNoticeService::PrivacySandboxNoticeService(
    Profile* profile,
    std::unique_ptr<NoticeCatalog> catalog,
    std::unique_ptr<NoticeStorage> storage)
    : profile_(profile),
      catalog_(std::move(catalog)),
      notice_storage_(std::move(storage)) {
  CHECK(profile_);
  CHECK(notice_storage_);
  CHECK(catalog_);

#if !BUILDFLAG(IS_ANDROID)
  desktop_view_manager_ = std::make_unique<DesktopViewManager>(this);
  CHECK(desktop_view_manager_);
#endif  // !BUILDFLAG(IS_ANDROID)

  // Refresh fulfillment status for all notices at service initialization.
  for (Notice* notice : catalog_->GetNotices()) {
    CHECK(notice);
    notice->RefreshFulfillmentStatus(*notice_storage_);
  }

  EmitStartupHistograms();
}

PrivacySandboxNoticeService::~PrivacySandboxNoticeService() = default;

void PrivacySandboxNoticeService::Shutdown() {
  profile_ = nullptr;
  notice_storage_ = nullptr;
  catalog_ = nullptr;
}

void PrivacySandboxNoticeService::EventOccurred(
    NoticeId notice_id,
    PrivacySandboxNoticeEvent event) {
  notice_storage()->RecordEvent(notice_id, event);

  Notice* notice = catalog_->GetNotice(notice_id);
  CHECK(notice);

  // Refresh fulfillment status after an event has occurred.
  notice->RefreshFulfillmentStatus(*notice_storage());
  notice->UpdateTargetApiResults(event);
}

std::vector<PrivacySandboxNotice>
PrivacySandboxNoticeService::GetRequiredNotices(SurfaceType surface) {
  // Step 1: Filtering APIs.
  std::set<NoticeApi*> filtered_apis =
      GetEligibleApis(catalog_->GetNoticeApis());

  // Step 2: Finding Notices for the surface type, and the filtered APIs.
  auto grouped_notices = GetEligibleNotices(surface, std::move(filtered_apis),
                                            catalog_->GetNotices());

  // Step 3: Scoring.
  GroupKey best_group_key = GetBestGroupKey(grouped_notices);

  if (best_group_key.index() == 0) {
    return {};
  }

  // Step 4: Sort and return.
  // Now we have the best group, sort and return.
  std::vector<Notice*>& best_group = grouped_notices[best_group_key];
  std::sort(best_group.begin(), best_group.end(), [](Notice* a, Notice* b) {
    return a->view_group().second < b->view_group().second;
  });

  std::vector<PrivacySandboxNotice> required_notices;
  for (Notice* notice : best_group) {
    required_notices.push_back(notice->notice_id().first);
  }

  return required_notices;
}

void PrivacySandboxNoticeService::EmitStartupHistograms() {
  notice_storage()->RecordStartupHistograms();
}

#if !BUILDFLAG(IS_ANDROID)
DesktopViewManagerInterface*
PrivacySandboxNoticeService::GetDesktopViewManager() {
  return desktop_view_manager_.get();
}
#endif  // !BUILDFLAG(IS_ANDROID)

}  // namespace privacy_sandbox