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

components/gcm_driver/gcm_driver_desktop.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_driver_desktop.h"
 
 #include <utility>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
@@ skipping 36 matching lines @@
   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& app_id,
-                         const IncomingMessage& message) override;
+                         const IncomingMessage& message,
+                         const MessageReceiptCallback& callback) override;
   void OnMessagesDeleted(const std::string& app_id) override;
   void OnMessageSendError(
       const std::string& app_id,
       const 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 36 matching lines @@
   void GetToken(const std::string& app_id,
                 const std::string& authorized_entity,
                 const std::string& scope,
                 const std::map<std::string, std::string>& options);
   void DeleteToken(const std::string& app_id,
                    const std::string& authorized_entity,
                    const std::string& scope);
 
   void RecordDecryptionFailure(const std::string& app_id,
                                GCMEncryptionProvider::DecryptionResult result);
+  void SendMessageReceipt(const MessageReceiptCallback& callback,
+                          GCMMessageStatus status);
 
   // For testing purpose. Can be called from UI thread. Use with care.
   GCMClient* gcm_client_for_testing() const { return gcm_client_.get(); }
 
  private:
   scoped_refptr<base::SequencedTaskRunner> ui_thread_;
   scoped_refptr<base::SequencedTaskRunner> io_thread_;
 
   base::WeakPtr<GCMDriverDesktop> service_;
 
@@ skipping 102 matching lines @@
   DCHECK(io_thread_->RunsTasksOnCurrentThread());
 
   ui_thread_->PostTask(
       FROM_HERE,
       base::Bind(&GCMDriverDesktop::SendFinished, service_, app_id, message_id,
                  result));
 }
 
 void GCMDriverDesktop::IOWorker::OnMessageReceived(
     const std::string& app_id,
-    const IncomingMessage& message) {
+    const IncomingMessage& message,
+    const MessageReceiptCallback& callback) {
   DCHECK(io_thread_->RunsTasksOnCurrentThread());
 
-  ui_thread_->PostTask(
-      FROM_HERE,
-      base::Bind(&GCMDriverDesktop::MessageReceived,
-                 service_,
-                 app_id,
-                 message));
+  ui_thread_->PostTask(FROM_HERE,
+                       base::Bind(&GCMDriverDesktop::MessageReceived, service_,
+                                  app_id, message, callback));
 }
 
 void GCMDriverDesktop::IOWorker::OnMessagesDeleted(const std::string& app_id) {
   DCHECK(io_thread_->RunsTasksOnCurrentThread());
 
   ui_thread_->PostTask(
       FROM_HERE,
       base::Bind(&GCMDriverDesktop::MessagesDeleted, service_, app_id));
 }
 
@@ skipping 248 matching lines @@
   gcm_client_->RemoveHeartbeatInterval(scope);
 }
 
 void GCMDriverDesktop::IOWorker::RecordDecryptionFailure(
     const std::string& app_id,
     GCMEncryptionProvider::DecryptionResult result) {
   DCHECK(io_thread_->RunsTasksOnCurrentThread());
   gcm_client_->RecordDecryptionFailure(app_id, result);
 }
 
+void GCMDriverDesktop::IOWorker::SendMessageReceipt(
+    const MessageReceiptCallback& callback,
+    GCMMessageStatus status) {
+  DCHECK(io_thread_->RunsTasksOnCurrentThread());
+
+  // The callback was created by the GCMClient on the IO thead so it is safe to
+  // invoke from here.
+  callback.Run(status);
+}
+
 GCMDriverDesktop::GCMDriverDesktop(
     std::unique_ptr<GCMClientFactory> gcm_client_factory,
     const GCMClient::ChromeBuildInfo& chrome_build_info,
     const std::string& channel_status_request_url,
     const std::string& user_agent,
     PrefService* prefs,
     const base::FilePath& store_path,
     const scoped_refptr<net::URLRequestContextGetter>& request_context,
     const scoped_refptr<base::SequencedTaskRunner>& ui_thread,
     const scoped_refptr<base::SequencedTaskRunner>& io_thread,
@@ skipping 686 matching lines @@
   // Remove all the queued tasks since they no longer make sense after
   // GCM service is stopped.
   weak_ptr_factory_.InvalidateWeakPtrs();
 
   gcm_started_ = false;
   delayed_task_controller_.reset();
   ClearCallbacks();
 }
 
 void GCMDriverDesktop::MessageReceived(const std::string& app_id,
-                                       const IncomingMessage& message) {
+                                       const IncomingMessage& message,
+                                       const MessageReceiptCallback& callback) {
   DCHECK(ui_thread_->RunsTasksOnCurrentThread());
 
   // Drop the event if the service has been stopped.
   if (!gcm_started_)
     return;
 
-  DispatchMessage(app_id, message);
+  DispatchMessage(app_id, message, callback);

[Peter Beverloo, 2017/02/08 17:09:09]

The |callback| passed to DispatchMessage any beyond *must* be invoked on the UI
thread. The one that's being passed now *must* be invoked on the IO thread.

The simplest path here would be to -

GCMDriverDesktop
    void SendMessageReceipt(
        const MessageReceiptCallback& io_receipt_callback,
        GCMMessageStatus status);

--> DispatchMessage(..., base::Bind(&SendMessageReceipt, callback))

GCMDriverAndroid
    void SendMessageReceipt(
        const std::string& message_id,
        const std::string& app_id,
        GCMMessageStatus status);

--> DispatchMessage(..., base::Bind(&SendMessageReceipt, message_id,
                                    app_id))

That way you don't need DoSendMessageReceipt either, since SendMessageReceipt
can take care of posting the task if needs be (desktop).

[harkness, 2017/02/09 16:27:30]

Good point, I hadn't considered that there was a step in the GCMDriver(Desktop)
where we could intercept that before it got into Dispatch Message.

Moved the re-bind to that level.

 }
 
 void GCMDriverDesktop::MessagesDeleted(const std::string& app_id) {
   DCHECK(ui_thread_->RunsTasksOnCurrentThread());
 
   // Drop the event if the service has been stopped.
   if (!gcm_started_)
     return;
 
   GetAppHandler(app_id)->OnMessagesDeleted(app_id);
@@ skipping 98 matching lines @@
     return false;
 
   if (std::get<1>(a) < std::get<1>(b))
     return true;
   if (std::get<1>(a) > std::get<1>(b))
     return false;
 
   return std::get<2>(a) < std::get<2>(b);
 }
 
+void GCMDriverDesktop::DoSendMessageReceipt(
+    const MessageReceiptCallback& callback,
+    GCMMessageStatus status) {
+  DCHECK(ui_thread_->RunsTasksOnCurrentThread());
+
+  io_thread_->PostTask(
+      FROM_HERE,
+      base::Bind(&GCMDriverDesktop::IOWorker::SendMessageReceipt,
+                 base::Unretained(io_worker_.get()), callback, status));
+}
 }  // namespace gcm