Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make sure that list of plugins is sorted and unique #5395

Merged
merged 15 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 46 additions & 9 deletions forc/src/cli/commands/plugins.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
use crate::cli::PluginsCommand;
use anyhow::anyhow;
use clap::Parser;
use forc_tracing::println_warning;
use forc_util::ForcResult;
use std::path::{Path, PathBuf};
use std::{
collections::HashMap,
path::{Path, PathBuf},
};
use tracing::info;

/// Find all forc plugins available via `PATH`.
Expand All @@ -18,15 +22,52 @@ pub struct Command {
describe: bool,
}

fn get_file_name(path: &Path) -> String {
crodas marked this conversation as resolved.
Show resolved Hide resolved
if let Some(path_str) = path.file_name().and_then(|path_str| path_str.to_str()) {
path_str.to_owned()
} else {
path.display().to_string()
}
}

pub(crate) fn exec(command: PluginsCommand) -> ForcResult<()> {
let PluginsCommand {
print_full_path,
describe,
} = command;

let mut plugins = crate::cli::plugin::find_all()
.map(|path| {
get_plugin_info(path.clone(), print_full_path, describe).map(|info| (path, info))
})
.collect::<Result<Vec<(_, _)>, _>>()?
.into_iter()
.fold(HashMap::new(), |mut acc, (path, content)| {
let bin_name = get_file_name(&path);
acc.entry(bin_name.clone())
.or_insert_with(|| (bin_name, vec![], content.clone()))
.1
.push(path);
acc
})
.into_values()
.map(|(bin_name, mut paths, content)| {
paths.sort();
paths.dedup();
(bin_name, paths, content)
crodas marked this conversation as resolved.
Show resolved Hide resolved
})
.collect::<Vec<_>>();
plugins.sort_by(|a, b| a.0.cmp(&b.0));

info!("Installed Plugins:");
for path in crate::cli::plugin::find_all() {
info!("{}", print_plugin(path, print_full_path, describe)?);
for plugin in plugins {
info!("{}", plugin.2);
if plugin.1.len() > 1 {
println_warning(&format!("Multiple path found for {}", plugin.0));
crodas marked this conversation as resolved.
Show resolved Hide resolved
for path in plugin.1 {
println_warning(&format!(" {}", path.display()));
}
}
}
Ok(())
}
Expand Down Expand Up @@ -72,11 +113,7 @@ fn format_print_description(
let display = if print_full_path {
path.display().to_string()
} else {
path.file_name()
.expect("Failed to read file name")
.to_str()
.expect("Failed to print file name")
.to_string()
get_file_name(&path)
};

let description = parse_description_for_plugin(&path);
Expand All @@ -94,7 +131,7 @@ fn format_print_description(
/// paths yielded from plugin::find_all(), as well as that the file names are in valid
/// unicode format since file names should be prefixed with `forc-`. Should one of these 2
/// assumptions fail, this function panics.
fn print_plugin(path: PathBuf, print_full_path: bool, describe: bool) -> ForcResult<String> {
fn get_plugin_info(path: PathBuf, print_full_path: bool, describe: bool) -> ForcResult<String> {
format_print_description(path, print_full_path, describe)
.map_err(|e| anyhow!("Could not get plugin info: {}", e.as_ref()).into())
}
2 changes: 1 addition & 1 deletion forc/src/cli/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ pub async fn run_cli() -> ForcResult<()> {
Forc::ContractId(command) => contract_id::exec(command),
Forc::PredicateRoot(command) => predicate_root::exec(command),
Forc::Plugin(args) => {
let output = plugin::execute_external_subcommand(args)?;
let output = plugin::execute_external_subcommand(args, opt.silent)?;
let code = output
.status
.code()
Expand Down
18 changes: 17 additions & 1 deletion forc/src/cli/plugin.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
//! Items related to plugin support for `forc`.

use anyhow::{bail, Result};
use forc_tracing::println_warning;
use std::{
env, fs,
path::{Path, PathBuf},
Expand All @@ -14,14 +15,29 @@ use std::{
///
/// E.g. given `foo bar baz` where `foo` is an unrecognized subcommand to `forc`, tries to execute
/// `forc-foo bar baz`.
pub(crate) fn execute_external_subcommand(args: Vec<String>) -> Result<process::Output> {
pub(crate) fn execute_external_subcommand(
args: Vec<String>,
silent: bool,
) -> Result<process::Output> {
let cmd = args.get(0).expect("`args` must not be empty");
let args = &args[1..];
let path = find_external_subcommand(cmd);
let command = match path {
Some(command) => command,
None => bail!("no such subcommand: `{}`", cmd),
};

if let Ok(forc_path) = std::env::current_exe() {
kayagokalp marked this conversation as resolved.
Show resolved Hide resolved
if !silent && command.parent() != forc_path.parent() {
println_warning(&format!(
"The {} ({}) plugin is in a different directory than forc ({})\n",
cmd,
command.display(),
forc_path.display(),
));
}
}

let output = process::Command::new(command)
.stdin(process::Stdio::inherit())
.stdout(process::Stdio::inherit())
Expand Down
Loading