web-vitals

A modular library for measuring the Web Vitals metrics on real users.

This was vendored from: https://github.com/GoogleChrome/web-vitals: v5.1.0

The commit SHA used is: e22d23b22c1440e69c5fc25a2f373b1a425cc940

Current vendored web vitals are:

• LCP (Largest Contentful Paint)
• FID (First Input Delay)
• CLS (Cumulative Layout Shift)
• INP (Interaction to Next Paint)
• TTFB (Time to First Byte)

Notable Changes from web-vitals library

This vendored web-vitals library is meant to be used in conjunction with the @sentry/browser browserTracingIntegration. As such, logic around BFCache and multiple reports were removed from the library as our web-vitals only report once per pageload.

License

Apache 2.0

CHANGELOG

• Bumped from Web Vitals 5.0.2 to 5.1.0
  • Remove visibilitychange event listeners when no longer required #627
  • Register visibility-change early #637
  • Only finalize LCP on user events (isTrusted=true) #635
  • Fallback to default getSelector if custom function is null or undefined #634

https://github.com/getsentry/sentry-javascript/pull/17076

• Removed FID-related code with v10 of the SDK

https://github.com/getsentry/sentry-javascript/pull/16492

• Bumped from Web Vitals 4.2.5 to 5.0.2
  • Mainly fixes some INP, LCP and FCP edge cases
  • Original library removed FID; we still keep it around for now

https://github.com/getsentry/sentry-javascript/pull/14439

• Bumped from Web Vitals v3.5.2 to v4.2.4

https://github.com/getsentry/sentry-javascript/pull/11391

• Bumped from Web Vitals v3.0.4 to v3.5.2

https://github.com/getsentry/sentry-javascript/pull/5987

• Bumped from Web Vitals v2.1.0 to v3.0.4

https://github.com/getsentry/sentry-javascript/pull/3781

• Bumped from Web Vitals v0.2.4 to v2.1.0

https://github.com/getsentry/sentry-javascript/pull/3515

• Remove support for Time to First Byte (TTFB)

https://github.com/getsentry/sentry-javascript/pull/2964

• Added support for Cumulative Layout Shift (CLS) and Time to First Byte (TTFB)

https://github.com/getsentry/sentry-javascript/pull/2909

• Added support for FID (First Input Delay) and LCP (Largest Contentful Paint)

https://github.com/getsentry/sentry-javascript/pull/9690

• Added support for INP (Interaction to Next Paint)

TODO

• Add support for TTFB (Time to First Byte)