Fix a regression in v1 Firestore functions#1829
Conversation
…as a leading or trailing slash
Summary of ChangesHello, 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 addresses a regression in v1 Firestore functions where inconsistent document paths, specifically those with leading or trailing slashes, could lead to deployment and Terraform errors. The core change introduces a path normalization step for Firestore document paths, ensuring that all paths are consistently formatted before being used to construct trigger resources. This resolves potential issues and improves the robustness of Firestore function deployments. 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. Changelog
Activity
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 aims to fix a regression where leading or trailing slashes in Firestore document paths could cause issues. The approach is to normalize the path.
The implementation correctly fixes the issue for string literal paths, and a test case has been added to verify this. However, the fix does not work for parameterized paths (i.e., when an Expression<string> is passed). I've left a comment with a detailed explanation and a suggested change to handle this case more explicitly. I've also suggested adding a test case for parameterized paths to prevent future regressions.
| it("should normalize the document path", () => { | ||
| const resource = "projects/project1/databases/(default)/documents/users/{uid}"; | ||
| const cloudFunction = firestore.document("/users/{uid}/").onWrite(() => null); | ||
|
|
||
| expect(cloudFunction.__endpoint).to.deep.equal(expectedEndpoint(resource, "document.write")); | ||
| }); |
There was a problem hiding this comment.
This is a good test for string literal paths. To ensure complete coverage of the document function's path argument, it would be beneficial to add a test case for when path is an Expression<string> (e.g., a StringParam from firebase-functions/params). This would help verify the behavior for parameterized paths and catch issues like the one I mentioned in src/v1/providers/firestore.ts.
There was a problem hiding this comment.
Good call. Huge rabbit hole
3 participants
Leading or trailing slashes could cause double slashes causing potential deployment errors and definitely terraform errors.