fix: raise SpaOfflineError when currentState is missing#125
Merged
Conversation
When the spa gateway is offline, the API returns spa data without a 'currentState' key, causing KeyError in all property accessors. This adds a dedicated SpaOfflineError exception raised early in _get_info() with a clear message, so callers can handle the offline case gracefully. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2 tasks
The spa gateway being temporarily offline is often transient. Retrying the data fetch (without re-authenticating) gives it a chance to recover before erroring out. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
SpaOfflineErrorexception raised when the API response lackscurrentState(typically means spa gateway is offline)KeyError: 'currentState'deep in property accessors — now it fails fast with a descriptive message in_get_info()SpaOfflineErrorfrom the package so consumers can catch it specificallyContext
Seeing ~500
KeyError: 'currentState'events per week in Sentry from a downstream consumer (controlmyspa-porssari). The ControlMySpa API sometimes returns spa data withoutcurrentStatewhen the gateway is offline.Test plan
SpaOfflineErroris raised whencurrentStatekey is absent🤖 Generated with Claude Code