core icon indicating copy to clipboard operation
core copied to clipboard

Use tcp sensor available flag to reflect connection errors

Open fopina opened this issue 1 year ago • 4 comments

Breaking change

  • before: when a connection fails, there is no state change - it remains with the value from the last successful connection
  • now: when a connection fails, state is updated to unavailable

This might have impact on automations / triggers as unavailable state was not used before, not sure if that's considered breaking change.

Proposed change

Currently when a TCP sensor fails to connect (DNS failure, port is closed, host is not reachable or connection times out), state does not reflect it. It continues to show the last successful connection which is not accurate.

I propose to use sensor available flag by setting it to False whenever a connection exception occurs

Type of change

  • [ ] Dependency upgrade
  • [x] 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

  • [x] The code change is tested and works locally.
  • [x] Local tests pass. Your PR cannot be merged unless tests pass
  • [x] There is no commented out code in this PR.
  • [x] I have followed the development checklist
  • [x] I have followed the perfect PR recommendations
  • [x] The code has been formatted using Ruff (ruff format homeassistant tests)
  • [x] 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.
  • [ ] Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

fopina avatar May 17 '24 00:05 fopina

@MartinHjelmare thanks for the title fix. Anyone that could be pinged for this, as there is no codeowner pinged automatically by the bot?

fopina avatar Jul 04 '24 23:07 fopina

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

Learn more about our pull request process.

home-assistant[bot] avatar Jul 19 '24 07:07 home-assistant[bot]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes. Thank you for your contribution!

github-actions[bot] avatar Sep 17 '24 09:09 github-actions[bot]

coming back to this, no need to close

fopina avatar Sep 19 '24 23:09 fopina

Because there hasn't been any activity on this PR for quite some time now, I've decided to close it for being stale.

Feel free to re-open this PR when you are ready to pick up work on it again 👍

../Frenck

frenck avatar Nov 08 '24 20:11 frenck