perf(exports): cap row count and stream body in chunks across xlsx/html/cases endpoints#35
Merged
Merged
Conversation
…ml/cases endpoints
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
routers/executions/exports.pywrapped responses inStreamingResponse(BytesIO(...)), which still buffers the entire workbook or HTML payload in one Pythonbytesobject. A 1000-result execution with inline base64 attachments would blow the API process's memory before sending a single byte, with no way for an admin to short-circuit huge exports.MAX_EXPORT_RESULTSenv var (default 5000) gates the three export endpoints (/executions/{id}/export/xlsx,/executions/{id}/export/html,/projects/{id}/cases/export/xlsx). Requests above the cap return413with the actual count and the configured ceiling so the caller knows how to narrow the scope (filter by version, environment, suite). The cases endpoint counts via SQL (func.countacrossTestCasejoined toTestSuite) so we don't materialize cases just to reject them._stream_bytes(payload)yieldsEXPORT_STREAM_CHUNK_BYTES(default 64 KiB) slices via generator.StreamingResponsenow consumes the generator, so the kernel send queue drains as the worker iterates instead of holding the whole bytes blob alive across the await boundary.backend/tests/test_export_size_cap.pymonkeypatches the cap to 3 and exercises all three endpoints: 413 above cap, 200 at cap (and the workbook contains exactly N data rows), HTML 413, cases-xlsx 413, plus a chunk-streaming test that asserts the body is delivered in multipleiter_bytes()chunks and starts with the ZIP magic bytes.