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

Ignore trackable without details in Tractive integration #109814

Merged
merged 3 commits into from Feb 6, 2024

Conversation

bieniu
Copy link
Member

@bieniu bieniu commented Feb 6, 2024

Breaking change

Proposed change

It appears that currently the Tractive API does not provide details about a tracker that is shared from another account. We don't know if this is a temporary bug or a change in API functionality. With this change, trackers without details will be skipped.

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

home-assistant bot commented Feb 6, 2024

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

Code owner commands

Code owners of tractive 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 tractive 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
Copy link
Contributor

edenhaus commented Feb 6, 2024

I have tested, and it works, but I would change it to

diff --git a/homeassistant/components/tractive/__init__.py b/homeassistant/components/tractive/__init__.py
index 79b1b6d7db..c0d214750e 100644
--- a/homeassistant/components/tractive/__init__.py
+++ b/homeassistant/components/tractive/__init__.py
@@ -103,7 +103,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     # So we have to remove None values from trackables list. Additionally, we must omit
     # trackables that do not have `details`, pets shared from another account do not
     # contain details.
-    trackables = [item for item in trackables if item and "details" in item.trackable]
+    trackables = [item for item in trackables if item]
 
     hass.data[DOMAIN][entry.entry_id][CLIENT] = tractive
     hass.data[DOMAIN][entry.entry_id][TRACKABLES] = trackables
@@ -130,6 +130,10 @@ async def _generate_trackables(
     # Check that the pet has tracker linked.
     if not trackable["device_id"]:
         return None
+    
+    if "details" not in trackable:
+        _LOGGER.warning("Tracker %s has no details and will be skipped. This happens for shared trackers", trackable["device_id"])
+        return None
 
     tracker = client.tracker(trackable["device_id"])

@edenhaus edenhaus added this to the 2024.2.0 milestone Feb 6, 2024
@bieniu bieniu marked this pull request as ready for review February 6, 2024 18:46
@home-assistant
Copy link

home-assistant bot commented Feb 6, 2024

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 home-assistant bot marked this pull request as draft February 6, 2024 20:02
@bieniu bieniu marked this pull request as ready for review February 6, 2024 21:19
@home-assistant home-assistant bot requested a review from frenck February 6, 2024 21:19
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.

Thanks, @bieniu 👍

../Frenck

@frenck frenck merged commit a6f0b6a into home-assistant:dev Feb 6, 2024
19 checks passed
@bieniu bieniu deleted the tractive-trackable-no-details branch February 6, 2024 21:36
frenck pushed a commit that referenced this pull request Feb 6, 2024
Co-authored-by: Maciej Bieniek <478555+bieniu@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Feb 7, 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.

Tractive integration doesn't work anymore
4 participants