Skip to content

fix(dpp): decoding invalid consensus error variants#2510

Merged
shumkov merged 2 commits into
v2.0-devfrom
fix/decoding-invalid-consensus-error-variants
Mar 27, 2025
Merged

fix(dpp): decoding invalid consensus error variants#2510
shumkov merged 2 commits into
v2.0-devfrom
fix/decoding-invalid-consensus-error-variants

Conversation

@shumkov
Copy link
Copy Markdown
Collaborator

@shumkov shumkov commented Mar 20, 2025

Issue being fixed or feature implemented

Protocol(PlatformDeserializationError("unable to deserialize ConsensusError : UnexpectedVariant { type_name: \"BasicError\", allowed: Range { min: 0, max: 117 }, found: 119 }"))

Some of consensus error enum variants are defined using features. Since Drive and SDK use different features, SDK is not able to decode a consensus error due to different enum structure.

What was done?

  • Remove feature instructions for consensus errors.

How Has This Been Tested?

None

Breaking Changes

None

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • New Features
    • Enhanced validation error reporting now delivers clearer, detailed feedback for troubleshooting.
  • Refactor
    • Simplified error handling by unifying previously conditional error paths, ensuring consistent error reporting for schema and state validations.

@shumkov shumkov added this to the v2.0.0 milestone Mar 20, 2025
@shumkov shumkov self-assigned this Mar 20, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 20, 2025

Walkthrough

This pull request removes conditional compilation for JSON schema and state transition validations across multiple modules. Previously optional error variants, modules, and associated imports are now always included. In addition, new conversion implementations and a builder have been added to handle JSON schema validation errors when the feature is enabled. The modifications simplify the code by eliminating feature flags in error-handling and module declarations.

Changes

File(s) Change Summary
packages/rs-dpp/.../basic/basic_error.rs, packages/rs-dpp/.../basic/data_contract/mod.rs, packages/rs-dpp/.../basic/mod.rs, packages/rs-dpp/.../basic/json_schema_error/error.rs, packages/rs-dpp/.../basic/json_schema_error/error_data.rs, packages/rs-dpp/.../consensus/codes.rs (JSON schema parts) Removed #[cfg(feature = "json-schema-validation")] attributes from error variants, modules, and imports. Now JSON schema errors are always present. Also added implementations to convert a ValidationError into a JsonSchemaError/ConsensusError and introduced a DataBuilder for constructing error data.
packages/rs-dpp/.../consensus/codes.rs (state parts), packages/rs-dpp/.../state/mod.rs, packages/rs-dpp/.../state/state_error.rs Removed #[cfg(feature = "state-transition-validation")] from the data trigger module and DataTriggerError variant. The state trigger functionality is now always included.

Sequence Diagram(s)

sequenceDiagram
    participant VE as ValidationError
    participant DB as DataBuilder
    participant JE as JsonSchemaError
    participant CE as ConsensusError

    VE->>DB: Pass error details
    DB->>JE: Build structured error data
    VE->>JE: Convert via From implementation
    JE->>CE: Wrap error into ConsensusError
Loading

Suggested reviewers

  • QuantumExplorer
  • pauldelucia

Poem

In the meadow of pure code I roam,
No more flags to hide errors at home.
JSON and state now dance in the light,
Each conversion gleams shiny and bright.
I hop with joy, a code rabbit free—🐇
Celebrating changes in pure harmony!


📜 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 3d0b098 and 6c822df.

📒 Files selected for processing (2)
  • packages/rs-dpp/src/errors/consensus/basic/json_schema_error/error.rs (3 hunks)
  • packages/rs-dpp/src/errors/consensus/basic/json_schema_error/error_data.rs (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: Rust packages (dpp) / Tests
  • GitHub Check: Rust packages (dpp) / Formatting
  • GitHub Check: Rust packages (drive) / Tests
  • GitHub Check: Rust packages (dash-sdk) / Tests
  • GitHub Check: Rust packages (dpp) / Check each feature
  • GitHub Check: Rust packages (dash-sdk) / Check each feature
  • GitHub Check: Rust packages (drive-abci) / Check each feature
  • GitHub Check: Rust packages (dash-sdk) / Linting
  • GitHub Check: Rust packages (drive) / Unused dependencies
  • GitHub Check: Rust packages (drive-abci) / Linting
  • GitHub Check: Rust packages (drive) / Linting
  • GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
  • GitHub Check: Build JS packages / Build JS
  • GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
  • GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
🔇 Additional comments (6)
packages/rs-dpp/src/errors/consensus/basic/json_schema_error/error.rs (3)

6-6: Properly isolates ValidationError import with feature flag.

The conditional compilation directive ensures that ValidationError is only imported when the json-schema-validation feature is enabled, which is consistent with the PR's goal of addressing deserialization issues.


32-51: LGTM: Clean implementation of From for JsonSchemaError.

This implementation correctly converts ValidationError to JsonSchemaError by extracting all relevant fields and is properly guarded by the feature flag. This is essential for ensuring consistent error handling regardless of feature definitions between components.


53-60: LGTM: Straightforward conversion from ValidationError to ConsensusError.

This implementation provides a convenient direct conversion from ValidationError to ConsensusError by wrapping the JsonSchemaError. The feature flag is correctly applied, ensuring consistency with the overall approach.

packages/rs-dpp/src/errors/consensus/basic/json_schema_error/error_data.rs (3)

1-6: Proper feature flagging for jsonschema imports.

All imports from the jsonschema crate are correctly guarded with feature flags, ensuring they're only included when the json-schema-validation feature is enabled.


25-192: LGTM: Comprehensive implementation of From<&ValidationError> for JsonSchemaErrorData.

This implementation thoroughly handles all ValidationError kinds, mapping each one to appropriate keywords and parameters. The code is well-structured and covers all validation error scenarios, which is essential for proper error reporting and handling.

The approach of using a builder pattern makes the code more readable and maintainable, especially given the large number of error variants that need to be handled.


194-230: Clean DataBuilder implementation following the builder pattern.

The DataBuilder struct and its implementation provide a clean way to construct JsonSchemaErrorData instances. The methods are well-defined and the builder pattern is implemented correctly.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 plan to trigger planning for file edits and PR creation.
  • @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.

@shumkov shumkov changed the title fix: decoding invalid consensus error variants fix(dpp): decoding invalid consensus error variants Mar 20, 2025
pauldelucia
pauldelucia previously approved these changes Mar 20, 2025
Copy link
Copy Markdown
Member

@pauldelucia pauldelucia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested in DET

@shumkov shumkov merged commit 3d9b08d into v2.0-dev Mar 27, 2025
@shumkov shumkov deleted the fix/decoding-invalid-consensus-error-variants branch March 27, 2025 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants