123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310 |
- // Copyright 2020 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #include "components/sync/invalidations/fcm_handler.h"
- #include <set>
- #include <string>
- #include <utility>
- #include "base/files/file_path.h"
- #include "base/test/scoped_feature_list.h"
- #include "base/test/task_environment.h"
- #include "components/gcm_driver/fake_gcm_driver.h"
- #include "components/gcm_driver/gcm_driver.h"
- #include "components/gcm_driver/instance_id/instance_id.h"
- #include "components/gcm_driver/instance_id/instance_id_driver.h"
- #include "components/sync/base/features.h"
- #include "components/sync/invalidations/fcm_registration_token_observer.h"
- #include "components/sync/invalidations/invalidations_listener.h"
- #include "google_apis/gcm/engine/account_mapping.h"
- #include "testing/gmock/include/gmock/gmock.h"
- #include "testing/gtest/include/gtest/gtest.h"
- using instance_id::InstanceID;
- using testing::_;
- using testing::Invoke;
- using testing::NiceMock;
- using testing::Return;
- using testing::WithArg;
- namespace syncer {
- namespace {
- const char kDefaultSenderId[] = "fake_sender_id";
- const char kSyncInvalidationsAppId[] = "com.google.chrome.sync.invalidations";
- const int kTokenValidationPeriodMinutesDefault = 60 * 24;
- class MockInstanceID : public InstanceID {
- public:
- MockInstanceID() : InstanceID("app_id", /*gcm_driver=*/nullptr) {}
- ~MockInstanceID() override = default;
- MOCK_METHOD(void, GetID, (GetIDCallback callback), (override));
- MOCK_METHOD(void,
- GetCreationTime,
- (GetCreationTimeCallback callback),
- (override));
- MOCK_METHOD(void,
- GetToken,
- (const std::string& authorized_entity,
- const std::string& scope,
- base::TimeDelta time_to_live,
- std::set<Flags> flags,
- GetTokenCallback callback),
- (override));
- MOCK_METHOD(void,
- ValidateToken,
- (const std::string& authorized_entity,
- const std::string& scope,
- const std::string& token,
- ValidateTokenCallback callback),
- (override));
- protected:
- MOCK_METHOD(void,
- DeleteTokenImpl,
- (const std::string& authorized_entity,
- const std::string& scope,
- DeleteTokenCallback callback),
- (override));
- MOCK_METHOD(void, DeleteIDImpl, (DeleteIDCallback callback), (override));
- };
- class MockInstanceIDDriver : public instance_id::InstanceIDDriver {
- public:
- MockInstanceIDDriver() : InstanceIDDriver(/*gcm_driver=*/nullptr) {}
- ~MockInstanceIDDriver() override = default;
- MOCK_METHOD(InstanceID*,
- GetInstanceID,
- (const std::string& app_id),
- (override));
- MOCK_METHOD(void, RemoveInstanceID, (const std::string& app_id), (override));
- MOCK_METHOD(bool,
- ExistsInstanceID,
- (const std::string& app_id),
- (const override));
- };
- class MockListener : public InvalidationsListener {
- public:
- MOCK_METHOD(void,
- OnInvalidationReceived,
- (const std::string& payload),
- (override));
- };
- class MockTokenObserver : public FCMRegistrationTokenObserver {
- public:
- MOCK_METHOD(void, OnFCMRegistrationTokenChanged, (), (override));
- };
- class FCMHandlerTest : public testing::Test {
- public:
- FCMHandlerTest()
- : fcm_handler_(&fake_gcm_driver_,
- &mock_instance_id_driver_,
- kDefaultSenderId,
- kSyncInvalidationsAppId) {
- // This is called in the FCMHandler.
- ON_CALL(mock_instance_id_driver_, GetInstanceID(kSyncInvalidationsAppId))
- .WillByDefault(Return(&mock_instance_id_));
- override_features_.InitWithFeatures(
- /*enabled_features=*/{kSyncSendInterestedDataTypes,
- kUseSyncInvalidations},
- /*disabled_features=*/{});
- }
- protected:
- base::test::SingleThreadTaskEnvironment task_environment_{
- base::test::SingleThreadTaskEnvironment::TimeSource::MOCK_TIME};
- base::test::ScopedFeatureList override_features_;
- gcm::FakeGCMDriver fake_gcm_driver_;
- NiceMock<MockInstanceIDDriver> mock_instance_id_driver_;
- NiceMock<MockInstanceID> mock_instance_id_;
- FCMHandler fcm_handler_;
- };
- TEST_F(FCMHandlerTest, ShouldReturnValidToken) {
- // Check that the handler gets the token through GetToken.
- EXPECT_CALL(mock_instance_id_, GetToken)
- .WillOnce(
- WithArg<4>(Invoke([this](InstanceID::GetTokenCallback callback) {
- EXPECT_TRUE(fcm_handler_.IsWaitingForToken());
- std::move(callback).Run("token", InstanceID::Result::SUCCESS);
- })));
- fcm_handler_.StartListening();
- EXPECT_EQ("token", fcm_handler_.GetFCMRegistrationToken());
- EXPECT_FALSE(fcm_handler_.IsWaitingForToken());
- }
- TEST_F(FCMHandlerTest, ShouldPropagatePayloadToListener) {
- const std::string kPayloadValue = "some_payload";
- NiceMock<MockListener> mock_listener;
- fcm_handler_.AddListener(&mock_listener);
- gcm::IncomingMessage gcm_message;
- gcm_message.raw_data = kPayloadValue;
- EXPECT_CALL(mock_listener, OnInvalidationReceived(kPayloadValue));
- fcm_handler_.OnMessage(kSyncInvalidationsAppId, gcm_message);
- fcm_handler_.RemoveListener(&mock_listener);
- }
- TEST_F(FCMHandlerTest, ShouldNotifyOnTokenChange) {
- NiceMock<MockTokenObserver> mock_token_observer;
- fcm_handler_.AddTokenObserver(&mock_token_observer);
- // Check that the handler gets the token through GetToken.
- ON_CALL(mock_instance_id_, GetToken)
- .WillByDefault(
- WithArg<4>(Invoke([](InstanceID::GetTokenCallback callback) {
- std::move(callback).Run("token", InstanceID::Result::SUCCESS);
- })));
- EXPECT_CALL(mock_token_observer, OnFCMRegistrationTokenChanged());
- fcm_handler_.StartListening();
- fcm_handler_.RemoveTokenObserver(&mock_token_observer);
- }
- TEST_F(FCMHandlerTest, ShouldScheduleTokenValidationAndActOnNewToken) {
- NiceMock<MockTokenObserver> mock_token_observer;
- fcm_handler_.AddTokenObserver(&mock_token_observer);
- // Check that the handler gets the token through GetToken and notifies the
- // observer.
- EXPECT_CALL(mock_instance_id_, GetToken)
- .WillOnce(WithArg<4>(Invoke([](InstanceID::GetTokenCallback callback) {
- std::move(callback).Run("token", InstanceID::Result::SUCCESS);
- })));
- EXPECT_CALL(mock_token_observer, OnFCMRegistrationTokenChanged()).Times(1);
- fcm_handler_.StartListening();
- // Adjust the time and check that validation will happen in time.
- // The old token is invalid, so token observer should be informed.
- task_environment_.FastForwardBy(
- base::Minutes(kTokenValidationPeriodMinutesDefault) - base::Seconds(1));
- // When it is time, validation happens.
- EXPECT_CALL(mock_instance_id_, GetToken)
- .WillOnce(WithArg<4>(Invoke([](InstanceID::GetTokenCallback callback) {
- std::move(callback).Run("new token", InstanceID::Result::SUCCESS);
- })));
- EXPECT_CALL(mock_token_observer, OnFCMRegistrationTokenChanged()).Times(1);
- task_environment_.FastForwardBy(base::Seconds(1));
- fcm_handler_.RemoveTokenObserver(&mock_token_observer);
- }
- TEST_F(FCMHandlerTest, ShouldScheduleTokenValidationAndNotActOnSameToken) {
- NiceMock<MockTokenObserver> mock_token_observer;
- fcm_handler_.AddTokenObserver(&mock_token_observer);
- // Check that the handler gets the token through GetToken and notifies the
- // observer.
- EXPECT_CALL(mock_instance_id_, GetToken)
- .WillOnce(WithArg<4>(Invoke([](InstanceID::GetTokenCallback callback) {
- std::move(callback).Run("token", InstanceID::Result::SUCCESS);
- })));
- EXPECT_CALL(mock_token_observer, OnFCMRegistrationTokenChanged()).Times(1);
- fcm_handler_.StartListening();
- // Adjust the time and check that validation will happen in time.
- // The old token is valid, so token observer should not be informed.
- task_environment_.FastForwardBy(
- base::Minutes(kTokenValidationPeriodMinutesDefault) - base::Seconds(1));
- // When it is time, validation happens.
- EXPECT_CALL(mock_instance_id_, GetToken)
- .WillOnce(WithArg<4>(Invoke([](InstanceID::GetTokenCallback callback) {
- std::move(callback).Run("token", InstanceID::Result::SUCCESS);
- })));
- EXPECT_CALL(mock_token_observer, OnFCMRegistrationTokenChanged()).Times(0);
- task_environment_.FastForwardBy(base::Seconds(1));
- fcm_handler_.RemoveTokenObserver(&mock_token_observer);
- }
- TEST_F(FCMHandlerTest, ShouldClearTokenOnStopListeningPermanently) {
- // Check that the handler gets the token through GetToken.
- EXPECT_CALL(mock_instance_id_, GetToken)
- .WillOnce(WithArg<4>(Invoke([](InstanceID::GetTokenCallback callback) {
- std::move(callback).Run("token", InstanceID::Result::SUCCESS);
- })));
- fcm_handler_.StartListening();
- NiceMock<MockTokenObserver> mock_token_observer;
- fcm_handler_.AddTokenObserver(&mock_token_observer);
- EXPECT_CALL(mock_instance_id_driver_,
- ExistsInstanceID(kSyncInvalidationsAppId))
- .WillOnce(Return(true));
- // Token should be cleared when StopListeningPermanently() is called.
- EXPECT_CALL(mock_token_observer, OnFCMRegistrationTokenChanged());
- fcm_handler_.StopListeningPermanently();
- EXPECT_EQ("", fcm_handler_.GetFCMRegistrationToken());
- fcm_handler_.RemoveTokenObserver(&mock_token_observer);
- }
- TEST_F(FCMHandlerTest, ShouldReplayIncomingMessagesOnAddingListener) {
- const std::string kPayloadValue1 = "payload_1";
- const std::string kPayloadValue2 = "payload_2";
- gcm::IncomingMessage gcm_message;
- gcm_message.raw_data = kPayloadValue1;
- fcm_handler_.OnMessage(kSyncInvalidationsAppId, gcm_message);
- gcm_message.raw_data = kPayloadValue2;
- fcm_handler_.OnMessage(kSyncInvalidationsAppId, gcm_message);
- NiceMock<MockListener> mock_listener;
- EXPECT_CALL(mock_listener, OnInvalidationReceived(kPayloadValue1));
- EXPECT_CALL(mock_listener, OnInvalidationReceived(kPayloadValue2));
- fcm_handler_.AddListener(&mock_listener);
- // Adding the same listener twice should have no effect.
- fcm_handler_.AddListener(&mock_listener);
- fcm_handler_.RemoveListener(&mock_listener);
- }
- TEST_F(FCMHandlerTest, ShouldLimitIncomingMessagesForReplay) {
- gcm::IncomingMessage gcm_message;
- gcm_message.raw_data = "payload";
- for (size_t i = 0; i < 100; ++i) {
- fcm_handler_.OnMessage(kSyncInvalidationsAppId, gcm_message);
- }
- NiceMock<MockListener> mock_listener;
- EXPECT_CALL(mock_listener, OnInvalidationReceived).Times(5);
- fcm_handler_.AddListener(&mock_listener);
- fcm_handler_.RemoveListener(&mock_listener);
- }
- TEST_F(FCMHandlerTest, ShouldClearLastIncomingMessagesOnStopListening) {
- EXPECT_CALL(mock_instance_id_, GetToken)
- .WillRepeatedly(
- WithArg<4>(Invoke([](InstanceID::GetTokenCallback callback) {
- std::move(callback).Run("token", InstanceID::Result::SUCCESS);
- })));
- fcm_handler_.StartListening();
- gcm::IncomingMessage gcm_message;
- gcm_message.raw_data = "payload";
- fcm_handler_.OnMessage(kSyncInvalidationsAppId, gcm_message);
- fcm_handler_.StopListening();
- fcm_handler_.StartListening();
- NiceMock<MockListener> mock_listener;
- EXPECT_CALL(mock_listener, OnInvalidationReceived).Times(0);
- fcm_handler_.AddListener(&mock_listener);
- fcm_handler_.RemoveListener(&mock_listener);
- }
- } // namespace
- } // namespace syncer
|