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
//! What:
//! One entry from the wrapper a person ran to the journal, as a datagram on the native socket, sent without waiting and
//! never failing the command.
//! Why:
//! The wrapper is no service: its standard error is the person's terminal or an agent's capture, which is gone when the
//! command ends. A decision the person was told about once (an add that took the slow way and why) is then recoverable
//! afterwards only from the journal (`journalctl --identifier=cli-git`). The socket is unconnected and non-blocking, so a
//! journal that is absent, restarting or full costs the command nothing; the entry is then only in the debug log.
//!
//! In TS you'd write (pseudocode):
//! ```ts
//! try { socket.send(`PRIORITY=4\nSYSLOG_IDENTIFIER=cli-git\nMESSAGE=${message}\n`) } catch { /* nothing waits for the journal */ }
//! ```
use super::diagnostic_log::debug;
use super::journald_native::{CLIENT_IDENTIFIER, Priority, TEST_SOCKET_VARIABLE, Target, datagram_as};
use std::os::unix::net::UnixDatagram;
/// Tag used for diagnostics from this module.
const TAG: &str = "clientJournal";
/// What:
/// Where the entry goes: the journal's socket, or the stand-in a test names; a unit test that names none reaches nothing.
/// Why:
/// A control must never write into the host's journal, and the variable is the only way a test says where its entry may go.
///
/// In TS you'd write (pseudocode):
/// ```ts
/// const target = process.env.CLI_GIT_TEST_ONLY_JOURNAL_SOCKET ?? (isUnitTest ? undefined : '/run/systemd/journal/socket');
/// ```
fn target() -> Option<Target> {
return match std::env::var(TEST_SOCKET_VARIABLE) {
Ok(text) => Some(Target::parse(text.as_str())),
Err(_) if cfg!(test) => None,
Err(_) => Some(Target::journal()),
};
}
/// What:
/// Send one entry to the journal; whether the socket took it.
/// Why:
/// The command that sends it goes on whatever the journal does; the answer is for a test and for the debug log.
///
/// In TS you'd write (pseudocode):
/// ```ts
/// const sent = recordEntry({ priority: 'warning', message, fields: [['CLI_GIT_WORKTREE', path]] });
/// ```
pub fn record_entry(priority: Priority, message: &str, fields: &[(&str, String)]) -> bool {
let Some(found) = target() else { return false };
return send_entry(&found, priority, message, fields);
}
/// What:
/// Send one entry to `target`; whether the socket took it.
/// Why:
/// Split from the choice of target so a control names its own receiver without touching the process environment.
///
/// In TS you'd write (pseudocode):
/// ```ts
/// const sent = sendEntry(target, 'warning', message, fields);
/// ```
pub fn send_entry(target: &Target, priority: Priority, message: &str, fields: &[(&str, String)]) -> bool {
let Some(address) = target.address() else {
debug(TAG, format!("the journal address {target:?} does not fit a socket name; no entry is sent").as_str());
return false;
};
let socket: UnixDatagram = match UnixDatagram::unbound() {
Ok(opened) => opened,
Err(error) => {
debug(TAG, format!("no socket for the journal entry ({error})").as_str());
return false;
}
};
if let Err(error) = socket.set_nonblocking(true) {
debug(TAG, format!("the journal socket cannot be made non-blocking ({error}); no entry is sent").as_str());
return false;
}
return match socket.send_to_addr(datagram_as(CLIENT_IDENTIFIER, priority, message, fields).as_slice(), &address) {
Ok(_) => true,
Err(error) => {
debug(TAG, format!("the journal took no entry ({error})").as_str());
false
}
};
}
/// Journal entry controls stay out of the release executable.
#[cfg(test)]
#[path = "client_journal_tests.rs"]
mod tests;