heesung-sn commented on code in PR #18195: URL: https://github.com/apache/pulsar/pull/18195#discussion_r1015805463
########## pulsar-broker/src/main/java/org/apache/pulsar/compaction/StrategicTwoPhaseCompactor.java: ########## @@ -0,0 +1,433 @@ +/* + * 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.pulsar.compaction; + +import io.netty.buffer.ByteBuf; +import java.time.Duration; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; +import org.apache.bookkeeper.client.BKException; +import org.apache.bookkeeper.client.BookKeeper; +import org.apache.bookkeeper.client.LedgerHandle; +import org.apache.bookkeeper.mledger.impl.LedgerMetadataUtils; +import org.apache.pulsar.broker.ServiceConfiguration; +import org.apache.pulsar.client.api.Consumer; +import org.apache.pulsar.client.api.CryptoKeyReader; +import org.apache.pulsar.client.api.Message; +import org.apache.pulsar.client.api.MessageId; +import org.apache.pulsar.client.api.PulsarClient; +import org.apache.pulsar.client.api.PulsarClientException; +import org.apache.pulsar.client.api.Reader; +import org.apache.pulsar.client.impl.BatchMessageIdImpl; +import org.apache.pulsar.client.impl.CompactionReaderImpl; +import org.apache.pulsar.client.impl.MessageIdImpl; +import org.apache.pulsar.client.impl.MessageImpl; +import org.apache.pulsar.client.impl.PulsarClientImpl; +import org.apache.pulsar.client.impl.RawBatchMessageContainerImpl; +import org.apache.pulsar.common.topics.TopicCompactionStrategy; +import org.apache.pulsar.common.util.FutureUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Compaction will go through the topic in two passes. The first pass + * selects valid message(defined in the TopicCompactionStrategy.isValid()) + * for each key in the topic. Then, the second pass writes these values + * to a ledger. + * + * <p>As the first pass caches the entire message(not just offset) for each key into a map, + * this compaction could be memory intensive if the message payload is large. + */ +public class StrategicTwoPhaseCompactor extends TwoPhaseCompactor { + private static final Logger log = LoggerFactory.getLogger(StrategicTwoPhaseCompactor.class); + private static final int MAX_OUTSTANDING = 500; + private final Duration phaseOneLoopReadTimeout; + private final RawBatchMessageContainerImpl batchMessageContainer; + + public StrategicTwoPhaseCompactor(ServiceConfiguration conf, + PulsarClient pulsar, + BookKeeper bk, + ScheduledExecutorService scheduler, + int maxNumMessagesInBatch) { + super(conf, pulsar, bk, scheduler); + batchMessageContainer = new RawBatchMessageContainerImpl(maxNumMessagesInBatch); + phaseOneLoopReadTimeout = Duration.ofSeconds(conf.getBrokerServiceCompactionPhaseOneLoopTimeInSeconds()); + } + + public StrategicTwoPhaseCompactor(ServiceConfiguration conf, + PulsarClient pulsar, + BookKeeper bk, + ScheduledExecutorService scheduler) { + this(conf, pulsar, bk, scheduler, -1); + } + + public CompletableFuture<Long> compact(String topic) { + throw new UnsupportedOperationException(); + } + + + public <T> CompletableFuture<Long> compact(String topic, + TopicCompactionStrategy<T> strategy) { + return compact(topic, strategy, null); + } + + public <T> CompletableFuture<Long> compact(String topic, + TopicCompactionStrategy<T> strategy, + CryptoKeyReader cryptoKeyReader) { + CompletableFuture<Consumer<T>> consumerFuture = new CompletableFuture<>(); + if (cryptoKeyReader != null) { + batchMessageContainer.setCryptoKeyReader(cryptoKeyReader); + } + CompactionReaderImpl reader = CompactionReaderImpl.create( + (PulsarClientImpl) pulsar, strategy.getSchema(), topic, consumerFuture, cryptoKeyReader); + + return consumerFuture.thenComposeAsync(__ -> compactAndCloseReader(reader, strategy), scheduler); + } + + <T> CompletableFuture<Long> doCompaction(Reader<T> reader, TopicCompactionStrategy strategy) { + + if (!(reader instanceof CompactionReaderImpl<T>)) { + return CompletableFuture.failedFuture( + new IllegalStateException("reader has to be DelayedAckReaderImpl")); + } + return reader.hasMessageAvailableAsync() + .thenCompose(available -> { + if (available) { + return phaseOne(reader, strategy) + .thenCompose((result) -> phaseTwo(result, reader, bk)); + } else { + log.info("Skip compaction of the empty topic {}", reader.getTopic()); + return CompletableFuture.completedFuture(-1L); + } + }); + } + + <T> CompletableFuture<Long> compactAndCloseReader(Reader<T> reader, TopicCompactionStrategy strategy) { + CompletableFuture<Long> promise = new CompletableFuture<>(); + mxBean.addCompactionStartOp(reader.getTopic()); + doCompaction(reader, strategy).whenComplete( + (ledgerId, exception) -> { + log.info("Completed doCompaction ledgerId:{}", ledgerId); + reader.closeAsync().whenComplete((v, exception2) -> { + if (exception2 != null) { + log.warn("Error closing reader handle {}, ignoring", reader, exception2); + } + if (exception != null) { + // complete with original exception + mxBean.addCompactionEndOp(reader.getTopic(), false); + promise.completeExceptionally(exception); + } else { + mxBean.addCompactionEndOp(reader.getTopic(), true); + promise.complete(ledgerId); + } + }); + }); + return promise; + } + + private <T> boolean doCompactMessage( + Message<T> msg, PhaseOneResult<T> result, TopicCompactionStrategy<T> strategy) { + Map<String, Message<T>> cache = result.cache; + String key = msg.getKey(); + + if (key == null) { + msg.release(); + return true; + } + T val = msg.getValue(); + Message<T> prev = cache.get(key); + T prevVal = prev == null ? null : prev.getValue(); + + if (!strategy.shouldKeepLeft(prevVal, val)) { + if (val != null && msg.size() > 0) { + cache.remove(key); // to reorder + cache.put(key, msg); + } else { + cache.remove(key); + msg.release(); + } + + if (prev != null) { + prev.release(); + } + + result.validCompactionCount.incrementAndGet(); + return true; + } else { + msg.release(); + result.invalidCompactionCount.incrementAndGet(); + return false; + } + + } + + private static class PhaseOneResult<T> { + MessageId firstId; + MessageId lastId; // last read messageId + Map<String, Message<T>> cache; + + AtomicInteger invalidCompactionCount; + + AtomicInteger validCompactionCount; + + AtomicInteger numReadMessages; + + String topic; + + PhaseOneResult(String topic) { + this.topic = topic; + cache = new LinkedHashMap<>(); + invalidCompactionCount = new AtomicInteger(); + validCompactionCount = new AtomicInteger(); + numReadMessages = new AtomicInteger(); + } + + @Override + public String toString() { + return String.format( + "{Topic:%s, firstId:%s, lastId:%s, cache.size:%d, " + + "invalidCompactionCount:%d, validCompactionCount:%d, numReadMessages:%d}", + topic, + firstId != null ? firstId.toString() : "", + lastId != null ? lastId.toString() : "", + cache.size(), + invalidCompactionCount.get(), + validCompactionCount.get(), + numReadMessages.get()); + } + } + + + private <T> CompletableFuture<PhaseOneResult> phaseOne(Reader<T> reader, TopicCompactionStrategy strategy) { + CompletableFuture<PhaseOneResult> promise = new CompletableFuture<>(); + PhaseOneResult<T> result = new PhaseOneResult(reader.getTopic()); + + ((CompactionReaderImpl<T>) reader).getLastMessageIdAsync() + .thenAccept(lastMessageId -> { + log.info("Commencing phase one of compaction for {}, reading to {}", + reader.getTopic(), lastMessageId); + result.lastId = copyMessageId(lastMessageId); + phaseOneLoop(reader, promise, result, strategy); + }).exceptionally(ex -> { + promise.completeExceptionally(ex); + return null; + }); + + return promise; + + } + + private static MessageId copyMessageId(MessageId msgId) { + if (msgId instanceof BatchMessageIdImpl) { + BatchMessageIdImpl tempId = (BatchMessageIdImpl) msgId; + return new BatchMessageIdImpl(tempId); + } else if (msgId instanceof MessageIdImpl) { + MessageIdImpl tempId = (MessageIdImpl) msgId; + return new MessageIdImpl(tempId.getLedgerId(), tempId.getEntryId(), + tempId.getPartitionIndex()); + } else { + throw new IllegalStateException("Unknown lastMessageId type"); + } + } + + private <T> void phaseOneLoop(Reader<T> reader, CompletableFuture<PhaseOneResult> promise, + PhaseOneResult<T> result, TopicCompactionStrategy<T> strategy) { + + if (promise.isDone()) { + return; + } + + CompletableFuture<Message<T>> future = reader.readNextAsync(); + FutureUtil.addTimeoutHandling(future, + phaseOneLoopReadTimeout, scheduler, + () -> FutureUtil.createTimeoutException("Timeout", getClass(), + "phaseOneLoop(...)")); + + future.thenAcceptAsync(msg -> { + + MessageId id = msg.getMessageId(); + boolean completed = false; + if (result.lastId.compareTo(id) == 0) { + completed = true; + } + + result.numReadMessages.incrementAndGet(); + mxBean.addCompactionReadOp(reader.getTopic(), msg.size()); + if (doCompactMessage(msg, result, strategy)) { + mxBean.addCompactionRemovedEvent(reader.getTopic()); + } + //set ids in the result + if (result.firstId == null) { + result.firstId = copyMessageId(id); + log.info("Resetting cursor to firstId:{}", result.firstId); + try { + reader.seek(result.firstId); + } catch (PulsarClientException e) { + throw new RuntimeException("Failed to reset the cursor to firstId:" + result.firstId, e); + } + } + if (completed) { + promise.complete(result); + } else { + phaseOneLoop(reader, promise, result, strategy); + } + + }, scheduler).exceptionally(ex -> { + promise.completeExceptionally(ex); + return null; + }); + + } + + private <T> CompletableFuture<Long> phaseTwo(PhaseOneResult<T> phaseOneResult, Reader<T> reader, BookKeeper bk) { + log.info("Completed phase one. Result:{}. ", phaseOneResult); + Map<String, byte[]> metadata = + LedgerMetadataUtils.buildMetadataForCompactedLedger( + phaseOneResult.topic, phaseOneResult.lastId.toByteArray()); + return createLedger(bk, metadata) + .thenCompose((ledger) -> { + log.info( + "Commencing phase two of compaction for {}, from {} to {}, compacting {} keys to ledger {}", + phaseOneResult.topic, phaseOneResult.firstId, phaseOneResult.lastId, + phaseOneResult.cache.size(), ledger.getId()); + return runPhaseTwo(phaseOneResult, reader, ledger, bk); + }); + } + + private <T> CompletableFuture<Long> runPhaseTwo( + PhaseOneResult<T> phaseOneResult, Reader<T> reader, LedgerHandle ledger, BookKeeper bk) { + CompletableFuture<Long> promise = new CompletableFuture<>(); + Semaphore outstanding = new Semaphore(MAX_OUTSTANDING); + CompletableFuture<Void> loopPromise = new CompletableFuture<>(); + phaseTwoLoop(phaseOneResult.topic, phaseOneResult.cache.values().iterator(), ledger, + outstanding, loopPromise); + loopPromise.thenCompose((v) -> { + log.info("Flushing batch container numMessagesInBatch:{}", + batchMessageContainer.getNumMessagesInBatch()); + return addToCompactedLedger(ledger, null, reader.getTopic(), outstanding) + .whenComplete((res, exception2) -> { + if (exception2 != null) { + promise.completeExceptionally(exception2); + return; + } + }); + }) + .thenCompose(v -> { + log.info("Acking ledger id {}", phaseOneResult.firstId); + return ((CompactionReaderImpl<T>) reader) + .acknowledgeCumulativeAsync( + phaseOneResult.lastId, Map.of(COMPACTED_TOPIC_LEDGER_PROPERTY, + ledger.getId())); + }) + .thenCompose((v) -> closeLedger(ledger)) + .whenComplete((v, exception) -> { + if (exception != null) { + deleteLedger(bk, ledger).whenComplete((res2, exception2) -> { + if (exception2 != null) { + log.error("Cleanup of ledger {} for failed", ledger, exception2); + } + // complete with original exception + promise.completeExceptionally(exception); + }); + } else { + log.info("kept ledger:{}", ledger.getId()); + promise.complete(ledger.getId()); + } + }); + + return promise; + } + + private <T> void phaseTwoLoop(String topic, Iterator<Message<T>> reader, + LedgerHandle lh, Semaphore outstanding, + CompletableFuture<Void> promise) { + if (promise.isDone()) { + return; + } + CompletableFuture.runAsync(() -> { + if (reader.hasNext()) { + Message<T> message = reader.next(); + mxBean.addCompactionReadOp(topic, message.size()); + addToCompactedLedger(lh, message, topic, outstanding) + .whenComplete((res, exception2) -> { + outstanding.release(); + if (exception2 != null) { + promise.completeExceptionally(exception2); + return; + } + }); + phaseTwoLoop(topic, reader, lh, outstanding, promise); Review Comment: No. We don't want to wait for each `addToCompactedLedger` call to complete for high concurrency (this concurrency is limited by the semaphore, `outstanding`). -- 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]
