Support logging debug events via the guest interface #464
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
leighmcculloch
requested review from
graydon,
jonjove,
sisuresh and
a team
as code owners
leighmcculloch
commented
Sep 22, 2022
soroban-env-host/src/host.rs
Outdated
Comment on lines
1084
to
1087
| let fmt: String = self | ||
| .visit_obj(fmt, move |hv: &Vec<u8>| Ok(String::from_utf8(hv.clone())))? | ||
| // TODO: Remove unwrap. | ||
| .unwrap(); |
There was a problem hiding this comment.
This allocates a String, but only when debug-assertions are enabled. This code will not be compiled in releases used in stellar-core.
leighmcculloch
commented
Sep 22, 2022
leighmcculloch
commented
Sep 22, 2022
| @@ -87,13 +87,13 @@ impl Display for DebugArg { | |||
| /// [host::Host::debug_event](crate::host::Host::debug_event) for normal use. | |||
| #[derive(Clone, Debug)] | |||
| pub struct DebugEvent { | |||
| pub msg: Option<&'static str>, | |||
| pub msg: Option<Cow<'static, str>>, | |||
There was a problem hiding this comment.
I think this is the right way to do the Cow so it can hold either the static str or the String. I'm not overly familiar with Cow though. @graydon Am I using this right?
leighmcculloch
commented
Sep 22, 2022
|
I updated the PR to use a feature instead of debug-assertions, because if we ever wanted to use debug-assertions to debug the host, we'd be enabling new functionality for contracts which could be dangerous. |
|
@graydon requesting a post-merge review on this one when you have a moment. |
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.
What
Support logging debug events via the guest interface, gated behind the debug-assertions build flag.
Why
Close #447
The reason I've used the debug-assertions build flag and not a feature is because the Rust reference describes the flag as something that can be used to gate extra debug code, and I think we'll use it in the SDK for debug logs since it is a pretty huge advantage to not have to ask every contract developer to layer adebugfeature into their contract just to get logging. Having that consistency between SDK and env is convenient.https://doc.rust-lang.org/stable/reference/conditional-compilation.html?highlight=debug_assertions#debug_assertionsStatus
This is a WIP.