the-other-tim-brown commented on code in PR #17632: URL: https://github.com/apache/hudi/pull/17632#discussion_r2646063578
########## hudi-spark-datasource/hudi-spark/src/test/java/org/apache/hudi/io/storage/TestHoodieSparkLanceReader.java: ########## @@ -0,0 +1,534 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hudi.io.storage; + +import org.apache.hudi.HoodieSchemaConversionUtils; +import org.apache.hudi.client.SparkTaskContextSupplier; +import org.apache.hudi.common.model.HoodieKey; +import org.apache.hudi.common.model.HoodieRecord; +import org.apache.hudi.common.schema.HoodieSchema; +import org.apache.hudi.common.testutils.HoodieTestUtils; +import org.apache.hudi.common.util.collection.ClosableIterator; +import org.apache.hudi.common.util.collection.Pair; +import org.apache.hudi.storage.HoodieStorage; +import org.apache.hudi.storage.StoragePath; +import org.apache.spark.sql.catalyst.InternalRow; +import org.apache.spark.sql.catalyst.expressions.GenericInternalRow; +import org.apache.spark.sql.types.DataType; +import org.apache.spark.sql.types.DataTypes; +import org.apache.spark.sql.types.StructType; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; + +import java.io.File; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Set; +import java.util.stream.Stream; + +import static org.apache.hudi.io.storage.LanceTestUtils.createRow; +import static org.apache.hudi.io.storage.LanceTestUtils.createRowWithMetaFields; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * Tests for {@link HoodieSparkLanceReader}. + */ +public class TestHoodieSparkLanceReader { + + @TempDir + File tempDir; + + private HoodieStorage storage; + private SparkTaskContextSupplier taskContextSupplier; + private String instantTime; + + @BeforeEach + public void setUp() throws IOException { + storage = HoodieTestUtils.getStorage(tempDir.getAbsolutePath()); + taskContextSupplier = new SparkTaskContextSupplier(); + instantTime = "20251201120000000"; + } + + @AfterEach + public void tearDown() throws Exception { + if (storage != null) { + storage.close(); + } + } + + @Test + public void testReadWithNulls() throws Exception { + StructType schema = new StructType() + .add("id", DataTypes.IntegerType, false) + .add("name", DataTypes.StringType, true) + .add("value", DataTypes.DoubleType, true); + + List<InternalRow> expectedRows = new ArrayList<>(); + expectedRows.add(createRow(1, "Alice", 100.0)); + expectedRows.add(createRow(2, null, 200.0)); // null name + expectedRows.add(createRow(3, "Charlie", null)); // null value + expectedRows.add(createRow(4, null, null)); // multiple nulls + + // Write and read back + StoragePath path = new StoragePath(tempDir.getAbsolutePath() + "/test_nulls.lance"); + try (HoodieSparkLanceReader reader = writeAndCreateReader(path, schema, expectedRows)) { + List<InternalRow> actualRows = readAllRows(reader, schema); + + assertEquals(expectedRows.size(), actualRows.size(), "Should read same number of records"); + + // Verify nulls are preserved + assertTrue(actualRows.get(1).isNullAt(1), "Second row name should be null"); + assertFalse(actualRows.get(1).isNullAt(2), "Second row value should not be null"); + + assertFalse(actualRows.get(2).isNullAt(1), "Third row name should not be null"); + assertTrue(actualRows.get(2).isNullAt(2), "Third row value should be null"); + + assertTrue(actualRows.get(3).isNullAt(1), "Fourth row name should be null"); + assertTrue(actualRows.get(3).isNullAt(2), "Fourth row value should be null"); + } + } + + @Test + public void testReadAllSupportedTypes() throws Exception { + // Create schema with all supported primitive types + StructType schema = new StructType() + .add("int_field", DataTypes.IntegerType, false) + .add("long_field", DataTypes.LongType, false) + .add("float_field", DataTypes.FloatType, false) + .add("double_field", DataTypes.DoubleType, false) + .add("bool_field", DataTypes.BooleanType, false) + .add("string_field", DataTypes.StringType, false) + .add("binary_field", DataTypes.BinaryType, false); + + // Create test data with 3 records + List<InternalRow> expectedRows = new ArrayList<>(); + expectedRows.add(createRow(42, 123456789L, 3.14f, 2.71828, true, "Alice", new byte[]{1, 2, 3, 4})); + expectedRows.add(createRow(-100, 987654321L, 2.5f, 98.765, false, "Bob", new byte[]{10, 20, 30})); + expectedRows.add(createRow(0, 0L, 0.0f, 0.0, true, "Charlie", new byte[]{99})); + + // Write and read back + StoragePath path = new StoragePath(tempDir.getAbsolutePath() + "/test_all_types.lance"); + try (HoodieSparkLanceReader reader = writeAndCreateReader(path, schema, expectedRows)) { + assertEquals(expectedRows.size(), reader.getTotalRecords(), "Record count should match"); + assertNotNull(reader.getSchema(), "Schema should not be null"); + + List<InternalRow> actualRows = readAllRows(reader, schema); + assertEquals(expectedRows.size(), actualRows.size(), "Should read same number of records"); + + // Verify each record + for (int i = 0; i < expectedRows.size(); i++) { + InternalRow expected = expectedRows.get(i); + InternalRow actual = actualRows.get(i); + assertEquals(expected, actual); + } + } + } + + @Test + public void testReadLargeDataset() throws Exception { + // Test batch reading with more than 1000 records + StructType schema = new StructType() + .add("id", DataTypes.IntegerType, false) + .add("value", DataTypes.LongType, false); + + StoragePath path = new StoragePath(tempDir.getAbsolutePath() + "/test_large.lance"); + int recordCount = 2500; + try (HoodieSparkLanceWriter writer = new HoodieSparkLanceWriter( + path, schema, instantTime, taskContextSupplier, storage, false)) { + for (int i = 0; i < recordCount; i++) { + GenericInternalRow row = new GenericInternalRow(new Object[]{i, (long) i * 2}); + writer.writeRow("key" + i, row); + } + } + + // Read back + try (HoodieSparkLanceReader reader = new HoodieSparkLanceReader(path)) { + assertEquals(recordCount, reader.getTotalRecords(), "Total record count should match"); + + // Verify all records + int count = 0; + HoodieSchema readerSchema = reader.getSchema(); + try (ClosableIterator<HoodieRecord<InternalRow>> iterator = reader.getRecordIterator(readerSchema)) { + while (iterator.hasNext()) { + HoodieRecord<InternalRow> record = iterator.next(); + InternalRow row = record.getData(); + assertEquals(count, row.getInt(0), "id should match"); + assertEquals(count * 2L, row.getLong(1), "value should match"); + count++; + } + } + + assertEquals(recordCount, count, "Should read all records"); + } + } + + @Test + public void testGetRecordKeyIterator() throws Exception { + // Create schema with all 5 Hudi metadata fields + StructType schema = new StructType() + .add(HoodieRecord.COMMIT_TIME_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.COMMIT_SEQNO_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.RECORD_KEY_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.PARTITION_PATH_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.FILENAME_METADATA_FIELD, DataTypes.StringType, false) + .add("name", DataTypes.StringType, true) + .add("age", DataTypes.IntegerType, true); + + // Create test data with placeholder metadata fields + List<InternalRow> expectedRows = new ArrayList<>(); + expectedRows.add(createRowWithMetaFields("Alice", 30)); + expectedRows.add(createRowWithMetaFields("Bob", 25)); + expectedRows.add(createRowWithMetaFields("Charlie", 35)); + expectedRows.add(createRowWithMetaFields("David", 40)); + expectedRows.add(createRowWithMetaFields("Eve", 28)); + + // Write with metadata population enabled + StoragePath path = new StoragePath(tempDir.getAbsolutePath() + "/test_record_keys.lance"); + try (HoodieSparkLanceReader reader = writeAndCreateReader(path, schema, expectedRows, true)) { + // Read record keys using getRecordKeyIterator + List<String> actualKeys = new ArrayList<>(); + try (ClosableIterator<String> keyIterator = reader.getRecordKeyIterator()) { + while (keyIterator.hasNext()) { + actualKeys.add(keyIterator.next()); + } + } + + // Verify all keys are returned in the same order + List<String> expectedKeys = Arrays.asList("key0", "key1", "key2", "key3", "key4"); + assertEquals(expectedKeys, actualKeys, "Record keys should match"); + } + } + + @Test + public void testFilterRowKeysWithCandidates() throws Exception { + // Create schema with all 5 Hudi metadata fields + StructType schema = new StructType() + .add(HoodieRecord.COMMIT_TIME_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.COMMIT_SEQNO_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.RECORD_KEY_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.PARTITION_PATH_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.FILENAME_METADATA_FIELD, DataTypes.StringType, false) + .add("value", DataTypes.IntegerType, true); + + // Create 10 records with placeholder metadata fields + List<InternalRow> rows = new ArrayList<>(); + for (int i = 0; i < 10; i++) { + rows.add(createRowWithMetaFields(i * 10)); + } + + // Write with metadata population enabled + StoragePath path = new StoragePath(tempDir.getAbsolutePath() + "/test_filter_candidates.lance"); + try (HoodieSparkLanceReader reader = writeAndCreateReader(path, schema, rows, true)) { + // Create candidate set with 3 specific keys + Set<String> candidateKeys = new HashSet<>(); + candidateKeys.add("key2"); + candidateKeys.add("key5"); + candidateKeys.add("key7"); + + // Filter row keys + Set<Pair<String, Long>> result = reader.filterRowKeys(candidateKeys); + + // Verify result contains exactly the expected key-position pairs + Set<Pair<String, Long>> expected = Set.of( + Pair.of("key2", 2L), + Pair.of("key5", 5L), + Pair.of("key7", 7L) + ); + assertEquals(expected, result, "Should contain exactly the expected key-position pairs"); + } + } + + private static Stream<Arguments> filterRowKeysInputParams() { + return Stream.of( + Arguments.of(Collections.emptySet()), + Arguments.of((Set<String>) null) + ); + } + + @ParameterizedTest + @MethodSource("filterRowKeysInputParams") + public void testFilterRowKeysReturnsAllKeys(Set<String> candidateKeys) throws Exception { + // Create schema with all 5 Hudi metadata fields + StructType schema = new StructType() + .add(HoodieRecord.COMMIT_TIME_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.COMMIT_SEQNO_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.RECORD_KEY_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.PARTITION_PATH_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.FILENAME_METADATA_FIELD, DataTypes.StringType, false) + .add("value", DataTypes.IntegerType, true); + + // Create 5 records with placeholder metadata fields + List<InternalRow> rows = new ArrayList<>(); + for (int i = 0; i < 5; i++) { + rows.add(createRowWithMetaFields(i)); + } + + // Write with metadata population enabled + StoragePath path = new StoragePath(tempDir.getAbsolutePath() + "/test_filter.lance"); + try (HoodieSparkLanceReader reader = writeAndCreateReader(path, schema, rows, true)) { + // Filter with candidateKeys - should return all keys for null or empty set + Set<Pair<String, Long>> result = reader.filterRowKeys(candidateKeys); + + // Verify all 5 keys are returned with correct positions + Set<Pair<String, Long>> expected = Set.of( + Pair.of("key0", 0L), + Pair.of("key1", 1L), + Pair.of("key2", 2L), + Pair.of("key3", 3L), + Pair.of("key4", 4L) + ); + assertEquals(expected, result, "Filter should return all keys with correct positions"); + } + } + + @Test + public void testFilterRowKeysNoMatches() throws Exception { + // Create schema with all 5 Hudi metadata fields + StructType schema = new StructType() + .add(HoodieRecord.COMMIT_TIME_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.COMMIT_SEQNO_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.RECORD_KEY_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.PARTITION_PATH_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.FILENAME_METADATA_FIELD, DataTypes.StringType, false) + .add("value", DataTypes.IntegerType, true); + + // Create 5 records with placeholder metadata fields + List<InternalRow> rows = new ArrayList<>(); + for (int i = 0; i < 5; i++) { + rows.add(createRowWithMetaFields(i)); + } + + // Write with metadata population enabled + StoragePath path = new StoragePath(tempDir.getAbsolutePath() + "/test_filter_no_match.lance"); + try (HoodieSparkLanceReader reader = writeAndCreateReader(path, schema, rows, true)) { + // Filter with candidates that don't exist + Set<String> candidateKeys = new HashSet<>(); + candidateKeys.add("key999"); + candidateKeys.add("key888"); + candidateKeys.add("nonexistent"); + + Set<Pair<String, Long>> result = reader.filterRowKeys(candidateKeys); + + // Verify result is empty + assertEquals(0, result.size(), "Should return empty set when no keys match"); + } + } + + @Test + public void testReadWithMetadataPopulation() throws Exception { + // Create schema WITH all 5 Hudi metadata fields + user fields + StructType schema = new StructType() + .add(HoodieRecord.COMMIT_TIME_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.COMMIT_SEQNO_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.RECORD_KEY_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.PARTITION_PATH_METADATA_FIELD, DataTypes.StringType, false) + .add(HoodieRecord.FILENAME_METADATA_FIELD, DataTypes.StringType, false) + .add("id", DataTypes.IntegerType, false) + .add("name", DataTypes.StringType, true) + .add("age", DataTypes.LongType, true); + + // Create rows WITH placeholder metadata fields (empty strings) + user data + List<InternalRow> rows = new ArrayList<>(); + rows.add(createRowWithMetaFields(1, "Alice", 30L)); + rows.add(createRowWithMetaFields(2, "Bob", 25L)); + rows.add(createRowWithMetaFields(3, "Charlie", 35L)); + + // Write with populateMetaFields=true - writer should populate the placeholders + StoragePath path = new StoragePath(tempDir.getAbsolutePath() + "/test_metadata_population.lance"); + try (HoodieSparkLanceReader reader = writeAndCreateReader(path, schema, rows, true)) { + // Verify record count + assertEquals(3, reader.getTotalRecords(), "Should have 3 records"); + + // Read all records and verify metadata fields were populated + List<InternalRow> actualRows = readAllRows(reader, schema); + assertEquals(3, actualRows.size(), "Should read 3 records"); + + // Verify first row has populated metadata fields + InternalRow firstRow = actualRows.get(0); + + // Verify metadata fields are populated (not empty placeholders) + assertFalse(firstRow.isNullAt(0), "Commit time should not be null"); + assertEquals(instantTime, firstRow.getUTF8String(0).toString(), "Commit time should match"); + + assertFalse(firstRow.isNullAt(1), "Commit seqno should not be null"); + String seqNo = firstRow.getUTF8String(1).toString(); + assertTrue(seqNo.startsWith(instantTime), "Sequence number should start with instant time"); + + assertFalse(firstRow.isNullAt(2), "Record key should not be null"); + // Record key is set to "key0" by writeAndCreateReader helper + + assertFalse(firstRow.isNullAt(3), "Partition path should not be null"); + assertFalse(firstRow.isNullAt(4), "File name should not be null"); + assertEquals(path.getName(), firstRow.getUTF8String(4).toString(), "File name should match"); + + // Verify user data fields are intact (at positions 5, 6, 7) + assertEquals(1, firstRow.getInt(5), "ID should match"); + assertEquals("Alice", firstRow.getUTF8String(6).toString(), "Name should match"); + assertEquals(30L, firstRow.getLong(7), "Age should match"); + + // Verify all three rows have unique sequence numbers + Set<String> seqNos = new HashSet<>(); + for (InternalRow row : actualRows) { + seqNos.add(row.getUTF8String(1).toString()); + } + assertEquals(3, seqNos.size(), "All sequence numbers should be unique"); + } + } + + /** + * Helper method to read all rows from a reader into a list. + * Converts UnsafeRow to GenericInternalRow by extracting field values using type-specific getters. + */ + private List<InternalRow> readAllRows(HoodieSparkLanceReader reader, StructType schema) throws IOException { + List<InternalRow> rows = new ArrayList<>(); + HoodieSchema hoodieSchema = reader.getSchema(); + + try (ClosableIterator<HoodieRecord<InternalRow>> iterator = reader.getRecordIterator(hoodieSchema)) { + while (iterator.hasNext()) { + HoodieRecord<InternalRow> record = iterator.next(); + InternalRow unsafeRow = record.getData(); + + // Extract all field values from UnsafeRow using type-specific getters + Object[] values = new Object[schema.fields().length]; + for (int i = 0; i < schema.fields().length; i++) { + if (unsafeRow.isNullAt(i)) { + values[i] = null; + } else { + DataType dataType = schema.fields()[i].dataType(); + switch (dataType.typeName().toLowerCase()) { + case "integer": + values[i] = unsafeRow.getInt(i); + break; + case "long": + values[i] = unsafeRow.getLong(i); + break; + case "float": + values[i] = unsafeRow.getFloat(i); + break; + case "double": + values[i] = unsafeRow.getDouble(i); + break; + case "boolean": + values[i] = unsafeRow.getBoolean(i); + break; + case "string": + // Must copy UTF8String to avoid buffer reuse issues + values[i] = unsafeRow.getUTF8String(i).copy(); + break; + case "binary": + // Must clone binary array to avoid buffer reuse issues + values[i] = unsafeRow.getBinary(i).clone(); + break; + default: + values[i] = unsafeRow.get(i, dataType); + break; + } + } + } + rows.add(new GenericInternalRow(values)); Review Comment: ```suggestion rows.add(SafeProjection.create(schema).apply(unsafeRow)); ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
