memfaultd 1.27.0

Memfault daemon for embedded Linux systems. Observability, logging, crash reporting, and updating all in one service. Learn more at https://docs.memfault.com/
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//
// Copyright (c) Memfault, Inc.
// See License.txt for details
use eyre::{eyre, Result};
use log::error;
use ssf::MsgMailbox;
use std::{io::Read, str::from_utf8};
use tiny_http::{Method, Request, Response};

use crate::chunk_relay::RelayChunksMsg;
use crate::http_server::{ChunksRequest, HttpHandler, HttpHandlerResult};

pub struct ChunkRelayHttpHandler {
    relay_service_mbox: MsgMailbox<RelayChunksMsg>,
    data_collection_enabled: bool,
}

const MAX_BODY_BYTES: u64 = 5 * 1024;

impl ChunkRelayHttpHandler {
    pub fn new(
        relay_service_mbox: MsgMailbox<RelayChunksMsg>,
        data_collection_enabled: bool,
    ) -> Self {
        Self {
            relay_service_mbox,
            data_collection_enabled,
        }
    }

    fn parse_request(stream: &mut dyn Read) -> Result<ChunksRequest> {
        let mut buf = Vec::with_capacity((MAX_BODY_BYTES) as usize);
        let mut limited = stream.take(MAX_BODY_BYTES + 1);
        limited.read_to_end(&mut buf)?;
        if buf.len() > MAX_BODY_BYTES as usize {
            return Err(eyre!("Request body too large (max {MAX_BODY_BYTES} bytes)"));
        }
        let body = from_utf8(&buf)?;
        Ok(serde_json::from_str(body)?)
    }

    fn relay_chunks(&self, chunks_request: &ChunksRequest) -> Result<()> {
        match self
            .relay_service_mbox
            .send_and_forget(RelayChunksMsg::from(chunks_request))
        {
            Ok(()) => Ok(()),
            Err(e) => Err(eyre!("Failed to send chunks to mailbox: {:?}", e)),
        }
    }
}

impl HttpHandler for ChunkRelayHttpHandler {
    fn handle_request(&self, request: &mut Request) -> HttpHandlerResult {
        if request.url() != "/v1/chunks" || *request.method() != Method::Post {
            return HttpHandlerResult::NotHandled;
        }

        if self.data_collection_enabled {
            match Self::parse_request(request.as_reader()) {
                Ok(chunks_request) => match self.relay_chunks(&chunks_request) {
                    Ok(()) => (),
                    Err(e) => {
                        error!("Failed to relay chunks: {:?}", e);
                        return HttpHandlerResult::Error(format!(
                            "Failed to relay chunks: {:?}",
                            e
                        ));
                    }
                },
                Err(e) => {
                    error!("Failed to parse chunks relay request: {:?}", e);
                    return HttpHandlerResult::Error(format!(
                        "Failed to parse chunks relay request: {:?}",
                        e
                    ));
                }
            }
        } else {
            log::trace!("Data collection disabled, dropping chunks");
        }
        HttpHandlerResult::Response(Response::empty(200).boxed())
    }
}

#[cfg(test)]
mod tests {
    use rstest::rstest;
    use tiny_http::{Method, TestRequest};

    use crate::http_server::{HttpHandler, HttpHandlerResult};

    use super::ChunkRelayHttpHandler;

    #[rstest]
    #[case(r#"{"project_key":null,"device_serial":null,"chunks":["aGk="]}"#)]
    #[case(r#"{"project_key":"1234-5678","device_serial":"ABCDEFGHIJ","chunks":["aGk="]}"#)]
    #[case(r#"{"project_key":"1234-5678","device_serial":"ABCDEFGHIJ","chunks":["aGk=", "non-base64"]}"#)]
    fn ignores_chunks_when_data_collection_is_off(#[case] body: &'static str) {
        let mut mock = ssf::ServiceMock::new();
        let handler = ChunkRelayHttpHandler::new(mock.mbox.clone(), false);
        let r = TestRequest::new()
            .with_method(Method::Post)
            .with_path("/v1/chunks")
            .with_body(body);
        assert!(matches!(
            handler.handle_request(&mut r.into()),
            HttpHandlerResult::Response(_)
        ));

        assert_eq!(mock.take_messages().len(), 0)
    }

    #[rstest]
    #[case(
        vec![
            r#"{"project_key":null,"device_serial":null,"chunks":["aGk="]}"#,
        ])]
    #[case(
        vec![
            r#"{"project_key":null,"device_serial":null,"chunks":["aGk="]}"#,
            r#"{"project_key":null,"device_serial":null,"chunks":["aGk="]}"#,
        ])]
    #[case(
        vec![
            r#"{"project_key":null,"device_serial":null,"chunks":["aGk="]}"#,
            r#"{"project_key":null,"device_serial":null,"chunks":["aGk=", "non-base64"]}"#,
            r#"{"project_key":null,"device_serial":null,"chunks":["aGk="]}"#,
        ])]
    fn accepts_chunks_when_data_collection_is_on(#[case] msgs: Vec<&'static str>) {
        let mut mock = ssf::ServiceMock::new();
        let handler = ChunkRelayHttpHandler::new(mock.mbox.clone(), true);
        for body in &msgs {
            let r = TestRequest::new()
                .with_method(Method::Post)
                .with_path("/v1/chunks")
                .with_body(body);
            assert!(matches!(
                handler.handle_request(&mut r.into()),
                HttpHandlerResult::Response(_)
            ));
        }

        assert_eq!(mock.take_messages().len(), msgs.len())
    }
}