Skip to content

Remove PerformanceEntry.id and rephrase id generation. #219

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 10 commits into
base: gh-pages
Choose a base branch
from
Open

Remove PerformanceEntry.id and rephrase id generation. #219

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8308e97
Remove PerformanceEntry.id and rephrase id generation.
powdercloud Mar 18, 2025
cc34a39
typo
powdercloud Mar 18, 2025
07ffd9b
swap the queing sections for now
powdercloud Mar 19, 2025
dd6399b
Make navigationId an int32, and simplify algorithm.
powdercloud Mar 21, 2025
7da63a6
distinguish current document navigation id
powdercloud Mar 21, 2025
9d78e2d
tweak wording
powdercloud Mar 21, 2025
58b39fb
Make navigationId an unsigned integer, since we wont' use the sign an…
powdercloud May 30, 2025
4505520
Merge branch 'w3c:gh-pages' into navigationid
powdercloud May 30, 2025
3ffe833
tweaks
powdercloud May 30, 2025
4524f6c
fix markup
powdercloud May 30, 2025
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
106 changes: 44 additions & 62 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h2>Introduction</h2>
and be notified of new performance metrics and, optionally, previously
buffered performance metrics of specified type, via the
<a>PerformanceObserver</a> interface.</p>
<p>The <a>PerformanceObserver</a> interface was added
<p>The <a>PerformanceObserver</a> interface was added
and is designed to address limitations of the buffer-based
approach shown in the first example. By using the PerformanceObserver
interface, the application can:</p>
Expand Down Expand Up @@ -247,14 +247,13 @@ <h2><dfn>Performance Timeline</dfn></h2>
<li>An integer <dfn>dropped entries count</dfn> that is initially 0.</li>
</ul>
</li>
<li>An integer <dfn>last performance entry id</dfn> that is initially set
to a random integer between 100 and 10000.
<li>An integer <dfn>current navigation id</dfn>, which is initially 0.
</li>
</ul>
<p>Each <a>Document</a> has:</p>
<ul>
<li>A <dfn>most recent navigation</dfn>, which is a <a>PerformanceEntry</a>,
initially unset.
<li>
An integer <dfn>current document navigation id</dfn>, which is initially 0.
</li>
</ul>
<p>In order to get the <dfn>relevant performance entry tuple</dfn>, given
Expand Down Expand Up @@ -314,12 +313,11 @@ <h2>The <dfn>PerformanceEntry</dfn> interface</h2>
<pre class='idl'>
[Exposed=(Window,Worker)]
interface PerformanceEntry {
readonly attribute unsigned long long id;
readonly attribute DOMString name;
readonly attribute DOMString entryType;
readonly attribute DOMHighResTimeStamp startTime;
readonly attribute DOMHighResTimeStamp duration;
readonly attribute unsigned long long navigationId;
readonly attribute unsigned long navigationId;
[Default] object toJSON();
};</pre>
<dl>
Expand All @@ -332,9 +330,8 @@ <h2>The <dfn>PerformanceEntry</dfn> interface</h2>
<dd>
This attribute must return the value it is initialized to.

<p class="note">All `entryType` values are defined in the
relevant<a href=
"https://w3c.github.io/timing-entrytypes-registry/#registry">registry</a>.
<p class="note">All `entryType` values are defined in the relevant
<a href="https://w3c.github.io/timing-entrytypes-registry/#registry">registry</a>.
Examples include: <code>"mark"</code> and <code>"measure"</code>
[[USER-TIMING-2]], <code>"navigation"</code> [[NAVIGATION-TIMING-2]],
and <code>"resource"</code> [[RESOURCE-TIMING-2]].</p>
Expand Down Expand Up @@ -684,30 +681,25 @@ <h2>Queue a <code>PerformanceEntry</code></h2>
<p>To <dfn class="export">queue a PerformanceEntry</dfn> (<var>newEntry</var>), run
these steps:</p>
<ol>
<li>If <var>newEntry</var>'s {{PerformanceEntry/id}} is unset:
<ol>
<li>Let <var>id</var> be the result of running <a>generate an id</a> for <var>newEntry</var>.</li>
<li>Set <var>newEntry</var>'s {{PerformanceEntry/id}} to <var>id</var>.</li>
</ol>
</li>
<li>Let <var>interested observers</var> be an initially empty set of
<a>PerformanceObserver</a> objects.
</li>
<li>Let <var>entryType</var> be <var>newEntry</var>’s <a data-lt=
<li>Let <var>entryType</var> be <var>newEntry</var>'s <a data-lt=
"PerformanceEntry.entryType">entryType</a> value.
</li>
<li>Let <var>relevantGlobal</var> be <var>newEntry</var>'s <a>relevant
global object</a>.
</li>
<li>If <var>relevantGlobal</var> has an [=associated document=]:
<ol>
<li>Set <var>newEntry</var>'s <a
data-lt="PerformanceEntry.navigationId">navigationId</a> to the value of
<var>relevantGlobal</var>'s [=associated document=]'s [=most recent navigation=]'s {{PerformanceEntry/id}}.</li>
</ol>
<li>If the <code>PerformanceEntry</code> to be queued is a navigation
entry (in other words, <code>entryType=='navigation'</code>), then
let <var>navigationId</var> be the result of running
<a>generate a navigation id</a>.
</li>
<li>Otherwise, set <var>newEntry</var>'s <a
data-lt="PerformanceEntry.navigationId">navigationId</a> to null.</li>
<li>Otherwise, let <var>navigationId</var>
be the <var>relevantGlobal</var>’s <var>current navigation id</var>.
</li>
<li>Set <var>newEntry</var>'s <a
data-lt="PerformanceEntry.navigationId">navigationId</a> to <var>navigationId</var>.</li>
<li>For each <a>registered performance observer</a> <var>regObs</var> in
<var>relevantGlobal</var>'s <a>list of registered performance observer objects</a>:
<ol>
Expand Down Expand Up @@ -753,25 +745,6 @@ <h2>Queue a <code>PerformanceEntry</code></h2>
</li>
</ol>
</section>
<section data-link-for="PerformanceObserver">
<h2>Queue a navigation <code>PerformanceEntry</code></h2>
<p>To <dfn class="export">queue a navigation PerformanceEntry</dfn> (<var>newEntry</var>), run
these steps:</p>
<ol>
<li>Let <var>id</var> be the result of running <a>generate an id</a> for <var>newEntry</var>.</li>
<li>Let <var>relevantGlobal</var> be <var>newEntry</var>'s <a>relevant
global object</a>.
</li>
<li>Set <var>newEntry</var>'s {{PerformanceEntry/id}} to <var>id</var>.</li>
<li>Set <var>newEntry</var>'s {{PerformanceEntry/navigationId}} to <var>id</var>.</li>
<li>If <var>relevantGlobal</var> has an [=associated document=]:
<ol>
<li>Set <var>relevantGlobal</var>'s [=associated document=]'s [=most recent navigation=] to <var>newEntry</var>.</li>
</ol>
</li>
<li><a>Queue a PerformanceEntry</a> with <var>newEntry</var> as input.</li>
</ol>
</section>
<section data-link-for="PerformanceObserver">
<h2>Queue the PerformanceObserver task</h2>
<p>When asked to <dfn>queue the PerformanceObserver task</dfn>, given
Expand Down Expand Up @@ -940,26 +913,34 @@ <h2>Determine if a performance entry buffer is full</h2>
</ol>
</section>
<section data-link-for="PerformanceEntry">
<h2>Generate a Performance Entry id</h2>
<p>When asked to <dfn class="export">generate an id</dfn> for a
<a>PerformanceEntry</a> <var>entry</a>, run the following steps:</p>
<h2>Generate a Navigation id</h2>
<p>When asked to <dfn class="export">generate a navigation id</dfn> for a navigation
<a>PerformanceEntry</a> <var>entry</var>, run the following steps:</p>
<ol>
<li>Let <var>relevantGlobal</var> be <var>entry</var>'s <a>relevant
global object</a>.
<li>Increase <var>relevantGlobal</var>'s <a>last performance entry
id</a> by a small number chosen by the user agent.</li>
<li>Return <var>relevantGlobal</var>'s <a>last performance entry id</a>.
global object</a>.
<li>Let <var>relevantDoc</var> be <var>relevantGlobal</var>'s [=associated document=], or null.
<li>If <var>relevantGlobal</var>'s [=current navigation id=] is 0 (the initial value),
of if <var>relevantDoc</var> is null,
or if <var>relevantDoc</var> is not null and <var>relevantGlobal</var>'s
[=current navigation id=] differs from <var>doc</var>'s [=current document navigation id=],
then let <var>navigationId</var> be a random integer between 100 and 10000000.
<li>Otherwise, let <var>navigationId</var> be the sum of <var>relevantGlobal</var>'s
[=current navigation id=] and a small integer.
<li>Set <var>relevantGlobal</var>'s [=current navigation id=] to <var>navigationId</var>.
<li>If <var>relevantDoc</var> is not null, set <var>relevantDoc</var>'s [=current document navigation id=]
to <var>navigationId</var>.
<li>Return <var>navigationId</var>.
</ol>
<p>A user agent may choose to increase the <a>last performance entry
id</a>it by a small random integer every time. A user agent must not pick
a single global random integer and increase the <a>last performance entry
id</a> of all global objects by that amount because this could introduce
cross origin leaks.
</p>
<p class="note">The <a>last performance entry id</a> has an initial random
value, and is increased by a small number chosen by the user agent instead
of 1 to discourage developers from considering it as a counter of the
number of entries that have been generated in the web application.</p>
<p class="note">Sequences of navigation ids that are associated with
the same document can be used to establish order, by sorting by
navigation id.</p>
<p class="note">The increcase between same-document navigation ids is
as small number as opposed to 1, to discourage developers from considering
navigation ids as a counter of the number of entries that have been generated
in the web application.</p>
<p class="note">To avoid integer overflow, the same-document mechanism may revert to assign
a random integer between 10 and 10000000, but this is expected to be extremeley rare.</p>
</section>
</section>
<section id="privacy">
Expand All @@ -969,8 +950,9 @@ <h3>Privacy Considerations</h3>
refer to [[HR-TIME-3]] for privacy considerations of exposing high-resoluting timing
information. Each new specification introducing new performance entries should have its own
privacy considerations as well.</p>
<p>The <a>last performance entry id</a> is deliberately initialized to a
<p>The <a>current navigation id</a> is deliberately initialized to a
random value, and is incremented by another small value every time a new
navigation
{{PerformanceEntry}} is queued. User agents may choose to use a consistent
increment for all users, or may pick a different increment for each
<a>global object</a>, or may choose a new random increment for each
Expand Down