-
Notifications
You must be signed in to change notification settings - Fork 993
fix(firestore): use Firestore instead of FirebaseFirestore in error messages #9435
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
base: main
Are you sure you want to change the base?
Conversation
|
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @atharv290, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the clarity and consistency of error messages within the Firestore Lite API. It updates specific error strings to reflect the current v9 modular API terminology, replacing an older type name with its contemporary equivalent. The primary goal is to improve the developer experience by ensuring error messages are aligned with the latest API standards, without introducing any functional changes to the system. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly updates error messages in the Firestore lite API to use Firestore instead of the legacy FirebaseFirestore name, which improves consistency with the v9 modular API. The changes in packages/firestore/src/lite-api/reference.ts are correct. However, it appears that related test cases were not updated, which will likely cause the test suite to fail. I've left specific comments with details.
| 'Expected first argument to doc() to be a CollectionReference, ' + | ||
| 'a DocumentReference or FirebaseFirestore' | ||
| 'a DocumentReference or Firestore' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This error message change is correct. However, it looks like the corresponding unit test in packages/firestore/test/lite/integration.test.ts (around line 292) that validates this error message has not been updated. This will cause the test to fail. Please update the test to expect 'Firestore' instead of 'FirebaseFirestore'.
| 'Expected first argument to collection() to be a CollectionReference, ' + | ||
| 'a DocumentReference or FirebaseFirestore' | ||
| 'a DocumentReference or Firestore' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While updating this error message, it would be a good opportunity to add a test case to packages/firestore/test/lite/integration.test.ts that validates this specific error for the collection() function. This would improve test coverage and ensure this error message is validated, similar to the existing test for doc().
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestion! I’ve updated the existing doc() test to expect
Firestore and added a corresponding test for collection() to improve
coverage. Please let me know if this looks good.
This PR updates Firestore lite API error messages to use the v9 modular API
type name
Firestoreinstead of the legacy v8 nameFirebaseFirestore.No behavior changes; string-only fix for consistency and clarity.
Fixes #9434