Skip to content

Fix build_green_tree token ownership#63

Merged
leynos merged 1 commit intomainfrom
codex/change-build_green_tree-to-borrow-tokens
Jul 7, 2025
Merged

Fix build_green_tree token ownership#63
leynos merged 1 commit intomainfrom
codex/change-build_green_tree-to-borrow-tokens

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 7, 2025

Summary

  • borrow tokens when constructing the CST to avoid unnecessary moves

Testing

  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_686c20b1ce3483228c1b6c1568e8aba5

Summary by Sourcery

Refactor the build_green_tree function to borrow token slices instead of consuming owned vectors, and update all call sites and tests to pass token references accordingly.

Enhancements:

  • Change build_green_tree signature to take a token slice reference (&[(SyntaxKind, Span)]) instead of an owned Vec
  • Adapt the token iteration and push_token calls to operate on borrowed tokens

Tests:

  • Update tests to invoke build_green_tree with &tokens instead of moving them

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 7, 2025

Reviewer's Guide

Refactor build_green_tree to borrow the token list rather than consuming it, eliminating unnecessary moves and updating loop destructuring, push_token usage, and related tests to work with the new signature.

File-Level Changes

Change Details Files
Refactor build_green_tree to borrow tokens instead of consuming
  • Changed function signature to accept a slice (&[(SyntaxKind, Span)])
  • Updated parse() and test call sites to pass &tokens
  • Removed Vec ownership moves in tree construction
src/parser/mod.rs
Adjust token iteration and push_token usage
  • Modified for loop to destructure tokens by reference
  • Updated push_token invocation to pass span directly
src/parser/mod.rs

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 7, 2025

Summary by CodeRabbit

  • Refactor
    • Improved internal efficiency by updating how token data is handled, reducing unnecessary cloning or moving of data. No changes to visible features or functionality.

Walkthrough

The build_green_tree function and its call sites have been updated to accept a borrowed slice of tokens (&[(SyntaxKind, Span)]) instead of taking ownership of a vector. All relevant function signatures and usages, including in tests, have been adjusted accordingly to use references.

Changes

File(s) Change Summary
src/parser/mod.rs Changed build_green_tree to accept a token slice reference; updated all call sites and token iteration.
(Test code in src/parser/mod.rs) Updated test calls to build_green_tree to pass token slices by reference.

Possibly related issues

Possibly related PRs

Poem

A rabbit nibbles code with glee,
Passing slices, wild and free.
No more vectors lost in flight—
Just borrowed tokens, swift and light.
With every hop, the code grows lean,
In parser fields of deepest green!
🥕


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 73b4d14 and 0268fe1.

📒 Files selected for processing (1)
  • src/parser/mod.rs (6 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.rs`: Comment why, not what. Explain assumptions, edge cases, trade-offs, o...

**/*.rs: Comment why, not what. Explain assumptions, edge cases, trade-offs, or complexity. Don't echo the obvious.
Comments must use en-GB-oxendict spelling and grammar.
Function documentation must include clear examples.
Name things precisely. Use clear, descriptive variable and function names. For booleans, prefer names with is, has, or should.
Each file should encapsulate a coherent module. Group related code (e.g., models + utilities + fixtures) close together.
Group by feature, not layer. Colocate views, logic, fixtures, and helpers related to a domain concept rather than splitting by type.
Every module must begin with a module level (//! ) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.
Do not use return in single-line functions.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.
Clippy warnings MUST be disallowed.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Use predicate functions for conditional criteria with more than two branches.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Prefer .expect() over .unwrap().

📄 Source: CodeRabbit Inference Engine (AGENTS.md)

List of files the instruction was applied to:

  • src/parser/mod.rs
`**/*.rs`: * Seek to keep the cyclomatic complexity of functions no more than 12...

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

  • Adhere to single responsibility and CQRS

  • Place function attributes after doc comments.

  • Do not use return in single-line functions.

  • Move conditionals with >2 branches into a predicate function.

  • Avoid unsafe unless absolutely necessary.

  • Every module must begin with a //! doc comment that explains the module's purpose and utility.

  • Comments must use en-GB-oxendict spelling and grammar.

  • Lints must not be silenced except as a last resort.

    • #[allow] is forbidden.
    • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
    • No lint groups, no blanket or file-wide suppression.
    • Include FIXME: with link if a fix is expected.
  • Use rstest fixtures for shared setup and to avoid repetition between tests.

  • Replace duplicated tests with #[rstest(...)] parameterised cases.

  • Prefer mockall for mocks/stubs.

  • Prefer .expect() over .unwrap()

  • Ensure that any API or behavioural changes are reflected in the documentation in docs/

  • Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

  • src/parser/mod.rs
🧬 Code Graph Analysis (1)
src/parser/mod.rs (1)
src/parser/token_stream.rs (2)
  • tokens (105-107)
  • src (118-120)
⏰ Context from checks skipped due to timeout of 240000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build-test
🔇 Additional comments (5)
src/parser/mod.rs (5)

849-849: Well-implemented signature change for better performance.

The function signature change from Vec<(SyntaxKind, Span)> to &[(SyntaxKind, Span)] follows Rust best practices by borrowing instead of taking ownership for read-only access. This avoids unnecessary moves and improves efficiency.


258-258: Correct call site update.

The change from build_green_tree(tokens, src, &spans) to build_green_tree(&tokens, src, &spans) correctly matches the updated function signature.


861-861: Proper destructuring pattern for slice iteration.

The pattern for &(kind, ref span) in tokens correctly destructures each &(SyntaxKind, Span) element from the slice, yielding kind: SyntaxKind and span: &Span.


901-901: Correct reference handling in function call.

The change to pass span directly (instead of &span) is correct because span is now &Span (from ref span destructuring), matching the push_token function's expected parameter type span: &Span.


849-849: Consistent test updates.

The test calls are correctly updated to use &tokens, maintaining consistency with the function signature change.

Also applies to: 877-877

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/change-build_green_tree-to-borrow-tokens

🪧 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 auto-generate unit tests to generate unit tests 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.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos leynos linked an issue Jul 7, 2025 that may be closed by this pull request
@leynos leynos merged commit eb0b867 into main Jul 7, 2025
2 checks passed
@leynos leynos deleted the codex/change-build_green_tree-to-borrow-tokens branch July 7, 2025 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Optimise build_green_tree to accept token slice instead of Vec

1 participant