MAINT Extract scenario-history aggregate queries and record construction
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Wait for #2766 and #2768 to land before starting. Then read pyrit/memory/memory_interface.py and the scenario-history entry points, followed by tests/unit/memory/memory_interface/test_interface_scenario_history.py and tests/unit/backend/test_scenario_run_service.py. Done means the public delegate and return shape remain unchanged, aggregation stays database-side, and the existing history coverage passes with database portability preserved.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem? Please describe.
MemoryInterface.get_scenario_history_aggregates() and _build_scenario_history_aggregate_statement() combine SQL aggregation, retry/error accounting, latest-attempt selection, auxiliary name lookup, and typed aggregate-record construction. After page retrieval and attempt-to-work-unit matching have been extracted, these are the remaining core history-query responsibilities in the general memory interface.
This is M3 of three scenario-history extraction steps. Not ready yet: depends on #2768, after #2766. Wait for those boundaries to land, then move aggregation into the same internal query module and reassess readiness before adding help wanted.
Describe the solution you'd like
Extract history aggregate statement construction, execution, and row-to-ScenarioHistoryAggregate conversion. Use the matching logic from #2768 rather than duplicating it, and retain the public MemoryInterface.get_scenario_history_aggregates() method as a delegate.
- Preserve grouping by logical work unit, the existing latest-attempt ordering, and all success/completion/error/retry arithmetic.
- Keep aggregation database-side, with compact result rows and the existing backend-specific expression hooks.
- Preserve empty/default records for requested runs with no matching attempts and the existing sorted attack-name output.
- Finish wiring the page method from #2766 through the cohesive internal history-query implementation without changing its return shape.
- Keep legacy/unusable-plan handling and caller policy in their existing layers. Do not redesign the backend service or GUI.
Acceptance criteria:
- Public signatures and typed return values remain unchanged.
- Runs with no attempts retain their zero/default aggregates; empty input is handled as before.
- Repeated attempts, internal retries, error attempts, and transitions between success/error outcomes produce exactly the existing counters.
- Tied timestamps retain the ID tiebreaker; latest timestamps, sorted attack names, and mixed planned/legacy results remain unchanged.
- Runs outside a usable plan keep existing fallback behavior, while unmatched planned attempts remain excluded from counters.
- No full result-object hydration, Python-side replacement of SQL aggregation, or new per-run/per-attempt query loop is introduced.
- Existing memory and backend history coverage exercises the final delegated path and guards database portability.
Describe alternatives you've considered, if relevant
Do not combine this with new counter semantics, a schema migration, or broad extraction of all scenario persistence methods. Do not make a separate service for each extraction step. The intended result is one cohesive private query component reached through the existing memory API.
Additional context
Starting points: pyrit/memory/memory_interface.py, get_scenario_history_aggregates, _build_scenario_history_aggregate_statement, and the page entry point. Coverage: tests/unit/memory/memory_interface/test_interface_scenario_history.py and tests/unit/backend/test_scenario_run_service.py.
Series: #2766 (history pages), #2768 (attempt matching), then this issue (aggregate queries/records). Follow doc/code/framework.md and the applicable database, Python, and test instructions. Memory owns retrieval and database aggregation here, not scenario execution, scoring decisions, or presentation.
- Dominant language
- Python
- Stars
- 4.5k
- Forks
- 896
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 191
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/PyRIT
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
-
Bug: triage GUI help wanted
Difficulty 3/5 1-2 days Newbie friendliness 65/100
-
feature-request
Difficulty 3/5 1-2 days Newbie friendliness 70/100
-
bug help wanted
Difficulty 4/5 3-5 days Newbie friendliness 68/100
-
not ready yet
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
area: harness bug status: needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Human-Agent-Society/reef#625 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 1/5 Under an hour Newbie friendliness 80/100
learningequality/kolibri#15351 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Name consistency Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
eellak/triplestore#65 · 1 comment ·