Merge pull request #16 from Miaxos/feat-add-client-info

Add client info

Author: Miaxos

app/roster/src/application/server/cmd/client/info.rs

@@ -0,0 +1,36 @@
+use super::super::parse::Parse;
+use crate::application::server::connection::WriteConnection;
+use crate::application::server::context::Context;
+use crate::application::server::frame::Frame;
+
+/// The command returns information and statistics about the current client
+/// connection in a mostly human readable format.
+///
+/// The reply format is identical to that of CLIENT LIST, and the content
+/// consists only of information about the current client.
+#[derive(Debug, Default)]
+pub struct ClientInfo {}
+
+impl ClientInfo {
+    pub fn new() -> ClientInfo {
+        ClientInfo {}
+    }
+
+    pub(crate) fn parse_frames(
+        parse: &mut Parse,
+    ) -> anyhow::Result<ClientInfo> {
+        parse.finish()?;
+
+        Ok(ClientInfo::new())
+    }
+
+    pub(crate) async fn apply(
+        self,
+        dst: &mut WriteConnection,
+        ctx: Context,
+    ) -> anyhow::Result<()> {
+        let response = Frame::Simple(ctx.connection.format_conn().await);
+        dst.write_frame(&response).await?;
+        Ok(())
+    }
+}

app/roster/src/application/server/cmd/client/list.rs

@@ -1,5 +1,4 @@
 use anyhow::bail;
-use bytestring::ByteString;
 
 use super::super::parse::Parse;
 use crate::application::server::cmd::parse::ParseError;
@@ -107,14 +106,7 @@ impl ClientList {
         // TODO(@miaxos): lot of things missing here
         let mut conn_frames = Vec::with_capacity(connections.len());
         for conn in connections {
-            conn_frames.push(Frame::Simple(ByteString::from(format!(
-                "id={id} addr={addr} laddr={laddr} fd={fd} name={name}",
-                id = &conn.id,
-                addr = &conn.addr,
-                laddr = &conn.laddr,
-                fd = &conn.fd,
-                name = &conn.name().await.unwrap_or(ByteString::new()),
-            ))));
+            conn_frames.push(Frame::Simple(conn.format_conn().await));
         }
 
         let response = Frame::Array(conn_frames);

app/roster/src/application/server/cmd/client/mod.rs

@@ -7,6 +7,7 @@ use crate::application::server::context::Context;
 use crate::application::server::frame::Frame;
 
 mod id;
+mod info;
 mod list;
 mod set_info;
 mod set_name;
@@ -18,6 +19,7 @@ pub enum Client {
     SetName(set_name::ClientSetName),
     List(list::ClientList),
     Id(id::ClientID),
+    Info(info::ClientInfo),
 }
 
 // TODO(@miaxos): This is a simple implementation of the HELP to have the
@@ -26,6 +28,8 @@ pub enum Client {
 const HELP_TEXT: &str = r#"CLIENT <subcommand> [<arg> [value] [opt] ...]. subcommands are:
 ID
     Return the ID of the current connection.
+INFO
+    Return information about the current client connection.
 LIST [options ...]
     Return information about client connections. Options:
     * TYPE (NORMAL|MASTER|REPLICA|PUBSUB)
@@ -64,6 +68,9 @@ impl SubcommandRegistry for Client {
             "id" => Command::Client(Client::Id(id::ClientID::parse_frames(
                 &mut parse,
             )?)),
+            "info" => Command::Client(Client::Info(
+                info::ClientInfo::parse_frames(&mut parse)?,
+            )),
             "list" => Command::Client(Client::List(
                 list::ClientList::parse_frames(&mut parse)?,
             )),
@@ -114,6 +121,7 @@ impl CommandExecution for Client {
             Client::SetInfo(cmd) => cmd.apply(dst, ctx).await,
             Client::SetName(cmd) => cmd.apply(dst, ctx).await,
             Client::Id(cmd) => cmd.apply(dst, ctx).await,
+            Client::Info(cmd) => cmd.apply(dst, ctx).await,
             Client::List(cmd) => cmd.apply(dst, ctx).await,
         }
     }

app/roster/src/application/server/supervisor/mod.rs

@@ -124,6 +124,17 @@ impl MetadataConnection {
     pub async fn name(&self) -> Option<ByteString> {
         self.name.read().await.clone()
     }
+
+    pub async fn format_conn(&self) -> ByteString {
+        ByteString::from(format!(
+            "id={id} addr={addr} laddr={laddr} fd={fd} name={name}",
+            id = &self.id,
+            addr = &self.addr,
+            laddr = &self.laddr,
+            fd = &self.fd,
+            name = &self.name().await.unwrap_or(ByteString::new()),
+        ))
+    }
 }
 
 impl MetadataConnection {

app/roster/tests/client.rs

@@ -33,6 +33,8 @@ pub async fn test_simple_client_help() {
     CLIENT <subcommand> [<arg> [value] [opt] ...]. subcommands are:
     ID
         Return the ID of the current connection.
+    INFO
+        Return information about the current client connection.
     LIST [options ...]
         Return information about client connections. Options:
         * TYPE (NORMAL|MASTER|REPLICA|PUBSUB)

app/roster/tests/client_info.rs

@@ -0,0 +1,19 @@
+mod utils;
+use redis_async::resp_array;
+use regex::Regex;
+
+#[tokio::test]
+pub async fn client_info() {
+    let test_re: Regex =
+        Regex::new(r"^id=0 addr=.*? laddr=.*? fd=.*? name=$").unwrap();
+    let addr = utils::start_simple_server();
+
+    let connection = utils::connect_without_auth(addr).await;
+
+    let res_f: String = connection
+        .send(resp_array!["CLIENT", "INFO"])
+        .await
+        .unwrap();
+
+    assert!(test_re.is_match(&res_f));
+}

docs/cmd_list.md

@@ -43,7 +43,7 @@ the command or open an issue.
 - [ ] CLIENT GETREDIR
 - [x] CLIENT HELP
 - [x] CLIENT ID
-- [ ] CLIENT INFO
+- [x] CLIENT INFO
 - [ ] CLIENT KILL
 - [ ] CLIENT LIST
   A lot is missing right now but it's partially working, not every arguments are