Skip to content

Commit

Permalink
Rename and update semantics for navigation duration measurement
Browse files Browse the repository at this point in the history
Closes #8 by renaming to something shorter, although not to the proposed name since navigationStart is apparently deprecated.

Closes #12 by changing the semantics to when the navigation is initiated to be more useful.

Points to #33 for further work on this area.
  • Loading branch information
domenic authored Feb 11, 2021
1 parent 02edefb commit 5cefb71
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -565,12 +565,14 @@ This can be useful for cleaning up any information in secondary stores, such as
The `window.appHistory` object has an event, `currententrychange`, which allows the application to react to any updates to the `appHistory.currentEntry` property. This includes both navigations that change its value, and calls to `appHistory.updateCurrentEntry()` that change its `state` or `url` properties. This cannot be intercepted or canceled, as it occurs after the navigation has already happened; it's just an after-the-fact notification.
This event has one special property, `event.navigationStartTimeStamp`, which for same-document navigations gives the value of `event.timeStamp` for the corresponding `navigate` event. This allows it to be used for determining the overall load time, including the time it took for a promise passed to `e.respondWith()` to settle:
This event has one special property, `event.startTime`, which for [same-document](#appendix-types-of-navigations) navigations gives the value of `performance.now()` when the navigation was initiated. This includes for navigations that were originally [cross-document](#appendix-types-of-navigations), like the user clicking on `<a href="https://example.com/another-page">`, but were transformed into same-document navigations by [navigation interception](#navigation-monitoring-and-interception). For completely cross-document navigations, `startTime` will be `null`.
"Initiated" means either when the corresponding API was called (like `location.href` or `appHistory.pushNewEntry()`), or when the user activated the corresponding `<a>` element, or submitted the corresponding `<form>`. This allows it to be used for determining the overall time from navigation initiation to navigation completion, including the time it took for a promise passed to `e.respondWith()` to settle:
```js
appHistory.addEventListener("currententrychange", e => {
if (e.navigationStartTimeStamp) {
const loadTime = e.timeStamp - e.navigationStartTimeStamp;
if (e.startTime) {
const loadTime = e.timeStamp - e.startTime;

document.querySelector("#status-bar").textContent = `Loaded in ${loadTime} ms!`;
analyticsPackage.sendEvent("single-page-app-nav", { loadTime });
Expand All @@ -580,7 +582,9 @@ appHistory.addEventListener("currententrychange", e => {
});
```
_TODO: could we populate this for cross-document navigations too? Then it kind of overlaps with existing timing APIs, and is probably a lot harder to implement..._
_TODO: reconsider cross-document navigations. There will only be one (the initial load of the page); should we even fire this event in that case? (That's [#31](https://github.com/WICG/app-history/issues/31).) Could we give `startTime` a useful value there, if we do?_
_TODO: is this property-on-the-event design the right one, or should we integrate with the performance timeline APIs, or...? Discuss in [#33](https://github.com/WICG/app-history/issues/33)._
_TODO: Add a non-analytics examples, similar to how people use `popstate` today._
Expand Down Expand Up @@ -819,6 +823,7 @@ This proposal is based on [an earlier revision](https://github.com/slightlyoff/h
Thanks also to
[@chrishtr](https://github.com/chrishtr),
[@dvoytenko](https://github.com/dvoytenko),
[@esprehn](https://github.com/esprehn),
[@housseindjirdeh](https://github.com/housseindjirdeh),
[@jakearchibald](https://github.com/jakearchibald),
[@matt-buland-sfdc](https://github.com/matt-buland-sfdc),
Expand Down Expand Up @@ -976,10 +981,10 @@ dictionary AppHistoryUpcomingNavigateEventInit : EventInit {
interface AppHistoryCurrentEntryChangeEvent : Event {
constructor(DOMString type, optional AppHistoryCurrentEntryChangeEventInit eventInit = {});
readonly attribute DOMHighResTimeStamp? navigationStartTimeStamp;
readonly attribute DOMHighResTimeStamp? startTime;
};
dictionary AppHistoryCurrentEntryChangeEventInit : EventInit {
DOMHighResTimeStamp? navigationStartTimeStamp = null;
DOMHighResTimeStamp? startTime = null;
};
```

0 comments on commit 5cefb71

Please sign in to comment.