feat(ask): Add configurable max timeout for ask endpoint

[SyedaAnshrahGillani]

This pull request enhances the timeout functionality for the /asks endpoint by introducing a configurable maximum timeout. This provides an important safety rail, preventing users from setting excessively long timeouts and ensuring the stability of the service.

Use Case

While the initial timeout feature allows clients to specify a timeout, a user could still potentially set a very large value (e.g., 1 hour), tying up server resources for an unreasonable amount of time. This could happen by mistake or with malicious intent.

By adding a server-side max_ask_timeout (e.g., 5 minutes), we can enforce a reasonable upper bound. If a user requests a timeout longer than the allowed maximum, the service will automatically cap it at the configured maximum, preventing resource exhaustion and ensuring fair use.

Changes

• Max Timeout Configuration: A new max_ask_timeout setting has been added to config.py, allowing administrators to define a global maximum timeout for all ask queries.
• Enforced Maximum: The AskService now caps the user-provided timeout at the max_ask_timeout value.
• Global Propagation: The ServiceContainer has been updated to pass the new setting to the AskService during instantiation.

This feature further improves the robustness and resilience of the Wren AI service by providing administrators with more control over resource usage and protecting against potential abuse.

If you find this feature meaningful and intend to add timeout functionality, you may merge this pull request.

Summary by CodeRabbit

• New Features
  • Added a configurable timeout for ask queries, allowing users to specify a maximum duration per query.
  • Introduced a default timeout of 30 seconds for ask queries, with an upper limit of 300 seconds.
  • Ask queries that exceed the timeout now return a clear error message indicating a timeout occurred.

[coderabbitai[bot]]

Walkthrough

A new configuration parameter for maximum ask query timeout was introduced and propagated through the service configuration, initialization, and request handling layers. The ask service now enforces per-request timeouts, with explicit error handling for queries exceeding the allowed duration. The changes add new configuration fields and refactor the ask logic to support timeout enforcement.

Changes

Cohort / File(s)	Change Summary
Configuration Update wren-ai-service/src/config.py	Added max_ask_timeout integer field (default 300 seconds) to the Settings class for configuring maximum ask query timeout.
Service Initialization wren-ai-service/src/globals.py	Passed the new max_ask_timeout configuration from settings into the ask_service initialization within the service container.
Ask Service Timeout Enforcement wren-ai-service/src/web/v1/services/ask.py	Added timeout field to AskRequest, updated AskService to accept and enforce max_ask_timeout. Refactored ask method to wrap original logic in a timeout, with error handling for timeouts and a new _ask method containing the original ask logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant AskService
    participant _ask (internal)

    Client->>API: Send AskRequest (with optional timeout)
    API->>AskService: call ask(AskRequest)
    AskService->>_ask: Run _ask within asyncio.wait_for (timeout = min(request.timeout, max_ask_timeout))
    alt Query completes in time
        _ask-->>AskService: Result
        AskService-->>API: Return result
    else Query times out
        AskService-->>API: Return error ("Query timed out")
    end
    API-->>Client: Respond with result or timeout error

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Poem

A timeout hops in, not a moment too late,
For queries that dawdle, the service won’t wait.
With configs and wrappers, the logic is neat—
If answers take ages, they’ll taste defeat.
So here’s to swift queries, and errors that rhyme,
The code’s now more nimble—just in time!
🕰️🐇✨

[!NOTE]

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 3cfdd66289197772bbdb88e6017adb12ef21cf50 and d689059d0f9a15ccf20f6e2b42e896ec6a513a63.

📒 Files selected for processing (1)

• wren-ai-service/src/web/v1/services/ask.py (4 hunks)

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

• wren-ai-service/src/web/v1/services/ask.py

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

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

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[cyyeh]

@SyedaAnshrahGillani great feature! thanks for contribution! I will review and test it asap