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.

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

Add config flow for Ecovacs #108111

Merged
merged 9 commits into from Jan 16, 2024
Merged

Add config flow for Ecovacs #108111

merged 9 commits into from Jan 16, 2024

Conversation

edenhaus
Copy link
Contributor

@edenhaus edenhaus commented Jan 15, 2024 •
edited

Breaking change

The YAML configuration for Ecovacs is deprecated and will be removed in 2024.8. Please remove it from your configuration.

Proposed change

SSIA

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant home-assistant bot added cla-signed config-flow This integration migrates to the UI by adding a config flow deprecation Indicates a breaking change to happen in the future has-tests integration: ecovacs labels Jan 15, 2024
@home-assistant
Copy link

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

Code owner commands

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

@edenhaus edenhaus mentioned this pull request Jan 15, 2024
Merged
8 tasks
joostlek
joostlek requested changes Jan 15, 2024
View reviewed changes
homeassistant/components/ecovacs/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/strings.json Show resolved Hide resolved
tests/components/ecovacs/test_config_flow.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft January 15, 2024 17:36
@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.

@edenhaus edenhaus marked this pull request as ready for review January 15, 2024 19:56
MartinHjelmare
MartinHjelmare reviewed Jan 15, 2024
View reviewed changes
homeassistant/components/ecovacs/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/strings.json Outdated Show resolved Hide resolved
mib1185
mib1185 reviewed Jan 15, 2024
View reviewed changes
Copy link
Contributor

@mib1185 mib1185 left a comment

Choose a reason for hiding this comment

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

from functional point of view, it works as expected

  • correct repair issue is shown when validation during import fails (tested with intentional wrong credentials)
  • import of correct yaml data is successful
  • create a new config entry is successful
  • validation during config flow is also correct (wrong data, causes corresponding error messages)

edenhaus and others added 2 commits January 16, 2024 08:14
@edenhaus @joostlek @MartinHjelmare
Apply suggestions from code review
27603e7 
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
@edenhaus
Implement suggestions
2d0f5b7
edenhaus
edenhaus commented Jan 16, 2024
View reviewed changes
homeassistant/components/ecovacs/config_flow.py
type=selector.TextSelectorType.PASSWORD
)
),
vol.Required(CONF_COUNTRY): vol.All(vol.Lower, cv.string),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Country selector will be used in a follow-up PR, where I also make it optional to specify the continent

MartinHjelmare
MartinHjelmare reviewed Jan 16, 2024
View reviewed changes
homeassistant/components/ecovacs/strings.json Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/__init__.py Outdated
_LOGGER.error("Ecovacs login failed due to wrong username/password")
raise ConfigEntryError("invalid username or password") from ex
except RuntimeError as ex:
_LOGGER.exception("Unexpected exception")
Copy link
Member

Choose a reason for hiding this comment

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

Normally we don't log when we try again to avoid spamming the log. We can pass the message as an exception argument, which will be logged.

It's always ok to log at debug level, besides performance considerations. ConfigEntryNotReady will log the message at debug level.

We also normally don't catch unknown exceptions outside of the config flow.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will add the error handling in a follow-up including the new lib

MartinHjelmare
MartinHjelmare approved these changes Jan 16, 2024
View reviewed changes
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Looks good!

@edenhaus
Copy link
Contributor Author

Test failure unrelated

@edenhaus edenhaus merged commit 7fe6fc9 into dev Jan 16, 2024
48 of 49 checks passed
@edenhaus edenhaus deleted the edenhaus-ecovacs-configflow branch January 16, 2024 12:31
@github-actions github-actions bot locked and limited conversation to collaborators Jan 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mib1185 mib1185 mib1185 left review comments

@MartinHjelmare MartinHjelmare MartinHjelmare approved these changes

@joostlek joostlek joostlek approved these changes

@OverloadUT OverloadUT Awaiting requested review from OverloadUT OverloadUT is a code owner

Assignees

@OverloadUT OverloadUT

@mib1185 mib1185

Labels
cla-signed config-flow This integration migrates to the UI by adding a config flow deprecation Indicates a breaking change to happen in the future has-tests integration: ecovacs Quality Scale: No score
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@edenhaus @MartinHjelmare @joostlek @mib1185 @OverloadUT