Skip to content

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Sep 1, 2025

Description

Refactoring: table based branching is a bit better that if-elif with different tests

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement

Summary by CodeRabbit

  • Refactor
    • Streamlined internal event routing for streaming responses using pattern matching for clearer, more maintainable dispatch logic.
    • Added debug logging for previously unhandled event combinations to aid diagnostics.
    • Preserves existing behavior and error handling; no changes to public interfaces, APIs, or user workflows.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 1, 2025

Warning

Rate limit exceeded

@tisnik has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 19 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8a0f54f and facf446.

📒 Files selected for processing (1)
  • src/app/endpoints/streaming_query.py (2 hunks)

Walkthrough

Refactors stream_build_event in src/app/endpoints/streaming_query.py to use Python 3.10 structural pattern matching on (event_type, step_type) for dispatch, adds a debug log for unhandled combinations, and preserves the initial error-handling branch and existing handler delegation.

Changes

Cohort / File(s) Summary of edits
Control-flow dispatch refactor
src/app/endpoints/streaming_query.py
Replaced chained if/elif dispatch with match (event_type, step_type) pattern matching. Implemented mappings: (turn_start | turn_awaiting_input, ) → _handle_turn_start_event; (turn_complete, ) → _handle_turn_complete_event; (, shield_call) → _handle_shield_event; (, inference) → _handle_inference_event; (_, tool_execution) → _handle_tool_execution_event; default logs via logger.debug(...) then delegates to _handle_heartbeat_event. Retained initial if hasattr(chunk, "error") branch. No public signature changes.

Sequence Diagram(s)

sequenceDiagram
  participant C as Caller
  participant S as stream_build_event
  participant H1 as _handle_turn_start_event
  participant H2 as _handle_turn_complete_event
  participant H3 as _handle_shield_event
  participant H4 as _handle_inference_event
  participant H5 as _handle_tool_execution_event
  participant H6 as _handle_heartbeat_event
  participant L as logger

  C->>S: stream_build_event(chunk, event_type, step_type, ...)
  Note over S: match (event_type, step_type)

  alt (turn_start | turn_awaiting_input), _
    S->>H1: delegate to turn-start handler
  else turn_complete, _
    S->>H2: delegate to turn-complete handler
  else _, "shield_call"
    S->>H3: delegate to shield handler
  else _, "inference"
    S->>H4: delegate to inference handler
  else _, "tool_execution"
    S->>H5: delegate to tool-execution handler
  else
    S->>L: logger.debug("Unhandled event combo: event_type=%s, step_type=%s")
    S->>H6: delegate to heartbeat handler
  end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my ears at patterns clear,
A match-case hop with tidy cheer —
No tangled ifs to slow my pace,
I bound to handlers, one by case.
Debugged footsteps, heartbeat hum — the rabbit's refactor, here I come! 🥕

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@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

🧹 Nitpick comments (3)
src/app/endpoints/streaming_query.py (3)

157-171: Consolidate match-cases, prefer tuple pattern, and log unexpected combinations

Nice readability win. Minor cleanups:

  • Use a tuple pattern instead of constructing a list.
  • Merge the two identical turn-start cases with an OR-pattern.
  • Log unhandled (event_type, step_type) combos before falling back to heartbeat.
-    match [event_type, step_type]:
-        case ["turn_start", _]:
+    match (event_type, step_type):
+        case (("turn_start" | "turn_awaiting_input"), _):
             yield from _handle_turn_start_event(chunk_id)
-        case ["turn_awaiting_input", _]:
-            yield from _handle_turn_start_event(chunk_id)
-        case ["turn_complete", _]:
+        case ("turn_complete", _):
             yield from _handle_turn_complete_event(chunk, chunk_id)
-        case [_, "shield_call"]:
+        case (_, "shield_call"):
             yield from _handle_shield_event(chunk, chunk_id)
-        case [_, "inference"]:
+        case (_, "inference"):
             yield from _handle_inference_event(chunk, chunk_id)
-        case [_, "tool_execution"]:
+        case (_, "tool_execution"):
             yield from _handle_tool_execution_event(chunk, chunk_id, metadata_map)
         case _:
-            yield from _handle_heartbeat_event(chunk_id)
+            logger.debug(
+                "Unhandled event combo: event_type=%s, step_type=%s",
+                event_type, step_type,
+            )
+            yield from _handle_heartbeat_event(chunk_id)

137-150: Docstring is stale vs. current dispatch

The docstring says it handles only step_progress/step_complete, but the dispatcher now routes turn_start/turn_awaiting_input/turn_complete and step_* by step_type.

-    This function processes chunks from the Llama Stack streaming response and formats
-    them into Server-Sent Events (SSE) format for the client. It handles two main
-    event types:
-
-    1. step_progress: Contains text deltas from the model inference process
-    2. step_complete: Contains information about completed tool execution steps
+    This function processes chunks from the Llama Stack streaming response and formats
+    them into Server-Sent Events (SSE). It dispatches on (event_type, step_type):
+    - turn_start, turn_awaiting_input -> start token
+    - turn_complete -> final output message
+    - step_* with step_type in {"shield_call", "inference", "tool_execution"} -> delegated handlers
+    - anything else -> heartbeat

157-171: PR description vs. implementation

The PR title/description mentions “table-based branching,” but this change uses structural pattern matching, not a dispatch table. Consider updating the PR text for clarity.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • 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 5058eba and f9e0c6d.

📒 Files selected for processing (1)
  • src/app/endpoints/streaming_query.py (1 hunks)
⏰ 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: build-pr
  • GitHub Check: e2e_tests
🔇 Additional comments (1)
src/app/endpoints/streaming_query.py (1)

157-171: Python version requirement confirmed
pyproject.toml already declares requires-python = ">=3.12,<3.14", ensuring support for pattern matching (Python 3.10+) across all runtimes.

@tisnik tisnik force-pushed the refactoring-table-based-branching branch from f9e0c6d to 8a0f54f Compare September 1, 2025 08:39
@tisnik
Copy link
Contributor Author

tisnik commented Sep 1, 2025

@CodeRabbit full review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 1, 2025

✅ Actions performed

Full review triggered.

Copy link
Contributor

@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

🧹 Nitpick comments (1)
src/app/endpoints/streaming_query.py (1)

137-145: Fix typos and tighten dispatch docstring.

Minor nits: fix “dispatche” and avoid “into … format” phrasing. Clarify item 1 wording.

-    formats them into Server-Sent Events (SSE) format for the client. It
-    dispatche on (event_type, step_type):
+    formats them as Server-Sent Events (SSE) for the client. It
+    dispatches on (event_type, step_type):
-    1. turn_start, turn_awaiting_input -> start token
+    1. turn_start, turn_awaiting_input -> token event (turn start)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • 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 5058eba and 8a0f54f.

📒 Files selected for processing (1)
  • src/app/endpoints/streaming_query.py (2 hunks)
⏰ 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). (1)
  • GitHub Check: build-pr
🔇 Additional comments (1)
src/app/endpoints/streaming_query.py (1)

159-176: Include chunk_id in fallback debug; match-case is safe under Python ≥ 3.12

In src/app/endpoints/streaming_query.py, update the unhandled-event log to include chunk_id:

-   logger.debug(
-       "Unhandled event combo: event_type=%s, step_type=%s",
-       event_type,
-       step_type,
-   )
+   logger.debug(
+       "Unhandled event combo id=%s: event_type=%r, step_type=%r",
+       chunk_id,
+       event_type,
+       step_type,
+   )

pyproject.toml already declares requires-python = ">=3.12,<3.14", so the match statement is supported.

@tisnik tisnik force-pushed the refactoring-table-based-branching branch from 8a0f54f to facf446 Compare September 1, 2025 09:03
@tisnik tisnik merged commit 8dd2924 into lightspeed-core:main Sep 1, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant