Stream scripts to V8 as they load - Blink side.

Source/core/dom/PendingScript.cpp

 /*
  * Copyright (C) 2010 Google, Inc. All Rights Reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 #include "core/dom/PendingScript.h"
 
+#include "bindings/core/v8/ScriptStreamer.h"
 #include "core/dom/Element.h"
 #include "core/fetch/ScriptResource.h"
 
 namespace blink {
 
 PendingScript::~PendingScript()
 {
 }
 
-void PendingScript::watchForLoad(ResourceClient* client)
+void PendingScript::watchForLoad(ScriptResourceClient* client)
 {
     ASSERT(!m_watchingForLoad);
     ASSERT(!resource()->isLoaded());
-    // addClient() will call notifyFinished() if the load is complete. Callers
-    // do not expect to be re-entered from this call, so they should not become
-    // a client of an already-loaded Resource.
-    resource()->addClient(client);
+    if (m_streamer) {
+        m_streamer->addClient(client);
+    } else {
+        // addClient() will call notifyFinished() if the load is
+        // complete. Callers do not expect to be re-entered from this call, so
+        // they should not become a client of an already-loaded Resource.
+        resource()->addClient(client);
+    }
     m_watchingForLoad = true;
 }
 
-void PendingScript::stopWatchingForLoad(ResourceClient* client)
+void PendingScript::stopWatchingForLoad(ScriptResourceClient* client)
 {
-    if (resource() && m_watchingForLoad) {
+    if (!m_watchingForLoad) {
+        return;
+    }
+    if (m_streamer) {
+        m_streamer->cancel();
+        m_streamer->removeClient(client);
+    } else if (resource()) {

[haraken, 2014/09/10 05:57:52]

How is it possible that resource() returns 0 here?

I guess this branch should be:

  else {
    ASSERT(resource());
  }

[marja, 2014/09/11 09:15:37]

This code was originally in HTMLScriptRunner like this:

if (m_parserBlockingScript.resource() &&
m_parserBlockingScript.watchingForLoad())


and in that case, it's clear that it can be that resource() is NULL. However, I
think that check was unnecessarily complicated, and 

if (m_parserBlockingScript.watchingForLoad())

would've been enough.

Anyhow, added the ASSERT here as you suggested.

         resource()->removeClient(client);
-        m_watchingForLoad = false;
     }
+    m_watchingForLoad = false;
 }
 
 PassRefPtrWillBeRawPtr<Element> PendingScript::releaseElementAndClear()
 {
     setScriptResource(0);
     m_watchingForLoad = false;
     m_startingPosition = TextPosition::belowRangePosition();
     return m_element.release();
 }
 
 void PendingScript::setScriptResource(ScriptResource* resource)
 {
     setResource(resource);
+    // This function is only called 1) during construction (we're not yet
+    // streaming) 2) after loading has completed (and streaming too, if we were
+    // streaming).
+    ASSERT(!m_streamer || !m_streamer->streamingInProgress());

[haraken, 2014/09/10 05:57:52]

ASSERT(!isStreaming());

[haraken, 2014/09/10 05:57:52]

Add ASSERT(!m_watchingForLoad);

[marja, 2014/09/11 09:15:37]

Done.

[marja, 2014/09/11 09:15:37]

Done.

[marja, 2014/09/16 11:20:38]

Actually, this is not true in the current code (independent of script
streaming).

The code path where this is not true:

#3 blink::PendingScript::setScriptResource()
#4 blink::PendingScript::PendingScript()
#5 WTF::Deque<>::takeFirst()
#6 blink::HTMLScriptRunner::executeScriptsWaitingForParsing()
#7 blink::HTMLDocumentParser::attemptToRunDeferredScriptsAndEnd()
#8 blink::HTMLDocumentParser::notifyScriptLoaded()

... in general, it's not guaranteed that HTMLScriptRunner calls
stopWatchingForLoad when it has already been notified of the load having
finished.

+    m_streamer.release();
 }
 
 void PendingScript::notifyFinished(Resource*)
 {
+    if (m_streamer) {
+        m_streamer->notifyFinished();
+    }
+}
+
+void PendingScript::notifyAppendData(ScriptResource*)
+{
+    if (m_streamer) {
+        m_streamer->notifyAppendData();
+    }
 }
 
 void PendingScript::trace(Visitor* visitor)
 {
     visitor->trace(m_element);
 }
 
 ScriptSourceCode PendingScript::getSource(const KURL& documentURL, bool& errorOccurred) const
 {
     if (resource()) {
         errorOccurred = resource()->errorOccurred();
         ASSERT(resource()->isLoaded());
+        if (m_streamer && !m_streamer->streamingSuppressed()) {

[haraken, 2014/09/10 05:57:51]

Help me understand: Why do we need this branch? Can we just always return
ScriptSourceCode(resource()) ?

I think I just don't understand how the suppressing works.

[marja, 2014/09/11 09:15:37]

We need to somehow take the results of streaming into use when compiling, so
this is why we cannot do ScriptSourceCode(resource()) - that would just discard
everything we have done, and we'd end up parsing and compiling the script like
before. We need ScriptSourceCode reflect the fact that we have parsed the code
already and the only thing left is compilation.

Suppressing means that ScriptStreamer is still watching the resource load, just
not giving data to V8. So in those cases, we get the source code via the normal,
non-streaming code path. And from that point on, we just forget that we ever
streamed, and we parse and compile the code like before.

+            return ScriptSourceCode(m_streamer, resource());
+        }
         return ScriptSourceCode(resource());
     }
     errorOccurred = false;
     return ScriptSourceCode(m_element->textContent(), documentURL, startingPosition());
 }
 
+bool PendingScript::isStreaming() const
+{
+    return m_streamer && m_streamer->streamingInProgress();
 }
+
+}