Super early dataconnect-basics skill draft #9822
Conversation
Summary of ChangesHello @joehan, 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 introduces a foundational skill guide for Firebase Data Connect, designed to equip developers with the necessary knowledge to provision services, define schemas, write GraphQL operations, and generate typed SDKs. It provides a structured approach to understanding and implementing Data Connect, complete with configuration examples and practical GraphQL query, mutation, and schema definitions. 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
|
![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 a new 'skill' for Firebase Data Connect, including a comprehensive guide and several GraphQL examples. The documentation is a good start, but has a minor ambiguity. The main issue is in mutations_example.gql, which contains several GraphQL syntax errors due to incorrect use of commas in input objects. These are critical issues that will prevent the mutations from being parsed correctly. I've provided suggestions to fix these syntax errors. There's also a minor point about the potentially unnecessary use of insecureReason.
| # Create a movie based on user input | ||
| mutation CreateMovie($title: String!, $genre: String!, $imageUrl: String!) | ||
| @auth(level: USER_EMAIL_VERIFIED, insecureReason: "Any email verified users can create a new movie.") { | ||
| movie_insert(data: { title: $title, genre: $genre, imageUrl: $imageUrl }) |
There was a problem hiding this comment.
The data object for the movie_insert mutation has incorrect GraphQL syntax. Fields within an input object should not be separated by commas. This will cause a parsing error.
movie_insert(data: { title: $title genre: $genre imageUrl: $imageUrl })
| # Upsert (update or insert) a user's username based on their auth.uid | ||
| mutation UpsertUser($username: String!) @auth(level: USER) { | ||
| # The "auth.uid" server value ensures that users can only register their own user. | ||
| user_upsert(data: { id_expr: "auth.uid", username: $username }) |
There was a problem hiding this comment.
The data object for the user_upsert mutation has incorrect GraphQL syntax. Fields within an input object should not be separated by commas. This will cause a parsing error.
user_upsert(data: { id_expr: "auth.uid" username: $username })
| # Logged in user can delete their review for a movie | ||
| mutation DeleteReview($movieId: UUID!) @auth(level: USER) { | ||
| # The "auth.uid" server value ensures that users can only delete their own reviews. | ||
| review_delete(key: { userId_expr: "auth.uid", movieId: $movieId }) |
There was a problem hiding this comment.
The key object for the review_delete mutation has incorrect GraphQL syntax. Fields within an input object should not be separated by commas. This will cause a parsing error.
review_delete(key: { userId_expr: "auth.uid" movieId: $movieId })
| * **@auth(level: ...)**: Controls access level. | ||
| * `PUBLIC`: Accessible by anyone (requires `insecureReason`). | ||
| * `USER`: Accessible by any authenticated user. | ||
| * `USER_EMAIL_VERIFIED`: Accessible by potential verified users. |
There was a problem hiding this comment.
The description for USER_EMAIL_VERIFIED is a bit ambiguous. "potential verified users" could be misinterpreted. It would be clearer to state that it's for users who have a verified email.
| * `USER_EMAIL_VERIFIED`: Accessible by potential verified users. | |
| * `USER_EMAIL_VERIFIED`: Accessible by users with a verified email. |
|
|
||
| # Create a movie based on user input | ||
| mutation CreateMovie($title: String!, $genre: String!, $imageUrl: String!) | ||
| @auth(level: USER_EMAIL_VERIFIED, insecureReason: "Any email verified users can create a new movie.") { |
There was a problem hiding this comment.
The @auth directive for USER_EMAIL_VERIFIED probably doesn't require an insecureReason. According to the documentation in SKILL.md, only the PUBLIC level requires it. Including it here can be confusing and might imply the operation is less secure than it is.
@auth(level: USER_EMAIL_VERIFIED) {
1 participant
Super early unpolished draft of the data connect skill.