Introduce binlog feature, proxy mysql_common features

Author: blackbeam

Cargo.toml

@@ -32,11 +32,11 @@ default = [
     "flate2/zlib",
 
     # set of enabled-by-default mysql_common features
-    "mysql_common/bigdecimal",
-    "mysql_common/rust_decimal",
-    "mysql_common/time",
-    "mysql_common/frunk",
-    "mysql_common/binlog",
+    "bigdecimal",
+    "rust_decimal",
+    "time",
+    "frunk",
+    "binlog",
 
     "derive",
     # use global buffer pool by default
@@ -48,19 +48,31 @@ default-rustls = [
     # default-rustls uses rust_backend for flate2.
     "flate2/rust_backend",
 
-    "mysql_common/bigdecimal",
-    "mysql_common/rust_decimal",
-    "mysql_common/time",
-    "mysql_common/frunk",
+    "bigdecimal",
+    "rust_decimal",
+    "time",
+    "frunk",
+    "binlog",
 
     "derive",
     "buffer-pool",
 ]
+# minimal feature set with system flate2 impl
 minimal = ["flate2/zlib"]
+# minimal feature set with rust flate2 impl
+minimal-rust = ["flate2/rust_backend"]
 rustls-tls = ["rustls", "webpki", "webpki-roots", "rustls-pemfile"]
 buffer-pool = []
 nightly = []
+
+# mysql_common features
 derive = ["mysql_common/derive"]
+chrono = ["mysql_common/chrono"]
+time = ["mysql_common/time"]
+bigdecimal = ["mysql_common/bigdecimal"]
+rust_decimal = ["mysql_common/rust_decimal"]
+frunk = ["mysql_common/frunk"]
+binlog = ["mysql_common/binlog"]
 
 [dev-dependencies]
 lazy_static = "1.4.0"

Makefile

@@ -84,6 +84,12 @@ doc:
 
 test:
 	$(run-mysql)
+	if ! (COMPRESS=0 SSL=0 cargo test --no-default-features --features minimal,time,frunk); \
+	then \
+		kill -9 `cat $(MYSQL_DATA_DIR)/mysqld.pid`; \
+		rm -rf $(MYSQL_DATA_DIR) || true; \
+		exit 1; \
+	fi
 	if ! (COMPRESS=0 SSL=0 cargo test); \
 	then \
 		kill -9 `cat $(MYSQL_DATA_DIR)/mysqld.pid`; \

src/conn/binlog_stream.rs

@@ -21,6 +21,7 @@ use crate::Conn;
 /// Binlog event stream.
 ///
 /// Stream initialization is lazy, i.e. binlog won't be requested until this stream is polled.
+#[cfg_attr(docsrs, doc(cfg(feature = "binlog")))]
 pub struct BinlogStream {
     conn: Option<Conn>,
     esr: EventStreamReader,

src/conn/mod.rs

@@ -7,17 +7,18 @@
 // modified, or distributed except according to those terms.
 
 use bytes::{Buf, BufMut};
+#[cfg(feature = "binlog")]
+use mysql_common::packets::binlog_request::BinlogRequest;
 use mysql_common::{
     constants::UTF8MB4_GENERAL_CI,
     crypto,
     io::{ParseBuf, ReadMysqlExt},
     named_params::ParsedNamedParams,
     packets::{
-        binlog_request::BinlogRequest, AuthPlugin, AuthSwitchRequest, Column, ComChangeUser,
-        ComChangeUserMoreData, ComStmtClose, ComStmtExecuteRequestBuilder, ComStmtSendLongData,
-        CommonOkPacket, ErrPacket, HandshakePacket, HandshakeResponse, OkPacket,
-        OkPacketDeserializer, OkPacketKind, OldAuthSwitchRequest, OldEofPacket,
-        ResultSetTerminator, SessionStateInfo,
+        AuthPlugin, AuthSwitchRequest, Column, ComChangeUser, ComChangeUserMoreData, ComStmtClose,
+        ComStmtExecuteRequestBuilder, ComStmtSendLongData, CommonOkPacket, ErrPacket,
+        HandshakePacket, HandshakeResponse, OkPacket, OkPacketDeserializer, OkPacketKind,
+        OldAuthSwitchRequest, OldEofPacket, ResultSetTerminator, SessionStateInfo,
     },
     proto::{codec::Compression, sync_framed::MySyncFramed, MySerialize},
 };
@@ -70,8 +71,10 @@ use crate::{
 use crate::DriverError::TlsNotSupported;
 use crate::SslOpts;
 
+#[cfg(feature = "binlog")]
 use self::binlog_stream::BinlogStream;
 
+#[cfg(feature = "binlog")]
 pub mod binlog_stream;
 pub mod local_infile;
 pub mod opts;
@@ -1215,6 +1218,7 @@ impl Conn {
             .contains(StatusFlags::SERVER_STATUS_NO_BACKSLASH_ESCAPES)
     }
 
+    #[cfg(feature = "binlog")]
     fn register_as_slave(&mut self, server_id: u32) -> Result<()> {
         use mysql_common::packets::ComRegisterSlave;
 
@@ -1227,6 +1231,7 @@ impl Conn {
         Ok(())
     }
 
+    #[cfg(feature = "binlog")]
     fn request_binlog(&mut self, request: BinlogRequest<'_>) -> Result<()> {
         self.register_as_slave(request.server_id())?;
         self.write_command_raw(&request.as_cmd())?;
@@ -1238,6 +1243,8 @@ impl Conn {
     /// You can use `SHOW BINARY LOGS` to get the current log file and position from the master.
     /// If the request's `filename` is empty, the server will send the binlog-stream
     /// of the first known binlog.
+    #[cfg(feature = "binlog")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "binlog")))]
     pub fn get_binlog_stream(mut self, request: BinlogRequest<'_>) -> Result<BinlogStream> {
         self.request_binlog(request)?;
         Ok(BinlogStream::new(self))
@@ -1326,8 +1333,10 @@ mod test {
             time::Duration,
         };
 
+        #[cfg(feature = "binlog")]
         use mysql_common::{binlog::events::EventData, packets::binlog_request::BinlogRequest};
         use rand::Fill;
+        #[cfg(feature = "time")]
         use time::PrimitiveDateTime;
 
         use crate::{
@@ -2422,6 +2431,7 @@ mod test {
         }
 
         #[test]
+        #[cfg(feature = "binlog")]
         fn should_read_binlog() -> crate::Result<()> {
             use std::{
                 collections::HashMap, sync::mpsc::sync_channel, thread::spawn, time::Duration,

src/conn/pool/mod.rs

@@ -259,6 +259,8 @@ impl PooledConn {
     }
 
     /// Turns this connection into a binlog stream (see [`Conn::get_binlog_stream`]).
+    #[cfg(feature = "binlog")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "binlog")))]
     pub fn get_binlog_stream(
         mut self,
         request: crate::BinlogRequest<'_>,

src/lib.rs

@@ -903,6 +903,8 @@ pub use crate::myc::constants as consts;
 #[doc(inline)]
 pub use crate::myc::packets::{binlog_request::BinlogRequest, BinlogDumpFlags};
 
+#[cfg(feature = "binlog")]
+#[cfg_attr(docsrs, doc(cfg(feature = "binlog")))]
 pub mod binlog {
     #[doc(inline)]
     pub use crate::myc::binlog::consts::*;
@@ -918,6 +920,9 @@ pub use crate::conn::opts::ClientIdentity;
 #[doc(inline)]
 pub use crate::myc::packets::{session_state_change, SessionStateInfo};
 
+#[cfg(feature = "binlog")]
+#[doc(inline)]
+pub use crate::conn::binlog_stream::BinlogStream;
 #[doc(inline)]
 pub use crate::conn::local_infile::{LocalInfile, LocalInfileHandler};
 #[doc(inline)]
@@ -938,7 +943,7 @@ pub use crate::conn::stmt::Statement;
 #[doc(inline)]
 pub use crate::conn::transaction::{AccessMode, IsolationLevel, Transaction, TxOpts};
 #[doc(inline)]
-pub use crate::conn::{binlog_stream::BinlogStream, Conn};
+pub use crate::conn::Conn;
 #[doc(inline)]
 pub use crate::error::{DriverError, Error, MySqlError, Result, ServerError, UrlError};
 #[doc(inline)]