Conversation
# Conflicts: # src/main/resources/application.yml
…y fields from user entities
…and adjust SQL schema
…vents, notices, and FAQs
MOSU-276 feat: flyway DB 마이그레이션
|
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 ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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 Flyway for robust database schema and data migration, moving away from Hibernate's ddl-auto for schema management. Concurrently, I've removed the entire 'Form' feature, streamlining the codebase by eliminating its associated components. I also refined the user entity by removing outdated consent fields and ensuring phone numbers are unique, alongside adjusting S3 key column definitions to support longer values.
Highlights
- Database Migration with Flyway: I have integrated Flyway for database migration management. This includes enabling Flyway in the
application-base.ymland settingddl-autotovalidateto ensure schema changes are handled by Flyway scripts. I also added initial schema (V1__init.sql) and data (V2__insert_data.sql) migration scripts. - Removal of Form Feature: I have completely removed the
Formfeature, including its service (FormService.java), JPA entity (FormJpaEntity.java), repository (FormJpaRepository.java), controller (FormController.java), controller documentation (FormControllerDocs.java), and all related DTOs (FormListResponse.java,FormResponse.java,RegisterFormRequest.java). This indicates that theFormfunctionality is no longer needed. - User Entity and Consent Field Updates: I updated the
UserJpaEntityto remove theagreedToTermsOfServiceandagreedToPrivacyPolicyfields, along with their usage in the constructor and related DTOs (OAuthUserPersistenceProcessor.java,ApplicationGuestRequest.java,SignUpAccountRequest.java). Additionally, I added a unique constraint to thephoneNumbercolumn inUserJpaEntity. - Database Column Definition Update for S3 Keys: I modified
FileMoveFailLog.javaandFileWithTime.javato explicitly define thes3Keycolumn asTEXTusing@Column(columnDefinition = "TEXT"). This change accommodates potentially longer S3 object keys.
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 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 or fill out our survey 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
This pull request successfully introduces Flyway for database schema management, which is a significant improvement for the project. The changes also include the removal of the 'Form' feature and updates to the user entity. My review focuses on improving the robustness and maintainability of the new migration scripts. I've identified a critical issue with schema inconsistency, a high-severity issue that could lead to runtime exceptions, and a couple of medium-severity suggestions for better schema design.
| INSERT INTO sa.exam (created_at, updated_at, detail, street, zipcode, area, capacity, deadline_time, | ||
| exam_date, exam_status, lunch_name, lunch_price, school_name, deleted) |
There was a problem hiding this comment.
This script uses a hardcoded schema prefix sa. (e.g., sa.exam), while the V1__init.sql script does not specify a schema. This can cause migration failures if the database connection's default schema is not sa. To ensure consistency and portability, please remove the sa. prefix from all table names in this script.
INSERT INTO exam (created_at, updated_at, detail, street, zipcode, area, capacity, deadline_time,
exam_date, exam_status, lunch_name, lunch_price, school_name, deleted)| birth date NULL, | ||
| phone_number VARCHAR(255) NULL, | ||
| customer_key VARCHAR(255) NULL, | ||
| agreed_to_marketing BIT(1) NULL, |
There was a problem hiding this comment.
The agreed_to_marketing column is defined as nullable (BIT(1) NULL), but the corresponding field agreedToMarketing in UserJpaEntity is a primitive boolean. This can cause a NullPointerException if a record with a null value for this column is loaded from the database. To prevent this, the column should be non-nullable.
It's recommended to either change the column to be NOT NULL with a default value, or change the field in UserJpaEntity to the wrapper type Boolean.
agreed_to_marketing BIT(1) NOT NULL DEFAULT 0,| created_at datetime NULL, | ||
| updated_at datetime NULL, | ||
| question VARCHAR(500) NOT NULL, | ||
| answer VARCHAR(255) NOT NULL, |
There was a problem hiding this comment.
The answer column in the faq table is defined as VARCHAR(255). Given that answers can be detailed and may include HTML formatting (as seen in V2__insert_data.sql), this length might be insufficient and could lead to data truncation in the future. It is recommended to use the TEXT data type for this column to allow for longer content, similar to how snapshot columns are defined in other tables.
answer TEXT NOT NULL,| ); | ||
|
|
||
| ALTER TABLE profile | ||
| ADD CONSTRAINT uc_25d92281884ae5fdff0d3ec10 UNIQUE (user_id); |
There was a problem hiding this comment.
The constraint name uc_25d92281884ae5fdff0d3ec10 is not descriptive and seems to be auto-generated. For better schema readability and maintainability, it's recommended to use meaningful constraint names. A good convention is uq_{table_name}_{column_name}.
ADD CONSTRAINT uq_profile_user_id UNIQUE (user_id);
✨ 구현한 기능
📢 논의하고 싶은 내용
🎸 기타