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

chore(katana-rpc): test cleanup #2363

Merged
merged 1 commit into from
Aug 29, 2024
Merged

chore(katana-rpc): test cleanup #2363

merged 1 commit into from
Aug 29, 2024

Conversation

kariy
Copy link
Member

@kariy kariy commented Aug 29, 2024

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced error handling in contract declaration and deployment tests for improved reliability.
    • Streamlined assertions to directly check expected outcomes, increasing clarity.
  • Chores

    • Removed unused imports to clean up the codebase.
    • Replaced hardcoded values with constants for better maintainability.
  • Refactor

    • Simplified transaction waiting logic and improved constructor call data for consistency and readability.

Copy link

coderabbitai bot commented Aug 29, 2024

Walkthrough

Ohayo, sensei! The changes involve significant updates to the test functions for declaring and deploying contracts within the StarkNet framework. Key modifications include enhanced error handling, the removal of unused imports, a switch to dojo_utils::TransactionWaiter for transaction management, refactoring of constructor call data, streamlined assertions, and the use of DEFAULT_UDC_ADDRESS for maintainability.

Changes

Files Change Summary
crates/katana/rpc/rpc/tests/starknet.rs - Updated test_send_declare_and_deploy_contract and test_send_declare_and_deploy_legacy_contract to return Result<()> instead of using unwrap().
- Removed unused import std::time::Duration.
- Replaced tokio::time::sleep with dojo_utils::TransactionWaiter.
- Refactored constructor call data to use ctor_args.
- Improved assertions for clarity.
- Replaced hardcoded UDC address with DEFAULT_UDC_ADDRESS.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 13cee86 and 16e1b0c.

Files selected for processing (1)
  • crates/katana/rpc/rpc/tests/starknet.rs (3 hunks)
Additional comments not posted (3)
crates/katana/rpc/rpc/tests/starknet.rs (3)

14-14: LGTM!

The import statement for DEFAULT_UDC_ADDRESS is correct and necessary for the changes made in the test functions.


32-84: LGTM!

The changes to test_send_declare_and_deploy_contract improve error handling, readability, and maintainability. The use of dojo_utils::TransactionWaiter, ctor_args, and DEFAULT_UDC_ADDRESS are all positive improvements.


87-138: LGTM!

The changes to test_send_declare_and_deploy_legacy_contract improve error handling, readability, and maintainability. The use of dojo_utils::TransactionWaiter, ctor_args, and DEFAULT_UDC_ADDRESS are all positive improvements.


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

codecov bot commented Aug 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.49%. Comparing base (13cee86) to head (16e1b0c).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2363   +/-   ##
=======================================
  Coverage   67.49%   67.49%           
=======================================
  Files         359      359           
  Lines       46971    46971           
=======================================
  Hits        31704    31704           
  Misses      15267    15267           

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

@kariy kariy merged commit 1298382 into main Aug 29, 2024
15 checks passed
@kariy kariy deleted the katana/test-cleanup branch August 29, 2024 16:55
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