Skip to content

Release Kafka sink lock on early return and failure #7231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ashwinhs wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Release Kafka sink lock on early return and failure #7231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .../kafka-plugins/src/main/java/org/opensearch/dataprepper/plugins/kafka/sink/KafkaSink.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,10 @@ private void doInitializeInternal() {

@Override
public void doOutput(Collection<Record<Event>> records) {
reentrantLock.lock();
if (records.isEmpty()) {
return;
}
reentrantLock.lock();
try {
// TODO: Looks like this call to prepareTopicAndSchema is unnecessary as it is
// done in createProducer().
Expand All @@ -133,8 +133,9 @@ public void doOutput(Collection<Record<Event>> records) {
} catch (Exception e) {
LOG.error("Failed to setup the Kafka sink Plugin.", e);
throw new RuntimeException(e.getMessage());
} finally {
reentrantLock.unlock();
}
reentrantLock.unlock();
}

private void prepareTopicAndSchema() {
Expand Down
27 changes: 27 additions & 0 deletions ...ka-plugins/src/test/java/org/opensearch/dataprepper/plugins/kafka/sink/KafkaSinkTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@
import java.util.concurrent.Executors;
import java.util.concurrent.FutureTask;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.ReentrantLock;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
Expand Down Expand Up @@ -173,6 +176,30 @@ public void doOutputEmptyRecordsTest() {

}

@Test
public void doOutputReleasesLockWhenRecordsAreEmpty() {
final KafkaSink objectUnderTest = createObjectUnderTest();

objectUnderTest.doOutput(Arrays.asList());

assertThat(getLock(objectUnderTest).isLocked(), equalTo(false));
}

@Test
public void doOutputReleasesLockWhenSubmitFails() {
final Collection records = Arrays.asList(new Record(event));
when(executorService.submit(any(ProducerWorker.class))).thenThrow(new RuntimeException());
final KafkaSink objectUnderTest = createObjectUnderTest();

assertThrows(RuntimeException.class, () -> objectUnderTest.doOutput(records));

assertThat(getLock(objectUnderTest).isLocked(), equalTo(false));
}

private ReentrantLock getLock(final KafkaSink kafkaSink) {

@srikanthpadakanti srikanthpadakanti Nov 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ashwinhs, the fix looks good. A small thought: could the tests check behavior instead of reading the lock field? For example, after an empty or failing doOutput, a doOutput from another thread should still finish. That way the tests do not depend on a private field name.

return (ReentrantLock) ReflectionTestUtils.getField(kafkaSink, "reentrantLock");
}

@Test
public void shutdownTest() {
final KafkaSink objectUnderTest = createObjectUnderTest();
Expand Down
Loading