Network traffic annotation added to google_apis/gaia.

google_apis/gaia/gaia_auth_fetcher.cc

 // Copyright (c) 2012 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 "google_apis/gaia/gaia_auth_fetcher.h"
 
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/json/json_reader.h"
 #include "base/json/json_writer.h"
 #include "base/macros.h"
 #include "base/profiler/scoped_tracker.h"
 #include "base/strings/string_split.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/values.h"
 #include "google_apis/gaia/gaia_auth_consumer.h"
 #include "google_apis/gaia/gaia_auth_util.h"
 #include "google_apis/gaia/gaia_constants.h"
 #include "google_apis/gaia/gaia_urls.h"
 #include "google_apis/gaia/google_service_auth_error.h"
 #include "net/base/escape.h"
 #include "net/base/load_flags.h"
 #include "net/http/http_response_headers.h"
 #include "net/http/http_status_code.h"
 #include "net/http/http_util.h"
+#include "net/traffic_annotation/network_traffic_annotation.h"
 #include "net/url_request/url_fetcher.h"
 #include "net/url_request/url_request_context_getter.h"
 #include "net/url_request/url_request_status.h"
 
 namespace {
 const int kLoadFlagsIgnoreCookies = net::LOAD_DO_NOT_SEND_COOKIES |
                                     net::LOAD_DO_NOT_SAVE_COOKIES;
 
 static bool CookiePartsContains(const std::vector<std::string>& parts,
                                 const char* part) {
@@ skipping 178 matching lines @@
 void GaiaAuthFetcher::CancelRequest() {
   fetcher_.reset();
   fetch_pending_ = false;
 }
 
 void GaiaAuthFetcher::CreateAndStartGaiaFetcher(const std::string& body,
                                                 const std::string& headers,
                                                 const GURL& gaia_gurl,
                                                 int load_flags) {
   DCHECK(!fetch_pending_) << "Tried to fetch two things at once!";
+  net::NetworkTrafficAnnotationTag traffic_annotation =

[msarda, 2017/05/03 09:03:53]

This is a helper method that creates a fetcher that interacts with GAIA (as you
can see the body, the headers, the urls and the load flags are configurable). It
is not clear to me if this needs to be annotated here with somethign generic or
if it should be an argument passed to this function. 

As you can see here
https://cs.chromium.org/chromium/src/google_apis/gaia/gaia_auth_fetcher.h?typ...
,this method is protected, and is called from 13 different places in this file.

[Ramin Halavati, 2017/05/03 09:45:06]

OK, do you that suggest I add annotation as an input to
CreateAndStartGaiaFetcher function, or constructor of GaiaAuthFetcher?

[msarda, 2017/05/10 09:01:54]

If we need to annotate each call differently, then it must be passed in the
method.

However, it is not clear to me in what detail we need to go for each of these
fetchers (can we aggregate the ones that are part of the same flow even though
they fetch different things?).

[Ramin Halavati, 2017/05/10 09:25:20]

Can we can have a generic one here?
If we decide to separate them in future, we can use (the not landed yet) new
annotation definition functions which let part of annotation be defined in
another function and part of it here.

+      net::DefineNetworkTrafficAnnotation("...", R"(
+        semantics {
+          sender: "..."
+          description: "..."
+          trigger: "..."
+          data: "..."
+          destination: WEBSITE/GOOGLE_OWNED_SERVICE/OTHER
+        }
+        policy {
+          cookies_allowed: false/true
+          cookies_store: "..."
+          setting: "..."
+          chrome_policy {
+            [POLICY_NAME] {
+              policy_options {mode: MANDATORY/RECOMMENDED/UNSET}
+              [POLICY_NAME]: ... //(value to disable it)
+            }
+          }
+          policy_exception_justification: "..."
+        })");
   fetcher_ = net::URLFetcher::Create(
       0, gaia_gurl, body.empty() ? net::URLFetcher::GET : net::URLFetcher::POST,
-      this);
+      this, traffic_annotation);
   fetcher_->SetRequestContext(getter_);
   fetcher_->SetUploadData("application/x-www-form-urlencoded", body);
   gaia::MarkURLFetcherAsGaia(fetcher_.get());
 
   VLOG(2) << "Gaia fetcher URL: " << gaia_gurl.spec();
   VLOG(2) << "Gaia fetcher headers: " << headers;
   VLOG(2) << "Gaia fetcher body: " << body;
 
   // The Gaia token exchange requests do not require any cookie-based
   // identification as part of requests.  We suppress sending any cookies to
@@ skipping 775 matching lines @@
   return alleged_error.find(kSecondFactor) !=
       std::string::npos;
 }
 
 // static
 bool GaiaAuthFetcher::IsWebLoginRequiredSuccess(
     const std::string& alleged_error) {
   return alleged_error.find(kWebLoginRequired) !=
       std::string::npos;
 }