feat(firestore): Added Firestore Multi Database Support #733
Conversation
Summary of ChangesHello @jonathanedey, 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 significantly enhances the Firestore client by introducing support for multiple named databases. It provides a new API method, Highlights
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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces support for multiple Cloud Firestore databases by adding a new FirestoreWithDatabase function. The implementation is accompanied by comprehensive unit and integration tests. My feedback focuses on improving code maintainability by addressing code duplication and enhancing the robustness of the integration tests to ensure proper resource cleanup.
| if a.projectID == "" { | ||
| return nil, errors.New("project id is required to access Firestore") | ||
| } |
There was a problem hiding this comment.
This project ID check is duplicated from the Firestore() function. To improve maintainability and reduce code duplication, consider refactoring Firestore() to call FirestoreWithDatabase() with the default database ID. This would centralize the client creation logic and the project ID validation.
| if _, err := doc.Set(ctx, cityData); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| snap, err := doc.Get(ctx) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if !reflect.DeepEqual(snap.Data(), cityData) { | ||
| t.Errorf("Get() = %v; want %v", snap.Data(), cityData) | ||
| } | ||
| if _, err := doc.Delete(ctx); err != nil { | ||
| t.Fatal(err) | ||
| } |
There was a problem hiding this comment.
To ensure test resources are cleaned up even if assertions fail, it's better to use defer for the Delete operation. This prevents leaving orphaned documents in Firestore if the test fails midway. The defer should be placed after the document is successfully created.
if _, err := doc.Set(ctx, cityData); err != nil {
t.Fatal(err)
}
defer doc.Delete(ctx)
snap, err := doc.Get(ctx)
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual(snap.Data(), cityData) {
t.Errorf("Get() = %v; want %v", snap.Data(), cityData)
}| if _, err := doc.Set(ctx, cityData); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| snap, err := doc.Get(ctx) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if !reflect.DeepEqual(snap.Data(), cityData) { | ||
| t.Errorf("Get() = %v; want %v", snap.Data(), cityData) | ||
| } | ||
| if _, err := doc.Delete(ctx); err != nil { | ||
| t.Fatal(err) | ||
| } |
There was a problem hiding this comment.
To ensure test resources are cleaned up even if assertions fail, it's better to use defer for the Delete operation. This prevents leaving orphaned documents in Firestore if the test fails midway. The defer should be placed after the document is successfully created.
if _, err := doc.Set(ctx, cityData); err != nil {
t.Fatal(err)
}
defer doc.Delete(ctx)
snap, err := doc.Get(ctx)
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual(snap.Data(), cityData) {
t.Errorf("Get() = %v; want %v", snap.Data(), cityData)
}| if _, err := cityDoc.Set(ctx, cityData); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if _, err := movieDoc.Set(ctx, movieData); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| citySnap, err := cityDoc.Get(ctx) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| movieSnap, err := movieDoc.Get(ctx) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| if !reflect.DeepEqual(citySnap.Data(), cityData) { | ||
| t.Errorf("City Get() = %v; want %v", citySnap.Data(), cityData) | ||
| } | ||
| if !reflect.DeepEqual(movieSnap.Data(), movieData) { | ||
| t.Errorf("Movie Get() = %v; want %v", movieSnap.Data(), movieData) | ||
| } | ||
|
|
||
| if _, err := cityDoc.Delete(ctx); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if _, err := movieDoc.Delete(ctx); err != nil { | ||
| t.Fatal(err) | ||
| } |
There was a problem hiding this comment.
To ensure test resources are cleaned up even if assertions fail, it's better to use defer for the Delete operations. This prevents leaving orphaned documents in Firestore if the test fails midway. The defer should be placed after each document is successfully created.
if _, err := cityDoc.Set(ctx, cityData); err != nil {
t.Fatal(err)
}
defer cityDoc.Delete(ctx)
if _, err := movieDoc.Set(ctx, movieData); err != nil {
t.Fatal(err)
}
defer movieDoc.Delete(ctx)
citySnap, err := cityDoc.Get(ctx)
if err != nil {
t.Fatal(err)
}
movieSnap, err := movieDoc.Get(ctx)
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual(citySnap.Data(), cityData) {
t.Errorf("City Get() = %v; want %v", citySnap.Data(), cityData)
}
if !reflect.DeepEqual(movieSnap.Data(), movieData) {
t.Errorf("Movie Get() = %v; want %v", movieSnap.Data(), movieData)
}1 participant
RELEASE NOTE: Added support for multiple Cloud Firestore named databases.