pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-13 14:01:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore/error: remove from str conversion and add deprecation notificat… (#7472)

Browse Source 
* chore/error: remove from str conversion and add deprecation notifications

* fixup changes

* fix test looking for gone ::Msg variant

* another test fix

* one is duplicate, the other is not, so duplicates reported are n-1

* darn spaces

Co-authored-by: Andronik Ordian <write@reusable.software>

* remove pointless doc comments of error variants without any value

* low hanging fruits (for a tall person)

* moar error type variants

* avoid the storage modules for now

They are in need of a refactor, and the pain is rather large
removing all String error and DefaultError occurences.

* chore remove pointless error generic

* fix test for mocks, add a bunch of non_exhaustive

* max line width

* test fixes due to error changes

* fin

* error outputs... again

* undo stderr adjustments

* Update client/consensus/slots/src/lib.rs

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

* remove closure clutter

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

* more error types

* introduce ApiError

* extract Mock error

* ApiError refactor

* even more error types

* the last for now

* chore unused deps

* another extraction

* reduce should panic, due to extended error messages

* error test happiness

* shift error lines by one

* doc tests

* white space

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

* Into -> From

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

* remove pointless codec

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

* avoid pointless self import

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

Co-authored-by: Bernhard Schuster <bernhard@parity.io>
Co-authored-by: Andronik Ordian <write@reusable.software>
Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
This commit is contained in:
Bernhard Schuster
2020-11-27 19:37:53 +01:00
committed by GitHub
parent 6722a83ba6
commit 8c7d217091
48 changed files with 500 additions and 350 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/primitives/api/Cargo.toml
+2
View File
@@ -21,6 +21,7 @@ sp-runtime = { version = "2.0.0", default-features = false, path = "../runtime"
sp-version = { version = "2.0.0", default-features = false, path = "../version" }
sp-state-machine = { version = "0.8.0", optional = true, path = "../../primitives/state-machine" }
hash-db = { version = "0.15.2", optional = true }
thiserror = { version = "1.0.21", optional = true }
[dev-dependencies]
sp-test-primitives = { version = "2.0.0", path = "../test-primitives" }
@@ -35,4 +36,5 @@ std = [
"sp-state-machine",
"sp-version/std",
"hash-db",
"thiserror",
]
substrate/primitives/api/proc-macro/src/decl_runtime_apis.rs
+1 -7
View File
@@ -708,13 +708,7 @@ impl<'a> ToClientSideDecl<'a> {
},
#crate_::NativeOrEncoded::Encoded(r) => {
<#ret_type as #crate_::Decode>::decode(&mut &r[..])
.map_err(|err|
format!(
"Failed to decode result of `{}`: {}",
#function_name,
err.what(),
).into()
)
.map_err(|err| { #crate_::ApiError::new(#function_name, err).into() })
}
}
)
substrate/primitives/api/proc-macro/src/mock_impl_runtime_apis.rs
+3 -1
View File
@@ -69,7 +69,9 @@ fn implement_common_api_traits(
) -> Result<TokenStream> {
let crate_ = generate_crate_access(HIDDEN_INCLUDES_ID);
let error_type = error_type.map(|e| quote!(#e)).unwrap_or_else(|| quote!(String));
let error_type = error_type
.map(|e| quote!(#e))
.unwrap_or_else(|| quote!( #crate_::ApiError ) );
// Quote using the span from `error_type` to generate nice error messages when the type is
// not implementing a trait or similar.
substrate/primitives/api/src/lib.rs
+38 -6
View File
@@ -74,6 +74,7 @@ use sp_core::OpaqueMetadata;
#[cfg(feature = "std")]
use std::{panic::UnwindSafe, cell::RefCell};
/// Maximum nesting level for extrinsics.
pub const MAX_EXTRINSIC_DEPTH: u32 = 256;
@@ -288,7 +289,7 @@ pub use sp_api_proc_macro::impl_runtime_apis;
/// /// Sets the error type that is being used by the mock implementation.
/// /// The error type is used by all runtime apis. It is only required to
/// /// be specified in one trait implementation.
/// type Error = String;
/// type Error = sp_api::ApiError;
///
/// fn build_block() -> Block {
/// unimplemented!("Not Required in tests")
@@ -315,6 +316,7 @@ pub use sp_api_proc_macro::impl_runtime_apis;
/// # use sp_runtime::{traits::Block as BlockT, generic::BlockId};
/// # use sp_test_primitives::Block;
/// # use sp_core::NativeOrEncoded;
/// # use codec;
/// #
/// # sp_api::decl_runtime_apis! {
/// # /// Declare the api trait.
@@ -331,15 +333,15 @@ pub use sp_api_proc_macro::impl_runtime_apis;
///
/// sp_api::mock_impl_runtime_apis! {
/// impl Balance<Block> for MockApi {
/// type Error = String;
/// type Error = sp_api::ApiError;
/// #[advanced]
/// fn get_balance(&self, at: &BlockId<Block>) -> Result<NativeOrEncoded<u64>, String> {
/// fn get_balance(&self, at: &BlockId<Block>) -> Result<NativeOrEncoded<u64>, Self::Error> {
/// println!("Being called at: {}", at);
///
/// Ok(self.balance.into())
/// }
/// #[advanced]
/// fn set_balance(at: &BlockId<Block>, val: u64) -> Result<NativeOrEncoded<()>, String> {
/// fn set_balance(at: &BlockId<Block>, val: u64) -> Result<NativeOrEncoded<()>, Self::Error> {
/// if let BlockId::Number(1) = at {
/// println!("Being called to set balance to: {}", val);
/// }
@@ -392,12 +394,42 @@ pub trait ConstructRuntimeApi<Block: BlockT, C: CallApiAt<Block>> {
fn construct_runtime_api<'a>(call: &'a C) -> ApiRef<'a, Self::RuntimeApi>;
}
/// An error describing which API call failed.
#[cfg_attr(feature = "std", derive(Debug, thiserror::Error, Eq, PartialEq))]
#[cfg_attr(feature = "std", error("Failed to execute API call {tag}"))]
#[cfg(feature = "std")]
pub struct ApiError {
tag: &'static str,
#[source]
error: codec::Error,
}
#[cfg(feature = "std")]
impl From<(&'static str, codec::Error)> for ApiError {
fn from((tag, error): (&'static str, codec::Error)) -> Self {
Self {
tag,
error,
}
}
}
#[cfg(feature = "std")]
impl ApiError {
pub fn new(tag: &'static str, error: codec::Error) -> Self {
Self {
tag,
error,
}
}
}
/// Extends the runtime api traits with an associated error type. This trait is given as super
/// trait to every runtime api trait.
#[cfg(feature = "std")]
pub trait ApiErrorExt {
/// Error type used by the runtime apis.
type Error: std::fmt::Debug + From<String>;
type Error: std::fmt::Debug + From<ApiError>;
}
/// Extends the runtime api implementation with some common functionality.
@@ -506,7 +538,7 @@ pub struct CallApiAtParams<'a, Block: BlockT, C, NC, Backend: StateBackend<HashF
#[cfg(feature = "std")]
pub trait CallApiAt<Block: BlockT> {
/// Error type used by the implementation.
type Error: std::fmt::Debug + From<String>;
type Error: std::fmt::Debug + From<ApiError>;
/// The state backend that is used to store the block states.
type StateBackend: StateBackend<HashFor<Block>>;
substrate/primitives/api/test/tests/decl_and_impl.rs
+18 -4
View File
@@ -17,6 +17,7 @@
use sp_api::{
RuntimeApiInfo, decl_runtime_apis, impl_runtime_apis, mock_impl_runtime_apis,
ApiError,
ApiExt,
};
use sp_runtime::{traits::{GetNodeBlockType, Block as BlockT}, generic::BlockId};
@@ -103,17 +104,27 @@ mock_impl_runtime_apis! {
}
#[advanced]
fn same_name(_: &BlockId<Block>) -> std::result::Result<NativeOrEncoded<()>, String> {
fn same_name(_: &BlockId<Block>) ->
std::result::Result<
NativeOrEncoded<()>,
ApiError
>
{
Ok(().into())
}
#[advanced]
fn wild_card(at: &BlockId<Block>, _: u32) -> std::result::Result<NativeOrEncoded<()>, String> {
fn wild_card(at: &BlockId<Block>, _: u32) ->
std::result::Result<
NativeOrEncoded<()>,
ApiError
>
{
if let BlockId::Number(1337) = at {
// yeah
Ok(().into())
} else {
Err("Ohh noooo".into())
Err(ApiError::new("MockApi", codec::Error::from("Ohh noooo")))
}
}
}
@@ -197,5 +208,8 @@ fn mock_runtime_api_works_with_advanced() {
Api::<Block>::same_name(&mock, &BlockId::Number(0)).unwrap();
mock.wild_card(&BlockId::Number(1337), 1).unwrap();
assert_eq!(String::from("Ohh noooo"), mock.wild_card(&BlockId::Number(1336), 1).unwrap_err());
assert_eq!(
ApiError::new("MockApi", ::codec::Error::from("Ohh noooo")),
mock.wild_card(&BlockId::Number(1336), 1).unwrap_err()
);
}
substrate/primitives/api/test/tests/ui/mock_advanced_block_id_by_value.rs
+2 -1
View File
@@ -1,4 +1,5 @@
use substrate_test_runtime_client::runtime::Block;
use sp_api::ApiError;
sp_api::decl_runtime_apis! {
pub trait Api {
@@ -11,7 +12,7 @@ struct MockApi;
sp_api::mock_impl_runtime_apis! {
impl Api<Block> for MockApi {
#[advanced]
fn test(&self, _: BlockId<Block>) -> Result<sp_core::NativeOrEncoded<()>, String> {
fn test(&self, _: BlockId<Block>) -> Result<sp_core::NativeOrEncoded<()>, ApiError> {
Ok(().into())
}
}
substrate/primitives/api/test/tests/ui/mock_advanced_block_id_by_value.stderr
+7 -7
View File
@@ -1,13 +1,13 @@
error: `BlockId` needs to be taken by reference and not by value!
--> $DIR/mock_advanced_block_id_by_value.rs:11:1
--> $DIR/mock_advanced_block_id_by_value.rs:12:1
|
11 | / sp_api::mock_impl_runtime_apis! {
12 | | impl Api<Block> for MockApi {
13 | | #[advanced]
14 | | fn test(&self, _: BlockId<Block>) -> Result<sp_core::NativeOrEncoded<()>, String> {
12 | / sp_api::mock_impl_runtime_apis! {
13 | | impl Api<Block> for MockApi {
14 | | #[advanced]
15 | | fn test(&self, _: BlockId<Block>) -> Result<sp_core::NativeOrEncoded<()>, ApiError> {
... |
17 | | }
18 | | }
18 | | }
19 | | }
| |_^
|
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
substrate/primitives/api/test/tests/ui/mock_advanced_missing_blockid.rs
+2 -1
View File
@@ -1,4 +1,5 @@
use substrate_test_runtime_client::runtime::Block;
use sp_api::ApiError;
sp_api::decl_runtime_apis! {
pub trait Api {
@@ -11,7 +12,7 @@ struct MockApi;
sp_api::mock_impl_runtime_apis! {
impl Api<Block> for MockApi {
#[advanced]
fn test(&self) -> Result<sp_core::NativeOrEncoded<()>, String> {
fn test(&self) -> Result<sp_core::NativeOrEncoded<()>, ApiError> {
Ok(().into())
}
}
substrate/primitives/api/test/tests/ui/mock_advanced_missing_blockid.stderr
+2 -2
View File
@@ -1,5 +1,5 @@
error: If using the `advanced` attribute, it is required that the function takes at least one argument, the `BlockId`.
--> $DIR/mock_advanced_missing_blockid.rs:14:3
--> $DIR/mock_advanced_missing_blockid.rs:15:3
|
14 | fn test(&self) -> Result<sp_core::NativeOrEncoded<()>, String> {
15 | fn test(&self) -> Result<sp_core::NativeOrEncoded<()>, ApiError> {
| ^^
substrate/primitives/api/test/tests/ui/mock_only_one_error_type.stderr
+4 -4
View File
@@ -10,16 +10,16 @@ error: First error type was declared here.
17 | type Error = u32;
| ^^^
error[E0277]: the trait bound `u32: std::convert::From<std::string::String>` is not satisfied
error[E0277]: the trait bound `u32: std::convert::From<sp_api_hidden_includes_DECL_RUNTIME_APIS::sp_api::ApiError>` is not satisfied
--> $DIR/mock_only_one_error_type.rs:17:16
|
17 | type Error = u32;
| ^^^ the trait `std::convert::From<std::string::String>` is not implemented for `u32`
| ^^^ the trait `std::convert::From<sp_api_hidden_includes_DECL_RUNTIME_APIS::sp_api::ApiError>` is not implemented for `u32`
|
::: $WORKSPACE/primitives/api/src/lib.rs
|
| type Error: std::fmt::Debug + From<String>;
| ------------ required by this bound in `sp_api_hidden_includes_DECL_RUNTIME_APIS::sp_api::ApiErrorExt`
| type Error: std::fmt::Debug + From<ApiError>;
| -------------- required by this bound in `sp_api_hidden_includes_DECL_RUNTIME_APIS::sp_api::ApiErrorExt`
|
= help: the following implementations were found:
<u32 as std::convert::From<bool>>