Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

MAINT Extract scenario-history aggregate queries and record construction

Open
#2,769 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
python, sql
Domain
backend, database

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

not ready yet
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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/PyRIT

All issues in microsoft/PyRIT

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.