<!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>[278222] 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/278222">278222</a></dd>
<dt>Author</dt> <dd>jya@apple.com</dd>
<dt>Date</dt> <dd>2021-05-28 13:08:08 -0700 (Fri, 28 May 2021)</dd>
</dl>

<h3>Log Message</h3>
<pre>Add MediaSession.callActionHandler
https://bugs.webkit.org/show_bug.cgi?id=226077
rdar://77463304

Reviewed by Eric Carlson.

Source/WebCore:

Make it possible for JavaScript to be able to trigger a MediaSession action
handler so a MediaSession.coordinator polyfill such as one provided by an
external JS library will work.
Test: media/media-session/callActionHandler.html

* Modules/mediasession/MediaSession.cpp:
(WebCore::MediaSession::callActionHandler):
* Modules/mediasession/MediaSession.h:
* Modules/mediasession/MediaSession.idl: Add method definition.

LayoutTests:

* media/media-session/callActionHandler-expected.txt: Added.
* media/media-session/callActionHandler.html: Added.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkLayoutTestsChangeLog">trunk/LayoutTests/ChangeLog</a></li>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCoreModulesmediasessionMediaSessioncpp">trunk/Source/WebCore/Modules/mediasession/MediaSession.cpp</a></li>
<li><a href="#trunkSourceWebCoreModulesmediasessionMediaSessionh">trunk/Source/WebCore/Modules/mediasession/MediaSession.h</a></li>
<li><a href="#trunkSourceWebCoreModulesmediasessionMediaSessionidl">trunk/Source/WebCore/Modules/mediasession/MediaSession.idl</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#trunkLayoutTestsmediamediasessioncallActionHandlerexpectedtxt">trunk/LayoutTests/media/media-session/callActionHandler-expected.txt</a></li>
<li><a href="#trunkLayoutTestsmediamediasessioncallActionHandlerhtml">trunk/LayoutTests/media/media-session/callActionHandler.html</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkLayoutTestsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/LayoutTests/ChangeLog (278221 => 278222)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/ChangeLog      2021-05-28 20:02:28 UTC (rev 278221)
+++ trunk/LayoutTests/ChangeLog 2021-05-28 20:08:08 UTC (rev 278222)
</span><span class="lines">@@ -1,3 +1,14 @@
</span><ins>+2021-05-28  Jean-Yves Avenard  <jya@apple.com>
+
+        Add MediaSession.callActionHandler
+        https://bugs.webkit.org/show_bug.cgi?id=226077
+        rdar://77463304
+
+        Reviewed by Eric Carlson.
+
+        * media/media-session/callActionHandler-expected.txt: Added.
+        * media/media-session/callActionHandler.html: Added.
+
</ins><span class="cx"> 2021-05-28  Alan Bujtas  <zalan@apple.com>
</span><span class="cx"> 
</span><span class="cx">         CrashOnOverflow in WebCore::RenderTable::cellBefore(WebCore::RenderTableCell const*)
</span></span></pre></div>
<a id="trunkLayoutTestsmediamediasessioncallActionHandlerexpectedtxt"></a>
<div class="addfile"><h4>Added: trunk/LayoutTests/media/media-session/callActionHandler-expected.txt (0 => 278222)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/media/media-session/callActionHandler-expected.txt                             (rev 0)
+++ trunk/LayoutTests/media/media-session/callActionHandler-expected.txt        2021-05-28 20:08:08 UTC (rev 278222)
</span><span class="lines">@@ -0,0 +1,24 @@
</span><ins>+
+RUN(video.src = findMediaFile("video", "../content/test"))
+EVENT(loadeddata)
+Test that default media element action will be run when no media session handlers exist for that action.
+EXPECTED (video.paused == 'true') OK
+EXPECTED (video.paused == 'false') OK
+EXPECTED (video.paused == 'true') OK
+RUN(video.currentTime = 0)
+EXPECTED (video.currentTime == '0') OK
+EXPECTED (video.currentTime == '1') OK
+EXPECTED (video.currentTime == '6') OK
+EXPECTED (video.currentTime == '1') OK
+Test that if an action handler is defined, the default action won't be called
+ACTION: play
+EXPECTED (video.paused == 'true') OK
+EXPECTED (video.paused == 'false') OK
+ACTION: pause
+EXPECTED (video.paused == 'false') OK
+EXPECTED (video.paused == 'true') OK
+ACTION: seekto
+EXPECTED (video.currentTime == '1') OK
+EXPECTED (video.currentTime == '5') OK
+END OF TEST
+
</ins></span></pre></div>
<a id="trunkLayoutTestsmediamediasessioncallActionHandlerhtml"></a>
<div class="addfile"><h4>Added: trunk/LayoutTests/media/media-session/callActionHandler.html (0 => 278222)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/media/media-session/callActionHandler.html                             (rev 0)
+++ trunk/LayoutTests/media/media-session/callActionHandler.html        2021-05-28 20:08:08 UTC (rev 278222)
</span><span class="lines">@@ -0,0 +1,77 @@
</span><ins>+<!DOCTYPE html>
+<html>
+<head>
+    <title>default-actionHandlers</title>
+    <script src="../video-test.js"></script>
+    <script src="../media-file.js"></script>
+    <script>
+
+    async function runTest() {
+        findMediaElement();
+        run('video.src = findMediaFile("video", "../content/test")');
+        await waitFor(video, 'loadeddata');
+
+        consoleWrite('Test that default media element action will be run when no media session handlers exist for that action.');
+
+        testExpected("video.paused", true);
+
+        await navigator.mediaSession.callActionHandler({action: "play"});
+        testExpected("video.paused", false);
+
+        await navigator.mediaSession.callActionHandler({action: "pause"});
+        testExpected("video.paused", true);
+
+        run('video.currentTime = 0');
+        testExpected("video.currentTime", 0);
+
+        await navigator.mediaSession.callActionHandler( {action: "seekto", seekTime: 1});
+        testExpected("video.currentTime", 1);
+
+        await navigator.mediaSession.callActionHandler({action: "seekforward", seekOffset: 5});
+        testExpected("video.currentTime", 6);
+
+        await navigator.mediaSession.callActionHandler({action: "seekbackward", seekOffset: 5});
+        testExpected("video.currentTime", 1);
+
+        consoleWrite('Test that if an action handler is defined, the default action won\'t be called');
+
+        navigator.mediaSession.setActionHandler("play", actionDetails => {
+            consoleWrite(`ACTION: ${actionDetails.action}`);
+        });
+        await navigator.mediaSession.callActionHandler({action: "play"});
+        // Playback shouldn't have started if a handler for the play action was defined and it did nothing.
+        testExpected("video.paused", true);
+
+        navigator.mediaSession.setActionHandler("play", null);
+        await navigator.mediaSession.callActionHandler({action: "play"});
+        testExpected("video.paused", false);
+
+        navigator.mediaSession.setActionHandler("pause", actionDetails => {
+            consoleWrite(`ACTION: ${actionDetails.action}`);
+        });
+        await navigator.mediaSession.callActionHandler({action: "pause"});
+        // Playback shouldn't have been interrupted if a handler for the pause action was defined and it did nothing.
+        testExpected("video.paused", false);
+
+        navigator.mediaSession.setActionHandler("pause", null);
+        await navigator.mediaSession.callActionHandler({action: "pause"});
+        testExpected("video.paused", true);
+
+        navigator.mediaSession.setActionHandler("seekto", actionDetails => {
+            consoleWrite(`ACTION: ${actionDetails.action}`);
+        });
+        await navigator.mediaSession.callActionHandler({action: "seekto", seekTime: 5});
+        testExpected("video.currentTime", 1);
+
+        navigator.mediaSession.setActionHandler("seekto", null);
+        await navigator.mediaSession.callActionHandler({action: "seekto", seekTime: 5});
+        testExpected("video.currentTime", 5);
+
+        endTest();
+    }
+    </script>
+</head>
+<body onload="runTest()">
+    <video controls preload='auto'></video>
+</body>
+</html>
</ins></span></pre></div>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (278221 => 278222)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog   2021-05-28 20:02:28 UTC (rev 278221)
+++ trunk/Source/WebCore/ChangeLog      2021-05-28 20:08:08 UTC (rev 278222)
</span><span class="lines">@@ -1,3 +1,21 @@
</span><ins>+2021-05-28  Jean-Yves Avenard  <jya@apple.com>
+
+        Add MediaSession.callActionHandler
+        https://bugs.webkit.org/show_bug.cgi?id=226077
+        rdar://77463304
+
+        Reviewed by Eric Carlson.
+
+        Make it possible for JavaScript to be able to trigger a MediaSession action
+        handler so a MediaSession.coordinator polyfill such as one provided by an
+        external JS library will work.
+        Test: media/media-session/callActionHandler.html
+
+        * Modules/mediasession/MediaSession.cpp:
+        (WebCore::MediaSession::callActionHandler):
+        * Modules/mediasession/MediaSession.h:
+        * Modules/mediasession/MediaSession.idl: Add method definition.
+
</ins><span class="cx"> 2021-05-28  Alan Bujtas  <zalan@apple.com>
</span><span class="cx"> 
</span><span class="cx">         CrashOnOverflow in WebCore::RenderTable::cellBefore(WebCore::RenderTableCell const*)
</span></span></pre></div>
<a id="trunkSourceWebCoreModulesmediasessionMediaSessioncpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/mediasession/MediaSession.cpp (278221 => 278222)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/mediasession/MediaSession.cpp       2021-05-28 20:02:28 UTC (rev 278221)
+++ trunk/Source/WebCore/Modules/mediasession/MediaSession.cpp  2021-05-28 20:08:08 UTC (rev 278222)
</span><span class="lines">@@ -31,6 +31,7 @@
</span><span class="cx"> #include "DOMWindow.h"
</span><span class="cx"> #include "EventNames.h"
</span><span class="cx"> #include "HTMLMediaElement.h"
</span><ins>+#include "JSDOMPromiseDeferred.h"
</ins><span class="cx"> #include "JSMediaPositionState.h"
</span><span class="cx"> #include "JSMediaSessionAction.h"
</span><span class="cx"> #include "JSMediaSessionPlaybackState.h"
</span><span class="lines">@@ -272,10 +273,24 @@
</span><span class="cx">     notifyActionHandlerObservers();
</span><span class="cx"> }
</span><span class="cx"> 
</span><del>-bool MediaSession::callActionHandler(const MediaSessionActionDetails& actionDetails)
</del><ins>+void MediaSession::callActionHandler(const MediaSessionActionDetails& actionDetails, DOMPromiseDeferred<void>&& promise)
</ins><span class="cx"> {
</span><ins>+    ALWAYS_LOG(LOGIDENTIFIER);
+
+    if (!callActionHandler(actionDetails, TriggerGestureIndicator::No)) {
+        promise.reject(InvalidStateError);
+        return;
+    }
+
+    promise.resolve();
+}
+
+bool MediaSession::callActionHandler(const MediaSessionActionDetails& actionDetails, TriggerGestureIndicator triggerGestureIndicator)
+{
</ins><span class="cx">     if (auto handler = m_actionHandlers.get(actionDetails.action)) {
</span><del>-        UserGestureIndicator gestureIndicator(ProcessingUserGesture, document());
</del><ins>+        Optional<UserGestureIndicator> maybeGestureIndicator;
+        if (triggerGestureIndicator == TriggerGestureIndicator::Yes)
+            maybeGestureIndicator.emplace(ProcessingUserGesture, document());
</ins><span class="cx">         handler->handleEvent(actionDetails);
</span><span class="cx">         return true;
</span><span class="cx">     }
</span></span></pre></div>
<a id="trunkSourceWebCoreModulesmediasessionMediaSessionh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/mediasession/MediaSession.h (278221 => 278222)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/mediasession/MediaSession.h 2021-05-28 20:02:28 UTC (rev 278221)
+++ trunk/Source/WebCore/Modules/mediasession/MediaSession.h    2021-05-28 20:08:08 UTC (rev 278222)
</span><span class="lines">@@ -50,6 +50,7 @@
</span><span class="cx"> class MediaSessionCoordinator;
</span><span class="cx"> class MediaSessionCoordinatorPrivate;
</span><span class="cx"> class Navigator;
</span><ins>+template<typename> class DOMPromiseDeferred;
</ins><span class="cx"> 
</span><span class="cx"> class MediaSession : public RefCounted<MediaSession>, public ActiveDOMObject, public EventTargetWithInlineData {
</span><span class="cx">     WTF_MAKE_FAST_ALLOCATED;
</span><span class="lines">@@ -66,6 +67,8 @@
</span><span class="cx"> 
</span><span class="cx">     void setActionHandler(MediaSessionAction, RefPtr<MediaSessionActionHandler>&&);
</span><span class="cx"> 
</span><ins>+    void callActionHandler(const MediaSessionActionDetails&, DOMPromiseDeferred<void>&&);
+
</ins><span class="cx">     ExceptionOr<void> setPositionState(Optional<MediaPositionState>&&);
</span><span class="cx">     Optional<MediaPositionState> positionState() const { return m_positionState; }
</span><span class="cx"> 
</span><span class="lines">@@ -87,7 +90,11 @@
</span><span class="cx"> #endif
</span><span class="cx"> 
</span><span class="cx">     bool hasActiveActionHandlers() const { return !m_actionHandlers.isEmpty(); }
</span><del>-    WEBCORE_EXPORT bool callActionHandler(const MediaSessionActionDetails&);
</del><ins>+    enum class TriggerGestureIndicator {
+        No,
+        Yes,
+    };
+    WEBCORE_EXPORT bool callActionHandler(const MediaSessionActionDetails&, TriggerGestureIndicator = TriggerGestureIndicator::Yes);
</ins><span class="cx"> 
</span><span class="cx">     const Logger& logger() const { return *m_logger.get(); }
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebCoreModulesmediasessionMediaSessionidl"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/mediasession/MediaSession.idl (278221 => 278222)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/mediasession/MediaSession.idl       2021-05-28 20:02:28 UTC (rev 278221)
+++ trunk/Source/WebCore/Modules/mediasession/MediaSession.idl  2021-05-28 20:08:08 UTC (rev 278222)
</span><span class="lines">@@ -37,6 +37,8 @@
</span><span class="cx"> 
</span><span class="cx">     undefined setActionHandler(MediaSessionAction action, MediaSessionActionHandler? handler);
</span><span class="cx"> 
</span><ins>+    Promise<undefined> callActionHandler(MediaSessionActionDetails actionDetails);
+
</ins><span class="cx">     undefined setPositionState(optional MediaPositionState? state = null);
</span><span class="cx"> };
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>