-
Notifications
You must be signed in to change notification settings - Fork 3
Backport to branch(3.9) : Fix to put state even in read-only transactions #190
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @feeblefakie, I'm Gemini Code Assist1! 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 bug where transaction state was not being properly recorded for read-only transactions. The core change involves adjusting the timing of a state management call to ensure it always occurs before a transaction is committed. This fix is accompanied by comprehensive updates to the test suite, introducing parameterized tests to thoroughly validate the corrected behavior across different transaction types and configurations.
Highlights
- Core Fix: Transaction State Management: The
stateManager.putCommitcall has been relocated withinScalarTamperEvidentAssetLedger.javato ensure it is always executed beforetransaction.commit(), regardless of whether the transaction involved write operations. This addresses an issue where transaction state was not being recorded for read-only transactions. - Enhanced Test Coverage: Existing tests for transaction state management have been refactored into parameterized tests using JUnit Jupiter Params. New parameterized tests have been added to specifically verify the correct behavior of
stateManager.putCommitfor both write and read-only transactions, depending on thetxStateManagementEnabledconfiguration. - Dependency Update: The
build.gradlefile has been updated to include thejunit-jupiter-paramsdependency, enabling the use of parameterized tests.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
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.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request backports a fix to ensure that the transaction state is updated even in read-only transactions. The key change involves moving the stateManager.putCommit call to after the transaction.put call in ScalarTamperEvidentAssetLedger.java to prevent inconsistencies. The pull request also includes updates to the test suite to use parameterized tests to improve coverage and readability, and adds the junit-jupiter-params dependency to support the parameterized tests.
|
|
||
| if (config.isTxStateManagementEnabled()) { | ||
| stateManager.putCommit(transaction, transaction.getId()); | ||
| } | ||
|
|
||
| transaction.put(puts); | ||
|
|
||
| if (!config.isDirectAssetAccessEnabled()) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moving the stateManager.putCommit call after the transaction.put call ensures that the transaction state is updated only if the data is successfully written. This prevents inconsistencies where the transaction is marked as committed but the data is not actually persisted. This is a critical change to ensure data integrity.
| if (config.isTxStateManagementEnabled()) { | |
| stateManager.putCommit(transaction, transaction.getId()); | |
| } | |
| transaction.put(puts); | |
| if (!config.isDirectAssetAccessEnabled()) { | |
| transaction.put(puts); | |
| if (!config.isDirectAssetAccessEnabled()) { | |
| metadata.put(snapshot.getWriteSet().values()); | |
| } | |
| } | |
| if (config.isTxStateManagementEnabled()) { | |
| stateManager.putCommit(transaction, transaction.getId()); |
| assertThat(proofs).containsOnly(proof); | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The original test commit_TxStateManagementEnabled_ShouldPutWithStateManager is being replaced with a parameterized test to cover both true and false cases for txStateManagementEnabled. This is a good improvement to ensure that the state manager is called correctly based on the configuration.
@ParameterizedTest
@ValueSource(booleans = {true, false})
public void commit_WriteTransactionGiven_ShouldPutWithStateManagerAccordingToConfig(
boolean txStateManagementEnabled)
This is an automated backport of the following:
Please merge this PR after all checks have passed.