1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "components/invalidation/impl/registration_manager.h"
13 #include "base/basictypes.h"
14 #include "base/message_loop/message_loop.h"
15 #include "base/stl_util.h"
16 #include "components/invalidation/public/invalidation_util.h"
17 #include "google/cacheinvalidation/include/invalidation-client.h"
18 #include "testing/gtest/include/gtest/gtest.h"
23 // Fake registration manager that lets you override jitter.
24 class FakeRegistrationManager
: public RegistrationManager
{
26 explicit FakeRegistrationManager(
27 invalidation::InvalidationClient
* invalidation_client
)
28 : RegistrationManager(invalidation_client
),
31 ~FakeRegistrationManager() override
{}
33 void SetJitter(double jitter
) {
38 double GetJitter() override
{ return jitter_
; }
43 DISALLOW_COPY_AND_ASSIGN(FakeRegistrationManager
);
46 // Fake invalidation client that just stores the currently-registered
48 class FakeInvalidationClient
: public invalidation::InvalidationClient
{
50 FakeInvalidationClient() {}
52 ~FakeInvalidationClient() override
{}
54 void LoseRegistration(const invalidation::ObjectId
& oid
) {
55 EXPECT_TRUE(ContainsKey(registered_ids_
, oid
));
56 registered_ids_
.erase(oid
);
59 void LoseAllRegistrations() {
60 registered_ids_
.clear();
63 // invalidation::InvalidationClient implementation.
65 void Start() override
{}
66 void Stop() override
{}
67 void Acknowledge(const invalidation::AckHandle
& handle
) override
{}
69 void Register(const invalidation::ObjectId
& oid
) override
{
70 EXPECT_FALSE(ContainsKey(registered_ids_
, oid
));
71 registered_ids_
.insert(oid
);
74 void Register(const std::vector
<invalidation::ObjectId
>& oids
) override
{
78 void Unregister(const invalidation::ObjectId
& oid
) override
{
79 EXPECT_TRUE(ContainsKey(registered_ids_
, oid
));
80 registered_ids_
.erase(oid
);
83 void Unregister(const std::vector
<invalidation::ObjectId
>& oids
) override
{
87 const ObjectIdSet
& GetRegisteredIdsForTest() const {
88 return registered_ids_
;
92 ObjectIdSet registered_ids_
;
94 DISALLOW_COPY_AND_ASSIGN(FakeInvalidationClient
);
97 size_t kObjectIdsCount
= 5;
99 invalidation::ObjectId
GetIdForIndex(size_t index
) {
101 name
[0] += static_cast<char>(index
);
102 return invalidation::ObjectId(1 + index
, name
);
105 ObjectIdSet
GetSequenceOfIdsStartingAt(size_t start
, size_t count
) {
107 for (size_t i
= start
; i
< start
+ count
; ++i
)
108 ids
.insert(GetIdForIndex(i
));
112 ObjectIdSet
GetSequenceOfIds(size_t count
) {
113 return GetSequenceOfIdsStartingAt(0, count
);
116 void ExpectPendingRegistrations(
117 const ObjectIdSet
& expected_pending_ids
,
118 double expected_delay_seconds
,
119 const RegistrationManager::PendingRegistrationMap
& pending_registrations
) {
120 ObjectIdSet pending_ids
;
121 for (RegistrationManager::PendingRegistrationMap::const_iterator it
=
122 pending_registrations
.begin(); it
!= pending_registrations
.end();
124 SCOPED_TRACE(ObjectIdToString(it
->first
));
125 pending_ids
.insert(it
->first
);
126 base::TimeDelta offset
=
127 it
->second
.last_registration_request
-
128 it
->second
.registration_attempt
;
129 base::TimeDelta expected_delay
=
130 base::TimeDelta::FromSeconds(
131 static_cast<int64
>(expected_delay_seconds
)) + offset
;
132 // TODO(akalin): Add base::PrintTo() for base::Time and
134 EXPECT_EQ(expected_delay
, it
->second
.delay
)
135 << expected_delay
.InMicroseconds()
136 << ", " << it
->second
.delay
.InMicroseconds();
137 if (it
->second
.delay
<= base::TimeDelta()) {
138 EXPECT_EQ(base::TimeDelta(), it
->second
.actual_delay
);
140 EXPECT_EQ(it
->second
.actual_delay
, it
->second
.delay
);
143 EXPECT_EQ(expected_pending_ids
, pending_ids
);
146 class RegistrationManagerTest
: public testing::Test
{
148 RegistrationManagerTest()
149 : fake_registration_manager_(&fake_invalidation_client_
) {}
151 ~RegistrationManagerTest() override
{}
153 void LoseRegistrations(const ObjectIdSet
& oids
) {
154 for (ObjectIdSet::const_iterator it
= oids
.begin(); it
!= oids
.end();
156 fake_invalidation_client_
.LoseRegistration(*it
);
157 fake_registration_manager_
.MarkRegistrationLost(*it
);
161 void DisableIds(const ObjectIdSet
& oids
) {
162 for (ObjectIdSet::const_iterator it
= oids
.begin(); it
!= oids
.end();
164 fake_invalidation_client_
.LoseRegistration(*it
);
165 fake_registration_manager_
.DisableId(*it
);
169 // Used by MarkRegistrationLostBackoff* tests.
170 void RunBackoffTest(double jitter
) {
171 fake_registration_manager_
.SetJitter(jitter
);
172 ObjectIdSet ids
= GetSequenceOfIds(kObjectIdsCount
);
173 fake_registration_manager_
.UpdateRegisteredIds(ids
);
176 ObjectIdSet lost_ids
= GetSequenceOfIds(2);
177 LoseRegistrations(lost_ids
);
178 ExpectPendingRegistrations(
180 fake_registration_manager_
.GetPendingRegistrationsForTest());
182 // Trigger another failure to start delaying.
183 fake_registration_manager_
.FirePendingRegistrationsForTest();
184 LoseRegistrations(lost_ids
);
186 double scaled_jitter
=
187 jitter
* RegistrationManager::kRegistrationDelayMaxJitter
;
189 double expected_delay
=
190 RegistrationManager::kInitialRegistrationDelaySeconds
*
191 (1.0 + scaled_jitter
);
192 expected_delay
= std::floor(expected_delay
);
193 ExpectPendingRegistrations(
194 lost_ids
, expected_delay
,
195 fake_registration_manager_
.GetPendingRegistrationsForTest());
197 // Trigger another failure.
198 fake_registration_manager_
.FirePendingRegistrationsForTest();
199 LoseRegistrations(lost_ids
);
201 RegistrationManager::kRegistrationDelayExponent
+ scaled_jitter
;
202 expected_delay
= std::floor(expected_delay
);
203 ExpectPendingRegistrations(
204 lost_ids
, expected_delay
,
205 fake_registration_manager_
.GetPendingRegistrationsForTest());
207 // Trigger enough failures to hit the ceiling.
208 while (expected_delay
< RegistrationManager::kMaxRegistrationDelaySeconds
) {
209 fake_registration_manager_
.FirePendingRegistrationsForTest();
210 LoseRegistrations(lost_ids
);
212 RegistrationManager::kRegistrationDelayExponent
+ scaled_jitter
;
213 expected_delay
= std::floor(expected_delay
);
215 ExpectPendingRegistrations(
217 RegistrationManager::kMaxRegistrationDelaySeconds
,
218 fake_registration_manager_
.GetPendingRegistrationsForTest());
221 FakeInvalidationClient fake_invalidation_client_
;
222 FakeRegistrationManager fake_registration_manager_
;
225 // Needed by timers in RegistrationManager.
226 base::MessageLoop message_loop_
;
228 DISALLOW_COPY_AND_ASSIGN(RegistrationManagerTest
);
231 // Basic test of UpdateRegisteredIds to make sure we properly register
232 // new IDs and unregister any IDs no longer in the set.
233 TEST_F(RegistrationManagerTest
, UpdateRegisteredIds
) {
234 ObjectIdSet ids
= GetSequenceOfIds(kObjectIdsCount
- 1);
236 EXPECT_TRUE(fake_registration_manager_
.GetRegisteredIdsForTest().empty());
237 EXPECT_TRUE(fake_invalidation_client_
.GetRegisteredIdsForTest().empty());
239 ObjectIdSet expected_unregistered_ids
;
241 ObjectIdSet unregistered_ids
=
242 fake_registration_manager_
.UpdateRegisteredIds(ids
);
243 EXPECT_EQ(expected_unregistered_ids
, unregistered_ids
);
244 EXPECT_EQ(ids
, fake_registration_manager_
.GetRegisteredIdsForTest());
245 EXPECT_EQ(ids
, fake_invalidation_client_
.GetRegisteredIdsForTest());
247 ids
.insert(GetIdForIndex(kObjectIdsCount
- 1));
248 ids
.erase(GetIdForIndex(kObjectIdsCount
- 2));
249 unregistered_ids
= fake_registration_manager_
.UpdateRegisteredIds(ids
);
250 expected_unregistered_ids
.insert(GetIdForIndex(kObjectIdsCount
- 2));
251 EXPECT_EQ(expected_unregistered_ids
, unregistered_ids
);
252 EXPECT_EQ(ids
, fake_registration_manager_
.GetRegisteredIdsForTest());
253 EXPECT_EQ(ids
, fake_invalidation_client_
.GetRegisteredIdsForTest());
256 int GetRoundedBackoff(double retry_interval
, double jitter
) {
257 const double kInitialRetryInterval
= 3.0;
258 const double kMinRetryInterval
= 2.0;
259 const double kMaxRetryInterval
= 20.0;
260 const double kBackoffExponent
= 2.0;
261 const double kMaxJitter
= 0.5;
263 return static_cast<int>(
264 RegistrationManager::CalculateBackoff(retry_interval
,
265 kInitialRetryInterval
,
273 TEST_F(RegistrationManagerTest
, CalculateBackoff
) {
275 EXPECT_EQ(2, GetRoundedBackoff(0.0, -1.0));
276 EXPECT_EQ(3, GetRoundedBackoff(0.0, 0.0));
277 EXPECT_EQ(4, GetRoundedBackoff(0.0, +1.0));
280 EXPECT_EQ(4, GetRoundedBackoff(3.0, -1.0));
281 EXPECT_EQ(6, GetRoundedBackoff(3.0, 0.0));
282 EXPECT_EQ(7, GetRoundedBackoff(3.0, +1.0));
284 EXPECT_EQ(7, GetRoundedBackoff(5.0, -1.0));
285 EXPECT_EQ(10, GetRoundedBackoff(5.0, 0.0));
286 EXPECT_EQ(12, GetRoundedBackoff(5.0, +1.0));
289 EXPECT_EQ(19, GetRoundedBackoff(13.0, -1.0));
290 EXPECT_EQ(20, GetRoundedBackoff(13.0, 0.0));
291 EXPECT_EQ(20, GetRoundedBackoff(13.0, +1.0));
294 // Losing a registration should queue automatic re-registration.
295 TEST_F(RegistrationManagerTest
, MarkRegistrationLost
) {
296 ObjectIdSet ids
= GetSequenceOfIds(kObjectIdsCount
);
298 fake_registration_manager_
.UpdateRegisteredIds(ids
);
300 fake_registration_manager_
.GetPendingRegistrationsForTest().empty());
303 ObjectIdSet lost_ids
= GetSequenceOfIds(3);
304 ObjectIdSet non_lost_ids
= GetSequenceOfIdsStartingAt(3, kObjectIdsCount
- 3);
305 LoseRegistrations(lost_ids
);
306 ExpectPendingRegistrations(
308 fake_registration_manager_
.GetPendingRegistrationsForTest());
309 EXPECT_EQ(non_lost_ids
, fake_registration_manager_
.GetRegisteredIdsForTest());
310 EXPECT_EQ(non_lost_ids
, fake_invalidation_client_
.GetRegisteredIdsForTest());
312 // Pretend we waited long enough to re-register.
313 fake_registration_manager_
.FirePendingRegistrationsForTest();
314 EXPECT_EQ(ids
, fake_registration_manager_
.GetRegisteredIdsForTest());
315 EXPECT_EQ(ids
, fake_invalidation_client_
.GetRegisteredIdsForTest());
318 TEST_F(RegistrationManagerTest
, MarkRegistrationLostBackoffLow
) {
319 RunBackoffTest(-1.0);
322 TEST_F(RegistrationManagerTest
, MarkRegistrationLostBackoffMid
) {
326 TEST_F(RegistrationManagerTest
, MarkRegistrationLostBackoffHigh
) {
327 RunBackoffTest(+1.0);
330 // Exponential backoff on lost registrations should be reset to zero if
331 // UpdateRegisteredIds is called.
332 TEST_F(RegistrationManagerTest
, MarkRegistrationLostBackoffReset
) {
333 ObjectIdSet ids
= GetSequenceOfIds(kObjectIdsCount
);
335 fake_registration_manager_
.UpdateRegisteredIds(ids
);
338 ObjectIdSet lost_ids
= GetSequenceOfIds(2);
339 LoseRegistrations(lost_ids
);
340 ExpectPendingRegistrations(
342 fake_registration_manager_
.GetPendingRegistrationsForTest());
344 // Trigger another failure to start delaying.
345 fake_registration_manager_
.FirePendingRegistrationsForTest();
346 LoseRegistrations(lost_ids
);
347 double expected_delay
=
348 RegistrationManager::kInitialRegistrationDelaySeconds
;
349 ExpectPendingRegistrations(
350 lost_ids
, expected_delay
,
351 fake_registration_manager_
.GetPendingRegistrationsForTest());
354 fake_registration_manager_
.UpdateRegisteredIds(ids
);
355 ExpectPendingRegistrations(
358 fake_registration_manager_
.GetPendingRegistrationsForTest());
361 TEST_F(RegistrationManagerTest
, MarkAllRegistrationsLost
) {
362 ObjectIdSet ids
= GetSequenceOfIds(kObjectIdsCount
);
364 fake_registration_manager_
.UpdateRegisteredIds(ids
);
366 fake_invalidation_client_
.LoseAllRegistrations();
367 fake_registration_manager_
.MarkAllRegistrationsLost();
369 EXPECT_TRUE(fake_registration_manager_
.GetRegisteredIdsForTest().empty());
370 EXPECT_TRUE(fake_invalidation_client_
.GetRegisteredIdsForTest().empty());
372 ExpectPendingRegistrations(
374 fake_registration_manager_
.GetPendingRegistrationsForTest());
376 // Trigger another failure to start delaying.
377 fake_registration_manager_
.FirePendingRegistrationsForTest();
378 fake_invalidation_client_
.LoseAllRegistrations();
379 fake_registration_manager_
.MarkAllRegistrationsLost();
380 double expected_delay
=
381 RegistrationManager::kInitialRegistrationDelaySeconds
;
382 ExpectPendingRegistrations(
384 fake_registration_manager_
.GetPendingRegistrationsForTest());
386 // Pretend we waited long enough to re-register.
387 fake_registration_manager_
.FirePendingRegistrationsForTest();
388 EXPECT_EQ(ids
, fake_registration_manager_
.GetRegisteredIdsForTest());
389 EXPECT_EQ(ids
, fake_invalidation_client_
.GetRegisteredIdsForTest());
392 // IDs that are disabled should not be re-registered by UpdateRegisteredIds or
393 // automatic re-registration if that registration is lost.
394 TEST_F(RegistrationManagerTest
, DisableId
) {
395 ObjectIdSet ids
= GetSequenceOfIds(kObjectIdsCount
);
397 fake_registration_manager_
.UpdateRegisteredIds(ids
);
399 fake_registration_manager_
.GetPendingRegistrationsForTest().empty());
402 ObjectIdSet disabled_ids
= GetSequenceOfIds(3);
403 ObjectIdSet enabled_ids
= GetSequenceOfIdsStartingAt(3, kObjectIdsCount
- 3);
404 DisableIds(disabled_ids
);
405 ExpectPendingRegistrations(
408 fake_registration_manager_
.GetPendingRegistrationsForTest());
409 EXPECT_EQ(enabled_ids
, fake_registration_manager_
.GetRegisteredIdsForTest());
410 EXPECT_EQ(enabled_ids
, fake_invalidation_client_
.GetRegisteredIdsForTest());
412 fake_registration_manager_
.UpdateRegisteredIds(ids
);
413 EXPECT_EQ(enabled_ids
, fake_registration_manager_
.GetRegisteredIdsForTest());
415 fake_registration_manager_
.MarkRegistrationLost(
416 *disabled_ids
.begin());
417 ExpectPendingRegistrations(
420 fake_registration_manager_
.GetPendingRegistrationsForTest());
422 fake_registration_manager_
.MarkAllRegistrationsLost();
423 ExpectPendingRegistrations(
425 fake_registration_manager_
.GetPendingRegistrationsForTest());
429 } // namespace syncer