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

fix: all bindgen functionns external instead of view #2725

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

MartianGreed
Copy link
Contributor

@MartianGreed MartianGreed commented Nov 26, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced function generation for TypeScript based on state mutability, differentiating between External and View functions.
    • Introduced a new format for View functions that does not require input parameters.
  • Bug Fixes

    • Improved handling of function input parameters for View functions.
  • Tests

    • Added a new test case to validate the behavior of function input formatting for View functions.

Copy link

coderabbitai bot commented Nov 26, 2024

Walkthrough

Ohayo, sensei! This pull request introduces enhancements to the TsFunctionGenerator class in function.rs, focusing on how functions are generated based on the state mutability of tokens. The StateMutability enum is now utilized to distinguish between External and View functions, affecting the formatting and input handling in the generate_system_function and format_function_inputs methods. Additionally, a new test case and a helper function for creating View functions have been added to improve testing capabilities.

Changes

File Path Change Summary
crates/dojo/bindgen/src/plugins/typescript/generator/function.rs - Updated generate_system_function to handle StateMutability for formatting.
- Modified format_function_inputs to return an empty vector for View functions.
- Added create_basic_view_function for testing purposes.
- Introduced new test case test_format_function_inputs_view for validating View function behavior.

Possibly related PRs

  • fix: function mappings + object naming #2651: The changes in this PR also modify the generate_system_function method in the TsFunctionGenerator class, which is directly related to the enhancements made in the main PR regarding function generation based on state mutability.

Suggested reviewers

  • glihm

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>, please review it.
    • 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 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.

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

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

🧹 Outside diff range and nitpick comments (1)
crates/dojo/bindgen/src/plugins/typescript/generator/function.rs (1)

Line range hint 38-77: Ohayo, sensei! Consider refactoring duplicated code in generate_system_function.

The match arms for StateMutability::External and StateMutability::View share similar structures, especially in error handling and function templates. Refactoring the common parts could improve readability and maintainability.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8eb8c48 and e25c963.

📒 Files selected for processing (1)
  • crates/dojo/bindgen/src/plugins/typescript/generator/function.rs (5 hunks)
🔇 Additional comments (4)
crates/dojo/bindgen/src/plugins/typescript/generator/function.rs (4)

1-1: Ohayo, sensei! Importing StateMutability for function generation.

Including StateMutability in the imports enables handling of External and View functions appropriately during code generation.


81-84: Ohayo, sensei! Correct handling of function inputs based on mutability.

The format_function_inputs method adjusts inputs appropriately for External and View functions by including or excluding snAccount.


298-304: Ohayo, sensei! Great addition of test for View functions.

Adding test_format_function_inputs_view enhances test coverage and ensures that View functions are handled correctly.


441-449: Ohayo, sensei! Helpful create_basic_view_function for testing.

The create_basic_view_function provides a clear way to test View functions, improving test clarity and maintainability.

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

Attention: Patch coverage is 60.46512% with 17 lines in your changes missing coverage. Please review.

Project coverage is 56.24%. Comparing base (da52a06) to head (e25c963).
Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
...ndgen/src/plugins/typescript/generator/function.rs 60.46% 17 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2725   +/-   ##
=======================================
  Coverage   56.23%   56.24%           
=======================================
  Files         415      415           
  Lines       53206    53241   +35     
=======================================
+ Hits        29921    29943   +22     
- Misses      23285    23298   +13     

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

@glihm glihm merged commit 1aabd5f into dojoengine:main Nov 26, 2024
14 checks passed
augustin-v pushed a commit to augustin-v/dojo that referenced this pull request Dec 4, 2024
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