Skip to content

Prevent Zeroconf Exception on truncated service type#62528

Closed
apworks1 wants to merge 2 commits intohome-assistant:devfrom
apworks1:patch-1
Closed

Prevent Zeroconf Exception on truncated service type#62528
apworks1 wants to merge 2 commits intohome-assistant:devfrom
apworks1:patch-1

Conversation

@apworks1
Copy link
Copy Markdown

@apworks1 apworks1 commented Dec 21, 2021

The proposed change avoids unexpected exception from Zeroconf service.

My example: currently with an Asustor NAS the "%NAS._asustor-looksgood_http._tcp.local." service appears to have a "_http._tcp.local." service_type while its actual type is "_asustor-looksgood_http._tcp.local."
This causes an exception because the ServiceInfo init checks:

if not type_.endswith(service_type_name(name, strict=False)):
raise BadTypeInNameException

File "/usr/src/homeassistant/homeassistant/components/zeroconf/init.py", line 405, in _process_service_update
async_service_info = AsyncServiceInfo(service_type, name)
File "/usr/local/lib/python3.9/site-packages/zeroconf/_services/info.py", line 131, in init
raise BadTypeInNameException

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)
  • 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
  • The code has been formatted using Black (black --fast 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

The proposed change avoids unexpected exception from Zeroconf service.

My example: currently with an Asustor NAS the "%NAS._asustor-looksgood_http._tcp.local." service appears to have a "_http._tcp.local." service_type while its actual type is "_asustor-looksgood_http._tcp.local."  
This causes an exception because the ServiceInfo __init__ checks:

if not type_.endswith(service_type_name(name, strict=False)):
            raise BadTypeInNameException

 File "/usr/src/homeassistant/homeassistant/components/zeroconf/__init__.py", line 405, in _process_service_update
    async_service_info = AsyncServiceInfo(service_type, name)
  File "/usr/local/lib/python3.9/site-packages/zeroconf/_services/info.py", line 131, in __init__
    raise BadTypeInNameException
@probot-home-assistant
Copy link
Copy Markdown

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

@epenet
Copy link
Copy Markdown
Contributor

epenet commented Dec 21, 2021

Can you add a unit test for this case?

@apworks1 apworks1 mentioned this pull request Dec 21, 2021
22 tasks
Tests for updated zeroconf/__init__.py
Service name which contains a shorter well known service type.
@apworks1 apworks1 changed the title Update __init__.py Prevent Zeroconf Exception when service type contains shorter well known type instead of full service name Dec 21, 2021
@apworks1 apworks1 changed the title Prevent Zeroconf Exception when service type contains shorter well known type instead of full service name Prevent Zeroconf Exception on truncated service type Dec 21, 2021
@bdraco
Copy link
Copy Markdown
Member

bdraco commented Dec 22, 2021

We might need to solve this upstream

Some research is required

@apworks1
Copy link
Copy Markdown
Author

I have opened a Pull Request on " jstasiak / python-zeroconf" to fix browser.py so that it does not erroneously match a type which is a superstring of the type under search.

@apworks1 apworks1 closed this Dec 23, 2021
@bdraco bdraco mentioned this pull request Dec 24, 2021
22 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Dec 24, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants