manually revert from serde_yml to serde_yaml (#14987)

# Description

This reverts back to serde_yaml from serde_yml.
Closes https://github.com/nushell/nushell/issues/14934

Reopen https://github.com/nushell/nushell/pull/14630

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the
tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

# After Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
This commit is contained in:
Darren Schroeder 2025-02-02 19:42:04 -06:00 committed by GitHub
parent 13d5a15f75
commit 34c09d8b35
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 67 additions and 70 deletions

28
Cargo.lock generated
View File

@ -2977,16 +2977,6 @@ dependencies = [
"vcpkg",
]
[[package]]
name = "libyml"
version = "0.0.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3302702afa434ffa30847a83305f0a69d6abd74293b6554c18ec85c7ef30c980"
dependencies = [
"anyhow",
"version_check",
]
[[package]]
name = "libz-rs-sys"
version = "0.4.1"
@ -3689,7 +3679,7 @@ dependencies = [
"serde",
"serde_json",
"serde_urlencoded",
"serde_yml",
"serde_yaml",
"sha2",
"sysinfo 0.32.1",
"tabled",
@ -6486,18 +6476,16 @@ dependencies = [
]
[[package]]
name = "serde_yml"
version = "0.0.12"
name = "serde_yaml"
version = "0.9.34+deprecated"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "59e2dd588bf1597a252c3b920e0143eb99b0f76e4e082f4c92ce34fbc9e71ddd"
checksum = "6a8b1a1a2ebf674015cc02edccce75287f1a0130d394307b36743c2f5d504b47"
dependencies = [
"indexmap",
"itoa",
"libyml",
"memchr",
"ryu",
"serde",
"version_check",
"unsafe-libyaml",
]
[[package]]
@ -7505,6 +7493,12 @@ version = "0.2.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853"
[[package]]
name = "unsafe-libyaml"
version = "0.2.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "673aac59facbab8a9007c7f6108d11f63b603f7cabff99fabf650fea5c32b861"
[[package]]
name = "untrusted"
version = "0.9.0"

View File

@ -152,7 +152,7 @@ scopeguard = { version = "1.2.0" }
serde = { version = "1.0" }
serde_json = "1.0"
serde_urlencoded = "0.7.1"
serde_yml = "0.0.12"
serde_yaml = "0.9.33"
sha2 = "0.10"
strip-ansi-escapes = "0.2.0"
syn = "2.0"

View File

@ -84,7 +84,7 @@ scopeguard = { workspace = true }
serde = { workspace = true, features = ["derive"] }
serde_json = { workspace = true, features = ["preserve_order"] }
serde_urlencoded = { workspace = true }
serde_yml = { workspace = true }
serde_yaml = { workspace = true }
sha2 = { workspace = true }
sysinfo = { workspace = true }
tabled = { workspace = true, features = ["ansi"], default-features = false }

View File

@ -72,7 +72,7 @@ impl Command for FromYml {
}
fn convert_yaml_value_to_nu_value(
v: &serde_yml::Value,
v: &serde_yaml::Value,
span: Span,
val_span: Span,
) -> Result<Value, ShellError> {
@ -83,22 +83,22 @@ fn convert_yaml_value_to_nu_value(
input_span: val_span,
};
Ok(match v {
serde_yml::Value::Bool(b) => Value::bool(*b, span),
serde_yml::Value::Number(n) if n.is_i64() => {
serde_yaml::Value::Bool(b) => Value::bool(*b, span),
serde_yaml::Value::Number(n) if n.is_i64() => {
Value::int(n.as_i64().ok_or(err_not_compatible_number)?, span)
}
serde_yml::Value::Number(n) if n.is_f64() => {
serde_yaml::Value::Number(n) if n.is_f64() => {
Value::float(n.as_f64().ok_or(err_not_compatible_number)?, span)
}
serde_yml::Value::String(s) => Value::string(s.to_string(), span),
serde_yml::Value::Sequence(a) => {
serde_yaml::Value::String(s) => Value::string(s.to_string(), span),
serde_yaml::Value::Sequence(a) => {
let result: Result<Vec<Value>, ShellError> = a
.iter()
.map(|x| convert_yaml_value_to_nu_value(x, span, val_span))
.collect();
Value::list(result?, span)
}
serde_yml::Value::Mapping(t) => {
serde_yaml::Value::Mapping(t) => {
// Using an IndexMap ensures consistent ordering
let mut collected = IndexMap::new();
@ -111,19 +111,19 @@ fn convert_yaml_value_to_nu_value(
input_span: val_span,
};
match (k, v) {
(serde_yml::Value::Number(k), _) => {
(serde_yaml::Value::Number(k), _) => {
collected.insert(
k.to_string(),
convert_yaml_value_to_nu_value(v, span, val_span)?,
);
}
(serde_yml::Value::Bool(k), _) => {
(serde_yaml::Value::Bool(k), _) => {
collected.insert(
k.to_string(),
convert_yaml_value_to_nu_value(v, span, val_span)?,
);
}
(serde_yml::Value::String(k), _) => {
(serde_yaml::Value::String(k), _) => {
collected.insert(
k.clone(),
convert_yaml_value_to_nu_value(v, span, val_span)?,
@ -132,16 +132,16 @@ fn convert_yaml_value_to_nu_value(
// Hard-code fix for cases where "v" is a string without quotations with double curly braces
// e.g. k = value
// value: {{ something }}
// Strangely, serde_yml returns
// Strangely, serde_yaml returns
// "value" -> Mapping(Mapping { map: {Mapping(Mapping { map: {String("something"): Null} }): Null} })
(serde_yml::Value::Mapping(m), serde_yml::Value::Null) => {
(serde_yaml::Value::Mapping(m), serde_yaml::Value::Null) => {
return m
.iter()
.take(1)
.collect_vec()
.first()
.and_then(|e| match e {
(serde_yml::Value::String(s), serde_yml::Value::Null) => {
(serde_yaml::Value::String(s), serde_yaml::Value::Null) => {
Some(Value::string("{{ ".to_owned() + s.as_str() + " }}", span))
}
_ => None,
@ -156,22 +156,22 @@ fn convert_yaml_value_to_nu_value(
Value::record(collected.into_iter().collect(), span)
}
serde_yml::Value::Tagged(t) => {
serde_yaml::Value::Tagged(t) => {
let tag = &t.tag;
let value = match &t.value {
serde_yml::Value::String(s) => {
serde_yaml::Value::String(s) => {
let val = format!("{} {}", tag, s).trim().to_string();
Value::string(val, span)
}
serde_yml::Value::Number(n) => {
serde_yaml::Value::Number(n) => {
let val = format!("{} {}", tag, n).trim().to_string();
Value::string(val, span)
}
serde_yml::Value::Bool(b) => {
serde_yaml::Value::Bool(b) => {
let val = format!("{} {}", tag, b).trim().to_string();
Value::string(val, span)
}
serde_yml::Value::Null => {
serde_yaml::Value::Null => {
let val = format!("{}", tag).trim().to_string();
Value::string(val, span)
}
@ -180,7 +180,7 @@ fn convert_yaml_value_to_nu_value(
value
}
serde_yml::Value::Null => Value::nothing(span),
serde_yaml::Value::Null => Value::nothing(span),
x => unimplemented!("Unsupported YAML case: {:?}", x),
})
}
@ -188,9 +188,9 @@ fn convert_yaml_value_to_nu_value(
pub fn from_yaml_string_to_value(s: &str, span: Span, val_span: Span) -> Result<Value, ShellError> {
let mut documents = vec![];
for document in serde_yml::Deserializer::from_str(s) {
let v: serde_yml::Value =
serde_yml::Value::deserialize(document).map_err(|x| ShellError::UnsupportedInput {
for document in serde_yaml::Deserializer::from_str(s) {
let v: serde_yaml::Value =
serde_yaml::Value::deserialize(document).map_err(|x| ShellError::UnsupportedInput {
msg: format!("Could not load YAML: {x}"),
input: "value originates from here".into(),
msg_span: span,
@ -393,8 +393,8 @@ mod test {
];
for test_case in test_cases {
let doc = serde_yml::Deserializer::from_str(test_case.input);
let v: serde_yml::Value = serde_yml::Value::deserialize(doc.last().unwrap()).unwrap();
let doc = serde_yaml::Deserializer::from_str(test_case.input);
let v: serde_yaml::Value = serde_yaml::Value::deserialize(doc.last().unwrap()).unwrap();
let result = convert_yaml_value_to_nu_value(&v, Span::test_data(), Span::test_data());
assert!(result.is_ok());
assert!(result.ok().unwrap() == test_case.expected.ok().unwrap());

View File

@ -51,27 +51,29 @@ pub fn value_to_yaml_value(
engine_state: &EngineState,
v: &Value,
serialize_types: bool,
) -> Result<serde_yml::Value, ShellError> {
) -> Result<serde_yaml::Value, ShellError> {
Ok(match &v {
Value::Bool { val, .. } => serde_yml::Value::Bool(*val),
Value::Int { val, .. } => serde_yml::Value::Number(serde_yml::Number::from(*val)),
Value::Filesize { val, .. } => serde_yml::Value::Number(serde_yml::Number::from(val.get())),
Value::Duration { val, .. } => serde_yml::Value::String(val.to_string()),
Value::Date { val, .. } => serde_yml::Value::String(val.to_string()),
Value::Range { .. } => serde_yml::Value::Null,
Value::Float { val, .. } => serde_yml::Value::Number(serde_yml::Number::from(*val)),
Value::Bool { val, .. } => serde_yaml::Value::Bool(*val),
Value::Int { val, .. } => serde_yaml::Value::Number(serde_yaml::Number::from(*val)),
Value::Filesize { val, .. } => {
serde_yaml::Value::Number(serde_yaml::Number::from(val.get()))
}
Value::Duration { val, .. } => serde_yaml::Value::String(val.to_string()),
Value::Date { val, .. } => serde_yaml::Value::String(val.to_string()),
Value::Range { .. } => serde_yaml::Value::Null,
Value::Float { val, .. } => serde_yaml::Value::Number(serde_yaml::Number::from(*val)),
Value::String { val, .. } | Value::Glob { val, .. } => {
serde_yml::Value::String(val.clone())
serde_yaml::Value::String(val.clone())
}
Value::Record { val, .. } => {
let mut m = serde_yml::Mapping::new();
let mut m = serde_yaml::Mapping::new();
for (k, v) in &**val {
m.insert(
serde_yml::Value::String(k.clone()),
serde_yaml::Value::String(k.clone()),
value_to_yaml_value(engine_state, v, serialize_types)?,
);
}
serde_yml::Value::Mapping(m)
serde_yaml::Value::Mapping(m)
}
Value::List { vals, .. } => {
let mut out = vec![];
@ -80,7 +82,7 @@ pub fn value_to_yaml_value(
out.push(value_to_yaml_value(engine_state, value, serialize_types)?);
}
serde_yml::Value::Sequence(out)
serde_yaml::Value::Sequence(out)
}
Value::Closure { val, .. } => {
if serialize_types {
@ -88,36 +90,36 @@ pub fn value_to_yaml_value(
if let Some(span) = block.span {
let contents_bytes = engine_state.get_span_contents(span);
let contents_string = String::from_utf8_lossy(contents_bytes);
serde_yml::Value::String(contents_string.to_string())
serde_yaml::Value::String(contents_string.to_string())
} else {
serde_yml::Value::String(format!(
serde_yaml::Value::String(format!(
"unable to retrieve block contents for yaml block_id {}",
val.block_id.get()
))
}
} else {
serde_yml::Value::Null
serde_yaml::Value::Null
}
}
Value::Nothing { .. } => serde_yml::Value::Null,
Value::Nothing { .. } => serde_yaml::Value::Null,
Value::Error { error, .. } => return Err(*error.clone()),
Value::Binary { val, .. } => serde_yml::Value::Sequence(
Value::Binary { val, .. } => serde_yaml::Value::Sequence(
val.iter()
.map(|x| serde_yml::Value::Number(serde_yml::Number::from(*x)))
.map(|x| serde_yaml::Value::Number(serde_yaml::Number::from(*x)))
.collect(),
),
Value::CellPath { val, .. } => serde_yml::Value::Sequence(
Value::CellPath { val, .. } => serde_yaml::Value::Sequence(
val.members
.iter()
.map(|x| match &x {
PathMember::String { val, .. } => Ok(serde_yml::Value::String(val.clone())),
PathMember::String { val, .. } => Ok(serde_yaml::Value::String(val.clone())),
PathMember::Int { val, .. } => {
Ok(serde_yml::Value::Number(serde_yml::Number::from(*val)))
Ok(serde_yaml::Value::Number(serde_yaml::Number::from(*val)))
}
})
.collect::<Result<Vec<serde_yml::Value>, ShellError>>()?,
.collect::<Result<Vec<serde_yaml::Value>, ShellError>>()?,
),
Value::Custom { .. } => serde_yml::Value::Null,
Value::Custom { .. } => serde_yaml::Value::Null,
})
}
@ -135,9 +137,9 @@ fn to_yaml(
let value = input.into_value(head)?;
let yaml_value = value_to_yaml_value(engine_state, &value, serialize_types)?;
match serde_yml::to_string(&yaml_value) {
Ok(serde_yml_string) => {
Ok(Value::string(serde_yml_string, head)
match serde_yaml::to_string(&yaml_value) {
Ok(serde_yaml_string) => {
Ok(Value::string(serde_yaml_string, head)
.into_pipeline_data_with_metadata(Some(metadata)))
}
_ => Ok(Value::error(

View File

@ -50,6 +50,7 @@ fn convert_dict_to_yaml_with_integer_floats_key() {
}
#[test]
#[ignore]
fn convert_bool_to_yaml_in_yaml_spec_1_2() {
let actual = nu!(pipeline(
r#"