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.

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

Deprecate onFID() and remove previously deprecated APIs #435

Merged
merged 7 commits into from
Mar 9, 2024

Conversation

tunetheweb
Copy link
Member

@tunetheweb tunetheweb commented Feb 28, 2024

Makes the following changes assumiong the next release after this merge is a major version bump:

  • Removes old deprecated APIs (getXXX calls and ReportCallback)
  • Marks onFID as deprecated and to be removed in next major version
  • Removes polyfill base builds as per Consider deprecating base+polyfill due to complexity and misuse #238 (note this includes NavigationTimingPolyfillEntry)
  • Updates all examples in README from onFID to onINP
  • Updates INP to a CWV in README
  • Notes FID as deprecated in README

Notable it does NOT:

  • Remove the FID polyfill. It's need to emit a FID on bfcache restore as browser doesn't 😔
  • Console.warn on onFID use. As we're in a handover stage I think it's a little early for that. We can add that in a few months without a major release IMHO.
@tunetheweb
Copy link
Member Author

Test all now passing, but leaving this in draft until we're ready to merge, nearer 12th March. However I'm not planning on adding more to this PR so it is ready for review in the meantime.

@tunetheweb tunetheweb changed the title Deprecate FID and prep v4.0.0 Feb 29, 2024
Copy link
Member

@philipwalton philipwalton left a comment

Choose a reason for hiding this comment

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

Overall LGTM. I left a few suggestions in this PR. In addition, can you:

  • Create a v4 branch and update this PR's merge target to that (instead of main).
  • Remove references to the "base" script still in package.json (in "exports" and "files").
src/onFID.ts Outdated Show resolved Hide resolved
src/onFID.ts Outdated Show resolved Hide resolved
src/onFID.ts Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@tunetheweb tunetheweb changed the base branch from main to v4 February 29, 2024 18:45
@tunetheweb tunetheweb marked this pull request as ready for review February 29, 2024 18:50
Copy link
Member

@philipwalton philipwalton left a comment

Choose a reason for hiding this comment

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

Still need to remove references to the "base" script in package.json (in "exports" and "files").

@tunetheweb
Copy link
Member Author

Done!

@philipwalton philipwalton merged commit d5539ab into v4 Mar 9, 2024
2 checks passed
@philipwalton philipwalton deleted the deprectate-fid-readme branch March 9, 2024 06:10
@philipwalton philipwalton changed the title Deprecate FID and remove other deprecated APIs Mar 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants