rocketmq_protocol/protocol/header/
consume_message_directly_result_request_header.rs

1// Copyright 2023 The RocketMQ Rust Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use cheetah_string::CheetahString;
16use rocketmq_macros::RequestHeaderCodec;
17use serde::Deserialize;
18use serde::Serialize;
19
20use crate::rpc::topic_request_header::TopicRequestHeader;
21
22#[derive(Clone, Debug, Serialize, Deserialize, Default, RequestHeaderCodec)]
23#[header(
24    type_id = "rocketmq_protocol::protocol::header::consume_message_directly_result_request_header::ConsumeMessageDirectlyResultRequestHeader",
25    java_class = "org.apache.rocketmq.remoting.protocol.header.ConsumeMessageDirectlyResultRequestHeader",
26    lookup = "scan",
27    fast
28)]
29#[serde(rename_all = "camelCase")]
30pub struct ConsumeMessageDirectlyResultRequestHeader {
31    #[header(required)]
32    pub consumer_group: CheetahString,
33    pub client_id: Option<CheetahString>,
34    pub msg_id: Option<CheetahString>,
35    pub broker_name: Option<CheetahString>,
36    pub topic: Option<CheetahString>,
37    pub topic_sys_flag: Option<i32>,
38    pub group_sys_flag: Option<i32>,
39    #[serde(flatten)]
40    #[header(flatten, presence = "always")]
41    pub topic_request_header: Option<TopicRequestHeader>,
42}
43
44#[cfg(test)]
45mod tests {
46    use std::collections::HashMap;
47
48    use cheetah_string::CheetahString;
49
50    use super::*;
51    use crate::protocol::command_custom_header::CommandCustomHeader;
52    use crate::protocol::command_custom_header::FromMap;
53    use crate::rpc::rpc_request_header::RpcRequestHeader;
54
55    #[test]
56    fn consume_message_directly_result_request_header_serializes_correctly() {
57        let header = ConsumeMessageDirectlyResultRequestHeader {
58            consumer_group: CheetahString::from_static_str("test_group"),
59            client_id: Some(CheetahString::from_static_str("client_id")),
60            msg_id: Some(CheetahString::from_static_str("msg_id")),
61            broker_name: Some(CheetahString::from_static_str("broker_name")),
62            topic: Some(CheetahString::from_static_str("topic")),
63            topic_sys_flag: Some(1),
64            group_sys_flag: Some(2),
65            topic_request_header: None,
66        };
67        let serialized = serde_json::to_string(&header).unwrap();
68        let expected = r#"{"consumerGroup":"test_group","clientId":"client_id","msgId":"msg_id","brokerName":"broker_name","topic":"topic","topicSysFlag":1,"groupSysFlag":2}"#;
69        assert_eq!(serialized, expected);
70    }
71
72    #[test]
73    fn consume_message_directly_result_request_header_deserializes_correctly() {
74        let data = r#"{"consumerGroup":"test_group","clientId":"client_id","msgId":"msg_id","brokerName":"broker_name","topic":"topic","topicSysFlag":1,"groupSysFlag":2}"#;
75        let header: ConsumeMessageDirectlyResultRequestHeader = serde_json::from_str(data).unwrap();
76        assert_eq!(header.consumer_group, CheetahString::from_static_str("test_group"));
77        assert_eq!(header.client_id.unwrap(), CheetahString::from_static_str("client_id"));
78        assert_eq!(header.msg_id.unwrap(), CheetahString::from_static_str("msg_id"));
79        assert_eq!(
80            header.broker_name.unwrap(),
81            CheetahString::from_static_str("broker_name")
82        );
83        assert_eq!(header.topic.unwrap(), CheetahString::from_static_str("topic"));
84        assert_eq!(header.topic_sys_flag.unwrap(), 1);
85        assert_eq!(header.group_sys_flag.unwrap(), 2);
86    }
87
88    #[test]
89    fn consume_message_directly_result_request_header_handles_missing_optional_fields() {
90        let data = r#"{"consumerGroup":"test_group"}"#;
91        let header: ConsumeMessageDirectlyResultRequestHeader = serde_json::from_str(data).unwrap();
92        assert_eq!(header.consumer_group, CheetahString::from_static_str("test_group"));
93        assert!(header.client_id.is_none());
94        assert!(header.msg_id.is_none());
95        assert!(header.broker_name.is_none());
96        assert!(header.topic.is_none());
97        assert!(header.topic_sys_flag.is_none());
98        assert!(header.group_sys_flag.is_none());
99    }
100
101    #[test]
102    fn consume_message_directly_result_request_header_handles_invalid_data() {
103        let data = r#"{"consumerGroup":12345}"#;
104        let result: Result<ConsumeMessageDirectlyResultRequestHeader, _> = serde_json::from_str(data);
105        assert!(result.is_err());
106    }
107
108    #[test]
109    fn business_and_rpc_broker_names_do_not_collide() {
110        let header = ConsumeMessageDirectlyResultRequestHeader {
111            consumer_group: "group-a".into(),
112            broker_name: Some("outer".into()),
113            topic_request_header: Some(TopicRequestHeader {
114                rpc_request_header: Some(RpcRequestHeader {
115                    broker_name: Some("base".into()),
116                    ..Default::default()
117                }),
118                ..Default::default()
119            }),
120            ..Default::default()
121        };
122
123        let map = header.to_map().unwrap();
124        assert_eq!(map.get("brokerName").map(CheetahString::as_str), Some("outer"));
125        assert_eq!(map.get("bname").map(CheetahString::as_str), Some("base"));
126
127        let decoded = <ConsumeMessageDirectlyResultRequestHeader as FromMap>::from(&map).unwrap();
128        assert_eq!(decoded.broker_name.as_deref(), Some("outer"));
129        assert_eq!(
130            decoded
131                .topic_request_header
132                .and_then(|topic| topic.rpc_request_header)
133                .and_then(|rpc| rpc.broker_name)
134                .as_deref(),
135            Some("base")
136        );
137    }
138
139    #[test]
140    fn required_consumer_group_rejects_present_empty() {
141        let map = HashMap::from([(CheetahString::from_static_str("consumerGroup"), CheetahString::new())]);
142
143        assert!(<ConsumeMessageDirectlyResultRequestHeader as FromMap>::from(&map).is_err());
144    }
145}
rocketmq_protocol/protocol/header/consume_message_directly_result_request_header.rs

rocketmq_protocol/protocol/header/
consume_message_directly_result_request_header.rs
