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
/*!
[`RedisListener`]接口的具体实现

[`RedisListener`]: trait.RedisListener.html
*/

/// 此模块针对单节点Redis,实现了`RedisListener`接口
///
/// # 示例
///
/// ```no_run
/// use std::net::{IpAddr, SocketAddr};
/// use std::sync::atomic::AtomicBool;
/// use std::sync::Arc;
/// use std::str::FromStr;
/// use std::rc::Rc;
/// use std::cell::RefCell;
/// use redis_event::listener;
/// use redis_event::config::Config;
/// use redis_event::{NoOpEventHandler, RedisListener};
///
///
/// let ip = IpAddr::from_str("127.0.0.1").unwrap();
/// let port = 6379;
///
/// let conf = Config {
///     is_discard_rdb: false,            // 不跳过RDB
///     is_aof: false,                    // 不处理AOF
///     addr: SocketAddr::new(ip, port),
///     password: String::new(),          // 密码为空
///     repl_id: String::from("?"),       // replication id,若无此id,设置为?即可
///     repl_offset: -1,                  // replication offset,若无此offset,设置为-1即可
///     read_timeout: None,               // None,即读取永不超时
///     write_timeout: None,              // None,即写入永不超时
/// };
/// let running = Arc::new(AtomicBool::new(true));
/// let mut redis_listener = listener::new(conf, running);
/// // 设置事件处理器
/// redis_listener.set_event_handler(Rc::new(RefCell::new(NoOpEventHandler{})));
/// // 启动程序
/// redis_listener.start()?;
/// ```

use std::borrow::Borrow;
use std::cell::{RefCell, RefMut};
use std::io::{ErrorKind, Result};
use std::net::TcpStream;
use std::rc::Rc;
use std::result::Result::Ok;
use std::sync::{Arc, mpsc};
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
use std::thread::sleep;
use std::time::{Duration, Instant};

use log::{error, info, warn};

use crate::{cmd, EventHandler, io, ModuleParser, NoOpEventHandler, rdb, RedisListener, to_string};
use crate::config::Config;
use crate::io::{Conn, send};
use crate::rdb::Data;
use crate::rdb::Data::Bytes;

/// 用于监听单个Redis实例的事件
pub struct Listener {
    pub config: Config,
    conn: Option<Conn>,
    event_handler: Rc<RefCell<dyn EventHandler>>,
    module_parser: Option<Rc<RefCell<dyn ModuleParser>>>,
    t_heartbeat: HeartbeatWorker,
    sender: Option<mpsc::Sender<Message>>,
    running: Arc<AtomicBool>,
}

impl Listener {
    /// 连接Redis,创建TCP连接
    fn connect(&mut self) -> Result<()> {
        let stream = TcpStream::connect(self.config.addr)?;
        stream.set_read_timeout(self.config.read_timeout)
            .expect("read timeout set failed");
        stream.set_write_timeout(self.config.write_timeout)
            .expect("write timeout set failed");
        info!("connected to server {}", self.config.addr.to_string());
        let mut conn = io::new(stream, self.running.clone());
        if let Some(parser) = &self.module_parser {
            conn.module_parser = Option::Some(parser.clone());
        }
        self.conn = Option::Some(conn);
        Ok(())
    }
    /// 如果有设置密码,将尝试使用此密码进行认证
    fn auth(&mut self) -> Result<()> {
        if !self.config.password.is_empty() {
            let conn = self.conn.as_mut().unwrap();
            conn.send(b"AUTH", &[self.config.password.as_bytes()])?;
            let mut event_handler: RefMut<dyn EventHandler> = self.event_handler.borrow_mut();
            conn.reply(io::read_bytes, &mut event_handler)?;
        }
        Ok(())
    }
    /// 发送本地所使用的socket端口到redis,此端口展现在`info replication`中
    fn send_port(&mut self) -> Result<()> {
        let conn = self.conn.as_mut().unwrap();
        let stream: &TcpStream = match conn.input.as_any().borrow().downcast_ref::<TcpStream>() {
            Some(stream) => stream,
            None => panic!("not tcp stream")
        };
        let port = stream.local_addr()?.port().to_string();
        let port = port.as_bytes();
        conn.send(b"REPLCONF", &[b"listening-port", port])?;
        let mut event_handler: RefMut<dyn EventHandler> = self.event_handler.borrow_mut();
        conn.reply(io::read_bytes, &mut event_handler)?;
        Ok(())
    }
    /// 设置事件处理器
    pub fn set_event_handler(&mut self, handler: Rc<RefCell<dyn EventHandler>>) {
        self.event_handler = handler
    }
    
    pub fn set_module_parser(&mut self, parser: Rc<RefCell<dyn ModuleParser>>) {
        self.module_parser = Option::Some(parser)
    }
    
    /// 开启replication
    /// 默认使用PSYNC命令,若不支持PSYNC则尝试使用SYNC命令
    fn start_sync(&mut self) -> Result<bool> {
        let offset = self.config.repl_offset.to_string();
        let repl_offset = offset.as_bytes();
        let repl_id = self.config.repl_id.as_bytes();
        
        let conn = self.conn.as_mut().unwrap();
        conn.send(b"PSYNC", &[repl_id, repl_offset])?;
        let mut event_handler: RefMut<dyn EventHandler> = self.event_handler.borrow_mut();
        if let Bytes(resp) = conn.reply(io::read_bytes, &mut event_handler)? {
            let resp = to_string(resp);
            if resp.starts_with("FULLRESYNC") {
                info!("Redis全量RDB准备接收, 等待Redis dump完成...");
                if self.config.is_discard_rdb {
                    info!("跳过RDB不进行处理");
                    conn.reply(io::skip, &mut event_handler)?;
                } else {
                    conn.reply(rdb::parse, &mut event_handler)?;
                }
                let mut iter = resp.split_whitespace();
                if let Some(repl_id) = iter.nth(1) {
                    self.config.repl_id = repl_id.to_owned();
                } else {
                    panic!("Expect replication id, bot got None");
                }
                if let Some(repl_offset) = iter.next() {
                    self.config.repl_offset = repl_offset.parse::<i64>().unwrap();
                } else {
                    panic!("Expect replication offset, bot got None");
                }
                return Ok(true);
            } else if resp.starts_with("CONTINUE") {
                // PSYNC 继续之前的offset
                info!("PSYNC进度恢复");
                let mut iter = resp.split_whitespace();
                if let Some(repl_id) = iter.nth(1) {
                    if !repl_id.eq(&self.config.repl_id) {
                        self.config.repl_id = repl_id.to_owned();
                    }
                }
                return Ok(true);
            } else if resp.starts_with("NOMASTERLINK") {
                // redis丢失了master
                warn!("{}", resp);
                return Ok(false);
            } else if resp.starts_with("LOADING") {
                info!("{}", resp);
                // redis正在启动,加载rdb中
                return Ok(false);
            } else {
                info!("切换至SYNC模式重试");
                // 不支持PSYNC命令,改用SYNC命令
                conn.send(b"SYNC", &Vec::new())?;
                if self.config.is_discard_rdb {
                    info!("跳过RDB不进行处理");
                    conn.reply(io::skip, &mut event_handler)?;
                } else {
                    conn.reply(rdb::parse, &mut event_handler)?;
                }
                return Ok(true);
            }
        } else {
            panic!("Expect Redis string response");
        }
    }
    /// 接收AOF,并处理replication offset发送到心跳线程
    fn receive_cmd(&mut self) -> Result<Data<Vec<u8>, Vec<Vec<u8>>>> {
        let conn = self.conn.as_mut().unwrap();
        conn.mark();
        let mut event_handler: RefMut<dyn EventHandler> = self.event_handler.borrow_mut();
        let cmd = conn.reply(io::read_bytes, &mut event_handler);
        let read_len = conn.unmark()?;
        self.config.repl_offset += read_len;
        if let Err(error) = self.sender.as_ref().unwrap().send(Message::Some(self.config.repl_offset)) {
            error!("repl offset send error: {}", error);
        }
        return cmd;
    }
    /// 开启心跳
    fn start_heartbeat(&mut self) {
        if !self.is_running() {
            return;
        }
        let conn = self.conn.as_ref().unwrap();
        let stream: &TcpStream = match conn.input.as_any().borrow().downcast_ref::<TcpStream>() {
            Some(stream) => stream,
            None => panic!("not tcp stream")
        };
        let mut stream_clone = stream.try_clone().unwrap();
        
        let (sender, receiver) = mpsc::channel();
        
        let t = thread::spawn(move || {
            let mut offset = 0;
            let mut timer = Instant::now();
            let half_sec = Duration::from_millis(500);
            info!("heartbeat thread started");
            loop {
                match receiver.recv_timeout(half_sec) {
                    Ok(Message::Terminate) => break,
                    Ok(Message::Some(new_offset)) => {
                        offset = new_offset;
                    }
                    Err(_) => {}
                };
                let elapsed = timer.elapsed();
                if elapsed.ge(&half_sec) {
                    let offset_str = offset.to_string();
                    let offset_bytes = offset_str.as_bytes();
                    if let Err(error) = send(&mut stream_clone, b"REPLCONF", &[b"ACK", offset_bytes]) {
                        error!("heartbeat error: {}", error);
                        break;
                    }
                    timer = Instant::now();
                }
            }
            info!("heartbeat thread terminated");
        });
        self.t_heartbeat = HeartbeatWorker { thread: Some(t) };
        self.sender = Some(sender);
    }
    /// 获取当前运行的状态,若为false,程序将有序退出
    fn is_running(&self) -> bool {
        self.running.load(Ordering::Relaxed)
    }
}

impl RedisListener for Listener {
    /// 程序运行的整体逻辑都在这个方法里面实现
    ///
    /// 具体的细节体现在各个方法内
    fn start(&mut self) -> Result<()> {
        self.connect()?;
        self.auth()?;
        self.send_port()?;
        while !self.start_sync()? && self.is_running() {
            sleep(Duration::from_secs(5));
        }
        if !self.config.is_aof {
            return Ok(());
        }
        self.start_heartbeat();
        while self.is_running() {
            match self.receive_cmd() {
                Ok(Data::Bytes(_)) => panic!("Expect BytesVec response, but got Bytes"),
                Ok(Data::BytesVec(data)) => {
                    let mut handler: RefMut<dyn EventHandler> = self.event_handler.borrow_mut();
                    cmd::parse(data, &mut handler);
                }
                Err(ref err) if err.kind() == ErrorKind::WouldBlock || err.kind() == ErrorKind::TimedOut => {
                    // 不管,连接是好的
                }
                Err(err) => return Err(err),
                Ok(Data::Empty) => {}
            }
        }
        Ok(())
    }
}

impl Drop for Listener {
    fn drop(&mut self) {
        if let Some(sender) = self.sender.as_ref() {
            if let Err(err) = sender.send(Message::Terminate) {
                error!("Closing heartbeat thread error: {}", err)
            }
        }
        if let Some(thread) = self.t_heartbeat.thread.take() {
            if let Err(_) = thread.join() {}
        }
    }
}

/// Listener实例的创建方法。 `running`变量用于在外部中断此crate内部的逻辑,设置为true再传入
pub fn new(conf: Config, running: Arc<AtomicBool>) -> Listener {
    if conf.is_aof && !running.load(Ordering::Relaxed) {
        running.store(true, Ordering::Relaxed);
    }
    
    Listener {
        config: conf,
        conn: Option::None,
        event_handler: Rc::new(RefCell::new(NoOpEventHandler {})),
        module_parser: None,
        t_heartbeat: HeartbeatWorker { thread: None },
        sender: None,
        running,
    }
}

struct HeartbeatWorker {
    thread: Option<thread::JoinHandle<()>>
}

enum Message {
    Terminate,
    Some(i64),
}