Waze travel time last updated fix

[etiennec78]

Proposed change

Previously, when Waze Travel Time sensor was failing to update (often because of a 503 error), its state was left untouched, but its last_updated value was refreshed. However, to calculate an ETA in an automation, the sensor value and the time at which it was updated needs to be summed up. So, with the previous behavior, the ETA was slowly getting off at each failed update.

Now, with the added coordinator, the sensor is left untouched when an update fails, to avoid propagating a wrong last_updated timestamp.

https://github.com/home-assistant/core/issues/146798

Type of change

• [ ] Dependency upgrade
• [x] 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 #146798
• This PR is related to issue:
• Link to documentation pull request:
• Link to developer documentation pull request:
• Link to frontend pull request:

Checklist

• [x] The code change is tested and works locally.
• [x] Local tests pass. Your PR cannot be merged unless tests pass
• [x] There is no commented out code in this PR.
• [x] I have followed the development checklist
• [x] I have followed the perfect PR recommendations
• [x] 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:

• [ ] Documentation added/updated for www.home-assistant.io

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:

• [ ] I have reviewed two other open pull requests in this repository.

[home-assistant[bot]]

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

Code owner commands

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

[etiennec78]

Thanks for all your suggestions! I will split this PR as you requested and apply your changes. For now, I'll keep this PR open in case I have any more questions.

[etiennec78]

I think I'll make the following PRs : ~~1. Use a Typed Dict to store waze data~~ ~~2. Make async_get_travel_times return [] instead of None~~ (not that useful without the changes we removed)

3. Add a coordinator 3b. Use a proper dataclass
4. Catch errors with UpdateFailed
5. Add a custom available function to avoid reporting "unknown"
6. Remove rounding on the state
7. Split attributes into distinct sensors

I will start tomorrow

[eifinger]

I think I'll make the following PRs :

1. Use a Typed Dict to store waze data

2. Add a coordinator

3. Catch errors with UpdateFailed

4. Add a custom available function to avoid reporting "unknown"

5. Split attributes into distinct sensors

I will start tomorrow

I am missing the changes to async_get_travel_times. Where do you want to put them?

[etiennec78]

I have updated my previous message to add the simplification of async_get_travel_times() return types.

But all the other changes I had made in async_get_travel_times() seem useless. I wanted to raise UpdateFailed for the coordinator, and log a warning for the service, but it turns out that raising UpdateFailed in the service also works (it shows the error in dev tools, and stops automations if not handeled)