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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
use crate::SlackClientHyperConnector;
use async_trait::async_trait;
use futures::{SinkExt, StreamExt};
use log::*;
use rvstruct::*;
use slack_morphism::clients::{
SlackSocketModeWssClient, SlackSocketModeWssClientId, SlackSocketModeWssClientListener,
SlackSocketModeWssClientsFactory,
};
use slack_morphism::errors::*;
use slack_morphism::*;
use slack_morphism_models::SlackWebSocketsUrl;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, RwLock};
use std::time::SystemTime;
use tokio::net::TcpStream;
use tokio::sync::mpsc::{UnboundedReceiver, UnboundedSender};
use tokio_tungstenite::*;
use url::Url;
#[derive(Clone)]
pub struct SlackTungsteniteWssClient {
id: SlackSocketModeWssClientId,
token: SlackApiToken,
client_listener: Arc<dyn SlackSocketModeWssClientListener + Sync + Send>,
url: Url,
command_writer: Arc<RwLock<Option<UnboundedSender<SlackTungsteniteWssClientCommand>>>>,
destroyed: Arc<AtomicBool>,
}
#[derive(Clone, Debug)]
enum SlackTungsteniteWssClientCommand {
Message(String),
Ping,
Pong(Vec<u8>),
Exit,
}
impl SlackTungsteniteWssClient {
pub fn new(
wss_url: &SlackWebSocketsUrl,
id: SlackSocketModeWssClientId,
token: SlackApiToken,
client_listener: Arc<dyn SlackSocketModeWssClientListener + Sync + Send>,
) -> Self {
let url_to_connect = Url::parse(wss_url.value()).unwrap();
SlackTungsteniteWssClient {
id,
token,
client_listener,
url: url_to_connect,
command_writer: Arc::new(RwLock::new(None)),
destroyed: Arc::new(AtomicBool::new(false)),
}
}
async fn try_to_connect(&self) -> Option<WebSocketStream<MaybeTlsStream<TcpStream>>> {
match connect_async(&self.url).await {
Ok((_, response))
if !response.status().is_success() && !response.status().is_informational() =>
{
error!(
"[{}] Unable to connect {}: {}",
self.id.to_string(),
self.url,
response.status()
);
None
}
Err(err) => {
error!(
"[{}] Unable to connect {}: {:?}",
self.id.to_string(),
self.url,
err
);
None
}
Ok((wss_stream, _)) => Some(wss_stream),
}
}
async fn connect_with_reconnections(
&self,
reconnect_timeout: u64,
) -> ClientResult<WebSocketStream<MaybeTlsStream<TcpStream>>> {
let mut maybe_stream = self.try_to_connect().await;
loop {
if let Some(wss_stream) = maybe_stream {
return Ok(wss_stream);
} else if !self.destroyed.load(Ordering::Relaxed) {
trace!(
"[{}] Reconnecting after {} seconds...",
self.id.to_string(),
reconnect_timeout
);
let mut interval =
tokio::time::interval(std::time::Duration::from_secs(reconnect_timeout));
interval.tick().await;
interval.tick().await;
maybe_stream = self.try_to_connect().await;
} else {
return Err(Box::new(SlackClientError::EndOfStream(
SlackClientEndOfStreamError::new(),
)))
.map_err(|err| err.into());
}
}
}
pub async fn connect(
&self,
initial_wait_timeout: u64,
reconnect_timeout: u64,
) -> ClientResult<()> {
debug!("[{}] Connecting to {}", self.id.to_string(), self.url);
if initial_wait_timeout > 0 {
trace!(
"[{}] Delayed connection for {} seconds (backoff timeout for multiple connections)",
self.id.to_string(),
initial_wait_timeout
);
let mut interval =
tokio::time::interval(std::time::Duration::from_secs(initial_wait_timeout));
interval.tick().await;
interval.tick().await;
}
let wss_stream = self.connect_with_reconnections(reconnect_timeout).await?;
debug!("[{}] Connected to {}", self.id.to_string(), self.url);
let (mut writer, mut reader) = wss_stream.split();
let (tx, mut rx): (
UnboundedSender<SlackTungsteniteWssClientCommand>,
UnboundedReceiver<SlackTungsteniteWssClientCommand>,
) = tokio::sync::mpsc::unbounded_channel();
{
let mut self_command_writer = self.command_writer.write().unwrap();
self_command_writer.replace(tx.clone());
};
let ping_interval_in_seconds = 10;
struct PongState {
time: SystemTime,
}
let last_time_pong_received: Arc<RwLock<PongState>> = Arc::new(RwLock::new(PongState {
time: SystemTime::now(),
}));
{
let thread_last_time_pong_received = last_time_pong_received.clone();
let thread_client_id = self.id.clone();
tokio::spawn(async move {
while let Some(message) = rx.recv().await {
match message {
SlackTungsteniteWssClientCommand::Message(body) => {
if writer
.send(tokio_tungstenite::tungstenite::Message::Text(body))
.await
.is_err()
{
rx.close()
}
}
SlackTungsteniteWssClientCommand::Pong(body) => {
trace!(
"[{}] Pong to Slack: {:?}",
thread_client_id.to_string(),
body
);
if writer
.send(tokio_tungstenite::tungstenite::Message::Pong(body))
.await
.is_err()
{
rx.close()
}
}
SlackTungsteniteWssClientCommand::Ping => {
let body: [u8; 5] = rand::random();
trace!(
"[{}] Ping to Slack: {:?}",
thread_client_id.to_string(),
body
);
let seen_pong_time_in_secs = {
let last_pong = thread_last_time_pong_received.read().unwrap();
SystemTime::now()
.duration_since(last_pong.time)
.unwrap()
.as_secs()
};
if seen_pong_time_in_secs > ping_interval_in_seconds * 5 {
warn!(
"[{}] Haven't seen any pong from Slack since {} seconds ago",
thread_client_id.to_string(),
seen_pong_time_in_secs
);
rx.close()
} else if let Err(err) = writer
.send(tokio_tungstenite::tungstenite::Message::Ping(body.to_vec()))
.await
{
warn!(
"[{}] Ping slack failed with: {:?}",
thread_client_id.to_string(),
err
);
rx.close()
}
}
SlackTungsteniteWssClientCommand::Exit => {
writer.close().await.unwrap_or(());
rx.close();
}
}
}
});
}
{
let thread_listener = self.client_listener.clone();
let thread_client_id = self.id.clone();
let ping_tx = tx.clone();
tokio::spawn(async move {
let mut interval =
tokio::time::interval(std::time::Duration::from_secs(ping_interval_in_seconds));
loop {
interval.tick().await;
if !ping_tx.is_closed() {
if ping_tx
.send(SlackTungsteniteWssClientCommand::Ping)
.is_err()
{
break;
}
} else {
thread_listener.on_disconnect(&thread_client_id).await;
break;
}
}
});
}
{
let thread_listener = self.client_listener.clone();
let thread_client_id = self.id.clone();
let thread_last_time_pong_received = last_time_pong_received;
tokio::spawn(async move {
while let Some(message) = reader.next().await {
match message {
Ok(tokio_tungstenite::tungstenite::Message::Text(body)) => {
trace!(
"[{}] Received from Slack: {:?}",
thread_client_id.to_string(),
body
);
if let Some(reply) =
thread_listener.on_message(&thread_client_id, body).await
{
trace!(
"[{}] Sending reply to Slack: {:?}",
thread_client_id.to_string(),
reply
);
tx.send(SlackTungsteniteWssClientCommand::Message(reply))
.unwrap_or(());
}
}
Ok(tokio_tungstenite::tungstenite::Message::Ping(body)) => {
trace!(
"[{}] Ping from Slack: {:?}",
thread_client_id.to_string(),
body
);
tx.send(SlackTungsteniteWssClientCommand::Pong(body))
.unwrap_or(());
}
Ok(tokio_tungstenite::tungstenite::Message::Pong(body)) => {
trace!(
"[{}] Pong from Slack: {:?}",
thread_client_id.to_string(),
body
);
let mut last_pong = thread_last_time_pong_received.write().unwrap();
last_pong.time = SystemTime::now();
}
Ok(tokio_tungstenite::tungstenite::Message::Binary(body)) => {
warn!(
"[{}] Unexpected binary received from Slack: {:?}",
thread_client_id.to_string(),
body
);
thread_listener
.on_error(Box::new(SlackClientError::SocketModeProtocolError(
SlackClientSocketModeProtocolError::new(format!(
"Unexpected binary received from Slack: {:?}",
body
)),
)))
.await;
}
Ok(tokio_tungstenite::tungstenite::Message::Close(body)) => {
debug!(
"[{}] Shutting down WSS channel: {:?}",
thread_client_id.to_string(),
body
);
thread_listener.on_disconnect(&thread_client_id).await
}
Err(err) => {
error!(
"[{}] Slack WSS error: {:?}",
thread_client_id.to_string(),
err
);
thread_listener
.on_error(Box::new(SlackClientError::SocketModeProtocolError(
SlackClientSocketModeProtocolError::new(format!(
"Unexpected binary received from Slack: {:?}",
err
)),
)))
.await;
thread_listener.on_disconnect(&thread_client_id).await
}
}
}
});
}
Ok(())
}
async fn shutdown_channel(&mut self) {
let maybe_sender = {
let mut commands_writer = self.command_writer.write().unwrap().clone();
commands_writer.take()
};
if let Some(sender) = maybe_sender {
sender
.send(SlackTungsteniteWssClientCommand::Exit)
.unwrap_or(());
}
self.destroyed.store(true, Ordering::Relaxed);
}
}
#[async_trait]
impl SlackSocketModeWssClient for SlackTungsteniteWssClient {
async fn message(&self, message_body: String) -> ClientResult<()> {
let maybe_sender = {
let commands_writer = self.command_writer.read().unwrap().clone();
commands_writer
};
if let Some(sender) = maybe_sender {
if !sender.is_closed() {
tokio::spawn(async move {
sender.send(SlackTungsteniteWssClientCommand::Message(message_body))
});
Ok(())
} else {
Err(Box::new(SlackClientError::EndOfStream(
SlackClientEndOfStreamError::new(),
)))
}
} else {
Err(Box::new(SlackClientError::EndOfStream(
SlackClientEndOfStreamError::new(),
)))
}
}
async fn start(&self, initial_wait_timeout: u64, reconnect_timeout: u64) {
self.connect(initial_wait_timeout, reconnect_timeout)
.await
.unwrap_or(());
}
async fn destroy(&mut self) {
debug!("Destroying {}. Id: {:?}", self.url, self.id);
self.shutdown_channel().await;
}
}
impl SlackSocketModeWssClientsFactory<SlackTungsteniteWssClient> for SlackClientHyperConnector {
fn create_wss_client(
&self,
wss_url: &SlackWebSocketsUrl,
client_id: SlackSocketModeWssClientId,
token: SlackApiToken,
client_listener: Arc<dyn SlackSocketModeWssClientListener + Sync + Send + 'static>,
) -> ClientResult<SlackTungsteniteWssClient> {
Ok(SlackTungsteniteWssClient::new(
wss_url,
client_id,
token,
client_listener,
))
}
}