File: recent_session_tracker_unittest.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 (285 lines) | stat: -rw-r--r-- 9,516 bytes parent folder | download | duplicates (3)
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
// Copyright 2024 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/user_education/recent_session_tracker.h"

#include <memory>
#include <optional>
#include <vector>

#include "base/callback_list.h"
#include "base/memory/raw_ref.h"
#include "base/test/bind.h"
#include "base/test/simple_test_clock.h"
#include "base/time/time.h"
#include "chrome/browser/user_education/browser_user_education_storage_service.h"
#include "components/user_education/common/session/user_education_session_manager.h"
#include "components/user_education/common/user_education_data.h"
#include "components/user_education/common/user_education_storage_service.h"
#include "components/user_education/test/test_user_education_storage_service.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace {

// At some point these may need to be moved to a common header file.

// Short-circuits all of the functionality of the session manager except for
// updating session data and sending notifications.
class FakeSessionManager
    : protected user_education::UserEducationSessionManager {
 public:
  explicit FakeSessionManager(
      user_education::UserEducationStorageService& storage_service)
      : storage_service_(storage_service) {}
  ~FakeSessionManager() override = default;

  // Simulates a new session at the current time provided by the storage
  // service's clock.
  void SimulateNewSession() {
    const auto old_session = storage_service_->ReadSessionData();
    const auto now = storage_service_->GetCurrentTime();
    user_education::UserEducationSessionData new_session =
        storage_service_->ReadSessionData();
    new_session.most_recent_active_time = now;
    new_session.start_time = now;
    ++new_session.session_number;
    storage_service_->SaveSessionData(new_session);
    OnNewSession(old_session.start_time, old_session.most_recent_active_time,
                 now);
  }

  user_education::UserEducationSessionManager& AsSessionManager() {
    return *static_cast<user_education::UserEducationSessionManager*>(this);
  }

 private:
  const raw_ref<user_education::UserEducationStorageService> storage_service_;
};

// Implementation of `RecentSessionDataStorageService` that extends
// `TestUserEducationStorageService` with in-memory data storage.
class TestBrowserStorageService
    : public user_education::test::TestUserEducationStorageService,
      public RecentSessionDataStorageService {
 public:
  TestBrowserStorageService() = default;
  ~TestBrowserStorageService() override = default;

  RecentSessionData ReadRecentSessionData() const override {
    RecentSessionData data;
    data.recent_session_start_times = recent_sessions_;
    data.enabled_time = enabled_time_;
    return data;
  }

  void SaveRecentSessionData(const RecentSessionData& data) override {
    recent_sessions_ = data.recent_session_start_times;
    enabled_time_ = data.enabled_time;
  }

 private:
  std::vector<base::Time> recent_sessions_;
  std::optional<base::Time> enabled_time_;
};

base::Time Days(double d) {
  return base::Time::FromSecondsSinceUnixEpoch(d * 24 * 60 * 60);
}

}  // namespace

class RecentSessionTrackerTest : public testing::Test {
 public:
  RecentSessionTrackerTest() {
    storage_service_.set_clock_for_testing(&clock_);
  }
  ~RecentSessionTrackerTest() override = default;

  // Sets up the data for the test.
  //  - saves a list of `old_sessions` to the storage service
  //  - optionally starts a new session in the current process
  //  - creates the tracker and initializes it
  //
  // Use `session_before_tracker_init` if you want to simulate a session
  // starting before the tracker is created; otherwise you can call
  // `StartNewSession()` to create a new session later.
  void Init(const std::vector<base::Time>& old_sessions,
            std::optional<base::Time> session_before_tracker_init) {
    RecentSessionData data;
    data.recent_session_start_times = old_sessions;
    if (!old_sessions.empty()) {
      data.enabled_time = old_sessions.back();
    }
    storage_service_.SaveRecentSessionData(data);
    if (session_before_tracker_init) {
      StartNewSession(*session_before_tracker_init);
    }
    tracker_ = std::make_unique<RecentSessionTracker>(
        session_manager_.AsSessionManager(), storage_service_,
        storage_service_);
    update_subscription_ = tracker_->AddRecentSessionsUpdatedCallback(
        base::BindLambdaForTesting([this](const RecentSessionData& data) {
          ++update_count_;
          last_update_data_ = data;
        }));
  }

  // Starts a new session at `session_time`.
  void StartNewSession(base::Time session_time) {
    clock_.SetNow(session_time);
    session_manager_.SimulateNewSession();
  }

  void EnsureRecentSessions(const std::vector<base::Time>& expected_data,
                            int expected_update_count) const {
    const auto recent_sessions = storage_service_.ReadRecentSessionData();
    EXPECT_THAT(recent_sessions.recent_session_start_times,
                testing::ContainerEq(expected_data));
    EXPECT_EQ(expected_update_count, update_count_);
    if (last_update_data_) {
      EXPECT_THAT(last_update_data_->recent_session_start_times,
                  testing::ContainerEq(expected_data));
    }
    EXPECT_EQ(expected_update_count > 0,
              tracker_->recent_session_data_for_testing().has_value());
    if (tracker_->recent_session_data_for_testing().has_value()) {
      EXPECT_THAT(tracker_->recent_session_data_for_testing()
                      ->recent_session_start_times,
                  testing::ContainerEq(expected_data));
    }
    ASSERT_EQ(!recent_sessions.recent_session_start_times.empty(),
              recent_sessions.enabled_time.has_value());
    if (recent_sessions.enabled_time) {
      EXPECT_LE(*recent_sessions.enabled_time,
                recent_sessions.recent_session_start_times.back());
    }
  }

 private:
  base::SimpleTestClock clock_;
  TestBrowserStorageService storage_service_;
  FakeSessionManager session_manager_{storage_service_};
  std::unique_ptr<RecentSessionTracker> tracker_;
  int update_count_ = 0;
  std::optional<RecentSessionData> last_update_data_;
  base::CallbackListSubscription update_subscription_;
};

TEST_F(RecentSessionTrackerTest, NoNewSession) {
  const std::vector<base::Time> old_sessions{
      Days(102),
      Days(101),
      Days(100),
  };
  Init(old_sessions, std::nullopt);
  EnsureRecentSessions(old_sessions, 0);
}

TEST_F(RecentSessionTrackerTest, NewSessionBeforeInit) {
  std::vector<base::Time> sessions{
      Days(102),
      Days(101),
      Days(100),
  };
  Init(sessions, Days(103));
  sessions.insert(sessions.begin(), Days(103));
  EnsureRecentSessions(sessions, 1);
}

TEST_F(RecentSessionTrackerTest, NewSessionAfterInit) {
  std::vector<base::Time> sessions{
      Days(102),
      Days(101),
      Days(100),
  };
  Init(sessions, std::nullopt);
  StartNewSession(Days(103));
  sessions.insert(sessions.begin(), Days(103));
  EnsureRecentSessions(sessions, 1);
}

TEST_F(RecentSessionTrackerTest, OldSessionsRollOff) {
  std::vector<base::Time> sessions{
      Days(103),
      Days(102),
      Days(101),
      Days(100),
  };

  // Move forward enough that the first two entries roll out of the window.
  const base::Time time1 = Days(102) +
                           RecentSessionTracker::kMaxRecentSessionRetention -
                           base::Seconds(1);
  Init(sessions, time1);
  sessions = {
      time1,
      Days(103),
      Days(102),
  };
  EnsureRecentSessions(sessions, 1);

  // Move forward enough to cause the next entry to roll off.
  const base::Time time2 = time1 + base::Seconds(2);
  StartNewSession(time2);
  sessions = {
      time2,
      time1,
      Days(103),
  };
  EnsureRecentSessions(sessions, 2);

  // Move forward enough to cause all entries but the current one to roll off.
  const base::Time time3 = time2 +
                           RecentSessionTracker::kMaxRecentSessionRetention +
                           base::Seconds(1);
  StartNewSession(time3);
  sessions = {time3};
  EnsureRecentSessions(sessions, 3);
}

TEST_F(RecentSessionTrackerTest, TooManySessionsRollOff) {
  // Create a list of sessions of max length.
  std::vector<base::Time> sessions;
  for (int i = RecentSessionTracker::kMaxRecentSessionRecords; i > 0; i--) {
    sessions.push_back(Days(100 + i));
  }

  // Add a new session; the last session should roll off.
  const base::Time time1 = sessions.front() + base::Days(1);
  Init(sessions, time1);
  sessions.pop_back();
  sessions.insert(sessions.begin(), time1);
  EnsureRecentSessions(sessions, 1);

  // Add a new session; the last session should roll off.
  const base::Time time2 = time1 + base::Days(1);
  StartNewSession(time2);
  sessions.pop_back();
  sessions.insert(sessions.begin(), time2);
  EnsureRecentSessions(sessions, 2);
}

TEST_F(RecentSessionTrackerTest, ClockSetBackElidesValues) {
  std::vector<base::Time> sessions{
      Days(104),
      Days(103),
      Days(101),
      Days(100),
  };
  Init(sessions, Days(102));
  sessions = {
      Days(102),
      Days(101),
      Days(100),
  };
  EnsureRecentSessions(sessions, 1);
}

TEST_F(RecentSessionTrackerTest, EnabledForTheFirstTime) {
  Init({}, std::nullopt);
  EnsureRecentSessions({}, 0);
  StartNewSession(Days(100));
  EnsureRecentSessions({Days(100)}, 1);
}