mirror of
https://github.com/nushell/nushell.git
synced 2025-08-09 09:25:38 +02:00
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:
@ -125,7 +125,7 @@ pub trait Eval {
|
||||
}
|
||||
// length equality already ensured in parser
|
||||
output_rows.push(Value::record(
|
||||
Record::from_raw_cols_vals(output_headers.clone(), row),
|
||||
Record::from_raw_cols_vals_unchecked(output_headers.clone(), row),
|
||||
expr.span,
|
||||
));
|
||||
}
|
||||
|
@ -607,6 +607,20 @@ pub enum ShellError {
|
||||
first_use: Span,
|
||||
},
|
||||
|
||||
/// Attempted to create a record from different number of columns and values
|
||||
///
|
||||
/// ## Resolution
|
||||
///
|
||||
/// Check the record has the same number of columns as values
|
||||
#[error("Attempted to create a record from different number of columns and values")]
|
||||
#[diagnostic(code(nu::shell::record_cols_vals_mismatch))]
|
||||
RecordColsValsMismatch {
|
||||
#[label = "problematic value"]
|
||||
bad_value: Span,
|
||||
#[label = "attempted to create the record here"]
|
||||
creation_site: Span,
|
||||
},
|
||||
|
||||
/// An error happened while performing an external command.
|
||||
///
|
||||
/// ## Resolution
|
||||
|
@ -1,6 +1,6 @@
|
||||
use std::ops::RangeBounds;
|
||||
|
||||
use crate::Value;
|
||||
use crate::{ShellError, Span, Value};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
@ -28,14 +28,39 @@ impl Record {
|
||||
|
||||
// Constructor that checks that `cols` and `vals` are of the same length.
|
||||
//
|
||||
// WARNING! Panics with assertion failure if cols and vals have different length!
|
||||
// Should be used only when the same lengths are guaranteed!
|
||||
//
|
||||
// For perf reasons does not validate the rest of the record assumptions.
|
||||
// - unique keys
|
||||
pub fn from_raw_cols_vals(cols: Vec<String>, vals: Vec<Value>) -> Self {
|
||||
pub fn from_raw_cols_vals_unchecked(cols: Vec<String>, vals: Vec<Value>) -> Self {
|
||||
assert_eq!(cols.len(), vals.len());
|
||||
|
||||
Self { cols, vals }
|
||||
}
|
||||
|
||||
// Constructor that checks that `cols` and `vals` are of the same length.
|
||||
//
|
||||
// Returns None if cols and vals have different length.
|
||||
//
|
||||
// For perf reasons does not validate the rest of the record assumptions.
|
||||
// - unique keys
|
||||
pub fn from_raw_cols_vals(
|
||||
cols: Vec<String>,
|
||||
vals: Vec<Value>,
|
||||
input_span: Span,
|
||||
creation_site_span: Span,
|
||||
) -> Result<Self, ShellError> {
|
||||
if cols.len() == vals.len() {
|
||||
Ok(Self { cols, vals })
|
||||
} else {
|
||||
Err(ShellError::RecordColsValsMismatch {
|
||||
bad_value: input_span,
|
||||
creation_site: creation_site_span,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
pub fn iter(&self) -> Iter {
|
||||
self.into_iter()
|
||||
}
|
||||
@ -455,7 +480,7 @@ impl ExactSizeIterator for Drain<'_> {
|
||||
#[macro_export]
|
||||
macro_rules! record {
|
||||
{$($col:expr => $val:expr),+ $(,)?} => {
|
||||
$crate::Record::from_raw_cols_vals (
|
||||
$crate::Record::from_raw_cols_vals_unchecked (
|
||||
vec![$($col.into(),)+],
|
||||
vec![$($val,)+]
|
||||
)
|
||||
|
Reference in New Issue
Block a user