|
| 1 | +// SPDX-License-Identifier: Apache-2.0 |
| 2 | +// SPDX-FileCopyrightText: Copyright the Vortex contributors |
| 3 | + |
| 4 | +//! Regression tests for extension dtype nullability changes and debug output. |
| 5 | +
|
| 6 | +use std::sync::atomic::AtomicUsize; |
| 7 | +use std::sync::atomic::Ordering; |
| 8 | + |
| 9 | +use rstest::rstest; |
| 10 | +use vortex_error::VortexResult; |
| 11 | +use vortex_error::vortex_err; |
| 12 | +use vortex_session::registry::CachedId; |
| 13 | + |
| 14 | +use super::ExtDType; |
| 15 | +use super::ExtId; |
| 16 | +use super::ExtVTable; |
| 17 | +use crate::dtype::DType; |
| 18 | +use crate::dtype::Nullability::NonNullable; |
| 19 | +use crate::dtype::Nullability::Nullable; |
| 20 | +use crate::dtype::PType; |
| 21 | +use crate::extension::datetime::TimeUnit; |
| 22 | +use crate::extension::datetime::Timestamp; |
| 23 | +use crate::scalar::ScalarValue; |
| 24 | + |
| 25 | +/// The number of times [`CountingValidator::validate_dtype`] ran. |
| 26 | +static VALIDATIONS: AtomicUsize = AtomicUsize::new(0); |
| 27 | + |
| 28 | +/// An extension type that counts how often its dtype is validated. |
| 29 | +#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)] |
| 30 | +struct CountingValidator; |
| 31 | + |
| 32 | +impl ExtVTable for CountingValidator { |
| 33 | + type Metadata = u32; |
| 34 | + type NativeValue<'a> = &'a ScalarValue; |
| 35 | + |
| 36 | + fn id(&self) -> ExtId { |
| 37 | + static ID: CachedId = CachedId::new("test.counting_validator"); |
| 38 | + *ID |
| 39 | + } |
| 40 | + |
| 41 | + fn serialize_metadata(&self, metadata: &Self::Metadata) -> VortexResult<Vec<u8>> { |
| 42 | + Ok(metadata.to_le_bytes().to_vec()) |
| 43 | + } |
| 44 | + |
| 45 | + fn deserialize_metadata(&self, metadata: &[u8]) -> VortexResult<Self::Metadata> { |
| 46 | + let bytes = metadata |
| 47 | + .try_into() |
| 48 | + .map_err(|_| vortex_err!("Expected four metadata bytes, got {}", metadata.len()))?; |
| 49 | + |
| 50 | + Ok(u32::from_le_bytes(bytes)) |
| 51 | + } |
| 52 | + |
| 53 | + fn validate_dtype(_ext_dtype: &ExtDType<Self>) -> VortexResult<()> { |
| 54 | + VALIDATIONS.fetch_add(1, Ordering::Relaxed); |
| 55 | + |
| 56 | + Ok(()) |
| 57 | + } |
| 58 | + |
| 59 | + fn unpack_native<'a>( |
| 60 | + _ext_dtype: &'a ExtDType<Self>, |
| 61 | + storage_value: &'a ScalarValue, |
| 62 | + ) -> VortexResult<Self::NativeValue<'a>> { |
| 63 | + Ok(storage_value) |
| 64 | + } |
| 65 | +} |
| 66 | + |
| 67 | +// One test owns `VALIDATIONS`, so test threads cannot race on the counter. |
| 68 | +#[test] |
| 69 | +fn test_nullability_changes_do_not_validate_again() -> VortexResult<()> { |
| 70 | + for initial in [NonNullable, Nullable] { |
| 71 | + VALIDATIONS.store(0, Ordering::Relaxed); |
| 72 | + let dtype = |
| 73 | + ExtDType::<CountingValidator>::try_new(42, DType::Primitive(PType::I64, initial))?; |
| 74 | + assert_eq!(VALIDATIONS.load(Ordering::Relaxed), 1); |
| 75 | + |
| 76 | + for target in [Nullable, NonNullable] { |
| 77 | + let changed = dtype.with_nullability(target); |
| 78 | + |
| 79 | + assert_eq!( |
| 80 | + changed.storage_dtype(), |
| 81 | + &DType::Primitive(PType::I64, target) |
| 82 | + ); |
| 83 | + assert_eq!(changed.metadata::<CountingValidator>(), &42); |
| 84 | + assert_eq!(changed.id(), dtype.id()); |
| 85 | + } |
| 86 | + |
| 87 | + assert_eq!(VALIDATIONS.load(Ordering::Relaxed), 1); |
| 88 | + } |
| 89 | + |
| 90 | + Ok(()) |
| 91 | +} |
| 92 | + |
| 93 | +#[rstest] |
| 94 | +#[case::compact(false)] |
| 95 | +#[case::pretty(true)] |
| 96 | +fn test_debug_preserves_metadata(#[case] pretty: bool) -> VortexResult<()> { |
| 97 | + let dtype = |
| 98 | + Timestamp::try_new_with_tz(TimeUnit::Milliseconds, Some("UTC".into()), Nullable)?.erased(); |
| 99 | + let output = if pretty { |
| 100 | + format!("{dtype:#?}") |
| 101 | + } else { |
| 102 | + format!("{dtype:?}") |
| 103 | + }; |
| 104 | + |
| 105 | + assert!(output.starts_with("ExtDType {"), "{output}"); |
| 106 | + assert!(output.contains("metadata: TimestampOptions {"), "{output}"); |
| 107 | + assert!(output.contains("unit: Milliseconds"), "{output}"); |
| 108 | + assert_eq!( |
| 109 | + output.contains("metadata: TimestampOptions {\n"), |
| 110 | + pretty, |
| 111 | + "{output}" |
| 112 | + ); |
| 113 | + assert_eq!(output.matches("UTC").count(), 1, "{output}"); |
| 114 | + |
| 115 | + Ok(()) |
| 116 | +} |
0 commit comments