vortex-data / vortex / 16885597172

88%

Build Type

push

github

Committed by web-flow

Commit Message

fix: race condition in vortex-layout, plus test improvements (#4198)

# Vortex Layout Improvements Summary

## Overview
This document summarizes all changes made to improve test coverage, fix
bugs, and enhance the reliability of the `vortex-layout` crate.

## Changes Summary
- **Files Modified**: 13 files
- **Lines Added**: 421
- **Lines Removed**: 31
- **Tests Added**: New comprehensive test suite for LayoutChildType and
RowIdxExpr
- **Bugs Fixed**: 11

## 1. Test Coverage Improvements

### Added High-Value Tests

#### `layout.rs` - LayoutChildType Tests
- **Test Count**: 6 test functions with multiple cases
- **Coverage**: Tests all variants (Chunk, Field, Auxiliary,
Transparent)
- **Features Tested**:
  - Name generation for each variant type
  - Row offset calculation logic
  - Equality comparisons between variants
  - Edge cases with special characters in field names
  - Parameterized tests using rstest for comprehensive coverage

#### `expr_test.rs` - RowIdxExpr VTable Tests  
- **Test Count**: 13 test functions
- **Coverage**: Complete VTable implementation testing
- **Features Tested**:
  - VTable ID verification
  - Encoding reference consistency
  - Metadata handling
  - Children management (should have none)
  - Build operations with various inputs
  - Error handling for invalid operations
  - Return type verification across different scopes

## 2. Critical Bug Fixes

### 2.1 Integer Underflow Protection
**File**: `layouts/chunked/reader.rs:85`
```rust
// Before: Could underflow if x == 0
.unwrap_or_else(|x| x - 1);

// After: Safe with saturating subtraction
.unwrap_or_else(|x| x.saturating_sub(1));
```

### 2.2 Division by Zero Prevention
**File**: `layouts/zoned/mod.rs:131`
```rust
// Added validation
if zone_len == 0 {
    vortex_panic!("Zone length must be greater than 0");
}
```

### 2.3 Race Condition Fix
**File**: `layouts/zoned/reader.rs:334-339`

**Problem**: Double-checked locking pattern had a race condition with
two separate re... (continued)

Run Details

207 of 219 new or added lines in 7 files covered. (94.52%)

1 existing line in 1 file now uncovered.

53618 of 62120 relevant lines covered (86.31%)

545425.28 hits per line