<!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>[218642] 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/218642">218642</a></dd>
<dt>Author</dt> <dd>wenson_hsieh@apple.com</dd>
<dt>Date</dt> <dd>2017-06-21 11:54:45 -0700 (Wed, 21 Jun 2017)</dd>
</dl>

<h3>Log Message</h3>
<pre>[iOS DnD] [WK2] Add drag-and-drop release logging around WKContentView
https://bugs.webkit.org/show_bug.cgi?id=173636

Reviewed by Tim Horton.

Add logging at key points in the drag-and-drop lifecycle in the UI process, so that sysdiagnoses will contain
sufficient information to debug sparse failures.

* Platform/Logging.h:
* UIProcess/ios/WKContentViewInteraction.mm:
(-[WKContentView _didHandleStartDataInteractionRequest:]):
(-[WKContentView cleanUpDragSourceSessionState]):
(-[WKContentView _didPerformDataInteractionControllerOperation:]):
(-[WKContentView _dragInteraction:prepareForSession:completion:]):
(-[WKContentView dragInteraction:itemsForBeginningSession:]):
(-[WKContentView dragInteraction:sessionWillBegin:]):
(-[WKContentView _api_dragInteraction:session:didEndWithOperation:]):
(-[WKContentView dropInteraction:canHandleSession:]):
(-[WKContentView _api_dropInteraction:sessionDidEnter:]):
(-[WKContentView dropInteraction:sessionDidExit:]):
(-[WKContentView dropInteraction:performDrop:]):
(-[WKContentView dropInteraction:sessionDidEnd:]):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2PlatformLoggingh">trunk/Source/WebKit2/Platform/Logging.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessiosWKContentViewInteractionmm">trunk/Source/WebKit2/UIProcess/ios/WKContentViewInteraction.mm</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (218641 => 218642)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog   2017-06-21 18:42:44 UTC (rev 218641)
+++ trunk/Source/WebKit2/ChangeLog      2017-06-21 18:54:45 UTC (rev 218642)
</span><span class="lines">@@ -1,3 +1,28 @@
</span><ins>+2017-06-21  Wenson Hsieh  <wenson_hsieh@apple.com>
+
+        [iOS DnD] [WK2] Add drag-and-drop release logging around WKContentView
+        https://bugs.webkit.org/show_bug.cgi?id=173636
+
+        Reviewed by Tim Horton.
+
+        Add logging at key points in the drag-and-drop lifecycle in the UI process, so that sysdiagnoses will contain
+        sufficient information to debug sparse failures.
+
+        * Platform/Logging.h:
+        * UIProcess/ios/WKContentViewInteraction.mm:
+        (-[WKContentView _didHandleStartDataInteractionRequest:]):
+        (-[WKContentView cleanUpDragSourceSessionState]):
+        (-[WKContentView _didPerformDataInteractionControllerOperation:]):
+        (-[WKContentView _dragInteraction:prepareForSession:completion:]):
+        (-[WKContentView dragInteraction:itemsForBeginningSession:]):
+        (-[WKContentView dragInteraction:sessionWillBegin:]):
+        (-[WKContentView _api_dragInteraction:session:didEndWithOperation:]):
+        (-[WKContentView dropInteraction:canHandleSession:]):
+        (-[WKContentView _api_dropInteraction:sessionDidEnter:]):
+        (-[WKContentView dropInteraction:sessionDidExit:]):
+        (-[WKContentView dropInteraction:performDrop:]):
+        (-[WKContentView dropInteraction:sessionDidEnd:]):
+
</ins><span class="cx"> 2017-06-21  Jeremy Jones  <jeremyj@apple.com>
</span><span class="cx"> 
</span><span class="cx">         Don't clear audio mute when muting capture.
</span></span></pre></div>
<a id="trunkSourceWebKit2PlatformLoggingh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/Platform/Logging.h (218641 => 218642)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/Platform/Logging.h  2017-06-21 18:42:44 UTC (rev 218641)
+++ trunk/Source/WebKit2/Platform/Logging.h     2017-06-21 18:54:45 UTC (rev 218642)
</span><span class="lines">@@ -42,6 +42,7 @@
</span><span class="cx"> 
</span><span class="cx"> #define WEBKIT2_LOG_CHANNELS(M) \
</span><span class="cx">     M(ContextMenu) \
</span><ins>+    M(DragAndDrop) \
</ins><span class="cx">     M(Gamepad) \
</span><span class="cx">     M(IconDatabase) \
</span><span class="cx">     M(IDB) \
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessiosWKContentViewInteractionmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ios/WKContentViewInteraction.mm (218641 => 218642)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ios/WKContentViewInteraction.mm   2017-06-21 18:42:44 UTC (rev 218641)
+++ trunk/Source/WebKit2/UIProcess/ios/WKContentViewInteraction.mm      2017-06-21 18:54:45 UTC (rev 218642)
</span><span class="lines">@@ -4239,6 +4239,7 @@
</span><span class="cx">         [self cleanUpDragSourceSessionState];
</span><span class="cx">     }
</span><span class="cx"> 
</span><ins>+    RELEASE_LOG(DragAndDrop, "Handling drag start request (started: %d, completion block: %p)", started, savedCompletionBlock.get());
</ins><span class="cx">     if (savedCompletionBlock)
</span><span class="cx">         savedCompletionBlock();
</span><span class="cx"> }
</span><span class="lines">@@ -4356,6 +4357,7 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)cleanUpDragSourceSessionState
</span><span class="cx"> {
</span><ins>+    RELEASE_LOG(DragAndDrop, "Cleaning up dragging state (has pending operation: %d)", [[WebItemProviderPasteboard sharedInstance] hasPendingOperation]);
</ins><span class="cx">     if (![[WebItemProviderPasteboard sharedInstance] hasPendingOperation]) {
</span><span class="cx">         // If we're performing a drag operation, don't clear out the pasteboard yet, since another web view may still require access to it.
</span><span class="cx">         // The pasteboard will be cleared after the last client is finished performing a drag operation using the item providers.
</span><span class="lines">@@ -4427,6 +4429,7 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)_didPerformDataInteractionControllerOperation:(BOOL)handled
</span><span class="cx"> {
</span><ins>+    RELEASE_LOG(DragAndDrop, "Finished performing drag controller operation (handled: %d)", handled);
</ins><span class="cx">     [[WebItemProviderPasteboard sharedInstance] decrementPendingOperationCount];
</span><span class="cx">     RetainPtr<id <UIDropSession>> dropSession = _dataInteractionState.dropSession;
</span><span class="cx">     if ([self.webViewUIDelegate respondsToSelector:@selector(_webView:dataInteractionOperationWasHandled:forSession:itemProviders:)])
</span><span class="lines">@@ -4506,8 +4509,10 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)_dragInteraction:(UIDragInteraction *)interaction prepareForSession:(id <UIDragSession>)session completion:(dispatch_block_t)completion
</span><span class="cx"> {
</span><ins>+    RELEASE_LOG(DragAndDrop, "Preparing for drag session: %p", session);
</ins><span class="cx">     if (self.currentDragOrDropSession) {
</span><span class="cx">         // FIXME: Support multiple simultaneous drag sessions in the future.
</span><ins>+        RELEASE_LOG(DragAndDrop, "Drag session failed: %p (a current drag session already exists)", session);
</ins><span class="cx">         completion();
</span><span class="cx">         return;
</span><span class="cx">     }
</span><span class="lines">@@ -4519,6 +4524,7 @@
</span><span class="cx"> 
</span><span class="cx">     [self doAfterPositionInformationUpdate:[retainedSelf, session, dragOrigin, capturedBlock = makeBlockPtr(completion)] (InteractionInformationAtPosition positionInformation) {
</span><span class="cx">         if (!positionInformationMayStartDataInteraction(positionInformation)) {
</span><ins>+            RELEASE_LOG(DragAndDrop, "Drag session failed: %p (no draggable content at {%.1f, %.1f})", session, dragOrigin.x, dragOrigin.y);
</ins><span class="cx">             capturedBlock();
</span><span class="cx">             return;
</span><span class="cx">         }
</span><span class="lines">@@ -4531,18 +4537,25 @@
</span><span class="cx">         state.linkURL = retainedSelf->_positionInformation.url;
</span><span class="cx">         state.dragSession = session;
</span><span class="cx">         retainedSelf->_page->requestStartDataInteraction(roundedIntPoint(state.adjustedOrigin), roundedIntPoint([retainedSelf convertPoint:state.adjustedOrigin toView:[retainedSelf window]]));
</span><ins>+
+        auto elementBounds = state.elementBounds;
+        RELEASE_LOG(DragAndDrop, "Drag session requested: %p at element bounds: {{%.1f, %.1f}, {%.1f, %.1f}}", session, elementBounds.origin.x, elementBounds.origin.y, elementBounds.size.width, elementBounds.size.height);
</ins><span class="cx">     } forRequest:InteractionInformationRequest(roundedIntPoint(dragOrigin))];
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> - (NSArray<UIDragItem *> *)dragInteraction:(UIDragInteraction *)interaction itemsForBeginningSession:(id <UIDragSession>)session
</span><span class="cx"> {
</span><del>-    if (_dataInteractionState.dragSession != session)
</del><ins>+    RELEASE_LOG(DragAndDrop, "Drag items requested for session: %p", session);
+    if (_dataInteractionState.dragSession != session) {
+        RELEASE_LOG(DragAndDrop, "Drag session failed: %p (delegate session does not match %p)", session, _dataInteractionState.dragSession.get());
</ins><span class="cx">         return @[ ];
</span><ins>+    }
</ins><span class="cx"> 
</span><span class="cx">     WebItemProviderPasteboard *draggingPasteboard = [WebItemProviderPasteboard sharedInstance];
</span><span class="cx">     ASSERT(interaction == _dataInteraction);
</span><span class="cx">     NSUInteger numberOfItems = draggingPasteboard.numberOfItems;
</span><span class="cx">     if (!numberOfItems) {
</span><ins>+        RELEASE_LOG(DragAndDrop, "Drag session failed: %p (no item providers generated before adjustment)", session);
</ins><span class="cx">         _page->dragCancelled();
</span><span class="cx">         return @[ ];
</span><span class="cx">     }
</span><span class="lines">@@ -4578,6 +4591,7 @@
</span><span class="cx">     if (![itemsForDragInteraction count])
</span><span class="cx">         _page->dragCancelled();
</span><span class="cx"> 
</span><ins>+    RELEASE_LOG(DragAndDrop, "Drag session: %p starting with %tu items", session, [itemsForDragInteraction count]);
</ins><span class="cx">     return itemsForDragInteraction.get();
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="lines">@@ -4594,6 +4608,7 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)dragInteraction:(UIDragInteraction *)interaction sessionWillBegin:(id <UIDragSession>)session
</span><span class="cx"> {
</span><ins>+    RELEASE_LOG(DragAndDrop, "Drag session beginning: %p", session);
</ins><span class="cx">     id <WKUIDelegatePrivate> uiDelegate = self.webViewUIDelegate;
</span><span class="cx">     if ([uiDelegate respondsToSelector:@selector(_webView:dataInteraction:sessionWillBegin:)])
</span><span class="cx">         [uiDelegate _webView:_webView dataInteraction:interaction sessionWillBegin:session];
</span><span class="lines">@@ -4608,6 +4623,7 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)_api_dragInteraction:(UIDragInteraction *)interaction session:(id <UIDragSession>)session didEndWithOperation:(UIDropOperation)operation
</span><span class="cx"> {
</span><ins>+    RELEASE_LOG(DragAndDrop, "Drag session ended: %p (with operation: %tu, performing operation: %d, began dragging: %d)", session, operation, _dataInteractionState.isPerformingOperation, _dataInteractionState.didBeginDragging);
</ins><span class="cx">     id <WKUIDelegatePrivate> uiDelegate = self.webViewUIDelegate;
</span><span class="cx">     if ([uiDelegate respondsToSelector:@selector(_webView:dataInteraction:session:didEndWithOperation:)])
</span><span class="cx">         [uiDelegate _webView:_webView dataInteraction:interaction session:session didEndWithOperation:operation];
</span><span class="lines">@@ -4643,11 +4659,14 @@
</span><span class="cx"> {
</span><span class="cx">     // FIXME: Support multiple simultaneous drop sessions in the future.
</span><span class="cx">     id <UIDragDropSession> dragOrDropSession = self.currentDragOrDropSession;
</span><ins>+    RELEASE_LOG(DragAndDrop, "Can handle drag session: %p with local session: %p existing session: %p?", session, session.localDragSession, dragOrDropSession);
+
</ins><span class="cx">     return !dragOrDropSession || session.localDragSession == dragOrDropSession;
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> - (void)_api_dropInteraction:(UIDropInteraction *)interaction sessionDidEnter:(id <UIDropSession>)session
</span><span class="cx"> {
</span><ins>+    RELEASE_LOG(DragAndDrop, "Drop session entered: %p with %tu items", session, session.items.count);
</ins><span class="cx">     _dataInteractionState.dropSession = session;
</span><span class="cx"> 
</span><span class="cx">     [[WebItemProviderPasteboard sharedInstance] setItemProviders:extractItemProvidersFromDropSession(session)];
</span><span class="lines">@@ -4675,6 +4694,7 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)dropInteraction:(UIDropInteraction *)interaction sessionDidExit:(id <UIDropSession>)session
</span><span class="cx"> {
</span><ins>+    RELEASE_LOG(DragAndDrop, "Drop session exited: %p with %tu items", session, session.items.count);
</ins><span class="cx">     [[WebItemProviderPasteboard sharedInstance] setItemProviders:extractItemProvidersFromDropSession(session)];
</span><span class="cx"> 
</span><span class="cx">     auto dragData = [self dragDataForDropSession:session dragDestinationAction:WKDragDestinationActionAny];
</span><span class="lines">@@ -4702,6 +4722,7 @@
</span><span class="cx">     _dataInteractionState.isPerformingOperation = YES;
</span><span class="cx">     auto dragData = [self dragDataForDropSession:session dragDestinationAction:WKDragDestinationActionAny];
</span><span class="cx"> 
</span><ins>+    RELEASE_LOG(DragAndDrop, "Loading data from %tu item providers for session: %p", itemProviders.count, session);
</ins><span class="cx">     // Always loading content from the item provider ensures that the web process will be allowed to call back in to the UI
</span><span class="cx">     // process to access pasteboard contents at a later time. Ideally, we only need to do this work if we're over a file input
</span><span class="cx">     // or the page prevented default on `dragover`, but without this, dropping into a normal editable areas will fail due to
</span><span class="lines">@@ -4708,6 +4729,7 @@
</span><span class="cx">     // item providers not loading any data.
</span><span class="cx">     RetainPtr<WKContentView> retainedSelf(self);
</span><span class="cx">     [[WebItemProviderPasteboard sharedInstance] doAfterLoadingProvidedContentIntoFileURLs:[retainedSelf, capturedDragData = WTFMove(dragData)] (NSArray *fileURLs) mutable {
</span><ins>+        RELEASE_LOG(DragAndDrop, "Loaded data into %tu files", fileURLs.count);
</ins><span class="cx">         Vector<String> filenames;
</span><span class="cx">         for (NSURL *fileURL in fileURLs)
</span><span class="cx">             filenames.append([fileURL path]);
</span><span class="lines">@@ -4744,6 +4766,7 @@
</span><span class="cx"> 
</span><span class="cx"> - (void)dropInteraction:(UIDropInteraction *)interaction sessionDidEnd:(id <UIDropSession>)session
</span><span class="cx"> {
</span><ins>+    RELEASE_LOG(DragAndDrop, "Drop session ended: %p (performing operation: %d, began dragging: %d)", session, _dataInteractionState.isPerformingOperation, _dataInteractionState.didBeginDragging);
</ins><span class="cx">     if (_dataInteractionState.isPerformingOperation || _dataInteractionState.didBeginDragging)
</span><span class="cx">         return;
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>