Skip to content
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

fix(dpp): invalid imports and tests #2459

Merged
merged 2 commits into from
Feb 14, 2025
Merged

fix(dpp): invalid imports and tests #2459

merged 2 commits into from
Feb 14, 2025

Conversation

shumkov
Copy link
Member

@shumkov shumkov commented Feb 13, 2025

Issue being fixed or feature implemented

Invalid imports in WASM DPP prevent it from compiling

What was done?

  • Fixed imports
  • Fixed tests

How Has This Been Tested?

Running tests

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

  • Refactor
    • Streamlined the organization of document transition components.
    • Updated method interfaces for handling document actions.
    • Aligned module references to improve maintainability without impacting end-user functionality.
  • New Features
    • Enhanced imports for document transition functionalities, improving modular access.
  • Tests
    • Renamed DocumentsBatchTransition to BatchTransition in test cases for consistency with updated terminology.

@shumkov shumkov added this to the v2.0.0 milestone Feb 13, 2025
Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Walkthrough

The pull request refactors several import paths from the old documents_batch_transition to the new batch_transition modules across multiple document transition files. In the DocumentCreateTransitionWasm, method signatures for retrieving and setting the identity contract nonce have been updated. Additional accessor methods related to data contracts and document types are introduced in the document replace transition file, and the module file consolidates import statements while simplifying match patterns.

Changes

File(s) Change Summary
.../document_create_transition.rs, .../document_delete_transition.rs, .../document_replace_transition.rs Updated import paths from dpp::state_transition::documents_batch_transition to dpp::state_transition::batch_transition. Added new imports for base transition accessors and v0 methods. Modified DocumentCreateTransitionWasm methods (signature update for get_identity_contract_nonce and set_identity_contract_nonce), and introduced additional imports in the replace transition for data contract and document type accessors.
.../document_transition/mod.rs Streamlined import statements by updating paths for document transitions (including replace, purchase, transfer, and update price transitions) and simplified match arms in methods (get_data, get_price, get_receiver_id) by using unused parameter placeholders.

Possibly related PRs

Suggested labels

js-sdk

Suggested reviewers

  • QuantumExplorer
  • lklimek
  • pshenmic

Poem

I'm a happy rabbit with a joyful beat,
Hopping through code with a spring in my feet.
Imports are dancing and methods align,
The transitions are flowing, all clean and fine.
Celebrate the refactor, oh what a treat!
🐇💻


📜 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 091922a and dd49d96.

📒 Files selected for processing (1)
  • packages/wasm-dpp/test/integration/document/DocumentFacade.spec.js (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Rust packages (wasm-dpp) / Unused dependencies
  • GitHub Check: Rust packages (wasm-dpp) / Tests
  • GitHub Check: Rust packages (wasm-dpp) / Linting
  • GitHub Check: Build JS packages / Build JS
  • GitHub Check: Rust crates security audit
🔇 Additional comments (2)
packages/wasm-dpp/test/integration/document/DocumentFacade.spec.js (2)

11-11: LGTM! Import renamed correctly.

The import has been correctly updated from DocumentsBatchTransition to BatchTransition, aligning with the module restructuring.


98-110:

❓ Verification inconclusive

LGTM! Test updated to reflect class rename.

The test description and assertion have been correctly updated to use BatchTransition. However, there are commented-out assertions that might need attention.

Let's verify if similar test cases exist in other test files:


🏁 Script executed:

#!/bin/bash
# Search for other test files that might need similar updates
rg -l "DocumentsBatchTransition" "packages/wasm-dpp/test"

Length of output: 787


LGTM for the changes in DocumentFacade.spec.js – the test is correctly updated to use BatchTransition.

The test description and assertion now match the new class name. However, note the following:

  • There are several other test files still referencing DocumentsBatchTransition. For consistency, please verify if these should be updated as well or intentionally left unchanged:

    • packages/wasm-dpp/test/integration/stateTransition/StateTransitionFacade.spec.js
    • packages/wasm-dpp/test/integration/document/stateTransition/DocumentsBatchTransition/validation/basic/validateDocumentsBatchTransitionBasicFactory.spec.js
    • packages/wasm-dpp/test/unit/document/DocumentFactory.spec.js
    • packages/wasm-dpp/test/unit/stateTransition/createStateTransitionFactory.spec.js
    • packages/wasm-dpp/test/unit/document/stateTransition/DocumetsBatchTransition/DocumentsBatchTransition.spec.js
    • packages/wasm-dpp/test/unit/stateTransition/validation/validateStateTransitionFeeFactory.spec.js
    • packages/wasm-dpp/test/unit/document/stateTransition/DocumetsBatchTransition/validation/state/validateDocumentsBatchTransitionStateFactory.spec.js
  • Also, there are commented-out assertions in DocumentFacade.spec.js (lines 111–114) that might need a review to decide if they should be updated and enabled or removed.

Please confirm the intended behavior for these cases.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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. (Beta)
  • @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.

Copy link
Contributor

@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)
packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/mod.rs (1)

1-8: Remove commented-out code.

These commented-out module declarations and exports are no longer needed and should be removed to maintain code cleanliness.

-mod document_create_transition;
-// mod document_delete_transition;
-// mod document_replace_transition;
-
-// pub use document_create_transition::*;
-// pub use document_delete_transition::*;
-// pub use document_replace_transition::*;
+mod document_create_transition;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 82e4d4c and 091922a.

📒 Files selected for processing (4)
  • packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/document_create_transition.rs (2 hunks)
  • packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/document_delete_transition.rs (2 hunks)
  • packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/document_replace_transition.rs (2 hunks)
  • packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/mod.rs (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Rust packages (wasm-dpp) / Unused dependencies
  • GitHub Check: Rust packages (wasm-dpp) / Tests
  • GitHub Check: Rust packages (wasm-dpp) / Linting
  • GitHub Check: Rust packages (wasm-dpp) / Formatting
  • GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
  • GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
  • GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
  • GitHub Check: Build JS packages / Build JS
🔇 Additional comments (6)
packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/document_delete_transition.rs (1)

1-3: LGTM! Import path changes look good.

The import path changes from documents_batch_transition to batch_transition are consistent with the PR objectives and maintain the same functionality.

Also applies to: 13-15

packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/mod.rs (2)

21-25: LGTM! Import path changes look good.

The new imports for document transition types are consistent with the PR objectives and maintain the same functionality.


65-68: LGTM! Match arm changes improve readability.

Using underscores for unused parameters in match arms improves code readability and follows Rust best practices.

packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/document_replace_transition.rs (1)

6-8: LGTM! Import changes enhance module capabilities.

The new imports for data contract and document type accessors, along with the updated import path for DocumentTransitionActionType, improve the module's interaction capabilities while maintaining consistency with the PR objectives.

Also applies to: 13-14, 34-34

packages/wasm-dpp/src/document/state_transition/batch_transition/document_transition/document_create_transition.rs (2)

7-10: LGTM! Import changes look good.

The updated import paths and new imports for document transition types are consistent with the PR objectives.


93-95: LGTM! Method changes are safe.

The changes to get_identity_contract_nonce and set_identity_contract_nonce methods are safe:

  • Removing the u64 cast is safe as the underlying type is already u64.
  • Removing the return type annotation is safe as it's the default return type in Rust.

Also applies to: 98-104

@shumkov shumkov changed the title fix(dpp): invalid imports fix(dpp): invalid imports and tests Feb 14, 2025
@shumkov shumkov self-assigned this Feb 14, 2025
@shumkov shumkov merged commit d88ea46 into v2.0-dev Feb 14, 2025
41 of 44 checks passed
@shumkov shumkov deleted the fix/invalid-imports branch February 14, 2025 02:52
@coderabbitai coderabbitai bot mentioned this pull request Feb 14, 2025
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants