network service: Add job wrapper to SWControlleeRequestHandler

content/browser/service_worker/service_worker_controllee_request_handler.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 "content/browser/service_worker/service_worker_controllee_request_handler.h"
 
 #include <memory>
 #include <set>
 #include <string>
 
 #include "base/trace_event/trace_event.h"
 #include "content/browser/service_worker/service_worker_context_core.h"
 #include "content/browser/service_worker/service_worker_metrics.h"
 #include "content/browser/service_worker/service_worker_provider_host.h"
 #include "content/browser/service_worker/service_worker_registration.h"
 #include "content/browser/service_worker/service_worker_response_info.h"
+#include "content/browser/service_worker/service_worker_url_job_wrapper.h"
 #include "content/browser/service_worker/service_worker_url_request_job.h"
 #include "content/common/resource_request_body_impl.h"
 #include "content/common/service_worker/service_worker_types.h"
 #include "content/common/service_worker/service_worker_utils.h"
 #include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/resource_request_info.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/browser_side_navigation_policy.h"
 #include "content/public/common/content_client.h"
 #include "content/public/common/resource_response_info.h"
 #include "net/base/load_flags.h"
 #include "net/base/url_util.h"
 #include "net/url_request/url_request.h"
 #include "ui/base/page_transition_types.h"
 
 namespace content {
 
 namespace {
 
-bool MaybeForwardToServiceWorker(ServiceWorkerURLRequestJob* job,
+bool MaybeForwardToServiceWorker(ServiceWorkerURLJobWrapper* job,
                                  const ServiceWorkerVersion* version) {
   DCHECK(job);
   DCHECK(version);
   DCHECK_NE(version->fetch_handler_existence(),
             ServiceWorkerVersion::FetchHandlerExistence::UNKNOWN);
   if (version->fetch_handler_existence() ==
       ServiceWorkerVersion::FetchHandlerExistence::EXISTS) {
     job->ForwardToServiceWorker();
     return true;
   }
 
   job->FallbackToNetworkOrRenderer();
   return false;
 }
 
-ui::PageTransition GetPageTransition(net::URLRequest* request) {
-  const ResourceRequestInfo* info = ResourceRequestInfo::ForRequest(request);
-  // ResourceRequestInfo may not be set in some tests.
-  if (!info)
-    return ui::PAGE_TRANSITION_LINK;
-  return info->GetPageTransition();
-}
-
 }  // namespace
 
 ServiceWorkerControlleeRequestHandler::ServiceWorkerControlleeRequestHandler(
     base::WeakPtr<ServiceWorkerContextCore> context,
     base::WeakPtr<ServiceWorkerProviderHost> provider_host,
     base::WeakPtr<storage::BlobStorageContext> blob_storage_context,
     FetchRequestMode request_mode,
     FetchCredentialsMode credentials_mode,
     FetchRedirectMode redirect_mode,
     ResourceType resource_type,
@@ skipping 62 matching lines @@
   }
 
   // It's for original request (A) or redirect case (B-a or B-b).
   std::unique_ptr<ServiceWorkerURLRequestJob> job(
       new ServiceWorkerURLRequestJob(
           request, network_delegate, provider_host_->client_uuid(),
           blob_storage_context_, resource_context, request_mode_,
           credentials_mode_, redirect_mode_, resource_type_,
           request_context_type_, frame_type_, body_,
           ServiceWorkerFetchType::FETCH, base::nullopt, this));
-  job_ = job->GetWeakPtr();
+  url_job_ = base::MakeUnique<ServiceWorkerURLJobWrapper>(job->GetWeakPtr());
 
   resource_context_ = resource_context;
 
   if (is_main_resource_load_)
-    PrepareForMainResource(request);
+    PrepareForMainResource(request->url(), request->first_party_for_cookies());
   else
     PrepareForSubResource();
 
-  if (job_->ShouldFallbackToNetwork()) {
+  if (url_job_->ShouldFallbackToNetwork()) {
     // If we know we can fallback to network at this point (in case
     // the storage lookup returned immediately), just destroy the job and return
     // NULL here to fallback to network.
 
     // If this is a subresource request, all subsequent requests should also use
     // the network.
     if (!is_main_resource_load_)
       use_network_ = true;
 
     job.reset();
     ClearJob();
   }
 
   return job.release();
 }
 
 void ServiceWorkerControlleeRequestHandler::PrepareForMainResource(
-    const net::URLRequest* request) {
-  DCHECK(job_.get());
+    const GURL& url,
+    const GURL& first_party_for_cookies) {
+  DCHECK(url_job_.get());
   DCHECK(context_);
   DCHECK(provider_host_);
   TRACE_EVENT_ASYNC_BEGIN1(
       "ServiceWorker",
       "ServiceWorkerControlleeRequestHandler::PrepareForMainResource",
-      job_.get(),
-      "URL", request->url().spec());
+      url_job_.get(), "URL", url.spec());
   // The corresponding provider_host may already have associated a registration
   // in redirect case, unassociate it now.
   provider_host_->DisassociateRegistration();
 
   // Also prevent a registrater job for establishing an association to a new
   // registration while we're finding an existing registration.
   provider_host_->SetAllowAssociation(false);
 
-  stripped_url_ = net::SimplifyUrlForRequest(request->url());
+  stripped_url_ = net::SimplifyUrlForRequest(url);
   provider_host_->SetDocumentUrl(stripped_url_);
-  provider_host_->SetTopmostFrameUrl(request->first_party_for_cookies());
+  provider_host_->SetTopmostFrameUrl(first_party_for_cookies);
   context_->storage()->FindRegistrationForDocument(
       stripped_url_, base::Bind(&self::DidLookupRegistrationForMainResource,
                                 weak_factory_.GetWeakPtr()));
 }
 
 void ServiceWorkerControlleeRequestHandler::
     DidLookupRegistrationForMainResource(
         ServiceWorkerStatusCode status,
         scoped_refptr<ServiceWorkerRegistration> registration) {
-  // The job may have been canceled and then destroyed before this was invoked.
-  if (!job_)
+  // The job may have been canceled before this was invoked.
+  if (JobWasCanceled())
     return;
 
   const bool need_to_update = !force_update_started_ && registration &&
                               context_->force_update_on_page_load();
 
   if (provider_host_ && !need_to_update)
     provider_host_->SetAllowAssociation(true);
   if (status != SERVICE_WORKER_OK || !provider_host_ || !context_) {
-    job_->FallbackToNetwork();
+    url_job_->FallbackToNetwork();
     TRACE_EVENT_ASYNC_END1(
         "ServiceWorker",
         "ServiceWorkerControlleeRequestHandler::PrepareForMainResource",
-        job_.get(),
-        "Status", status);
+        url_job_.get(), "Status", status);
     return;
   }
   DCHECK(registration.get());
 
   base::Callback<WebContents*(void)> web_contents_getter;
   if (IsBrowserSideNavigationEnabled()) {
     web_contents_getter = provider_host_->web_contents_getter();
   } else if (provider_host_->process_id() != -1 &&
              provider_host_->frame_id() != -1) {
     web_contents_getter = base::Bind(
         [](int render_process_id, int render_frame_id) {
           RenderFrameHost* rfh =
               RenderFrameHost::FromID(render_process_id, render_frame_id);
           return WebContents::FromRenderFrameHost(rfh);
         },
         provider_host_->process_id(), provider_host_->frame_id());
   }
   if (!GetContentClient()->browser()->AllowServiceWorker(
           registration->pattern(), provider_host_->topmost_frame_url(),
           resource_context_, web_contents_getter)) {
-    job_->FallbackToNetwork();
+    url_job_->FallbackToNetwork();
     TRACE_EVENT_ASYNC_END2(
         "ServiceWorker",
         "ServiceWorkerControlleeRequestHandler::PrepareForMainResource",
-        job_.get(),
-        "Status", status,
-        "Info", "ServiceWorker is blocked");
+        url_job_.get(), "Status", status, "Info", "ServiceWorker is blocked");
     return;
   }
 
   if (!provider_host_->IsContextSecureForServiceWorker()) {
     // TODO(falken): Figure out a way to surface in the page's DevTools
     // console that the service worker was blocked for security.
-    job_->FallbackToNetwork();
+    url_job_->FallbackToNetwork();
     TRACE_EVENT_ASYNC_END1(
         "ServiceWorker",
         "ServiceWorkerControlleeRequestHandler::PrepareForMainResource",
-        job_.get(), "Info", "Insecure context");
+        url_job_.get(), "Info", "Insecure context");
     return;
   }
 
   if (need_to_update) {
     force_update_started_ = true;
     context_->UpdateServiceWorker(
         registration.get(), true /* force_bypass_cache */,
         true /* skip_script_comparison */, provider_host_.get(),
         base::Bind(&self::DidUpdateRegistration, weak_factory_.GetWeakPtr(),
                    registration));
@@ skipping 13 matching lines @@
   // Wait until it's activated before firing fetch events.
   if (active_version.get() &&
       active_version->status() == ServiceWorkerVersion::ACTIVATING) {
     provider_host_->SetAllowAssociation(false);
     registration->active_version()->RegisterStatusChangeCallback(base::Bind(
         &self::OnVersionStatusChanged, weak_factory_.GetWeakPtr(),
         base::RetainedRef(registration), base::RetainedRef(active_version)));
     TRACE_EVENT_ASYNC_END2(
         "ServiceWorker",
         "ServiceWorkerControlleeRequestHandler::PrepareForMainResource",
-        job_.get(),
-        "Status", status,
-        "Info", "Wait until finished SW activation");
+        url_job_.get(), "Status", status, "Info",
+        "Wait until finished SW activation");
     return;
   }
 
   // A registration exists, so associate it. Note that the controller is only
   // set if there's an active version. If there's no active version, we should
   // still associate so the provider host can use .ready.
   provider_host_->AssociateRegistration(registration.get(),
                                         false /* notify_controllerchange */);
 
   if (!active_version.get() ||
       active_version->status() != ServiceWorkerVersion::ACTIVATED) {
-    job_->FallbackToNetwork();
+    url_job_->FallbackToNetwork();
     TRACE_EVENT_ASYNC_END2(
         "ServiceWorker",
         "ServiceWorkerControlleeRequestHandler::PrepareForMainResource",
-        job_.get(),
-        "Status", status,
-        "Info",
+        url_job_.get(), "Status", status, "Info",
         "ServiceWorkerVersion is not available, so falling back to network");
     return;
   }
 
   DCHECK_NE(active_version->fetch_handler_existence(),
             ServiceWorkerVersion::FetchHandlerExistence::UNKNOWN);
   ServiceWorkerMetrics::CountControlledPageLoad(
       active_version->site_for_uma(), stripped_url_, is_main_frame_load_,
-      GetPageTransition(job_->request()), job_->request()->url_chain().size());
+      url_job_->GetPageTransition(), url_job_->GetURLChainSize());
 
   bool is_forwarded =
-      MaybeForwardToServiceWorker(job_.get(), active_version.get());
+      MaybeForwardToServiceWorker(url_job_.get(), active_version.get());
 
   TRACE_EVENT_ASYNC_END2(
       "ServiceWorker",
       "ServiceWorkerControlleeRequestHandler::PrepareForMainResource",
-      job_.get(), "Status", status, "Info",
+      url_job_.get(), "Status", status, "Info",
       (is_forwarded) ? "Forwarded to the ServiceWorker"
                      : "Skipped the ServiceWorker which has no fetch handler");
 }
 
 void ServiceWorkerControlleeRequestHandler::OnVersionStatusChanged(
     ServiceWorkerRegistration* registration,
     ServiceWorkerVersion* version) {
-  // The job may have been canceled and then destroyed before this was invoked.
-  if (!job_)
+  // The job may have been canceled before this was invoked.
+  if (JobWasCanceled())
     return;
 
   if (provider_host_)
     provider_host_->SetAllowAssociation(true);
   if (version != registration->active_version() ||
       version->status() != ServiceWorkerVersion::ACTIVATED ||
       !provider_host_) {
-    job_->FallbackToNetwork();
+    url_job_->FallbackToNetwork();
     return;
   }
 
   DCHECK_NE(version->fetch_handler_existence(),
             ServiceWorkerVersion::FetchHandlerExistence::UNKNOWN);
   ServiceWorkerMetrics::CountControlledPageLoad(
       version->site_for_uma(), stripped_url_, is_main_frame_load_,
-      GetPageTransition(job_->request()), job_->request()->url_chain().size());
+      url_job_->GetPageTransition(), url_job_->GetURLChainSize());
 
   provider_host_->AssociateRegistration(registration,
                                         false /* notify_controllerchange */);
 
-  MaybeForwardToServiceWorker(job_.get(), version);
+  MaybeForwardToServiceWorker(url_job_.get(), version);
 }
 
 void ServiceWorkerControlleeRequestHandler::DidUpdateRegistration(
     const scoped_refptr<ServiceWorkerRegistration>& original_registration,
     ServiceWorkerStatusCode status,
     const std::string& status_message,
     int64_t registration_id) {
   DCHECK(force_update_started_);
 
-  // The job may have been canceled and then destroyed before this was invoked.
-  if (!job_)
+  // The job may have been canceled before this was invoked.
+  if (JobWasCanceled())
     return;
 
   if (!context_) {
-    job_->FallbackToNetwork();
+    url_job_->FallbackToNetwork();
     return;
   }
   if (status != SERVICE_WORKER_OK ||
       !original_registration->installing_version()) {
     // Update failed. Look up the registration again since the original
     // registration was possibly unregistered in the meantime.
     context_->storage()->FindRegistrationForDocument(
         stripped_url_, base::Bind(&self::DidLookupRegistrationForMainResource,
                                   weak_factory_.GetWeakPtr()));
     return;
   }
   DCHECK_EQ(original_registration->id(), registration_id);
   scoped_refptr<ServiceWorkerVersion> new_version =
       original_registration->installing_version();
   new_version->ReportForceUpdateToDevTools();
   new_version->set_skip_waiting(true);
   new_version->RegisterStatusChangeCallback(base::Bind(
       &self::OnUpdatedVersionStatusChanged, weak_factory_.GetWeakPtr(),
       original_registration, new_version));
 }
 
 void ServiceWorkerControlleeRequestHandler::OnUpdatedVersionStatusChanged(
     const scoped_refptr<ServiceWorkerRegistration>& registration,
     const scoped_refptr<ServiceWorkerVersion>& version) {
-  // The job may have been canceled and then destroyed before this was invoked.
-  if (!job_)
+  // The job may have been canceled before this was invoked.
+  if (JobWasCanceled())
     return;
 
   if (!context_) {
-    job_->FallbackToNetwork();
+    url_job_->FallbackToNetwork();
     return;
   }
   if (version->status() == ServiceWorkerVersion::ACTIVATED ||
       version->status() == ServiceWorkerVersion::REDUNDANT) {
     // When the status is REDUNDANT, the update failed (eg: script error), we
     // continue with the incumbent version.
     // In case unregister job may have run, look up the registration again.
     context_->storage()->FindRegistrationForDocument(
         stripped_url_, base::Bind(&self::DidLookupRegistrationForMainResource,
                                   weak_factory_.GetWeakPtr()));
     return;
   }
   version->RegisterStatusChangeCallback(
       base::Bind(&self::OnUpdatedVersionStatusChanged,
                  weak_factory_.GetWeakPtr(), registration, version));
 }
 
 void ServiceWorkerControlleeRequestHandler::PrepareForSubResource() {
-  DCHECK(job_.get());
+  DCHECK(url_job_.get());

[kinuko, 2017/05/18 01:59:29]

This needs to be DCHECK(!JobWasCanceled()) I think

[scottmg, 2017/05/18 03:25:59]

Thank you! Done.

   DCHECK(context_);
 
   // When this request handler was created, the provider host had a controller
   // and hence an active version, but by the time MaybeCreateJob() is called
   // the active version may have been lost. This happens when
   // ServiceWorkerRegistration::DeleteVersion() was called to delete the worker
   // because a permanent failure occurred when trying to start it.
   //
   // As this is an exceptional case, just error out.
   // TODO(falken): Figure out if |active_version| can change to
   // |controlling_version| and do it or document the findings.
   if (!provider_host_->active_version()) {
-    job_->FailDueToLostController();
+    url_job_->FailDueToLostController();
     return;
   }
 
-  MaybeForwardToServiceWorker(job_.get(), provider_host_->active_version());
+  MaybeForwardToServiceWorker(url_job_.get(), provider_host_->active_version());
 }
 
 void ServiceWorkerControlleeRequestHandler::OnPrepareToRestart() {
   use_network_ = true;
   ClearJob();
 }
 
 ServiceWorkerVersion*
 ServiceWorkerControlleeRequestHandler::GetServiceWorkerVersion(
     ServiceWorkerMetrics::URLRequestJobResult* result) {
@@ skipping 19 matching lines @@
   return true;
 }
 
 void ServiceWorkerControlleeRequestHandler::MainResourceLoadFailed() {
   DCHECK(provider_host_);
   // Detach the controller so subresource requests also skip the worker.
   provider_host_->NotifyControllerLost();
 }
 
 void ServiceWorkerControlleeRequestHandler::ClearJob() {
-  job_.reset();
+  url_job_.reset();
+}
+
+bool ServiceWorkerControlleeRequestHandler::JobWasCanceled() const {
+  return !url_job_ || url_job_->WasCanceled();
 }
 
 }  // namespace content