Enforce valid UTF-8 encoding for sqlite collation names by ever0de · Pull Request #6015 · RustPython/RustPython

ever0de

Walkthrough

A UTF-8 validation step was added to the create_collation method in the SQLite connection implementation, ensuring that collation names are valid UTF-8 before proceeding. To support this, the ensure_valid_utf8 method in the PyStr implementation was made public, allowing its use outside its original module.

Changes

File(s)	Change Summary
stdlib/src/sqlite.rs	Added UTF-8 validation (`name.ensure_valid_utf8(vm)?`) at the start of `create_collation`.
vm/src/builtins/str.rs	Changed `ensure_valid_utf8` method in `PyStr` from private to public for broader accessibility.

Estimated code review effort

2 (10–30 minutes)

Possibly related PRs

fix(sqlite): produce correct error for surrogate characters #5962: Both PRs enhance UTF-8 validation handling for SQLite-related string inputs by improving error detection and propagation for invalid Unicode sequences within the stdlib/src/sqlite.rs context.

Suggested reviewers

youknowone

Poem

A bunny hops through code so bright,
UTF-8 checks now done just right.
Strings are safe, no surrogates sneak,
Collations robust, no errors to tweak.
With every hop, the code grows strong—
Valid text, all day long!
🐇✨

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bbe98dd and 67a6e13.

⛔ Files ignored due to path filters (1)

Lib/test/test_sqlite3/test_regression.py is excluded by !Lib/**

📒 Files selected for processing (2)

stdlib/src/sqlite.rs (1 hunks)
vm/src/builtins/str.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

**/*.rs: Follow the default rustfmt code style (cargo fmt to format)
Always run clippy to lint code (cargo clippy) before completing tasks. Fix any warnings or lints that are introduced by your changes
Follow Rust best practices for error handling and memory management
Use the macro system (pyclass, pymodule, pyfunction, etc.) when implementing Python functionality in Rust

Files:

vm/src/builtins/str.rs
stdlib/src/sqlite.rs

🔇 Additional comments (2)

vm/src/builtins/str.rs (1)

460-477: LGTM! Clean visibility change for UTF-8 validation.

The change from private to public visibility for ensure_valid_utf8 is well-justified and maintains the existing validation logic. The method correctly:

Checks UTF-8 validity using self.is_utf8()

Identifies the first invalid surrogate code point

Returns a proper UnicodeEncodeError with accurate position and message

This change enables external modules (like SQLite collation handling) to validate UTF-8 encoding while keeping the implementation encapsulated and robust.

stdlib/src/sqlite.rs (1)

1166-1166: LGTM – UTF-8 validation is correctly applied for create_collation

The call to name.ensure_valid_utf8(vm)? (defined in vm/src/builtins/str.rs:460–465) appropriately rejects invalid UTF-8 before converting to a C string and registering the collation.

Please review other SQLite methods that accept string names and call to_cstring(vm)?—for example, complete_statement, create_function, and create_aggregate—to ensure they likewise enforce UTF-8 validity where needed.

✨ 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

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

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.