Skip to content

yang-push: fix clippy::result_large_err in the YANG Library fetcher #8

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.

Sign up for GitHub

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

Merged
rodonile merged 1 commit into from
Jul 28, 2026
Merged

yang-push: fix clippy::result_large_err in the YANG Library fetcher #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions crates/yang-push/src/cache/actor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Copyright (C) 2026-present The NetCalyx Authors.
// Copyright (C) 2025-present The NetGauze Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -580,7 +581,8 @@ impl<F: YangLibraryFetcher> CacheActor<F> {
);
warn!(error=%err, "cache actor worker failed to execute a task");
}
Ok(Err((subscription_info, err))) => {
Ok(Err(worker_err)) => {
let (subscription_info, err) = *worker_err;
self.stats.device_fetch_failed.add(
1,
&[
Expand Down Expand Up @@ -911,7 +913,7 @@ impl<F: YangLibraryFetcher> CacheActor<F> {
format!("{err}"),
));
self.stats.device_fetch_failed.add(1, &otl_tags);
Err((subscription_info.clone(), err.into()))
Err(Box::new((subscription_info.clone(), err.into())))
}
};
self.process_worker_result(Ok(worker_result)).await;
Expand Down Expand Up @@ -1090,7 +1092,7 @@ impl<F: YangLibraryFetcher> CacheActor<F> {
peer,
subscription_id,
);
Err((empty.clone(), err.into()))
Err(Box::new((empty.clone(), err.into())))
}
};
self.process_worker_result(Ok(worker_result)).await;
Expand Down
52 changes: 24 additions & 28 deletions crates/yang-push/src/cache/fetcher.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ use tracing::{error, info, trace, warn};

pub type FetcherResult = Result<
(SubscriptionInfo, YangLibrary, HashMap<Box<str>, Box<str>>),
(SubscriptionInfo, YangLibraryCacheError),
Box<(SubscriptionInfo, YangLibraryCacheError)>,
>;

/// Fetch YANG Library and schemas from an external source
Expand Down Expand Up @@ -180,11 +180,11 @@ impl NetconfYangLibraryFetcher {
Ok(Ok(c)) => c,
Ok(Err(err)) => {
error!(host=%host,error=%err, "error connecting to device over SSH");
return Err((subscription_info.clone(), err.into()));
return Err(Box::new((subscription_info.clone(), err.into())));
}
Err(err) => {
error!(host=%host,error=%err, "timeout while connecting to device over SSH");
return Err((subscription_info.clone(), err.into()));
return Err(Box::new((subscription_info.clone(), err.into())));
}
};
let modules = subscription_info
Expand All @@ -196,7 +196,7 @@ impl NetconfYangLibraryFetcher {
let (yang_lib, schemas) = client
.load_from_modules(&modules, &PermissiveVersionChecker)
.await
.map_err(|err| (subscription_info.clone(), err.into()))?;
.map_err(|err| Box::new((subscription_info.clone(), err.into())))?;
match tokio::time::timeout(cfg.timeout, client.close()).await {
Ok(Ok(_)) => {
info!(host=%host,"SSH connection closed successfully");
Expand Down Expand Up @@ -260,22 +260,22 @@ impl NetconfYangLibraryFetcher {
Ok(Ok(c)) => c,
Ok(Err(err)) => {
error!(host=%host,error=%err, "error connecting to device over SSH");
return Err((empty, err.into()));
return Err(Box::new((empty, err.into())));
}
Err(err) => {
error!(host=%host,error=%err, "timeout while connecting to device over SSH");
return Err((empty, err.into()));
return Err(Box::new((empty, err.into())));
}
};

let subscription = client
.get_yang_push_subscription_by_id(subscription_id)
.await
.map_err(|err| (empty.clone(), err.into()))?;
.map_err(|err| Box::new((empty.clone(), err.into())))?;
let router_yang_library = client
.get_yang_library()
.await
.map_err(|err| (empty.clone(), err.into()))?;
.map_err(|err| Box::new((empty.clone(), err.into())))?;

let modules = if let Some(modules) = &subscription.module_version {
modules.clone().to_vec()
Expand All @@ -286,12 +286,12 @@ impl NetconfYangLibraryFetcher {
StreamSelectionFilterObjects::ByReference(name) => {
// references are resolved in the NETCONF client,
// if we reach this point, there must be a misconfigured router,
return Err((
return Err(Box::new((
empty,
YangLibraryCacheError::IoError(std::io::Error::other(format!(
"cannot fetch YANG Library for stream selection filter by reference for {name}"
))),
));
)));
}
StreamSelectionFilterObjects::WithInSubscription(filter) => {
(DatastoreName::Running, filter.namespaces())
Expand All @@ -300,12 +300,12 @@ impl NetconfYangLibraryFetcher {
}
Target::Datastore(datastore_target) => match &datastore_target.selection {
DatastoreSelectionFilterObjects::ByReference(name) => {
return Err((
return Err(Box::new((
empty,
YangLibraryCacheError::IoError(std::io::Error::other(format!(
"cannot fetch YANG Library for datastore selection filter by reference for {name}"
))),
));
)));
}
DatastoreSelectionFilterObjects::WithInSubscription(filter) => {
(datastore_target.datastore.clone(), filter.namespaces())
Expand All @@ -314,7 +314,7 @@ impl NetconfYangLibraryFetcher {
};
let mut ret = Vec::with_capacity(namespaces.len());
for (_prefix, namespace) in namespaces {
let module = router_yang_library.find_module_by_datastore_and_ns(&ds_name, namespace).ok_or_else(|| (empty.clone(), YangLibraryCacheError::IoError(std::io::Error::other(format!("module with namespace {namespace} not found in YANG Library for datastore {ds_name}")))))?;
let module = router_yang_library.find_module_by_datastore_and_ns(&ds_name, namespace).ok_or_else(|| Box::new((empty.clone(), YangLibraryCacheError::IoError(std::io::Error::other(format!("module with namespace {namespace} not found in YANG Library for datastore {ds_name}"))))))?;
ret.push(YangPushModuleVersion::new(
module.name().into(),
module.revision().map(|x| x.into()),
Expand All @@ -332,7 +332,7 @@ impl NetconfYangLibraryFetcher {
let (yang_lib, schemas) = client
.load_from_modules(&module_names, &PermissiveVersionChecker)
.await
.map_err(|err| (empty.clone(), err.into()))?;
.map_err(|err| Box::new((empty.clone(), err.into())))?;
match tokio::time::timeout(cfg.timeout, client.close()).await {
Ok(Ok(_)) => {
info!(host=%host,"SSH connection closed successfully");
Expand All @@ -343,12 +343,12 @@ impl NetconfYangLibraryFetcher {
}
}
let subscription_target = subscription.target.try_into().map_err(|err| {
(
Box::new((
empty,
YangLibraryCacheError::IoError(std::io::Error::other(format!(
"invalid subscription target: {err}"
))),
)
))
})?;
let subscription_info = SubscriptionInfo::new(
collector,
Expand Down Expand Up @@ -507,7 +507,6 @@ pub(crate) mod tests {
}
}

#[allow(clippy::result_large_err)]
fn get_from_cache(&self, subscription_info: SubscriptionInfo) -> FetcherResult {
info!(
peer=%subscription_info.peer(),
Expand All @@ -534,15 +533,14 @@ pub(crate) mod tests {
target=%subscription_info.target(),
"YANG Library not found in cache"
);
(
Box::new((
subscription_info.clone(),
YangLibraryCacheError::IoError(std::io::Error::other("not found")),
)
))
})?;
Ok((subscription_info, yang_lib, schemas))
}

#[allow(clippy::result_large_err)]
fn get_from_cache_by_id(&self, subscription_info: SubscriptionInfo) -> FetcherResult {
let collector = subscription_info.collector();
let interface = subscription_info.interface();
Expand All @@ -568,10 +566,10 @@ pub(crate) mod tests {
*counts.entry(subscription_info.clone()).or_default() += 1;
}
if subscription_info.is_empty() {
return Err((
return Err(Box::new((
subscription_info,
YangLibraryCacheError::IoError(std::io::Error::other("not found")),
));
)));
}
let (yang_lib, schemas) =
self.yang_libs
Expand All @@ -585,10 +583,10 @@ pub(crate) mod tests {
target=%subscription_info.target(),
"YANG Library not found in cache"
);
(
Box::new((
subscription_info.clone(),
YangLibraryCacheError::IoError(std::io::Error::other("not found")),
)
))
})?;
Ok((subscription_info, yang_lib, schemas))
}
Expand Down Expand Up @@ -657,20 +655,18 @@ mod retry_tests {
"127.0.0.1:0".parse().unwrap()
}

#[allow(clippy::result_large_err)]
fn make_ok() -> FetcherResult {
let info = SubscriptionInfo::new_empty(collector(), None, dummy_peer(), 1);
let yang_lib = YangLibrary::new("test-content-id".into(), vec![], vec![], vec![]);
Ok((info, yang_lib, HashMap::new()))
}

#[allow(clippy::result_large_err)]
fn make_err(msg: &'static str) -> FetcherResult {
let info = SubscriptionInfo::new_empty(collector(), None, dummy_peer(), 1);
Err((
Err(Box::new((
info,
YangLibraryCacheError::IoError(std::io::Error::other(msg)),
))
)))
}

/// A single attempt that succeeds immediately — no retries should happen.
Expand Down