reifydb_core/encoded/

identity.rs

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use std::ptr;

use reifydb_type::value::{identity::IdentityId, r#type::Type, uuid::Uuid7};
use uuid::Uuid;

use crate::encoded::{row::EncodedRow, shape::RowShape};

impl RowShape {
	pub fn set_identity_id(&self, row: &mut EncodedRow, index: usize, value: IdentityId) {
		let field = &self.fields()[index];
		debug_assert!(row.len() >= self.total_static_size());
		debug_assert_eq!(*field.constraint.get_type().inner_type(), Type::IdentityId);
		row.set_valid(index, true);
		unsafe {
			// IdentityId wraps Uuid7 which is 16 bytes
			ptr::write_unaligned(
				row.make_mut().as_mut_ptr().add(field.offset as usize) as *mut [u8; 16],
				*value.as_bytes(),
			);
		}
	}

	pub fn get_identity_id(&self, row: &EncodedRow, index: usize) -> IdentityId {
		let field = &self.fields()[index];
		debug_assert!(row.len() >= self.total_static_size());
		debug_assert_eq!(*field.constraint.get_type().inner_type(), Type::IdentityId);
		unsafe {
			// IdentityId wraps Uuid7 which is 16 bytes
			let bytes: [u8; 16] =
				ptr::read_unaligned(row.as_ptr().add(field.offset as usize) as *const [u8; 16]);
			let uuid = Uuid::from_bytes(bytes);
			let uuid7 = Uuid7::from(uuid);
			IdentityId::from(uuid7)
		}
	}

	pub fn try_get_identity_id(&self, row: &EncodedRow, index: usize) -> Option<IdentityId> {
		if row.is_defined(index) && self.fields()[index].constraint.get_type() == Type::IdentityId {
			Some(self.get_identity_id(row, index))
		} else {
			None
		}
	}
}

#[cfg(test)]
pub mod tests {
	use reifydb_runtime::context::{
		clock::{Clock, MockClock},
		rng::Rng,
	};
	use reifydb_type::value::{identity::IdentityId, r#type::Type};

	use crate::encoded::shape::RowShape;

	fn test_clock_and_rng() -> (MockClock, Clock, Rng) {
		let mock = MockClock::from_millis(1000);
		let clock = Clock::Mock(mock.clone());
		let rng = Rng::seeded(42);
		(mock, clock, rng)
	}

	#[test]
	fn test_set_get_identity_id() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);
		let mut row = shape.allocate();

		let id = IdentityId::generate(&clock, &rng);
		shape.set_identity_id(&mut row, 0, id.clone());
		assert_eq!(shape.get_identity_id(&row, 0), id);
	}

	#[test]
	fn test_try_get_identity_id() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);
		let mut row = shape.allocate();

		assert_eq!(shape.try_get_identity_id(&row, 0), None);

		let id = IdentityId::generate(&clock, &rng);
		shape.set_identity_id(&mut row, 0, id.clone());
		assert_eq!(shape.try_get_identity_id(&row, 0), Some(id));
	}

	#[test]
	fn test_multiple_generations() {
		let (mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);

		// Generate multiple Identity IDs and ensure they're different
		let mut ids = Vec::new();
		for _ in 0..10 {
			let mut row = shape.allocate();
			let id = IdentityId::generate(&clock, &rng);
			shape.set_identity_id(&mut row, 0, id.clone());
			let retrieved = shape.get_identity_id(&row, 0);
			assert_eq!(retrieved, id);
			ids.push(id);
			mock.advance_millis(1);
		}

		// Ensure all generated Identity IDs are unique
		for i in 0..ids.len() {
			for j in (i + 1)..ids.len() {
				assert_ne!(ids[i], ids[j], "Identity IDs should be unique");
			}
		}
	}

	#[test]
	fn test_uuid7_properties() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);
		let mut row = shape.allocate();

		let id = IdentityId::generate(&clock, &rng);
		shape.set_identity_id(&mut row, 0, id.clone());
		let retrieved = shape.get_identity_id(&row, 0);

		// Verify it's backed by a version 7 UUID
		assert_eq!(retrieved.get_version_num(), 7);
		assert_eq!(id.get_version_num(), 7);
	}

	#[test]
	fn test_timestamp_ordering() {
		let (mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);

		// Generate Identity IDs in sequence - they should be ordered by
		// timestamp
		let mut ids = Vec::new();
		for _ in 0..5 {
			let mut row = shape.allocate();
			let id = IdentityId::generate(&clock, &rng);
			shape.set_identity_id(&mut row, 0, id.clone());
			let retrieved = shape.get_identity_id(&row, 0);
			assert_eq!(retrieved, id);
			ids.push(id);

			// Advance clock to ensure different timestamps
			mock.advance_millis(1);
		}

		// Verify that Identity IDs are ordered (timestamp-based)
		for i in 1..ids.len() {
			assert!(ids[i].as_bytes() >= ids[i - 1].as_bytes(), "Identity IDs should be timestamp-ordered");
		}
	}

	#[test]
	fn test_mixed_with_other_types() {
		let (mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId, Type::Boolean, Type::IdentityId, Type::Int4]);
		let mut row = shape.allocate();

		let id1 = IdentityId::generate(&clock, &rng);
		mock.advance_millis(1);
		let id2 = IdentityId::generate(&clock, &rng);

		shape.set_identity_id(&mut row, 0, id1.clone());
		shape.set_bool(&mut row, 1, true);
		shape.set_identity_id(&mut row, 2, id2.clone());
		shape.set_i32(&mut row, 3, 42);

		assert_eq!(shape.get_identity_id(&row, 0), id1);
		assert_eq!(shape.get_bool(&row, 1), true);
		assert_eq!(shape.get_identity_id(&row, 2), id2);
		assert_eq!(shape.get_i32(&row, 3), 42);
	}

	#[test]
	fn test_undefined_handling() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId, Type::IdentityId]);
		let mut row = shape.allocate();

		let id = IdentityId::generate(&clock, &rng);
		shape.set_identity_id(&mut row, 0, id.clone());

		assert_eq!(shape.try_get_identity_id(&row, 0), Some(id));
		assert_eq!(shape.try_get_identity_id(&row, 1), None);

		shape.set_none(&mut row, 0);
		assert_eq!(shape.try_get_identity_id(&row, 0), None);
	}

	#[test]
	fn test_persistence() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);
		let mut row = shape.allocate();

		let id = IdentityId::generate(&clock, &rng);
		let id_string = id.to_string();

		shape.set_identity_id(&mut row, 0, id.clone());
		let retrieved = shape.get_identity_id(&row, 0);

		assert_eq!(retrieved, id);
		assert_eq!(retrieved.to_string(), id_string);
		assert_eq!(retrieved.as_bytes(), id.as_bytes());
	}

	#[test]
	fn test_clone_consistency() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);
		let mut row = shape.allocate();

		let original_id = IdentityId::generate(&clock, &rng);
		shape.set_identity_id(&mut row, 0, original_id.clone());

		let retrieved_id = shape.get_identity_id(&row, 0);
		assert_eq!(retrieved_id, original_id);

		// Verify that the underlying UUID7 byte representation is
		// identical
		assert_eq!(retrieved_id.as_bytes(), original_id.as_bytes());
	}

	#[test]
	fn test_multiple_fields() {
		let (mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId, Type::IdentityId, Type::IdentityId]);
		let mut row = shape.allocate();

		let id1 = IdentityId::generate(&clock, &rng);
		mock.advance_millis(1);
		let id2 = IdentityId::generate(&clock, &rng);
		mock.advance_millis(1);
		let id3 = IdentityId::generate(&clock, &rng);

		shape.set_identity_id(&mut row, 0, id1.clone());
		shape.set_identity_id(&mut row, 1, id2.clone());
		shape.set_identity_id(&mut row, 2, id3.clone());

		assert_eq!(shape.get_identity_id(&row, 0), id1);
		assert_eq!(shape.get_identity_id(&row, 1), id2);
		assert_eq!(shape.get_identity_id(&row, 2), id3);

		// Ensure all Identity IDs are different
		assert_ne!(id1, id2);
		assert_ne!(id1, id3);
		assert_ne!(id2, id3);
	}

	#[test]
	fn test_format_consistency() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);
		let mut row = shape.allocate();

		let id = IdentityId::generate(&clock, &rng);
		let original_string = id.to_string();

		shape.set_identity_id(&mut row, 0, id.clone());
		let retrieved = shape.get_identity_id(&row, 0);
		let retrieved_string = retrieved.to_string();

		assert_eq!(original_string, retrieved_string);

		// Verify UUID string format (8-4-4-4-12) since IdentityId is
		// based on UUID7
		assert_eq!(original_string.len(), 36);
		assert_eq!(original_string.matches('-').count(), 4);
	}

	#[test]
	fn test_byte_level_storage() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);
		let mut row = shape.allocate();

		let id = IdentityId::generate(&clock, &rng);
		let original_bytes = *id.as_bytes();

		shape.set_identity_id(&mut row, 0, id.clone());
		let retrieved = shape.get_identity_id(&row, 0);
		let retrieved_bytes = *retrieved.as_bytes();

		assert_eq!(original_bytes, retrieved_bytes);

		// Verify that it's exactly 16 bytes
		assert_eq!(original_bytes.len(), 16);
		assert_eq!(retrieved_bytes.len(), 16);
	}

	#[test]
	fn test_time_based_properties() {
		let (mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[Type::IdentityId]);

		// Generate Identity IDs at different times
		let id1 = IdentityId::generate(&clock, &rng);
		mock.advance_millis(2);
		let id2 = IdentityId::generate(&clock, &rng);

		let mut row1 = shape.allocate();
		let mut row2 = shape.allocate();

		shape.set_identity_id(&mut row1, 0, id1.clone());
		shape.set_identity_id(&mut row2, 0, id2.clone());

		let retrieved1 = shape.get_identity_id(&row1, 0);
		let retrieved2 = shape.get_identity_id(&row2, 0);

		// The second Identity ID should be "greater" due to timestamp
		// ordering
		assert!(retrieved2.as_bytes() > retrieved1.as_bytes());
	}

	#[test]
	fn test_as_primary_key() {
		let (_mock, clock, rng) = test_clock_and_rng();
		let shape = RowShape::testing(&[
			Type::IdentityId, // Primary key
			Type::Utf8,       // Name field
			Type::Int4,       // Age field
		]);
		let mut row = shape.allocate();

		// Simulate a database record with Identity ID as primary key
		let primary_key = IdentityId::generate(&clock, &rng);
		shape.set_identity_id(&mut row, 0, primary_key.clone());
		shape.set_utf8(&mut row, 1, "John Doe");
		shape.set_i32(&mut row, 2, 30);

		assert_eq!(shape.get_identity_id(&row, 0), primary_key);
		assert_eq!(shape.get_utf8(&row, 1), "John Doe");
		assert_eq!(shape.get_i32(&row, 2), 30);

		// Verify that the primary key is suitable for ordering/indexing
		assert_eq!(primary_key.get_version_num(), 7);
	}

	#[test]
	fn test_try_get_identity_id_wrong_type() {
		let shape = RowShape::testing(&[Type::Boolean]);
		let mut row = shape.allocate();

		shape.set_bool(&mut row, 0, true);

		assert_eq!(shape.try_get_identity_id(&row, 0), None);
	}
}