webRequest: reliably determine tabId

extensions/browser/api/web_request/web_request_event_details.h

 // Copyright 2016 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_API_WEB_REQUEST_WEB_REQUEST_EVENT_DETAILS_H_
 #define EXTENSIONS_BROWSER_API_WEB_REQUEST_WEB_REQUEST_EVENT_DETAILS_H_
 
 #include <memory>
 #include <string>
 
@@ skipping 18 matching lines @@
 // This class provides setters that are aware of these rules.
 //
 // Not all keys are managed by this class. Keys that do not require a special
 // treatment can be set using the generic SetBoolean / SetInteger / SetString
 // methods (e.g. to set "error", "message", "redirectUrl", "stage" or "tabId").
 //
 // This class should be constructed on the IO thread. It can safely be used on
 // other threads, as long as there is no concurrent access.
 class WebRequestEventDetails {
  public:
-  using DeterminedFrameIdCallback =
+  using DeterminedFrameDataCallback =
       base::Callback<void(std::unique_ptr<WebRequestEventDetails>)>;
 
   // Create a WebRequestEventDetails with the following keys:
   // - method
   // - requestId
   // - tabId
   // - timeStamp
   // - type
   // - url
   WebRequestEventDetails(const net::URLRequest* request, int extra_info_spec);
@@ skipping 32 matching lines @@
 
   void SetInteger(const std::string& key, int value) {
     dict_.SetInteger(key, value);
   }
 
   void SetString(const std::string& key, const std::string& value) {
     dict_.SetString(key, value);
   }
 
   // Sets the following keys using information from constructor.
+  // - tabId
   // - frameId
   // - parentFrameId
   // This must be called from the UI thread.
-  void DetermineFrameIdOnUI();
+  void DetermineFrameDataOnUI();
 
   // Sets the following keys using information from constructor.
+  // - tabId
   // - frameId
   // - parentFrameId
   //
-  // This method is more expensive than DetermineFrameIdOnUI because it may
-  // involve thread hops, so prefer using DetermineFrameIdOnUI() when possible.
+  // This method is more expensive than DetermineFrameDataOnUI because it may
+  // involve thread hops, so prefer using DetermineFrameDataOnUI() if possible.
   // The callback is called as soon as these IDs are determined, which can be
   // synchronous or asynchronous.
   //
   // The caller must not use or delete this WebRequestEventDetails instance
   // after calling this method. Ownership of this instance is transferred to
   // |callback|.
-  void DetermineFrameIdOnIO(const DeterminedFrameIdCallback& callback);
+  void DetermineFrameDataOnIO(const DeterminedFrameDataCallback& callback);
 
   // Create an event dictionary that contains all required keys, and also the
   // extra keys as specified by the |extra_info_spec| filter.
   // This can be called from any thread.
   std::unique_ptr<base::DictionaryValue> GetFilteredDict(
       int extra_info_spec) const;
 
   // Get the internal dictionary, unfiltered. After this call, the internal
   // dictionary is empty.
   std::unique_ptr<base::DictionaryValue> GetAndClearDict();
 
  private:
-  void OnDeterminedFrameId(std::unique_ptr<WebRequestEventDetails> self,
-                           const DeterminedFrameIdCallback& callback,
-                           const ExtensionApiFrameIdMap::FrameData& frame_data);
+  void OnDeterminedFrameData(
+      std::unique_ptr<WebRequestEventDetails> self,
+      const DeterminedFrameDataCallback& callback,
+      const ExtensionApiFrameIdMap::FrameData& frame_data);
 
   // The details that are always included in a webRequest event object.
   base::DictionaryValue dict_;
 
   // Extra event details: Only included when |extra_info_spec_| matches.
   std::unique_ptr<base::DictionaryValue> request_body_;
   std::unique_ptr<base::ListValue> request_headers_;
   std::unique_ptr<base::ListValue> response_headers_;
 
   int extra_info_spec_;
 
-  // Used to determine the frameId and parentFrameId.
+  // Used to determine the tabId, frameId and parentFrameId.
   int render_process_id_;
   int render_frame_id_;
 
   DISALLOW_COPY_AND_ASSIGN(WebRequestEventDetails);
 };
 
 }  // namespace extensions
 
 #endif  // EXTENSIONS_BROWSER_API_WEB_REQUEST_WEB_REQUEST_EVENT_DETAILS_H_