Fast-fail WPAD detection.

net/proxy/proxy_script_decider.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 "net/proxy/proxy_script_decider.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/compiler_specific.h"
 #include "base/format_macros.h"
 #include "base/logging.h"
+#include "base/metrics/histogram.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
 #include "net/base/net_errors.h"
 #include "net/proxy/dhcp_proxy_script_fetcher.h"
 #include "net/proxy/dhcp_proxy_script_fetcher_factory.h"
 #include "net/proxy/proxy_script_fetcher.h"
+#include "net/url_request/url_request_context.h"
 
 namespace net {
 
 namespace {
 
 bool LooksLikePacScript(const base::string16& script) {
   // Note: this is only an approximation! It may not always work correctly,
   // however it is very likely that legitimate scripts have this exact string,
   // since they must minimally define a function of this name. Conversely, a
   // file not containing the string is not likely to be a PAC script.
@@ skipping 11 matching lines @@
 // be dangerous should our top level domain registry  become out of date.
 //
 // Instead we directly resolve "wpad", and let the operating system apply the
 // DNS suffix search paths. This is the same approach taken by Firefox, and
 // compatibility hasn't been an issue.
 //
 // For more details, also check out this comment:
 // http://code.google.com/p/chromium/issues/detail?id=18575#c20
 static const char kWpadUrl[] = "http://wpad/wpad.dat";
 
+static const int kQuickCheckDelayMs = 1000;
+
 base::Value* ProxyScriptDecider::PacSource::NetLogCallback(
     const GURL* effective_pac_url,
     NetLog::LogLevel /* log_level */) const {
   base::DictionaryValue* dict = new base::DictionaryValue();
   std::string source;
   switch (type) {
     case PacSource::WPAD_DHCP:
       source = "WPAD DHCP";
       break;
     case PacSource::WPAD_DNS:
@@ skipping 14 matching lines @@
     DhcpProxyScriptFetcher* dhcp_proxy_script_fetcher,
     NetLog* net_log)
     : resolver_(NULL),
       proxy_script_fetcher_(proxy_script_fetcher),
       dhcp_proxy_script_fetcher_(dhcp_proxy_script_fetcher),
       current_pac_source_index_(0u),
       pac_mandatory_(false),
       next_state_(STATE_NONE),
       net_log_(BoundNetLog::Make(
           net_log, NetLog::SOURCE_PROXY_SCRIPT_DECIDER)),
-      fetch_pac_bytes_(false) {
+      fetch_pac_bytes_(false),
+      host_resolver_(
+          proxy_script_fetcher->GetRequestContext()->host_resolver()) {
 }
 
 ProxyScriptDecider::~ProxyScriptDecider() {
   if (next_state_ != STATE_NONE)
     Cancel();
 }
 
 int ProxyScriptDecider::Start(
     const ProxyConfig& config, const base::TimeDelta wait_delay,
     bool fetch_pac_bytes, const CompletionCallback& callback) {
@@ skipping 70 matching lines @@
     State state = next_state_;
     next_state_ = STATE_NONE;
     switch (state) {
       case STATE_WAIT:
         DCHECK_EQ(OK, rv);
         rv = DoWait();
         break;
       case STATE_WAIT_COMPLETE:
         rv = DoWaitComplete(rv);
         break;
+      case STATE_QUICK_CHECK:
+        DCHECK_EQ(OK, rv);
+        rv = DoQuickCheck();
+        break;
+      case STATE_QUICK_CHECK_COMPLETE:
+        rv = DoQuickCheckComplete(rv);
+        break;
       case STATE_FETCH_PAC_SCRIPT:
         DCHECK_EQ(OK, rv);
         rv = DoFetchPacScript();
         break;
       case STATE_FETCH_PAC_SCRIPT_COMPLETE:
         rv = DoFetchPacScriptComplete(rv);
         break;
       case STATE_VERIFY_PAC_SCRIPT:
         DCHECK_EQ(OK, rv);
         rv = DoVerifyPacScript();
         break;
       case STATE_VERIFY_PAC_SCRIPT_COMPLETE:
         rv = DoVerifyPacScriptComplete(rv);
         break;
       default:
         NOTREACHED() << "bad state";
         rv = ERR_UNEXPECTED;
         break;
     }
   } while (rv != ERR_IO_PENDING && next_state_ != STATE_NONE);
   return rv;
 }
 
 void ProxyScriptDecider::DoCallback(int result) {
   DCHECK_NE(ERR_IO_PENDING, result);
   DCHECK(!callback_.is_null());
   callback_.Run(result);
 }
 
+int ProxyScriptDecider::DoQuickCheck() {

[szym, 2013/08/23 20:45:57]

nit: Move both after DoWait() (to match my nit regarding the header)

[Elly Fong-Jones, 2013/08/26 15:17:29]

Done.

+  quick_check_started_ = base::Time::Now();
+  HostResolver::RequestInfo reqinfo(HostPortPair("wpad", 80));
+  CompletionCallback callback = base::Bind(
+      &ProxyScriptDecider::OnIOCompletion,
+      base::Unretained(this));
+
+  int rv = host_resolver_.Resolve(reqinfo, HIGHEST,  // we block startup...

[szym, 2013/08/23 20:45:57]

nit: suggest putting this comment above this line.

Also per code style: "Use full sentences."

[Elly Fong-Jones, 2013/08/26 15:17:29]

Done.

+                                  &wpad_addrs_, callback, net_log_);
+
+  // we can't get an error response - the name is known to be valid, and we
+  // don't cache negative dns responses.
+  CHECK(rv == OK || rv == ERR_IO_PENDING);
+
+  if (rv == OK) {
+    // already in cache or something and valid, we're golden
+    next_state_ = STATE_FETCH_PAC_SCRIPT;

[szym, 2013/08/23 20:45:57]

Perhaps this should be GetStartState()...
... but something tells me that you should after QUICK_CHECK we should always go
to FETCH_PAC_SCRIPT, and after WAIT we should go to either QUICK_CHECK or
VERIFY_PAC_SCRIPT, which means you need to update the other transitions in lines
252 and 276.

Frankly, I'm not quite sure if WAIT should be preceding VERIFY_PAC. I'll need to
read Eric's old comments.

+    return OK;
+  }
+
+  quick_check_timer_.Start(FROM_HERE,
+                           base::TimeDelta::FromMilliseconds(
+                              kQuickCheckDelayMs),
+                           base::Bind(callback, ERR_NAME_NOT_RESOLVED));
+
+  next_state_ = STATE_QUICK_CHECK_COMPLETE;
+  return ERR_IO_PENDING;
+}
+
+int ProxyScriptDecider::DoQuickCheckComplete(int result) {
+  base::TimeDelta delta = base::Time::Now()
+                        - quick_check_started_;
+  UMA_HISTOGRAM_TIMES("Net.WpadQuickCheck", delta);
+  host_resolver_.Cancel();
+  quick_check_timer_.Stop();
+  next_state_ = result == OK ? GetStartState() : STATE_NONE;
+  return result;
+}
+
 int ProxyScriptDecider::DoWait() {
   next_state_ = STATE_WAIT_COMPLETE;
 
   // If no waiting is required, continue on to the next state.
   if (wait_delay_.ToInternalValue() == 0)
     return OK;
 
   // Otherwise wait the specified amount of time.
   wait_timer_.Start(FROM_HERE, wait_delay_, this,
                     &ProxyScriptDecider::OnWaitTimerFired);
   net_log_.BeginEvent(NetLog::TYPE_PROXY_SCRIPT_DECIDER_WAIT);
   return ERR_IO_PENDING;
 }
 
 int ProxyScriptDecider::DoWaitComplete(int result) {
   DCHECK_EQ(OK, result);
   if (wait_delay_.ToInternalValue() != 0) {
     net_log_.EndEventWithNetErrorCode(NetLog::TYPE_PROXY_SCRIPT_DECIDER_WAIT,
                                       result);
   }
-  next_state_ = GetStartState();
+  next_state_ = STATE_QUICK_CHECK;
   return OK;
 }
 
 int ProxyScriptDecider::DoFetchPacScript() {
   DCHECK(fetch_pac_bytes_);
 
   next_state_ = STATE_FETCH_PAC_SCRIPT_COMPLETE;
 
   const PacSource& pac_source = current_pac_source();
 
@@ skipping 157 matching lines @@
 
   net_log_.AddEvent(NetLog::TYPE_CANCELLED);
 
   switch (next_state_) {
     case STATE_WAIT_COMPLETE:
       wait_timer_.Stop();
       break;
     case STATE_FETCH_PAC_SCRIPT_COMPLETE:
       proxy_script_fetcher_->Cancel();
       break;
+    case STATE_FAILED:
+      break;
     default:
       NOTREACHED();
       break;
   }
 
   // This is safe to call in any state.
   if (dhcp_proxy_script_fetcher_)
     dhcp_proxy_script_fetcher_->Cancel();
 
   DidComplete();
 }
 
 }  // namespace net