Changeset 207699 in webkit

Timestamp:

Oct 21, 2016 4:20:11 PM (7 years ago)

Author:

barraclough@apple.com

Message:

WebPage should take UserActivity directly for user input
​https://bugs.webkit.org/show_bug.cgi?id=163813

Reviewed by Anders Carlsson.

When we receive mouse/keyboard events in a page, we want to prevent AppNap. We currently do so
via the PageThrottler. This patch is to just make the WebPage drive the UserActivity directly.

Two reasons to do so: (1) to cleanup & simplify for further refactoring. (2) The current code
isn't really achieving the desired effect. The page setting the flag in the throttler to get
the activity to be set is now a less effective way of achieving this goal, since the
PageActivityState bounces back across to the UI process & then messages back to the WebContent
process to take the UserActivity. These extra hops defeat the purpose of making sure the boost
from the initial message isn't lost.

Source/WebCore:

• page/PageThrottler.cpp:

(WebCore::PageThrottler::PageThrottler):
(WebCore::m_userInputHysteresis): Deleted.

• page/PageThrottler.h:

(WebCore::PageThrottler::didReceiveUserInput): Deleted.

• removed PageActivityState::UserInputActivity, didReceiveUserInput, m_userInputHysteresis.

Source/WebKit2:

• WebProcess/WebPage/WebPage.cpp:

(WebKit::m_userActivityHysteresis):

• m_userActivityHysteresis triggers updateUserActivity.

(WebKit::WebPage::setPageSuppressed):

• setPageSuppressed starts/stops m_userActivityHysteresis.

(WebKit::WebPage::updateUserActivity):

• update UserActivity based on state of m_userActivityHysteresis.

(WebKit::WebPage::mouseEvent):
(WebKit::WebPage::wheelEvent):
(WebKit::WebPage::keyEvent):

• input events impulse m_userActivityHysteresis.

• WebProcess/WebPage/WebPage.h:

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/page/PageThrottler.cpp (modified) (1 diff)
• WebCore/page/PageThrottler.h (modified) (4 diffs)
• WebKit2/ChangeLog (modified) (1 diff)
• WebKit2/WebProcess/WebPage/WebPage.cpp (modified) (5 diffs)
• WebKit2/WebProcess/WebPage/WebPage.h (modified) (2 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2016-10-21  Gavin Barraclough  <barraclough@apple.com>
+
+        WebPage should take UserActivity directly for user input
+        https://bugs.webkit.org/show_bug.cgi?id=163813
+
+        Reviewed by Anders Carlsson.
+
+        When we receive mouse/keyboard events in a page, we want to prevent AppNap. We currently do so
+        via the PageThrottler. This patch is to just make the WebPage drive the UserActivity directly.
+
+        Two reasons to do so: (1) to cleanup & simplify for further refactoring. (2) The current code
+        isn't really achieving the desired effect. The page setting the flag in the throttler to get
+        the activity to be set is now a less effective way of achieving this goal, since the
+        PageActivityState bounces back across to the UI process & then messages back to the WebContent
+        process to take the UserActivity. These extra hops defeat the purpose of making sure the boost
+        from the initial message isn't lost.
+
+        * page/PageThrottler.cpp:
+        (WebCore::PageThrottler::PageThrottler):
+        (WebCore::m_userInputHysteresis): Deleted.
+        * page/PageThrottler.h:
+        (WebCore::PageThrottler::didReceiveUserInput): Deleted.
+            - removed PageActivityState::UserInputActivity, didReceiveUserInput, m_userInputHysteresis.
+
 2016-10-21  Wenson Hsieh  <wenson_hsieh@apple.com>
 

trunk/Source/WebCore/page/PageThrottler.cpp

@@ -35 +35 @@
 PageThrottler::PageThrottler(Page& page)
     : m_page(page)
-    , m_userInputHysteresis([this](HysteresisState state) { setActivityFlag(PageActivityState::UserInputActivity, state == HysteresisState::Started); })
     , m_mediaActivityHysteresis([this](HysteresisState state) { setActivityFlag(PageActivityState::MediaActivity, state == HysteresisState::Started); })
     , m_pageLoadActivityHysteresis([this](HysteresisState state) { setActivityFlag(PageActivityState::PageLoadActivity, state == HysteresisState::Started); }, PageLoadHysteresisSeconds)

trunk/Source/WebCore/page/PageThrottler.h

@@ -43 +43 @@
 struct PageActivityState {
     enum {
-        UserInputActivity = 1 << 0,
-        MediaActivity = 1 << 1,
-        PageLoadActivity = 1 << 2,
+        MediaActivity = 1 << 0,
+        PageLoadActivity = 1 << 1,
     };
 
@@ -51 +50 @@
 
     static const Flags NoFlags = 0;
-    static const Flags AllFlags = UserInputActivity | MediaActivity | PageLoadActivity;
+    static const Flags AllFlags = MediaActivity | PageLoadActivity;
 };
 
@@ -59 +58 @@
     PageThrottler(Page&);
 
-    void didReceiveUserInput() { m_userInputHysteresis.impulse(); }
     PageActivityState::Flags activityState() { return m_activityState; }
     void pluginDidEvaluateWhileAudioIsPlaying() { m_mediaActivityHysteresis.impulse(); }
@@ -72 +70 @@
     Page& m_page;
     PageActivityState::Flags m_activityState { PageActivityState::NoFlags };
-    HysteresisActivity m_userInputHysteresis;
     HysteresisActivity m_mediaActivityHysteresis;
     HysteresisActivity m_pageLoadActivityHysteresis;

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2016-10-21  Gavin Barraclough  <barraclough@apple.com>
+
+        WebPage should take UserActivity directly for user input
+        https://bugs.webkit.org/show_bug.cgi?id=163813
+
+        Reviewed by Anders Carlsson.
+
+        When we receive mouse/keyboard events in a page, we want to prevent AppNap. We currently do so
+        via the PageThrottler. This patch is to just make the WebPage drive the UserActivity directly.
+
+        Two reasons to do so: (1) to cleanup & simplify for further refactoring. (2) The current code
+        isn't really achieving the desired effect. The page setting the flag in the throttler to get
+        the activity to be set is now a less effective way of achieving this goal, since the
+        PageActivityState bounces back across to the UI process & then messages back to the WebContent
+        process to take the UserActivity. These extra hops defeat the purpose of making sure the boost
+        from the initial message isn't lost.
+
+        * WebProcess/WebPage/WebPage.cpp:
+        (WebKit::m_userActivityHysteresis):
+            - m_userActivityHysteresis triggers updateUserActivity.
+        (WebKit::WebPage::setPageSuppressed):
+            - setPageSuppressed starts/stops m_userActivityHysteresis.
+        (WebKit::WebPage::updateUserActivity):
+            - update UserActivity based on state of m_userActivityHysteresis.
+        (WebKit::WebPage::mouseEvent):
+        (WebKit::WebPage::wheelEvent):
+        (WebKit::WebPage::keyEvent):
+            - input events impulse m_userActivityHysteresis.
+        * WebProcess/WebPage/WebPage.h:
+
 2016-10-21  Wenson Hsieh  <wenson_hsieh@apple.com>
 

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

@@ -379 +379 @@
     , m_viewState(parameters.viewState)
     , m_userActivity("Process suppression disabled for page.")
+    , m_userActivityHysteresis([this](HysteresisState) { updateUserActivity(); })
     , m_pendingNavigationID(0)
 #if ENABLE(WEBGL)
@@ -591 +592 @@
     // If the page should not be supressed, start it.
     if (pageSuppressed)
+        m_userActivityHysteresis.stop();
+    else
+        m_userActivityHysteresis.start();
+}
+
+void WebPage::updateUserActivity()
+{
+    if (m_userActivityHysteresis.state() == HysteresisState::Started)
+        m_userActivity.start();
+    else
         m_userActivity.stop();
-    else
-        m_userActivity.start();
 }
 
@@ -2239 +2248 @@
     TemporaryChange<bool> userIsInteractingChange { m_userIsInteracting, true };
 
-    m_page->pageThrottler().didReceiveUserInput();
+    m_userActivityHysteresis.impulse();
 
     bool shouldHandleEvent = true;
@@ -2294 +2303 @@
 void WebPage::wheelEvent(const WebWheelEvent& wheelEvent)
 {
-    m_page->pageThrottler().didReceiveUserInput();
+    m_userActivityHysteresis.impulse();
 
     CurrentEvent currentEvent(wheelEvent);
@@ -2317 +2326 @@
     TemporaryChange<bool> userIsInteractingChange { m_userIsInteracting, true };
 
-    m_page->pageThrottler().didReceiveUserInput();
+    m_userActivityHysteresis.impulse();
 
     CurrentEvent currentEvent(keyboardEvent);

trunk/Source/WebKit2/WebProcess/WebPage/WebPage.h

@@ -972 +972 @@
     WebPage(uint64_t pageID, const WebPageCreationParameters&);
 
+    void updateUserActivity();
+
     // IPC::MessageSender
     IPC::Connection* messageSenderConnection() override;
@@ -1487 +1489 @@
 
     UserActivity m_userActivity;
+    WebCore::HysteresisActivity m_userActivityHysteresis;
 
     uint64_t m_pendingNavigationID;