[GCM] API update to allow only a single sender in registration

chrome/browser/services/gcm/gcm_profile_service_unittest.cc

 // Copyright (c) 2013 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 <algorithm>
 #include <map>
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/message_loop/message_loop.h"
@@ skipping 342 matching lines @@
     waiter_->PumpUILoop();
   }
 
   void SignOut() {
     signin_manager_->SignOut();
     waiter_->PumpIOLoop();
     waiter_->PumpUILoop();
   }
 
   void Register(const std::string& app_id,
-                const std::vector<std::string>& sender_ids) {
+                const std::string& sender_id) {
     GetGCMProfileService()->Register(
         app_id,
-        sender_ids,
+        sender_id,
         kTestingSha1Cert,
         base::Bind(&GCMProfileServiceTestConsumer::RegisterCompleted,
                    base::Unretained(this)));
   }
 
   void RegisterCompleted(const std::string& registration_id,
                          GCMClient::Result result) {
     registration_id_ = registration_id;
     registration_result_ = result;
     waiter_->SignalCompleted();
@@ skipping 268 matching lines @@
   consumer()->SignIn(kTestingUsername2);
 
   // GCMClient should be loaded again.
   EXPECT_TRUE(consumer()->IsGCMClientReady());
   EXPECT_EQ(GCMClientMock::LOADED, consumer()->GetGCMClient()->status());
 }
 
 TEST_F(GCMProfileServiceTest, RegisterWhenNotSignedIn) {
   consumer()->CreateGCMProfileServiceInstance();
 
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
 
   EXPECT_TRUE(consumer()->registration_id().empty());
   EXPECT_EQ(GCMClient::NOT_SIGNED_IN, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceTest, RegisterUnderNeutralChannelSignal) {
   // Neutral channel signal will prevent GCMClient from checking in when the
   // profile is signed in.
   profile()->GetPrefs()->ClearPref(prefs::kGCMChannelEnabled);
 
   consumer()->CreateGCMProfileServiceInstance();
   consumer()->SignIn(kTestingUsername);
 
   // GCMClient should not be checked in.
   EXPECT_FALSE(consumer()->IsGCMClientReady());
   EXPECT_EQ(GCMClientMock::UNINITIALIZED, consumer()->GetGCMClient()->status());
 
   // Invoking register will make GCMClient checked in.
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
   WaitUntilCompleted();
 
   // GCMClient should be checked in.
   EXPECT_TRUE(consumer()->IsGCMClientReady());
   EXPECT_EQ(GCMClientMock::LOADED, consumer()->GetGCMClient()->status());
 
   // Registration should succeed.
   std::string expected_registration_id =
-      GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids);
+      GCMClientMock::GetRegistrationIdFromSenderIds("sender1");
   EXPECT_EQ(expected_registration_id, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceTest, SendWhenNotSignedIn) {
   consumer()->CreateGCMProfileServiceInstance();
 
   GCMClient::OutgoingMessage message;
   message.id = "1";
   message.data["key1"] = "value1";
@@ skipping 42 matching lines @@
 
   virtual void SetUp() OVERRIDE {
     GCMProfileServiceTest::SetUp();
 
     consumer()->CreateGCMProfileServiceInstance();
     consumer()->SignIn(kTestingUsername);
   }
 };
 
 TEST_F(GCMProfileServiceSingleProfileTest, Register) {
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
   std::string expected_registration_id =
-      GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids);
+      GCMClientMock::GetRegistrationIdFromSenderIds("sender1");
 
   WaitUntilCompleted();
   EXPECT_EQ(expected_registration_id, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest, DoubleRegister) {
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
   std::string expected_registration_id =
-      GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids);
+      GCMClientMock::GetRegistrationIdFromSenderIds("sender1");
 
   // Calling regsiter 2nd time without waiting 1st one to finish will fail
   // immediately.
-  sender_ids.push_back("sender2");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender2");
   EXPECT_TRUE(consumer()->registration_id().empty());
   EXPECT_EQ(GCMClient::ASYNC_OPERATION_PENDING,
             consumer()->registration_result());
 
   // The 1st register is still doing fine.
   WaitUntilCompleted();
   EXPECT_EQ(expected_registration_id, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest, RegisterError) {
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1@error");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sedner1@error");

[jianli, 2014/03/03 21:29:31]

nit: typo for sender

[fgorski, 2014/03/03 23:14:16]

Done. Brilliant catch!

 
   WaitUntilCompleted();
   EXPECT_TRUE(consumer()->registration_id().empty());
   EXPECT_NE(GCMClient::SUCCESS, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest, RegisterAgainWithSameSenderIDs) {

[jianli, 2014/03/03 21:29:31]

Remove the trailing "s" from the test case name.

[fgorski, 2014/03/03 23:14:16]

Done.

-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  sender_ids.push_back("sender2");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
   std::string expected_registration_id =
-      GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids);
+      GCMClientMock::GetRegistrationIdFromSenderIds("sender1");
 
   WaitUntilCompleted();
   EXPECT_EQ(expected_registration_id, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 
   // Clears the results the would be set by the Register callback in preparation
   // to call register 2nd time.
   consumer()->clear_registration_result();
 
-  // Calling register 2nd time with the same set of sender IDs but different
-  // ordering will get back the same registration ID. There is no need to wait
-  // since register simply returns the cached registration ID.
-  std::vector<std::string> another_sender_ids;
-  another_sender_ids.push_back("sender2");
-  another_sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, another_sender_ids);
+  // Calling register 2nd time will get back the same registration ID. There is
+  // no need to wait since register simply returns the cached registration ID.
+  consumer()->Register(kTestingAppId, "sender1");
   EXPECT_EQ(expected_registration_id, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest,
        RegisterAgainWithDifferentSenderIDs) {

[jianli, 2014/03/03 21:29:31]

ditto.

[fgorski, 2014/03/03 23:14:16]

Done.

-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
   std::string expected_registration_id =
-      GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids);
+      GCMClientMock::GetRegistrationIdFromSenderIds("sender1");
 
   WaitUntilCompleted();
   EXPECT_EQ(expected_registration_id, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 
   // Make sender IDs different.

[jianli, 2014/03/03 21:29:31]

IDs => ID

[fgorski, 2014/03/03 23:14:16]

Done.

-  sender_ids.push_back("sender2");
   std::string expected_registration_id2 =
-      GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids);
+      GCMClientMock::GetRegistrationIdFromSenderIds("sender2");
 
   // Calling register 2nd time with the different sender IDs will get back a new
   // registration ID.
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender2");
   WaitUntilCompleted();
   EXPECT_EQ(expected_registration_id2, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest, ReadRegistrationFromStateStore) {
   scoped_refptr<Extension> extension(consumer()->CreateExtension());
 
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(extension->id(), sender_ids);
+  consumer()->Register(extension->id(), "sender1");
 
   WaitUntilCompleted();
   EXPECT_FALSE(consumer()->registration_id().empty());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
   std::string old_registration_id = consumer()->registration_id();
 
   // Clears the results that would be set by the Register callback in
   // preparation to call register 2nd time.
   consumer()->clear_registration_result();
 
   // Register should not reach the server. Forcing GCMClient server error should
   // help catch this.
   consumer()->set_gcm_client_error_simulation(GCMClientMock::FORCE_ERROR);
 
   // Simulate start-up by recreating GCMProfileService.
   consumer()->CreateGCMProfileServiceInstance();
 
   // Simulate start-up by reloading extension.
   consumer()->ReloadExtension(extension);
 
   // This should read the registration info from the extension's state store.
-  consumer()->Register(extension->id(), sender_ids);
+  consumer()->Register(extension->id(), "sender1");
   PumpIOLoop();
   PumpUILoop();
   EXPECT_EQ(old_registration_id, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest,
        GCMClientReadyAfterReadingRegistration) {
   scoped_refptr<Extension> extension(consumer()->CreateExtension());
 
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(extension->id(), sender_ids);
+  consumer()->Register(extension->id(), "sender1");
 
   WaitUntilCompleted();
   EXPECT_FALSE(consumer()->registration_id().empty());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
   std::string old_registration_id = consumer()->registration_id();
 
   // Clears the results that would be set by the Register callback in
   // preparation to call register 2nd time.
   consumer()->clear_registration_result();
 
   // Simulate start-up by recreating GCMProfileService.
   consumer()->set_gcm_client_loading_delay(GCMClientMock::DELAY_LOADING);
   consumer()->CreateGCMProfileServiceInstance();
 
   // Simulate start-up by reloading extension.
   consumer()->ReloadExtension(extension);
 
   // Read the registration info from the extension's state store.
   // This would hold up because GCMClient is in loading state.
-  consumer()->Register(extension->id(), sender_ids);
+  consumer()->Register(extension->id(), "sender1");
   base::RunLoop().RunUntilIdle();
   EXPECT_TRUE(consumer()->registration_id().empty());
   EXPECT_EQ(GCMClient::UNKNOWN_ERROR, consumer()->registration_result());
 
   // Register operation will be invoked after GCMClient becomes ready.
   consumer()->GetGCMClient()->PerformDelayedLoading();
   WaitUntilCompleted();
   EXPECT_EQ(old_registration_id, consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest,
        PersistedRegistrationInfoRemoveAfterSignOut) {
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
   WaitUntilCompleted();
 
   // The app id and registration info should be persisted.
   EXPECT_TRUE(profile()->GetPrefs()->HasPrefPath(prefs::kGCMRegisteredAppIDs));
   EXPECT_TRUE(consumer()->HasPersistedRegistrationInfo(kTestingAppId));
 
   consumer()->SignOut();
   PumpUILoop();
 
   // The app id and persisted registration info should be removed.
   EXPECT_FALSE(profile()->GetPrefs()->HasPrefPath(prefs::kGCMRegisteredAppIDs));
   EXPECT_FALSE(consumer()->HasPersistedRegistrationInfo(kTestingAppId));
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest, RegisterAfterSignOut) {
   // This will trigger check-out.
   consumer()->SignOut();
 
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
 
   EXPECT_TRUE(consumer()->registration_id().empty());
   EXPECT_EQ(GCMClient::NOT_SIGNED_IN, consumer()->registration_result());
 }
 
 TEST_F(GCMProfileServiceSingleProfileTest, Unregister) {
   scoped_refptr<Extension> extension(consumer()->CreateExtension());
 
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(extension->id(), sender_ids);
+  consumer()->Register(extension->id(), "sender1");
 
   WaitUntilCompleted();
   EXPECT_FALSE(consumer()->registration_id().empty());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 
   // The registration info should be cached.
   EXPECT_TRUE(consumer()->ExistsCachedRegistrationInfo());
 
   // The registration info should be persisted.
   EXPECT_TRUE(consumer()->HasPersistedRegistrationInfo(extension->id()));
@@ skipping 112 matching lines @@
 
   Profile* profile2() const { return consumer2_->profile(); }
   GCMProfileServiceTestConsumer* consumer2() const { return consumer2_.get(); }
 
  protected:
   scoped_ptr<GCMProfileServiceTestConsumer> consumer2_;
 };
 
 TEST_F(GCMProfileServiceMultiProfileTest, Register) {
   // Register an app.
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
 
   // Register the same app in a different profile.
-  std::vector<std::string> sender_ids2;
-  sender_ids2.push_back("foo");
-  sender_ids2.push_back("bar");
-  consumer2()->Register(kTestingAppId, sender_ids2);
+  consumer2()->Register(kTestingAppId, "sender2");
 
   WaitUntilCompleted();
   WaitUntilCompleted();
 
-  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids),
+  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds("sender1"),
             consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 
-  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids2),
+  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds("sender2"),
             consumer2()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 
   // Register a different app in a different profile.
-  std::vector<std::string> sender_ids3;
-  sender_ids3.push_back("sender1");
-  sender_ids3.push_back("sender2");
-  sender_ids3.push_back("sender3");
-  consumer2()->Register(kTestingAppId2, sender_ids3);
+  consumer2()->Register(kTestingAppId2, "sender3");
 
   WaitUntilCompleted();
 
-  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids3),
+  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds("sender3"),
             consumer2()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer2()->registration_result());
 }
 
 TEST_F(GCMProfileServiceMultiProfileTest, Send) {
   // Send a message from one app in one profile.
   GCMClient::OutgoingMessage message;
   message.id = "1";
   message.data["key1"] = "value1";
   message.data["key2"] = "value2";
@@ skipping 71 matching lines @@
 // 3) Receive a message to an app in profile1 and receive a message for each of
 //    two apps in profile2;
 // 4) Send a message foe ach of two apps in profile2;
 // 5) Sign out of profile1.
 // 6) Register/send stops working for profile1;
 // 7) The app in profile2 could still receive these events;
 // 8) Sign into profile1 with a different user.
 // 9) The message to the new signed-in user will be routed.
 TEST_F(GCMProfileServiceMultiProfileTest, Combined) {
   // Register an app.
-  std::vector<std::string> sender_ids;
-  sender_ids.push_back("sender1");
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
 
   // Register the same app in a different profile.
-  std::vector<std::string> sender_ids2;
-  sender_ids2.push_back("foo");
-  sender_ids2.push_back("bar");
-  consumer2()->Register(kTestingAppId, sender_ids2);
+  consumer2()->Register(kTestingAppId, "sender2");
 
   // Register a different app in a different profile.
-  std::vector<std::string> sender_ids3;
-  sender_ids3.push_back("sender1");
-  sender_ids3.push_back("sender2");
-  sender_ids3.push_back("sender3");
-  consumer2()->Register(kTestingAppId2, sender_ids3);
+  consumer2()->Register(kTestingAppId2, "sender3");
 
   WaitUntilCompleted();
   WaitUntilCompleted();
   WaitUntilCompleted();
 
-  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids),
+  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds("sender1"),
             consumer()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 
-  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds(sender_ids3),
+  EXPECT_EQ(GCMClientMock::GetRegistrationIdFromSenderIds("sender3"),
             consumer2()->registration_id());
   EXPECT_EQ(GCMClient::SUCCESS, consumer()->registration_result());
 
   // Send a message from one profile.
   GCMClient::OutgoingMessage out_message;
   out_message.id = "1";
   out_message.data["out1"] = "out_data1";
   out_message.data["out1_2"] = "out_data1_2";
   consumer()->Send(kTestingAppId, kUserId, out_message);
 
@@ skipping 64 matching lines @@
   WaitUntilCompleted();
 
   EXPECT_EQ(consumer2()->send_message_id(), out_message3.id);
   EXPECT_EQ(GCMClient::SUCCESS, consumer2()->send_result());
 
   // Sign out of one profile.
   consumer()->SignOut();
 
   // Register/send stops working for signed-out profile.
   consumer()->gcm_event_router()->clear_results();
-  consumer()->Register(kTestingAppId, sender_ids);
+  consumer()->Register(kTestingAppId, "sender1");
   EXPECT_TRUE(consumer()->registration_id().empty());
   EXPECT_EQ(GCMClient::NOT_SIGNED_IN, consumer()->registration_result());
 
   consumer()->gcm_event_router()->clear_results();
   consumer()->Send(kTestingAppId2, kUserId2, out_message3);
   EXPECT_TRUE(consumer()->send_message_id().empty());
   EXPECT_EQ(GCMClient::NOT_SIGNED_IN, consumer()->send_result());
 
   // Deleted messages event will go through for another signed-in profile.
   consumer2()->GetGCMClient()->DeleteMessages(kTestingAppId2);
@@ skipping 36 matching lines @@
   consumer()->gcm_event_router()->clear_results();
   WaitUntilCompleted();
 
   EXPECT_EQ(FakeGCMEventRouter::MESSAGE_EVENT,
             consumer()->gcm_event_router()->received_event());
   EXPECT_TRUE(
       in_message5.data == consumer()->gcm_event_router()->message().data);
 }
 
 }  // namespace gcm