File: push_notification_service_desktop_impl_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 (436 lines) | stat: -rw-r--r-- 19,413 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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
// 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 "chrome/browser/push_notification/push_notification_service_desktop_impl.h"

#include <memory>

#include "base/notimplemented.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "chrome/browser/push_notification/prefs/push_notification_prefs.h"
#include "chrome/browser/push_notification/server_client/fake_push_notification_server_client.h"
#include "chrome/browser/push_notification/server_client/push_notification_server_client_desktop_impl.h"
#include "chromeos/ash/components/nearby/common/scheduling/fake_nearby_scheduler_factory.h"
#include "components/gcm_driver/fake_gcm_driver.h"
#include "components/gcm_driver/instance_id/instance_id_driver.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/testing_pref_service.h"
#include "components/push_notification/fake_push_notification_client.h"
#include "components/push_notification/push_notification_constants.h"
#include "components/signin/public/identity_manager/identity_test_environment.h"
#include "services/network/public/cpp/weak_wrapper_shared_url_loader_factory.h"
#include "services/network/test/test_url_loader_factory.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace {

const char kPushNotificationAppId[] = "com.google.chrome.push_notification";
const char kSenderIdFCMToken[] = "sharing_fcm_token";
const char kSharingSenderID[] = "745476177629";
const char kTestMessage[] = "This is a test message";
const char kTestRepresentativeTargetId[] = "0123456789";
const char kTotalTokenRetrievalTime[] =
    "PushNotification.ChromeOS.GCM.Token.RetrievalTime";
const char kTotalSuccessfulRegistrationResponseTime[] =
    "PushNotification.ChromeOS.MultiLoginUpdateApi.ResponseTime.Success";
const char kTotalFailedRegistrationResponseTime[] =
    "PushNotification.ChromeOS.MultiLoginUpdateApi.ResponseTime.Failure";
const char kGcmTokenRetrievalResult[] =
    "PushNotification.ChromeOS.GCM.Token.RetrievalResult";
const char kServiceRegistrationResult[] =
    "PushNotification.ChromeOS.Registration.Result";

class FakeInstanceID : public instance_id::InstanceID {
 public:
  explicit FakeInstanceID(gcm::FakeGCMDriver* gcm_driver)
      : InstanceID(kPushNotificationAppId, gcm_driver) {}
  ~FakeInstanceID() override = default;

  void GetID(GetIDCallback callback) override { NOTIMPLEMENTED(); }

  void GetCreationTime(GetCreationTimeCallback callback) override {
    NOTIMPLEMENTED();
  }

  void GetToken(const std::string& authorized_entity,
                const std::string& scope,
                base::TimeDelta time_to_live,
                std::set<Flags> flags,
                GetTokenCallback callback) override {
    if (authorized_entity == kSharingSenderID) {
      std::move(callback).Run(kSenderIdFCMToken, result_);
    } else {
      std::move(callback).Run(fcm_token_, result_);
    }
  }

  void ValidateToken(const std::string& authorized_entity,
                     const std::string& scope,
                     const std::string& token,
                     ValidateTokenCallback callback) override {
    NOTIMPLEMENTED();
  }

  void DeleteToken(const std::string& authorized_entity,
                   const std::string& scope,
                   DeleteTokenCallback callback) override {
    std::move(callback).Run(result_);
  }

  void DeleteTokenImpl(const std::string& authorized_entity,
                       const std::string& scope,
                       DeleteTokenCallback callback) override {
    NOTIMPLEMENTED();
  }

  void DeleteIDImpl(DeleteIDCallback callback) override { NOTIMPLEMENTED(); }

  void SetFCMResult(InstanceID::Result result) { result_ = result; }

  void SetFCMToken(std::string fcm_token) { fcm_token_ = std::move(fcm_token); }

 private:
  InstanceID::Result result_;
  std::string fcm_token_;
};

class FakeInstanceIDDriver : public instance_id::InstanceIDDriver {
 public:
  FakeInstanceIDDriver() : InstanceIDDriver(nullptr) {}

  FakeInstanceIDDriver(const FakeInstanceIDDriver&) = delete;
  FakeInstanceIDDriver& operator=(const FakeInstanceIDDriver&) = delete;

  ~FakeInstanceIDDriver() override = default;

  instance_id::InstanceID* GetInstanceID(const std::string& app_id) override {
    return fake_instance_id_;
  }

  void SetFakeInstanceID(raw_ptr<FakeInstanceID> fake_instance_id) {
    fake_instance_id_ = std::move(fake_instance_id);
  }

 private:
  raw_ptr<FakeInstanceID> fake_instance_id_;
};

}  // namespace

namespace push_notification {

class PushNotificationServiceDesktopImplTest : public testing::Test {
 public:
  PushNotificationServiceDesktopImplTest() {
    shared_factory_ =
        base::MakeRefCounted<network::WeakWrapperSharedURLLoaderFactory>(
            base::BindOnce([]() -> network::mojom::URLLoaderFactory* {
              ADD_FAILURE() << "Did not expect this to actually be used";
              return nullptr;
            }));
  }

  ~PushNotificationServiceDesktopImplTest() override = default;

  // testing::Test:
  void SetUp() override {
    RegisterPushNotificationPrefs(pref_service_.registry());
    ash::nearby::NearbySchedulerFactory::SetFactoryForTesting(
        &scheduler_factory_);
    PushNotificationServerClientDesktopImpl::Factory::SetFactoryForTesting(
        &fake_client_factory_);
    fake_gcm_driver_ = std::make_unique<gcm::FakeGCMDriver>();
    fake_instance_id_ =
        std::make_unique<FakeInstanceID>(fake_gcm_driver_.get());
    fake_instance_id_driver_.SetFakeInstanceID(fake_instance_id_.get());
    identity_test_env_ = std::make_unique<signin::IdentityTestEnvironment>(
        &test_url_loader_factory_, nullptr, nullptr);

    push_notification_service_ =
        std::make_unique<PushNotificationServiceDesktopImpl>(
            &pref_service_, &fake_instance_id_driver_,
            identity_test_env_->identity_manager(),
            base::MakeRefCounted<network::WeakWrapperSharedURLLoaderFactory>(
                &test_url_loader_factory_));
    histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 0);
    histogram_tester_.ExpectTotalCount(kTotalSuccessfulRegistrationResponseTime,
                                       0);
    histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 0);
    histogram_tester_.ExpectBucketCount(kGcmTokenRetrievalResult,
                                        /*bucket: failure=*/0, 0);
    histogram_tester_.ExpectBucketCount(kGcmTokenRetrievalResult,
                                        /*bucket: success=*/1, 0);
    histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                        /*bucket: failure=*/0, 0);
    histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                        /*bucket: success=*/1, 0);
  }

  void TearDown() override {
    push_notification_service_.reset();
    identity_test_env_.reset();
    fake_gcm_driver_.reset();
  }

  push_notification::proto::NotificationsMultiLoginUpdateResponse
  CreateResponseProto() {
    push_notification::proto::NotificationsMultiLoginUpdateResponse
        response_proto;
    push_notification::proto::NotificationsMultiLoginUpdateResponse::
        RegistrationResult* registration_result =
            response_proto.add_registration_results();
    push_notification::proto::StatusProto* status =
        registration_result->mutable_status();
    status->set_code(0);
    status->set_message("OK");
    push_notification::proto::Target* target =
        registration_result->mutable_target();
    target->set_representative_target_id(kTestRepresentativeTargetId);
    return response_proto;
  }

  void CheckForSuccessfulRegistration() {
    EXPECT_TRUE(fake_client_factory_.fake_server_client()
                    ->HasRegisterWithPushNotificationServiceCallback());
    EXPECT_TRUE(fake_client_factory_.fake_server_client()->HasErrorCallback());
    fake_client_factory_.fake_server_client()
        ->InvokeRegisterWithPushNotificationServiceSuccessCallback(
            CreateResponseProto());
    EXPECT_TRUE(push_notification_service_->IsServiceInitialized());
    EXPECT_EQ(kTestRepresentativeTargetId,
              pref_service_.GetString(
                  prefs::kPushNotificationRepresentativeTargetIdPrefName));
    histogram_tester_.ExpectTotalCount(kTotalSuccessfulRegistrationResponseTime,
                                       1);
  }

  void CheckForFailedRegistration(
      PushNotificationDesktopApiCallFlow::PushNotificationApiCallFlowError
          error) {
    EXPECT_TRUE(fake_client_factory_.fake_server_client()
                    ->HasRegisterWithPushNotificationServiceCallback());
    EXPECT_TRUE(fake_client_factory_.fake_server_client()->HasErrorCallback());
    fake_client_factory_.fake_server_client()
        ->InvokeRegisterWithPushNotificationServiceErrorCallback(error);
  }

  base::test::TaskEnvironment task_environment_{
      base::test::TaskEnvironment::TimeSource::MOCK_TIME};
  base::HistogramTester histogram_tester_;
  TestingPrefServiceSimple pref_service_;
  std::unique_ptr<PushNotificationServiceDesktopImpl>
      push_notification_service_;
  std::unique_ptr<signin::IdentityTestEnvironment> identity_test_env_;
  scoped_refptr<network::SharedURLLoaderFactory> shared_factory_;
  network::TestURLLoaderFactory test_url_loader_factory_;
  std::unique_ptr<FakeInstanceID> fake_instance_id_;
  std::unique_ptr<gcm::FakeGCMDriver> fake_gcm_driver_;
  FakeInstanceIDDriver fake_instance_id_driver_;
  FakePushNotificationServerClient::Factory fake_client_factory_;
  ash::nearby::FakeNearbySchedulerFactory scheduler_factory_;
};

TEST_F(PushNotificationServiceDesktopImplTest, StartService) {
  fake_instance_id_->SetFCMResult(instance_id::InstanceID::Result::SUCCESS);
  fake_instance_id_->SetFCMToken(kSenderIdFCMToken);
  ash::nearby::FakeNearbyScheduler* registration_scheduler =
      scheduler_factory_.pref_name_to_on_demand_instance()
          .find(
              prefs::
                  kPushNotificationRegistrationAttemptBackoffSchedulerPrefName)
          ->second.fake_scheduler;
  registration_scheduler->InvokeRequestCallback();
  EXPECT_EQ(std::string(), fake_client_factory_.fake_server_client()
                               ->GetRequestProto()
                               .target()
                               .representative_target_id());
  histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 1);
  CheckForSuccessfulRegistration();
  histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 0);
  histogram_tester_.ExpectBucketCount(kGcmTokenRetrievalResult,
                                      /*bucket: success=*/1, 1);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: failure=*/0, 0);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: success=*/1, 1);
}

TEST_F(PushNotificationServiceDesktopImplTest, StartServiceWithPref) {
  fake_instance_id_->SetFCMResult(instance_id::InstanceID::Result::SUCCESS);
  fake_instance_id_->SetFCMToken(kSenderIdFCMToken);
  pref_service_.SetString(
      prefs::kPushNotificationRepresentativeTargetIdPrefName,
      kTestRepresentativeTargetId);
  ash::nearby::FakeNearbyScheduler* registration_scheduler =
      scheduler_factory_.pref_name_to_on_demand_instance()
          .find(
              prefs::
                  kPushNotificationRegistrationAttemptBackoffSchedulerPrefName)
          ->second.fake_scheduler;
  registration_scheduler->InvokeRequestCallback();
  EXPECT_EQ(kTestRepresentativeTargetId,
            fake_client_factory_.fake_server_client()
                ->GetRequestProto()
                .target()
                .representative_target_id());
  histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 1);
  CheckForSuccessfulRegistration();
  histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 0);
  histogram_tester_.ExpectBucketCount(kGcmTokenRetrievalResult,
                                      /*bucket: success=*/1, 1);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: failure=*/0, 0);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: success=*/1, 1);
}

TEST_F(PushNotificationServiceDesktopImplTest, StartServiceWithPrefStoreReset) {
  fake_instance_id_->SetFCMResult(instance_id::InstanceID::Result::SUCCESS);
  fake_instance_id_->SetFCMToken(kSenderIdFCMToken);
  pref_service_.SetString(
      prefs::kPushNotificationRepresentativeTargetIdPrefName,
      kTestRepresentativeTargetId);
  ash::nearby::FakeNearbyScheduler* registration_scheduler =
      scheduler_factory_.pref_name_to_on_demand_instance()
          .find(
              prefs::
                  kPushNotificationRegistrationAttemptBackoffSchedulerPrefName)
          ->second.fake_scheduler;
  registration_scheduler->InvokeRequestCallback();
  EXPECT_EQ(kTestRepresentativeTargetId,
            fake_client_factory_.fake_server_client()
                ->GetRequestProto()
                .target()
                .representative_target_id());
  histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 1);
  CheckForSuccessfulRegistration();
  histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 0);
  histogram_tester_.ExpectBucketCount(kGcmTokenRetrievalResult,
                                      /*bucket: success=*/1, 1);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: failure=*/0, 0);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: success=*/1, 1);
  push_notification_service_->OnStoreReset();
  EXPECT_EQ(std::string(),
            pref_service_.GetString(
                prefs::kPushNotificationRepresentativeTargetIdPrefName));
}

TEST_F(PushNotificationServiceDesktopImplTest, StartServiceTokenFailure) {
  fake_instance_id_->SetFCMResult(
      instance_id::InstanceID::Result::SERVER_ERROR);

  ash::nearby::FakeNearbyScheduler* registration_scheduler =
      scheduler_factory_.pref_name_to_on_demand_instance()
          .find(
              prefs::
                  kPushNotificationRegistrationAttemptBackoffSchedulerPrefName)
          ->second.fake_scheduler;
  registration_scheduler->InvokeRequestCallback();

  histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 0);
  EXPECT_FALSE(fake_client_factory_.fake_server_client());
  EXPECT_FALSE(push_notification_service_->IsServiceInitialized());
  histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 0);
  histogram_tester_.ExpectBucketCount(kGcmTokenRetrievalResult,
                                      /*bucket: failure=*/0, 1);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: failure=*/0, 0);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: success=*/1, 0);
}

TEST_F(PushNotificationServiceDesktopImplTest,
       StartServiceAuthenticationFailure) {
  fake_instance_id_->SetFCMResult(instance_id::InstanceID::Result::SUCCESS);
  fake_instance_id_->SetFCMToken(kSenderIdFCMToken);

  ash::nearby::FakeNearbyScheduler* registration_scheduler =
      scheduler_factory_.pref_name_to_on_demand_instance()
          .find(
              prefs::
                  kPushNotificationRegistrationAttemptBackoffSchedulerPrefName)
          ->second.fake_scheduler;
  registration_scheduler->InvokeRequestCallback();

  histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 1);
  CheckForFailedRegistration(
      PushNotificationDesktopApiCallFlow::PushNotificationApiCallFlowError::
          kAuthenticationError);
  histogram_tester_.ExpectBucketCount(kGcmTokenRetrievalResult,
                                      /*bucket: success=*/1, 1);
  histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 1);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: failure=*/0, 1);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: success=*/1, 0);
}

TEST_F(PushNotificationServiceDesktopImplTest,
       StartServiceAuthenticationFailureRetrySuccess) {
  fake_instance_id_->SetFCMResult(instance_id::InstanceID::Result::SUCCESS);
  fake_instance_id_->SetFCMToken(kSenderIdFCMToken);

  ash::nearby::FakeNearbyScheduler* registration_scheduler =
      scheduler_factory_.pref_name_to_on_demand_instance()
          .find(
              prefs::
                  kPushNotificationRegistrationAttemptBackoffSchedulerPrefName)
          ->second.fake_scheduler;
  registration_scheduler->InvokeRequestCallback();

  histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 1);
  CheckForFailedRegistration(
      PushNotificationDesktopApiCallFlow::PushNotificationApiCallFlowError::
          kAuthenticationError);
  histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 1);

  registration_scheduler->InvokeRequestCallback();

  histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 2);
  CheckForFailedRegistration(
      PushNotificationDesktopApiCallFlow::PushNotificationApiCallFlowError::
          kAuthenticationError);
  histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 2);

  registration_scheduler->InvokeRequestCallback();

  histogram_tester_.ExpectTotalCount(kTotalTokenRetrievalTime, 3);
  CheckForSuccessfulRegistration();
  histogram_tester_.ExpectTotalCount(kTotalFailedRegistrationResponseTime, 2);
  histogram_tester_.ExpectBucketCount(kGcmTokenRetrievalResult,
                                      /*bucket: success=*/1, 3);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: failure=*/0, 2);
  histogram_tester_.ExpectBucketCount(kServiceRegistrationResult,
                                      /*bucket: success=*/1, 1);
}

TEST_F(PushNotificationServiceDesktopImplTest, OnMessageReceived) {
  // No need to invoke the scheduler here because we aren't performing any
  // actions that require initialization to be complete.

  auto* client_manager =
      push_notification_service_->GetPushNotificationClientManager();
  auto fake_push_notification_client =
      std::make_unique<FakePushNotificationClient>(
          push_notification::ClientId::kNearbyPresence);
  client_manager->AddPushNotificationClient(
      fake_push_notification_client.get());
  gcm::IncomingMessage message;
  message.data.insert_or_assign(kNotificationTypeIdKey,
                                push_notification::kNearbyPresenceClientId);
  message.data.insert_or_assign(kNotificationPayloadKey, kTestMessage);

  push_notification_service_->OnMessage(kPushNotificationAppId,
                                        std::move(message));
  EXPECT_EQ(
      kTestMessage,
      fake_push_notification_client->GetMostRecentMessageDataReceived().at(
          kNotificationPayloadKey));
}

}  // namespace push_notification