Skip to content

Conversation

@yarikdevcom
Copy link
Contributor

@yarikdevcom yarikdevcom commented Oct 28, 2025

Summary by CodeRabbit

  • New Features

    • Built-in agent profiling with HTML report generation and lifecycle events
    • Gemini-based LLMs: async real-time streaming with multi‑hop tool execution and chunked results
  • Changes

    • More reliable agent startup/shutdown sequencing and event processing
    • Example apps switched to ElevenLabs TTS
  • Chores

    • Added profiling tooling and example dependencies (pyinstrument)
    • Updated ignore list to exclude generated profile and opencode files
  • Documentation

    • Added Profiling section with usage and report guidance

@coderabbitai
Copy link

coderabbitai bot commented Oct 28, 2025

Walkthrough

Adds a pyinstrument-based Profiler package and hooks it into Agent lifecycle (AgentInitEvent/AgentFinishEvent), introduces EventManager producer-consumer wake signaling, converts Gemini plugin to async streaming with multi‑hop tool execution, updates examples and dependencies, and adds two .gitignore entries.

Changes

Cohort / File(s) Summary
Profiling module
agents-core/vision_agents/core/profiling/__init__.py, agents-core/vision_agents/core/profiling/base.py
New profiling package exposing Profiler; starts pyinstrument on agent creation, subscribes to AgentFinishEvent, stops profiler and writes HTML output on finish.
Agent lifecycle events
agents-core/vision_agents/core/agents/events.py
Added AgentInitEvent and AgentFinishEvent (subclasses of BaseEvent) for init/finish signaling.
Agent core
agents-core/vision_agents/core/agents/agents.py
Agent.__init__ gains profiler: Optional[Profiler] parameter; agent emits AgentInitEvent and coordinates finish via an asyncio Event, emitting AgentFinishEvent on completion.
Event manager
agents-core/vision_agents/core/events/manager.py
Added internal _received_event asyncio.Event for producer-consumer coordination; send() signals it; processing loop awaits it; exceptions now enqueue ExceptionEvent; logging tuned to debug.
Gemini plugin (LLM)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py
Switched to AsyncClient and async streaming; refactored to async iteration with per-chunk events, extraction of tool calls, multi‑hop tool execution loop (capped rounds, deduplication), sanitized tool results and follow‑up sequencing.
Examples & deps
examples/01_simple_agent_example/pyproject.toml, examples/01_simple_agent_example/simple_agent_example.py, examples/other_examples/openai_realtime_webrtc/pyproject.toml, examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py, pyproject.toml
Added pyinstrument>=5.1.1 to example and root dev deps; simple example now instantiates/passes Profiler() and swaps TTS backend; WebRTC example adds manual profiling instrumentation.
Ignores
.gitignore
Added entries for profile.html and /opencode.json.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant Agent
    participant EventManager
    participant Profiler
    participant GeminiPlugin

    App->>+Agent: init(..., profiler=Profiler())
    Agent->>EventManager: merge/register profiler events
    Agent->>EventManager: emit AgentInitEvent

    App->>Agent: run workflow
    Agent->>+GeminiPlugin: send_message (async)
    GeminiPlugin->>Agent: stream chunks (async)
    Agent->>Agent: extract tool calls per chunk
    Agent->>+Agent: execute tools (multi‑hop rounds)
    Agent->>-GeminiPlugin: send follow-ups (if needed)

    GeminiPlugin->>EventManager: emit streaming events
    EventManager->>EventManager: set/clear _received_event (wake processing)
    EventManager->>Profiler: deliver events / invoke on_finish

    Agent->>EventManager: emit CallEndedEvent
    Agent->>EventManager: emit AgentFinishEvent
    Profiler->>Profiler: stop & write profile.html
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

  • Areas needing extra attention:
    • plugins/gemini/.../gemini_llm.py — async streaming, multi‑hop orchestration, deduplication, follow-up message construction.
    • agents-core/vision_agents/core/agents/agents.py — profiler wiring, event ordering, finish/wait synchronization.
    • agents-core/vision_agents/core/events/manager.py_received_event signaling, processing loop wake semantics, and ExceptionEvent enqueueing.
    • agents-core/vision_agents/core/profiling/base.py — lifecycle subscription and file output handling.

Possibly related PRs

Suggested labels

core-agents

Suggested reviewers

  • maxkahan
  • d3xvn
  • Nash0x7E2

Poem

I set the clock inside the code and watched it bloom to ash,
AgentInit opens like a mouth that tastes the dark.
Streams unspool, small tools answer in their raw speech,
The manager listens, a patient bone that rings and keeps,
At finish, a white profile lies open — a clean, bright wound.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title refers to optimizing delays and waiting logic, but the changeset primarily adds profiling instrumentation (Profiler class, pyinstrument integration, AgentInitEvent/AgentFinishEvent) with secondary EventManager synchronization changes. Consider revising the title to reflect the main changes: something like 'Add profiling instrumentation and event synchronization' or 'Integrate pyinstrument profiling with event management'.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch profiling/realtime-data

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 903d016 and 592faf4.

📒 Files selected for processing (1)
  • agents-core/vision_agents/core/profiling/base.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • agents-core/vision_agents/core/profiling/base.py
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: unit / Ruff & mypy
  • GitHub Check: unit / Test "not integration"

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@yarikdevcom yarikdevcom force-pushed the profiling/realtime-data branch from cbf9efc to 69ac841 Compare October 29, 2025 15:33
@yarikdevcom yarikdevcom changed the title Optimize EventManager waiting logic and error handling Optimize delays - realtime, waiting logic and error handling Oct 29, 2025
@yarikdevcom yarikdevcom force-pushed the profiling/realtime-data branch from 35eedab to 29b7a8a Compare November 3, 2025 15:06
@yarikdevcom yarikdevcom marked this pull request as ready for review November 3, 2025 16:11
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (1)

152-158: Apply async/await to follow-up tool call streaming at lines 152 and 158.

Line 102 establishes the correct pattern: await self.chat.send_message_stream() followed by async for. Line 152 omits the await, leaving follow_up_iter as an unawaited coroutine, then line 158 attempts synchronous iteration, which would fail at runtime.

-                follow_up_iter = self.chat.send_message_stream(parts, config=cfg_with_tools)  # type: ignore[arg-type]
+                follow_up_iter = await self.chat.send_message_stream(parts, config=cfg_with_tools)  # type: ignore[arg-type]
                 
                 follow_up_text_parts: List[str] = []
                 follow_up_last = None
                 next_calls = []
                 
-                for idx, chk in enumerate(follow_up_iter):
+                async for idx, chk in enumerate(follow_up_iter):

Note: enumerate() supports async iteration, so no manual index tracking is needed.

agents-core/vision_agents/core/agents/agents.py (1)

544-567: Fix finish() hang when CallEndedEvent already fired

Subscribing to CallEndedEvent inside finish() means we miss any event that fired earlier. If the remote participant drops before we call await agent.finish(), the event manager never replays that notification, running_event stays unset, and this coroutine blocks forever. Please handle the “call already ended” path—e.g., set the event immediately when you detect the connection is no longer active or register the handler earlier so the flag is updated before finish() waits.

🧹 Nitpick comments (3)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (1)

117-121: Consider logging ignored extraction errors for debugging.

The bare except: pass blocks silence all errors during tool call extraction. While this prevents crashes from malformed chunks, it may hide legitimate issues during development or debugging.

Consider adding debug-level logging:

             try:
                 chunk_calls = self._extract_tool_calls_from_stream_chunk(chunk)
                 pending_calls.extend(chunk_calls)
-            except Exception:
-                pass  # Ignore errors in chunk processing
+            except Exception as e:
+                logger.debug(f"Ignoring tool call extraction error: {e}")

Apply the same pattern at lines 163-168.

Also applies to: 163-168

agents-core/vision_agents/core/agents/events.py (2)

6-11: Well-structured lifecycle event.

AgentInitEvent correctly inherits from BaseEvent (rather than PluginBaseEvent) since this is an agent lifecycle marker, not a plugin-specific operation. The init=False parameter on the type field appropriately prevents callers from overriding the event type.

The docstring could be expanded to clarify the emission context:

-    """Event emitted when Agent class initialized."""
+    """Event emitted when an Agent instance is initialized.
+    
+    This event marks the beginning of an agent's lifecycle and is used
+    for profiling and tracking agent initialization.
+    """

13-18: Lifecycle event properly implemented.

AgentFinishEvent follows the same pattern as AgentInitEvent and correctly uses BaseEvent as the parent class. The structure is clean and consistent.

Consider enriching the docstring to provide context about the finish phase:

-    """Event emitted when agent.finish() call ended."""
+    """Event emitted when an agent's finish() method completes.
+    
+    This event marks the end of an agent's lifecycle and is used for
+    profiling, cleanup tracking, and resource finalization monitoring.
+    """
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 4bc269b and 16bc202.

⛔ Files ignored due to path filters (3)
  • examples/01_simple_agent_example/uv.lock is excluded by !**/*.lock
  • examples/other_examples/openai_realtime_webrtc/uv.lock is excluded by !**/*.lock
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (12)
  • .gitignore (1 hunks)
  • agents-core/vision_agents/core/agents/agents.py (6 hunks)
  • agents-core/vision_agents/core/agents/events.py (1 hunks)
  • agents-core/vision_agents/core/events/manager.py (7 hunks)
  • agents-core/vision_agents/core/profiling/__init__.py (1 hunks)
  • agents-core/vision_agents/core/profiling/base.py (1 hunks)
  • examples/01_simple_agent_example/pyproject.toml (3 hunks)
  • examples/01_simple_agent_example/simple_agent_example.py (2 hunks)
  • examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py (3 hunks)
  • examples/other_examples/openai_realtime_webrtc/pyproject.toml (1 hunks)
  • plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (5 hunks)
  • pyproject.toml (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.py

📄 CodeRabbit inference engine (.cursor/rules/python.mdc)

**/*.py: Do not modify sys.path in Python code
Docstrings must follow the Google style guide

Files:

  • examples/01_simple_agent_example/simple_agent_example.py
  • examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py
  • plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py
  • agents-core/vision_agents/core/agents/events.py
  • agents-core/vision_agents/core/profiling/__init__.py
  • agents-core/vision_agents/core/agents/agents.py
  • agents-core/vision_agents/core/events/manager.py
  • agents-core/vision_agents/core/profiling/base.py
🧠 Learnings (1)
📚 Learning: 2025-10-13T22:00:34.300Z
Learnt from: dangusev
Repo: GetStream/Vision-Agents PR: 98
File: plugins/deepgram/vision_agents/plugins/deepgram/stt.py:135-150
Timestamp: 2025-10-13T22:00:34.300Z
Learning: In the Deepgram STT plugin (plugins/deepgram/vision_agents/plugins/deepgram/stt.py), the `started()` method is designed to wait for the connection attempt to complete, not to guarantee a successful connection. It's acceptable for the connection attempt to fail, and downstream code handles the case where `self.dg_connection` is `None`. The `_connected_once` event is set in the `finally` block intentionally to signal attempt completion.

Applied to files:

  • agents-core/vision_agents/core/agents/agents.py
🧬 Code graph analysis (8)
examples/01_simple_agent_example/simple_agent_example.py (2)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
plugins/elevenlabs/vision_agents/plugins/elevenlabs/tts.py (1)
  • TTS (12-74)
examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py (1)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (1)
agents-core/vision_agents/core/llm/llm_types.py (1)
  • NormalizedToolCallItem (107-111)
agents-core/vision_agents/core/agents/events.py (1)
agents-core/vision_agents/core/events/base.py (2)
  • PluginBaseEvent (52-54)
  • BaseEvent (34-48)
agents-core/vision_agents/core/profiling/__init__.py (1)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
agents-core/vision_agents/core/agents/agents.py (3)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
agents-core/vision_agents/core/events/manager.py (2)
  • send (428-472)
  • wait (474-488)
agents-core/vision_agents/core/agents/events.py (2)
  • AgentInitEvent (7-10)
  • AgentFinishEvent (14-17)
agents-core/vision_agents/core/events/manager.py (1)
agents-core/vision_agents/core/events/base.py (1)
  • ExceptionEvent (97-100)
agents-core/vision_agents/core/profiling/base.py (3)
agents-core/vision_agents/core/events/manager.py (3)
  • EventManager (56-551)
  • register_events_from_module (219-256)
  • subscribe (301-370)
agents-core/vision_agents/core/agents/agents.py (1)
  • subscribe (285-297)
agents-core/vision_agents/core/agents/events.py (1)
  • AgentFinishEvent (14-17)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: unit / Test "not integration"
  • GitHub Check: unit / Ruff & mypy
  • GitHub Check: unit / Ruff & mypy
  • GitHub Check: unit / Test "not integration"
🔇 Additional comments (14)
.gitignore (1)

88-90: Clarify the purpose of opencode.json.

The profile.html entry aligns with the profiling infrastructure introduced in this PR. However, opencode.json lacks context in the PR description and related changes.

Could you clarify what opencode.json is used for and why it's being ignored at the repository root?

examples/other_examples/openai_realtime_webrtc/pyproject.toml (1)

13-13: LGTM!

The pyinstrument dependency addition aligns with the profiling infrastructure introduced in this PR.

pyproject.toml (1)

83-83: LGTM!

Adding pyinstrument as a dev dependency is appropriate for the profiling infrastructure introduced in this PR.

examples/01_simple_agent_example/pyproject.toml (1)

6-6: LGTM!

The addition of the vogent plugin and pyinstrument dependency, along with the corresponding source configuration, aligns with the profiling and plugin enhancements in this PR.

Also applies to: 17-17, 23-23, 35-35

agents-core/vision_agents/core/events/manager.py (5)

145-145: LGTM!

Introducing _received_event for internal synchronization is a solid improvement over sleep-based polling in event processing.


217-217: LGTM!

Sharing _received_event during merge ensures proper synchronization across merged event managers.


472-472: LGTM!

Setting _received_event after queueing ensures the processing loop wakes up promptly to handle new events.


528-530: LGTM!

Replacing the sleep with await _received_event.wait() is a more efficient approach that eliminates unnecessary delays while ensuring the loop resumes promptly when events arrive.


536-536: LGTM!

Routing exceptions through the standard send() method ensures they're processed consistently with other events and properly signals the event loop.

plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (4)

4-4: LGTM!

The migration to AsyncClient and use of .aio accessor is consistent with the async pattern adopted in this PR.

Also applies to: 40-40, 57-57


102-102: LGTM!

The async streaming implementation with await and async for is correct, and the idx tracking properly annotates emitted events.

Also applies to: 110-123


126-137: LGTM!

The multi-round tool calling setup with MAX_ROUNDS = 3, deduplication, and concurrent execution with timeout is well-designed to handle complex tool interactions safely.


138-150: LGTM!

The concurrent tool execution with result sanitization and proper conversion to Gemini's function response format is well-implemented.

agents-core/vision_agents/core/agents/events.py (1)

2-2: LGTM! Import updated correctly.

The addition of BaseEvent to the imports is necessary for the new agent lifecycle events and follows the existing import pattern.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (1)

152-169: Fix the follow-up stream handling

chat.send_message_stream returns an awaitable async iterator. Here we neither await it nor iterate with async for, so we hand a coroutine to enumerate, tripping mypy and blowing up at runtime once tool calls trigger this path. The Google GenAI SDK examples require async for chunk in await chat.send_message_stream(...) to consume the stream(googleapis.github.io). Please await the call and switch to an async loop with a manual index, e.g.:

-                follow_up_iter = self.chat.send_message_stream(parts, config=cfg_with_tools)  # type: ignore[arg-type]
-                
-                follow_up_text_parts: List[str] = []
-                follow_up_last = None
-                next_calls = []
-                
-                for idx, chk in enumerate(follow_up_iter):
+                follow_up_iter = await self.chat.send_message_stream(parts, config=cfg_with_tools)  # type: ignore[arg-type]
+                
+                follow_up_text_parts: List[str] = []
+                follow_up_last = None
+                next_calls = []
+                follow_idx = 0
+                
+                async for chk in follow_up_iter:
                     follow_up_last = chk
                     # TODO: unclear if this is correct (item_id and idx)
-                    self._standardize_and_emit_event(chk, follow_up_text_parts, item_id, idx)
+                    self._standardize_and_emit_event(chk, follow_up_text_parts, item_id, follow_idx)
+                    follow_idx += 1
agents-core/vision_agents/core/agents/agents.py (1)

544-566: Add timeout and improve error handling in finish().

The refactored finish() method has several concerns:

  1. Missing timeout: Line 560's await running_event.wait() has no timeout. If CallEndedEvent is never emitted (e.g., due to network issues or edge transport bugs), this will hang indefinitely. Consider adding a timeout parameter or a reasonable default.

  2. Subscription cleanup: The on_ended subscription (line 553) is never unsubscribed. If the function exits early or is called multiple times, old subscriptions will accumulate.

  3. CancelledError handling: Lines 561-563 catch CancelledError, clear the event, but then continue to line 564 to send AgentFinishEvent and call close(). Is it intentional to emit the finish event and close even when cancelled? This might be correct, but should be documented.

  4. Race condition: Between lines 544 and 553, there's a window where the event could fire before the subscription is registered if CallEndedEvent was already queued.

Consider this refactor:

 async def finish(self):
     """Wait for the call to end gracefully.
     Subscribes to the edge transport's `call_ended` event and awaits it. If
     no connection is active, returns immediately.
     """
     if not self._connection:
         self.logger.info(
             "🔚 Agent connection is already closed, finishing immediately"
         )
         return

-    running_event = asyncio.Event()
+    running_event = asyncio.Event()
+    subscription = None
+    
     with self.span("agent.finish"):
         # If connection is None or already closed, return immediately
         if not self._connection:
             logging.info(
                 "🔚 Agent connection already closed, finishing immediately"
             )
             return

         @self.edge.events.subscribe
         async def on_ended(event: CallEndedEvent):
             running_event.set()
             self._is_running = False
+        
+        subscription = on_ended

-    # TODO: add members count check (particiapnts left + count = 1 timeout 2 minutes)
+    # TODO: add members count check (participants left + count = 1 timeout 2 minutes)

     try:
-        await running_event.wait()
+        await asyncio.wait_for(running_event.wait(), timeout=120.0)
     except asyncio.CancelledError:
         running_event.clear()
+        raise  # Re-raise to prevent finish event emission when cancelled
+    except asyncio.TimeoutError:
+        self.logger.warning("finish() timed out waiting for CallEndedEvent")
+    finally:
+        # Clean up subscription
+        if subscription and hasattr(self.edge.events, 'unsubscribe'):
+            self.edge.events.unsubscribe(subscription)

     self.events.send(events.AgentFinishEvent())

     await asyncio.shield(self.close())
🧹 Nitpick comments (1)
examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py (1)

14-14: Consider using the Profiler class for consistency.

The manual pyinstrument setup duplicates functionality available in vision_agents.core.profiling.Profiler. For consistency with other examples (e.g., simple_agent_example.py), consider using the Profiler class which handles start/stop lifecycle automatically via AgentFinishEvent.

If the agent setup supports it, replace manual profiling with:

-import pyinstrument
+from vision_agents.core.profiling import Profiler

 async def start_agent() -> None:
-    profiler = pyinstrument.Profiler()
-    profiler.start()
     # ...
     agent = Agent(
         # ... other params
+        profiler=Profiler(output_path='profiled.html'),
     )
     # ...
     await agent.finish()
-
-    profiler.stop()
-    with open('profiled.html', 'w') as f:
-        f.write(profiler.output_html())

Also applies to: 27-28, 78-80

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 4bc269b and 16bc202.

⛔ Files ignored due to path filters (3)
  • examples/01_simple_agent_example/uv.lock is excluded by !**/*.lock
  • examples/other_examples/openai_realtime_webrtc/uv.lock is excluded by !**/*.lock
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (12)
  • .gitignore (1 hunks)
  • agents-core/vision_agents/core/agents/agents.py (6 hunks)
  • agents-core/vision_agents/core/agents/events.py (1 hunks)
  • agents-core/vision_agents/core/events/manager.py (7 hunks)
  • agents-core/vision_agents/core/profiling/__init__.py (1 hunks)
  • agents-core/vision_agents/core/profiling/base.py (1 hunks)
  • examples/01_simple_agent_example/pyproject.toml (3 hunks)
  • examples/01_simple_agent_example/simple_agent_example.py (2 hunks)
  • examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py (3 hunks)
  • examples/other_examples/openai_realtime_webrtc/pyproject.toml (1 hunks)
  • plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (5 hunks)
  • pyproject.toml (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.py

📄 CodeRabbit inference engine (.cursor/rules/python.mdc)

**/*.py: Do not modify sys.path in Python code
Docstrings must follow the Google style guide

Files:

  • agents-core/vision_agents/core/profiling/__init__.py
  • agents-core/vision_agents/core/profiling/base.py
  • examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py
  • agents-core/vision_agents/core/agents/events.py
  • plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py
  • agents-core/vision_agents/core/agents/agents.py
  • examples/01_simple_agent_example/simple_agent_example.py
  • agents-core/vision_agents/core/events/manager.py
🧠 Learnings (1)
📚 Learning: 2025-10-13T22:00:34.300Z
Learnt from: dangusev
Repo: GetStream/Vision-Agents PR: 98
File: plugins/deepgram/vision_agents/plugins/deepgram/stt.py:135-150
Timestamp: 2025-10-13T22:00:34.300Z
Learning: In the Deepgram STT plugin (plugins/deepgram/vision_agents/plugins/deepgram/stt.py), the `started()` method is designed to wait for the connection attempt to complete, not to guarantee a successful connection. It's acceptable for the connection attempt to fail, and downstream code handles the case where `self.dg_connection` is `None`. The `_connected_once` event is set in the `finally` block intentionally to signal attempt completion.

Applied to files:

  • agents-core/vision_agents/core/agents/agents.py
🧬 Code graph analysis (8)
agents-core/vision_agents/core/profiling/__init__.py (1)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
agents-core/vision_agents/core/profiling/base.py (3)
agents-core/vision_agents/core/events/manager.py (2)
  • register_events_from_module (219-256)
  • subscribe (301-370)
agents-core/vision_agents/core/agents/agents.py (1)
  • subscribe (285-297)
agents-core/vision_agents/core/agents/events.py (1)
  • AgentFinishEvent (14-17)
examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py (1)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
agents-core/vision_agents/core/agents/events.py (1)
agents-core/vision_agents/core/events/base.py (2)
  • PluginBaseEvent (52-54)
  • BaseEvent (34-48)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (1)
agents-core/vision_agents/core/llm/llm_types.py (1)
  • NormalizedToolCallItem (107-111)
agents-core/vision_agents/core/agents/agents.py (3)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
agents-core/vision_agents/core/events/manager.py (2)
  • send (428-472)
  • wait (474-488)
agents-core/vision_agents/core/agents/events.py (2)
  • AgentInitEvent (7-10)
  • AgentFinishEvent (14-17)
examples/01_simple_agent_example/simple_agent_example.py (2)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
plugins/elevenlabs/vision_agents/plugins/elevenlabs/tts.py (1)
  • TTS (12-74)
agents-core/vision_agents/core/events/manager.py (1)
agents-core/vision_agents/core/events/base.py (1)
  • ExceptionEvent (97-100)
🪛 GitHub Actions: CI (unit)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py

[error] 158-158: Mypy type-check error: Argument 1 to 'enumerate' has incompatible type 'Coroutine[Any, Any, AsyncIterator[GenerateContentResponse]] | Any'; expected 'Iterable[Any]'.

🔇 Additional comments (15)
.gitignore (1)

88-90: Appropriate additions for profiling and tooling artifacts.

Both entries align well with the PR objectives—profile.html captures output from the new profiling instrumentation, while /opencode.json excludes root-level code-generation artifacts. The placement under "Artifacts / assets" is sensible, and the use of a leading slash for /opencode.json ensures proper root-level scoping.

examples/other_examples/openai_realtime_webrtc/pyproject.toml (1)

13-13: Dependency addition looks good.

The pyinstrument dependency supports the profiling instrumentation added in the example code.

pyproject.toml (1)

83-83: Dev dependency addition is appropriate.

Adding pyinstrument to dev dependencies enables profiling across the workspace.

examples/01_simple_agent_example/pyproject.toml (1)

6-6: Dependencies and comment update look good.

The changes appropriately add vogent plugin and pyinstrument dependencies, with proper source mappings following the existing pattern.

Also applies to: 17-17, 23-23, 35-35

agents-core/vision_agents/core/events/manager.py (3)

145-145: Event-driven synchronization improves performance.

Replacing the polling sleep with asyncio.Event provides better responsiveness and reduces unnecessary wake-ups. The propagation in merge ensures consistency across merged managers.

Also applies to: 217-217, 472-472, 528-530


412-412: Logging level adjustments are appropriate.

Moving high-frequency event logs from info to debug reduces noise while maintaining observability for debugging.

Also applies to: 545-547


536-536: Revert this review comment — ExceptionEvent is properly handled and will not be dropped.

The concern assumes _prepare_event() could return None for ExceptionEvent, but analysis shows this cannot occur. ExceptionEvent is registered during initialization (line 147) and has a type attribute set to "base.exception". When _prepare_event() is called at line 468, it reaches the final validation (line 408) which checks if event.type in self._events. Since ExceptionEvent is registered, this check passes and the method explicitly returns the event at line 410-411. The event is then successfully appended to the queue at line 470. No code path exists that would silently drop ExceptionEvent.

Likely an incorrect or invalid review comment.

examples/01_simple_agent_example/simple_agent_example.py (2)

7-7: Profiler integration looks good.

The Profiler usage follows the correct pattern, automatically handling lifecycle via AgentFinishEvent subscription.

Also applies to: 27-27


6-6: I need to verify that ElevenLabs is properly imported in the modified file:

Confirm TTS provider change from Cartesia to ElevenLabs is intentional.

The codebase shows Cartesia remains actively maintained and used in other examples (e.g., plugins/sample_plugin/example/my_example.py, AWS examples, tts_cartesia/ example directory), while ElevenLabs is an established, production-ready TTS integration in the framework with support for configurable models and voice IDs. This appears to be a deliberate choice to demonstrate ElevenLabs TTS in this specific example rather than a complete migration. The change is appropriate, and no action is required.

agents-core/vision_agents/core/profiling/__init__.py (1)

1-3: Clean public API exposure.

The module initialization properly exports the Profiler class, following Python packaging conventions.

agents-core/vision_agents/core/agents/events.py (1)

2-2: Agent lifecycle events are well-defined.

The AgentInitEvent and AgentFinishEvent classes follow the established event pattern and provide clear lifecycle hooks for profiling and other observability features.

Also applies to: 6-17

agents-core/vision_agents/core/agents/agents.py (4)

54-54: LGTM!

The profiler import is clean and follows the project's relative import pattern.


213-216: LGTM!

The profiler is correctly integrated into the plugin aggregation loop with proper None-safety checks. The conditional on line 214 ensures that only plugins with event managers are merged.


243-244: Verify event subscribers are ready for AgentInitEvent.

The AgentInitEvent is emitted at the end of __init__, but event handler subscriptions are registered later in the join() method (lines 478-479). This means:

  • The profiler's on_finish handler is subscribed in the Profiler's __init__ (line 17 of base.py), so it should receive events
  • Other handlers registered in _setup_llm_events() and _setup_speech_events() won't be active yet

Ensure that all intended subscribers to AgentInitEvent are registered before this event is sent, or document that this event is only for early-stage subscribers like the profiler.


158-158: Clarify whether log_level default was actually changed from INFO to DEBUG.

The review comment asserts that "the default log level has been changed from INFO to DEBUG," but I found no evidence supporting this claimed transition:

  • No git history for the log_level parameter
  • No test files document prior default values
  • No documentation or README shows prior configuration
  • The Agent class docstring example does not mention log_level usage

The parameter currently defaults to logging.DEBUG at line 158, and configure_default_logging() applies it to handlers. However, without verifiable evidence of a prior INFO default, the factual claim of a "change" cannot be confirmed.

The underlying concern about DEBUG-level logging producing excessive verbosity is worth addressing, but verify first whether this is a newly added parameter or an existing one that was always DEBUG.

Likely an incorrect or invalid review comment.

@yarikdevcom yarikdevcom force-pushed the profiling/realtime-data branch from 16bc202 to b87b512 Compare November 4, 2025 15:27
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (1)

152-169: Fix async follow-up streaming loop
send_message_stream on the async Gemini client must be awaited, and the resulting stream must be consumed with async for. Here we neither await the call nor use async iteration, so the first tool round will blow up with TypeError: 'async_generator' object is not iterable (and no follow-up chunks will be processed). The official samples show async for chunk in await chat.send_message_stream(...), which we should mirror.(pypi.org)
Please apply something like:

-                follow_up_iter = self.chat.send_message_stream(parts, config=cfg_with_tools)  # type: ignore[arg-type]
+                follow_up_iter = await self.chat.send_message_stream(parts, config=cfg_with_tools)  # type: ignore[arg-type]
@@
-                for idx, chk in enumerate(follow_up_iter):
+                follow_up_idx = 0
+                async for chk in follow_up_iter:
                     follow_up_last = chk
                     # TODO: unclear if this is correct (item_id and idx)
-                    self._standardize_and_emit_event(chk, follow_up_text_parts, item_id, idx)
+                    self._standardize_and_emit_event(chk, follow_up_text_parts, item_id, follow_up_idx)
@@
-                current_calls = next_calls
+                    follow_up_idx += 1
+                current_calls = next_calls
🧹 Nitpick comments (3)
examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py (3)

14-14: Consider using the framework's Profiler abstraction.

The example imports pyinstrument directly, but the codebase now provides vision_agents.core.profiling.Profiler which wraps pyinstrument and integrates with the agent lifecycle via events.

Import the framework's Profiler instead:

-import pyinstrument
+from vision_agents.core.profiling import Profiler

27-28: Refactor to use the framework's Profiler class.

The manual profiler instantiation and start call can be replaced with the framework's Profiler class, which auto-starts profiling and integrates with the agent lifecycle.

Apply this diff:

-    profiler = pyinstrument.Profiler()
-    profiler.start()
+    profiler = Profiler(output_path='profiled.html')

Then pass the profiler to the Agent constructor at line 37:

    agent = Agent(
        edge=getstream.Edge(),
        agent_user=agent_user,
        instructions=(...),
        llm=openai.Realtime(),
        processors=[],
        profiler=profiler,  # Add this parameter
    )

78-81: Remove manual profiler cleanup if using the framework's Profiler.

If you refactor to use vision_agents.core.profiling.Profiler (as suggested earlier), these lines become redundant. The Profiler class automatically stops profiling and writes HTML output when AgentFinishEvent is emitted by agent.finish().

Remove these lines after switching to the framework's Profiler:

-    profiler.stop()
-    with open('profiled.html', 'w') as f:
-        f.write(profiler.output_html())
-
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 16bc202 and b87b512.

⛔ Files ignored due to path filters (3)
  • examples/01_simple_agent_example/uv.lock is excluded by !**/*.lock
  • examples/other_examples/openai_realtime_webrtc/uv.lock is excluded by !**/*.lock
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (12)
  • .gitignore (1 hunks)
  • agents-core/vision_agents/core/agents/agents.py (6 hunks)
  • agents-core/vision_agents/core/agents/events.py (1 hunks)
  • agents-core/vision_agents/core/events/manager.py (7 hunks)
  • agents-core/vision_agents/core/profiling/__init__.py (1 hunks)
  • agents-core/vision_agents/core/profiling/base.py (1 hunks)
  • examples/01_simple_agent_example/pyproject.toml (3 hunks)
  • examples/01_simple_agent_example/simple_agent_example.py (2 hunks)
  • examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py (3 hunks)
  • examples/other_examples/openai_realtime_webrtc/pyproject.toml (1 hunks)
  • plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (5 hunks)
  • pyproject.toml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (6)
  • .gitignore
  • examples/01_simple_agent_example/pyproject.toml
  • pyproject.toml
  • agents-core/vision_agents/core/agents/events.py
  • agents-core/vision_agents/core/profiling/base.py
  • examples/01_simple_agent_example/simple_agent_example.py
🧰 Additional context used
📓 Path-based instructions (1)
**/*.py

📄 CodeRabbit inference engine (.cursor/rules/python.mdc)

**/*.py: Do not modify sys.path in Python code
Docstrings must follow the Google style guide

Files:

  • agents-core/vision_agents/core/profiling/__init__.py
  • agents-core/vision_agents/core/agents/agents.py
  • agents-core/vision_agents/core/events/manager.py
  • plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py
  • examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py
🧠 Learnings (1)
📚 Learning: 2025-10-13T22:00:34.300Z
Learnt from: dangusev
Repo: GetStream/Vision-Agents PR: 98
File: plugins/deepgram/vision_agents/plugins/deepgram/stt.py:135-150
Timestamp: 2025-10-13T22:00:34.300Z
Learning: In the Deepgram STT plugin (plugins/deepgram/vision_agents/plugins/deepgram/stt.py), the `started()` method is designed to wait for the connection attempt to complete, not to guarantee a successful connection. It's acceptable for the connection attempt to fail, and downstream code handles the case where `self.dg_connection` is `None`. The `_connected_once` event is set in the `finally` block intentionally to signal attempt completion.

Applied to files:

  • agents-core/vision_agents/core/agents/agents.py
🧬 Code graph analysis (5)
agents-core/vision_agents/core/profiling/__init__.py (1)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
agents-core/vision_agents/core/agents/agents.py (3)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
agents-core/vision_agents/core/events/manager.py (2)
  • send (428-472)
  • wait (474-488)
agents-core/vision_agents/core/agents/events.py (2)
  • AgentInitEvent (7-10)
  • AgentFinishEvent (14-17)
agents-core/vision_agents/core/events/manager.py (1)
agents-core/vision_agents/core/events/base.py (1)
  • ExceptionEvent (97-100)
plugins/gemini/vision_agents/plugins/gemini/gemini_llm.py (1)
agents-core/vision_agents/core/llm/llm_types.py (1)
  • NormalizedToolCallItem (107-111)
examples/other_examples/openai_realtime_webrtc/openai_realtime_example.py (1)
agents-core/vision_agents/core/profiling/base.py (1)
  • Profiler (10-23)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: unit / Ruff & mypy
  • GitHub Check: unit / Test "not integration"
  • GitHub Check: unit / Test "not integration"
  • GitHub Check: unit / Ruff & mypy
🔇 Additional comments (12)
examples/other_examples/openai_realtime_webrtc/pyproject.toml (1)

13-13: Good addition for profiling support in examples.

The pyinstrument>=5.1.1 dependency exists and was released Aug 12, 2025, providing the profiling tooling needed for the agent event profiling hooks mentioned in the PR objectives. The version constraint is appropriately permissive for an example project.

agents-core/vision_agents/core/profiling/__init__.py (1)

1-3: LGTM!

Standard module initialization that correctly exposes the Profiler class as the public API.

agents-core/vision_agents/core/agents/agents.py (4)

54-54: LGTM!

The import correctly brings in the Profiler class for integration into the agent lifecycle.


159-159: LGTM!

The profiler parameter and plugin integration correctly wire the profiler into the agent's event system. The hasattr check at line 214 safely handles None profiler instances, and merging profiler events enables lifecycle-based profiling via AgentFinishEvent.

Also applies to: 213-216


243-244: LGTM!

Emitting AgentInitEvent at the end of initialization correctly signals that the agent setup is complete, enabling subscribers to react to the agent lifecycle.


544-566: Review cancellation handling and subscription cleanup.

The refactored finish() method improves upon busy-waiting, but consider these concerns:

  1. Cancellation behavior: Lines 561-562 catch CancelledError and clear the event, but execution continues to send AgentFinishEvent and call close(). If finish() is cancelled, should it propagate the cancellation rather than proceeding with cleanup?

  2. Subscription leak: The on_ended handler at line 553 subscribes to edge.events but never unsubscribes. If finish() is called multiple times (though discouraged by the class docstring), multiple subscriptions accumulate.

Consider these adjustments:

Option 1: Propagate cancellation

         try:
             await running_event.wait()
         except asyncio.CancelledError:
-            running_event.clear()
+            self.logger.debug("finish() was cancelled")
+            raise

Option 2: Unsubscribe on completion

        @self.edge.events.subscribe
        async def on_ended(event: CallEndedEvent):
            running_event.set()
            self._is_running = False
        
        try:
            await running_event.wait()
        except asyncio.CancelledError:
            running_event.clear()
        finally:
            self.edge.events.unsubscribe(on_ended)  # Clean up subscription

Verify the intended behavior when finish() is cancelled.

agents-core/vision_agents/core/events/manager.py (6)

145-145: LGTM!

The _received_event field correctly initializes an asyncio.Event for coordinating producer-consumer wakeups.


217-217: LGTM!

Propagating _received_event during merge ensures that both managers coordinate on the same synchronization primitive, maintaining correct producer-consumer behavior.


412-412: LGTM!

Reducing event reception logging to DEBUG level appropriately decreases log verbosity for this high-frequency operation.


472-473: LGTM!

Signaling _received_event after enqueuing events correctly wakes the consumer to process the newly queued work. Signaling once after all events are enqueued is efficient.


528-530: LGTM!

The wait-and-clear pattern correctly implements event-based consumer wakeup, replacing inefficient sleep polling. The pattern is race-free given the single-consumer design and atomic deque operations.


536-540: LGTM!

Using self.send() for ExceptionEvent ensures proper event preparation and signaling, maintaining consistency with the producer-consumer pattern. The additional debug logging with module names improves observability.

Also applies to: 545-547

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants