search

ethereum / sourcify

Decentralized Solidity contract source code verification service
https://sourcify.dev
MIT License
768 stars 378 forks source link

Init compilers #1462

Closed kuzdogan closed 1 month ago

kuzdogan commented 1 month ago

Adds the optional init functin to VerificationService to download all compilers ahead. This is useful for the migration server because when we start hitting the server with a lot of verification requests, they translate into solc download requests and the solc server gets overloaded (like 20 req per chain x 100s chains).

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes across multiple files primarily involve replacing the fetchWithTimeout function with an improved fetchWithBackoff implementation, enhancing retry logic using exponential backoff, and refactoring related error handling and logging. Configuration updates include adjustments to compiler initialization options and export modifications to improve clarity and functionality in service management, storage, and verification processes.

Changes

File Path Change Summary
packages/lib-sourcify/src/lib/CheckedContract.ts, services/server/src/server/services/compiler/local/solidityCompiler.ts, serverless/compiler-lambda/index.js Replaced fetchWithTimeout with fetchWithBackoff, adding exponential backoff and enhanced logging.
services/server/.env.test Removed FETCH_TIMEOUT value from .env.test configuration.
services/server/src/config/default.js Added initCompilers configuration option to control compiler initialization.
services/server/src/config/migration.js Introduced initCompilers: true in the exported configuration module, enabling compiler initialization feature.
services/server/src/server/controllers/verification/verification.common.ts Updated import for VerificationService and adjusted its usage in verifyContractsInSession function.
services/server/src/server/services/StorageService.ts Refactored storage service initialization logic for clarity and efficiency.
services/server/src/server/services/VerificationService.ts Introduced VerificationServiceOptions and added initCompilers handling and initialization methods in VerificationService class.
services/server/src/server/services/services.ts Updated Services class constructor to use VerificationServiceOptions instead of SourcifyChainMap.
services/server/src/server/services/storageServices/AbstractDatabaseService.ts Added logging statements to track database pool initialization and health checks.
services/server/src/server/server.ts Removed unused import, renamed constructor parameter, and expanded Server instantiation configuration.

Poem

In the code, changes swiftly flow,
With backoff retry, errors go.
Compilers now, they initialize,
Enhanced logs, a coder's prize.
Debug messages light the way,
As storage services find their sway.
Cheers to efforts, all refined,
A rabbit's joy, so well aligned! 🐇✨

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
kuzdogan commented 1 month ago

@coderabbitai please review

coderabbitai[bot] commented 1 month ago

@kuzdogan, I have reviewed the changes in the PR. Here's a summary of my findings:

  1. Replacement of fetchWithTimeout with fetchWithBackoff:

    • The new fetchWithBackoff function implements an exponential backoff strategy, which is a more robust approach for handling fetch operations, especially under high load conditions.
    • This change has been consistently applied across multiple files.

  2. New init function in VerificationService:

    • The init function pre-downloads all compiler versions, which will help in reducing the load on the solc server during high-traffic periods.
    • The function uses a chunked download approach to avoid overloading the server.

  3. Configuration changes:

    • The new initCompilers option has been added to the configuration files, allowing control over the pre-download functionality.
    • The VerificationService has been updated to accept these options via its constructor.

  4. Code refactoring:

    • Necessary refactoring has been done to accommodate these changes, ensuring consistency and maintainability.

  5. Testing:

    • Ensure that appropriate tests are in place for the new functionality. If not, consider adding tests to validate the behavior of the init function and the fetchWithBackoff function.

Overall, the changes look good and are aligned with the objectives stated. Please confirm if you would like to proceed with any additional changes or if there are specific areas you would like me to focus on further.

Analysis chain
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # List the files changed in the PR and show the diffs gh pr diff 1462 ``` Length of output: 33485
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.