initia-labs / movevm

Other
18 stars 11 forks source link

fix: aptos compatibility + json & event natives #109

Closed beer-1 closed 2 months ago

beer-1 commented 2 months ago

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@beer-1 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 37 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 687b5e528aa65480fbcb0e3790dd0a8fe82bdb80 and 244199909ef7e3c304912cfeba16b0b3f4011a01.

Walkthrough

This update enhances the JSON and Move modules by introducing new testing functions and refining existing structures to better manage edge cases. Key improvements include handling for structs with dummy fields, enhanced event emission testing, and expanded block information retrieval. Collectively, these modifications strengthen the testing framework, ensuring robust handling of various scenarios while maintaining core functionality.

Changes

Files Change Summary
crates/json/src/json_to_value.rs Added check for structs with a "dummy_field" to return a Value of false, improving edge case handling.
crates/json/src/move_to_json.rs Introduced conditional check for MoveStruct with "dummy_field" to return an empty JSON object, enhancing robustness in JSON conversion.
crates/natives/src/event.rs Added events_for_testing to NativeEventContext, modified emitted_events for better testing output, and cached events for validation purposes.
precompile/modules/initia_stdlib/sources/account.move New function create_account_for_test added for creating a signer in test scenarios, enhancing module testing capabilities.
precompile/modules/initia_stdlib/sources/block.move Introduced get_current_block_height and get_current_block_timestamp for real-time data retrieval, plus test-only functions for easier simulation.
precompile/modules/minitia_stdlib/sources/account.move Added create_account_for_test function to facilitate signer creation for testing.
precompile/modules/minitia_stdlib/sources/block.move Included get_current_block_height, get_current_block_timestamp, and two test-only functions to bolster testing capabilities.
precompile/modules/initia_stdlib/sources/code.move Simplified control flow in a loop to enhance readability without altering logic.
precompile/modules/minitia_stdlib/sources/code.move Similar simplification of control flow for clarity while maintaining functionality.
precompile/modules/compatibility/reconfiguration.move New module with initialize_for_test function for standardized initialization in test contexts without side effects.
precompile/modules/minitia_stdlib/sources/json.move Added EmptyObject struct for testing, with a function to verify JSON marshaling/unmarshaling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MoveModule
    participant JSONModule
    participant EventContext

    User->>MoveModule: Create struct
    MoveModule->>JSONModule: Convert MoveStruct to JSON
    JSONModule->>MoveModule: Check for "dummy_field"
    MoveModule->>EventContext: Emit event
    EventContext->>EventContext: Cache emitted event
    User->>MoveModule: Request block info
    MoveModule->>EventContext: Call get_current_block_height()
    EventContext->>MoveModule: Return block height

🐰 In the code's warren, changes abound,
New paths for testing, where joy is found.
With dummy fields handled, events in a row,
Our modules now dance, with a jubilant glow!
Let's hop through the code, with glee and delight,
Embracing the changes, as day turns to night! πŸŒ™βœ¨


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.