<!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>[225343] trunk/Source/WebCore</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/225343">225343</a></dd>
<dt>Author</dt> <dd>beidson@apple.com</dd>
<dt>Date</dt> <dd>2017-11-30 13:01:12 -0800 (Thu, 30 Nov 2017)</dd>
</dl>

<h3>Log Message</h3>
<pre>Make WorkerThread lifetime much more predictable.
https://bugs.webkit.org/show_bug.cgi?id=180203

Reviewed by Chris Dumez.

No new tests (Fixes flakiness in existing and future tests).

The family of classes related to Workers has a complicated ownership model.

For Dedicated Workers, the WorkerThread object is owned by the WorkerMessagingProxy,
which manages its own lifetime. Additionally, other object(s) have raw C++ references
to it, and the expected lifetimes are described in comments scattered through a few files.

What it boils down to is that the "Worker" DOM object - which lives on the main thread -
is the key to the proper destruction of all of these objects.

For ServiceWorkers running in their own context process, there is no "Worker" on the main thread.

As a result, ServiceWorkers can get into a situation where their WorkerThread can be destroyed before
their ServiceWorkerGlobalScope is destroyed on the running background thread.

There's no reason to not have WorkerThread guarantee its own lifetime until its background thread
has actually completed.

* workers/WorkerThread.cpp:
(WebCore::WorkerThread::workerThread): Protect the WorkerThread object during the entire runtime
  of the background thread itself, and release that protection on the main thread.
* workers/WorkerThread.h:</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCoreworkersWorkerThreadcpp">trunk/Source/WebCore/workers/WorkerThread.cpp</a></li>
<li><a href="#trunkSourceWebCoreworkersWorkerThreadh">trunk/Source/WebCore/workers/WorkerThread.h</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (225342 => 225343)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog   2017-11-30 20:48:53 UTC (rev 225342)
+++ trunk/Source/WebCore/ChangeLog      2017-11-30 21:01:12 UTC (rev 225343)
</span><span class="lines">@@ -1,3 +1,34 @@
</span><ins>+2017-11-30  Brady Eidson  <beidson@apple.com>
+
+        Make WorkerThread lifetime much more predictable.
+        https://bugs.webkit.org/show_bug.cgi?id=180203
+
+        Reviewed by Chris Dumez.
+
+        No new tests (Fixes flakiness in existing and future tests).
+
+        The family of classes related to Workers has a complicated ownership model.
+
+        For Dedicated Workers, the WorkerThread object is owned by the WorkerMessagingProxy,
+        which manages its own lifetime. Additionally, other object(s) have raw C++ references
+        to it, and the expected lifetimes are described in comments scattered through a few files.
+
+        What it boils down to is that the "Worker" DOM object - which lives on the main thread - 
+        is the key to the proper destruction of all of these objects.
+
+        For ServiceWorkers running in their own context process, there is no "Worker" on the main thread.
+
+        As a result, ServiceWorkers can get into a situation where their WorkerThread can be destroyed before
+        their ServiceWorkerGlobalScope is destroyed on the running background thread.
+
+        There's no reason to not have WorkerThread guarantee its own lifetime until its background thread
+        has actually completed.
+
+        * workers/WorkerThread.cpp:
+        (WebCore::WorkerThread::workerThread): Protect the WorkerThread object during the entire runtime
+          of the background thread itself, and release that protection on the main thread.
+        * workers/WorkerThread.h:
+
</ins><span class="cx"> 2017-11-30  Chris Dumez  <cdumez@apple.com>
</span><span class="cx"> 
</span><span class="cx">         Populate self.registration.installing/waiting/active inside service workers
</span></span></pre></div>
<a id="trunkSourceWebCoreworkersWorkerThreadcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/workers/WorkerThread.cpp (225342 => 225343)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/workers/WorkerThread.cpp    2017-11-30 20:48:53 UTC (rev 225342)
+++ trunk/Source/WebCore/workers/WorkerThread.cpp       2017-11-30 21:01:12 UTC (rev 225343)
</span><span class="lines">@@ -149,6 +149,8 @@
</span><span class="cx"> 
</span><span class="cx"> void WorkerThread::workerThread()
</span><span class="cx"> {
</span><ins>+    auto protectedThis = makeRef(*this);
+
</ins><span class="cx">     // Propagate the mainThread's fenv to workers.
</span><span class="cx"> #if PLATFORM(IOS)
</span><span class="cx">     FloatingPointEnvironment::singleton().propagateMainThreadEnvironment();
</span><span class="lines">@@ -231,6 +233,9 @@
</span><span class="cx">     // Clean up WebCore::ThreadGlobalData before WTF::Thread goes away!
</span><span class="cx">     threadGlobalData().destroy();
</span><span class="cx"> 
</span><ins>+    // Send the last WorkerThread Ref to be Deref'ed on the main thread.
+    callOnMainThread([protectedThis = WTFMove(protectedThis)] { });
+
</ins><span class="cx">     // The thread object may be already destroyed from notification now, don't try to access "this".
</span><span class="cx">     protector->detach();
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkSourceWebCoreworkersWorkerThreadh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/workers/WorkerThread.h (225342 => 225343)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/workers/WorkerThread.h      2017-11-30 20:48:53 UTC (rev 225342)
+++ trunk/Source/WebCore/workers/WorkerThread.h 2017-11-30 21:01:12 UTC (rev 225343)
</span><span class="lines">@@ -59,7 +59,7 @@
</span><span class="cx"> 
</span><span class="cx"> struct WorkerThreadStartupData;
</span><span class="cx"> 
</span><del>-class WorkerThread : public RefCounted<WorkerThread> {
</del><ins>+class WorkerThread : public ThreadSafeRefCounted<WorkerThread> {
</ins><span class="cx"> public:
</span><span class="cx">     virtual ~WorkerThread();
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>