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

Fix reauth config flow title #129134

Draft
wants to merge 12 commits into
base: dev
Choose a base branch
from
Draft

Fix reauth config flow title #129134

wants to merge 12 commits into from

Conversation

CFenner
Copy link
Contributor

@CFenner CFenner commented Oct 25, 2024

Proposed change

Adds missing name to reauth title.

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

  • 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

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

@home-assistant
Copy link

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

Code owner commands

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

@home-assistant
Copy link

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

Code owner commands

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

@home-assistant
Copy link

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

Code owner commands

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

@home-assistant
Copy link

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

Code owner commands

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

@home-assistant
Copy link

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

Code owner commands

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

@epenet
Copy link
Contributor

epenet commented Oct 25, 2024

Could this be trapped as part of the translation checks?

def check_config_translations(ignore_translations: str | list[str]) -> Generator[None]:

@CFenner
Copy link
Contributor Author

CFenner commented Oct 25, 2024

There are some integrations that use custom reauth titles (neato, weheat) and others that are missing the title string completely (google_photos, google_tasks, microbees), I did not touch those.

@epenet
Copy link
Contributor

epenet commented Oct 25, 2024

There are some integrations that use custom reauth titles (neato, weheat) and others that are missing the title string completely (google_photos, google_tasks, microbees), I did not touch those.

Yes - but maybe we could adjust the check to say:

  • if the step has a title => extract the placeholders => check that flow result/context has necessary placeholders => fail if missing placeholders

Also - I think there is a difference between "title placeholders" and "description placeholders"

@CFenner
Copy link
Contributor Author

CFenner commented Oct 25, 2024

Could this be trapped as part of the translation checks?

Would be nice, but I'm not familiar with these tests.

Also - I think there is a difference between "title placeholders" and "description placeholders"

Tested and verified with description_placeholders.

@CFenner CFenner marked this pull request as ready for review October 25, 2024 08:57
@CFenner
Copy link
Contributor Author

CFenner commented Oct 25, 2024

See #129140 to help identify the instances Already two more reauth_confirm flows affected.

CI run has completed on #129140: https://github.com/home-assistant/core/actions/runs/11516128405 I suggest you take a look to see how many more need adjusting

I think I got every finding..

@epenet
Copy link
Contributor

epenet commented Oct 25, 2024

There are a few where the entry is already available (I haven't checked all as I'm on mobile) so you don't need to do a second lookup.
Also renault is using snapshot assertion on the flow result :)

@CFenner CFenner marked this pull request as draft October 25, 2024 20:55
@CFenner CFenner marked this pull request as ready for review October 25, 2024 20:55
@@ -384,6 +385,7 @@ async def async_step_reauth_confirm(
return self.async_show_form(
step_id="reauth_confirm",
data_schema=data_schema,
description_placeholders={CONF_NAME: self._get_reauth_entry().title},
Copy link
Member

Choose a reason for hiding this comment

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

We should not be handling it this way. Let's see if we can make it smarter and inject name automatically. This is not something every integration should have to do.

@home-assistant home-assistant bot marked this pull request as draft October 26, 2024 00:27
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

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.

Translation issue with reauth config flow
6 participants