Fix panic in rotate; Add safe record creation function (#11718)

<!--
if this PR closes one or more issues, you can automatically link the PR
with
them by using one of the [*linking
keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword),
e.g.
- this PR should close #xxxx
- fixes #xxxx

you can also mention related issues, PRs or discussions!
-->

# Description
<!--
Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.

Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.
-->

Fixes https://github.com/nushell/nushell/issues/11716

The problem is in our [record creation
API](0d518bf813/crates/nu-protocol/src/value/record.rs (L33))
which panics if the numbers of columns and values are different. I added
a safe variant that returns a `Result` and used it in the `rotate`
command.

## TODO in another PR:

Go through all `from_raw_cols_vals_unchecked()` (this includes the
`record!` macro which uses the unchecked version) and make sure that
either
a) it is guaranteed the number of cols and vals is the same, or
b) convert the call to `from_raw_cols_vals()`

Reason: Nushell should never panic.

# 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 std testing; testing run-tests --path
crates/nu-std"` 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:
Jakub Žádník
2024-02-03 13:23:16 +02:00
committed by GitHub
parent c7a8aac883
commit b8d37a7541
19 changed files with 107 additions and 45 deletions

View File

@ -70,7 +70,10 @@ fn horizontal_rotate_value(
HorizontalDirection::Left => vals.rotate_left(rotations),
}
Ok(Value::record(Record::from_raw_cols_vals(cols, vals), span))
Ok(Value::record(
Record::from_raw_cols_vals_unchecked(cols, vals),
span,
))
}
Value::List { vals, .. } => {
let values = vals

View File

@ -161,7 +161,7 @@ pub fn rotate(
) -> Result<PipelineData, ShellError> {
let metadata = input.metadata();
let col_given_names: Vec<String> = call.rest(engine_state, stack, 0)?;
let span = input.span();
let input_span = input.span().unwrap_or(call.head);
let mut values = input.into_iter().collect::<Vec<_>>();
let mut old_column_names = vec![];
let mut new_values = vec![];
@ -203,7 +203,7 @@ pub fn rotate(
msg: "list input is empty".to_string(),
input: "value originates from here".into(),
msg_span: call.head,
input_span: span.unwrap_or(call.head),
input_span,
});
}
@ -234,15 +234,14 @@ pub fn rotate(
}
if not_a_record {
return Ok(Value::list(
vec![Value::record(
Record::from_raw_cols_vals(new_column_names, new_values),
call.head,
)],
call.head,
)
.into_pipeline_data()
.set_metadata(metadata));
let record =
Record::from_raw_cols_vals(new_column_names, new_values, input_span, call.head)?;
return Ok(
Value::list(vec![Value::record(record, call.head)], call.head)
.into_pipeline_data()
.set_metadata(metadata),
);
}
// holder for the new records
@ -281,10 +280,11 @@ pub fn rotate(
}
res.to_vec()
};
final_values.push(Value::record(
Record::from_raw_cols_vals(new_column_names.clone(), new_vals),
call.head,
))
let record =
Record::from_raw_cols_vals(new_column_names.clone(), new_vals, input_span, call.head)?;
final_values.push(Value::record(record, call.head))
}
Ok(Value::list(final_values, call.head)