File: consent_throttle_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 (174 lines) | stat: -rw-r--r-- 6,761 bytes parent folder | download | duplicates (9)
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
// 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.

#include "components/unified_consent/consent_throttle.h"
#include <memory>

#include "base/run_loop.h"
#include "base/test/bind.h"
#include "base/test/task_environment.h"
#include "components/unified_consent/url_keyed_data_collection_consent_helper.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace unified_consent {
namespace {

class TestUrlKeyedDataCollectionConsentHelper
    : public UrlKeyedDataCollectionConsentHelper {
 public:
  void SetConsentStateAndFireNotification(State state) {
    consent_state_ = state;
    FireOnStateChanged();
  }

  // UrlKeyedCollectionConsentHelper:
  State GetConsentState() override { return consent_state_; }

 private:
  State consent_state_ = State::kInitializing;
};

class ConsentThrottleTest : public testing::Test {
 protected:
  bool GetResultSynchronously(ConsentThrottle* throttle) {
    std::optional<bool> out_result;
    throttle->EnqueueRequest(
        base::BindLambdaForTesting([&](bool result) { out_result = result; }));
    EXPECT_TRUE(out_result.has_value())
        << "The throttle must have run the callback.";
    return *out_result;
  }

  base::test::TaskEnvironment task_environment_{
      base::test::SingleThreadTaskEnvironment::TimeSource::MOCK_TIME};
};

TEST_F(ConsentThrottleTest, EnabledAndDisabledRunSynchronously) {
  auto helper = std::make_unique<TestUrlKeyedDataCollectionConsentHelper>();
  helper->SetConsentStateAndFireNotification(
      UrlKeyedDataCollectionConsentHelper::State::kDisabled);

  auto* helper_ptr = helper.get();

  auto consent_throttle = ConsentThrottle(std::move(helper));
  EXPECT_FALSE(GetResultSynchronously(&consent_throttle));

  helper_ptr->SetConsentStateAndFireNotification(
      UrlKeyedDataCollectionConsentHelper::State::kEnabled);
  EXPECT_TRUE(GetResultSynchronously(&consent_throttle));
}

TEST_F(ConsentThrottleTest, ExpireOldRequests) {
  auto helper = std::make_unique<TestUrlKeyedDataCollectionConsentHelper>();
  ASSERT_EQ(helper->GetConsentState(),
            UrlKeyedDataCollectionConsentHelper::State::kInitializing);

  auto consent_throttle = ConsentThrottle(std::move(helper));
  std::vector<bool> results;
  consent_throttle.EnqueueRequest(base::BindLambdaForTesting(
      [&](bool result) { results.push_back(result); }));

  EXPECT_TRUE(results.empty()) << "Callback should not be run immediately.";
  task_environment_.FastForwardBy(base::Seconds(3));
  EXPECT_TRUE(results.empty()) << "Callback should not be run after 3 seconds.";

  // Add another request while the first request is still pending.
  consent_throttle.EnqueueRequest(base::BindLambdaForTesting(
      [&](bool result) { results.push_back(result); }));

  task_environment_.FastForwardBy(base::Seconds(5));
  ASSERT_EQ(results.size(), 2U) << "Both callbacks should expire as false.";
  EXPECT_FALSE(results[0]);
  EXPECT_FALSE(results[1]);

  // Enqueuing another one should restart the timer, which should expire after
  // a second delay of 5 seconds.
  consent_throttle.EnqueueRequest(base::BindLambdaForTesting(
      [&](bool result) { results.push_back(result); }));
  EXPECT_EQ(results.size(), 2U) << "Callback should not be run immediately.";
  task_environment_.FastForwardBy(base::Seconds(3));
  EXPECT_EQ(results.size(), 2U);
  task_environment_.FastForwardBy(base::Seconds(3));
  ASSERT_EQ(results.size(), 3U);
  EXPECT_FALSE(results[2]);
}

TEST_F(ConsentThrottleTest, InitializationFulfillsAllQueuedRequests) {
  auto helper = std::make_unique<TestUrlKeyedDataCollectionConsentHelper>();
  ASSERT_EQ(helper->GetConsentState(),
            UrlKeyedDataCollectionConsentHelper::State::kInitializing);

  auto* helper_ptr = helper.get();
  auto consent_throttle = ConsentThrottle(std::move(helper));

  // Enqueue two requests, 2 seconds apart.
  std::vector<bool> results;
  consent_throttle.EnqueueRequest(base::BindLambdaForTesting(
      [&](bool result) { results.push_back(result); }));
  ASSERT_TRUE(results.empty());
  task_environment_.FastForwardBy(base::Seconds(2));
  consent_throttle.EnqueueRequest(base::BindLambdaForTesting(
      [&](bool result) { results.push_back(result); }));
  ASSERT_TRUE(results.empty()) << "Still nothing should be run yet.";

  helper_ptr->SetConsentStateAndFireNotification(
      UrlKeyedDataCollectionConsentHelper::State::kEnabled);
  ASSERT_EQ(results.size(), 2U)
      << "Requests should have been immediately fulfilled as true.";
  EXPECT_TRUE(results[0]);
  EXPECT_TRUE(results[1]);
}

TEST_F(ConsentThrottleTest, InitializationDisabledCase) {
  auto helper = std::make_unique<TestUrlKeyedDataCollectionConsentHelper>();
  ASSERT_EQ(helper->GetConsentState(),
            UrlKeyedDataCollectionConsentHelper::State::kInitializing);

  auto* helper_ptr = helper.get();
  auto consent_throttle = ConsentThrottle(std::move(helper));

  std::vector<bool> results;
  consent_throttle.EnqueueRequest(base::BindLambdaForTesting(
      [&](bool result) { results.push_back(result); }));
  ASSERT_TRUE(results.empty());

  helper_ptr->SetConsentStateAndFireNotification(
      UrlKeyedDataCollectionConsentHelper::State::kDisabled);
  ASSERT_EQ(results.size(), 1U);
  EXPECT_FALSE(results[0]);
}

// In production, sometimes the callback to a request enqueues a new request.
// This tests this case and fixes the crash in https://crbug.com/1483454.
TEST_F(ConsentThrottleTest, CallbacksMakingNewRequests) {
  auto helper = std::make_unique<TestUrlKeyedDataCollectionConsentHelper>();
  ASSERT_EQ(helper->GetConsentState(),
            UrlKeyedDataCollectionConsentHelper::State::kInitializing);

  auto consent_throttle = ConsentThrottle(std::move(helper));
  std::vector<bool> results;

  // These two blocks are identical. The crash is reliably triggered when
  // adding two of these. Probably having two pushes the vector to reallocate
  // while iterating.
  consent_throttle.EnqueueRequest(base::BindLambdaForTesting([&](bool result) {
    results.push_back(result);
    consent_throttle.EnqueueRequest(base::BindLambdaForTesting(
        [&](bool result2) { results.push_back(result2); }));
  }));
  consent_throttle.EnqueueRequest(base::BindLambdaForTesting([&](bool result) {
    results.push_back(result);
    consent_throttle.EnqueueRequest(base::BindLambdaForTesting(
        [&](bool result2) { results.push_back(result2); }));
  }));

  // New requests added during iteration live as long as the NEXT timeout.
  task_environment_.FastForwardBy(base::Seconds(6));
  EXPECT_EQ(results.size(), 2U);
  task_environment_.FastForwardBy(base::Seconds(6));
  EXPECT_EQ(results.size(), 4U);
}

}  // namespace
}  // namespace unified_consent