Compare commits

...
Author SHA1 Message Date
praisonai-triage-agent[bot] e7076d0949 Release v4.7.19 2026-10-26 22:19:43 +00:00
Mervin Praison 6aabf3a856 Merge pull request #6067 from MervinPraison/chore/aiui-floor-0.3.148
chore(deps): require aiui>=0.3.148 for PraisonAI Replay embed
2026-10-26 23:16:09 +01:00
Mervin Praison 5fe1a61697 Merge branch 'main' into chore/aiui-floor-0.3.148 2026-10-26 22:25:29 +01:00
MervinPraison cd5f61d14c docs: auto-update feature parity trackers [skip ci] 2026-10-26 21:22:28 +00:00
153e4c8078 fix: make completion promise the only autonomy success signal (#6064)
* fix: make completion promise the only autonomy success signal (fixes #6027)

When a completion_promise is configured, the tool_completion, keyword,
direct-stage and no_tool_calls heuristics no longer end the run with
success=True in run_autonomous/run_autonomous_async. Promise-less runs are
unchanged. The async tool path now increments _autonomy_turn_tool_count for
sync/async parity, and `praisonai loop` sets mode="iterative" so
--completion-promise/--max-iterations take effect without --level full_auto.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: tell the model the completion promise and only count executed async tools

Addresses review on #6064: SDK autonomy loops now append the expected
<promise> tag to the prompt (unless already present in the prompt or
instructions), and the async per-turn tool count is incremented only after
the tool runs so BEFORE_TOOL-blocked calls cannot trigger tool_completion.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 22:20:59 +01:00
4be3be0797 fix: require approval for GitHub write tools and scope git to repo_path (#6063)
* fix: require approval for GitHub write tools and scope git to repo_path (fixes #6023)

- Register github_create_branch/commit_and_push/create_pull_request as
  high-risk and add them to the default deny preset, so unattended agents
  need an explicit allow (same as execute_command).
- Add optional repo_path (cwd for every git/gh call) and paths args.
- Stage with 'git add -u' (+ explicit paths) after the branch-safety
  checks, so untracked files are not swept in and a refusal leaves the
  index untouched.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: scope github_commit_and_push staging to the working directory

git add -u with no pathspec stages tracked edits across the whole
repository, so a call from a subdirectory could publish unrelated sibling
changes. Use 'git add -u -- .' and scope the no-changes status check the
same way.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 22:20:54 +01:00
ebf0a1b275 fix: run kanban dispatcher git work off the event loop (#6059)
* fix: run kanban dispatcher git work off the event loop (fixes #6039)

- dispatch_once / _spawn_worker / _shutdown hand _cleanup_completed_tasks
  and _prepare_worktree to a worker thread, serialised by a class-level
  lock so integrations never run git concurrently in the base checkout.
- Workers start in their own session; shutdown SIGTERMs every worker
  group first, waits for all of them off the loop, then SIGKILLs groups
  that are still alive.
- Sync helpers are unchanged, so the CLI one-shot dispatch path keeps
  working.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: clean up cancelled worktree prep and always SIGKILL worker groups on shutdown

- Cancelling dispatch during worktree preparation now waits for the git
  thread, discards the unused worktree/branch, closes the run and releases
  the claim before re-raising.
- Shutdown SIGKILLs every worker's process group even when the worker
  itself already exited, so SIGTERM-ignoring descendants cannot survive.
- Tests: new cancellation test; descendant test uses a marker file and a
  SIGTERM-ignoring child instead of os.kill(pid, 0), which zombies pass.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 22:20:46 +01:00
c25c5f042d fix: make loop-guard turn time limit configurable and raise the default (fixes #6026) (#6057)
* fix: make loop-guard turn time limit configurable via ExecutionConfig.max_execution_time (fixes #6026)

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: clarify that only ExecutionConfig.max_execution_time=0 disables the turn time limit

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 22:20:41 +01:00
58fbee09e4 fix: walk fallback_models on the custom-LLM chat/achat path (#6053)
* fix: walk fallback_models on the custom-LLM chat/achat path (fixes #6030)

provider/model, dict, base_url and model-object agents call
LLM.get_response* directly and turned any primary-model outage into a
None turn without trying a single fallback model. Wrap that call so a
fallback-class error (per classify_llm_error) moves to the next entry in
fallback_models via a throwaway per-call LLM, emitting MODEL_FALLBACK.
self.llm_instance is never mutated, so concurrent turns keep the primary.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: keep base_url for bare-name fallbacks and skip fallback after a tool ran

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 22:20:36 +01:00
7c64856641 fix: kanban dispatcher re-runs healthy long tasks and orphans workers (#6048)
* fix: kanban dispatcher heartbeats its live workers instead of re-running them (fixes #6025)

The dispatcher stamped a worker's heartbeat only at spawn, so any task
running longer than claim TTL + stale timeout (~30 min by default) was
reclaimed while healthy, re-dispatched, and the first worker orphaned.

- Renew lease/heartbeat for every live child before the reclaim sweep;
  terminate a child whose claim was lost.
- Never overwrite a running worker's handle in running_tasks.
- Close a reclaimed task's open run as 'crashed' and count the failure.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: close reclaimed kanban run atomically and keep lost-claim worktree tracking

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: log run_closed when reclaim closes a run; scope headless output_file test to its project root

The reclaim sweep now records the usual run_closed event in the same
transaction that closes the abandoned run. test_output_file_and_metrics_json
writes under tmp_path, which the #5770 project-root guard rejects; point
PRAISONAI_PROJECT_ROOT at tmp_path so the test checks the written files
without loosening the guard. This test already fails the same way on main.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 22:20:32 +01:00
ee454013b0 fix: keep gateway scheduler tick alive on errors (#6047)
* fix: keep gateway scheduler tick alive on errors (fixes #6035)

A tick that raises (store lock I/O such as EMFILE, a malformed scheduler:
block) is now logged and retried with capped backoff instead of ending
_scheduler_task for good. _build_run_policy tolerates a non-mapping
scheduler: block by warning and using the fail-closed defaults.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: cap scheduler backoff exponent and scope headless output_file test to its project root

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: whitespace in headless output_file test

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 22:20:27 +01:00
Mervin PraisonandClaude Opus 5.5 f4ac213ae2 test: set the project root for headless YAML output_file tests (#6071)
#5770 contains task output_file writes to the project root (cwd or
PRAISONAI_PROJECT_ROOT), matching Agent.output_file. These tests write under
tmp_path, which is outside the cwd, so main's test-core (root) failed with
'output_file not written'. Point the project root at tmp_path.

Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 22:18:24 +01:00
MervinPraisonandClaude Opus 5.5 ec978dd399 chore(deps): require aiui>=0.3.148 for PraisonAI Replay embed (watch / replay_app)
aiui 0.3.148 ships create_replay_app (PraisonAIUI#317), which
praisonai.replay.watch() and replay_app() (#6017) need.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 19:38:01 +00:00
Mervin Praison a5f35a7a9e Merge pull request #6016 from MervinPraison/fix/replay-rerun-prefix-variables
fix(replay): restore handler step variables on re-run; reject steps inserted before the target
2026-10-26 19:46:09 +01:00
MervinPraison 597868883f docs: auto-update feature parity trackers [skip ci] 2026-10-26 18:42:35 +00:00
56c34fd055 fix(ts): send maxOutputTokens so the AI SDK output-token cap applies (#6013)
* fix(ts): send maxOutputTokens to the AI SDK so the output-token cap applies

AI SDK 5 renamed generateText/streamText's `maxTokens` to `maxOutputTokens`
and ignores the old key. The package pins ai@^6, so AISDKBackend (and
src/ai/generate-text.ts) passed a key the SDK drops: neither
SAFE_DEFAULTS.maxOutputTokens (4096) nor a caller's maxTokens reached the
model on any AI SDK-backed provider (Anthropic, Google, ...).

Send maxOutputTokens, and keep maxTokens for the ai@4 peer range.
Found with SoreqAI (soreqai.com).

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* test(ts): cover maxOutputTokens on all five changed AI SDK calls

Per review: generateText alone left four calls untested. Adds
AISDKBackend.streamText (stream drained so the SDK call runs) and
generateObject, plus the generateText/streamText helpers in
src/ai/generate-text.ts, each checking the default cap and a caller override.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix(ts): send maxOutputTokens from the generateObject/streamObject helpers too

Per CodeRabbit: src/ai/generate-object.ts passed only the old maxTokens key
to sdk.generateObject and sdk.streamObject, the same dropped-cap bug. Adds
maxOutputTokens there and a test for each helper.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: Shaked Yacoby <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 19:42:01 +01:00
Swapnil Yadav 13d02e41d1 fix(context-agent): write saved artifacts as UTF-8 (#5989)
* fix(context-agent): write saved artifacts as UTF-8

ContextAgent saved its PRP, analysis summary, and results/interaction
files with the platform default encoding, while other writers in the same
file already pass encoding="utf-8". Writing a PRP or summary that contains
non-ASCII (any non-English content) raised UnicodeEncodeError on Windows,
and the JSON results escaped non-ASCII to \uXXXX. Open every ContextAgent
output file as UTF-8 and dump JSON with ensure_ascii=False so the saved
artifacts are readable and portable, matching the rest of the module.

* test(context-agent): keep the regression test's files inside tmp_path

* test(context-agent): cover all result JSON writers for UTF-8

Populate non-ASCII in every result field and assert each saved file
(comprehensive_analysis, pattern_library, validation_framework,
all_agent_interactions) round-trips as readable UTF-8, not just
comprehensive_analysis.json.
2026-10-26 19:41:56 +01:00
Swapnil Yadav e4b1088f68 fix(memory): use timezone-aware UTC timestamps in the learn store (#5988)
* fix(memory): use timezone-aware UTC timestamps in the learn store

The learn store built timestamps with the deprecated datetime.utcnow(),
which returns a naive datetime. Retention pruning subtracted a naive now
from timestamps parsed back from storage, and datetime.utcnow().timestamp()
computed the wrong epoch by treating the naive UTC value as local time.

Use datetime.now(timezone.utc) everywhere, and when parsing a stored
timestamp that predates this change (naive, no offset), treat it as UTC so
pruning keeps working on existing stores instead of raising "can't subtract
offset-naive and offset-aware datetimes".

* test(memory): add docstrings to learn-store timestamp tests

* fix(memory): normalize timestamps before sorting in the learn store

list_all() and the excess-entry pruning sorted raw ISO strings, so a
stored timestamp with a non-UTC offset could order against a UTC value in
the wrong direction. Add a shared sort key that parses each timestamp,
treats naive values as UTC, and buckets unparseable ones last. Covers the
updated_at ordering and the last_used/created_at pruning tie-breakers.

Also add an end-to-end prune() test and a list ordering test for mixed
offsets.

* fix(memory): sort missing/malformed timestamps as oldest in the learn store

Bucketing unparseable values last flipped prune()'s eviction order: an
entry never used (last_used=None, which parses as empty) sorted after used
ones, so it was evicted last instead of first. Bucket missing/malformed
values as the oldest instant instead. prune() (ascending) then evicts them
first, matching the previous raw-string behaviour, and list_all()
(descending) still lists them last. Add a regression test with two
use_count=0 entries where only one was ever used.
2026-10-26 19:41:49 +01:00
51accf43c6 fix: window doom-loop per-tool count and harden download_file SSRF/size cap (#5959)
* fix: window doom-loop per-tool count and route download_file through shared SSRF guard (fixes #5957)

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: keep download_file SSRF guard independent of ALLOW_LOCAL_CRAWL (#5957)

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: download_file writes to temp file so a rejected download keeps the existing destination (#5957)

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 19:41:43 +01:00
64d3924985 fix: detect cancel_token support by signature instead of replaying on TypeError (fixes #5884) (#5885)
Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 19:41:37 +01:00
abc3d72197 fix(security): contain Task and Workflow step output_file writes in project root (#5770)
* fix(security): contain Task and Workflow step output_file writes in project root

AgentTeam.save_output_to_file and both workflow step writers opened
output_file without the resolve_within_root check Agent.output_file
already applies, so a relative or {{input}}-templated path could write
anywhere on disk. Route all three through a shared write_output_file
helper that rejects paths outside the project root (PRAISONAI_PROJECT_ROOT
or cwd), honours create_directory and writes UTF-8.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
Signed-off-by: Stanley Shen <[email protected]>

* fix: preserve output_file permissions on overwrite

atomic_write_text replaces the destination with a mkstemp file (0600),
which silently made shared reports owner-only. Use plain open() like
Agent.output_file so existing modes and umask are kept.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: replace existing output_file instead of truncating it

Truncating in place writes through a hardlink to a file outside the
project root. Create new files exclusively so umask applies, and replace
existing ones atomically, restoring their previous mode.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: Stanley Shen <[email protected]>

* fix: overwrite output_file in place unless it is hardlinked

Replacing the file through a temp file needed write access to the parent
directory and changed the mode through the destination path afterwards.
Truncate the existing file in place when it has a single link, and only
unlink and recreate it (with the old mode) when it is hardlinked.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: Stanley Shen <[email protected]>

* fix: swap in hardlinked output_file replacement after writing it

Unlinking first lost the old report if creating or writing the new one
failed, and the replacement's mode was masked by umask. Write a temp file
in the same directory, set the old mode on its descriptor, then
os.replace it over the hardlinked name.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: Stanley Shen <[email protected]>

* fix: keep group on hardlinked output_file replacement or drop group bits

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Signed-off-by: Stanley Shen <[email protected]>
Co-authored-by: Claude Sonnet 5.5 <[email protected]>
Co-authored-by: MervinPraison <[email protected]>
2026-10-26 19:41:31 +01:00
MervinPraisonandClaude Opus 5.5 aef2f8ecee fix(replay): snapshot nested-step variables only when the step really runs, not when skipped or cached
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 17:38:25 +00:00
praisonai-triage-agent[bot] a28549c977 Merge pull request #6019 from MervinPraison/claude/issue-6018-20261026
fix: remove dead praisonaiagents/eval/utils.py (duplicate of BaseEvaluator._save_result)
2026-10-26 17:30:15 +00:00
MervinPraisonandClaude Opus 5.5 a62ae64398 fix: remove unreferenced eval/utils.py duplicating BaseEvaluator._save_result (fixes #6018)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 17:17:07 +00:00
MervinPraisonandClaude Opus 5.5 3e73cfd68b fix(replay): copy nested-step variables per value so one uncopyable value does not disable change detection
Before, one variable that could not be deep-copied (a lock or a client, for
example) switched the whole snapshot to identity comparison, so a list another
variable's step changed in place was no longer recorded on step_end. Use the
existing _isolate_scope, which shares only the uncopyable values.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 16:38:18 +00:00
MervinPraison 629bc88a9c docs: auto-update feature parity trackers [skip ci] 2026-10-26 16:22:43 +00:00
praisonai-triage-agent[bot] bc3ed37841 Merge pull request #5981 from MervinPraison/claude/issue-5980-20261025
fix: re-runnable AgentTeam.start/astart, non-mutating RAG overrides, SmartRetriever filter/error contracts
2026-10-26 16:22:00 +00:00
MervinPraison b6a8ab1d46 docs: auto-update api.md [skip ci] 2026-10-26 16:13:16 +00:00
praisonai-triage-agent[bot] 783a940d11 Merge pull request #6017 from MervinPraison/feat/replay-show
feat(replay): watch() / replay_app(): a Run button that draws each run live, and embedding
2026-10-26 16:11:15 +00:00
MervinPraisonandClaude Opus 5.5 8eed25c3c2 fix: keep propagated-variable ownership across start_for_each so later runs pick up current team variables
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 16:03:32 +00:00
MervinPraisonandClaude Opus 5.5 693a3337b2 fix: keep caller-defined Task.variables on AgentTeam rerun, retain injected content across resume, deterministic race tests
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 15:58:49 +00:00
MervinPraisonandClaude Opus 5.5 fcf4bebc15 fix: re-runnable AgentTeam.start/astart, non-mutating RAG.retrieve overrides, and SmartRetriever filter/error contracts (fixes #5980)
- AgentTeam: a repeated start()/astart() resets per-task run state and the
  content the previous run injected, instead of skipping completed tasks and
  returning stale output. restore_session_state() still resumes.
- RAG.retrieve: resolve top_k/rerank per call instead of writing them to the
  shared RAGConfig (aretrieve runs concurrently in an executor).
- SmartRetriever: over-fetch before post-filtering, raise ValueError on an
  invalid path_filter regex, return store errors from _search instead of
  storing them on self.
- SubQuestionEngine: unwrap RetrievalResult.chunks from SmartRetriever.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 15:58:49 +00:00
MervinPraison 6f09f5e02f docs: auto-update feature parity trackers [skip ci] 2026-10-26 15:57:45 +00:00
Wu Shuwen f74706d573 fix: check failed workflow dependencies before dispatch (#5936) 2026-10-26 16:57:13 +01:00
Wu Shuwen 2f93c7bf82 fix: keep synchronous input guardrails off the async event loop (#5932)
* fix: offload synchronous input guardrails in achat

* perf: retain disabled input guardrail fast path

* perf: avoid thread dispatch for output-only guardrails
2026-10-26 16:57:07 +01:00
Wu Shuwen b5713a302d fix: avoid default memory-tool import for supplied adapters (#5896)
* fix: use supplied memory adapter without importing default tool

* test: focus memory adapter checks on capability and input ownership
2026-10-26 16:57:01 +01:00
Wu Shuwen 87a3baea82 perf: defer handoff import when no conversion is needed (#5894)
* perf: defer handoff import when no conversion is needed

* test: document handoff import regression scenarios
2026-10-26 16:56:56 +01:00
Wu Shuwen f50f64ef93 fix: populate existing after-LLM hook token usage (#5890) 2026-10-26 16:56:50 +01:00
Wu Shuwen 942c5dbac0 fix: reject undefined YAML route targets (#5888) 2026-10-26 16:56:44 +01:00
Wu Shuwen 53afc70905 fix: return retained completions from synchronous default wait (#5887)
* fix: return retained completions from synchronous default wait

* fix: preserve explicit empty completion target selection
2026-10-26 16:56:38 +01:00
Wu Shuwen dabc3f5593 fix: align asynchronous moderation default model (#5886) 2026-10-26 16:56:32 +01:00
MervinPraisonandClaude Opus 5.5 3bee2f57de fix(replay): restore team task context between runs, await async targets, bracket IPv6 URL
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 15:53:29 +00:00
MervinPraisonandClaude Opus 5.5 06c97d3d7a test(replay): prove a recorded skip stays skipped on re-run (replaces a test that only checked a file existed)
Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 15:52:48 +00:00
MervinPraisonandClaude Opus 5.5 e3a4319b50 fix(replay): keep full outputs out of cached step_end; check nested targets; compare nested variables by value
- core: a step-cache hit traced the cached variables, which include the step's
  output variable (its full output), bypassing preview-only recording. Trace
  only what the handler set, as the cold run does.
- core: nested-step variables are diffed against a deep copy (recording only),
  so a list or dict changed in place counts as set; identity missed it and a
  re-run restored the stale value.
- wrapper: the inserted-step check now covers a target nested in a pattern
  (e.g. If): every top-level step before its container must have run.

Addresses the merge-gate findings on #6016 (workflows.py:2044, rerun.py:316,
workflows.py:3143).

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 15:51:27 +00:00
MervinPraisonandClaude Opus 5.5 faba52b940 feat(replay): watch() / replay_app(): a Run button that draws each run live, and embedding
- praisonai.replay.watch(target): serves a page with a Run button; each click
  records the Agent/AgentTeam/AgentFlow/YAML/callable under a new run id and the
  page draws it live (map: not reached / running / done). A team's tasks start
  afresh each run (AgentTeam otherwise skips completed tasks).
- praisonai.replay.replay_app(target=None): the same page as an ASGI app to mount
  in your own FastAPI/Starlette app; /replay/?run=<id> shows one run (iframe).
- CLI: praisonai replay watch [agents.yaml] ("show" was taken).
- examples/replay: watch_flow.py (no key), watch_team.py, embed_fastapi.py.

Needs aiui with create_replay_app (MervinPraison/PraisonAIUI#317); older aiui
gets a clear "pip install -U praisonai[ui]" error and the tests skip.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 15:47:17 +00:00
MervinPraisonandClaude Opus 5.5 91641a906d fix(replay): record nested-step variables; reject redacted restores and unnamed inserted steps
- core: steps run via _execute_single_step_internal (patterns, hierarchical)
  now record the variables they set on step_end, like the sequential path.
- wrapper: plan_rerun refuses to restore a variable the recording redacted,
  instead of feeding the literal [REDACTED] marker to later steps.
- wrapper: the inserted-step check matches top-level steps by graph node id,
  so an unnamed pattern (e.g. If) before the target is rejected too.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 15:14:29 +00:00
MervinPraison 930d6d9837 docs: auto-update api.md [skip ci] 2026-10-26 14:27:30 +00:00
MervinPraisonandClaude Opus 5.5 746cb1fcdf fix(replay): restore handler step variables on re-run; reject steps inserted before the target
- core: step_end records the variables a step set (redacted), so a re-run can
  restore them; before this, step_end carried none and the wrapper's restore
  path had nothing to read from a real recording.
- wrapper: plan_rerun records which steps started before the target; seed_flow
  refuses a flow that has an earlier step the recording never ran, instead of
  silently feeding the target the wrong prefix.

Addresses review threads on #6011 (rerun.py:240, rerun.py:297).

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 14:27:05 +00:00
Mervin Praison 05d38d1705 Merge pull request #6010 from MervinPraison/feat/replay-core
feat(replay): complete run events (run/parent ids, tasks, steps, hand-offs, approvals, LiteLLM) and graph export for Replay
2026-10-26 15:26:56 +01:00
adbc6d7b3d fix: route Telegram/Discord/Slack group gating through core admission primitive (#5911)
* test: cover cross-channel group admission parity (#5908)

Adapter routing landed on main via #5962 (_group_policy); this keeps the
parity tests, retargeted at decide_group_admission.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: cap litellm <1.106 to stay compatible with mcp<2 pin

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* fix: sync praisonai-code uv.lock with litellm<1.106 cap

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: MervinPraison <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-26 14:53:18 +01:00
MervinPraisonandClaude Opus 5.5 c763f77014 docs(replay): note that the recording is the run boundary for run_id
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 13:48:11 +00:00
MervinPraison a0516b47db docs: auto-update api.md [skip ci] 2026-10-26 13:44:43 +00:00
Mervin Praison 1d65000a30 Merge pull request #6011 from MervinPraison/feat/replay-wrapper
feat(replay): praisonai replay view/export/rerun, record(), OTel and self-contained HTML export
2026-10-26 14:44:17 +01:00
MervinPraisonandClaude Opus 5.5 e5983ca964 fix(replay): keep distinct route labels when merging a shared graph edge
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 13:18:22 +00:00
MervinPraisonandClaude Opus 5.5 d5b87bb052 chore(parity): record AgentTeam.to_graph/to_mermaid as Python-only
The signature gate flags new Python public methods without a TypeScript
counterpart. Replay's graph export is Python-only for now (the TS SDK has no
Replay viewer or run-event schema 1.1 yet), so the two methods are recorded in
the inventory baseline; the regenerated parity reports only move line numbers.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 13:10:45 +00:00
Mervin PraisonandClaude Opus 5.5 f060fcfbdd fix(browser): assert start_automation on send_json; run test_server.py in CI (#6012)
#5818 moved start_automation delivery from send_text to send_json, but
test_ws_no_origin_cli_start_session still asserted send_text, and a
not-awaited check on send_text became vacuous. CI never ran test_server.py
(only test_protocol_compliance.py), so the break went unseen.

Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 13:52:09 +01:00
MervinPraisonandClaude Opus 5.5 3250b28893 fix(replay): export filename ignores unsafe trace run ids; rerun rejects reordered flows
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 12:42:02 +00:00
MervinPraisonandClaude Opus 5.5 e36fa35ef5 fix(replay): strip ANSI codes before checking view --help flags
Rich forces colour under GITHUB_ACTIONS and splits '--live' with escape
codes, so the plain substring check failed on CI only.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 12:38:55 +00:00
MervinPraisonandClaude Opus 5.5 7f92faff5e fix(replay): address review findings on graph export and LLM events
- llm: snapshot the messages list in llm_request; record the model that
  served the response (failover) for name and cost
- diagram: draw when/then_task/else_task team routes; keep both labels
  when two conditions share a target; expand Repeat(step=[...]) members
- tests: replace wall-clock import budget with a deterministic check;
  add regression tests for each fix

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 12:28:29 +00:00
MervinPraisonandClaude Opus 5.5 be0b44ff35 fix(replay): rerun keeps step variables, rejects shortened answers and mismatched flows
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 12:26:32 +00:00
MervinPraisonandClaude Opus 5.5 c90f145745 fix(replay): HTML export runs aiui's renderer instead of the fallback table
aiui's replay-core.js and replay.js are ES modules (export statements). Inlined
as classic <script> elements they threw a SyntaxError, so an exported run only
ever showed the built-in fallback table. Inline them as module scripts.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 2337d08a01 fix(replay): rerun accepts the Path that record() returns
plan_rerun only treated str as a trace path, so passing rec.path (a
pathlib.Path) straight from record() crashed with 'PosixPath is not iterable'.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 d73f4d4b8e fix(replay): a team YAML's map uses the ids its run emits
`replay flow team.yaml` built the static graph from the YAML flow conversion,
which gives step: node ids, while running the same YAML builds an AgentTeam
whose events carry task:/agent: ids, so live events never landed on the map.
Team YAMLs now go through the PraisonAI adapter's own builders (no LLM call);
flow YAMLs and older SDKs keep the previous path.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 e6f6ba9d57 fix(replay): record() stamps its run_id on every event
record() passed run_id only to emitters that took it as an argument, and the
schema 1.1 emitter stamps it through a run scope instead, so events outside a
team or flow (session start/end, a single agent's hand-off) had no run_id.
record() now enters the SDK run scope for the whole recording; nested teams
and flows inherit it. Older SDKs without run scopes are unaffected.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 5dfac0c01f test(replay): real agentic record -> export test (gated)
RUN_REAL_KEY_TESTS=1 PRAISONAI_ALLOW_NETWORK=1 with OPENAI_API_KEY: one
gpt-4o-mini call under record(live=True), then replay export --format
html and --format otel on the recorded trace.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 d49a32f713 feat(replay): rerun a recorded run from a node (P4)
replay rerun RUN --from NODE_ID [--file YAML]; Python:
praisonai.replay.rerun.rerun(flow_or_team, run, node_id).

- plan_rerun reads the recording: outputs of every task/step that
  finished before NODE started (completed/cached). A preview cut at 500
  chars is recovered from the span's last llm_response, otherwise the
  rerun refuses rather than feed the next node a truncated input. 1.0
  traces (no node_id) and unknown nodes fail with a clear message.
- AgentFlow: TraceStepCache implements StepCacheProtocol and serves the
  recorded outputs through the flow's own cache-hit path (variables,
  previous_output, callbacks), identifying the asking step by the
  "running" status the flow sets just before the lookup; set() is a
  no-op so NODE onwards always executes.
- AgentTeam: the team's checkpoint restore (_restore_serialised_task_state)
  marks earlier tasks completed with their recorded output; tasks from
  NODE on are reset to "not started".
- YAML runs: a zero-cost ContextVar hook (replay/_hook.py) seeds the
  team/flow AgentsGenerator builds; the CLI checks the YAML kind first so
  a mismatch is refused before any LLM call.
- The new run records forked_from = {run_id, node_id} on session_start
  and on its first workflow_start (sink wrapper, no core change needed).

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 27672202e2 feat(replay): replay view / export CLI, mermaid flow and YAML static graph
- replay flow <run|yaml> --format ascii|json|mermaid: a YAML file gives
  the static graph (diagram.to_graph / graph_to_mermaid when the SDK has
  them, else AgentFlow.to_mermaid()); a run gives the sequence diagram.
  Existing ascii/json output for runs is unchanged.
- replay view [RUN|JSONL|YAML] [--live] [--port 8090] [--host 127.0.0.1]
  launches aiui with the new praisonai/ui_replay preset (pages=["replay"])
  and opens http://127.0.0.1:<port>/#/replay?run=<id>. A YAML file is run
  recorded live in a background thread while serving; a JSONL path
  serves its own directory (PRAISONAI_TRACES_DIR for the server). Warns
  on a non-loopback host, fails with the pip install "praisonai[ui]"
  hint when aiui is missing, and stops the server on exit/SIGTERM.
- replay export RUN --format html|json|mermaid|otel [-o FILE]
  [--no-redact].

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 cf241acdf1 feat(replay): export runs to JSON, Mermaid, OTLP-JSON and one HTML file
praisonai.replay.export, stdlib only:
- to_json: {schema, run_id, graph, events}.
- to_mermaid: sequenceDiagram with lanes You / Manager / one per agent;
  messages are task boundaries, hand-offs/delegations and approvals
  (1.0 traces fall back to agent start/end).
- to_otlp_json: offline OTLP/JSON with OTel GenAI semconv
  (invoke_workflow / invoke_agent / chat / execute_tool, INTERNAL
  task/step/approval spans), traceId = sha256(run_id)[:32],
  spanId = sha256(run_id:start_seq)[:16], parents from parent_seq or
  nesting; scope marked gen_ai.semconv.stability=development.
- to_html: self-contained page, no CDN. Inlines aiui's standalone
  replay-core.js + replay.js when aiui ships them (detected at runtime),
  always includes a plain table timeline; embedded JSON escapes every
  "<" so event data cannot close the script.
- Everything is redacted by default (praisonaiagents.trace.redact key
  rules + scrub_pii_text), keeping numeric token counters; redact=False
  opts out.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 4629a75276 feat(replay): record() context manager and env-aware traces dir
- Traces live in PRAISONAI_TRACES_DIR, else $PRAISON_HOME/traces (the
  root trace/last_run.py already uses), else ~/.praison/traces.
- praisonai.replay.record(run_id=None, *, live=False, meta=None,
  full_content=None) owns writer + emitter + set_context_emitter and the
  session_start/session_end pair; live=True flushes every event
  (buffer_size=1). It yields .run_id / .path.
- The three duplicated setup blocks (legacy praison_ai.py via the
  wrapper bridge, workflow run, recipe core) now use it. Recipe early
  returns (not found / missing deps / policy denied / dry run) used to
  leave the trace open and the emitter set; they now always close.
- save_replay: true in agents.yaml / workflow YAML records like --save
  (added to YAMLConfig, schema artefact regenerated). YAML runs store
  yaml_path in session_start so a rerun can find the definition.
- events.py: tolerant raw-dict reader (partial last line, unknown event
  types, schema 1.0 and 1.1) plus start/end span pairing.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:37 +00:00
MervinPraisonandClaude Opus 5.5 12d9ee0744 fix(replay): label an unnamed team run by its agents
AgentTeam.name defaults to None, so workflow_start carried no name and viewers
fell back to the first agent's name ('Researcher') as the run's title. An
unnamed team is now labelled by its agents ('Researcher + Writer'); a named
team keeps its name.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:36 +00:00
MervinPraisonandClaude Opus 5.5 82680b0970 test(replay): real agentic test for team, LLM and hand-off events
A two-agent AgentTeam on gpt-4o-mini (one agent on the OpenAI-client path, one
on the LiteLLM path) plus a real Triage -> Billing hand-off, recorded with a
ContextListSink. Asserts workflow/task/agent/llm events, the hand-off, the
team graph, run ids and resolvable parent links. Gated on RUN_REAL_KEY_TESTS=1,
PRAISONAI_ALLOW_NETWORK=1 and a real OPENAI_API_KEY; about five small calls.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:36 +00:00
MervinPraisonandClaude Opus 5.5 da00df8e69 feat(llm): record the Responses API calls on the LiteLLM path too
OpenAI models reached through LiteLLM (e.g. llm="openai/gpt-4o-mini") use
litellm.responses, not litellm.completion, so the real agentic run showed the
Writer agent with no LLM events. The four Responses API entry points (sync,
async, streamed sync, streamed async) are now thin traced wrappers around the
unchanged bodies, recording input/output tokens, text and cost.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:36 +00:00
MervinPraisonandClaude Opus 5.5 fea0c82680 test(replay): cover run events, spans, branches and every emission site
Schema round-trip and 1.0 back-compat, unknown event types, parent_seq and
run_id inheritance, 8 concurrent Parallel branches (branch_id, parent_seq,
unique sequence numbers), flow step statuses and chosen routes, team task
completed/skipped/failed (sync and async), the manager's delegate hand-off,
human-review and tool-call approval pairs, every hand-off path emitting once,
the LiteLLM path (mocked: sync, async, streaming, errors, no double count),
and a micro-benchmark that the disabled emitter adds next to nothing.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:36 +00:00
MervinPraisonandClaude Opus 5.5 9ba8c09bd9 feat(llm): record llm_request/llm_response on the LiteLLM path
Only the agent's OpenAI-client path recorded model calls, so a team or flow
running on any LiteLLM model showed no LLM activity in a replay. The two
LiteLLM choke points (_completion_with_retry and its async twin) now emit
the pair with model, duration_ms, prompt/completion tokens and cost when
litellm knows the price. Streams are wrapped in a pass-through that records
the response when the stream ends; with tracing off the stream is untouched.

A call the agent already recorded (its OpenAI-client dispatch can reach the
LiteLLM adapter) is not counted twice: the agent's llm_request leaves a
context marker the LLM class honours inside the same span. chat_mixin.py is
not modified.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:36 +00:00
MervinPraisonandClaude Opus 5.5 08ca3aca18 feat(replay): record hand-offs, team tasks, flow steps, manager choices and approvals
- agent/handoff.py: every place a hand-off actually happens (programmatic,
  async, LLM tool, typed sync/async) emits one agent_handoff(kind="handoff")
  with the context policy and redacted args.
- agents/agents.py: task_start/task_end (completed, failed after retries,
  skipped by should_run) on the sync and async paths in every process mode;
  workflow_start/workflow_end with the team graph inside _run_scope(run_id);
  approval_requested/approval_decided around human review.
- workflows/workflows.py: step_start/step_end for top-level and nested steps
  (completed/failed/skipped/cached) via helpers that wrap the existing
  on_step_start/on_step_complete calls; Route and If record the branch taken;
  pattern executors are wrapped once so every nesting level is covered;
  workflow_start/workflow_end with the flow graph and a fresh run id.
- process/process.py: the hierarchical manager's choice is an
  agent_handoff from "Manager" with kind="delegate", the task node id and a
  task-status summary (sync and async).
- approval/registry.py: approval_requested/approval_decided around the real
  backend call only (not the fast paths), args redacted.

All of it is skipped when the context emitter is disabled; the graph builder
is imported only for a traced run.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:36 +00:00
MervinPraisonandClaude Opus 5.5 662edacc9e feat(workflows): graph data for agents, teams and flows
One builder walks a definition and produces praisonai.graph/1 data with ids
derived from names and positions only (agent:, task:, step:, tool:,
human:you, manager:Manager, start:begin, end:done), so the ids are the same
in every process and are what replay events carry as node_id. Covers task
context/next_tasks/conditions, the hierarchical manager, hand-offs, tools,
human review and Route/Parallel/Loop/Repeat/If/Include/Discussion.

AgentFlow.to_mermaid() output is byte-identical (the builder records the
legacy draw order). Adds to_graph(), graph_to_mermaid(), AgentFlow.to_graph()
and AgentTeam.to_graph()/to_mermaid(). Stdlib only and never imported by
import praisonaiagents; golden JSON and a two-subprocess stability check pin
the shape.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:36 +00:00
MervinPraisonandClaude Opus 5.5 12a04358b3 feat(trace): replay schema 1.1 with run_id, parent_seq and node_id
Context events gain three optional fields (omitted from to_dict when unset)
so a replay can tell which run, which enclosing span and which graph node an
event belongs to. 1.0 traces still load, and from_dict keeps an unknown
event_type as its raw string (with .value) instead of relabelling it.

Branch id and the open-span stack move into contextvars keyed by emitter, so
concurrent Parallel/Loop branches no longer clobber each other; sequence
numbers come from itertools.count under a lock so append order matches
sequence order. Adds workflow/task/step/approval start/end events, a kind on
agent_handoff, and private _run_scope/_workflow_scope helpers. Every new
method is a no-op when the emitter is disabled.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
2026-10-26 12:05:36 +00:00
136 changed files with 11755 additions and 1122 deletions

No files matched your search

+1 -1
View File
@@ -256,7 +256,7 @@ jobs:
"
/tmp/praisonai-browser-standalone/bin/praisonai-browser --help
bash "$GITHUB_WORKSPACE/scripts/check_c11_browser_imports.sh"
python -m pytest src/praisonai-browser/tests/browser/test_protocol_compliance.py -q -m "not network"
python -m pytest src/praisonai-browser/tests/browser/test_protocol_compliance.py src/praisonai-browser/tests/browser/test_server.py -q -m "not network"
- name: Standalone praisonai-mcp smoke (C12)
run: |
+7
View File
@@ -717,6 +717,7 @@ Methods:
* <code title="class AgentFlow">AgentFlow.<a href="./src/praisonai-agents/praisonaiagents/workflows/workflows.py">state</a>()</code>
* <code title="class AgentFlow">AgentFlow.<a href="./src/praisonai-agents/praisonaiagents/workflows/workflows.py">stream</a>() -> bool</code>
* <code title="class AgentFlow">AgentFlow.<a href="./src/praisonai-agents/praisonaiagents/workflows/workflows.py">to_dict</a>() -> Dict[str, Any]</code>
* <code title="class AgentFlow">AgentFlow.<a href="./src/praisonai-agents/praisonaiagents/workflows/workflows.py">to_graph</a>() -> Dict[str, Any]</code>
* <code title="class AgentFlow">AgentFlow.<a href="./src/praisonai-agents/praisonaiagents/workflows/workflows.py">to_mermaid</a>() -> str</code>
* <code title="class AgentFlow">AgentFlow.<a href="./src/praisonai-agents/praisonaiagents/workflows/workflows.py">validate_variables</a>() -> None</code>
* <code title="class AgentFlow">AgentFlow.<a href="./src/praisonai-agents/praisonaiagents/workflows/workflows.py">verbose</a>() -> bool</code>
@@ -770,6 +771,8 @@ Methods:
* <code title="class AgentTeam">AgentTeam.<a href="./src/praisonai-agents/praisonaiagents/agents/agents.py">start</a>(content = None, return_dict = False, output = None, **kwargs)</code>
* <code title="class AgentTeam">AgentTeam.<a href="./src/praisonai-agents/praisonaiagents/agents/agents.py">start_for_each</a>(inputs, **kwargs)</code>
* <code title="class AgentTeam">AgentTeam.<a href="./src/praisonai-agents/praisonaiagents/agents/agents.py">stream_emitter</a>()</code>
* <code title="class AgentTeam">AgentTeam.<a href="./src/praisonai-agents/praisonaiagents/agents/agents.py">to_graph</a>() -> Dict[str, Any]</code>
* <code title="class AgentTeam">AgentTeam.<a href="./src/praisonai-agents/praisonaiagents/agents/agents.py">to_mermaid</a>() -> str</code>
* <code title="class AgentTeam">AgentTeam.<a href="./src/praisonai-agents/praisonaiagents/agents/agents.py">todo_list</a>()</code>
* <code title="class AgentTeam">AgentTeam.<a href="./src/praisonai-agents/praisonaiagents/agents/agents.py">update_plan_step_status</a>(step_id: str, status: str) -> bool</code>
* <code title="class AgentTeam">AgentTeam.<a href="./src/praisonai-agents/praisonaiagents/agents/agents.py">update_state</a>(updates: Dict) -> None</code>
@@ -898,9 +901,13 @@ Methods:
* <code title="cli">praisonai replay context <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay dashboard <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay delete <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay export <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay flow <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay list <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay rerun <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay show <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay view <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai replay watch <a href="./src/praisonai/praisonai/cli/commands/replay.py">--help</a></code>
* <code title="cli">praisonai run <a href="./src/praisonai/praisonai/cli/main.py">--help</a></code>
* <code title="cli">praisonai schedule add <a href="./src/praisonai/praisonai/cli/commands/schedule.py">--help</a></code>
* <code title="cli">praisonai schedule blueprint <a href="./src/praisonai/praisonai/cli/commands/schedule.py">--help</a></code>
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.7.18" \
"praisonai>=4.7.19" \
"praisonai[chat]" \
"embedchain[github,youtube]"
+1 -1
View File
@@ -20,7 +20,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.7.18" \
"praisonai>=4.7.19" \
"praisonai[ui]" \
"praisonai[chat]" \
"praisonai[realtime]" \
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.7.18" \
"praisonai>=4.7.19" \
"praisonai[ui]" \
"praisonai[crewai]"
+16
View File
@@ -0,0 +1,16 @@
# PraisonAI Replay: watch runs live
| Example | What it shows |
|---|---|
| `watch_flow.py` | Click **Run** and watch each step light up on the map; **Play** goes through it again. No API key. |
| `watch_team.py` | The same for two real agents (needs `OPENAI_API_KEY`). |
| `embed_fastapi.py` | Your own app starts a run and shows its progress in an `<iframe>` (`app.mount("/replay", replay_app())`). |
The same from the command line, for a YAML file:
```bash
praisonai replay watch agents.yaml
```
Install: `pip install "praisonai[ui]"`. Keep the page on localhost or behind your app's
login: anyone who can reach it can read the runs, and with a Run button, start one.
+60
View File
@@ -0,0 +1,60 @@
"""Show agent progress inside your own web app.
Your app starts the run and records it; the Replay view, mounted at /replay,
draws it live in an <iframe>. No dashboard, no second server.
pip install "praisonai[ui]" fastapi uvicorn
uvicorn embed_fastapi:app --port 8000 # open http://127.0.0.1:8000/
"""
import threading
import time
import uuid
from fastapi import FastAPI
from fastapi.responses import HTMLResponse
from praisonaiagents import AgentFlow
from praisonaiagents.workflows import StepResult
from praisonai.replay import record, replay_app
def research(ctx):
time.sleep(1.2)
return StepResult(output="notes")
def write(ctx):
time.sleep(1.2)
return StepResult(output="article")
flow = AgentFlow(name="Article", steps=[research, write])
app = FastAPI()
app.mount("/replay", replay_app()) # read-only view: /replay/?run=<id> shows one run
@app.post("/generate")
def generate():
run_id = f"run-{uuid.uuid4().hex[:12]}"
def job():
with record(run_id, live=True): # live: the view follows it as it is written
flow.start("solar sails")
threading.Thread(target=job, daemon=True).start()
return {"run_id": run_id}
@app.get("/", response_class=HTMLResponse)
def home():
return """<!doctype html><title>My app</title>
<h1>My app</h1>
<button id="go">Generate article</button>
<iframe id="progress" title="Progress" style="width:100%;height:640px;border:1px solid #ccc"></iframe>
<script>
go.onclick = async () => {
const { run_id } = await (await fetch('/generate', { method: 'POST' })).json();
progress.src = '/replay/?run=' + run_id;
};
</script>"""
+40
View File
@@ -0,0 +1,40 @@
"""Watch a flow run, step by step: click Run and each step lights up on the map.
No API key needed (the steps are plain Python that take a moment each).
pip install "praisonai[ui]"
python watch_flow.py # opens http://127.0.0.1:8090/
Map: dashed = not reached, blue = running now, green = done.
After a run, press Play to go through it again one step at a time.
"""
import time
from praisonaiagents import AgentFlow
from praisonaiagents.workflows import StepResult
from praisonai.replay import watch
def research(ctx):
time.sleep(1.5)
return StepResult(output=f"3 sources about {ctx.input}")
def outline(ctx):
time.sleep(1.5)
return StepResult(output="intro, body, close")
def draft(ctx):
time.sleep(1.5)
return StepResult(output="first draft")
def review(ctx):
time.sleep(1.5)
return StepResult(output="approved")
flow = AgentFlow(name="Write an article", steps=[research, outline, draft, review])
watch(flow, input="solar sails")
+18
View File
@@ -0,0 +1,18 @@
"""Watch two agents work together, live (calls the LLM: needs OPENAI_API_KEY).
python watch_team.py # opens http://127.0.0.1:8090/, press Run
"""
from praisonaiagents import Agent, AgentTeam, Task
from praisonai.replay import watch
researcher = Agent(name="Researcher", instructions="Give 3 short facts.", llm="gpt-4o-mini")
writer = Agent(name="Writer", instructions="Write one short paragraph from the facts.", llm="gpt-4o-mini")
team = AgentTeam(
agents=[researcher, writer],
tasks=[
Task(name="research", description="3 facts about solar sails", agent=researcher, expected_output="3 facts"),
Task(name="write", description="One paragraph using the facts", agent=writer, expected_output="a paragraph"),
],
)
watch(team)
@@ -463,7 +463,11 @@ class Agent(GoalLoopMixin, SteeringMixin, SandboxMixin, SkillReviewMixin, Unifie
concurrent turns on a shared agent do not share per-turn counters."""
if self._loop_guard is None:
from ..escalation.loop_guard import LoopGuard, LoopGuardConfig
self._loop_guard = LoopGuard(LoopGuardConfig(enabled=True))
config = LoopGuardConfig(enabled=True)
limit = getattr(self, "max_execution_time", None)
if limit is not None:
config.max_time_per_turn = float(limit) if limit > 0 else float("inf")
self._loop_guard = LoopGuard(config)
from .chat_mixin import _current_turn_loop_guard
turn_guard = _current_turn_loop_guard(self)
return turn_guard if turn_guard is not None else self._loop_guard
@@ -4766,6 +4770,11 @@ Summary:"""
effective_promise = completion_promise
if effective_promise is None:
effective_promise = self.autonomy_config.get("completion_promise")
# The promise is the only success signal, so tell the model about it
# unless the caller already did (e.g. the `loop` CLI instructions).
_promise_tag = f"<promise>{effective_promise}</promise>"
if effective_promise and _promise_tag not in prompt and _promise_tag not in (self.instructions or ""):
prompt = f"{prompt}\n\nWhen the task is fully complete, include {_promise_tag} in your response."
# Get clear_context from config if not explicitly set
effective_clear_context = clear_context
@@ -5008,7 +5017,7 @@ Summary:"""
# the task naturally (model stopped calling tools = done).
# This is the same signal the CLI/wrapper path trusts.
# ─────────────────────────────────────────────────────────────
if self._autonomy_turn_tool_count > 0 and len(response_str) > 100:
if not effective_promise and self._autonomy_turn_tool_count > 0 and len(response_str) > 100:
# P3/G2: Emit completion callback
execute_sync_callback('autonomy_complete',
completion_reason="tool_completion",
@@ -5045,7 +5054,8 @@ Summary:"""
if obs is not None:
obs.emit(_EvtType.STAGE_ESCALATE, {"from": prev_stage, "to": stage})
# Check for completion promise FIRST (structured signal)
# Completion promise: when configured, it is the only success signal
# (heuristic exits above/below are skipped in promise mode)
if effective_promise:
promise_tag = f"<promise>{effective_promise}</promise>"
if promise_tag in response_str:
@@ -5067,7 +5077,7 @@ Summary:"""
)
# Check for keyword-based completion signals (word-boundary, G-COMPLETION-1 fix)
if self._is_completion_signal(response_str):
if not effective_promise and self._is_completion_signal(response_str):
# P3/G2: Emit completion callback
execute_sync_callback('autonomy_complete',
completion_reason="goal",
@@ -5086,7 +5096,7 @@ Summary:"""
)
# For DIRECT stage, complete after first response
if stage == "direct":
if not effective_promise and stage == "direct":
# P3/G2: Emit completion callback
execute_sync_callback('autonomy_complete',
completion_reason="goal",
@@ -5114,7 +5124,7 @@ Summary:"""
# Suppressed when doom recovery is active — once a doom loop
# is detected, no_tool_calls (a success exit) should not fire;
# the doom loop system manages termination instead.
if (self._autonomy_turn_tool_count == 0 and iterations > 1
if (not effective_promise and self._autonomy_turn_tool_count == 0 and iterations > 1
and not self._doom_recovery_active):
self._consecutive_no_tool_turns += 1
if self._consecutive_no_tool_turns >= 2:
@@ -5253,6 +5263,11 @@ Summary:"""
effective_promise = completion_promise
if effective_promise is None:
effective_promise = self.autonomy_config.get("completion_promise")
# The promise is the only success signal, so tell the model about it
# unless the caller already did (e.g. the `loop` CLI instructions).
_promise_tag = f"<promise>{effective_promise}</promise>"
if effective_promise and _promise_tag not in prompt and _promise_tag not in (self.instructions or ""):
prompt = f"{prompt}\n\nWhen the task is fully complete, include {_promise_tag} in your response."
# Get clear_context from config if not explicitly set
effective_clear_context = clear_context
@@ -5475,7 +5490,7 @@ Summary:"""
# produced a substantive response, the inner loop completed
# the task naturally (model stopped calling tools = done).
# ─────────────────────────────────────────────────────────────
if self._autonomy_turn_tool_count > 0 and len(response_str) > 100:
if not effective_promise and self._autonomy_turn_tool_count > 0 and len(response_str) > 100:
return AutonomyResult(
success=True,
output=response_str,
@@ -5498,7 +5513,8 @@ Summary:"""
if obs is not None:
obs.emit(_EvtType.STAGE_ESCALATE, {"from": stage_order[idx], "to": stage})
# Check for completion promise FIRST (structured signal)
# Completion promise: when configured, it is the only success signal
# (heuristic exits above/below are skipped in promise mode)
if effective_promise:
promise_tag = f"<promise>{effective_promise}</promise>"
if promise_tag in response_str:
@@ -5514,7 +5530,7 @@ Summary:"""
)
# Check for keyword-based completion signals (word-boundary, G-COMPLETION-1 fix)
if self._is_completion_signal(response_str):
if not effective_promise and self._is_completion_signal(response_str):
return AutonomyResult(
success=True,
output=response_str,
@@ -5527,7 +5543,7 @@ Summary:"""
)
# For DIRECT stage, complete after first response
if stage == "direct":
if not effective_promise and stage == "direct":
return AutonomyResult(
success=True,
output=response_str,
@@ -5548,7 +5564,7 @@ Summary:"""
# Suppressed when doom recovery is active — once a doom loop
# is detected, no_tool_calls (a success exit) should not fire;
# the doom loop system manages termination instead.
if (self._autonomy_turn_tool_count == 0 and iterations > 1
if (not effective_promise and self._autonomy_turn_tool_count == 0 and iterations > 1
and not self._doom_recovery_active):
self._consecutive_no_tool_turns += 1
if self._consecutive_no_tool_turns >= 2:
@@ -7091,6 +7107,9 @@ Answer:"""
def _process_handoffs(self):
"""Process handoffs and convert them to tools that can be used by the agent."""
if not self.handoffs and not (isinstance(self.tools, list) and self.tools):
return
# Import here to avoid circular imports
from .handoff import Handoff
@@ -1912,6 +1912,105 @@ Your Goal: {self.goal}"""
self._openai_client = get_openai_client(api_key=getattr(self, 'api_key', None))
return create_llm_dispatcher(openai_client=self._openai_client, model=model)
def _fallback_llm_for(self, model):
"""Build a throwaway LLM bound to fallback ``model`` for the custom-LLM path.
Never assigned to ``self.llm_instance``, so concurrent turns keep the
primary model. A fallback entry that is already a model object is used
as-is. Option params (metrics, max_iter, retries, ...) are inherited;
connection settings (base_url, api_key, auth) only when the fallback
targets the same provider prefix as the primary.
"""
if not isinstance(model, str):
return model
from ..llm.llm import LLM
params = dict(getattr(self, '_llm_init_params', None) or {})
primary = str(params.get('model') or self.llm or '')
# Bare names (no "provider/" prefix) share the configured server.
prefix = lambda name: name.split('/', 1)[0] if '/' in name else ''
if prefix(primary) != prefix(model):
for key in ('base_url', 'api_key', 'auth'):
params.pop(key, None)
params['model'] = model
return LLM(**params)
def _classify_custom_llm_fallback(self, error, failed_model, fallback_index):
"""Return ``(next_model, category)`` if ``error`` warrants a model fallback."""
next_model = self._get_next_fallback_model(fallback_index)
if next_model is None:
return None, None
from ..llm.error_classifier import classify_llm_error
model_name = str(failed_model)
provider = model_name.split('/', 1)[0] if '/' in model_name else "openai"
classification = classify_llm_error(error, provider=provider, model=model_name)
if not classification.should_fallback_model:
return None, None
logging.info(f"[{self.name}] {model_name} unavailable — falling back to {next_model}")
return next_model, classification.error_category
@staticmethod
def _track_tool_runs(llm_kwargs):
"""Return ``(llm_kwargs, ran)``; ``ran`` becomes non-empty once a tool executes.
A fallback replays the whole turn from the original messages, so it is
only safe while no tool has run (otherwise side effects would repeat).
"""
import functools
import inspect
ran = []
fn = llm_kwargs.get('execute_tool_fn')
if fn is None:
return llm_kwargs, ran
if inspect.iscoroutinefunction(fn):
@functools.wraps(fn)
async def tracked(*args, **kwargs):
ran.append(True)
return await fn(*args, **kwargs)
else:
@functools.wraps(fn)
def tracked(*args, **kwargs):
ran.append(True)
return fn(*args, **kwargs)
return {**llm_kwargs, 'execute_tool_fn': tracked}, ran
def _custom_llm_get_response(self, llm_kwargs):
"""Call ``llm_instance.get_response`` walking ``fallback_models`` on outage."""
llm, index, current = self.llm_instance, 0, self.llm
stream_cb = self.stream_emitter.emit if hasattr(self, 'stream_emitter') else None
llm_kwargs, tools_ran = self._track_tool_runs(llm_kwargs)
while True:
try:
return llm.get_response(**llm_kwargs)
except (ToolExecutionError, BudgetExceededError, InterruptedError):
raise
except Exception as e:
if tools_ran:
raise
next_model, category = self._classify_custom_llm_fallback(e, current, index)
if next_model is None:
raise
self._emit_model_fallback(current, next_model, category, index, stream_cb)
llm, index, current = self._fallback_llm_for(next_model), index + 1, next_model
async def _custom_llm_get_response_async(self, llm_kwargs):
"""Async twin of :meth:`_custom_llm_get_response`."""
llm, index, current = self.llm_instance, 0, self.llm
stream_cb = self.stream_emitter.emit if hasattr(self, 'stream_emitter') else None
llm_kwargs, tools_ran = self._track_tool_runs(llm_kwargs)
while True:
try:
return await llm.get_response_async(**llm_kwargs)
except (ToolExecutionError, BudgetExceededError, InterruptedError):
raise
except Exception as e:
if tools_ran:
raise
next_model, category = self._classify_custom_llm_fallback(e, current, index)
if next_model is None:
raise
await self._aemit_model_fallback(current, next_model, category, index, stream_cb)
llm, index, current = self._fallback_llm_for(next_model), index + 1, next_model
def _get_model_fallback_lock(self):
"""Lazily create the per-instance lock guarding model-fallback swaps.
@@ -2336,6 +2435,7 @@ Your Goal: {self.goal}"""
messages=messages,
response=str(final_response),
model=self.llm if isinstance(self.llm, str) else str(self.llm),
tokens_used=_prompt_tokens + _completion_tokens,
latency_ms=(time.time() - start_time) * 1000
)
self._hook_runner.execute_sync(HookEvent.AFTER_LLM, after_llm_input)
@@ -3037,6 +3137,7 @@ Your Goal: {self.goal}"""
messages=messages,
response=str(final_response),
model=self.llm if isinstance(self.llm, str) else str(self.llm),
tokens_used=_prompt_tokens + _completion_tokens,
latency_ms=(time.time() - _achat_start_time) * 1000
)
await self._hook_runner.execute(HookEvent.AFTER_LLM, after_llm_input)
@@ -3849,7 +3950,7 @@ Your Goal: {self.goal}"""
if hasattr(self, '_drain_steering_messages') and getattr(self, '_message_steering', None) is not None:
llm_kwargs['steering_drain'] = self._drain_steering_messages
response_text = self.llm_instance.get_response(**llm_kwargs)
response_text = self._custom_llm_get_response(llm_kwargs)
self._add_to_chat_history("assistant", response_text)
# Persist assistant message to DB
@@ -4240,11 +4341,17 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
except Exception as e:
logger.warning(f"Steering check failed, continuing without steering: {e}")
# Input-side guardrail validation (parity with sync chat()). No-op
# unless the guardrail exposes validate_input; runs before any
# backend/LLM dispatch so a rejected prompt never reaches the model.
# Input-side validators may perform blocking LLM calls. Keep them off
# the event loop, before any backend/LLM dispatch, just like tool guards.
if hasattr(self, '_validate_input_with_guardrail'):
_in_ok, _in_prompt, _in_err = self._validate_input_with_guardrail(prompt)
_input_guard = self._guardrail_fn
if (_input_guard is None or not hasattr(_input_guard, "validate_input")
or getattr(_input_guard, "_praison_output_only", False)):
_in_ok, _in_prompt, _in_err = self._validate_input_with_guardrail(prompt)
else:
_in_ok, _in_prompt, _in_err = await asyncio.to_thread(
self._validate_input_with_guardrail, prompt
)
if not _in_ok:
logging.warning(f"Agent {self.name}: input blocked by guardrail: {_in_err}")
return None
@@ -4576,7 +4683,7 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
if hasattr(self, '_drain_steering_messages') and getattr(self, '_message_steering', None) is not None:
llm_kwargs['steering_drain'] = self._drain_steering_messages
response_text = await self.llm_instance.get_response_async(**llm_kwargs)
response_text = await self._custom_llm_get_response_async(llm_kwargs)
# LLM call succeeded - now it's safe to commit any compacted history
if effective_history is not self.chat_history:
@@ -400,8 +400,8 @@ This report contains all agent interactions and outputs from a complete ContextA
response_filename = f"{self.interaction_counter:03d}_{safe_agent_name}_{timestamp.replace(':', '_')}.json"
response_path = os.path.join(self.output_dir, "agent_responses", response_filename)
with open(response_path, "w") as f:
json.dump(interaction_data, f, indent=2)
with open(response_path, "w", encoding="utf-8") as f:
json.dump(interaction_data, f, indent=2, ensure_ascii=False)
# Save individual markdown files - debug only
md_filename = f"{self.interaction_counter:03d}_{safe_agent_name}_{timestamp.replace(':', '_')}"
@@ -1201,20 +1201,20 @@ detailed, actionable implementation steps."""
def _save_context_engineering_results(self):
"""Save all Context Engineering results following PRD methodology."""
# Save comprehensive analysis
with open(os.path.join(self.output_dir, "comprehensive_analysis.json"), "w") as f:
json.dump(self.codebase_analysis, f, indent=2)
with open(os.path.join(self.output_dir, "comprehensive_analysis.json"), "w", encoding="utf-8") as f:
json.dump(self.codebase_analysis, f, indent=2, ensure_ascii=False)
# Save pattern library
with open(os.path.join(self.output_dir, "pattern_library.json"), "w") as f:
json.dump(self.pattern_library, f, indent=2)
with open(os.path.join(self.output_dir, "pattern_library.json"), "w", encoding="utf-8") as f:
json.dump(self.pattern_library, f, indent=2, ensure_ascii=False)
# Save validation framework
with open(os.path.join(self.output_dir, "validation_framework.json"), "w") as f:
json.dump(self.validation_framework, f, indent=2)
with open(os.path.join(self.output_dir, "validation_framework.json"), "w", encoding="utf-8") as f:
json.dump(self.validation_framework, f, indent=2, ensure_ascii=False)
# Save all agent interactions summary
with open(os.path.join(self.output_dir, "all_agent_interactions.json"), "w") as f:
json.dump(self.agent_interactions, f, indent=2)
with open(os.path.join(self.output_dir, "all_agent_interactions.json"), "w", encoding="utf-8") as f:
json.dump(self.agent_interactions, f, indent=2, ensure_ascii=False)
print(f"💾 Context Engineering results saved to: {self.output_dir}/")
print(f"💾 Agent interactions ({len(self.agent_interactions)} total) saved to: agent_responses/")
@@ -1267,7 +1267,7 @@ Product Requirements Prompts following PRD template methodology.
Every agent interaction has been saved for full audit trail and reproducibility.
"""
with open(os.path.join(self.output_dir, "analysis_summary.md"), "w") as f:
with open(os.path.join(self.output_dir, "analysis_summary.md"), "w", encoding="utf-8") as f:
f.write(summary)
print(f"📋 Analysis summary saved following PRD methodology")
@@ -1308,7 +1308,7 @@ Every agent interaction has been saved for full audit trail and reproducibility.
safe_filename = feature_request.lower().replace(' ', '_').replace('-', '_')[:50]
prp_path = os.path.join(self.output_dir, "PRPs", f"{safe_filename}.md")
with open(prp_path, "w") as f:
with open(prp_path, "w", encoding="utf-8") as f:
f.write(prp)
print(f"📄 Comprehensive PRP following PRD template saved to: {prp_path}")
@@ -1427,6 +1427,10 @@ Write the complete compiled report:"""
_loop_detection.record_tool_outcome(
_ld_history, function_name, arguments, _result, _ld_config
)
# Per-turn tool count for autonomy completion heuristics (sync
# parity with tool_execution.py). Counted only once the tool has
# actually run, so a BEFORE_TOOL-blocked call cannot count.
self._autonomy_turn_tool_count = getattr(self, '_autonomy_turn_tool_count', 0) + 1
return _result
# Enforce BEFORE_TOOL/AFTER_TOOL security hooks for every async caller,
@@ -630,6 +630,27 @@ class Handoff:
None, lambda: self.agent.chat(prompt, tools=effective_tools)
)
def _trace_handoff(self, source_agent: 'Agent', context: Optional[Dict[str, Any]], reason: Optional[str] = None) -> None:
"""Record the hand-off on the replay trace (no-op when tracing is off)."""
from ..trace.context_events import get_context_emitter
emitter = get_context_emitter()
if not emitter._enabled:
return
context = dict(context or {})
if reason is None:
reason = context.get("reason") or context.get("task") or context.get("prompt")
policy = getattr(self.config, "context_policy", None)
emitter.agent_handoff(
getattr(source_agent, "name", None) or "agent",
getattr(self.agent, "name", None),
reason=emitter._preview(reason) if reason is not None else None,
context_passed={
"context_policy": getattr(policy, "value", policy),
"args": context,
},
kind="handoff",
)
def _check_safety(self, source_agent: 'Agent') -> None:
"""
Check safety constraints before handoff.
@@ -778,6 +799,7 @@ class Handoff:
# Track handoff chain
_push_handoff(source_agent.name)
pushed = True
self._trace_handoff(source_agent, kwargs, reason=prompt)
# Execute on_handoff callback
self._execute_callback(self.config.on_handoff or self.on_handoff, source_agent, kwargs)
@@ -888,6 +910,7 @@ class Handoff:
self._check_safety(source_agent)
_push_handoff(source_agent.name)
pushed = True
self._trace_handoff(source_agent, kwargs, reason=prompt)
# Execute callback
self._execute_callback(self.config.on_handoff or self.on_handoff, source_agent, kwargs)
@@ -1016,6 +1039,7 @@ class Handoff:
# Track handoff chain
_push_handoff(source_agent.name)
pushed = True
self._trace_handoff(source_agent, kwargs, reason=None)
# Execute on_handoff callback
self._execute_callback(self.config.on_handoff or self.on_handoff, source_agent, kwargs)
@@ -1632,6 +1656,7 @@ class TypedHandoff(Handoff, Generic[T]):
# Track handoff chain
_push_handoff(source_agent.name)
pushed = True
self._trace_handoff(source_agent, kwargs, reason=None)
# Execute on_handoff callback
self._execute_callback(self.config.on_handoff or self.on_handoff, source_agent, kwargs)
@@ -1747,6 +1772,7 @@ class TypedHandoff(Handoff, Generic[T]):
self._check_safety(source_agent)
_push_handoff(source_agent.name)
pushed = True
self._trace_handoff(source_agent, kwargs, reason=None)
# Execute callback
self._execute_callback(self.config.on_handoff or self.on_handoff, source_agent, kwargs)
@@ -356,6 +356,39 @@ def _record_skipped_task(agents_instance, task):
task.status = "completed"
def _trace_task_begin(agents_instance, task):
"""Emit ``task_start``; returns a span for ``_trace_task_end`` (None when off)."""
from ..trace.context_events import get_context_emitter
emitter = get_context_emitter()
if not emitter._enabled:
return None
from ..workflows.diagram import task_node_id
node_id = task_node_id(agents_instance.tasks, task)
agent = getattr(getattr(task, "agent", None), "name", None)
emitter.task_start(
getattr(task, "name", None), getattr(task, "description", None),
agent=agent, node_id=node_id,
)
return emitter, node_id, agent, time.perf_counter()
def _trace_task_end(span, task, status):
"""Emit ``task_end`` (completed / failed / skipped) for a ``_trace_task_begin`` span."""
if span is None:
return
emitter, node_id, agent, started = span
result = getattr(task, "result", None)
emitter.task_end(
getattr(task, "name", None),
status,
retries=getattr(task, "retry_count", 0) or 0,
duration_ms=(time.perf_counter() - started) * 1000,
output=getattr(result, "raw", None) if result is not None else None,
agent=agent,
node_id=node_id,
)
def _task_should_skip(agents_instance, task):
"""Return True when a task's should_run gate evaluates falsy.
@@ -1539,7 +1572,19 @@ class AgentTeam(SpawnAnnounceProtocol):
agent_name=getattr(getattr(task, "agent", None), "name", None),
context={"kind": "task_output_review", "prompt": prompt},
)
decision = backend.request_approval_sync(request)
from ..trace.context_events import _approval_begin, _approval_end, get_context_emitter
_approval = None
if get_context_emitter()._enabled:
from ..workflows.diagram import task_node_id
_approval = _approval_begin(
request, kind="task_output_review", node_id=task_node_id(self.tasks, task),
)
try:
decision = backend.request_approval_sync(request)
except BaseException as exc:
_approval_end(_approval, error=exc)
raise
_approval_end(_approval, decision)
if getattr(decision, "approved", False):
return task_output, False
@@ -1684,10 +1729,21 @@ class AgentTeam(SpawnAnnounceProtocol):
except Exception as e:
logger.error(f"Error in on_task_start callback: {e}")
# Apply global variables to task if not already set. Use a shallow copy so a
# task mutating its variables doesn't leak back into the shared AgentTeam state.
self._propagate_variables(task, task_id)
def _propagate_variables(self, task, task_id):
"""Apply global variables to a task that has none of its own.
Uses a shallow copy so a task mutating its variables doesn't leak back
into the shared AgentTeam state. The copy is remembered so a later fresh
``start()`` can drop it (and re-propagate current values) without
touching caller-defined ``Task.variables``.
"""
if self.variables and not getattr(task, 'variables', None):
task.variables = self.variables.copy()
if not hasattr(self, "_propagated_variables"):
self._propagated_variables = {}
self._propagated_variables[task_id] = task.variables
def _run_task_complete_hook(self, task, task_output):
"""Run the on_task_complete hook. Shared by run_task and arun_task."""
@@ -1714,8 +1770,7 @@ class AgentTeam(SpawnAnnounceProtocol):
except Exception as e:
logger.error(f"Error in on_task_start callback: {e}")
if self.variables and not getattr(task, 'variables', None):
task.variables = self.variables.copy()
self._propagate_variables(task, task_id)
async def _arun_task_complete_hook(self, task, task_output):
"""Async-aware on_task_complete hook for arun_task (see _arun_task_start_hook)."""
@@ -1740,6 +1795,18 @@ class AgentTeam(SpawnAnnounceProtocol):
logger.info(f"Task with ID {task_id} is already completed")
return
_span = _trace_task_begin(self, task)
_status = "failed"
try:
if await self._arun_task_body(task_id, task) == "skipped":
_status = "skipped"
elif task.status == "completed":
_status = "completed"
finally:
_trace_task_end(_span, task, _status)
async def _arun_task_body(self, task_id, task):
"""Body of :meth:`arun_task`; returns ``"skipped"`` for a gated-out task."""
# Call on_task_start callback and propagate variables (async-aware, mirrors run_task)
await self._arun_task_start_hook(task, task_id)
@@ -1747,7 +1814,7 @@ class AgentTeam(SpawnAnnounceProtocol):
if await _atask_should_skip(self, task):
logger.info(f"Task {task_id} skipped by should_run gate")
_record_skipped_task(self, task)
return
return "skipped"
# Use per-task max_retries if available
task_max = getattr(task, "max_retries", self.max_retries)
@@ -1927,18 +1994,20 @@ class AgentTeam(SpawnAnnounceProtocol):
if self._depends_on_pending(task, tasks_to_run):
await self._gather_with_isolation([c for _, c in tasks_to_run])
tasks_to_run = []
# A just-flushed prerequisite may now be failed; don't
# queue a dependent that would run with missing context
# unless it opted into graceful degradation.
if self._deps_failed(task_id) and not self._should_continue_on_dep_failure(task_id):
self.tasks[task_id].status = "failed"
continue
# The predecessor may have run synchronously (no batch),
# or may just have finished in the batch flushed above.
if self._deps_failed(task_id) and not self._should_continue_on_dep_failure(task_id):
task.status = "failed"
continue
tasks_to_run.append((task_id, self.arun_task(task_id)))
else:
# If we encounter a sync task, we must wait for the previous async tasks to finish.
if tasks_to_run:
await self._gather_with_isolation([c for _, c in tasks_to_run])
tasks_to_run = []
if self._deps_failed(task_id) and not self._should_continue_on_dep_failure(task_id):
task.status = "failed"
continue
# Run sync task in an executor to avoid blocking the event loop
# Use copy_context_to_callable to propagate contextvars (needed for trace emission)
@@ -2201,7 +2270,16 @@ class AgentTeam(SpawnAnnounceProtocol):
# Re-entrant on the owning thread so batch runs (astart_for_each) can hold
# the guard across the whole batch while still calling astart() per item.
with self._guard_execution():
return await self._astart_impl(content=content, return_dict=return_dict, **kwargs)
self._reset_if_previous_run_finished()
try:
from ..trace.context_events import _workflow_scope
with _workflow_scope("team", self._replay_name(), self.process,
graph_fn=self.to_graph, run_id=self.run_id) as _run:
result = await self._astart_impl(content=content, return_dict=return_dict, **kwargs)
self._mark_run_status(_run)
return result
finally:
self._previous_run_finished = True
async def _astart_impl(self, content=None, return_dict=False, **kwargs):
# Track execution via telemetry
@@ -2215,6 +2293,7 @@ class AgentTeam(SpawnAnnounceProtocol):
if not task.context:
task.context = []
task.context.append(content)
self._injected_content.append((task, content))
if self.planning:
await self._arun_with_planning()
@@ -2253,13 +2332,11 @@ class AgentTeam(SpawnAnnounceProtocol):
def save_output_to_file(self, task, task_output):
if task.output_file:
try:
if task.create_directory:
dir_name = os.path.dirname(task.output_file)
if dir_name:
os.makedirs(dir_name, exist_ok=True)
with open(task.output_file, "w") as f:
f.write(str(task_output))
if self.verbose >= 1:
from ..utils.output_file import write_output_file
saved = write_output_file(
task.output_file, str(task_output), create_dirs=task.create_directory
)
if saved and self.verbose >= 1:
logger.info(f"Task output saved to {task.output_file}")
except Exception as e:
display_error(f"Error saving task output to file: {e}")
@@ -2318,6 +2395,18 @@ class AgentTeam(SpawnAnnounceProtocol):
logger.info(f"Task with ID {task_id} is already completed")
return
_span = _trace_task_begin(self, task)
_status = "failed"
try:
if self._run_task_body(task_id, task) == "skipped":
_status = "skipped"
elif task.status == "completed":
_status = "completed"
finally:
_trace_task_end(_span, task, _status)
def _run_task_body(self, task_id, task):
"""Body of :meth:`run_task`; returns ``"skipped"`` for a gated-out task."""
# Call on_task_start callback and propagate variables (shared with arun_task)
self._run_task_start_hook(task, task_id)
@@ -2325,7 +2414,7 @@ class AgentTeam(SpawnAnnounceProtocol):
if _task_should_skip(self, task):
logger.info(f"Task {task_id} skipped by should_run gate")
_record_skipped_task(self, task)
return
return "skipped"
# Use per-task max_retries if available
task_max = getattr(task, "max_retries", self.max_retries)
@@ -2417,6 +2506,9 @@ class AgentTeam(SpawnAnnounceProtocol):
if self.process == "workflow":
for task_id in process.workflow():
if self._deps_failed(task_id) and not self._should_continue_on_dep_failure(task_id):
self.tasks[task_id].status = "failed"
continue
self.run_task(task_id)
elif self.process == "sequential":
for task_id in process.sequential():
@@ -2441,6 +2533,21 @@ class AgentTeam(SpawnAnnounceProtocol):
except StopIteration:
pass
def to_graph(self) -> Dict[str, Any]:
"""This team's definition as graph data (``praisonai.graph/1``).
Covers agents, tasks (context/depends_on, next_tasks, conditions),
tools, hand-offs, human review and the hierarchical manager. Node ids
are stable across processes and match replay events' ``node_id``.
"""
from ..workflows.diagram import to_graph
return to_graph(self)
def to_mermaid(self) -> str:
"""Render this team's definition as a mermaid diagram."""
from ..workflows.diagram import graph_to_mermaid, to_graph
return graph_to_mermaid(to_graph(self))
def get_task_status(self, task_id):
if task_id in self.tasks:
return self.tasks[task_id].status
@@ -2519,8 +2626,31 @@ class AgentTeam(SpawnAnnounceProtocol):
# Re-entrant on the owning thread so batch runs (start_for_each) can hold
# the guard across the whole batch while still calling start() per item.
with self._guard_execution():
return self._start_impl(content=content, return_dict=return_dict,
output=output, **kwargs)
self._reset_if_previous_run_finished()
try:
from ..trace.context_events import _workflow_scope
with _workflow_scope("team", self._replay_name(), self.process,
graph_fn=self.to_graph, run_id=self.run_id) as _run:
result = self._start_impl(content=content, return_dict=return_dict,
output=output, **kwargs)
self._mark_run_status(_run)
return result
finally:
self._previous_run_finished = True
def _replay_name(self) -> str:
"""Run label for Replay: the team's name, else its agents joined ("A + B")."""
if self.name:
return self.name
names = [getattr(a, "name", None) or "Agent" for a in (self.agents or [])]
return " + ".join(names) if names else "Agent team"
def _mark_run_status(self, run_state):
"""Record a failed replay run when any task ended failed (tracing on only)."""
if run_state is not None and any(
getattr(t, "status", None) == "failed" for t in self.tasks.values()
):
run_state["status"] = "failed"
def _start_impl(self, content=None, return_dict=False, output=None, **kwargs):
# Track execution via telemetry
@@ -2551,6 +2681,7 @@ class AgentTeam(SpawnAnnounceProtocol):
if not task.context:
task.context = []
task.context.append(content)
self._injected_content.append((task, content))
# ─────────────────────────────────────────────────────────────
# Verbose Mode: Show Rich panels for multi-agent workflow
@@ -2746,14 +2877,19 @@ class AgentTeam(SpawnAnnounceProtocol):
Captures the fields that ``run_task``/``arun_task`` mutate during a run
(``status``, ``result``, ``retry_count``) plus caller-defined
``variables``, keeping the public Task API backward-compatible.
``propagated`` records whether those variables were copied from the
team's ``variables`` so a restore keeps that ownership tracking.
"""
snapshot = {}
propagated = getattr(self, "_propagated_variables", {})
for task_id, task in getattr(self, "tasks", {}).items():
variables = getattr(task, "variables", None)
snapshot[task_id] = {
"status": getattr(task, "status", None),
"result": getattr(task, "result", None),
"retry_count": getattr(task, "retry_count", None),
"variables": getattr(task, "variables", None),
"variables": variables,
"propagated": variables is not None and propagated.get(task_id) is variables,
}
return snapshot
@@ -2772,8 +2908,41 @@ class AgentTeam(SpawnAnnounceProtocol):
task.retry_count = 0
task.variables = {}
def _reset_if_previous_run_finished(self):
"""Make a repeated ``start()``/``astart()`` a fresh run.
``run_task``/``arun_task`` skip tasks whose status is "completed", so
without this a second ``start()`` on the same team executed nothing and
returned the previous run's output. Resetting only once a previous run
has finished keeps ``restore_session_state()`` + ``start()`` resuming,
and also drops the ``content`` earlier runs appended to task context.
Caller-defined ``Task.variables`` are kept; only copies propagated from
the team's ``variables`` are cleared so current values re-propagate.
"""
injected = getattr(self, "_injected_content", [])
if getattr(self, "_previous_run_finished", False):
propagated = getattr(self, "_propagated_variables", {})
for task_id, task in self.tasks.items():
task.status = "not started"
task.result = None
if hasattr(task, "retry_count"):
task.retry_count = 0
if task_id in propagated and getattr(task, "variables", None) is propagated[task_id]:
task.variables = {}
propagated.clear()
for task, item in injected:
try:
task.context.remove(item)
except (AttributeError, ValueError):
pass
injected = []
# A resumed run keeps the tracked entries so the next fresh run removes them.
self._previous_run_finished = False
self._injected_content = injected
def _restore_task_state(self, snapshot):
"""Restore per-task run state captured by ``_snapshot_task_state``."""
propagated = {}
for task_id, state in snapshot.items():
task = self.tasks.get(task_id)
if task is None:
@@ -2783,6 +2952,9 @@ class AgentTeam(SpawnAnnounceProtocol):
if state["retry_count"] is not None:
task.retry_count = state["retry_count"]
task.variables = state["variables"]
if state.get("propagated"):
propagated[task_id] = task.variables
self._propagated_variables = propagated
def _build_batch_result(self, batch_id, items):
"""Aggregate per-item results into a batch summary dict.
@@ -3131,6 +3303,9 @@ class AgentTeam(SpawnAnnounceProtocol):
if state.get("variables"):
task.variables = state["variables"]
restored += 1
if restored:
# A restored checkpoint is meant to be resumed, not reset.
self._previous_run_finished = False
return restored
@staticmethod
@@ -4461,7 +4636,10 @@ class AgentTeam(SpawnAnnounceProtocol):
# Read target agents inside lock to avoid race condition
with self._spawn_lock:
target_agents = agent_ids or list(self._spawned_agents.keys())
if not target_agents:
# Return retained history only for the default target selection.
return list(self._completion_events) if agent_ids is None else []
completed_agents = set()
while True:
@@ -44,6 +44,9 @@ DEFAULT_DANGEROUS_TOOLS: Dict[str, str] = {
"acp_edit_file": "high",
"acp_delete_file": "high",
"execute_query": "high",
"github_create_branch": "high",
"github_commit_and_push": "high",
"github_create_pull_request": "high",
"evaluate": "medium",
"crawl": "medium",
"scrape_page": "medium",
@@ -76,10 +79,11 @@ DOOM_LOOP_TARGET = "__doom_loop__"
# or set ``PRAISONAI_TOOL_SAFETY=off``; users who want stricter
# controls can opt into ``approval="safe"`` or ``"read_only"``.
PERMISSION_PRESETS = {
# "default" — blocks delete + shell/code exec. Allows read/create/edit.
# "default" — blocks delete + shell/code exec + git push/PR. Allows read/create/edit.
"default": frozenset({
"execute_command", "kill_process", "execute_code", "acp_execute_command",
"delete_file", "move_file", "copy_file", "acp_delete_file",
"github_create_branch", "github_commit_and_push", "github_create_pull_request",
}),
# "safe" — blocks all dangerous tools (file writes, shell exec, etc.)
"safe": frozenset(DEFAULT_DANGEROUS_TOOLS.keys()),
@@ -689,29 +693,41 @@ class ApprovalRegistry:
liveness=liveness,
)
with _human_wait_scope():
# Prefer sync method if available
if hasattr(backend, "request_approval_sync"):
decision = backend.request_approval_sync(request)
else:
# Use shared utility for consistent async-to-sync bridging
from .utils import run_coroutine_safely
decision = run_coroutine_safely(
backend.request_approval(request),
timeout=self.timeout
)
# Replay: a person is actually being asked (the fast paths above are not).
from ..trace.context_events import _approval_begin, _approval_end
_trace = _approval_begin(request)
try:
with _human_wait_scope():
# Prefer sync method if available
if hasattr(backend, "request_approval_sync"):
decision = backend.request_approval_sync(request)
else:
# Use shared utility for consistent async-to-sync bridging
from .utils import run_coroutine_safely
decision = run_coroutine_safely(
backend.request_approval(request),
timeout=self.timeout
)
# Live-authority gate: a resolution that lands after the originating
# turn was stopped/superseded is dropped fail-closed — the tool does not
# run and no durable session/always grant is persisted.
stale = self._reject_if_stale(request)
if stale is not None:
return stale
# Live-authority gate: a resolution that lands after the originating
# turn was stopped/superseded is dropped fail-closed — the tool does not
# run and no durable session/always grant is persisted.
stale = self._reject_if_stale(request)
if stale is not None:
decision = stale
return stale
if decision.approved:
self.mark_approved(tool_name, arguments, agent_name, scope_id)
self._persist_scoped_decision(agent_name, tool_name, arguments, decision, scope_id)
return decision
if decision.approved:
self.mark_approved(tool_name, arguments, agent_name, scope_id)
self._persist_scoped_decision(agent_name, tool_name, arguments, decision, scope_id)
return decision
except BaseException as exc:
_approval_end(_trace, error=exc)
_trace = None
raise
finally:
if _trace is not None:
_approval_end(_trace, decision)
async def approve_async(
self,
@@ -764,26 +780,38 @@ class ApprovalRegistry:
liveness=liveness,
)
# Replay: a person is actually being asked (the fast paths above are not).
from ..trace.context_events import _approval_begin, _approval_end
_trace = _approval_begin(request)
try:
async with _human_wait_scope():
decision = await asyncio.wait_for(
backend.request_approval(request),
timeout=self.timeout,
)
except asyncio.TimeoutError:
decision = ApprovalDecision(approved=False, reason="Approval timed out")
try:
async with _human_wait_scope():
decision = await asyncio.wait_for(
backend.request_approval(request),
timeout=self.timeout,
)
except asyncio.TimeoutError:
decision = ApprovalDecision(approved=False, reason="Approval timed out")
# Live-authority gate: a resolution that lands after the originating
# turn was stopped/superseded is dropped fail-closed — the tool does not
# run and no durable session/always grant is persisted.
stale = self._reject_if_stale(request)
if stale is not None:
return stale
# Live-authority gate: a resolution that lands after the originating
# turn was stopped/superseded is dropped fail-closed — the tool does not
# run and no durable session/always grant is persisted.
stale = self._reject_if_stale(request)
if stale is not None:
decision = stale
return stale
if decision.approved:
self.mark_approved(tool_name, arguments, agent_name, scope_id)
self._persist_scoped_decision(agent_name, tool_name, arguments, decision, scope_id)
return decision
if decision.approved:
self.mark_approved(tool_name, arguments, agent_name, scope_id)
self._persist_scoped_decision(agent_name, tool_name, arguments, decision, scope_id)
return decision
except BaseException as exc:
_approval_end(_trace, error=exc)
_trace = None
raise
finally:
if _trace is not None:
_approval_end(_trace, decision)
@staticmethod
def _reject_if_stale(request: ApprovalRequest) -> Optional[ApprovalDecision]:
@@ -909,7 +909,8 @@ class ExecutionConfig:
# ``rate_limiter`` explicitly for burst/TPM control (it takes precedence).
max_rpm: Optional[int] = None
# Time limits
# Time limits: per-turn wall-clock seconds for the loop guard.
# None = loop-guard default (600s); 0 = no time limit.
max_execution_time: Optional[int] = None
# Retry settings
@@ -107,7 +107,8 @@ class LoopGuardConfig:
mutating_halt_threshold: int = 7
# Time-based limits
max_time_per_turn: float = 120.0 # Max seconds per chat turn
# Max seconds per chat turn; ExecutionConfig.max_execution_time overrides (0 = no limit there).
max_time_per_turn: float = 600.0
# No-progress detection
no_progress_warn: int = 4
@@ -1,147 +0,0 @@
"""
Utility functions for PraisonAI Agents evaluation framework.
"""
import json
from praisonaiagents._logging import get_logger
from pathlib import Path
from typing import Any, Dict, Optional, Union
logger = get_logger(__name__)
def save_result_to_file(
result: Any,
file_path: str,
eval_id: Optional[str] = None,
name: Optional[str] = None
) -> bool:
"""
Save evaluation result to a file.
Args:
result: The evaluation result to save
file_path: Path to save the result (supports {name}, {eval_id} placeholders)
eval_id: Optional eval ID for placeholder substitution
name: Optional name for placeholder substitution
Returns:
True if save was successful, False otherwise
"""
try:
formatted_path = file_path.format(name=name or "", eval_id=eval_id or "")
path = Path(formatted_path)
path.parent.mkdir(parents=True, exist_ok=True)
if hasattr(result, 'to_dict'):
data = result.to_dict()
elif hasattr(result, '__dict__'):
data = result.__dict__
else:
data = {"result": str(result)}
path.write_text(json.dumps(data, indent=2, default=str))
logger.debug(f"Saved result to: {formatted_path}")
return True
except Exception as e:
logger.warning(f"Failed to save result: {e}")
return False
def load_result_from_file(file_path: str) -> Optional[Dict[str, Any]]:
"""
Load evaluation result from a file.
Args:
file_path: Path to the result file
Returns:
Dictionary containing the result data, or None if load failed
"""
try:
path = Path(file_path)
if not path.exists():
logger.warning(f"Result file not found: {file_path}")
return None
data = json.loads(path.read_text())
return data
except Exception as e:
logger.warning(f"Failed to load result: {e}")
return None
def format_score(score: float, max_score: float = 10.0) -> str:
"""
Format a score for display.
Args:
score: The score value
max_score: Maximum possible score
Returns:
Formatted score string
"""
return f"{score:.1f}/{max_score:.0f}"
def format_percentage(value: float) -> str:
"""
Format a value as a percentage.
Args:
value: Value between 0 and 1
Returns:
Formatted percentage string
"""
return f"{value * 100:.1f}%"
def format_duration(seconds: float) -> str:
"""
Format a duration in seconds for display.
Args:
seconds: Duration in seconds
Returns:
Formatted duration string
"""
if seconds < 0.001:
return f"{seconds * 1000000:.0f}μs"
elif seconds < 1:
return f"{seconds * 1000:.2f}ms"
elif seconds < 60:
return f"{seconds:.2f}s"
else:
minutes = int(seconds // 60)
secs = seconds % 60
return f"{minutes}m {secs:.1f}s"
def format_memory(mb: float) -> str:
"""
Format memory usage for display.
Args:
mb: Memory in megabytes
Returns:
Formatted memory string
"""
if mb < 1:
return f"{mb * 1024:.1f} KB"
elif mb < 1024:
return f"{mb:.2f} MB"
else:
return f"{mb / 1024:.2f} GB"
def calculate_pass_rate(passed: int, total: int) -> float:
"""
Calculate pass rate.
Args:
passed: Number of passed evaluations
total: Total number of evaluations
Returns:
Pass rate as a float between 0 and 1
"""
if total == 0:
return 0.0
return passed / total
@@ -281,6 +281,8 @@ class SubQuestionEngine:
# Retrieve for each sub-question
try:
results = retriever.retrieve(sub_q, top_k=3)
# SmartRetriever returns a RetrievalResult, not a list.
results = getattr(results, "chunks", results)
for r in results:
if hasattr(r, 'text'):
all_contexts.append(r.text)
+267 -22
View File
@@ -43,6 +43,165 @@ _TOOL_ARGUMENTS_PARSE_FAILED = object()
# Bounded shrink-and-retry steps after a provider context-overflow rejection.
_CONTEXT_OVERFLOW_SHRINK_STEPS = 3
# ---------------------------------------------------------------------------
# Replay llm_request / llm_response for the LiteLLM path. The agent's
# OpenAI-client path records its own pair around the whole dispatch (which can
# reach this class through the LiteLLM adapter); ``_llm_call_open`` makes sure
# that call is not counted twice. A no-op returning None when tracing is off.
# ---------------------------------------------------------------------------
def _replay_llm_begin(llm: Any, params: Dict[str, Any]):
from ..trace.context_events import get_context_emitter
emitter = get_context_emitter()
if not emitter._enabled or emitter._llm_call_open():
return None
agent = getattr(llm, "current_agent_name", None) or emitter._current_agent()
model = params.get("model") or getattr(llm, "model", None)
# Chat Completions sends ``messages``; the Responses API sends ``input``.
messages = params.get("messages", params.get("input"))
# Copy: the caller keeps appending turns to (and shrinking) the live list.
messages = list(messages) if isinstance(messages, list) else None
emitter._emit(emitter._llm_request_event(
agent, len(messages) if messages else 0, 0, model=model, messages=messages,
))
return {"emitter": emitter, "agent": agent, "model": model,
"started": time.perf_counter(), "content": [], "usage": None, "finish": None}
def _replay_usage_tokens(usage: Any) -> tuple:
if not usage:
return 0, 0
get = usage.get if isinstance(usage, dict) else (lambda k, d=None: getattr(usage, k, d))
# Chat Completions names, then the Responses API names.
prompt = get("prompt_tokens", None) or get("input_tokens", 0)
completion = get("completion_tokens", None) or get("output_tokens", 0)
return int(prompt or 0), int(completion or 0)
def _replay_observe(span: Dict[str, Any], response: Any, chunk: bool) -> None:
"""Collect content / finish reason / usage from a response or a stream chunk."""
try:
get = response.get if isinstance(response, dict) else (lambda k, d=None: getattr(response, k, d))
usage = get("usage", None)
if usage:
span["usage"] = usage
# The model that actually served the call (a failover profile may
# differ from the requested one), so name and price match it.
served = get("model", None)
if isinstance(served, str) and served:
span["model"] = served
choices = get("choices", None) or []
if not choices:
return
first = choices[0]
fget = first.get if isinstance(first, dict) else (lambda k, d=None: getattr(first, k, d))
if fget("finish_reason", None):
span["finish"] = fget("finish_reason", None)
body = fget("delta" if chunk else "message", None)
if body is not None:
content = body.get("content") if isinstance(body, dict) else getattr(body, "content", None)
if isinstance(content, str) and content:
span["content"].append(content)
except Exception:
pass # Tracing must never break a model call.
def _replay_llm_end(span: Optional[Dict[str, Any]], error: Optional[BaseException] = None) -> None:
if span is None or span.get("done"):
return
span["done"] = True
emitter = span["emitter"]
prompt_tokens, completion_tokens = _replay_usage_tokens(span.get("usage"))
cost = 0.0
if prompt_tokens or completion_tokens:
try:
import litellm
prompt_cost, completion_cost = litellm.cost_per_token(
model=span["model"], prompt_tokens=prompt_tokens,
completion_tokens=completion_tokens,
)
cost = float(prompt_cost or 0) + float(completion_cost or 0)
except Exception:
cost = 0.0 # Unknown price: leave it unknown rather than guess.
emitter._emit(emitter._llm_response_event(
span["agent"],
duration_ms=(time.perf_counter() - span["started"]) * 1000,
finish_reason="error" if error is not None else span.get("finish"),
response_content=str(error) if error is not None else "".join(span["content"]),
prompt_tokens=prompt_tokens,
completion_tokens=completion_tokens,
cost_usd=cost,
model=span["model"],
))
def _replay_stream_result(span: Dict[str, Any], result: Any) -> None:
"""Finish a span from a streamed Responses API ``(text, tools, final)`` tuple."""
try:
text, final = result[0], result[2] if len(result) > 2 else None
if isinstance(text, str) and text:
span["content"].append(text)
if final is not None:
span["usage"] = getattr(final, "usage", None)
except Exception:
pass
_replay_llm_end(span)
class _ReplayStream:
"""Pass-through for a LiteLLM stream that records ``llm_response`` when it ends."""
__slots__ = ("_stream", "_iter", "_span")
def __init__(self, stream: Any, span: Dict[str, Any]) -> None:
self._stream = stream
self._iter = None
self._span = span
def __iter__(self):
return self
def __next__(self):
if self._iter is None:
self._iter = iter(self._stream)
try:
chunk = next(self._iter)
except StopIteration:
_replay_llm_end(self._span)
raise
except BaseException as exc:
_replay_llm_end(self._span, exc)
raise
_replay_observe(self._span, chunk, chunk=True)
return chunk
def __aiter__(self):
return self
async def __anext__(self):
if self._iter is None:
self._iter = self._stream.__aiter__()
try:
chunk = await self._iter.__anext__()
except StopAsyncIteration:
_replay_llm_end(self._span)
raise
except BaseException as exc:
_replay_llm_end(self._span, exc)
raise
_replay_observe(self._span, chunk, chunk=True)
return chunk
def close(self):
_replay_llm_end(self._span)
close = getattr(self._stream, "close", None)
if callable(close):
return close()
def __getattr__(self, name: str) -> Any:
return getattr(self._stream, name)
# Default per-request timeout (seconds) when ``timeout`` is not passed. Without
# it litellm falls back to its 6000s ceiling, so a provider that accepts the
# connection but never answers blocks the turn for ~100 minutes per attempt.
@@ -1736,15 +1895,25 @@ Respond with ONLY a valid JSON tool call in this format:
# entirely, so scripted turns never reach (or trip) the guard.
check_model_request(self.model, "litellm.completion")
import litellm
for step in range(_CONTEXT_OVERFLOW_SHRINK_STEPS + 1):
try:
response = self._call_with_retry(litellm.completion, **completion_params)
break
except Exception as e:
if not self._shrink_on_context_overflow(e, completion_params, step):
raise
_replay = _replay_llm_begin(self, completion_params)
try:
for step in range(_CONTEXT_OVERFLOW_SHRINK_STEPS + 1):
try:
response = self._call_with_retry(litellm.completion, **completion_params)
break
except Exception as e:
if not self._shrink_on_context_overflow(e, completion_params, step):
raise
except BaseException as exc:
_replay_llm_end(_replay, exc)
raise
if not completion_params.get("stream"):
self._track_token_usage(response, self._response_model_for_tracking(response))
if _replay is not None:
_replay_observe(_replay, response, chunk=False)
_replay_llm_end(_replay)
elif _replay is not None:
response = _ReplayStream(response, _replay)
return response
async def _acompletion_with_retry(self, **completion_params):
@@ -1765,18 +1934,28 @@ Respond with ONLY a valid JSON tool call in this format:
"""
check_model_request(self.model, "litellm.acompletion")
import litellm
for step in range(_CONTEXT_OVERFLOW_SHRINK_STEPS + 1):
try:
response = await self._call_with_retry_async(
litellm.acompletion,
**completion_params,
)
break
except Exception as e:
if not self._shrink_on_context_overflow(e, completion_params, step):
raise
_replay = _replay_llm_begin(self, completion_params)
try:
for step in range(_CONTEXT_OVERFLOW_SHRINK_STEPS + 1):
try:
response = await self._call_with_retry_async(
litellm.acompletion,
**completion_params,
)
break
except Exception as e:
if not self._shrink_on_context_overflow(e, completion_params, step):
raise
except BaseException as exc:
_replay_llm_end(_replay, exc)
raise
if not completion_params.get("stream"):
self._track_token_usage(response, self._response_model_for_tracking(response))
if _replay is not None:
_replay_observe(_replay, response, chunk=False)
_replay_llm_end(_replay)
elif _replay is not None:
response = _ReplayStream(response, _replay)
return response
def _supports_web_search(self) -> bool:
@@ -1837,10 +2016,10 @@ Respond with ONLY a valid JSON tool call in this format:
return None
if self._claude_memory_tool is None:
from ..tools.claude_memory_tool import ClaudeMemoryTool
if isinstance(self.claude_memory, bool):
# Create default memory tool
# Only the default implementation needs this dependency.
from ..tools.claude_memory_tool import ClaudeMemoryTool
self._claude_memory_tool = ClaudeMemoryTool()
else:
# Use provided memory tool instance
@@ -7636,6 +7815,32 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
return params
def _call_responses_api(self, **params) -> Any:
"""``litellm.responses()`` with retry, recorded on the replay trace."""
span = _replay_llm_begin(self, params)
if span is None:
return self._call_responses_api_impl(**params)
try:
response = self._call_responses_api_impl(**params)
except BaseException as exc:
_replay_llm_end(span, exc)
raise
self._replay_observe_responses(span, response)
_replay_llm_end(span)
return response
def _replay_observe_responses(self, span: Dict[str, Any], response: Any) -> None:
"""Usage and text of a Responses API result, for the replay trace."""
try:
span["usage"] = getattr(response, "usage", None) or (
response.get("usage") if isinstance(response, dict) else None
)
text = self._extract_from_responses_output(response)[0]
if isinstance(text, str) and text:
span["content"].append(text)
except Exception:
pass # Tracing must never break a model call.
def _call_responses_api_impl(self, **params) -> Any:
"""
Call ``litellm.responses()`` synchronously with retry support.
Returns a ``ResponsesAPIResponse`` object.
@@ -7649,6 +7854,20 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
return self._call_with_retry(litellm.responses, **params)
async def _call_responses_api_async(self, **params) -> Any:
"""``litellm.aresponses()`` with retry, recorded on the replay trace."""
span = _replay_llm_begin(self, params)
if span is None:
return await self._call_responses_api_async_impl(**params)
try:
response = await self._call_responses_api_async_impl(**params)
except BaseException as exc:
_replay_llm_end(span, exc)
raise
self._replay_observe_responses(span, response)
_replay_llm_end(span)
return response
async def _call_responses_api_async_impl(self, **params) -> Any:
"""
Call ``litellm.aresponses()`` asynchronously with retry support.
Returns a ``ResponsesAPIResponse`` object.
@@ -7778,7 +7997,20 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
except Exception:
logging.debug("Responses stream cleanup failed", exc_info=True)
def _stream_responses_api(
def _stream_responses_api(self, params: Dict[str, Any], *args: Any, **kwargs: Any) -> tuple:
"""Streamed ``litellm.responses()``, recorded on the replay trace."""
span = _replay_llm_begin(self, params)
if span is None:
return self._stream_responses_api_impl(params, *args, **kwargs)
try:
result = self._stream_responses_api_impl(params, *args, **kwargs)
except BaseException as exc:
_replay_llm_end(span, exc)
raise
_replay_stream_result(span, result)
return result
def _stream_responses_api_impl(
self,
params: Dict[str, Any],
verbose: bool = True,
@@ -7931,7 +8163,20 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
return response_text, tool_calls if tool_calls else None, _final_response
async def _stream_responses_api_async(
async def _stream_responses_api_async(self, params: Dict[str, Any], *args: Any, **kwargs: Any) -> tuple:
"""Async streamed ``litellm.aresponses()``, recorded on the replay trace."""
span = _replay_llm_begin(self, params)
if span is None:
return await self._stream_responses_api_async_impl(params, *args, **kwargs)
try:
result = await self._stream_responses_api_async_impl(params, *args, **kwargs)
except BaseException as exc:
_replay_llm_end(span, exc)
raise
_replay_stream_result(span, result)
return result
async def _stream_responses_api_async_impl(
self,
params: Dict[str, Any],
stream_callback: Optional[Callable] = None,
@@ -13,7 +13,7 @@ Each store handles a specific type of learning data:
from abc import ABC, abstractmethod
from dataclasses import dataclass, field
from datetime import datetime
from datetime import datetime, timezone
import json
from pathlib import Path
from typing import Any, Dict, List, Optional, TYPE_CHECKING
@@ -31,8 +31,8 @@ class LearnEntry:
id: str
content: str
metadata: Dict[str, Any] = field(default_factory=dict)
created_at: str = field(default_factory=lambda: datetime.utcnow().isoformat())
updated_at: str = field(default_factory=lambda: datetime.utcnow().isoformat())
created_at: str = field(default_factory=lambda: datetime.now(timezone.utc).isoformat())
updated_at: str = field(default_factory=lambda: datetime.now(timezone.utc).isoformat())
use_count: int = 0
last_used: Optional[str] = None
@@ -53,8 +53,8 @@ class LearnEntry:
id=data["id"],
content=data["content"],
metadata=data.get("metadata", {}),
created_at=data.get("created_at", datetime.utcnow().isoformat()),
updated_at=data.get("updated_at", datetime.utcnow().isoformat()),
created_at=data.get("created_at", datetime.now(timezone.utc).isoformat()),
updated_at=data.get("updated_at", datetime.now(timezone.utc).isoformat()),
use_count=data.get("use_count", 0),
last_used=data.get("last_used"),
)
@@ -154,13 +154,13 @@ class BaseStore(ABC):
# Update metadata if provided, but don't create duplicate
if metadata:
existing_entry.metadata.update(metadata)
existing_entry.updated_at = datetime.utcnow().isoformat()
existing_entry.updated_at = datetime.now(timezone.utc).isoformat()
self._save()
self._was_updated = True
return existing_entry
# No duplicate found, create new entry
entry_id = f"{self.store_name}_{len(self._entries)}_{datetime.utcnow().timestamp()}"
entry_id = f"{self.store_name}_{len(self._entries)}_{datetime.now(timezone.utc).timestamp()}"
entry = LearnEntry(
id=entry_id,
content=content,
@@ -183,7 +183,7 @@ class BaseStore(ABC):
"""
if not entries:
return
now = datetime.utcnow().isoformat()
now = datetime.now(timezone.utc).isoformat()
for entry in entries:
entry.use_count += 1
entry.last_used = now
@@ -229,7 +229,7 @@ class BaseStore(ABC):
"""List all entries."""
refreshed = self._refresh_for_retrieval()
entries = list(self._entries.values())
entries.sort(key=lambda x: x.updated_at, reverse=True)
entries.sort(key=lambda x: self._timestamp_sort_key(x.updated_at), reverse=True)
entries = entries[:limit]
if refreshed:
self._touch(entries)
@@ -244,7 +244,7 @@ class BaseStore(ABC):
entry.content = content
if metadata:
entry.metadata.update(metadata)
entry.updated_at = datetime.utcnow().isoformat()
entry.updated_at = datetime.now(timezone.utc).isoformat()
self._save()
self._was_updated = True
return entry
@@ -308,9 +308,29 @@ class BaseStore(ABC):
ref_dt = datetime.fromisoformat(reference)
except (ValueError, TypeError):
return False
if ref_dt.tzinfo is None:
ref_dt = ref_dt.replace(tzinfo=timezone.utc)
age_days = (now - ref_dt).total_seconds() / 86400.0
return age_days > self.retention_days
@staticmethod
def _timestamp_sort_key(value: str) -> tuple:
"""Comparable key that orders ISO timestamps chronologically in UTC.
Naive values are treated as UTC (matching how older stores were written).
Missing or unparseable values sort as the oldest instant, so prune()
evicts them first (an entry never used sorts before used ones, as it did
under the previous raw-string sort) and list_all() lists them last. A
datetime is never compared against a string, so mixed data never raises.
"""
try:
parsed = datetime.fromisoformat(value)
except (ValueError, TypeError):
return (-1, value)
if parsed.tzinfo is None:
parsed = parsed.replace(tzinfo=timezone.utc)
return (0, parsed.astimezone(timezone.utc))
def prune(self, save: bool = True, protect_id: Optional[str] = None) -> int:
"""Archive stale and least-used/oldest excess entries.
@@ -331,7 +351,7 @@ class BaseStore(ABC):
if self.max_entries <= 0 and self.retention_days <= 0:
return 0
now = datetime.utcnow()
now = datetime.now(timezone.utc)
evicted: List[LearnEntry] = []
# 1. Staleness: archive entries beyond the retention window
@@ -349,7 +369,11 @@ class BaseStore(ABC):
]
remaining = sorted(
candidates,
key=lambda e: (e.use_count, e.last_used or "", e.created_at),
key=lambda e: (
e.use_count,
self._timestamp_sort_key(e.last_used or ""),
self._timestamp_sort_key(e.created_at),
),
)
overflow = len(self._entries) - self.max_entries
for entry in remaining[:overflow]:
@@ -5,6 +5,7 @@ Detects and prevents agents from getting stuck in repetitive loops.
"""
from praisonaiagents._logging import get_logger
import threading
import time
from collections import defaultdict
from dataclasses import dataclass, field
@@ -93,8 +94,13 @@ class DoomLoopDetector:
self.max_tool_calls = max_tool_calls
self._records: List[ToolCallRecord] = []
# Lifetime per-tool totals, reported by get_stats() only. Loop
# decisions use the windowed _records so a slow, healthy tool is
# never permanently denied.
self._call_counts: Dict[str, int] = defaultdict(int)
self._session_id: Optional[str] = None
# check_doom_loop is reached from concurrent tool execution.
self._lock = threading.RLock()
def set_session(self, session_id: str):
"""Set the current session ID."""
@@ -125,19 +131,18 @@ class DoomLoopDetector:
Returns:
The recorded ToolCallRecord
"""
self._cleanup_old_records()
args_hash = self._hash_arguments(arguments or {})
record = ToolCallRecord(
tool_name=tool_name,
arguments_hash=args_hash,
session_id=self._session_id,
)
self._records.append(record)
self._call_counts[tool_name] += 1
with self._lock:
self._cleanup_old_records()
record = ToolCallRecord(
tool_name=tool_name,
arguments_hash=args_hash,
session_id=self._session_id,
)
self._records.append(record)
self._call_counts[tool_name] += 1
return record
def check(
@@ -155,13 +160,15 @@ class DoomLoopDetector:
Returns:
DoomLoopResult indicating if a loop is detected
"""
self._cleanup_old_records()
args_hash = self._hash_arguments(arguments or {})
with self._lock:
self._cleanup_old_records()
records = list(self._records)
# Count identical calls in window
identical_count = sum(
1 for r in self._records
1 for r in records
if r.tool_name == tool_name and r.arguments_hash == args_hash
)
@@ -176,7 +183,7 @@ class DoomLoopDetector:
)
# Check for excessive tool calls
total_calls = len(self._records)
total_calls = len(records)
if total_calls >= self.max_tool_calls:
return DoomLoopResult(
is_loop=True,
@@ -185,8 +192,8 @@ class DoomLoopDetector:
recommendation="Reduce tool usage or break task into smaller steps",
)
# Check for tool-specific excessive calls
tool_count = self._call_counts.get(tool_name, 0)
# Check for tool-specific excessive calls (within the window)
tool_count = sum(1 for r in records if r.tool_name == tool_name)
if tool_count >= self.max_tool_calls // 2:
return DoomLoopResult(
is_loop=True,
@@ -219,29 +226,32 @@ class DoomLoopDetector:
Returns:
DoomLoopResult indicating if a loop is detected
"""
result = self.check(tool_name, arguments)
if not result.is_loop:
self.record(tool_name, arguments)
with self._lock:
result = self.check(tool_name, arguments)
if not result.is_loop:
self.record(tool_name, arguments)
return result
def get_stats(self) -> Dict[str, Any]:
"""Get statistics about tool calls."""
self._cleanup_old_records()
return {
"total_calls": len(self._records),
"unique_tools": len(set(r.tool_name for r in self._records)),
"call_counts": dict(self._call_counts),
"window_seconds": self.window_seconds,
"loop_threshold": self.loop_threshold,
}
with self._lock:
self._cleanup_old_records()
return {
"total_calls": len(self._records),
"unique_tools": len(set(r.tool_name for r in self._records)),
"call_counts": dict(self._call_counts),
"window_seconds": self.window_seconds,
"loop_threshold": self.loop_threshold,
}
def reset(self):
"""Reset all records."""
self._records.clear()
self._call_counts.clear()
with self._lock:
self._records.clear()
self._call_counts.clear()
def reset_tool(self, tool_name: str):
"""Reset records for a specific tool."""
self._records = [r for r in self._records if r.tool_name != tool_name]
self._call_counts.pop(tool_name, None)
with self._lock:
self._records = [r for r in self._records if r.tool_name != tool_name]
self._call_counts.pop(tool_name, None)
@@ -80,6 +80,31 @@ class Process:
self._state_lock = asyncio.Lock()
return self._state_lock
def _trace_delegate(self, task_id, tasks_summary):
"""Record the manager's choice as a ``delegate`` hand-off (tracing on only)."""
from ..trace.context_events import get_context_emitter
emitter = get_context_emitter()
if not emitter._enabled:
return
from ..workflows.diagram import task_node_id
task = self.tasks[task_id]
agent = getattr(getattr(task, "agent", None), "name", None)
emitter.agent_handoff(
"Manager",
agent,
reason=f"Manager delegated task {getattr(task, 'name', None) or task_id}",
context_passed={
"task_id": task_id,
"task_status": [
{"task_id": t.get("task_id"), "name": t.get("name"),
"status": t.get("status"), "agent": t.get("agent")}
for t in tasks_summary
],
},
kind="delegate",
node_id=task_node_id(self.tasks, task),
)
def _task_by_name(self, name):
"""Return the task whose name matches, or None. First-match, mirrors prior inline lookup."""
return next((t for t in self.tasks.values() if t.name == name), None)
@@ -1256,6 +1281,7 @@ Provide a JSON with the structure:
if self.tasks[selected_task_id].status != "completed":
logging.info(f"Starting execution of task {selected_task_id}")
self._trace_delegate(selected_task_id, tasks_summary)
yield selected_task_id
logging.info(f"Finished execution of task {selected_task_id}, status: {self.tasks[selected_task_id].status}")
# Count a task toward completion only the first time it actually
@@ -1916,6 +1942,7 @@ Provide a JSON with the structure:
if self.tasks[selected_task_id].status != "completed":
logging.info(f"Starting execution of task {selected_task_id}")
self._trace_delegate(selected_task_id, tasks_summary)
yield selected_task_id
logging.info(f"Finished execution of task {selected_task_id}, status: {self.tasks[selected_task_id].status}")
# Count a task toward completion only the first time it actually
@@ -154,6 +154,7 @@ class RAG:
user_id: Optional[str] = None,
agent_id: Optional[str] = None,
run_id: Optional[str] = None,
top_k: Optional[int] = None,
**kwargs,
) -> List[Dict[str, Any]]:
"""
@@ -193,8 +194,8 @@ class RAG:
filtered.append(r)
results = filtered
# Limit to top_k
results = results[:self.config.top_k]
# Limit to top_k (per-call value, never written back to shared config)
results = results[:self.config.top_k if top_k is None else top_k]
return results
@@ -202,6 +203,7 @@ class RAG:
self,
query: str,
results: List[Dict[str, Any]],
rerank: Optional[bool] = None,
) -> List[Dict[str, Any]]:
"""
Rerank results if reranker is configured.
@@ -213,7 +215,9 @@ class RAG:
Returns:
Reranked results
"""
if not self.config.rerank or not self.reranker:
if rerank is None:
rerank = self.config.rerank
if not rerank or not self.reranker:
return results
try:
@@ -354,54 +358,47 @@ class RAG:
"""
start_time = time.time()
# Apply overrides
original_top_k = self.config.top_k
original_rerank = self.config.rerank
# Resolve per-call overrides without mutating the shared config:
# aretrieve() runs this in an executor, so concurrent calls on one RAG
# would otherwise see (and permanently "restore") each other's values.
eff_top_k = self.config.top_k if top_k is None else top_k
eff_rerank = self.config.rerank if rerank is None else rerank
if top_k is not None:
self.config.top_k = top_k
if rerank is not None:
self.config.rerank = rerank
# 1. Retrieve
results = self._retrieve(
query=query,
user_id=user_id,
agent_id=agent_id,
run_id=run_id,
filters=filters,
top_k=eff_top_k,
**kwargs,
)
try:
# 1. Retrieve
results = self._retrieve(
query=query,
user_id=user_id,
agent_id=agent_id,
run_id=run_id,
filters=filters,
**kwargs,
)
# 2. Rerank (optional)
results = self._rerank(query, results)
# 3. Build context
context, used_results = self._build_context(results)
# 4. Format citations
citations = self._format_citations(used_results)
elapsed = time.time() - start_time
return ContextPack(
context=context,
citations=citations,
query=query,
metadata={
"elapsed_seconds": elapsed,
"num_results": len(results),
"num_citations": len(citations),
"retrieval_strategy": self.config.retrieval_strategy.value,
"reranked": self.config.rerank,
"top_k": self.config.top_k,
},
)
finally:
# Restore original config
self.config.top_k = original_top_k
self.config.rerank = original_rerank
# 2. Rerank (optional)
results = self._rerank(query, results, rerank=eff_rerank)
# 3. Build context
context, used_results = self._build_context(results)
# 4. Format citations
citations = self._format_citations(used_results)
elapsed = time.time() - start_time
return ContextPack(
context=context,
citations=citations,
query=query,
metadata={
"elapsed_seconds": elapsed,
"num_results": len(results),
"num_citations": len(citations),
"retrieval_strategy": self.config.retrieval_strategy.value,
"reranked": eff_rerank,
"top_k": eff_top_k,
},
)
async def aretrieve(
self,
@@ -131,26 +131,44 @@ class SmartRetriever:
if not self._knowledge:
return result
has_filters = bool(include_glob or exclude_glob or path_filter or metadata_filters)
if path_filter:
import re
try:
re.compile(path_filter)
except re.error as e:
# Fail closed: silently dropping the filter would return every
# chunk while still reporting the result as filtered.
raise ValueError(f"Invalid path_filter regex {path_filter!r}: {e}") from e
# Filters are applied after the store truncates, so over-fetch when any
# is set (same rule as Memory's metadata_filter search) -- otherwise a
# filter whose matches sit just below the top_k cut returns nothing.
fetch_k = top_k * 3 if strategy in ("reranked", "hybrid") else top_k
if has_filters:
fetch_k = max(fetch_k, top_k * 10)
# Get initial results from knowledge store
search_results = self._search(
search_results, error = self._search(
query=query,
top_k=top_k * 3 if strategy in ("reranked", "hybrid") else top_k,
top_k=fetch_k,
user_id=user_id,
agent_id=agent_id,
)
# Surface a store failure on the result. Without this the caller sees an
# empty chunk list and cannot tell whether the knowledge base had no
# match or was never reached.
if getattr(self, "_last_error", None):
# match or was never reached. The error is returned rather than stored
# on self so concurrent calls on one retriever cannot see each other's.
if error:
result.retrieval_failed = True
result.error = self._last_error
result.metadata["retrieval_error"] = self._last_error
result.error = error
result.metadata["retrieval_error"] = error
chunks = self._normalize_results(search_results)
result.total_found = len(chunks)
# Apply filters
if include_glob or exclude_glob or path_filter or metadata_filters:
if has_filters:
chunks = self._apply_filters(
chunks,
include_glob=include_glob,
@@ -176,23 +194,22 @@ class SmartRetriever:
top_k: int,
user_id: Optional[str] = None,
agent_id: Optional[str] = None,
) -> Any:
"""Perform search on knowledge store."""
self._last_error = None
) -> tuple:
"""Perform search on knowledge store. Returns ``(results, error)``."""
try:
return self._knowledge.search(
query,
user_id=user_id,
agent_id=agent_id,
limit=top_k,
)
), None
except Exception as e:
# Record the failure rather than returning a bare [] that is
# indistinguishable from "nothing matched". Knowledge.search itself
# re-raises, so reaching here means the store really is broken --
# misconfigured, unreachable, or refusing auth -- and the agent is
# about to answer with no context at all.
self._last_error = f"{type(e).__name__}: {e}"
error = f"{type(e).__name__}: {e}"
# Do not log the raw query: it may carry personal data, credentials
# or proprietary text, and this line lands at ERROR in application
# logs. The exception text is enough to diagnose the store; the
@@ -200,9 +217,9 @@ class SmartRetriever:
logger.error(
"Knowledge retrieval failed (query length %d): %s. "
"Returning no chunks; the answer will not use the knowledge base.",
len(query or ""), self._last_error,
len(query or ""), error,
)
return []
return [], error
def _normalize_results(self, results: Any) -> List[Dict[str, Any]]:
"""Normalize search results to list of dicts."""
@@ -275,12 +292,8 @@ class SmartRetriever:
continue
# Check path filter regex
if path_filter:
try:
if not re.search(path_filter, filepath):
continue
except re.error:
pass
if path_filter and not re.search(path_filter, filepath):
continue
# Check metadata filters
if metadata_filters:
@@ -29,6 +29,10 @@ DEFAULT_MAX_LINES = 2000
# cannot dominate the window.
DEFAULT_MAX_LINE_CHARS = 2000
# Default byte cap for ``download_file`` so an endless or oversized response
# cannot fill the disk. Override with PRAISONAI_MAX_DOWNLOAD_BYTES.
_DEFAULT_MAX_DOWNLOAD_BYTES = 100 * 1024 * 1024
def _render_with_line_numbers(lines, start_index, max_line_chars):
"""Render ``lines`` with a right-aligned 1-based line-number gutter.
@@ -485,58 +489,63 @@ class FileTools:
# Validate destination path
safe_path = self._validate_path(destination)
# Validate URL to prevent SSRF
# Validate URL to prevent SSRF (shared guard used by all HTTP tools)
from urllib.parse import urlparse
import ipaddress
import socket
from .url_safety import is_safe_http_url
parsed = urlparse(url)
if parsed.scheme not in ("http", "https"):
return {
"success": False, "path": "", "size": 0,
"error": f"Unsupported URL scheme: {parsed.scheme}. Only http/https allowed."
}
hostname = parsed.hostname or ""
# Resolve hostname and check for private/reserved IPs
try:
resolved = socket.getaddrinfo(hostname, parsed.port or 443)
for family, _, _, _, sockaddr in resolved:
addr = ipaddress.ip_address(sockaddr[0])
if addr.is_private or addr.is_loopback or addr.is_reserved or addr.is_link_local:
return {
"success": False, "path": "", "size": 0,
"error": f"Access to private/internal addresses is blocked: {hostname}"
}
except (socket.gaierror, ValueError):
pass # Let httpx handle DNS failures naturally
# Block cloud metadata endpoints
_blocked_hosts = {"169.254.169.254", "metadata.google.internal", "metadata.google.com"}
if hostname in _blocked_hosts:
# allow_local=False: download_file never had a local-access opt-in,
# so ALLOW_LOCAL_CRAWL must not bypass this check.
if not is_safe_http_url(url, allow_local=False):
return {
"success": False, "path": "", "size": 0,
"error": f"Access to metadata service is blocked: {hostname}"
"error": f"Access to private/internal addresses is blocked: {parsed.hostname or ''}"
}
max_bytes = int(os.environ.get("PRAISONAI_MAX_DOWNLOAD_BYTES", _DEFAULT_MAX_DOWNLOAD_BYTES))
# Create directory if needed
os.makedirs(os.path.dirname(safe_path) or ".", exist_ok=True)
# Download file
with httpx.stream("GET", url, timeout=timeout, follow_redirects=False) as response:
response.raise_for_status()
total_size = int(response.headers.get("content-length", 0))
downloaded = 0
with open(safe_path, "wb") as f:
dest_dir = os.path.dirname(safe_path) or "."
os.makedirs(dest_dir, exist_ok=True)
# Download into a temp file next to the destination and only
# replace the destination on success, so a failed or oversized
# download never clobbers an existing file.
import tempfile
fd, tmp_path = tempfile.mkstemp(dir=dest_dir, suffix=".part")
try:
with os.fdopen(fd, "wb") as f, \
httpx.stream("GET", url, timeout=timeout, follow_redirects=False) as response:
response.raise_for_status()
total_size = int(response.headers.get("content-length", 0))
downloaded = 0
for chunk in response.iter_bytes(chunk_size=8192):
f.write(chunk)
downloaded += len(chunk)
if downloaded > max_bytes:
break
f.write(chunk)
if progress_callback and total_size:
progress_callback(downloaded, total_size)
if downloaded > max_bytes:
return {
"success": False, "path": "", "size": 0,
"error": f"Download exceeds {max_bytes} bytes"
}
os.replace(tmp_path, safe_path)
finally:
if os.path.exists(tmp_path):
os.unlink(tmp_path)
return {
"success": True,
"path": safe_path,
@@ -3,7 +3,7 @@ import re
import subprocess
import logging
import secrets
from typing import Optional
from typing import List, Optional
from .decorator import tool
logger = logging.getLogger(__name__)
@@ -11,22 +11,22 @@ logger = logging.getLogger(__name__)
AGENT_BRANCH_PREFIX = "praisonai/"
def _git(*args: str) -> subprocess.CompletedProcess:
"""Run a git command capturing output as text."""
return subprocess.run(["git", *args], check=True, capture_output=True, text=True)
def _git(*args: str, cwd: Optional[str] = None) -> subprocess.CompletedProcess:
"""Run a git command (in ``cwd`` when given) capturing output as text."""
return subprocess.run(["git", *args], check=True, capture_output=True, text=True, cwd=cwd)
def _default_branch() -> str:
def _default_branch(cwd: Optional[str] = None) -> str:
"""Detect the remote default branch, falling back to main/master."""
try:
ref = _git("symbolic-ref", "refs/remotes/origin/HEAD").stdout.strip()
ref = _git("symbolic-ref", "refs/remotes/origin/HEAD", cwd=cwd).stdout.strip()
# e.g. refs/remotes/origin/main -> main
return ref.rsplit("/", 1)[-1]
except subprocess.CalledProcessError:
pass
for candidate in ("main", "master"):
try:
_git("show-ref", "--verify", "--quiet", f"refs/remotes/origin/{candidate}")
_git("show-ref", "--verify", "--quiet", f"refs/remotes/origin/{candidate}", cwd=cwd)
return candidate
except subprocess.CalledProcessError:
continue
@@ -45,7 +45,7 @@ def _auto_branch_name(commit_message: str) -> str:
return f"{AGENT_BRANCH_PREFIX}{_slugify(commit_message)}-{secrets.token_hex(3)}"
def _divergence_refusal(branch: str) -> Optional[str]:
def _divergence_refusal(branch: str, cwd: Optional[str] = None) -> Optional[str]:
"""Return a refusal reason if pushing ``branch`` would require a force.
A force push is required when the remote branch exists but is not an
@@ -54,13 +54,13 @@ def _divergence_refusal(branch: str) -> Optional[str]:
agent-prefixed ones.
"""
try:
_git("show-ref", "--verify", "--quiet", f"refs/remotes/origin/{branch}")
_git("show-ref", "--verify", "--quiet", f"refs/remotes/origin/{branch}", cwd=cwd)
remote_exists = True
except subprocess.CalledProcessError:
remote_exists = False
if remote_exists:
try:
_git("merge-base", "--is-ancestor", f"origin/{branch}", "HEAD")
_git("merge-base", "--is-ancestor", f"origin/{branch}", "HEAD", cwd=cwd)
except subprocess.CalledProcessError:
return (
f"refusing to push to '{branch}': the remote branch has "
@@ -69,7 +69,7 @@ def _divergence_refusal(branch: str) -> Optional[str]:
return None
def _branch_push_safety(branch: str) -> Optional[str]:
def _branch_push_safety(branch: str, cwd: Optional[str] = None) -> Optional[str]:
"""Return a refusal reason if pushing ``branch`` is unsafe, else None.
Rules (see github_commit_and_push docstring):
@@ -82,14 +82,14 @@ def _branch_push_safety(branch: str) -> Optional[str]:
(i.e. would require a force push) are refused.
"""
# Divergence (force-push) is refused for every branch, agent-prefixed or not.
diverged = _divergence_refusal(branch)
diverged = _divergence_refusal(branch, cwd=cwd)
if diverged:
return diverged
if branch.startswith(AGENT_BRANCH_PREFIX):
return None
default = _default_branch()
default = _default_branch(cwd=cwd)
if branch == default:
return (
f"refusing to push to '{branch}': it is the repository "
@@ -99,16 +99,16 @@ def _branch_push_safety(branch: str) -> Optional[str]:
# Foreign-author check: commits on this branch since the merge-base with
# the default branch must all be authored by the configured committer.
try:
committer = _git("config", "user.email").stdout.strip()
committer = _git("config", "user.email", cwd=cwd).stdout.strip()
except subprocess.CalledProcessError:
committer = ""
if committer:
try:
merge_base = _git(
"merge-base", f"origin/{default}", "HEAD"
"merge-base", f"origin/{default}", "HEAD", cwd=cwd
).stdout.strip()
authors = _git(
"log", "--format=%ae", f"{merge_base}..HEAD"
"log", "--format=%ae", f"{merge_base}..HEAD", cwd=cwd
).stdout.split()
foreign = {a for a in authors if a and a != committer}
if foreign:
@@ -123,25 +123,27 @@ def _branch_push_safety(branch: str) -> Optional[str]:
return None
@tool
def github_create_branch(branch_name: str) -> str:
def github_create_branch(branch_name: str, repo_path: Optional[str] = None) -> str:
"""Create and checkout a new git branch.
Args:
branch_name: The name of the branch to create and checkout.
repo_path: Repository directory to run git in. Defaults to the
current working directory.
"""
try:
# Check if we are in a git repository
subprocess.run(["git", "rev-parse", "--is-inside-work-tree"], check=True, capture_output=True)
subprocess.run(["git", "rev-parse", "--is-inside-work-tree"], check=True, capture_output=True, cwd=repo_path)
# Validate branch name to prevent misinterpretation as git options or invalid refs
try:
subprocess.run(
["git", "check-ref-format", f"refs/heads/{branch_name}"],
check=True, capture_output=True, text=True
check=True, capture_output=True, text=True, cwd=repo_path
)
except subprocess.CalledProcessError as e:
return f"Error: invalid branch name '{branch_name}': {e.stderr.strip() if e.stderr else 'branch name is not a valid git ref'}"
subprocess.run(["git", "checkout", "-B", branch_name], check=True, capture_output=True, text=True)
subprocess.run(["git", "checkout", "-B", branch_name], check=True, capture_output=True, text=True, cwd=repo_path)
logger.debug(f"Branch '{branch_name}' checked out successfully.")
logger.debug(f"Successfully checked out branch '{branch_name}'")
return f"Successfully created and checked out branch '{branch_name}'"
@@ -154,8 +156,15 @@ def github_commit_and_push(
commit_message: str,
branch: Optional[str] = None,
allow_unsafe_branch: bool = False,
repo_path: Optional[str] = None,
paths: Optional[List[str]] = None,
) -> str:
"""Stage all changes, commit them, and push to the remote repository safely.
"""Stage tracked changes, commit them, and push to the remote repository safely.
Only changes to already-tracked files under the working directory are
staged (``git add -u -- .``); new files are committed only when listed in
``paths``. Staging happens after the safety checks below, so a refusal
leaves the index untouched.
Pushes are safe by construction. Before pushing, these rules are enforced:
@@ -176,25 +185,27 @@ def github_commit_and_push(
branch: Target branch to push to. Defaults to the current branch.
allow_unsafe_branch: Opt-in override for the default/foreign-author
refusals. Divergence (force-push) is never allowed.
repo_path: Repository directory to run git in. Defaults to the
current working directory.
paths: Extra (e.g. untracked) files to stage alongside tracked changes.
"""
try:
allow_unsafe = allow_unsafe_branch or os.environ.get(
"PRAISONAI_GIT_ALLOW_UNSAFE_BRANCH", ""
).lower() in ("1", "true", "yes")
# Add all changes
subprocess.run(["git", "add", "."], check=True, capture_output=True)
# Check if there are changes to commit
status = subprocess.run(["git", "status", "--porcelain"], check=True, capture_output=True, text=True)
if not status.stdout.strip():
# Check if there are changes to commit (tracked changes or explicit paths)
status = _git(
"status", "--porcelain", "--untracked-files=no", "--", ".", cwd=repo_path
)
if not status.stdout.strip() and not paths:
return "No changes to commit."
# Resolve target branch (defaults to current)
current_branch = _git("rev-parse", "--abbrev-ref", "HEAD").stdout.strip()
current_branch = _git("rev-parse", "--abbrev-ref", "HEAD", cwd=repo_path).stdout.strip()
target_branch = branch or current_branch
default = _default_branch()
default = _default_branch(cwd=repo_path)
auto_created = False
# Rule 2: default branch is never pushed directly (unless overridden).
@@ -207,7 +218,7 @@ def github_commit_and_push(
# retry can then succeed). Adding the new commit does not change the
# divergence/foreign-author verdicts, which are about existing history.
if not allow_unsafe:
reason = _branch_push_safety(target_branch)
reason = _branch_push_safety(target_branch, cwd=repo_path)
if reason:
return f"Error: {reason}"
else:
@@ -217,14 +228,14 @@ def github_commit_and_push(
"checks for '%s'", target_branch
)
# Even when overriding, divergence (force) is never permitted.
diverged = _divergence_refusal(target_branch)
diverged = _divergence_refusal(target_branch, cwd=repo_path)
if diverged:
return f"Error: {diverged}"
# Move to the resolved branch only after passing safety checks.
if auto_created:
# Fresh agent branch created from current HEAD.
_git("checkout", "-B", target_branch)
_git("checkout", "-B", target_branch, cwd=repo_path)
elif target_branch != current_branch:
# Switch to the requested branch without discarding its commits:
# ``-B`` would reset an existing branch to HEAD, so use a plain
@@ -233,17 +244,24 @@ def github_commit_and_push(
try:
_git(
"show-ref", "--verify", "--quiet",
f"refs/heads/{target_branch}",
f"refs/heads/{target_branch}", cwd=repo_path,
)
_git("checkout", target_branch)
_git("checkout", target_branch, cwd=repo_path)
except subprocess.CalledProcessError:
_git("checkout", "-b", target_branch)
_git("checkout", "-b", target_branch, cwd=repo_path)
# Stage tracked changes under cwd plus explicitly listed paths (never
# ``git add .``). The ``.`` pathspec keeps ``-u`` from reaching sibling
# directories when run from a repository subdirectory.
_git("add", "-u", "--", ".", cwd=repo_path)
if paths:
_git("add", "--", *paths, cwd=repo_path)
# Commit changes on the resolved branch
subprocess.run(["git", "commit", "-m", commit_message], check=True, capture_output=True, text=True)
_git("commit", "-m", commit_message, cwd=repo_path)
# Push to remote (never with --force)
subprocess.run(["git", "push", "-u", "origin", target_branch], check=True, capture_output=True, text=True)
_git("push", "-u", "origin", target_branch, cwd=repo_path)
if auto_created:
return (
f"Successfully committed and pushed changes to new agent branch "
@@ -255,7 +273,13 @@ def github_commit_and_push(
return f"Error committing and pushing: {e.stderr}"
@tool
def github_create_pull_request(title: str, body: str, head_branch: str, base_branch: str = "main") -> str:
def github_create_pull_request(
title: str,
body: str,
head_branch: str,
base_branch: str = "main",
repo_path: Optional[str] = None,
) -> str:
"""Create a Pull Request on GitHub using the gh CLI.
Args:
@@ -267,6 +291,8 @@ def github_create_pull_request(title: str, body: str, head_branch: str, base_bra
This is typically the feature branch you've been working on.
base_branch: The target branch to merge your changes into. Usually the main
development branch like "main", "master", or "develop". Defaults to "main".
repo_path: Repository directory to run gh in. Defaults to the current
working directory.
Returns:
str: Success message with PR URL if created successfully, or error message if failed.
@@ -282,7 +308,7 @@ def github_create_pull_request(title: str, body: str, head_branch: str, base_bra
"""
try:
# Verify gh CLI is installed and authenticated
subprocess.run(["gh", "auth", "status"], check=True, capture_output=True)
subprocess.run(["gh", "auth", "status"], check=True, capture_output=True, cwd=repo_path)
# Create PR
cmd = [
@@ -292,7 +318,7 @@ def github_create_pull_request(title: str, body: str, head_branch: str, base_bra
"--head", head_branch,
"--base", base_branch
]
result = subprocess.run(cmd, check=True, capture_output=True, text=True)
result = subprocess.run(cmd, check=True, capture_output=True, text=True, cwd=repo_path)
return f"Successfully created Pull Request:\n{result.stdout.strip()}"
except subprocess.CalledProcessError as e:
logger.error(f"Failed to create PR: {e.stderr}")
@@ -89,7 +89,10 @@ def is_safe_http_url(
continue
return False
if (
ip.is_private
# is_global also catches shared/CGNAT space (100.64.0.0/10,
# e.g. Alibaba Cloud metadata), which is_private misses.
not ip.is_global
or ip.is_private
or ip.is_link_local
or ip.is_multicast
or ip.is_unspecified
@@ -9,10 +9,12 @@ Zero Performance Impact:
- Disabled emitter has near-zero overhead
- Uses __slots__ for memory efficiency
Schema Version: 1.0
Schema Version: 1.1 (adds optional run_id / parent_seq / node_id; 1.0 files still load)
"""
import contextvars
import itertools
import threading
import time
from contextlib import contextmanager
from dataclasses import dataclass, field
@@ -21,7 +23,7 @@ from typing import Any, Dict, Generator, List, Optional, Protocol, runtime_check
import json
CONTEXT_SCHEMA_VERSION = "1.0"
CONTEXT_SCHEMA_VERSION = "1.1"
# =============================================================================
@@ -37,6 +39,28 @@ _context_emitter: contextvars.ContextVar["ContextTraceEmitter"] = contextvars.Co
# Singleton disabled emitter for default case (zero allocation per call)
_default_disabled_emitter: Optional["ContextTraceEmitter"] = None
# Per-context run state. These live in contextvars, not on the emitter, so
# concurrent Parallel/Loop branches (each running in its own copied context, see
# copy_context_to_callable) and gathered asyncio tasks cannot clobber each
# other. Values are immutable tuples and are only ever replaced via .set(), so
# a copied context never shares a mutable object with its parent.
#
# Entries are keyed by the owning emitter's ``_uid`` so state set through one
# emitter never leaks into events of another emitter in the same context.
_branch_var: contextvars.ContextVar = contextvars.ContextVar(
'praisonai_trace_branch', default=None # (emitter_uid, branch_id)
)
_span_var: contextvars.ContextVar = contextvars.ContextVar(
'praisonai_trace_spans', default=() # ((emitter_uid, seq, kind, key), ...)
)
_run_id_var: contextvars.ContextVar = contextvars.ContextVar(
'praisonai_trace_run_id', default=None
)
_llm_open_var: contextvars.ContextVar = contextvars.ContextVar(
'praisonai_trace_llm_open', default=None # (emitter_uid, parent_seq, previous)
)
_emitter_uids = itertools.count(1)
def get_context_emitter() -> "ContextTraceEmitter":
"""
@@ -114,12 +138,130 @@ def trace_context(emitter: "ContextTraceEmitter") -> Generator["ContextTraceEmit
reset_context_emitter(token)
@contextmanager
def _run_scope(run_id: Optional[str] = None) -> Generator[str, None, None]:
"""Stamp ``run_id`` on every event emitted inside the block.
Nested teams and flows inherit the OUTER run id: when a run id is already
in scope it is kept and ``run_id`` is ignored. A fresh uuid is used when no
id is given. Yields the effective run id.
The recording is the run boundary: inside an outer scope (for example
``praisonai.replay.record()``) every team or flow start shares one run id;
outside one, a team run is stamped with its own ``AgentTeam.run_id``.
"""
outer = _run_id_var.get()
if outer is not None:
yield outer
return
if not run_id:
import uuid
run_id = uuid.uuid4().hex
token = _run_id_var.set(run_id)
try:
yield run_id
finally:
try:
_run_id_var.reset(token)
except ValueError:
# Exited from a different context than it was entered in.
_run_id_var.set(None)
@contextmanager
def _workflow_scope(
kind: str,
name: Optional[str],
process: str,
graph_fn=None,
run_id: Optional[str] = None,
) -> Generator[Optional[Dict[str, Any]], None, None]:
"""Emit ``workflow_start``/``workflow_end`` around a team or flow run.
Yields ``None`` (and does nothing else, not even building the graph) when
the current emitter is disabled. Otherwise yields a mutable dict whose
``"status"`` the caller may set to ``"failed"``; an exception escaping the
block always records ``"failed"``.
"""
emitter = get_context_emitter()
if not emitter._enabled:
yield None
return
with _run_scope(run_id):
graph = None
if graph_fn is not None:
try:
graph = graph_fn()
except Exception:
graph = None # A diagram must never break a run.
emitter.workflow_start(kind, name, process, graph=graph)
state: Dict[str, Any] = {"status": "completed"}
started = time.perf_counter()
try:
yield state
except BaseException:
state["status"] = "failed"
raise
finally:
emitter.workflow_end(
status=state.get("status") or "completed",
duration_ms=(time.perf_counter() - started) * 1000,
)
def _approval_begin(request: Any, kind: str = "tool_call", node_id: Optional[str] = None):
"""Emit ``approval_requested`` for an ``ApprovalRequest``; token or None."""
emitter = get_context_emitter()
if not emitter._enabled:
return None
agent_name = getattr(request, "agent_name", None)
tool = getattr(request, "tool_name", None) or ""
if node_id is None and kind == "tool_call":
node_id = f"tool:{agent_name}/{tool}" if agent_name else None
emitter.approval_requested(
getattr(request, "approval_id", None) or "",
tool,
args=getattr(request, "arguments", None),
risk=getattr(request, "risk_level", None),
kind=kind,
agent_name=agent_name,
node_id=node_id,
)
return emitter, request, node_id
def _approval_end(token, decision: Any = None, error: Optional[BaseException] = None) -> None:
"""Emit ``approval_decided`` for a token from :func:`_approval_begin`."""
if token is None:
return
emitter, request, node_id = token
if decision is None:
approved, reason, approver, modified = False, f"approval failed: {error}", None, False
else:
approved = bool(getattr(decision, "approved", False))
reason = getattr(decision, "reason", None)
approver = getattr(decision, "approver", None)
modified = bool(getattr(decision, "modified_args", None))
emitter.approval_decided(
getattr(request, "approval_id", None) or "",
approved,
reason=reason,
approver=approver,
modified=modified,
agent_name=getattr(request, "agent_name", None),
node_id=node_id,
)
def copy_context_to_callable(func):
"""
Wrap a callable to copy the current context to the new thread/executor.
This is needed because contextvars are NOT automatically propagated to
thread pool executors. Use this when calling run_in_executor().
The whole context is copied, so the replay state (emitter, run id, branch
id and the open-span stack that yields ``parent_seq``) reaches the thread.
Usage:
# Instead of:
@@ -159,6 +301,53 @@ class ContextEventType(str, Enum):
# Knowledge events for knowledge utilization tracking
KNOWLEDGE_SEARCH = "knowledge_search"
KNOWLEDGE_ADD = "knowledge_add"
# Run structure (schema 1.1): teams/flows, tasks, flow steps, approvals
WORKFLOW_START = "workflow_start"
WORKFLOW_END = "workflow_end"
TASK_START = "task_start"
TASK_END = "task_end"
STEP_START = "step_start"
STEP_END = "step_end"
APPROVAL_REQUESTED = "approval_requested"
APPROVAL_DECIDED = "approval_decided"
class _UnknownEventType(str):
"""An ``event_type`` string this version does not know.
``from_dict`` keeps the raw value instead of relabelling it, so a trace
written by a newer version stays readable. ``.value`` mirrors the Enum API
so existing ``event.event_type.value`` callers keep working.
"""
__slots__ = ()
@property
def value(self) -> str:
return str(self)
# Span bookkeeping: which event types open/close a span, and of which kind.
_SPAN_START = {
"session_start": "session",
"agent_start": "agent",
"tool_call_start": "tool_call",
"workflow_start": "workflow",
"task_start": "task",
"step_start": "step",
"approval_requested": "approval",
}
_SPAN_END = {
"session_end": "session",
"agent_end": "agent",
"tool_call_end": "tool_call",
"workflow_end": "workflow",
"task_end": "task",
"step_end": "step",
"approval_decided": "approval",
}
_PREVIEW_LIMIT = 500
_UNSET = object()
@dataclass
@@ -184,6 +373,10 @@ class ContextEvent:
completion_tokens: Number of tokens in the completion/response
cost_usd: Estimated cost in USD for this event
content_hash: SHA256 hash of content for duplicate detection
run_id: The team/flow/recorded run this event belongs to (1.1)
parent_seq: sequence_num of the enclosing (or, on *_end, the closed)
*_start event (1.1)
node_id: Graph node the event concerns, e.g. ``agent:Writer`` (1.1)
"""
event_type: ContextEventType
timestamp: float
@@ -199,6 +392,9 @@ class ContextEvent:
completion_tokens: int = 0
cost_usd: float = 0.0
content_hash: Optional[str] = None
run_id: Optional[str] = None
parent_seq: Optional[int] = None
node_id: Optional[str] = None
def to_dict(self) -> Dict[str, Any]:
"""Convert to dictionary for serialization."""
@@ -221,6 +417,12 @@ class ContextEvent:
result["branch_id"] = self.branch_id
if self.content_hash is not None:
result["content_hash"] = self.content_hash
if self.run_id is not None:
result["run_id"] = self.run_id
if self.parent_seq is not None:
result["parent_seq"] = self.parent_seq
if self.node_id is not None:
result["node_id"] = self.node_id
return result
def to_json(self) -> str:
@@ -232,12 +434,12 @@ class ContextEvent:
"""Create ContextEvent from dictionary."""
event_type_str = data.get("event_type", "")
# Convert string to enum
# Convert string to enum. An unknown type (written by a newer version)
# keeps its raw string rather than being relabelled as something else.
try:
event_type = ContextEventType(event_type_str)
except ValueError:
# Fallback for unknown event types
event_type = ContextEventType.CONTEXT_SNAPSHOT
event_type = _UnknownEventType(event_type_str)
return cls(
event_type=event_type,
@@ -254,6 +456,9 @@ class ContextEvent:
completion_tokens=data.get("completion_tokens", 0),
cost_usd=data.get("cost_usd", 0.0),
content_hash=data.get("content_hash"),
run_id=data.get("run_id"),
parent_seq=data.get("parent_seq"),
node_id=data.get("node_id"),
)
@@ -349,6 +554,28 @@ class ContextListSink:
return iter(self._events)
def _innermost(stack: tuple, uid: int) -> Optional[int]:
"""Sequence number of the innermost open span owned by emitter ``uid``."""
for entry in reversed(stack):
if entry[0] == uid:
return entry[1]
return None
def _find_span(stack: tuple, uid: int, kind: str, key: Any) -> Optional[int]:
"""Index of the innermost open span matching kind+key (else kind only)."""
fallback = None
for i in range(len(stack) - 1, -1, -1):
entry = stack[i]
if entry[0] != uid or entry[2] != kind:
continue
if entry[3] == key:
return i
if fallback is None:
fallback = i
return fallback
class ContextTraceEmitter:
"""
Emitter for context trace events.
@@ -367,7 +594,7 @@ class ContextTraceEmitter:
emitter.session_end()
"""
__slots__ = ("_sink", "_session_id", "_enabled", "_redact", "_sequence", "_branch_id", "_full_content")
__slots__ = ("_sink", "_session_id", "_enabled", "_redact", "_full_content", "_uid", "_counter", "_lock")
# Default limits for truncation (can be overridden with full_content=True)
# Increased significantly to capture full search results and avoid false truncation
@@ -396,40 +623,124 @@ class ContextTraceEmitter:
self._session_id = session_id
self._enabled = enabled
self._redact = redact
self._sequence = 0
self._branch_id: Optional[str] = None
self._full_content = full_content
self._uid = next(_emitter_uids)
# itertools.count is atomic under the GIL; the lock additionally keeps
# the sink's append order equal to sequence order when Parallel/Loop
# branches emit from several threads at once (live tailers resume by
# sequence number, so an out-of-order line would be skipped).
self._counter = itertools.count()
self._lock = threading.RLock()
def _emit(self, event: ContextEvent) -> None:
"""Internal emit with enabled check and sequence assignment.
def _emit(self, event: ContextEvent, span_key: Any = _UNSET) -> None:
"""Internal emit with enabled check, sequence and span assignment.
Stamps ``sequence_num``, ``branch_id``, ``run_id`` and ``parent_seq``.
A ``*_start`` event (and ``approval_requested``) opens a span on the
per-context stack; the matching ``*_end`` closes it and points its
``parent_seq`` at the start it closes. Every other event points at the
innermost open span.
Exception-safe: sink errors are silently caught to prevent
tracing from crashing agent execution.
"""
if not self._enabled:
return
event.sequence_num = self._sequence
event.branch_id = self._branch_id # Include branch context
self._sequence += 1
try:
self._sink.emit(event)
except Exception:
# Tracing should never crash agent execution
pass
uid = self._uid
branch = _branch_var.get()
event.branch_id = branch[1] if branch is not None and branch[0] == uid else None
if event.run_id is None:
event.run_id = _run_id_var.get()
etype = event.event_type
value = etype.value if isinstance(etype, ContextEventType) else str(etype)
if span_key is _UNSET:
span_key = event.node_id or event.agent_name
with self._lock:
seq = next(self._counter)
event.sequence_num = seq
stack = _span_var.get()
kind = _SPAN_START.get(value)
if kind is not None:
if event.parent_seq is None:
event.parent_seq = _innermost(stack, uid)
_span_var.set(stack + ((uid, seq, kind, span_key),))
else:
kind = _SPAN_END.get(value)
if kind is not None:
idx = _find_span(stack, uid, kind, span_key)
if idx is not None:
event.parent_seq = stack[idx][1]
# Close it and anything of ours left open above it
# (a start whose end was skipped by an exception).
_span_var.set(stack[:idx] + tuple(e for e in stack[idx + 1:] if e[0] != uid))
elif event.parent_seq is None:
event.parent_seq = _innermost(stack, uid)
try:
self._sink.emit(event)
except Exception:
# Tracing should never crash agent execution
pass
def set_branch(self, branch_id: str) -> None:
"""Set current branch context for parallel execution tracking.
All subsequent events will include this branch_id until cleared.
All subsequent events emitted from the current context (thread or
asyncio task) include this branch_id until cleared. Concurrent
branches each run in their own copied context, so they cannot
overwrite each other's branch.
Args:
branch_id: Identifier for the parallel branch (e.g., 'parallel_0', 'loop_5')
"""
self._branch_id = branch_id
_branch_var.set((self._uid, branch_id))
def clear_branch(self) -> None:
"""Clear the current branch context."""
self._branch_id = None
_branch_var.set(None)
def _preview(self, text: Any) -> Optional[str]:
"""Truncate to 500 chars and pass through redaction (for previews)."""
if text is None:
return None
text = text if isinstance(text, str) else str(text)
if self._redact:
from .redact import redact_string
text = redact_string(text[: _PREVIEW_LIMIT * 4])
return text[:_PREVIEW_LIMIT]
def _redact_args(self, args: Optional[Dict[str, Any]]) -> Dict[str, Any]:
"""Approval args: sensitive keys redacted; text values previewed + redacted."""
if not args:
return {}
if not isinstance(args, dict):
return {"value": self._preview(args)}
args = self._redact_dict(args)
return {k: self._preview(v) if isinstance(v, str) else v for k, v in args.items()}
def _current_agent(self) -> Optional[str]:
"""Name of the innermost open agent span in this context, if any."""
uid = self._uid
for entry in reversed(_span_var.get()):
if entry[0] == uid and entry[2] == "agent":
key = entry[3]
if isinstance(key, str) and key.startswith("agent:"):
return key[len("agent:"):]
return key
return None
def _llm_call_open(self) -> bool:
"""True while a caller-emitted ``llm_request`` awaits its response.
The agent's OpenAI-client path emits llm_request/llm_response around
its whole dispatch, which may itself reach the LiteLLM path; the LLM
class checks this so the same call is not counted twice. The marker is
only honoured inside the span it was opened in, so one left behind by
an exception goes stale as soon as that span closes.
"""
mark = _llm_open_var.get()
if mark is None or mark[0] != self._uid:
return False
return mark[1] == _innermost(_span_var.get(), self._uid)
def _redact_dict(self, data: Optional[Dict[str, Any]]) -> Optional[Dict[str, Any]]:
"""Redact sensitive data from dictionary if enabled."""
@@ -475,6 +786,7 @@ class ContextTraceEmitter:
session_id=self._session_id,
agent_name=agent_name,
data=metadata or {},
node_id=f"agent:{agent_name}" if agent_name else None,
))
def agent_end(
@@ -491,6 +803,7 @@ class ContextTraceEmitter:
session_id=self._session_id,
agent_name=agent_name,
data=metadata or {},
node_id=f"agent:{agent_name}" if agent_name else None,
))
def message_added(
@@ -540,6 +853,7 @@ class ContextTraceEmitter:
"tool_name": tool_name,
"tool_args": self._redact_dict(tool_args) if tool_args else {},
},
node_id=f"tool:{agent_name}/{tool_name}",
))
def tool_call_end(
@@ -587,6 +901,7 @@ class ContextTraceEmitter:
"duration_ms": duration_ms,
"error": error,
},
node_id=f"tool:{agent_name}/{tool_name}",
))
def _smart_truncate_result(self, result: str, tool_name: str) -> str:
@@ -686,11 +1001,27 @@ class ContextTraceEmitter:
"""
if not self._enabled:
return
event = self._llm_request_event(
agent_name, messages_count, tokens_used, tokens_budget, model, messages
)
self._emit(event)
# Mark the call open so the LLM class does not record it a second time.
# The previous marker is kept so a nested agent's call restores it.
_llm_open_var.set((self._uid, event.parent_seq, _llm_open_var.get()))
def _llm_request_event(
self,
agent_name: Optional[str],
messages_count: int,
tokens_used: int,
tokens_budget: int = 0,
model: Optional[str] = None,
messages: Optional[List[Dict[str, Any]]] = None,
) -> ContextEvent:
data = {"model": model}
if messages is not None:
data["messages"] = messages
self._emit(ContextEvent(
return ContextEvent(
event_type=ContextEventType.LLM_REQUEST,
timestamp=time.time(),
session_id=self._session_id,
@@ -699,7 +1030,8 @@ class ContextTraceEmitter:
tokens_used=tokens_used,
tokens_budget=tokens_budget,
data=data,
))
node_id=f"agent:{agent_name}" if agent_name else None,
)
def llm_response(
self,
@@ -711,6 +1043,7 @@ class ContextTraceEmitter:
prompt_tokens: int = 0,
completion_tokens: int = 0,
cost_usd: float = 0.0,
model: Optional[str] = None,
) -> None:
"""Emit LLM response event.
@@ -723,9 +1056,30 @@ class ContextTraceEmitter:
prompt_tokens: Number of tokens in the prompt/request
completion_tokens: Number of tokens in the completion/response
cost_usd: Estimated cost in USD for this LLM call
model: Model that served the call (stored as ``data.model``)
"""
if not self._enabled:
return
self._emit(self._llm_response_event(
agent_name, response_tokens, duration_ms, finish_reason,
response_content, prompt_tokens, completion_tokens, cost_usd, model,
))
mark = _llm_open_var.get()
if mark is not None and mark[0] == self._uid:
_llm_open_var.set(mark[2])
def _llm_response_event(
self,
agent_name: Optional[str],
response_tokens: int = 0,
duration_ms: float = 0.0,
finish_reason: Optional[str] = None,
response_content: Optional[str] = None,
prompt_tokens: int = 0,
completion_tokens: int = 0,
cost_usd: float = 0.0,
model: Optional[str] = None,
) -> ContextEvent:
# Use completion_tokens if provided, fallback to response_tokens for backward compat
actual_completion_tokens = completion_tokens if completion_tokens > 0 else response_tokens
@@ -748,8 +1102,10 @@ class ContextTraceEmitter:
data["response_content"] = f"{head}\n...[{len(response_content):,} chars, showing first/last portions]...\n{tail}"
else:
data["response_content"] = response_content
if model is not None:
data["model"] = model
self._emit(ContextEvent(
return ContextEvent(
event_type=ContextEventType.LLM_RESPONSE,
timestamp=time.time(),
session_id=self._session_id,
@@ -758,7 +1114,8 @@ class ContextTraceEmitter:
completion_tokens=actual_completion_tokens,
cost_usd=cost_usd,
data=data,
))
node_id=f"agent:{agent_name}" if agent_name else None,
)
def context_snapshot(
self,
@@ -790,8 +1147,16 @@ class ContextTraceEmitter:
to_agent: str,
reason: Optional[str] = None,
context_passed: Optional[Dict[str, Any]] = None,
kind: str = "handoff",
node_id: Optional[str] = None,
) -> None:
"""Emit agent handoff event for tracking agent-to-agent flow."""
"""Emit agent handoff event for tracking agent-to-agent flow.
Args:
kind: ``handoff`` (agent hands over), ``delegate`` (the hierarchical
manager assigns a task), ``route`` or ``spawn``.
node_id: Graph node concerned; defaults to the receiving agent.
"""
if not self._enabled:
return
self._emit(ContextEvent(
@@ -803,10 +1168,217 @@ class ContextTraceEmitter:
"from_agent": from_agent,
"to_agent": to_agent,
"reason": reason,
"context_passed": context_passed or {},
"context_passed": self._redact_dict(context_passed) or {},
"kind": kind,
},
node_id=node_id or (f"agent:{to_agent}" if to_agent else None),
))
# ------------------------------------------------------------------
# Run structure (schema 1.1). Each method is a no-op when disabled.
# ------------------------------------------------------------------
def workflow_start(
self,
kind: str,
name: Optional[str],
process: str,
graph: Optional[Dict[str, Any]] = None,
metadata: Optional[Dict[str, Any]] = None,
) -> None:
"""A team, flow or agent run begins. ``graph`` is its static graph."""
if not self._enabled:
return
data: Dict[str, Any] = {"kind": kind, "name": name, "process": process}
if graph is not None:
data["graph"] = graph
if metadata:
data.update(metadata)
self._emit(ContextEvent(
event_type=ContextEventType.WORKFLOW_START,
timestamp=time.time(),
session_id=self._session_id,
data=data,
))
def workflow_end(self, status: str = "completed", duration_ms: float = 0.0) -> None:
"""The innermost open team/flow run ends."""
if not self._enabled:
return
self._emit(ContextEvent(
event_type=ContextEventType.WORKFLOW_END,
timestamp=time.time(),
session_id=self._session_id,
data={"status": status, "duration_ms": duration_ms},
))
def task_start(
self,
name: Optional[str],
description: Optional[str] = None,
agent: Optional[str] = None,
node_id: Optional[str] = None,
) -> None:
"""A team task starts (node_id ``task:<name or index>``)."""
if not self._enabled:
return
self._emit(ContextEvent(
event_type=ContextEventType.TASK_START,
timestamp=time.time(),
session_id=self._session_id,
agent_name=agent,
data={
"name": name,
"description_preview": self._preview(description),
"agent": agent,
},
node_id=node_id,
))
def task_end(
self,
name: Optional[str],
status: str,
retries: int = 0,
duration_ms: float = 0.0,
output: Any = None,
agent: Optional[str] = None,
node_id: Optional[str] = None,
) -> None:
"""A team task ends: ``completed``, ``failed`` or ``skipped``."""
if not self._enabled:
return
self._emit(ContextEvent(
event_type=ContextEventType.TASK_END,
timestamp=time.time(),
session_id=self._session_id,
agent_name=agent,
data={
"name": name,
"status": status,
"retries": retries,
"duration_ms": duration_ms,
"output_preview": self._preview(output),
},
node_id=node_id,
))
def step_start(
self,
name: Optional[str],
pattern: Optional[str] = None,
node_id: Optional[str] = None,
agent: Optional[str] = None,
) -> None:
"""An AgentFlow step (or a Route/Parallel/Loop/... pattern) starts."""
if not self._enabled:
return
data: Dict[str, Any] = {"name": name}
if pattern:
data["pattern"] = pattern
self._emit(ContextEvent(
event_type=ContextEventType.STEP_START,
timestamp=time.time(),
session_id=self._session_id,
agent_name=agent,
data=data,
node_id=node_id,
))
def step_end(
self,
name: Optional[str],
status: str,
duration_ms: float = 0.0,
output: Any = None,
route: Optional[str] = None,
node_id: Optional[str] = None,
agent: Optional[str] = None,
variables: Optional[Dict[str, Any]] = None,
) -> None:
"""A flow step ends: ``completed``, ``failed``, ``skipped`` or ``cached``.
``variables`` are the workflow variables the step itself set (a handler's
``StepResult.variables``); recorded redacted so a re-run that reuses the
step can restore them.
"""
if not self._enabled:
return
data: Dict[str, Any] = {
"name": name,
"status": status,
"duration_ms": duration_ms,
"output_preview": self._preview(output),
}
if route is not None:
data["route"] = route
if variables:
data["variables"] = self._redact_dict(dict(variables))
self._emit(ContextEvent(
event_type=ContextEventType.STEP_END,
timestamp=time.time(),
session_id=self._session_id,
agent_name=agent,
data=data,
node_id=node_id,
))
def approval_requested(
self,
approval_id: str,
tool: str,
args: Optional[Dict[str, Any]] = None,
risk: Optional[str] = None,
kind: str = "tool_call",
agent_name: Optional[str] = None,
node_id: Optional[str] = None,
) -> None:
"""A person is asked to approve a tool call or a task's output."""
if not self._enabled:
return
self._emit(ContextEvent(
event_type=ContextEventType.APPROVAL_REQUESTED,
timestamp=time.time(),
session_id=self._session_id,
agent_name=agent_name,
data={
"approval_id": approval_id,
"tool": tool,
"args": self._redact_args(args),
"risk": risk,
"kind": kind,
},
node_id=node_id,
), span_key=approval_id)
def approval_decided(
self,
approval_id: str,
approved: bool,
reason: Optional[str] = None,
approver: Optional[str] = None,
modified: bool = False,
agent_name: Optional[str] = None,
node_id: Optional[str] = None,
) -> None:
"""The decision for ``approval_id`` (parent_seq = the request)."""
if not self._enabled:
return
self._emit(ContextEvent(
event_type=ContextEventType.APPROVAL_DECIDED,
timestamp=time.time(),
session_id=self._session_id,
agent_name=agent_name,
data={
"approval_id": approval_id,
"approved": bool(approved),
"reason": reason,
"approver": approver,
"modified": bool(modified),
},
node_id=node_id,
), span_key=approval_id)
def memory_store(
self,
agent_name: str,
@@ -0,0 +1,62 @@
import os
import stat
import tempfile
from praisonaiagents._logging import get_logger
from ..tools.path_safety import resolve_within_root
logger = get_logger(__name__)
def _open_nofollow(path, flags, mode=0o666):
return os.open(path, flags | getattr(os, "O_NOFOLLOW", 0), mode)
def write_output_file(path: str, content: str, create_dirs: bool = True) -> str | None:
"""Write *content* to *path* if it resolves inside the project root.
The root is ``PRAISONAI_PROJECT_ROOT`` or the cwd, matching ``Agent.output_file``.
Returns the resolved path, or ``None`` when the path escapes the root.
"""
project_root = os.environ.get("PRAISONAI_PROJECT_ROOT") or os.getcwd()
file_path = resolve_within_root(path, project_root)
if file_path is None:
logger.warning(
"Output file %r is outside project root %r; skipping save",
path,
project_root,
)
return None
if create_dirs:
os.makedirs(os.path.dirname(file_path), exist_ok=True)
with open(file_path, "a", encoding="utf-8", opener=_open_nofollow) as f:
st = os.fstat(f.fileno())
if st.st_nlink == 1:
f.truncate(0)
f.write(content)
return file_path
# A hardlink may share its inode with a file outside the root, so swap in
# a new file under the same name instead of truncating the shared one.
fd, tmp = tempfile.mkstemp(
dir=os.path.dirname(file_path),
prefix=os.path.basename(file_path) + ".",
suffix=".tmp",
)
try:
mode = stat.S_IMODE(st.st_mode)
if hasattr(os, "fchown"):
try:
os.fchown(fd, -1, st.st_gid)
except OSError:
# Can't keep the original group; don't grant its bits to ours.
mode &= ~0o070
if hasattr(os, "fchmod"):
os.fchmod(fd, mode)
with os.fdopen(fd, "w", encoding="utf-8") as f:
f.write(content)
os.replace(tmp, file_path)
except BaseException:
os.unlink(tmp)
raise
return file_path
@@ -1,13 +1,25 @@
"""Render a workflow's DEFINITION as a mermaid diagram.
"""Render a run's DEFINITION as graph data and as a mermaid diagram.
PraisonAI could already diagram a captured execution trace
(``telemetry/performance_utils.py``), but that only exists once a flow has run
-- so a flow could only be pictured after it had already cost money. This
renders the structure from the step list, before anything executes, which is
renders the structure from the definition, before anything executes, which is
what CrewAI's ``flow.plot()`` gives its users.
One builder walks the definition and produces graph data
(``schema: "praisonai.graph/1"``) for an ``Agent``, an ``AgentTeam`` or an
``AgentFlow``. Node ids are derived from names and positions only (never a
uuid), so they are identical across processes and runs and the same ids appear
as ``node_id`` on replay trace events:
- ``agent:<name>``, ``task:<name or index>``, ``step:<name>``
(duplicates become ``#2``, ``#3`` in definition order),
``tool:<agent>/<tool>``, ``human:you``, ``manager:Manager``
- ``start:begin`` ("Brief") and ``end:done`` ("Delivered")
Mermaid rather than graphviz on purpose: it needs no new dependency, and both
GitHub and the docs render it inline.
GitHub and the docs render it inline. Stdlib only; nothing here is imported
when ``praisonaiagents`` is.
>>> print(flow.to_mermaid())
graph TD
@@ -16,9 +28,25 @@ GitHub and the docs render it inline.
...
"""
from typing import Any, List, Optional, Tuple
from typing import Any, Dict, List, Optional, Tuple
__all__ = ["to_mermaid", "flow_to_mermaid"]
__all__ = [
"to_mermaid",
"flow_to_mermaid",
"to_graph",
"graph_to_mermaid",
"GRAPH_SCHEMA",
]
GRAPH_SCHEMA = "praisonai.graph/1"
START_ID = "start:begin"
END_ID = "end:done"
HUMAN_ID = "human:you"
MANAGER_ID = "manager:Manager"
_FLOW_CLASSES = {"AgentFlow"}
_TEAM_CLASSES = {"AgentTeam"}
def _label(step: Any) -> str:
@@ -41,23 +69,179 @@ def _escape(text: str) -> str:
return str(text).replace('"', "'").replace("\n", " ")
class _Builder:
def __init__(self) -> None:
self.lines: List[str] = ["graph TD"]
self._n = 0
def _class_names(obj: Any) -> set:
return {klass.__name__ for klass in type(obj).__mro__}
def node(self, shape: str) -> str:
node_id = f"n{self._n}"
self._n += 1
self.lines.append(f" {node_id}{shape}")
def _tool_name(tool: Any) -> str:
if isinstance(tool, str):
return tool
if isinstance(tool, dict):
function = tool.get("function") if isinstance(tool.get("function"), dict) else {}
return str(function.get("name") or tool.get("name") or "tool")
for attr in ("name", "__name__"):
value = getattr(tool, attr, None)
if isinstance(value, str) and value:
return value
return type(tool).__name__
def _is_agent(obj: Any) -> bool:
return hasattr(obj, "chat") and isinstance(getattr(obj, "name", None), str)
# ---------------------------------------------------------------------------
# Graph builder
# ---------------------------------------------------------------------------
class _Graph:
"""Accumulates nodes/edges, and the mermaid draw order for flows.
``ops`` records exactly the nodes and edges the legacy flow diagram drew,
in the order it drew them, so ``flow_to_mermaid`` stays byte-identical
while the graph data can carry more (agents, tools, pattern groups).
"""
def __init__(self, kind: str, name: Optional[str], process: str) -> None:
self.kind = kind
self.name = name
self.process = process
self.nodes: Dict[str, Dict[str, Any]] = {}
self.edges: Dict[str, Dict[str, Any]] = {}
self.ops: List[tuple] = []
# id(definition object) -> node id, first occurrence wins. Used at run
# time to stamp node_id on step events.
self.ids: Dict[int, str] = {}
self._seen: Dict[str, int] = {}
# edge id -> distinct route labels, joined only for display.
self._labels: Dict[str, List[str]] = {}
def unique(self, base: str) -> str:
"""``base`` the first time, then ``base#2``, ``base#3`` ..."""
count = self._seen.get(base, 0) + 1
self._seen[base] = count
return base if count == 1 else f"{base}#{count}"
def node(
self,
node_id: str,
kind: str,
label: str,
parent: Optional[str] = None,
meta: Optional[Dict[str, Any]] = None,
shape: Optional[str] = None,
) -> str:
if node_id not in self.nodes:
self.nodes[node_id] = {
"id": node_id,
"kind": kind,
"label": label,
"parent": parent,
"meta": dict(meta or {}),
}
if shape is not None:
self.ops.append(("node", node_id, shape))
return node_id
def edge(self, src: str, dst: str, label: Optional[str] = None) -> None:
arrow = f' -->|"{_escape(label)}"| ' if label else " --> "
self.lines.append(f" {src}{arrow}{dst}")
def edge(
self,
source: str,
target: str,
kind: str,
label: Optional[str] = None,
draw: bool = False,
) -> None:
edge_id = f"{source}->{target}:{kind}"
if edge_id not in self.edges:
self.edges[edge_id] = {
"id": edge_id,
"source": source,
"target": target,
"kind": kind,
"label": label,
}
self._labels[edge_id] = [label] if label else []
elif label:
# Two conditions to the same target share one edge; keep both labels.
labels = self._labels[edge_id]
if label not in labels:
labels.append(label)
self.edges[edge_id]["label"] = " / ".join(labels)
if draw:
self.ops.append(("edge", source, target, label))
def has_edge(self, source: str, target: str, kind: str) -> bool:
return f"{source}->{target}:{kind}" in self.edges
def register(self, obj: Any, node_id: str) -> None:
self.ids.setdefault(id(obj), node_id)
def to_dict(self) -> Dict[str, Any]:
return {
"schema": GRAPH_SCHEMA,
"kind": self.kind,
"name": self.name,
"process": self.process,
"nodes": list(self.nodes.values()),
"edges": list(self.edges.values()),
}
def ops_to_mermaid(self) -> str:
lines = ["graph TD"]
short: Dict[str, str] = {}
for op in self.ops:
if op[0] == "node":
ref = f"n{len(short)}"
short[op[1]] = ref
lines.append(f" {ref}{op[2]}")
else:
_, source, target, label = op
arrow = f' -->|"{_escape(label)}"| ' if label else " --> "
lines.append(f" {short[source]}{arrow}{short[target]}")
return "\n".join(lines)
def _branch(steps: Any, b: "_Builder") -> Optional[Tuple[str, str]]:
def _add_agent(g: _Graph, agent: Any, parent: Optional[str] = None, _seen: Optional[set] = None) -> str:
"""Add an agent node with its tools and hand-off targets; return its id."""
name = getattr(agent, "name", None) or type(agent).__name__
agent_id = f"agent:{name}"
seen = _seen if _seen is not None else set()
if agent_id in seen:
return agent_id
seen.add(agent_id)
g.node(agent_id, "agent", name, parent=parent, meta={"role": getattr(agent, "role", None)})
targets = []
handoff_tools = set()
for handoff in list(getattr(agent, "handoffs", None) or []):
target = handoff if _is_agent(handoff) else getattr(handoff, "agent", None)
if target is None or not getattr(target, "name", None):
continue
targets.append(target)
tool_name = getattr(handoff, "tool_name", None) if not _is_agent(handoff) else None
if tool_name is None:
from ..agent.handoff import Handoff
tool_name = Handoff(agent=target).tool_name
handoff_tools.add(tool_name)
for tool in list(getattr(agent, "tools", None) or []):
tool_name = _tool_name(tool)
if tool_name in handoff_tools:
continue # drawn as the hand-off edge, not as a tool
tool_id = f"tool:{name}/{tool_name}"
g.node(tool_id, "tool", tool_name, parent=parent)
g.edge(agent_id, tool_id, "uses")
for target in targets:
target_id = _add_agent(g, target, parent=parent, _seen=seen)
g.edge(agent_id, target_id, "handoff")
return agent_id
# ---------------------------------------------------------------------------
# AgentFlow
# ---------------------------------------------------------------------------
def _flow_branch(steps: Any, g: _Graph, parent: Optional[str]) -> Optional[Tuple[str, str]]:
"""Render a sub-sequence of steps in isolation.
Returns the ``(entry, exit)`` pair for the whole sub-sequence, or ``None``
@@ -68,7 +252,7 @@ def _branch(steps: Any, b: "_Builder") -> Optional[Tuple[str, str]]:
entry: Optional[str] = None
tail: Optional[str] = None
for inner in steps or []:
rendered = _render(inner, b, tail)
rendered = _flow_step(inner, g, tail, parent)
if rendered is None:
continue
inner_entry, inner_exit = rendered
@@ -80,7 +264,15 @@ def _branch(steps: Any, b: "_Builder") -> Optional[Tuple[str, str]]:
return entry, tail
def _render(step: Any, b: _Builder, prev: Optional[str]) -> Optional[Tuple[str, str]]:
def _pattern_group(g: _Graph, step: Any, pattern: str, parent: Optional[str], label: str, meta: Dict[str, Any]) -> Tuple[str, str]:
"""The ``step:<name>`` node that groups a pattern's parts; returns (id, suffix)."""
group = g.unique(f"step:{label}")
g.node(group, "step", label, parent=parent, meta={"pattern": pattern, **meta})
g.register(step, group)
return group, group[len("step:"):]
def _flow_step(step: Any, g: _Graph, prev: Optional[str], parent: Optional[str]) -> Optional[Tuple[str, str]]:
"""Render one step, returning its ``(entry, exit)`` nodes.
``entry`` is what an incoming edge should point at; ``exit`` is what the
@@ -89,82 +281,96 @@ def _render(step: Any, b: _Builder, prev: Optional[str]) -> Optional[Tuple[str,
its join).
"""
cls = type(step).__name__
name = _escape(_label(step))
if cls == "If":
decision = b.node(f'{{"{_escape(getattr(step, "condition", "") or "if")}"}}')
condition = getattr(step, "condition", "") or "if"
group, suffix = _pattern_group(g, step, "if", parent, "if", {"condition": str(condition)})
decision = g.node(f"decision:{suffix}", "decision", str(condition), parent=group,
shape=f'{{"{_escape(condition)}"}}')
if prev:
b.edge(prev, decision)
g.edge(prev, decision, "next", draw=True)
ends = []
for branch, edge_label in (("then_steps", "true"), ("else_steps", "false")):
rendered = _branch(getattr(step, branch, None), b)
rendered = _flow_branch(getattr(step, branch, None), g, group)
if rendered:
branch_entry, branch_exit = rendered
b.edge(decision, branch_entry, edge_label)
g.edge(decision, branch_entry, "routes", edge_label, draw=True)
ends.append(branch_exit)
join = b.node('(("join"))')
join = g.node(f"join:{suffix}", "join", "join", parent=group, shape='(("join"))')
for end in ends or [decision]:
b.edge(end, join)
g.edge(end, join, "next", draw=True)
return decision, join
if cls == "Route":
router = b.node(f'{{"route"}}')
group, suffix = _pattern_group(g, step, "route", parent, "route", {})
router = g.node(f"decision:{suffix}", "decision", "route", parent=group, shape='{"route"}')
if prev:
b.edge(prev, router)
g.edge(prev, router, "next", draw=True)
ends = []
routes = getattr(step, "routes", None) or {}
for key, steps in routes.items():
rendered = _branch(steps, b)
rendered = _flow_branch(steps, g, group)
if rendered:
branch_entry, branch_exit = rendered
b.edge(router, branch_entry, key)
g.edge(router, branch_entry, "routes", key, draw=True)
ends.append(branch_exit)
# ``Route.__init__`` mirrors ``routes["default"]`` into ``.default``;
# only render ``.default`` when it was not already drawn as a key above.
if "default" not in routes:
rendered = _branch(getattr(step, "default", None), b)
rendered = _flow_branch(getattr(step, "default", None), g, group)
if rendered:
branch_entry, branch_exit = rendered
b.edge(router, branch_entry, "default")
g.edge(router, branch_entry, "routes", "default", draw=True)
ends.append(branch_exit)
join = b.node('(("join"))')
join = g.node(f"join:{suffix}", "join", "join", parent=group, shape='(("join"))')
for end in ends or [router]:
b.edge(end, join)
g.edge(end, join, "next", draw=True)
return router, join
if cls == "Parallel":
fork = b.node('(("fork"))')
group, suffix = _pattern_group(g, step, "parallel", parent, "parallel", {})
fork = g.node(f"fork:{suffix}", "fork", "fork", parent=group, shape='(("fork"))')
if prev:
b.edge(prev, fork)
g.edge(prev, fork, "next", draw=True)
ends = []
for inner in getattr(step, "steps", None) or []:
rendered = _render(inner, b, None)
rendered = _flow_step(inner, g, None, group)
if rendered:
branch_entry, branch_exit = rendered
b.edge(fork, branch_entry)
g.edge(fork, branch_entry, "parallel", draw=True)
ends.append(branch_exit)
join = b.node('(("join"))')
join = g.node(f"join:{suffix}", "join", "join", parent=group, shape='(("join"))')
for end in ends or [fork]:
b.edge(end, join)
g.edge(end, join, "next", draw=True)
return fork, join
if cls in ("Loop", "Repeat"):
pattern = cls.lower()
inner = getattr(step, "step", None)
# ``Repeat(step=[a, b])`` runs each member, as ``_execute_repeat`` does.
inner_steps = getattr(step, "steps", None) or (
[getattr(step, "step")] if getattr(step, "step", None) is not None else []
list(inner) if isinstance(inner, (list, tuple))
else [inner] if inner is not None else []
)
over = getattr(step, "over", None)
iterations = getattr(step, "max_iterations", None)
meta = {}
if over:
meta["over"] = str(over)
if iterations:
meta["max_iterations"] = iterations
group, _ = _pattern_group(g, step, pattern, parent, pattern, meta)
tail = prev
first = None
for inner in inner_steps:
rendered = _render(inner, b, tail)
rendered = _flow_step(inner, g, tail, group)
if rendered:
inner_entry, inner_exit = rendered
first = first or inner_entry
tail = inner_exit
if first and tail:
over = getattr(step, "over", None)
iterations = getattr(step, "max_iterations", None)
back = f"over {over}" if over else (f"up to {iterations}x" if iterations else "repeat")
b.edge(tail, first, back)
g.edge(tail, first, "loop", back, draw=True)
if first is None or tail is None:
return None
return first, tail
@@ -174,33 +380,300 @@ def _render(step: Any, b: _Builder, prev: Optional[str]) -> Optional[Tuple[str,
# them inline rather than as an opaque node. A recipe include (by name)
# is only resolvable at runtime, so it stays a single node.
workflow = getattr(step, "workflow", None)
recipe = getattr(step, "recipe", None)
meta = {"recipe": recipe} if recipe else {}
if workflow is not None and getattr(workflow, "name", None):
meta["workflow"] = workflow.name
group, _ = _pattern_group(g, step, "include", parent, "include", meta)
if workflow is not None:
rendered = _branch(getattr(workflow, "steps", None), b)
rendered = _flow_branch(getattr(workflow, "steps", None), g, group)
if rendered:
branch_entry, branch_exit = rendered
if prev:
b.edge(prev, branch_entry)
g.edge(prev, branch_entry, "next", draw=True)
return branch_entry, branch_exit
# Unexpanded: the group node itself is the drawn step.
g.ops.append(("node", group, f'["{_escape(_label(step))}"]'))
if prev:
g.edge(prev, group, "next", draw=True)
return group, group
node = b.node(f'["{name}"]')
label = _label(step)
node_id = g.unique(f"step:{label}")
meta: Dict[str, Any] = {}
if cls == "Discussion":
meta["pattern"] = "discussion"
g.node(node_id, "step", label, parent=parent, meta=meta, shape=f'["{_escape(label)}"]')
g.register(step, node_id)
if prev:
b.edge(prev, node)
return node, node
g.edge(prev, node_id, "next", draw=True)
# Graph-only detail: who does the step, and with which tools.
if cls == "Discussion":
for speaker in getattr(step, "agents", None) or []:
if _is_agent(speaker):
g.edge(node_id, _add_agent(g, speaker), "assigned")
g.register(speaker, node_id)
elif _is_agent(step):
g.edge(node_id, _add_agent(g, step), "assigned")
elif _is_agent(getattr(step, "agent", None)):
g.edge(node_id, _add_agent(g, step.agent), "assigned")
return node_id, node_id
def _build_flow(steps: Any, name: Optional[str], kind: str = "flow", process: str = "flow") -> _Graph:
g = _Graph(kind, name, process)
start = g.node(START_ID, "start", "Brief",
shape='([" start "])' if not name else f'(["{_escape(name)}"])')
prev: Optional[str] = start
for step in (steps or []):
rendered = _flow_step(step, g, prev, None)
if rendered:
prev = rendered[1]
end = g.node(END_ID, "end", "Delivered", shape='([" end "])')
if prev:
g.edge(prev, end, "next", draw=True)
return g
def _flow_process(flow: Any) -> str:
return "hierarchical" if getattr(flow, "process", None) == "hierarchical" else "flow"
def _flow_graph(flow: Any) -> _Graph:
return _build_flow(getattr(flow, "steps", None), getattr(flow, "name", None),
process=_flow_process(flow))
# ---------------------------------------------------------------------------
# AgentTeam
# ---------------------------------------------------------------------------
def _is_synthetic_manager(task: Any) -> bool:
"""The hierarchical process injects a ``manager_task`` run by "Manager"."""
agent = getattr(task, "agent", None)
return getattr(task, "name", None) == "manager_task" and getattr(agent, "name", None) == "Manager"
def _team_tasks(team: Any) -> List[Any]:
tasks = getattr(team, "tasks", None) or []
if isinstance(tasks, dict):
return list(tasks.values())
return list(tasks)
def task_node_ids(tasks: List[Any]) -> List[str]:
"""Stable node ids for a team's tasks, aligned with ``tasks``.
``task:<name>`` (or ``task:<index>`` for an unnamed task), duplicates
suffixed ``#2``... The hierarchical synthetic manager task maps to
``manager:Manager``.
"""
seen: Dict[str, int] = {}
ids = []
for index, task in enumerate(tasks):
if _is_synthetic_manager(task):
ids.append(MANAGER_ID)
continue
name = getattr(task, "name", None)
base = f"task:{name}" if name else f"task:{index}"
count = seen.get(base, 0) + 1
seen[base] = count
ids.append(base if count == 1 else f"{base}#{count}")
return ids
def task_node_id(tasks: Any, task: Any) -> Optional[str]:
"""Node id of ``task`` within a team's ``tasks`` (dict or list)."""
if isinstance(tasks, dict):
tasks = list(tasks.values())
tasks = list(tasks or [])
for task_obj, node_id in zip(tasks, task_node_ids(tasks)):
if task_obj is task:
return node_id
name = getattr(task, "name", None)
return f"task:{name}" if name else None
def _team_graph(team: Any) -> _Graph:
process = getattr(team, "process", None) or "sequential"
hierarchical = process == "hierarchical"
g = _Graph("team", getattr(team, "name", None), process)
all_tasks = _team_tasks(team)
ids = task_node_ids(all_tasks)
pairs = [(t, i) for t, i in zip(all_tasks, ids) if not _is_synthetic_manager(t)]
by_name = {}
for task, node_id in pairs:
if getattr(task, "name", None):
by_name.setdefault(task.name, node_id)
g.node(START_ID, "start", "Brief")
if hierarchical:
g.node(MANAGER_ID, "manager", "Manager")
for agent in getattr(team, "agents", None) or []:
if getattr(agent, "name", None):
_add_agent(g, agent)
if any(getattr(t, "human_input", False) for t, _ in pairs):
g.node(HUMAN_ID, "human", "You")
for index, (task, node_id) in enumerate(pairs):
label = getattr(task, "name", None) or (
(getattr(task, "description", None) or "")[:60] or f"Task {index + 1}"
)
agent = getattr(task, "agent", None)
meta: Dict[str, Any] = {}
if getattr(task, "task_type", None) not in (None, "task"):
meta["task_type"] = task.task_type
if getattr(task, "human_input", False):
meta["human_input"] = True
g.node(node_id, "task", str(label), meta=meta)
g.register(task, node_id)
if agent is not None and getattr(agent, "name", None):
g.edge(node_id, _add_agent(g, agent), "assigned")
if getattr(task, "human_input", False):
g.edge(HUMAN_ID, node_id, "reviews")
if hierarchical:
g.edge(START_ID, MANAGER_ID, "next")
for agent in getattr(team, "agents", None) or []:
if getattr(agent, "name", None):
g.edge(MANAGER_ID, f"agent:{agent.name}", "delegates")
g.edge(MANAGER_ID, END_ID, "next")
elif process == "workflow" and pairs:
starts = [n for t, n in pairs if getattr(t, "is_start", False)] or [pairs[0][1]]
for node_id in starts:
g.edge(START_ID, node_id, "next")
for task, node_id in pairs:
condition = getattr(task, "condition", None) or {}
followers = [x for x in (getattr(task, "next_tasks", None) or []) if x in by_name]
routed = False
# Unified when/then_task/else_task routing, which execution
# checks before condition/next_tasks.
for attr, branch in (("then_task", str(getattr(task, "when", None) or "then")),
("else_task", "else")):
target = getattr(task, attr, None)
if isinstance(target, str) and target in by_name:
g.edge(node_id, by_name[target], "routes", branch)
routed = True
if isinstance(condition, dict):
for key, targets in condition.items():
for target in (targets if isinstance(targets, (list, tuple)) else [targets]):
if target in by_name:
g.edge(node_id, by_name[target], "routes", str(key))
routed = True
elif target in ("exit", "end", "done"):
g.edge(node_id, END_ID, "routes", str(key))
routed = True
for target in followers:
g.edge(node_id, by_name[target], "next")
if not followers and not routed:
g.edge(node_id, END_ID, "next")
else:
prev = START_ID
for _, node_id in pairs:
g.edge(prev, node_id, "next")
prev = node_id
g.edge(prev, END_ID, "next")
# Explicit data dependencies (context=/depends_on=), unless the same pair
# is already joined by a control edge (sequential teams add both).
task_ids = {id(t): n for t, n in pairs}
for task, node_id in pairs:
for dep in getattr(task, "context", None) or []:
dep_id = task_ids.get(id(dep))
if dep_id and dep_id != node_id and not g.has_edge(dep_id, node_id, "next"):
g.edge(dep_id, node_id, "depends_on")
g.node(END_ID, "end", "Delivered")
return g
def _agent_graph(agent: Any) -> _Graph:
g = _Graph("agent", getattr(agent, "name", None), "sequential")
g.node(START_ID, "start", "Brief")
agent_id = _add_agent(g, agent)
g.register(agent, agent_id)
g.edge(START_ID, agent_id, "next")
g.node(END_ID, "end", "Delivered")
g.edge(agent_id, END_ID, "next")
return g
def _graph_for(obj: Any) -> _Graph:
names = _class_names(obj)
if names & _FLOW_CLASSES:
return _flow_graph(obj)
if names & _TEAM_CLASSES:
return _team_graph(obj)
if isinstance(obj, (list, tuple)):
return _build_flow(obj, None)
if _is_agent(obj):
return _agent_graph(obj)
if hasattr(obj, "steps"):
return _flow_graph(obj)
if hasattr(obj, "tasks") and hasattr(obj, "agents"):
return _team_graph(obj)
raise TypeError(f"to_graph() expects an Agent, AgentTeam or AgentFlow, got {type(obj).__name__}")
def to_graph(obj: Any) -> Dict[str, Any]:
"""Graph data (``praisonai.graph/1``) for an Agent, AgentTeam or AgentFlow."""
return _graph_for(obj).to_dict()
# ---------------------------------------------------------------------------
# Mermaid
# ---------------------------------------------------------------------------
_SHAPES = {
"start": '(["{}"])',
"end": '(["{}"])',
"decision": '{{"{}"}}',
"fork": '(("{}"))',
"join": '(("{}"))',
"manager": '{{{{"{}"}}}}',
"human": '>"{}"]',
"tool": '[["{}"]]',
}
def graph_to_mermaid(graph: Dict[str, Any]) -> str:
"""Render ``praisonai.graph/1`` data as a mermaid ``graph TD``.
Group nodes (a node other nodes name as ``parent``) are containers, not
boxes, so they and their edges are left out of the picture.
"""
nodes = list(graph.get("nodes") or [])
parents = {n.get("parent") for n in nodes if n.get("parent")}
short: Dict[str, str] = {}
lines = ["graph TD"]
for node in nodes:
if node["id"] in parents:
continue
ref = f"n{len(short)}"
short[node["id"]] = ref
shape = _SHAPES.get(node.get("kind"), '["{}"]')
lines.append(f" {ref}{shape.format(_escape(node.get('label') or node['id']))}")
for edge in graph.get("edges") or []:
source, target = short.get(edge["source"]), short.get(edge["target"])
if source is None or target is None:
continue
kind = edge.get("kind")
label = edge.get("label")
if kind in ("next", "parallel"):
arrow = f' -->|"{_escape(label)}"| ' if label else " --> "
elif kind in ("routes", "loop", "handoff", "delegates"):
arrow = f' -->|"{_escape(label or kind)}"| '
else:
arrow = f' -.->|"{_escape(label or kind)}"| '
lines.append(f" {source}{arrow}{target}")
return "\n".join(lines)
def to_mermaid(steps: Any, name: Optional[str] = None) -> str:
"""Render a list of workflow steps as a mermaid ``graph TD``."""
b = _Builder()
start = b.node('([" start "])' if not name else f'(["{_escape(name)}"])')
prev: Optional[str] = start
for step in (steps or []):
rendered = _render(step, b, prev)
if rendered:
prev = rendered[1]
end = b.node('([" end "])')
if prev:
b.edge(prev, end)
return "\n".join(b.lines)
return _build_flow(steps, name).ops_to_mermaid()
def flow_to_mermaid(flow: Any) -> str:
@@ -725,6 +725,115 @@ def include(recipe: Optional[str] = None, workflow: Optional[Any] = None, input:
# Maximum nesting depth for patterns (prevents stack overflow)
MAX_NESTING_DEPTH = 5
# ---------------------------------------------------------------------------
# Replay step events (step_start / step_end). Every helper is a no-op returning
# None when the context emitter is disabled, so an untraced run pays one
# attribute check per step.
# ---------------------------------------------------------------------------
# The innermost pattern span (Route/If) so it can record the branch it chose.
_replay_step_span: "contextvars.ContextVar[Optional[dict]]" = contextvars.ContextVar(
"praisonai_replay_step_span", default=None
)
def _replay_step_begin(flow, step, name=None, pattern=None):
"""Emit ``step_start`` for a definition object; returns a span or None."""
from ..trace.context_events import get_context_emitter
emitter = get_context_emitter()
if not emitter._enabled:
return None
node_id = (getattr(flow, "_replay_node_ids", None) or {}).get(id(step))
if name is None:
if node_id is not None:
name = node_id[len("step:"):] if node_id.startswith("step:") else node_id
else:
from .diagram import _label
name = pattern or _label(step)
if node_id is None:
node_id = f"step:{name}"
agent = getattr(step, "agent", None) if not hasattr(step, "chat") else step
agent = getattr(agent, "name", None) if agent is not None else None
emitter.step_start(name, pattern=pattern, node_id=node_id, agent=agent)
return {"emitter": emitter, "name": name, "node_id": node_id, "agent": agent,
"started": time.perf_counter()}
def _differs(a: Any, b: Any) -> bool:
"""``a != b`` that treats a failing or ambiguous comparison as "changed"."""
try:
return bool(a != b)
except Exception:
return True
def _snapshot_scope(span, variables):
"""Before a recorded leaf step really runs (not skipped or cached), keep a
per-value deep copy of the scope on its span, so a list or dict the step
changes in place still counts as set by it; only an uncopyable value is
shared by reference."""
if span is not None:
span["before"] = _isolate_scope(variables)
def _replay_step_end(span, status, output=None, variables=None):
"""Emit ``step_end`` for a span from :func:`_replay_step_begin`."""
if span is None:
return
span["emitter"].step_end(
span["name"],
status,
duration_ms=(time.perf_counter() - span["started"]) * 1000,
output=output,
route=span.get("route"),
node_id=span["node_id"],
agent=span["agent"],
variables=variables,
)
def _replay_note_route(label):
"""Record which branch the enclosing Route/If chose (tracing on only)."""
span = _replay_step_span.get()
if span is not None:
span["route"] = label
def _replay_pattern(pattern):
"""Wrap a pattern executor (``_execute_route`` ...) in step_start/step_end.
Top-level and nested patterns both reach the executor, so wrapping it here
covers every nesting level once.
"""
def decorate(execute):
def wrapper(self, step, *args, **kwargs):
name = getattr(step, "name", None) if pattern == "discussion" else None
span = _replay_step_begin(self, step, name, pattern)
if span is None:
return execute(self, step, *args, **kwargs)
token = _replay_step_span.set(span)
try:
result = execute(self, step, *args, **kwargs)
except BaseException:
_replay_step_end(span, "failed")
raise
finally:
_replay_step_span.reset(token)
is_dict = isinstance(result, dict)
_replay_step_end(
span,
"failed" if is_dict and result.get("stop") else "completed",
result.get("output") if is_dict else None,
)
return result
wrapper.__name__ = execute.__name__
wrapper.__qualname__ = execute.__qualname__
wrapper.__doc__ = execute.__doc__
wrapper.__wrapped__ = execute
return wrapper
return decorate
@dataclass
class If:
"""
@@ -1464,19 +1573,26 @@ class AgentFlow:
"separate Workflow instance per concurrent run."
)
try:
if self.tools_run_on is None:
return self._run_impl(input, llm, verbose, stream)
# One sandbox for the whole run; torn down even if a step raises.
with self._shared_compute() as shared:
shared.attach(self._collect_agents())
# Expose the live sandbox so agents created *during* the run
# (e.g. an action-only step's temporary agent) can be attached
# too, instead of silently executing tools locally.
self._active_shared_compute = shared
try:
return self._run_impl(input, llm, verbose, stream)
finally:
self._active_shared_compute = None
from ..trace.context_events import _workflow_scope
_process = "hierarchical" if self.process == "hierarchical" else "flow"
with _workflow_scope("flow", self.name, _process, graph_fn=self._replay_graph) as _run:
if self.tools_run_on is None:
result = self._run_impl(input, llm, verbose, stream)
else:
# One sandbox for the whole run; torn down even if a step raises.
with self._shared_compute() as shared:
shared.attach(self._collect_agents())
# Expose the live sandbox so agents created *during* the run
# (e.g. an action-only step's temporary agent) can be attached
# too, instead of silently executing tools locally.
self._active_shared_compute = shared
try:
result = self._run_impl(input, llm, verbose, stream)
finally:
self._active_shared_compute = None
if _run is not None and isinstance(result, dict) and result.get("status") == "failed":
_run["status"] = "failed"
return result
finally:
# Restore the generation the caller's context carried before this
# run stamped its own, so a nested Workflow.run() (Include) does not
@@ -1498,6 +1614,15 @@ class AgentFlow:
from .diagram import flow_to_mermaid
return flow_to_mermaid(self)
def to_graph(self) -> Dict[str, Any]:
"""This flow's definition as graph data (``praisonai.graph/1``).
Node ids are stable across processes (derived from step names and
positions), and are the ``node_id`` values replay trace events carry.
"""
from .diagram import to_graph
return to_graph(self)
@property
def state(self):
"""The flow's variables as the declared ``state_model``.
@@ -1601,6 +1726,35 @@ class AgentFlow:
visit(self.steps)
return found
def _notify_step_start(self, raw_step: Any, step: Any, context: Any) -> Optional[dict]:
"""Emit replay ``step_start`` then call ``on_step_start``; returns the span."""
span = _replay_step_begin(self, raw_step, step.name)
if self.on_step_start:
try:
self.on_step_start(step.name, context)
except Exception as e:
logger.error(f"on_step_start callback failed: {e}")
return span
def _notify_step_complete(
self, span: Optional[dict], step_name: str, step_result: Any, status: str, output: Any = None,
variables: Optional[Dict[str, Any]] = None,
) -> None:
"""Call ``on_step_complete`` then emit replay ``step_end``."""
if self.on_step_complete:
try:
self.on_step_complete(step_name, step_result)
except Exception as e:
logger.error(f"on_step_complete callback failed: {e}")
_replay_step_end(span, status, output, variables)
def _replay_graph(self) -> Dict[str, Any]:
"""Graph for ``workflow_start``; also maps step objects to node ids."""
from .diagram import _flow_graph
graph = _flow_graph(self)
self._replay_node_ids = graph.ids
return graph.to_dict()
def _run_impl(
self,
input: str = "",
@@ -1821,6 +1975,7 @@ class AgentFlow:
continue
# Normalize single step
raw_step = step
step = self._normalize_single_step(step, i)
# Create context for handlers
@@ -1839,11 +1994,7 @@ class AgentFlow:
# Preserve the preparation hook before the gate: it may populate
# context variables used by should_run, including on cached runs.
if self.on_step_start:
try:
self.on_step_start(step.name, context)
except Exception as e:
logger.error(f"on_step_start callback failed: {e}")
_replay = self._notify_step_start(raw_step, step, context)
# Check should_run condition
if step.should_run:
@@ -1854,11 +2005,9 @@ class AgentFlow:
if hasattr(step, 'status'):
step.status = "skipped"
self.step_statuses[step.name] = "skipped"
if self.on_step_complete:
try:
self.on_step_complete(step.name, StepResult(output="", skipped=True))
except Exception as e:
logger.error(f"on_step_complete callback failed: {e}")
self._notify_step_complete(
_replay, step.name, StepResult(output="", skipped=True), "skipped",
)
i += 1
continue
except Exception as e:
@@ -1904,16 +2053,16 @@ class AgentFlow:
step.status = cached_record["status"]
if _cached.get("variables"):
all_variables.update(_cached["variables"])
if self.on_step_complete:
try:
self.on_step_complete(
step.name, StepResult(
output=previous_output or "",
stop_workflow=bool(_cached.get("stop")),
),
)
except Exception as e:
logger.error(f"on_step_complete callback failed: {e}")
# The cache also holds the step's output variable (its full
# output): trace only what the handler set, like a cold run.
_out_var = step.output_variable or f"{step.name}_output"
self._notify_step_complete(
_replay, step.name, StepResult(
output=previous_output or "",
stop_workflow=bool(_cached.get("stop")),
), "cached", previous_output,
variables={k: v for k, v in (_cached.get("variables") or {}).items() if k != _out_var},
)
if _cached.get("stop"):
if verbose:
print(f"🛑 Workflow stopped at: {step.name}")
@@ -1933,6 +2082,8 @@ class AgentFlow:
validation_feedback = None
guardrail_failed = False
cached_variable_updates = {} if _cache_key is not None else None
# Variables this step set (StepResult.variables), for replay's step_end.
step_variable_updates: Dict[str, Any] = {}
while retry_count <= max_retries:
step_error = None
@@ -1955,6 +2106,7 @@ class AgentFlow:
# accepted attempt that wrote {a} leaves both
# keys in the live run, so both must be cached.
all_variables.update(result.variables)
step_variable_updates.update(result.variables)
if cached_variable_updates is not None:
cached_variable_updates.update(result.variables)
else:
@@ -2196,14 +2348,10 @@ class AgentFlow:
})
# Still notify the step-complete callback so lifecycle observers
# see the (failed) terminal step before the workflow aborts.
if self.on_step_complete:
try:
self.on_step_complete(
step.name,
StepResult(output=output or "", stop_workflow=True),
)
except Exception as e:
logger.error(f"on_step_complete callback failed: {e}")
self._notify_step_complete(
_replay, step.name,
StepResult(output=output or "", stop_workflow=True), "failed", output,
)
if verbose:
print(f"🛑 Workflow stopped: step '{step.name}' failed (on_error='stop')")
break
@@ -2212,25 +2360,21 @@ class AgentFlow:
step_result = StepResult(output=output or "", stop_workflow=stop)
# Call on_step_complete callback
if self.on_step_complete:
try:
self.on_step_complete(step.name, step_result)
except Exception as e:
logger.error(f"on_step_complete callback failed: {e}")
self._notify_step_complete(
_replay, step.name, step_result,
"failed" if step_failed else "completed", output,
variables=step_variable_updates,
)
# Handle output_file - save output to file
if hasattr(step, 'output_file') and step.output_file and output:
try:
import os
from ..utils.output_file import write_output_file
output_path = step.output_file
# Substitute variables in path
for key, value in all_variables.items():
output_path = output_path.replace(f"{{{{{key}}}}}", str(value))
# Create directory if needed
os.makedirs(os.path.dirname(output_path) if os.path.dirname(output_path) else ".", exist_ok=True)
with open(output_path, "w") as f:
f.write(str(output))
if verbose:
if write_output_file(output_path, str(output)) and verbose:
print(f"📁 Saved output to: {output_path}")
except Exception as e:
logger.error(f"Failed to save output to file: {e}")
@@ -2984,10 +3128,57 @@ Create a brief execution plan (2-3 sentences) describing how to best accomplish
# them on every run so their conditions and nested Task gates execute;
# their individual leaves can still reuse cached results.
if isinstance(step, (Loop, Parallel, Route, Repeat, Discussion, If, Include)):
# Pattern executors emit their own replay step events.
return self._execute_single_step_uncached(
step, previous_output, input, all_variables, model, verbose, index,
stream=stream, depth=depth,
)
span = _replay_step_begin(self, step)
if span is None:
return self._execute_leaf_step(
step, previous_output, input, all_variables, model, verbose, index,
stream=stream, depth=depth,
)
try:
result = self._execute_leaf_step(
step, previous_output, input, all_variables, model, verbose, index,
stream=stream, depth=depth, _replay=span,
)
except BaseException:
_replay_step_end(span, "failed")
raise
is_dict = isinstance(result, dict)
status = span.get("status") or (
"skipped" if is_dict and result.get("skipped")
else "failed" if is_dict and result.get("error") else "completed"
)
# Variables this step set, minus its output variable, for replay's step_end.
# A cache hit leaves all_variables untouched, so it is its own baseline.
before = span.pop("before", all_variables)
step_vars = {}
if is_dict:
step_vars = {
k: v for k, v in (result.get("variables") or {}).items()
if k not in before or _differs(before[k], v)
}
step_vars.pop(getattr(step, "output_variable", None) or f"{result.get('step')}_output", None)
_replay_step_end(span, status, result.get("output") if is_dict else None, step_vars)
return result
def _execute_leaf_step(
self,
step: Any,
previous_output: Optional[str],
input: str,
all_variables: Dict[str, Any],
model: str,
verbose: bool,
index: int = 0,
stream: bool = True,
depth: int = 0,
_replay: Optional[dict] = None,
) -> Dict[str, Any]:
"""Leaf-step body of :meth:`_execute_single_step_internal` (gate + cache)."""
if depth > MAX_NESTING_DEPTH:
raise ValueError(
f"Maximum nesting depth ({MAX_NESTING_DEPTH}) exceeded. "
@@ -3014,6 +3205,7 @@ Create a brief execution plan (2-3 sentences) describing how to best accomplish
}
cache = getattr(self, "_step_cache", None)
if cache is None:
_snapshot_scope(_replay, all_variables)
return self._execute_single_step_uncached(
step, previous_output, input, all_variables, model, verbose, index,
stream=stream, depth=depth,
@@ -3036,8 +3228,11 @@ Create a brief execution plan (2-3 sentences) describing how to best accomplish
if hasattr(step, "status"):
step.status = "completed"
self.step_statuses[step.name] = "completed"
if _replay is not None:
_replay["status"] = "cached"
# Copy: a caller mutating a returned result must not edit the cache.
return dict(hit)
_snapshot_scope(_replay, all_variables)
result = self._execute_single_step_uncached(
step, previous_output, input, all_variables, model, verbose, index,
stream=stream, depth=depth,
@@ -3410,19 +3605,18 @@ Create a brief execution plan (2-3 sentences) describing how to best accomplish
# Handle output_file - save output to file
if hasattr(step, 'output_file') and step.output_file and output and not step_error:
try:
from ..utils.output_file import write_output_file
output_path = step.output_file
for key, value in all_variables.items():
output_path = output_path.replace(f"{{{{{key}}}}}", str(value))
os.makedirs(os.path.dirname(output_path) if os.path.dirname(output_path) else ".", exist_ok=True)
with open(output_path, "w") as f:
f.write(str(output))
if verbose:
if write_output_file(output_path, str(output)) and verbose:
print(f"📁 Saved output to: {output_path}")
except Exception as e:
logger.error(f"Failed to save output to file: {e}")
return output, step_error
@_replay_pattern("route")
def _execute_route(
self,
route_step: Route,
@@ -3453,6 +3647,9 @@ Create a brief execution plan (2-3 sentences) describing how to best accomplish
if matched_route is None:
matched_route = route_step.default or []
_replay_note_route("default")
else:
_replay_note_route(key)
if verbose:
route_name = next((k for k in route_step.routes if route_step.routes[k] == matched_route), "default")
@@ -3704,6 +3901,7 @@ CONCISE SUMMARY:"""
winners[key] = idx
all_variables[key] = value
@_replay_pattern("parallel")
def _execute_parallel(
self,
parallel_step: Parallel,
@@ -3956,6 +4154,7 @@ CONCISE SUMMARY:"""
return {"steps": results, "output": combined_output, "variables": all_variables, "stop": parallel_stopped}
@_replay_pattern("loop")
def _execute_loop(
self,
loop_step: Loop,
@@ -4342,6 +4541,7 @@ CONCISE SUMMARY:"""
# 4. Fallback: wrap as single item
return [text]
@_replay_pattern("discussion")
def _execute_discussion(
self, discussion, previous_output, input, all_variables, model, verbose, stream=True, depth=0
):
@@ -4425,6 +4625,7 @@ CONCISE SUMMARY:"""
"stop": discussion_stopped,
}
@_replay_pattern("repeat")
def _execute_repeat(
self,
repeat_step: Repeat,
@@ -4499,6 +4700,7 @@ CONCISE SUMMARY:"""
all_variables["repeat_iterations"] = iteration + 1 if repeat_step.max_iterations > 0 else 0
return {"steps": results, "output": output, "variables": all_variables, "stop": repeat_stopped}
@_replay_pattern("if")
def _execute_if(
self,
if_step: If,
@@ -4530,6 +4732,7 @@ CONCISE SUMMARY:"""
# Evaluate the condition
condition_result = self._evaluate_condition(if_step.condition, all_variables, previous_output)
_replay_note_route("true" if condition_result else "false")
if verbose:
branch = "then" if condition_result else "else"
@@ -4583,6 +4786,7 @@ CONCISE SUMMARY:"""
from praisonaiagents.conditions.evaluator import evaluate_condition
return evaluate_condition(condition, variables, previous_output)
@_replay_pattern("include")
def _execute_include(
self,
include_step: Include,
@@ -1077,11 +1077,15 @@ class YAMLWorkflowParser:
# Build routes dictionary with resolved agents
routes = {}
for route_key, agent_ids in route_config.items():
if isinstance(agent_ids, list):
routes[route_key] = [self._agents[aid] for aid in agent_ids if aid in self._agents]
else:
if agent_ids in self._agents:
routes[route_key] = [self._agents[agent_ids]]
if not isinstance(agent_ids, list):
agent_ids = [agent_ids]
try:
routes[route_key] = [self._agents[aid] for aid in agent_ids]
except KeyError as exc:
raise ValueError(
f"Agent '{exc.args[0]}' in route '{route_key}' "
"not defined in agents section"
) from exc
return route(routes)
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
description = "Praison AI agents for completing complex tasks with Self Reflection Agents"
readme = "README.md"
requires-python = ">=3.10"
@@ -0,0 +1,113 @@
"""Real agentic test for PraisonAI Replay events (AGENTS.md section 9.4).
Runs a real two-agent AgentTeam and a real hand-off against gpt-4o-mini while
recording with a ContextListSink, then checks the trace a replay needs:
workflow, task, agent and LLM events (on both the OpenAI-client path and the
LiteLLM path), a real hand-off, one run id and parent links that resolve.
About five small model calls. Opt in with:
RUN_REAL_KEY_TESTS=1 PRAISONAI_ALLOW_NETWORK=1 OPENAI_API_KEY=... \
pytest tests/integration/test_replay_events_real.py -s
"""
import os
import pytest
pytestmark = [
pytest.mark.network,
pytest.mark.skipif(
os.getenv("RUN_REAL_KEY_TESTS") != "1"
or not os.getenv("OPENAI_API_KEY")
or os.getenv("OPENAI_API_KEY") == "test-key",
reason="Real model calls: set RUN_REAL_KEY_TESTS=1, PRAISONAI_ALLOW_NETWORK=1 and a real OPENAI_API_KEY",
),
]
def _types(events):
return [e.event_type.value for e in events]
def test_team_and_handoff_record_a_replayable_trace():
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
from praisonaiagents.trace.context_events import (
ContextListSink, ContextTraceEmitter, trace_context,
)
sink = ContextListSink()
emitter = ContextTraceEmitter(sink=sink, session_id="replay-real", enabled=True)
# Researcher uses the OpenAI-client path, Writer the LiteLLM path.
researcher = Agent(name="Researcher", instructions="Answer in one short sentence.",
llm="gpt-4o-mini")
writer = Agent(name="Writer", instructions="Rewrite the given text as a headline of at most eight words.",
llm="openai/gpt-4o-mini")
team = AgentTeam(
agents=[researcher, writer],
tasks=[
Task(name="research", description="State one fact about the Moon.",
expected_output="One sentence", agent=researcher),
Task(name="headline", description="Turn the fact into a headline.",
expected_output="A headline", agent=writer),
],
output="silent",
)
billing = Agent(name="Billing", instructions="Reply exactly: Refund logged.", llm="gpt-4o-mini")
triage = Agent(
name="Triage",
instructions=("You never answer yourself. For any request, immediately call the "
"transfer_to_billing tool, then repeat its answer."),
llm="gpt-4o-mini",
handoffs=[billing],
)
with trace_context(emitter):
team_output = team.start()
handoff_output = triage.start("Please refund order 7.")
events = sink.get_events()
print("\n--- team output ---\n", team_output)
print("--- hand-off output ---\n", handoff_output)
print("--- trace ---")
for e in events:
print(f"{e.sequence_num:>3} parent={e.parent_seq!s:>4} {e.event_type.value:<18} "
f"{(e.agent_name or ''):<11} {e.node_id or ''}")
assert team_output and handoff_output
types = _types(events)
for needed in ("workflow_start", "workflow_end", "task_start", "task_end",
"agent_start", "agent_end", "llm_request", "llm_response", "agent_handoff"):
assert needed in types, needed
start = next(e for e in events if e.event_type.value == "workflow_start")
assert start.data["kind"] == "team" and start.data["graph"]["schema"] == "praisonai.graph/1"
graph_ids = {n["id"] for n in start.data["graph"]["nodes"]}
task_ends = [e for e in events if e.event_type.value == "task_end"]
assert [e.data["status"] for e in task_ends] == ["completed", "completed"]
assert {e.node_id for e in task_ends} == {"task:research", "task:headline"} <= graph_ids
team_events = [e for e in events if e.run_id == team.run_id]
assert team_events and team_events[0] is start
# LLM activity on both paths, attributed to the right agent.
responses = [e for e in events if e.event_type.value == "llm_response"]
by_agent = {e.agent_name for e in responses}
assert {"Researcher", "Writer", "Triage", "Billing"} <= by_agent
writer_calls = [e for e in responses if e.agent_name == "Writer"]
assert "gpt-4o-mini" in writer_calls[0].data.get("model") # recorded by the LLM class
assert writer_calls[0].prompt_tokens > 0 and writer_calls[0].completion_tokens > 0
assert len([e for e in events if e.event_type.value == "llm_request" and e.agent_name == "Writer"]) == len(writer_calls)
handoffs = [e for e in events if e.event_type.value == "agent_handoff"]
assert any(h.data["from_agent"] == "Triage" and h.data["to_agent"] == "Billing"
and h.data["kind"] == "handoff" for h in handoffs)
# Every parent link resolves to an earlier event; sequence numbers are unique.
seqs = [e.sequence_num for e in events]
assert seqs == list(range(len(events)))
for e in events:
assert e.parent_seq is None or e.parent_seq < e.sequence_num
@@ -1274,12 +1274,13 @@ class TestTaskTools:
class TestMigratedFeatures:
"""Test features migrated from process='workflow'."""
def test_step_output_file(self):
def test_step_output_file(self, monkeypatch):
"""Test Task with output_file parameter."""
import tempfile
import os
with tempfile.TemporaryDirectory() as tmpdir:
monkeypatch.setenv("PRAISONAI_PROJECT_ROOT", tmpdir)
output_path = os.path.join(tmpdir, "output.txt")
def generate_content(ctx: WorkflowContext) -> StepResult:
@@ -0,0 +1,130 @@
"""A configured completion promise must be the only success signal (#6027)."""
import asyncio
import pytest
from praisonaiagents import Agent
from praisonaiagents.model_harness import ScriptedModel
NOT_DONE = (
"I listed the files and started on the parser, but work remains: the tokenizer "
"is still failing two tests and the CLI flag is not wired yet. Continuing next turn."
)
DONE_REPLY = "Fixed the tokenizer and wired the flag. <promise>DONE</promise>"
PROMPT = "Refactor auth module" # stage=autonomous
DIRECT_PROMPT = "Implement feature X" # stage=direct
@pytest.fixture(autouse=True)
def _offline(monkeypatch, tmp_path):
for key in ("OPENAI_BASE_URL", "OPENAI_API_BASE", "ANTHROPIC_BASE_URL"):
monkeypatch.setenv(key, "http://127.0.0.1:9")
monkeypatch.setenv("HOME", str(tmp_path))
def list_files(path: str) -> str:
"""List files in a directory."""
return "parser.py tokenizer.py cli.py"
def _script(follow_ups=1):
return (
[ScriptedModel.tool_call("list_files", {"path": "."})]
+ [NOT_DONE] * follow_ups
+ [DONE_REPLY] * 3
)
def _make(model, **autonomy):
return Agent(
name="worker", instructions="Do the task.", llm=model, tools=[list_files],
output="silent", autonomy={"level": "full_auto", **autonomy},
)
def _assert_promise(result):
assert result.success is True
assert result.completion_reason == "promise"
assert "<promise>DONE</promise>" in result.output
assert result.iterations >= 2
def test_sync_tool_completion_does_not_preempt_promise():
r = _make(ScriptedModel(_script())).run_autonomous(
PROMPT, completion_promise="DONE", max_iterations=5)
_assert_promise(r)
def test_async_waits_for_promise():
r = asyncio.run(_make(ScriptedModel(_script(2))).run_autonomous_async(
PROMPT, completion_promise="DONE", max_iterations=5))
_assert_promise(r)
def test_sync_direct_stage_waits_for_promise():
r = _make(ScriptedModel([NOT_DONE, DONE_REPLY])).run_autonomous(
DIRECT_PROMPT, completion_promise="DONE", max_iterations=5)
_assert_promise(r)
def test_async_direct_stage_waits_for_promise():
r = asyncio.run(_make(ScriptedModel([NOT_DONE, DONE_REPLY])).run_autonomous_async(
DIRECT_PROMPT, completion_promise="DONE", max_iterations=5))
_assert_promise(r)
def test_promise_never_emitted_ends_unsuccessfully():
r = _make(ScriptedModel([NOT_DONE] * 5)).run_autonomous(
PROMPT, completion_promise="DONE", max_iterations=3)
assert r.success is False
assert r.completion_reason == "max_iterations"
def test_iterative_mode_start_honours_promise():
agent = Agent(
name="loop_agent", instructions="Complete the task.", llm=ScriptedModel(_script()),
tools=[list_files], output="silent",
autonomy={"mode": "iterative", "max_iterations": 10,
"completion_promise": "DONE", "observe": False},
)
_assert_promise(agent.start(PROMPT))
def test_without_promise_tool_completion_unchanged():
r = _make(ScriptedModel(_script())).run_autonomous(PROMPT, max_iterations=5)
assert r.success is True
assert r.completion_reason == "tool_completion"
assert r.iterations == 1
def test_async_tool_path_counts_tools():
r = asyncio.run(_make(ScriptedModel(_script(2))).run_autonomous_async(
PROMPT, max_iterations=5))
assert r.success is True
assert r.completion_reason == "tool_completion"
assert r.iterations == 1
def test_promise_tag_is_sent_to_model():
model = ScriptedModel([DONE_REPLY])
_make(model).run_autonomous(PROMPT, completion_promise="DONE", max_iterations=2)
assert "<promise>DONE</promise>" in model.requests[0].last_user_message
def test_async_blocked_tool_does_not_count_as_tool_completion():
from praisonaiagents.hooks import HookEvent, HookRegistry, HookResult
registry = HookRegistry()
@registry.on(HookEvent.BEFORE_TOOL)
def deny(data):
return HookResult.deny("blocked")
agent = Agent(
name="worker", instructions="Do the task.", llm=ScriptedModel(_script(2)),
tools=[list_files], output="silent", hooks=registry,
autonomy={"level": "full_auto"},
)
r = asyncio.run(agent.run_autonomous_async(PROMPT, max_iterations=3))
assert r.completion_reason != "tool_completion"
@@ -154,9 +154,14 @@ class TestPromptReinjection:
completion_promise="DONE"
)
# All prompts should be the original, not "Continue with the task"
# All prompts should be the original (plus the promise instruction),
# not "Continue with the task"
expected = (
"Build a REST API\n\nWhen the task is fully complete, include "
"<promise>DONE</promise> in your response."
)
for prompt in prompts_received:
assert prompt == "Build a REST API", f"Expected original prompt, got: {prompt}"
assert prompt == expected, f"Expected original prompt, got: {prompt}"
def test_prompt_not_continue_with_task(self):
"""Prompt should NOT be 'Continue with the task' after first iteration."""
@@ -0,0 +1,27 @@
from praisonaiagents.agent.context_agent import ContextAgent
NON_ASCII = "日本語 café ☕"
def test_context_engineering_results_written_as_readable_utf8(tmp_path, monkeypatch):
"""Every saved Context Engineering result file keeps non-ASCII content as readable UTF-8."""
# ContextAgent defaults output to .praisonai/prp under the cwd, so run inside tmp.
monkeypatch.chdir(tmp_path)
agent = ContextAgent(llm="gpt-4o-mini", auto_analyze=False)
agent.output_dir = str(tmp_path)
agent.codebase_analysis = {"summary": NON_ASCII}
agent.pattern_library = {"summary": NON_ASCII}
agent.validation_framework = {"summary": NON_ASCII}
agent.agent_interactions = [{"response": NON_ASCII}]
agent._save_context_engineering_results()
for filename in (
"comprehensive_analysis.json",
"pattern_library.json",
"validation_framework.json",
"all_agent_interactions.json",
):
saved = (tmp_path / filename).read_text(encoding="utf-8")
assert NON_ASCII in saved, filename
assert "\\u" not in saved, filename
@@ -0,0 +1,93 @@
"""Loop guard per-turn time limit is configurable via ExecutionConfig (#6026)."""
import asyncio
import pytest
import praisonaiagents.escalation.loop_guard as lg
from praisonaiagents import Agent
from praisonaiagents.config.feature_configs import ExecutionConfig
from praisonaiagents.escalation.loop_guard import GuardAction, LoopGuardConfig
from praisonaiagents.model_harness import ScriptedModel
@pytest.fixture
def clock(monkeypatch):
state = {"t": 1_000_000.0}
class FakeTime:
@staticmethod
def time():
return state["t"]
monkeypatch.setattr(lg, "time", FakeTime)
return state
def _agent(clock, tool_seconds, execution=None, calls=None):
calls = [] if calls is None else calls
def run_tests(suite: str) -> str:
"""Run a (slow) test suite."""
calls.append(suite)
clock["t"] += tool_seconds
return f"{suite}: 412 passed"
model = ScriptedModel([
ScriptedModel.tool_call("run_tests", {"suite": "unit"}),
ScriptedModel.tool_call("run_tests", {"suite": "integration"}),
"All suites passed.",
])
kwargs = {"execution": execution} if execution is not None else {}
return Agent(name="coder", instructions="Run the tests.", llm=model,
tools=[run_tests], output="silent", **kwargs)
@pytest.mark.parametrize("use_async", [False, True])
def test_default_turn_with_130s_tool_completes(clock, use_async):
agent = _agent(clock, 130.0)
if use_async:
out = asyncio.run(agent.achat("Run both suites"))
else:
out = agent.chat("Run both suites")
assert "All suites passed" in str(out)
@pytest.mark.parametrize("use_async", [False, True])
def test_configured_limit_halts(clock, use_async):
calls = []
agent = _agent(clock, 130.0, ExecutionConfig(max_execution_time=60), calls)
if use_async:
asyncio.run(agent.achat("Run both suites"))
else:
with pytest.raises(Exception, match="Turn time limit exceeded"):
agent.chat("Run both suites")
# The second tool call is refused by the loop guard on both paths.
assert calls == ["unit"]
@pytest.mark.parametrize("use_async", [False, True])
def test_zero_disables_time_halt(clock, use_async):
agent = _agent(clock, 10_000.0, ExecutionConfig(max_execution_time=0))
if use_async:
out = asyncio.run(agent.achat("Run both suites"))
else:
out = agent.chat("Run both suites")
assert "All suites passed" in str(out)
def test_ensure_loop_guard_reads_max_execution_time():
agent = Agent(name="a", instructions="x", llm=ScriptedModel(["ok"]),
output="silent", execution=ExecutionConfig(max_execution_time=900))
assert agent._ensure_loop_guard().config.max_time_per_turn == 900.0
def test_real_loop_still_halts_without_time_limit():
guard = lg.LoopGuard(LoopGuardConfig(max_time_per_turn=float("inf")))
actions = []
for _ in range(20):
decision = guard.check("read_file", {"path": "a.txt"})
actions.append(decision.action)
if decision.action == GuardAction.HALT:
break
guard.record("read_file", {"path": "a.txt"}, success=True, result="same")
assert actions[-1] == GuardAction.HALT
@@ -0,0 +1,35 @@
"""Retained completed events are available to both wait entry points."""
import asyncio
from praisonaiagents import AgentTeam
def test_sync_default_returns_already_completed_events():
with AgentTeam(agents=[]) as team:
team.announce_completion("finished-a", "task-a", "result-a")
team.announce_completion("finished-b", "task-b", "result-b")
events = team.wait_for_completions(timeout=0.2)
assert [event.agent_id for event in events] == ["finished-a", "finished-b"]
def test_explicit_empty_ids_do_not_return_retained_events():
"""An explicit empty target set retains its previous empty result."""
with AgentTeam(agents=[]) as team:
team.announce_completion("finished-a", "task-a", "result-a")
assert team.wait_for_completions(timeout=0.2, agent_ids=[]) == []
def test_explicit_ids_filter_retained_events():
with AgentTeam(agents=[]) as team:
team.announce_completion("finished-a", "task-a", "result-a")
team.announce_completion("finished-b", "task-b", "result-b")
events = team.wait_for_completions(timeout=0.2, agent_ids=["finished-b"])
assert [event.agent_id for event in events] == ["finished-b"]
def test_async_default_returns_already_completed_events():
with AgentTeam(agents=[]) as team:
team.announce_completion("finished-a", "task-a", "result-a")
team.announce_completion("finished-b", "task-b", "result-b")
events = asyncio.run(team.await_for_completions(timeout=0.2))
assert [event.agent_id for event in events] == ["finished-a", "finished-b"]
@@ -0,0 +1,49 @@
"""Workflow dependents must honor failure policy after synchronous predecessors."""
import asyncio
import pytest
from praisonaiagents import Agent, AgentTeam, Task
class ScriptedAgent(Agent):
"""Exercise production task scheduling without provider requests."""
def __init__(self, name, reply):
super().__init__(name=name, instructions="test", llm="gpt-4o-mini")
self.reply = reply
self.calls = 0
def chat(self, prompt, **kwargs):
"""Record a real dispatch of this task's agent."""
self.calls += 1
return self.reply
async def achat(self, prompt, **kwargs):
"""Record asynchronous dispatch through the same fixture."""
return self.chat(prompt, **kwargs)
@pytest.mark.parametrize("entry", ["start", "astart"])
@pytest.mark.parametrize("upstream_async", [False, True])
@pytest.mark.parametrize("downstream_async", [False, True])
@pytest.mark.parametrize("policy", ["stop", "continue", "skip"])
def test_workflow_failed_predecessor_policy(entry, upstream_async, downstream_async, policy):
"""Default dependents do not execute; explicit degraded-mode ones still do."""
upstream = ScriptedAgent("upstream", None)
downstream = ScriptedAgent("downstream", "done")
first = Task(name="first", description="first", agent=upstream,
is_start=True, next_tasks=["second"], async_execution=upstream_async, max_retries=1)
flags = {"on_error": "continue"} if policy == "continue" else {}
if policy == "skip":
flags["skip_on_failure"] = True
second = Task(name="second", description="second", agent=downstream,
async_execution=downstream_async, max_retries=1, **flags)
team = AgentTeam(agents=[upstream, downstream], tasks=[first, second], process="workflow")
if entry == "astart":
asyncio.run(team.astart())
else:
team.start()
assert first.status == "failed"
assert upstream.calls == 1
assert downstream.calls == (0 if policy == "stop" else 1)
@@ -0,0 +1,44 @@
"""GitHub write tools must go through the approval system (issue #6023)."""
import pytest
from praisonaiagents.approval import get_approval_registry
from praisonaiagents.approval.registry import PERMISSION_PRESETS
GITHUB_WRITE_TOOLS = (
"github_create_branch",
"github_commit_and_push",
"github_create_pull_request",
)
@pytest.mark.parametrize("name", GITHUB_WRITE_TOOLS)
def test_registered_as_high_risk(name):
reg = get_approval_registry()
assert reg.is_required(name)
# high (not critical) so YAML/declarative approve lists still apply
assert reg.get_risk_level(name) == "high"
@pytest.mark.parametrize("name", GITHUB_WRITE_TOOLS)
def test_in_deny_presets(name):
for preset in ("default", "safe", "read_only"):
assert name in PERMISSION_PRESETS[preset]
assert name not in PERMISSION_PRESETS["full"]
def test_unattended_agent_denied_by_default(monkeypatch):
monkeypatch.delenv("PRAISONAI_TOOL_SAFETY", raising=False)
from praisonaiagents import Agent
agent = Agent(instructions="t", llm="gpt-4o-mini", approval=False)
for name in ("github_commit_and_push", "github_create_pull_request"):
result = agent._check_tool_approval_sync(name, {})
assert isinstance(result, dict) and result.get("permission_denied")
def test_explicit_full_preset_allows(monkeypatch):
monkeypatch.setenv("PRAISONAI_TOOL_SAFETY", "off")
from praisonaiagents import Agent
agent = Agent(instructions="t", llm="gpt-4o-mini", approval=False)
assert "github_commit_and_push" not in (agent._perm_deny or ())
@@ -1,222 +0,0 @@
"""Unit tests for evaluation utility functions."""
import json
import tempfile
from pathlib import Path
from unittest.mock import MagicMock
from praisonaiagents.eval.utils import (
save_result_to_file,
load_result_from_file,
format_score,
format_percentage,
format_duration,
format_memory,
calculate_pass_rate,
)
class TestSaveResultToFile:
"""Tests for save_result_to_file function."""
def test_save_with_to_dict(self):
"""Test saving result with to_dict method."""
with tempfile.TemporaryDirectory() as tmpdir:
path = f"{tmpdir}/result.json"
result = MagicMock()
result.to_dict.return_value = {"score": 8.0, "passed": True}
success = save_result_to_file(result, path)
assert success is True
assert Path(path).exists()
with open(path) as f:
data = json.load(f)
assert data["score"] == 8.0
def test_save_with_dict_attr(self):
"""Test saving result with __dict__ attribute."""
with tempfile.TemporaryDirectory() as tmpdir:
path = f"{tmpdir}/result.json"
class SimpleResult:
def __init__(self):
self.score = 9.0
self.name = "test"
result = SimpleResult()
success = save_result_to_file(result, path)
assert success is True
with open(path) as f:
data = json.load(f)
assert data["score"] == 9.0
def test_save_with_placeholders(self):
"""Test saving with path placeholders."""
with tempfile.TemporaryDirectory() as tmpdir:
path = f"{tmpdir}/{{name}}_{{eval_id}}.json"
result = MagicMock()
result.to_dict.return_value = {"score": 8.0}
success = save_result_to_file(
result, path,
eval_id="abc123",
name="test_eval"
)
assert success is True
expected_path = f"{tmpdir}/test_eval_abc123.json"
assert Path(expected_path).exists()
def test_save_creates_directories(self):
"""Test that save creates parent directories."""
with tempfile.TemporaryDirectory() as tmpdir:
path = f"{tmpdir}/nested/dir/result.json"
result = MagicMock()
result.to_dict.return_value = {"score": 8.0}
success = save_result_to_file(result, path)
assert success is True
assert Path(path).exists()
def test_save_failure_returns_false(self):
"""Test that save failure returns False."""
result = MagicMock()
result.to_dict.side_effect = Exception("Test error")
success = save_result_to_file(result, "/invalid/path/result.json")
assert success is False
class TestLoadResultFromFile:
"""Tests for load_result_from_file function."""
def test_load_existing_file(self):
"""Test loading existing result file."""
with tempfile.TemporaryDirectory() as tmpdir:
path = f"{tmpdir}/result.json"
data = {"score": 8.0, "passed": True}
with open(path, 'w') as f:
json.dump(data, f)
loaded = load_result_from_file(path)
assert loaded == data
def test_load_nonexistent_file(self):
"""Test loading nonexistent file returns None."""
result = load_result_from_file("/nonexistent/path/result.json")
assert result is None
def test_load_invalid_json(self):
"""Test loading invalid JSON returns None."""
with tempfile.TemporaryDirectory() as tmpdir:
path = f"{tmpdir}/invalid.json"
with open(path, 'w') as f:
f.write("not valid json")
result = load_result_from_file(path)
assert result is None
class TestFormatScore:
"""Tests for format_score function."""
def test_format_default_max(self):
"""Test formatting with default max score."""
assert format_score(8.5) == "8.5/10"
def test_format_custom_max(self):
"""Test formatting with custom max score."""
assert format_score(85.0, 100.0) == "85.0/100"
def test_format_zero(self):
"""Test formatting zero score."""
assert format_score(0.0) == "0.0/10"
class TestFormatPercentage:
"""Tests for format_percentage function."""
def test_format_full(self):
"""Test formatting 100%."""
assert format_percentage(1.0) == "100.0%"
def test_format_half(self):
"""Test formatting 50%."""
assert format_percentage(0.5) == "50.0%"
def test_format_zero(self):
"""Test formatting 0%."""
assert format_percentage(0.0) == "0.0%"
def test_format_decimal(self):
"""Test formatting decimal percentage."""
assert format_percentage(0.333) == "33.3%"
class TestFormatDuration:
"""Tests for format_duration function."""
def test_format_microseconds(self):
"""Test formatting microseconds."""
result = format_duration(0.0001)
assert "μs" in result
def test_format_milliseconds(self):
"""Test formatting milliseconds."""
result = format_duration(0.5)
assert "ms" in result
def test_format_seconds(self):
"""Test formatting seconds."""
result = format_duration(5.5)
assert "s" in result
assert "m" not in result
def test_format_minutes(self):
"""Test formatting minutes."""
result = format_duration(90.0)
assert "m" in result
class TestFormatMemory:
"""Tests for format_memory function."""
def test_format_kilobytes(self):
"""Test formatting kilobytes."""
result = format_memory(0.5)
assert "KB" in result
def test_format_megabytes(self):
"""Test formatting megabytes."""
result = format_memory(100.0)
assert "MB" in result
def test_format_gigabytes(self):
"""Test formatting gigabytes."""
result = format_memory(2048.0)
assert "GB" in result
class TestCalculatePassRate:
"""Tests for calculate_pass_rate function."""
def test_all_passed(self):
"""Test 100% pass rate."""
assert calculate_pass_rate(10, 10) == 1.0
def test_none_passed(self):
"""Test 0% pass rate."""
assert calculate_pass_rate(0, 10) == 0.0
def test_half_passed(self):
"""Test 50% pass rate."""
assert calculate_pass_rate(5, 10) == 0.5
def test_zero_total(self):
"""Test with zero total."""
assert calculate_pass_rate(0, 0) == 0.0
@@ -0,0 +1,53 @@
"""AFTER_LLM reports the usage counted by the existing completion path."""
import asyncio
from types import SimpleNamespace
from unittest.mock import AsyncMock, Mock
from openai.types.chat import ChatCompletion
import pytest
from praisonaiagents import Agent
from praisonaiagents.config.feature_configs import HooksConfig
from praisonaiagents.hooks import HookEvent, HookRegistry, HookResult
@pytest.mark.parametrize("asynchronous", [False, True])
@pytest.mark.parametrize("with_usage", [False, True])
def test_after_llm_receives_current_completion_usage(asynchronous, with_usage):
usage = {"prompt_tokens": 11, "completion_tokens": 7, "total_tokens": 18}
completion = ChatCompletion(
id="chatcmpl-fixture", created=1, object="chat.completion",
model="gpt-4o-mini",
choices=[{
"index": 0, "finish_reason": "stop",
"message": {"role": "assistant", "content": "Fixture greeting."},
}],
usage=usage if with_usage else None,
)
observed = []
registry = HookRegistry()
def after_llm(event):
observed.append(event.tokens_used)
return HookResult.allow()
registry.register_function(HookEvent.AFTER_LLM, after_llm)
agent = Agent(
name="usage-fixture", instructions="Greet.", model="gpt-4o-mini",
api_key="synthetic-offline-fixture",
hooks=HooksConfig(registry=registry),
output={"verbose": False, "stream": False},
reflection=False, memory=False, rules=False, retry=False,
)
agent._unified_dispatcher = SimpleNamespace(
chat_completion=Mock(return_value=completion),
achat_completion=AsyncMock(return_value=completion),
)
if asynchronous:
result = asyncio.run(agent.achat("Hello", stream=False))
agent._unified_dispatcher.achat_completion.assert_awaited_once()
else:
result = agent.chat("Hello", stream=False)
agent._unified_dispatcher.chat_completion.assert_called_once()
assert result == "Fixture greeting."
assert observed == [18 if with_usage else 0]
@@ -275,3 +275,113 @@ def test_async_fallback_passes_override_and_leaves_shared_state(monkeypatch):
assert used[0] is not original_dispatcher
assert agent.llm == "gpt-4o-mini" # shared model untouched
assert agent._unified_dispatcher is original_dispatcher # shared cache untouched
# --- Custom-LLM path (Issue #6030) ---------------------------------------------
class _Unavailable(Exception):
status_code = 503
class _StubLLM:
def __init__(self, model, fail, calls):
self.model, self._fail, self._calls = model, fail, calls
def _respond(self):
self._calls.append(self.model)
if self._fail:
raise self._fail
return f"answer from {self.model}"
def get_response(self, **kwargs):
return self._respond()
async def get_response_async(self, **kwargs):
return self._respond()
class _ToolThenFailLLM(_StubLLM):
"""Runs a tool, then fails, like a 503 on the follow-up model request."""
def get_response(self, execute_tool_fn=None, **kwargs):
execute_tool_fn("send_email", {})
return self._respond()
def _custom_agent(primary_error, fallbacks):
from praisonaiagents import Agent
calls = []
primary = _StubLLM("primary-model", primary_error, calls)
agent = Agent(name="c", instructions="x", llm=primary, output="silent")
agent.fallback_models = [_StubLLM(m, None, calls) for m in fallbacks]
seen = []
agent._hook_runner.registry.register_function(
HookEvent.MODEL_FALLBACK, lambda inp: seen.append(inp) or HookResult.allow()
)
return agent, primary, calls, seen
def test_custom_llm_sync_falls_back_on_outage():
agent, primary, calls, seen = _custom_agent(_Unavailable("503 overloaded"), ["backup"])
assert agent.chat("hello") == "answer from backup"
assert calls == ["primary-model", "backup"]
assert len(seen) == 1 and seen[0].fallback_index == 0
assert agent.llm_instance is primary # shared state untouched
def test_custom_llm_async_falls_back_on_outage():
agent, primary, calls, seen = _custom_agent(_Unavailable("503 overloaded"), ["backup"])
assert asyncio.run(agent.achat("hello")) == "answer from backup"
assert calls == ["primary-model", "backup"]
assert len(seen) == 1
assert agent.llm_instance is primary
def test_custom_llm_non_fallback_error_does_not_walk_chain():
err = Exception("401 Unauthorized: invalid api key")
err.status_code = 401
agent, _, calls, seen = _custom_agent(err, ["backup"])
assert agent.chat("hello") is None
assert calls == ["primary-model"]
assert seen == []
def test_fallback_llm_for_drops_connection_settings_across_providers(monkeypatch):
import praisonaiagents.llm.llm as llm_mod
built = []
monkeypatch.setattr(llm_mod, "LLM", lambda **kw: built.append(kw) or kw)
agent = _DummyAgent()
agent.llm = "ollama/llama3"
agent._llm_init_params = {"model": "ollama/llama3", "base_url": "http://h", "api_key": "k", "max_iter": 3}
agent._fallback_llm_for("ollama/qwen")
agent._fallback_llm_for("openai/gpt-4o-mini")
assert built[0] == {"model": "ollama/qwen", "base_url": "http://h", "api_key": "k", "max_iter": 3}
assert built[1] == {"model": "openai/gpt-4o-mini", "max_iter": 3}
assert agent._llm_init_params["model"] == "ollama/llama3"
def test_fallback_llm_for_keeps_connection_settings_for_bare_names(monkeypatch):
import praisonaiagents.llm.llm as llm_mod
built = []
monkeypatch.setattr(llm_mod, "LLM", lambda **kw: built.append(kw) or kw)
agent = _DummyAgent()
agent.llm = "model-a"
agent._llm_init_params = {"model": "model-a", "base_url": "http://custom/v1", "api_key": "k"}
agent._fallback_llm_for("model-b")
assert built[0] == {"model": "model-b", "base_url": "http://custom/v1", "api_key": "k"}
def test_custom_llm_does_not_fall_back_after_a_tool_ran():
from praisonaiagents import Agent
calls, sent = [], []
primary = _ToolThenFailLLM("primary-model", _Unavailable("503 overloaded"), calls)
agent = Agent(name="c", instructions="x", llm=primary, output="silent")
agent.fallback_models = [_StubLLM("backup", None, calls)]
agent.execute_tool = lambda name, args, **kw: sent.append(name)
assert agent.chat("hello") is None # existing error handling, no replay
assert calls == ["primary-model"]
assert sent == ["send_email"]
@@ -0,0 +1,94 @@
"""A supplied memory adapter must not require the default implementation."""
import copy
import sys
import types
import pytest
pytest.importorskip("litellm", reason="optional LLM provider dependency")
from praisonaiagents.llm import LLM
class ProvidedMemory:
"""Side-effect-free implementation of the supplied memory adapter surface."""
def get_tool_definition(self):
"""Return the request tool definition without constructing a backend."""
return {"type": "memory_20250818", "name": "memory"}
def get_beta_header(self):
"""Return a synthetic beta marker for local parameter checks."""
return "synthetic-memory-fixture-beta"
def execute(self, **kwargs):
"""Provide the adapter execution surface without I/O."""
return "fixture memory result"
def make_llm(memory, **kwargs):
"""Construct the real params producer with an explicit synthetic key."""
return LLM(
model="anthropic/claude-sonnet-4-20250514",
api_key="synthetic-offline-fixture",
base_url="http://127.0.0.1:1",
claude_memory=memory,
**kwargs,
)
def test_supplied_memory_is_used_without_default_module(monkeypatch):
"""A supplied instance is reused even if the default cannot be imported."""
monkeypatch.setitem(sys.modules, "praisonaiagents.tools.claude_memory_tool", None)
supplied = ProvidedMemory()
llm = make_llm(supplied)
assert llm._get_claude_memory_tool() is supplied
assert llm._get_claude_memory_tool() is supplied
@pytest.mark.parametrize("tools, headers", [
(None, None),
([], {}),
([{"type": "function", "function": {"name": "fixture", "parameters": {"type": "object", "properties": {}}}}], {"x-fixture": "retained"}),
])
def test_real_params_builder_accepts_supplied_memory_without_default_module(monkeypatch, tools, headers):
"""Supplied memory is included without ordering assumptions or input mutation."""
monkeypatch.setitem(sys.modules, "praisonaiagents.tools.claude_memory_tool", None)
supplied = ProvidedMemory()
llm = make_llm(supplied, web_fetch=True)
original_tools, original_headers = copy.deepcopy(tools), copy.deepcopy(headers)
first = llm._build_completion_params(tools=tools, extra_headers=headers)
second = llm._build_completion_params(tools=tools, extra_headers=headers)
assert supplied.get_tool_definition() in first["tools"]
assert first["tools"] == second["tools"]
assert supplied.get_beta_header() in first["extra_headers"]["anthropic-beta"]
assert tools == original_tools
assert headers == original_headers
@pytest.mark.parametrize("memory", [None, False])
def test_disabled_memory_still_needs_no_implementation(monkeypatch, memory):
"""Disabled memory never imports an implementation."""
monkeypatch.setitem(sys.modules, "praisonaiagents.tools.claude_memory_tool", None)
assert make_llm(memory)._get_claude_memory_tool() is None
def test_boolean_opt_in_still_constructs_and_caches_default(monkeypatch):
"""Boolean opt-in retains default factory construction and caching."""
calls = []
class DefaultMemory(ProvidedMemory):
"""Optional implementation stand-in that records construction."""
def __init__(self):
"""Record one default factory invocation."""
calls.append(self)
module = types.ModuleType("praisonaiagents.tools.claude_memory_tool")
module.ClaudeMemoryTool = DefaultMemory
monkeypatch.setitem(sys.modules, module.__name__, module)
llm = make_llm(True)
tool = llm._get_claude_memory_tool()
assert isinstance(tool, DefaultMemory)
assert llm._get_claude_memory_tool() is tool
assert calls == [tool]
@@ -0,0 +1,80 @@
from datetime import datetime, timezone
from praisonaiagents.memory.learn.stores import InsightStore, LearnEntry
def test_new_entry_timestamps_are_timezone_aware():
"""New learn entries carry timezone-aware created_at and updated_at."""
entry = LearnEntry(id="e1", content="hello")
assert datetime.fromisoformat(entry.created_at).tzinfo is not None
assert datetime.fromisoformat(entry.updated_at).tzinfo is not None
def test_prune_handles_legacy_naive_timestamps(tmp_path):
"""Pruning treats legacy naive timestamps as UTC instead of raising on the subtraction."""
store = InsightStore(store_path=str(tmp_path / "store.json"), retention_days=1)
now = datetime.now(timezone.utc)
# An entry persisted before the timezone-aware change: naive isoformat, no offset.
legacy = LearnEntry(
id="old",
content="old",
created_at="2020-01-01T00:00:00",
updated_at="2020-01-01T00:00:00",
)
# Must not raise "can't subtract offset-naive and offset-aware datetimes".
assert store._is_stale(legacy, now) is True
fresh = LearnEntry(id="new", content="new")
assert store._is_stale(fresh, now) is False
def test_prune_evicts_stale_legacy_entry_end_to_end(tmp_path):
"""prune() archives a stale legacy (naive-timestamp) entry without raising."""
store = InsightStore(store_path=str(tmp_path / "store.json"), retention_days=1)
store._entries["old"] = LearnEntry(
id="old",
content="old",
created_at="2020-01-01T00:00:00",
updated_at="2020-01-01T00:00:00",
)
assert store.prune(save=False) == 1
assert "old" not in store._entries
def test_list_all_orders_by_instant_not_raw_string(tmp_path):
"""list_all() orders by the actual UTC instant, even when offsets differ.
00:30+01:00 is an earlier instant than 00:00+00:00, but a raw-string sort
would order them the other way round.
"""
store = InsightStore(store_path=str(tmp_path / "store.json"))
store._entries = {
"earlier": LearnEntry(id="earlier", content="e", updated_at="2024-01-01T00:30:00+01:00"),
"later": LearnEntry(id="later", content="l", updated_at="2024-01-01T00:00:00+00:00"),
}
store._save() # persist so list_all's refresh reloads these entries
ordered = [e.id for e in store.list_all()] # reverse=True: most recent first
assert ordered == ["later", "earlier"]
def test_prune_evicts_never_used_entry_before_used_one(tmp_path):
"""At equal use_count, a never-used entry (last_used=None) is evicted first."""
store = InsightStore(store_path=str(tmp_path / "store.json"), max_entries=1)
store._entries = {
"never": LearnEntry(
id="never", content="n", use_count=0, last_used=None,
created_at="2024-01-01T00:00:00+00:00",
),
"used": LearnEntry(
id="used", content="u", use_count=0,
last_used="2024-06-01T00:00:00+00:00",
created_at="2024-01-01T00:00:00+00:00",
),
}
store.prune(save=False)
assert "never" not in store._entries
assert "used" in store._entries
@@ -0,0 +1,62 @@
"""Input validation must not run blocking validators on the achat event loop."""
import asyncio
import threading
import pytest
from praisonaiagents import Agent
class RecordingInputGuardrail:
"""Reject before provider dispatch while recording the execution thread."""
def __init__(self):
self.thread_id = None
self.content = None
def validate_input(self, content, **kwargs):
self.thread_id = threading.get_ident()
self.content = content
return False, "blocked by test validator"
def validate_output(self, content, **kwargs):
return True, content
def test_achat_offloads_sync_input_guardrail():
"""Public achat invokes a synchronous validator outside its event-loop thread."""
guardrail = RecordingInputGuardrail()
agent = Agent(name="T", instructions="test", llm="gpt-4o-mini", guardrails=guardrail)
async def run():
loop_thread = threading.get_ident()
await agent.achat("blocked prompt")
assert guardrail.content == "blocked prompt"
assert guardrail.thread_id is not None
assert guardrail.thread_id != loop_thread
asyncio.run(run())
@pytest.mark.parametrize("guardrails", [None, "Check output quality", lambda output: (True, output)])
def test_achat_disabled_guardrail_keeps_fast_path(monkeypatch, guardrails):
"""Absent, callable and output-only guards need no worker-thread dispatch."""
agent = Agent(name="T", instructions="test", llm="gpt-4o-mini", guardrails=guardrails)
guardrail = RecordingInputGuardrail()
def record(prompt):
guardrail.validate_input(prompt)
return False, None, "stop before provider dispatch"
monkeypatch.setattr(agent, "_validate_input_with_guardrail", record)
asyncio.run(agent.achat("blocked prompt"))
assert guardrail.thread_id == threading.get_ident()
def test_chat_keeps_sync_input_guardrail_on_caller_thread():
"""The synchronous public API retains its existing execution context."""
guardrail = RecordingInputGuardrail()
agent = Agent(name="T", instructions="test", llm="gpt-4o-mini", guardrails=guardrail)
agent.chat("blocked prompt")
assert guardrail.content == "blocked prompt"
assert guardrail.thread_id == threading.get_ident()
@@ -0,0 +1,61 @@
"""Disabled handoffs do not load their implementation; enabled paths still convert."""
import sys
import pytest
from praisonaiagents import Agent
from praisonaiagents.agent.handoff import Handoff
def make_agent(name, **kwargs):
"""Construct a minimal offline agent for handoff conversion checks."""
return Agent(
name=name,
instructions="Return a short answer.",
api_key="synthetic-offline-fixture",
reflection=False,
memory=False,
knowledge=False,
**kwargs,
)
@pytest.mark.parametrize("tools", [None, []])
def test_disabled_handoffs_do_not_require_handoff_module(monkeypatch, tools):
"""Empty tool/handoff configuration must not load handoff support."""
# A blocked import makes an unnecessary local import observable even when
# another test has already loaded this module in the same interpreter.
monkeypatch.setitem(sys.modules, "praisonaiagents.agent.handoff", None)
agent = make_agent("no-handoff", tools=tools)
assert agent.tools == []
assert agent.handoffs == []
@pytest.mark.parametrize("entry", ["tools", "handoffs"])
def test_handoff_objects_still_convert_to_bound_tools(entry):
"""Both supported Handoff entry points retain their bound source object."""
target = make_agent("target")
source = Handoff(target)
agent = make_agent("parent", **{entry: [source]})
assert len(agent.tools) == 1
assert callable(agent.tools[0])
assert agent.tools[0]._praison_handoff_source is source
def test_direct_agent_handoff_still_converts_to_bound_tool():
"""A direct Agent handoff still creates a tool for that target."""
target = make_agent("target")
agent = make_agent("parent", handoffs=[target])
assert len(agent.tools) == 1
assert callable(agent.tools[0])
assert agent.tools[0]._praison_handoff_source.agent is target
def test_regular_tool_is_unchanged():
"""Ordinary callable tools remain unchanged by handoff conversion."""
def echo(text: str) -> str:
"""Return the input text."""
return text
agent = make_agent("regular-tool", tools=[echo])
assert agent.tools == [echo]
@@ -0,0 +1,139 @@
"""Regression tests for issue #5957 (doom-loop window, download_file SSRF/size cap)."""
import socket
import time
from unittest.mock import MagicMock, patch
import pytest
from praisonaiagents.approval import reset_yaml_approved_tools, set_yaml_approved_tools
from praisonaiagents.permissions.doom_loop import DoomLoopDetector
from praisonaiagents.tools import url_safety
def test_doom_loop_tool_count_is_windowed():
detector = DoomLoopDetector(window_seconds=0.05, max_tool_calls=10)
# One call per window with fresh arguments is not a loop.
for i in range(8):
result = detector.record_and_check("read_file", {"path": f"f{i}"})
assert not result.is_loop, result.reason
time.sleep(0.06)
# Lifetime totals are still reported for stats.
assert detector.get_stats()["call_counts"]["read_file"] == 8
def test_doom_loop_tool_count_still_trips_within_window():
detector = DoomLoopDetector(window_seconds=60, max_tool_calls=10)
for i in range(5):
detector.record("read_file", {"path": f"f{i}"})
result = detector.check("read_file", {"path": "new"})
assert result.is_loop
assert "excessively" in result.reason
def _addrinfo(ip):
return [(socket.AF_INET, socket.SOCK_STREAM, 0, "", (ip, 0))]
@pytest.mark.parametrize("ip", ["100.100.100.200", "100.64.0.1"])
def test_url_safety_blocks_shared_address_space(ip, monkeypatch):
monkeypatch.delenv("ALLOW_LOCAL_CRAWL", raising=False)
with patch.object(url_safety.socket, "getaddrinfo", return_value=_addrinfo(ip)):
assert not url_safety.is_safe_http_url(f"http://{ip}/latest/meta-data/")
def test_url_safety_allows_public_address(monkeypatch):
monkeypatch.delenv("ALLOW_LOCAL_CRAWL", raising=False)
with patch.object(url_safety.socket, "getaddrinfo", return_value=_addrinfo("93.184.216.34")):
assert url_safety.is_safe_http_url("https://example.com/")
@pytest.fixture
def file_tools(tmp_path, monkeypatch):
pytest.importorskip("httpx")
from praisonaiagents.tools.file_tools import FileTools
monkeypatch.chdir(tmp_path)
monkeypatch.delenv("ALLOW_LOCAL_CRAWL", raising=False)
tools = FileTools()
monkeypatch.setattr(tools, "_require_workspace_access", lambda write=False: None)
monkeypatch.setattr(tools, "_validate_path", lambda p: str(tmp_path / p))
token = set_yaml_approved_tools(["download_file"])
try:
yield tools
finally:
reset_yaml_approved_tools(token)
@pytest.mark.parametrize("url", [
"http://localhost./x",
"http://169.254.169.254./x",
"http://0177.0.0.1/x",
])
def test_download_file_uses_shared_ssrf_guard(file_tools, url):
with patch("httpx.stream") as stream:
result = file_tools.download_file(url, "out.bin")
assert not result["success"]
stream.assert_not_called()
def test_download_file_ignores_allow_local_crawl(file_tools, monkeypatch):
monkeypatch.setenv("ALLOW_LOCAL_CRAWL", "true")
with patch("httpx.stream") as stream:
result = file_tools.download_file("http://127.0.0.1/x", "out.bin")
assert not result["success"]
stream.assert_not_called()
def test_download_file_fails_closed_on_unresolvable_host(file_tools):
with patch.object(url_safety.socket, "getaddrinfo", side_effect=socket.gaierror), \
patch("httpx.stream") as stream:
result = file_tools.download_file("http://does-not-resolve.invalid/x", "out.bin")
assert not result["success"]
stream.assert_not_called()
def test_download_file_enforces_byte_cap(file_tools, tmp_path, monkeypatch):
monkeypatch.setenv("PRAISONAI_MAX_DOWNLOAD_BYTES", "10000")
response = MagicMock()
response.headers = {}
response.iter_bytes.return_value = iter([b"x" * 8192] * 10)
ctx = MagicMock()
ctx.__enter__.return_value = response
with patch.object(url_safety.socket, "getaddrinfo", return_value=_addrinfo("93.184.216.34")), \
patch("httpx.stream", return_value=ctx):
result = file_tools.download_file("https://example.com/big", "big.bin")
assert not result["success"]
assert "exceeds" in result["error"]
assert not (tmp_path / "big.bin").exists()
def _stream_ctx(chunks):
response = MagicMock()
response.headers = {}
response.iter_bytes.return_value = iter(chunks)
ctx = MagicMock()
ctx.__enter__.return_value = response
return ctx
def test_download_file_cap_keeps_existing_file(file_tools, tmp_path, monkeypatch):
monkeypatch.setenv("PRAISONAI_MAX_DOWNLOAD_BYTES", "10000")
(tmp_path / "keep.bin").write_bytes(b"original")
with patch.object(url_safety.socket, "getaddrinfo", return_value=_addrinfo("93.184.216.34")), \
patch("httpx.stream", return_value=_stream_ctx([b"x" * 8192] * 10)):
result = file_tools.download_file("https://example.com/big", "keep.bin")
assert not result["success"]
assert (tmp_path / "keep.bin").read_bytes() == b"original"
assert sorted(p.name for p in tmp_path.iterdir()) == ["keep.bin"]
def test_download_file_success_replaces_destination(file_tools, tmp_path):
(tmp_path / "out.bin").write_bytes(b"old")
with patch.object(url_safety.socket, "getaddrinfo", return_value=_addrinfo("93.184.216.34")), \
patch("httpx.stream", return_value=_stream_ctx([b"new", b"data"])):
result = file_tools.download_file("https://example.com/f", "out.bin")
assert result["success"]
assert result["size"] == 7
assert (tmp_path / "out.bin").read_bytes() == b"newdata"
assert sorted(p.name for p in tmp_path.iterdir()) == ["out.bin"]
@@ -278,3 +278,58 @@ class TestTelemetryConfig:
if __name__ == "__main__":
pytest.main([__file__, "-v"])
def _fresh_python(code):
"""Run ``code`` in a fresh interpreter against this checkout; return stdout."""
import os
import subprocess
from pathlib import Path
root = str(Path(__file__).resolve().parents[2])
env = dict(os.environ, PYTHONPATH=root, PYTHONDONTWRITEBYTECODE="1")
out = subprocess.run([sys.executable, "-c", code], env=env, capture_output=True,
text=True, timeout=120, check=True)
return out.stdout.strip().splitlines()[-1]
class TestReplayStaysLazy:
"""PraisonAI Replay's graph builder must cost nothing until a trace is on."""
def test_package_import_does_not_load_the_graph_builder(self):
loaded = _fresh_python(
"import sys, praisonaiagents;"
"from praisonaiagents import Agent, AgentTeam, AgentFlow;"
"print('praisonaiagents.workflows.diagram' in sys.modules)"
)
assert loaded == "False"
def test_an_untraced_run_does_not_load_the_graph_builder(self):
loaded = _fresh_python(
"import sys\n"
"from praisonaiagents import AgentFlow\n"
"def step(ctx): return 'ok'\n"
"AgentFlow(steps=[step]).run('go');"
"print('praisonaiagents.workflows.diagram' in sys.modules)"
)
assert loaded == "False"
def test_a_traced_run_builds_the_graph(self):
has_graph = _fresh_python(
"from praisonaiagents import AgentFlow\n"
"from praisonaiagents.trace.context_events import ContextListSink, ContextTraceEmitter, trace_context\n"
"sink = ContextListSink()\n"
"def step(ctx): return 'ok'\n"
"with trace_context(ContextTraceEmitter(sink=sink, session_id='s')):\n"
" AgentFlow(steps=[step]).run('go')\n"
"print(sink.get_events()[0].data['graph']['schema'])"
)
assert has_graph == "praisonai.graph/1"
def test_package_import_does_not_load_heavy_optional_modules(self):
"""Deterministic stand-in for the <200 ms budget: no heavy optional deps."""
loaded = _fresh_python(
"import sys, praisonaiagents;"
"print(sorted(m for m in ('litellm', 'chromadb') if m in sys.modules))"
)
assert loaded == "[]"
@@ -0,0 +1,173 @@
"""Task and Workflow step output_file writes must stay inside the project root."""
import asyncio
import os
import pytest
from praisonaiagents import (
Agent,
AgentTeam,
StepResult,
Task,
Workflow,
WorkflowContext,
)
@pytest.fixture
def root(tmp_path, monkeypatch):
work = tmp_path / "work"
work.mkdir()
monkeypatch.chdir(work)
monkeypatch.delenv("PRAISONAI_PROJECT_ROOT", raising=False)
return work
def _team(output_file, create_directory=True):
agent = Agent(name="a", instructions="test")
task = Task(
description="d",
expected_output="e",
agent=agent,
output_file=output_file,
create_directory=create_directory,
)
return AgentTeam(agents=[agent], tasks=[task]), task
def _workflow(output_file):
def generate(ctx: WorkflowContext) -> StepResult:
return StepResult(output="report")
return Workflow(steps=[Task(name="gen", handler=generate, output_file=output_file)])
def test_task_output_file_traversal_blocked(root):
team, task = _team("../escaped/out.txt")
team.save_output_to_file(task, "PWNED")
assert not (root.parent / "escaped").exists()
def test_task_output_file_symlink_escape_blocked(root, tmp_path):
outside = tmp_path / "outside"
outside.mkdir()
os.symlink(outside, root / "link")
team, task = _team("link/out.txt")
team.save_output_to_file(task, "PWNED")
assert not (outside / "out.txt").exists()
def test_task_output_file_inside_root(root):
team, task = _team("sub/out.txt")
team.save_output_to_file(task, "héllo 世界")
assert (root / "sub" / "out.txt").read_text(encoding="utf-8") == "héllo 世界"
team, task = _team(str(root / "abs.txt"))
team.save_output_to_file(task, "ok")
assert (root / "abs.txt").read_text() == "ok"
@pytest.mark.skipif(os.name == "nt", reason="POSIX permission bits")
def test_task_output_file_overwrite_preserves_permissions(root):
target = root / "shared.txt"
target.write_text("old")
os.chmod(target, 0o644)
team, task = _team("shared.txt")
team.save_output_to_file(task, "new")
assert target.read_text() == "new"
assert target.stat().st_mode & 0o777 == 0o644
@pytest.mark.skipif(os.name == "nt", reason="POSIX hardlinks")
def test_task_output_file_hardlink_does_not_write_outside(root, tmp_path):
outside = tmp_path / "outside.txt"
outside.write_text("secret")
os.link(outside, root / "linked.txt")
team, task = _team("linked.txt")
team.save_output_to_file(task, "PWNED")
assert (root / "linked.txt").read_text() == "PWNED"
assert outside.read_text() == "secret"
@pytest.mark.skipif(os.name == "nt", reason="POSIX hardlinks")
def test_task_output_file_hardlink_keeps_mode_under_umask(root, tmp_path):
outside = tmp_path / "outside.txt"
outside.write_text("secret")
os.chmod(outside, 0o664)
os.link(outside, root / "linked.txt")
team, task = _team("linked.txt")
old_umask = os.umask(0o077)
try:
team.save_output_to_file(task, "new")
finally:
os.umask(old_umask)
assert (root / "linked.txt").stat().st_mode & 0o777 == 0o664
assert outside.read_text() == "secret"
@pytest.mark.skipif(os.name == "nt" or os.geteuid() == 0, reason="POSIX permission bits")
def test_task_output_file_overwrite_in_readonly_directory(root):
(root / "ro").mkdir()
target = root / "ro" / "out.txt"
target.write_text("old")
os.chmod(root / "ro", 0o555)
try:
team, task = _team("ro/out.txt")
team.save_output_to_file(task, "new")
finally:
os.chmod(root / "ro", 0o755)
assert target.read_text() == "new"
def test_task_output_file_respects_create_directory(root):
team, task = _team("missing/out.txt", create_directory=False)
team.save_output_to_file(task, "ok")
assert not (root / "missing").exists()
def test_task_output_file_project_root_override(root, tmp_path, monkeypatch):
monkeypatch.setenv("PRAISONAI_PROJECT_ROOT", str(tmp_path))
team, task = _team(str(tmp_path / "shared" / "out.txt"))
team.save_output_to_file(task, "ok")
assert (tmp_path / "shared" / "out.txt").read_text() == "ok"
def test_workflow_output_file_input_traversal_blocked(root):
_workflow("reports/{{input}}.md").start("../../x")
assert not (root.parent / "x.md").exists()
_workflow("reports/{{input}}.md").start("ok")
assert (root / "reports" / "ok.md").read_text() == "report"
def test_workflow_async_output_file_input_traversal_blocked(root):
asyncio.run(_workflow("reports/{{input}}.md").arun("../../x"))
assert not (root.parent / "x.md").exists()
asyncio.run(_workflow("reports/{{input}}.md").arun("ok"))
assert (root / "reports" / "ok.md").read_text() == "report"
@pytest.mark.skipif(not os.environ.get("OPENAI_API_KEY"), reason="OPENAI_API_KEY not set")
def test_task_output_file_traversal_blocked_real_run(root):
team, _ = _team("../escaped.txt")
team.start()
assert not (root.parent / "escaped.txt").exists()
@pytest.mark.skipif(os.name == "nt", reason="POSIX hardlinks")
def test_task_output_file_hardlink_group_kept_or_bits_dropped(root, tmp_path, monkeypatch):
outside = tmp_path / "outside.txt"
outside.write_text("secret")
os.chmod(outside, 0o660)
os.link(outside, root / "linked.txt")
def deny(*args):
raise PermissionError
monkeypatch.setattr(os, "fchown", deny)
team, task = _team("linked.txt")
team.save_output_to_file(task, "new")
assert (root / "linked.txt").read_text() == "new"
assert (root / "linked.txt").stat().st_mode & 0o777 == 0o600
assert outside.read_text() == "secret"
@@ -0,0 +1,179 @@
"""Regression tests for #5980.
- A second AgentTeam.start()/astart() must re-execute tasks, not return stale output.
- RAG.retrieve(top_k=...) must not mutate the shared RAGConfig.
- SmartRetriever must over-fetch before post-filtering, fail closed on a bad
path_filter regex, and not share store errors across calls via instance state.
"""
import asyncio
import threading
import pytest
from praisonaiagents import Agent, AgentTeam, Task
from praisonaiagents.knowledge.query_engine import SubQuestionEngine
from praisonaiagents.rag.models import RAGConfig
from praisonaiagents.rag.pipeline import RAG
from praisonaiagents.rag.retriever import SmartRetriever
def _team():
calls = []
agent = Agent(name="a", instructions="x", llm="gpt-4o-mini")
def chat(prompt, **kw):
calls.append(prompt)
return f"answer#{len(calls)}"
async def achat(prompt, **kw):
return chat(prompt)
agent.chat = chat
agent.achat = achat
task = Task(name="t1", description="Summarise the ticket", expected_output="e", agent=agent)
return AgentTeam(agents=[agent], tasks=[task], process="sequential"), task, calls
def test_second_start_reexecutes_and_drops_previous_content():
team, task, calls = _team()
assert team.start("ticket A", output="silent") == "answer#1"
assert team.start("ticket B", output="silent") == "answer#2"
assert len(calls) == 2
assert task.context == ["ticket B"]
def test_second_astart_reexecutes():
team, _, calls = _team()
async def run():
return await team.astart(), await team.astart()
assert asyncio.run(run()) == ("answer#1", "answer#2")
assert len(calls) == 2
def test_restored_checkpoint_is_resumed_not_reset():
team, task, calls = _team()
team.start(output="silent")
snapshot = team._serialisable_task_state()
assert team._restore_serialised_task_state(snapshot) == 1
team.start(output="silent")
assert len(calls) == 1 # completed task restored -> skipped
assert task.status == "completed"
def test_rerun_keeps_caller_defined_task_variables():
team, task, calls = _team()
task.description = "Summarise {{ticket}}"
task.variables = {"ticket": "T-1"}
team.start(output="silent")
team.start(output="silent")
assert task.variables == {"ticket": "T-1"}
assert all("T-1" in str(p) and "{{ticket}}" not in str(p) for p in calls)
def test_rerun_repropagates_current_team_variables():
team, task, calls = _team()
task.description = "Summarise {{ticket}}"
team.variables = {"ticket": "T-1"}
team.start(output="silent")
team.variables = {"ticket": "T-2"}
team.start(output="silent")
assert "T-2" in str(calls[1])
def test_team_variables_repropagate_after_batch():
team, task, calls = _team()
task.description = "Summarise {{ticket}}"
team.variables = {"ticket": "T-1"}
team.start(output="silent")
team.start_for_each([{"ticket": "X"}])
team.variables = {"ticket": "T-2"}
team.start(output="silent")
assert "T-2" in str(calls[-1])
def test_fresh_run_after_resume_drops_earlier_content():
team, task, calls = _team()
team.start("ticket A", output="silent")
team._restore_serialised_task_state(team._serialisable_task_state())
team.start(output="silent") # resume: completed task skipped
team.start("ticket B", output="silent")
assert task.context == ["ticket B"]
def test_rag_retrieve_override_does_not_mutate_config():
# Hold the top_k=1 call inside search() until a default call has finished,
# so the default call is guaranteed to run while the override is active.
override_in_search = threading.Event()
default_done = threading.Event()
class Knowledge:
def search(self, query, **kw):
if query == "override":
override_in_search.set()
default_done.wait(2)
return [{"text": f"d{i}", "score": 1.0, "metadata": {}} for i in range(20)]
rag = RAG(knowledge=Knowledge(), config=RAGConfig(top_k=5))
out = {}
ta = threading.Thread(target=lambda: out.setdefault("a", rag.retrieve("override", top_k=1)))
ta.start()
assert override_in_search.wait(2)
out["b"] = rag.retrieve("default")
default_done.set()
ta.join()
assert rag.config.top_k == 5
assert out["a"].metadata["top_k"] == 1
assert out["b"].metadata["top_k"] == 5
class _MixedStore:
def search(self, query, limit=5, **kw):
docs = [{"text": f"p{i}", "metadata": {"filename": f"p{i}.pdf"}, "score": 1 - i / 100}
for i in range(10)]
docs += [{"text": f"m{i}", "metadata": {"filename": f"m{i}.md"}, "score": 0.5}
for i in range(3)]
return docs[:limit]
def test_filters_over_fetch_before_truncation():
result = SmartRetriever(_MixedStore()).retrieve("q", top_k=5, include_glob=["*.md"])
assert [c["text"] for c in result.chunks] == ["m0", "m1", "m2"]
def test_invalid_path_filter_fails_closed():
with pytest.raises(ValueError):
SmartRetriever(_MixedStore()).retrieve("q", path_filter="([unclosed")
def test_store_error_is_not_shared_across_concurrent_calls():
# Hold the good call inside search() until the failing call has fully
# recorded its error, the interleaving that leaked it via instance state.
good_in_search = threading.Event()
bad_done = threading.Event()
class Store:
def search(self, query, **kw):
if query == "bad":
raise RuntimeError("down")
good_in_search.set()
bad_done.wait(2)
return [{"text": "ok", "metadata": {}, "score": 1.0}]
retriever = SmartRetriever(Store())
out = {}
tg = threading.Thread(target=lambda: out.setdefault("good", retriever.retrieve("good")))
tg.start()
assert good_in_search.wait(2)
out["bad"] = retriever.retrieve("bad")
bad_done.set()
tg.join()
assert out["bad"].retrieval_failed is True
assert out["good"].retrieval_failed is False
def test_sub_question_engine_accepts_smart_retriever():
result = SubQuestionEngine().query("what is m?", retriever=SmartRetriever(_MixedStore()))
assert result.sources
@@ -5,11 +5,13 @@ import pytest
from praisonaiagents.tools import github_tools
def _fake_git_factory(responses, calls):
def _fake_git_factory(responses, calls, cwds=None):
"""Build a fake subprocess.run that records calls and serves canned output."""
cwds = cwds if cwds is not None else []
def fake_run(cmd, check=False, capture_output=False, text=False):
def fake_run(cmd, check=False, capture_output=False, text=False, cwd=None):
calls.append(cmd)
cwds.append(cwd)
assert cmd[0] == "git"
key = tuple(cmd[1:])
# Match on a prefix of the git args
@@ -256,3 +258,50 @@ def test_create_branch_accepts_slash_names(monkeypatch):
checkouts = [c for c in calls if c[:2] == ["git", "checkout"]]
assert checkouts, "expected a checkout for a valid branch name"
assert ["git", "checkout", "-B", "feature/new-thing"] in checkouts
def test_repo_path_used_as_cwd_for_every_git_call(monkeypatch):
responses = {
("status", "--porcelain"): ("M file\n", 0),
("rev-parse", "--abbrev-ref", "HEAD"): ("praisonai/work\n", 0),
("symbolic-ref", "refs/remotes/origin/HEAD"): ("refs/remotes/origin/main\n", 0),
}
calls, cwds = [], []
monkeypatch.setattr(subprocess, "run", _fake_git_factory(responses, calls, cwds))
result = _run_tool(github_tools.github_commit_and_push, "fix", repo_path="/repo")
assert "Successfully" in result
assert calls and all(c == "/repo" for c in cwds)
def test_never_stages_untracked_with_add_dot(monkeypatch):
responses = {
("status", "--porcelain"): ("M file\n", 0),
("rev-parse", "--abbrev-ref", "HEAD"): ("praisonai/work\n", 0),
("symbolic-ref", "refs/remotes/origin/HEAD"): ("refs/remotes/origin/main\n", 0),
}
calls = _call(monkeypatch, responses)
_run_tool(github_tools.github_commit_and_push, "fix", paths=["new.py"])
adds = [c for c in calls if c[:2] == ["git", "add"]]
# scoped to cwd so a subdirectory call cannot stage sibling edits
assert ["git", "add", "-u", "--", "."] in adds
assert ["git", "add", "-u"] not in adds
assert ["git", "add", "--", "new.py"] in adds
assert ["git", "add", "."] not in adds
# untracked files are not considered when checking for changes
status = [c for c in calls if c[:2] == ["git", "status"]]
assert all("--untracked-files=no" in c for c in status)
def test_refusal_leaves_index_untouched(monkeypatch):
responses = {
("status", "--porcelain"): ("M file\n", 0),
("rev-parse", "--abbrev-ref", "HEAD"): ("release/v2\n", 0),
("symbolic-ref", "refs/remotes/origin/HEAD"): ("refs/remotes/origin/main\n", 0),
("config", "user.email"): ("[email protected]\n", 0),
("merge-base", "origin/main", "HEAD"): ("abc\n", 0),
("log", "--format=%ae", "abc..HEAD"): ("[email protected]\n", 0),
}
calls = _call(monkeypatch, responses)
result = _run_tool(github_tools.github_commit_and_push, "fix", branch="release/v2")
assert "Error" in result
assert not [c for c in calls if c[:2] == ["git", "add"]]
@@ -0,0 +1,939 @@
"""PraisonAI Replay: run-structure events on the context trace (schema 1.1).
A replay can only explain a run if the trace says which run, which task or
step, which graph node and which enclosing span every event belongs to, and if
concurrent branches cannot scramble that. These cover the event schema, the
span/branch bookkeeping, and every place the SDK now records what happened:
hand-offs, team tasks, flow steps, manager decisions, approvals and the
LiteLLM call path. No test here reaches a model.
"""
import asyncio
import time
import types
import pytest
from praisonaiagents.trace.context_events import (
ContextEvent,
ContextEventType,
ContextListSink,
ContextTraceEmitter,
_run_scope,
copy_context_to_callable,
get_context_emitter,
trace_context,
)
@pytest.fixture
def recorder():
"""A live emitter installed for the test; yields its sink."""
sink = ContextListSink()
emitter = ContextTraceEmitter(sink=sink, session_id="replay-test", enabled=True)
with trace_context(emitter):
yield sink
def _types(sink):
return [e.event_type.value for e in sink.get_events()]
def _of(sink, event_type):
return [e for e in sink.get_events() if e.event_type.value == event_type]
def _by_seq(sink):
return {e.sequence_num: e for e in sink.get_events()}
# ---------------------------------------------------------------------------
# Schema
# ---------------------------------------------------------------------------
class TestSchema:
def test_schema_version_is_1_1(self):
from praisonaiagents.trace.context_events import CONTEXT_SCHEMA_VERSION
assert CONTEXT_SCHEMA_VERSION == "1.1"
def test_new_fields_round_trip(self):
event = ContextEvent(
event_type=ContextEventType.TASK_START,
timestamp=1.5,
session_id="s",
run_id="run-1",
parent_seq=3,
node_id="task:research",
)
data = event.to_dict()
assert data["run_id"] == "run-1"
assert data["parent_seq"] == 3
assert data["node_id"] == "task:research"
back = ContextEvent.from_dict(data)
assert (back.run_id, back.parent_seq, back.node_id) == ("run-1", 3, "task:research")
assert back.event_type == ContextEventType.TASK_START
def test_new_fields_are_omitted_when_none(self):
data = ContextEvent(ContextEventType.SESSION_START, 1.0, "s").to_dict()
for key in ("run_id", "parent_seq", "node_id", "branch_id"):
assert key not in data
def test_a_1_0_event_still_loads(self):
legacy = {
"schema_version": "1.0",
"event_type": "agent_start",
"timestamp": 10.0,
"session_id": "old",
"agent_name": "Writer",
"sequence_num": 4,
"messages_count": 0,
"tokens_used": 0,
"tokens_budget": 0,
"data": {"role": "w"},
"prompt_tokens": 0,
"completion_tokens": 0,
"cost_usd": 0.0,
}
event = ContextEvent.from_dict(legacy)
assert event.event_type == ContextEventType.AGENT_START
assert event.sequence_num == 4
assert event.run_id is None and event.parent_seq is None and event.node_id is None
def test_an_unknown_event_type_keeps_its_raw_value(self):
event = ContextEvent.from_dict({"event_type": "hologram_beamed", "session_id": "s"})
assert event.event_type == "hologram_beamed"
assert event.event_type.value == "hologram_beamed" # Enum-style callers still work
assert event.to_dict()["event_type"] == "hologram_beamed"
def test_control_a_known_event_type_is_still_the_enum(self):
event = ContextEvent.from_dict({"event_type": "tool_call_end", "session_id": "s"})
assert event.event_type is ContextEventType.TOOL_CALL_END
def test_new_event_types_have_contract_values(self):
assert {t.value for t in ContextEventType} >= {
"workflow_start", "workflow_end", "task_start", "task_end",
"step_start", "step_end", "approval_requested", "approval_decided",
}
# ---------------------------------------------------------------------------
# Spans, sequence numbers, branches, run ids
# ---------------------------------------------------------------------------
class TestSpans:
def test_parent_seq_nests_and_end_points_at_its_start(self, recorder):
emitter = get_context_emitter()
emitter.workflow_start("team", "t", "sequential") # 0
emitter.task_start("research", node_id="task:research") # 1
emitter.agent_start("Writer") # 2
emitter.message_added("Writer", "user", "hi", 1, 1) # 3 point
emitter.agent_end("Writer") # 4
emitter.task_end("research", "completed", node_id="task:research") # 5
emitter.workflow_end() # 6
e = _by_seq(recorder)
assert e[0].parent_seq is None
assert e[1].parent_seq == 0
assert e[2].parent_seq == 1
assert e[3].parent_seq == 2
assert e[4].parent_seq == 2
assert e[5].parent_seq == 1
assert e[6].parent_seq == 0
def test_a_start_left_open_is_closed_by_its_parent_end(self, recorder):
emitter = get_context_emitter()
emitter.workflow_start("team", "t", "sequential")
emitter.tool_call_start("Writer", "search") # never ended (exception path)
emitter.workflow_end()
emitter.message_added("x", "user", "after", 1, 1)
assert recorder.get_events()[-1].parent_seq is None
def test_spans_of_another_emitter_do_not_leak(self, recorder):
other_sink = ContextListSink()
other = ContextTraceEmitter(sink=other_sink, session_id="other")
get_context_emitter().workflow_start("team", "t", "sequential")
other.message_added("x", "user", "hi", 1, 1)
assert other_sink.get_events()[0].parent_seq is None
def test_run_scope_stamps_run_id_and_nested_scopes_inherit(self, recorder):
emitter = get_context_emitter()
with _run_scope("outer") as outer:
with _run_scope("inner") as inner:
emitter.message_added("a", "user", "x", 1, 1)
emitter.message_added("a", "user", "y", 1, 1)
assert outer == inner == "outer"
first, second = recorder.get_events()
assert first.run_id == "outer"
assert second.run_id is None
def test_eight_concurrent_branches_keep_their_own_branch_and_parent(self, recorder):
import concurrent.futures
emitter = get_context_emitter()
emitter.step_start("parallel", pattern="parallel", node_id="step:parallel")
fork_seq = recorder.get_events()[-1].sequence_num
def branch(idx):
trace = get_context_emitter()
trace.set_branch(f"parallel_{idx}")
try:
for _ in range(20):
trace.step_start(f"b{idx}", node_id=f"step:b{idx}")
time.sleep(0.0005)
trace.step_end(f"b{idx}", "completed", node_id=f"step:b{idx}")
finally:
trace.clear_branch()
with concurrent.futures.ThreadPoolExecutor(max_workers=8) as pool:
futures = [pool.submit(copy_context_to_callable(lambda i=i: branch(i))) for i in range(8)]
for future in futures:
future.result()
emitter.step_end("parallel", "completed", node_id="step:parallel")
events = recorder.get_events()
seqs = [e.sequence_num for e in events]
assert seqs == sorted(seqs) == list(range(len(events))) # unique, append order
by_seq = {e.sequence_num: e for e in events}
for e in events[1:-1]:
idx = int(e.node_id.split(":b")[1])
assert e.branch_id == f"parallel_{idx}"
if e.event_type == ContextEventType.STEP_START:
assert e.parent_seq == fork_seq
else:
start = by_seq[e.parent_seq]
assert start.node_id == e.node_id and start.branch_id == e.branch_id
assert events[-1].parent_seq == fork_seq
assert events[-1].branch_id is None
# ---------------------------------------------------------------------------
# AgentFlow steps
# ---------------------------------------------------------------------------
def _handler(name, output=None):
def run(ctx):
return output if output is not None else name
run.__name__ = name
return run
class TestFlowSteps:
def test_flow_records_workflow_and_step_events_with_graph(self, recorder):
from praisonaiagents.workflows.workflows import AgentFlow
flow = AgentFlow(name="demo", steps=[_handler("draft"), _handler("polish")])
flow.run("go")
types_ = _types(recorder)
assert types_[0] == "workflow_start" and types_[-1] == "workflow_end"
start = recorder.get_events()[0]
assert start.data["kind"] == "flow" and start.data["name"] == "demo"
assert start.data["graph"]["schema"] == "praisonai.graph/1"
steps = _of(recorder, "step_start")
assert [s.node_id for s in steps] == ["step:draft", "step:polish"]
assert all(s.parent_seq == start.sequence_num for s in steps)
run_ids = {e.run_id for e in recorder.get_events()}
assert len(run_ids) == 1 and None not in run_ids
assert [e.data["status"] for e in _of(recorder, "step_end")] == ["completed", "completed"]
assert recorder.get_events()[-1].data["status"] == "completed"
def test_parallel_with_eight_branches(self, recorder):
from praisonaiagents.workflows.workflows import AgentFlow, Parallel
def slow(name):
def run(ctx):
time.sleep(0.002)
return name
run.__name__ = name
return run
flow = AgentFlow(steps=[Parallel(steps=[slow(f"b{i}") for i in range(8)])])
flow.run("go")
events = recorder.get_events()
seqs = [e.sequence_num for e in events]
assert seqs == list(range(len(events)))
parallel = [e for e in _of(recorder, "step_start") if e.data.get("pattern") == "parallel"]
assert len(parallel) == 1 and parallel[0].node_id == "step:parallel"
branches = [e for e in _of(recorder, "step_start") if e.node_id != "step:parallel"]
assert sorted(e.branch_id for e in branches) == sorted(f"parallel_{i}" for i in range(8))
assert {e.parent_seq for e in branches} == {parallel[0].sequence_num}
by_seq = _by_seq(recorder)
for end in _of(recorder, "step_end"):
assert by_seq[end.parent_seq].node_id == end.node_id
assert {e.node_id for e in branches} == {f"step:b{i}" for i in range(8)}
def test_route_and_if_record_the_branch_taken(self, recorder):
from praisonaiagents.workflows.workflows import AgentFlow, If, Route
flow = AgentFlow(steps=[
_handler("classify", "this is urgent"),
Route(routes={"urgent": [_handler("page")], "default": [_handler("queue")]}),
If(condition="{{missing}} == yes", then_steps=[_handler("a")], else_steps=[_handler("b")]),
])
flow.run("go")
ends = {e.node_id: e for e in _of(recorder, "step_end")}
assert ends["step:route"].data["route"] == "urgent"
assert ends["step:if"].data["route"] == "false"
assert "step:page" in ends and "step:queue" not in ends
assert "step:b" in ends and "step:a" not in ends
def test_skipped_failed_and_cached_steps(self, recorder):
from praisonaiagents.task.task import Task
from praisonaiagents.workflows.workflows import AgentFlow
def boom(ctx):
raise RuntimeError("nope")
skip = Task(name="gated", handler=_handler("gated"), should_run=lambda ctx: False)
fail = Task(name="boom", handler=boom, max_retries=0, on_error="continue")
flow = AgentFlow(steps=[_handler("cached_step"), skip, fail], cache=True)
flow.run("go")
statuses = {e.node_id: e.data["status"] for e in _of(recorder, "step_end")}
assert statuses == {"step:cached_step": "completed", "step:gated": "skipped", "step:boom": "failed"}
recorder.clear()
flow.run("go")
statuses = {e.node_id: e.data["status"] for e in _of(recorder, "step_end")}
assert statuses["step:cached_step"] == "cached"
def test_nested_flow_inherits_the_outer_run_id(self, recorder):
from praisonaiagents.workflows.workflows import AgentFlow
inner = AgentFlow(name="inner", steps=[_handler("fetch")])
def nested(ctx):
return inner.run("sub")["output"]
outer = AgentFlow(name="outer", steps=[_handler("first"), nested])
outer.run("go")
starts = _of(recorder, "workflow_start")
assert [s.data["name"] for s in starts] == ["outer", "inner"]
assert len({e.run_id for e in recorder.get_events()}) == 1
step = [e for e in _of(recorder, "step_start") if e.node_id == "step:nested"][0]
assert starts[1].parent_seq == step.sequence_num
def test_team_inside_a_flow_inherits_the_flow_run_id(self, recorder, monkeypatch):
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
from praisonaiagents.workflows.workflows import AgentFlow
monkeypatch.setattr(AgentTeam, "execute_task", _fake_execute({}))
writer = Agent(name="Writer", instructions="write")
team = _team([Task(name="draft", description="d", agent=writer)], agents=[writer])
def run_team(ctx):
return team.start()
AgentFlow(name="outer", steps=[run_team]).run("go")
run_ids = {e.run_id for e in recorder.get_events()}
assert len(run_ids) == 1 and team.run_id not in run_ids
# ---------------------------------------------------------------------------
# AgentTeam tasks, manager decisions, human review
# ---------------------------------------------------------------------------
def _team(tasks, process="sequential", agents=None):
from praisonaiagents import Agent
from praisonaiagents.agents.agents import AgentTeam
agents = agents or [Agent(name="Writer", instructions="write")]
return AgentTeam(agents=agents, tasks=tasks, process=process, output="silent")
def _fake_execute(outputs):
"""Stand-in for AgentTeam.execute_task: no model, scripted results."""
from praisonaiagents.main import TaskOutput
def execute(self, task_id):
task = self.tasks[task_id]
raw = outputs.get(task.name, "done")
if raw is None:
return None
out = TaskOutput(description=task.description, raw=raw, agent=task.agent.name)
task.result = out
return out
return execute
class TestTeamTasks:
def test_task_completed_skipped_and_failed(self, recorder, monkeypatch):
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
writer = Agent(name="Writer", instructions="write")
done = Task(name="draft", description="Draft it", agent=writer)
skipped = Task(name="optional", description="Maybe", agent=writer, should_run=lambda ctx: False)
failed = Task(name="flaky", description="Never finishes", agent=writer, max_retries=1, retry_delay=0)
monkeypatch.setattr(AgentTeam, "execute_task", _fake_execute({"flaky": None}))
team = _team([done, skipped, failed], agents=[writer])
team.start()
ends = {e.node_id: e for e in _of(recorder, "task_end")}
assert ends["task:draft"].data["status"] == "completed"
assert ends["task:draft"].data["output_preview"] == "done"
assert ends["task:optional"].data["status"] == "skipped"
assert ends["task:flaky"].data["status"] == "failed"
starts = {e.node_id: e for e in _of(recorder, "task_start")}
assert starts["task:draft"].data["description_preview"] == "Draft it"
assert starts["task:draft"].data["agent"] == "Writer"
for node_id, end in ends.items():
assert end.parent_seq == starts[node_id].sequence_num
wf_start = _of(recorder, "workflow_start")[0]
assert wf_start.data["kind"] == "team" and wf_start.data["graph"]["kind"] == "team"
assert {s.parent_seq for s in starts.values()} == {wf_start.sequence_num}
assert _of(recorder, "workflow_end")[0].data["status"] == "failed"
assert {e.run_id for e in recorder.get_events()} == {team.run_id}
def test_async_team_records_tasks(self, recorder, monkeypatch):
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
async def aexecute(self, task_id):
return _fake_execute({})(self, task_id)
writer = Agent(name="Writer", instructions="write")
task = Task(name="draft", description="Draft", agent=writer, async_execution=True)
monkeypatch.setattr(AgentTeam, "aexecute_task", aexecute)
team = _team([task], agents=[writer])
asyncio.run(team.astart())
assert [e.data["status"] for e in _of(recorder, "task_end")] == ["completed"]
assert _types(recorder)[0] == "workflow_start"
assert _types(recorder)[-1] == "workflow_end"
def test_manager_choice_is_a_delegate_handoff(self, recorder, monkeypatch):
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
from praisonaiagents.process.manager_schema import ManagerInstructions
from praisonaiagents.process.process import Process
writer = Agent(name="Writer", instructions="write")
editor = Agent(name="Editor", instructions="edit")
t1 = Task(name="draft", description="Draft", agent=writer)
t2 = Task(name="review", description="Review", agent=writer)
script = iter([
ManagerInstructions(task_id=0, agent_name="Writer", action="execute"),
ManagerInstructions(task_id=1, agent_name="Editor", action="execute"),
])
monkeypatch.setattr(
Process, "_get_manager_instructions_with_fallback",
lambda self, *a: next(script),
)
monkeypatch.setattr(AgentTeam, "execute_task", _fake_execute({}))
team = _team([t1, t2], process="hierarchical", agents=[writer, editor])
team.start()
delegates = [e for e in _of(recorder, "agent_handoff") if e.data["kind"] == "delegate"]
assert [(d.agent_name, d.data["to_agent"], d.node_id) for d in delegates] == [
("Manager", "Writer", "task:draft"),
("Manager", "Editor", "task:review"),
]
summary = delegates[1].data["context_passed"]["task_status"]
assert [(s["name"], s["status"]) for s in summary] == [("draft", "completed"), ("review", "not started")]
manager = [e for e in _of(recorder, "task_start") if e.node_id == "manager:Manager"]
assert len(manager) == 1
def test_human_review_records_an_approval_pair(self, recorder):
from praisonaiagents import Agent, Task
from praisonaiagents.approval import ApprovalDecision, get_approval_registry
from praisonaiagents.main import TaskOutput
class Reviewer:
def request_approval_sync(self, request):
return ApprovalDecision(approved=True, reason="looks good", approver="ana")
registry = get_approval_registry()
previous = registry.get_backend()
registry.set_backend(Reviewer())
try:
writer = Agent(name="Writer", instructions="write")
task = Task(name="draft", description="Draft", agent=writer, human_input=True)
team = _team([task], agents=[writer])
out = TaskOutput(description="Draft", raw="api_key=sk-secret123456 text", agent="Writer")
team._apply_human_review(task, 0, out)
finally:
registry.set_backend(previous)
requested, decided = _of(recorder, "approval_requested"), _of(recorder, "approval_decided")
assert len(requested) == len(decided) == 1
assert requested[0].data["kind"] == "task_output_review"
assert requested[0].node_id == "task:draft"
assert "sk-secret123456" not in str(requested[0].data["args"])
assert decided[0].parent_seq == requested[0].sequence_num
assert decided[0].data["approved"] is True and decided[0].data["approver"] == "ana"
assert decided[0].data["approval_id"] == requested[0].data["approval_id"]
# ---------------------------------------------------------------------------
# Tool-call approvals
# ---------------------------------------------------------------------------
class TestToolApprovals:
def _registry(self, backend):
from praisonaiagents.approval.registry import ApprovalRegistry
registry = ApprovalRegistry()
registry.set_backend(backend)
registry.add_requirement("delete_file", risk_level="high")
return registry
def test_sync_approval_records_request_and_decision(self, recorder, monkeypatch):
from praisonaiagents.approval import ApprovalDecision
monkeypatch.delenv("PRAISONAI_AUTO_APPROVE", raising=False)
class Deny:
def request_approval_sync(self, request):
return ApprovalDecision(approved=False, reason="not today", approver="ops")
registry = self._registry(Deny())
decision = registry.approve_sync("Writer", "delete_file", {"path": "/x", "password": "hunter2"})
assert decision.approved is False
requested, decided = _of(recorder, "approval_requested"), _of(recorder, "approval_decided")
assert len(requested) == len(decided) == 1
assert requested[0].data["tool"] == "delete_file"
assert requested[0].data["risk"] == "high"
assert requested[0].data["kind"] == "tool_call"
assert requested[0].node_id == "tool:Writer/delete_file"
assert "hunter2" not in str(requested[0].data["args"])
assert decided[0].parent_seq == requested[0].sequence_num
assert decided[0].data == {
"approval_id": requested[0].data["approval_id"],
"approved": False, "reason": "not today", "approver": "ops", "modified": False,
}
def test_async_approval_records_request_and_decision(self, recorder, monkeypatch):
from praisonaiagents.approval import ApprovalDecision
monkeypatch.delenv("PRAISONAI_AUTO_APPROVE", raising=False)
class Allow:
async def request_approval(self, request):
return ApprovalDecision(approved=True, reason="ok", modified_args={"path": "/y"})
registry = self._registry(Allow())
asyncio.run(registry.approve_async("Writer", "delete_file", {"path": "/x"}))
decided = _of(recorder, "approval_decided")
assert len(decided) == 1 and decided[0].data["modified"] is True
assert decided[0].parent_seq == _of(recorder, "approval_requested")[0].sequence_num
def test_control_the_fast_path_records_nothing(self, recorder):
from praisonaiagents.approval.registry import ApprovalRegistry
ApprovalRegistry().approve_sync("Writer", "read_file", {}) # not required
assert _of(recorder, "approval_requested") == []
# ---------------------------------------------------------------------------
# Hand-offs
# ---------------------------------------------------------------------------
class TestHandoffs:
def _pair(self):
from praisonaiagents import Agent
source = Agent(name="Router", instructions="route")
target = Agent(name="Billing", instructions="bill")
target.chat = lambda *a, **k: "handled"
async def achat(*a, **k):
return "handled"
target.achat = achat
return source, target
def _one_handoff(self, sink):
handoffs = _of(sink, "agent_handoff")
assert len(handoffs) == 1, [h.data for h in handoffs]
h = handoffs[0]
assert (h.agent_name, h.data["from_agent"], h.data["to_agent"]) == ("Router", "Router", "Billing")
assert h.data["kind"] == "handoff"
assert h.node_id == "agent:Billing"
return h
def test_programmatic(self, recorder):
from praisonaiagents.agent.handoff import Handoff
source, target = self._pair()
Handoff(agent=target).execute_programmatic(source, "refund order 7")
assert self._one_handoff(recorder).data["reason"] == "refund order 7"
def test_async(self, recorder):
from praisonaiagents.agent.handoff import Handoff
source, target = self._pair()
asyncio.run(Handoff(agent=target).execute_async(source, "refund order 7"))
self._one_handoff(recorder)
def test_tool_function(self, recorder):
from praisonaiagents.agent.handoff import Handoff
source, target = self._pair()
tool = Handoff(agent=target).to_tool_function(source)
tool(task="refund order 7")
h = self._one_handoff(recorder)
assert h.data["context_passed"]["args"] == {"task": "refund order 7"}
def test_typed_programmatic_and_async(self, recorder):
from pydantic import BaseModel
from praisonaiagents.agent.handoff import TypedHandoff
class Refund(BaseModel):
order: int
source, target = self._pair()
TypedHandoff(agent=target, input_schema=Refund).execute_programmatic(source, Refund(order=7))
self._one_handoff(recorder)
recorder.clear()
asyncio.run(TypedHandoff(agent=target, input_schema=Refund).execute_async(source, Refund(order=7)))
self._one_handoff(recorder)
def test_control_a_refused_handoff_records_nothing(self, recorder):
from praisonaiagents.agent.handoff import Handoff, HandoffConfig, _clear_handoff_chain, _push_handoff
source, target = self._pair()
_push_handoff("Billing") # Billing already in the chain -> cycle
try:
with pytest.raises(Exception):
Handoff(agent=target, config=HandoffConfig(detect_cycles=True)).execute_programmatic(source, "x")
finally:
_clear_handoff_chain()
assert _of(recorder, "agent_handoff") == []
# ---------------------------------------------------------------------------
# LiteLLM path
# ---------------------------------------------------------------------------
def _response(text="hello", prompt=11, completion=3):
message = types.SimpleNamespace(content=text, tool_calls=None)
choice = types.SimpleNamespace(message=message, finish_reason="stop", delta=None)
usage = types.SimpleNamespace(prompt_tokens=prompt, completion_tokens=completion, total_tokens=prompt + completion)
return types.SimpleNamespace(choices=[choice], usage=usage, model="gpt-4o-mini")
def _chunk(text=None, finish=None, usage=None):
delta = types.SimpleNamespace(content=text, tool_calls=None)
choice = types.SimpleNamespace(delta=delta, finish_reason=finish)
return types.SimpleNamespace(choices=[choice], usage=usage)
@pytest.fixture
def fake_litellm(monkeypatch):
import litellm
import praisonaiagents.llm.llm as llm_module
monkeypatch.setattr(llm_module, "check_model_request", lambda *a, **k: None)
calls = []
def completion(**params):
calls.append(params)
if params.get("stream"):
usage = types.SimpleNamespace(prompt_tokens=5, completion_tokens=2)
return iter([_chunk("hel"), _chunk("lo", finish="stop"), _chunk(usage=usage)])
return _response()
async def acompletion(**params):
calls.append(params)
if params.get("stream"):
async def gen():
for c in [_chunk("a"), _chunk("b", finish="stop")]:
yield c
return gen()
return _response("async")
monkeypatch.setattr(litellm, "completion", completion)
monkeypatch.setattr(litellm, "acompletion", acompletion)
return calls
class TestLiteLLMPath:
def _llm(self):
from praisonaiagents.llm.llm import LLM
return LLM(model="gpt-4o-mini")
def test_non_streaming_call_records_request_and_response(self, recorder, fake_litellm):
llm = self._llm()
emitter = get_context_emitter()
emitter.agent_start("Writer")
llm._completion_with_retry(model="gpt-4o-mini", messages=[{"role": "user", "content": "hi"}])
emitter.agent_end("Writer")
request, response = _of(recorder, "llm_request"), _of(recorder, "llm_response")
assert len(request) == len(response) == 1
assert request[0].agent_name == "Writer" and request[0].node_id == "agent:Writer"
assert request[0].messages_count == 1
r = response[0]
assert (r.prompt_tokens, r.completion_tokens) == (11, 3)
assert r.data["model"] == "gpt-4o-mini"
assert r.data["response_content"] == "hello"
assert r.data["finish_reason"] == "stop"
assert r.data["duration_ms"] >= 0
assert r.cost_usd > 0 # litellm knows gpt-4o-mini's price
def test_response_records_the_serving_model_and_a_message_snapshot(self, recorder, fake_litellm, monkeypatch):
import litellm
served = _response()
served.model = "gpt-4o" # a failover profile answered
monkeypatch.setattr(litellm, "completion", lambda **params: served)
messages = [{"role": "user", "content": "hi"}]
self._llm()._completion_with_retry(model="gpt-4o-mini", messages=messages)
messages.append({"role": "assistant", "content": "later turn"})
assert _of(recorder, "llm_response")[0].data["model"] == "gpt-4o"
assert _of(recorder, "llm_request")[0].messages_count == 1
assert len(_of(recorder, "llm_request")[0].data["messages"]) == 1
def test_streaming_call_records_response_when_the_stream_ends(self, recorder, fake_litellm):
llm = self._llm()
stream = llm._completion_with_retry(model="gpt-4o-mini", messages=[], stream=True)
assert _of(recorder, "llm_response") == []
text = "".join(c.choices[0].delta.content or "" for c in stream)
assert text == "hello"
response = _of(recorder, "llm_response")
assert len(response) == 1
assert response[0].data["response_content"] == "hello"
assert (response[0].prompt_tokens, response[0].completion_tokens) == (5, 2)
def test_async_calls_record_events(self, recorder, fake_litellm):
llm = self._llm()
async def run():
await llm._acompletion_with_retry(model="gpt-4o-mini", messages=[])
stream = await llm._acompletion_with_retry(model="gpt-4o-mini", messages=[], stream=True)
return "".join([c.choices[0].delta.content async for c in stream])
assert asyncio.run(run()) == "ab"
responses = _of(recorder, "llm_response")
assert [r.data["response_content"] for r in responses] == ["async", "ab"]
assert len(_of(recorder, "llm_request")) == 2
def test_a_call_already_recorded_by_the_agent_is_not_counted_twice(self, recorder, fake_litellm):
llm = self._llm()
emitter = get_context_emitter()
emitter.agent_start("Writer")
emitter.llm_request("Writer", messages_count=1, tokens_used=0, model="gpt-4o-mini")
llm._completion_with_retry(model="gpt-4o-mini", messages=[])
emitter.llm_response("Writer", duration_ms=1.0)
llm._completion_with_retry(model="gpt-4o-mini", messages=[]) # a fresh call counts
emitter.agent_end("Writer")
assert len(_of(recorder, "llm_request")) == 2
assert len(_of(recorder, "llm_response")) == 2
def test_a_failed_call_records_an_error_response(self, recorder, monkeypatch):
import litellm
import praisonaiagents.llm.llm as llm_module
monkeypatch.setattr(llm_module, "check_model_request", lambda *a, **k: None)
def explode(**params):
raise ValueError("bad request")
monkeypatch.setattr(litellm, "completion", explode)
llm = self._llm()
llm._max_retries = 0
with pytest.raises(Exception):
llm._completion_with_retry(model="gpt-4o-mini", messages=[])
response = _of(recorder, "llm_response")
assert len(response) == 1 and response[0].data["finish_reason"] == "error"
def test_responses_api_calls_record_events(self, recorder, monkeypatch):
"""OpenAI models on the LiteLLM path go through the Responses API."""
from praisonaiagents.llm.llm import LLM
usage = types.SimpleNamespace(input_tokens=7, output_tokens=2)
monkeypatch.setattr(LLM, "_call_responses_api_impl", lambda self, **p: types.SimpleNamespace(usage=usage))
monkeypatch.setattr(LLM, "_extract_from_responses_output", lambda self, r: ("answer", None, None))
monkeypatch.setattr(LLM, "_stream_responses_api_impl",
lambda self, params, *a, **k: ("streamed", None, types.SimpleNamespace(usage=usage)))
async def acall(self, **p):
return types.SimpleNamespace(usage=usage)
monkeypatch.setattr(LLM, "_call_responses_api_async_impl", acall)
llm = self._llm()
params = {"model": "gpt-4o-mini", "input": [{"role": "user", "content": "hi"}]}
llm._call_responses_api(**params)
llm._stream_responses_api(dict(params), verbose=False)
asyncio.run(llm._call_responses_api_async(**params))
requests, responses = _of(recorder, "llm_request"), _of(recorder, "llm_response")
assert len(requests) == len(responses) == 3
assert requests[0].messages_count == 1
assert [r.data["response_content"] for r in responses] == ["answer", "streamed", "answer"]
assert all((r.prompt_tokens, r.completion_tokens) == (7, 2) for r in responses)
def test_control_disabled_tracing_leaves_the_stream_untouched(self, fake_litellm):
llm = self._llm()
stream = llm._completion_with_retry(model="gpt-4o-mini", messages=[], stream=True)
assert type(stream).__name__ == "list_iterator"
# ---------------------------------------------------------------------------
# The disabled emitter costs (almost) nothing
# ---------------------------------------------------------------------------
def test_disabled_emitter_adds_next_to_nothing():
emitter = ContextTraceEmitter(enabled=False)
n = 20000
def baseline():
pass
t0 = time.perf_counter()
for _ in range(n):
baseline()
base = time.perf_counter() - t0
t0 = time.perf_counter()
for _ in range(n):
emitter.task_start("t", "d", "a", "task:t")
emitter.step_end("s", "completed", 1.0, "out")
emitter.agent_handoff("a", "b", kind="delegate")
emitter.approval_requested("id", "tool", {"x": 1})
emitter.workflow_start("team", "t", "sequential", graph={})
cost = time.perf_counter() - t0
# Five disabled calls per iteration: one attribute check each.
assert cost / (n * 5) < 2e-6, f"{cost / (n * 5) * 1e9:.0f} ns per disabled call"
assert cost < base * 5 * 20 + 0.05
def test_disabled_tracing_never_builds_the_graph():
from praisonaiagents.trace.context_events import _workflow_scope
built = []
with _workflow_scope("team", "t", "sequential", graph_fn=lambda: built.append(1)) as run:
assert run is None
assert built == []
class TestTeamRunLabel:
"""An unnamed team is labelled by its agents, not by whichever agent comes first."""
def test_unnamed_team_is_labelled_by_its_agents(self):
from praisonaiagents import Agent, AgentTeam
team = AgentTeam(agents=[Agent(name="Researcher", output="silent"), Agent(name="Writer", output="silent")])
assert team._replay_name() == "Researcher + Writer"
def test_named_team_keeps_its_name(self):
from praisonaiagents import Agent, AgentTeam
team = AgentTeam(agents=[Agent(name="Researcher", output="silent")], name="EV brief")
assert team._replay_name() == "EV brief"
class TestStepVariables:
"""step_end records the variables a step set, so a re-run can restore them."""
def test_step_end_records_handler_variables_redacted(self, recorder):
from praisonaiagents.workflows import StepResult
from praisonaiagents.workflows.workflows import AgentFlow
def research(ctx):
return StepResult(output="notes", variables={"customer_id": 42, "api_key": "sk-abcdefghijklmnop1234"})
def draft(ctx):
return StepResult(output="draft")
AgentFlow(name="v", steps=[research, draft]).run("go")
ends = {e.node_id: e.data for e in _of(recorder, "step_end")}
assert ends["step:research"]["variables"]["customer_id"] == 42
assert "sk-abcdefghijklmnop1234" not in str(ends["step:research"]["variables"])
assert "variables" not in ends["step:draft"]
def test_nested_step_end_records_handler_variables(self, recorder):
"""Steps run through _execute_single_step_internal (patterns, hierarchical) record them too."""
from praisonaiagents.workflows import StepResult
from praisonaiagents.workflows.workflows import AgentFlow, If
def research(ctx):
return StepResult(output="notes", variables={"customer_id": 42})
AgentFlow(name="v", steps=[If(condition="1 > 0", then_steps=[research])]).run("go")
ends = {e.node_id: e.data for e in _of(recorder, "step_end")}
variables = next(d["variables"] for n, d in ends.items() if n.endswith("research"))
assert variables == {"customer_id": 42}
def test_cache_hit_step_end_leaves_out_the_output_variable(self, recorder):
"""The step cache stores the output variable (the full output); a cached
step_end must trace only what the handler set, like the cold run."""
from praisonaiagents.workflows import StepResult
from praisonaiagents.workflows.workflows import AgentFlow
def research(ctx):
return StepResult(output="the full step output " * 50, variables={"customer_id": 42})
flow = AgentFlow(name="v", steps=[research], cache=True)
flow.run("go")
flow.run("go") # cache hit
ends = [e.data for e in _of(recorder, "step_end")]
assert [d["status"] for d in ends] == ["completed", "cached"]
for d in ends:
assert d["variables"] == {"customer_id": 42}
assert "the full step output" not in str(d["variables"])
def test_nested_step_records_a_variable_changed_in_place(self, recorder):
"""A list the step appends to (same object) still counts as set by it."""
from praisonaiagents.workflows import StepResult
from praisonaiagents.workflows.workflows import AgentFlow, If
def seed(ctx):
return StepResult(output="s", variables={"items": ["a"]})
def add(ctx):
ctx.variables["items"].append("b")
return StepResult(output="m")
AgentFlow(name="v", steps=[seed, If(condition="1 > 0", then_steps=[add])]).run("go")
ends = {e.node_id: e.data for e in _of(recorder, "step_end")}
variables = next(d.get("variables") for n, d in ends.items() if n.endswith("add"))
assert variables == {"items": ["a", "b"]}
def test_uncopyable_variable_does_not_hide_an_in_place_change(self, recorder):
"""One variable that cannot be deep-copied must not stop the others being compared by value."""
import threading
from praisonaiagents.workflows import StepResult
from praisonaiagents.workflows.workflows import AgentFlow, If
def seed(ctx):
return StepResult(output="s", variables={"items": ["a"]})
def add(ctx):
ctx.variables["items"].append("b")
return StepResult(output="m")
flow = AgentFlow(name="v", steps=[seed, If(condition="1 > 0", then_steps=[add])],
variables={"lock": threading.Lock()})
flow.run("go")
ends = {e.node_id: e.data for e in _of(recorder, "step_end")}
variables = next(d.get("variables") for n, d in ends.items() if n.endswith("add"))
assert variables == {"items": ["a", "b"]}
def test_skipped_or_cached_nested_step_does_not_copy_the_scope(self, recorder, monkeypatch):
"""Only a nested step that really runs snapshots the variables; a cache
hit still records what the handler set."""
from praisonaiagents.workflows import StepResult, Task
from praisonaiagents.workflows import workflows as wf
copies = []
real = wf._isolate_scope
monkeypatch.setattr(wf, "_isolate_scope", lambda v: copies.append(1) or real(v))
def research(ctx):
return StepResult(output="notes", variables={"customer_id": 42})
def never(ctx):
return StepResult(output="x")
steps = [wf.If(condition="1 > 0", then_steps=[
research, Task(name="never", handler=never, should_run=lambda ctx: False),
])]
flow = wf.AgentFlow(name="v", steps=steps, variables={"items": list(range(1000))}, cache=True)
flow.run("go")
assert len(copies) == 1 # research ran; the skipped step copied nothing
copies.clear()
flow.run("go") # research is a cache hit
assert copies == []
cached = [e.data for e in _of(recorder, "step_end") if e.data["status"] == "cached"]
assert [d.get("variables") for d in cached] == [{"customer_id": 42}]
@@ -0,0 +1,107 @@
"""Definitions whose graphs are pinned as golden JSON (see test_graph.py).
Kept in their own module so a subprocess can rebuild them and prove the node
ids do not depend on the process (hash seed, uuids, object ids).
"""
def search_web(query: str) -> str:
"""Search the web."""
return query
def score(ctx):
return "approved"
def fetch(ctx):
return "a,b"
def tidy(ctx):
return "ok"
def team():
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
researcher = Agent(name="Researcher", instructions="Find facts", tools=[search_web])
billing = Agent(name="Billing", instructions="Handle billing")
writer = Agent(name="Writer", instructions="Write", handoffs=[billing])
research = Task(name="research", description="Find facts", agent=researcher,
is_start=True, next_tasks=["draft"])
draft = Task(name="draft", description="Write the piece", agent=writer,
context=[research], human_input=True,
condition={"approved": ["publish"], "rejected": ["research"]})
publish = Task(name="publish", description="Ship it", agent=writer)
unnamed = Task(description="Archive everything afterwards", agent=writer)
return AgentTeam(agents=[researcher, writer], tasks=[research, draft, publish, unnamed],
process="workflow", name="newsroom")
def sequential_team():
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
researcher = Agent(name="Researcher", instructions="Find facts", tools=[search_web])
writer = Agent(name="Writer", instructions="Write")
return AgentTeam(
agents=[researcher, writer],
tasks=[
Task(name="research", description="Find facts", agent=researcher),
Task(name="write", description="Write it up", agent=writer),
Task(name="write", description="Write it again", agent=writer),
],
name="pair",
)
def hierarchical_team():
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
researcher = Agent(name="Researcher", instructions="Find facts", tools=[search_web])
writer = Agent(name="Writer", instructions="Write")
return AgentTeam(
agents=[researcher, writer],
tasks=[
Task(name="research", description="Find facts", agent=researcher),
Task(name="write", description="Write it up", agent=writer),
],
process="hierarchical",
manager_llm="gpt-4o-mini",
name="managed",
)
def flow():
from praisonaiagents import Agent
from praisonaiagents.workflows.workflows import (
AgentFlow, Discussion, If, Include, Loop, Parallel, Repeat, Route,
)
researcher = Agent(name="Researcher", instructions="Find facts", tools=[search_web])
critic = Agent(name="Critic", instructions="Critique")
return AgentFlow(
name="pipeline",
steps=[
researcher,
score,
Route(routes={"approved": [tidy], "default": [fetch]}),
Parallel(steps=[fetch, tidy]),
Loop(step=tidy, over="items"),
If(condition="{{score}} > 80", then_steps=[tidy], else_steps=[Repeat(fetch, max_iterations=2)]),
Discussion(agents=[researcher, critic], rounds=1),
researcher,
Include(recipe="publisher"),
],
)
BUILDERS = {
"team": team,
"sequential_team": sequential_team,
"hierarchical_team": hierarchical_team,
"flow": flow,
}
@@ -0,0 +1,431 @@
{
"edges": [
{
"id": "start:begin->step:Researcher:next",
"kind": "next",
"label": null,
"source": "start:begin",
"target": "step:Researcher"
},
{
"id": "agent:Researcher->tool:Researcher/search_web:uses",
"kind": "uses",
"label": null,
"source": "agent:Researcher",
"target": "tool:Researcher/search_web"
},
{
"id": "step:Researcher->agent:Researcher:assigned",
"kind": "assigned",
"label": null,
"source": "step:Researcher",
"target": "agent:Researcher"
},
{
"id": "step:Researcher->step:score:next",
"kind": "next",
"label": null,
"source": "step:Researcher",
"target": "step:score"
},
{
"id": "step:score->decision:route:next",
"kind": "next",
"label": null,
"source": "step:score",
"target": "decision:route"
},
{
"id": "decision:route->step:tidy:routes",
"kind": "routes",
"label": "approved",
"source": "decision:route",
"target": "step:tidy"
},
{
"id": "decision:route->step:fetch:routes",
"kind": "routes",
"label": "default",
"source": "decision:route",
"target": "step:fetch"
},
{
"id": "step:tidy->join:route:next",
"kind": "next",
"label": null,
"source": "step:tidy",
"target": "join:route"
},
{
"id": "step:fetch->join:route:next",
"kind": "next",
"label": null,
"source": "step:fetch",
"target": "join:route"
},
{
"id": "join:route->fork:parallel:next",
"kind": "next",
"label": null,
"source": "join:route",
"target": "fork:parallel"
},
{
"id": "fork:parallel->step:fetch#2:parallel",
"kind": "parallel",
"label": null,
"source": "fork:parallel",
"target": "step:fetch#2"
},
{
"id": "fork:parallel->step:tidy#2:parallel",
"kind": "parallel",
"label": null,
"source": "fork:parallel",
"target": "step:tidy#2"
},
{
"id": "step:fetch#2->join:parallel:next",
"kind": "next",
"label": null,
"source": "step:fetch#2",
"target": "join:parallel"
},
{
"id": "step:tidy#2->join:parallel:next",
"kind": "next",
"label": null,
"source": "step:tidy#2",
"target": "join:parallel"
},
{
"id": "join:parallel->step:tidy#3:next",
"kind": "next",
"label": null,
"source": "join:parallel",
"target": "step:tidy#3"
},
{
"id": "step:tidy#3->step:tidy#3:loop",
"kind": "loop",
"label": "over items",
"source": "step:tidy#3",
"target": "step:tidy#3"
},
{
"id": "step:tidy#3->decision:if:next",
"kind": "next",
"label": null,
"source": "step:tidy#3",
"target": "decision:if"
},
{
"id": "decision:if->step:tidy#4:routes",
"kind": "routes",
"label": "true",
"source": "decision:if",
"target": "step:tidy#4"
},
{
"id": "step:fetch#3->step:fetch#3:loop",
"kind": "loop",
"label": "up to 2x",
"source": "step:fetch#3",
"target": "step:fetch#3"
},
{
"id": "decision:if->step:fetch#3:routes",
"kind": "routes",
"label": "false",
"source": "decision:if",
"target": "step:fetch#3"
},
{
"id": "step:tidy#4->join:if:next",
"kind": "next",
"label": null,
"source": "step:tidy#4",
"target": "join:if"
},
{
"id": "step:fetch#3->join:if:next",
"kind": "next",
"label": null,
"source": "step:fetch#3",
"target": "join:if"
},
{
"id": "join:if->step:discussion:next",
"kind": "next",
"label": null,
"source": "join:if",
"target": "step:discussion"
},
{
"id": "step:discussion->agent:Researcher:assigned",
"kind": "assigned",
"label": null,
"source": "step:discussion",
"target": "agent:Researcher"
},
{
"id": "step:discussion->agent:Critic:assigned",
"kind": "assigned",
"label": null,
"source": "step:discussion",
"target": "agent:Critic"
},
{
"id": "step:discussion->step:Researcher#2:next",
"kind": "next",
"label": null,
"source": "step:discussion",
"target": "step:Researcher#2"
},
{
"id": "step:Researcher#2->agent:Researcher:assigned",
"kind": "assigned",
"label": null,
"source": "step:Researcher#2",
"target": "agent:Researcher"
},
{
"id": "step:Researcher#2->step:include:next",
"kind": "next",
"label": null,
"source": "step:Researcher#2",
"target": "step:include"
},
{
"id": "step:include->end:done:next",
"kind": "next",
"label": null,
"source": "step:include",
"target": "end:done"
}
],
"kind": "flow",
"name": "pipeline",
"nodes": [
{
"id": "start:begin",
"kind": "start",
"label": "Brief",
"meta": {},
"parent": null
},
{
"id": "step:Researcher",
"kind": "step",
"label": "Researcher",
"meta": {},
"parent": null
},
{
"id": "agent:Researcher",
"kind": "agent",
"label": "Researcher",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "tool:Researcher/search_web",
"kind": "tool",
"label": "search_web",
"meta": {},
"parent": null
},
{
"id": "step:score",
"kind": "step",
"label": "score",
"meta": {},
"parent": null
},
{
"id": "step:route",
"kind": "step",
"label": "route",
"meta": {
"pattern": "route"
},
"parent": null
},
{
"id": "decision:route",
"kind": "decision",
"label": "route",
"meta": {},
"parent": "step:route"
},
{
"id": "step:tidy",
"kind": "step",
"label": "tidy",
"meta": {},
"parent": "step:route"
},
{
"id": "step:fetch",
"kind": "step",
"label": "fetch",
"meta": {},
"parent": "step:route"
},
{
"id": "join:route",
"kind": "join",
"label": "join",
"meta": {},
"parent": "step:route"
},
{
"id": "step:parallel",
"kind": "step",
"label": "parallel",
"meta": {
"pattern": "parallel"
},
"parent": null
},
{
"id": "fork:parallel",
"kind": "fork",
"label": "fork",
"meta": {},
"parent": "step:parallel"
},
{
"id": "step:fetch#2",
"kind": "step",
"label": "fetch",
"meta": {},
"parent": "step:parallel"
},
{
"id": "step:tidy#2",
"kind": "step",
"label": "tidy",
"meta": {},
"parent": "step:parallel"
},
{
"id": "join:parallel",
"kind": "join",
"label": "join",
"meta": {},
"parent": "step:parallel"
},
{
"id": "step:loop",
"kind": "step",
"label": "loop",
"meta": {
"over": "items",
"pattern": "loop"
},
"parent": null
},
{
"id": "step:tidy#3",
"kind": "step",
"label": "tidy",
"meta": {},
"parent": "step:loop"
},
{
"id": "step:if",
"kind": "step",
"label": "if",
"meta": {
"condition": "{{score}} > 80",
"pattern": "if"
},
"parent": null
},
{
"id": "decision:if",
"kind": "decision",
"label": "{{score}} > 80",
"meta": {},
"parent": "step:if"
},
{
"id": "step:tidy#4",
"kind": "step",
"label": "tidy",
"meta": {},
"parent": "step:if"
},
{
"id": "step:repeat",
"kind": "step",
"label": "repeat",
"meta": {
"max_iterations": 2,
"pattern": "repeat"
},
"parent": "step:if"
},
{
"id": "step:fetch#3",
"kind": "step",
"label": "fetch",
"meta": {},
"parent": "step:repeat"
},
{
"id": "join:if",
"kind": "join",
"label": "join",
"meta": {},
"parent": "step:if"
},
{
"id": "step:discussion",
"kind": "step",
"label": "discussion",
"meta": {
"pattern": "discussion"
},
"parent": null
},
{
"id": "agent:Critic",
"kind": "agent",
"label": "Critic",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "step:Researcher#2",
"kind": "step",
"label": "Researcher",
"meta": {},
"parent": null
},
{
"id": "step:include",
"kind": "step",
"label": "include",
"meta": {
"pattern": "include",
"recipe": "publisher"
},
"parent": null
},
{
"id": "end:done",
"kind": "end",
"label": "Delivered",
"meta": {},
"parent": null
}
],
"process": "flow",
"schema": "praisonai.graph/1"
}
@@ -0,0 +1,126 @@
{
"edges": [
{
"id": "agent:Researcher->tool:Researcher/search_web:uses",
"kind": "uses",
"label": null,
"source": "agent:Researcher",
"target": "tool:Researcher/search_web"
},
{
"id": "task:research->agent:Researcher:assigned",
"kind": "assigned",
"label": null,
"source": "task:research",
"target": "agent:Researcher"
},
{
"id": "task:write->agent:Writer:assigned",
"kind": "assigned",
"label": null,
"source": "task:write",
"target": "agent:Writer"
},
{
"id": "start:begin->manager:Manager:next",
"kind": "next",
"label": null,
"source": "start:begin",
"target": "manager:Manager"
},
{
"id": "manager:Manager->agent:Researcher:delegates",
"kind": "delegates",
"label": null,
"source": "manager:Manager",
"target": "agent:Researcher"
},
{
"id": "manager:Manager->agent:Writer:delegates",
"kind": "delegates",
"label": null,
"source": "manager:Manager",
"target": "agent:Writer"
},
{
"id": "manager:Manager->end:done:next",
"kind": "next",
"label": null,
"source": "manager:Manager",
"target": "end:done"
},
{
"id": "task:research->task:write:depends_on",
"kind": "depends_on",
"label": null,
"source": "task:research",
"target": "task:write"
}
],
"kind": "team",
"name": "managed",
"nodes": [
{
"id": "start:begin",
"kind": "start",
"label": "Brief",
"meta": {},
"parent": null
},
{
"id": "manager:Manager",
"kind": "manager",
"label": "Manager",
"meta": {},
"parent": null
},
{
"id": "agent:Researcher",
"kind": "agent",
"label": "Researcher",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "tool:Researcher/search_web",
"kind": "tool",
"label": "search_web",
"meta": {},
"parent": null
},
{
"id": "agent:Writer",
"kind": "agent",
"label": "Writer",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "task:research",
"kind": "task",
"label": "research",
"meta": {},
"parent": null
},
{
"id": "task:write",
"kind": "task",
"label": "write",
"meta": {},
"parent": null
},
{
"id": "end:done",
"kind": "end",
"label": "Delivered",
"meta": {},
"parent": null
}
],
"process": "hierarchical",
"schema": "praisonai.graph/1"
}
@@ -0,0 +1,126 @@
{
"edges": [
{
"id": "agent:Researcher->tool:Researcher/search_web:uses",
"kind": "uses",
"label": null,
"source": "agent:Researcher",
"target": "tool:Researcher/search_web"
},
{
"id": "task:research->agent:Researcher:assigned",
"kind": "assigned",
"label": null,
"source": "task:research",
"target": "agent:Researcher"
},
{
"id": "task:write->agent:Writer:assigned",
"kind": "assigned",
"label": null,
"source": "task:write",
"target": "agent:Writer"
},
{
"id": "task:write#2->agent:Writer:assigned",
"kind": "assigned",
"label": null,
"source": "task:write#2",
"target": "agent:Writer"
},
{
"id": "start:begin->task:research:next",
"kind": "next",
"label": null,
"source": "start:begin",
"target": "task:research"
},
{
"id": "task:research->task:write:next",
"kind": "next",
"label": null,
"source": "task:research",
"target": "task:write"
},
{
"id": "task:write->task:write#2:next",
"kind": "next",
"label": null,
"source": "task:write",
"target": "task:write#2"
},
{
"id": "task:write#2->end:done:next",
"kind": "next",
"label": null,
"source": "task:write#2",
"target": "end:done"
}
],
"kind": "team",
"name": "pair",
"nodes": [
{
"id": "start:begin",
"kind": "start",
"label": "Brief",
"meta": {},
"parent": null
},
{
"id": "agent:Researcher",
"kind": "agent",
"label": "Researcher",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "tool:Researcher/search_web",
"kind": "tool",
"label": "search_web",
"meta": {},
"parent": null
},
{
"id": "agent:Writer",
"kind": "agent",
"label": "Writer",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "task:research",
"kind": "task",
"label": "research",
"meta": {},
"parent": null
},
{
"id": "task:write",
"kind": "task",
"label": "write",
"meta": {},
"parent": null
},
{
"id": "task:write#2",
"kind": "task",
"label": "write",
"meta": {},
"parent": null
},
{
"id": "end:done",
"kind": "end",
"label": "Delivered",
"meta": {},
"parent": null
}
],
"process": "sequential",
"schema": "praisonai.graph/1"
}
@@ -0,0 +1,186 @@
{
"edges": [
{
"id": "agent:Researcher->tool:Researcher/search_web:uses",
"kind": "uses",
"label": null,
"source": "agent:Researcher",
"target": "tool:Researcher/search_web"
},
{
"id": "agent:Writer->agent:Billing:handoff",
"kind": "handoff",
"label": null,
"source": "agent:Writer",
"target": "agent:Billing"
},
{
"id": "task:research->agent:Researcher:assigned",
"kind": "assigned",
"label": null,
"source": "task:research",
"target": "agent:Researcher"
},
{
"id": "task:draft->agent:Writer:assigned",
"kind": "assigned",
"label": null,
"source": "task:draft",
"target": "agent:Writer"
},
{
"id": "human:you->task:draft:reviews",
"kind": "reviews",
"label": null,
"source": "human:you",
"target": "task:draft"
},
{
"id": "task:publish->agent:Writer:assigned",
"kind": "assigned",
"label": null,
"source": "task:publish",
"target": "agent:Writer"
},
{
"id": "task:3->agent:Writer:assigned",
"kind": "assigned",
"label": null,
"source": "task:3",
"target": "agent:Writer"
},
{
"id": "start:begin->task:research:next",
"kind": "next",
"label": null,
"source": "start:begin",
"target": "task:research"
},
{
"id": "task:research->task:draft:next",
"kind": "next",
"label": null,
"source": "task:research",
"target": "task:draft"
},
{
"id": "task:draft->task:publish:routes",
"kind": "routes",
"label": "approved",
"source": "task:draft",
"target": "task:publish"
},
{
"id": "task:draft->task:research:routes",
"kind": "routes",
"label": "rejected",
"source": "task:draft",
"target": "task:research"
},
{
"id": "task:publish->end:done:next",
"kind": "next",
"label": null,
"source": "task:publish",
"target": "end:done"
},
{
"id": "task:3->end:done:next",
"kind": "next",
"label": null,
"source": "task:3",
"target": "end:done"
}
],
"kind": "team",
"name": "newsroom",
"nodes": [
{
"id": "start:begin",
"kind": "start",
"label": "Brief",
"meta": {},
"parent": null
},
{
"id": "agent:Researcher",
"kind": "agent",
"label": "Researcher",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "tool:Researcher/search_web",
"kind": "tool",
"label": "search_web",
"meta": {},
"parent": null
},
{
"id": "agent:Writer",
"kind": "agent",
"label": "Writer",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "agent:Billing",
"kind": "agent",
"label": "Billing",
"meta": {
"role": "Assistant"
},
"parent": null
},
{
"id": "human:you",
"kind": "human",
"label": "You",
"meta": {},
"parent": null
},
{
"id": "task:research",
"kind": "task",
"label": "research",
"meta": {},
"parent": null
},
{
"id": "task:draft",
"kind": "task",
"label": "draft",
"meta": {
"human_input": true
},
"parent": null
},
{
"id": "task:publish",
"kind": "task",
"label": "publish",
"meta": {},
"parent": null
},
{
"id": "task:3",
"kind": "task",
"label": "Archive everything afterwards",
"meta": {},
"parent": null
},
{
"id": "end:done",
"kind": "end",
"label": "Delivered",
"meta": {},
"parent": null
}
],
"process": "workflow",
"schema": "praisonai.graph/1"
}
@@ -0,0 +1,160 @@
"""Graph data (``praisonai.graph/1``) for teams, flows and agents.
The replay UI draws the Map from this graph and joins it to trace events by
``node_id``, so the ids must be derived from the definition alone: identical
in every process and on every run. The goldens pin the full shape; regenerate
them deliberately with ``PRAISONAI_UPDATE_GOLDEN=1``.
"""
import json
import os
import subprocess
import sys
from pathlib import Path
import pytest
HERE = Path(__file__).parent
GOLDEN = HERE / "golden"
sys.path.insert(0, str(HERE))
import _graph_fixtures as fixtures # noqa: E402
from praisonaiagents.workflows.diagram import graph_to_mermaid, to_graph # noqa: E402
@pytest.mark.parametrize("name", ["team", "sequential_team", "hierarchical_team", "flow"])
def test_graph_matches_golden(name):
graph = to_graph(fixtures.BUILDERS[name]())
path = GOLDEN / f"graph_{name}.json"
if os.environ.get("PRAISONAI_UPDATE_GOLDEN") == "1":
path.write_text(json.dumps(graph, indent=2, sort_keys=True) + "\n")
assert graph == json.loads(path.read_text())
def test_ids_are_stable_across_processes():
"""Two fresh interpreters with different hash seeds produce the same graphs."""
code = (
"import json, sys; sys.path.insert(0, sys.argv[1]);"
"import _graph_fixtures as f;"
"from praisonaiagents.workflows.diagram import to_graph;"
"print(json.dumps({k: to_graph(b()) for k, b in sorted(f.BUILDERS.items())}, sort_keys=True))"
)
root = str(Path(__import__("praisonaiagents").__file__).parent.parent)
outputs = []
for seed in ("1", "2"):
env = dict(os.environ, PYTHONHASHSEED=seed, PYTHONPATH=root, PYTHONDONTWRITEBYTECODE="1")
out = subprocess.run([sys.executable, "-c", code, str(HERE)], env=env,
capture_output=True, text=True, timeout=120, check=True)
outputs.append(json.loads(out.stdout.strip().splitlines()[-1]))
assert outputs[0] == outputs[1]
assert outputs[0]["flow"] == to_graph(fixtures.flow())
def test_every_edge_joins_known_nodes_and_ids_are_unique():
for build in fixtures.BUILDERS.values():
graph = to_graph(build())
ids = [n["id"] for n in graph["nodes"]]
assert len(ids) == len(set(ids))
for edge in graph["edges"]:
assert edge["source"] in ids and edge["target"] in ids, edge
assert edge["id"] == f'{edge["source"]}->{edge["target"]}:{edge["kind"]}'
for node in graph["nodes"]:
assert node["parent"] is None or node["parent"] in ids
def test_no_uuid_reaches_the_graph():
import re
uuid = re.compile(r"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}")
for build in fixtures.BUILDERS.values():
assert not uuid.search(json.dumps(to_graph(build())))
def test_team_and_flow_methods():
team = fixtures.hierarchical_team()
assert team.to_graph() == to_graph(team)
diagram = team.to_mermaid()
assert diagram.startswith("graph TD")
assert '{{"Manager"}}' in diagram and '-->|"delegates"|' in diagram
flow = fixtures.flow()
assert flow.to_graph() == to_graph(flow)
def test_agent_graph_has_tools_and_handoffs():
from praisonaiagents import Agent
billing = Agent(name="Billing", instructions="b")
triage = Agent(name="Triage", instructions="t", tools=[fixtures.search_web], handoffs=[billing])
graph = to_graph(triage)
assert graph["kind"] == "agent"
edges = {e["id"] for e in graph["edges"]}
assert {
"start:begin->agent:Triage:next",
"agent:Triage->tool:Triage/search_web:uses",
"agent:Triage->agent:Billing:handoff",
"agent:Triage->end:done:next",
} <= edges
# The hand-off's generated transfer tool is the hand-off edge, not a tool node.
assert not any(n["id"].startswith("tool:Triage/transfer_to") for n in graph["nodes"])
def test_graph_to_mermaid_draws_leaf_nodes_not_groups():
graph = to_graph(fixtures.flow())
diagram = graph_to_mermaid(graph)
assert diagram.startswith("graph TD")
assert '(("fork"))' in diagram and '{"route"}' in diagram
assert '["parallel"]' not in diagram # a pattern group is a container
def test_team_graph_keeps_when_routes_and_shared_target_labels():
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
a = Agent(name="A", instructions="a")
tasks = [
Task(name="check", description="c", agent=a, is_start=True,
when="score > 80", then_task="publish", else_task="revise"),
Task(name="revise", description="r", agent=a,
condition={"approved": ["publish"], "forced": ["publish"]}),
Task(name="publish", description="p", agent=a),
]
graph = to_graph(AgentTeam(agents=[a], tasks=tasks, process="workflow"))
edges = {e["id"]: e for e in graph["edges"]}
assert edges["task:check->task:publish:routes"]["label"] == "score > 80"
assert edges["task:check->task:revise:routes"]["label"] == "else"
assert "task:check->end:done:next" not in edges
assert edges["task:revise->task:publish:routes"]["label"] == "approved / forced"
def test_shared_target_keeps_a_label_that_looks_like_a_merged_one():
from praisonaiagents import Agent, Task
from praisonaiagents.agents.agents import AgentTeam
a = Agent(name="A", instructions="a")
tasks = [
Task(name="revise", description="r", agent=a, is_start=True,
condition={"approved / forced": ["publish"], "approved": ["publish"]}),
Task(name="publish", description="p", agent=a),
]
graph = to_graph(AgentTeam(agents=[a], tasks=tasks, process="workflow"))
edges = {e["id"]: e for e in graph["edges"]}
assert edges["task:revise->task:publish:routes"]["label"] == "approved / forced / approved"
def test_repeat_with_a_step_list_draws_each_member():
from praisonaiagents.workflows.workflows import AgentFlow, Repeat
def draft(ctx):
return "d"
def polish(ctx):
return "p"
graph = to_graph(AgentFlow(steps=[Repeat(step=[draft, polish], until=lambda ctx: True)]))
ids = {n["id"] for n in graph["nodes"]}
assert {"step:draft", "step:polish"} <= ids
assert "step:list" not in ids
def test_unsupported_object_is_rejected():
with pytest.raises(TypeError):
to_graph(42)
@@ -0,0 +1,28 @@
"""Route references must not silently discard undefined agents."""
import pytest
from praisonaiagents.workflows.yaml_parser import YAMLWorkflowParser
PREFIX = """name: route-validation
agents:
known:
name: Known
instructions: Greet.
llm: openai/fixture-model
steps:
"""
@pytest.mark.parametrize("target", ["missing", "[known, missing]"])
def test_route_rejects_undefined_target(target):
source = PREFIX + f" - route:\n chosen: {target}\n"
with pytest.raises(ValueError, match="Agent 'missing'.*route 'chosen'"):
YAMLWorkflowParser().parse_string(source)
@pytest.mark.parametrize("target", ["known", "[known]"])
def test_route_keeps_defined_targets(target):
source = PREFIX + f" - route:\n chosen: {target}\n"
flow = YAMLWorkflowParser().parse_string(source)
assert [agent.name for agent in flow.steps[0].routes["chosen"]] == ["Known"]
+3 -3
View File
@@ -3162,7 +3162,7 @@ wheels = [
[[package]]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
source = { editable = "." }
dependencies = [
{ name = "aiohttp" },
@@ -3292,8 +3292,8 @@ requires-dist = [
{ name = "fastapi", marker = "extra == 'api'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'mcp'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'os'", specifier = ">=0.115.0" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14,<1.106" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14,<1.106" },
{ name = "markitdown", extras = ["all"], marker = "extra == 'knowledge'", specifier = ">=0.1.0" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.20.0,<2" },
{ name = "mcp", marker = "extra == 'parallel-search'", specifier = ">=1.30.0,<2" },
+1 -1
View File
@@ -1 +1 @@
__version__ = "0.1.15"
__version__ = "0.1.16"
@@ -11,11 +11,13 @@ import logging
import math
import os
import re
import signal
import subprocess
import threading
import time
from typing import Dict, Any, List, Optional
from .._guarded_subprocess import run_guarded
from .._guarded_subprocess import _kill_process_group, run_guarded
logger = logging.getLogger(__name__)
@@ -86,6 +88,17 @@ class KanbanDispatcher:
self._task_runs: Dict[str, int] = {} # task_id -> open run_id
self.worker_id = f"gateway_{os.getpid()}"
# Serialises blocking git/SQLite work handed to worker threads, so two
# integrations never run git concurrently in the same base checkout.
_blocking_lock = threading.Lock()
async def _run_blocking(self, fn, *args):
"""Run a blocking (git / SQLite) helper off the event loop."""
def _locked():
with self._blocking_lock:
return fn(*args)
return await asyncio.to_thread(_locked)
def _close_run_safe(self, store, run_id, outcome, *, summary=None, metadata=None, error=None) -> bool:
"""Close a run, swallowing errors so dispatch stays resilient.
@@ -196,8 +209,13 @@ class KanbanDispatcher:
if not store:
return 0
# Clean up completed processes first
self._cleanup_completed_tasks(store)
# Clean up completed processes first. Integration runs several git
# commands, so keep it off the event loop.
await self._run_blocking(self._cleanup_completed_tasks, store)
# Prove liveness for our own children before the reclaim sweep runs,
# so a healthy long-running worker is never mistaken for a stale one.
self._heartbeat_children(store)
# Reclaim stale/crashed claims before dispatching new work so that
# tasks stranded by dead workers return to 'ready' and get re-dispatched.
@@ -221,6 +239,14 @@ class KanbanDispatcher:
spawned = 0
for task in ready_tasks[:available_slots]:
live = self.running_tasks.get(task.id)
if live is not None and live.poll() is None:
# Never overwrite the handle of a still-running worker.
logger.error(
"Task %s is 'ready' but its worker (pid %s) is still running; "
"skipping re-dispatch", task.id, live.pid,
)
continue
try:
# Try to claim the task atomically with a lease + owner PID.
claimed = self._claim_task(store, task)
@@ -245,8 +271,24 @@ class KanbanDispatcher:
)
continue
# Spawn worker process
success = await self._spawn_worker(task, store)
# Spawn worker process. If the dispatcher is stopped while the
# worktree is being prepared, no worker exists yet: close the
# run and hand the claim back before propagating.
try:
success = await self._spawn_worker(task, store)
except asyncio.CancelledError:
self._close_run_safe(
store, run_id, 'failed',
error='Dispatcher stopped before worker spawn',
)
try:
store.release_claim(task.id, self.worker_id)
except Exception as release_err:
logger.error(
"Failed to release claim for %s on cancel: %s",
task.id, release_err,
)
raise
if not success:
# Failed to spawn: close run as failed, count it, and only
# release the claim for retry when the failure was recorded
@@ -394,6 +436,69 @@ class KanbanDispatcher:
(pid, datetime.now(timezone.utc).isoformat(), task_id, self.worker_id),
)
def _heartbeat_children(self, store: Any):
"""Renew lease + heartbeat for every child worker that is still alive.
The spawned worker cannot heartbeat for itself, so the supervisor that
holds its ``Popen`` handle does it. If the claim is gone (an operator
released or moved the card), the child is terminated rather than left
running unowned.
"""
beat = getattr(store, 'heartbeat', None)
if beat is None:
return
for task_id, process in list(self.running_tasks.items()):
if process.poll() is not None:
continue
try:
owned = beat(task_id, self.worker_id, ttl_seconds=self.claim_ttl_seconds)
except Exception as e:
logger.debug(f"Heartbeat for task {task_id} failed: {e}")
continue
if not owned:
logger.warning(
f"Lost claim on task {task_id} while worker {process.pid} "
f"was running; terminating it"
)
self._terminate_unowned(store, task_id, process)
def _terminate_unowned(self, store: Any, task_id: str, process: subprocess.Popen):
"""Stop a child whose claim is no longer ours and forget its tracking."""
try:
process.terminate()
process.wait(timeout=5)
except subprocess.TimeoutExpired:
process.kill()
except OSError as e:
logger.error(f"Failed to terminate worker for task {task_id}: {e}")
self.running_tasks.pop(task_id, None)
entry = getattr(self, '_worktrees', {}).get(task_id)
if entry:
# Lossless teardown: keep tracking (and say why) if work remains.
preserved = self._remove_worktree(*entry)
if preserved is None:
self._worktrees.pop(task_id, None)
else:
try:
store.add_comment(
task_id, self.worker_id,
f"worktree_preserved at {entry[0]}: {preserved}",
)
except Exception:
pass
log_path = getattr(self, '_temp_logs', {}).pop(task_id, None)
if log_path:
try:
os.unlink(log_path)
except OSError:
pass
run_id = self._task_runs.get(task_id)
if run_id is None or self._close_run_safe(
store, run_id, 'failed',
error='Claim lost while worker was running; worker terminated',
):
self._task_runs.pop(task_id, None)
def _reclaim_stale_claims(self, store: Any):
"""Sweep running tasks and reclaim those stranded by dead/stale workers."""
reclaim = getattr(store, 'reclaim_stale_claims', None)
@@ -409,6 +514,11 @@ class KanbanDispatcher:
for task_id in reclaimed or []:
logger.warning(f"Reclaimed stale kanban task {task_id} back to 'ready'")
# The store closed the abandoned run as 'crashed' atomically with
# the reclaim; count the attempt so the circuit breaker sees it.
self._record_failure_safe(
store, task_id, error='Worker died or went stale; claim reclaimed'
)
# The running -> ready transition is announced as
# KANBAN_TASK_MOVED (reclaimed=True) by the store itself;
# 'KANBAN_TASK_RECLAIMED' was never a HookEvent member and so
@@ -584,6 +694,11 @@ class KanbanDispatcher:
return f"worktree removal error: {e}"
return None
def _discard_worktree(self, path: str, branch: str) -> None:
"""Remove a worktree and branch that no worker ever used."""
if self._remove_worktree(path, force=True) is None:
self._run_git("branch", "-D", branch)
def _commit_worktree_changes(self, path: str, branch: str) -> None:
"""Commit any uncommitted edits the worker left in its worktree.
@@ -724,7 +839,22 @@ class KanbanDispatcher:
# cwd so nothing regresses.
worktree_path = None
if getattr(task, 'workspace_kind', 'default') == 'worktree':
worktree_path = self._prepare_worktree(task, store)
prep = asyncio.ensure_future(
self._run_blocking(self._prepare_worktree, task, store)
)
try:
worktree_path = await asyncio.shield(prep)
except asyncio.CancelledError:
# The thread keeps running after cancellation. Let it
# finish, then drop the fresh (unused) worktree and branch
# so a retry can recreate them with `worktree add -b`.
path = await asyncio.shield(prep)
if path:
await self._run_blocking(
self._discard_worktree, path,
f"kanban/{self._safe_task_id(task.id)}",
)
raise
if worktree_path:
if not hasattr(self, '_worktrees'):
self._worktrees = {}
@@ -753,6 +883,9 @@ class KanbanDispatcher:
stderr=subprocess.STDOUT,
text=True,
cwd=worktree_path,
# Own process group so shutdown can stop the worker's
# descendants too (POSIX; ignored on Windows).
start_new_session=(os.name != 'nt'),
)
# parent FD closed here; child still has its duped copy
@@ -1005,30 +1138,27 @@ class KanbanDispatcher:
while self.running_tasks and (time.time() - start_time) < timeout:
store = self._get_kanban_store()
if store:
self._cleanup_completed_tasks(store)
await self._run_blocking(self._cleanup_completed_tasks, store)
await asyncio.sleep(1)
# Force terminate remaining tasks
# Force terminate remaining tasks: signal every worker group
# first, then wait for them together off the event loop.
store = self._get_kanban_store()
for task_id, process in self.running_tasks.items():
logger.warning(f"Force terminating task {task_id}")
try:
process.terminate()
process.wait(timeout=5)
except subprocess.TimeoutExpired:
_terminate_worker(process)
await asyncio.gather(*(
asyncio.to_thread(_wait_quiet, process, 5)
for process in self.running_tasks.values()
))
for task_id, process in self.running_tasks.items():
if process.poll() is None:
logger.warning(f"Task {task_id} did not terminate in 5s; sending SIGKILL")
try:
process.kill()
except OSError as kill_err:
logger.error(f"Failed to kill task {task_id}: {kill_err}")
except OSError as os_err:
logger.error(f"OS error while terminating task {task_id}: {os_err}")
try:
process.kill()
except OSError as kill_err:
logger.error(f"Failed to kill task {task_id}: {kill_err}")
# KeyboardInterrupt, SystemExit, CancelledError now propagate as intended
# Even if the worker exited, a descendant may have ignored
# SIGTERM, so always finish off the whole group.
_kill_worker_group(process)
for task_id in list(self.running_tasks):
# Close any open run for the interrupted attempt so we do not
# leave dangling task_runs rows / stale current_run_id pointers.
run_id = self._task_runs.pop(task_id, None)
@@ -1044,6 +1174,49 @@ class KanbanDispatcher:
logger.info("Kanban dispatcher shutdown complete")
def _terminate_worker(process: subprocess.Popen) -> None:
"""Ask a worker and its descendants to exit (SIGTERM to its group)."""
try:
if os.name != 'nt':
os.killpg(process.pid, signal.SIGTERM)
else:
process.terminate()
except OSError:
try:
process.terminate()
except OSError as err:
logger.error(f"Failed to terminate worker {process.pid}: {err}")
def _kill_worker_group(process: subprocess.Popen) -> None:
"""SIGKILL a worker's group, even after the worker itself was reaped.
The worker leads its own session, so its group id equals its pid and the
group stays addressable while any descendant is alive.
"""
if os.name == 'nt':
if process.poll() is None:
_kill_process_group(process)
return
try:
os.killpg(process.pid, signal.SIGKILL)
except OSError:
pass # group already empty
if process.poll() is None:
try:
process.kill()
except OSError:
pass
def _wait_quiet(process: subprocess.Popen, timeout: float) -> None:
"""Wait for a process, ignoring a timeout (the caller escalates)."""
try:
process.wait(timeout=timeout)
except subprocess.TimeoutExpired:
pass
# Global dispatcher management functions
async def start_kanban_dispatcher(max_concurrent: int = 3, poll_interval: float = 5.0):
@@ -9,6 +9,7 @@ from __future__ import annotations
import asyncio
import hashlib
import inspect
import logging
import math
import os
@@ -4636,17 +4637,29 @@ class WebSocketGateway:
except Exception:
pass
async def _call_async(fn: Any) -> Any:
def _kwargs_for(fn: Any) -> Dict[str, Any]:
# Issue #5884: decide the calling convention *before* invoking, so
# an application ``TypeError`` raised inside the entry point is
# never mistaken for a missing ``cancel_token`` and replayed.
if not _kw:
return _kw
try:
result = await fn(content, **_kw)
except TypeError:
if not _kw:
raise
# Entry point predates cancel_token: fall back to the shared
# attribute for this turn (best-effort, non-isolated).
if hasattr(agent, "interrupt_controller"):
agent.interrupt_controller = interrupt
result = await fn(content)
params = inspect.signature(fn).parameters.values()
except (TypeError, ValueError):
return _kw
if any(
p.name == "cancel_token" or p.kind is inspect.Parameter.VAR_KEYWORD
for p in params
):
return _kw
# Entry point predates cancel_token: fall back to the shared
# attribute for this turn (best-effort, non-isolated).
if hasattr(agent, "interrupt_controller"):
agent.interrupt_controller = interrupt
return {}
async def _call_async(fn: Any) -> Any:
result = await fn(content, **_kwargs_for(fn))
# No ``await`` between the turn completing and the snapshot: the
# single-threaded loop cannot run another turn in between.
_snapshot()
@@ -4660,14 +4673,7 @@ class WebSocketGateway:
loop = asyncio.get_running_loop()
def _call_sync() -> Any:
try:
result = agent.chat(content, **_kw)
except TypeError:
if not _kw:
raise
if hasattr(agent, "interrupt_controller"):
agent.interrupt_controller = interrupt
result = agent.chat(content)
result = agent.chat(content, **_kwargs_for(agent.chat))
# Snapshot in *this* worker thread, immediately after the turn
# produced its result, before the thread returns to the pool and a
# concurrent turn can overwrite the agent's shared metrics.
@@ -7680,6 +7686,14 @@ class WebSocketGateway:
return None
cfg = (self._loaded_config or {}).get("scheduler", {}) or {}
if not isinstance(cfg, dict):
# A malformed (e.g. hot-reloaded) ``scheduler:`` block must not
# kill the tick loop — fall back to the fail-closed defaults.
logger.warning(
"Ignoring non-mapping 'scheduler:' config (%s); using defaults",
type(cfg).__name__,
)
cfg = {}
denied = cfg.get("denied_toolsets")
denied_toolsets = (
set(denied) if isinstance(denied, (list, tuple, set))
@@ -7756,16 +7770,33 @@ class WebSocketGateway:
# keeps a long-lived gateway from pinning stale unattended-run
# settings. Falls back to ``run_loop`` when the executor predates
# per-tick policy refresh.
# A tick that raises (store I/O such as EMFILE on the lock file, a
# bad config) is logged and retried with capped backoff instead of
# ending the task — otherwise scheduling would silently stop for
# good while chat channels keep the gateway looking healthy.
failures = 0
try:
while True:
executor._run_policy = self._build_run_policy()
await executor.tick_all()
await asyncio.sleep(interval)
try:
executor._run_policy = self._build_run_policy()
await executor.tick_all()
failures = 0
except asyncio.CancelledError:
raise
except Exception:
failures += 1
logger.exception(
"Scheduler tick failed (%d in a row)", failures,
)
await asyncio.sleep(
min(interval * 2 ** min(failures, 10), 300.0) if failures
else interval
)
except asyncio.CancelledError:
pass
self._scheduler_task = asyncio.create_task(_run())
logger.info("Scheduler tick started (interval=15s)")
logger.info("Scheduler tick started (interval=%ss)", interval)
async def _start_session_cleanup(self) -> None:
"""Start periodic cleanup of expired sessions."""
@@ -1094,7 +1094,8 @@ class SQLiteKanbanStore:
with self._get_connection() as conn:
cursor = conn.execute("""
SELECT id, claim_lock, claim_expires, worker_pid, last_heartbeat_at, version
SELECT id, claim_lock, claim_expires, worker_pid, last_heartbeat_at, version,
current_run_id
FROM tasks
WHERE status = 'running' AND claim_lock IS NOT NULL AND claim_lock != ''
""")
@@ -1127,7 +1128,7 @@ class SQLiteKanbanStore:
result = conn.execute("""
UPDATE tasks
SET claim_lock = NULL, claim_expires = NULL, worker_pid = NULL,
last_heartbeat_at = NULL,
last_heartbeat_at = NULL, current_run_id = NULL,
updated_at = ?, status = 'ready', version = version + 1
WHERE id = ? AND status = 'running' AND claim_lock = ?
AND version = ?
@@ -1136,6 +1137,20 @@ class SQLiteKanbanStore:
if result.rowcount > 0:
reclaimed.append(row['id'])
reason = 'dead' if not worker_alive else 'stale_heartbeat'
# Close the abandoned attempt in the same transaction, so a
# dispatcher that claims the task next can never have its
# own fresh run mistaken for this one.
if row.get('current_run_id') is not None and conn.execute(
"UPDATE task_runs SET outcome = ?, error = ?, ended_at = ? "
"WHERE id = ? AND ended_at IS NULL",
(RunOutcome.CRASHED.value,
f'Worker {reason}; claim reclaimed',
now.isoformat(), row['current_run_id']),
).rowcount:
self._log_event(conn, row['id'], 'run_closed', {
'run_id': row['current_run_id'],
'outcome': RunOutcome.CRASHED.value,
})
reclaim_details[row['id']] = {
'worker_id': row['claim_lock'],
'worker_pid': pid,
+1 -1
View File
@@ -1,6 +1,6 @@
[project]
name = "praisonai-bot"
version = "0.1.15"
version = "0.1.16"
description = "Bots, gateway, and channel CLI for PraisonAI — messaging platforms and WebSocket control plane extracted from the praisonai wrapper."
readme = "README.md"
license = "MIT"
@@ -0,0 +1,80 @@
#!/usr/bin/env python3
"""Issue #5884: ``_dispatch_agent_turn`` must not replay a turn whose entry
point raised an internal ``TypeError``; legacy entry points without
``cancel_token`` are detected from the signature before invoking."""
import sys
from pathlib import Path
import pytest
REPO_ROOT = Path(__file__).resolve().parents[5]
sys.path.insert(0, str(REPO_ROOT / "src" / "praisonai-agents"))
from praisonai_bot.gateway.server import WebSocketGateway
_dispatch = WebSocketGateway._dispatch_agent_turn
_TOKEN = object()
class _FailingSync:
interrupt_controller = None
def __init__(self):
self.calls = []
def chat(self, content, cancel_token=None):
self.calls.append(cancel_token)
raise TypeError("application failure")
class _FailingAsync(_FailingSync):
async def achat(self, content, cancel_token=None):
self.calls.append(cancel_token)
raise TypeError("application failure")
class _LegacySync:
interrupt_controller = None
def __init__(self):
self.calls = 0
def chat(self, content):
self.calls += 1
return f"sync:{content}"
class _LegacyAsync(_LegacySync):
async def achat(self, content):
self.calls += 1
return f"async:{content}"
class _KwargsAsync:
async def achat(self, content, **kwargs):
return kwargs.get("cancel_token")
@pytest.mark.asyncio
@pytest.mark.parametrize("cls", [_FailingSync, _FailingAsync])
async def test_internal_type_error_is_not_replayed(cls):
agent = cls()
with pytest.raises(TypeError, match="application failure"):
await _dispatch(agent, "hi", interrupt=_TOKEN)
assert agent.calls == [_TOKEN]
assert agent.interrupt_controller is None
@pytest.mark.asyncio
@pytest.mark.parametrize("cls,prefix", [(_LegacySync, "sync"), (_LegacyAsync, "async")])
async def test_legacy_signature_uses_shared_controller(cls, prefix):
agent = cls()
assert await _dispatch(agent, "hi", interrupt=_TOKEN) == f"{prefix}:hi"
assert agent.calls == 1
assert agent.interrupt_controller is _TOKEN
@pytest.mark.asyncio
async def test_var_keyword_receives_cancel_token():
assert await _dispatch(_KwargsAsync(), "hi", interrupt=_TOKEN) is _TOKEN
@@ -0,0 +1,167 @@
"""Regression tests for #6025: the dispatcher heartbeats its own children.
A healthy worker that outlives the claim lease + stale timeout must not be
reclaimed and re-dispatched while it is still running.
"""
import asyncio
import subprocess
import sys
import pytest
from praisonai_bot.gateway.kanban_dispatcher import KanbanDispatcher
from praisonai_bot.kanban.sqlite_store import SQLiteKanbanStore
pytestmark = pytest.mark.skipif(sys.platform == "win32", reason="uses sleep stub")
class _StubDispatcher(KanbanDispatcher):
def __init__(self, store, seconds, **kwargs):
super().__init__(**kwargs)
self._store = store
self._seconds = seconds
def _get_kanban_store(self):
return self._store
def _build_execution_command(self, task):
return [sys.executable, "-c", f"import time; time.sleep({self._seconds})"]
@pytest.fixture
def store(tmp_path, monkeypatch):
monkeypatch.setenv("PRAISONAI_KANBAN_DB", str(tmp_path / "kanban.db"))
return SQLiteKanbanStore()
def _run(coro):
return asyncio.run(coro)
def test_long_running_worker_is_not_reclaimed(store):
store.create_task({"id": "t1", "title": "long job", "status": "ready",
"workspace_kind": "default"})
d = _StubDispatcher(store, 5, max_concurrent=3, poll_interval=0.5,
claim_ttl_seconds=1, stale_timeout_seconds=2)
async def drive():
handles = []
loop = asyncio.get_running_loop()
t0 = loop.time()
while loop.time() - t0 < 4.5:
await d.dispatch_once()
proc = d.running_tasks.get("t1")
if proc is not None and proc not in handles:
handles.append(proc)
await asyncio.sleep(0.25)
return handles
handles = _run(drive())
try:
assert len(handles) == 1
runs = store.get_runs("t1")
assert len(runs) == 1
assert runs[0].ended_at is None
assert not [e for e in store.list_events()
if e.task_id == "t1" and e.event_type == "reclaimed"]
handles[0].wait(timeout=10)
_run(d.dispatch_once())
runs = store.get_runs("t1")
assert len(runs) == 1
assert runs[0].outcome == "completed"
assert store.get_task("t1").status == "done"
finally:
for p in handles:
if p.poll() is None:
p.kill()
def test_lost_claim_terminates_child(store):
store.create_task({"id": "t2", "title": "job", "status": "ready",
"workspace_kind": "default"})
d = _StubDispatcher(store, 30, max_concurrent=1, poll_interval=0.5)
_run(d.dispatch_once())
proc = d.running_tasks["t2"]
try:
store.release_claim("t2", d.worker_id) # operator takes the card back
d._heartbeat_children(store)
assert "t2" not in d.running_tasks
assert proc.wait(timeout=10) is not None
runs = store.get_runs("t2")
assert len(runs) == 1 and runs[0].outcome == "failed"
finally:
if proc.poll() is None:
proc.kill()
def test_reclaim_of_dead_worker_closes_run_and_counts_failure(store):
store.create_task({"id": "t3", "title": "job", "status": "ready",
"workspace_kind": "default"})
# Simulate another dispatcher whose worker has died.
assert store.claim_task("t3", "other", ttl_seconds=0, worker_pid=0)
run_id = store.start_run("t3", profile="other")
d = KanbanDispatcher(claim_ttl_seconds=1, stale_timeout_seconds=1)
d._reclaim_stale_claims(store)
run = [r for r in store.get_runs("t3") if r.id == run_id][0]
assert run.outcome == "crashed"
assert run.ended_at
assert store.get_task("t3").consecutive_failures == 1
def test_live_handle_is_never_overwritten(store):
store.create_task({"id": "t4", "title": "job", "status": "ready",
"workspace_kind": "default"})
d = _StubDispatcher(store, 30, max_concurrent=2)
proc = subprocess.Popen([sys.executable, "-c", "import time; time.sleep(30)"])
d.running_tasks["t4"] = proc
d._heartbeat_children = lambda _store: None # isolate the spawn guard
try:
assert _run(d.dispatch_once()) == 0
assert d.running_tasks["t4"] is proc
finally:
proc.kill()
proc.wait()
def test_reclaim_closes_run_atomically_so_replacement_run_survives(store):
store.create_task({"id": "t5", "title": "job", "status": "ready",
"workspace_kind": "default"})
assert store.claim_task("t5", "other", ttl_seconds=0, worker_pid=0)
old_run = store.start_run("t5", profile="other")
assert store.reclaim_stale_claims(stale_timeout_seconds=1) == ["t5"]
assert store.get_task("t5").current_run_id is None
assert any(e.event_type == "run_closed" and e.task_id == "t5"
for e in store.list_events())
# Another dispatcher wins the reclaimed task before ours reacts.
assert store.claim_task("t5", "rival", ttl_seconds=60)
new_run = store.start_run("t5", profile="rival")
KanbanDispatcher()._reclaim_stale_claims(store)
runs = {r.id: r for r in store.get_runs("t5")}
assert runs[old_run].outcome == "crashed"
assert runs[new_run].ended_at is None
def test_lost_claim_keeps_worktree_tracking_when_work_is_preserved(store):
store.create_task({"id": "t6", "title": "job", "status": "ready",
"workspace_kind": "default"})
d = _StubDispatcher(store, 30, max_concurrent=1)
_run(d.dispatch_once())
proc = d.running_tasks["t6"]
d._worktrees = {"t6": ("/tmp/wt-t6", "kanban/t6")}
d._remove_worktree = lambda path, branch: "worktree has uncommitted changes"
try:
store.release_claim("t6", d.worker_id)
d._heartbeat_children(store)
assert "t6" not in d.running_tasks
assert d._worktrees == {"t6": ("/tmp/wt-t6", "kanban/t6")}
assert any("worktree_preserved" in c.text for c in store.get_comments("t6"))
finally:
if proc.poll() is None:
proc.kill()
@@ -0,0 +1,136 @@
"""The kanban dispatcher must not run blocking git work on the event loop."""
import asyncio
import itertools
import os
import subprocess
import sys
import threading
import time
import types
import pytest
import praisonai_bot.gateway.kanban_dispatcher as kd
from praisonai_bot.kanban.sqlite_store import SQLiteKanbanStore
GIT_DELAY = 0.5
class _Stub(kd.KanbanDispatcher):
def _build_execution_command(self, task):
return ["true"]
async def _heartbeat(gaps, stop):
last = time.monotonic()
while not stop.is_set():
await asyncio.sleep(0.05)
now = time.monotonic()
gaps.append(now - last)
last = now
@pytest.fixture
def slow_git(tmp_path, monkeypatch):
"""Patch ``run_guarded`` with a synchronous sleep, recording overlap."""
monkeypatch.setenv("PRAISONAI_KANBAN_DB", str(tmp_path / "kanban.db"))
monkeypatch.setenv("HOME", str(tmp_path))
monkeypatch.chdir(tmp_path)
state = {"active": 0, "max_active": 0, "calls": []}
lock = threading.Lock()
def fake(cmd, *, timeout=None, cwd=None, **kw):
with lock:
state["active"] += 1
state["max_active"] = max(state["max_active"], state["active"])
state["calls"].append(" ".join(cmd[:3]))
try:
time.sleep(GIT_DELAY)
if list(cmd[1:3]) == ["worktree", "add"]:
os.makedirs(cmd[3], exist_ok=True)
out = {"rev-parse": "main\n", "rev-list": "0\n"}.get(cmd[1], "")
return subprocess.CompletedProcess(cmd, 0, stdout=out, stderr="")
finally:
with lock:
state["active"] -= 1
monkeypatch.setattr(kd, "run_guarded", fake)
return state
@pytest.mark.skipif(sys.platform == "win32", reason="uses the POSIX `true` worker")
async def test_dispatch_does_not_block_event_loop(slow_git):
store = SQLiteKanbanStore()
store.create_task({"id": "w1", "title": "isolated", "status": "ready",
"workspace_kind": "worktree"})
d = _Stub(max_concurrent=1)
gaps, stop = [], asyncio.Event()
hb = asyncio.create_task(_heartbeat(gaps, stop))
await asyncio.sleep(0.1)
assert await d.dispatch_once() == 1 # spawn: rev-parse + worktree add
await asyncio.to_thread(d.running_tasks["w1"].wait)
await d.dispatch_once() # completion: commit/merge/cleanup
await asyncio.sleep(0.1)
stop.set()
await hb
assert "git worktree add" in slow_git["calls"]
assert "git merge --no-ff" in slow_git["calls"]
assert max(gaps) < 0.3, f"event loop stalled for {max(gaps):.2f}s"
async def test_blocking_work_is_serialised(slow_git):
a, b = _Stub(), _Stub()
await asyncio.gather(
a._run_blocking(a._run_git, "status"),
b._run_blocking(b._run_git, "status"),
)
assert slow_git["max_active"] == 1
async def test_cancel_during_worktree_prep_cleans_up(slow_git):
store = SQLiteKanbanStore()
store.create_task({"id": "w1", "title": "isolated", "status": "ready",
"workspace_kind": "worktree"})
d = _Stub(max_concurrent=1)
t = asyncio.create_task(d.dispatch_once())
await asyncio.sleep(GIT_DELAY + 0.1) # inside `git worktree add`
t.cancel()
with pytest.raises(asyncio.CancelledError):
await t
assert "git worktree remove" in slow_git["calls"]
assert "git branch -D" in slow_git["calls"]
assert not d.running_tasks
assert store.get_task("w1").status == "ready"
assert all(r.ended_at for r in store.get_runs("w1"))
@pytest.mark.skipif(sys.platform == "win32", reason="POSIX process groups")
async def test_shutdown_terminates_worker_descendants(tmp_path, monkeypatch):
monkeypatch.setenv("PRAISONAI_KANBAN_DB", str(tmp_path / "kanban.db"))
marker = tmp_path / "survived"
class _Spawner(kd.KanbanDispatcher):
def _build_execution_command(self, task):
# Worker exits on SIGTERM, but its child ignores SIGTERM and
# would leave a marker if it outlived shutdown.
return ["sh", "-c",
f"(trap '' TERM; sleep 1; touch {marker}) & wait"]
class _Task:
id, board, title, body = "t1", "default", "t1", ""
d = _Spawner()
assert await d._spawn_worker(_Task(), store=None)
await asyncio.sleep(0.2)
# Skip the 30 s graceful window; go straight to force-terminate.
ticks = itertools.count(step=1000)
monkeypatch.setattr(kd, "time", types.SimpleNamespace(time=lambda: next(ticks)))
await d._shutdown()
await asyncio.sleep(1.5)
assert not marker.exists(), "worker's descendant survived shutdown"
@@ -0,0 +1,61 @@
"""The gateway scheduler tick loop survives a failing tick (issue #6035)."""
import asyncio
import tempfile
import pytest
pytest.importorskip("praisonaiagents.scheduler")
import praisonaiagents.scheduler as sched_pkg
from praisonaiagents.scheduler.store import FileScheduleStore
from praisonai_bot.gateway.server import WebSocketGateway
from praisonai_bot.scheduler.executor import ScheduledAgentExecutor
def _bare_gateway(config=None):
gw = WebSocketGateway.__new__(WebSocketGateway) # skip heavy __init__
gw._agents, gw._loaded_config, gw._scheduler_task = {}, config or {}, None
async def _deliver(*a, **k):
return None
gw._deliver_scheduled_result = _deliver
return gw
async def test_tick_loop_survives_exception(monkeypatch):
store = FileScheduleStore(store_dir=tempfile.mkdtemp())
monkeypatch.setattr(sched_pkg, "get_default_store", lambda: store)
calls = {"n": 0}
orig = ScheduledAgentExecutor.tick_all
async def flaky_tick_all(self):
calls["n"] += 1
if calls["n"] == 1:
raise OSError(24, "Too many open files")
return await orig(self)
monkeypatch.setattr(ScheduledAgentExecutor, "tick_all", flaky_tick_all)
gw = _bare_gateway()
gw._start_scheduler_tick(interval=0.01)
try:
await asyncio.sleep(0.3)
assert calls["n"] >= 2
assert not gw._scheduler_task.done()
finally:
gw._scheduler_task.cancel()
await asyncio.gather(gw._scheduler_task, return_exceptions=True)
def test_non_mapping_scheduler_block_uses_defaults():
pytest.importorskip("praisonai.scheduler.run_policy")
gw = _bare_gateway({"scheduler": ["x"]})
policy = gw._build_run_policy()
assert policy is not None
assert policy.deliver_on_failure is True
assert policy.scan_assembled_prompt is True
from praisonai.scheduler.run_policy import DEFAULT_DENIED_TOOLSETS
assert policy.denied_toolsets == set(DEFAULT_DENIED_TOOLSETS)
@@ -0,0 +1,53 @@
"""Cross-channel group admission parity via the core primitive (Issue #5908)."""
from types import SimpleNamespace
import pytest
from praisonaiagents.bots.admission import MentionFacts
from praisonai_bot.bots._group_policy import decide_group_admission
def _admit(chat_type="group", explicit=False, reply_to_bot=False, is_command=False, **cfg):
return decide_group_admission(
SimpleNamespace(**cfg),
chat_type=chat_type,
mention=MentionFacts(explicit=explicit, reply_to_bot=reply_to_bot),
is_command=is_command,
)
def test_dm_always_admitted():
assert _admit(chat_type="dm", group_policy="command_only").admit
assert _admit(chat_type="im", group_policy="command_only").admit
def test_mention_only_admits_explicit_and_reply_to_bot():
cfg = dict(group_policy="mention_only", mention_required=True)
assert _admit(explicit=True, **cfg).admit
assert _admit(reply_to_bot=True, **cfg).admit
decision = _admit(**cfg)
assert not decision.admit
assert decision.reason_code == "group_mention_only"
def test_command_only_drops_mentions():
# Gateway sets mention_required=False for command_only; it must not open
# the gate to all group traffic.
cfg = dict(group_policy="command_only", mention_required=False)
assert not _admit(explicit=True, **cfg).admit
assert _admit(is_command=True, **cfg).admit
def test_observe_flags_passive_record():
decision = _admit(group_policy="observe", mention_required=False)
assert not decision.admit and decision.observe
def test_legacy_mention_required_false_responds_all():
assert _admit(group_policy="mention_only", mention_required=False).admit
@pytest.mark.parametrize("policy", [None, "bogus"])
def test_unset_or_unknown_policy_fails_safe(policy):
assert not _admit(group_policy=policy).admit
+4 -4
View File
@@ -1428,7 +1428,7 @@ wheels = [
[[package]]
name = "praisonai-bot"
version = "0.1.15"
version = "0.1.16"
source = { editable = "." }
dependencies = [
{ name = "aiohttp" },
@@ -1510,7 +1510,7 @@ provides-extras = ["gateway", "bot", "bot-whatsapp-web", "all"]
[[package]]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
source = { directory = "../praisonai-agents" }
dependencies = [
{ name = "aiohttp" },
@@ -1539,8 +1539,8 @@ requires-dist = [
{ name = "fastapi", marker = "extra == 'api'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'mcp'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'os'", specifier = ">=0.115.0" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14,<1.106" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14,<1.106" },
{ name = "markitdown", extras = ["all"], marker = "extra == 'knowledge'", specifier = ">=0.1.0" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.20.0,<2" },
{ name = "mcp", marker = "extra == 'parallel-search'", specifier = ">=1.30.0,<2" },
@@ -1 +1 @@
__version__ = "0.1.15"
__version__ = "0.1.16"
+1 -1
View File
@@ -1,6 +1,6 @@
[project]
name = "praisonai-browser"
version = "0.1.15"
version = "0.1.16"
description = "Browser automation for PraisonAI — Chrome extension bridge, CDP, and Playwright agents extracted from the praisonai wrapper."
readme = "README.md"
license = {text = "MIT"}
@@ -553,7 +553,7 @@ class TestRegisterRole:
{"type": "start_session", "goal": "Test"}, conn
)
assert response["code"] == "NO_EXTENSION"
conn.websocket.send_text.assert_not_awaited()
conn.websocket.send_json.assert_not_awaited()
@pytest.mark.asyncio
async def test_ws_no_origin_cli_start_session(self):
@@ -571,8 +571,8 @@ class TestRegisterRole:
{"type": "start_session", "goal": "Test"}, cli
)
assert response["status"] == "running"
ext.websocket.send_text.assert_awaited_once()
cli.websocket.send_text.assert_not_awaited()
ext.websocket.send_json.assert_awaited_once()
cli.websocket.send_json.assert_not_awaited()
if server._sessions:
server._sessions.close()
+4 -4
View File
@@ -932,7 +932,7 @@ wheels = [
[[package]]
name = "praisonai-browser"
version = "0.1.15"
version = "0.1.16"
source = { editable = "." }
dependencies = [
{ name = "click" },
@@ -976,7 +976,7 @@ provides-extras = ["server", "playwright", "all"]
[[package]]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
source = { directory = "../praisonai-agents" }
dependencies = [
{ name = "aiohttp" },
@@ -1005,8 +1005,8 @@ requires-dist = [
{ name = "fastapi", marker = "extra == 'api'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'mcp'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'os'", specifier = ">=0.115.0" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14,<1.106" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14,<1.106" },
{ name = "markitdown", extras = ["all"], marker = "extra == 'knowledge'", specifier = ">=0.1.0" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.20.0,<2" },
{ name = "mcp", marker = "extra == 'parallel-search'", specifier = ">=1.30.0,<2" },
@@ -12,6 +12,6 @@ the remaining terminal-agent modules, with PEP 562 shims left behind at the
old ``praisonai.*`` paths for backward compatibility.
"""
__version__ = "0.1.15"
__version__ = "0.1.16"
__all__ = ["__version__"]
@@ -88,8 +88,11 @@ def _run_loop(
typer.echo("Error: praisonaiagents not installed. Run: pip install praisonaiagents", err=True)
raise typer.Exit(1)
# Build autonomy config
# Build autonomy config. `loop` always iterates: without an explicit mode
# the default level (suggest) maps to single-call "caller" mode, which
# would ignore --completion-promise and --max-iterations.
autonomy_config = {
"mode": "iterative",
"max_iterations": max_iterations,
"completion_promise": completion_promise,
"clear_context": clear_context,
@@ -889,29 +889,31 @@ class PraisonAI:
except Exception:
pass # Continue even if flow display fails
# Initialize trace variables for cleanup
trace_writer = None
trace_emitter = None
trace_emitter_token = None
# Get save flag for replay trace
save_replay = getattr(args, 'save', False)
# Initialize replay trace writer if --save flag is set
# Replay trace: --save, or ``save_replay: true`` in the YAML. Recording
# lives in the wrapper (praisonai.replay.record); reach it through the
# bridge so a standalone praisonai-code install still runs, untraced.
import contextlib
import uuid
from praisonai_code._wrapper_bridge import optional_wrapper_attr
run_id = f"run-{uuid.uuid4().hex[:12]}"
save_replay = getattr(args, 'save', False)
if not save_replay:
yaml_wants_replay = optional_wrapper_attr('praisonai.replay.yaml_run', 'yaml_wants_replay')
if yaml_wants_replay is not None:
save_replay = yaml_wants_replay(self.agent_file, self.agent_yaml)
replay_stack = contextlib.ExitStack()
recording = None
if save_replay:
try:
from praisonai_code._wrapper_bridge import import_wrapper_module
_mod = import_wrapper_module('praisonai.replay')
ContextTraceWriter = getattr(_mod, 'ContextTraceWriter')
from praisonaiagents.trace.context_events import ContextTraceEmitter, set_context_emitter
trace_writer = ContextTraceWriter(session_id=run_id)
trace_emitter = ContextTraceEmitter(sink=trace_writer, session_id=run_id)
# Set as global emitter so agents can access it
trace_emitter_token = set_context_emitter(trace_emitter)
trace_emitter.session_start({"agents_file": self.agent_file, "run_id": run_id})
record = optional_wrapper_attr('praisonai.replay', 'record')
if record is None:
raise ImportError("praisonai.replay is not installed")
meta = {"agents_file": self.agent_file, "run_id": run_id}
if self.agent_file and os.path.isfile(self.agent_file):
meta["yaml_path"] = os.path.abspath(self.agent_file)
recording = replay_stack.enter_context(record(run_id, meta=meta))
print(f"[cyan]📝 Replay trace enabled: {run_id}[/cyan]")
except ImportError as e:
import logging
@@ -919,8 +921,8 @@ class PraisonAI:
except Exception as e:
import logging
logging.warning(f"Failed to initialize trace writer: {e}")
try:
with replay_stack:
AgentsGenerator = _get_agents_generator()
# Extract CLI configuration for YAML CLI parity
cli_config = self._extract_cli_config_for_yaml()
@@ -934,29 +936,9 @@ class PraisonAI:
) as agents_generator:
result = agents_generator.generate_crew_and_kickoff()
print(result)
# Close trace writer on success
if trace_emitter:
trace_emitter.session_end()
print(f"[cyan]📝 Replay trace saved: {run_id}[/cyan]")
if trace_writer:
trace_writer.close()
# Reset global emitter
if trace_emitter_token:
from praisonaiagents.trace.context_events import reset_context_emitter
reset_context_emitter(trace_emitter_token)
return result
except Exception as e:
# Cleanup trace on error
if trace_emitter:
trace_emitter.session_end()
if trace_writer:
trace_writer.close()
if trace_emitter_token:
from praisonaiagents.trace.context_events import reset_context_emitter
reset_context_emitter(trace_emitter_token)
raise
if recording is not None:
print(f"[cyan]📝 Replay trace saved: {run_id}[/cyan]")
return result
def parse_args(self):
"""
+2 -2
View File
@@ -1,6 +1,6 @@
[project]
name = "praisonai-code"
version = "0.1.15"
version = "0.1.16"
description = "Agentic terminal CLI for PraisonAI — the terminal-native agent (run, chat, code, runtime, cli backends) extracted from the praisonai wrapper."
readme = "README.md"
license = {text = "MIT"}
@@ -16,7 +16,7 @@ dependencies = [
"textual>=0.47.0",
"PyYAML>=6.0",
"python-dotenv>=0.19.0",
"litellm>=1.83.14,<2",
"litellm>=1.83.14,<1.106", # 1.106+ imports mcp>=2.2 types; we pin mcp<2
"mcp>=1.20.0,<2",
"pydantic>=2.0.0",
"toml>=0.10.2",
@@ -0,0 +1,19 @@
"""`praisonai loop` must run the iterative autonomy loop by default (#6027)."""
from unittest.mock import MagicMock, patch
from praisonai_code.cli.commands.loop import _run_loop
def test_loop_builds_iterative_autonomy_config():
result = MagicMock(success=True, completion_reason="promise", iterations=2,
duration_seconds=0.1, started_at=None)
with patch("praisonaiagents.Agent") as agent_cls:
agent_cls.return_value.start.return_value = result
_run_loop("Refactor auth module", max_iterations=10, completion_promise="DONE",
clear_context=False, timeout=None, model=None, verbose=False)
autonomy = agent_cls.call_args.kwargs["autonomy"]
assert autonomy["mode"] == "iterative"
assert autonomy["completion_promise"] == "DONE"
assert autonomy["max_iterations"] == 10
+5 -5
View File
@@ -1370,7 +1370,7 @@ wheels = [
[[package]]
name = "praisonai-code"
version = "0.1.15"
version = "0.1.16"
source = { editable = "." }
dependencies = [
{ name = "click" },
@@ -1389,7 +1389,7 @@ dependencies = [
[package.metadata]
requires-dist = [
{ name = "click", specifier = ">=8.4.2" },
{ name = "litellm", specifier = ">=1.83.14,<2" },
{ name = "litellm", specifier = ">=1.83.14,<1.106" },
{ name = "mcp", specifier = ">=1.20.0,<2" },
{ name = "praisonaiagents", directory = "../praisonai-agents" },
{ name = "pydantic", specifier = ">=2.0.0" },
@@ -1403,7 +1403,7 @@ requires-dist = [
[[package]]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
source = { directory = "../praisonai-agents" }
dependencies = [
{ name = "aiohttp" },
@@ -1432,8 +1432,8 @@ requires-dist = [
{ name = "fastapi", marker = "extra == 'api'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'mcp'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'os'", specifier = ">=0.115.0" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14,<1.106" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14,<1.106" },
{ name = "markitdown", extras = ["all"], marker = "extra == 'knowledge'", specifier = ">=0.1.0" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.20.0,<2" },
{ name = "mcp", marker = "extra == 'parallel-search'", specifier = ">=1.30.0,<2" },
@@ -1 +1 @@
__version__ = "0.1.15"
__version__ = "0.1.16"
+1 -1
View File
@@ -1,6 +1,6 @@
[project]
name = "praisonai-deploy"
version = "0.1.15"
version = "0.1.16"
description = "Deployment for PraisonAI — API, Docker, and cloud (AWS, Azure, GCP) deployments extracted from the praisonai wrapper."
readme = "README.md"
license = {text = "MIT"}
+4 -4
View File
@@ -977,7 +977,7 @@ wheels = [
[[package]]
name = "praisonai-deploy"
version = "0.1.15"
version = "0.1.16"
source = { editable = "." }
dependencies = [
{ name = "click" },
@@ -1014,7 +1014,7 @@ provides-extras = ["api", "all"]
[[package]]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
source = { directory = "../praisonai-agents" }
dependencies = [
{ name = "aiohttp" },
@@ -1043,8 +1043,8 @@ requires-dist = [
{ name = "fastapi", marker = "extra == 'api'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'mcp'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'os'", specifier = ">=0.115.0" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14,<1.106" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14,<1.106" },
{ name = "markitdown", extras = ["all"], marker = "extra == 'knowledge'", specifier = ">=0.1.0" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.20.0,<2" },
{ name = "mcp", marker = "extra == 'parallel-search'", specifier = ">=1.30.0,<2" },
+1 -1
View File
@@ -1 +1 @@
__version__ = "0.1.17"
__version__ = "0.1.18"
+1 -1
View File
@@ -1,6 +1,6 @@
[project]
name = "praisonai-mcp"
version = "0.1.17"
version = "0.1.18"
description = "MCP server hosting for PraisonAI — expose agents and tools to Cursor, Claude Desktop, and other MCP clients."
readme = "README.md"
license = {text = "MIT"}
+4 -4
View File
@@ -1044,7 +1044,7 @@ wheels = [
[[package]]
name = "praisonai-mcp"
version = "0.1.17"
version = "0.1.18"
source = { editable = "." }
dependencies = [
{ name = "click" },
@@ -1084,7 +1084,7 @@ provides-extras = ["server", "auth", "all"]
[[package]]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
source = { directory = "../praisonai-agents" }
dependencies = [
{ name = "aiohttp" },
@@ -1113,8 +1113,8 @@ requires-dist = [
{ name = "fastapi", marker = "extra == 'api'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'mcp'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'os'", specifier = ">=0.115.0" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14,<1.106" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14,<1.106" },
{ name = "markitdown", extras = ["all"], marker = "extra == 'knowledge'", specifier = ">=0.1.0" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.20.0,<2" },
{ name = "mcp", marker = "extra == 'parallel-search'", specifier = ">=1.30.0,<2" },
@@ -1 +1 @@
__version__ = "0.1.15"
__version__ = "0.1.16"
+1 -1
View File
@@ -1,6 +1,6 @@
[project]
name = "praisonai-sandbox"
version = "0.1.15"
version = "0.1.16"
description = "Where PraisonAI agents run code — Docker, E2B, Modal, Daytona, Fly.io, Tenki, Novita, Sandlock, SSH and subprocess, as both single sandboxes and multi-instance compute providers."
readme = "README.md"
license = {text = "MIT"}
+4 -4
View File
@@ -1679,7 +1679,7 @@ wheels = [
[[package]]
name = "praisonai-sandbox"
version = "0.1.15"
version = "0.1.16"
source = { editable = "." }
dependencies = [
{ name = "click" },
@@ -1744,7 +1744,7 @@ provides-extras = ["docker", "e2b", "sandlock", "ssh", "tenki", "flyio", "modal"
[[package]]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
source = { directory = "../praisonai-agents" }
dependencies = [
{ name = "aiohttp" },
@@ -1773,8 +1773,8 @@ requires-dist = [
{ name = "fastapi", marker = "extra == 'api'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'mcp'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'os'", specifier = ">=0.115.0" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14,<1.106" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14,<1.106" },
{ name = "markitdown", extras = ["all"], marker = "extra == 'knowledge'", specifier = ">=0.1.0" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.20.0,<2" },
{ name = "mcp", marker = "extra == 'parallel-search'", specifier = ">=1.30.0,<2" },
@@ -1 +1 @@
__version__ = "0.1.15"
__version__ = "0.1.16"
+1 -1
View File
@@ -1,6 +1,6 @@
[project]
name = "praisonai-train"
version = "0.1.15"
version = "0.1.16"
description = "Training for PraisonAI — LLM fine-tuning (Unsloth) and iterative agent training extracted from the praisonai wrapper."
readme = "README.md"
license = "MIT"
+4 -4
View File
@@ -2606,7 +2606,7 @@ wheels = [
[[package]]
name = "praisonai-train"
version = "0.1.15"
version = "0.1.16"
source = { editable = "." }
dependencies = [
{ name = "click" },
@@ -2696,7 +2696,7 @@ provides-extras = ["llm", "vision", "all"]
[[package]]
name = "praisonaiagents"
version = "1.7.16"
version = "1.7.17"
source = { directory = "../praisonai-agents" }
dependencies = [
{ name = "aiohttp" },
@@ -2725,8 +2725,8 @@ requires-dist = [
{ name = "fastapi", marker = "extra == 'api'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'mcp'", specifier = ">=0.115.0" },
{ name = "fastapi", marker = "extra == 'os'", specifier = ">=0.115.0" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14" },
{ name = "litellm", marker = "extra == 'llm'", specifier = ">=1.83.14,<1.106" },
{ name = "litellm", marker = "extra == 'memory'", specifier = ">=1.83.14,<1.106" },
{ name = "markitdown", extras = ["all"], marker = "extra == 'knowledge'", specifier = ">=0.1.0" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.20.0,<2" },
{ name = "mcp", marker = "extra == 'parallel-search'", specifier = ">=1.30.0,<2" },
+5 -5
View File
@@ -46,7 +46,7 @@ This complements `PARITY.md`, which only tracks whether an export exists.
### `Agent.__init__`
- Python: `src/praisonai-agents/praisonaiagents/agent/agent.py:624`
- Python: `src/praisonai-agents/praisonaiagents/agent/agent.py:628`
- TypeScript: `src/praisonai-ts/src/agent/simple.ts:197` (ctor `src/praisonai-ts/src/agent/simple.ts:1019`)
- Counts: 42 python params: 29 exact, 8 camelCase, 2 alias, 3 flattened, 0 missing; 8 mismatches; 8 waived; 14 TS-only of 60
@@ -99,7 +99,7 @@ TS-only members: `config`, `pretty`?, `fetch`?, `outputSchema`?, `outputSchemaNa
### `AgentTeam.__init__`
- Python: `src/praisonai-agents/praisonaiagents/agents/agents.py:804`
- Python: `src/praisonai-agents/praisonaiagents/agents/agents.py:837`
- TypeScript: `src/praisonai-ts/src/agent/team.ts:93` (ctor `src/praisonai-ts/src/agent/team.ts:381`)
- Python aliases: PraisonAIAgents, Agents
- Counts: 23 python params: 20 exact, 3 camelCase, 0 alias, 0 flattened, 0 missing; 1 mismatches; 1 waived; 3 TS-only of 26
@@ -219,7 +219,7 @@ TS-only members: `previousResult`?, `onToken`?, `signal`?, `onEvent`?, `options`
### `Agent.chat`
- Python: `src/praisonai-agents/praisonaiagents/agent/chat_mixin.py:3369`
- Python: `src/praisonai-agents/praisonaiagents/agent/chat_mixin.py:3470`
- TypeScript: `src/praisonai-ts/src/agent/simple.ts:3592`
- Counts: 17 python params: 7 exact, 9 camelCase, 1 alias, 0 flattened, 0 missing; 0 mismatches; 0 waived; 2 TS-only of 19
@@ -247,7 +247,7 @@ TS-only members: `previousResult`?, `options`?
### `AgentTeam.start`
- Python: `src/praisonai-agents/praisonaiagents/agents/agents.py:2484`
- Python: `src/praisonai-agents/praisonaiagents/agents/agents.py:2591`
- TypeScript: `src/praisonai-ts/src/agent/team.ts:1125`
- Counts: 3 python params: 2 exact, 1 camelCase, 0 alias, 0 flattened, 0 missing; 0 mismatches; 0 waived; 1 TS-only of 4
@@ -279,7 +279,7 @@ TS-only members: `condition`?, `contextPolicy`?, `maxContextTokens`?, `maxContex
### `LLM.__init__`
- Python: `src/praisonai-agents/praisonaiagents/llm/llm.py:514`
- Python: `src/praisonai-agents/praisonaiagents/llm/llm.py:673`
- TypeScript: `src/praisonai-ts/src/llm/index.ts:236` (ctor `src/praisonai-ts/src/llm/index.ts:416`)
- Counts: 25 python params: 8 exact, 16 camelCase, 1 alias, 0 flattened, 0 missing; 1 mismatches; 1 waived; 1 TS-only of 26
+5 -5
View File
@@ -1185,7 +1185,7 @@
}
],
"python": {
"location": "src/praisonai-agents/praisonaiagents/agent/agent.py:624",
"location": "src/praisonai-agents/praisonaiagents/agent/agent.py:628",
"resolved_class": "Agent"
},
"ts_only": [
@@ -1797,7 +1797,7 @@
}
],
"python": {
"location": "src/praisonai-agents/praisonaiagents/agent/chat_mixin.py:3369",
"location": "src/praisonai-agents/praisonaiagents/agent/chat_mixin.py:3470",
"resolved_class": "ChatMixin"
},
"ts_only": [
@@ -2714,7 +2714,7 @@
"PraisonAIAgents",
"Agents"
],
"location": "src/praisonai-agents/praisonaiagents/agents/agents.py:804",
"location": "src/praisonai-agents/praisonaiagents/agents/agents.py:837",
"resolved_class": "AgentTeam"
},
"ts_only": [
@@ -2852,7 +2852,7 @@
}
],
"python": {
"location": "src/praisonai-agents/praisonaiagents/agents/agents.py:2484",
"location": "src/praisonai-agents/praisonaiagents/agents/agents.py:2591",
"resolved_class": "AgentTeam"
},
"ts_only": [
@@ -4659,7 +4659,7 @@
}
],
"python": {
"location": "src/praisonai-agents/praisonaiagents/llm/llm.py:514",
"location": "src/praisonai-agents/praisonaiagents/llm/llm.py:673",
"resolved_class": "LLM"
},
"ts_only": [
Loaded 100 of 136 files, more files were not shown because too many files have changed in this diff. Show more