<!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>[244977] 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/244977">244977</a></dd>
<dt>Author</dt> <dd>youenn@apple.com</dd>
<dt>Date</dt> <dd>2019-05-06 14:14:12 -0700 (Mon, 06 May 2019)</dd>
</dl>

<h3>Log Message</h3>
<pre>WebAudio Node JS wrappers should not be collected if events can be fired
https://bugs.webkit.org/show_bug.cgi?id=197533

Reviewed by Jer Noble.

Source/WebCore:

Before the patch, some web audio nodes could fire event listeners, but were not protected from GC.
Use CustomIsReachable to ensure theses nodes can be collected if:
- their AudioContext is stopped (typically due to document being navigated away).
- their AudioContext is closed.
- nodes do not have event listeners.

Covered by WPT mediacapture-streams/MediaStreamTrack-MediaElement-disabled-audio-is-silence.https.html and
WPT webaudio/the-audio-api/the-mediaelementaudiosourcenode-interface/mediaElementAudioSourceToScriptProcessorTest.html
and web audio WebRTC tests.
Specific newly added test: webaudio/webaudio-gc.html

* Modules/webaudio/AudioContext.h:
(WebCore::AudioContext::isClosed const):
* Modules/webaudio/AudioNode.idl:
* Sources.txt:
* WebCore.xcodeproj/project.pbxproj:
* bindings/js/JSAudioNodeCustom.cpp: Added.
(WebCore::JSAudioNodeOwner::isReachableFromOpaqueRoots):

LayoutTests:

* webaudio/webaudio-gc-expected.txt: Added.
* webaudio/webaudio-gc.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="#trunkSourceWebCoreModuleswebaudioAudioContexth">trunk/Source/WebCore/Modules/webaudio/AudioContext.h</a></li>
<li><a href="#trunkSourceWebCoreModuleswebaudioAudioNodeidl">trunk/Source/WebCore/Modules/webaudio/AudioNode.idl</a></li>
<li><a href="#trunkSourceWebCoreSourcestxt">trunk/Source/WebCore/Sources.txt</a></li>
<li><a href="#trunkSourceWebCoreWebCorexcodeprojprojectpbxproj">trunk/Source/WebCore/WebCore.xcodeproj/project.pbxproj</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#trunkLayoutTestswebaudiowebaudiogcexpectedtxt">trunk/LayoutTests/webaudio/webaudio-gc-expected.txt</a></li>
<li><a href="#trunkLayoutTestswebaudiowebaudiogchtml">trunk/LayoutTests/webaudio/webaudio-gc.html</a></li>
<li><a href="#trunkSourceWebCorebindingsjsJSAudioNodeCustomcpp">trunk/Source/WebCore/bindings/js/JSAudioNodeCustom.cpp</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkLayoutTestsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/LayoutTests/ChangeLog (244976 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/ChangeLog      2019-05-06 20:44:27 UTC (rev 244976)
+++ trunk/LayoutTests/ChangeLog 2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -1,3 +1,13 @@
</span><ins>+2019-05-06  Youenn Fablet  <youenn@apple.com>
+
+        WebAudio Node JS wrappers should not be collected if events can be fired
+        https://bugs.webkit.org/show_bug.cgi?id=197533
+
+        Reviewed by Jer Noble.
+
+        * webaudio/webaudio-gc-expected.txt: Added.
+        * webaudio/webaudio-gc.html: Added.
+
</ins><span class="cx"> 2019-05-06  Ryan Haddad  <ryanhaddad@apple.com>
</span><span class="cx"> 
</span><span class="cx">         REGRESSION: Layout test imported/w3c/web-platform-tests/resource-timing/resource-timing-level1.sub.html is frequently failing on EWS
</span></span></pre></div>
<a id="trunkLayoutTestswebaudiowebaudiogcexpectedtxt"></a>
<div class="addfile"><h4>Added: trunk/LayoutTests/webaudio/webaudio-gc-expected.txt (0 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/webaudio/webaudio-gc-expected.txt                              (rev 0)
+++ trunk/LayoutTests/webaudio/webaudio-gc-expected.txt 2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -0,0 +1,3 @@
</span><ins>+
+PASS Web audio events while gcing 
+
</ins></span></pre></div>
<a id="trunkLayoutTestswebaudiowebaudiogchtml"></a>
<div class="addfile"><h4>Added: trunk/LayoutTests/webaudio/webaudio-gc.html (0 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/LayoutTests/webaudio/webaudio-gc.html                              (rev 0)
+++ trunk/LayoutTests/webaudio/webaudio-gc.html 2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -0,0 +1,38 @@
</span><ins>+<!doctype html>
+<html>
+<head>
+<title>Web audio events while gcing</title>
+</head>
+<body>
+<script src=../resources/testharness.js></script>
+<script src=../resources/testharnessreport.js></script>
+<script src=../resources/gc.js></script>
+<script>
+let count = 100;
+
+function checkEvent() {
+    if (!--count)
+        done();
+}
+
+function init() {
+    let ctx = new webkitAudioContext();
+
+    let source = ctx.createOscillator();
+    source.frequency.value = 300;
+    source.type = 0;
+    source.connect(ctx.destination);
+    source.start(0);
+
+    let detector = ctx.createScriptProcessor(1024);
+    detector.onaudioprocess = checkEvent;
+    detector.connect(ctx.destination);
+}
+
+init();
+
+gc();
+
+</script>
+</body>
+</html>
</ins></span></pre></div>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (244976 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog   2019-05-06 20:44:27 UTC (rev 244976)
+++ trunk/Source/WebCore/ChangeLog      2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -1,3 +1,29 @@
</span><ins>+2019-05-06  Youenn Fablet  <youenn@apple.com>
+
+        WebAudio Node JS wrappers should not be collected if events can be fired
+        https://bugs.webkit.org/show_bug.cgi?id=197533
+
+        Reviewed by Jer Noble.
+
+        Before the patch, some web audio nodes could fire event listeners, but were not protected from GC.
+        Use CustomIsReachable to ensure theses nodes can be collected if:
+        - their AudioContext is stopped (typically due to document being navigated away).
+        - their AudioContext is closed.
+        - nodes do not have event listeners.
+
+        Covered by WPT mediacapture-streams/MediaStreamTrack-MediaElement-disabled-audio-is-silence.https.html and
+        WPT webaudio/the-audio-api/the-mediaelementaudiosourcenode-interface/mediaElementAudioSourceToScriptProcessorTest.html
+        and web audio WebRTC tests.
+        Specific newly added test: webaudio/webaudio-gc.html
+
+        * Modules/webaudio/AudioContext.h:
+        (WebCore::AudioContext::isClosed const):
+        * Modules/webaudio/AudioNode.idl:
+        * Sources.txt:
+        * WebCore.xcodeproj/project.pbxproj:
+        * bindings/js/JSAudioNodeCustom.cpp: Added.
+        (WebCore::JSAudioNodeOwner::isReachableFromOpaqueRoots):
+
</ins><span class="cx"> 2019-05-06  Daniel Bates  <dabates@apple.com>
</span><span class="cx"> 
</span><span class="cx">         Google Docs & Yahoo! Japan: Can’t compose characters with Chinese or Japanese keyboard
</span></span></pre></div>
<a id="trunkSourceWebCoreModuleswebaudioAudioContexth"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/webaudio/AudioContext.h (244976 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/webaudio/AudioContext.h     2019-05-06 20:44:27 UTC (rev 244976)
+++ trunk/Source/WebCore/Modules/webaudio/AudioContext.h        2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -133,6 +133,7 @@
</span><span class="cx"> 
</span><span class="cx">     enum class State { Suspended, Running, Interrupted, Closed };
</span><span class="cx">     State state() const;
</span><ins>+    bool isClosed() const { return m_state == State::Closed; }
</ins><span class="cx"> 
</span><span class="cx">     bool wouldTaintOrigin(const URL&) const;
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebCoreModuleswebaudioAudioNodeidl"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Modules/webaudio/AudioNode.idl (244976 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Modules/webaudio/AudioNode.idl      2019-05-06 20:44:27 UTC (rev 244976)
+++ trunk/Source/WebCore/Modules/webaudio/AudioNode.idl 2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -24,7 +24,7 @@
</span><span class="cx"> 
</span><span class="cx"> [
</span><span class="cx">     Conditional=WEB_AUDIO,
</span><del>-    GenerateIsReachable=Impl,
</del><ins>+    CustomIsReachable,
</ins><span class="cx"> ] interface AudioNode : EventTarget {
</span><span class="cx">     readonly attribute AudioContext context;
</span><span class="cx">     readonly attribute unsigned long numberOfInputs;
</span></span></pre></div>
<a id="trunkSourceWebCoreSourcestxt"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/Sources.txt (244976 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/Sources.txt 2019-05-06 20:44:27 UTC (rev 244976)
+++ trunk/Source/WebCore/Sources.txt    2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -431,6 +431,7 @@
</span><span class="cx"> animation/KeyframeEffect.cpp
</span><span class="cx"> animation/WebAnimation.cpp
</span><span class="cx"> 
</span><ins>+bindings/js/JSAudioNodeCustom.cpp
</ins><span class="cx"> bindings/js/CachedModuleScriptLoader.cpp
</span><span class="cx"> bindings/js/CachedScriptFetcher.cpp
</span><span class="cx"> bindings/js/CallTracer.cpp
</span></span></pre></div>
<a id="trunkSourceWebCoreWebCorexcodeprojprojectpbxproj"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/WebCore.xcodeproj/project.pbxproj (244976 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/WebCore.xcodeproj/project.pbxproj   2019-05-06 20:44:27 UTC (rev 244976)
+++ trunk/Source/WebCore/WebCore.xcodeproj/project.pbxproj      2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -7160,6 +7160,7 @@
</span><span class="cx">          3FFFF9A7159D9A550020BBD5 /* WebKitCSSViewportRule.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = WebKitCSSViewportRule.h; sourceTree = "<group>"; };
</span><span class="cx">          3FFFF9AB159D9B060020BBD5 /* ViewportStyleResolver.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = ViewportStyleResolver.cpp; sourceTree = "<group>"; };
</span><span class="cx">          3FFFF9AC159D9B060020BBD5 /* ViewportStyleResolver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ViewportStyleResolver.h; sourceTree = "<group>"; };
</span><ins>+               410626A72280A22A006D1B59 /* JSAudioNodeCustom.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = JSAudioNodeCustom.cpp; sourceTree = "<group>"; };
</ins><span class="cx">           4107908A1FC3E4F20061B27A /* ClientOrigin.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ClientOrigin.h; sourceTree = "<group>"; };
</span><span class="cx">          410B7E711045FAB000D8224F /* JSMessageEventCustom.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = JSMessageEventCustom.cpp; sourceTree = "<group>"; };
</span><span class="cx">          41103AA71E39790A00769F03 /* RealtimeOutgoingAudioSource.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = RealtimeOutgoingAudioSource.cpp; sourceTree = "<group>"; };
</span><span class="lines">@@ -20574,6 +20575,7 @@
</span><span class="cx">                          71EFCEDE202B39C700D7C411 /* JSAnimationEffectCustom.cpp */,
</span><span class="cx">                          71025ED51F99F147004A250C /* JSAnimationTimelineCustom.cpp */,
</span><span class="cx">                          BC2ED6BB0C6BD2F000920BFF /* JSAttrCustom.cpp */,
</span><ins>+                               410626A72280A22A006D1B59 /* JSAudioNodeCustom.cpp */,
</ins><span class="cx">                           BE6DF70E171CA2DA00DD52B8 /* JSAudioTrackCustom.cpp */,
</span><span class="cx">                          BE6DF710171CA2DA00DD52B8 /* JSAudioTrackListCustom.cpp */,
</span><span class="cx">                          576082562011BE0200116678 /* JSAuthenticatorResponseCustom.cpp */,
</span></span></pre></div>
<a id="trunkSourceWebCorebindingsjsJSAudioNodeCustomcpp"></a>
<div class="addfile"><h4>Added: trunk/Source/WebCore/bindings/js/JSAudioNodeCustom.cpp (0 => 244977)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/bindings/js/JSAudioNodeCustom.cpp                           (rev 0)
+++ trunk/Source/WebCore/bindings/js/JSAudioNodeCustom.cpp      2019-05-06 21:14:12 UTC (rev 244977)
</span><span class="lines">@@ -0,0 +1,60 @@
</span><ins>+/*
+ * Copyright (C) 2019 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "config.h"
+
+#if ENABLE(WEB_AUDIO)
+
+#include "AudioContext.h"
+#include "JSAudioNode.h"
+
+namespace WebCore {
+using namespace JSC;
+
+bool JSAudioNodeOwner::isReachableFromOpaqueRoots(JSC::Handle<JSC::Unknown> handle, void*, SlotVisitor& visitor, const char** reason)
+{
+    auto& node = jsCast<JSAudioNode*>(handle.slot()->asCell())->wrapped();
+
+    if (node.isFiringEventListeners()) {
+        if (UNLIKELY(reason))
+            *reason = "AudioNode is firing event listeners";
+        return true;
+    }
+
+    if (!node.context().hasPendingActivity() || node.context().isClosed())
+        return false;
+
+    if (node.hasEventListeners()) {
+        if (UNLIKELY(reason))
+            *reason = "AudioNode has event listeners";
+        return true;
+    }
+
+    return visitor.containsOpaqueRoot(&node);
+}
+
+} // namespace WebCore
+
+#endif
</ins></span></pre>
</div>
</div>

</body>
</html>