feat(cli): add plan explain and decision tree outputs #464
Merged
hamza.khyari
merged 4 commits from 2026-03-03 12:16:04 +00:00
feature/m4-decision-cli into master
Dismiss Review
Are you sure you want to dismiss this review?
Labels
Clear labels
auto/needs-reevaluation
controller-managed
overdue
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Needs Feedback
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.
PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.
Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.
Currently being processed by an implementer worker.
Currently being processed by the merge driver.
Currently being processed by a reviewer worker.
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.
In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.
Tracking issues used by the AI Automation system for agents to communicate and report.
Rebase conflict needs LLM conflict-resolver.
Failing CI needs implementer attention.
Documenting a driver incident or rollback.
Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.
Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.
A ticket in a blocked state and unable to complete until some other task is completed first.
Bounty
$100
A bounty of $100 for any open-source contributor who provides a MR that solves this issue
Bounty
$1000
A bounty of $1000 for any open-source contributor who provides a MR that solves this issue
Bounty
$10000
A bounty of $10000 for any open-source contributor who provides a MR that solves this issue
Bounty
$20
A bounty of $20 for any open-source contributor who provides a MR that solves this issue
Bounty
$2000
A bounty of $2000 for any open-source contributor who provides a MR that solves this issue
Bounty
$250
A bounty of $250 for any open-source contributor who provides a MR that solves this issue
Bounty
$50
A bounty of $50 for any open-source contributor who provides a MR that solves this issue
Bounty
$500
A bounty of $500 for any open-source contributor who provides a MR that solves this issue
Bounty
$5000
A bounty of $5000 for any open-source contributor who provides a MR that solves this issue
Bounty
$750
A bounty of $750 for any open-source contributor who provides a MR that solves this issue
MoSCoW
Could have
Could have feature in order to satisfy the epic/legendary.
MoSCoW
Must have
Must have feature in order to satisfy the epic/legendary.
MoSCoW
Should have
Should have feature in order to satisfy the epic/legendary.
There are questions in the ticket that can not be completed until the project owner provides clarity.
Points
1
1 man-hours worth of work for an expert with no learning curve.
Points
13
13 man-hours worth of work for an expert with no learning curve.
Points
2
2 man-hours worth of work for an expert with no learning curve.
Points
21
21 man-hours worth of work for an expert with no learning curve.
Points
3
3 man-hours worth of work for an expert with no learning curve.
Points
34
34 man-hours worth of work for an expert with no learning curve.
Points
5
5 man-hours worth of work for an expert with no learning curve.
Points
55
55 man-hours worth of work for an expert with no learning curve.
Points
8
8 man-hours worth of work for an expert with no learning curve.
Points
88
88 man-hours worth of work for an expert with no learning curve.
Priority
Backlog
This ticket has backlogged priority and is not to be worked on yet
Priority
CI Blocker
Critical priority issue that blocks CI/CD pipeline and prevents PR merges
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
A ticket for learning a tool or technology that is needed to be able to do future planning and design.
State
Completed
The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.
State
Duplicate
A ticket that represents the same content as an existing ticket.
State
In Progress
A ticket that is actively being developed.
State
In Review
A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.
State
Paused
This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.
State
Unverified
All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.
State
Verified
The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.
State
Wont Do
This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.
Type
Automation
Any edits or discussion about the AI automated coding system.
Type
Bug
Something that doesnt work as intended.
Type
Discussion
Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.
Type
Documentation
An error or improvement needed in the documentation.
Type
Epic
Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.
Type
Feature
Some new functionality not present.
Type
Legendary
A type of Epic which will contain other Epics.
Type
Refactor
A code change that restructures existing code without changing its external behavior.
Type
Support
Someone needs help using the project.
Type
Task
A generic task that doesnt fit into the other type categories.
Type
Testing
Work exclusively focusing on fixing or expanding testing.
Projects
Clear projects
No project
Assignees
aditya (Aditya Chhabra)
aleenaumair (Aleena Umair)
brent.edwards (Brent Edwards)
CoreRasurae (Luis Mendes)
drew (Drew Morris)
eugen.thaci (Eugen Thaci)
freemo (Jeffrey Phillips Freeman)
HAL9000 (HAL 9000)
HAL9001 (HAL9001)
hamza.khyari (Hamza Khyari)
hurui200320 (Rui Hu)
justin.morris
khird (Kyle Hird)
org.cleveragents
Clear assignees
No Assignees
hamza.khyari
Notifications
Due Date
No due date set.
Blocks
#174 feat(cli): add plan explain and decision tree outputs
cleveragents/cleveragents-core
Reference: cleveragents/cleveragents-core#464
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Delete Branch "feature/m4-decision-cli"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
plan explain <decision_id>CLI command with--format(json/yaml/table/rich),--show-context,--show-reasoning,--show-alternativesflags for inspecting individual decisionsplan tree <plan_id>CLI command with--format,--show-superseded,--depthflags for rendering the full decision treecollections.deque(nolist.pop(0))Testing
robot/plan_explain.robot)benchmarks/plan_explain_bench.py)Files Changed
src/cleveragents/cli/commands/plan.py— Addedplan explainandplan treecommands (+317 lines)features/plan_explain.feature+features/steps/plan_explain_steps.py— BDD testsrobot/plan_explain.robot+robot/helper_plan_explain.py— Integration testsbenchmarks/plan_explain_bench.py— ASV benchmarksdocs/reference/plan_cli.md— Updated with explain/tree docsCHANGELOG.md— UpdatedCloses #174
4e5df4cc63tof50bd80686Code Review — Commit
f50bd80:test(cli): add 32 behave scenarios to close plan.py diff-coverage gapReview scope: test coverage, test flaws, performance, bug detection, security, and spec compliance against issue #174 and
docs/specification.md.All 32 scenarios pass (126 steps, 0.4s). No security or performance issues found. However, the following findings should be addressed before merge.
1. HIGH — Sham Test: Orphan Scenario Does Not Exercise the Claimed Code Path
File:
features/steps/plan_explain_cli_coverage_steps.pylines 240–249Scenario 16, "Tree builder skips orphan child references gracefully", does not actually trigger the orphan branch at
plan.py:2724-2726:The step definition contains an explicit comment admitting this:
Since only a root decision with no children is provided,
children_map.get(did, [])returns an empty list and the defensive guard is never evaluated. The scenario name and assertion give the illusion of coverage without actually hitting the branch.Fix: Construct a decision list where
children_mapcontains a reference to adecision_idthat is absent fromby_id. For example, manually craft aparent_decision_idin the child that points at the root, then include a second child whosedecision_iddoes not match any entry in the filtered set (e.g., add a superseded child withshow_superseded=False).2. MEDIUM — Dead Code: Two Module-Level Constants Are Defined but Never Used
File:
features/steps/plan_explain_cli_coverage_steps.pylines 40–44Neither constant is referenced anywhere in the file. The actual patch targets are hardcoded inline in
_invoke_correctand the resumewhensteps. A reader assumes these named constants are the canonical patch targets, but they are not used.Fix: Either use the constants in the
whensteps, or remove them.3. MEDIUM — Spec Deviation:
--modeand--guidanceAre Required in Spec but Optional in ImplementationSpec ref:
docs/specification.mdline 321The specification defines (parentheses = required, brackets = optional):
The implementation gives both flags defaults (
mode="revert",guidance=""), making them optional at the Typer level. The function body catches empty guidance with a manual check, but--modesilently defaults to"revert".No test validates the behavior when
--modeor--guidanceis omitted. Tests always supply both.4. MEDIUM — Spec Deviation:
--show-alternativesFlag Absent from SpecificationSpec ref:
docs/specification.mdline 320The specification defines:
The implementation and tests add
--show-alternatives, which is documented indocs/reference/plan_cli.mdbut not present in the canonical spec. Either update the spec or mark this as an intentional extension.5. MEDIUM — Unnecessary Mock:
_resolve_active_plan_idPatched but Never Called in Correction TestsFile:
features/steps/plan_explain_cli_coverage_steps.pylines 615–628In
_invoke_correct,_resolve_active_plan_idis patched viapatch.multiple, but the test always explicitly passes--plan context.pec_plan_id. Sinceplan_idis always non-None in the production code path (resolved_plan_id = plan_id or _resolve_active_plan_id()), the mock is never triggered. This is dead mock setup that creates a false sense of thoroughness.6. LOW — Weak Assertions: Two Scenarios Lack Output Content Verification
For the superseded scenario, the
--show-supersededflag should cause superseded decisions to appear. Without asserting their presence, the test passes even if the flag is silently ignored.7. LOW —
typer.Abort()Conflates Distinct Error Types to Same Exit BehaviorThe
correct_decisioncommand wrapsResourceNotFoundError,ValidationError, andCleverAgentsErrorall intyper.Abort(). Tests checkexit code should be nonzero(not specific codes) plus different output strings. If someone reorders or removes a handler, the broaderCleverAgentsErrorcatch would absorb the specific ones, and the tests would still partially pass.Suggestion: Add negative assertions (e.g., when
ResourceNotFoundErroris raised, assert "Validation Error" is NOT in the output).8. LOW — Global
_PLAN_IDCreates Hidden Coupling Between StepsFile:
features/steps/plan_explain_cli_coverage_steps.pyline 38_PLAN_ID = str(ULID())is generated once at import time and implicitly shared between thegivenstep (step_pec_lifecycle_active) and thethenstep (step_pec_resolved_matches). This hidden coupling makes refactoring fragile. Prefer storing the expected ID oncontextin thegivenstep and reading it back in thethenstep.9. INFO — Coverage Claim May Be Off by 1 Line
The commit message states "Raises plan.py diff-coverage from 69% to 99.7% (1 line remaining)". Given finding #1 (the orphan guard at
plan.py:2726is never reached), the actual uncovered lines may be 2 rather than 1.Summary
_PATCH_CORRECTION_SVC,_PATCH_RESUME_SVC_MOD)--mode/--guidanceoptional in code, required in spec--show-alternativesflag not in specification_resolve_active_plan_idpatched but never triggeredtyper.Abort()conflates distinct error types to same exit behavior_PLAN_IDcreates hidden coupling between stepsRecommendation: Address at minimum findings #1 (sham coverage) and #2 (dead constants) before merge. Findings #3 and #4 (spec deviations) should be reconciled — either update the spec or adjust the implementation.
@@ -0,0 +37,4 @@_PATCH_CONTAINER = "cleveragents.application.container.get_container"_PATCH_LIFECYCLE = "cleveragents.cli.commands.plan._get_lifecycle_service"_PATCH_RESOLVE = "cleveragents.cli.commands.plan._resolve_active_plan_id"_PATCH_CORRECTION_SVC = "cleveragents.cli.commands.plan.correct_decision"MEDIUM — Dead code.
_PATCH_CORRECTION_SVCand_PATCH_RESUME_SVC_MODare defined here but never referenced anywhere in this file. The actual patch targets are hardcoded inline in_invoke_correct(line 620) and the resumewhensteps (lines 665, 677, 691). Either use these constants or remove them.@@ -0,0 +237,4 @@context.pec_plan_id = _PLAN_IDroot_id = str(ULID())old_id = str(ULID())new_id = str(ULID())HIGH — Sham test. This step provides only a root decision with no children, so
children_map.get(did, [])returns[]and the orphan guard atplan.py:2726(if child_id not in by_id: continue) is never reached. The comment in the code acknowledges this explicitly.To actually cover the orphan branch, construct a scenario where
children_mapcontains achild_idthat is absent fromby_id. For example, include a superseded child decision (so it gets filtered out ofby_idwhenshow_superseded=False) while the parent still references it inchildren_map.@@ -0,0 +617,4 @@"correct",context.pec_decision_id,"--mode","revert",MEDIUM — Unnecessary mock. Since
--planis always passed in_invoke_correct(line 630), the production code pathresolved_plan_id = plan_id or _resolve_active_plan_id()never calls_resolve_active_plan_id(). Thispatch.multipleis dead mock setup.f50bd80686tof0e924c1a1c4c6e71e20todc8dd9b57ddc8dd9b57dto21e7aecbe721e7aecbe7tof66cb8d68eNew commits pushed, approval review dismissed automatically according to repository settings