fix: sozo migrate hanging #2441

notV4l · 2024-09-17T14:08:16Z

Summary by CodeRabbit

New Features
- Introduced a timeout mechanism for connecting to the RPC provider, enhancing connection reliability.
Bug Fixes
- Resolved potential indefinite blocking issues during the connection process.

coderabbitai · 2024-09-17T14:08:37Z

Walkthrough

Ohayo, sensei! The changes introduce a timeout mechanism in the setup_env function of the migrate.rs file. This mechanism allows the function to concurrently wait for the RPC provider's specification version or a timeout after 5 seconds. Previously, the function could block indefinitely if the provider was unresponsive. With this update, if the timeout occurs, an error is returned, enhancing the robustness of the connection handling.

Changes

File Path	Change Summary
bin/sozo/src/commands/migrate.rs	Introduced a timeout mechanism in `setup_env` to prevent indefinite blocking when connecting to an RPC provider.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RPCProvider
    participant Timeout

    Client->>RPCProvider: Request spec_version()
    alt Successful Response
        RPCProvider-->>Client: Return spec_version
    else Timeout Occurs
        Timeout-->>Client: Return error (timeout)
    end

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 generate interesting stats about this repository and render them as a table.
-- @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.

Early access features: enabled

We are currently testing the following features in early access:

OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for generating code suggestions in code reviews.

Note:

You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

coderabbitai

Actionable comments posted: 1

Outside diff range and nitpick comments (1)

bin/sozo/src/commands/migrate.rs (1)
159-159: Capitalize 'CORS' in the error message

For clarity and correctness, 'CORS' should be capitalized in the error message.

Apply this diff to correct the message:
159-                Err(anyhow!( "Unable to connect to RPC provider: timeout, might be cors issue"))
159+                Err(anyhow!( "Unable to connect to RPC provider: timeout, might be CORS issue"))

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 21ec45e and c34916e.

Files selected for processing (1)

bin/sozo/src/commands/migrate.rs (3 hunks)

Additional comments not posted (1)

bin/sozo/src/commands/migrate.rs (1)

153-165: Ohayo, sensei! Implementing timeout for RPC provider connection

Adding a timeout to prevent indefinite blocking when connecting to the RPC provider enhances the robustness of the connection handling. Great job on implementing this improvement.

bin/sozo/src/commands/migrate.rs

codecov · 2024-09-17T14:23:41Z

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 68.21%. Comparing base (21ec45e) to head (c34916e).
Report is 109 commits behind head on main.

Files with missing lines	Patch %	Lines
bin/sozo/src/commands/migrate.rs	80.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2441   +/-   ##
=======================================
  Coverage   68.21%   68.21%           
=======================================
  Files         365      365           
  Lines       48022    48026    +4     
=======================================
+ Hits        32757    32760    +3     
- Misses      15265    15266    +1

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

glihm · 2024-09-17T16:18:18Z

bin/sozo/src/commands/migrate.rs

@@ -147,7 +150,19 @@ pub async fn setup_env<'a>(
        let provider = starknet.provider(env)?;
        trace!(?provider, "Provider initialized.");

-        let spec_version = provider.spec_version().await?;


What's the current timeout by default?

hmmm would be better if we can introduce this timeout in the Provider implementation itself. so that it'd be applied to all request.

i assume the current approach is to just add the timeout on the very first provider request for a command.

Agree, would be here @notV4l:

dojo/bin/sozo/src/commands/options/starknet.rs

Line 27 in 21ec45e

Ok(JsonRpcClient::new(HttpTransport::new(url)))

. Creating a client with the builder and timeout instead.

kariy · 2024-09-17T21:01:55Z

bin/sozo/src/commands/migrate.rs

@@ -147,7 +150,19 @@ pub async fn setup_env<'a>(
        let provider = starknet.provider(env)?;
        trace!(?provider, "Provider initialized.");

-        let spec_version = provider.spec_version().await?;


hmmm would be better if we can introduce this timeout in the Provider implementation itself. so that it'd be applied to all request.

i assume the current approach is to just add the timeout on the very first provider request for a command.

kariy · 2024-09-17T21:03:22Z

bin/sozo/src/commands/migrate.rs

+        let get_spec_version = provider.spec_version();
+        let timeout = time::sleep(Duration::from_secs(5));
+        tokio::pin!(timeout);
+
+        let spec_version = tokio::select! {
+            _ = &mut timeout => {
+                Err(anyhow!( "Unable to connect to RPC provider: timeout, might be cors issue"))
+            },
+            version = get_spec_version => {
+                Ok(version.unwrap())
+            },


can be simplified to

let timeout_duration = Duration::from_secs(5); tokio::time::timeout(timeout_duration, provider.spec_version()).await?;

ha nice way less verbose!

glihm · 2024-10-31T19:26:57Z

#2602

fix: sozo migrate hanging

c34916e

coderabbitai bot reviewed Sep 17, 2024

View reviewed changes

bin/sozo/src/commands/migrate.rs Show resolved Hide resolved

glihm reviewed Sep 17, 2024

View reviewed changes

kariy reviewed Sep 17, 2024

View reviewed changes

glihm closed this Oct 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: sozo migrate hanging #2441

fix: sozo migrate hanging #2441

notV4l commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 17, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

codecov bot commented Sep 17, 2024 •

edited

Loading

glihm Sep 17, 2024

notV4l Sep 17, 2024

kariy Sep 17, 2024

glihm Sep 17, 2024

kariy Sep 17, 2024

kariy Sep 17, 2024

notV4l Sep 18, 2024

glihm commented Oct 31, 2024

fix: sozo migrate hanging #2441

fix: sozo migrate hanging #2441

Conversation

notV4l commented Sep 17, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Sep 17, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Sep 17, 2024 • edited Loading

Codecov Report

glihm Sep 17, 2024

Choose a reason for hiding this comment

notV4l Sep 17, 2024

Choose a reason for hiding this comment

kariy Sep 17, 2024

Choose a reason for hiding this comment

glihm Sep 17, 2024

Choose a reason for hiding this comment

kariy Sep 17, 2024

Choose a reason for hiding this comment

kariy Sep 17, 2024

Choose a reason for hiding this comment

notV4l Sep 18, 2024

Choose a reason for hiding this comment

glihm commented Oct 31, 2024

notV4l commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 17, 2024 •

edited

Loading

codecov bot commented Sep 17, 2024 •

edited

Loading