Changeset 161532 in webkit for trunk/Source/WebCore/xml/XMLHttpRequestProgressEventThrottle.cpp

Timestamp:

Jan 8, 2014, 6:11:59 PM (11 years ago)

Author:

[email protected]

Message:

Source/WebCore: Correctly set XHR loadend attributes (loaded and total).
​https://bugs.webkit.org/show_bug.cgi?id=120828

Patch by Youenn Fablet <​[email protected]> on 2014-01-08
Reviewed by Alexey Proskuryakov.

Added correct initialization of lengthComputable, loaded and total attributes
to XHR ProgressEvent events (load, loadstart, loadend, abort, error and timeout).

XMLHttpRequestProgressEventThrottle and XMLHttpRequestUpload now keep persistent knowledge
of m_loaded and m_total values with this patch.

Code refactoring to handle event dispatching in case of error in a single manner.
XMLHttpRequestProgressEventThrottle::dispatchProgressEvent is renamed as dispatchThrottledProgressEvent
XMLHttpRequestProgressEventThrottle::dispatchEventAndLoadend is replaced by dispatchProgressEvent(const AtomicString&)

Tests: http/tests/xmlhttprequest/loadstart-event-init.html

http/tests/xmlhttprequest/onabort-progressevent-attributes.html
http/tests/xmlhttprequest/onload-progressevent-attributes.html
http/tests/xmlhttprequest/upload-onabort-progressevent-attributes.html
http/tests/xmlhttprequest/upload-onload-progressevent-attributes.html

• xml/XMLHttpRequest.cpp:

(WebCore::XMLHttpRequest::callReadyStateChangeListener): changed readystatechange event from ProgressEvent to Event (not cancellable, not bubblable) to better match the spec
(WebCore::XMLHttpRequest::createRequest):
(WebCore::XMLHttpRequest::abort): code refactoring to handle error event dispatching in a single way
(WebCore::XMLHttpRequest::networkError): code refactoring to handle error event dispatching in a single way
(WebCore::XMLHttpRequest::abortError): code refactoring to handle error event dispatching in a single way
(WebCore::XMLHttpRequest::didSendData):
(WebCore::XMLHttpRequest::didReceiveData):
(WebCore::XMLHttpRequest::dispatchErrorEvents): dispatch progress events in case of error
(WebCore::XMLHttpRequest::didTimeout): code refactoring to handle error event dispatching in a single way

• xml/XMLHttpRequest.h:
• xml/XMLHttpRequestProgressEventThrottle.cpp: before the patch, the fact that a progress event is being throttled is stored indirectly (m_loaded or m_total not equal to zero). With the patch, this information is stored in m_hasThrottledProgressEvent. The m_loaded and m_total values are no longer set back to zero after a progress event is dispatched. This allows using these values to correctly initialize other ProgressEvent events (in particular loadend, abort, timeout...)

(WebCore::XMLHttpRequestProgressEventThrottle::XMLHttpRequestProgressEventThrottle):
(WebCore::XMLHttpRequestProgressEventThrottle::dispatchThrottledProgressEvent): always update the new m_loaded and m_total values. If progress event is not sent as part of the function call, store the fact that a progress event is being throttled through m_hasThrottledProgressEvent.
(WebCore::XMLHttpRequestProgressEventThrottle::dispatchProgressEvent): used to send any ProgressEvent event that is not be throttled
(WebCore::XMLHttpRequestProgressEventThrottle::flushProgressEvent): after the call, no progress event is throttled anymore
(WebCore::XMLHttpRequestProgressEventThrottle::fired): after the call, no progress event is throttled anymore
(WebCore::XMLHttpRequestProgressEventThrottle::hasEventToDispatch):
(WebCore::XMLHttpRequestProgressEventThrottle::suspend):

• xml/XMLHttpRequestProgressEventThrottle.h: introduced m_hasThrottledProgressEvent which stores whether a progress event is being throttled and m_computableLength which is used to initialize ProgressEvent computableLength
• xml/XMLHttpRequestUpload.cpp:

(WebCore::XMLHttpRequestUpload::XMLHttpRequestUpload):
(WebCore::XMLHttpRequestUpload::dispatchProgressEvent):

• xml/XMLHttpRequestUpload.h: introduced m_loaded, m_total and m_lengthComputable, similarly to XMLHttpRequestProgressEventThrottle

LayoutTests: Correctly set XHR loadend event attributes (loaded and total).
​https://bugs.webkit.org/show_bug.cgi?id=120828

Patch by Youenn Fablet <​[email protected]> on 2014-01-08
Reviewed by Alexey Proskuryakov.

Tests for abort, load, loadstart and loadend ProgressEvent events for XMLHttpRequest and XMLHttpRequestUpload

• fast/xmlhttprequest/xmlhttprequest-get-expected.txt: Changed to correct event values
• http/tests/xmlhttprequest/loadstart-event-init-expected.txt: Added.
• http/tests/xmlhttprequest/loadstart-event-init.html: Added.
• http/tests/xmlhttprequest/onabort-progressevent-attributes-expected.txt: Added.
• http/tests/xmlhttprequest/onabort-progressevent-attributes.html: Added.
• http/tests/xmlhttprequest/onload-progressevent-attributes-expected.txt: Added.
• http/tests/xmlhttprequest/onload-progressevent-attributes.html: Added.
• http/tests/xmlhttprequest/upload-onabort-progressevent-attributes-expected.txt: Added.
• http/tests/xmlhttprequest/upload-onabort-progressevent-attributes.html: Added.
• http/tests/xmlhttprequest/upload-onload-progressevent-attributes-expected.txt: Added.
• http/tests/xmlhttprequest/upload-onload-progressevent-attributes.html: Added.

File:

• trunk/Source/WebCore/xml/XMLHttpRequestProgressEventThrottle.cpp (modified) (7 diffs)

trunk/Source/WebCore/xml/XMLHttpRequestProgressEventThrottle.cpp

@@ -37 +37 @@
 XMLHttpRequestProgressEventThrottle::XMLHttpRequestProgressEventThrottle(EventTarget* target)
     : m_target(target)
+    , m_hasThrottledProgressEvent(false)
+    , m_lengthComputable(false)
     , m_loaded(0)
     , m_total(0)
@@ -49 +51 @@
 }
 
-void XMLHttpRequestProgressEventThrottle::dispatchProgressEvent(bool lengthComputable, unsigned long long loaded, unsigned long long total)
-{
+void XMLHttpRequestProgressEventThrottle::dispatchThrottledProgressEvent(bool lengthComputable, unsigned long long loaded, unsigned long long total)
+{
+    m_lengthComputable = lengthComputable;
+    m_loaded = loaded;
+    m_total = total;
+    
     if (m_deferEvents) {
         // Only store the latest progress event while suspended.
@@ -67 +73 @@
         dispatchEvent(XMLHttpRequestProgressEvent::create(eventNames().progressEvent, lengthComputable, loaded, total));
         startRepeating(minimumProgressEventDispatchingIntervalInSeconds);
+        m_hasThrottledProgressEvent = false;
         return;
     }
 
     // The timer is already active so minimumProgressEventDispatchingIntervalInSeconds is the least frequent event.
-    m_lengthComputable = lengthComputable;
-    m_loaded = loaded;
-    m_total = total;
+    m_hasThrottledProgressEvent = true;
 }
 
@@ -97 +102 @@
 }
 
-void XMLHttpRequestProgressEventThrottle::dispatchEventAndLoadEnd(PassRefPtr<Event> event)
-{
-    ASSERT(event->type() == eventNames().loadEvent || event->type() == eventNames().abortEvent || event->type() == eventNames().errorEvent || event->type() == eventNames().timeoutEvent);
-
-    dispatchEvent(event);
-    dispatchEvent(XMLHttpRequestProgressEvent::create(eventNames().loadendEvent));
+void XMLHttpRequestProgressEventThrottle::dispatchProgressEvent(const AtomicString &type)
+{
+    ASSERT(type == eventNames().loadEvent || type == eventNames().loadstartEvent || type == eventNames().abortEvent || type == eventNames().errorEvent || type == eventNames().timeoutEvent);
+
+    if (type == eventNames().loadstartEvent) {
+        m_lengthComputable = false;
+        m_loaded = 0;
+        m_total = 0;
+    }
+
+    dispatchEvent(XMLHttpRequestProgressEvent::create(type, m_lengthComputable, m_loaded, m_total));
 }
 
@@ -116 +126 @@
     if (!hasEventToDispatch())
         return;
-
     PassRefPtr<Event> event = XMLHttpRequestProgressEvent::create(eventNames().progressEvent, m_lengthComputable, m_loaded, m_total);
-    m_loaded = 0;
-    m_total = 0;
+    m_hasThrottledProgressEvent = false;
 
     // We stop the timer as this is called when no more events are supposed to occur.
@@ -161 +169 @@
 
     dispatchEvent(XMLHttpRequestProgressEvent::create(eventNames().progressEvent, m_lengthComputable, m_loaded, m_total));
-    m_total = 0;
-    m_loaded = 0;
+    m_hasThrottledProgressEvent = false;
 }
 
 bool XMLHttpRequestProgressEventThrottle::hasEventToDispatch() const
 {
-    return (m_total || m_loaded) && isActive();
+    return m_hasThrottledProgressEvent && isActive();
 }
 
@@ -188 +195 @@
     if (hasEventToDispatch()) {
         m_deferredProgressEvent = XMLHttpRequestProgressEvent::create(eventNames().progressEvent, m_lengthComputable, m_loaded, m_total);
-        m_total = 0;
-        m_loaded = 0;
+        m_hasThrottledProgressEvent = false;
     }
     stop();