chore: add demo- to emulator project names #207
Conversation
| To view this pull requests documentation preview, visit the following URL: docs.page/invertase/tanstack-query-firebase~207 Documentation is deployed and generated using docs.page. |
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @cabljac, 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 standardizes the project ID used for Firebase emulators across the codebase by renaming instances of test-project to demo-test-project. This change ensures consistency in how various development and testing scripts interact with the local Firebase emulator suite. Additionally, it introduces a new Firebase initialization file for a React example, facilitating easier setup and connection to these emulators.
Highlights
- Standardized Emulator Project ID: The project ID used for Firebase emulators has been consistently updated from
test-projecttodemo-test-projectacross all relevant configurations and scripts. - New Firebase Initialization for React Example: A new
firebase.tsfile was introduced in theexamples/react/kitchen-sinkdirectory to handle Firebase initialization and automatic connection to local Auth and Firestore emulators during development. - Updated Emulator Scripts: Various
package.jsonscripts, includingtest:emulatorandemulatorin the root, anddev:emulatorinexamples/react/useGetIdTokenQuery, were modified to correctly reference the newdemo-test-projectID. - Updated Vitest Utilities: The Vitest testing utilities were updated to ensure that Firebase emulator interactions, such as
projectIdand data wiping operations, correctly target thedemo-test-project.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review | Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary | Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help | Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request consistently renames the emulator project ID from test-project to demo-test-project across various configuration files and source code. The changes are straightforward and achieve the goal stated in the title.
I've added a couple of suggestions in packages/react/vitest/utils.ts to improve maintainability by removing hardcoded project IDs within that file.
For future consideration, you might want to centralize the project ID and other emulator configurations to avoid duplication across the entire repository. This could be done using environment variables or a shared constants package.
| const response = await fetch( | ||
| "http://localhost:8080/emulator/v1/projects/test-project/databases/(default)/documents", | ||
| "http://localhost:8080/emulator/v1/projects/demo-test-project/databases/(default)/documents", | ||
| { | ||
| method: "DELETE", | ||
| }, |
There was a problem hiding this comment.
To improve maintainability and avoid hardcoding the project ID in multiple places within this file, you can use the projectId from the firebaseTestingOptions constant. This ensures that if the project ID changes in the future, you only need to update it in one place.
| const response = await fetch( | |
| "http://localhost:8080/emulator/v1/projects/test-project/databases/(default)/documents", | |
| "http://localhost:8080/emulator/v1/projects/demo-test-project/databases/(default)/documents", | |
| { | |
| method: "DELETE", | |
| }, | |
| const response = await fetch( | |
| `http://localhost:8080/emulator/v1/projects/${firebaseTestingOptions.projectId}/databases/(default)/documents`, | |
| { | |
| method: "DELETE", | |
| }, |
| const response = await fetch( | ||
| "http://localhost:9099/emulator/v1/projects/test-project/accounts", | ||
| "http://localhost:9099/emulator/v1/projects/demo-test-project/accounts", | ||
| { | ||
| method: "DELETE", | ||
| }, |
There was a problem hiding this comment.
Similar to the wipeFirestore function, you can use the projectId from firebaseTestingOptions here to avoid hardcoding and improve maintainability.
| const response = await fetch( | |
| "http://localhost:9099/emulator/v1/projects/test-project/accounts", | |
| "http://localhost:9099/emulator/v1/projects/demo-test-project/accounts", | |
| { | |
| method: "DELETE", | |
| }, | |
| const response = await fetch( | |
| `http://localhost:9099/emulator/v1/projects/${firebaseTestingOptions.projectId}/accounts`, | |
| { | |
| method: "DELETE", | |
| }, |
No description provided.