Skip to content
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

Jump to bottom

fix: Rebatch messages when restarting a publish stream #496

Merged
merged 2 commits into from Feb 24, 2021
Merged

fix: Rebatch messages when restarting a publish stream #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cd1535
fix: Rebatch messages when restarting a publish stream
dpcollins-google Feb 5, 2021
b3893f7
fix: Rebatch messages when restarting a publish stream
dpcollins-google Feb 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion google-cloud-pubsublite/src/main/java/com/google/cloud/pubsublite/Constants.java
View file
Open in desktop
Expand Up @@ -31,7 +31,7 @@ public class Constants {
.build();

public static final long MAX_PUBLISH_BATCH_COUNT = 1_000;
public static final long MAX_PUBLISH_BATCH_BYTES = 3_500_000;
public static final long MAX_PUBLISH_BATCH_BYTES = 1024 * 1024 * 7 / 2; // 3.5 MiB

private Constants() {}
}
42 changes: 36 additions & 6 deletions ...oud-pubsublite/src/main/java/com/google/cloud/pubsublite/internal/wire/PublisherImpl.java
View file
Open in desktop
Expand Up @@ -26,6 +26,7 @@
import com.google.api.gax.batching.BatchingSettings;
import com.google.api.gax.rpc.ApiException;
import com.google.api.gax.rpc.StatusCode.Code;
import com.google.cloud.pubsublite.Constants;
import com.google.cloud.pubsublite.Message;
import com.google.cloud.pubsublite.Offset;
import com.google.cloud.pubsublite.internal.CheckedApiException;
Expand Down Expand Up @@ -85,12 +86,8 @@ private static class InFlightBatch {
final List<SettableApiFuture<Offset>> messageFutures;

InFlightBatch(Collection<UnbatchedMessage> toBatch) {
messages =
toBatch.stream()
.map(SerialBatcher.UnbatchedMessage::message)
.collect(Collectors.toList());
messageFutures =
toBatch.stream().map(SerialBatcher.UnbatchedMessage::future).collect(Collectors.toList());
messages = toBatch.stream().map(UnbatchedMessage::message).collect(Collectors.toList());
messageFutures = toBatch.stream().map(UnbatchedMessage::future).collect(Collectors.toList());
}
}

Expand Down Expand Up @@ -136,10 +133,43 @@ public PublisherImpl(
addServices(backgroundResourceAsApiService(client));
}

@GuardedBy("monitor.monitor")
private void rebatchForRestart() {
Queue<UnbatchedMessage> messages = new ArrayDeque<>();
for (InFlightBatch batch : batchesInFlight) {
for (int i = 0; i < batch.messages.size(); ++i) {
messages.add(UnbatchedMessage.of(batch.messages.get(i), batch.messageFutures.get(i)));
}
}
long size = 0;
int count = 0;
Queue<UnbatchedMessage> currentBatch = new ArrayDeque<>();
batchesInFlight.clear();
for (UnbatchedMessage message : messages) {
long messageSize = message.message().getSerializedSize();
if (size + messageSize > Constants.MAX_PUBLISH_BATCH_BYTES
|| count + 1 > Constants.MAX_PUBLISH_BATCH_COUNT) {
if (!currentBatch.isEmpty()) {
batchesInFlight.add(new InFlightBatch(currentBatch));
currentBatch = new ArrayDeque<>();
count = 0;
size = 0;
}
}
currentBatch.add(message);
size = size + messageSize;
count += 1;
}
if (!currentBatch.isEmpty()) {
batchesInFlight.add(new InFlightBatch(currentBatch));
}
}

@Override
public void triggerReinitialize() {
try (CloseableMonitor.Hold h = monitor.enter()) {
connection.reinitialize();
rebatchForRestart();
Collection<InFlightBatch> batches = batchesInFlight;
connection.modifyConnection(
connectionOr -> {
Expand Down
133 changes: 131 additions & 2 deletions ...pubsublite/src/test/java/com/google/cloud/pubsublite/internal/wire/PublisherImplTest.java
View file
Open in desktop
Expand Up @@ -19,11 +19,13 @@
import static com.google.cloud.pubsublite.internal.wire.RetryingConnectionHelpers.whenFailed;
import static com.google.common.truth.Truth.assertThat;
import static org.hamcrest.CoreMatchers.hasItems;
import static org.hamcrest.Matchers.contains;
import static org.junit.Assert.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
Expand All @@ -37,6 +39,7 @@
import com.google.api.gax.rpc.ApiException;
import com.google.api.gax.rpc.ResponseObserver;
import com.google.api.gax.rpc.StatusCode.Code;
import com.google.cloud.pubsublite.Constants;
import com.google.cloud.pubsublite.Message;
import com.google.cloud.pubsublite.Offset;
import com.google.cloud.pubsublite.internal.CheckedApiException;
Expand All @@ -45,17 +48,24 @@
import com.google.cloud.pubsublite.proto.PubSubMessage;
import com.google.cloud.pubsublite.proto.PublishRequest;
import com.google.cloud.pubsublite.proto.PublishResponse;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.ByteString;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentMatchers;
import org.mockito.InOrder;
import org.mockito.Mock;
import org.mockito.stubbing.Answer;
import org.threeten.bp.Duration;
Expand Down Expand Up @@ -226,8 +236,14 @@ public void multipleBatches_Ok() throws Exception {
@Test
public void retryableError_RecreatesAndRetriesAll() throws Exception {
startPublisher();
Message message1 = Message.builder().setData(ByteString.copyFromUtf8("message1")).build();
Message message2 = Message.builder().setData(ByteString.copyFromUtf8("message2")).build();
Message message1 =
Message.builder()
.setData(ByteString.copyFrom(new byte[(int) Constants.MAX_PUBLISH_BATCH_BYTES - 20]))
.build();
Message message2 =
Message.builder()
.setData(ByteString.copyFromUtf8(String.join("", Collections.nCopies(21, "a"))))
.build();
Future<Offset> future1 = publisher.publish(message1);
publisher.flushToStream();
verify(mockBatchPublisher)
Expand Down Expand Up @@ -273,6 +289,119 @@ public void retryableError_RecreatesAndRetriesAll() throws Exception {
verifyNoMoreInteractions(mockBatchPublisher, mockBatchPublisher2);
}

@Test
public void retryableError_RebatchesProperly() throws Exception {
startPublisher();
Message message1 = Message.builder().setData(ByteString.copyFromUtf8("message1")).build();
Message message2 = Message.builder().setData(ByteString.copyFromUtf8("message2")).build();
Message message3 =
Message.builder()
.setData(ByteString.copyFrom(new byte[(int) Constants.MAX_PUBLISH_BATCH_BYTES - 20]))
.build();
Message message4 =
Message.builder()
.setData(ByteString.copyFromUtf8(String.join("", Collections.nCopies(21, "a"))))
.build();
List<Message> remaining =
IntStream.range(0, (int) Constants.MAX_PUBLISH_BATCH_COUNT)
.mapToObj(x -> Message.builder().setData(ByteString.copyFromUtf8("clone-" + x)).build())
.collect(Collectors.toList());

Future<Offset> future1 = publisher.publish(message1);
Future<Offset> future2 = publisher.publish(message2);
publisher.flushToStream();
verify(mockBatchPublisher)
.publish(
(Collection<PubSubMessage>) argThat(hasItems(message1.toProto(), message2.toProto())));
publisher.flushToStream();
Future<Offset> future3 = publisher.publish(message3);
publisher.flushToStream();
verify(mockBatchPublisher)
.publish((Collection<PubSubMessage>) argThat(hasItems(message3.toProto())));
Future<Offset> future4 = publisher.publish(message4);
publisher.flushToStream();
verify(mockBatchPublisher)
.publish((Collection<PubSubMessage>) argThat(hasItems(message4.toProto())));
List<Future<Offset>> remainingFutures =
remaining.stream().map(publisher::publish).collect(Collectors.toList());
publisher.flushToStream();

assertThat(future1.isDone()).isFalse();
assertThat(future2.isDone()).isFalse();
assertThat(future3.isDone()).isFalse();
assertThat(future4.isDone()).isFalse();
for (Future<Offset> future : remainingFutures) {
assertThat(future.isDone()).isFalse();
}

BatchPublisher mockBatchPublisher2 = mock(BatchPublisher.class);
doReturn(mockBatchPublisher2)
.when(mockPublisherFactory)
.New(any(), any(), eq(INITIAL_PUBLISH_REQUEST));
leakedOffsetStream.onError(new CheckedApiException(Code.UNKNOWN));

// wait for retry to complete
Thread.sleep(500);

verify(mockBatchPublisher).close();
verify(mockPublisherFactory, times(2)).New(any(), any(), eq(INITIAL_PUBLISH_REQUEST));
InOrder order = inOrder(mockBatchPublisher2);
order
.verify(mockBatchPublisher2)
.publish(
(Collection<PubSubMessage>) argThat(hasItems(message1.toProto(), message2.toProto())));
order
.verify(mockBatchPublisher2)
.publish((Collection<PubSubMessage>) argThat(hasItems(message3.toProto())));
ImmutableList.Builder<PubSubMessage> expectedRebatch = ImmutableList.builder();
expectedRebatch.add(message4.toProto());
for (int i = 0; i < (Constants.MAX_PUBLISH_BATCH_COUNT - 1); ++i) {
expectedRebatch.add(remaining.get(i).toProto());
}
order
.verify(mockBatchPublisher2)
.publish((Collection<PubSubMessage>) argThat(contains(expectedRebatch.build().toArray())));
order
.verify(mockBatchPublisher2)
.publish(
(Collection<PubSubMessage>) argThat(hasItems(Iterables.getLast(remaining).toProto())));

assertThat(future1.isDone()).isFalse();
assertThat(future2.isDone()).isFalse();
assertThat(future3.isDone()).isFalse();
assertThat(future4.isDone()).isFalse();
for (Future<Offset> future : remainingFutures) {
assertThat(future.isDone()).isFalse();
}

leakedOffsetStream.onResponse(Offset.of(10));
assertThat(future1.isDone()).isTrue();
assertThat(future1.get()).isEqualTo(Offset.of(10));
assertThat(future2.isDone()).isTrue();
assertThat(future2.get()).isEqualTo(Offset.of(11));
assertThat(future3.isDone()).isFalse();

leakedOffsetStream.onResponse(Offset.of(50));
assertThat(future3.isDone()).isTrue();
assertThat(future3.get()).isEqualTo(Offset.of(50));
assertThat(future4.isDone()).isFalse();

leakedOffsetStream.onResponse(Offset.of(100));
assertThat(future4.isDone()).isTrue();
assertThat(future4.get()).isEqualTo(Offset.of(100));
for (int i = 0; i < (Constants.MAX_PUBLISH_BATCH_COUNT - 1); ++i) {
Future<Offset> future = remainingFutures.get(i);
assertThat(future.isDone()).isTrue();
assertThat(future.get()).isEqualTo(Offset.of(100 + 1 + i));
}
Future<Offset> lastFuture = Iterables.getLast(remainingFutures);
assertThat(lastFuture.isDone()).isFalse();

leakedOffsetStream.onResponse(Offset.of(10000));
assertThat(lastFuture.isDone()).isTrue();
assertThat(lastFuture.get()).isEqualTo(Offset.of(10000));
}

@Test
public void invalidOffsetSequence_SetsPermanentException() throws Exception {
startPublisher();
Expand Down