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

Jump to bottom

docs: deprecation guide for moving to firebase-js-sdk v9 modular API #8279

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

docs: deprecation guide for moving to firebase-js-sdk v9 modular API #8279

wants to merge 12 commits into from
+95 −8

Conversation

russellwheatley
Copy link
Member

Description

Related issues

Release Summary

Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
    • Yes
  • My change supports the following platforms;
    • Android
    • iOS
  • My change includes tests;
    • e2e tests added or updated in packages/\*\*/e2e
    • jest tests added or updated in packages/\*\*/__tests__
  • I have updated TypeScript types that are affected by my change.
  • This is a breaking change;
    • Yes
    • No

Test Plan

Think react-native-firebase is great? Please consider supporting the project with any of the below:

@vercel Vercel
Copy link

vercel bot commented Feb 6, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
react-native-firebase ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 11:14am

mikehardy
mikehardy reviewed Feb 6, 2025
View reviewed changes
docs/index.md Outdated
@@ -4,6 +4,9 @@ description: Welcome to React Native Firebase! To get started, you must first se
next: /typescript
---

> React Native Firebase has begun to deprecate the namespaced API (i.e firebase-js-sdk `< v9` chaining API). React Native Firebase will be moving to the modular API (i.e. firebase-js-sdk `>= v9`) in the next major release. See [migration guide]() for more information.
Copy link
Collaborator

@mikehardy mikehardy Feb 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

everything looks beautiful except the guide isn't hooked up to the URL here and the prev/next links need rearrange, you probably know that
only commenting to say this all looks like a +1 from me otherwise, even though it's draft at moment

@mikehardy
Copy link
Collaborator

Feedback from a user:

Also the current warning messages is not so clear, it talks about v8 methods vs v9 methods while RNFB is currently on v21. Thats the reason I originally thought it was a firebase web sdk dependency bug instead of a RNFB api change.

The deprecation message should connect any mention of v8/v9 explicitly to firebase-js-sdk, maybe should have a link to the migration guide as well ?

@russellwheatley
Copy link
Member Author

@mikehardy - I've made some updates.

  • updated links in migration guide.
  • fleshed out the migration guide with more information for user.
  • provided link to migration guide in the deprecation console warning.

@russellwheatley russellwheatley marked this pull request as ready for review February 7, 2025 11:14
@russellwheatley russellwheatley changed the title docs: deprecation guide for moving to v9 modular API docs: deprecation guide for moving to firebase-js-sdk v9 modular API Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mikehardy mikehardy mikehardy left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
Needs Attention
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@russellwheatley @mikehardy