Skip to content

Conversation

yiweichi
Copy link
Member

@yiweichi yiweichi commented Mar 4, 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?

To fix the issue when a prover holds a jwt token that dispatched by old version of coordinator, it will fail to pass the jwt token fields check, and not able to query task until jwt expires. So we should add the jwt backward compatibility here.

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

  • Chores
    • Updated the software version to v4.4.90.
  • Bug Fixes
    • Improved error handling by adopting a fallback default when a required configuration is missing, enhancing the application’s stability and ensuring a smoother operation.

@yiweichi yiweichi added the bump-version Bump the version tag for deployment label Mar 4, 2025
Copy link

coderabbitai bot commented Mar 4, 2025

Walkthrough

This pull request makes two separate changes. The first change updates the version tag in the software by modifying the value in common/version/version.go from "v4.4.89" to "v4.4.90". The second change adjusts the error handling in the checkParameter method of the BaseProverTask struct within coordinator/internal/logic/provertask/prover_task.go. When the ProverProviderType is missing in the context, the method now defaults to coordinatorType.ProverProviderTypeInternal instead of returning an error.

Changes

File(s) Change Summary
common/version/version.go Updated the version tag from "v4.4.89" to "v4.4.90".
coordinator/internal/logic/provertask/prover_task.go Modified the checkParameter method to introduce a fallback: if ProverProviderType is missing from the context, it now defaults to an internal provider.

Sequence Diagram(s)

sequenceDiagram
    participant B as BaseProverTask
    participant C as Context
    participant D as Default Provider

    B->>C: Retrieve ProverProviderType
    alt ProverProviderType exists
       C-->>B: Return found ProverProviderType
    else ProverProviderType missing
       B->>B: Set default provider to coordinatorType.ProverProviderTypeInternal
       Note over B: Fallback mechanism engaged
    end
Loading

Possibly related PRs

Suggested reviewers

  • amoylan2
  • georgehao

Poem

I'm a little rabbit, hopping by,
Updating our version, oh me, oh my!
When context falters and the type is missing,
A default hops in—no error dismissing.
Code leaps forward with a joyful sigh!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package zstd: could not load export data: no export data for "github.com/scroll-tech/da-codec/encoding/zstd""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package zstd: could not load export data: no export data for "github.com/scroll-tech/da-codec/encoding/zstd""


📜 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 41d23d4 and 3077371.

📒 Files selected for processing (1)
  • coordinator/internal/logic/provertask/prover_task.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • coordinator/internal/logic/provertask/prover_task.go
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: tests
  • GitHub Check: tests

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.
  • @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.

georgehao
georgehao previously approved these changes Mar 4, 2025
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.72%. Comparing base (6b837c0) to head (3077371).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1606   +/-   ##
========================================
  Coverage    51.72%   51.72%           
========================================
  Files          157      157           
  Lines        12555    12555           
========================================
  Hits          6494     6494           
  Misses        5497     5497           
  Partials       564      564           
Flag Coverage Δ
coordinator 16.55% <ø> (ø)

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.

@yiweichi yiweichi requested review from colinlyguo and georgehao March 4, 2025 06:54
@yiweichi yiweichi merged commit 5fb93c4 into develop Mar 5, 2025
6 checks passed
@yiweichi yiweichi deleted the fix-coordinator-backward-compatibility branch March 5, 2025 05:17
colinlyguo pushed a commit that referenced this pull request Mar 7, 2025
Co-authored-by: yiweichi <yiweichi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bump-version Bump the version tag for deployment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants