holdon 0.4.0

Wait for anything. Know why if it doesn't.
Documentation 
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

use std::time::Instant;

use mongodb::Client;
use mongodb::bson::doc;
use mongodb::options::ClientOptions;
use tokio::time::timeout;
use url::Url;

use super::hint::{Hintable, hints};
use super::{AttemptCtx, err_stage, install_rustls_provider_once, ok_stage};
use crate::diagnostic::{Stage, StageKind};
use crate::util::{format_error_chain, redact_in};

impl Hintable for mongodb::error::Error {
    fn hint(&self) -> Option<&'static str> {
        use mongodb::error::ErrorKind;
        match self.kind.as_ref() {
            ErrorKind::Authentication { .. } => Some(hints::MONGODB_AUTH),
            ErrorKind::InvalidTlsConfig { .. } => Some(hints::MONGODB_TLS),
            ErrorKind::ServerSelection { message, .. } => {
                let lower = message.to_ascii_lowercase();
                if lower.contains("no primary")
                    || lower.contains("replicasetnoprimary")
                    || lower.contains("replica set")
                {
                    Some(hints::MONGODB_NO_PRIMARY)
                } else {
                    Some(hints::MONGODB_NOT_READY)
                }
            }
            _ => Some(hints::MONGODB_NOT_READY),
        }
    }
}

pub(super) async fn probe(url: &Url, ctx: AttemptCtx) -> Vec<Stage> {
    install_rustls_provider_once();
    let start = Instant::now();
    let pw = url.password().unwrap_or("").to_owned();
    let has_userinfo = !pw.is_empty() || !url.username().is_empty();
    if has_userinfo && !mongo_tls_in_effect(url) {
        return vec![err_stage(
            StageKind::Mongodb,
            start.elapsed(),
            "refusing to send credentials over a non-TLS mongodb:// URL",
            Some(hints::CLEARTEXT_CREDS),
        )];
    }
    let conn_str = url.as_str().to_owned();
    let stage = match timeout(ctx.attempt_timeout, ping(&conn_str, ctx)).await {
        Ok(Ok(())) => ok_stage(StageKind::Mongodb, start.elapsed()),
        Ok(Err(e)) => {
            let hint = e.hint();
            let mut msg = format_error_chain(&e);
            if !pw.is_empty() {
                msg = redact_in(&msg, &conn_str);
                msg = redact_in(&msg, &pw);
            }
            err_stage(StageKind::Mongodb, start.elapsed(), msg, hint)
        }
        Err(_) => err_stage(
            StageKind::Mongodb,
            ctx.attempt_timeout,
            hints::TIMED_OUT,
            Some(hints::MONGODB_NOT_READY),
        ),
    };
    vec![stage]
}

fn mongo_tls_in_effect(url: &Url) -> bool {
    if url.scheme().eq_ignore_ascii_case("mongodb+srv") {
        return true;
    }
    url.query_pairs().any(|(k, v)| {
        (k.eq_ignore_ascii_case("tls") || k.eq_ignore_ascii_case("ssl"))
            && v.eq_ignore_ascii_case("true")
    })
}

async fn ping(uri: &str, ctx: AttemptCtx) -> mongodb::error::Result<()> {
    let mut opts = ClientOptions::parse(uri).await?;
    opts.connect_timeout = Some(ctx.attempt_timeout);
    opts.server_selection_timeout = Some(ctx.attempt_timeout);
    let client = Client::with_options(opts)?;
    client
        .database("admin")
        .run_command(doc! { "ping": 1 })
        .await?;
    Ok(())
}