Skip to content

Fix onboarding crash when area translations are missing#171533

Open
frenck wants to merge 2 commits into
devfrom
frenck-2026-0608
Open

Fix onboarding crash when area translations are missing#171533
frenck wants to merge 2 commits into
devfrom
frenck-2026-0608

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented May 20, 2026

Proposed change

Fix a KeyError crash during onboarding when area translation keys are not available. This happens when running Home Assistant Core from a development install or when translation files are incomplete for a given language. The onboarding user creation step crashes because it uses direct dict access on translations that may not exist.

Now fetches English translations as a fallback for any missing keys in the user's language, with the area key itself as a last resort.

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 Onboarding failure: #170802
  • 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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings May 20, 2026 12:55
@frenck frenck requested a review from a team as a code owner May 20, 2026 12:55
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented May 20, 2026

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (onboarding) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of onboarding can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign onboarding Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copilot AI reviewed May 20, 2026
View reviewed changes
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

Fixes a KeyError during onboarding user creation when default area translation keys are missing, by adding a fallback mechanism.

Changes:

  • Load English area translations during onboarding to use as a fallback for missing keys in the user’s selected language.
  • Use safe lookup for area translation keys, falling back to English and then to the raw area key.

Comment thread homeassistant/components/onboarding/views.py Outdated
Comment thread homeassistant/components/onboarding/views.py Outdated
Comment thread homeassistant/components/onboarding/views.py
edenhaus
edenhaus reviewed May 20, 2026
View reviewed changes
Comment thread homeassistant/components/onboarding/views.py
# Create default areas using the users supplied language.
# Create default areas using the users supplied language,
# falling back to English for any missing keys.
english_translations = await async_get_translations(
Copy link
Copy Markdown
Member

@edenhaus edenhaus May 20, 2026

Choose a reason for hiding this comment

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

In my opinion we should do this transparent in async_get_translations.
async_get_translations should always return all the keys. If a translation is missing in the given language we include the english one. So we don't need to implement the manual fallback on each call and fix the issues for all occurrences.

@frenck What do you think?

Copy link
Copy Markdown
Member

@balloob balloob May 20, 2026

Choose a reason for hiding this comment

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

how would we know that not all keys are there?

Copy link
Copy Markdown
Member Author

@frenck frenck May 20, 2026

Choose a reason for hiding this comment

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

Essentially load english, overwrite with the lanbguage in the same structure, but deep merging that isn't really efficient I would say.

Copy link
Copy Markdown
Member

@balloob balloob May 20, 2026

Choose a reason for hiding this comment

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

We already do that actually

https://github.com/home-assistant/core/blob/dev/homeassistant/helpers/translation.py#L216-L217

Copy link
Copy Markdown
Member Author

@frenck frenck May 20, 2026

Choose a reason for hiding this comment

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

Hmmm so what the crap is going south here?

Copy link
Copy Markdown
Member

@balloob balloob May 20, 2026

Choose a reason for hiding this comment

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

it's reported against the dev branch. Maybe they didn't generate translations? They are auto-generated when you run script/setup, but this person might not have run that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@balloob balloob balloob left review comments

@edenhaus edenhaus edenhaus left review comments

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

bugfix by-code-owner cla-signed core integration: onboarding Quality Scale: internal small-pr PRs with less than 30 lines.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Onboarding failure:

4 participants

@frenck @balloob @edenhaus