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

Respect icloud Enable polling updates #117984

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

fopina
Copy link
Contributor

@fopina fopina commented May 23, 2024

Proposed change

Make icloud integration to respect Enable polling updates under System Options by not polling device details (if disabled).

My personal motivation being:
I don't want to drain device battery to get their locations, I only want to use the "Play Sound" feature when I don't know where the phone is.

Disabling polling also prevents the daily email of "someone has logged in your account" from Apple 😄

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

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

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

@fopina fopina marked this pull request as draft May 23, 2024 14:35
@fopina fopina changed the title Draft: icloud: respect Enable polling updates icloud: respect Enable polling updates May 23, 2024
…ions` and do not poll devices/location if disabled
@fopina fopina marked this pull request as ready for review May 23, 2024 15:40
@MartinHjelmare MartinHjelmare changed the title icloud: respect Enable polling updates Respect icloud Enable polling updates May 25, 2024
@@ -161,6 +161,7 @@ def update_devices(self) -> None:
"""Update iCloud devices."""
if self.api is None:
return
_LOGGER.debug("Updating devices")

Choose a reason for hiding this comment

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

If this is going into debug logging, could you please make the debug message a bit more expressive? Especially, if this will cause the "Someone logged in..." emails (which we all loathe).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This message is related to updating devices.
If it kicks in a re-authentication (due to expired token), it will send that email, but i don't think this is the place to log that...
I think "Updating devices" is quite clear for when devices are being updated 😃
This is mostly to make sure that polling is not happening (ie: this message does not show up in logs)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But maybe it would be nice to have that message (logging in) to match the emails, though debug logging is disabled after some time, in integrations, so it probably needed INFO level.
I'll let one of the owners comment on that before using this PR for that

@joedzado
Copy link

If this in fact solves the email issue, then please make sure to follow up with that issue when merged. :-)

@fopina
Copy link
Contributor Author

fopina commented Jun 16, 2024

Hey @Quentame and @nzapponi, any chance to take a look at this small PR 😃 ?

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.

None yet

3 participants