feat: deprecate constructor (Throwable, String)

[javier-godoy]

Close #81

Summary by CodeRabbit

• New Features

  • Updated project version to 4.2.0-SNAPSHOT, indicating new features and improvements.

• Bug Fixes

  • Deprecated the constructor that displayed error messages in production mode, improving error handling clarity.

• Documentation

  • Enhanced API documentation for constructors in the ErrorWindow class for better understanding.

• Chores

  • Removed the "Throw Error with custom message" button from the demo, streamlining error handling options in the UI.

[coderabbitai]

Walkthrough

The pull request involves updates to the error-window-vaadin project, focusing on version incrementation and modifications to the ErrorWindow class. The changes include updating the project version in pom.xml, revising documentation and deprecating a constructor in ErrorWindow.java, and removing a specific error-throwing button from the demo class. These modifications aim to improve the clarity of error handling and versioning of the project.

Changes

File	Change Summary
pom.xml	Version updated from 4.1.1-SNAPSHOT to 4.2.0-SNAPSHOT
src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindow.java	- Deprecated constructor with Throwable and errorMessage - Updated comments for constructors to clarify message display behavior
src/test/java/com/flowingcode/vaadin/addons/errorwindow/ErrorwindowDemo.java	Removed "Throw Error with custom message" button

Assessment against linked issues

Objective	Addressed	Explanation
Custom message not shown in Production mode [#81]	❓	Unclear if the changes fully resolve the production mode message display issue

Possibly related PRs

• feat: default to actual production mode from Vaadin #80: Version update in pom.xml aligns with the current PR's version increment

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 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 4789039 and 3a77957.

📒 Files selected for processing (3)

• pom.xml (1 hunks)
• src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindow.java (3 hunks)
• src/test/java/com/flowingcode/vaadin/addons/errorwindow/ErrorwindowDemo.java (0 hunks)

💤 Files with no reviewable changes (1)

• src/test/java/com/flowingcode/vaadin/addons/errorwindow/ErrorwindowDemo.java

🔇 Additional comments (5)

src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindow.java (4)

101-111: Consider removing usages of the now-deprecated constructor.
This constructor is marked as deprecated. Ensure references elsewhere are updated to use the recommended constructors; otherwise, you may accumulate technical debt.

---

117-121: Documentation clarity approved.
The updated doc comment aligns with the recommended approach to include an ErrorWindowI18n instance. No issues found.

---

132-132: Constructor comments look good.
No functional changes observed; the added/modified doc comment is consistent with the class semantics.

---

144-144: Internationalization parameter usage is consistent.
The constructor’s signature and doc update accurately reflect the intended usage, ensuring production mode handling and custom i18n.

pom.xml (1)

6-6: Version bump to 4.2.0-SNAPSHOT is appropriate.
Increasing the minor version is consistent with introducing a new feature (constructor deprecation) and other changes.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[sonarqubecloud]

Quality Gate failed

Failed conditions
C Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

[javier-godoy]

Quality Gate failed

Failed conditions C Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Sonar complains about "Deprecated code should be removed." (S1133) which doesn't make sense because the goal of this PR is to introduce the deprecation.

[mlopezFC]

LGTM