Fix: reason return on rest api error

[bigredfrog]

As per sentry example

https://ledfx-org.sentry.io/issues/4985345081/?project=4506350233321472&query=release%3Aledfx%402.0.93&referrer=release-issue-stream

If the reason return is complex, the json serialisation in the rest call response can fail.

In this case, setting min freq to 0 by typing in device edit and directly hitting save allows an out of range return

The reason is an object and existing code would pass that on, leading to a generic error in the front and a report back into sentry

This fix hardens the handling of reason when found, and ensures conversion to string

Tested by forcing the zero value in min freq and hitting save, now reports correct reason string to front end. No crash trace triggered in console

Note call to repr(e) was replaced with str(e) due to advice from chatgpt. quoting...

Use of str() Over repr(): While repr(e) is also a string, str(e) is generally more user-friendly and intended for end-user display. This change makes the error message more suitable for inclusion in a JSON response intended for client applications.

Summary by CodeRabbit

• Bug Fixes
  • Improved error handling by ensuring error reasons are correctly converted to strings for clearer messaging.

[coderabbitai]

Walkthrough

The update is a minor yet crucial enhancement focusing on improving error handling within the system. It specifically adjusts how error reasons are processed, ensuring that they are consistently converted to strings. This change aids in standardizing the error logging or handling mechanism, making it easier to understand and diagnose issues by ensuring error messages are always in a readable and expected format.

Changes

Files	Change Summary
ledfx/api/__init__.py	Convert reason variable to string for reason[0] and e.

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a664f6a and 6d892f8.

Files selected for processing (1)

• ledfx/api/init.py (1 hunks)

Additional comments: 2

ledfx/api/__init__.py (2)

• 65-65: Converting reason[0] to a string using str() is a good practice for ensuring that the error message is serializable and user-friendly. This change aligns with the PR's objective to improve error handling by making error messages more comprehensible to end-users.
• 67-67: Similarly, converting the exception e to a string using str() is a positive change. It ensures that exceptions are handled gracefully and that error messages are suitable for display in client applications, enhancing the user experience by providing clearer error information.