<!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>[170115] trunk/Source/WebKit2</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/170115">170115</a></dd>
<dt>Author</dt> <dd>benjamin@webkit.org</dd>
<dt>Date</dt> <dd>2014-06-18 14:38:04 -0700 (Wed, 18 Jun 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>[iOS][WK2] Re-sync didCommitLoadForMainFrame with its corresponding tile update
https://bugs.webkit.org/show_bug.cgi?id=134009

Patch by Benjamin Poulain &lt;bpoulain@apple.com&gt; on 2014-06-18
Reviewed by Tim Horton.

WKWebView assumed the first _didCommitLayerTree: after _didCommitLoadForMainFrame
had the state of the page being loaded.

This is not always true. Sometimes, a set of tiles can be rendering asynchronously while the next
page is loaded, and does not flush the queue until after didCommitLoadForMainFrame is executed.

Tim introduced a transactionID with each layer tree update. This patch uses that to synchronize
WKWebView with the right set of tiles.

* UIProcess/API/Cocoa/WKWebView.mm:
(-[WKWebView _didCommitLoadForMainFrame]):
(-[WKWebView _didCommitLayerTree:WebKit::]):
(-[WKWebView _updateVisibleContentRects]):
* UIProcess/WebPageProxy.h:
* UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.h:
(WebKit::RemoteLayerTreeDrawingAreaProxy::nextLayerTreeTransactionID):
* UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.messages.in:
* UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.mm:
(WebKit::RemoteLayerTreeDrawingAreaProxy::RemoteLayerTreeDrawingAreaProxy):
(WebKit::RemoteLayerTreeDrawingAreaProxy::willCommitLayerTree):
* WebProcess/WebPage/mac/RemoteLayerTreeDrawingArea.mm:
(WebKit::RemoteLayerTreeDrawingArea::flushLayers):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewmm">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm</a></li>
<li><a href="#trunkSourceWebKit2UIProcessWebPageProxyh">trunk/Source/WebKit2/UIProcess/WebPageProxy.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessmacRemoteLayerTreeDrawingAreaProxyh">trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessmacRemoteLayerTreeDrawingAreaProxymessagesin">trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.messages.in</a></li>
<li><a href="#trunkSourceWebKit2UIProcessmacRemoteLayerTreeDrawingAreaProxymm">trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.mm</a></li>
<li><a href="#trunkSourceWebKit2WebProcessWebPagemacRemoteLayerTreeDrawingAreamm">trunk/Source/WebKit2/WebProcess/WebPage/mac/RemoteLayerTreeDrawingArea.mm</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (170114 => 170115)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog        2014-06-18 20:56:12 UTC (rev 170114)
+++ trunk/Source/WebKit2/ChangeLog        2014-06-18 21:38:04 UTC (rev 170115)
</span><span class="lines">@@ -1,3 +1,33 @@
</span><ins>+2014-06-18  Benjamin Poulain  &lt;bpoulain@apple.com&gt;
+
+        [iOS][WK2] Re-sync didCommitLoadForMainFrame with its corresponding tile update
+        https://bugs.webkit.org/show_bug.cgi?id=134009
+
+        Reviewed by Tim Horton.
+
+        WKWebView assumed the first _didCommitLayerTree: after _didCommitLoadForMainFrame
+        had the state of the page being loaded.
+
+        This is not always true. Sometimes, a set of tiles can be rendering asynchronously while the next
+        page is loaded, and does not flush the queue until after didCommitLoadForMainFrame is executed.
+
+        Tim introduced a transactionID with each layer tree update. This patch uses that to synchronize
+        WKWebView with the right set of tiles.
+
+        * UIProcess/API/Cocoa/WKWebView.mm:
+        (-[WKWebView _didCommitLoadForMainFrame]):
+        (-[WKWebView _didCommitLayerTree:WebKit::]):
+        (-[WKWebView _updateVisibleContentRects]):
+        * UIProcess/WebPageProxy.h:
+        * UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.h:
+        (WebKit::RemoteLayerTreeDrawingAreaProxy::nextLayerTreeTransactionID):
+        * UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.messages.in:
+        * UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.mm:
+        (WebKit::RemoteLayerTreeDrawingAreaProxy::RemoteLayerTreeDrawingAreaProxy):
+        (WebKit::RemoteLayerTreeDrawingAreaProxy::willCommitLayerTree):
+        * WebProcess/WebPage/mac/RemoteLayerTreeDrawingArea.mm:
+        (WebKit::RemoteLayerTreeDrawingArea::flushLayers):
+
</ins><span class="cx"> 2014-06-18  Anders Carlsson  &lt;andersca@apple.com&gt;
</span><span class="cx"> 
</span><span class="cx">         Simplify WebCredential
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm (170114 => 170115)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm        2014-06-18 20:56:12 UTC (rev 170114)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.mm        2014-06-18 21:38:04 UTC (rev 170115)
</span><span class="lines">@@ -79,6 +79,7 @@
</span><span class="cx"> #import &quot;_WKWebViewPrintFormatter.h&quot;
</span><span class="cx"> #import &quot;PrintInfo.h&quot;
</span><span class="cx"> #import &quot;ProcessThrottler.h&quot;
</span><ins>+#import &quot;RemoteLayerTreeDrawingAreaProxy.h&quot;
</ins><span class="cx"> #import &quot;WKPDFView.h&quot;
</span><span class="cx"> #import &quot;WKScrollView.h&quot;
</span><span class="cx"> #import &quot;WKWebViewContentProviderRegistry.h&quot;
</span><span class="lines">@@ -162,6 +163,7 @@
</span><span class="cx">     BOOL _overridesInterfaceOrientation;
</span><span class="cx"> 
</span><span class="cx">     BOOL _needsResetViewStateAfterCommitLoadForMainFrame;
</span><ins>+    uint64_t _firstPaintAfterCommitLoadTransactionID;
</ins><span class="cx">     BOOL _isAnimatingResize;
</span><span class="cx">     CATransform3D _resizeAnimationTransformAdjustments;
</span><span class="cx">     RetainPtr&lt;UIView&gt; _resizeAnimationView;
</span><span class="lines">@@ -705,6 +707,8 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)_didCommitLoadForMainFrame
</span><span class="cx"> {
</span><ins>+    _firstPaintAfterCommitLoadTransactionID = toRemoteLayerTreeDrawingAreaProxy(_page-&gt;drawingArea())-&gt;nextLayerTreeTransactionID();
+
</ins><span class="cx">     _needsResetViewStateAfterCommitLoadForMainFrame = YES;
</span><span class="cx">     _usesMinimalUI = NO;
</span><span class="cx"> }
</span><span class="lines">@@ -739,9 +743,10 @@
</span><span class="cx">             [static_cast&lt;id &lt;WKUIDelegatePrivate&gt;&gt;(delegate.get()) _webView:self usesMinimalUI:_usesMinimalUI];
</span><span class="cx">     }
</span><span class="cx"> 
</span><del>-    if (_needsResetViewStateAfterCommitLoadForMainFrame) {
</del><ins>+    if (_needsResetViewStateAfterCommitLoadForMainFrame &amp;&amp; layerTreeTransaction.transactionID() &gt;= _firstPaintAfterCommitLoadTransactionID) {
</ins><span class="cx">         _needsResetViewStateAfterCommitLoadForMainFrame = NO;
</span><span class="cx">         [_scrollView setContentOffset:CGPointMake(-_obscuredInsets.left, -_obscuredInsets.top)];
</span><ins>+        [self _updateVisibleContentRects];
</ins><span class="cx">     }
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="lines">@@ -1181,6 +1186,9 @@
</span><span class="cx">     if (_isAnimatingResize)
</span><span class="cx">         return;
</span><span class="cx"> 
</span><ins>+    if (_needsResetViewStateAfterCommitLoadForMainFrame)
+        return;
+
</ins><span class="cx">     CGRect fullViewRect = self.bounds;
</span><span class="cx">     CGRect visibleRectInContentCoordinates = [self convertRect:fullViewRect toView:_contentView.get()];
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessWebPageProxyh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/WebPageProxy.h (170114 => 170115)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/WebPageProxy.h        2014-06-18 20:56:12 UTC (rev 170114)
+++ trunk/Source/WebKit2/UIProcess/WebPageProxy.h        2014-06-18 21:38:04 UTC (rev 170115)
</span><span class="lines">@@ -395,6 +395,7 @@
</span><span class="cx">     void setMaximumUnobscuredSize(const WebCore::FloatSize&amp;);
</span><span class="cx">     void setDeviceOrientation(int32_t);
</span><span class="cx">     int32_t deviceOrientation() const { return m_deviceOrientation; }
</span><ins>+    void willCommitLayerTree(uint64_t transactionID);
</ins><span class="cx">     void didCommitLayerTree(const WebKit::RemoteLayerTreeTransaction&amp;);
</span><span class="cx"> 
</span><span class="cx">     void selectWithGesture(const WebCore::IntPoint, WebCore::TextGranularity, uint32_t gestureType, uint32_t gestureState, std::function&lt;void (const WebCore::IntPoint&amp;, uint32_t, uint32_t, uint32_t, CallbackBase::Error)&gt;);
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessmacRemoteLayerTreeDrawingAreaProxyh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.h (170114 => 170115)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.h        2014-06-18 20:56:12 UTC (rev 170114)
+++ trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.h        2014-06-18 21:38:04 UTC (rev 170115)
</span><span class="lines">@@ -49,6 +49,8 @@
</span><span class="cx"> 
</span><span class="cx">     void coreAnimationDidCommitLayers();
</span><span class="cx"> 
</span><ins>+    uint64_t nextLayerTreeTransactionID() const { return m_pendingLayerTreeTransactionID + 1; }
+
</ins><span class="cx"> private:
</span><span class="cx">     virtual void sizeDidChange() override;
</span><span class="cx">     virtual void deviceScaleFactorDidChange() override;
</span><span class="lines">@@ -72,6 +74,7 @@
</span><span class="cx">     virtual void didReceiveMessage(IPC::Connection*, IPC::MessageDecoder&amp;) override;
</span><span class="cx"> 
</span><span class="cx">     // Message handlers
</span><ins>+    void willCommitLayerTree(uint64_t transactionID);
</ins><span class="cx">     void commitLayerTree(const RemoteLayerTreeTransaction&amp;, const RemoteScrollingCoordinatorTransaction&amp;);
</span><span class="cx">     
</span><span class="cx">     void sendUpdateGeometry();
</span><span class="lines">@@ -90,6 +93,7 @@
</span><span class="cx"> 
</span><span class="cx">     std::unique_ptr&lt;WebCore::RunLoopObserver&gt; m_layerCommitObserver;
</span><span class="cx"> 
</span><ins>+    uint64_t m_pendingLayerTreeTransactionID;
</ins><span class="cx">     uint64_t m_lastVisibleTransactionID;
</span><span class="cx">     uint64_t m_transactionIDForPendingCACommit;
</span><span class="cx"> };
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessmacRemoteLayerTreeDrawingAreaProxymessagesin"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.messages.in (170114 => 170115)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.messages.in        2014-06-18 20:56:12 UTC (rev 170114)
+++ trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.messages.in        2014-06-18 21:38:04 UTC (rev 170115)
</span><span class="lines">@@ -21,5 +21,6 @@
</span><span class="cx"> # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</span><span class="cx"> 
</span><span class="cx"> messages -&gt; RemoteLayerTreeDrawingAreaProxy : DrawingAreaProxy {
</span><ins>+    void WillCommitLayerTree(uint64_t transactionID)
</ins><span class="cx">     void CommitLayerTree(WebKit::RemoteLayerTreeTransaction layerTreeTransaction, WebKit::RemoteScrollingCoordinatorTransaction scrollingTreeTransaction)
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessmacRemoteLayerTreeDrawingAreaProxymm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.mm (170114 => 170115)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.mm        2014-06-18 20:56:12 UTC (rev 170114)
+++ trunk/Source/WebKit2/UIProcess/mac/RemoteLayerTreeDrawingAreaProxy.mm        2014-06-18 21:38:04 UTC (rev 170115)
</span><span class="lines">@@ -47,6 +47,7 @@
</span><span class="cx">     : DrawingAreaProxy(DrawingAreaTypeRemoteLayerTree, webPageProxy)
</span><span class="cx">     , m_remoteLayerTreeHost(*this)
</span><span class="cx">     , m_isWaitingForDidUpdateGeometry(false)
</span><ins>+    , m_pendingLayerTreeTransactionID(0)
</ins><span class="cx">     , m_lastVisibleTransactionID(0)
</span><span class="cx"> {
</span><span class="cx"> #if USE(IOSURFACE)
</span><span class="lines">@@ -115,6 +116,11 @@
</span><span class="cx">     m_isWaitingForDidUpdateGeometry = true;
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+void RemoteLayerTreeDrawingAreaProxy::willCommitLayerTree(uint64_t transactionID)
+{
+    m_pendingLayerTreeTransactionID = transactionID;
+}
+
</ins><span class="cx"> void RemoteLayerTreeDrawingAreaProxy::commitLayerTree(const RemoteLayerTreeTransaction&amp; layerTreeTransaction, const RemoteScrollingCoordinatorTransaction&amp; scrollingTreeTransaction)
</span><span class="cx"> {
</span><span class="cx">     LOG(RemoteLayerTree, &quot;%s&quot;, layerTreeTransaction.description().data());
</span></span></pre></div>
<a id="trunkSourceWebKit2WebProcessWebPagemacRemoteLayerTreeDrawingAreamm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/WebProcess/WebPage/mac/RemoteLayerTreeDrawingArea.mm (170114 => 170115)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/WebProcess/WebPage/mac/RemoteLayerTreeDrawingArea.mm        2014-06-18 20:56:12 UTC (rev 170114)
+++ trunk/Source/WebKit2/WebProcess/WebPage/mac/RemoteLayerTreeDrawingArea.mm        2014-06-18 21:38:04 UTC (rev 170115)
</span><span class="lines">@@ -289,6 +289,8 @@
</span><span class="cx"> 
</span><span class="cx">     m_waitingForBackingStoreSwap = true;
</span><span class="cx"> 
</span><ins>+    m_webPage-&gt;send(Messages::RemoteLayerTreeDrawingAreaProxy::WillCommitLayerTree(layerTransaction.transactionID()));
+
</ins><span class="cx">     Messages::RemoteLayerTreeDrawingAreaProxy::CommitLayerTree message(layerTransaction, scrollingTransaction);
</span><span class="cx">     auto commitEncoder = std::make_unique&lt;IPC::MessageEncoder&gt;(Messages::RemoteLayerTreeDrawingAreaProxy::CommitLayerTree::receiverName(), Messages::RemoteLayerTreeDrawingAreaProxy::CommitLayerTree::name(), m_webPage-&gt;pageID());
</span><span class="cx">     commitEncoder-&gt;encode(message.arguments());
</span></span></pre>
</div>
</div>

</body>
</html>