fix: preserve unreadable event config files - #3861
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Preserves user-owned event configuration when JSON files cannot be read.
Changes:
- Treats read errors like parse errors and skips configuration merging.
- Adds regression coverage for an unreadable configuration path.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/specify_cli/events.py |
Handles OSError while loading user JSON. |
tests/integrations/test_events.py |
Verifies unreadable paths remain untouched. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Review details
Comments suppressed due to low confidence (2)
tests/integrations/test_events.py:1425
- This regression test substitutes a directory for the configuration file, so it only exercises a wrong-path-type
IsADirectoryError; it neither simulates the reported read-permission failure on an existing user file nor proves that the file's bytes remain unchanged. A handler narrowed to directory errors would still pass. PatchPath.read_textfor this specific regular file to raisePermissionErrorand assert its original bytes are preserved.
def test_unreadable_config_not_overwritten_on_merge(self, tmp_path):
"""An unreadable user config aborts the merge instead of crashing."""
integration = ClaudeIntegration()
config_path = tmp_path / ".claude/settings.json"
config_path.mkdir(parents=True)
src/specify_cli/events.py:1991
- The return contract is inaccurate: a missing path returns
{}on lines 1993–1994, notNone. This distinction is intentional because callers use the empty mapping to create a new configuration, whereasNoneaborts the merge; documenting both asNonemakes the preservation behavior misleading.
Returns the parsed dict, or ``None`` when the file is missing or cannot be
read or parsed (e.g. JSONC with comments, a temporarily malformed JSON
document, or an unreadable path). Callers must skip the merge rather than
resetting user content to ``{}``.
- Files reviewed: 2/2 changed files
- Comments generated: 0 new
- Review effort level: Medium
Collaborator
|
Thank you! |
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.
Summary
Testing
uvx ruff@0.15.0 check src tests.venv/bin/python -m pytest -q tests/integrations/test_events.py(104 passed).venv/bin/python -m pytest -q(6009 passed, 173 skipped)AI disclosure
GitHub Copilot helped identify edge cases and review the implementation. I reproduced the failure and validated the final change with targeted and full test suites.