Refine development-mode message

[christiangoerdes]

Summary by CodeRabbit

• Documentation
  • Enhanced error handling guidance to provide improved instructions for properly configuring production settings to hide sensitive error details from end-users.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The ATTENTION field message in ProblemDetails.createInternal was updated to provide revised guidance for production environments on hiding detailed error information.

Changes

Cohort / File(s)	Summary
Error Message Update core/src/main/java/com/predic8/membrane/core/exceptions/ProblemDetails.java	Updated ATTENTION field value with reworded production guidance for configuring error information visibility

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

• t-burch

Poem

🐰 A message refined with care, so clear,
Production wisdom whispered near,
Hide those errors, let secrets keep,
While rabbits tend the stack so deep! 🌟

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Refine development-mode message' accurately describes the main change: updating the ATTENTION field message in ProblemDetails to provide refined guidance for development-mode error handling.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch improve-prod-log

---

📜 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 53b0528 and 350406f.

📒 Files selected for processing (1)

• core/src/main/java/com/predic8/membrane/core/exceptions/ProblemDetails.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (java)

🔇 Additional comments (1)

core/src/main/java/com/predic8/membrane/core/exceptions/ProblemDetails.java (1)

303-304: Clear and actionable development-mode guidance.

The refinement provides helpful direction to developers in development mode, clearly stating the current state and the configuration step needed to hide detailed error information in production. The message is appropriate and well-placed in the createInternal method, which is only executed when not in production (line 239).

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[membrane-ci-server]

This pull request needs "/ok-to-test" from an authorized committer.

[predic8]

Membrane is running in development mode. Enable production mode in the configuration to prevent detailed information from appearing in error responses.