Skip to content

Conversation

@wuede
Copy link
Contributor

@wuede wuede commented Apr 14, 2025

Breaking change

Proposed change

This PR ensures, that the integration gracefully handles a schedule update communicated through the webhook.

example webhook payload:

{
    "user_id": "xxxxxxxxxxxxxxx",
    "user": {
        "id": "xxxxxxxxxxxxxxx",
        "email": "xxxxx.xxxxx.com"
    },
    "home_id": "xxxxxxxxxxxxx",
    "event_type": "schedule",
    "push_type": "home_event_changed"
}

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:
  • Link to developer documentation pull request:
  • Link to frontend 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:

@home-assistant
Copy link

Hey there @cgtobi, mind taking a look at this pull request as it has been labeled with an integration (netatmo) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of netatmo can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign netatmo Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@wuede wuede marked this pull request as ready for review April 14, 2025 14:51
@wuede wuede requested a review from cgtobi as a code owner April 14, 2025 14:51
Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

Can we add a test for this?

@wuede
Copy link
Contributor Author

wuede commented Apr 15, 2025

Can we add a test for this?

I don't see how. The change has no effect on the internal state.

@edenhaus edenhaus changed the title do not fail on schedule updates Netatmo: do not fail on schedule updates May 5, 2025
@joostlek
Copy link
Member

joostlek commented May 9, 2025

I don't see how. The change has no effect on the internal state.

But we can try doing a request with an invalid payload and then see that it just handles it correctly? Because I would assume something now doesn't work like expected?

@wuede
Copy link
Contributor Author

wuede commented May 15, 2025

I don't see how. The change has no effect on the internal state.

But we can try doing a request with an invalid payload and then see that it just handles it correctly? Because I would assume something now doesn't work like expected?

Before my change the raised KeyError was handled in the event processing pipeline and never bubbled up. I can write a test to ensure that the stored data remains unchanged. But I can't test for the KeyError. Or at least I don't know how.

Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

Awesome, thanks! Now we at least ensure that we don't regress :D

@joostlek joostlek added this to the 2025.5.3 milestone May 18, 2025
@joostlek joostlek merged commit 541b969 into home-assistant:dev May 18, 2025
34 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators May 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants