chore: fix typo in test/unit/sanityCheck.test.ts hiding root cause of error
Replace BigInt(1) ** BigInt(15); to BigInt(10) ** BigInt(15);
Fixes 6358
Motivation
When trying to fix flaky test/unit/sanityCheck.test.ts test in https://github.com/ChainSafe/lodestar/issues/6358 I noticed the test has a typo causing it to pass when I don't think it should. I don't have time to fix the underlying issue but thought I should let you know there is a deeper issue.
Description
It appears there to be a typo in the test, multiplying 1^15 instead of 10^15. The test now fails properly instead of incorrectly passing.
Steps to test or reproduce
git checkout matthandzel/fixing-typo-in-sanity-check-test
yarn install
yarn build
yarn vitest run test/unit/sanityCheck.test.ts
Summary of Changes
Hello @MattHandzel, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a critical typo within a unit test (sanityCheck.test.ts) that was causing it to incorrectly pass. By changing a BigInt calculation from 1^15 to 10^15, the test now accurately reflects its intended logic and fails, thereby unmasking a deeper, previously obscured issue that contributes to test flakiness.
Highlights
- Test Typo Correction: Corrected a mathematical typo in
packages/state-transition/test/unit/sanityCheck.test.tsby changingBigInt(1) ** BigInt(15)toBigInt(10) ** BigInt(15). - Revealing Root Cause: This fix ensures the test now fails as intended, exposing a previously hidden underlying issue related to flaky tests (referenced as #6358).
- Motivation: The change was motivated by an attempt to fix a flaky test, where the typo was discovered to be masking the true problem, allowing the test to incorrectly pass.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
good catch! looks like the test has always been bugged since it was added https://github.com/ChainSafe/lodestar/commit/a75ef9b0c28cce5a58cc243b6ee10010b15fcce8