Prod 1: 추천인 기능 배포 #79
Conversation
MOSU-69 feat: 추천인 API 구현
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @wlgns12370, 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 new "recommender" feature, allowing users to register and verify a recommender's phone number. This involved implementing new business logic, API endpoints, and refactoring the data model to store recommender information directly within the user's profile. Additionally, the PR updates the application's CORS configuration to enable necessary cross-origin requests for API integration and includes a new initializer for development data.
Highlights
- Recommender Feature Implementation: New service (
RecommenderService) and controller (RecommenderController) have been introduced to support the registration and verification of recommender phone numbers for user profiles. - Data Model Refactoring: The
recommenderPhoneNumberfield has been moved fromApplicationJpaEntitytoProfileJpaEntity, centralizing recommender information with user profiles and removing it from application requests. - CORS Configuration Update: Custom CORS rules have been implemented in
WebMvcConfigto allow specific origins, enabling proper API integration, while Spring Security's default CORS handling has been disabled to defer to this custom configuration. - Error Handling & Initialization: A new error code (
ALREADY_REGISTERED_RECOMMENDER) was added to handle re-registration attempts, and aUserAndProfileInitializerwas created to populate dummy data, including pre-registered recommenders for development.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
The pull request introduces the recommender feature. The code is well-structured. The review focuses on security, configuration management, and code quality. Key points include a security concern with the CORS configuration, and suggestions for improving API design consistency and externalizing configuration.
| @Column(name = "agreed_to_notices") | ||
| private Boolean agreedToNotices; | ||
|
|
||
| @Column(name = "agreed_to_refund_policy") | ||
| private Boolean agreedToRefundPolicy; |
There was a problem hiding this comment.
The removal of recommenderPhoneNumber from ApplicationJpaEntity seems correct given the new design. Ensure that all references to this field have been removed or updated in other parts of the application to avoid potential NullPointerException or unexpected behavior.
| http.csrf(AbstractHttpConfigurer::disable) | ||
| .cors(Customizer.withDefaults()) | ||
| // .cors(Customizer.withDefaults()) | ||
| .cors(AbstractHttpConfigurer::disable) |
There was a problem hiding this comment.
Disabling CORS completely (.cors(AbstractHttpConfigurer::disable)) is generally not recommended as it opens up the application to potential security vulnerabilities. It's better to configure CORS properly to allow only specific origins. If CORS is intended to be disabled temporarily, add a comment explaining the reason and a reminder to re-enable it with proper configuration.
// TODO: Re-enable CORS with proper configuration before deploying to production
// http.cors(Customizer.withDefaults());
http.cors(AbstractHttpConfigurer::disable);| if (profile.getRecommenderPhoneNumber() != null) { | ||
| throw new CustomRuntimeException(ErrorCode.ALREADY_REGISTERED_RECOMMENDER); | ||
| } |
There was a problem hiding this comment.
Consider throwing a more specific exception or creating a custom exception to better reflect the business logic. This can improve error handling and provide more context to the caller.
| if (profile.getRecommenderPhoneNumber() != null) { | |
| throw new CustomRuntimeException(ErrorCode.ALREADY_REGISTERED_RECOMMENDER); | |
| } | |
| if (profile.getRecommenderPhoneNumber() != null) { | |
| throw new AlreadyRegisteredRecommenderException("Recommender already registered for this profile."); | |
| } |
| registry.addMapping("/**") | ||
| .allowedMethods("GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS") | ||
| .allowedHeaders("*") | ||
| .allowedOrigins("http://localhost:3000", "http://localhost:8080", | ||
| "http://api.mosuedu.com", "https://api.mosuedu.com") | ||
| .allowCredentials(true) |
There was a problem hiding this comment.
Consider using environment variables or configuration properties to manage the allowed origins instead of hardcoding them. This allows for easier configuration changes without requiring code deployments. For example, you can define a property cors.allowed-origins in application.properties and inject it into the WebMvcConfig class.
String[] allowedOrigins = {"http://localhost:3000", "http://localhost:8080",
"http://api.mosuedu.com", "https://api.mosuedu.com"};
registry.addMapping("/**")
.allowedMethods("GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS")
.allowedHeaders("*")
.allowedOrigins(allowedOrigins)
.allowCredentials(true)
.maxAge(3600);| Grade grade = Grade.values()[random.nextInt(Grade.values().length)]; | ||
| SchoolInfoJpaVO schoolInfo = new SchoolInfoJpaVO(("모수대학교" + (i % 3 + 1)), "123-23", | ||
| "서울시 모수구 모수동"); | ||
| String recommenderPhoneNumber = (i % 3 == 0) ? "010-1234-5678" : null; |
There was a problem hiding this comment.
The recommenderPhoneNumber is hardcoded with a default value. Consider making this configurable or removing it entirely from the initializer if it's not essential for dummy data.
✨ 구현한 기능
📢 논의하고 싶은 내용
🎸 기타