[Extensions] Consolidate ExtensionFunction::SendResponse()s

extensions/browser/extension_function.h

 // Copyright 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.
 
 #ifndef EXTENSIONS_BROWSER_EXTENSION_FUNCTION_H_
 #define EXTENSIONS_BROWSER_EXTENSION_FUNCTION_H_
 
 #include <stddef.h>
 
 #include <list>
@@ skipping 379 matching lines @@
   //
   // More specifically: call this iff Run() has already executed, it returned
   // RespondLater(), and Respond(...) hasn't already been called.
   void Respond(ResponseValue result);
 
   virtual ~ExtensionFunction();
 
   // Helper method for ExtensionFunctionDeleteTraits. Deletes this object.
   virtual void Destruct() const = 0;
 
-  // Do not call this function directly, return the appropriate ResponseAction
-  // from Run() instead. If using RespondLater then call Respond().
-  //
-  // Call with true to indicate success, false to indicate failure, in which
-  // case please set |error_|.
-  virtual void SendResponse(bool success) = 0;
-
-  // Common implementation for SendResponse.
-  void SendResponseImpl(bool success);
+  // Called after thre response is sent, allowing the function to perform any

[lazyboy, 2016/09/20 20:21:33]

s/thre/the

[Devlin, 2016/09/20 21:51:04]

Done.

+  // additional work or cleanup.
+  virtual void OnResponded() {}
 
   // Return true if the argument to this function at |index| was provided and
   // is non-null.
   bool HasOptionalArgument(size_t index);
 
   // Id of this request, used to map the response back to the caller.
   int request_id_;
 
   // The id of the profile of this function's extension.
   void* profile_id_;
@@ skipping 16 matching lines @@
   // mode extension, this will always be false, and we will limit access to
   // data from within the same profile_ (either incognito or not).
   bool include_incognito_;
 
   // True if the call was made in response of user gesture.
   bool user_gesture_;
 
   // The arguments to the API. Only non-null if argument were specified.
   std::unique_ptr<base::ListValue> args_;
 
-  // The results of the API. This should be populated by the derived class
-  // before SendResponse() is called.
+  // The results of the API. This should be populated through the Respond()/
+  // RespondNow() methods. In legacy implementations, this is set directly, and
+  // should be set before calling SendResponse().
   std::unique_ptr<base::ListValue> results_;
 
   // Any detailed error from the API. This should be populated by the derived
   // class before Run() returns.
   std::string error_;
 
   // Any class that gets a malformed message should set this to true before
   // returning.  Usually we want to kill the message sending process.
   bool bad_message_;
 
@@ skipping 11 matching lines @@
   extensions::Feature::Context source_context_type_;
 
   // The process ID of the page that triggered this function call, or -1
   // if unknown.
   int source_process_id_;
 
   // Whether this function has responded.
   bool did_respond_;
 
  private:
+  // Call with true to indicate success, false to indicate failure. If this
+  // failed, |error_| should be set.
+  void SendResponseImpl(bool success);
+
   base::ElapsedTimer timer_;
 
   // The response type of the function, if the response has been sent.
   std::unique_ptr<ResponseType> response_type_;
 
   void OnRespondingLater(ResponseValue response);
 
   DISALLOW_COPY_AND_ASSIGN(ExtensionFunction);
 };
 
@@ skipping 49 matching lines @@
   // Emits a message to the extension's devtools console.
   void WriteToConsole(content::ConsoleMessageLevel level,
                       const std::string& message);
 
   friend struct content::BrowserThread::DeleteOnThread<
       content::BrowserThread::UI>;
   friend class base::DeleteHelper<UIThreadExtensionFunction>;
 
   ~UIThreadExtensionFunction() override;
 
-  void SendResponse(bool success) override;
+  void OnResponded() override;
 
   // Sets the Blob UUIDs whose ownership is being transferred to the renderer.
   void SetTransferredBlobUUIDs(const std::vector<std::string>& blob_uuids);
 
   // The BrowserContext of this function's extension.
   // TODO(devlin): Grr... protected members. Move this to be private.
   content::BrowserContext* context_;
 
  private:
   class RenderFrameHostTracker;
@@ skipping 53 matching lines @@
 
  protected:
   friend struct content::BrowserThread::DeleteOnThread<
       content::BrowserThread::IO>;
   friend class base::DeleteHelper<IOThreadExtensionFunction>;
 
   ~IOThreadExtensionFunction() override;
 
   void Destruct() const override;
 
-  void SendResponse(bool success) override;
-
  private:
   base::WeakPtr<extensions::IOThreadExtensionMessageFilter> ipc_sender_;
   int routing_id_;
 
   scoped_refptr<const extensions::InfoMap> extension_info_map_;
 
   DISALLOW_COPY_AND_ASSIGN(IOThreadExtensionFunction);
 };
 
 // Base class for an extension function that runs asynchronously *relative to
 // the browser's UI thread*.
 class AsyncExtensionFunction : public UIThreadExtensionFunction {
  public:
   AsyncExtensionFunction();
 
  protected:
   ~AsyncExtensionFunction() override;
 
   // Deprecated: Override UIThreadExtensionFunction and implement Run() instead.
   //
   // AsyncExtensionFunctions implement this method. Return true to indicate that
   // nothing has gone wrong yet; SendResponse must be called later. Return false
   // to respond immediately with an error.
   virtual bool RunAsync() = 0;
 
   // ValidationFailure override to match RunAsync().
   static bool ValidationFailure(AsyncExtensionFunction* function);
 
+  // Responds with success/failure. |results_| or |error_| should be set
+  // accordingly.
+  void SendResponse(bool success);
+
  private:
   // If you're hitting a compile error here due to "final" - great! You're
   // doing the right thing, you just need to extend UIThreadExtensionFunction
   // instead of AsyncExtensionFunction.
   ResponseAction Run() final;
 
   DISALLOW_COPY_AND_ASSIGN(AsyncExtensionFunction);
 };
 
 #endif  // EXTENSIONS_BROWSER_EXTENSION_FUNCTION_H_