add to_unchecked_string, deprecate old APIs

[Yoorkin]

• add to_unchecked_string(~offset,~length) to Bytes
• add to_unchecked_string to Buffer
• deprecate Bytes::to_string Bytes::sub_string Buffer::to_string

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coveralls]

Pull Request Test Coverage Report for Build 3839

Details

• 6 of 9 (66.67%) changed or added relevant lines in 4 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-0.03%) to 80.17%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
buffer/buffer.mbt	2	3	66.67%
builtin/buffer.mbt	0	1	0.0%
builtin/bytes.mbt	2	3	66.67%

Totals
Change from base Build 3837:	-0.03%
Covered Lines:	4342
Relevant Lines:	5416

---

💛 - Coveralls

[peter-jerry-ye]

We may need to unify to unsafe_xxx or xxx_unsafe

[peter-jerry-ye-code-review]

From the provided git diff output, here are three observations that could potentially lead to issues or improvements in the MoonBit code:

1. Deprecated Function Usage:

   • The function sub_string is marked as deprecated in multiple places and is replaced with to_unchecked_string. However, in some instances, such as in builtin/bytes_test.mbt, the deprecation alert is missed for the sub_string function. This could lead to future confusion or issues if the deprecated function is eventually removed.

     - assert_eq!(bytes.sub_string(0, 5 * 2), "Hello")
     + assert_eq!(bytes.to_unchecked_string(offset=0, length=5 * 2), "Hello")

   Suggestion: Ensure all instances of sub_string are updated to to_unchecked_string and add the appropriate deprecation alerts where missing.

2. Incorrect Documentation Update:

   • In buffer/buffer.mbt, the documentation comment for to_string is updated to mention "new string" instead of "new String". This typo might seem minor but could lead to confusion, especially since MoonBit seems to prefer starting type names with an uppercase letter.

     - /// Return a new String contains the data in buffer.
     + /// Return a new string contains the data in buffer.

   Suggestion: Correct the typo to maintain consistency in documentation and code style.

   - /// Return a new string contains the data in buffer.
   + /// Return a new String contains the data in buffer.

3. Potential Security Concern with to_unchecked_string:

   • The function to_unchecked_string is introduced to replace sub_string but it mentions that it does not validate the encoding of the byte sequence. This could potentially lead to security issues if the byte sequence is not properly validated before conversion to a string.

     +pub fn to_unchecked_string(self : Buffer) -> String {
     +  self.bytes.to_unchecked_string(offset=0, length=self.len)
     +}

   Suggestion: Although the function is named "unchecked" to indicate its behavior, consider adding a prominent warning in the documentation and possibly in the code comments to highlight the potential risks associated with its use. This will help developers make informed decisions about when and how to use this function safely.

These observations focus on maintaining code clarity, addressing deprecation properly, and ensuring awareness of potential security implications, which are crucial for the maintainability and robustness of the codebase.

[Yoorkin]

@bobzhang, we need to merge this before changing the behavior of to_string in #1141, and provide users with time to migrate

[bobzhang]

type Buffer should be deprecated, leave it untouched

[bobzhang]

lgtm