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

Simulate: Properly handle failing clear state programs #5842

Merged
merged 5 commits into from Dec 8, 2023

Conversation

jasonpaulos
Copy link
Member

@jasonpaulos jasonpaulos commented Nov 21, 2023

Problem

Currently the simulate endpoint does not properly handle failing clear state programs. Unlike every other type of program execution, if a clear state program rejects or errors, the transaction group continues and can still succeed. Any stateful operations the clear state program performed before it failed are rolled back.

Simulate incorrectly handled failing clear state programs in the following ways:

  1. Reporting the wrong ApplyData for a failed clear state txn (it should be blank, but that's not what simulate reports)
  2. If there's a later error, it uses the location of the earlier clear state error
  3. For app state traces, it doesn't communicate that clear state operations should be rolled back

Solution

Implementation fixes for items 1 & 2 have been added in this PR.

Additionally, for item 3, the fields clear-state-rollback and clear-state-rollback-error have been added to the SimulationTransactionExecTrace object. If clear-state-rollback is true, this indicates to trace consumers that they must discard all state changes from the clear state trace after it finishes.

Test Plan

Unit tests added

@jasonpaulos jasonpaulos self-assigned this Nov 21, 2023
Copy link

codecov bot commented Nov 21, 2023

Codecov Report

Attention: 9 lines in your changes are missing coverage. Please review.

Comparison is base (9229066) 55.92% compared to head (dcb2a37) 55.95%.

Files Patch % Lines
daemon/algod/api/server/v2/utils.go 0.00% 8 Missing ⚠️
data/transactions/logic/tracer.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5842      +/-   ##
==========================================
+ Coverage   55.92%   55.95%   +0.03%     
==========================================
  Files         477      477              
  Lines       67371    67382      +11     
==========================================
+ Hits        37676    37705      +29     
+ Misses      27139    27125      -14     
+ Partials     2556     2552       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jasonpaulos jasonpaulos marked this pull request as ready for review November 21, 2023 20:26
jannotti
jannotti previously approved these changes Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants