Add throttling to permission reporter

chrome/browser/safe_browsing/permission_reporter.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 CHROME_BROWSER_SAFE_BROWSING_PERMISSION_REPORTER_H_
 #define CHROME_BROWSER_SAFE_BROWSING_PERMISSION_REPORTER_H_
 
+#include <queue>
 #include <string>
+#include <unordered_map>
 
+#include "base/time/time.h"
 #include "chrome/browser/permissions/permission_uma_util.h"
 #include "url/gurl.h"
 
+namespace base {
+class Clock;
+}  // namespace base
+
 namespace net {
 class ReportSender;
 class URLRequestContext;
 }  // namespace net
 
 namespace safe_browsing {
 
+struct PermissionAndOrigin {
+  bool operator==(const PermissionAndOrigin& other) const;
+
+  content::PermissionType permission;
+  GURL origin;
+};
+
+struct PermissionAndOriginHash {
+  std::size_t operator()(
+      const PermissionAndOrigin& permission_and_origin) const;
+};

[raymes, 2016/06/29 07:09:17]

nit: If we define these as nested classes within PermissionReporter, we can just
forward declare them in the header and have the complexity defined in the cc
file which might be a bit nicer. 

[stefanocs, 2016/06/30 00:24:51]

Do you mean these structs should be forward declared in this header file and
have the declaration and definition in the cc file? That's what I was trying to
do but the hash table needs to know the declaration of these structs in the this
file.

+
 // Provides functionality for building and serializing reports about permissions
 // to a report collection server.
 class PermissionReporter {
  public:
   // Creates a permission reporter that will send permission reports to
   // the SafeBrowsing permission action server, using |request_context| as the
   // context for the reports.
   explicit PermissionReporter(net::URLRequestContext* request_context);
 
   ~PermissionReporter();
 
   // Sends a serialized permission report to the report collection server.
   // The permission report includes |origin| as the origin of
   // the site requesting permission, |permission| as the type of permission
   // requested, and |action| as the action taken. The report will be serialized
   // using protobuf defined in
   // //src/chrome/common/safe_browsing/permission_report.proto
   void SendReport(const GURL& origin,
                   content::PermissionType permission,
                   PermissionAction action);
 
  private:
   friend class PermissionReporterTest;
 
   // Used by tests. This constructor allows tests to have access to the
-  // ReportSender.
-  explicit PermissionReporter(std::unique_ptr<net::ReportSender> report_sender);
+  // ReportSender and use a test Clock.
+  explicit PermissionReporter(std::unique_ptr<net::ReportSender> report_sender,
+                              std::unique_ptr<base::Clock> clock);
 
   // Builds and serializes a permission report with |origin| as the origin of
   // the site requesting permission, |permission| as the type of permission
   // requested, and |action| as the action taken. The serialized report is
   // written into |output|. Returns true if the serialization was successful and
   // false otherwise.
   static bool BuildReport(const GURL& origin,
                           content::PermissionType permission,
                           PermissionAction action,
                           std::string* output);
 
+  // Returns true if the number of reports sent in the last one minute per
+  // origin per permission is under a threshold, otherwise false.
+  bool IsAllowedToSend(content::PermissionType permission, const GURL& origin);
+
   std::unique_ptr<net::ReportSender> permission_report_sender_;
 
+  std::unordered_map<PermissionAndOrigin,
+                     std::queue<base::Time>,
+                     PermissionAndOriginHash>
+      sent_histories;

[raymes, 2016/06/29 07:09:17]

It seems like we might need this complexity then unless we change the
definition. Let's get Kendra's thoughts.

[stefanocs, 2016/06/30 00:24:51]

Acknowledged.

+
+  std::unique_ptr<base::Clock> clock_;
+
   DISALLOW_COPY_AND_ASSIGN(PermissionReporter);
 };
 
 }  // namespace safe_browsing
 
 #endif  // CHROME_BROWSER_SAFE_BROWSING_PERMISSION_REPORTER_H_