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

Add console.timeStamp() to the specification #236

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

Add console.timeStamp() to the specification #236

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31280ac
Add `console.timeStamp()` to the specification
bmeurer Jul 12, 2024
2519cb2
Remove unnecessary code
bmeurer Jul 24, 2024
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
7 changes: 7 additions & 0 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ namespace console { // but see namespace object requirements below
undefined time(optional DOMString label = "default");
undefined timeLog(optional DOMString label = "default", any... data);
undefined timeEnd(optional DOMString label = "default");
undefined timeStamp(optional DOMString label = "default");
Copy link
Contributor

Choose a reason for hiding this comment

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

im not sure exactly the behavior of Chrome/Firefox/etc., but at least in WebKit there is no = "default" value (i.e. calling console.timeStamp() will show "Timestamp" in the UI)

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, Chromium appears to not use "default" at all. At least when provided with no string, it shows "TimeStamp: <empty string technically here>" in the UI which I think matches Safari, but I fear I am too dumb to figure out where in the "Timelines" UI calls to console.timeStamp() actually show up.

Screenshot 2024-07-21 at 11 09 01 PM

Copy link
Author

Choose a reason for hiding this comment

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

Yes, I just fixed V8 last week to have the = "default" value for all console.time*() APIs, including console.timeStamp(). Maybe we can update JSC as well to have consistency.

Copy link
Contributor

Choose a reason for hiding this comment

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

i kinda prefer it showing "Timestamp" in the UI, but i dont feel too strongly about it

we could always have the API use = "default" and then in the UI check if === "default" and if so show "Timestamp"

Copy link
Author

Choose a reason for hiding this comment

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

Ok, so we can stick to = "default" for consistency here?

Copy link
Member

Choose a reason for hiding this comment

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

we could always have the API use = "default" and then in the UI check if === "default" and if so show "Timestamp"

This seems a little funky, especially since Safari treats console.timeStamp() differently from console.timeStamp("default")—the former defaults to "TimeStamp" and the latter prints "default". Whereas Chrome shows "TimeStamp: default" for both. I think it makes more sense to stick with = "default" personally. Do you think Safari's inspector would be willing to budge on this @dcrousso ?

Copy link
Contributor

Choose a reason for hiding this comment

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

like i mentioned, im not a huge fan of showing "default" in the UI as i think it's not super clear (especially when compared to showing "Timestamp"), but Web Inspector certainly can adopt the behavior of DOMString label = "default" and then have the UI adjust based on whether a value was actually provided

Copy link
Author

Choose a reason for hiding this comment

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

So that means we are good to go with this?

Copy link
Member

Choose a reason for hiding this comment

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

Web Inspector could also unconditionally show “Timestamp: <label-which-defaults-to-‘default’>” to do what chrome does. Either way I agree this isn’t a big deal.

@bmeurer it would be nice to know what Firefox does here (see #236 (comment)) but I think we’re probably good.

};
</pre>

Expand Down Expand Up @@ -274,6 +275,12 @@ for plans to make {{console/timeEnd()}} and {{console/timeLog()}} formally repor
console when a given |label| does not exist in the associated <a>timer table</a>.
</p>

<h4 id="timestamp" oldids="timestamp-label,dom-console-timestamp" method for="console">timeStamp(|label|)</h4>
Copy link
Member

Choose a reason for hiding this comment

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

Maybe this should go in its own section about performance APIs? I guess this is kind of time related, but the existing timing APIs all have to do with keeping track of literal time stamps that get printed for the developer, where as timeStamp() seems to not interact with that timer table at all, and be more focused on interacting with a performance console.

This sounds very similar to console.markTimeline() actually. Am I correct in thinking it does not deal with actual raw times or timestamps at all?

(Also this is separate, and maybe I am dumb, but can you show me where the marked point actually shows up in the Performance panel's UI, when this API is called? I can't seem to find it when I call the API)

Copy link

Choose a reason for hiding this comment

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

can you show me where the marked point actually shows up in the Performance panel's UI, when this API is called?

In Chrome, any call to console.timeStamp that happens during a recording is shown inside the "Timings" track.
image

Copy link

Choose a reason for hiding this comment

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

and yeah at least in Chrome, you are right about timeStamp being independent from the other timing APIs in console. There, it simply adds an entry to the data buffer of the performance panel (a trace event)

Copy link
Member

Choose a reason for hiding this comment

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

Got it, can you confirm whether or not other browsers behave the same (or at least are as distinct from the other timing APIs as in Chrome)? That will help inform the tests we'll need for this I think.

Copy link
Author

Choose a reason for hiding this comment

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

According to MDN, console.timeStamp() is solely intended for the purpose of adding data to performance traces, and from my tests with Firefox, that's exactly what happens there.

@and-oli can you confirm for Safari?

Copy link
Author

Choose a reason for hiding this comment

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

@domfarolino Let me know if you want me to put this into a separate section on Performance APIs.

Copy link
Author

Choose a reason for hiding this comment

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

Friendly ping.

Copy link

Choose a reason for hiding this comment

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

Sorry for the delay. Safari also uses console.timeStamp solely to add markers to the Timelines tab: see docs


1. If the developer is recording a performance trace, add a single marker to the performance trace with the |label|.
domfarolino marked this conversation as resolved.
Show resolved Hide resolved
1. Otherwise, do nothing.
bmeurer marked this conversation as resolved.
Show resolved Hide resolved
1. Return *undefined*.
bmeurer marked this conversation as resolved.
Show resolved Hide resolved

<h2 id="supporting-ops">Supporting abstract operations</h2>

<h3 id="logger" abstract-op lt="Logger">Logger(|logLevel|, |args|)</h3>
Expand Down
Loading