Replace panicking unwrap with descriptive errors in plugin-api #1134
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.
Summary
compile_src()andinvoke()injavy-plugin-apicall.unwrap()onRUNTIME.get(), which panics with an opaque message when the runtime has not been initialized:This makes debugging difficult for plugin authors and host integrators, as the panic message gives no indication of what went wrong or how to fix it.
Changes
Replace the bare
.unwrap()calls with.ok_or_else()returning a descriptiveanyhowerror that names the uninitialized runtime and points toinitialize_runtimeas the required precondition:Both functions already return
Result<T>, so this is a non-breaking change with no new dependencies.Context
This issue was encountered while building a Chainlink CRE workflow plugin. The javy host (v5.0.4) called
compile_srcbeforeinitialize_runtime, producing the opaque panic. The resulting error message (called Option::unwrap() on a None value) with a path pointing into the Cargo registry gave no actionable information about the root cause.