yihua commented on code in PR #18224: URL: https://github.com/apache/hudi/pull/18224#discussion_r2843313206
########## hudi-utilities/src/main/java/org/apache/hudi/utilities/sources/helpers/KinesisOffsetGen.java: ########## @@ -0,0 +1,500 @@ +/* + * 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.utilities.sources.helpers; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.common.table.checkpoint.Checkpoint; +import org.apache.hudi.common.util.Option; +import org.apache.hudi.utilities.exception.HoodieReadFromSourceException; +import org.apache.hudi.utilities.config.KinesisSourceConfig; +import org.apache.hudi.utilities.ingestion.HoodieIngestionMetrics; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; +import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; +import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.kinesis.KinesisClient; +import software.amazon.awssdk.services.kinesis.KinesisClientBuilder; +import software.amazon.awssdk.services.kinesis.model.ExpiredIteratorException; +import software.amazon.awssdk.services.kinesis.model.GetRecordsRequest; +import software.amazon.awssdk.services.kinesis.model.GetRecordsResponse; +import software.amazon.awssdk.services.kinesis.model.GetShardIteratorRequest; +import software.amazon.awssdk.services.kinesis.model.InvalidArgumentException; +import software.amazon.awssdk.services.kinesis.model.LimitExceededException; +import software.amazon.awssdk.services.kinesis.model.ListShardsRequest; +import software.amazon.awssdk.services.kinesis.model.ListShardsResponse; +import software.amazon.awssdk.services.kinesis.model.ProvisionedThroughputExceededException; +import software.amazon.awssdk.services.kinesis.model.ResourceNotFoundException; +import software.amazon.awssdk.services.kinesis.model.Record; +import software.amazon.awssdk.services.kinesis.model.Shard; +import software.amazon.awssdk.services.kinesis.model.ShardIteratorType; + +import java.net.URI; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +import static org.apache.hudi.common.util.ConfigUtils.checkRequiredConfigProperties; +import static org.apache.hudi.common.util.ConfigUtils.getBooleanWithAltKeys; +import static org.apache.hudi.common.util.ConfigUtils.getLongWithAltKeys; +import static org.apache.hudi.common.util.ConfigUtils.getStringWithAltKeys; + +/** + * Helper for reading from Kinesis Data Streams and managing checkpoints. + * Checkpoint format: streamName,shardId:sequenceNumber,shardId:sequenceNumber,... + */ +@Slf4j +@Getter +public class KinesisOffsetGen { + + public static class CheckpointUtils { + /** Separator between lastSeq and endSeq for closed shards. Seq numbers are numeric, so this is safe. */ + private static final String END_SEQ_SEPARATOR = "|"; + /** + * Kinesis checkpoint pattern. + * Format: streamName,shardId:lastSeq,shardId:lastSeq|endSeq,... + * For closed shards we store lastSeq|endSeq so we can detect data loss when shard expires. + */ + private static final Pattern PATTERN = Pattern.compile(".*,.*:.*"); + + /** + * Parse checkpoint string to shardId -> value map. Value is lastSeq or lastSeq|endSeq for closed shards. + */ + public static Map<String, String> strToOffsets(String checkpointStr) { + Map<String, String> offsetMap = new HashMap<>(); + String[] splits = checkpointStr.split(","); + for (int i = 1; i < splits.length; i++) { + String part = splits[i]; + int colonIdx = part.indexOf(':'); + if (colonIdx > 0 && colonIdx < part.length() - 1) { + String shardId = part.substring(0, colonIdx); + String value = part.substring(colonIdx + 1); + offsetMap.put(shardId, value); + } + } + return offsetMap; + } + + /** + * Extract lastSeq from checkpoint value (which may be "lastSeq" or "lastSeq|endSeq"). + */ + public static String getLastSeqFromValue(String value) { + if (value == null || value.isEmpty()) { + return value; + } + int sep = value.indexOf(END_SEQ_SEPARATOR); + return sep >= 0 ? value.substring(0, sep) : value; + } + + /** + * Extract endSeq from checkpoint value if present. Returns null for open shards. + */ + public static String getEndSeqFromValue(String value) { + if (value == null || value.isEmpty()) { + return null; + } + int sep = value.indexOf(END_SEQ_SEPARATOR); + return sep >= 0 && sep < value.length() - 1 ? value.substring(sep + 1) : null; + } + + /** + * Build checkpoint value: "lastSeq" or "lastSeq|endSeq" when endSeq is present (closed shards). + */ + public static String buildCheckpointValue(String lastSeq, String endSeq) { + if (endSeq != null && !endSeq.isEmpty()) { + return lastSeq + END_SEQ_SEPARATOR + endSeq; + } + return lastSeq; + } + + /** + * String representation of checkpoint. + * Format: streamName,shardId:value,shardId:value,... where value is lastSeq or lastSeq|endSeq. + */ + public static String offsetsToStr(String streamName, Map<String, String> shardToValue) { + String parts = shardToValue.entrySet().stream() + .sorted(Map.Entry.comparingByKey()) + .map(e -> e.getKey() + ":" + e.getValue()) + .collect(Collectors.joining(",")); + return streamName + "," + parts; + } + + public static boolean checkStreamCheckpoint(Option<String> lastCheckpointStr) { Review Comment: ```suggestion public static boolean isStreamCheckpointValid(Option<String> lastCheckpointStr) { ``` ########## hudi-utilities/src/main/java/org/apache/hudi/utilities/sources/helpers/KinesisOffsetGen.java: ########## @@ -0,0 +1,500 @@ +/* + * 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.utilities.sources.helpers; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.common.table.checkpoint.Checkpoint; +import org.apache.hudi.common.util.Option; +import org.apache.hudi.utilities.exception.HoodieReadFromSourceException; +import org.apache.hudi.utilities.config.KinesisSourceConfig; +import org.apache.hudi.utilities.ingestion.HoodieIngestionMetrics; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; +import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; +import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.kinesis.KinesisClient; +import software.amazon.awssdk.services.kinesis.KinesisClientBuilder; +import software.amazon.awssdk.services.kinesis.model.ExpiredIteratorException; +import software.amazon.awssdk.services.kinesis.model.GetRecordsRequest; +import software.amazon.awssdk.services.kinesis.model.GetRecordsResponse; +import software.amazon.awssdk.services.kinesis.model.GetShardIteratorRequest; +import software.amazon.awssdk.services.kinesis.model.InvalidArgumentException; +import software.amazon.awssdk.services.kinesis.model.LimitExceededException; +import software.amazon.awssdk.services.kinesis.model.ListShardsRequest; +import software.amazon.awssdk.services.kinesis.model.ListShardsResponse; +import software.amazon.awssdk.services.kinesis.model.ProvisionedThroughputExceededException; +import software.amazon.awssdk.services.kinesis.model.ResourceNotFoundException; +import software.amazon.awssdk.services.kinesis.model.Record; +import software.amazon.awssdk.services.kinesis.model.Shard; +import software.amazon.awssdk.services.kinesis.model.ShardIteratorType; + +import java.net.URI; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +import static org.apache.hudi.common.util.ConfigUtils.checkRequiredConfigProperties; +import static org.apache.hudi.common.util.ConfigUtils.getBooleanWithAltKeys; +import static org.apache.hudi.common.util.ConfigUtils.getLongWithAltKeys; +import static org.apache.hudi.common.util.ConfigUtils.getStringWithAltKeys; + +/** + * Helper for reading from Kinesis Data Streams and managing checkpoints. + * Checkpoint format: streamName,shardId:sequenceNumber,shardId:sequenceNumber,... + */ +@Slf4j +@Getter +public class KinesisOffsetGen { + + public static class CheckpointUtils { + /** Separator between lastSeq and endSeq for closed shards. Seq numbers are numeric, so this is safe. */ + private static final String END_SEQ_SEPARATOR = "|"; + /** + * Kinesis checkpoint pattern. + * Format: streamName,shardId:lastSeq,shardId:lastSeq|endSeq,... + * For closed shards we store lastSeq|endSeq so we can detect data loss when shard expires. + */ + private static final Pattern PATTERN = Pattern.compile(".*,.*:.*"); + + /** + * Parse checkpoint string to shardId -> value map. Value is lastSeq or lastSeq|endSeq for closed shards. + */ + public static Map<String, String> strToOffsets(String checkpointStr) { + Map<String, String> offsetMap = new HashMap<>(); + String[] splits = checkpointStr.split(","); + for (int i = 1; i < splits.length; i++) { + String part = splits[i]; + int colonIdx = part.indexOf(':'); + if (colonIdx > 0 && colonIdx < part.length() - 1) { + String shardId = part.substring(0, colonIdx); + String value = part.substring(colonIdx + 1); + offsetMap.put(shardId, value); + } + } + return offsetMap; + } + + /** + * Extract lastSeq from checkpoint value (which may be "lastSeq" or "lastSeq|endSeq"). + */ + public static String getLastSeqFromValue(String value) { + if (value == null || value.isEmpty()) { + return value; + } + int sep = value.indexOf(END_SEQ_SEPARATOR); + return sep >= 0 ? value.substring(0, sep) : value; + } + + /** + * Extract endSeq from checkpoint value if present. Returns null for open shards. + */ + public static String getEndSeqFromValue(String value) { + if (value == null || value.isEmpty()) { + return null; + } + int sep = value.indexOf(END_SEQ_SEPARATOR); + return sep >= 0 && sep < value.length() - 1 ? value.substring(sep + 1) : null; + } + + /** + * Build checkpoint value: "lastSeq" or "lastSeq|endSeq" when endSeq is present (closed shards). + */ + public static String buildCheckpointValue(String lastSeq, String endSeq) { + if (endSeq != null && !endSeq.isEmpty()) { + return lastSeq + END_SEQ_SEPARATOR + endSeq; + } + return lastSeq; + } + + /** + * String representation of checkpoint. + * Format: streamName,shardId:value,shardId:value,... where value is lastSeq or lastSeq|endSeq. + */ + public static String offsetsToStr(String streamName, Map<String, String> shardToValue) { + String parts = shardToValue.entrySet().stream() + .sorted(Map.Entry.comparingByKey()) + .map(e -> e.getKey() + ":" + e.getValue()) + .collect(Collectors.joining(",")); + return streamName + "," + parts; + } + + public static boolean checkStreamCheckpoint(Option<String> lastCheckpointStr) { + return lastCheckpointStr.isPresent() && PATTERN.matcher(lastCheckpointStr.get()).matches(); + } + } + + /** LocalStack returns Long.MAX_VALUE for closed shards' endingSequenceNumber; real AWS returns actual value. */ + public static final String LOCALSTACK_END_SEQ_SENTINEL = "9223372036854775807"; + + /** + * Represents a shard to read from, with optional starting sequence number. + * For closed shards, endingSequenceNumber is set so we can store it in the checkpoint + * and later detect data loss when the shard expires. + */ + @AllArgsConstructor + @Getter + public static class KinesisShardRange implements java.io.Serializable { + private final String shardId; + /** If empty, use TRIM_HORIZON or LATEST based on config. */ + private final Option<String> startingSequenceNumber; + /** For closed shards: the shard's ending sequence number. Empty for open shards. */ + private final Option<String> endingSequenceNumber; + + public static KinesisShardRange of(String shardId, Option<String> seqNum) { + return new KinesisShardRange(shardId, seqNum, Option.empty()); + } + + public static KinesisShardRange of(String shardId, Option<String> seqNum, Option<String> endSeq) { + return new KinesisShardRange(shardId, seqNum, endSeq); + } + + /** + * Returns true if this range may have unread records, false if we can definitively determine it has none. + * Uses conservative default (useLatestWhenNoCheckpoint=false). + */ + public boolean hasUnreadRecords() { + return hasUnreadRecords(false); + } + + /** + * Returns true if this range may have unread records, false if we can definitively determine it has none. + * <ul> + * <li>Open shard: always true (may have new records)</li> + * <li>Closed shard, lastSeq >= endSeq: false (fully consumed)</li> + * <li>Closed shard, no checkpoint and useLatest: false (at LATEST tip, closed shard has no records)</li> + * <li>Closed shard with LocalStack endSeq sentinel and lastSeq equals sentinel: false (fully consumed)</li> + * <li>Otherwise: true (may have unread records or cannot definitively say)</li> + * </ul> + * + * @param useLatestWhenNoCheckpoint when startingSequenceNumber is empty, true means we use LATEST + * (start at tip); for a closed shard there are no records to read + */ + public boolean hasUnreadRecords(boolean useLatestWhenNoCheckpoint) { + String lastSeq = startingSequenceNumber.orElse(null); + String endSeq = endingSequenceNumber.orElse(null); + + // Open shard: may have records + if (endSeq == null || endSeq.isEmpty()) { + return true; + } + + // Closed shard with no checkpoint + if (lastSeq == null || lastSeq.isEmpty()) { + return !useLatestWhenNoCheckpoint; + } + + // Closed shard: lastSeq >= endSeq means fully consumed + if (lastSeq.compareTo(endSeq) >= 0) { + return false; + } + + // LocalStack sentinel: when lastSeq equals sentinel, we've fully consumed + if (LOCALSTACK_END_SEQ_SENTINEL.equals(endSeq) && LOCALSTACK_END_SEQ_SENTINEL.equals(lastSeq)) { + return false; + } + + // lastSeq < endSeq or ambiguous (e.g. LocalStack sentinel): may have unread records + return true; + } + } + + private final String streamName; + private final String region; + private final Option<String> endpointUrl; + private final KinesisSourceConfig.KinesisStartingPosition startingPosition; + private final TypedProperties props; + + public KinesisOffsetGen(TypedProperties props) { + this.props = props; + checkRequiredConfigProperties(props, + Arrays.asList(KinesisSourceConfig.KINESIS_STREAM_NAME, KinesisSourceConfig.KINESIS_REGION)); + this.streamName = getStringWithAltKeys(props, KinesisSourceConfig.KINESIS_STREAM_NAME); + this.region = getStringWithAltKeys(props, KinesisSourceConfig.KINESIS_REGION); + this.endpointUrl = Option.ofNullable(getStringWithAltKeys(props, KinesisSourceConfig.KINESIS_ENDPOINT_URL, null)); + String posStr = getStringWithAltKeys(props, KinesisSourceConfig.KINESIS_STARTING_POSITION, true); + String normalized = posStr.toUpperCase().replace("EARLIEST", "TRIM_HORIZON"); + this.startingPosition = KinesisSourceConfig.KinesisStartingPosition.valueOf(normalized); + } + + public KinesisClient createKinesisClient() { + KinesisClientBuilder builder = KinesisClient.builder().region(Region.of(region)); + if (endpointUrl.isPresent()) { + builder = builder.endpointOverride(URI.create(endpointUrl.get())); + } + String accessKey = getStringWithAltKeys(props, KinesisSourceConfig.KINESIS_ACCESS_KEY, null); + String secretKey = getStringWithAltKeys(props, KinesisSourceConfig.KINESIS_SECRET_KEY, null); + if (accessKey != null && !accessKey.isEmpty() && secretKey != null && !secretKey.isEmpty()) { + builder = builder.credentialsProvider( + StaticCredentialsProvider.create(AwsBasicCredentials.create(accessKey, secretKey))); + } + return builder.build(); + } + + /** + * List all active shards for the stream. + * Note: AWS API disallows streamName and nextToken in the same request. + */ + public List<Shard> listShards(KinesisClient client) { + List<Shard> allShards = new ArrayList<>(); + String nextToken = null; + do { + ListShardsRequest request = nextToken != null + ? ListShardsRequest.builder().nextToken(nextToken).build() + : ListShardsRequest.builder().streamName(streamName).build(); + ListShardsResponse response; + try { + response = client.listShards(request); + } catch (ResourceNotFoundException e) { + throw new HoodieReadFromSourceException("Kinesis stream " + streamName + " not found", e); + } catch (ProvisionedThroughputExceededException e) { + throw new HoodieReadFromSourceException("Kinesis throughput exceeded listing shards for " + streamName, e); + } catch (LimitExceededException e) { + throw new HoodieReadFromSourceException("Kinesis limit exceeded listing shards: " + e.getMessage(), e); + } + allShards.addAll(response.shards()); + nextToken = response.nextToken(); + } while (nextToken != null); + + // Include both open and closed shards. Closed shards (e.g., from resharding) may still contain + // unread records within the retention period. GetRecords works on closed shards until all data + // is consumed, at which point NextShardIterator returns null. + long openCount = allShards.stream() + .filter(s -> s.sequenceNumberRange() != null && s.sequenceNumberRange().endingSequenceNumber() == null) + .count(); + log.info("Found {} shards for stream {} ({} open, {} closed)", + allShards.size(), streamName, openCount, allShards.size() - openCount); + return allShards; + } + + /** + * Get shard ranges to read, based on checkpoint and limits. + */ + public KinesisShardRange[] getNextShardRanges(Option<Checkpoint> lastCheckpoint, + long sourceLimit, + HoodieIngestionMetrics metrics) { + long maxEvents = getLongWithAltKeys(props, KinesisSourceConfig.MAX_EVENTS_FROM_KINESIS_SOURCE); + long numEvents = sourceLimit == Long.MAX_VALUE ? maxEvents : Math.min(sourceLimit, maxEvents); + long minPartitions = getLongWithAltKeys(props, KinesisSourceConfig.KINESIS_SOURCE_MIN_PARTITIONS); + log.info("getNextShardRanges set config {} to {}", KinesisSourceConfig.KINESIS_SOURCE_MIN_PARTITIONS.key(), minPartitions); + + try (KinesisClient client = createKinesisClient()) { + // List all open and closed shards. + List<Shard> shards = listShards(client); + if (shards.isEmpty()) { + return new KinesisShardRange[0]; + } + + Map<String, String> fromSequenceNumbers = new HashMap<>(); + Option<String> lastCheckpointStr = lastCheckpoint.isPresent() + ? Option.of(lastCheckpoint.get().getCheckpointKey()) : Option.empty(); + + // CASE: last checkpoint exists. + if (lastCheckpointStr.isPresent() && CheckpointUtils.checkStreamCheckpoint(lastCheckpointStr)) { + Map<String, String> checkpointOffsets = CheckpointUtils.strToOffsets(lastCheckpointStr.get()); + if (!checkpointOffsets.isEmpty() && lastCheckpointStr.get().startsWith(streamName + ",")) { Review Comment: Add `lastCheckpointStr.get().startsWith(streamName + ",")` to `CheckpointUtils#checkStreamCheckpoint`? -- 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]
