<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[175441] trunk/Source/WebCore</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/175441">175441</a></dd>
<dt>Author</dt> <dd>cdumez@apple.com</dd>
<dt>Date</dt> <dd>2014-10-31 17:12:51 -0700 (Fri, 31 Oct 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>Support throttling of DOMTimers using nested setTimeout() calls
https://bugs.webkit.org/show_bug.cgi?id=138262

Reviewed by Gavin Barraclough.

Extend DOMTimers throttling support to timers that are using nested
setTimeout() calls instead of a setInterval(). To achieve this, this
patch introduces a NestedTimersVector singleton class where nested
timers are appended, and for which we potentially update the next
firing time, after the parent timer is done executing.

I have verified this helps on cnn.com for example, which has timers
interacting with non-visible plugins that are scheduled using nested
setTimeout() calls with a frequency of 150 / 200 ms.

* page/DOMTimer.cpp:
(WebCore::NestedTimersVector::NestedTimersVector):
(WebCore::NestedTimersVector::~NestedTimersVector):
(WebCore::NestedTimersVector::registerTimer):
(WebCore::NestedTimersVector::begin):
(WebCore::NestedTimersVector::end):
(WebCore::DOMTimer::install):
(WebCore::DOMTimer::updateThrottlingStateIfNecessary):
(WebCore::DOMTimer::fired):
* page/DOMTimer.h:</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCorepageDOMTimercpp">trunk/Source/WebCore/page/DOMTimer.cpp</a></li>
<li><a href="#trunkSourceWebCorepageDOMTimerh">trunk/Source/WebCore/page/DOMTimer.h</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (175440 => 175441)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog        2014-10-31 23:58:53 UTC (rev 175440)
+++ trunk/Source/WebCore/ChangeLog        2014-11-01 00:12:51 UTC (rev 175441)
</span><span class="lines">@@ -1,5 +1,33 @@
</span><span class="cx"> 2014-10-31  Chris Dumez  &lt;cdumez@apple.com&gt;
</span><span class="cx"> 
</span><ins>+        Support throttling of DOMTimers using nested setTimeout() calls
+        https://bugs.webkit.org/show_bug.cgi?id=138262
+
+        Reviewed by Gavin Barraclough.
+
+        Extend DOMTimers throttling support to timers that are using nested
+        setTimeout() calls instead of a setInterval(). To achieve this, this
+        patch introduces a NestedTimersVector singleton class where nested
+        timers are appended, and for which we potentially update the next
+        firing time, after the parent timer is done executing.
+
+        I have verified this helps on cnn.com for example, which has timers
+        interacting with non-visible plugins that are scheduled using nested
+        setTimeout() calls with a frequency of 150 / 200 ms.
+
+        * page/DOMTimer.cpp:
+        (WebCore::NestedTimersVector::NestedTimersVector):
+        (WebCore::NestedTimersVector::~NestedTimersVector):
+        (WebCore::NestedTimersVector::registerTimer):
+        (WebCore::NestedTimersVector::begin):
+        (WebCore::NestedTimersVector::end):
+        (WebCore::DOMTimer::install):
+        (WebCore::DOMTimer::updateThrottlingStateIfNecessary):
+        (WebCore::DOMTimer::fired):
+        * page/DOMTimer.h:
+
+2014-10-31  Chris Dumez  &lt;cdumez@apple.com&gt;
+
</ins><span class="cx">         Move -webkit-marquee-increment property to the new StyleBuilder
</span><span class="cx">         https://bugs.webkit.org/show_bug.cgi?id=138208
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebCorepageDOMTimercpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/page/DOMTimer.cpp (175440 => 175441)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/page/DOMTimer.cpp        2014-10-31 23:58:53 UTC (rev 175440)
+++ trunk/Source/WebCore/page/DOMTimer.cpp        2014-11-01 00:12:51 UTC (rev 175441)
</span><span class="lines">@@ -84,6 +84,42 @@
</span><span class="cx"> 
</span><span class="cx"> DOMTimerFireState* DOMTimerFireState::current = nullptr;
</span><span class="cx"> 
</span><ins>+struct NestedTimersVector {
+    typedef Vector&lt;DOMTimer*, 1&gt;::const_iterator const_iterator;
+
+    NestedTimersVector(ScriptExecutionContext* context)
+        : shouldSetCurrent(context-&gt;isDocument())
+    {
+        if (shouldSetCurrent) {
+            previous = current;
+            current = this;
+        }
+    }
+
+    ~NestedTimersVector()
+    {
+        if (shouldSetCurrent)
+            current = previous;
+    }
+
+    static NestedTimersVector* current;
+
+    void registerTimer(DOMTimer* timer)
+    {
+        nestedTimers.append(timer);
+    }
+
+    const_iterator begin() const { return nestedTimers.begin(); }
+    const_iterator end() const { return nestedTimers.end(); }
+
+private:
+    bool shouldSetCurrent;
+    NestedTimersVector* previous;
+    Vector&lt;DOMTimer*, 1&gt; nestedTimers;
+};
+
+NestedTimersVector* NestedTimersVector::current = nullptr;
+
</ins><span class="cx"> static inline bool shouldForwardUserGesture(int interval, int nestingLevel)
</span><span class="cx"> {
</span><span class="cx">     return UserGestureIndicator::processingUserGesture()
</span><span class="lines">@@ -133,6 +169,10 @@
</span><span class="cx">     timer-&gt;suspendIfNeeded();
</span><span class="cx">     InspectorInstrumentation::didInstallTimer(context, timer-&gt;m_timeoutId, timeout, singleShot);
</span><span class="cx"> 
</span><ins>+    // Keep track of nested timer installs.
+    if (NestedTimersVector::current)
+        NestedTimersVector::current-&gt;registerTimer(timer);
+
</ins><span class="cx">     return timer-&gt;m_timeoutId;
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="lines">@@ -148,6 +188,17 @@
</span><span class="cx">     context-&gt;removeTimeout(timeoutId);
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+void DOMTimer::updateThrottlingStateIfNecessary(const DOMTimerFireState&amp; fireState)
+{
+    if (fireState.scriptDidInteractWithUserObservablePlugin &amp;&amp; m_throttleState != ShouldNotThrottle) {
+        m_throttleState = ShouldNotThrottle;
+        updateTimerIntervalIfNecessary();
+    } else if (fireState.scriptDidInteractWithNonUserObservablePlugin &amp;&amp; m_throttleState == Undetermined) {
+        m_throttleState = ShouldThrottle;
+        updateTimerIntervalIfNecessary();
+    }
+}
+
</ins><span class="cx"> void DOMTimer::scriptDidInteractWithPlugin(HTMLPlugInElement&amp; pluginElement)
</span><span class="cx"> {
</span><span class="cx">     if (!DOMTimerFireState::current)
</span><span class="lines">@@ -198,15 +249,8 @@
</span><span class="cx">         m_action-&gt;execute(context);
</span><span class="cx"> 
</span><span class="cx">         InspectorInstrumentation::didFireTimer(cookie);
</span><ins>+        updateThrottlingStateIfNecessary(fireState);
</ins><span class="cx"> 
</span><del>-        if (fireState.scriptDidInteractWithUserObservablePlugin &amp;&amp; m_throttleState != ShouldNotThrottle) {
-            m_throttleState = ShouldNotThrottle;
-            updateTimerIntervalIfNecessary();
-        } else if (fireState.scriptDidInteractWithNonUserObservablePlugin &amp;&amp; m_throttleState == Undetermined) {
-            m_throttleState = ShouldThrottle;
-            updateTimerIntervalIfNecessary();
-        }
-
</del><span class="cx">         return;
</span><span class="cx">     }
</span><span class="cx"> 
</span><span class="lines">@@ -229,6 +273,8 @@
</span><span class="cx">     }
</span><span class="cx"> #endif
</span><span class="cx"> 
</span><ins>+    // Keep track nested timer installs.
+    NestedTimersVector nestedTimers(context);
</ins><span class="cx">     m_action-&gt;execute(context);
</span><span class="cx"> 
</span><span class="cx"> #if PLATFORM(IOS)
</span><span class="lines">@@ -243,6 +289,12 @@
</span><span class="cx"> 
</span><span class="cx">     InspectorInstrumentation::didFireTimer(cookie);
</span><span class="cx"> 
</span><ins>+    // Check if we should throttle nested single-shot timers.
+    for (auto* timer : nestedTimers) {
+        if (!timer-&gt;repeatInterval())
+            timer-&gt;updateThrottlingStateIfNecessary(fireState);
+    }
+
</ins><span class="cx">     context-&gt;setTimerNestingLevel(0);
</span><span class="cx"> }
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebCorepageDOMTimerh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/page/DOMTimer.h (175440 => 175441)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/page/DOMTimer.h        2014-10-31 23:58:53 UTC (rev 175440)
+++ trunk/Source/WebCore/page/DOMTimer.h        2014-11-01 00:12:51 UTC (rev 175441)
</span><span class="lines">@@ -33,6 +33,7 @@
</span><span class="cx"> 
</span><span class="cx"> namespace WebCore {
</span><span class="cx"> 
</span><ins>+    struct DOMTimerFireState;
</ins><span class="cx">     class HTMLPlugInElement;
</span><span class="cx">     class ScheduledAction;
</span><span class="cx"> 
</span><span class="lines">@@ -54,6 +55,7 @@
</span><span class="cx">     private:
</span><span class="cx">         DOMTimer(ScriptExecutionContext*, std::unique_ptr&lt;ScheduledAction&gt;, int interval, bool singleShot);
</span><span class="cx">         double intervalClampedToMinimum() const;
</span><ins>+        void updateThrottlingStateIfNecessary(const DOMTimerFireState&amp;);
</ins><span class="cx"> 
</span><span class="cx">         // SuspendableTimer
</span><span class="cx">         virtual void fired() override;
</span></span></pre>
</div>
</div>

</body>
</html>