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

Use tcp sensor available flag to reflect connection errors #117602

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

Conversation

fopina
Copy link
Contributor

@fopina fopina commented May 17, 2024

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
  • 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

state = hass.states.get(TEST_ENTITY)

assert state
# FIXME: state should remain the same, but how to assert the available flag?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added new test to assert available flag changes (that I have validated using the component in my instance) but unable to find a quick way to retrieve the entity and assert it.
Is there an helper for it? Or another way?

assert state.state == "7.123"

mock_socket.connect.side_effect = OSError("Boom")
# FIXME: where is the default scan interval for tcp sensor?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Isn't there a constant for it? I only find multiple defined at specific component levels

@MartinHjelmare MartinHjelmare changed the title tcp: use sensor available flag to reflect connection errors Use tcp sensor available flag to reflect connection errors May 19, 2024
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.

None yet

1 participant