Fix #2266

[DarkaMaul]

When a function was used as a r-value in a variable assignment, its type was not properly printed using the slithir printer.

This PR fixes that.

It also add a test to check that this issue does not arise again. However, I'm unsure where to put this test and if we even want tests for this kind of issues.

Summary by CodeRabbit

• Bug Fixes
  • Improved the display of function return types in certain scenarios.
• New Features
  • Introduced new test cases to enhance the testing of SlithIR printer functionality.
• Tests
  • Added tests for validating the correct behavior of SlithIR output in edge cases.

[coderabbitai]

Walkthrough

This update enhances the Slither tool's handling of function return types and introduces a new test to ensure the accuracy of the Slither IR printer. It addresses a specific issue where the return type of functions wasn't displayed correctly when functions were used as rvalues, improving the tool's usability for Solidity developers.

Changes

Files	Summary
.../operations/assignment.py	Modified to correctly display function return types as rvalues.
tests/e2e/printers/.../bug-2266.sol	Added a new test file with Solidity contracts to support the assignment modification.
tests/e2e/printers/test_printers.py	Introduced a new test function to ensure the Slither IR printer's output is accurate.

Possibly related issues

• [Bug]: Reference variable has type None when overriding a variable name  #2050: The update could potentially address the incorrect typing issue by improving how return types are handled and displayed, making IR more accurate.
• [Bug]: lowering of InitArray fails #2210: Although this change focuses on display and assignment, the underlying improvements in handling function return types might indirectly resolve type-related errors mentioned.

🐇✨
In the realm of code, where the smart contracts play,
A rabbit hopped in, making everything okay.
With a flick and a fix, no more display dismay,
Now the types shine bright, clear as day.
Celebrate the change, hip hip hooray!
🎉🐰

---

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.

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

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between fdf54f6 and 114dc2e.

Files selected for processing (3)

• slither/slithir/operations/assignment.py (1 hunks)
• tests/e2e/printers/test_data/test_printer_slithir/bug-2266.sol (1 hunks)
• tests/e2e/printers/test_printers.py (2 hunks)

Additional comments not posted (3)

tests/e2e/printers/test_data/test_printer_slithir/bug-2266.sol (1)

1-13: The Solidity test file bug-2266.sol is correctly set up to replicate the issue being addressed. It effectively demonstrates the assignment of a function to a local variable, which is central to the issue fixed by this PR.

tests/e2e/printers/test_printers.py (1)

40-52: The test function test_slithir_printer correctly implements the logic to verify the fix for the PrinterSlithIR functionality. However, it would be beneficial to add a comment explaining why the presence of "slither.core.solidity_types" in the output indicates a failure to correctly display function types.

slither/slithir/operations/assignment.py (1)

48-63: The changes made to the Assignment class correctly address the issue of displaying function return types when they are used as r-values in assignments. To ensure robustness, consider adding unit tests covering both single and multiple return types scenarios.