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: filtering of unused-import,incorrect-solc, pragma #2472

Merged
merged 2 commits into from
Jun 5, 2024

Conversation

0xalpharush
Copy link
Contributor

@0xalpharush 0xalpharush commented Jun 5, 2024

closes #2415

Summary by CodeRabbit

  • Refactor

    • Improved handling and output formatting of Solidity pragma directives by version.
    • Enhanced detection logic for disallowed pragma versions.
  • New Features

    • Added functionality to handle import containers in unused import detection.
  • Tests

    • Updated test data and snapshots to reflect new formatting and version constraints for Solidity pragmas.
    • Improved test messages for outdated Solidity versions, recommending updates to newer versions.

Copy link

coderabbitai bot commented Jun 5, 2024

Warning

Rate limit exceeded

@0xalpharush has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 0 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 0d690c9 and fe254ef.

Walkthrough

The recent changes focus on improving how Solidity version directives and pragma handling are managed in the Slither detectors. The updates involve refactoring the storage and output formatting of pragma directives and disallowed pragmas, as well as enhancing the logic for detecting unused imports. Additionally, test snapshots have been updated to reflect these changes, ensuring that version constraints and usage recommendations are accurately represented.

Changes

File(s) Change Summary
slither/detectors/attributes/constant_pragma.py Refactored storage of pragma directives by version and adjusted output formatting for multiple versions.
slither/detectors/attributes/incorrect_solc.py Modified handling of disallowed pragmas by storing pragma objects in lists and enhancing output format for disallowed pragmas.
slither/detectors/statements/unused_import.py Added _is_import_container method and updated _detect method to handle import containers, improving logic for detecting unused imports based on file scopes and references.
tests/e2e/detectors/snapshots/... Updated test snapshots to reflect new version constraint representations and recommendations for Solidity versions, ensuring accurate detection and reporting in test data files.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Detectors unused-import, solc-version, and pragma should respect filter_paths config (#2415) The provided summary does not mention changes related to filter_paths configuration.

Possibly related issues


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

@0xalpharush 0xalpharush marked this pull request as ready for review June 5, 2024 21:30
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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 57842b0 and 0d690c9.

Files selected for processing (21)
  • slither/detectors/attributes/constant_pragma.py (1 hunks)
  • slither/detectors/attributes/incorrect_solc.py (1 hunks)
  • slither/detectors/statements/unused_import.py (3 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_ConstantPragma_0_4_25_pragma_0_4_25_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_ConstantPragma_0_5_16_pragma_0_5_16_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_ConstantPragma_0_6_11_pragma_0_6_11_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_ConstantPragma_0_7_6_pragma_0_7_6_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_4_25_static_sol__0.txt (2 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_5_14_static_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_5_16_dynamic_1_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_5_16_dynamic_2_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_5_16_static_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_6_10_static_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_6_11_dynamic_1_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_6_11_dynamic_2_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_6_11_static_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_7_4_static_sol__0.txt (2 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_7_6_dynamic_1_sol__0.txt (2 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_7_6_dynamic_2_sol__0.txt (1 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_7_6_static_sol__0.txt (2 hunks)
  • tests/e2e/detectors/snapshots/detectors__detector_UnusedImport_0_8_16_C_sol__0.txt (1 hunks)
Files skipped from review due to trivial changes (13)
  • tests/e2e/detectors/snapshots/detectors__detector_ConstantPragma_0_4_25_pragma_0_4_25_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_ConstantPragma_0_7_6_pragma_0_7_6_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_4_25_static_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_5_14_static_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_5_16_dynamic_1_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_5_16_dynamic_2_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_6_10_static_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_6_11_dynamic_1_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_6_11_dynamic_2_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_7_4_static_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_7_6_dynamic_2_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_7_6_static_sol__0.txt
  • tests/e2e/detectors/snapshots/detectors__detector_UnusedImport_0_8_16_C_sol__0.txt
Additional comments not posted (12)
tests/e2e/detectors/snapshots/detectors__detector_ConstantPragma_0_5_16_pragma_0_5_16_sol__0.txt (2)

3-3: Updated reference to version ^0.5.16 enhances traceability.


5-5: Updated reference to version ^0.5.15 enhances traceability.

tests/e2e/detectors/snapshots/detectors__detector_ConstantPragma_0_6_11_pragma_0_6_11_sol__0.txt (2)

3-3: Updated reference to version ^0.6.11 enhances traceability.


5-5: Updated reference to version ^0.6.10 enhances traceability.

tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_7_6_dynamic_1_sol__0.txt (1)

12-12: Updated reference to version ^0.7.4 enhances traceability.

tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_6_11_static_sol__0.txt (1)

14-14: Updated reference to version 0.6.11 enhances traceability.

tests/e2e/detectors/snapshots/detectors__detector_IncorrectSolc_0_5_16_static_sol__0.txt (1)

15-15: Updated reference to version 0.5.16 enhances traceability.

slither/detectors/attributes/constant_pragma.py (2)

39-41: Refactoring to store pragma directives in a list format enhances manageability and display.


48-51: Updated display format for version constraints improves clarity and structure.

slither/detectors/statements/unused_import.py (2)

34-64: The implementation of _is_import_container method appears logically sound and well-documented.


Line range hint 66-117: Enhancements to _detect method improve the accuracy of unused import detection by considering file dependencies and import containers.

slither/detectors/attributes/incorrect_solc.py (1)

118-129: Refactoring to store pragma objects in lists enhances data organization and retrieval in _detect method.

@0xalpharush 0xalpharush force-pushed the fix/filtering-detectors branch from 2212ff9 to fe254ef Compare June 5, 2024 21:50
@0xalpharush 0xalpharush changed the title Fix/filtering detectors fix: filtering of unused-import,incorrect-solc, pragma Jun 5, 2024
@0xalpharush 0xalpharush merged commit a0afa25 into dev Jun 5, 2024
83 checks passed
@0xalpharush 0xalpharush deleted the fix/filtering-detectors branch June 5, 2024 21:59
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.

1 participant