Skip to content

chore(wren-ui): enhance model substitution error message#1574

Merged
wwwy3y3 merged 3 commits intomainfrom
chore/error-message-dialect-sql
Apr 18, 2025
Merged

chore(wren-ui): enhance model substitution error message#1574
wwwy3y3 merged 3 commits intomainfrom
chore/error-message-dialect-sql

Conversation

@onlyjackfrost
Copy link
Copy Markdown
Contributor

@onlyjackfrost onlyjackfrost commented Apr 18, 2025

enhance model substitution error message

Summary by CodeRabbit

  • Bug Fixes
    • Improved error messages for "Model not found" scenarios, providing more specific guidance based on how the model name is formatted.
  • Tests
    • Added new tests to ensure error messages are accurate for different model name formats.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 18, 2025

Caution

Review failed

The pull request is closed.

"""

Walkthrough

This update refines the error message logic in the modelSubstituteErrorMessageBuilder function within the Ibis adaptor. The function now analyzes the number of dots in the model name from error messages and provides tailored guidance: suggesting catalog and/or schema prefixes or indicating possible issues with the model's existence, naming, or case. Corresponding tests have been added to ensure the function returns the correct message for model names with zero, one, two, or more dots. No changes were made to exported or public entity declarations.

Changes

File(s) Change Summary
wren-ui/src/apollo/server/adaptors/ibisAdaptor.ts Enhanced error message logic in modelSubstituteErrorMessageBuilder to provide specific suggestions based on the number of dots in the model name.
wren-ui/src/apollo/server/adaptors/tests/ibisAdaptor.test.ts Added three new test cases to cover error handling for model names with one, two, and more than two dots in the modelSubstitute method, verifying tailored error messages and extensions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant IbisAdaptor
    participant ErrorHandler

    User->>IbisAdaptor: Call modelSubstitute with model name
    IbisAdaptor->>IbisAdaptor: Attempt model substitution
    IbisAdaptor->>ErrorHandler: Catch MODEL_NOT_FOUND error
    ErrorHandler->>ErrorHandler: Count dots in model name
    ErrorHandler->>IbisAdaptor: Return tailored error message
    IbisAdaptor-->>User: Reject with specific guidance
Loading

Possibly related PRs

Suggested reviewers

  • andreashimin
  • wwwy3y3

Poem

In the land of dots and names,
The adaptor now plays clever games.
With every dot, advice is new—
Catalog? Schema? Or just a clue?
Tests now check each message right,
Helping coders sleep at night.
🐇✨
"""

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 0d6a9e7 and ae41f7e.

📒 Files selected for processing (2)
  • wren-ui/src/apollo/server/adaptors/ibisAdaptor.ts (1 hunks)
  • wren-ui/src/apollo/server/adaptors/tests/ibisAdaptor.test.ts (1 hunks)

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

@wwwy3y3 wwwy3y3 merged commit 1a5cfe0 into main Apr 18, 2025
8 of 9 checks passed
@wwwy3y3 wwwy3y3 deleted the chore/error-message-dialect-sql branch April 18, 2025 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants