transferSize implementation

third_party/WebKit/Source/core/fetch/ResourceFetcher.cpp

 /*
     Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
     Copyright (C) 2001 Dirk Mueller (mueller@kde.org)
     Copyright (C) 2002 Waldo Bastian (bastian@kde.org)
     Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All
     rights reserved.
     Copyright (C) 2009 Torch Mobile Inc. http://www.torchmobile.com/
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Library General Public
@@ skipping 85 matching lines @@
     DEFINE_SINGLE_RESOURCE_HISTOGRAM(prefix, TextTrack)      \
     DEFINE_SINGLE_RESOURCE_HISTOGRAM(prefix, XSLStyleSheet)  \
   }
 
 bool IsCrossOrigin(const KURL& a, const KURL& b) {
   RefPtr<SecurityOrigin> originA = SecurityOrigin::create(a);
   RefPtr<SecurityOrigin> originB = SecurityOrigin::create(b);
   return !originB->isSameSchemeHostPort(originA.get());
 }
 
+void addRedirectsToResourceTimingInfo(Resource* resource,

[Yoav Weiss, 2016/12/01 21:53:55]

As this is used for both RT and NT2, do you think renaming this function would
be appropriate?

[sunjian, 2016/12/01 23:28:42]

I personally think it might be a better idea not to differentiate RT and NT2
here. Apparently this method is purely for updating ResourceTimingInfo object
for all resources, including mainResource which is associated with NT2. And i
made a decision in here to reuse ResourceTimingInfo for NT2 instead of creating
a new counterpart class. 

[Yoav Weiss, 2016/12/02 07:10:05]

I'd have preferred something like "addRedirectsToTimingInfo()", but I'll leave
that to you to decide.

[sunjian, 2016/12/03 00:16:50]

Acknowledged.

+                                      ResourceTimingInfo* info) {
+  // Store redirect responses that were packed inside the final response.
+  const Vector<ResourceResponse>& responses =
+      resource->response().redirectResponses();
+  for (size_t i = 0; i < responses.size(); ++i) {
+    const KURL& newURL = i + 1 < responses.size()
+                             ? KURL(responses[i + 1].url())
+                             : resource->resourceRequest().url();
+    bool crossOrigin = IsCrossOrigin(responses[i].url(), newURL);
+    info->addRedirect(responses[i], crossOrigin);
+  }
+}
+
 }  // namespace
 
 static void RecordSriResourceIntegrityMismatchEvent(
     SriResourceIntegrityMismatchEvent event) {
   DEFINE_THREAD_SAFE_STATIC_LOCAL(
       EnumerationHistogram, integrityHistogram,
       new EnumerationHistogram("sri.resource_integrity_mismatch_event",
                                SriResourceIntegrityMismatchEventCount));
   integrityHistogram.count(event);
 }
@@ skipping 629 matching lines @@
 
   // - Don't add main resource to cache to prevent reuse.
   // - Don't add the resource if its body will not be stored.
   if (factory.type() != Resource::MainResource &&
       request.options().dataBufferingPolicy != DoNotBufferData) {
     memoryCache()->add(resource);
   }
   return resource;
 }
 
-void ResourceFetcher::storeResourceTimingInitiatorInformation(
+void ResourceFetcher::storePerformanceTimingInitiatorInformation(
     Resource* resource) {
   const AtomicString& fetchInitiator = resource->options().initiatorInfo.name;
   if (fetchInitiator == FetchInitiatorTypeNames::internal)
     return;
 
   bool isMainResource = resource->getType() == Resource::MainResource;
 
   // The request can already be fetched in a previous navigation. Thus
   // startTime must be set accordingly.
   double startTime = resource->resourceRequest().navigationStartTime()
                          ? resource->resourceRequest().navigationStartTime()
                          : monotonicallyIncreasingTime();
 
   std::unique_ptr<ResourceTimingInfo> info =
       ResourceTimingInfo::create(fetchInitiator, startTime, isMainResource);
 
   if (resource->isCacheValidator()) {
     const AtomicString& timingAllowOrigin =
         resource->response().httpHeaderField(HTTPNames::Timing_Allow_Origin);
     if (!timingAllowOrigin.isEmpty())
       info->setOriginalTimingAllowOrigin(timingAllowOrigin);
   }
 
   if (!isMainResource ||
-      context().updateTimingInfoForIFrameNavigation(info.get()))
+      context().updateTimingInfoForIFrameNavigation(info.get())) {
     m_resourceTimingInfoMap.add(resource, std::move(info));
+  } else {
+    DCHECK(!m_mainResourceTimingInfo);
+    m_mainResourceTimingInfo = std::move(info);
+    m_mainResourceIdentifier = resource->identifier();
+  }
 }
 
 ResourceFetcher::RevalidationPolicy
 ResourceFetcher::determineRevalidationPolicy(Resource::Type type,
                                              const FetchRequest& fetchRequest,
                                              Resource* existingResource,
                                              bool isStaticData) const {
   const ResourceRequest& request = fetchRequest.resourceRequest();
 
   if (!existingResource)
@@ skipping 321 matching lines @@
 }
 
 ArchiveResource* ResourceFetcher::createArchive(Resource* resource) {
   // Only the top-frame can load MHTML.
   if (!context().isMainFrame())
     return nullptr;
   m_archive = MHTMLArchive::create(resource->url(), resource->resourceBuffer());
   return m_archive ? m_archive->mainResource() : nullptr;
 }
 
+ResourceTimingInfo* ResourceFetcher::getMainResourceTimingInfo(
+    unsigned long identifier) {
+  if (m_mainResourceTimingInfo) {

[Yoav Weiss, 2016/12/01 21:53:55]

The condition here seems unnecessary other than for DCHECK purposes. Can you
rewrite so that the condition is contained inside the DCHECK (to avoid slowing
down shipping release builds)

[sunjian, 2016/12/01 23:28:41]

Agree. But since this is a public method, how i can know for sure that other
callers will invoke this method at the right time (after main resource is
fetched) when they use it.

[kinuko, 2016/12/02 00:44:55]

Just document / have a comment to say calling getMainResourceTimingInfo before
main resource is fetched is invalid in .h, which should be enough.

[Yoav Weiss, 2016/12/02 07:10:05]

if callers are invoking it before m_mainResourceTimingInfo was set,
m_mainResourceTimingInfo.get() returns a nullptr, so the condition is not really
meaningful. (plus as kinuko@ said, a comment + DCHECK will make sure this is not
called when it's not supposed to)

[sunjian, 2016/12/03 00:16:50]

This commit is old. I uploaded a new commit and that one actually addressed
that.

+    DCHECK(m_mainResourceIdentifier == identifier);
+    return m_mainResourceTimingInfo.get();
+  }
+  return nullptr;
+}
+
 void ResourceFetcher::didFinishLoading(Resource* resource,
                                        double finishTime,
                                        DidFinishLoadingReason finishReason) {
   network_instrumentation::endResourceLoad(
       resource->identifier(), network_instrumentation::RequestOutcome::Success);
   DCHECK(resource);
   const int64_t encodedDataLength = resource->response().encodedDataLength();
 
   // When loading a multipart resource, make the loader non-block when finishing
   // loading the first part.
   if (finishReason == DidFinishFirstPartInMultipart)
     moveResourceLoaderToNonBlocking(resource->loader());
   else
     removeResourceLoader(resource->loader());
   DCHECK(!m_loaders.contains(resource->loader()));
   DCHECK(finishReason == DidFinishFirstPartInMultipart ||
          !m_nonBlockingLoaders.contains(resource->loader()));
 
+  if (resource->getType() == Resource::MainResource &&
+      m_mainResourceTimingInfo) {
+    DCHECK(resource->identifier() == m_mainResourceIdentifier);
+    // Store redirect responses that were packed inside the final response.
+    addRedirectsToResourceTimingInfo(resource, m_mainResourceTimingInfo.get());
+    m_mainResourceTimingInfo->addFinalTransferSize(
+        encodedDataLength == -1 ? 0 : encodedDataLength);
+  }
   if (std::unique_ptr<ResourceTimingInfo> info =
           m_resourceTimingInfoMap.take(resource)) {
     // Store redirect responses that were packed inside the final response.
-    const Vector<ResourceResponse>& responses =
-        resource->response().redirectResponses();
-    for (size_t i = 0; i < responses.size(); ++i) {
-      const KURL& newURL = i + 1 < responses.size()
-                               ? KURL(responses[i + 1].url())
-                               : resource->resourceRequest().url();
-      bool crossOrigin = IsCrossOrigin(responses[i].url(), newURL);
-      info->addRedirect(responses[i], crossOrigin);
-    }
+    addRedirectsToResourceTimingInfo(resource, info.get());
 
     if (resource->response().isHTTP() &&
         resource->response().httpStatusCode() < 400) {
       populateResourceTiming(info.get(), resource);
       info->setLoadFinishTime(finishTime);
       // encodedDataLength == -1 means "not available".
       // TODO(ricea): Find cases where it is not available but the
       // PerformanceResourceTiming spec requires it to be available and fix
       // them.
       info->addFinalTransferSize(encodedDataLength == -1 ? 0
@@ skipping 144 matching lines @@
   SecurityOrigin* sourceOrigin = context().getSecurityOrigin();
   if (sourceOrigin && sourceOrigin->hasSuborigin())
     request.setSkipServiceWorker(WebURLRequest::SkipServiceWorker::All);
 
   ResourceLoader* loader = ResourceLoader::create(this, resource);
   if (resource->shouldBlockLoadEvent())
     m_loaders.add(loader);
   else
     m_nonBlockingLoaders.add(loader);
 
-  storeResourceTimingInitiatorInformation(resource);
+  storePerformanceTimingInitiatorInformation(resource);
   resource->setFetcherSecurityOrigin(sourceOrigin);
 
   loader->activateCacheAwareLoadingIfNeeded(request);
   loader->start(request, context().loadingTaskRunner(),
                 context().defersLoading());
   return true;
 }
 
 void ResourceFetcher::removeResourceLoader(ResourceLoader* loader) {
   if (m_loaders.contains(loader))
@@ skipping 68 matching lines @@
     if (resource->getType() == Resource::Image &&
         shouldDeferImageLoad(newRequest.url()))
       return false;
   }
 
   ResourceTimingInfoMap::iterator it = m_resourceTimingInfoMap.find(resource);
   if (it != m_resourceTimingInfoMap.end()) {
     bool crossOrigin = IsCrossOrigin(redirectResponse.url(), newRequest.url());
     it->value->addRedirect(redirectResponse, crossOrigin);
   }
+
+  if (resource->getType() == Resource::MainResource &&
+      m_mainResourceTimingInfo) {

[Yoav Weiss, 2016/12/01 21:53:55]

I think this is true for iframes as well. Would be great to see a test for that
scenario (redirected iframe)

[sunjian, 2016/12/01 23:28:41]

Did you mean context().updateTimingInfoForIFrameNavigation(info.get())? So if
it's iframe and also main resource, i ignored it, which means
m_mainResourceTimingInfo will be nullptr, right?

[Yoav Weiss, 2016/12/02 07:10:05]

What happens when m_mainResourceTimingInfo is filled for the main resource,
which is then added an iframe, which gets redirected?
I think such a scenario will pass the condition here, but a test would show it
either way for sure :)

[sunjian, 2016/12/03 00:16:49]

I see. So i modified the if condition a little bit. Instead of verifying whether
m_mainResourceTimingInfo is empty or not, now i verify the whether the
identifiers match and DCHECK m_mainResourceTimingInfo. I think this will
eliminate the possibility you mentioned. Let me know if you think a test is
still needed.

+    DCHECK(resource->identifier() == m_mainResourceIdentifier);
+    bool crossOrigin = IsCrossOrigin(redirectResponse.url(), newRequest.url());
+    m_mainResourceTimingInfo->addRedirect(redirectResponse, crossOrigin);
+  }
+
   newRequest.setAllowStoredCredentials(resource->options().allowCredentials ==
                                        AllowStoredCredentials);
   willSendRequest(resource->identifier(), newRequest, redirectResponse,
                   resource->options());
   return true;
 }
 
 void ResourceFetcher::willSendRequest(unsigned long identifier,
                                       ResourceRequest& newRequest,
                                       const ResourceResponse& redirectResponse,
@@ skipping 225 matching lines @@
   visitor->trace(m_context);
   visitor->trace(m_archive);
   visitor->trace(m_loaders);
   visitor->trace(m_nonBlockingLoaders);
   visitor->trace(m_documentResources);
   visitor->trace(m_preloads);
   visitor->trace(m_resourceTimingInfoMap);
 }
 
 }  // namespace blink