Skip to content
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

Fixed logic to handle invalid JSON and return an empty dictionary #134010

Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

farzadadel92
Copy link

@farzadadel92 farzadadel92 commented Dec 25, 2024

Breaking change

Proposed change

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @farzadadel92

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot added cla-needed integration: rest small-pr PRs with less than 30 lines. labels Dec 25, 2024
@home-assistant home-assistant bot marked this pull request as draft December 25, 2024 21:43
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

PR description is missing the proposed change and what is trying to be fixed here.

@home-assistant home-assistant bot marked this pull request as draft December 26, 2024 17:41
@farzadadel92
Copy link
Author

There was an issue (#133289) indicating that the JSON result was neither a dictionary nor a list, with the first element not being a dictionary. I modified the logic a bit to handle invalid JSON.

@farzadadel92 farzadadel92 marked this pull request as ready for review December 26, 2024 21:07
@gjohansson-ST
Copy link
Member

I don't get all the changes here since the only thing really done is to change the logging from warning to debug. The rest would be the same result as before.

Secondly it's lacking the argumentation why we should do this change and not warn when it's actually returning an incorrect json?

@farzadadel92
Copy link
Author

The main change here improves the logic to handle cases where json_dict is unexpected, like a list without a dictionary as the first element. The previous version could raise runtime errors or log incorrect warnings.

The logging level was changed to debug to reduce noise for non-critical issues. If this should remain a warning, I can adjust it.

If I misunderstood the problem or if something here is incorrect, please let me know!

@gjohansson-ST
Copy link
Member

gjohansson-ST commented Dec 30, 2024

The main change here improves the logic to handle cases where json_dict is unexpected,

That's the thing right, because if you are here, then a json_dict is expected?
You change the logic of the function so because the second if is now an elif instead (so it will break the use of jsonpath) and secondly we change the logging.

I suppose in your case what you want to achieve is to mute the logging when the json path is empty (or something as such)?

Converted the PR to draft while we are discussing.

@gjohansson-ST gjohansson-ST marked this pull request as draft December 30, 2024 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants