Skip to content

Commit

Permalink
feat: Add more logging to binstalk-{downloader, registry} (#1340)
Browse files Browse the repository at this point in the history
for debugging purposes.

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
  • Loading branch information
NobodyXu committed Sep 2, 2023
1 parent 3c56416 commit 3e67e36
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 6 deletions.
9 changes: 5 additions & 4 deletions crates/binstalk-downloader/src/remote.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use reqwest::{
Request,
};
use thiserror::Error as ThisError;
use tracing::{debug, info};
use tracing::{debug, info, instrument};

pub use reqwest::{header, Error as ReqwestError, Method, StatusCode};
pub use url::Url;
Expand Down Expand Up @@ -155,6 +155,7 @@ impl Client {
///
/// Return `Ok(ControlFlow::Break(response))` when succeeds and no need
/// to retry.
#[instrument]
async fn do_send_request(
&self,
request: Request,
Expand All @@ -177,7 +178,7 @@ impl Client {
let status = response.status();

let add_delay_and_continue = |response: reqwest::Response, duration| {
info!("Receiver status code {status}, will wait for {duration:#?} and retry");
info!("Received status code {status}, will wait for {duration:#?} and retry");

self.0
.service
Expand Down Expand Up @@ -237,6 +238,8 @@ impl Client {
request: Request,
error_for_status: bool,
) -> Result<reqwest::Response, Error> {
debug!("Downloading from: '{}'", request.url());

self.send_request_inner(&request)
.await
.and_then(|response| {
Expand Down Expand Up @@ -313,8 +316,6 @@ impl Client {
&self,
url: Url,
) -> Result<impl Stream<Item = Result<Bytes, Error>>, Error> {
debug!("Downloading from: '{url}'");

Ok(self.get(url).send(true).await?.bytes_stream())
}

Expand Down
3 changes: 2 additions & 1 deletion crates/binstalk-registry/src/common.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use semver::{Version, VersionReq};
use serde::Deserialize;
use serde_json::Error as JsonError;
use sha2::{Digest, Sha256};
use tracing::debug;
use tracing::{debug, instrument};

use crate::{visitor::ManifestVisitor, RegistryError};

Expand All @@ -37,6 +37,7 @@ impl DataVerifier for Sha256Digest {
}
}

#[instrument]
pub(super) async fn parse_manifest(
client: Client,
crate_name: &str,
Expand Down
3 changes: 2 additions & 1 deletion crates/binstalk-registry/src/crates_io_registry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use cargo_toml_workspace::cargo_toml::Manifest;
use compact_str::{CompactString, ToCompactString};
use semver::{Comparator, Op as ComparatorOp, Version as SemVersion, VersionReq};
use serde::Deserialize;
use tracing::debug;
use tracing::{debug, instrument};

use crate::{parse_manifest, MatchedVersion, RegistryError};

Expand Down Expand Up @@ -105,6 +105,7 @@ async fn fetch_crate_cratesio_version_matched(

/// Find the crate by name, get its latest stable version matches `version_req`,
/// retrieve its Cargo.toml and infer all its bins.
#[instrument]
pub async fn fetch_crate_cratesio_api(
client: Client,
name: &str,
Expand Down
2 changes: 2 additions & 0 deletions crates/binstalk-registry/src/git_registry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ use serde_json::{from_slice as json_from_slice, Deserializer as JsonDeserializer
use simple_git::{GitCancellationToken, GitUrl, Repository};
use tempfile::TempDir;
use tokio::task::spawn_blocking;
use tracing::instrument;
use url::Url;

use crate::{
Expand Down Expand Up @@ -96,6 +97,7 @@ impl GitRegistry {
)
}

#[instrument]
pub async fn fetch_crate_matched(
&self,
client: Client,
Expand Down
2 changes: 2 additions & 0 deletions crates/binstalk-registry/src/sparse_registry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ use compact_str::CompactString;
use semver::VersionReq;
use serde_json::Deserializer as JsonDeserializer;
use tokio::sync::OnceCell;
use tracing::instrument;
use url::Url;

use crate::{
Expand Down Expand Up @@ -77,6 +78,7 @@ impl SparseRegistry {
)
}

#[instrument]
pub async fn fetch_crate_matched(
&self,
client: Client,
Expand Down

0 comments on commit 3e67e36

Please sign in to comment.