Better type checking. #541
Conversation
Summary of ChangesHello @MapleSyrupy, 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 data integrity and user experience by introducing robust validation for student names and grades. It ensures that all student data adheres to predefined formats and ranges, both at the API level and directly within the user interface. This prevents invalid data from entering the system and provides immediate feedback to users. Additionally, a new 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 input validation for student names and grades, both on the backend and client-side, which is a great improvement for data integrity. My review focuses on ensuring consistency and correctness of these new validation rules. I've found a few inconsistencies in the grade validation range between the implementation and the PR description. Additionally, there are some opportunities to improve error handling and feedback on the client-side for a better user experience. I've also pointed out a couple of minor issues in the React components and Storybook files.
| clearTimeout(timeoutId); | ||
| } | ||
| }; | ||
| }, [student, setBreadcrumbs, formError]); |
There was a problem hiding this comment.
The dependency array for this useEffect includes student and setBreadcrumbs, which are not used inside the effect. This can cause the timeout to be reset unnecessarily. The effect should only run when formError changes.
| }, [student, setBreadcrumbs, formError]); | |
| }, [formError]); |
| first_name: data.get("firstName") as string, | ||
| last_name: data.get("lastName") as string, | ||
| email: (data.get("email") as string) || null, | ||
| grade: Number(data.get("grade")) || 0, |
There was a problem hiding this comment.
The || 0 is redundant here. The zod schema validation on line 135 already ensures that grade is a number greater than or equal to 1. If the validation passes, Number(data.get("grade")) will be a valid number, so the fallback to 0 is unnecessary and could be confusing.
| grade: Number(data.get("grade")) || 0, | |
| grade: Number(data.get("grade")), |
|
Error handling is a bit of a mess with this PR, but I don't think that is the main focus of the issue, so it's more of a stopgap measure. |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Teachers can no longer set grade to less than 1 or more than 13, and also cannot use special characters (or number) for names, unless its a dash.