v4_update_protocol_manager: Basic implementation with TODOs

components/safe_browsing_db/v4_protocol_manager_util.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 COMPONENTS_SAFE_BROWSING_DB_V4_PROTOCOL_MANAGER_UTIL_H_
 #define COMPONENTS_SAFE_BROWSING_DB_V4_PROTOCOL_MANAGER_UTIL_H_
 
 // A class that implements the stateless methods used by the GetHashUpdate and
 // GetFullHash stubby calls made by Chrome using the SafeBrowsing V4 protocol.
 
 #include <string>
 
 #include "base/gtest_prod_util.h"
+#include "components/safe_browsing_db/safebrowsing.pb.h"
 #include "net/url_request/url_request_status.h"
 #include "url/gurl.h"
 
 namespace safe_browsing {
-
 // Config passed to the constructor of a V4 protocol manager.
 struct V4ProtocolConfig {
   // The safe browsing client name sent in each request.
   std::string client_name;
 
   // Current product version sent in each request.
   std::string version;
 
   // The Google API key.
   std::string key_param;
 };
 
+// The information required to uniquely identify each list the client is
+// interested in maintaining and downloading from the SafeBrowsing servers.
+// For example, for digests of Malware binaries on Windows:
+// platform_type = WINDOWS,
+// threat_entry_type = BINARY_DIGEST,
+// threat_type = MALWARE
+struct UpdateListIdentifier {
+  PlatformType platform_type;
+  ThreatEntryType threat_entry_type;
+  ThreatType threat_type;
+};
+
+// A class that provides static methods related to the Pver4 protocol.
 class V4ProtocolManagerUtil {
  public:
+  // Enumerate failures for histogramming purposes.  DO NOT CHANGE THE
+  // ORDERING OF THESE VALUES.
+  enum OperationResultType {

[Nathan Parker, 2016/03/22 23:57:54]

nit: How about just "OperationResult"?

Another idea: You could call it "class enum V4ProtocolResult" and put it outside
this class, so it's not a nested type.  Then the values would be ref'd by
V4ProtocolResult::PARSE_ERROR, etc.  Your choice...

[vakh (use Gerrit instead), 2016/03/24 22:34:24]

Done. Changed to enum V4OperationResult outside the class.
UMA_HISTOGRAM_ENUMERATION doesn't allow "enum class"

+    // 200 response code means that the server recognized the request.
+    STATUS_200 = 0,
+
+    // Subset of successful responses where the response body wasn't parsable.
+    PARSE_ERROR = 1,
+
+    // Operation request failed (network error).
+    NETWORK_ERROR = 2,
+
+    // Operation request returned HTTP result code other than 200.
+    HTTP_ERROR = 3,
+
+    // Operation attempted during error backoff, no request sent.
+    BACKOFF_ERROR = 4,
+
+    // Operation attempted before min wait duration elapsed, no request sent.
+    MIN_WAIT_DURATION_ERROR = 5,
+
+    // Identical operation already pending.
+    ALREADY_PENDING_ERROR = 6,
+
+    // Memory space for histograms is determined by the max.  ALWAYS
+    // ADD NEW VALUES BEFORE THIS ONE.
+    OPERATION_RESULT_TYPE_MAX = 7
+  };
+
   // Record HTTP response code when there's no error in fetching an HTTP
   // request, and the error code, when there is.
   // |metric_name| is the name of the UMA metric to record the response code or
   // error code against, |status| represents the status of the HTTP request, and
   // |response code| represents the HTTP response code received from the server.
   static void RecordHttpResponseOrErrorCode(const char* metric_name,
                                             const net::URLRequestStatus& status,
                                             int response_code);
 
   // Generates a Pver4 request URL.
@@ skipping 27 matching lines @@
                                 const std::string& client_id,
                                 const std::string& version,
                                 const std::string& key_param);
 
   DISALLOW_COPY_AND_ASSIGN(V4ProtocolManagerUtil);
 };
 
 }  // namespace safe_browsing
 
 #endif  // COMPONENTS_SAFE_BROWSING_DB_V4_PROTOCOL_MANAGER_UTIL_H_