fix(controller): wait for controller to be deployed #2278

kariy · 2024-08-08T17:17:03Z

cartridge_deployController doesn't wait until the account actually gets deployed before returning the response. so we wait for the returned deployment tx hash before proceeding.

Summary by CodeRabbit

New Features
- Enhanced the account deployment functionality to support a wider range of providers, improving flexibility.
- Introduced robust error handling and response parsing for deployment transactions, ensuring better reliability.
Bug Fixes
- Improved handling of deployment transaction completion, reducing potential failures during the process.

coderabbitai · 2024-08-08T17:17:15Z

Walkthrough

Ohayo, sensei! The changes enhance the deploy_account_if_not_exist function by making it more flexible and robust. The function now accepts a generic provider type, improving compatibility with various implementations. Additionally, response handling from RPC calls has been upgraded for better error context, and a TransactionWaiter has been integrated to ensure deployment transactions are completed reliably. Overall, this streamlines account deployment processes significantly.

Changes

File	Change Summary
`bin/sozo/src/commands/options/account/controller.rs`	Modified `deploy_account_if_not_exist` to accept a generic provider type and enhanced error handling for RPC response. Added `TransactionWaiter` for transaction completion management.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Controller
    participant Provider
    participant RPC

    User->>Controller: Request to deploy account
    Controller->>Provider: Check if account exists
    Provider-->>Controller: Account existence response
    alt Account does not exist
        Controller->>RPC: Send deployment request
        RPC-->>Controller: Deployment response
        Controller->>TransactionWaiter: Wait for transaction confirmation
        TransactionWaiter-->>Controller: Transaction confirmed
        Controller-->>User: Account deployed successfully
    else Account exists
        Controller-->>User: Account already exists
    end

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f1c5214 and d02d9b8.

Files selected for processing (1)

bin/sozo/src/commands/options/account/controller.rs (4 hunks)

Additional comments not posted (1)

bin/sozo/src/commands/options/account/controller.rs (1)
335-337: LGTM! Verify the usage of TransactionWaiter.

The integration of TransactionWaiter enhances reliability by ensuring deployment transactions are completed. This looks good to me!

However, verify that TransactionWaiter is correctly implemented and used in the codebase.

Verification successful

Ohayo, sensei! TransactionWaiter is correctly implemented and used across the codebase.

The TransactionWaiter struct is defined in crates/dojo-world/src/utils.rs and is used in various modules and tests, including the file under review. Its integration appears consistent and reliable, ensuring transaction completion as intended.

Implementation: crates/dojo-world/src/utils.rs

Usage in tests and modules: Multiple instances across the codebase, confirming its active role.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the implementation and usage of `TransactionWaiter`.

# Test: Search for the `TransactionWaiter` implementation and its usage.
ast-grep --lang rust --pattern $'struct TransactionWaiter {
  $$$
}'
Length of output: 69

Script:
#!/bin/bash
# Search for all occurrences of `TransactionWaiter` in the codebase to find its definition and usage.
rg 'TransactionWaiter' -A 5
Length of output: 22506

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

Outside diff range, codebase verification and nitpick comments (1)

bin/sozo/src/commands/options/account/controller.rs (1)
329-333: Consider improving error handling for response parsing.

The current approach uses context for error handling, which is good, but consider adding more specific error messages or handling cases where the expected keys might be missing.
// Example improvement
let transaction_hash = response.get("result")
    .and_then(|result| result.get("transaction_hash"))
    .and_then(|hash| hash.as_str())
    .context("Transaction hash not found in response")?;

codecov · 2024-08-08T18:01:04Z

Codecov Report

Attention: Patch coverage is 0% with 19 lines in your changes missing coverage. Please review.

Project coverage is 70.27%. Comparing base (f1c5214) to head (d02d9b8).

Files	Patch %	Lines
...in/sozo/src/commands/options/account/controller.rs	0.00%	19 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2278      +/-   ##
==========================================
- Coverage   70.29%   70.27%   -0.02%     
==========================================
  Files         342      342              
  Lines       45094    45107      +13     
==========================================
+ Hits        31698    31699       +1     
- Misses      13396    13408      +12

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

wait until account is deployed

d02d9b8

coderabbitai bot reviewed Aug 8, 2024

View reviewed changes

glihm approved these changes Aug 8, 2024

View reviewed changes

kariy merged commit d5e2f9d into main Aug 8, 2024
13 of 15 checks passed

kariy deleted the sozo/controller-wait-tx branch August 8, 2024 19:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(controller): wait for controller to be deployed #2278

fix(controller): wait for controller to be deployed #2278

kariy commented Aug 8, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 8, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

codecov bot commented Aug 8, 2024

fix(controller): wait for controller to be deployed #2278

fix(controller): wait for controller to be deployed #2278

Conversation

kariy commented Aug 8, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Aug 8, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Aug 8, 2024

Codecov Report

kariy commented Aug 8, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 8, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)