<!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>[260966] trunk/Source/WebKit</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/260966">260966</a></dd>
<dt>Author</dt> <dd>cdumez@apple.com</dd>
<dt>Date</dt> <dd>2020-04-30 14:19:15 -0700 (Thu, 30 Apr 2020)</dd>
</dl>

<h3>Log Message</h3>
<pre>[iOS][WK2] Add timeout for "Client navigation" foreground assertion
https://bugs.webkit.org/show_bug.cgi?id=211202

Reviewed by Alex Christensen.

Add a 30s timeout for "Client navigation" foreground assertion. Foreground assertions do not timeout
at RunningBoard level and we thus need to make sure we release them to avoid power leaks.

* UIProcess/API/APINavigation.cpp:
(API::Navigation::Navigation):
* UIProcess/API/APINavigation.h:
(API::Navigation::setClientNavigationActivity):
(API::Navigation::setForegroundActivity): Deleted.
* UIProcess/ProcessThrottler.cpp:
(WebKit::ProcessThrottler::TimedActivity::TimedActivity):
(WebKit::ProcessThrottler::TimedActivity::operator=):
(WebKit::ProcessThrottler::TimedActivity::activityTimedOut):
(WebKit::ProcessThrottler::TimedActivity::updateTimer):
* UIProcess/ProcessThrottler.h:
* UIProcess/WebPageProxy.cpp:
(WebKit::WebPageProxy::loadRequest):
(WebKit::WebPageProxy::loadFile):
(WebKit::WebPageProxy::loadData):
(WebKit::WebPageProxy::didFailProvisionalLoadForFrameShared):
(WebKit::WebPageProxy::didFinishLoadForFrame):
(WebKit::WebPageProxy::didFailLoadForFrame):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKitChangeLog">trunk/Source/WebKit/ChangeLog</a></li>
<li><a href="#trunkSourceWebKitUIProcessAPIAPINavigationcpp">trunk/Source/WebKit/UIProcess/API/APINavigation.cpp</a></li>
<li><a href="#trunkSourceWebKitUIProcessAPIAPINavigationh">trunk/Source/WebKit/UIProcess/API/APINavigation.h</a></li>
<li><a href="#trunkSourceWebKitUIProcessProcessThrottlercpp">trunk/Source/WebKit/UIProcess/ProcessThrottler.cpp</a></li>
<li><a href="#trunkSourceWebKitUIProcessProcessThrottlerh">trunk/Source/WebKit/UIProcess/ProcessThrottler.h</a></li>
<li><a href="#trunkSourceWebKitUIProcessWebPageProxycpp">trunk/Source/WebKit/UIProcess/WebPageProxy.cpp</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKitChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/ChangeLog (260965 => 260966)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/ChangeLog    2020-04-30 21:15:19 UTC (rev 260965)
+++ trunk/Source/WebKit/ChangeLog       2020-04-30 21:19:15 UTC (rev 260966)
</span><span class="lines">@@ -1,3 +1,32 @@
</span><ins>+2020-04-30  Chris Dumez  <cdumez@apple.com>
+
+        [iOS][WK2] Add timeout for "Client navigation" foreground assertion
+        https://bugs.webkit.org/show_bug.cgi?id=211202
+
+        Reviewed by Alex Christensen.
+
+        Add a 30s timeout for "Client navigation" foreground assertion. Foreground assertions do not timeout
+        at RunningBoard level and we thus need to make sure we release them to avoid power leaks.
+
+        * UIProcess/API/APINavigation.cpp:
+        (API::Navigation::Navigation):
+        * UIProcess/API/APINavigation.h:
+        (API::Navigation::setClientNavigationActivity):
+        (API::Navigation::setForegroundActivity): Deleted.
+        * UIProcess/ProcessThrottler.cpp:
+        (WebKit::ProcessThrottler::TimedActivity::TimedActivity):
+        (WebKit::ProcessThrottler::TimedActivity::operator=):
+        (WebKit::ProcessThrottler::TimedActivity::activityTimedOut):
+        (WebKit::ProcessThrottler::TimedActivity::updateTimer):
+        * UIProcess/ProcessThrottler.h:
+        * UIProcess/WebPageProxy.cpp:
+        (WebKit::WebPageProxy::loadRequest):
+        (WebKit::WebPageProxy::loadFile):
+        (WebKit::WebPageProxy::loadData):
+        (WebKit::WebPageProxy::didFailProvisionalLoadForFrameShared):
+        (WebKit::WebPageProxy::didFinishLoadForFrame):
+        (WebKit::WebPageProxy::didFailLoadForFrame):
+
</ins><span class="cx"> 2020-04-30  Alex Christensen  <achristensen@webkit.org>
</span><span class="cx"> 
</span><span class="cx">         Add SPI to change a WKWebView's CORS disabling pattern after initialization
</span></span></pre></div>
<a id="trunkSourceWebKitUIProcessAPIAPINavigationcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/API/APINavigation.cpp (260965 => 260966)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/API/APINavigation.cpp      2020-04-30 21:15:19 UTC (rev 260965)
+++ trunk/Source/WebKit/UIProcess/API/APINavigation.cpp 2020-04-30 21:19:15 UTC (rev 260966)
</span><span class="lines">@@ -35,8 +35,11 @@
</span><span class="cx"> using namespace WebCore;
</span><span class="cx"> using namespace WebKit;
</span><span class="cx"> 
</span><ins>+static constexpr Seconds navigationActivityTimeout { 30_s };
+
</ins><span class="cx"> Navigation::Navigation(WebNavigationState& state)
</span><span class="cx">     : m_navigationID(state.generateNavigationID())
</span><ins>+    , m_clientNavigationActivity(navigationActivityTimeout)
</ins><span class="cx"> {
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="lines">@@ -43,6 +46,7 @@
</span><span class="cx"> Navigation::Navigation(WebNavigationState& state, WebBackForwardListItem* currentAndTargetItem)
</span><span class="cx">     : m_navigationID(state.generateNavigationID())
</span><span class="cx">     , m_reloadItem(currentAndTargetItem)
</span><ins>+    , m_clientNavigationActivity(navigationActivityTimeout)
</ins><span class="cx"> {
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="lines">@@ -51,6 +55,7 @@
</span><span class="cx">     , m_originalRequest(WTFMove(request))
</span><span class="cx">     , m_currentRequest(m_originalRequest)
</span><span class="cx">     , m_fromItem(fromItem)
</span><ins>+    , m_clientNavigationActivity(navigationActivityTimeout)
</ins><span class="cx"> {
</span><span class="cx">     m_redirectChain.append(m_originalRequest.url());
</span><span class="cx"> }
</span><span class="lines">@@ -62,6 +67,7 @@
</span><span class="cx">     , m_targetItem(&targetItem)
</span><span class="cx">     , m_fromItem(fromItem)
</span><span class="cx">     , m_backForwardFrameLoadType(backForwardFrameLoadType)
</span><ins>+    , m_clientNavigationActivity(navigationActivityTimeout)
</ins><span class="cx"> {
</span><span class="cx"> }
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebKitUIProcessAPIAPINavigationh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/API/APINavigation.h (260965 => 260966)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/API/APINavigation.h        2020-04-30 21:15:19 UTC (rev 260965)
+++ trunk/Source/WebKit/UIProcess/API/APINavigation.h   2020-04-30 21:19:15 UTC (rev 260966)
</span><span class="lines">@@ -155,7 +155,7 @@
</span><span class="cx"> 
</span><span class="cx">     const Optional<WebCore::AdClickAttribution>& adClickAttribution() const { return m_lastNavigationAction.adClickAttribution; }
</span><span class="cx"> 
</span><del>-    void setForegroundActivity(std::unique_ptr<WebKit::ProcessThrottler::ForegroundActivity>&& activity) { m_foregroundActivity = WTFMove(activity); }
</del><ins>+    void setClientNavigationActivity(WebKit::ProcessThrottler::ActivityVariant&& activity) { m_clientNavigationActivity = WTFMove(activity); }
</ins><span class="cx"> 
</span><span class="cx">     void setIsLoadedWithNavigationShared(bool value) { m_isLoadedWithNavigationShared = value; }
</span><span class="cx">     bool isLoadedWithNavigationShared() const { return m_isLoadedWithNavigationShared; }
</span><span class="lines">@@ -183,7 +183,7 @@
</span><span class="cx">     WebCore::SecurityOriginData m_destinationFrameSecurityOrigin;
</span><span class="cx">     bool m_userContentExtensionsEnabled { true };
</span><span class="cx">     WebKit::WebContentMode m_effectiveContentMode { WebKit::WebContentMode::Recommended };
</span><del>-    std::unique_ptr<WebKit::ProcessThrottler::ForegroundActivity> m_foregroundActivity;
</del><ins>+    WebKit::ProcessThrottler::TimedActivity m_clientNavigationActivity;
</ins><span class="cx">     bool m_isLoadedWithNavigationShared { false };
</span><span class="cx"> };
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebKitUIProcessProcessThrottlercpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/ProcessThrottler.cpp (260965 => 260966)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/ProcessThrottler.cpp       2020-04-30 21:15:19 UTC (rev 260965)
+++ trunk/Source/WebKit/UIProcess/ProcessThrottler.cpp  2020-04-30 21:19:15 UTC (rev 260966)
</span><span class="lines">@@ -239,4 +239,33 @@
</span><span class="cx">     return WTF::get<UniqueRef<ProcessThrottler::ForegroundActivity>>(activity)->isValid();
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+ProcessThrottler::TimedActivity::TimedActivity(Seconds timeout, ProcessThrottler::ActivityVariant&& activity)
+    : m_timer(RunLoop::main(), this, &TimedActivity::activityTimedOut)
+    , m_timeout(timeout)
+    , m_activity(WTFMove(activity))
+{
+    updateTimer();
+}
+
+auto ProcessThrottler::TimedActivity::operator=(ProcessThrottler::ActivityVariant&& activity) -> TimedActivity&
+{
+    m_activity = WTFMove(activity);
+    updateTimer();
+    return *this;
+}
+
+void ProcessThrottler::TimedActivity::activityTimedOut()
+{
+    RELEASE_LOG_ERROR(ProcessSuspension, "%p - TimedActivity::activityTimedOut:", this);
+    m_activity = nullptr;
+}
+
+void ProcessThrottler::TimedActivity::updateTimer()
+{
+    if (WTF::holds_alternative<std::nullptr_t>(m_activity))
+        m_timer.stop();
+    else
+        m_timer.startOneShot(m_timeout);
+}
+
</ins><span class="cx"> } // namespace WebKit
</span></span></pre></div>
<a id="trunkSourceWebKitUIProcessProcessThrottlerh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/ProcessThrottler.h (260965 => 260966)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/ProcessThrottler.h 2020-04-30 21:15:19 UTC (rev 260965)
+++ trunk/Source/WebKit/UIProcess/ProcessThrottler.h    2020-04-30 21:19:15 UTC (rev 260966)
</span><span class="lines">@@ -102,6 +102,20 @@
</span><span class="cx">     using ActivityVariant = Variant<std::nullptr_t, UniqueRef<BackgroundActivity>, UniqueRef<ForegroundActivity>>;
</span><span class="cx">     static bool isValidBackgroundActivity(const ActivityVariant&);
</span><span class="cx">     static bool isValidForegroundActivity(const ActivityVariant&);
</span><ins>+
+    class TimedActivity {
+    public:
+        TimedActivity(Seconds timeout, ActivityVariant&& = nullptr);
+        TimedActivity& operator=(ActivityVariant&&);
+
+    private:
+        void activityTimedOut();
+        void updateTimer();
+
+        RunLoop::Timer<TimedActivity> m_timer;
+        Seconds m_timeout;
+        ActivityVariant m_activity;
+    };
</ins><span class="cx">     
</span><span class="cx">     void didConnectToProcess(ProcessID);
</span><span class="cx">     bool shouldBeRunnable() const { return m_foregroundActivities.size() || m_backgroundActivities.size(); }
</span></span></pre></div>
<a id="trunkSourceWebKitUIProcessWebPageProxycpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/WebPageProxy.cpp (260965 => 260966)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/WebPageProxy.cpp   2020-04-30 21:15:19 UTC (rev 260965)
+++ trunk/Source/WebKit/UIProcess/WebPageProxy.cpp      2020-04-30 21:19:15 UTC (rev 260966)
</span><span class="lines">@@ -1301,7 +1301,7 @@
</span><span class="cx">     auto navigation = m_navigationState->createLoadRequestNavigation(ResourceRequest(request), m_backForwardList->currentItem());
</span><span class="cx"> 
</span><span class="cx">     if (shouldForceForegroundPriorityForClientNavigation())
</span><del>-        navigation->setForegroundActivity(process().throttler().foregroundActivity("Client navigation"_s).moveToUniquePtr());
</del><ins>+        navigation->setClientNavigationActivity(process().throttler().foregroundActivity("Client navigation"_s));
</ins><span class="cx"> 
</span><span class="cx">     loadRequestWithNavigationShared(m_process.copyRef(), m_webPageID, navigation.get(), WTFMove(request), shouldOpenExternalURLsPolicy, userData, ShouldTreatAsContinuingLoad::No, isNavigatingToAppBoundDomain(), hasNavigatedAwayFromAppBoundDomain());
</span><span class="cx">     return navigation;
</span><span class="lines">@@ -1382,7 +1382,7 @@
</span><span class="cx">     auto navigation = m_navigationState->createLoadRequestNavigation(ResourceRequest(fileURL), m_backForwardList->currentItem());
</span><span class="cx"> 
</span><span class="cx">     if (shouldForceForegroundPriorityForClientNavigation())
</span><del>-        navigation->setForegroundActivity(process().throttler().foregroundActivity("Client navigation"_s).moveToUniquePtr());
</del><ins>+        navigation->setClientNavigationActivity(process().throttler().foregroundActivity("Client navigation"_s));
</ins><span class="cx"> 
</span><span class="cx">     auto transaction = m_pageLoadState.transaction();
</span><span class="cx"> 
</span><span class="lines">@@ -1425,7 +1425,7 @@
</span><span class="cx">     auto navigation = m_navigationState->createLoadDataNavigation(makeUnique<API::SubstituteData>(data.vector(), MIMEType, encoding, baseURL, userData));
</span><span class="cx"> 
</span><span class="cx">     if (shouldForceForegroundPriorityForClientNavigation())
</span><del>-        navigation->setForegroundActivity(process().throttler().foregroundActivity("Client navigation"_s).moveToUniquePtr());
</del><ins>+        navigation->setClientNavigationActivity(process().throttler().foregroundActivity("Client navigation"_s));
</ins><span class="cx"> 
</span><span class="cx">     loadDataWithNavigationShared(m_process.copyRef(), m_webPageID, navigation, data, MIMEType, encoding, baseURL, userData, ShouldTreatAsContinuingLoad::No, isNavigatingToAppBoundDomain(), hasNavigatedAwayFromAppBoundDomain(), WTF::nullopt, shouldOpenExternalURLsPolicy);
</span><span class="cx">     return navigation;
</span><span class="lines">@@ -4602,7 +4602,7 @@
</span><span class="cx">         m_pageLoadState.didFailProvisionalLoad(transaction);
</span><span class="cx">         pageClient().didFailProvisionalLoadForMainFrame();
</span><span class="cx">         if (navigation)
</span><del>-            navigation->setForegroundActivity(nullptr);
</del><ins>+            navigation->setClientNavigationActivity(nullptr);
</ins><span class="cx">     }
</span><span class="cx"> 
</span><span class="cx">     frame->didFailProvisionalLoad();
</span><span class="lines">@@ -4839,7 +4839,7 @@
</span><span class="cx">         pageClient().didFinishLoadForMainFrame();
</span><span class="cx"> 
</span><span class="cx">         if (navigation)
</span><del>-            navigation->setForegroundActivity(nullptr);
</del><ins>+            navigation->setClientNavigationActivity(nullptr);
</ins><span class="cx"> 
</span><span class="cx">         resetRecentCrashCountSoon();
</span><span class="cx"> 
</span><span class="lines">@@ -4892,7 +4892,7 @@
</span><span class="cx">         reportPageLoadResult(error);
</span><span class="cx">         pageClient().didFailLoadForMainFrame();
</span><span class="cx">         if (navigation)
</span><del>-            navigation->setForegroundActivity(nullptr);
</del><ins>+            navigation->setClientNavigationActivity(nullptr);
</ins><span class="cx">     }
</span><span class="cx"> }
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>