Split `waitingDuration` to make it easier to understand redirect delays #458

tunetheweb · 2024-04-03T13:35:12Z

Fixes #395

This splits waitingDuration (formerly known as waitingTime in v3) into two:

waitingDuration - which the time until (workerStart or fetchStart). This will mostly be redirect time but I've avoided explicitly calling that as redirectStart/End can't be used and it's easy to see when testing instances where looking at workerStart or fetchStart still leaves a non-0 amount of time that is not redirects.
cacheDuration which is the time from then until domainLookupStart. This will mostly be HTTP cache time, except for service-worker controlled sites when it will be service worker time.

See PerformanceNavigationTiming breakdown for more context:

As part of this I've also moved any delays between connectEnd and requestStart from being attributed to connectionDuration (i.e before the delay) to requestDuration (i.e after the delay). This helps avoiding attributing this delay to connectionDuration for service-worker controlled sites when this should be 0, but without adding an extra breakdown that would not be that useful.

README.md

docs/upgrading-to-v4.md

src/attribution/onTTFB.ts

test/e2e/onTTFB-test.js

src/types/ttfb.ts

src/attribution/onTTFB.ts

##### [`v4.2.3](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v423-2024-08-06) - Fix missing LoAF entries in INP attribution ([#512](GoogleChrome/web-vitals#512)) ##### [`v4.2.2](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v422-2024-07-17) - Fix interaction count after bfcache restore ([#505](GoogleChrome/web-vitals#505)) ##### [`v4.2.1](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v421-2024-06-30) - Fix compatibility issues with TypeScript v5.5 ([#497](GoogleChrome/web-vitals#497)) ##### [`v4.2.0](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v420-2024-06-20) - Refactor INP attribution code to fix errors on Windows 10 ([#495](GoogleChrome/web-vitals#495)) ##### [`v4.1.1](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v411-2024-06-10) - Fix pending LoAF cleanup logic ([#493](GoogleChrome/web-vitals#493)) ##### [`v4.1.0](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v410-2024-06-06) - Move the support check to the top of the onINP() function ([#490](GoogleChrome/web-vitals#490)) - Fix missing LoAF attribution when entries are dispatched before event entries ([#487](GoogleChrome/web-vitals#487)) ##### [`v4.0.1](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v401-2024-05-21) - Add the `ReportCallback` type back but deprecate it ([#483](GoogleChrome/web-vitals#483)) ##### [`v4.0.0](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v400-2024-05-13) - **\[BREAKING]** Update types to support more generic usage ([#471](GoogleChrome/web-vitals#471)) - **\[BREAKING]** Split `waitingDuration` to make it easier to understand redirect delays ([#458](GoogleChrome/web-vitals#458)) - **\[BREAKING]** Rename `TTFBAttribution` fields from `*Time` to `*Duration` ([#453](GoogleChrome/web-vitals#453)) - **\[BREAKING]** Rename `resourceLoadTime` to `resourceLoadDuration` in LCP attribution ([#450](GoogleChrome/web-vitals#450)) - **\[BREAKING]** Add INP breakdown timings and LoAF attribution ([#442](GoogleChrome/web-vitals#442)) - **\[BREAKING]** Deprecate `onFID()` and remove previously deprecated APIs ([#435](GoogleChrome/web-vitals#435)) - Expose the target element in INP attribution ([#479](GoogleChrome/web-vitals#479)) - Save INP target after interactions to reduce null values when removed from the DOM ([#477](GoogleChrome/web-vitals#477)) - Cap TTFB in attribution ([#440](GoogleChrome/web-vitals#440)) - Fix `reportAllChanges` behavior for LCP when library is loaded late ([#468](GoogleChrome/web-vitals#468)) ##### [`v3.5.2](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v352-2024-01-25) - Pick the first non-null `target` for INP attribution ([#421](GoogleChrome/web-vitals#421)) ##### [`v3.5.1](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v351-2023-12-27) - Add extra guard for `PerformanceEventTiming` not existing ([#403](GoogleChrome/web-vitals#403)) ##### [`v3.5.0](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v350-2023-09-28) - Run `onLCP` callback in separate task ([#386](GoogleChrome/web-vitals#386)) - Fix INP durationThreshold bug when set to 0 ([#372](GoogleChrome/web-vitals#372)) - Prevent FID entries being emitted as INP for non-supporting browsers ([#368](GoogleChrome/web-vitals#368)) ##### [`v3.4.0](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v340-2023-07-11) - Make `bindReporter` generic over metric type ([#359](GoogleChrome/web-vitals#359)) - Update INP status in README ([#362](GoogleChrome/web-vitals#362)) - Fix Metric types for better TypeScript support ([#356](GoogleChrome/web-vitals#356)) - Fix selector for SVGs for attribution build ([#354](GoogleChrome/web-vitals#354)) ##### [`v3.3.2](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v332-2023-05-29) - Fix attribution types ([#348](GoogleChrome/web-vitals#348)) - Safe access navigation entry type ([#290](GoogleChrome/web-vitals#290)) ##### [`v3.3.1](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v331-2023-04-04) - Export metric rating thresholds in attribution build as well. ##### [`v3.3.0](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v330-2023-03-09) - Export metric rating thresholds, add explicit `MetricRatingThresholds` type ([#323](GoogleChrome/web-vitals#323)) - Trim classname selector ([#328](GoogleChrome/web-vitals#328)) - Add link to CrUX versus RUM blog post ([#327](GoogleChrome/web-vitals#327)) - Prevent LCP being reported for hidden prerendered pages ([#326](GoogleChrome/web-vitals#326)) - Add Server Timing information to docs ([#324](GoogleChrome/web-vitals#324)) - Fix link in `onINP()` thresholds comment ([#318](GoogleChrome/web-vitals#318)) - Update web.dev link for `onINP()` ([#307](GoogleChrome/web-vitals#307)) - Add a note about when to load the library ([#305](GoogleChrome/web-vitals#305)) ##### [`v3.1.1](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v311-2023-01-10) - Defer CLS logic until after `onFCP()` callback ([#297](GoogleChrome/web-vitals#297)) ##### [`v3.1.0](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v310-2022-11-15) - Add support for `'restore'` as a `navigationType` ([#284](GoogleChrome/web-vitals#284)) - Report initial CLS value when `reportAllChanges` is true ([#283](GoogleChrome/web-vitals#283)) - Defer all observers until after activation ([#282](GoogleChrome/web-vitals#282)) - Ignore TTFB for loads where responseStart is zero ([#281](GoogleChrome/web-vitals#281)) - Defer execution of observer callbacks ([#278](GoogleChrome/web-vitals#278)) ##### [`v3.0.4](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v304-2022-10-18) - Clamp LCP and FCP to 0 for prerendered pages ([#270](GoogleChrome/web-vitals#270)) ##### [`v3.0.3](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v303-2022-10-04) - Ensure `attribution` object is always present in attribution build ([#265](GoogleChrome/web-vitals#265)) ##### [`v3.0.2](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v302-2022-09-14) - Set an explicit unpkg dist file ([#261](GoogleChrome/web-vitals#261)) ##### [`v3.0.1](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v301-2022-08-31) - Use the cjs extension for all UMD builds ([#257](GoogleChrome/web-vitals#257)) ##### [`v3.0.0](https://github.com/GoogleChrome/web-vitals/blob/HEAD/CHANGELOG.md#v300-2022-08-24) - **\[BREAKING]** Add a config object param to all metric functions ([#225](GoogleChrome/web-vitals#225)) - **\[BREAKING]** Report TTFB after a bfcache restore ([#220](GoogleChrome/web-vitals#220)) - **\[BREAKING]** Only include last LCP entry in metric entries ([#218](GoogleChrome/web-vitals#218)) - Update the metric ID prefix for v3 ([#251](GoogleChrome/web-vitals#251)) - Move the Navigation Timing API polyfill to the base+polyfill build ([#248](GoogleChrome/web-vitals#248)) - Add a metric rating property ([#246](GoogleChrome/web-vitals#246)) - Add deprecation notices for base+polyfill builds ([#242](GoogleChrome/web-vitals#242)) - Add a new attribution build for debugging issues in the field ([#237](GoogleChrome/web-vitals#237), [#244](GoogleChrome/web-vitals#244)) - Add support for prerendered pages ([#233](GoogleChrome/web-vitals#233)) - Rename the `ReportHandler` type to `ReportCallback`, with alias for back-compat ([#225](GoogleChrome/web-vitals#225), [#227](GoogleChrome/web-vitals#227)) - Add support for the new INP metric ([#221](GoogleChrome/web-vitals#221), [#232](GoogleChrome/web-vitals#232)) - Rename `getXXX()` functions to `onXXX()` ([#222](GoogleChrome/web-vitals#222)) - Add a `navigationType` property to the Metric object ([#219](GoogleChrome/web-vitals#219))

tunetheweb added 4 commits April 3, 2024 12:59

Add redirect time

995dea2

Fix unit tests

24c01b3

Clean up old code

c514892

Fix tests

36d9981

tunetheweb requested a review from philipwalton April 3, 2024 13:35

tunetheweb added 4 commits April 4, 2024 00:09

globalThis better fix

eeb3fc3

Merge branch 'v4' into redirect-duration

efe1b30

Add TTFB PR

42957c8

PR number

f88e069

philipwalton requested changes Apr 4, 2024

View reviewed changes

philipwalton reviewed Apr 4, 2024

View reviewed changes

src/types/ttfb.ts Outdated Show resolved Hide resolved

Review feedback

7345b20

tunetheweb requested a review from philipwalton April 4, 2024 06:29

tunetheweb and others added 14 commits April 4, 2024 07:37

aMore feedback

98756db

Remove changelog

ee7c8f5

Remove redirectEnd

a3891ad

Language tweaks

18ed6cd

Merge branch 'v4' into redirect-duration

3b3a452

Update TTFB breakdown

501fa4e

Simplify TTFB attribution to 4 breakdowns

8517801

Revert some changes

a76122a

Clean up

9163ce0

More cleanup

ab8d979

Revert some more changes

93c698a

more reverts to make PR cleaner

5c1fd8d

Space

8e0ede2

Move to wait end

ecd4dca

tunetheweb changed the title ~~Redirect duration~~ Split waitingDuration to make it easier to understand redirect delays Apr 12, 2024

tunetheweb changed the title ~~Split waitingDuration to make it easier to understand redirect delays~~ Split waitingDuration to make it easier to understand redirect delays Apr 12, 2024

More fixes

4c6f60f

tunetheweb added 2 commits April 12, 2024 15:36

Typo

25c29bd

Fix test

2aff58b

philipwalton requested changes Apr 12, 2024

View reviewed changes

src/attribution/onTTFB.ts Outdated Show resolved Hide resolved

src/attribution/onTTFB.ts Show resolved Hide resolved

Remove unnecessary check

d2fb0ae

philipwalton mentioned this pull request Apr 12, 2024

Timing values are inconsistent across browsers when page is controlled by service worker w3c/navigation-timing#199

Open

Update timing comments

51213c2

philipwalton approved these changes Apr 12, 2024

View reviewed changes

Fix typo

8436f53

philipwalton merged commit da10e5a into v4 Apr 12, 2024
6 checks passed

philipwalton deleted the redirect-duration branch April 12, 2024 23:12

tunetheweb mentioned this pull request Apr 13, 2024

Add redirect time to TTFB breakdown #395

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split `waitingDuration` to make it easier to understand redirect delays #458

Split `waitingDuration` to make it easier to understand redirect delays #458

tunetheweb commented Apr 3, 2024 •

edited

Loading

Split waitingDuration to make it easier to understand redirect delays #458

Split waitingDuration to make it easier to understand redirect delays #458

Conversation

tunetheweb commented Apr 3, 2024 • edited Loading

Split `waitingDuration` to make it easier to understand redirect delays #458

Split `waitingDuration` to make it easier to understand redirect delays #458

tunetheweb commented Apr 3, 2024 •

edited

Loading