trillium-logger 0.5.4

logger for trillium.rs
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
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
121
122
123
124
125

use access_log_parser::{LogEntry, LogType, RequestResult, parse};
use std::{net::IpAddr, sync::Arc};
use time::OffsetDateTime;
use trillium::{
    KnownHeaderName::{Referer, UserAgent},
    Status, Version,
};
use trillium_logger::{ColorMode, Targetable, apache_combined, apache_common, logger};
use trillium_testing::{TestServer, harness, test};

async fn teapot(conn: trillium::Conn) -> trillium::Conn {
    conn.with_status(Status::ImATeapot).with_body("ok")
}

#[derive(Clone, Debug)]
struct TestTarget(
    Arc<(
        async_channel::Sender<String>,
        async_channel::Receiver<String>,
    )>,
);

impl Default for TestTarget {
    fn default() -> Self {
        Self(Arc::new(async_channel::unbounded()))
    }
}

impl Targetable for TestTarget {
    fn write(&self, data: String) {
        let sender = &self.0.0;
        sender.send_blocking(data).unwrap();
    }
}

impl TestTarget {
    async fn next(&self) -> String {
        self.0.1.recv().await.unwrap()
    }
}

#[test(harness)]
async fn test_apache_combined() {
    let target = TestTarget::default();
    let logger = logger()
        .with_formatter(apache_combined("request-id", "user"))
        .with_target(target.clone())
        .with_color_mode(ColorMode::Off);

    let ip = IpAddr::from([1, 2, 3, 4]);
    let handler = (logger, teapot);

    let app = TestServer::new(handler).await;

    let _ = target.next().await; // startup message

    app.get("/some/path?query")
        .with_request_header(Referer, "http://example.com")
        .with_request_header(UserAgent, "secret agent")
        .with_peer_ip(ip)
        .await
        .assert_status(Status::ImATeapot)
        .assert_body("ok");

    let log_entry = target.next().await;

    let LogEntry::CombinedLog(log) = parse(LogType::CombinedLog, &log_entry).unwrap() else {
        panic!()
    };

    let RequestResult::Valid(request) = log.request else {
        panic!()
    };

    assert_eq!(log.ip, ip);
    assert!(OffsetDateTime::now_utc().unix_timestamp() - log.timestamp.timestamp() < 2);
    assert_eq!(request.uri(), "/some/path?query");
    assert_eq!(request.method(), "GET");
    assert_eq!(log.status_code, Status::ImATeapot);
    assert_eq!(request.version(), Version::Http1_1);
    assert_eq!(log.identd_user, Some("request-id"));
    assert_eq!(log.user, Some("user"));
    assert_eq!(log.referrer, Some("http://example.com".parse().unwrap()));
    assert_eq!(log.user_agent, Some("secret agent"));
}

#[test(harness)]
async fn test_apache_common() {
    let target = TestTarget::default();
    let logger = logger()
        .with_formatter(apache_common("request-id", "user"))
        .with_target(target.clone())
        .with_color_mode(ColorMode::Off);

    let ip = IpAddr::from([1, 2, 3, 4]);
    let handler = (logger, teapot);
    let app = TestServer::new(handler).await;
    let _ = target.next().await;

    app.get("/some/path?query")
        .with_request_header(Referer, "http://example.com")
        .with_request_header(UserAgent, "secret agent")
        .with_peer_ip(ip)
        .await
        .assert_status(Status::ImATeapot)
        .assert_body("ok");

    let log_entry = target.next().await;

    let log = match parse(LogType::CommonLog, &log_entry).unwrap() {
        LogEntry::CommonLog(log) => log,
        other => panic!("unexpectd log type {other:?}"),
    };
    let RequestResult::Valid(request) = log.request else {
        panic!()
    };
    assert!(OffsetDateTime::now_utc().unix_timestamp() - log.timestamp.timestamp() < 2);
    assert_eq!(log.ip, ip);
    assert_eq!(request.uri(), "/some/path?query");
    assert_eq!(request.method(), "GET");
    assert_eq!(log.status_code, Status::ImATeapot);
    assert_eq!(request.version(), Version::Http1_1);
    assert_eq!(log.identd_user, Some("request-id"));
    assert_eq!(log.user, Some("user"));
}