<!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>[172158] 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/172158">172158</a></dd>
<dt>Author</dt> <dd>burg@cs.washington.edu</dd>
<dt>Date</dt> <dd>2014-08-06 10:59:06 -0700 (Wed, 06 Aug 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Web Inspector: protocol command invocations should return a promise if no callback is supplied
https://bugs.webkit.org/show_bug.cgi?id=130702
Reviewed by Timothy Hatcher.
Source/WebInspectorUI:
This allows the trailing Agent.command.promise(args) to be dropped in favor of just
Agent.command(args). It should make it a bit easier to convert code to use promises.
Test: LayoutTests/inspector/protocol-promise-result.html
* UserInterface/Controllers/ReplayManager.js: Drop use of .promise().
* UserInterface/Controllers/TimelineManager.js: Drop use of .promise().
(WebInspector.TimelineManager.prototype.startCapturing):
* UserInterface/Protocol/InspectorBackend.js:
(.callable): Redirect to the promise entry point if the last argument isn't a function.
(InspectorBackend.Command.create):
LayoutTests:
Addd a test for recieving protocol command results through an explicit callback,
via the .promise() entry point, and via an implicitly created promise.
* inspector/protocol-promise-result-expected.txt: Added.
* inspector/protocol-promise-result.html: Added.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkLayoutTestsChangeLog">trunk/LayoutTests/ChangeLog</a></li>
<li><a href="#trunkSourceWebInspectorUIChangeLog">trunk/Source/WebInspectorUI/ChangeLog</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceControllersReplayManagerjs">trunk/Source/WebInspectorUI/UserInterface/Controllers/ReplayManager.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceControllersTimelineManagerjs">trunk/Source/WebInspectorUI/UserInterface/Controllers/TimelineManager.js</a></li>
<li><a href="#trunkSourceWebInspectorUIUserInterfaceProtocolInspectorBackendjs">trunk/Source/WebInspectorUI/UserInterface/Protocol/InspectorBackend.js</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkLayoutTestsinspectorprotocolpromiseresultexpectedtxt">trunk/LayoutTests/inspector/protocol-promise-result-expected.txt</a></li>
<li><a href="#trunkLayoutTestsinspectorprotocolpromiseresulthtml">trunk/LayoutTests/inspector/protocol-promise-result.html</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkLayoutTestsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/LayoutTests/ChangeLog (172157 => 172158)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/ChangeLog 2014-08-06 17:57:47 UTC (rev 172157)
+++ trunk/LayoutTests/ChangeLog 2014-08-06 17:59:06 UTC (rev 172158)
</span><span class="lines">@@ -1,3 +1,16 @@
</span><ins>+2014-08-06 Brian J. Burg <burg@cs.washington.edu>
+
+ Web Inspector: protocol command invocations should return a promise if no callback is supplied
+ https://bugs.webkit.org/show_bug.cgi?id=130702
+
+ Reviewed by Timothy Hatcher.
+
+ Addd a test for recieving protocol command results through an explicit callback,
+ via the .promise() entry point, and via an implicitly created promise.
+
+ * inspector/protocol-promise-result-expected.txt: Added.
+ * inspector/protocol-promise-result.html: Added.
+
</ins><span class="cx"> 2014-07-28 Myles C. Maxfield <mmaxfield@apple.com>
</span><span class="cx">
</span><span class="cx"> Text-shadow with (0, 0) offset and radius = 0 is ugly
</span></span></pre></div>
<a id="trunkLayoutTestsinspectorprotocolpromiseresultexpectedtxt"></a>
<div class="addfile"><h4>Added: trunk/LayoutTests/inspector/protocol-promise-result-expected.txt (0 => 172158)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/inspector/protocol-promise-result-expected.txt (rev 0)
+++ trunk/LayoutTests/inspector/protocol-promise-result-expected.txt 2014-08-06 17:59:06 UTC (rev 172158)
</span><span class="lines">@@ -0,0 +1,7 @@
</span><ins>+Testing that the inspector backend can return command results using promises.
+
+Using a callback, got RuntimeAgent.evaluate() result: 41
+Setting up two promises for RuntimeAgent.evaluate.
+Using a promise, got RuntimeAgent.evaluate() result: 42
+Using a promise, got RuntimeAgent.evaluate() result: 43
+
</ins></span></pre></div>
<a id="trunkLayoutTestsinspectorprotocolpromiseresulthtml"></a>
<div class="addfile"><h4>Added: trunk/LayoutTests/inspector/protocol-promise-result.html (0 => 172158)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/inspector/protocol-promise-result.html (rev 0)
+++ trunk/LayoutTests/inspector/protocol-promise-result.html 2014-08-06 17:59:06 UTC (rev 172158)
</span><span class="lines">@@ -0,0 +1,38 @@
</span><ins>+<!doctype html>
+<html>
+<head>
+<script type="text/javascript" src="../http/tests/inspector/inspector-test.js"></script>
+<script>
+function test()
+{
+ var c1 = RuntimeAgent.evaluate("41", function(err, result, wasThrown) {
+ InspectorTest.log("Using a callback, got RuntimeAgent.evaluate() result: " + result.value);
+
+ InspectorTest.log("Setting up two promises for RuntimeAgent.evaluate.");
+
+ var p1 = RuntimeAgent.evaluate.promise("42");
+ var p2 = RuntimeAgent.evaluate("43");
+
+ InspectorTest.assert(!(c1 instanceof Promise), "A promise was returned even though a callback was supplied to the command!");
+
+ p1.then(function(payload) {
+ InspectorTest.log("Using a promise, got RuntimeAgent.evaluate() result: " + payload.result.value);
+ });
+ p2.then(function(payload) {
+ InspectorTest.log("Using a promise, got RuntimeAgent.evaluate() result: " + payload.result.value);
+ });
+
+ Promise.all([p1, p2]).then(function() {
+ InspectorTest.completeTest();
+ }).catch(function(error) {
+ InspectorTest.log("ERROR: " + error);
+ InspectorTest.completeTest();
+ })
+ });
+}
+</script>
+</head>
+<body onload="runTest()">
+ <p>Testing that the inspector backend can return command results using promises.</p>
+</body>
+</html>
</ins></span></pre></div>
<a id="trunkSourceWebInspectorUIChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/ChangeLog (172157 => 172158)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/ChangeLog 2014-08-06 17:57:47 UTC (rev 172157)
+++ trunk/Source/WebInspectorUI/ChangeLog 2014-08-06 17:59:06 UTC (rev 172158)
</span><span class="lines">@@ -1,3 +1,22 @@
</span><ins>+2014-08-06 Brian J. Burg <burg@cs.washington.edu>
+
+ Web Inspector: protocol command invocations should return a promise if no callback is supplied
+ https://bugs.webkit.org/show_bug.cgi?id=130702
+
+ Reviewed by Timothy Hatcher.
+
+ This allows the trailing Agent.command.promise(args) to be dropped in favor of just
+ Agent.command(args). It should make it a bit easier to convert code to use promises.
+
+ Test: LayoutTests/inspector/protocol-promise-result.html
+
+ * UserInterface/Controllers/ReplayManager.js: Drop use of .promise().
+ * UserInterface/Controllers/TimelineManager.js: Drop use of .promise().
+ (WebInspector.TimelineManager.prototype.startCapturing):
+ * UserInterface/Protocol/InspectorBackend.js:
+ (.callable): Redirect to the promise entry point if the last argument isn't a function.
+ (InspectorBackend.Command.create):
+
</ins><span class="cx"> 2014-08-05 James Craig <jcraig@apple.com>
</span><span class="cx">
</span><span class="cx"> Web Inspector: AXI: Add label string once AccessibilityObject::computedLabel() is available
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceControllersReplayManagerjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Controllers/ReplayManager.js (172157 => 172158)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Controllers/ReplayManager.js 2014-08-06 17:57:47 UTC (rev 172157)
+++ trunk/Source/WebInspectorUI/UserInterface/Controllers/ReplayManager.js 2014-08-06 17:59:06 UTC (rev 172158)
</span><span class="lines">@@ -52,7 +52,7 @@
</span><span class="cx">
</span><span class="cx"> var instance = this;
</span><span class="cx">
</span><del>- this._initializationPromise = ReplayAgent.currentReplayState.promise()
</del><ins>+ this._initializationPromise = ReplayAgent.currentReplayState()
</ins><span class="cx"> .then(function(payload) {
</span><span class="cx"> console.assert(payload.sessionState in WebInspector.ReplayManager.SessionState, "Unknown session state: " + payload.sessionState);
</span><span class="cx"> console.assert(payload.segmentState in WebInspector.ReplayManager.SegmentState, "Unknown segment state: " + payload.segmentState);
</span><span class="lines">@@ -65,7 +65,7 @@
</span><span class="cx">
</span><span class="cx"> instance._initialized = true;
</span><span class="cx"> }).then(function() {
</span><del>- return ReplayAgent.getAvailableSessions.promise();
</del><ins>+ return ReplayAgent.getAvailableSessions();
</ins><span class="cx"> }).then(function(payload) {
</span><span class="cx"> for (var sessionId of payload.ids)
</span><span class="cx"> instance.sessionCreated(sessionId);
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceControllersTimelineManagerjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Controllers/TimelineManager.js (172157 => 172158)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Controllers/TimelineManager.js 2014-08-06 17:57:47 UTC (rev 172157)
+++ trunk/Source/WebInspectorUI/UserInterface/Controllers/TimelineManager.js 2014-08-06 17:59:06 UTC (rev 172158)
</span><span class="lines">@@ -86,7 +86,7 @@
</span><span class="cx"> if (!this._activeRecording || shouldCreateRecording)
</span><span class="cx"> this._loadNewRecording();
</span><span class="cx">
</span><del>- var result = TimelineAgent.start.promise();
</del><ins>+ var result = TimelineAgent.start();
</ins><span class="cx">
</span><span class="cx"> // COMPATIBILITY (iOS 7): recordingStarted event did not exist yet. Start explicitly.
</span><span class="cx"> if (!TimelineAgent.hasEvent("recordingStarted")) {
</span></span></pre></div>
<a id="trunkSourceWebInspectorUIUserInterfaceProtocolInspectorBackendjs"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebInspectorUI/UserInterface/Protocol/InspectorBackend.js (172157 => 172158)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebInspectorUI/UserInterface/Protocol/InspectorBackend.js 2014-08-06 17:57:47 UTC (rev 172157)
+++ trunk/Source/WebInspectorUI/UserInterface/Protocol/InspectorBackend.js 2014-08-06 17:59:06 UTC (rev 172158)
</span><span class="lines">@@ -340,7 +340,11 @@
</span><span class="cx"> var instance = new InspectorBackend.Command(backend, commandName, callSignature, replySignature);
</span><span class="cx">
</span><span class="cx"> function callable() {
</span><del>- instance._invokeWithArguments.apply(instance, arguments);
</del><ins>+ // If the last argument to the command is not a function, return a result promise.
+ if (!arguments.length || typeof arguments[arguments.length - 1] !== "function")
+ return instance.promise.apply(instance, arguments);
+
+ return instance._invokeWithArguments.apply(instance, arguments);
</ins><span class="cx"> }
</span><span class="cx"> callable._instance = instance;
</span><span class="cx"> callable.__proto__ = InspectorBackend.Command.prototype;
</span></span></pre>
</div>
</div>
</body>
</html>