Skip to content

Update synology_srm to use ScannerEntity with config flow #144645

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

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

Conversation

noriega3
Copy link

@noriega3 noriega3 commented May 10, 2025

Breaking change

This uses the config flow template (fairly similar to mikrotik's implementation) while still keeping the original synology_srm api by the original owner

Proposed change

Updated legacy integration to implement files like the coordinator, init, and consts in order for the config flow to work, this was updated to use ScannerEntity.

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

Since there is coming from the configuration.yml way, there was not a previous config entry flow implemented.

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:

rename file

fix system info pathing

clean up code, add node_id, add original params

complete integration updates

fixes after merge

core: update to match original config
@home-assistant home-assistant bot added cla-needed config-flow This integration migrates to the UI by adding a config flow has-tests integration: synology_srm new-feature labels May 10, 2025
Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @noriega3

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot marked this pull request as draft May 10, 2025 20:58
@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.

@home-assistant
Copy link

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

Code owner commands

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

@noriega3 noriega3 marked this pull request as ready for review May 10, 2025 21:04
@home-assistant home-assistant bot dismissed their stale review May 10, 2025 21:05

Stale

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Hi there @noriega3 👋

Wow that is quite a bunch in this pull request. Great effort! However, as a result, the pull request has grown beyond a reasonable size.

I don't like doing this, but I have to ask you to split this PR into multiple smaller pull requests. See also:

https://developers.home-assistant.io/docs/review-process#creating-the-perfect-pr

In the end, having a coordinator + config flow + scanner entity changes + other refactorings in a single PR really isn't needed and makes reviewing very hard.

../Frenck

@home-assistant home-assistant bot marked this pull request as draft May 12, 2025 17:36
@noriega3
Copy link
Author

sounds good. I'll split it into different PRs. Context was I was originally fixing the intermittent drop offs of the integration, but evolved into the config flow and resulting it in me modernizing it, where it worked consistently.

@noriega3
Copy link
Author

noriega3 commented May 29, 2025

Please check out #145865 for a separated PR, started from the base integration again.

@noriega3 noriega3 requested a review from frenck May 29, 2025 23:01
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.

Migrate synology_srm from DeviceScanner to ScannerEntity
2 participants