rocketmq-protocol 1.0.0

Runtime-neutral RocketMQ wire protocol contracts
Documentation 
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

// Copyright 2023 The RocketMQ Rust Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use cheetah_string::CheetahString;
use rocketmq_macros::RequestHeaderCodec;
use serde::Deserialize;
use serde::Serialize;

use crate::rpc::topic_request_header::TopicRequestHeader;

/// Request header for getting consumer status from client.
#[derive(Clone, Debug, Serialize, Deserialize, Default, RequestHeaderCodec)]
#[header(
    type_id = "rocketmq_protocol::protocol::header::get_consumer_status_request_header::GetConsumerStatusRequestHeader",
    java_class = "org.apache.rocketmq.remoting.protocol.header.GetConsumerStatusRequestHeader",
    lookup = "scan",
    fast
)]
#[serde(rename_all = "camelCase")]
pub struct GetConsumerStatusRequestHeader {
    #[header(required)]
    pub topic: CheetahString,

    #[header(required)]
    pub group: CheetahString,

    pub client_addr: Option<CheetahString>,

    #[serde(flatten)]
    #[header(flatten, presence = "always")]
    pub topic_request_header: Option<TopicRequestHeader>,
}

impl GetConsumerStatusRequestHeader {
    pub fn new(topic: CheetahString, group: CheetahString) -> Self {
        Self {
            topic,
            group,
            client_addr: None,
            topic_request_header: None,
        }
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use super::*;
    use crate::protocol::command_custom_header::FromMap;

    #[test]
    fn get_consumer_status_request_header_serialization() {
        let mut header =
            GetConsumerStatusRequestHeader::new(CheetahString::from("topic1"), CheetahString::from("group1"));
        assert_eq!(header.topic, "topic1");
        assert_eq!(header.group, "group1");
        assert!(header.client_addr.is_none());
        assert!(header.topic_request_header.is_none());

        header.client_addr = Some(CheetahString::from("127.0.0.1"));
        header.topic_request_header = Some(TopicRequestHeader {
            lo: Some(true),
            rpc_request_header: Some(crate::rpc::rpc_request_header::RpcRequestHeader {
                broker_name: Some(CheetahString::from("broker")),
                ..Default::default()
            }),
        });
        let json = serde_json::to_string(&header).unwrap();
        assert!(json.contains("\"topic\":\"topic1\""));
        assert!(json.contains("\"group\":\"group1\""));
        assert!(json.contains("\"clientAddr\":\"127.0.0.1\""));
        assert!(json.contains("\"bname\":\"broker\""));
        assert!(json.contains("\"lo\":true"));
    }

    #[test]
    fn get_consumer_status_request_header_deserialization() {
        let json = r#"{"topic":"topic1","group":"group1","clientAddr":"127.0.0.1","lo":true,"bname":"broker"}"#;
        let header: GetConsumerStatusRequestHeader = serde_json::from_str(json).unwrap();
        assert_eq!(header.topic, "topic1");
        assert_eq!(header.group, "group1");
        assert_eq!(header.client_addr, Some(CheetahString::from("127.0.0.1")));
        assert_eq!(
            header
                .topic_request_header
                .unwrap()
                .rpc_request_header
                .unwrap()
                .broker_name,
            Some(CheetahString::from("broker"))
        );
    }

    #[test]
    fn get_consumer_status_request_header_from_map() {
        let mut map = HashMap::new();
        map.insert(CheetahString::from("topic"), CheetahString::from("topic1"));
        map.insert(CheetahString::from("group"), CheetahString::from("group1"));
        map.insert(CheetahString::from("clientAddr"), CheetahString::from("127.0.0.1"));
        map.insert(CheetahString::from("lo"), CheetahString::from("true"));
        map.insert(CheetahString::from("bname"), CheetahString::from("broker1"));

        let header = <GetConsumerStatusRequestHeader as FromMap>::from(&map).unwrap();
        assert_eq!(header.topic, "topic1");
        assert_eq!(header.group, "group1");
        assert_eq!(header.client_addr, Some(CheetahString::from("127.0.0.1")));
        assert_eq!(
            header
                .topic_request_header
                .unwrap()
                .rpc_request_header
                .unwrap()
                .broker_name,
            Some(CheetahString::from("broker1"))
        );
    }
}