fix: skip corrupted run state files in list_runs - #3817
Open
Quratulain-bilal wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Improves workflow run listing resilience by skipping unreadable or malformed state files.
Changes:
- Handles JSON parsing and file-access failures in
list_runs().
Show a summary per file
| File | Description |
|---|---|
src/specify_cli/workflows/engine.py |
Skips state files that raise JSON or I/O errors. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Medium
…n, and regression tests - Catch UnicodeDecodeError for invalid UTF-8 encoding - Validate loaded JSON is a dict with required 'run_id' key - Add 5 regression tests for corrupted state files Fixes github#3817
Contributor
There was a problem hiding this comment.
Review details
Comments suppressed due to low confidence (1)
tests/test_workflows.py:6224
- This does not reliably create an unreadable file: Windows'
attrib +Ronly prevents writes (and the branch explicitly expects the read to succeed), while POSIX mode bits are bypassed by privileged/root test processes. As a result, the newOSErrorhandling is untested on Windows and this test can fail in root-based containers. Please monkeypatch the file-opening call to raisePermissionErrorfor this state file so the exception path is deterministic on every platform.
if sys.platform == "win32":
subprocess.run(["attrib", "+R", str(state_file)], check=True)
else:
state_file.chmod(0o000)
- Files reviewed: 2/2 changed files
- Comments generated: 0 new
- Review effort level: Medium
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.
Wrap json.load() in workflows/engine.py list_runs with ry/except (json.JSONDecodeError, OSError) so a single corrupted state.json doesn't crash the entire listing.