reifydb_core/key/
output_frontier.rs

1// SPDX-License-Identifier: Apache-2.0
2// Copyright (c) 2026 ReifyDB
3
4use reifydb_codec::key::encoded::EncodedKey;
5use reifydb_macro::KeyCodec;
6
7use super::{
8	KeyTag,
9	catalog::{KeyDeserializerCatalogExt, KeySerializerCatalogExt},
10};
11use crate::{
12	interface::catalog::object::ObjectId,
13	key::{
14		any::{Field, KeyFields, Width},
15		bound::TaggedKeyBoundRange,
16	},
17};
18
19#[derive(Debug, Clone, PartialEq, KeyCodec, Hash)]
20#[key(tag = OutputFrontier)]
21pub struct OutputFrontierKey {
22	pub object: ObjectId,
23}
24
25impl OutputFrontierKey {
26	pub fn new(object: impl Into<ObjectId>) -> Self {
27		Self {
28			object: object.into(),
29		}
30	}
31
32	pub fn encoded(object: impl Into<ObjectId>) -> EncodedKey {
33		Self::new(object).encode()
34	}
35
36	pub fn full_scan() -> TaggedKeyBoundRange {
37		TaggedKeyBoundRange::kind(Self::TAG)
38	}
39}
40
41#[cfg(test)]
42pub mod tests {
43	use reifydb_codec::key::encoded::EncodedKey;
44
45	use super::OutputFrontierKey;
46	use crate::{
47		interface::catalog::{id::ViewId, object::ObjectId},
48		key::KeyTag,
49	};
50
51	#[test]
52	fn test_encode_decode() {
53		let key = OutputFrontierKey {
54			object: ObjectId::View(ViewId(0xABCD)),
55		};
56		let encoded = key.encode();
57		let decoded = OutputFrontierKey::decode(&encoded).unwrap();
58
59		assert_eq!(decoded.object, ObjectId::View(ViewId(0xABCD)));
60		assert_eq!(key, decoded);
61	}
62
63	#[test]
64	fn the_tag_byte_is_the_inverted_kind() {
65		// extend_u8 inverts, so a raw 0x1D here would sort into a neighbouring keyspace.
66		let encoded = OutputFrontierKey::encoded(ObjectId::View(ViewId(1)));
67
68		assert_eq!(encoded.as_slice()[0], !(KeyTag::OutputFrontier as u8));
69	}
70
71	#[test]
72	fn a_key_of_another_kind_never_decodes_as_a_frontier() {
73		// 0x1D previously held FlowNodeInternalState, so a stale row must be rejected, never misread.
74		let mut foreign = OutputFrontierKey::encoded(ObjectId::View(ViewId(1))).as_slice().to_vec();
75		foreign[0] = !(KeyTag::FlowEdgeByFlow as u8);
76
77		assert!(OutputFrontierKey::decode(&EncodedKey::new(foreign)).is_none());
78	}
79
80	#[test]
81	fn every_object_kind_round_trips_under_the_one_frontier_tag() {
82		// A kind landing on another tag escapes the hydration scan, so its consumer pins at the epoch forever.
83		for object in [
84			ObjectId::table(1),
85			ObjectId::View(ViewId(2)),
86			ObjectId::series(3),
87			ObjectId::ringbuffer(4),
88			ObjectId::queue(5),
89		] {
90			let encoded = OutputFrontierKey::encoded(object);
91
92			assert_eq!(
93				encoded.as_slice()[0],
94				!(KeyTag::OutputFrontier as u8),
95				"{:?} encoded under a foreign tag",
96				object
97			);
98			assert_eq!(OutputFrontierKey::decode(&encoded).unwrap().object, object);
99		}
100	}
101
102	#[test]
103	fn test_order_preserving_within_same_object_kind() {
104		let key1 = OutputFrontierKey {
105			object: ObjectId::table(1),
106		};
107		let key2 = OutputFrontierKey {
108			object: ObjectId::table(2),
109		};
110
111		let encoded1 = key1.encode();
112		let encoded2 = key2.encode();
113
114		assert!(encoded2 < encoded1, "ordering not preserved");
115	}
116}
117
118#[cfg(test)]
119mod verify_byte_identical {
120	use reifydb_codec::key::serializer::KeySerializer;
121
122	use super::OutputFrontierKey;
123	use crate::{
124		interface::catalog::{id::ViewId, object::ObjectId},
125		key::catalog::KeySerializerCatalogExt,
126	};
127
128	fn legacy_encode(key: &OutputFrontierKey) -> Vec<u8> {
129		let mut serializer = KeySerializer::with_capacity(10);
130		serializer.extend_u8(OutputFrontierKey::TAG as u8).extend_object_id(key.object);
131		serializer.to_encoded_key().as_slice().to_vec()
132	}
133
134	#[test]
135	fn matches_legacy_byte_layout() {
136		for object in [
137			ObjectId::table(1),
138			ObjectId::View(ViewId(2)),
139			ObjectId::series(3),
140			ObjectId::ringbuffer(4),
141			ObjectId::queue(5),
142		] {
143			let key = OutputFrontierKey {
144				object,
145			};
146			assert_eq!(legacy_encode(&key), key.encode().as_slice().to_vec(), "object={object:?}");
147		}
148	}
149}
reifydb_core/key/output_frontier.rs

reifydb_core/key/
output_frontier.rs
