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(eth-bytecode-db): bump verification-common to support non-map 'compilation_artifacts.sources' values #1216

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

rimrakhimov
Copy link
Member

@rimrakhimov rimrakhimov commented Jan 28, 2025

Summary by CodeRabbit

  • Dependency Updates

    • Updated verification-common library to a new commit version
  • Bug Fixes

    • Improved error logging in database service for alliance source retrieval
  • Refactor

    • Modified source mapping representation in compilation artifacts
    • Simplified source ID handling in test configurations

Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

Walkthrough

The pull request encompasses changes across multiple files in the eth-bytecode-db project. The primary modifications include updating the verification-common dependency in the Cargo.toml file to a new commit, enhancing error logging in the database service, and modifying the representation of source mappings in compilation artifacts. The changes involve transitioning from using explicit SourceId structs to a more JSON-like structure for representing source information, with a focus on simplifying source mapping serialization and improving error observability.

Possibly related PRs

Poem

🐰 Hop, hop, through bytecode's maze,
Revisions dance in Cargo's praise
Sources mapped with JSON's might
Errors logged with tracing's light
A rabbit's code, both swift and bright! 🔍


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.

@rimrakhimov rimrakhimov changed the title fix(eth-bytecode-db): bump verification-common to support invalid 'compilation_artifacts.sources' values fix(eth-bytecode-db): bump verification-common to support non-map 'compilation_artifacts.sources' values Jan 28, 2025
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 (1)
eth-bytecode-db/eth-bytecode-db-server/src/services/database.rs (1)

363-366: LGTM! Consider enhancing the error context with structured fields.

The addition of detailed error logging before converting to tonic::Status improves error observability, which is crucial for debugging issues with invalid compilation artifacts.

Consider adding structured fields to provide more context in the logs:

-            tracing::error!("error while retrieving alliance sources: {err:#?}");
+            tracing::error!(
+                error.details = ?err,
+                error.display = %err,
+                "error while retrieving alliance sources"
+            );

This structured approach:

  • Separates the detailed debug representation (?err) from the display representation (%err)
  • Makes it easier to query and filter logs
  • Maintains the same level of detail while improving log parsing
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8d9cf0e and 71a91d1.

⛔ Files ignored due to path filters (1)
  • eth-bytecode-db/Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • eth-bytecode-db/Cargo.toml (1 hunks)
  • eth-bytecode-db/eth-bytecode-db-server/src/services/database.rs (1 hunks)
  • eth-bytecode-db/verifier-alliance-database/tests/integration/internal_compiled_contracts.rs (2 hunks)
  • eth-bytecode-db/verifier-alliance-database/tests/integration/verified_contracts.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Unit, doc and integration tests
🔇 Additional comments (3)
eth-bytecode-db/verifier-alliance-database/tests/integration/internal_compiled_contracts.rs (1)

33-33: LGTM! Verify JSON structure matches schema.

The change from SourceId to a JSON-based structure simplifies the source mapping representation while maintaining the same semantic meaning.

✅ Verification successful

Source mapping JSON structure is consistent and valid

The source mapping structure {"src/Counter.sol": { "id": 0 }} is consistently used across the codebase and maintains a clear, simple schema mapping source files to their IDs.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the JSON structure for sources matches the schema across the codebase.

# Search for similar source mapping patterns
rg -A 2 '"sources":\s*Some\(from_json!\('

Length of output: 43


Script:

#!/bin/bash
# Search for from_json! macro usage and source-related patterns
echo "=== Searching for from_json! macro usage ==="
rg "from_json!\(" -A 3

echo -e "\n=== Searching specifically in test files ==="
fd "test.*\.rs$" --exec rg -l "sources.*from_json"

echo -e "\n=== Looking for source-related structures ==="
rg "sources.*Some\(" -A 2

Length of output: 8671

eth-bytecode-db/verifier-alliance-database/tests/integration/verified_contracts.rs (1)

194-194: LGTM! Consistent with other test files.

The change aligns with the updated source mapping representation in internal_compiled_contracts.rs.

eth-bytecode-db/Cargo.toml (1)

78-78: Verify the new verification-common commit.

The dependency update to commit 8d9cf0e supports the new JSON-based source mapping structure.

✅ Verification successful

✓ Commit 8d9cf0e is valid and contains the expected changes

The commit implements the required JSON-based source mapping structure changes through a more flexible CompilationArtifacts.sources implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the new verification-common commit exists and check for breaking changes.

# Check if the commit exists in the repository
gh api repos/blockscout/blockscout-rs/commits/8d9cf0e --jq '.sha' || echo "Commit not found"

# Compare the commits to identify breaking changes
gh api repos/blockscout/blockscout-rs/compare/5481500...8d9cf0e --jq '.commits[] | {sha: .sha, message: .commit.message}'

Length of output: 6868

@rimrakhimov rimrakhimov merged commit 97be784 into main Jan 28, 2025
5 checks passed
@rimrakhimov rimrakhimov deleted the rimrakhimov/eth-bytecode-db/fix-alliance-search branch January 28, 2025 12:06
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