Add debug file dump

[piohei]

Motivation

It could be very helpful to be able to dump to a JSON file whole debugger context: calls, source code, refs, etc. It would allow then to do a post processing like for example creating heatmap for most costly lines in terms of gas usage.

Closes #7364
Closes #7112

Solution

New --dump param is being added to forge debug and forge test --debug commands. It requires a path to file where to dump data and passing --debug flag same time. Debugger code is refactored to create abstraction over it. It is then used by two different presenters: TUI (interactive debugger) and file dumper. I also added to debugger data original path for the source file to allow figuring out where to make changes when debugging.

[onbjerg]

i am not too sure i am fond of this approach, ideally we'd move away from allocating a big chunk of memory for the debugger, i.e. ideally we'd move away from record/replay

[piohei]

Thanks for comment! Do you find the idea of changing record/replay approach as a new feature request or a blocker for that functionality? This record/replay could be also run only for the dumping or dump can be created on the fly and written to file. The main idea is to be able to use that output for post processing things. Other approach could be to create a plugin system and move things like that out of the core of foundry. What do you think?

[onbjerg]

hmm, thinking about this more, I think this is ok. if/when we move away from record/replay we can always change this as well

would like input from @DaniPopes iirc there are some coming changes to the debugger?

[onbjerg]

ping @DaniPopes

[DaniPopes]

Makes sense

would like input from @DaniPopes iirc there are some coming changes to the debugger?

No

[piohei]

Just fixed tests (clippy + fmt)

[piohei]

Fixed (again) - now using proper rust version locally. I don't know if this is intentional or not but in Cargo.toml there is rust-version = "1.76" while CI is using nightly version.

[piohei]

Any chances for merging this one? :) I don't want to mix same code and I could then work on fixing this #7292.

[mattsse]

very sorry about this @piohei

this now has a few conflicts that must be resolved first, still supportive of that feature

[piohei]

No problem. I will fix them. :)

[zerosnacks]

Hi @piohei thanks for your PR! Would you mind updating the PR to resolve the merge conflicts? Looks like there is consensus on the feature and the approach so it would be great to get this merged

[zerosnacks]

Thanks for your updates!

Pending minor nits, implementation LGTM

General note, the file dumps are quite large (7MB / 100K lines) for basic Counter w/ test_Increment but I can see this be useful as a preprocessed source

[piohei]

@zerosnacks Updated with suggestions and rebased with master again to allow merging. :)

[zerosnacks]

Thanks, latest changes LGTM

Would like to get one more review before merging cc @grandizzy

To setup:

$ forge init counter
$ git clone https://github.com/reilabs/foundry.git reilabs-foundry
$ cd reilabs-foundry
$ git checkout add_debug_file_dump
$ make build
$ cd ..
$ cd counter
$ ../reilabs-foundry/target/debug/forge test --debug test_Increment --dump dump.json
$ ../reilabs-foundry/target/debug/forge debug --debug script/Counter.s.sol --dump dump.json

Side note: forge debug --debug is a bit of a weird syntax but changing it is out of scope of this PR

[zerosnacks]

@piohei would you mind fixing the merge conflicts one last time? I don't have the permissions to push directly to your fork as I normally would.

[piohei]

@zerosnacks rebased with master. :) should be fine now

[zerosnacks]

Thanks! Pending review of @grandizzy

[grandizzy]

looks good, thank you! couple of nits and I suggest adding a test too (like make sure json file is created when running forge test --debug

[piohei]

@grandizzy Thanks for suggestions! Test added and code refactored as suggested. :)
@zerosnacks I have rebased with master once again.

[grandizzy]

thank you, lgtm! CC @DaniPopes if you want to have a look too before merging

[zerosnacks]

Merging this, any additional feedback or improvements can be handled in follow-ups

Thanks @piohei for your contribution!