File: event_model_impl.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 (242 lines) | stat: -rw-r--r-- 8,116 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
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
230
231
232
233
234
235
236
237
238
239
240
241
242
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/feature_engagement/internal/event_model_impl.h"

#include <map>
#include <memory>
#include <string>
#include <vector>

#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/memory/weak_ptr.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "components/feature_engagement/internal/event_model.h"
#include "components/feature_engagement/internal/event_storage_validator.h"
#include "components/feature_engagement/internal/event_store.h"

namespace feature_engagement {

EventModelImpl::EventModelImpl(
    std::unique_ptr<EventStore> store,
    std::unique_ptr<EventStorageValidator> storage_validator)
    : store_(std::move(store)),
      storage_validator_(std::move(storage_validator)),
      ready_(false) {}

EventModelImpl::~EventModelImpl() = default;

void EventModelImpl::Initialize(OnModelInitializationFinished callback,
                                uint32_t current_day) {
  store_->Load(base::BindOnce(&EventModelImpl::OnStoreLoaded,
                              weak_factory_.GetWeakPtr(), std::move(callback),
                              current_day));
}

bool EventModelImpl::IsReady() const {
  return ready_;
}

const Event* EventModelImpl::GetEvent(const std::string& event_name) const {
  auto search = events_.find(event_name);
  if (search == events_.end())
    return nullptr;

  return &search->second;
}

uint32_t EventModelImpl::GetEventCount(const std::string& event_name,
                                       uint32_t current_day,
                                       uint32_t window_size) const {
  uint32_t event_count =
      GetEventCountOrSnooze(event_name, current_day, window_size,
                            /*is_snooze=*/false);
  uint32_t snooze_count =
      GetEventCountOrSnooze(event_name, current_day, window_size,
                            /*is_snooze=*/true);
  return event_count - snooze_count;
}

void EventModelImpl::IncrementEvent(const std::string& event_name,
                                    uint32_t current_day) {
  DCHECK(ready_);

  if (!storage_validator_->ShouldStore(event_name)) {
    DVLOG(2) << "Not incrementing event " << event_name << " @ " << current_day;
    return;
  }

  DVLOG(2) << "Incrementing event " << event_name << " @ " << current_day;

  Event& event = GetNonConstEvent(event_name);
  for (int i = 0; i < event.events_size(); ++i) {
    Event_Count* event_count = event.mutable_events(i);
    DCHECK(event_count->has_day());
    DCHECK(event_count->has_count());
    if (event_count->day() == current_day) {
      event_count->set_count(event_count->count() + 1);
      store_->WriteEvent(event);
      return;
    }
  }

  // Day not found for event, adding new day with a count of 1.
  Event_Count* event_count = event.add_events();
  event_count->set_day(current_day);
  event_count->set_count(1u);
  store_->WriteEvent(event);
}

void EventModelImpl::ClearEvent(const std::string& event_name) {
  DCHECK(ready_);

  Event& event = GetNonConstEvent(event_name);
  event.clear_events();
  store_->WriteEvent(event);
}

void EventModelImpl::IncrementSnooze(const std::string& event_name,
                                     uint32_t current_day,
                                     base::Time current_time) {
  DCHECK(ready_);

  DVLOG(2) << "Incrementing snooze for event  " << event_name << " on "
           << current_day << " @ " << current_time;

  Event& event = GetNonConstEvent(event_name);
  for (int i = 0; i < event.events_size(); ++i) {
    Event_Count* event_count = event.mutable_events(i);
    DCHECK(event_count->has_day());
    DCHECK(event_count->has_count());
    if (event_count->day() != current_day)
      continue;
    event_count->set_snooze_count(
        event_count->has_snooze_count() ? event_count->snooze_count() + 1 : 1u);
  }
  event.set_last_snooze_time_us(
      current_time.ToDeltaSinceWindowsEpoch().InMicroseconds());
  store_->WriteEvent(event);
}

void EventModelImpl::DismissSnooze(const std::string& event_name) {
  DCHECK(ready_);
  Event& event = GetNonConstEvent(event_name);
  event.set_snooze_dismissed(true);
  store_->WriteEvent(event);
}

base::Time EventModelImpl::GetLastSnoozeTimestamp(
    const std::string& event_name) const {
  const Event* event = GetEvent(event_name);

  // If the Event object is not found, return.
  if (!event)
    return base::Time();

  return base::Time::FromDeltaSinceWindowsEpoch(
      base::Microseconds(event->last_snooze_time_us()));
}

uint32_t EventModelImpl::GetSnoozeCount(const std::string& event_name,
                                        uint32_t window,
                                        uint32_t current_day) const {
  return GetEventCountOrSnooze(event_name, current_day, window,
                               /*is_snooze=*/true);
}

bool EventModelImpl::IsSnoozeDismissed(const std::string& event_name) const {
  const Event* event = GetEvent(event_name);
  return event ? event->snooze_dismissed() : false;
}

void EventModelImpl::OnStoreLoaded(OnModelInitializationFinished callback,
                                   uint32_t current_day,
                                   bool success,
                                   std::unique_ptr<std::vector<Event>> events) {
  if (!success) {
    std::move(callback).Run(false);
    return;
  }

  for (auto& event : *events) {
    DCHECK_NE("", event.name());

    Event new_event;
    for (const auto& event_count : event.events()) {
      if (!storage_validator_->ShouldKeep(event.name(), event_count.day(),
                                          current_day)) {
        continue;
      }

      Event_Count* new_event_count = new_event.add_events();
      new_event_count->set_day(event_count.day());
      new_event_count->set_count(event_count.count());
      new_event_count->set_snooze_count(event_count.snooze_count());
    }

    // Only keep Event object that have days with activity.
    if (new_event.events_size() > 0) {
      new_event.set_name(event.name());
      new_event.set_last_snooze_time_us(event.last_snooze_time_us());
      events_[event.name()] = new_event;

      // If the number of events is not the same, overwrite DB entry.
      if (new_event.events_size() != event.events_size())
        store_->WriteEvent(new_event);
    } else {
      // If there are no more activity for an Event, delete the whole event.
      store_->DeleteEvent(event.name());
    }
  }

  ready_ = true;
  std::move(callback).Run(true);
}

int EventModelImpl::GetEventCountOrSnooze(const std::string& event_name,
                                          int current_day,
                                          int window,
                                          bool is_snooze) const {
  const Event* event = GetEvent(event_name);

  // If the Event object is not found, or if the window is 0 days, there will
  // never be any events.
  if (!event || window == 0u)
    return 0;

  DCHECK(window >= 0);

  // A window of N=0:  Nothing should be counted.
  // A window of N=1:  |current_day| should be counted.
  // A window of N=2+: |current_day| plus |N-1| more days should be counted.
  uint32_t oldest_accepted_day = current_day - window + 1;

  // Cap |oldest_accepted_day| to UNIX epoch.
  if (window > current_day)
    oldest_accepted_day = 0u;

  // Calculate the number of events within the window.
  uint32_t count = 0;
  for (const auto& event_day : event->events()) {
    if (event_day.day() < oldest_accepted_day)
      continue;
    count += is_snooze ? event_day.snooze_count() : event_day.count();
  }

  return count;
}

Event& EventModelImpl::GetNonConstEvent(const std::string& event_name) {
  DCHECK_NE("", event_name);
  if (events_.find(event_name) == events_.end()) {
    // Event does not exist yet, so create it.
    events_[event_name].set_name(event_name);
    store_->WriteEvent(events_[event_name]);
  }
  return events_[event_name];
}

}  // namespace feature_engagement