Skip to content

[CHAT-5228] fix: add lombok to ProGuard rules#1069

Merged
ttypic merged 1 commit intomainfrom
ECO-5228/fix-proguard-rules
Feb 25, 2025
Merged

[CHAT-5228] fix: add lombok to ProGuard rules#1069
ttypic merged 1 commit intomainfrom
ECO-5228/fix-proguard-rules

Conversation

@ttypic
Copy link
Copy Markdown
Contributor

@ttypic ttypic commented Feb 24, 2025

Fixes #1067

We use Lombok deep down internally for code generation but Lombok itself should not be included in the final APK.

Effect of -dontwarn lombok.**:

  • It tells ProGuard to ignore missing Lombok classes, preventing unnecessary warnings.
  • This avoids potential build failures when ProGuard is set to treat warnings as errors.

Summary by CodeRabbit

  • Chores
    • Updated configuration settings to suppress non-critical warnings from an external utility library, helping to streamline the build process and improve overall stability.

We use Lombok for code generation but Lombok itself should not be included in the final APK.

Effect of `-dontwarn lombok.**`:
- It tells ProGuard to ignore missing Lombok classes, preventing unnecessary warnings.
- This avoids potential build failures when ProGuard is set to treat warnings as errors.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 24, 2025

Walkthrough

This update adds a new directive to the Android ProGuard configuration file. The directive -dontwarn lombok.** is introduced to suppress warnings from the Lombok library. All existing configurations remain unchanged, and the new line is simply appended at the end of the file.

Changes

File(s) Summary
android/proguard.txt Appended -dontwarn lombok.** to suppress Lombok warnings

Suggested reviewers

  • sacOO7

Poem

I hopped along the codebase bright,
Adding a rule with all my might.
Lombok's warnings fade away,
ProGuard now leads the way!
A cheerful hop to code all day!


📜 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 950ea19 and 984a3a0.

📒 Files selected for processing (1)
  • android/proguard.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: check-rest-okhttp
  • GitHub Check: check (29)
  • GitHub Check: check (24)
  • GitHub Check: check-realtime
  • GitHub Check: check (21)
  • GitHub Check: check-rest
  • GitHub Check: check (19)
  • GitHub Check: check-realtime-okhttp
🔇 Additional comments (1)
android/proguard.txt (1)

8-8: New Lombok Directive Added Successfully.

The addition of the directive -dontwarn lombok.** is correctly implemented. This change meets the PR objective by instructing ProGuard to ignore warnings related to Lombok, thus preventing unnecessary build warnings and potential failures.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.

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. (Beta)
  • @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.

Copy link
Copy Markdown
Collaborator

@sacOO7 sacOO7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ttypic ttypic merged commit 5a51571 into main Feb 25, 2025
12 checks passed
@ttypic ttypic deleted the ECO-5228/fix-proguard-rules branch February 25, 2025 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Warning on Android Proguard

2 participants