Skip to content

Create issue for Sonos when Sonos system does not have UPnP enabled#159330

Merged
joostlek merged 19 commits into
home-assistant:devfrom
PeteRager:sonos-fordidden
Dec 23, 2025
Merged

Create issue for Sonos when Sonos system does not have UPnP enabled#159330
joostlek merged 19 commits into
home-assistant:devfrom
PeteRager:sonos-fordidden

Conversation

@PeteRager
Copy link
Copy Markdown
Contributor

@PeteRager PeteRager commented Dec 17, 2025

Proposed change

A recent change to the Sonos firmware has UPnP disabled by default. This prevents the integration from being able to connect. Additionally, when this error occurs it causes a "Unhandled Task Exception" because of lack of error handling in speaker discovery. Two changes

  • When a 403 / Forbidden HTTPError is reported, create an issue
  • Catch the set of error that could occur in the task and log an error message.

Related to these issues:

#154877
#156328

Docs were addressed in home-assistant/home-assistant.io#42467

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

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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
Copy Markdown
Contributor

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

Code owner commands

Code owners of sonos 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 sonos 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.

@PeteRager PeteRager marked this pull request as draft December 17, 2025 22:20
@PeteRager PeteRager marked this pull request as ready for review December 19, 2025 21:12
Copilot AI review requested due to automatic review settings December 19, 2025 21:12
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR addresses a bug in the Sonos integration where UPnP being disabled by default in recent firmware causes connection failures and unhandled task exceptions. The fix adds proper HTTP 403 error handling and creates repair issues to guide users in enabling UPnP on their Sonos system.

Key changes:

  • Added HTTP 403 error detection and repair issue creation when UPnP is disabled
  • Implemented comprehensive exception handling in speaker discovery tasks to prevent unhandled exceptions
  • Added test coverage for both discovery and manual host configuration scenarios

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File Description
homeassistant/components/sonos/__init__.py Adds _process_http_conection_error method to handle HTTP 403 errors and create repair issues; wraps discovery code in try-except blocks to catch HTTPError, OSError, SoCoException, Timeout, and TimeoutError
homeassistant/components/sonos/const.py Defines constants for UPnP issue ID and documentation URL
homeassistant/components/sonos/strings.json Adds user-facing repair issue text explaining UPnP disabled error
tests/components/sonos/test_init.py Adds three new test cases: HTTP 403 during discovery, HTTP 403 during manual host setup, and general exception handling during discovery

Comment thread homeassistant/components/sonos/__init__.py Outdated
Comment thread homeassistant/components/sonos/strings.json Outdated
Comment thread homeassistant/components/sonos/__init__.py Outdated
Comment thread homeassistant/components/sonos/__init__.py Outdated
Comment thread homeassistant/components/sonos/__init__.py Outdated
Comment thread homeassistant/components/sonos/__init__.py Outdated
Copy link
Copy Markdown
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.

You could also consider making this a repair, as then we can just automatically check for the user if it now works and tell them if it doesn't work yet

@joostlek joostlek added this to the 2025.12.5 milestone Dec 23, 2025
@joostlek joostlek merged commit 5150efd into home-assistant:dev Dec 23, 2025
36 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 24, 2025
@PeteRager PeteRager deleted the sonos-fordidden branch December 28, 2025 21:04
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.

5 participants