fix: refactor CertsError

[hanabi1224]

• use Cow<'static, str> instead of String
• split InvalidJustification into InvalidJustificationVotePhase and InvalidJustificationVoteValueChain
• use Cid instead of String in IncorrectPowerDiff

Summary by CodeRabbit

• New Features

  • Added the word "enum" to the user dictionary for improved text recognition.

• Bug Fixes

  • Improved error messages and reporting for certificate-related errors, providing clearer expected and actual values.

• Refactor

  • Renamed fields and parameters from "step" to "phase" for consistency across the application.
  • Enhanced error variant structures for more specific and type-safe error handling.
  • Updated documentation generation to include all features and exclude dependencies.

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

This set of changes refines error handling and naming consistency across several Rust modules. The CertsError enum is expanded with new variants and improved structure, while error reporting in certificate validation is updated to use more descriptive types. Additionally, the Phase enum and related fields are renamed for consistency, and documentation generation settings are updated in the Makefile. A dictionary file receives a minor update.

Changes

Cohort / File(s)	Change Summary
Error Handling Refinement certs/src/error.rs, certs/src/lib.rs	Expanded and restructured the CertsError enum with new variants, structured fields, and documentation. Updated error handling in certificate validation to use new error variants and explicit expected/actual fields. Adjusted test helpers and assertions for naming consistency.
Naming Consistency Updates gpbft/src/lib.rs	Renamed step field and parameters in the Payload struct and methods to phase for consistency. Added IntoStaticStr derive macro to the Phase enum. Updated related tests and usages.
Documentation Build Configuration Makefile	Modified the doc target to use cargo doc --all-features --no-deps for documentation generation.
Dictionary Update .config/rust-f3.dic	Added the word "enum" as a new entry in the Rust dictionary file.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FinalityCertificate
    participant CertsError

    User->>FinalityCertificate: new(power_delta, justification)
    FinalityCertificate->>CertsError: Validate justification.phase
    alt phase mismatch
        CertsError-->>User: InvalidJustificationVotePhase { expected, actual }
    else round mismatch
        CertsError-->>User: InvalidRound { expected, actual }
    else success
        FinalityCertificate-->>User: Ok(FinalityCertificate)
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Poem

In the warren, errors now are clear,
With phases and rounds, no longer unclear.
Enum joins the lexicon, sharp and neat,
While docs build swiftly, a developer’s treat.
From step to phase, the code aligns—
A tidy patch, where clarity shines!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 c77092e and 8ae5f21.

📒 Files selected for processing (5)

• .config/rust-f3.dic (1 hunks)
• Makefile (1 hunks)
• certs/src/error.rs (1 hunks)
• certs/src/lib.rs (7 hunks)
• gpbft/src/lib.rs (6 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: All lint checks

🔇 Additional comments (21)

.config/rust-f3.dic (1)

15-15: LGTM! Dictionary update aligns with enum usage improvements.

The addition of "enum" to the dictionary supports the enhanced enum usage throughout the codebase, particularly with the Phase enum receiving new derive macros.

Makefile (1)

11-11: LGTM! Enhanced documentation generation.

Adding --all-features --no-deps ensures comprehensive documentation coverage for the expanded error enum variants and new trait derivations while keeping the output focused on project code.

gpbft/src/lib.rs (5)

39-39: LGTM! Import supports enhanced enum functionality.

The addition of IntoStaticStr import enables conversion of Phase enum variants to static string slices, which will be useful for error reporting and debugging.

---

69-69: LGTM! Enhanced Phase enum with string conversion capability.

Adding IntoStaticStr derive alongside Display provides both formatted display and efficient static string conversion for the Phase enum variants.

---

98-98: LGTM! Consistent field naming.

Renaming step to phase improves consistency with the Phase enum name and makes the code more intuitive.

---

118-118: LGTM! Constructor parameter renamed for consistency.

The parameter renaming from step to phase maintains consistency with the struct field naming while preserving the same functionality.

Also applies to: 125-125

---

150-150: LGTM! Test updates reflect the naming changes.

All test code properly updated to use the new phase naming convention, maintaining test coverage while improving code consistency.

Also applies to: 160-160, 167-167

certs/src/lib.rs (7)

97-102: LGTM! Improved error specificity with structured variant.

The change from vote.step to vote.phase aligns with the field renaming in the gpbft module, and the new InvalidJustificationVotePhase error variant provides clearer error reporting with explicit expected and actual values.

---

105-109: LGTM! Consistent structured error pattern.

The InvalidRound error now uses structured fields with explicit expected and actual values, improving error clarity and consistency with other error variants.

---

302-303: LGTM! Consistent field naming in error variant.

The actual field name aligns with the updated InstanceMismatch error variant structure, maintaining consistency across error variants.

---

372-372: LGTM! Test helper parameter renamed for consistency.

The parameter name change from step to phase maintains consistency with the updated field naming throughout the codebase.

---

393-393: LGTM! Test data consistent with field renaming.

The phase field assignment reflects the updated naming convention from the gpbft module changes.

---

454-458: LGTM! Test assertion updated for structured error variant.

The test properly validates the new InvalidJustificationVotePhase error variant with its structured fields, ensuring the error handling changes are correctly tested.

---

470-477: LGTM! Test assertion updated for structured error variant.

The test assertion correctly validates the new InvalidRound error variant structure with explicit expected and actual fields.

certs/src/error.rs (7)

4-4: LGTM! Import supports memory-efficient error messages.

The Cow import enables the use of Cow<'static, str> for error messages, providing memory efficiency by allowing both owned and borrowed string data.

---

6-6: LGTM! Enhanced imports support improved error handling.

The additional imports (Phase, Cid) enable the use of structured error variants with type-safe fields instead of generic string messages.

---

19-25: LGTM! Well-documented structured error variants.

Both new error variants are properly documented and use structured fields for clear error reporting. The InvalidJustificationVotePhase variant provides explicit expected/actual phase comparison, while InvalidJustificationVoteValueChain uses Cow<'static, str> for memory efficiency.

---

33-33: LGTM! Memory-efficient error messages.

The use of Cow<'static, str> for error messages in InvalidPowerTableDelta and SerializationError provides memory efficiency while maintaining flexibility for both static and dynamic error content.

Also applies to: 37-37

---

40-45: LGTM! Structured error variants improve clarity.

Both InstanceMismatch and InvalidRound now use structured fields with explicit expected and actual values, making error messages clearer and more actionable for consumers.

---

79-99: LGTM! Comprehensive documentation and type-safe error handling.

The IncorrectPowerDiff variant improvements are excellent:

• Detailed documentation explains the purpose and field meanings
• Box<Cid> usage is well-justified for reducing enum size
• Structured fields provide clear expected vs actual comparison
• Type safety is improved by using Cid instead of String

---

11-17: LGTM! Comprehensive documentation improvements.

All error variants now have proper documentation comments explaining their purpose and context. This addresses the API documentation standards and provides clear guidance for error handling consumers.

Also applies to: 27-29, 31-33, 35-37, 47-49, 51-53, 55-57, 59-61, 63-65, 67-69, 71-73, 75-77, 88-89, 91-95, 101-103

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch hm/refactor-certs-error

---

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

Support

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

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 generate unit tests to generate unit tests 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.