Merge pull request #1967 from CosmWasm/1760-remove-backtrace-feature

Remove backtraces feature

Author: chipshort

CHANGELOG.md

@@ -58,6 +58,12 @@ and this project adheres to
   `AnalysisReport::required_capabilities` a `BTreeSet`. ([#1949])
 - cosmwasm-std: Add `Checksum` type and change type of
   `CodeInfoResponse::checksum` to that. ([#1944])
+- cosmwasm-std: Removed `backtraces` feature, use the `RUST_BACKTRACE=1` env
+  variable instead. Error variants that previously only contained a `backtrace`
+  field with the feature enabled now always contain it. ([#1967])
+- cosmwasm-vm: Removed `backtraces` feature, use the `RUST_BACKTRACE=1` env
+  variable instead. All `VmError` variants now have a `backtrace` field.
+  ([#1967])
 
 [#1874]: https://github.com/CosmWasm/cosmwasm/pull/1874
 [#1876]: https://github.com/CosmWasm/cosmwasm/pull/1876
@@ -73,6 +79,7 @@ and this project adheres to
 [#1941]: https://github.com/CosmWasm/cosmwasm/pull/1941
 [#1944]: https://github.com/CosmWasm/cosmwasm/pull/1944
 [#1949]: https://github.com/CosmWasm/cosmwasm/pull/1949
+[#1967]: https://github.com/CosmWasm/cosmwasm/pull/1967
 
 ### Removed
 

MIGRATING.md

@@ -21,7 +21,9 @@ major releases of `cosmwasm`. Note that you can also view the
 
   If you were using cosmwasm-std's `ibc3` feature, you can remove it, as it is
   the default now. Depending on your usage, you might have to enable the
-  `stargate` feature instead, since it was previously implied by `ibc3`.
+  `stargate` feature instead, since it was previously implied by `ibc3`. Also
+  remove any uses of the `backtraces` feature. You can use a `RUST_BACKTRACE=1`
+  env variable for this now.
 
 - `ContractInfoResponse::new` now takes all fields of the response as
   parameters:
@@ -125,6 +127,14 @@ major releases of `cosmwasm`. Note that you can also view the
   +CosmosMsg::Any(AnyMsg { type_url, value })
   ```
 
+- Replace all direct construction of `StdError` with use of the corresponding
+  constructor:
+
+  ```diff
+  -StdError::GenericErr { msg }
+  +StdError::generic_err(msg)
+  ```
+
 ## 1.4.x -> 1.5.0
 
 - Update `cosmwasm-*` dependencies in Cargo.toml (skip the ones you don't use):

contracts/burner/Cargo.toml

@@ -27,9 +27,7 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# for quicker tests, cargo test --lib
-# for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
+
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/crypto-verify/Cargo.toml

@@ -27,9 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# for quicker tests, cargo test --lib
-# for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/crypto-verify/src/contract.rs

@@ -317,12 +317,13 @@ mod tests {
 
         let res = query(deps.as_ref(), mock_env(), verify_msg);
         assert!(res.is_err());
-        assert_eq!(
+        assert!(matches!(
             res.unwrap_err(),
             StdError::VerificationErr {
-                source: VerificationError::InvalidPubkeyFormat
+                source: VerificationError::InvalidPubkeyFormat,
+                ..
             }
-        )
+        ))
     }
 
     #[test]
@@ -605,12 +606,13 @@ mod tests {
         };
         let res = query(deps.as_ref(), mock_env(), verify_msg);
         assert!(res.is_err());
-        assert_eq!(
+        assert!(matches!(
             res.unwrap_err(),
             StdError::VerificationErr {
                 source: VerificationError::InvalidPubkeyFormat,
+                ..
             }
-        )
+        ))
     }
 
     #[test]
@@ -670,12 +672,13 @@ mod tests {
         };
         let res = query(deps.as_ref(), mock_env(), verify_msg);
         assert!(res.is_err());
-        assert_eq!(
+        assert!(matches!(
             res.unwrap_err(),
             StdError::VerificationErr {
-                source: VerificationError::InvalidPubkeyFormat
+                source: VerificationError::InvalidPubkeyFormat,
+                ..
             }
-        )
+        ))
     }
 
     #[test]

contracts/cyberpunk/Cargo.toml

@@ -25,8 +25,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# For quicker tests, cargo test --lib. for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/empty/Cargo.toml

@@ -27,9 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# for quicker tests, cargo test --lib
-# for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/floaty/Cargo.toml

@@ -27,8 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# For quicker tests, cargo test --lib. for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/hackatom/Cargo.toml

@@ -27,8 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# For quicker tests, cargo test --lib. for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/ibc-reflect-send/Cargo.toml

@@ -27,9 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# for quicker tests, cargo test --lib
-# for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/ibc-reflect/Cargo.toml

@@ -27,9 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# for quicker tests, cargo test --lib
-# for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/queue/Cargo.toml

@@ -27,8 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# For quicker tests, cargo test --lib. for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 # this is to demonstrate conditional entry-points for cosmwasm-plus style
 library = []
 
@@ -40,4 +38,4 @@ schemars = "0.8.3"
 serde = { version = "1.0.103", default-features = false, features = ["derive"] }
 
 [dev-dependencies]
-cosmwasm-vm = { path = "../../packages/vm", default-features = false, features = ["iterator"]  }
+cosmwasm-vm = { path = "../../packages/vm", default-features = false, features = ["iterator"] }

contracts/reflect/Cargo.toml

@@ -28,9 +28,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# for quicker tests, cargo test --lib
-# for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/staking/Cargo.toml

@@ -27,9 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# for quicker tests, cargo test --lib
-# for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

contracts/virus/Cargo.toml

@@ -27,9 +27,6 @@ overflow-checks = true
 default = []
 # Use cranelift backend instead of singlepass. This is required for development on 32 bit or ARM machines.
 cranelift = ["cosmwasm-vm/cranelift"]
-# for quicker tests, cargo test --lib
-# for more explicit tests, cargo test --features=backtraces
-backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }

docs/USING_COSMWASM_STD.md

@@ -32,15 +32,14 @@ in the dependency tree. Otherwise conflicting C exports are created.
 
 ## cosmwasm-std features
 
-The libarary comes with the following features:
+The library comes with the following features:
 
 | Feature      | Enabled by default | Description                                                               |
 | ------------ | ------------------ | ------------------------------------------------------------------------- |
 | iterator     | x                  | Storage iterators                                                         |
 | abort        | x                  | A panic handler that aborts the contract execution with a helpful message |
 | stargate     |                    | Cosmos SDK 0.40+ features and IBC                                         |
 | staking      |                    | Access to the staking module                                              |
-| backtraces   |                    | Add backtraces to errors (for unit testing)                               |
 | cosmwasm_1_1 |                    | Features that require CosmWasm 1.1+ on the chain                          |
 | cosmwasm_1_2 |                    | Features that require CosmWasm 1.2+ on the chain                          |
 | cosmwasm_1_3 |                    | Features that require CosmWasm 1.3+ on the chain                          |

packages/crypto/Cargo.toml

@@ -9,10 +9,6 @@ license = "Apache-2.0"
 
 [features]
 default = []
-# backtraces provides much better context at runtime errors (in non-wasm code)
-# at the cost of a bit of code size and performance.
-# This feature requires Rust nightly because it depends on the unstable backtrace feature.
-backtraces = []
 
 [lib]
 # See https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options

packages/crypto/src/backtrace.rs

@@ -0,0 +1,26 @@
+use core::fmt::{Debug, Display, Formatter, Result};
+use std::backtrace::Backtrace;
+
+/// This wraps an actual backtrace to achieve two things:
+/// - being able to fill this with a stub implementation in `no_std` environments
+/// - being able to use this in conjunction with [`thiserror::Error`]
+pub struct BT(Backtrace);
+
+impl BT {
+    #[track_caller]
+    pub fn capture() -> Self {
+        BT(Backtrace::capture())
+    }
+}
+
+impl Debug for BT {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
+        Debug::fmt(&self.0, f)
+    }
+}
+
+impl Display for BT {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
+        Display::fmt(&self.0, f)
+    }
+}

packages/crypto/src/errors.rs

@@ -1,5 +1,4 @@
-#[cfg(feature = "backtraces")]
-use std::backtrace::Backtrace;
+use crate::BT;
 use std::fmt::Debug;
 use thiserror::Error;
 
@@ -8,81 +7,55 @@ pub type CryptoResult<T> = core::result::Result<T, CryptoError>;
 #[derive(Error, Debug)]
 pub enum CryptoError {
     #[error("Batch verify error: {msg}")]
-    BatchErr {
-        msg: String,
-        #[cfg(feature = "backtraces")]
-        backtrace: Backtrace,
-    },
+    BatchErr { msg: String, backtrace: BT },
     #[error("Crypto error: {msg}")]
-    GenericErr {
-        msg: String,
-        #[cfg(feature = "backtraces")]
-        backtrace: Backtrace,
-    },
+    GenericErr { msg: String, backtrace: BT },
     #[error("Invalid hash format")]
-    InvalidHashFormat {
-        #[cfg(feature = "backtraces")]
-        backtrace: Backtrace,
-    },
+    InvalidHashFormat { backtrace: BT },
     #[error("Invalid public key format")]
-    InvalidPubkeyFormat {
-        #[cfg(feature = "backtraces")]
-        backtrace: Backtrace,
-    },
+    InvalidPubkeyFormat { backtrace: BT },
     #[error("Invalid signature format")]
-    InvalidSignatureFormat {
-        #[cfg(feature = "backtraces")]
-        backtrace: Backtrace,
-    },
+    InvalidSignatureFormat { backtrace: BT },
     #[error("Invalid recovery parameter. Supported values: 0 and 1.")]
-    InvalidRecoveryParam {
-        #[cfg(feature = "backtraces")]
-        backtrace: Backtrace,
-    },
+    InvalidRecoveryParam { backtrace: BT },
 }
 
 impl CryptoError {
     pub fn batch_err(msg: impl Into<String>) -> Self {
         CryptoError::BatchErr {
             msg: msg.into(),
-            #[cfg(feature = "backtraces")]
-            backtrace: Backtrace::capture(),
+            backtrace: BT::capture(),
         }
     }
 
     pub fn generic_err(msg: impl Into<String>) -> Self {
         CryptoError::GenericErr {
             msg: msg.into(),
-            #[cfg(feature = "backtraces")]
-            backtrace: Backtrace::capture(),
+            backtrace: BT::capture(),
         }
     }
 
     pub fn invalid_hash_format() -> Self {
         CryptoError::InvalidHashFormat {
-            #[cfg(feature = "backtraces")]
-            backtrace: Backtrace::capture(),
+            backtrace: BT::capture(),
         }
     }
 
     pub fn invalid_pubkey_format() -> Self {
         CryptoError::InvalidPubkeyFormat {
-            #[cfg(feature = "backtraces")]
-            backtrace: Backtrace::capture(),
+            backtrace: BT::capture(),
         }
     }
 
     pub fn invalid_signature_format() -> Self {
         CryptoError::InvalidSignatureFormat {
-            #[cfg(feature = "backtraces")]
-            backtrace: Backtrace::capture(),
+            backtrace: BT::capture(),
         }
     }
 
     pub fn invalid_recovery_param() -> Self {
         CryptoError::InvalidRecoveryParam {
-            #[cfg(feature = "backtraces")]
-            backtrace: Backtrace::capture(),
+            backtrace: BT::capture(),
         }
     }
 

packages/crypto/src/lib.rs

@@ -2,9 +2,7 @@
 //! Please don't use any of these types directly, as
 //! they might change frequently, or be removed in the future.
 //! This crate does not adhere to semantic versioning.
-#![cfg_attr(feature = "backtraces", feature(error_generic_member_access))]
-#![cfg_attr(feature = "backtraces", feature(provide_any))]
-
+mod backtrace;
 mod ed25519;
 mod errors;
 mod identity_digest;
@@ -20,3 +18,4 @@ pub use crate::errors::{CryptoError, CryptoResult};
 pub use crate::secp256k1::{secp256k1_recover_pubkey, secp256k1_verify};
 #[doc(hidden)]
 pub use crate::secp256k1::{ECDSA_PUBKEY_MAX_LEN, ECDSA_SIGNATURE_LEN, MESSAGE_HASH_MAX_LEN};
+pub(crate) use backtrace::BT;