Skip to content

Introduce PyUtf8Str and fix(sqlite): validate surrogates in SQL statements #5969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

ever0de
Copy link
Contributor

@ever0de ever0de commented Jul 14, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved validation of SQL input strings when creating new statements, ensuring errors are detected earlier if the input is invalid.
  • New Features
    • Added UTF-8 string handling enhancements for better validation and conversion of text inputs.

Copy link
Contributor

coderabbitai bot commented Jul 14, 2025

Warning

Rate limit exceeded

@ever0de has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 48 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a50a7bc and 3899fbe.

📒 Files selected for processing (1)
  • vm/src/builtins/str.rs (4 hunks)

Walkthrough

The Statement::new function in the SQLite module was updated to accept a PyStrRef for the SQL string and to convert it explicitly into a UTF-8 validated PyUtf8Str using try_into_utf8. A new wrapper type PyUtf8Str was introduced around PyStr with methods to ensure UTF-8 validity.

Changes

File(s) Change Summary
stdlib/src/sqlite.rs Changed Statement::new signature to accept PyStrRef and added explicit UTF-8 conversion of SQL string.
vm/src/builtins/str.rs Added new PyUtf8Str wrapper type around PyStr with UTF-8 validation methods, including try_into_utf8.

Possibly related PRs

Suggested reviewers

  • youknowone

Poem

A bunny hopped through lines of code,
In SQLite’s gentle abode.
It checked the strings before the leap,
So errors wouldn’t make us weep.
One tiny hop, a safer run—
Early validation, now it’s done! 🐇✨

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

@ever0de ever0de marked this pull request as ready for review July 14, 2025 10:25
Comment on lines 2297 to 2298
let _ = sql.try_to_str(vm)?;
let sql_cstr = sql.to_cstring(vm)?;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It means we shouldn't create cstring from wtf8, but have to create one from str.
The underlying logic of this approach is fine. But let _ = sql.try_to_str(vm)?; to discard the result of try_to_str is weird.
How about adding a new helper method, fn ensure_utf8(&self) -> PyResult<()>, which provides basically the same feature but with better naming? I can call try_to_str inside.

Another suggestion is a proper way to handle it.

impl PyRef<PyStr> {
...
    fn into_utf8(self) -> PyRef<PyUtf8Str>
...
}

struct PyUtf8Str(PyStr);

This will be useful when we actually need utf8 string instead of wtf8

Comment on lines 95 to 103
/// Returns the underlying string slice. This is safe because the
/// type invariant guarantees UTF-8 validity.
pub fn as_str(&self) -> &str {
debug_assert!(
self.0.is_utf8(),
"PyUtf8Str invariant violated: inner string is not valid UTF-8"
);
unsafe { self.0.to_str().unwrap_unchecked() }
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The safety is trivial for users, but not for devs

Suggested change
/// Returns the underlying string slice. This is safe because the
/// type invariant guarantees UTF-8 validity.
pub fn as_str(&self) -> &str {
debug_assert!(
self.0.is_utf8(),
"PyUtf8Str invariant violated: inner string is not valid UTF-8"
);
unsafe { self.0.to_str().unwrap_unchecked() }
}
/// Returns the underlying string slice.
pub fn as_str(&self) -> &str {
debug_assert!(
self.0.is_utf8(),
"PyUtf8Str invariant violated: inner string is not valid UTF-8"
);
// Safety: This is safe because the type invariant guarantees UTF-8 validity.
unsafe { self.0.to_str().unwrap_unchecked() }
}

#[derive(Debug)]
pub struct PyUtf8Str(PyStr);

impl std::ops::Deref for PyUtf8Str {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
impl std::ops::Deref for PyUtf8Str {
// TODO: Remove this Deref which may hide missing optimized methods of PyUtf8Str
impl std::ops::Deref for PyUtf8Str {

@youknowone youknowone changed the title fix(sqlite): validate surrogates in SQL statements Introduce PyUtf8Str and fix(sqlite): validate surrogates in SQL statements Jul 14, 2025
Copy link
Member

@youknowone youknowone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@youknowone youknowone merged commit ed43383 into RustPython:main Jul 14, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants