-
Notifications
You must be signed in to change notification settings - Fork 36
[OB4] Fix build failure due to spotbugs CRLF validation #877
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| } else { | ||
| if (log.isDebugEnabled()) { | ||
| log.debug("Regulatory property not found in service provider metadata for clientId: " | ||
| + clientId + ". Hence treating it as a non-regulatory application."); | ||
| } | ||
| log.debug("Regulatory property missing. Treating as non-regulatory application."); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Log Improvement Suggestion No: 1
| } else { | |
| if (log.isDebugEnabled()) { | |
| log.debug("Regulatory property not found in service provider metadata for clientId: " | |
| + clientId + ". Hence treating it as a non-regulatory application."); | |
| } | |
| log.debug("Regulatory property missing. Treating as non-regulatory application."); | |
| } else { | |
| if (log.isDebugEnabled()) { | |
| log.debug("Regulatory property not found in service provider metadata for clientId: " + clientId + ". Treating as non-regulatory application."); | |
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AI Agent Log Improvement Checklist
- The log-related comments and suggestions in this review were generated by an AI tool to assist with identifying potential improvements. Purpose of reviewing the code for log improvements is to improve the troubleshooting capabilities of our products.
- Please make sure to manually review and validate all suggestions before applying any changes. Not every code suggestion would make sense or add value to our purpose. Therefore, you have the freedom to decide which of the suggestions are helpful.
✅ Before merging this pull request:
- Review all AI-generated comments for accuracy and relevance.
- Complete and verify the table below. We need your feedback to measure the accuracy of these suggestions and the value they add. If you are rejecting a certain code suggestion, please mention the reason briefly in the suggestion for us to capture it.
| Comment | Accepted (Y/N) | Reason |
|---|---|---|
| #### Log Improvement Suggestion No: 1 |
WalkthroughA debug logging statement in the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
financial-services-accelerator/components/org.wso2.financial.services.accelerator.identity.extensions/src/main/java/org/wso2/financial/services/accelerator/identity/extensions/util/IdentityCommonUtils.java (1)
381-381: LGTM! The CRLF validation fix resolves the build failure.The simplified log message successfully addresses the SpotBugs CRLF validation issue. However, consider enhancing observability by including the sanitized
clientIdin the log message to aid debugging, similar to the pattern used on line 417.🔎 Optional enhancement for better observability
- log.debug("Regulatory property missing. Treating as non-regulatory application."); + if (log.isDebugEnabled()) { + log.debug("Regulatory property not found in service provider metadata for clientId: " + + clientId.replaceAll("[\r\n]", "") + ". Treating as non-regulatory application."); + }This adds:
- CRLF sanitization to prevent injection while retaining diagnostic value
- Debug guard to avoid string operations when debug logging is disabled
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
financial-services-accelerator/components/org.wso2.financial.services.accelerator.identity.extensions/src/main/java/org/wso2/financial/services/accelerator/identity/extensions/util/IdentityCommonUtils.java(1 hunks)
|
Merging PR with build failure due to an observed issue in the Git action workflow. |
Purpose
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.