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

Avoid future exception during setup of Synology DSM #118583

Conversation

mib1185
Copy link
Contributor

@mib1185 mib1185 commented May 31, 2024

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
Copy link

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

Code owner commands

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

@mib1185 mib1185 force-pushed the synology_dsm/avoid-future-exception-during-setup branch from 45861e8 to b894f08 Compare May 31, 2024 20:06
@mib1185 mib1185 force-pushed the synology_dsm/avoid-future-exception-during-setup branch from b894f08 to 1a9c068 Compare May 31, 2024 20:23
@bdraco
Copy link
Member

bdraco commented May 31, 2024

If we don't resolve the future, I'm pretty sure every other coordinator will wait forever on the future if its also trying to relogin

@mib1185
Copy link
Contributor Author

mib1185 commented May 31, 2024

valid point, but i think we should not finished it with an exception, since during setup there will be no later task to wait for the future and consume the exception - those we get Error doing job: Future exception was never retrieved during integrations setup as long as the NAS is down.
Maybe we should just finish the future with done() during setup phase?

@bdraco
Copy link
Member

bdraco commented May 31, 2024

We can set it an than clear the flag instead so it doesn't raise when its gced

example

with contextlib.suppress(BaseException):

@mib1185
Copy link
Contributor Author

mib1185 commented Jun 1, 2024

uhhh great 👍 was looking for such a solution, but didn't find it 🙈

@@ -104,6 +104,9 @@ async def async_login(self) -> None:
except BaseException as err:
if not self._login_future.done():
self._login_future.set_exception(err)
if during_setup:
with suppress(BaseException):
Copy link
Member

Choose a reason for hiding this comment

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

I think we should always suppress it since unless there is another execution at the same time it will also be un-retrieved. We should add a comment about why. It's the same reason as I linked above

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you mean this way 0854a0f ?

@mib1185 mib1185 merged commit 46eb779 into home-assistant:dev Jun 1, 2024
24 checks passed
@mib1185 mib1185 deleted the synology_dsm/avoid-future-exception-during-setup branch June 1, 2024 21:51
@github-actions github-actions bot locked and limited conversation to collaborators Jun 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2024.5.2 lots of errors in log when synology is off
4 participants