Repository navigation
docs(sie): apply superlinked/sie#241 review fixes across codebase - #234
Merged
Merged
Conversation
Two amendments from the upstream SIE PR #241 review (code-owner @fm1320 and CodeRabbit) that were missing from the project's own user-facing guide: 1. Bounded poll loop: replace unbounded `until` loop in Step 3 with a 60-attempt cap (40 s × 60 ≈ 40 min). 502 exits immediately as a terminal load failure; 503/504 are treated as retryable. Loop wrapped in a subshell so that `exit 1` does not close an interactive terminal when pasted. 2. HF_TOKEN optionality: soften "required for model downloads" to "optional for ungated models (BGE-M3, Stella-v5); required for gated models such as naver/splade-v3" — updated prerequisites table, Path B summary row, Step B note, and Path B setup checklist.
…504 retryable Apply remaining gaps identified by post-merge sync-docs audit against superlinked/sie#241: - .env.example: mark HF_TOKEN optional for ungated models (BGE-M3, Stella-v5); required for gated models (e.g. naver/splade-v3); harmonise "Docker path only" wording across both comment lines - docs/user-guide/configuration.md: same optionality note at the commented env block (line 558) and the env-var reference table (line 665) - server/core/embedding/sie_embedder.py: add "504" and "gateway timeout" to _is_retryable_sie_error() — 504 was documented as retryable but missing from code Reviewed and approved by nw-documentarist-reviewer (PASS) and nw-software-crafter-reviewer (PASS) before commit.
neomatrix369
changed the title
7 tasks done
nw-software-crafter-reviewer flagged that the 504 addition in _is_retryable_sie_error() had no test proving the path executes. Mirrors test_embed_documents_retries_on_503_like_errors exactly, using "504 Gateway Timeout" as the transient error.
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
1 participant
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
Applies all actionable review comments from superlinked/sie#241 to rag-params-finder.
"504"and"gateway timeout"patterns to_is_retryable_sie_error()insie_embedder.pyso gateway timeouts are retried rather than treated as terminal failuressie-setup.md,.env.example, andconfiguration.md( ... )wrapper present insie-setup.mdpoll block soexit 1does not close interactive terminals; documented in-lineREADME.mdandsie-setup.mdvector_index_1024+text_search_indexonchunkscollection confirmed insie-setup.mdandmongodb-setup.mdMONGODB_URI) — project already uses the correct split variable namestest_embed_documents_retries_on_504_like_errorsto match the existing 503 retry test (flagged by nw-software-crafter-reviewer)Test Results
Backend
888 tests, 0 failures — coverage 75.8% (floor 70%)
All 11 quality-gate steps passed (
./scripts/ci/quality-gates.sh): repo lint, ruff, mypy, bandit, pytest + coverage, pip-audit, xenon complexity, frontend lint/test/typecheck/build.Pre-push gates passed on
386794a.Quality Gates
Reviewer verdicts
🤖 Generated with Claude Code
Complexity
Automatically refreshed by CI for product-code changes.
Functions above the JavaScript threshold
ExperimentDetailScreen.tsx:45— CC 118SearchExplorerScreen.tsx:35— CC 38labels.ts:35— CC 29ExplorePanels.tsx:391— CC 29LoadingFeedbackPanel.tsx:41— CC 28ExperimentsScreen.tsx:67— CC 20VectorDbStatsPanel.tsx:83— CC 18ExplorePanels.tsx:226— CC 15ExperimentsScreen.tsx:516— CC 15ExperimentControlButtons.tsx:54— CC 14Functions above the cognitive-complexity threshold
ExperimentDetailScreen.tsx:45— cognitive 63LoadingFeedbackPanel.tsx:41— cognitive 27labels.ts:35— cognitive 25ExplorePanels.tsx:391— cognitive 23SearchExplorerScreen.tsx:35— cognitive 17