Changeset 176297 in webkit

Timestamp:

Nov 18, 2014, 4:56:33 PM (12 years ago)

Author:

Chris Dumez

Message:

Add a setting to toggle DOMTimer throttling support
​https://bugs.webkit.org/show_bug.cgi?id=138844
<rdar://problem/19020874>

Reviewed by Andreas Kling.

Add a setting to disable DOM timers throttling, in order to help
developers determine if a specific issue is caused by timer
throttling.

Source/WebCore:

• page/DOMTimer.cpp:

(WebCore::DOMTimerFireState::contextDocument):
(WebCore::DOMTimerFireState::scriptMadeUserObservableChanges):
(WebCore::DOMTimer::isDOMTimersThrottlingEnabled):
(WebCore::DOMTimer::updateThrottlingStateIfNecessary):

• page/DOMTimer.h:
• page/Settings.in:

Source/WebKit/mac:

• WebView/WebPreferenceKeysPrivate.h:
• WebView/WebPreferences.mm:

(+[WebPreferences initialize]):
(-[WebPreferences domTimersThrottlingEnabled]):
(-[WebPreferences setDOMTimersThrottlingEnabled:]):

• WebView/WebPreferencesPrivate.h:
• WebView/WebView.mm:

(-[WebView _preferencesChanged:]):

Source/WebKit2:

• Shared/WebPreferencesDefinitions.h:
• UIProcess/API/C/WKPreferences.cpp:

(WKPreferencesSetDOMTimersThrottlingEnabled):
(WKPreferencesGetDOMTimersThrottlingEnabled):

• UIProcess/API/C/WKPreferencesRefPrivate.h:
• WebProcess/WebPage/WebPage.cpp:

(WebKit::WebPage::updatePreferences):

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/page/DOMTimer.cpp (modified) (5 diffs)
• WebCore/page/DOMTimer.h (modified) (2 diffs)
• WebCore/page/Settings.in (modified) (1 diff)
• WebKit/mac/ChangeLog (modified) (1 diff)
• WebKit/mac/WebView/WebPreferenceKeysPrivate.h (modified) (1 diff)
• WebKit/mac/WebView/WebPreferences.mm (modified) (2 diffs)
• WebKit/mac/WebView/WebPreferencesPrivate.h (modified) (1 diff)
• WebKit/mac/WebView/WebView.mm (modified) (1 diff)
• WebKit2/ChangeLog (modified) (1 diff)
• WebKit2/Shared/WebPreferencesDefinitions.h (modified) (1 diff)
• WebKit2/UIProcess/API/C/WKPreferences.cpp (modified) (1 diff)
• WebKit2/UIProcess/API/C/WKPreferencesRefPrivate.h (modified) (1 diff)
• WebKit2/WebProcess/WebPage/WebPage.cpp (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2014-11-18  Chris Dumez  <cdumez@apple.com>
+
+        Add a setting to toggle DOMTimer throttling support
+        https://bugs.webkit.org/show_bug.cgi?id=138844
+        <rdar://problem/19020874>
+
+        Reviewed by Andreas Kling.
+
+        Add a setting to disable DOM timers throttling, in order to help
+        developers determine if a specific issue is caused by timer
+        throttling.
+
+        * page/DOMTimer.cpp:
+        (WebCore::DOMTimerFireState::contextDocument):
+        (WebCore::DOMTimerFireState::scriptMadeUserObservableChanges):
+        (WebCore::DOMTimer::isDOMTimersThrottlingEnabled):
+        (WebCore::DOMTimer::updateThrottlingStateIfNecessary):
+        * page/DOMTimer.h:
+        * page/Settings.in:
+
 2014-11-18  Beth Dakin  <bdakin@apple.com>
 

trunk/Source/WebCore/page/DOMTimer.cpp

@@ -32 +32 @@
 #include "InspectorInstrumentation.h"
 #include "Logging.h"
+#include "Page.h"
 #include "PluginViewBase.h"
 #include "ScheduledAction.h"
 #include "ScriptExecutionContext.h"
+#include "Settings.h"
 #include "UserGestureIndicator.h"
 #include <wtf/CurrentTime.h>
@@ -46 +48 @@
 #include "ChromeClient.h"
 #include "Frame.h"
-#include "Page.h"
 #include "WKContentObservation.h"
 #endif
@@ -78 +79 @@
     }
 
+    Document* contextDocument() const { return m_contextIsDocument ? &downcast<Document>(m_context) : nullptr; }
+
     void setScriptMadeUserObservableChanges() { m_scriptMadeUserObservableChanges = true; }
     void setScriptMadeNonUserObservableChanges() { m_scriptMadeNonUserObservableChanges = true; }
@@ -92 +95 @@
             return true;
 
+        Document* document = contextDocument();
         // To be conservative, we also consider any DOM Tree change to be user observable.
-        return m_contextIsDocument && downcast<Document>(m_context).domTreeVersion() != m_initialDOMTreeVersion;
+        return document && document->domTreeVersion() != m_initialDOMTreeVersion;
     }
 
@@ -252 +256 @@
 }
 
+inline bool DOMTimer::isDOMTimersThrottlingEnabled(Document& document) const
+{
+    auto* page = document.page();
+    if (!page)
+        return true;
+    return page->settings().domTimersThrottlingEnabled();
+}
+
 void DOMTimer::updateThrottlingStateIfNecessary(const DOMTimerFireState& fireState)
 {
+    Document* contextDocument = fireState.contextDocument();
+    // We don't throttle timers in worker threads.
+    if (!contextDocument)
+        return;
+
+    if (UNLIKELY(!isDOMTimersThrottlingEnabled(*contextDocument))) {
+        if (m_throttleState == ShouldThrottle) {
+            // Unthrottle the timer in case it was throttled before the setting was updated.
+            LOG(DOMTimers, "%p - Unthrottling DOM timer because throttling was disabled via settings.", this);
+            m_throttleState = ShouldNotThrottle;
+            updateTimerIntervalIfNecessary();
+        }
+        return;
+    }
+
     if (fireState.scriptMadeUserObservableChanges()) {
         ASSERT(m_elementsCausingThrottling.isEmpty());

trunk/Source/WebCore/page/DOMTimer.h

@@ -36 +36 @@
 
     class DOMTimerFireState;
+    class Document;
     class HTMLPlugInElement;
     class IntRect;
@@ -66 +67 @@
         double intervalClampedToMinimum() const;
 
+        bool isDOMTimersThrottlingEnabled(Document&) const;
         bool isIntervalDependentOnViewport() const { return m_throttleState == ShouldThrottle && !m_elementsCausingThrottling.isEmpty(); }
         void registerForViewportChanges();

trunk/Source/WebCore/page/Settings.in

@@ -77 +77 @@
 scriptMarkupEnabled initial=true
 needsSiteSpecificQuirks initial=false
+domTimersThrottlingEnabled initial=true
 webArchiveDebugModeEnabled initial=false, conditional=WEB_ARCHIVE
 localFileContentSniffingEnabled initial=false

trunk/Source/WebKit/mac/ChangeLog

@@ +1 @@
+2014-11-18  Chris Dumez  <cdumez@apple.com>
+
+        Add a setting to toggle DOMTimer throttling support
+        https://bugs.webkit.org/show_bug.cgi?id=138844
+        <rdar://problem/19020874>
+
+        Reviewed by Andreas Kling.
+
+        Add a setting to disable DOM timers throttling, in order to help
+        developers determine if a specific issue is caused by timer
+        throttling.
+
+        * WebView/WebPreferenceKeysPrivate.h:
+        * WebView/WebPreferences.mm:
+        (+[WebPreferences initialize]):
+        (-[WebPreferences domTimersThrottlingEnabled]):
+        (-[WebPreferences setDOMTimersThrottlingEnabled:]):
+        * WebView/WebPreferencesPrivate.h:
+        * WebView/WebView.mm:
+        (-[WebView _preferencesChanged:]):
+
 2014-11-18  Tim Horton  <timothy_horton@apple.com>
 

trunk/Source/WebKit/mac/WebView/WebPreferenceKeysPrivate.h

@@ -88 +88 @@
 #define WebKitAuthorAndUserStylesEnabledPreferenceKey @"WebKitAuthorAndUserStylesEnabledPreferenceKey"
 #define WebKitApplicationChromeModeEnabledPreferenceKey @"WebKitApplicationChromeModeEnabledPreferenceKey"
+#define WebKitDOMTimersThrottlingEnabledPreferenceKey @"WebKitDOMTimersThrottlingEnabledPreferenceKey"
 #define WebKitWebArchiveDebugModeEnabledPreferenceKey @"WebKitWebArchiveDebugModeEnabledPreferenceKey"
 #define WebKitLocalFileContentSniffingEnabledPreferenceKey @"WebKitLocalFileContentSniffingEnabledPreferenceKey"

trunk/Source/WebKit/mac/WebView/WebPreferences.mm

@@ -477 +477 @@
         [NSNumber numberWithBool:YES],  WebKitAuthorAndUserStylesEnabledPreferenceKey,
         [NSNumber numberWithBool:NO],   WebKitApplicationChromeModeEnabledPreferenceKey,
+        [NSNumber numberWithBool:YES],  WebKitDOMTimersThrottlingEnabledPreferenceKey,
         [NSNumber numberWithBool:NO],   WebKitWebArchiveDebugModeEnabledPreferenceKey,
         [NSNumber numberWithBool:NO],   WebKitLocalFileContentSniffingEnabledPreferenceKey,
@@ -1223 +1224 @@
 {
     [self _setBoolValue:flag forKey:WebKitApplicationChromeModeEnabledPreferenceKey];
+}
+
+- (BOOL)domTimersThrottlingEnabled
+{
+    return [self _boolValueForKey:WebKitDOMTimersThrottlingEnabledPreferenceKey];
+}
+
+- (void)setDOMTimersThrottlingEnabled:(BOOL)flag
+{
+    [self _setBoolValue:flag forKey:WebKitDOMTimersThrottlingEnabledPreferenceKey];
 }
 

trunk/Source/WebKit/mac/WebView/WebPreferencesPrivate.h

@@ -103 +103 @@
 - (void)setAutomaticallyDetectsCacheModel:(BOOL)automaticallyDetectsCacheModel;
 
+- (BOOL)domTimersThrottlingEnabled;
+- (void)setDOMTimersThrottlingEnabled:(BOOL)domTimersThrottlingEnabled;
+
 - (BOOL)webArchiveDebugModeEnabled;
 - (void)setWebArchiveDebugModeEnabled:(BOOL)webArchiveDebugModeEnabled;

trunk/Source/WebKit/mac/WebView/WebView.mm

@@ -2223 +2223 @@
 
     settings.setNeedsSiteSpecificQuirks(_private->useSiteSpecificSpoofing);
+    settings.setDOMTimersThrottlingEnabled([preferences domTimersThrottlingEnabled]);
     settings.setWebArchiveDebugModeEnabled([preferences webArchiveDebugModeEnabled]);
     settings.setLocalFileContentSniffingEnabled([preferences localFileContentSniffingEnabled]);

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2014-11-18  Chris Dumez  <cdumez@apple.com>
+
+        Add a setting to toggle DOMTimer throttling support
+        https://bugs.webkit.org/show_bug.cgi?id=138844
+        <rdar://problem/19020874>
+
+        Reviewed by Andreas Kling.
+
+        Add a setting to disable DOM timers throttling, in order to help
+        developers determine if a specific issue is caused by timer
+        throttling.
+
+        * Shared/WebPreferencesDefinitions.h:
+        * UIProcess/API/C/WKPreferences.cpp:
+        (WKPreferencesSetDOMTimersThrottlingEnabled):
+        (WKPreferencesGetDOMTimersThrottlingEnabled):
+        * UIProcess/API/C/WKPreferencesRefPrivate.h:
+        * WebProcess/WebPage/WebPage.cpp:
+        (WebKit::WebPage::updatePreferences):
+
 2014-11-18  Geoffrey Garen  <ggaren@apple.com>
 

trunk/Source/WebKit2/Shared/WebPreferencesDefinitions.h

@@ -121 +121 @@
     macro(TabsToLinks, tabsToLinks, Bool, bool, DEFAULT_WEBKIT_TABSTOLINKS_ENABLED) \
     macro(DNSPrefetchingEnabled, dnsPrefetchingEnabled, Bool, bool, false) \
+    macro(DOMTimersThrottlingEnabled, domTimersThrottlingEnabled, Bool, bool, true) \
     macro(WebArchiveDebugModeEnabled, webArchiveDebugModeEnabled, Bool, bool, false) \
     macro(LocalFileContentSniffingEnabled, localFileContentSniffingEnabled, Bool, bool, false) \

trunk/Source/WebKit2/UIProcess/API/C/WKPreferences.cpp

@@ -580 +580 @@
 }
 
+void WKPreferencesSetDOMTimersThrottlingEnabled(WKPreferencesRef preferencesRef, bool enabled)
+{
+    toImpl(preferencesRef)->setDOMTimersThrottlingEnabled(enabled);
+}
+
+bool WKPreferencesGetDOMTimersThrottlingEnabled(WKPreferencesRef preferencesRef)
+{
+    return toImpl(preferencesRef)->domTimersThrottlingEnabled();
+}
+
 void WKPreferencesSetWebArchiveDebugModeEnabled(WKPreferencesRef preferencesRef, bool enabled)
 {

trunk/Source/WebKit2/UIProcess/API/C/WKPreferencesRefPrivate.h

@@ -117 +117 @@
 WK_EXPORT WKStringRef WKPreferencesCopyFTPDirectoryTemplatePath(WKPreferencesRef preferences);
 
+// Defaults to true.
+WK_EXPORT void WKPreferencesSetDOMTimersThrottlingEnabled(WKPreferencesRef preferences, bool enabled);
+WK_EXPORT bool WKPreferencesGetDOMTimersThrottlingEnabled(WKPreferencesRef preferences);
+
 // Defaults to false.
 WK_EXPORT void WKPreferencesSetWebArchiveDebugModeEnabled(WKPreferencesRef preferences, bool enabled);

trunk/Source/WebKit2/WebProcess/WebPage/WebPage.cpp

@@ -2661 +2661 @@
     settings.setForceFTPDirectoryListings(store.getBoolValueForKey(WebPreferencesKey::forceFTPDirectoryListingsKey()));
     settings.setDNSPrefetchingEnabled(store.getBoolValueForKey(WebPreferencesKey::dnsPrefetchingEnabledKey()));
+    settings.setDOMTimersThrottlingEnabled(store.getBoolValueForKey(WebPreferencesKey::domTimersThrottlingEnabledKey()));
 #if ENABLE(WEB_ARCHIVE)
     settings.setWebArchiveDebugModeEnabled(store.getBoolValueForKey(WebPreferencesKey::webArchiveDebugModeEnabledKey()));