Add per-call image queue expiry#64
Open
LordMike wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Queued image delivery currently uses one integration-wide expiry timeout. That works as a default, but not every image has the same useful lifetime. In my experience, the lifetime / expiry for a
drawcustomwas 24 hours. Seems arbitrary. A notification-styledrawcustomimage may only be relevant for a few minutes. A dashboard/status frame may be fine to deliver much later. Some "set this display to this state eventually" updates may not need a time-based expiry at all.This PR lets the service caller express that intent per image, while keeping the existing integration option as the default when no override is provided.
What Changed
expiretoopendisplay.drawcustomandopendisplay.upload_image.expireaccepts Home Assistant duration values.expirekeeps the existing default queue timeout.expire: 0means no time-based expiry.expire_secondsorNone.expires_at: null.expires_at; no time-based expiry is represented asnull.Example
Validation
PYTHONDONTWRITEBYTECODE=1 PYTHONPATH=/mnt/n/Personal/opendisplay-work/Home_Assistant_Integration /home/mike/.venvs/hass-dev/bin/python -m pytest -q tests -p no:cacheprovider52 passeddrawcustomwith a short custom expiry returns anexpires_atmatching the requested lifetime.