Skip to content
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

Jump to bottom

Add support for accessing cross-frame entries. #202

Open
wants to merge 3 commits into
base: gh-pages
Choose a base branch
from
Open

Add support for accessing cross-frame entries. #202

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb104eb
Add support for accessing cross-frame entries.
clelland Sep 18, 2022
ad59f43
Merge remote-tracking branch 'origin/gh-pages' into cross-iframe-time…
clelland Nov 21, 2022
2854086
Remove boolean trap from cross-frame API
clelland Jan 10, 2023
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
110 changes: 93 additions & 17 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"check-punctuation": true,
},
doJsonLd: true,
xref: ["hr-time-3", "infra", "html", "dom"],
xref: ["hr-time-3", "infra", "html", "dom", "document-policy"],
mdn: "performance-timeline",
};
</script>
Expand All @@ -69,6 +69,8 @@
</li>
<li>Adds support for {{PerformanceObserver}}.
</li>
<li>Adds support for cross-frame timeline sharing.
</li>
</ul>
</section>
<section class='informative'>
Expand Down Expand Up @@ -261,8 +263,14 @@ <h2>Extensions to the {{Performance}} interface</h2>
hosts performance related attributes and methods used to retrieve the
performance metric data from the <a>Performance Timeline</a>.</p>
<pre class="idl">
dictionary PerformanceEntryOptions {
DOMString type;
DOMString name;
boolean includeFrames;
};

partial interface Performance {
PerformanceEntryList getEntries ();
PerformanceEntryList getEntries (optional PerformanceEntryOptions options = {});
PerformanceEntryList getEntriesByType (DOMString type);
PerformanceEntryList getEntriesByName (DOMString name, optional DOMString type);
};
Expand All @@ -271,26 +279,43 @@ <h2>Extensions to the {{Performance}} interface</h2>
<p>The <dfn>PerformanceEntryList</dfn> represents a sequence of
<a>PerformanceEntry</a>, providing developers with all the convenience
methods found on JavaScript arrays.</p>
<section data-dfn-for="PerformanceEntryOptions" data-link-for=
"PerformanceEntryOptions">
<h2><dfn>PerformanceEntryOptions</dfn> dictionary</h2>
<dl>
<dt><dfn>type</dfn></dt>
<dd>A single entry type to be retrieved.</dd>
<dt><dfn>name</dfn></dt>
<dd>A string representing the name of entries to be retrieved.</dd>
<dt><dfn>includeFrames</dfn></dt>
<dd>A flag to indicate whether entries from child frames should be
retrieved.</dd>
</dl>
</section>
<section>
<h2><dfn>getEntries()</dfn> method</h2>
<p>Returns a <a>PerformanceEntryList</a> object returned by the
<a>filter buffer map by name and type</a> algorithm with
<var>name</var> and <var>type</var> set to <code>null</code>.</p>
<var>name</var>, <var>type</var> and <var>includeFrames</var> set to the
corresponding members of the method's input <code>options</code>
parameter.</p>
</section>
<section>
<h2><dfn>getEntriesByType()</dfn> method</h2>
<p>Returns a <a>PerformanceEntryList</a> object returned by <a>filter
buffer map by name and type</a> algorithm with <var>name</var> set to
<code>null</code>, and <var>type</var> set to the method's input
<code>type</code> parameter.</p>
<code>null</code>, <var>type</var> set to the method's input
<code>type</code> parameter, and <var>includeFrames</var> set to
<code>false</code>.</p>
</section>
<section>
<h2><dfn>getEntriesByName()</dfn> method</h2>
<p>Returns a <a>PerformanceEntryList</a> object returned by <a>filter
buffer map by name and type</a> algorithm with <var>name</var> set to
the method input <code>name</code> parameter, and <var>type</var> set
to <code>null</code> if optional `entryType` is omitted, or set to the
method's input <code>type</code> parameter otherwise.</p>
the method's input <code>name</code> parameter, <var>type</var> set to
either <code>null</code> if optional `entryType` is omitted, or the
method's input <code>type</code> parameter otherwise, and
<var>includeFrames</var> set to <code>false</code>.</p>
</section>
</section>
</section>
Expand All @@ -305,6 +330,7 @@ <h2>The <dfn>PerformanceEntry</dfn> interface</h2>
readonly attribute DOMString entryType;
readonly attribute DOMHighResTimeStamp startTime;
readonly attribute DOMHighResTimeStamp duration;
readonly attribute object? source;
[Default] object toJSON();
};</pre>
<dl>
Expand Down Expand Up @@ -341,9 +367,16 @@ <h2>The <dfn>PerformanceEntry</dfn> interface</h2>
duration concept doesn't apply, a performance metric may choose to
return a `duration` of <code>0</code>.
</dd>
<dt><dfn>source</dfn></dt>
<dd>
This attribute MUST return the [=global object=] for the realm in which
this <a>PerformanceEntry</a> was recorded.
</dd>
</dl>
<p>When <dfn>toJSON</dfn> is called, run [[WebIDL]]'s <a>default toJSON
steps</a>.</p>
<p class="issue">The <a>toJSON</a> method should not attempt to serialize
the <a>source</a> object reference.</p>
</section>
<section data-link-for="PerformanceObserver" data-dfn-for=
"PerformanceObserver">
Expand Down Expand Up @@ -402,7 +435,7 @@ <h2><dfn>PerformanceObserverCallbackOptions</dfn> dictionary</h2>
observer is observing when the <a>PerformanceObserver</a>'s <a>requires dropped entries</a>
is set.</dd>
</dl>
</section>
</section>
<section>
<h2><dfn>observe()</dfn> method</h2>
<p>The <a>observe()</a> method instructs the user agent to register
Expand Down Expand Up @@ -556,6 +589,7 @@ <h2><dfn>PerformanceObserverInit</dfn> dictionary</h2>
sequence&lt;DOMString&gt; entryTypes;
DOMString type;
boolean buffered;
boolean includeFrames;
};
</pre>
<dl>
Expand All @@ -574,6 +608,11 @@ <h2><dfn>PerformanceObserverInit</dfn> dictionary</h2>
<dd>A flag to indicate whether buffered entries should be queued into
observer's buffer.</dd>
</dl>
<dl>
<dt><dfn>includeFrames</dfn></dt>
<dd>A flag to indicate whether entries from child frames should be
observed.</dd>
</dl>
</section>
<section data-dfn-for="PerformanceObserverEntryList" data-link-for=
"PerformanceObserverEntryList">
Expand Down Expand Up @@ -657,8 +696,8 @@ <h2><a>supportedEntryTypes</a> attribute</h2>
<h2>Processing</h2>
<section data-link-for="PerformanceObserver">
<h2>Queue a <code>PerformanceEntry</code></h2>
<p>To <dfn class="export">queue a PerformanceEntry</dfn> (<var>newEntry</var>), run
these steps:</p>
<p>To <dfn class="export">queue a PerformanceEntry</dfn> (<var>newEntry</var>)
with optional <a>boolean</a> <var>traverse</var>, run these steps:</p>
<ol>
<li>Let <var>interested observers</var> be an initially empty set of
<a>PerformanceObserver</a> objects.
Expand All @@ -669,6 +708,8 @@ <h2>Queue a <code>PerformanceEntry</code></h2>
<li>Let <var>relevantGlobal</var> be <var>newEntry</var>'s <a>relevant
global object</a>.
</li>
<li>Set <var>newEntry</var>'s {{PerformanceEntry/source}} to <var>relevantGlobal</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 @@ -712,6 +753,25 @@ <h2>Queue a <code>PerformanceEntry</code></h2>
<li><a>Queue the PerformanceObserver task</a> with
<var>relevantGlobal</var> as input.
</li>
<li>If <var>traverse</var> is true:
<ol>
<li>Let <var>origins</var> be the result of calling
[=get-policy-value=] with `<a>share-performance-timeline-with</a>`
and <var>relevantGlobal</var>'s <a>active document</a>.</li>
<li>For each <a>browsing context</a> <var>context</var> which is an
<a>ancestor browsing context</a> of <var>relevantGlobal</var>'s
<a>browsing context</a>:
<ol>
<li>If <var>origins</var> contains the token `*`, or
<var>origins</var> contains <var>context</var>'s <a>origin</a>,
<a>Queue a global task</a> on the <a>performance timeline task
source</a> with <var>context</var>'s [=browsing context/active
window=] to <a>queue a PerformanceEntry</a> with
<var>newEntry</var>.</li>
</ol>
</li>
</ol>
</li>
</ol>
</section>
<section data-link-for="PerformanceObserver">
Expand Down Expand Up @@ -800,8 +860,8 @@ <h2>Queue the PerformanceObserver task</h2>
<section data-link-for="PerformanceEntry">
<h2>Filter buffer map by name and type</h2>
<p>When asked to run the <dfn>filter buffer map by name and type</dfn>
algorithm with optional <var>name</var> and <var>type</var>, run the
following steps:</p>
algorithm with optional <var>name</var>, <var>type</var>, and
<var>includeFrames</var>, run the following steps:</p>
<ol>
<li>Let <var>result</var> be an initially empty <a>list</a>.
</li>
Expand All @@ -826,8 +886,8 @@ <h2>Filter buffer map by name and type</h2>
continue to the next <var>tuple</var>.
</li>
<li>Let <var>entries</var> be the result of running <a>filter
buffer by name and type</a> with <var>buffer</var>, <var>name</var>
and <var>type</var> as inputs.
buffer by name and type</a> with <var>buffer</var>, <var>name</var>,
<var>type</var> and <var>includeFrames</var> as inputs.
</li>
<li>For each <var>entry</var> in <var>entries</var>,
[=list/append=] <var>entry</var> to <var>result</var>.</li>
Expand All @@ -842,14 +902,17 @@ <h2>Filter buffer map by name and type</h2>
<section data-link-for="PerformanceEntry">
<h2>Filter buffer by name and type</h2>
<p>When asked to run the <dfn>filter buffer by name and type</dfn>
algorithm, with <var>buffer</var>, <var>name</var>, and <var>type</var>
as inputs, run the following steps:</p>
algorithm, with <var>buffer</var>, <var>name</var>, <var>type</var> and
<var>includeFrames</var> as inputs, run the following steps:</p>
<ol>
<li>Let <var>result</var> be an initially empty <a>list</a>.
</li>
<li>For each <a>PerformanceEntry</a> <var>entry</var> in
<var>buffer</var>, run the following steps:
<ol>
<li>If <var>includeFrames</var> is not true and <a>this</a>'s
<a>relevant global object</a> is not the same as <var>entry</var>'s
{{PerformanceEntry/source}}, continue to next <var>entry</var>.
<li>If <var>type</var> is not null and if <var>type</var> is not
<a data-cite=INFRA#string-is>identical to</a> <var>entry</var>'s
<code>entryType</code> attribute, continue to next <var>entry</var>.
Expand Down Expand Up @@ -884,6 +947,19 @@ <h2>Determine if a performance entry buffer is full</h2>
</ol>
</section>
</section>
<section id="integratioons">
<h3>Integrations with other Specifications</h3>
<section id="permissions-policy-integration">
<h3>Integration with Document Policy</h3>
<p>This specification defines a [=configuration point=] with the name
<code><dfn>share-performance-timeline-with</dfn></code>. Its type is
<code>set</code>, and its default value is the empty set.</p>
<p>Set members must be strings representing origins, or the token `*`,
representing all origins.</p>
<p class="issue">This integration requires a currently-non-specified
"set" type and "string" type in Document Policy.</p>
</section>
</section>
<section id="privacy">
<h3>Privacy Considerations</h3>
<p>This specification extends the {{Performance}} interface defined by [[HR-TIME-3]] and
Expand Down