Skip to content

feat(allocator): add String::set_len method#10757

Merged
graphite-app[bot] merged 1 commit intomainfrom
05-01-feat_allocator_add_string_set_len_method
May 2, 2025
Merged

feat(allocator): add String::set_len method#10757
graphite-app[bot] merged 1 commit intomainfrom
05-01-feat_allocator_add_string_set_len_method

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented May 1, 2025

Add unsafe String::set_len method to match Vec::set_len.

Copy link
Member Author

overlookmotel commented May 1, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added the C-enhancement Category - New feature or request label May 1, 2025
@overlookmotel overlookmotel marked this pull request as ready for review May 1, 2025 16:49
@coderabbitai
Copy link

coderabbitai bot commented May 1, 2025

Walkthrough

A new unsafe method set_len was added to the String<'alloc> implementation in the crates/oxc_allocator/src/string.rs file. This method allows setting the string's length directly. It requires the caller to ensure that the new length is less than or equal to the string's capacity, that any newly included bytes beyond the current length are initialized, and that the new length lies on a UTF-8 character boundary so that the resulting string slice is valid UTF-8. Internally, the method delegates to the set_len method of the underlying mutable vector that stores the string data. Safety comments clarify that these invariants must be upheld by the caller. The method is publicly exposed as part of the String<'alloc> interface.


📜 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 05b9380 and 4b4b09e.

📒 Files selected for processing (1)
  • crates/oxc_allocator/src/string.rs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • crates/oxc_allocator/src/string.rs
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: Conformance
  • GitHub Check: Benchmark (formatter)
  • GitHub Check: Benchmark (codegen)
  • GitHub Check: Benchmark (minifier)
  • GitHub Check: Benchmark (semantic)
  • GitHub Check: Test wasm32-wasip1-threads
  • GitHub Check: Benchmark (isolated_declarations)
  • GitHub Check: Test NAPI
  • GitHub Check: Benchmark (transformer)
  • GitHub Check: Test (macos-latest)
  • GitHub Check: Benchmark (parser)
  • GitHub Check: Test (ubuntu-latest)
  • GitHub Check: Benchmark (lexer)
  • GitHub Check: Miri
  • GitHub Check: Clippy
  • GitHub Check: Build Linter Benchmark
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

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.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
crates/oxc_allocator/src/string.rs (1)

302-316: Method implementation looks good, but consider adding tests.

The set_len method is correctly implemented, with thorough safety documentation covering all the important invariants that callers must maintain. The function correctly delegates to the underlying vector's set_len method, matching the expected behavior of Vec::set_len.

Consider adding tests for this method to verify it works correctly in various scenarios, especially since it's an unsafe method with important invariants. For example, you could test:

  1. Setting to a smaller length (truncation)
  2. Setting to a equal length (no change)
  3. Verifying UTF-8 boundary requirements
#[test]
fn test_set_len() {
    let allocator = Allocator::default();
    
    // Test truncation
    let mut string = String::from_str_in("hello world", &allocator);
    unsafe { string.set_len(5) }; // Truncate to "hello"
    assert_eq!(string, "hello");
    
    // Test setting to same length
    let original_len = string.len();
    unsafe { string.set_len(original_len) };
    assert_eq!(string, "hello");
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2718f29 and 1b4d9ff.

📒 Files selected for processing (1)
  • crates/oxc_allocator/src/string.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Benchmark (codegen)
  • GitHub Check: Benchmark (formatter)
  • GitHub Check: Benchmark (parser)
  • GitHub Check: Benchmark (minifier)
  • GitHub Check: Benchmark (transformer)
  • GitHub Check: Benchmark (lexer)
  • GitHub Check: Conformance
  • GitHub Check: Clippy
  • GitHub Check: Build Linter Benchmark
  • GitHub Check: Test NAPI
  • GitHub Check: Miri

@codspeed-hq
Copy link

codspeed-hq bot commented May 1, 2025

CodSpeed Instrumentation Performance Report

Merging #10757 will not alter performance

Comparing 05-01-feat_allocator_add_string_set_len_method (4b4b09e) with main (79e462d)

Summary

✅ 36 untouched benchmarks

@overlookmotel
Copy link
Member Author

This was originally added for #10758, which is now closed. But it's still a useful addition to API.

@Boshen Boshen added the 0-merge Merge with Graphite Merge Queue label May 2, 2025
Copy link
Member

Boshen commented May 2, 2025

Merge activity

graphite-app bot pushed a commit that referenced this pull request May 2, 2025
Add unsafe `String::set_len` method to match `Vec::set_len`.
@graphite-app graphite-app bot force-pushed the 05-01-feat_allocator_add_string_set_len_method branch from 1b4d9ff to c02fcef Compare May 2, 2025 00:11
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label May 2, 2025
overlookmotel added a commit that referenced this pull request May 2, 2025
Add unsafe `String::set_len` method to match `Vec::set_len`.
@overlookmotel overlookmotel force-pushed the 05-01-feat_allocator_add_string_set_len_method branch from c02fcef to 767dada Compare May 2, 2025 07:02
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label May 2, 2025
Add unsafe `String::set_len` method to match `Vec::set_len`.
@graphite-app graphite-app bot force-pushed the 05-01-feat_allocator_add_string_set_len_method branch from 05b9380 to 4b4b09e Compare May 2, 2025 07:15
@graphite-app graphite-app bot merged commit 4b4b09e into main May 2, 2025
26 checks passed
@graphite-app graphite-app bot deleted the 05-01-feat_allocator_add_string_set_len_method branch May 2, 2025 07:21
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label May 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-enhancement Category - New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants