/
SubscriberOptions.java
204 lines (174 loc) · 7.46 KB
/
SubscriberOptions.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
* Copyright 2020 Google LLC
*
* Licensed 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 com.google.cloud.pubsublite.beam;
import static com.google.cloud.pubsublite.internal.ExtractStatus.toCanonical;
import static com.google.cloud.pubsublite.internal.wire.ServiceClients.addDefaultMetadata;
import static com.google.cloud.pubsublite.internal.wire.ServiceClients.addDefaultSettings;
import com.google.api.gax.rpc.ApiException;
import com.google.auto.value.AutoValue;
import com.google.cloud.pubsublite.Partition;
import com.google.cloud.pubsublite.SubscriptionPath;
import com.google.cloud.pubsublite.cloudpubsub.FlowControlSettings;
import com.google.cloud.pubsublite.internal.CursorClient;
import com.google.cloud.pubsublite.internal.CursorClientSettings;
import com.google.cloud.pubsublite.internal.wire.Committer;
import com.google.cloud.pubsublite.internal.wire.CommitterSettings;
import com.google.cloud.pubsublite.internal.wire.PubsubContext;
import com.google.cloud.pubsublite.internal.wire.PubsubContext.Framework;
import com.google.cloud.pubsublite.internal.wire.RoutingMetadata;
import com.google.cloud.pubsublite.internal.wire.SubscriberBuilder;
import com.google.cloud.pubsublite.internal.wire.SubscriberFactory;
import com.google.cloud.pubsublite.v1.CursorServiceClient;
import com.google.cloud.pubsublite.v1.CursorServiceSettings;
import com.google.cloud.pubsublite.v1.SubscriberServiceClient;
import com.google.cloud.pubsublite.v1.SubscriberServiceSettings;
import com.google.common.collect.ImmutableSet;
import java.io.Serializable;
import java.util.Set;
import org.checkerframework.checker.nullness.qual.Nullable;
@AutoValue
public abstract class SubscriberOptions implements Serializable {
private static final long serialVersionUID = 269598118L;
private static final Framework FRAMEWORK = Framework.of("BEAM");
private static final long MEBIBYTE = 1L << 20;
public static final FlowControlSettings DEFAULT_FLOW_CONTROL =
FlowControlSettings.builder()
.setMessagesOutstanding(Long.MAX_VALUE)
.setBytesOutstanding(100 * MEBIBYTE)
.build();
// Required parameters.
public abstract SubscriptionPath subscriptionPath();
// Optional parameters.
/** Per-partition flow control parameters for this subscription. */
public abstract FlowControlSettings flowControlSettings();
/**
* A set of partitions. If empty, continuously poll the set of partitions using an admin client.
*/
public abstract Set<Partition> partitions();
/**
* A factory to override subscriber creation entirely and delegate to another method. Primarily
* useful for testing.
*/
abstract @Nullable SubscriberFactory subscriberFactory();
/**
* A supplier to override committer creation entirely and delegate to another method. Primarily
* useful for testing.
*/
abstract @Nullable SerializableSupplier<Committer> committerSupplier();
/**
* A supplier to override topic backlog reader creation entirely and delegate to another method.
* Primarily useful for testing.
*/
abstract @Nullable SerializableSupplier<TopicBacklogReader> backlogReaderSupplier();
/**
* A supplier to override offset reader creation entirely and delegate to another method.
* Primarily useful for testing.
*/
abstract @Nullable SerializableSupplier<InitialOffsetReader> offsetReaderSupplier();
public static Builder newBuilder() {
Builder builder = new AutoValue_SubscriberOptions.Builder();
return builder.setPartitions(ImmutableSet.of()).setFlowControlSettings(DEFAULT_FLOW_CONTROL);
}
public abstract Builder toBuilder();
private SubscriberServiceClient newSubscriberServiceClient(Partition partition)
throws ApiException {
try {
SubscriberServiceSettings.Builder settingsBuilder = SubscriberServiceSettings.newBuilder();
addDefaultMetadata(
PubsubContext.of(FRAMEWORK),
RoutingMetadata.of(subscriptionPath(), partition),
settingsBuilder);
return SubscriberServiceClient.create(
addDefaultSettings(subscriptionPath().location().region(), settingsBuilder));
} catch (Throwable t) {
throw toCanonical(t).underlying;
}
}
SubscriberFactory getSubscriberFactory(Partition partition) {
SubscriberFactory factory = subscriberFactory();
if (factory != null) {
return factory;
}
return consumer ->
SubscriberBuilder.newBuilder()
.setMessageConsumer(consumer)
.setSubscriptionPath(subscriptionPath())
.setPartition(partition)
.setServiceClient(newSubscriberServiceClient(partition))
.build();
}
private CursorServiceClient newCursorServiceClient() throws ApiException {
try {
return CursorServiceClient.create(
addDefaultSettings(
subscriptionPath().location().region(), CursorServiceSettings.newBuilder()));
} catch (Throwable t) {
throw toCanonical(t).underlying;
}
}
Committer getCommitter(Partition partition) {
SerializableSupplier<Committer> supplier = committerSupplier();
if (supplier != null) {
return supplier.get();
}
return CommitterSettings.newBuilder()
.setSubscriptionPath(subscriptionPath())
.setPartition(partition)
.setServiceClient(newCursorServiceClient())
.build()
.instantiate();
}
TopicBacklogReader getBacklogReader(Partition partition) {
SerializableSupplier<TopicBacklogReader> supplier = backlogReaderSupplier();
if (supplier != null) {
return supplier.get();
}
return TopicBacklogReaderSettings.newBuilder()
.setTopicPathFromSubscriptionPath(subscriptionPath())
.setPartition(partition)
.build()
.instantiate();
}
InitialOffsetReader getInitialOffsetReader(Partition partition) {
SerializableSupplier<InitialOffsetReader> supplier = offsetReaderSupplier();
if (supplier != null) {
return supplier.get();
}
return new InitialOffsetReaderImpl(
CursorClient.create(
CursorClientSettings.newBuilder()
.setRegion(subscriptionPath().location().region())
.build()),
subscriptionPath(),
partition);
}
@AutoValue.Builder
public abstract static class Builder {
// Required parameters.
public abstract Builder setSubscriptionPath(SubscriptionPath path);
// Optional parameters
public abstract Builder setPartitions(Set<Partition> partitions);
public abstract Builder setFlowControlSettings(FlowControlSettings flowControlSettings);
// Used in unit tests
abstract Builder setSubscriberFactory(SubscriberFactory subscriberFactory);
abstract Builder setCommitterSupplier(SerializableSupplier<Committer> committerSupplier);
abstract Builder setBacklogReaderSupplier(
SerializableSupplier<TopicBacklogReader> backlogReaderSupplier);
abstract Builder setOffsetReaderSupplier(
SerializableSupplier<InitialOffsetReader> offsetReaderSupplier);
public abstract SubscriberOptions build();
}
}