Skip to content

Commit 592025b

Browse files
chingor13chingor13
authored
---
yaml --- r: 28257 b: refs/heads/pubsub-ordering-keys c: 029bfe8 h: refs/heads/master i: 28255: 21c6dc7
1 parent 495d81a commit 592025b

18 files changed

Lines changed: 69 additions & 1367 deletions

File tree

‎[refs]‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ refs/tags/v0.72.0: a7703f2593ba312c0b2dde6fdfd4f5c764bb55ac
155155
refs/tags/v0.73.0: 21241ea8be9439cc5764c4944cdce21d34ce4f9e
156156
refs/tags/v0.74.0: 9d1f733dbbf790de7b494418523b69c4a9a57638
157157
refs/heads/ignoretest: 23c412ae07af3d0ab1caa2d44d5bc5c0ccb8b31d
158-
refs/heads/pubsub-ordering-keys: 74daec86541c18120f91b78420ec35a8875c6d50
158+
refs/heads/pubsub-ordering-keys: 029bfe889078fa66b7f714a41e1e8f30502d9e81
159159
refs/tags/v0.75.0: c3673089ae09a897c1b4cf7dfe167fe4f8ab32fb
160160
refs/tags/v0.76.0: 395b016826d3ddf9cb8b34919636df15a4dbd032
161161
refs/tags/v0.77.0: 28a85a77883ccf5d48f297fd0ef3b3dca6ce01f0

‎branches/pubsub-ordering-keys/google-cloud-clients/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/MessageDispatcher.java‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ class MessageDispatcher {
6262
@InternalApi static final Duration PENDING_ACKS_SEND_DELAY = Duration.ofMillis(100);
6363

6464
private final Executor executor;
65-
private final SequentialExecutorService.AutoExecutor sequentialExecutor;
6665
private final ScheduledExecutorService systemExecutor;
6766
private final ApiClock clock;
6867

@@ -206,7 +205,6 @@ void sendAckOperations(
206205
jobLock = new ReentrantLock();
207206
messagesWaiter = new MessageWaiter();
208207
this.clock = clock;
209-
this.sequentialExecutor = new SequentialExecutorService.AutoExecutor(executor);
210208
}
211209

212210
void start() {
@@ -351,7 +349,7 @@ public void nack() {
351349
}
352350
};
353351
ApiFutures.addCallback(response, ackHandler, MoreExecutors.directExecutor());
354-
Runnable deliverMessageTask =
352+
executor.execute(
355353
new Runnable() {
356354
@Override
357355
public void run() {
@@ -372,12 +370,7 @@ public void run() {
372370
response.setException(e);
373371
}
374372
}
375-
};
376-
if (message.getOrderingKey().isEmpty()) {
377-
executor.execute(deliverMessageTask);
378-
} else {
379-
sequentialExecutor.submit(message.getOrderingKey(), deliverMessageTask);
380-
}
373+
});
381374
}
382375

383376
/** Compute the ideal deadline, set subsequent modacks to this deadline, and return it. */

‎branches/pubsub-ordering-keys/google-cloud-clients/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/Publisher.java‎

Lines changed: 26 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,9 @@
4848
import java.io.IOException;
4949
import java.util.ArrayList;
5050
import java.util.Collections;
51-
import java.util.EnumSet;
52-
import java.util.HashMap;
5351
import java.util.Iterator;
5452
import java.util.LinkedList;
5553
import java.util.List;
56-
import java.util.Map;
57-
import java.util.Set;
58-
import java.util.concurrent.Callable;
5954
import java.util.concurrent.ScheduledExecutorService;
6055
import java.util.concurrent.ScheduledFuture;
6156
import java.util.concurrent.TimeUnit;
@@ -89,17 +84,15 @@ public class Publisher {
8984
private final String topicName;
9085

9186
private final BatchingSettings batchingSettings;
92-
private final boolean enableMessageOrdering;
9387

9488
private final Lock messagesBatchLock;
95-
private final Map<String, MessagesBatch> messagesBatches;
89+
private MessagesBatch messagesBatch;
9690

9791
private final AtomicBoolean activeAlarm;
9892

9993
private final PublisherStub publisherStub;
10094

10195
private final ScheduledExecutorService executor;
102-
private final SequentialExecutorService.CallbackExecutor sequentialExecutor;
10396
private final AtomicBoolean shutdown;
10497
private final List<AutoCloseable> closeables;
10598
private final MessageWaiter messagesWaiter;
@@ -120,14 +113,12 @@ private Publisher(Builder builder) throws IOException {
120113
topicName = builder.topicName;
121114

122115
this.batchingSettings = builder.batchingSettings;
123-
this.enableMessageOrdering = builder.enableMessageOrdering;
124116
this.messageTransform = builder.messageTransform;
125117

126-
messagesBatches = new HashMap<>();
118+
messagesBatch = new MessagesBatch();
127119
messagesBatchLock = new ReentrantLock();
128120
activeAlarm = new AtomicBoolean(false);
129121
executor = builder.executorProvider.getExecutor();
130-
sequentialExecutor = new SequentialExecutorService.CallbackExecutor(executor);
131122
if (builder.executorProvider.shouldAutoClose()) {
132123
closeables =
133124
Collections.<AutoCloseable>singletonList(new ExecutorAsBackgroundResource(executor));
@@ -137,31 +128,9 @@ private Publisher(Builder builder) throws IOException {
137128

138129
// Publisher used to take maxAttempt == 0 to mean infinity, but to GAX it means don't retry.
139130
// We post-process this here to keep backward-compatibility.
140-
// Also, if "message ordering" is enabled, the publisher should retry sending the failed
141-
// message infinitely rather than sending the next one.
142-
RetrySettings.Builder retrySettingsBuilder = builder.retrySettings.toBuilder();
143-
if (retrySettingsBuilder.getMaxAttempts() == 0) {
144-
retrySettingsBuilder.setMaxAttempts(Integer.MAX_VALUE);
145-
}
146-
if (enableMessageOrdering) {
147-
retrySettingsBuilder
148-
.setMaxAttempts(Integer.MAX_VALUE)
149-
.setTotalTimeout(Duration.ofNanos(Long.MAX_VALUE));
150-
}
151-
152-
Set<StatusCode.Code> retryCodes;
153-
if (enableMessageOrdering) {
154-
retryCodes = EnumSet.allOf(StatusCode.Code.class);
155-
} else {
156-
retryCodes =
157-
EnumSet.of(
158-
StatusCode.Code.ABORTED,
159-
StatusCode.Code.CANCELLED,
160-
StatusCode.Code.DEADLINE_EXCEEDED,
161-
StatusCode.Code.INTERNAL,
162-
StatusCode.Code.RESOURCE_EXHAUSTED,
163-
StatusCode.Code.UNKNOWN,
164-
StatusCode.Code.UNAVAILABLE);
131+
RetrySettings retrySettings = builder.retrySettings;
132+
if (retrySettings.getMaxAttempts() == 0) {
133+
retrySettings = retrySettings.toBuilder().setMaxAttempts(Integer.MAX_VALUE).build();
165134
}
166135

167136
PublisherStubSettings.Builder stubSettings =
@@ -171,8 +140,15 @@ private Publisher(Builder builder) throws IOException {
171140
.setTransportChannelProvider(builder.channelProvider);
172141
stubSettings
173142
.publishSettings()
174-
.setRetryableCodes(retryCodes)
175-
.setRetrySettings(retrySettingsBuilder.build())
143+
.setRetryableCodes(
144+
StatusCode.Code.ABORTED,
145+
StatusCode.Code.CANCELLED,
146+
StatusCode.Code.DEADLINE_EXCEEDED,
147+
StatusCode.Code.INTERNAL,
148+
StatusCode.Code.RESOURCE_EXHAUSTED,
149+
StatusCode.Code.UNKNOWN,
150+
StatusCode.Code.UNAVAILABLE)
151+
.setRetrySettings(retrySettings)
176152
.setBatchingSettings(BatchingSettings.newBuilder().setIsEnabled(false).build());
177153
this.publisherStub = GrpcPublisherStub.create(stubSettings.build());
178154

@@ -220,23 +196,12 @@ public ApiFuture<String> publish(PubsubMessage message) {
220196
throw new IllegalStateException("Cannot publish on a shut-down publisher.");
221197
}
222198

223-
final String orderingKey = message.getOrderingKey();
224-
if (orderingKey != null && !orderingKey.isEmpty() && !enableMessageOrdering) {
225-
throw new IllegalStateException(
226-
"Cannot publish a message with an ordering key when message ordering is not enabled.");
227-
}
228-
229199
message = messageTransform.apply(message);
230200
List<OutstandingBatch> batchesToSend = new ArrayList<>();
231201
final OutstandingPublish outstandingPublish = new OutstandingPublish(message);
232202
messagesBatchLock.lock();
233203
try {
234204
// Check if the next message makes the current batch exceed the max batch byte size.
235-
MessagesBatch messagesBatch = messagesBatches.get(orderingKey);
236-
if (messagesBatch == null) {
237-
messagesBatch = new MessagesBatch(orderingKey);
238-
messagesBatches.put(orderingKey, messagesBatch);
239-
}
240205
if (!messagesBatch.isEmpty()
241206
&& hasBatchingBytes()
242207
&& messagesBatch.getBatchedBytes() + outstandingPublish.messageSize
@@ -254,7 +219,6 @@ && hasBatchingBytes()
254219
|| messagesBatch.getMessagesCount() == getBatchingSettings().getElementCountThreshold()) {
255220
batchesToSend.add(messagesBatch.popOutstandingBatch());
256221
}
257-
258222
// Setup the next duration based delivery alarm if there are messages batched.
259223
setupAlarm();
260224
} finally {
@@ -264,7 +228,6 @@ && hasBatchingBytes()
264228
messagesWaiter.incrementPendingMessages(1);
265229

266230
if (!batchesToSend.isEmpty()) {
267-
publishAllOutstanding();
268231
for (final OutstandingBatch batch : batchesToSend) {
269232
logger.log(Level.FINER, "Scheduling a batch for immediate sending.");
270233
executor.execute(
@@ -281,7 +244,7 @@ public void run() {
281244
}
282245

283246
private void setupAlarm() {
284-
if (!messagesBatches.isEmpty()) {
247+
if (!messagesBatch.isEmpty()) {
285248
if (!activeAlarm.getAndSet(true)) {
286249
long delayThresholdMs = getBatchingSettings().getDelayThreshold().toMillis();
287250
logger.log(Level.FINER, "Setting up alarm for the next {0} ms.", delayThresholdMs);
@@ -313,20 +276,16 @@ public void run() {
313276
*/
314277
public void publishAllOutstanding() {
315278
messagesBatchLock.lock();
279+
OutstandingBatch batchToSend;
316280
try {
317-
for (MessagesBatch batch : messagesBatches.values()) {
318-
if (!batch.isEmpty()) {
319-
// TODO(kimkyung-goog): Do not release `messagesBatchLock` when publishing a batch. If
320-
// it's released, the order of publishing cannot be guaranteed if `publish()` is called
321-
// while this function is running. This locking mechanism needs to be improved if it
322-
// causes any performance degradation.
323-
publishOutstandingBatch(batch.popOutstandingBatch());
324-
}
281+
if (messagesBatch.isEmpty()) {
282+
return;
325283
}
326-
messagesBatches.clear();
284+
batchToSend = messagesBatch.popOutstandingBatch();
327285
} finally {
328286
messagesBatchLock.unlock();
329287
}
288+
publishOutstandingBatch(batchToSend);
330289
}
331290

332291
private ApiFuture<PublishResponse> publishCall(OutstandingBatch outstandingBatch) {
@@ -335,11 +294,12 @@ private ApiFuture<PublishResponse> publishCall(OutstandingBatch outstandingBatch
335294
for (OutstandingPublish outstandingPublish : outstandingBatch.outstandingPublishes) {
336295
publishRequest.addMessages(outstandingPublish.message);
337296
}
297+
338298
return publisherStub.publishCallable().futureCall(publishRequest.build());
339299
}
340300

341301
private void publishOutstandingBatch(final OutstandingBatch outstandingBatch) {
342-
final ApiFutureCallback<PublishResponse> futureCallback =
302+
ApiFutureCallback<PublishResponse> futureCallback =
343303
new ApiFutureCallback<PublishResponse>() {
344304
@Override
345305
public void onSuccess(PublishResponse result) {
@@ -380,36 +340,20 @@ public void onFailure(Throwable t) {
380340
}
381341
};
382342

383-
if (outstandingBatch.orderingKey == null || outstandingBatch.orderingKey.isEmpty()) {
384-
ApiFutures.addCallback(publishCall(outstandingBatch), futureCallback, directExecutor());
385-
} else {
386-
// If ordering key is specified, publish the batch using the sequential executor.
387-
sequentialExecutor.submit(
388-
outstandingBatch.orderingKey,
389-
new Callable<ApiFuture<PublishResponse>>() {
390-
public ApiFuture<PublishResponse> call() {
391-
ApiFuture<PublishResponse> future = publishCall(outstandingBatch);
392-
ApiFutures.addCallback(future, futureCallback, directExecutor());
393-
return future;
394-
}
395-
});
396-
}
343+
ApiFutures.addCallback(publishCall(outstandingBatch), futureCallback, directExecutor());
397344
}
398345

399346
private static final class OutstandingBatch {
400347
final List<OutstandingPublish> outstandingPublishes;
401348
final long creationTime;
402349
int attempt;
403350
int batchSizeBytes;
404-
final String orderingKey;
405351

406-
OutstandingBatch(
407-
List<OutstandingPublish> outstandingPublishes, int batchSizeBytes, String orderingKey) {
352+
OutstandingBatch(List<OutstandingPublish> outstandingPublishes, int batchSizeBytes) {
408353
this.outstandingPublishes = outstandingPublishes;
409354
attempt = 1;
410355
creationTime = System.currentTimeMillis();
411356
this.batchSizeBytes = batchSizeBytes;
412-
this.orderingKey = orderingKey;
413357
}
414358

415359
int size() {
@@ -545,7 +489,7 @@ public static final class Builder {
545489
.setRpcTimeoutMultiplier(2)
546490
.setMaxRpcTimeout(DEFAULT_RPC_TIMEOUT)
547491
.build();
548-
static final boolean DEFAULT_ENABLE_MESSAGE_ORDERING = false;
492+
549493
private static final int THREADS_PER_CPU = 5;
550494
static final ExecutorProvider DEFAULT_EXECUTOR_PROVIDER =
551495
InstantiatingExecutorProvider.newBuilder()
@@ -559,8 +503,6 @@ public static final class Builder {
559503

560504
RetrySettings retrySettings = DEFAULT_RETRY_SETTINGS;
561505

562-
boolean enableMessageOrdering = DEFAULT_ENABLE_MESSAGE_ORDERING;
563-
564506
TransportChannelProvider channelProvider =
565507
TopicAdminSettings.defaultGrpcTransportProviderBuilder().setChannelsPerCpu(1).build();
566508

@@ -655,12 +597,6 @@ public Builder setRetrySettings(RetrySettings retrySettings) {
655597
return this;
656598
}
657599

658-
/** Sets the message ordering option. */
659-
public Builder setEnableMessageOrdering(boolean enableMessageOrdering) {
660-
this.enableMessageOrdering = enableMessageOrdering;
661-
return this;
662-
}
663-
664600
/** Gives the ability to set a custom executor to be used by the library. */
665601
public Builder setExecutorProvider(ExecutorProvider executorProvider) {
666602
this.executorProvider = Preconditions.checkNotNull(executorProvider);
@@ -686,14 +622,9 @@ public Publisher build() throws IOException {
686622
private static class MessagesBatch {
687623
private List<OutstandingPublish> messages = new LinkedList<>();
688624
private int batchedBytes;
689-
private String orderingKey;
690-
691-
private MessagesBatch(String orderingKey) {
692-
this.orderingKey = orderingKey;
693-
}
694625

695626
private OutstandingBatch popOutstandingBatch() {
696-
OutstandingBatch batch = new OutstandingBatch(messages, batchedBytes, orderingKey);
627+
OutstandingBatch batch = new OutstandingBatch(messages, batchedBytes);
697628
reset();
698629
return batch;
699630
}

0 commit comments

Comments
 (0)