RPC simulateTransaction endpoint now returns program log output #10432
Conversation
mvines
force-pushed
the
logit
branch
4 times, most recently
from
952d8ae to
845eb2f
Compare
|
|
||
| #[derive(Default)] | ||
| pub struct LogCollector { | ||
| messages: RefCell<Vec<String>>, |
There was a problem hiding this comment.
RefCell cause passing around Option<&mut LogCollector> turns into a mess very quickly, so I acquiesced to Option<&LogCollector> with this RefCell
programs/bpf_loader/src/syscalls.rs
Outdated
| } | ||
|
|
||
| // Ignore this test: solana_logger conflicts when running tests concurrently, | ||
| // this results in the bad string length being ignored and not returning an error | ||
| #[test] | ||
| #[ignore] | ||
| #[serial] |
There was a problem hiding this comment.
I tried serial for these two tests and it appeared to work but then started showing up in CI as failures...
There was a problem hiding this comment.
Just noticed that CI failed on this test as expected due to conflict. Commited a change to ignore these tests again to unblock CI
There was a problem hiding this comment.
I just reworked these tests to avoid using solana_logger::setup_with_default("solana=info"); entirely. With the MockInvokeContext, we can actually collect and validate that the log functions actually output the expected result instead
There was a problem hiding this comment.
Strange that it fails on CI but not locally, maybe the conflict is not what I thought it was
There was a problem hiding this comment.
Maybe I'm reading it wrong but doesn't MockInvokeContext still use solana_logger to determine if the log message is enabled?
There was a problem hiding this comment.
Sry I'm moving the furniture on you.
MockInvokeContext:
fn log_enabled(&self) -> bool {
true
}
fn log(&mut self, message: &str) {
info!("[MockInvokeContext::log] {}", message);
self.log.push(message.to_string());
}ThisInvokeContext:
fn log_enabled(&self) -> bool {
log_enabled!(log::Level::Info) || self.log_collector.is_some()
}
fn log(&mut self, message: &str) {
info!("{}", message);
if let Some(log_collector) = self.log_collector {
log_collector.log(message);
}
}
mvines
force-pushed
the
logit
branch
3 times, most recently
from
752328a to
093f495
Compare
|
Close, just gotta make |
|
lgtm! |
Codecov Report
@@ Coverage Diff @@
## master #10432 +/- ##
=======================================
Coverage 81.6% 81.6%
=======================================
Files 295 296 +1
Lines 69277 69353 +76
=======================================
+ Hits 56558 56625 +67
- Misses 12719 12728 +9 |
(cherry picked from commit 7e2651c) # Conflicts: # programs/bpf/benches/bpf_loader.rs # programs/bpf_loader/src/lib.rs # programs/bpf_loader/src/syscalls.rs # runtime/src/bank.rs # runtime/src/message_processor.rs # sdk/src/entrypoint_native.rs
(cherry picked from commit 7e2651c)
To view program log output in the wild, the only option is to find a
solana-validatorlog file to troll through. Not exactly friendly for a front-end program developer/user.Instead
simulateTransactionnow returns allsol_log,sol_log_64andsol_panicmessages back to the user for easy viewing.This required a touch of plumbing through bank/message_processor but
InvokeContextis proving handy for more than just enabling cross-program support. In the future more debug introspection facilities could probably be plumbed in along this same path.This PR changes the RPC simulateTransaction signature slightly, but I doubt any existing RPC users will notice/care
Fixes #10364