mirror of
https://github.com/nushell/nushell.git
synced 2025-05-07 16:32:58 +00:00
bc19be25b1
# Description
This PR uses the new plugin protocol to intelligently keep plugin
processes running in the background for further plugin calls.
Running plugins can be seen by running the new `plugin list` command,
and stopped by running the new `plugin stop` command.
This is an enhancement for the performance of plugins, as starting new
plugin processes has overhead, especially for plugins in languages that
take a significant amount of time on startup. It also enables plugins
that have persistent state between commands, making the migration of
features like dataframes and `stor` to plugins possible.
Plugins are automatically stopped by the new plugin garbage collector,
configurable with `$env.config.plugin_gc`:
```nushell
$env.config.plugin_gc = {
# Configuration for plugin garbage collection
default: {
enabled: true # true to enable stopping of inactive plugins
stop_after: 10sec # how long to wait after a plugin is inactive to stop it
}
plugins: {
# alternate configuration for specific plugins, by name, for example:
#
# gstat: {
# enabled: false
# }
}
}
```
If garbage collection is enabled, plugins will be stopped after
`stop_after` passes after they were last active. Plugins are counted as
inactive if they have no running plugin calls. Reading the stream from
the response of a plugin call is still considered to be activity, but if
a plugin holds on to a stream but the call ends without an active
streaming response, it is not counted as active even if it is reading
it. Plugins can explicitly disable the GC as appropriate with
`engine.set_gc_disabled(true)`.
The `version` command now lists plugin names rather than plugin
commands. The list of plugin commands is accessible via `plugin list`.
Recommend doing this together with #12029, because it will likely force
plugin developers to do the right thing with mutability and lead to less
unexpected behavior when running plugins nested / in parallel.
# User-Facing Changes
- new command: `plugin list`
- new command: `plugin stop`
- changed command: `version` (now lists plugin names, rather than
commands)
- new config: `$env.config.plugin_gc`
- Plugins will keep running and be reused, at least for the configured
GC period
- Plugins that used mutable state in weird ways like `inc` did might
misbehave until fixed
- Plugins can disable GC if they need to
- Had to change plugin signature to accept `&EngineInterface` so that
the GC disable feature works. #12029 does this anyway, and I'm expecting
(resolvable) conflicts with that
# Tests + Formatting
- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`
Because there is some specific OS behavior required for plugins to not
respond to Ctrl-C directly, I've developed against and tested on both
Linux and Windows to ensure that works properly.
# After Submitting
I think this probably needs to be in the book somewhere
84 lines
1.5 KiB
Rust
84 lines
1.5 KiB
Rust
mod alias;
|
|
mod break_;
|
|
mod collect;
|
|
mod const_;
|
|
mod continue_;
|
|
mod def;
|
|
mod describe;
|
|
mod do_;
|
|
mod echo;
|
|
mod error_make;
|
|
mod export;
|
|
mod export_alias;
|
|
mod export_const;
|
|
mod export_def;
|
|
mod export_extern;
|
|
mod export_module;
|
|
mod export_use;
|
|
mod extern_;
|
|
mod for_;
|
|
mod hide;
|
|
mod hide_env;
|
|
mod if_;
|
|
mod ignore;
|
|
mod lazy_make;
|
|
mod let_;
|
|
mod loop_;
|
|
mod match_;
|
|
mod module;
|
|
mod mut_;
|
|
pub(crate) mod overlay;
|
|
mod return_;
|
|
mod scope;
|
|
mod try_;
|
|
mod use_;
|
|
mod version;
|
|
mod while_;
|
|
|
|
pub use alias::Alias;
|
|
pub use break_::Break;
|
|
pub use collect::Collect;
|
|
pub use const_::Const;
|
|
pub use continue_::Continue;
|
|
pub use def::Def;
|
|
pub use describe::Describe;
|
|
pub use do_::Do;
|
|
pub use echo::Echo;
|
|
pub use error_make::ErrorMake;
|
|
pub use export::ExportCommand;
|
|
pub use export_alias::ExportAlias;
|
|
pub use export_const::ExportConst;
|
|
pub use export_def::ExportDef;
|
|
pub use export_extern::ExportExtern;
|
|
pub use export_module::ExportModule;
|
|
pub use export_use::ExportUse;
|
|
pub use extern_::Extern;
|
|
pub use for_::For;
|
|
pub use hide::Hide;
|
|
pub use hide_env::HideEnv;
|
|
pub use if_::If;
|
|
pub use ignore::Ignore;
|
|
pub use lazy_make::LazyMake;
|
|
pub use let_::Let;
|
|
pub use loop_::Loop;
|
|
pub use match_::Match;
|
|
pub use module::Module;
|
|
pub use mut_::Mut;
|
|
pub use overlay::*;
|
|
pub use return_::Return;
|
|
pub use scope::*;
|
|
pub use try_::Try;
|
|
pub use use_::Use;
|
|
pub use version::Version;
|
|
pub use while_::While;
|
|
|
|
mod plugin;
|
|
mod plugin_list;
|
|
mod plugin_stop;
|
|
mod register;
|
|
|
|
pub use plugin::PluginCommand;
|
|
pub use plugin_list::PluginList;
|
|
pub use plugin_stop::PluginStop;
|
|
pub use register::Register;
|