feat(wren-ui): pass invalid sql from AI service

[onlyjackfrost]

pass invalid sql from AI service

Summary by CodeRabbit

• New Features
  • Improved SQL query feedback by adding an indicator for invalid SQL, enabling more informative error reporting for users.

[coderabbitai]

Walkthrough

The pull request enhances SQL error reporting by adding an additional property to various components. In the transformAskResult method of the adaptor, a new property invalid_sql is extracted and returned as invalidSql. Parallel changes extend TypeScript interfaces and the GraphQL schema to support this field, ensuring that SQL validation feedback is propagated consistently through the resolver and data models.

Changes

File(s)	Change Summary
wren-ui/.../adaptors/wrenAIAdaptor.ts	Updated transformAskResult to destructure invalid_sql from the input and return it as invalidSql.
wren-ui/.../models/adaptor.ts	Added optional properties: invalid_sql?: string to AskResponse and invalidSql?: string to AskResult for enhanced error reporting.
wren-ui/.../resolvers/askingResolver.ts, wren-ui/.../schema.ts	Introduced the optional invalidSql property in the AskingTask interface and GraphQL type; updated resolver logic to include data from askResult.invalid_sql.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Resolver as AskingResolver
    participant Adaptor as WrenAIAdaptor
    participant Schema as GraphQL Schema

    Client->>Resolver: Request asking task
    Resolver->>Adaptor: Call transformAskResult(body)
    Adaptor->>Adaptor: Extract type, intent_reasoning, and invalid_sql
    Adaptor-->>Resolver: Return response with invalidSql field
    Resolver->>Schema: Map response to AskingTask (includes invalidSql)
    Resolver-->>Client: Return asking task with enhanced SQL error info

Loading

Possibly related PRs

• feat(wren-ai-service): Add invalid SQL tracking to AskResultResponse #1356: Introduces an invalid_sql attribute in the AskResultResponse class to improve SQL error reporting, closely related to the changes in the adaptor.
• feat(wren-ui): use intent reasoning instead of hard code string for misleading query #1217: Updates the transformAskResult method to include the intent_reasoning property, reinforcing similar enhancements to the method’s output structure.

Suggested labels

module/ai-service, ci/ai-service

Suggested reviewers

• wwwy3y3

Poem

I'm a rabbit of code, with a hop so light,
Bringing new fields to shine bright tonight.
I nibble on errors and transform each clue,
Adding invalidSql—a change fresh and new.
With carrots and code, I cheerfully say,
Happy hops in our codebase every day!

---

📜 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 ed0d0c6 and 21025ca.

📒 Files selected for processing (4)

• wren-ui/src/apollo/server/adaptors/wrenAIAdaptor.ts (2 hunks)
• wren-ui/src/apollo/server/models/adaptor.ts (2 hunks)
• wren-ui/src/apollo/server/resolvers/askingResolver.ts (2 hunks)
• wren-ui/src/apollo/server/schema.ts (1 hunks)

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

• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Analyze (go)

🔇 Additional comments (7)

wren-ui/src/apollo/server/schema.ts (1)

588-588: Approved: Added new field for invalid SQL reporting.

The new invalidSql field in the AskingTask type will allow the system to expose invalid SQL information to the client, improving error reporting capabilities.

wren-ui/src/apollo/server/resolvers/askingResolver.ts (2)

48-48: Approved: Added interface property for invalid SQL.

The invalidSql property in the AskingTask interface properly matches the GraphQL schema change, maintaining type consistency.

---

222-230: Improved code organization with better variable extraction.

Good refactoring to create a res object before returning, making it easier to add the new invalidSql property while maintaining readability.

wren-ui/src/apollo/server/adaptors/wrenAIAdaptor.ts (2)

510-511: Approved: Added extraction of invalid_sql from API response.

Properly destructuring the invalid_sql property from the response body to make it available for the return object.

---

524-524: Approved: Mapped invalid_sql to invalidSql in return object.

Correctly mapped the snake_case invalid_sql from the API response to the camelCase invalidSql in the return object, maintaining consistent naming conventions.

wren-ui/src/apollo/server/models/adaptor.ts (2)

100-100: Approved: Added optional property to AskResponse interface.

The invalid_sql property has been correctly added as optional to the AskResponse interface, allowing for backward compatibility.

---

126-126: Approved: Added optional property to AskResult type.

The invalidSql property has been correctly added as optional to the AskResult type to support the new error reporting feature.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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