ref: Replace failure with std::error::Error

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Unreleased
+
+**Breaking Changes**:
+
+- Usage of `failure` was removed, and all Error types were changed to only implement `std::error::Error` and related traits.
+- `symbolic-proguard` was removed in favor of the `proguard` crate. Proguard is still supported via `symbolic-cabi` and the python API however.
+
 ## 7.5.0
 
 **Changes**:

examples/addr2line/Cargo.toml

@@ -7,6 +7,6 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+anyhow = "1.0.32"
 clap = "2.33.0"
-failure = "0.1.7"
 symbolic = { path = "../../symbolic", features = ["demangle"] }

examples/addr2line/src/main.rs

@@ -1,20 +1,12 @@
 use std::borrow::Borrow;
 
+use anyhow::{Context, Result};
 use clap::{clap_app, ArgMatches};
-use failure::{Error, ResultExt};
 
 use symbolic::common::{ByteView, Name};
 use symbolic::debuginfo::{Function, Object};
 use symbolic::demangle::Demangle;
 
-fn print_error(error: &Error) {
-    eprintln!("Error: {}", error);
-
-    for cause in error.iter_causes() {
-        eprintln!("   caused by {}", cause);
-    }
-}
-
 fn print_name<'a, N: Borrow<Name<'a>>>(name: Option<N>, matches: &ArgMatches<'_>) {
     match name.as_ref().map(Borrow::borrow) {
         None => print!("??"),
@@ -36,7 +28,7 @@ fn print_range(start: u64, len: Option<u64>, matches: &ArgMatches<'_>) {
     }
 }
 
-fn resolve(function: &Function<'_>, addr: u64, matches: &ArgMatches<'_>) -> Result<bool, Error> {
+fn resolve(function: &Function<'_>, addr: u64, matches: &ArgMatches<'_>) -> Result<bool> {
     if function.address > addr || function.address + function.size <= addr {
         return Ok(false);
     }
@@ -76,7 +68,7 @@ fn resolve(function: &Function<'_>, addr: u64, matches: &ArgMatches<'_>) -> Resu
     Ok(false)
 }
 
-fn execute(matches: &ArgMatches<'_>) -> Result<(), Error> {
+fn execute(matches: &ArgMatches<'_>) -> Result<()> {
     let path = matches.value_of("path").unwrap_or("a.out");
     let view = ByteView::open(path).context("failed to open file")?;
     let object = Object::parse(&view).context("failed to parse file")?;
@@ -127,6 +119,6 @@ fn main() {
 
     match execute(&matches) {
         Ok(()) => (),
-        Err(e) => print_error(&e),
+        Err(e) => eprintln!("{:?}", e),
     };
 }

examples/dump_cfi/Cargo.toml

@@ -7,6 +7,6 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+anyhow = "1.0.32"
 clap = "2.33.0"
-failure = "0.1.7"
 symbolic = { path = "../../symbolic", features = ["minidump"] }

examples/dump_cfi/src/main.rs

@@ -1,21 +1,13 @@
 use std::path::Path;
 
+use anyhow::Result;
 use clap::{App, Arg, ArgMatches};
-use failure::Error;
 
 use symbolic::common::{ByteView, DSymPathExt};
 use symbolic::debuginfo::Object;
 use symbolic::minidump::cfi::AsciiCfiWriter;
 
-fn print_error(error: &Error) {
-    eprintln!("Error: {:#?}", error);
-
-    for cause in error.iter_causes() {
-        eprintln!("   caused by {}", cause);
-    }
-}
-
-fn dump_cfi<P: AsRef<Path>>(path: P) -> Result<(), Error> {
+fn dump_cfi<P: AsRef<Path>>(path: P) -> Result<()> {
     let path = path.as_ref();
 
     let dsym_path = path.resolve_dsym();
@@ -36,7 +28,7 @@ fn dump_cfi<P: AsRef<Path>>(path: P) -> Result<(), Error> {
     Ok(())
 }
 
-fn execute(matches: &ArgMatches<'_>) -> Result<(), Error> {
+fn execute(matches: &ArgMatches<'_>) -> Result<()> {
     let path = matches.value_of("path").unwrap();
     dump_cfi(path)
 }
@@ -56,6 +48,6 @@ fn main() {
 
     match execute(&matches) {
         Ok(()) => (),
-        Err(e) => print_error(&e),
+        Err(e) => eprintln!("{:?}", e),
     };
 }

examples/dump_sources/Cargo.toml

@@ -8,5 +8,4 @@ edition = "2018"
 
 [dependencies]
 clap = "2.33.0"
-failure = "0.1.7"
 symbolic = { path = "../../symbolic" }

examples/dump_sources/src/main.rs

@@ -1,21 +1,21 @@
 use std::path::Path;
 
 use clap::{App, Arg, ArgMatches};
-use failure::Error;
 
 use symbolic::common::{ByteView, DSymPathExt};
 use symbolic::debuginfo::sourcebundle::SourceBundleWriter;
 use symbolic::debuginfo::Archive;
 
-fn print_error(error: &Error) {
+fn print_error(mut error: &dyn std::error::Error) {
     println!("Error: {}", error);
 
-    for cause in error.iter_causes() {
-        println!("   caused by {}", cause);
+    while let Some(source) = error.source() {
+        println!("   caused by {}", source);
+        error = source;
     }
 }
 
-fn write_object_sources(path: &Path, output_path: &Path) -> Result<(), Error> {
+fn write_object_sources(path: &Path, output_path: &Path) -> Result<(), Box<dyn std::error::Error>> {
     println!("Inspecting {}", path.display());
 
     let dsym_path = path.resolve_dsym();
@@ -34,7 +34,7 @@ fn write_object_sources(path: &Path, output_path: &Path) -> Result<(), Error> {
             }
             Err(e) => {
                 print!(" - ");
-                print_error(&e.into());
+                print_error(&e);
                 continue;
             }
         }
@@ -43,18 +43,15 @@ fn write_object_sources(path: &Path, output_path: &Path) -> Result<(), Error> {
     Ok(())
 }
 
-fn execute(matches: &ArgMatches<'_>) -> Result<(), Error> {
+fn execute(matches: &ArgMatches<'_>) {
     let output_path = Path::new(matches.value_of("output").unwrap());
     for path in matches.values_of("paths").unwrap_or_default() {
-        match write_object_sources(Path::new(&path), &output_path) {
-            Ok(()) => (),
-            Err(e) => print_error(&e),
+        if let Err(e) = write_object_sources(Path::new(&path), &output_path) {
+            print_error(e.as_ref());
         }
 
         println!();
     }
-
-    Ok(())
 }
 
 fn main() {
@@ -79,8 +76,5 @@ fn main() {
         )
         .get_matches();
 
-    match execute(&matches) {
-        Ok(()) => (),
-        Err(e) => print_error(&e),
-    };
+    execute(&matches);
 }

examples/minidump_stackwalk/Cargo.toml

@@ -8,6 +8,5 @@ edition = "2018"
 
 [dependencies]
 clap = "2.33.0"
-failure = "0.1.7"
 symbolic = { path = "../../symbolic", features = ["minidump", "symcache", "demangle"] }
 walkdir = "2.3.1"

examples/minidump_stackwalk/src/main.rs

@@ -3,17 +3,17 @@ use std::io::Cursor;
 use std::path::Path;
 
 use clap::{App, Arg, ArgMatches};
-use failure::Error;
 use walkdir::WalkDir;
 
 use symbolic::common::{Arch, ByteView, InstructionInfo, SelfCell};
 use symbolic::debuginfo::{Archive, FileFormat, Object};
 use symbolic::demangle::Demangle;
 use symbolic::minidump::cfi::CfiCache;
 use symbolic::minidump::processor::{CodeModuleId, FrameInfoMap, ProcessState, StackFrame};
-use symbolic::symcache::{LineInfo, SymCache, SymCacheWriter};
+use symbolic::symcache::{LineInfo, SymCache, SymCacheError, SymCacheWriter};
 
 type SymCaches<'a> = BTreeMap<CodeModuleId, SelfCell<ByteView<'a>, SymCache<'a>>>;
+type Error = Box<dyn std::error::Error>;
 
 fn collect_referenced_objects<P, F, T>(
     path: P,
@@ -124,7 +124,7 @@ fn symbolize<'a>(
     frame: &StackFrame,
     arch: Arch,
     crashing: bool,
-) -> Result<Option<Vec<LineInfo<'a>>>, Error> {
+) -> Result<Option<Vec<LineInfo<'a>>>, SymCacheError> {
     let module = match frame.module() {
         Some(module) => module,
         None => return Ok(None),

examples/object_debug/Cargo.toml

@@ -8,5 +8,4 @@ edition = "2018"
 
 [dependencies]
 clap = "2.33.0"
-failure = "0.1.7"
 symbolic = { path = "../../symbolic" }

examples/object_debug/src/main.rs

@@ -1,20 +1,20 @@
 use std::path::Path;
 
 use clap::{App, Arg, ArgMatches};
-use failure::Error;
 
 use symbolic::common::{ByteView, DSymPathExt};
 use symbolic::debuginfo::Archive;
 
-fn print_error(error: &Error) {
+fn print_error(mut error: &dyn std::error::Error) {
     println!("Error: {}", error);
 
-    for cause in error.iter_causes() {
-        println!("   caused by {}", cause);
+    while let Some(source) = error.source() {
+        println!("   caused by {}", source);
+        error = source;
     }
 }
 
-fn inspect_object<P: AsRef<Path>>(path: P) -> Result<(), Error> {
+fn inspect_object<P: AsRef<Path>>(path: P) -> Result<(), Box<dyn std::error::Error>> {
     let path = path.as_ref();
     println!("Inspecting {}", path.display());
 
@@ -42,7 +42,7 @@ fn inspect_object<P: AsRef<Path>>(path: P) -> Result<(), Error> {
             }
             Err(e) => {
                 print!(" - ");
-                print_error(&e.into());
+                print_error(&e);
                 continue;
             }
         }
@@ -51,17 +51,14 @@ fn inspect_object<P: AsRef<Path>>(path: P) -> Result<(), Error> {
     Ok(())
 }
 
-fn execute(matches: &ArgMatches<'_>) -> Result<(), Error> {
+fn execute(matches: &ArgMatches<'_>) {
     for path in matches.values_of("paths").unwrap_or_default() {
-        match inspect_object(path) {
-            Ok(()) => (),
-            Err(e) => print_error(&e),
+        if let Err(e) = inspect_object(path) {
+            print_error(e.as_ref())
         }
 
         println!();
     }
-
-    Ok(())
 }
 
 fn main() {
@@ -78,8 +75,5 @@ fn main() {
         )
         .get_matches();
 
-    match execute(&matches) {
-        Ok(()) => (),
-        Err(e) => print_error(&e),
-    };
+    execute(&matches);
 }

examples/symcache_debug/Cargo.toml

@@ -7,6 +7,6 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+anyhow = "1.0.32"
 clap = "2.33.0"
-failure = "0.1.7"
 symbolic = { path = "../../symbolic", features = ["symcache", "demangle"] }

examples/symcache_debug/src/main.rs

@@ -3,15 +3,15 @@ use std::io::{Cursor, Write};
 use std::path::Path;
 use std::u64;
 
+use anyhow::{anyhow, Result};
 use clap::{App, Arg, ArgMatches};
-use failure::{err_msg, Error};
 
 use symbolic::common::{Arch, ByteView, DSymPathExt, Language};
 use symbolic::debuginfo::Archive;
 use symbolic::demangle::Demangle;
 use symbolic::symcache::{SymCache, SymCacheWriter};
 
-fn execute(matches: &ArgMatches) -> Result<(), Error> {
+fn execute(matches: &ArgMatches) -> Result<()> {
     let buffer;
     let symcache;
 
@@ -53,7 +53,7 @@ fn execute(matches: &ArgMatches) -> Result<(), Error> {
 
         let obj = match obj {
             Some(obj) => obj,
-            None => return Err(err_msg(format!("did not find architecture {}", arch))),
+            None => return Err(anyhow!("did not find architecture {}", arch)),
         };
 
         let writer = SymCacheWriter::write_object(obj, Cursor::new(Vec::new()))?;
@@ -73,7 +73,7 @@ fn execute(matches: &ArgMatches) -> Result<(), Error> {
         buffer = ByteView::open(file_path)?;
         symcache = SymCache::parse(&buffer)?;
     } else {
-        return Err(err_msg("No debug file or sym cache provided"));
+        return Err(anyhow!("No debug file or sym cache provided"));
     }
 
     // report

examples/unreal_engine_crash/Cargo.toml

@@ -8,5 +8,4 @@ edition = "2018"
 
 [dependencies]
 clap = "2.33.0"
-failure = "0.1.7"
 symbolic = { path = "../../symbolic", features = ["unreal"] }

examples/unreal_engine_crash/src/main.rs

@@ -3,11 +3,10 @@ use std::fs::File;
 use std::io::Read;
 
 use clap::{App, Arg, ArgMatches};
-use failure::Error;
 
 use symbolic::unreal::{Unreal4Crash, Unreal4FileType};
 
-fn execute(matches: &ArgMatches) -> Result<(), Error> {
+fn execute(matches: &ArgMatches) -> Result<(), Box<dyn std::error::Error>> {
     let crash_file_path = matches.value_of("crash_file_path").unwrap();
 
     let mut file = File::open(crash_file_path)?;

symbolic-cabi/Cargo.toml

@@ -21,7 +21,6 @@ crate-type = ["cdylib"]
 
 [dependencies]
 serde_json = "1.0.40"
-failure = "0.1.5"
 apple-crash-report-parser = { version = "0.4.0", features = ["with_serde"] }
 symbolic = { version = "7.5.0", path = "../symbolic", features = ["debuginfo", "demangle", "minidump", "proguard", "sourcemap", "symcache", "unreal-serde"] }
 proguard = { version = "4.0.1", features = ["uuid"] }