Skip to content

refactor: remove unused check #1685

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

Merged
merged 4 commits into from
Jul 3, 2025
Merged

refactor: remove unused check #1685

merged 4 commits into from
Jul 3, 2025

Conversation

georgehao
Copy link
Member

@georgehao georgehao commented Jul 1, 2025

Purpose or design rationale of this PR

Describe your change. Make sure to answer these three questions: What does this PR do? Why does it do it? How does it do it?

PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

  • No, this PR doesn't involve a new deployment, git tag, docker image tag
  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change
  • Yes

Summary by CodeRabbit

  • New Features

    • Added support for multiple verifier forks in the configuration, allowing the system to recognize both "euclidV2" and "feynman".
  • Bug Fixes

    • Removed restrictions and error handling related to unsupported hard fork names in prover task processing, enabling broader fork compatibility.
  • Chores

    • Updated test and mock configurations to use the "feynman" fork name.

@georgehao georgehao requested review from noel2004 and colinlyguo July 1, 2025 03:49
Copy link

coderabbitai bot commented Jul 1, 2025

Walkthrough

The changes remove hard fork name validation and associated constants from various prover task logic files, update configuration files and tests to use the "feynman" fork instead of "euclidV2," and expand the verifier configuration to support multiple forks. No exported entity signatures are altered.

Changes

File(s) Change Summary
common/types/message/message.go Removed EuclidV2Fork and EuclidV2ForkNameForProver constants.
coordinator/internal/logic/provertask/batch_prover_task.go
coordinator/internal/logic/provertask/bundle_prover_task.go
coordinator/internal/logic/provertask/chunk_prover_task.go
Removed hard fork name validation and setting of ForkName in prover task logic.
coordinator/cmd/api/app/mock_app.go
coordinator/internal/config/config_test.go
Changed verifier fork name from "euclidV2" to "feynman" in mock config and test config.
coordinator/conf/config.json Changed verifier configuration to include both "euclidV2" and "feynman" forks.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Coordinator
    participant Verifier

    Client->>Coordinator: Request prover task (with hardForkName)
    Coordinator->>Verifier: Pass hardForkName (no validation)
    Verifier-->>Coordinator: Verifier processes task
    Coordinator-->>Client: Returns task result
Loading

Possibly related PRs

  • scroll-tech/scroll#1621: Refactors and centralizes hard fork name validation logic in prover tasks, overlapping with this PR's removal of such validation.
  • scroll-tech/scroll#1668: Removes or refactors code related to EuclidV2Fork and Euclid verifier logic, similar to the changes in this PR.

Suggested labels

bump-version

Suggested reviewers

  • yiweichi
  • colinlyguo

Poem

In the warren of code, a fork took flight,
"EuclidV2" hops away, "Feynman" shines bright.
No more checks on names, just tasks to send,
Two verifiers now, the changes extend.
A bunny approves with a whiskery cheer—
Simpler, cleaner, the future is here! 🐇


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9df005e and 21c0c9b.

📒 Files selected for processing (1)
  • coordinator/internal/config/config_test.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • coordinator/internal/config/config_test.go
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: check
  • GitHub Check: tests
  • GitHub Check: tests
  • GitHub Check: tests
  • GitHub Check: check
  • GitHub Check: tests
  • GitHub Check: check
  • GitHub Check: tests
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@codecov-commenter
Copy link

codecov-commenter commented Jul 1, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 39.92%. Comparing base (ea38ae7) to head (21c0c9b).

Files with missing lines Patch % Lines
coordinator/cmd/api/app/mock_app.go 0.00% 1 Missing ⚠️
...or/internal/logic/provertask/bundle_prover_task.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1685      +/-   ##
===========================================
+ Coverage    39.83%   39.92%   +0.09%     
===========================================
  Files          236      236              
  Lines        18829    18814      -15     
===========================================
+ Hits          7500     7512      +12     
+ Misses       10594    10563      -31     
- Partials       735      739       +4     
Flag Coverage Δ
common 29.75% <ø> (ø)
coordinator 33.83% <50.00%> (+0.46%) ⬆️
database 42.05% <ø> (ø)
rollup 46.33% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link

@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)
coordinator/conf/config.json (1)

11-20: Consider deduplicating identical verifier asset paths

You now list two fork entries pointing to the same "assets" directory.
If the directory contains fork-specific proving keys, having both forks share it is fine; otherwise you risk key collisions.
Either split the assets into fork-scoped sub-folders or document the convention to avoid future confusion.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ea38ae7 and 64b3db7.

📒 Files selected for processing (7)
  • common/types/message/message.go (0 hunks)
  • coordinator/cmd/api/app/mock_app.go (1 hunks)
  • coordinator/conf/config.json (1 hunks)
  • coordinator/internal/config/config_test.go (1 hunks)
  • coordinator/internal/logic/provertask/batch_prover_task.go (0 hunks)
  • coordinator/internal/logic/provertask/bundle_prover_task.go (0 hunks)
  • coordinator/internal/logic/provertask/chunk_prover_task.go (0 hunks)
💤 Files with no reviewable changes (4)
  • common/types/message/message.go
  • coordinator/internal/logic/provertask/chunk_prover_task.go
  • coordinator/internal/logic/provertask/bundle_prover_task.go
  • coordinator/internal/logic/provertask/batch_prover_task.go
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: tests
  • GitHub Check: tests
  • GitHub Check: tests
🔇 Additional comments (2)
coordinator/internal/config/config_test.go (1)

24-27: Add a test variant that exercises multiple‐fork configs

The updated template now validates a single "feynman" fork, which is fine.
Given that the production conf/config.json supports an array with multiple fork entries, consider adding an extra sub-test that feeds a template containing ≥2 verifiers (e.g. "euclidV2" + "feynman"). That will guard against future regressions in the array-handling logic of NewConfig.

coordinator/cmd/api/app/mock_app.go (1)

93-99: Ensure non-empty AssetsPath for verifier initialization

We didn’t find any explicit len(AssetsPath)>0 guard, but in
coordinator/internal/logic/verifier/verifier.go (lines 139–144) the code does:

vkFile := path.Join(cfg.AssetsPath, vkFileName)
f, err := os.Open(filepath.Clean(vkFile))
if err != nil {
    return err
}

With AssetsPath == "", this opens vkFileName in the CWD, which will likely fail at runtime when loading verification keys. Both your mock in mock_app.go and the API tests use an empty path:

• coordinator/cmd/api/app/mock_app.go:95
• coordinator/test/api_test.go:90

Please confirm that the coordinator API binary can handle an empty assets_path (e.g. keys placed in CWD). Otherwise restore a valid assets path in tests, for example:

-               AssetsPath: "",
+               AssetsPath: "assets", // or a temp dir containing the vk files

@colinlyguo colinlyguo changed the title remove unused check refactor: remove unused check Jul 2, 2025
@georgehao georgehao merged commit a776ca7 into develop Jul 3, 2025
15 checks passed
@georgehao georgehao deleted the feat/remove-unused-check branch July 3, 2025 01:21
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.

4 participants