Radish alpha
h
Radicle Heartwood Protocol & Stack
Radicle
Git (anonymous pull)
Log in to clone via SSH
REVIEW: Error::with_hint constructor
Fintan Halpenny committed 3 months ago
commit 067ff6819c5f50e8072ad088383c88c5f5736d1e
parent b6d59d9dc7169c9d0a684c700ca1f1cc2b5de36c
7 files changed +35 -32
modified crates/radicle-cli/src/commands/id.rs
@@ -135,12 +135,11 @@ pub fn run(args: Args, ctx: impl term::Context) -> anyhow::Result<()> {
                let proposal = match update::privacy_allow_list(proposal, allow, disallow) {
                    Ok(proposal) => proposal,
                    Err(e) => match e {
-
                        update::error::PrivacyAllowList::Overlapping(overlap) =>                     anyhow::bail!("`--allow` and `--disallow` must not overlap: {overlap:?}"),
-
                        update::error::PrivacyAllowList::PublicVisibility =>                         return Err(Error::WithHint {
-
                            err:
+
                        update::error::PrivacyAllowList::Overlapping(overlap) =>anyhow::bail!("`--allow` and `--disallow` must not overlap: {overlap:?}"),
+
                        update::error::PrivacyAllowList::PublicVisibility => return Err(Error::with_hint(
                            anyhow!("`--allow` and `--disallow` should only be used for private repositories"),
-
                            hint: "use `--visibility private` to make the repository private, or perhaps you meant to use `--delegate`/`--rescind`".to_string(),
-
                        }.into())
+
                            "use `--visibility private` to make the repository private, or perhaps you meant to use `--delegate`/`--rescind`")
+
                        .into())
                    }
                };
                let threshold = proposal.threshold;
modified crates/radicle-cli/src/commands/issue.rs
@@ -122,9 +122,8 @@ pub fn run(args: Args, ctx: impl term::Context) -> anyhow::Result<()> {
            let id = id.resolve(&repo.backend)?;
            let issue = issues
                .get(&id)
-
                .map_err(|e| Error::WithHint {
-
                    err: e.into(),
-
                    hint: "reset the cache with `rad issue cache` and try again".to_string(),
+
                .map_err(|e| {
+
                    Error::with_hint(e, "reset the cache with `rad issue cache` and try again")
                })?
                .context("No issue with the given ID exists")?;
            term::issue::show(&issue, &id, format, args.verbose, &profile)?;
modified crates/radicle-cli/src/commands/patch/show.rs
@@ -33,10 +33,9 @@ pub fn run(
    workdir: Option<&git::raw::Repository>,
) -> anyhow::Result<()> {
    let patches = term::cob::patches(profile, stored)?;
-
    let Some(patch) = patches.get(patch_id).map_err(|e| Error::WithHint {
-
        err: e.into(),
-
        hint: "reset the cache with `rad patch cache` and try again".to_string(),
-
    })?
+
    let Some(patch) = patches
+
        .get(patch_id)
+
        .map_err(|e| Error::with_hint(e, "reset the cache with `rad patch cache` and try again"))?
    else {
        anyhow::bail!("Patch `{patch_id}` not found");
    };
modified crates/radicle-cli/src/commands/publish.rs
@@ -25,24 +25,20 @@ pub fn run(args: Args, ctx: impl term::Context) -> anyhow::Result<()> {
    let doc = identity.doc();

    if doc.is_public() {
-
        return Err(term::Error::WithHint {
-
            err: anyhow!("repository is already public"),
-
            hint: "to announce the repository to the network, run `rad sync --inventory`"
-
                .to_string(),
-
        }
+
        return Err(term::Error::with_hint(
+
            anyhow!("repository is already public"),
+
            "to announce the repository to the network, run `rad sync --inventory`",
+
        )
        .into());
    }
    if !doc.is_delegate(&profile.id().into()) {
        return Err(anyhow!("only the repository delegate can publish it"));
    }
    if doc.delegates().len() > 1 {
-
        return Err(term::Error::WithHint {
-
            err: anyhow!(
-
                "only repositories with a single delegate can be published with this command"
-
            ),
-
            hint: "see `rad id --help` to publish repositories with more than one delegate"
-
                .to_string(),
-
        }
+
        return Err(term::Error::with_hint(
+
            anyhow!("only repositories with a single delegate can be published with this command"),
+
            "see `rad id --help` to publish repositories with more than one delegate",
+
        )
        .into());
    }
    let signer = profile.signer()?;
modified crates/radicle-cli/src/terminal.rs
@@ -45,10 +45,10 @@ impl Context for DefaultContext {
    fn profile(&self) -> Result<Profile, anyhow::Error> {
        match Profile::load() {
            Ok(profile) => Ok(profile),
-
            Err(radicle::profile::Error::NotFound(path)) => Err(args::Error::WithHint {
-
                err: anyhow::anyhow!("Radicle profile not found in '{}'.", path.display()),
-
                hint: "To setup your radicle profile, run `rad auth`.".to_string(),
-
            }
+
            Err(radicle::profile::Error::NotFound(path)) => Err(args::Error::with_hint(
+
                anyhow::anyhow!("Radicle profile not found in '{}'.", path.display()),
+
                "To setup your radicle profile, run `rad auth`.",
+
            )
            .into()),
            Err(radicle::profile::Error::LoadConfig(e)) => Err(e.into()),
            Err(e) => Err(anyhow::anyhow!("Could not load radicle profile: {e}")),
modified crates/radicle-cli/src/terminal/args.rs
@@ -11,6 +11,19 @@ pub(crate) enum Error {
    WithHint { err: anyhow::Error, hint: String },
}

+
impl Error {
+
    pub fn with_hint<E, H>(err: E, hint: H) -> Self
+
    where
+
        E: Into<anyhow::Error>,
+
        H: ToString,
+
    {
+
        Self::WithHint {
+
            err: err.into(),
+
            hint: hint.to_string(),
+
        }
+
    }
+
}
+

/// Targets used in the `block` and `unblock` commands
#[derive(Clone, Debug)]
pub(crate) enum BlockTarget {
modified crates/radicle-cli/src/terminal/cob.rs
@@ -104,10 +104,7 @@ where
fn with_hint(e: profile::Error) -> anyhow::Error {
    match e {
        profile::Error::CobsCache(cob::cache::Error::OutOfDate) => {
-
            anyhow::Error::from(terminal::args::Error::WithHint {
-
                err: e.into(),
-
                hint: MIGRATION_HINT.to_string(),
-
            })
+
            terminal::args::Error::with_hint(e, MIGRATION_HINT).into()
        }
        e => anyhow::Error::from(e),
    }