Predictive error message when config hasn't been loaded
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6.5k
- Forks
- 787
- PR merge metrics
- No merged PRs in 30d
Description
I've done support a few times now and one of the most common problems arises from the fact that someone has changed a pack config file but haven't reloaded it.
The error message that usually pops up is a KeyError, since the action or sensor will likely be looking up some key in the config that may not exist in the config stored in the database. However, for some packs, where the default configuration is provided with some dummy values, this may not always be the case
It may be worth putting some thought into how we can detect whether or not the configuration has been reloaded recently, and provide something useful to the user that indicates this is what they should do. At the very least, we should catch "common" exceptions like KeyError and provide this additional context before re-raising.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Trace the config-loading and action or sensor lookup paths, then determine how to detect an outdated database configuration and verify that common lookup failures provide reload context before being re-raised.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100