feat: add chain debug command
#3221
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows running a debug server without launching a debug client which is useful to debug using other clients like gdlv or VSCode.
To keep the command simple it only starts the debug shell or server favouring the build and init commands to init/reset blockchain app data or to build the debug binary. Both build and init commands have now a `--debug` flag to build a binary for debugging.
Bubbletea UI is used when the debug server is run (--server flag) while a standard Cobra command is used when running the debug console. The debug command without `--server` runs outside Bubbletea because the debugger needs control over stdout.
jeronimoalbi
requested review from
aljo242,
lumtis,
fadeev,
tbruyelle and
Pantani
as code owners
|
Running the debugger in macOS requires the command line developer tools to be installed. I'm going to add a warning for that case but it's also possible to ask the user and trigger the developer tools installation from the CLI. This functionality could be documented instead which would keep the CLI code simpler. In any case we need a new section in the documentation to explain how to start debugging using the CLI or other clients like VSCode. |
I think it's ok because we already need the developer tools for Go and homebrew. But it's nice we can document this and also the steps to debug |
Pantani
reviewed
Dec 7, 2022
Co-authored-by: Danilo Pantani <[email protected]>
aljo242
reviewed
Dec 7, 2022
tbruyelle
reviewed
Dec 8, 2022
Co-authored-by: Thomas Bruyelle <[email protected]>
aljo242
reviewed
Dec 8, 2022
aljo242
previously approved these changes
Dec 8, 2022
tbruyelle
previously approved these changes
Dec 9, 2022
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #3221 +/- ##
==========================================
+ Coverage 20.05% 20.06% +0.01%
==========================================
Files 383 386 +3
Lines 30487 30822 +335
==========================================
+ Hits 6114 6185 +71
- Misses 23784 24049 +265
+ Partials 589 588 -1
|
tbruyelle
approved these changes
Dec 9, 2022
aljo242
approved these changes
Dec 9, 2022
Jchicode
pushed a commit
to Jchicode/cli
that referenced
this pull request
Aug 9, 2023
* feat: add support to compile chain app without optimizations * feat: add `debugger` package * chore: change `cliui` package to allow multiple `Session.End()` calls * feat: add `chain debug` command to launch a debugging session * feat: add debug server support to `chain debug` command This allows running a debug server without launching a debug client which is useful to debug using other clients like gdlv or VSCode. * chore: consistency changes * chore: add missing handling for config flag * chore: fix GRPC address * feat: add bubbletea UI to `chain debug` when `--server` flag is present * chore: remove some `chain debug` flags in favour of default values * refactor: simplify debug command by removing build functionality To keep the command simple it only starts the debug shell or server favouring the build and init commands to init/reset blockchain app data or to build the debug binary. Both build and init commands have now a `--debug` flag to build a binary for debugging. * chore: change `ignite serve` to build a debugging binary * docs: add long description for `ignite debug` command * test: add unit tests for `chain debug` server UI views * fix: change error output to be consisten between UI & non UI runs Bubbletea UI is used when the debug server is run (--server flag) while a standard Cobra command is used when running the debug console. The debug command without `--server` runs outside Bubbletea because the debugger needs control over stdout. * refactor: use a single `AddCommand` call to register commands Co-authored-by: Danilo Pantani <[email protected]> * chore: remove redundant `AddCommand` calls * chore: change chain debug command variable name to match flag name Co-authored-by: Alex Johnson <[email protected]> * chore: move disconnect channel init to debug options initialization Co-authored-by: Thomas Bruyelle <[email protected]> * docs: add docstrings to public model methods Co-authored-by: Danilo Pantani <[email protected]> Co-authored-by: Alex Johnson <[email protected]> Co-authored-by: Thomas Bruyelle <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #2992