Skip to content

Commit

Permalink
Reduce duplication in error messages (#532)
Browse files Browse the repository at this point in the history
* Reduce duplication in error messages

This commit removes duplication in error messages where the same text
would show up multiple times in a fully rendered error message.

When using `derive(Error)` when the `#[from]` attribute is used there's
no need to also render that payload into the error string because the
`#[from]` establishes a "backtrace" which means that when the full
context of an error is rendered it will include the `#[from]` in the
lower frames of the backtrace anyway.

This commit audits the `derive(Error)` implementations to avoid
duplication in the rendered error messages, ensuring that if `#[from]`
is used then the `#[from]` field isn't also rendered in the textual
description.

* Search the full error in wast assertions

Don't just search the top error, but search the whole backtrace by using
the `{:?}` format instead of `{}`.
  • Loading branch information
alexcrichton authored Nov 9, 2019
1 parent b58c2bf commit 29c8c4f
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions crates/environ/src/compilation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,11 @@ pub type Traps = PrimaryMap<DefinedFuncIndex, Vec<TrapInformation>>;
#[derive(Error, Debug)]
pub enum CompileError {
/// A wasm translation error occured.
#[error("WebAssembly translation error: {0}")]
#[error("WebAssembly translation error")]
Wasm(#[from] WasmError),

/// A compilation error occured.
#[error("Compilation error: {0}")]
#[error("Compilation error")]
Codegen(#[from] CodegenError),

/// A compilation error occured.
Expand Down
2 changes: 1 addition & 1 deletion crates/jit/src/action.rs
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ pub enum ActionOutcome {
#[derive(Error, Debug)]
pub enum ActionError {
/// An internal implementation error occurred.
#[error("{0}")]
#[error("Failed to setup a module")]
Setup(#[from] SetupError),

/// No field with the specified name was present.
Expand Down
4 changes: 2 additions & 2 deletions crates/jit/src/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ pub struct UnknownInstance {
#[derive(Error, Debug)]
pub enum ContextError {
/// An unknown instance name was used.
#[error("{0}")]
#[error("An error occured due to an unknown instance being specified")]
Instance(#[from] UnknownInstance),
/// An error occured while performing an action.
#[error("{0}")]
#[error("An error occurred while performing an action")]
Action(#[from] ActionError),
}

Expand Down
4 changes: 2 additions & 2 deletions crates/jit/src/instantiate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ pub enum SetupError {
Validate(String),

/// A wasm translation error occured.
#[error("WebAssembly compilation error: {0}")]
#[error("WebAssembly failed to compile")]
Compile(#[from] CompileError),

/// Some runtime resource was unavailable or insufficient, or the start function
/// trapped.
#[error("Instantiation error: {0}")]
#[error("Instantiation failed during setup")]
Instantiate(#[from] InstantiationError),

/// Debug information generation error occured.
Expand Down
2 changes: 1 addition & 1 deletion crates/runtime/src/instance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1289,7 +1289,7 @@ pub enum InstantiationError {
Resource(String),

/// A wasm link error occured.
#[error("{0}")]
#[error("Failed to link module")]
Link(#[from] LinkError),

/// A compilation error occured.
Expand Down
6 changes: 3 additions & 3 deletions crates/wast/src/wast.rs
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ impl WastContext {
Ok(()) => bail!("{}\nexpected module to fail to build", context(span)),
Err(e) => e,
};
let error_message = err.to_string();
let error_message = format!("{:?}", err);
if !error_message.contains(&message) {
// TODO: change to bail!
println!(
Expand Down Expand Up @@ -339,7 +339,7 @@ impl WastContext {
}
Err(e) => e,
};
let error_message = err.to_string();
let error_message = format!("{:?}", err);
if !error_message.contains(&message) {
// TODO: change to bail!
println!(
Expand All @@ -360,7 +360,7 @@ impl WastContext {
Ok(()) => bail!("{}\nexpected module to fail to link", context(span)),
Err(e) => e,
};
let error_message = err.to_string();
let error_message = format!("{:?}", err);
if !error_message.contains(&message) {
bail!(
"{}\nassert_unlinkable: expected {}, got {}",
Expand Down

0 comments on commit 29c8c4f

Please sign in to comment.