fix(wren-ai-service): allow sql generation reasoning streaming in followup asking

[cyyeh]

Summary by CodeRabbit

• New Features

  • Enhanced the ask service to support an additional streaming channel during planning, improving real-time response handling.

• Refactor

  • Streamlined the logic for processing user queues in SQL generation, ensuring prompt responses when no valid query reference is found.

[coderabbitai]

Walkthrough

This pull request streamlines user queue handling in two SQL generation reasoning pipelines by condensing the initialization logic into a single line and modifying the control flow in result retrieval to yield an empty string when a queue is absent. Additionally, the AskService’s streaming result method now incorporates an asynchronous loop to process responses from a secondary pipeline during the "planning" status. No changes have been made to exported or public entities.

Changes

File(s)	Change Summary
wren-ai-service/src/.../pipelines/generation/{followup,sql}_generation_reasoning.py	Simplified _streaming_callback by condensing user queue initialization into one line and removed explanatory comments. Modified _get_streaming_results to yield an empty string instead of creating a new queue if not present.
wren-ai-service/src/.../services/ask.py	Added an asynchronous loop in get_ask_streaming_result to stream events from the followup_sql_generation_reasoning pipeline when the ask result status is "planning", while retaining the existing logic for the sql_generation_reasoning pipeline.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AskService
    participant SQLGenPipeline as SQLGenerationReasoning
    participant FollowupPipeline as FollowUpSQLGenerationReasoning

    Client->>AskService: Request ask result
    AskService->>SQLGenPipeline: Initiate streaming (default flow)
    SQLGenPipeline-->>AskService: Stream SQL reasoning results
    opt When status is "planning"
      AskService->>FollowupPipeline: Initiate streaming (followup flow)
      FollowupPipeline-->>AskService: Stream followup reasoning results
    end
    AskService->>Client: Return aggregated streaming events

Loading

Possibly related PRs

• chore(wren-ai-service): add separate reasoning pipeline #1212: Modifies _streaming_callback and _get_streaming_results for user queue initialization, directly related to this change.
• chore(wren-ai-service): allow regenerate sql using retrieved tables #1324: Similar updates in stream handling logic, aligning with the modifications in queue management.
• chore(wren-ai-service): allow retrieving sql pairs while retrieving historical questions #1318: Focuses on refining the control flow in queue handling for SQL generation reasoning.

Suggested reviewers

• paopa

Poem

I'm a rabbit with a keen eye,
Hopping through code as changes fly.
Queues now start with one clear line,
Streaming results in perfect time.
Two pipelines sing in flow so bright,
Celebrating code in pixel light!
🐇💻

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17cda2c and 02a82f0.

📒 Files selected for processing (2)

• wren-ai-service/src/pipelines/generation/followup_sql_generation_reasoning.py (2 hunks)
• wren-ai-service/src/pipelines/generation/sql_generation_reasoning.py (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• wren-ai-service/src/pipelines/generation/followup_sql_generation_reasoning.py
• wren-ai-service/src/pipelines/generation/sql_generation_reasoning.py

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: build-image (linux_arm64_runner, linux/arm64)
• GitHub Check: build-image (ubuntu-latest, linux/amd64)
• GitHub Check: pytest
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Analyze (go)

---

🪧 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.
  • Generate unit testing code for this file.
  • 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. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai 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

Documentation and Community

• 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.