alexeykudinkin commented on code in PR #5416: URL: https://github.com/apache/hudi/pull/5416#discussion_r998654598
########## hudi-client/hudi-spark-client/src/main/java/org/apache/hudi/util/QueueBasedExecutorFactory.java: ########## @@ -0,0 +1,52 @@ +/* + * 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.util; + +import org.apache.hudi.common.util.queue.BoundedInMemoryExecutor; +import org.apache.hudi.common.util.queue.DisruptorExecutor; +import org.apache.hudi.common.util.queue.ExecutorType; +import org.apache.hudi.common.util.queue.HoodieExecutor; +import org.apache.hudi.common.util.queue.IteratorBasedQueueConsumer; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieException; + +import java.util.Iterator; +import java.util.function.Function; + +public class QueueBasedExecutorFactory { + + /** + * Create a new hoodie executor instance on demand. + */ + public static HoodieExecutor create(HoodieWriteConfig hoodieConfig, Iterator inputItr, IteratorBasedQueueConsumer consumer, Review Comment: Let's make sure we're not dropping generics params ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/DisruptorMessageQueue.java: ########## @@ -0,0 +1,133 @@ +/* + * 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.common.util.queue; + +import com.lmax.disruptor.EventFactory; +import com.lmax.disruptor.EventHandler; +import com.lmax.disruptor.EventTranslator; +import com.lmax.disruptor.RingBuffer; +import com.lmax.disruptor.WaitStrategy; +import com.lmax.disruptor.dsl.Disruptor; +import com.lmax.disruptor.dsl.ProducerType; +import org.apache.hudi.common.util.Option; +import org.apache.log4j.LogManager; +import org.apache.log4j.Logger; + +import java.util.function.Function; + +public class DisruptorMessageQueue<I, O> implements HoodieMessageQueue<I, O> { + + private static final Logger LOG = LogManager.getLogger(DisruptorMessageQueue.class); + + private final Disruptor<HoodieDisruptorEvent> queue; + private final Function<I, O> transformFunction; + private final RingBuffer<HoodieDisruptorEvent> ringBuffer; + + public DisruptorMessageQueue(Option<Integer> bufferSize, Function<I, O> transformFunction, Option<String> waitStrategyName, int totalProducers, Runnable preExecuteRunnable) { + WaitStrategy waitStrategy = WaitStrategyFactory.build(waitStrategyName); + HoodieDaemonThreadFactory threadFactory = new HoodieDaemonThreadFactory(preExecuteRunnable); + + this.queue = new Disruptor<>(new HoodieDisruptorEventFactory(), bufferSize.get(), threadFactory, totalProducers > 1 ? ProducerType.MULTI : ProducerType.SINGLE, waitStrategy); + this.ringBuffer = queue.getRingBuffer(); + this.transformFunction = transformFunction; + } + + @Override + public long size() { + return queue.getBufferSize(); + } + + @Override + public void insertRecord(I value) throws Exception { + O applied = transformFunction.apply(value); + + EventTranslator<HoodieDisruptorEvent> translator = new EventTranslator<HoodieDisruptorEvent>() { + @Override + public void translateTo(HoodieDisruptorEvent event, long sequence) { + event.set(applied); + } + }; + + queue.getRingBuffer().publishEvent(translator); + } + + @Override + public Option<O> readNextRecord() { + // Let DisruptorMessageHandler to handle consuming logic. Review Comment: We should throw `UnsupportedOperationException` in here ########## hudi-client/hudi-spark-client/src/test/java/org/apache/hudi/execution/TestDisruptorExecutionInSpark.java: ########## @@ -0,0 +1,159 @@ +/* + * 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.execution; + +import static org.apache.hudi.execution.HoodieLazyInsertIterable.getTransformFunction; + +import org.apache.avro.generic.IndexedRecord; +import org.apache.hudi.common.model.HoodieRecord; +import org.apache.hudi.common.table.timeline.HoodieActiveTimeline; +import org.apache.hudi.common.testutils.HoodieTestDataGenerator; +import org.apache.hudi.common.util.Option; +import org.apache.hudi.common.util.queue.IteratorBasedQueueConsumer; +import org.apache.hudi.common.util.queue.DisruptorExecutor; +import org.apache.hudi.common.util.queue.WaitStrategyFactory; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieException; +import org.apache.hudi.testutils.HoodieClientTestHarness; +import org.apache.spark.TaskContext; +import org.apache.spark.TaskContext$; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +import java.util.ArrayList; +import java.util.List; + +import scala.Tuple2; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class TestDisruptorExecutionInSpark extends HoodieClientTestHarness { + + private final String instantTime = HoodieActiveTimeline.createNewInstantTime(); + + @BeforeEach + public void setUp() throws Exception { + initTestDataGenerator(); + initExecutorServiceWithFixedThreadPool(2); + } + + @AfterEach + public void tearDown() throws Exception { + cleanupResources(); + } + + private Runnable getPreExecuteRunnable() { + final TaskContext taskContext = TaskContext.get(); + return () -> TaskContext$.MODULE$.setTaskContext(taskContext); + } + + @Test + public void testExecutor() { + + final List<HoodieRecord> hoodieRecords = dataGen.generateInserts(instantTime, 128); + final List<HoodieRecord> consumedRecords = new ArrayList<>(); + + HoodieWriteConfig hoodieWriteConfig = mock(HoodieWriteConfig.class); + when(hoodieWriteConfig.getWriteBufferSize()).thenReturn(Option.of(8)); + IteratorBasedQueueConsumer<HoodieLazyInsertIterable.HoodieInsertValueGenResult<HoodieRecord>, Integer> consumer = + new IteratorBasedQueueConsumer<HoodieLazyInsertIterable.HoodieInsertValueGenResult<HoodieRecord>, Integer>() { + + private int count = 0; + + @Override + public void consumeOneRecord(HoodieLazyInsertIterable.HoodieInsertValueGenResult<HoodieRecord> record) { + consumedRecords.add(record.record); + count++; + } + + @Override + protected Integer getResult() { + return count; + } + }; + DisruptorExecutor<HoodieRecord, Tuple2<HoodieRecord, Option<IndexedRecord>>, Integer> exec = null; + + try { + exec = new DisruptorExecutor(hoodieWriteConfig.getWriteBufferSize(), hoodieRecords.iterator(), consumer, + getTransformFunction(HoodieTestDataGenerator.AVRO_SCHEMA), Option.of(WaitStrategyFactory.DEFAULT_STRATEGY), getPreExecuteRunnable()); + int result = exec.execute(); + // It should buffer and write 100 records + assertEquals(128, result); + // There should be no remaining records in the buffer + assertFalse(exec.isRemaining()); + + // collect all records and assert that consumed records are identical to produced ones + // assert there's no tampering, and that the ordering is preserved + assertEquals(hoodieRecords.size(), consumedRecords.size()); Review Comment: We can actually just do `assertEquals(oneList, anotherList)` ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/IteratorBasedHoodieMessageQueue.java: ########## @@ -0,0 +1,29 @@ +/* + * 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.common.util.queue; + +import java.util.Iterator; + +/** + * IteratorBasedHoodieMessageQueue implements HoodieMessageQueue with Iterable + */ +public abstract class IteratorBasedHoodieMessageQueue<I, O> implements HoodieMessageQueue<I, O>, Iterable<O> { Review Comment: nit: It's rather `HoodieIterableMessageQueue` ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/WaitStrategyFactory.java: ########## @@ -0,0 +1,57 @@ +/* + * 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.common.util.queue; + +import static org.apache.hudi.common.util.queue.DisruptorWaitStrategyType.BLOCKING_WAIT; + +import com.lmax.disruptor.BlockingWaitStrategy; +import com.lmax.disruptor.BusySpinWaitStrategy; +import com.lmax.disruptor.SleepingWaitStrategy; +import com.lmax.disruptor.WaitStrategy; +import com.lmax.disruptor.YieldingWaitStrategy; +import org.apache.hudi.common.util.Option; +import org.apache.hudi.exception.HoodieException; + +public class WaitStrategyFactory { + + public static final String DEFAULT_STRATEGY = BLOCKING_WAIT.name(); + + /** + * Build WaitStrategy for disruptor + */ + public static WaitStrategy build(Option<String> name) { + if (!name.isPresent()) { + return new BlockingWaitStrategy(); Review Comment: nit: if name is not present we should fallback `strategyType` to default one ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/HoodieExecutorBase.java: ########## @@ -0,0 +1,119 @@ +/* + * 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.common.util.queue; + +import org.apache.hudi.common.util.CustomizedThreadFactory; +import org.apache.hudi.common.util.Option; +import org.apache.hudi.common.util.ValidationUtils; +import org.apache.hudi.exception.HoodieException; +import org.apache.log4j.LogManager; +import org.apache.log4j.Logger; + +import java.util.List; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +/** + * HoodieExecutorBase holds common elements producerExecutorService, consumerExecutorService, producers and a single consumer. + * Also HoodieExecutorBase control the lifecycle of producerExecutorService and consumerExecutorService. + */ +public abstract class HoodieExecutorBase<I, O, E> implements HoodieExecutor<I, O, E> { + + private static final Logger LOG = LogManager.getLogger(HoodieExecutorBase.class); + + private static final long TERMINATE_WAITING_TIME_SECS = 60L; + // Executor service used for launching write thread. + public final ExecutorService producerExecutorService; + // Executor service used for launching read thread. + public final ExecutorService consumerExecutorService; + // Producers + public final List<HoodieProducer<I>> producers; + // Consumer + public final Option<IteratorBasedQueueConsumer<O, E>> consumer; + // pre-execute function to implement environment specific behavior before executors (producers/consumer) run + public final Runnable preExecuteRunnable; + + public List<Future<Boolean>> producerTasks; + + public HoodieExecutorBase(List<HoodieProducer<I>> producers, Option<IteratorBasedQueueConsumer<O, E>> consumer, + Runnable preExecuteRunnable) { + this.producers = producers; + this.consumer = consumer; + this.preExecuteRunnable = preExecuteRunnable; + // Ensure fixed thread for each producer thread + this.producerExecutorService = Executors.newFixedThreadPool(producers.size(), new HoodieDaemonThreadFactory("producer", preExecuteRunnable)); + // Ensure single thread for consumer + this.consumerExecutorService = Executors.newSingleThreadExecutor(new CustomizedThreadFactory("consumer")); + } + + public boolean awaitTermination() { + // if current thread has been interrupted before awaitTermination was called, we still give + // executor a chance to proceeding. So clear the interrupt flag and reset it if needed before return. + boolean interruptedBefore = Thread.interrupted(); + boolean producerTerminated = false; + boolean consumerTerminated = false; + try { + producerTerminated = producerExecutorService.awaitTermination(TERMINATE_WAITING_TIME_SECS, TimeUnit.SECONDS); + consumerTerminated = consumerExecutorService.awaitTermination(TERMINATE_WAITING_TIME_SECS, TimeUnit.SECONDS); + } catch (InterruptedException ie) { + // fail silently for any other interruption + } + // reset interrupt flag if needed + if (interruptedBefore) { + Thread.currentThread().interrupt(); + } + return producerTerminated && consumerTerminated; + } + + public void shutdownNow() { + producerExecutorService.shutdownNow(); + consumerExecutorService.shutdownNow(); + } + + public void close() { + producerExecutorService.shutdown(); + consumerExecutorService.shutdown(); + } + + /** + * Main API to run both production and consumption. + */ + @Override + public E execute() { + try { + ValidationUtils.checkState(this.consumer.isPresent()); + setup(); + producerTasks = startProducers(); + Future<E> future = startConsumer(); + return future.get(); + } catch (InterruptedException ie) { + shutdownNow(); + Thread.currentThread().interrupt(); Review Comment: Can you please elaborate with a comment on why we want to interrupt the current thread? ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/HoodieExecutorBase.java: ########## @@ -0,0 +1,119 @@ +/* + * 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.common.util.queue; + +import org.apache.hudi.common.util.CustomizedThreadFactory; +import org.apache.hudi.common.util.Option; +import org.apache.hudi.common.util.ValidationUtils; +import org.apache.hudi.exception.HoodieException; +import org.apache.log4j.LogManager; +import org.apache.log4j.Logger; + +import java.util.List; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +/** + * HoodieExecutorBase holds common elements producerExecutorService, consumerExecutorService, producers and a single consumer. + * Also HoodieExecutorBase control the lifecycle of producerExecutorService and consumerExecutorService. + */ +public abstract class HoodieExecutorBase<I, O, E> implements HoodieExecutor<I, O, E> { + + private static final Logger LOG = LogManager.getLogger(HoodieExecutorBase.class); + + private static final long TERMINATE_WAITING_TIME_SECS = 60L; + // Executor service used for launching write thread. + public final ExecutorService producerExecutorService; + // Executor service used for launching read thread. + public final ExecutorService consumerExecutorService; + // Producers + public final List<HoodieProducer<I>> producers; + // Consumer + public final Option<IteratorBasedQueueConsumer<O, E>> consumer; + // pre-execute function to implement environment specific behavior before executors (producers/consumer) run + public final Runnable preExecuteRunnable; + + public List<Future<Boolean>> producerTasks; + + public HoodieExecutorBase(List<HoodieProducer<I>> producers, Option<IteratorBasedQueueConsumer<O, E>> consumer, + Runnable preExecuteRunnable) { + this.producers = producers; + this.consumer = consumer; + this.preExecuteRunnable = preExecuteRunnable; + // Ensure fixed thread for each producer thread + this.producerExecutorService = Executors.newFixedThreadPool(producers.size(), new HoodieDaemonThreadFactory("producer", preExecuteRunnable)); Review Comment: nit: "executor-queue-producer", "executor-queue-consumer" ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/BoundedInMemoryExecutor.java: ########## @@ -18,96 +18,77 @@ package org.apache.hudi.common.util.queue; -import org.apache.hudi.common.util.CustomizedThreadFactory; import org.apache.hudi.common.util.DefaultSizeEstimator; import org.apache.hudi.common.util.Functions; import org.apache.hudi.common.util.Option; import org.apache.hudi.common.util.SizeEstimator; import org.apache.hudi.exception.HoodieException; +import org.apache.hudi.exception.HoodieIOException; import org.apache.log4j.LogManager; import org.apache.log4j.Logger; +import java.io.IOException; import java.util.Collections; import java.util.Iterator; import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CountDownLatch; import java.util.concurrent.ExecutorCompletionService; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; import java.util.function.Function; import java.util.stream.Collectors; /** - * Executor which orchestrates concurrent producers and consumers communicating through a bounded in-memory queue. This + * Executor which orchestrates concurrent producers and consumers communicating through 'BoundedInMemoryQueue'. This * class takes as input the size limit, queue producer(s), consumer and transformer and exposes API to orchestrate * concurrent execution of these actors communicating through a central bounded queue */ -public class BoundedInMemoryExecutor<I, O, E> { +public class BoundedInMemoryExecutor<I, O, E> extends HoodieExecutorBase<I, O, E> { private static final Logger LOG = LogManager.getLogger(BoundedInMemoryExecutor.class); - private static final long TERMINATE_WAITING_TIME_SECS = 60L; - // Executor service used for launching write thread. - private final ExecutorService producerExecutorService; - // Executor service used for launching read thread. - private final ExecutorService consumerExecutorService; - // Used for buffering records which is controlled by HoodieWriteConfig#WRITE_BUFFER_LIMIT_BYTES. - private final BoundedInMemoryQueue<I, O> queue; - // Producers - private final List<BoundedInMemoryQueueProducer<I>> producers; - // Consumer - private final Option<BoundedInMemoryQueueConsumer<O, E>> consumer; - // pre-execute function to implement environment specific behavior before executors (producers/consumer) run - private final Runnable preExecuteRunnable; + private final HoodieMessageQueue<I, O> queue; public BoundedInMemoryExecutor(final long bufferLimitInBytes, final Iterator<I> inputItr, - BoundedInMemoryQueueConsumer<O, E> consumer, Function<I, O> transformFunction, Runnable preExecuteRunnable) { + IteratorBasedQueueConsumer<O, E> consumer, Function<I, O> transformFunction, Runnable preExecuteRunnable) { this(bufferLimitInBytes, new IteratorBasedQueueProducer<>(inputItr), Option.of(consumer), transformFunction, preExecuteRunnable); } - public BoundedInMemoryExecutor(final long bufferLimitInBytes, BoundedInMemoryQueueProducer<I> producer, - Option<BoundedInMemoryQueueConsumer<O, E>> consumer, final Function<I, O> transformFunction) { + public BoundedInMemoryExecutor(final long bufferLimitInBytes, HoodieProducer<I> producer, + Option<IteratorBasedQueueConsumer<O, E>> consumer, final Function<I, O> transformFunction) { this(bufferLimitInBytes, producer, consumer, transformFunction, Functions.noop()); } - public BoundedInMemoryExecutor(final long bufferLimitInBytes, BoundedInMemoryQueueProducer<I> producer, - Option<BoundedInMemoryQueueConsumer<O, E>> consumer, final Function<I, O> transformFunction, Runnable preExecuteRunnable) { + public BoundedInMemoryExecutor(final long bufferLimitInBytes, HoodieProducer<I> producer, + Option<IteratorBasedQueueConsumer<O, E>> consumer, final Function<I, O> transformFunction, Runnable preExecuteRunnable) { this(bufferLimitInBytes, Collections.singletonList(producer), consumer, transformFunction, new DefaultSizeEstimator<>(), preExecuteRunnable); } - public BoundedInMemoryExecutor(final long bufferLimitInBytes, List<BoundedInMemoryQueueProducer<I>> producers, - Option<BoundedInMemoryQueueConsumer<O, E>> consumer, final Function<I, O> transformFunction, + public BoundedInMemoryExecutor(final long bufferLimitInBytes, List<HoodieProducer<I>> producers, + Option<IteratorBasedQueueConsumer<O, E>> consumer, final Function<I, O> transformFunction, final SizeEstimator<O> sizeEstimator, Runnable preExecuteRunnable) { - this.producers = producers; - this.consumer = consumer; - this.preExecuteRunnable = preExecuteRunnable; - // Ensure fixed thread for each producer thread - this.producerExecutorService = Executors.newFixedThreadPool(producers.size(), new CustomizedThreadFactory("producer")); - // Ensure single thread for consumer - this.consumerExecutorService = Executors.newSingleThreadExecutor(new CustomizedThreadFactory("consumer")); + super(producers, consumer, preExecuteRunnable); this.queue = new BoundedInMemoryQueue<>(bufferLimitInBytes, transformFunction, sizeEstimator); } /** - * Start all Producers. + * Start all producers at once. */ - public ExecutorCompletionService<Boolean> startProducers() { + public List<Future<Boolean>> startProducers() { Review Comment: Let's rebase all of our usage of `Future` onto `CompletableFuture` (which are much more capable and versatile than the former) For that you just need to change how you trigger the execution doing: ``` CompletableFuture.runAsync(() -> ..., executorService); ``` Also, seems like this method is missing `@Override` ########## hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieWriteConfig.java: ########## @@ -132,6 +134,14 @@ public class HoodieWriteConfig extends HoodieConfig { .withDocumentation("Key generator class, that implements `org.apache.hudi.keygen.KeyGenerator` " + "extract a key out of incoming records."); + public static final ConfigProperty<String> EXECUTOR_TYPE = ConfigProperty + .key("hoodie.write.executor.type") + .defaultValue("BOUNDED_IN_MEMORY") Review Comment: Let's use it here as well ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/DisruptorMessageQueue.java: ########## @@ -0,0 +1,133 @@ +/* + * 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.common.util.queue; + +import com.lmax.disruptor.EventFactory; +import com.lmax.disruptor.EventHandler; +import com.lmax.disruptor.EventTranslator; +import com.lmax.disruptor.RingBuffer; +import com.lmax.disruptor.WaitStrategy; +import com.lmax.disruptor.dsl.Disruptor; +import com.lmax.disruptor.dsl.ProducerType; +import org.apache.hudi.common.util.Option; +import org.apache.log4j.LogManager; +import org.apache.log4j.Logger; + +import java.util.function.Function; + +public class DisruptorMessageQueue<I, O> implements HoodieMessageQueue<I, O> { + + private static final Logger LOG = LogManager.getLogger(DisruptorMessageQueue.class); + + private final Disruptor<HoodieDisruptorEvent> queue; + private final Function<I, O> transformFunction; + private final RingBuffer<HoodieDisruptorEvent> ringBuffer; + + public DisruptorMessageQueue(Option<Integer> bufferSize, Function<I, O> transformFunction, Option<String> waitStrategyName, int totalProducers, Runnable preExecuteRunnable) { + WaitStrategy waitStrategy = WaitStrategyFactory.build(waitStrategyName); + HoodieDaemonThreadFactory threadFactory = new HoodieDaemonThreadFactory(preExecuteRunnable); + + this.queue = new Disruptor<>(new HoodieDisruptorEventFactory(), bufferSize.get(), threadFactory, totalProducers > 1 ? ProducerType.MULTI : ProducerType.SINGLE, waitStrategy); + this.ringBuffer = queue.getRingBuffer(); + this.transformFunction = transformFunction; + } + + @Override + public long size() { + return queue.getBufferSize(); + } + + @Override + public void insertRecord(I value) throws Exception { + O applied = transformFunction.apply(value); + + EventTranslator<HoodieDisruptorEvent> translator = new EventTranslator<HoodieDisruptorEvent>() { Review Comment: We can simplify this to ``` EventTranslator<HoodieDisruptorEvent> translator = (event, sequence) -> event.set(applied); ``` ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/DisruptorMessageQueue.java: ########## @@ -0,0 +1,133 @@ +/* + * 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.common.util.queue; + +import com.lmax.disruptor.EventFactory; +import com.lmax.disruptor.EventHandler; +import com.lmax.disruptor.EventTranslator; +import com.lmax.disruptor.RingBuffer; +import com.lmax.disruptor.WaitStrategy; +import com.lmax.disruptor.dsl.Disruptor; +import com.lmax.disruptor.dsl.ProducerType; +import org.apache.hudi.common.util.Option; +import org.apache.log4j.LogManager; +import org.apache.log4j.Logger; + +import java.util.function.Function; + +public class DisruptorMessageQueue<I, O> implements HoodieMessageQueue<I, O> { + + private static final Logger LOG = LogManager.getLogger(DisruptorMessageQueue.class); + + private final Disruptor<HoodieDisruptorEvent> queue; + private final Function<I, O> transformFunction; + private final RingBuffer<HoodieDisruptorEvent> ringBuffer; + + public DisruptorMessageQueue(Option<Integer> bufferSize, Function<I, O> transformFunction, Option<String> waitStrategyName, int totalProducers, Runnable preExecuteRunnable) { + WaitStrategy waitStrategy = WaitStrategyFactory.build(waitStrategyName); + HoodieDaemonThreadFactory threadFactory = new HoodieDaemonThreadFactory(preExecuteRunnable); + + this.queue = new Disruptor<>(new HoodieDisruptorEventFactory(), bufferSize.get(), threadFactory, totalProducers > 1 ? ProducerType.MULTI : ProducerType.SINGLE, waitStrategy); + this.ringBuffer = queue.getRingBuffer(); + this.transformFunction = transformFunction; + } + + @Override + public long size() { + return queue.getBufferSize(); + } + + @Override + public void insertRecord(I value) throws Exception { + O applied = transformFunction.apply(value); + + EventTranslator<HoodieDisruptorEvent> translator = new EventTranslator<HoodieDisruptorEvent>() { + @Override + public void translateTo(HoodieDisruptorEvent event, long sequence) { + event.set(applied); + } + }; + + queue.getRingBuffer().publishEvent(translator); + } + + @Override + public Option<O> readNextRecord() { + // Let DisruptorMessageHandler to handle consuming logic. + return null; + } + + @Override + public void markAsFailed(Throwable e) { + // do nothing. + } + + @Override + public void close() { + // Waits until all events currently in the disruptor have been processed by all event processors + queue.shutdown(); + } + + public boolean isEmpty() { + return ringBuffer.getBufferSize() == ringBuffer.remainingCapacity(); + } + + public void setHandlers(IteratorBasedQueueConsumer consumer) { Review Comment: Should this be package-private? ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/HoodieExecutor.java: ########## @@ -0,0 +1,70 @@ +/* + * 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.common.util.queue; + +import java.util.List; +import java.util.concurrent.Future; + +/** + * HoodieExecutor which orchestrates concurrent producers and consumers communicating through a bounded in message queue. + */ +public interface HoodieExecutor<I, O, E> { Review Comment: I'd suggest to reserve this interface for APIs only exposed to the actual user: in that case such only APIs are `execute` and `close`. All the other APIs are implementation detils (setup, startConumers, postAction, etc) and shouldn't be exposed outside actual implementations: - Let's move all of these to a shared base class - Let's keep them "protected" Let's also make this extend `AutoCloseable` ########## hudi-common/src/main/java/org/apache/hudi/common/util/queue/DisruptorPublisher.java: ########## @@ -0,0 +1,34 @@ +/* + * 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.common.util.queue; + +public class DisruptorPublisher<I, O> { Review Comment: @zhangyue19921010 forgot to remove this class? -- 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]
