Skip to content

fix: some document error messages didnt specify the corresponding property #1873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 16, 2024
Merged

fix: some document error messages didnt specify the corresponding property #1873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6aa5373
fix: some document error messages didnt specify the corresponding pro…
pauldelucia Jun 4, 2024
509f966
Merge branch 'v1.0-dev' into fix/error-message-improvements
QuantumExplorer Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 25 additions & 14 deletions packages/rs-dpp/src/data_contract/document_type/property/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@
r_vec.extend(vec);
Ok(r_vec)
} else {
Err(get_field_type_matching_error().into())
Err(get_field_type_matching_error(&value).into())
}
}
DocumentPropertyType::Date => {
Expand Down Expand Up @@ -616,7 +616,9 @@
Ok(r_vec)
}
DocumentPropertyType::Boolean => {
let value_as_boolean = value.as_bool().ok_or_else(get_field_type_matching_error)?;
let value_as_boolean = value
.as_bool()
.ok_or_else(|| get_field_type_matching_error(&value))?;
// 0 means does not exist
if value_as_boolean {
Ok(vec![1]) // 1 is true
Expand Down Expand Up @@ -652,7 +654,7 @@
len_prepended_vec.append(&mut r_vec);
Ok(len_prepended_vec)
} else {
Err(get_field_type_matching_error().into())
Err(get_field_type_matching_error(&value).into())
}
}
DocumentPropertyType::Array(array_field_type) => {
Expand All @@ -667,7 +669,7 @@
})?;
Ok(r_vec)
} else {
Err(get_field_type_matching_error().into())
Err(get_field_type_matching_error(&value).into())
}
}
DocumentPropertyType::VariableTypeArray(_) => Err(ProtocolError::DataContractError(
Expand All @@ -688,7 +690,9 @@
}
return match self {
DocumentPropertyType::String(_) => {
let value_as_text = value.as_text().ok_or_else(get_field_type_matching_error)?;
let value_as_text = value
.as_text()
.ok_or_else(|| get_field_type_matching_error(value))?;
let vec = value_as_text.as_bytes().to_vec();
let mut r_vec = vec.len().encode_var_vec();
r_vec.extend(vec);
Expand Down Expand Up @@ -728,7 +732,9 @@
},
DocumentPropertyType::Identifier => Ok(value.to_identifier_bytes()?),
DocumentPropertyType::Boolean => {
let value_as_boolean = value.as_bool().ok_or_else(get_field_type_matching_error)?;
let value_as_boolean = value
.as_bool()
.ok_or_else(|| get_field_type_matching_error(value))?;
// 0 means does not exist
if value_as_boolean {
Ok(vec![1]) // 1 is true
Expand All @@ -738,7 +744,7 @@
}
DocumentPropertyType::Object(inner_fields) => {
let Some(value_map) = value.as_map() else {
return Err(get_field_type_matching_error().into());
return Err(get_field_type_matching_error(value).into());
};
let value_map = Value::map_ref_into_btree_string_map(value_map)?;
let mut r_vec = vec![];
Expand Down Expand Up @@ -780,7 +786,7 @@
})?;
Ok(r_vec)
} else {
Err(get_field_type_matching_error().into())
Err(get_field_type_matching_error(value).into())
}
}

Expand All @@ -799,7 +805,9 @@
}
match self {
DocumentPropertyType::String(_) => {
let value_as_text = value.as_text().ok_or_else(get_field_type_matching_error)?;
let value_as_text = value
.as_text()
.ok_or_else(|| get_field_type_matching_error(value))?;
let vec = value_as_text.as_bytes().to_vec();
if vec.is_empty() {
// we don't want to collide with the definition of an empty string
Expand All @@ -826,7 +834,9 @@
.to_identifier_bytes()
.map_err(ProtocolError::ValueError),
DocumentPropertyType::Boolean => {
let value_as_boolean = value.as_bool().ok_or_else(get_field_type_matching_error)?;
let value_as_boolean = value
.as_bool()
.ok_or_else(|| get_field_type_matching_error(value))?;
if value_as_boolean {
Ok(vec![1])
} else {
Expand Down Expand Up @@ -855,7 +865,7 @@
}
match self {
DocumentPropertyType::String(_) => {
if value == &vec![0] {

Check warning on line 868 in packages/rs-dpp/src/data_contract/document_type/property/mod.rs

View workflow job for this annotation

GitHub Actions / Rust packages (dpp) / Linting

taken reference of right operand 

warning: taken reference of right operand
   --> packages/rs-dpp/src/data_contract/document_type/property/mod.rs:868:20
    |
868 |                 if value == &vec![0] {
    |                    ^^^^^^^^^--------
    |                             |
    |                             help: use the right value directly: `...`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#op_ref
    = note: `#[warn(clippy::op_ref)]` on by default
// we don't want to collide with the definition of an empty string
Ok(Value::Text("".to_string()))
} else {
Expand Down Expand Up @@ -892,9 +902,9 @@
Ok(identifier.into())
}
DocumentPropertyType::Boolean => {
if value == &vec![0] {

Check warning on line 905 in packages/rs-dpp/src/data_contract/document_type/property/mod.rs

View workflow job for this annotation

GitHub Actions / Rust packages (dpp) / Linting

taken reference of right operand 

warning: taken reference of right operand
   --> packages/rs-dpp/src/data_contract/document_type/property/mod.rs:905:20
    |
905 |                 if value == &vec![0] {
    |                    ^^^^^^^^^--------
    |                             |
    |                             help: use the right value directly: `...`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#op_ref
Ok(Value::Bool(false))
} else if value == &vec![1] {

Check warning on line 907 in packages/rs-dpp/src/data_contract/document_type/property/mod.rs

View workflow job for this annotation

GitHub Actions / Rust packages (dpp) / Linting

taken reference of right operand 

warning: taken reference of right operand
   --> packages/rs-dpp/src/data_contract/document_type/property/mod.rs:907:27
    |
907 |                 } else if value == &vec![1] {
    |                           ^^^^^^^^^--------
    |                                    |
    |                                    help: use the right value directly: `...`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#op_ref
Ok(Value::Bool(true))
} else {
Err(ProtocolError::DecodingError(
Expand Down Expand Up @@ -1205,8 +1215,9 @@
}
}

fn get_field_type_matching_error() -> DataContractError {
DataContractError::ValueWrongType(
"document field type doesn't match document value".to_string(),
)
fn get_field_type_matching_error(value: &Value) -> DataContractError {
DataContractError::ValueWrongType(format!(
"document field type doesn't match \"{}\" document value",
value
))
}
5 changes: 4 additions & 1 deletion ...rc/errors/consensus/basic/document/missing_positions_in_document_type_properties_error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ use platform_value::Identifier;
PlatformSerialize,
PlatformDeserialize,
)]
#[error("missing position is not present for updated document type")]
#[error(
"position field is not present for document type \"{}\"",
document_type_name
)]
#[platform_serialize(unversioned)]
pub struct MissingPositionsInDocumentTypePropertiesError {
/*
Expand Down
Loading