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

chrome/browser/push_messaging/push_messaging_service_unittest.cc

 // Copyright 2015 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 "content/public/browser/push_messaging_service.h"
 
 #include <stdint.h>
 
 #include <string>
 #include <vector>
 
 #include "base/command_line.h"
 #include "base/macros.h"
 #include "base/run_loop.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "chrome/browser/content_settings/host_content_settings_map_factory.h"
 #include "chrome/browser/permissions/permission_manager.h"
 #include "chrome/browser/permissions/permission_manager_factory.h"
 #include "chrome/browser/push_messaging/push_messaging_app_identifier.h"
 #include "chrome/browser/push_messaging/push_messaging_service_factory.h"
 #include "chrome/browser/push_messaging/push_messaging_service_impl.h"
 #include "chrome/browser/services/gcm/fake_gcm_profile_service.h"
 #include "chrome/browser/services/gcm/gcm_profile_service_factory.h"
 #include "chrome/test/base/testing_profile.h"
 #include "components/content_settings/core/browser/host_content_settings_map.h"
 #include "components/gcm_driver/crypto/gcm_crypto_test_helpers.h"
 #include "components/gcm_driver/fake_gcm_client_factory.h"
+#include "components/gcm_driver/gcm_message_status.h"
 #include "components/gcm_driver/gcm_profile_service.h"
 #include "content/public/common/push_event_payload.h"
 #include "content/public/common/push_subscription_options.h"
 #include "content/public/test/test_browser_thread_bundle.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 #if defined(OS_ANDROID)
 #include "components/gcm_driver/instance_id/instance_id_android.h"
 #include "components/gcm_driver/instance_id/scoped_use_fake_instance_id_android.h"
 #endif  // OS_ANDROID
@@ skipping 91 matching lines @@
                           const std::string& app_id,
                           const GURL& origin,
                           int64_t service_worker_registration_id,
                           const content::PushEventPayload& payload) {
     *app_id_out = app_id;
     *origin_out = origin;
     *service_worker_registration_id_out = service_worker_registration_id;
     *payload_out = payload;
   }
 
+  // Callback to use to observe message receipts returned to GCM.
+  void DidSendReceipt(gcm::GCMMessageStatus* status_out,
+                      gcm::GCMMessageStatus status) {
+    *status_out = status;
+  }
+
  protected:
   PushMessagingTestingProfile* profile() { return &profile_; }
 
  private:
   content::TestBrowserThreadBundle thread_bundle_;
   PushMessagingTestingProfile profile_;
 
 #if defined(OS_ANDROID)
   instance_id::InstanceIDAndroid::ScopedBlockOnAsyncTasksForTesting
       block_async_;
@@ skipping 66 matching lines @@
   // dispatch the |message| on the GCM driver as if it had actually been
   // received by Google Cloud Messaging.
   push_service->SetMessageDispatchedCallbackForTesting(base::Bind(
       &PushMessagingServiceTest::DidDispatchMessage, base::Unretained(this),
       &app_id, &dispatched_origin, &service_worker_registration_id, &payload));
 
   gcm::FakeGCMProfileService* fake_profile_service =
       static_cast<gcm::FakeGCMProfileService*>(
           gcm::GCMProfileServiceFactory::GetForProfile(profile()));
 
-  fake_profile_service->DispatchMessage(app_identifier.app_id(), message);
+  gcm::GCMMessageStatus receipt_status = gcm::GCM_UNRESOLVED;
+
+  fake_profile_service->DispatchMessage(
+      app_identifier.app_id(), message,
+      base::Bind(&PushMessagingServiceTest::DidSendReceipt,
+                 base::Unretained(this), &receipt_status));
 
   base::RunLoop().RunUntilIdle();
 
   // (6) Verify that the message, as received by the Push Messaging Service, has
   // indeed been decrypted by the GCM Driver, and has been forwarded to the
   // Service Worker that has been associated with the subscription.
   EXPECT_EQ(app_identifier.app_id(), app_id);
   EXPECT_EQ(origin, dispatched_origin);
   EXPECT_EQ(service_worker_registration_id, kTestServiceWorkerId);
 
   EXPECT_FALSE(payload.is_null);
   EXPECT_EQ(kTestPayload, payload.data);
+
+  // Verify that no receipt was sent.
+  // TODO(harkness): Once the push service sends receipts for completed
+  // messages,

[Peter Beverloo, 2017/01/13 01:46:11]

nit: weird linebreak?

[harkness, 2017/01/19 13:20:41]

Done.

+  // update this check.
+  EXPECT_EQ(gcm::GCM_UNRESOLVED, receipt_status);
 }
 
 TEST_F(PushMessagingServiceTest, NormalizeSenderInfo) {
   PushMessagingServiceImpl* push_service = profile()->GetPushMessagingService();
   ASSERT_TRUE(push_service);
 
   std::string p256dh(kTestP256Key, kTestP256Key + arraysize(kTestP256Key));
   ASSERT_EQ(65u, p256dh.size());
 
   // NIST P-256 public keys in uncompressed format will be encoded using the
@@ skipping 10 matching lines @@
 }
 
 TEST_F(PushMessagingServiceTest, DifferentEndpoints) {
   PushMessagingServiceImpl* push_service = profile()->GetPushMessagingService();
   ASSERT_TRUE(push_service);
 
   // Verifies that the service returns different endpoints depending on whether
   // support for the standard protocol is requested.
   EXPECT_NE(push_service->GetEndpoint(true), push_service->GetEndpoint(false));
 }