Auth 패키지 리팩터링 (코드 스타일 수정)

[Do-oya]

📌 Issue

• closed Auth 패키지 리팩터링 #232

---

🧐 현재 상황

• SecurityConfig 설정 클래스 가독성이 떨어짐
• Auth 패키지내에 클래스들의 코드 정렬이 균일하지 않음

---

🎯 목표

• SecurityConfig 설정 클래스의 가독성 향상
• Auth 패키지내에 클래스들의 코드 포맷팅 균일

---

🛠 작업 내용

• 작업 할 내용을 입력해주세요.

• SecurityConfig 수정

• Auth 패키지내에 클래스들 코드 정렬

---

🚀 기타 사항

• 추가적인 내용을 작성해주세요.(참고 자료, 협업 내용)

Summary by CodeRabbit

• Refactor
  • Improved code formatting and readability across authentication-related classes, including consistent spacing, brace placement, and style adjustments.
  • Expanded and reorganized endpoint access rules for enhanced clarity in security configuration.
  • Updated method signature formatting for better code consistency.
• New Features
  • Introduced new abstract methods for extracting user ID and role in OAuth2 login success handling.

[coderabbitai]

Walkthrough

This change refactors the authentication package by applying consistent formatting, updating comments, and improving code readability across various classes. No logic or control flow has been altered, except for minor adjustments to abstract method declarations and endpoint access rules in the security configuration.

Changes

File(s)	Change Summary
.../auth/application/AbstractOAuth2LoginSuccessHandler.java	Added new abstract method getUserId(OAuth2User oAuth2User); added blank line for readability.
.../auth/application/AuthService.java	Reformatted lambda expressions and method calls for spacing and clarity; no logic changes.
.../auth/config/PasswordConfig.java	Moved method opening brace to a new line for consistent formatting.
.../auth/config/SecurityConfig.java	Refactored filterChain method for clarity; updated endpoint access rules; improved comments; removed unused imports.
.../auth/domain/LoginUser.java	Reformatted getId() method to multi-line with braces.
.../auth/dto/request/LoginRequest.java	Changed record declaration from compact to block form with empty braces.
.../auth/exception/CustomAccessDeniedHandler.java .../CustomAuthenticationEntryPoint.java	Added blank lines after field declarations for readability.
.../auth/filter/JwtAuthFilter.java	Applied consistent spacing and brace formatting throughout; no logic changes.
.../auth/presentation/AuthController.java	Added space in method signature for logout.
.../auth/util/CookieUtil.java	Added spaces in method signatures and control structures for standard formatting.
.../auth/util/JwtUtil.java	Enhanced formatting: added spaces, consistent brace placement, and improved code style.

Sequence Diagram(s)

Not applicable: All changes are related to formatting, comments, and minor refactoring without affecting control flow or introducing new features.

Assessment against linked issues

Objective	Addressed	Explanation
SecurityConfig comments updated, configuration and endpoint rules clarified (#232)	✅
Consistent code formatting and style in configuration and utility classes (#232)	✅
No logic or control flow changes except for formatting and comments as specified (#232)	✅

Poem

A hop and a skip through the code today,
With spaces and braces now neatly in play.
Comments are clearer, the style’s all aligned,
This bunny is proud of the polish you’ve signed!
🐇✨

“Format with care, let the logic stay true—
The auth package now shines, thanks to you!”

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 556c844 and f88c016.

📒 Files selected for processing (12)

• src/main/java/goorm/back/zo6/auth/application/AbstractOAuth2LoginSuccessHandler.java (1 hunks)
• src/main/java/goorm/back/zo6/auth/application/AuthService.java (1 hunks)
• src/main/java/goorm/back/zo6/auth/config/PasswordConfig.java (1 hunks)
• src/main/java/goorm/back/zo6/auth/config/SecurityConfig.java (2 hunks)
• src/main/java/goorm/back/zo6/auth/domain/LoginUser.java (1 hunks)
• src/main/java/goorm/back/zo6/auth/dto/request/LoginRequest.java (1 hunks)
• src/main/java/goorm/back/zo6/auth/exception/CustomAccessDeniedHandler.java (1 hunks)
• src/main/java/goorm/back/zo6/auth/exception/CustomAuthenticationEntryPoint.java (1 hunks)
• src/main/java/goorm/back/zo6/auth/filter/JwtAuthFilter.java (2 hunks)
• src/main/java/goorm/back/zo6/auth/presentation/AuthController.java (1 hunks)
• src/main/java/goorm/back/zo6/auth/util/CookieUtil.java (2 hunks)
• src/main/java/goorm/back/zo6/auth/util/JwtUtil.java (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build

🔇 Additional comments (32)

src/main/java/goorm/back/zo6/auth/config/PasswordConfig.java (1)

11-11: Consistent brace placement for method declaration
Moving the opening brace to its own line aligns with our coding style conventions and enhances readability without affecting behavior.

src/main/java/goorm/back/zo6/auth/exception/CustomAccessDeniedHandler.java (1)

18-19: Consistent formatting: blank line after field declaration
The inserted blank line after the objectMapper declaration enhances readability and aligns with the spacing in related exception handler classes.

src/main/java/goorm/back/zo6/auth/exception/CustomAuthenticationEntryPoint.java (1)

18-19: Consistent formatting: blank line after field declaration
Adding a blank line after the objectMapper field matches the style applied in CustomAccessDeniedHandler and maintains uniformity across exception handlers.

src/main/java/goorm/back/zo6/auth/util/CookieUtil.java (2)

19-27: Approve formatting enhancement in deleteCookie method
The blank line before the deleteCookie declaration and consistent indentation adheres to the project’s code style guidelines without affecting functionality.

---

29-43: Approve formatting consistency in findToken method
Standardizing blank lines around the null check and loop improves visual clarity and keeps the code style uniform.

src/main/java/goorm/back/zo6/auth/domain/LoginUser.java (1)

11-14: Approve reformatting of getId method
Expanding the one-line accessor into a full method body with braces and an explicit return makes it consistent with other record methods.

src/main/java/goorm/back/zo6/auth/presentation/AuthController.java (1)

48-48: Approve logout signature spacing adjustment
The added space before the opening brace in the logout method signature aligns with the controller’s existing formatting conventions.

src/main/java/goorm/back/zo6/auth/dto/request/LoginRequest.java (1)

14-15: LGTM! Formatting style improvement.

The formatting change from a compact to block form for the record declaration improves code consistency and readability, which aligns with the PR's goals of standardizing code formatting across Auth package classes.

src/main/java/goorm/back/zo6/auth/filter/JwtAuthFilter.java (6)

55-57: LGTM! Improved spacing in exception handling.

The added spaces around the catch block enhance readability and maintain consistent formatting.

---

68-68: LGTM! Improved method signature formatting.

The added spaces in the static method declaration improve readability.

---

73-73: LGTM! Better spacing around object initialization.

The improved spacing around the UsernamePasswordAuthenticationToken creation makes the code more readable.

---

77-77: LGTM! Consistent method signature formatting.

The added spaces in the method signature align with the coding style improvements.

---

85-87: LGTM! Improved spacing in method and conditional.

The consistent spacing in the method signature and inline return statement enhances readability.

---

91-91: LGTM! Improved spacing in method call.

The added space provides better readability for the setAttribute call.

src/main/java/goorm/back/zo6/auth/util/JwtUtil.java (6)

24-24: LGTM! Improved constructor signature formatting.

The added spaces in the constructor signature enhance readability.

---

28-28: LGTM! Consistent method signature formatting.

The added spaces in the method signature align with the coding style improvements.

---

34-35: LGTM! Improved spacing in method calls.

The consistent spacing in the claim method calls improves readability.

---

46-46: LGTM! Better method separation.

The added blank lines provide improved visual separation between methods, making the code structure clearer.

Also applies to: 51-51

---

57-57: LGTM! Consistent method signature formatting.

The added spaces in the method signatures align with the overall code style improvements.

Also applies to: 62-62

---

66-70: LGTM! Improved exception handling formatting.

The added spaces in the try-catch blocks provide better readability and consistent formatting.

Also applies to: 72-77

src/main/java/goorm/back/zo6/auth/application/AuthService.java (1)

22-25: LGTM! Improved formatting in login method.

The added spaces in the method signature and lambda expressions enhance readability and provide more consistent code style.

src/main/java/goorm/back/zo6/auth/application/AbstractOAuth2LoginSuccessHandler.java (1)

27-29: New abstract method added for user ID extraction.

The addition of the getUserId(OAuth2User oAuth2User) abstract method improves the API by explicitly requiring subclasses to implement user ID extraction. This method is used in the onAuthenticationSuccess method and complements the existing getEmail method.

The blank lines added before and after the method improve readability by visually separating the abstract methods.

src/main/java/goorm/back/zo6/auth/config/SecurityConfig.java (10)

17-17: Import organization improvement

Good addition of the AbstractHttpConfigurer import which is used in the refactored code for cleaner method reference syntax.

---

41-44: Improved method structure and documentation

The filterChain method has been nicely restructured with clear comments explaining the CORS configuration purpose. Using method chaining with descriptive comments improves readability significantly.

---

45-49: Enhanced readability with method references

Good refactoring from lambda expressions to method references (AbstractHttpConfigurer::disable). This change makes the code more concise and consistent with modern Java style.

---

50-90: Well-structured authorization rules with clear categorization

The authorization rules have been excellently reorganized with descriptive comments explaining the purpose of each section. This greatly improves readability and maintainability.

I noticed you've standardized from hasRole to hasAuthority for admin endpoints (lines 81 and 85), which is more explicit when working with custom Role enums.

---

92-93: Clear session management configuration

The session management configuration is now more readable with an explanatory comment about why STATELESS policy is used with JWT.

---

95-96: Descriptive JWT filter configuration

Good addition of a clear comment explaining the JWT filter position in the filter chain.

---

98-102: Improved exception handling formatting

The exception handling configuration has been reformatted to use method chaining with a consistent style, improving readability.

---

104-113: Enhanced OAuth2 configuration readability

The OAuth2 login configuration now has a clearer comment, and the token extraction code in lines 108-109 has been improved for better readability.

---

114-114: Overall code structure improvement

Adding appropriate spacing improves the overall readability of the code by clearly separating different configuration sections.

---

41-115: Comprehensive security configuration refactoring

The entire filterChain method has been excellently refactored to improve readability and maintainability. The changes include:

1. Logical grouping of related configurations
2. Clear, descriptive comments for each section
3. Consistent formatting and coding style
4. More explicit security rules with better organization

This refactoring aligns perfectly with the PR objectives of improving code style and readability in the Auth package.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.