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 flaky E2E test for EVM state building #532

Merged
merged 1 commit into from
Sep 10, 2024
Merged

Conversation

m-Peter
Copy link
Collaborator

@m-Peter m-Peter commented Sep 9, 2024

Description

The random values for the transfer amount, cannot be equal to 0.15 ether, as that is the balance of the test EOAs, and it will cause the transfer transaction to be reverted.


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Summary by CodeRabbit

  • Bug Fixes

    • Adjusted transfer amounts in the EVM interaction test to prevent exceeding account balances, ensuring test validity.
  • Tests

    • Updated test case to reflect new transfer amounts, maintaining the integrity of the simulation for Ethereum transactions.

@m-Peter m-Peter added this to the Flow-EVM-M2 milestone Sep 9, 2024
@m-Peter m-Peter self-assigned this Sep 9, 2024
Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Walkthrough

The pull request modifies the transferAmounts array in a test case for Ethereum Virtual Machine (EVM) interactions. The original amounts of ['0.01', '0.03', '0.05'] totaling 0.09 ether have been changed to ['0.01', '0.02', '0.04'], totaling 0.07 ether. This adjustment ensures that the total transfer amount does not exceed the balance of 0.15 ether for each Externally Owned Account (EOA), thus preventing transaction reversion and maintaining the validity of the test scenario.

Changes

Files Change Summary
tests/web3js/build_evm_state_test.js Updated transferAmounts array from ['0.01', '0.03', '0.05'] to ['0.01', '0.02', '0.04'] to ensure total does not exceed EOA balance.

Possibly related PRs

Suggested labels

Bugfix

Poem

🐇 In the land of ether, where transactions flow,
A tweak to the amounts, now balanced they grow.
With careful adjustments, no reversion in sight,
Our tests now run smoothly, all day and all night!
Hooray for the changes, let’s hop with delight,
For valid transactions make everything right! 🎉

Tip

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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

@@ -41,7 +41,10 @@ it('should handle a large number of EVM interactions', async () => {
let senderBalance = await web3.eth.getBalance(conf.eoa.address)
assert.equal(senderBalance, 1999999999937000000n)

let transferAmounts = ['0.01', '0.03', '0.05']
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

When the transfer amount 0.05 was randomly selected 3 times, it would cause the test to fail, as the EOA only has 0.15 ether.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 88c3830 and 3f531ac.

Files selected for processing (1)
  • tests/web3js/build_evm_state_test.js (1 hunks)
Additional comments not posted (1)
tests/web3js/build_evm_state_test.js (1)

44-47: Well-implemented change to prevent transaction reversion.

The modification to the transferAmounts array ensures that the total transfer amount does not reach the critical threshold of 0.15 ether, which is the balance of each EOA. This change effectively prevents transaction reversion due to insufficient funds after the transfer. The added comments provide clear guidance on the rationale behind these amounts, enhancing the readability and maintainability of the test.

Copy link
Contributor

@sideninja sideninja left a comment

Choose a reason for hiding this comment

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

noticed that yes

@sideninja sideninja merged commit 874fb14 into main Sep 10, 2024
2 checks passed
@m-Peter m-Peter deleted the fix-flaky-e2e-test branch September 10, 2024 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants