knope 0.23.0

A command line tool for automating common development tasks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use miette::Diagnostic;
use reessaie::{
    RetryAfterMiddleware, RetryAfterPolicy,
    reqwest_retry::{
        DefaultRetryableStrategy, Retryable, RetryableStrategy, policies::ExponentialBackoff,
    },
};
use reqwest::{Response, StatusCode, header::RETRY_AFTER};
use reqwest_middleware::ClientBuilder;
use thiserror::Error;
use tracing::warn;

pub(crate) type Client = reqwest_middleware::ClientWithMiddleware;
pub(crate) type Error = reqwest_middleware::Error;

/// Create a standard HTTP client to use for all HTTP requests.
///
/// `missing_token_env_var` logs warnings for the user if they are being rate-limited due to making
///   anonymous requests (especially for GitHub).
pub(crate) fn http_client(
    missing_token_env_var: Option<&'static str>,
) -> Result<Client, ClientCreationError> {
    let client = reqwest::Client::builder()
        .user_agent("Knope")
        .build()
        .map_err(ClientCreationError)?;
    let retry_policy = RetryAfterPolicy::with_policy_and_strategy(
        ExponentialBackoff::builder().build_with_max_retries(5),
        RateLimitLoggingStrategy {
            missing_token_env_var,
        },
    );
    Ok(ClientBuilder::new(client)
        .with(RetryAfterMiddleware::new_with_policy(retry_policy))
        .build())
}

#[derive(Debug, Diagnostic, Error)]
#[error("Failed to create client")]
#[diagnostic(help(
    "This is a bug, please report it at https://github.com/knope-dev/knope/issues/new"
))]
pub(crate) struct ClientCreationError(#[source] reqwest::Error);

pub async fn handle_response(
    response: Result<Response, reqwest_middleware::Error>,
    service: String,
    activity: String,
) -> Result<Response, ApiRequestError> {
    let response = match response {
        Ok(response) => response,
        Err(source) => {
            return Err(ApiRequestError {
                service,
                err: source.to_string(),
                activity,
            });
        }
    };
    handle_status(response, service, activity).await
}

async fn handle_status(
    response: Response,
    service: String,
    activity: String,
) -> Result<Response, ApiRequestError> {
    if let Err(status_err) = response.error_for_status_ref() {
        return Err(ApiRequestError {
            service,
            err: format!(
                "{status_err} with body: {}",
                response.text().await.unwrap_or_default()
            ),
            activity,
        });
    }
    Ok(response)
}

#[derive(Clone, Debug, Diagnostic, Error)]
#[error("Trouble communicating with {service} while {activity}: {err}")]
#[diagnostic(
    code(api_request_error),
    help(
        "There was a problem communicating with {service}, this may be a network issue or a permissions issue."
    )
)]
pub(crate) struct ApiRequestError {
    pub(crate) service: String,
    pub(crate) err: String,
    pub(crate) activity: String,
}

#[derive(Clone, Copy, Debug, Default)]
struct RateLimitLoggingStrategy {
    missing_token_env_var: Option<&'static str>,
}

impl RetryableStrategy for RateLimitLoggingStrategy {
    fn handle(&self, res: &Result<Response, reqwest_middleware::Error>) -> Option<Retryable> {
        if let Ok(response) = res
            && response.status() == StatusCode::TOO_MANY_REQUESTS
            && let Some(retry_after) = response.headers().get(RETRY_AFTER)
            && let Ok(retry_after) = retry_after.to_str()
        {
            if let Ok(delay_secs) = retry_after.parse::<u64>() {
                warn!("API rate limited; retrying in {delay_secs} seconds");
            } else {
                warn!("API rate limited; retrying after {retry_after}");
            }
            if let Some(missing_token_env_var) = self.missing_token_env_var {
                warn!(
                    "To increase your rate limit, set the {missing_token_env_var} environment variable"
                );
            }
        }
        DefaultRetryableStrategy.handle(res)
    }
}