fix: search populate snippet field from EFTS highlight payload (#47)#55
Merged
Conversation
|
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 685f932216
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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
Fixes #47 —
edgarq searchwas returning rows with\"snippet\": \"\"always.Root cause: the EFTS API (
efts.sec.gov/LATEST/search-index) does NOT return highlight fragments at all. The server-side Elasticsearch query excludesdoc_textfrom_sourceand never adds ahighlightclause, so the existing code that readhit[\"highlight\"]always found an empty dict. The SEC's own EDGAR full-text search UI confirms this — it doesn't show per-row snippets either.Fix: after fetching each EFTS page, fetch the matched filing's primary document (
https://www.sec.gov/Archives/edgar/data/{cik}/{accession_no_dashes}/{filename}), strip tags, and extract a ±150-char window around the first case-insensitive match of the query. Best-effort: a 404/5xx on the doc fetch yields an empty snippet but never aborts the search. Non-text primaries (.pdf, etc.) are skipped.Test plan
test_search_snippet_populated_from_filing_text— mocks EFTS + filing HTML, asserts snippet contains query terms (failed before fix, passes after).test_search_snippet_fetch_failure_yields_empty— verifies a 404 on the filing fetch leaves snippet empty without affecting other row fields.test_search.pyupdated to register a catch-all archive 404 mock (snippet stays empty for them, all other assertions unchanged).uv run toxmatrix py3.10–3.14 green (black, ruff format, ruff check, pyright, pytest).uv run edgarq search \"climate risk\" --forms 10-K --limit 2 --no-cachereturns non-empty snippets containing "Climate Risk" excerpts for both Carnival Corp and MSCI Inc.🤖 Generated with Claude Code