[Cronet] Write effective experimental options to NetLog

components/cronet/android/cronet_url_request_context_adapter.cc

 // Copyright 2014 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 "components/cronet/android/cronet_url_request_context_adapter.h"
 
 #include <limits.h>
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 40 matching lines @@
 #include "net/base/net_errors.h"
 #include "net/base/network_delegate_impl.h"
 #include "net/base/url_util.h"
 #include "net/cert/caching_cert_verifier.h"
 #include "net/cert/cert_verifier.h"
 #include "net/cookies/cookie_monster.h"
 #include "net/http/http_auth_handler_factory.h"
 #include "net/http/http_server_properties_manager.h"
 #include "net/log/file_net_log_observer.h"
 #include "net/log/net_log_util.h"
-#include "net/log/write_to_file_net_log_observer.h"
 #include "net/nqe/external_estimate_provider.h"
 #include "net/nqe/network_qualities_prefs_manager.h"
 #include "net/proxy/proxy_config_service_android.h"
 #include "net/proxy/proxy_service.h"
 #include "net/sdch/sdch_owner.h"
 #include "net/ssl/channel_id_service.h"
 #include "net/url_request/url_request_context.h"
 #include "net/url_request/url_request_context_builder.h"
 #include "net/url_request/url_request_interceptor.h"
 
@@ skipping 427 matching lines @@
   if (pref_service_)
     pref_service_->CommitPendingWrite();
   if (network_quality_estimator_) {
     network_quality_estimator_->RemoveRTTObserver(this);
     network_quality_estimator_->RemoveThroughputObserver(this);
     network_quality_estimator_->RemoveEffectiveConnectionTypeObserver(this);
     network_quality_estimator_->RemoveRTTAndThroughputEstimatesObserver(this);
   }
 
   // Stop NetLog observer if there is one.
-  StopNetLogHelper();
+  StopNetLogOnNetworkThread();
 }
 
 void CronetURLRequestContextAdapter::InitRequestContextOnMainThread(
     JNIEnv* env,
     const JavaParamRef<jobject>& jcaller) {
   base::android::ScopedJavaGlobalRef<jobject> jcaller_ref;
   jcaller_ref.Reset(env, jcaller);
   proxy_config_service_ = net::ProxyService::CreateSystemProxyConfigService(
       GetNetworkTaskRunner(), nullptr /* Ignored on Android */);
   net::ProxyConfigServiceAndroid* android_proxy_config_service =
@@ skipping 83 matching lines @@
                             base::Unretained(this), should));
 }
 
 void CronetURLRequestContextAdapter::InitializeOnNetworkThread(
     std::unique_ptr<URLRequestContextConfig> config,
     const base::android::ScopedJavaGlobalRef<jobject>&
         jcronet_url_request_context) {
   DCHECK(GetNetworkTaskRunner()->BelongsToCurrentThread());
   DCHECK(!is_context_initialized_);
   DCHECK(proxy_config_service_);
+
   // TODO(mmenke):  Add method to have the builder enable SPDY.
   net::URLRequestContextBuilder context_builder;
 
   std::unique_ptr<net::NetworkDelegate> network_delegate(
       new BasicNetworkDelegate());
 #if defined(DATA_REDUCTION_PROXY_SUPPORT)
   DCHECK(!data_reduction_proxy_);
   // For now, the choice to enable the data reduction proxy happens once,
   // at initialization. It cannot be disabled thereafter.
   if (!config->data_reduction_proxy_key.empty()) {
@@ skipping 18 matching lines @@
   // URL is present. Create a proxy service without a resolver and rely on this
   // local HTTP proxy. See: crbug.com/432539.
   context_builder.set_proxy_service(
       net::ProxyService::CreateWithoutProxyResolver(
           std::move(proxy_config_service_), g_net_log.Get().net_log()));
 
   config->ConfigureURLRequestContextBuilder(&context_builder,
                                             g_net_log.Get().net_log(),
                                             GetFileThread()->task_runner());
 
+  effective_experimental_options_ =
+      std::move(config->effective_experimental_options);
+
   // Set up pref file if storage path is specified.
   if (!config->storage_path.empty()) {
     base::FilePath storage_path(config->storage_path);
     // Make sure storage directory has correct version.
     InitializeStorageDirectory(storage_path);
     base::FilePath filepath =
         storage_path.Append(FILE_PATH_LITERAL(kPrefsDirectoryName))
             .Append(FILE_PATH_LITERAL(kPrefsFileName));
     json_pref_store_ =
         new JsonPrefStore(filepath, GetFileThread()->task_runner(),
@@ skipping 206 matching lines @@
 
 bool CronetURLRequestContextAdapter::IsOnNetworkThread() const {
   return GetNetworkTaskRunner()->BelongsToCurrentThread();
 }
 
 scoped_refptr<base::SingleThreadTaskRunner>
 CronetURLRequestContextAdapter::GetNetworkTaskRunner() const {
   return network_thread_->task_runner();
 }
 
-bool CronetURLRequestContextAdapter::StartNetLogToFile(
+void CronetURLRequestContextAdapter::StartNetLogToFile(
     JNIEnv* env,
     const JavaParamRef<jobject>& jcaller,
     const JavaParamRef<jstring>& jfile_name,
     jboolean jlog_all) {
-  base::AutoLock lock(write_to_file_observer_lock_);
-  // Do nothing if already logging to a file.
-  if (write_to_file_observer_)
-    return true;
-  std::string file_name =
-      base::android::ConvertJavaStringToUTF8(env, jfile_name);
-  base::FilePath file_path(file_name);
-  base::ScopedFILE file(base::OpenFile(file_path, "w"));
-  if (!file) {
-    LOG(ERROR) << "Failed to open NetLog file for writing.";
-    return false;
-  }
-
-  write_to_file_observer_.reset(new net::WriteToFileNetLogObserver());
-  if (jlog_all == JNI_TRUE) {
-    write_to_file_observer_->set_capture_mode(
-        net::NetLogCaptureMode::IncludeSocketBytes());
-  }
-  write_to_file_observer_->StartObserving(
-      g_net_log.Get().net_log(), std::move(file),
-      /*constants=*/nullptr, /*url_request_context=*/nullptr);
-
-  return true;
+  PostTaskToNetworkThread(
+      FROM_HERE,
+      base::Bind(&CronetURLRequestContextAdapter::StartNetLogOnNetworkThread,
+                 base::Unretained(this),
+                 base::android::ConvertJavaStringToUTF8(env, jfile_name),
+                 jlog_all == JNI_TRUE));
 }
 
 void CronetURLRequestContextAdapter::StartNetLogToDisk(
     JNIEnv* env,
     const JavaParamRef<jobject>& jcaller,
     const JavaParamRef<jstring>& jdir_name,
     jboolean jlog_all,
     jint jmax_size) {
   PostTaskToNetworkThread(
       FROM_HERE,
       base::Bind(&CronetURLRequestContextAdapter::
                      StartNetLogToBoundedFileOnNetworkThread,
                  base::Unretained(this),
                  base::android::ConvertJavaStringToUTF8(env, jdir_name),
                  jlog_all, jmax_size));
 }
 
 void CronetURLRequestContextAdapter::StopNetLog(
     JNIEnv* env,
     const JavaParamRef<jobject>& jcaller) {
-  StopNetLogHelper();
+  DCHECK(!GetNetworkTaskRunner()->BelongsToCurrentThread());
+  PostTaskToNetworkThread(
+      FROM_HERE,
+      base::Bind(&CronetURLRequestContextAdapter::StopNetLogOnNetworkThread,
+                 base::Unretained(this)));
 }
 
 void CronetURLRequestContextAdapter::GetCertVerifierData(
     JNIEnv* env,
     const JavaParamRef<jobject>& jcaller) {
   PostTaskToNetworkThread(
       FROM_HERE,
       base::Bind(
           &CronetURLRequestContextAdapter::GetCertVerifierDataOnNetworkThread,
           base::Unretained(this)));
@@ skipping 66 matching lines @@
 void CronetURLRequestContextAdapter::OnThroughputObservation(
     int32_t throughput_kbps,
     const base::TimeTicks& timestamp,
     net::NetworkQualityObservationSource source) {
   Java_CronetUrlRequestContext_onThroughputObservation(
       base::android::AttachCurrentThread(), jcronet_url_request_context_,
       throughput_kbps,
       (timestamp - base::TimeTicks::UnixEpoch()).InMilliseconds(), source);
 }
 
+void CronetURLRequestContextAdapter::StartNetLogOnNetworkThread(
+    const std::string& file_name,
+    bool include_socket_bytes) {
+  DCHECK(GetNetworkTaskRunner()->BelongsToCurrentThread());
+
+  // Do nothing if already logging to a file.
+  if (net_log_file_observer_)
+    return;
+  base::FilePath file_path(file_name);
+  base::ScopedFILE file(base::OpenFile(file_path, "w"));

[kapishnikov, 2017/03/14 14:37:09]

The same file can be opened for writing twice before the |file| variable goes
out of scope: once here, and once in
net::FileNetLogObserver::CreateUnbounded(...). I guess it is okay, just to
double check.

[xunjieli, 2017/03/14 19:03:06]

Yes, it's okay. But on second thought, let's move this back to the original
method and keep the method signature to return false upon open failure. Done.

+  if (!file) {
+    LOG(ERROR) << "Failed to open NetLog file for writing.";
+    return;
+  }
+
+  net_log_file_observer_ = net::FileNetLogObserver::CreateUnbounded(
+      GetFileThread()->task_runner(), file_path, /*constants=*/nullptr);
+  CreateNetLogEntriesForActiveObjects({context_.get()},
+                                      net_log_file_observer_.get());
+  net::NetLogCaptureMode capture_mode =
+      include_socket_bytes ? net::NetLogCaptureMode::IncludeSocketBytes()
+                           : net::NetLogCaptureMode::Default();
+  net_log_file_observer_->StartObserving(g_net_log.Get().net_log(),
+                                         capture_mode);
+}
+
 void CronetURLRequestContextAdapter::StartNetLogToBoundedFileOnNetworkThread(
     const std::string& dir_path,
     bool include_socket_bytes,
     int size) {
   DCHECK(GetNetworkTaskRunner()->BelongsToCurrentThread());
 
   // Do nothing if already logging to a directory.
-  if (bounded_file_observer_)
+  if (net_log_file_observer_)
     return;
 
   // Filepath for NetLog files must exist and be writable.
   base::FilePath file_path(dir_path);
   DCHECK(base::PathIsWritable(file_path));
 
-  bounded_file_observer_ = net::FileNetLogObserver::CreateBounded(
+  net_log_file_observer_ = net::FileNetLogObserver::CreateBounded(
       GetFileThread()->task_runner(), file_path, size, kNumNetLogEventFiles,
       /*constants=*/nullptr);
 
   CreateNetLogEntriesForActiveObjects({context_.get()},
-                                      bounded_file_observer_.get());
+                                      net_log_file_observer_.get());
 
   net::NetLogCaptureMode capture_mode =
       include_socket_bytes ? net::NetLogCaptureMode::IncludeSocketBytes()
                            : net::NetLogCaptureMode::Default();
-  bounded_file_observer_->StartObserving(g_net_log.Get().net_log(),
+  net_log_file_observer_->StartObserving(g_net_log.Get().net_log(),
                                          capture_mode);
 }
 
-void CronetURLRequestContextAdapter::StopBoundedFileNetLogOnNetworkThread() {
+void CronetURLRequestContextAdapter::StopNetLogOnNetworkThread() {
   DCHECK(GetNetworkTaskRunner()->BelongsToCurrentThread());
-  bounded_file_observer_->StopObserving(
-      net::GetNetInfo(context_.get(), net::NET_INFO_ALL_SOURCES),
+
+  if (!net_log_file_observer_)
+    return;
+  net_log_file_observer_->StopObserving(
+      GetNetLogInfo(),
       base::Bind(&CronetURLRequestContextAdapter::StopNetLogCompleted,
                  base::Unretained(this)));
-  bounded_file_observer_.reset();
+  net_log_file_observer_.reset();
 }
 
 void CronetURLRequestContextAdapter::StopNetLogCompleted() {
   Java_CronetUrlRequestContext_stopNetLogCompleted(
       base::android::AttachCurrentThread(), jcronet_url_request_context_.obj());
 }
 
-void CronetURLRequestContextAdapter::StopNetLogHelper() {
-  base::AutoLock lock(write_to_file_observer_lock_);
-  DCHECK(!(write_to_file_observer_ && bounded_file_observer_));
-  if (write_to_file_observer_) {
-    write_to_file_observer_->StopObserving(/*url_request_context=*/nullptr);
-    write_to_file_observer_.reset();
-  } else if (bounded_file_observer_) {
-    PostTaskToNetworkThread(FROM_HERE,
-                            base::Bind(&CronetURLRequestContextAdapter::
-                                           StopBoundedFileNetLogOnNetworkThread,
-                                       base::Unretained(this)));
+std::unique_ptr<base::DictionaryValue>
+CronetURLRequestContextAdapter::GetNetLogInfo() const {
+  std::unique_ptr<base::DictionaryValue> net_info =
+      net::GetNetInfo(context_.get(), net::NET_INFO_ALL_SOURCES);
+  if (effective_experimental_options_) {
+    net_info->Set("cronetExperimentalParams",
+                  effective_experimental_options_->CreateDeepCopy());
   }
+  return net_info;
 }
 
 // Create a URLRequestContextConfig from the given parameters.
 static jlong CreateRequestContextConfig(
     JNIEnv* env,
     const JavaParamRef<jclass>& jcaller,
     const JavaParamRef<jstring>& juser_agent,
     const JavaParamRef<jstring>& jstorage_path,
     jboolean jquic_enabled,
     const JavaParamRef<jstring>& jquic_default_user_agent_id,
@@ skipping 117 matching lines @@
     JNIEnv* env,
     const JavaParamRef<jclass>& jcaller) {
   base::StatisticsRecorder::Initialize();
   std::vector<uint8_t> data;
   if (!HistogramManager::GetInstance()->GetDeltas(&data))
     return ScopedJavaLocalRef<jbyteArray>();
   return base::android::ToJavaByteArray(env, &data[0], data.size());
 }
 
 }  // namespace cronet