fix(ibis): Enforcing MySQL utf8mb4 charset in connections

[douenergy]

Fix Canner/WrenAI#1374

Summary by CodeRabbit

• New Features

  • Improved MySQL connection handling now defaults to a robust UTF-8 variant, ensuring more reliable support for extended characters.

• Tests

  • Introduced a new test validating the handling of Chinese column names and data, reinforcing data integrity and seamless operation with diverse character sets.

[coderabbitai]

Walkthrough

The pull request updates the MySQL connection method in the data source module by setting a default character set (utf8mb4) if none is provided. In addition, it adds an asynchronous test function that creates a table with Chinese column names, inserts data with Chinese characters, and verifies that querying the database returns the expected results. The modifications maintain the existing control flow while ensuring consistent MySQL connection settings and validating character encoding through comprehensive testing.

Changes

File Path	Change Summary
ibis-server/app/model/.../data_source.py	Added kwargs.setdefault("charset", "utf8mb4") in get_mysql_connection to enforce UTF-8 encoding.
ibis-server/tests/routers/.../test_mysql.py	Introduced async test test_chinese_column_name_and_data to validate table creation, data insertion, query execution, and assertions using Chinese characters.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant DS as DataSourceExtension
    participant MYSQL as ibis.mysql.connect
    C->>DS: Call get_mysql_connection(info)
    DS->>DS: Set default charset (utf8mb4) if missing
    DS->>MYSQL: Connect with updated kwargs
    MYSQL-->>DS: Return MySQL connection
    DS-->>C: Return connection

Loading

sequenceDiagram
    participant T as Test Function
    participant DB as MySQL Container/Database
    T->>DB: Create table with Chinese column names
    T->>DB: Insert rows with Chinese characters
    T->>DB: Execute SQL query on ChineseTest table
    DB-->>T: Return query results
    T->>T: Assert response status and data correctness

Loading

Poem

I hopped through code with eager grace,
Setting charsets to keep pace.
Tables bloom with Chinese flair,
Data tested with utmost care.
A bunny's cheer in every line—
Debug and dance, results just fine! 🐇
Hop along in code divine!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 e233981 and 2715002.

📒 Files selected for processing (2)

• ibis-server/app/model/data_source.py (1 hunks)
• ibis-server/tests/routers/v2/connector/test_mysql.py (1 hunks)

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

• GitHub Check: ci

🔇 Additional comments (2)

ibis-server/app/model/data_source.py (1)

157-159: Great improvement: Adding utf8mb4 charset support for MySQL connections

This change properly enforces the utf8mb4 charset in MySQL connections, which is essential for supporting the full range of Unicode characters including emojis and multi-byte characters like Chinese. Using setdefault() ensures backward compatibility by only setting the default if no charset is already specified.

ibis-server/tests/routers/v2/connector/test_mysql.py (1)

478-550: Well-structured test for validating utf8mb4 charset support

This test thoroughly validates the MySQL utf8mb4 charset implementation by:

1. Creating a table with Chinese column names
2. Inserting data with Chinese characters
3. Querying and verifying the results

The test setup and teardown are properly handled with container initialization and cleanup.

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

[douenergy]

The root issue stems from the Ibis server image utilizing the libmysqlclient-dev MySQL driver, which differs from the driver implementation on macOS. I've successfully built and deployed the Ibis server image locally and conducted testing with Wren AI. The results confirm full UTF-8 compatibility.

[goldmedal]

Thanks @douenergy LGTM