Skip to content

Associcate idle periods with similar-origin window agent #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: event_loop_start
Choose a base branch
from
Open

Associcate idle periods with similar-origin window agent #1

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0465cfc
Associcate idle callback lists and idle periods with the event loop.
rmcilroy Oct 30, 2019
426afac
Replace event loop with similar-origin window agent
rmcilroy Oct 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 47 additions & 32 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,19 +341,24 @@ <h2><code>Window</code> interface extensions</h2>
</pre>
<p>Each <a>Window</a> has:</p>
<ul>
<li>A <dfn>list of idle request callbacks</dfn>. The list MUST be
initially empty and each entry in this list is identified by a number,
which MUST be unique within the list for the lifetime of the <code>Window</code>
object.</li>
<li>A <dfn>list of runnable idle callbacks</dfn>. The list MUST be
initially empty and each entry in this list is identified by a number,
which MUST be unique within the list of the lifetime of the <code>Window</code>
object.</li>
<li>An <dfn>idle callback identifier</dfn>, which is a number which MUST
initially be zero.</li>
</ul>

<p>In addition, each <a>event loop</a> has:</p>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be cleaner to use the similar-origin window agent here as the ordering is only supposed to be observable within such an agent. That's also what we do for mutation observers.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, that makes sense. Is there an easy way to get the all the similar-origin window agents associated with an event loop (i.e., for step 11 of the event loop processing model)?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so. @domenic?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No concrete <dfn> you can link to. But IMO something like

all similar-origin window agents that use event loop

is well-defined, given the definition at https://html.spec.whatwg.org/#window-event-loop

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, I've switch this over to similar-origin window agent.

<ul>
<li>A <dfn>list of idle request callbacks</dfn>. The list MUST be
initially empty and each entry in this list is identified by <a>Window</a>
and a number, the combination of which MUST be unique within the list for
the lifetime of the <a>event loop</a>.</li>
<li>A <dfn>list of runnable idle callbacks</dfn>. The list MUST be
initially empty and each entry in this list is identified by a
<a>Window</a> and a number, the combination of which which MUST be unique
within the list for the lifetime of the <a>event loop</a>.</li>
<li>A <dfn>last idle period deadline</dfn>, which is a
<a>DOMHighResTimeStamp</a> which MUST initially be zero.
</ul>

<section data-link-for="Window">
<h2>The <code><dfn data-dfn-for="Window">requestIdleCallback</dfn></code>
method</h2>
Expand All @@ -367,8 +372,11 @@ <h2>The <code><dfn data-dfn-for="Window">requestIdleCallback</dfn></code>
by one.</li>
<li>Let <var>handle</var> be the current value of <var>window</var>'s
<a>idle callback identifier</a>.</li>
<li>Push <var>callback</var> to the end of <var>window</var>'s <a>list
of idle request callbacks</a>, associated with <var>handle</var>.</li>
<li>Let <var>event_loop</var> be the <a>event loop</a> associated with
<var>window</var></li>
<li>Push <var>callback</var> to the end of <var>event_loop</var>'s
<a>list of idle request callbacks</a>, associated with <var>handle</var>
and <var>window</var>.</li>
<li>Return <var>handle</var> and then continue running this algorithm
asynchronously.
<p class="note">The following steps run in parallel and queue a timer
Expand Down Expand Up @@ -421,11 +429,13 @@ <h2>The <code><dfn data-dfn-for="Window">cancelIdleCallback</dfn></code>
</p>
<ol>
<li>Let <var>window</var> be this <code>Window</code> object.</li>
<li>Find the entry in either the <var>window</var>'s <a>list of idle
<li>Let <var>event_loop</var> be the <a>event loop</a> associated with
<var>window</var></li>
<li>Find the entry in either the <var>event_loop</var>'s <a>list of idle
request callbacks</a> or <a>list of runnable idle callbacks</a> that is
associated with the value <var>handle</var>.
associated with the value <var>handle</var> and <var>window</var>.
</li>
<li>If there is such an entry, remove it from both <var>window</var>'s
<li>If there is such an entry, remove it from both <var>event_loop</var>'s
<a>list of idle request callbacks</a> and the <a>list of runnable idle
callbacks</a>.
</li>
Expand Down Expand Up @@ -479,7 +489,7 @@ <h2>Start an idle period algorithm</h2>
the <a>event loop</a> is otherwise idle:</p>
<ol>
<li>Let <var>last_deadline</var> be the <a>last idle period deadline</a>
associated with <var>window</var>
associated with <var>event_loop</var>
<li>If <var>last_deadline</var> is greater than the current time,
return from this algorithm.
<li>Optionally, if the user agent determines the idle period should
Expand Down Expand Up @@ -509,31 +519,32 @@ <h2>Start an idle period algorithm</h2>
responsiveness to new user input within the threshold of human
perception.</p>
</li>
<li>Let <var>pending_list</var> be <var>window</var>'s <a>list of idle
request callbacks</a>.
<li>Let <var>pending_list</var> be <var>event_loop</var>'s <a>list of
idle request callbacks</a>.
</li>
<li>Let <var>run_list</var> be <var>window</var>'s <a>list of runnable
idle callbacks</a>.
<li>Let <var>run_list</var> be <var>event_loop</var>'s <a>list of
runnable idle callbacks</a>.
</li>
<li>Append all entries from <var>pending_list</var> into
<var>run_list</var> preserving order.</li>
<li>Clear <var>pending_list</var>.</li>
<li><a>Queue a task</a> on the queue associated with the idle-task
<a>task source</a>, which performs the steps defined in the <a>invoke
idle callbacks algorithm</a> with <var>deadline</var> and
<var>window</var> as parameters.
<var>event_loop</var> as parameters.
</li>
<li>Save <var>deadline</var> as the <a>last idle period deadline</a>
associated with <var>window</var>.</li>
associated with <var>event_loop</var>.</li>
</ol>
<p>The <a>task source</a> for these <a>tasks</a> is the <dfn>idle-task
task source</dfn>.</p>
<div class="note">
<p>The time between <var>now</var> and <var>deadline</var> is referred
to as the <dfn>idle period</dfn>. There can only be one idle period
active at a given time for any given <code>window</code>. The idle period can end
early if the user agent determines that it is no longer idle. If so,
the next idle period cannot start until after <var>deadline</var>.</p>
active at a given time for any given <a>event loop</a>. The idle period
can end early if the user agent determines that it is no longer idle. If
so, the next idle period cannot start until after <var>deadline</var>.
</p>
</div>
</section>
<section>
Expand All @@ -544,9 +555,10 @@ <h2>Invoke idle callbacks algorithm</h2>
to newly scheduled high-priority work, return from the algorithm.
<li>Let <var>now</var> be the current time.</li>
<li>If <var>now</var> is less than <var>deadline</var> and the
<var>window</var>'s <a>list of runnable idle callbacks</a> is not empty:
<var>event_loop</var>'s <a>list of runnable idle callbacks</a> is not
empty:
<ol>
<li>Pop the top <var>callback</var> from <var>window</var>'s
<li>Pop the top <var>callback</var> from <var>event_loop</var>'s
<a>list of runnable idle callbacks</a>.</li>
<li>Let <var>deadlineArg</var> be a new <a>IdleDeadline</a>.
Set the <a>time</a> associated with <var>deadlineArg</var> to
Expand All @@ -555,10 +567,10 @@ <h2>Invoke idle callbacks algorithm</h2>
<li>Call <var>callback</var> with <var>deadlineArg</var> as its
argument. If an uncaught runtime script error occurs, then <a>report
the error</a>.</li>
<li>If <var>window</var>'s <a>list of runnable idle callbacks</a>
<li>If <var>event_loop</var>'s <a>list of runnable idle callbacks</a>
is not empty, <a>queue a task</a> which performs the steps in the
<a>invoke idle callbacks algorithm</a> with <var>deadline</var>
and <var>window</var> as a parameters and return from this
and <var>event_loop</var> as a parameters and return from this
algorithm</li>
</ol>
</li>
Expand All @@ -572,16 +584,19 @@ <h2>Invoke idle callbacks algorithm</h2>
<h2>Invoke idle callback timeout algorithm</h2>
<p>The <dfn>invoke idle callback timeout algorithm</dfn>:</p>
<ol>
<li>Let <var>event_loop</var> be the <a>event loop</a> associated with
<var>window</var> argument passed to the algorithm</li>
<li>Let <var>callback</var> be the result of finding the entry in <var>
window</var>'s <a>list of idle request callbacks</a> or the <a>list
event_loop</var>'s <a>list of idle request callbacks</a> or the <a>list
of runnable idle callbacks</a> that is associated with the value
given by the <var>handle</var> argument passed to the algorithm.
given by the <var>handle</var> and <var>window</var> arguments passed
to the algorithm.
</li>
<li>If <var>callback</var> is not undefined:
<ol>
<li>Remove <var>callback</var> from both <var>window</var>'s <a>list
of idle request callbacks</a> and the <a>list of runnable idle
callbacks</a>.</var></li>
<li>Remove <var>callback</var> from both <var>event_loop</var>'s
<a>list of idle request callbacks</a> and the <a>list of runnable
idle callbacks</a>.</var></li>
<li>Let <var>now</var> be the current time.</li>
<li>Let <var>deadlineArg</var> be a new <a>IdleDeadline</a>.
Set the <a>time</a> associated with <var>deadlineArg</var> to
Expand Down