fix: use environment variables to prevent command_not_found from recursing (#11090)

<!--
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

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

# 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.
-->
When the `command_not_found` hook is entered, we set an environment
variable for context. If an unknown command is encountered and the
`command_not_found` context environment variable is already present, it
implies a command in the hook closure is also not found. We stop the
recursion right there.

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
Incorrect `command_not_found` hooks can be caught without panicking.

# 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
> ```
-->
Tests are passing.

# 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:
Himadri Bhattacharjee 2024-03-22 00:42:03 +05:30 committed by GitHub
parent 1d418030e1
commit 02a920395c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -401,25 +401,41 @@ impl ExternalCommand {
let mut engine_state = engine_state.clone();
if let Some(hook) = engine_state.config.hooks.command_not_found.clone()
{
let canary = "ENTERED_COMMAND_NOT_FOUND";
let stack = &mut stack.start_capture();
if let Ok(PipelineData::Value(Value::String { val, .. }, ..)) =
eval_hook(
&mut engine_state,
stack,
None,
vec![(
"cmd_name".into(),
Value::string(
self.name.item.to_string(),
self.name.span,
),
)],
&hook,
"command_not_found",
)
{
err_str = format!("{}\n{}", err_str, val);
if stack.has_env_var(&engine_state, canary) {
return Err(ShellError::ExternalCommand {
label: "command_not_found handler could not be run".into(),
help: "make sure the command_not_found closure itself does not use unknown commands".to_string(),
span: self.name.span,
});
}
stack.add_env_var(
canary.to_string(),
Value::bool(true, Span::unknown()),
);
match eval_hook(
&mut engine_state,
stack,
None,
vec![(
"cmd_name".into(),
Value::string(self.name.item.to_string(), self.name.span),
)],
&hook,
"command_not_found",
) {
Ok(PipelineData::Value(Value::String { val, .. }, ..)) => {
err_str = format!("{}\n{}", err_str, val);
}
Err(err) => {
stack.remove_env_var(&engine_state, canary);
return Err(err);
}
_ => {}
}
stack.remove_env_var(&engine_state, canary);
}
}