Skip to content
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

Allow to declare a reference as a constructor arg #387

Merged
merged 1 commit into from
Mar 28, 2024

Conversation

kpob
Copy link
Contributor

@kpob kpob commented Mar 28, 2024

Before if there was a reference in the constructor, the generated code was:

struct Erc20InitArgs {
  name: &String,
  ...
}

resulting a missing lifetime error. InitArgs should not have references as fields.

Summary by CodeRabbit

  • Refactor
    • Improved handling of argument types in mapping operations for enhanced reliability.

Copy link
Contributor

coderabbitai bot commented Mar 28, 2024

Walkthrough

This update refines the handling of argument types within a mapping operation in the codebase. It introduces a utility function dedicated to managing unreferenced types, streamlining the process and enhancing code efficiency and readability.

Changes

File(s) Change Summary
odra-macros/src/ast/deployer_item.rs Modified argument type handling in mapping by using a utility function for unreferenced types.

🐇✨

In the realm of code, where logic intertwines,
A rabbit hopped through, leaving changes behind.
With a flick and a hop, a tweak so fine,
Unreferenced types now gracefully align.
Celebrate we shall, for the code does shine,
Thanks to the rabbit, our guide divine.
🌟🐾

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

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ee1ca6e and e065d02.
Files selected for processing (1)
  • odra-macros/src/ast/deployer_item.rs (1 hunks)
Additional comments (1)
odra-macros/src/ast/deployer_item.rs (1)
  • 94-94: The modification to use utils::ty::unreferenced_ty for handling argument types in the InitArgsItem struct is a crucial improvement. This change effectively addresses the issue of missing lifetime errors by ensuring that references are not included in the InitArgs structs. By doing so, it aligns with Rust's ownership and borrowing rules, making the generated code more robust and compliant.

However, it's important to ensure that this change does not inadvertently affect other parts of the codebase where references might be intentionally used or required. Additionally, considering the complexity of Rust's lifetime and borrowing rules, thorough testing is recommended to verify that the generated code behaves as expected in various scenarios.

Verification successful

The usage of utils::ty::unreferenced_ty across the codebase for handling argument types in AST manipulation is consistent and aligns with the intended improvement mentioned in the review. The function's application in various parts of the codebase supports the notion that this approach is beneficial for ensuring that references are not included in structs like InitArgsItem, without introducing unintended side effects. This consistency in usage across different AST manipulation contexts verifies the original review comment.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that the unreferenced_ty function is used consistently across the codebase for similar purposes.
rg --type rust 'utils::ty::unreferenced_ty' -C 3

# Ensure that there are no unintended side effects in other parts of the codebase due to this change.
# This script is a placeholder for more specific tests that should be conducted.
echo "Placeholder for specific tests to verify the behavior of the generated code."

Length of output: 2200

Copy link

codecov bot commented Mar 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (release/0.8.2@ee1ca6e). Click here to learn what that means.

Additional details and impacted files
@@               Coverage Diff                @@
##             release/0.8.2     #387   +/-   ##
================================================
  Coverage                 ?   84.98%           
================================================
  Files                    ?      126           
  Lines                    ?    13740           
  Branches                 ?        0           
================================================
  Hits                     ?    11677           
  Misses                   ?     2063           
  Partials                 ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kpob kpob merged commit a0b5d3d into release/0.8.2 Mar 28, 2024
6 checks passed
@kpob kpob deleted the fix/references-in-constructor branch March 28, 2024 10:00
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