tuwunel_service/integrity/
referencedevents.rs1use std::{fmt, str::from_utf8};
2
3use futures::Stream;
4use tuwunel_core::{
5 Result,
6 smallstr::SmallString,
7 utils::{BoolExt, TryReadyExt},
8};
9use tuwunel_database::{KeyBuf, SEP};
10
11use super::{Check, Report, ScanExt, tally};
12use crate::Services;
13
14type Id = SmallString<[u8; 48]>;
19
20pub(super) static CHECK: Check = Check {
21 name: "referenced-events",
22 about: "Every referencedevents key separates its room and event ids",
23 quiescent: false,
24 walk: |services, limit| tally(scan(services), limit),
25};
26
27pub enum Finding {
32 Unseparated {
34 key: KeyBuf,
36
37 room_id: Id,
39
40 event_id: Id,
42 },
43
44 Unparsable {
46 key: KeyBuf,
48 },
49}
50
51#[tracing::instrument(level = "trace", skip_all)]
56pub fn scan(services: &Services) -> impl Stream<Item = Result<Finding>> + Send + '_ {
57 services.db["referencedevents"]
58 .raw_scan()
59 .scanned(&services.server)
60 .ready_try_filter_map(|(key, _)| Ok(key.contains(&SEP).or(|| finding(key))))
61}
62
63impl Report for Finding {
64 fn kind(&self) -> &'static str {
65 match self {
66 | Self::Unseparated { .. } => "missing-separator",
67 | Self::Unparsable { .. } => "unparsable-key",
68 }
69 }
70}
71
72impl fmt::Display for Finding {
73 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
74 match self {
75 | Self::Unseparated { room_id, event_id, .. } => {
76 write!(f, "no separator between {room_id} and {event_id}")
77 },
78 | Self::Unparsable { key } => write!(f, "key cannot be split: {key:?}"),
79 }
80 }
81}
82
83fn finding(key: &[u8]) -> Finding {
84 let parts = from_utf8(key)
85 .ok()
86 .and_then(|key| key.find('$').map(|at| key.split_at(at)));
87
88 match parts {
89 | None => Finding::Unparsable { key: KeyBuf::from_slice(key) },
90 | Some((room_id, event_id)) => Finding::Unseparated {
91 key: KeyBuf::from_slice(key),
92 room_id: room_id.into(),
93 event_id: event_id.into(),
94 },
95 }
96}