Provide a mechanism for the GCM driver to send message receipts to GCM.

components/gcm_driver/gcm_client_impl_unittest.cc

 // Copyright 2014 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/gcm_driver/gcm_client_impl.h"
 
 #include <stdint.h>
 
 #include <initializer_list>
 #include <memory>
@@ skipping 291 matching lines @@
   // GCMClient::Delegate overrides (for verification).
   void OnRegisterFinished(const linked_ptr<RegistrationInfo>& registration_info,
                           const std::string& registration_id,
                           GCMClient::Result result) override;
   void OnUnregisterFinished(
       const linked_ptr<RegistrationInfo>& registration_info,
       GCMClient::Result result) override;
   void OnSendFinished(const std::string& app_id,
                       const std::string& message_id,
                       GCMClient::Result result) override {}
-  void OnMessageReceived(const std::string& registration_id,
-                         const IncomingMessage& message) override;
+  void OnMessageReceived(
+      const std::string& registration_id,
+      const IncomingMessage& message,
+      const MessageReceiptCallback& receipt_callback) override;
   void OnMessagesDeleted(const std::string& app_id) override;
   void OnMessageSendError(
       const std::string& app_id,
       const gcm::GCMClient::SendErrorDetails& send_error_details) override;
   void OnSendAcknowledged(const std::string& app_id,
                           const std::string& message_id) override;
   void OnGCMReady(const std::vector<AccountMapping>& account_mappings,
                   const base::Time& last_token_fetch_time) override;
   void OnActivityRecorded() override {}
   void OnConnected(const net::IPEndPoint& ip_endpoint) override {}
@@ skipping 285 matching lines @@
 }
 
 void GCMClientImplTest::OnGCMReady(
     const std::vector<AccountMapping>& account_mappings,
     const base::Time& last_token_fetch_time) {
   last_event_ = LOADING_COMPLETED;
   last_account_mappings_ = account_mappings;
   last_token_fetch_time_ = last_token_fetch_time;
 }
 
-void GCMClientImplTest::OnMessageReceived(const std::string& registration_id,
-                                          const IncomingMessage& message) {
+void GCMClientImplTest::OnMessageReceived(
+    const std::string& registration_id,
+    const IncomingMessage& message,
+    const MessageReceiptCallback& receipt_callback) {
   last_event_ = MESSAGE_RECEIVED;
   last_app_id_ = registration_id;
   last_message_ = message;
 }
 
 void GCMClientImplTest::OnRegisterFinished(
     const linked_ptr<RegistrationInfo>& registration_info,
     const std::string& registration_id,
     GCMClient::Result result) {
   last_event_ = REGISTRATION_COMPLETED;
@@ skipping 298 matching lines @@
 
   reset_last_event();
 
   // Message from kSender3 will be dropped.
   MCSMessage message3(BuildDownstreamMessage(
       kSender3, kExtensionAppId, std::string() /* subtype */, expected_data,
       std::string() /* raw_data */));
   EXPECT_TRUE(message3.IsValid());
   ReceiveMessageFromMCS(message3);
 
+  // TODO(harkness): Add a check for invalid app handler once the
+  // DefaultAppHandler is removed.
+
   EXPECT_NE(MESSAGE_RECEIVED, last_event());
   EXPECT_NE(kExtensionAppId, last_app_id());
 }
 
 TEST_F(GCMClientImplTest, DispatchDownstreamMessageRawData) {
   std::vector<std::string> senders(1, kSender);
   AddRegistration(kExtensionAppId, senders, "reg_id");
 
   std::map<std::string, std::string> expected_data;
 
@@ skipping 833 matching lines @@
 
   // Message for kSender with a subtype will be dropped.
   MCSMessage message0(BuildDownstreamMessage(
       kSender, kProductCategoryForSubtypes, kExtensionAppId /* subtype */,
       expected_data, std::string() /* raw_data */));
   EXPECT_TRUE(message0.IsValid());
   ReceiveMessageFromMCS(message0);
 
   EXPECT_NE(MESSAGE_RECEIVED, last_event());
 
+  // Check that the last message sent was a message receipt for a failed message
+  // and that it had the values expected.
+  mcs_proto::DataMessageStanza stanza =
+      mcs_client()->last_data_message_stanza();
+  EXPECT_EQ(kExtensionAppId, stanza.category());
+  const auto& app_data = stanza.app_data();
+  ASSERT_EQ(3, app_data.size());
+  for (const auto& pair : app_data) {
+    if (pair.key() == "message_id")
+      EXPECT_EQ("", pair.value());
+    else if (pair.key() == "status")
+      EXPECT_EQ("2", pair.value());
+    else if (pair.key() == "type")
+      EXPECT_EQ("message_receipt", pair.value());
+    else
+      EXPECT_TRUE(0);

[Peter Beverloo, 2017/02/13 13:47:07]

FAIL() << "Unexpected key: " << pair.key();

[harkness, 2017/02/14 19:22:29]

Done.

+  }
+
   reset_last_event();
 
   // Message for kSender will be received.
   MCSMessage message1(BuildDownstreamMessage(
       kSender, kExtensionAppId, std::string() /* subtype */, expected_data,
       std::string() /* raw_data */));
   EXPECT_TRUE(message1.IsValid());
   ReceiveMessageFromMCS(message1);
 
   EXPECT_EQ(MESSAGE_RECEIVED, last_event());
@@ skipping 41 matching lines @@
 
   // Message for kSender without a subtype will be dropped.
   MCSMessage message0(BuildDownstreamMessage(
       kSender, kSubtypeAppId, std::string() /* subtype */, expected_data,
       std::string() /* raw_data */));
   EXPECT_TRUE(message0.IsValid());
   ReceiveMessageFromMCS(message0);
 
   EXPECT_NE(MESSAGE_RECEIVED, last_event());
 
+  // Check that the last message sent was a message receipt for a failed message
+  // and that it had the values expected.
+  mcs_proto::DataMessageStanza stanza =
+      mcs_client()->last_data_message_stanza();
+  EXPECT_EQ(kSubtypeAppId, stanza.category());
+  const auto& app_data = stanza.app_data();
+  ASSERT_EQ(3, app_data.size());
+  for (const auto& pair : app_data) {
+    if (pair.key() == "message_id")
+      EXPECT_EQ("", pair.value());
+    else if (pair.key() == "status")
+      EXPECT_EQ("2", pair.value());
+    else if (pair.key() == "type")
+      EXPECT_EQ("message_receipt", pair.value());
+    else
+      EXPECT_TRUE(0);

[Peter Beverloo, 2017/02/13 13:47:07]

dito

[harkness, 2017/02/14 19:22:29]

Done.

+  }
+
   reset_last_event();
 
   // Message for kSender will be received.
   MCSMessage message1(BuildDownstreamMessage(
       kSender, kProductCategoryForSubtypes, kSubtypeAppId /* subtype */,
       expected_data, std::string() /* raw_data */));
   EXPECT_TRUE(message1.IsValid());
   ReceiveMessageFromMCS(message1);
 
   EXPECT_EQ(MESSAGE_RECEIVED, last_event());
@@ skipping 53 matching lines @@
   ReceiveMessageFromMCS(message);
 
   EXPECT_EQ(MESSAGE_RECEIVED, last_event());
   EXPECT_EQ(kExtensionAppId, last_app_id());
   EXPECT_EQ(expected_data.size(), last_message().data.size());
   EXPECT_EQ(expected_data, last_message().data);
   EXPECT_EQ(kSender, last_message().sender_id);
 }
 
 }  // namespace gcm