feat(public-api): expose all router-facing APIs at cleveractors package level; update README #48
Open
hurui200320
wants to merge 1 commits from
feature/17-public-api into master
pull from: feature/17-public-api
merge into: cleveragents:master
cleveragents:master
cleveragents:feature/skill-package-support
cleveragents:task/m2-quick-benchmark-regression-ci
cleveragents:feature/76-budget-pre-flight
cleveragents:feature/m1-registry-http-client
cleveragents:master-backup
No Reviewers
Labels
Clear labels
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
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.
No Label
Type
Task
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
Notifications
Due Date
No due date set.
Blocks
#17 feat(public-api): expose all router-facing APIs at cleveractors package level; update README
cleveragents/cleveractors-core
Reference: cleveragents/cleveractors-core#48
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/17-public-api"
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
This PR completes Wave C8 (issue #17): finalising the
cleveractorsv2.1.0 public API surface by documenting all router-facing exports inREADME.mdand fixing a pre-existing test-isolation bug in the coverage pipeline.All code changes for C1–C7 (imports,
__all__, version bump, smoke tests) were already merged tomasterin prior commits. This PR delivers the one remaining subtask: the "Router-facing API" README section, plus the bug fix.Changes
README.md— New "Router-facing API" section (AC7)Added a comprehensive "Router-facing API" section after the Quick start block, including:
validate_dict,merge_configs,create_executor,Executor,ActorResult,NodeUsage,ExecutionError,ConfigurationError) with one-line descriptions.merge_configscorrectly described as accepting "zero or more" dicts.create_executorrow updated to "…per-request credentials, and optional execution limits and pricing table" (reflecting the optional parameters).ActorResult.nodes). Includesimport yaml, usesmerge_configsto buildplatform_limits, referencesNodeUsagein the billing loop, and definesactor_yaml_textas a placeholder to avoid an undefined variable reference.create_executorheading updated tocreate_executor(config_dict, credentials, limits=None, pricing=None)to show thatlimitsandpricingare optional.create_executor: "Always passlimitsandpricingin production. When omitted, no execution-limit enforcement is performed. The router MUST pass both on every request per ADR-2024."ActorResultfield list includes all 5 fields:response,prompt_tokens,completion_tokens,nodes, andstate(opaque client-carried graph state for stateless resumption per ADR-2026). Thestateannotation updated todict[str, Any] | None. Thestate=input parameter forexecute()is now documented to complete the round-trip.Executor.execute_stream()andlast_resultbilling, including:last_resultsemantics:timeoutremoved from "Early abandonment" — timeout raisesExecutionError(kind="timeout")and populateslast_resultbefore re-raising.try/except ExecutionErrorblock added to the streaming example showinglast_resultaccess in the except clause.ExecutionError.kind/.reasonreference table with recommended HTTP status codes (ADR-2029:budget_exhausted→ 429,missing_pricing_entry→ 500).cleveractors.templatesrow now lists only actually-exported names (BaseTemplate,GenericTemplate,TemplateType,TemplateParameter,TemplateRegistry,ComponentReference,InstantiationContext) — previously listed non-exportedAgentTemplate,GraphTemplate,StreamTemplate."Package structure" and "Key exports" tables updated to reflect the v2.1.0 surface:
NodeTypeadded to thecleveractors.langgraphrow (previously omitted).TemplateRegistryis now re-exported fromcleveractors.templates.__init__so the Key exports import block is runnable withoutImportError.src/cleveractors/runtime.py—Executor.__init__signature fix + DRY cleanuplimitsandpricingparameters now have matching defaultslimits: dict[str, Any] | None = None, pricing: dict[str, Any] | None = Nonewithor {}substitution inside__init__, matching thecreate_executorfactory signature. This preventsTypeError: missing 2 required positional argumentswhen users constructExecutordirectly (as documented in README's "Exports at a glance" table).if limits is not None and not isinstance(limits, dict)(wasnot isinstance(limits, dict)) —Noneis now accepted and treated as{}.create_executorpreviously didlimits or {}andpricing or {}before passing toExecutor.__init__, which also didlimits or {}andpricing or {}. Theor {}increate_executorhas been removed — allNone-handling now lives exclusively inExecutor.__init__(single source of truth, DRY).self.limits: dict[str, Any]andself.pricing: dict[str, Any]now have explicit class-level annotations per CONTRIBUTING.md mandate.create_executordocstring updated:Args:entries forlimitsandpricingnow include the ADR-2024 warning: "⚠️ Per ADR-2024, the router MUST pass both on every request. Omitting either disables timeout / depth / cost / call-count enforcement."create_executor(config_dict, credentials, limits=None, pricing=None)and note that omittinglimits/pricingdisables all enforcement.src/cleveractors/templates/__init__.py— ExportTemplateRegistry+ sorted__all__Added
TemplateRegistryto the import block and__all__so thatfrom cleveractors.templates import TemplateRegistryworks without raisingImportError.__all__is now sorted alphabetically for consistency with the root-levelcleveractors/__init__.py.features/environment.py— Root logger level, handler level, and handler set test-isolation fixBug:
ReactiveCleverAgentsApp.__init__setslogging.getLogger().setLevel(log_level)globally based on theverboseparameter (verbose=0→ CRITICAL,verbose=1→ ERROR), and also sets each handler's level. Tests that createReactiveCleverAgentsAppcontaminated the logging state for later scenarios in the same slipcover process, causing 5 BDD scenarios inexecute_stream.featureto fail innox -s coverage_report(while passing innox -s unit_testsdue to process isolation differences).Fix (extended): Extended the save/restore to snapshot and restore both the root logger level, all handler levels, AND the handler set itself:
before_scenario: savescontext._root_log_original_level(root logger level),context._root_log_original_handler_levels(list of(handler, level)tuples for all handlers), andcontext._root_log_original_handlers(set of handlers at scenario start).after_scenario: restores all three. Computesset(current_handlers) - set(original_handlers)and removes any handlers added during the scenario (e.g.StreamHandleradded byReactiveCleverAgentsApp.__init__). This makes the workaround fully hermetic against handler addition, not just level mutation. Added# Swallow intentionally: test isolation must not fail the test run.comments to the bareexcept Exception: passblocks per CONTRIBUTING.md guidance.Note: A follow-up issue (#49) has been filed to address the production-side root cause in
ReactiveCleverAgentsApp.__init__(move verbosity logic to a named child loggerlogging.getLogger("cleveractors")instead of mutating the root logger).features/templates_coverage.feature+features/steps/templates_steps.py— New smoke test forTemplateRegistryre-exportAdded BDD scenario verifying that
from cleveractors.templates import TemplateRegistrysucceeds and the imported class is the same object ascleveractors.templates.registry.TemplateRegistry. This follows the same pattern used by other top-level re-export smoke tests (e.g.,execution_limits.feature:32–34).Fixes applied from review:
context: Anyannotations from the three new step functions to match the existing local style intemplates_steps.py(no annotation oncontext).except Exceptiontoexcept ImportErrorinstep_tc_import_template_registryper project convention.(tc)suffix from all three step names (none of them actually conflict with existing steps).features/runtime_coverage.feature+features/steps/runtime_coverage_steps.py— NewExecutor.__init__None-handling testsAdded three BDD scenarios that construct
Executordirectly (not viacreate_executor) to exercise theNone → {}code paths inExecutor.__init__:Executor(config_dict, credentials)— nolimits/pricingkwargs at all → both default to{}Executor(config_dict, credentials, limits=None)— explicitlimits=None→limitsdefaults to{}Executor(config_dict, credentials, pricing=None)— explicitpricing=None→pricingdefaults to{}These complement the existing
create_executor with None limits and pricingscenario, which only exercises the factory path (whereNonewas previously pre-converted before reaching__init__).CHANGELOG.md### Fixed(after the second### Addedheader was removed) have been moved back to### Added. Entries likeExecutor.execute_stream(),create_executor(),ActorResult and NodeUsage types,merge_configs(),validate_dict(),Registry HTTP Client,Registry Client-Side Cache,Per-request credential injection,Structured ExecutionError fields, etc. are all new features, not bug fixes.### Fixedsections: There were two### Fixedsections; they have been merged into one canonical section.ActorResult.stateattributed to ADR-2026).### Fixedentry for the root-logger fix to mention handler set restoration (the fix now restores root logger level, handler levels, AND removes leaked handlers).Quality Gate Results
nox -s lintnox -s typechecklangchain_google_genai)nox -s unit_testsnox -s coverage_reportnox -s integration_testsDesign References
ActorResult.statefor stateless resumption)Known Limitations / Deferred Items
ReactiveCleverAgentsApp.__init__still mutates the root logger level and handler levels globally. The test-side workaround infeatures/environment.pyis now fully hermetic (saves/restores root level, handler levels, AND removes leaked handlers). The production-side fix (moving verbosity logic to a child logger) is tracked in issue #49.Closes #17
14b59ca201to203a433120203a433120to35ecb8d87535ecb8d875toe0625f3cdbe0625f3cdbto5776daed1b5776daed1bto88ca16e238View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.