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

No need to set unique_id in enphase_envoy reauth step #133615

Open
wants to merge 14 commits into
base: dev
Choose a base branch
from

Conversation

catsmanac
Copy link
Contributor

Improve integration quality scale by resolving quality_scale review feedback.

Feedback resolved:

async_step_reaut L160: I believe that the unique is already set when starting a reauth flow

Verified and this is indeed the case.

This PR changes async_step_reauth so it no longer sets the unique_id.

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)
  • 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:

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 @bdraco, @cgarwood, @joostlek, mind taking a look at this pull request as it has been labeled with an integration (enphase_envoy) you are listed as a code owner for? Thanks!

Code owner commands

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

@@ -156,8 +156,6 @@ async def async_step_reauth(
) -> ConfigFlowResult:
"""Handle configuration by re-auth."""
self._reauth_entry = self._get_reauth_entry()
Copy link
Contributor

Choose a reason for hiding this comment

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

We now recommend to NOT cache the reauth_entry, and request it once inside the required steps.

Looking more closely, I would actually recommend that you split out a reauth_confirm step from the user step, similar to how the reconfigure step is implemented.

Suggested change
self._reauth_entry = self._get_reauth_entry()

You could also move the try...catch inside the validate_input routine to reduce duplicate code:

envoy = validate_input(hass, host, user, pass, errors, description_placeholders)
if envoy:
    ...
    return self.async_create_entry(...)
# errors and description already filled
return self.async_show_form(step_id, schema, errors, description_placeholders)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review. I've applied the 3 recommendations.

@catsmanac catsmanac requested a review from epenet December 21, 2024 11:20
await envoy.setup()
await envoy.authenticate(username=username, password=password)
try:
envoy = Envoy(host, get_async_client(hass, verify_ssl=False))
Copy link
Contributor

Choose a reason for hiding this comment

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

Move up (before try)

homeassistant/components/enphase_envoy/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/config_flow.py Outdated Show resolved Hide resolved
@catsmanac
Copy link
Contributor Author

Hmm, setting step to done after merge of #133726 triggers the missing data descriptions error. Seems no exempt option is available. Changing status back to todo for now.

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.

5 participants