refactor(sources/firestore): move source implementation in Invoke() function into Source

[Yuan325]

Move source-related queries from Invoke() function into Source.

This is an effort to generalizing tools to work with any Source that implements a specific interface. This will provide a better segregation of the roles for Tools vs Source.

Tool's role will be limited to the following:

• Resolve any pre-implementation steps or parameters (e.g. template parameters)
• Retrieving Source
• Calling the source's implementation

[gemini-code-assist]

Summary of Changes

Hello @Yuan325, I'm Gemini Code Assist¹! 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 undertakes a significant architectural refactoring of the Firestore integration. By centralizing all Firestore-specific operational logic within the Source component, the change aims to create a more modular and maintainable codebase. This approach ensures that individual tools are lightweight and focused solely on orchestrating requests and parameters, while the Source handles the complexities of interacting with the Firestore API, thereby promoting a cleaner separation of responsibilities and enhancing the system's extensibility.

Highlights

• Refactoring of Firestore Logic: Moved all Firestore-related query building, execution, and data manipulation logic from individual tool Invoke() functions into the Source struct within internal/sources/firestore/firestore.go. This centralizes the core Firestore operations.
• Clearer Separation of Concerns: The refactoring aims to generalize tools to work with any Source implementing a specific interface, ensuring a better segregation of roles. Tools are now limited to resolving parameters, retrieving the Source, and calling its implementation.
• New Source Methods: Introduced several new methods to the Source struct, including FirestoreValueToJSON, BuildQuery, ExecuteQuery, GetDocuments, AddDocuments, UpdateDocument, DeleteDocuments, ListCollections, GetRules, and ValidateRules, encapsulating all major Firestore interactions.
• Simplified Tool Invoke() Functions: The Invoke() methods across various Firestore tools (e.g., firestoreadddocuments, firestorequery, firestorevalidaterules) have been significantly simplified, now primarily calling the corresponding methods on the Source interface.
• Updated Interfaces and Data Structures: The compatibleSource interfaces in each tool's package have been updated to reflect the new methods available on the Source. Related data structures like QueryResult, QueryResponse, Issue, and ValidationResult have been moved to the internal/sources/firestore package.

🧠 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 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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request refactors Firestore operations by centralizing common logic into the internal/sources/firestore/firestore.go file. Key changes include introducing a FirestoreValueToJSON helper for consistent JSON serialization of Firestore types, and new methods like BuildQuery, ExecuteQuery, GetDocuments, AddDocuments, UpdateDocument, DeleteDocuments, ListCollections, GetRules, and ValidateRules within the Source struct. The FirestoreValueToJSON function handles time.Time, latlng.LatLng, []byte, and *firestore.DocumentRef conversions. Consequently, various Firestore tool implementations (firestoreadddocuments, firestoredeletedocuments, firestoregetdocuments, firestoregetrules, firestorelistcollections, firestorequery, firestorequerycollection, firestoreupdatedocument, firestorevalidaterules) were updated to delegate their core logic to these new Source methods, simplifying their Invoke functions and compatibleSource interfaces. Additionally, the firestore_test.go file was updated to include a test for FirestoreValueToJSON and to use any instead of interface{} for consistency. Review comments highlighted potential nil pointer dereferences in firestorequery and firestorequerycollection when handling orderBy parameters, and recommended using FirestoreValueToJSON for all document data and timestamp fields in ExecuteQuery, GetDocuments, and AddDocuments for proper JSON serialization and to ensure returned data reflects the actual state in Firestore.