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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
use std::time::Duration;
use crate::apiv1::default_retry_setting;
use google_cloud_gax::cancel::CancellationToken;
use google_cloud_gax::grpc::{Code, Status, Streaming};
use google_cloud_gax::retry::RetrySetting;
use google_cloud_googleapis::pubsub::v1::{
AcknowledgeRequest, ModifyAckDeadlineRequest, PubsubMessage, ReceivedMessage as InternalReceivedMessage,
StreamingPullResponse,
};
use tokio::select;
use tokio::task::JoinHandle;
use tokio::time::sleep;
use crate::apiv1::subscriber_client::{create_empty_streaming_pull_request, SubscriberClient};
pub struct ReceivedMessage {
pub message: PubsubMessage,
ack_id: String,
subscription: String,
subscriber_client: SubscriberClient,
}
impl ReceivedMessage {
pub(crate) fn new(subscription: String, subc: SubscriberClient, message: PubsubMessage, ack_id: String) -> Self {
Self {
message,
ack_id,
subscription,
subscriber_client: subc,
}
}
pub async fn ack(&self) -> Result<(), Status> {
let req = AcknowledgeRequest {
subscription: self.subscription.to_string(),
ack_ids: vec![self.ack_id.to_string()],
};
self.subscriber_client
.acknowledge(req, None, None)
.await
.map(|e| e.into_inner())
}
pub async fn nack(&self) -> Result<(), Status> {
nack(
&self.subscriber_client,
self.subscription.to_string(),
vec![self.ack_id.to_string()],
)
.await
}
}
#[derive(Clone)]
pub struct SubscriberConfig {
pub ping_interval: Duration,
pub retry_setting: Option<RetrySetting>,
pub stream_ack_deadline_seconds: i32,
pub max_outstanding_messages: i64,
pub max_outstanding_bytes: i64,
}
impl Default for SubscriberConfig {
fn default() -> Self {
Self {
ping_interval: std::time::Duration::from_secs(10),
retry_setting: Some(default_retry_setting()),
stream_ack_deadline_seconds: 60,
max_outstanding_messages: 1000,
max_outstanding_bytes: 1000 * 1000 * 1000,
}
}
}
#[derive(Debug)]
pub(crate) struct Subscriber {
pinger: Option<JoinHandle<()>>,
inner: Option<JoinHandle<()>>,
}
impl Subscriber {
pub fn start(
ctx: CancellationToken,
subscription: String,
client: SubscriberClient,
queue: async_channel::Sender<ReceivedMessage>,
opt: Option<SubscriberConfig>,
) -> Self {
let config = opt.unwrap_or_default();
let cancel_receiver = ctx.clone();
let (ping_sender, ping_receiver) = async_channel::unbounded();
let subscription_clone = subscription.to_string();
let pinger = tokio::spawn(async move {
loop {
select! {
_ = cancel_receiver.cancelled() => {
ping_sender.close();
break;
}
_ = sleep(config.ping_interval) => {
let _ = ping_sender.send(true).await;
}
}
}
tracing::trace!("stop pinger : {}", subscription_clone);
});
let cancel_receiver = ctx;
let inner = tokio::spawn(async move {
tracing::trace!("start subscriber: {}", subscription);
let retryable_codes = match &config.retry_setting {
Some(v) => v.codes.clone(),
None => default_retry_setting().codes,
};
loop {
let mut request = create_empty_streaming_pull_request();
request.subscription = subscription.to_string();
request.stream_ack_deadline_seconds = config.stream_ack_deadline_seconds;
request.max_outstanding_messages = config.max_outstanding_messages;
request.max_outstanding_bytes = config.max_outstanding_bytes;
let response = client
.streaming_pull(
request,
Some(cancel_receiver.clone()),
ping_receiver.clone(),
config.retry_setting.clone(),
)
.await;
let stream = match response {
Ok(r) => r.into_inner(),
Err(e) => {
if e.code() == Code::Cancelled {
tracing::trace!("stop subscriber : {}", subscription);
break;
} else if retryable_codes.contains(&e.code()) {
tracing::warn!("failed to start streaming: will reconnect {:?} : {}", e, subscription);
continue;
} else {
tracing::error!("failed to start streaming: will stop {:?} : {}", e, subscription);
break;
}
}
};
match Self::recv(
client.clone(),
stream,
subscription.as_str(),
cancel_receiver.clone(),
queue.clone(),
)
.await
{
Ok(_) => break,
Err(e) => {
if retryable_codes.contains(&e.code()) {
tracing::trace!("reconnect - '{:?}' : {} ", e, subscription);
continue;
} else {
tracing::error!("terminated subscriber streaming with error {:?} : {}", e, subscription);
break;
}
}
}
}
tracing::trace!("stop subscriber in streaming: {}", subscription);
});
Self {
pinger: Some(pinger),
inner: Some(inner),
}
}
async fn recv(
client: SubscriberClient,
mut stream: Streaming<StreamingPullResponse>,
subscription: &str,
cancel: CancellationToken,
queue: async_channel::Sender<ReceivedMessage>,
) -> Result<(), Status> {
tracing::trace!("start streaming: {}", subscription);
loop {
select! {
_ = cancel.cancelled() => {
queue.close();
return Ok(());
}
maybe = stream.message() => {
let message = maybe?;
let message = match message {
Some(m) => m,
None => return Ok(())
};
let _ = handle_message(&queue, &client, subscription, message.received_messages).await;
}
}
}
}
pub async fn done(&mut self) {
if let Some(v) = self.pinger.take() {
let _ = v.await;
}
if let Some(v) = self.inner.take() {
let _ = v.await;
}
}
}
async fn handle_message(
queue: &async_channel::Sender<ReceivedMessage>,
client: &SubscriberClient,
subscription: &str,
messages: Vec<InternalReceivedMessage>,
) -> usize {
let mut nack_targets = vec![];
for received_message in messages {
if let Some(message) = received_message.message {
let id = message.message_id.clone();
tracing::debug!("message received: msg_id={id}");
if queue
.send(ReceivedMessage::new(
subscription.to_string(),
client.clone(),
message,
received_message.ack_id.clone(),
))
.await
.is_err()
{
tracing::error!("failed to send receiver queue -> so nack immediately : msg_id={id}");
nack_targets.push(received_message.ack_id);
}
}
}
let size = nack_targets.len();
if size > 0 {
if let Err(err) = nack(client, subscription.to_string(), nack_targets).await {
tracing::error!(
"failed to nack immediately {err}. The messages will be redelivered after the ack deadline."
);
}
}
size
}
async fn nack(subscriber_client: &SubscriberClient, subscription: String, ack_ids: Vec<String>) -> Result<(), Status> {
let req = ModifyAckDeadlineRequest {
subscription,
ack_deadline_seconds: 0,
ack_ids,
};
subscriber_client
.modify_ack_deadline(req, None, None)
.await
.map(|e| e.into_inner())
}
#[cfg(test)]
mod tests {
use crate::apiv1::conn_pool::ConnectionManager;
use crate::apiv1::publisher_client::PublisherClient;
use crate::apiv1::subscriber_client::SubscriberClient;
use crate::subscriber::handle_message;
use google_cloud_gax::conn::Environment;
use google_cloud_googleapis::pubsub::v1::{PublishRequest, PubsubMessage, PullRequest};
use serial_test::serial;
#[ctor::ctor]
fn init() {
let _ = tracing_subscriber::fmt().try_init();
}
#[tokio::test(flavor = "multi_thread")]
#[serial]
async fn test_handle_message_immediately_nack() {
let cm = || async {
ConnectionManager::new(4, &Environment::Emulator("localhost:8681".to_string()), "")
.await
.unwrap()
};
let subc = SubscriberClient::new(cm().await);
let pubc = PublisherClient::new(cm().await);
pubc.publish(
PublishRequest {
topic: "projects/local-project/topics/test-topic1".to_string(),
messages: vec![PubsubMessage {
data: "hoge".as_bytes().to_vec(),
..Default::default()
}],
},
None,
None,
)
.await
.unwrap();
let subscription = "projects/local-project/subscriptions/test-subscription1";
let response = subc
.pull(
PullRequest {
subscription: subscription.to_string(),
max_messages: 1,
..Default::default()
},
None,
None,
)
.await
.unwrap()
.into_inner();
let messages = response.received_messages;
let (queue, _) = async_channel::unbounded();
queue.close();
let nack_size = handle_message(&queue, &subc, subscription, messages).await;
assert_eq!(1, nack_size);
}
}