Skip to content

fix: preserve unreadable event config files - #3861

Merged
mnriem merged 1 commit into
github:mainfrom
marcelsafin:fix/events-unreadable-json
Jul 30, 2026
Merged

fix: preserve unreadable event config files#3861
mnriem merged 1 commit into
github:mainfrom
marcelsafin:fix/events-unreadable-json

Conversation

@marcelsafin

Copy link
Copy Markdown
Contributor

Summary

  • handle read failures while loading user-owned event configuration
  • skip the merge instead of crashing or replacing existing content
  • cover unreadable config paths with a regression test

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.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 29, 2026 18:05
@marcelsafin
marcelsafin requested a review from mnriem as a code owner July 29, 2026 18:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. Patch Path.read_text for this specific regular file to raise PermissionError and 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, not None. This distinction is intentional because callers use the empty mapping to create a new configuration, whereas None aborts the merge; documenting both as None makes 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

@mnriem
mnriem merged commit e916fd1 into github:main Jul 30, 2026
14 checks passed
@mnriem

mnriem commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants