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(verifier): bump actix-prost related dependencies #1233

Merged
merged 1 commit into from
Feb 6, 2025

Conversation

rimrakhimov
Copy link
Member

@rimrakhimov rimrakhimov commented Feb 6, 2025

bump actix-prost dependencies to v0.1.0; bump tonic dependencies to v0.12; bump prost dependencies to v0.13; bump blockscout-service-launcher to v0.17.0

Summary by CodeRabbit

  • Chores

    • Upgraded multiple dependency versions to enhance stability and compatibility.
  • Refactor

    • Improved connection management and error handling in signature and verification processes.
    • Enhanced type conversion routines in contract verification for more robust processing.
  • Tests

    • Updated integration tests to align with safer conversion handling mechanisms.

…dependencies to v0.12; bump prost dependencies to v0.13; bump blockscout-service-launcher to v0.17.0
Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

Walkthrough

This pull request implements multiple updates within the Rust workspace of the smart-contract-verifier. Dependency specifications in several Cargo.toml files have been modified—switching from Git repository revisions to explicit version numbers for crates such as actix-prost, actix-prost-build, actix-prost-macros, prost, prost-build, tonic, and tonic-build. The version for blockscout-service-launcher has been updated, and a new workspace-based dependency (tracing) has been added in the sig-provider-extension package. In the signature provider implementation, connection handling has transitioned from a Channel to a Uri with refined error logging using tracing::error. Additionally, both Solidity and Vyper verifiers, as well as integration tests, update their bytecode conversion methods from using from_i32 to try_from to incorporate error handling.

Possibly related PRs

Poem

I'm a rabbit in the code garden, hopping through the night,
Watching dependencies shift into versioned light.
Git links turned into numbers, crisp and clear,
A URI now leads the way, steering connections near.
Bytecode types and tests all dance in graceful flow,
A hop of change in the code, where new methods now glow.
Carrots and code—together we grow!

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

Copy link
Contributor

@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

🧹 Nitpick comments (3)
smart-contract-verifier/smart-contract-verifier-server/src/services/vyper_verifier.rs (1)

85-87: Consider handling conversion errors gracefully.

While switching to try_from is a good practice, immediately unwrapping the result could lead to panics. Since this is debug logging, you might want to handle the error case more gracefully:

-bytecode_type = BytecodeType::try_from(request.bytecode_type)
-    .unwrap()
-    .as_str_name(),
+bytecode_type = BytecodeType::try_from(request.bytecode_type)
+    .map(|t| t.as_str_name())
+    .unwrap_or("invalid"),

Also applies to: 156-158

smart-contract-verifier/smart-contract-verifier-server/tests/integration/types/batch_solidity.rs (1)

286-291: Add test cases for invalid enum values.

Since we're now using try_from for enum conversions, we should add test cases to verify that invalid values are handled correctly. Consider adding tests for:

  • Invalid compiler values
  • Invalid language values
  • Invalid match type values

Example test case structure:

#[test]
fn test_invalid_compiler_value() {
    let invalid_value = 999; // Value not defined in the enum
    let result = proto::contract_verification_success::compiler::Compiler::try_from(invalid_value);
    assert!(result.is_err());
}

Also applies to: 311-315

smart-contract-verifier/sig-provider-extension/src/lib.rs (1)

36-46: Consider reusing the gRPC client to improve performance

In the create_signatures method, a new SignatureServiceClient is created on each call, which may introduce overhead due to establishing a new connection every time. To improve performance, consider creating the client once during initialization and reusing it for subsequent calls.

Apply the following changes to store the client in SigProviderImpl:

 struct SigProviderImpl {
-    uri: Uri,
+    client: SignatureServiceClient<tonic::transport::Channel>,
 }

 impl SigProvider {
     pub async fn new(config: Config) -> Result<Self, tonic::transport::Error> {
+        let client = match SignatureServiceClient::connect(config.url.clone()).await {
+            Ok(client) => client,
+            Err(err) => {
+                tracing::error!(
+                    "error connecting to signature service; uri={}, err={}",
+                    config.url,
+                    err
+                );
+                return Err(err);
+            }
+        };
         Ok(Self {
-            inner: Arc::new(SigProviderImpl { uri: config.url }),
+            inner: Arc::new(SigProviderImpl { client }),
         })
     }
 }

 impl SigProviderImpl {
     async fn create_signatures(&self, abi: String) {
-        let mut client = match SignatureServiceClient::connect(self.uri.to_string()).await {
-            Ok(client) => client,
-            Err(err) => {
-                tracing::error!(
-                    "error connecting to signature service; uri={}, err={}",
-                    self.uri,
-                    err
-                );
-                return;
-            }
-        };
+        let mut client = self.client.clone();
         let _ = client
             .create_signatures(CreateSignaturesRequest { abi })
             .await;
     }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 21543d2 and 844f3ae.

⛔ Files ignored due to path filters (1)
  • smart-contract-verifier/Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (6)
  • smart-contract-verifier/Cargo.toml (3 hunks)
  • smart-contract-verifier/sig-provider-extension/Cargo.toml (1 hunks)
  • smart-contract-verifier/sig-provider-extension/src/lib.rs (2 hunks)
  • smart-contract-verifier/smart-contract-verifier-server/src/services/solidity_verifier.rs (2 hunks)
  • smart-contract-verifier/smart-contract-verifier-server/src/services/vyper_verifier.rs (2 hunks)
  • smart-contract-verifier/smart-contract-verifier-server/tests/integration/types/batch_solidity.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Linting / lint
  • GitHub Check: Unit, doc and integration tests
🔇 Additional comments (3)
smart-contract-verifier/smart-contract-verifier-server/src/services/solidity_verifier.rs (1)

99-101: Same error handling improvement needed as in vyper_verifier.rs.

The same pattern of unwrapping try_from result is used here. Consider applying the same error handling improvement suggested for the Vyper verifier.

Also applies to: 171-173

smart-contract-verifier/sig-provider-extension/Cargo.toml (1)

15-15: Dependency addition aligns with logging requirements

Adding tracing = { workspace = true } is appropriate, given the logging functionality introduced in lib.rs.

smart-contract-verifier/Cargo.toml (1)

16-18: Verify compatibility with updated dependencies

Several dependencies have been updated to new versions:

  • actix-prost to version "0.1.0"
  • blockscout-service-launcher to "0.17.0"
  • prost and prost-build to "0.13"
  • tonic and tonic-build to "0.12"

Ensure that these updates do not introduce breaking changes affecting the codebase.

Please check for any breaking changes or required code adjustments in the updated dependencies:

Also applies to: 26-26, 47-48, 69-70

@rimrakhimov rimrakhimov merged commit 04d3033 into main Feb 6, 2025
6 checks passed
@rimrakhimov rimrakhimov deleted the rimrakhimov/verifier/workspace-dependencies branch February 6, 2025 09:31
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