<!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>[197868] trunk</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/197868">197868</a></dd>
<dt>Author</dt> <dd>timothy_horton@apple.com</dd>
<dt>Date</dt> <dd>2016-03-09 11:56:41 -0800 (Wed, 09 Mar 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Removing and re-adding a script message handler with the same name results in an unusable message handler
https://bugs.webkit.org/show_bug.cgi?id=155223
Reviewed by Sam Weinig.
Source/WebCore:
New API test: WKUserContentController.ScriptMessageHandlerReplaceWithSameName.
* page/UserMessageHandler.h:
(WebCore::UserMessageHandler::descriptor):
* page/UserMessageHandlersNamespace.cpp:
(WebCore::UserMessageHandlersNamespace::handler):
This lazy removal mechanism combined with the fact that we only compare
handler name and world makes it such that m_messageHandlers could have
a stale UserMessageHandler with a UserMessageHandlerDescriptor that differed
only in client.
It is safe to compare the descriptors by pointer instead because m_messageHandler
holds a strong reference to its UserMessageHandlerDescriptors, and this will ensure
that the add-remove-add path (with identical name and world) causes a new
UserContentController to be created.
We also now clean up any stale UserMessageHandlers whenever we're about to
add a new one, by removing any which the UserContentController no longer knows about.
Tools:
* TestWebKitAPI/Tests/WebKit2Cocoa/UserContentController.mm:
(TEST):
Add a test ensuring that it is possible to remove and re-add a script message handler
with the same name and still dispatch messages to it.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCorepageUserMessageHandlerh">trunk/Source/WebCore/page/UserMessageHandler.h</a></li>
<li><a href="#trunkSourceWebCorepageUserMessageHandlersNamespacecpp">trunk/Source/WebCore/page/UserMessageHandlersNamespace.cpp</a></li>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsTestWebKitAPITestsWebKit2CocoaUserContentControllermm">trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/UserContentController.mm</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (197867 => 197868)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog 2016-03-09 19:36:21 UTC (rev 197867)
+++ trunk/Source/WebCore/ChangeLog 2016-03-09 19:56:41 UTC (rev 197868)
</span><span class="lines">@@ -1,3 +1,30 @@
</span><ins>+2016-03-09 Tim Horton <timothy_horton@apple.com>
+
+ Removing and re-adding a script message handler with the same name results in an unusable message handler
+ https://bugs.webkit.org/show_bug.cgi?id=155223
+
+ Reviewed by Sam Weinig.
+ Patch by Geoff Garen and myself.
+
+ New API test: WKUserContentController.ScriptMessageHandlerReplaceWithSameName.
+
+ * page/UserMessageHandler.h:
+ (WebCore::UserMessageHandler::descriptor):
+ * page/UserMessageHandlersNamespace.cpp:
+ (WebCore::UserMessageHandlersNamespace::handler):
+ This lazy removal mechanism combined with the fact that we only compare
+ handler name and world makes it such that m_messageHandlers could have
+ a stale UserMessageHandler with a UserMessageHandlerDescriptor that differed
+ only in client.
+
+ It is safe to compare the descriptors by pointer instead because m_messageHandler
+ holds a strong reference to its UserMessageHandlerDescriptors, and this will ensure
+ that the add-remove-add path (with identical name and world) causes a new
+ UserContentController to be created.
+
+ We also now clean up any stale UserMessageHandlers whenever we're about to
+ add a new one, by removing any which the UserContentController no longer knows about.
+
</ins><span class="cx"> 2016-03-09 Chris Dumez <cdumez@apple.com>
</span><span class="cx">
</span><span class="cx"> Align HTMLKeygenElement.keytype with the specification
</span></span></pre></div>
<a id="trunkSourceWebCorepageUserMessageHandlerh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/page/UserMessageHandler.h (197867 => 197868)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/page/UserMessageHandler.h 2016-03-09 19:36:21 UTC (rev 197867)
+++ trunk/Source/WebCore/page/UserMessageHandler.h 2016-03-09 19:56:41 UTC (rev 197868)
</span><span class="lines">@@ -48,6 +48,7 @@
</span><span class="cx">
</span><span class="cx"> const AtomicString& name();
</span><span class="cx"> DOMWrapperWorld& world();
</span><ins>+ const UserMessageHandlerDescriptor& descriptor() const { return m_descriptor.get(); }
</ins><span class="cx">
</span><span class="cx"> private:
</span><span class="cx"> UserMessageHandler(Frame&, UserMessageHandlerDescriptor&);
</span></span></pre></div>
<a id="trunkSourceWebCorepageUserMessageHandlersNamespacecpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/page/UserMessageHandlersNamespace.cpp (197867 => 197868)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/page/UserMessageHandlersNamespace.cpp 2016-03-09 19:36:21 UTC (rev 197867)
+++ trunk/Source/WebCore/page/UserMessageHandlersNamespace.cpp 2016-03-09 19:56:41 UTC (rev 197868)
</span><span class="lines">@@ -62,18 +62,23 @@
</span><span class="cx"> return nullptr;
</span><span class="cx">
</span><span class="cx"> RefPtr<UserMessageHandlerDescriptor> descriptor = userMessageHandlerDescriptors->get(std::make_pair(name, &world));
</span><del>- if (!descriptor) {
- m_messageHandlers.removeFirstMatching([&name, &world](Ref<UserMessageHandler>& handler) {
- return handler->name() == name && &handler->world() == &world;
- });
</del><ins>+ if (!descriptor)
</ins><span class="cx"> return nullptr;
</span><del>- }
</del><span class="cx">
</span><span class="cx"> for (auto& handler : m_messageHandlers) {
</span><del>- if (handler->name() == name && &handler->world() == &world)
</del><ins>+ if (&handler->descriptor() == descriptor.get())
</ins><span class="cx"> return &handler.get();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ auto liveHandlers = userMessageHandlerDescriptors->values();
+ m_messageHandlers.removeAllMatching([liveHandlers](const Ref<UserMessageHandler>& handler) {
+ for (const auto& liveHandler : liveHandlers) {
+ if (liveHandler.get() == &handler->descriptor())
+ return true;
+ }
+ return false;
+ });
+
</ins><span class="cx"> m_messageHandlers.append(UserMessageHandler::create(*frame(), *descriptor));
</span><span class="cx"> return &m_messageHandlers.last().get();
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (197867 => 197868)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog 2016-03-09 19:36:21 UTC (rev 197867)
+++ trunk/Tools/ChangeLog 2016-03-09 19:56:41 UTC (rev 197868)
</span><span class="lines">@@ -1,3 +1,15 @@
</span><ins>+2016-03-09 Tim Horton <timothy_horton@apple.com>
+
+ Removing and re-adding a script message handler with the same name results in an unusable message handler
+ https://bugs.webkit.org/show_bug.cgi?id=155223
+
+ Reviewed by Sam Weinig.
+
+ * TestWebKitAPI/Tests/WebKit2Cocoa/UserContentController.mm:
+ (TEST):
+ Add a test ensuring that it is possible to remove and re-add a script message handler
+ with the same name and still dispatch messages to it.
+
</ins><span class="cx"> 2016-03-08 Alexey Proskuryakov <ap@apple.com>
</span><span class="cx">
</span><span class="cx"> Fix iOS Simulator EWS.
</span></span></pre></div>
<a id="trunkToolsTestWebKitAPITestsWebKit2CocoaUserContentControllermm"></a>
<div class="modfile"><h4>Modified: trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/UserContentController.mm (197867 => 197868)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/UserContentController.mm 2016-03-09 19:36:21 UTC (rev 197867)
+++ trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/UserContentController.mm 2016-03-09 19:56:41 UTC (rev 197868)
</span><span class="lines">@@ -264,6 +264,44 @@
</span><span class="cx"> }
</span><span class="cx"> #endif
</span><span class="cx">
</span><ins>+TEST(WKUserContentController, ScriptMessageHandlerReplaceWithSameName)
+{
+ RetainPtr<ScriptMessageHandler> handler = adoptNS([[ScriptMessageHandler alloc] init]);
+ RetainPtr<WKWebViewConfiguration> configuration = adoptNS([[WKWebViewConfiguration alloc] init]);
+ RetainPtr<WKUserContentController> userContentController = [configuration userContentController];
+ [userContentController addScriptMessageHandler:handler.get() name:@"handlerToReplace"];
+
+ RetainPtr<WKWebView> webView = adoptNS([[WKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration.get()]);
+
+ RetainPtr<SimpleNavigationDelegate> delegate = adoptNS([[SimpleNavigationDelegate alloc] init]);
+ [webView setNavigationDelegate:delegate.get()];
+
+ NSURLRequest *request = [NSURLRequest requestWithURL:[[NSBundle mainBundle] URLForResource:@"simple" withExtension:@"html" subdirectory:@"TestWebKitAPI.resources"]];
+
+ [webView loadRequest:request];
+
+ TestWebKitAPI::Util::run(&isDoneWithNavigation);
+
+ // Test that handlerToReplace was succesfully added.
+ [webView evaluateJavaScript:@"window.webkit.messageHandlers.handlerToReplace.postMessage('PASS1');" completionHandler:nil];
+
+ TestWebKitAPI::Util::run(&receivedScriptMessage);
+ receivedScriptMessage = false;
+
+ EXPECT_WK_STREQ(@"PASS1", (NSString *)[lastScriptMessage body]);
+
+ [userContentController removeScriptMessageHandlerForName:@"handlerToReplace"];
+ [userContentController addScriptMessageHandler:handler.get() name:@"handlerToReplace"];
+
+ // Test that handlerToReplace still works.
+ [webView evaluateJavaScript:@"window.webkit.messageHandlers.handlerToReplace.postMessage('PASS2');" completionHandler:nil];
+
+ TestWebKitAPI::Util::run(&receivedScriptMessage);
+ receivedScriptMessage = false;
+
+ EXPECT_WK_STREQ(@"PASS2", (NSString *)[lastScriptMessage body]);
+}
+
</ins><span class="cx"> static NSString *styleSheetSource = @"body { background-color: green !important; }";
</span><span class="cx"> static NSString *backgroundColorScript = @"window.getComputedStyle(document.body, null).getPropertyValue('background-color')";
</span><span class="cx"> static NSString *frameBackgroundColorScript = @"window.getComputedStyle(document.getElementsByTagName('iframe')[0].contentDocument.body, null).getPropertyValue('background-color')";
</span></span></pre>
</div>
</div>
</body>
</html>