Fix cache loss when markdown report write fails - #31
Open
elhoim wants to merge 1 commit into
Open
Conversation
Finding MISP#10 (markdown-write-loses-cache, high): the markdown write in main() was the only unguarded file I/O and ran before save_cache. A bad --markdown-output path (e.g. a missing parent directory) raised an unhandled FileNotFoundError that escaped main() as a traceback, discarding every fresh cache entry gathered during that run (potentially paid/rate-limited lookups). Fix: persist the cache immediately after the query loop, before the markdown write, and additionally wrap the markdown file write in try/except OSError so a bad output path degrades to an error message and exit code 1 instead of crashing and losing data.
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.
Finding 10 (High) —
bin/cli.py:1075-1088Problem
The markdown write is the only unguarded file I/O in main() and runs before save_cache (:1090). --markdown-output /no/such/dir/report.md raises FileNotFoundError, escapes main() as a traceback, and discards every fresh (possibly paid/rate-limited) cache entry from that run.
Fix
Finding #10 (markdown-write-loses-cache, high): in main() of bin/cli.py, the markdown-report file write ran unguarded after the query loop but before save_cache(). An unwritable --markdown-output path (e.g. missing parent directory) raised an unhandled FileNotFoundError that escaped main() as a traceback, discarding every freshly-fetched cache entry from that run (potentially paid/rate-limited module responses). Fix: moved the cache_dirty/save_cache block to run immediately after the query loop, before any markdown output work, and wrapped the markdown file write in try/except OSError so a bad output path now prints an error and returns exit code 1 instead of crashing — and in both cases the cache is now safely persisted first.
Verification
Reproduced against the unmodified code at
9b8c605, then re-checked after the change.Before
After
python bin/cli.py --helpexits 0 and the module still imports cleanly. Verification was performed offline against the pure functions — no runningmisp-modulesinstance is required.Branched from
9b8c605. This PR addresses only this finding; the other findings from the same review are in separate PRs, so they will need rebasing against each other as they merge.🤖 Generated with Claude Code
https://claude.ai/code/session_01DYX4TKA5inzByJ4qGWKjqh