🌐 AI搜索 & 代理 主页
Skip to content

Trap for missing UUID in config_flow for Squeezebox #158721

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.

Sign up for GitHub

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

Jump to bottom
Merged
joostlek merged 4 commits into from
Dec 12, 2025
Merged

Trap for missing UUID in config_flow for Squeezebox #158721

joostlek merged 4 commits into from
Dec 12, 2025

Conversation

@peteS-UK
Copy link
Contributor

@peteS-UK peteS-UK commented Dec 11, 2025

Proposed change

The Squeezebox integration uses a uuid returned from the LMS as the unique identifier. In init we errored if the uuid was missing, but didn't trap this condition in config_flow. This PR traps for this error in config.flow.

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

  • 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

home-assistant bot commented Dec 11, 2025

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

Code owner commands

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

@peteS-UK peteS-UK mentioned this pull request Dec 11, 2025
Open
73 tasks
joostlek
joostlek reviewed Dec 12, 2025
View reviewed changes
homeassistant/components/squeezebox/strings.json Outdated
"error": {
"cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
"invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
"missing_uuid": "LMS did not provide a unique identifier.",
Copy link
Member

@joostlek joostlek Dec 12, 2025

Choose a reason for hiding this comment

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

So when does this happen? What can the user do to fix this?

Copy link
Contributor Author

@peteS-UK peteS-UK Dec 12, 2025

Choose a reason for hiding this comment

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

Well, nothing really.... All LMS versions for ever should always return a UUID. It likely means it's something pretending to be an LMS that isn't (e.g. like slimproto). The protocol has been around for so long there's a few lite versions out there, but basically if you don't have a uuid, you need a proper lms

Copy link
Contributor Author

@peteS-UK peteS-UK Dec 12, 2025

Choose a reason for hiding this comment

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

I guess I could add a "please check you LMS version" to the message ...

Copy link
Contributor

@pssc pssc Dec 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Think this is most likely i suspect when its not really lms on the other end of the connection

Copy link
Member

@joostlek joostlek Dec 12, 2025

Choose a reason for hiding this comment

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

Like, if we expect every client to return a UUID, we can turn it into an assertion (and if we then get an issue from a user we'd be proven wrong). If we do expect it to be not there, we should explain what it means that it didn't provide a unique identifier

Copy link
Contributor Author

@peteS-UK peteS-UK Dec 12, 2025

Choose a reason for hiding this comment

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

It's the server (LMS) rather than the client, and yes, we expect every one to return a UUID if they're actually an LMS.

Copy link
Member

@joostlek joostlek Dec 12, 2025

Choose a reason for hiding this comment

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

So if there's a reasonable chance that there are ones out there wihtout UUID, we should just tell that it's not compatible

Copy link
Contributor Author

@peteS-UK peteS-UK Dec 12, 2025

Choose a reason for hiding this comment

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

OK - I'll update the text message

Copy link
Contributor Author

@peteS-UK peteS-UK Dec 12, 2025

Choose a reason for hiding this comment

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

updated

joostlek
joostlek reviewed Dec 12, 2025
View reviewed changes
@peteS-UK
Copy link
Contributor Author

peteS-UK commented Dec 12, 2025

Thanks @joostlek . Is that the last one for the quality scale now?

@joostlek joostlek merged commit 5ffb39f into home-assistant:dev Dec 12, 2025
36 checks passed
@joostlek
Copy link
Member

joostlek commented Dec 12, 2025

I need to check up on that one again

@peteS-UK
Copy link
Contributor Author

peteS-UK commented Dec 12, 2025

I need to check up on that one again

Thanks

@peteS-UK peteS-UK deleted the trap_missing_uuid branch December 12, 2025 14:59
@github-actions github-actions bot locked and limited conversation to collaborators Dec 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@joostlek joostlek joostlek approved these changes

+1 more reviewer

@pssc pssc pssc left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

by-code-owner cla-signed code-quality has-tests integration: squeezebox Quality Scale: No score small-pr PRs with less than 30 lines.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@peteS-UK @joostlek @pssc