fix: catch the out of gas exception in preprocess #2638

piux2 · 2024-07-28T04:36:07Z

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

codecov · 2024-07-28T04:38:26Z

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 60.06%. Comparing base (0e3c050) to head (8c22541).
Report is 168 commits behind head on master.

Files with missing lines	Patch %	Lines
gnovm/pkg/gnolang/preprocess.go	0.00%	2 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2638      +/-   ##
==========================================
+ Coverage   54.99%   60.06%   +5.06%     
==========================================
  Files         595      560      -35     
  Lines       79775    75825    -3950     
==========================================
+ Hits        43872    45542    +1670     
+ Misses      32581    26834    -5747     
- Partials     3322     3449     +127

Flag	Coverage Δ
contribs/gnodev	`60.58% <ø> (+34.58%)`	⬆️
contribs/gnofaucet	`14.46% <ø> (ø)`
gno.land	`64.18% <ø> (+0.02%)`	⬆️
gnovm	`64.12% <0.00%> (+3.91%)`	⬆️
misc/genstd	`80.54% <ø> (ø)`
misc/logos	`19.88% <ø> (+2.50%)`	⬆️
tm2	`62.07% <ø> (+7.57%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

thehowl

Conceptually the same as this PR

Do you think it could make sense to swap with using errors.As, as I suggested here?

Also, do you have a testcase that can show what happens when there's an out-of-gas in preprocess/predefine? (that's what we were missing on the other PR)

piux2 · 2024-07-31T03:35:35Z

Conceptually the same as this PR

Yes, Same. This PR catch all places that could throw Out Of Gas Exception in preprocess.

Do you think it could make sense to swap with using errors.As, as I suggested here?

Using return errors in preprocess will change many signatures and also involves catching errors in recursive calls during transcribe. It will be easier to make mistakes in future changes not handling errors or shadowing error in closures and switch case block. Recover and throwing panic(r) is a clearer and simpler approach.

I would prefer panic everywhere with exceptions in the VM itself and catch the panics outside of VM and process them as errors in Keeper.

In addition, to handle it properly, an OutOfGas exception should be thrown all the way to the ante handler and base app where the gas meter was originally set.

Also, do you have a testcase that can show what happens when there's an out-of-gas in preprocess/predefine? (that's what we were missing on the other PR)

I will add testing cases.

thehowl · 2024-07-31T19:18:29Z

Using return errors in preprocess will change many signatures and also involves catching errors in recursive calls during transcribe. It will be easier to make mistakes in future changes not handling errors or shadowing error in closures and switch case block. Recover and throwing panic(r) is a clearer and simpler approach.

I'm not suggesting we returns error. Simply, that we are panic'ing with an error type; the value returned by recover() in the keeper will be of the same type too. So we can use errors.As instead -- thus we can special-case how we handle OutOfGasException in the keeper rather than in the VM.

The advantage I see out of this is that we don't have to think to add a condition to not wrap the error any other time we add a recover in vm. (They should happen seldom; but anyway I think the responsibility to do this kind of handling relies in the keeper).

piux2 · 2024-08-03T08:36:54Z

I found right gas amount to replicate the errors that PR2368 could not reproduce and added proper integration test for that. Both store.GetPackage and store.GetTypeSafe could cause out-of-gas exceptions during preprocess.

I'm not suggesting we returns error. Simply, that we are panic'ing with an error type; the value returned by recover() in the keeper will be of the same type too. So we can use errors.As instead

using error.As() adds additional unnecessary abstraction.

We do use different exception types for VM panics. OutOfGasException and PreprocessError are the examples. To use errors.As(), we not only have to wrap exceptions with errors in VM, but also when we recover from a panic in Keeper, instead of type switching on r.(type), directly, we need to use r.(type) checking for error first and if else errors.As(r, &Exception) for the r=recover(). On the other hand, type switching exception types on recover is cleaner and faster than type checking error with if-else blocks.

we can special-case how we handle OutOfGasException in the keeper rather than in the VM.
I'm not suggesting we returns error. Simply, that we are panic'ing with an error type; the value returned by recover() in the keeper will be of the same type too. So we can use errors.As instead -- thus we can special-case how we handle OutOfGasException in the keeper rather than in the VM.

It only works if we do not recover any panic and wrap additional information on the call path to the Keeper. However, this is not the case. Currently, we recover from panic, wrap the stack trace, and preprocess trace in PreprocessError. Therefore, we need to differentiate the OutOfGas execution in the VM. This is actually the root cause of the issue we are fixing.

MikaelVallenet · 2024-08-13T05:35:42Z

Hello, I wanted to report the issue, then I saw that the problem was already being fixed, to check, I cloned the fix branch, install gno from this branch and I have the impression of still having the problem, or is it something else? @piux2

https://www.loom.com/share/4c507cb56f0e45b6bec819fdd85c6152?sid=558ebe55-0cb8-4758-ac76-1fe87584d69b

piux2 · 2024-08-14T16:15:02Z

Hello, I wanted to report the issue, then I saw that the problem was already being fixed, to check, I cloned the fix branch, install gno from this branch and I have the impression of still having the problem, or is it something else? @piux2

https://www.loom.com/share/4c507cb56f0e45b6bec819fdd85c6152?sid=558ebe55-0cb8-4758-ac76-1fe87584d69b

@MikaelVallenet thank you for the feedback.

This is a normal case and not an issue. The chain checks the size of the transaction and consumes gas based on that size. The transaction runs out of gas before it reaches the VM.

gno/tm2/pkg/sdk/auth/ante.go

Line 108 in 763bdd1

    
           newCtx.GasMeter().ConsumeGas(params.TxSizeCostPerByte*store.Gas(len(newCtx.TxBytes())), "txSize")

For the issue we are trying to solve in this PR, the out-of-gas event happens during preprocessing. Before the fix, it returned the stack trace and preprocess stack. After the fix, it returns a normal out-of-gas message and stack trace, as seen in your video clip.

The issue is tricky to reproduce. Only a specific gas amount will be able to trigger it. You can try it out in the newly added txtar file and compare the results before and after the fix.

MikaelVallenet · 2024-08-14T16:31:17Z

Hello, I wanted to report the issue, then I saw that the problem was already being fixed, to check, I cloned the fix branch, install gno from this branch and I have the impression of still having the problem, or is it something else? @piux2
https://www.loom.com/share/4c507cb56f0e45b6bec819fdd85c6152?sid=558ebe55-0cb8-4758-ac76-1fe87584d69b

@MikaelVallenet thank you for the feedback.

This is a normal case and not an issue. The chain checks the size of the transaction and consumes gas based on that size. The transaction runs out of gas before it reaches the VM.

gno/tm2/pkg/sdk/auth/ante.go

Line 108 in 763bdd1

newCtx.GasMeter().ConsumeGas(params.TxSizeCostPerByte*store.Gas(len(newCtx.TxBytes())), "txSize")

For the issue we are trying to solve in this PR, the out-of-gas event happens during preprocessing. Before the fix, it returned the stack trace and preprocess stack. After the fix, it returns a normal out-of-gas message and stack trace, as seen in your video clip.

The issue is tricky to reproduce. Only a specific gas amount will be able to trigger it. You can try it out in the newly added txtar file and compare the results before and after the fix.

Hello, thanks for information but i mean not the first error but the second one around 0:55 of my video (cf. screenshot below)

I think it should print the out of gas exception, isn't ?

piux2 · 2024-10-04T17:04:13Z

@MikaelVallenet

I think it should print the out of gas exception, isn't ?

Have you checked if you ran the test against the correct version of the chain?

I noticed you only ran make install. Did you start the chain with the patch?

Also, here is the stack trace from the video at 1:04.

At line numbers preprocess.go:137 and preprocess.go:173, they do not match the code that follows the trace in this fixed patch.

MikaelVallenet · 2024-10-07T10:26:16Z

@MikaelVallenet

I think it should print the out of gas exception, isn't ?

Have you checked if you ran the test against the correct version of the chain?

I noticed you only ran make install. Did you start the chain with the patch?

Also, here is the stack trace from the video at 1:04.

At line numbers preprocess.go:137 and preprocess.go:173, they do not match the code that follows the trace in this fixed patch.

I see, indeed i did not start chain w/ patch thanks for clarification 🙏

thehowl · 2024-10-30T19:26:29Z

gno.land/cmd/gnoland/testdata/addpkg_outofgas.txtar

+stderr '--= Error =--'
+stderr 'Data: out of gas error'
+stderr 'Msg Traces:'
+stderr '    0  /home/runner/work/gno/gno/tm2/pkg/crypto/keys/client/maketx.go:215 - deliver transaction failed: log:out of gas, gasWanted: 60000, gasUsed: 60343 location: ReadFlat'


Suggested change

stderr ' 0 /home/runner/work/gno/gno/tm2/pkg/crypto/keys/client/maketx.go:215 - deliver transaction failed: log:out of gas, gasWanted: 60000, gasUsed: 60343 location: ReadFlat'

stderr ' 0 /home/runner/work/gno/gno/tm2/pkg/crypto/keys/client/maketx.go:215 - deliver transaction failed: log:out of gas, gasWanted: 60000, gasUsed: \d+ location: ReadFlat'

Same for the other gas used. I'd rather we checked the values of gas in gas_test.go rather than in filetests.

The chain consumes gas at multiple points outside the VM before reaching the VM. Even inside the VM, a transaction may run out of gas during preprocessing or runtime. To precisely replicate and verify that the bug is fixed in the preprocessing stage, we need to specify an exact gas amount in the integration test.

This is checking against the error message. If we change how gas calculated, even slightly, this is yet another file where we need to go update the tests. It's an annoyance.

In this case, it's not necessary for the test; this is just checking the error message.

thehowl · 2024-10-30T19:27:12Z

gno.land/cmd/gnoland/testdata/addpkg_outofgas.txtar

+gnoland start
+
+# add foo package
+gnokey maketx addpkg -pkgdir $WORK/foo -pkgpath gno.land/r/foo -gas-fee 1000000ugnot -gas-wanted 211483 -broadcast -chainid=tendermint_test test1


Suggested change

gnokey maketx addpkg -pkgdir $WORK/foo -pkgpath gno.land/r/foo -gas-fee 1000000ugnot -gas-wanted 211483 -broadcast -chainid=tendermint_test test1

gnokey maketx addpkg -pkgdir $WORK/foo -pkgpath gno.land/r/foo -gas-fee 1000000ugnot -gas-wanted 500000 -broadcast -chainid=tendermint_test test1

like the other comment, let's maybe not make this a test against specific gas results

Same reason as above:

The chain consumes gas at multiple points outside the VM before reaching the VM. Even inside the VM, a transaction may run out of gas during preprocessing or runtime. To precisely replicate and verify that the bug is fixed in the preprocessing stage, we need to specify an exact gas amount in the integration test.

Same here, this command is not supposed fail; in fact it's not prefixed with !.

thehowl

Let's change the test and merge this; I'd rather we did it slightly differently but I'm happy to do a follow-up PR myself.

chores: catch the out of gas exception in preprocess

b2a46ad

piux2 requested review from jaekwon, moul and deelawn as code owners July 28, 2024 04:36

github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Jul 28, 2024

github-actions bot assigned piux2 Jul 28, 2024

chore: lint

c73b83a

thehowl requested changes Jul 29, 2024

View reviewed changes

add a txtar file that catchs out-of-gas errors during preprocess

a86b93f

piux2 requested review from zivkovicmilos and a team as code owners August 3, 2024 08:20

github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Aug 3, 2024

updated txtar

8c22541

piux2 changed the title ~~chores: catch the out of gas exception in preprocess~~ fix: catch the out of gas exception in preprocess Aug 3, 2024

piux2 mentioned this pull request Aug 3, 2024

fix(gnovm): show "out of gas" errors (#2365) #2368

Closed

Kouteki mentioned this pull request Aug 4, 2024

Minutes: Core Staff Weekly Syncs [every Monday] gnolang/meetings#36

Open

deelawn approved these changes Aug 7, 2024

View reviewed changes

thehowl reviewed Oct 30, 2024

View reviewed changes

thehowl approved these changes Oct 30, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: catch the out of gas exception in preprocess #2638

fix: catch the out of gas exception in preprocess #2638

piux2 commented Jul 28, 2024

codecov bot commented Jul 28, 2024 •

edited

Loading

thehowl left a comment

piux2 commented Jul 31, 2024 •

edited

Loading

thehowl commented Jul 31, 2024

piux2 commented Aug 3, 2024 •

edited

Loading

MikaelVallenet commented Aug 13, 2024

piux2 commented Aug 14, 2024

MikaelVallenet commented Aug 14, 2024

piux2 commented Oct 4, 2024 •

edited

Loading

MikaelVallenet commented Oct 7, 2024

thehowl Oct 30, 2024

piux2 Oct 31, 2024

thehowl Nov 5, 2024

thehowl Oct 30, 2024 •

edited

Loading

piux2 Oct 31, 2024

thehowl Nov 5, 2024

thehowl left a comment

	stderr ' 0 /home/runner/work/gno/gno/tm2/pkg/crypto/keys/client/maketx.go:215 - deliver transaction failed: log:out of gas, gasWanted: 60000, gasUsed: 60343 location: ReadFlat'
	stderr ' 0 /home/runner/work/gno/gno/tm2/pkg/crypto/keys/client/maketx.go:215 - deliver transaction failed: log:out of gas, gasWanted: 60000, gasUsed: \d+ location: ReadFlat'

	gnokey maketx addpkg -pkgdir $WORK/foo -pkgpath gno.land/r/foo -gas-fee 1000000ugnot -gas-wanted 211483 -broadcast -chainid=tendermint_test test1
	gnokey maketx addpkg -pkgdir $WORK/foo -pkgpath gno.land/r/foo -gas-fee 1000000ugnot -gas-wanted 500000 -broadcast -chainid=tendermint_test test1

fix: catch the out of gas exception in preprocess #2638

Are you sure you want to change the base?

fix: catch the out of gas exception in preprocess #2638

Conversation

piux2 commented Jul 28, 2024

codecov bot commented Jul 28, 2024 • edited Loading

Codecov Report

thehowl left a comment

Choose a reason for hiding this comment

piux2 commented Jul 31, 2024 • edited Loading

thehowl commented Jul 31, 2024

piux2 commented Aug 3, 2024 • edited Loading

MikaelVallenet commented Aug 13, 2024

piux2 commented Aug 14, 2024

MikaelVallenet commented Aug 14, 2024

piux2 commented Oct 4, 2024 • edited Loading

MikaelVallenet commented Oct 7, 2024

thehowl Oct 30, 2024

Choose a reason for hiding this comment

piux2 Oct 31, 2024

Choose a reason for hiding this comment

thehowl Nov 5, 2024

Choose a reason for hiding this comment

thehowl Oct 30, 2024 • edited Loading

Choose a reason for hiding this comment

piux2 Oct 31, 2024

Choose a reason for hiding this comment

thehowl Nov 5, 2024

Choose a reason for hiding this comment

thehowl left a comment

Choose a reason for hiding this comment

codecov bot commented Jul 28, 2024 •

edited

Loading

piux2 commented Jul 31, 2024 •

edited

Loading

piux2 commented Aug 3, 2024 •

edited

Loading

piux2 commented Oct 4, 2024 •

edited

Loading

thehowl Oct 30, 2024 •

edited

Loading