rocketmq_protocol/protocol/header/
change_invisible_time_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 std::fmt::Display;
16
17use cheetah_string::CheetahString;
18use rocketmq_macros::RequestHeaderCodec;
19use serde::Deserialize;
20use serde::Serialize;
21
22use crate::rpc::topic_request_header::TopicRequestHeader;
23
24#[derive(Serialize, Deserialize, Debug, Default, RequestHeaderCodec)]
25#[header(
26    type_id = "rocketmq_protocol::protocol::header::change_invisible_time_request_header::ChangeInvisibleTimeRequestHeader",
27    java_class = "org.apache.rocketmq.remoting.protocol.header.ChangeInvisibleTimeRequestHeader"
28)]
29#[serde(rename_all = "camelCase")]
30pub struct ChangeInvisibleTimeRequestHeader {
31    #[header(required)]
32    pub consumer_group: CheetahString,
33
34    #[header(required)]
35    pub topic: CheetahString,
36
37    #[header(required)]
38    pub queue_id: i32,
39
40    //startOffset popTime invisibleTime queueId
41    #[header(required)]
42    pub extra_info: CheetahString,
43
44    #[header(required)]
45    pub offset: i64,
46
47    #[header(required)]
48    pub invisible_time: i64,
49
50    #[serde(skip_serializing_if = "Option::is_none")]
51    pub lite_topic: Option<CheetahString>,
52
53    #[serde(default)]
54    #[header(default, default_semantic = "literal:false")]
55    pub suspend: bool,
56
57    #[serde(flatten)]
58    #[header(flatten, presence = "always")]
59    pub topic_request_header: Option<TopicRequestHeader>,
60}
61
62impl Display for ChangeInvisibleTimeRequestHeader {
63    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
64        write!(
65            f,
66            "ChangeInvisibleTimeRequestHeader {{ consumer_group: {}, topic: {}, queue_id: {}, extra_info: {}, offset: \
67             {}, invisible_time: {}, lite_topic: {:?}, suspend: {} }}",
68            self.consumer_group,
69            self.topic,
70            self.queue_id,
71            self.extra_info,
72            self.offset,
73            self.invisible_time,
74            self.lite_topic,
75            self.suspend
76        )
77    }
78}
79
80#[cfg(test)]
81mod tests {
82    use cheetah_string::CheetahString;
83    use serde_json;
84
85    use super::*;
86    use crate::protocol::command_custom_header::CommandCustomHeader;
87    use crate::protocol::command_custom_header::FromMap;
88
89    #[test]
90    fn change_invisible_time_request_header_display_format() {
91        let header = ChangeInvisibleTimeRequestHeader {
92            consumer_group: CheetahString::from("group1"),
93            topic: CheetahString::from("topic1"),
94            queue_id: 1,
95            extra_info: CheetahString::from("info"),
96            offset: 12345,
97            invisible_time: 67890,
98            lite_topic: None,
99            suspend: false,
100            topic_request_header: None,
101        };
102        assert_eq!(
103            format!("{}", header),
104            "ChangeInvisibleTimeRequestHeader { consumer_group: group1, topic: topic1, queue_id: 1, extra_info: info, \
105             offset: 12345, invisible_time: 67890, lite_topic: None, suspend: false }"
106        );
107    }
108
109    #[test]
110    fn change_invisible_time_request_header_display_format_with_topic_request_header() {
111        let header = ChangeInvisibleTimeRequestHeader {
112            consumer_group: CheetahString::from("group1"),
113            topic: CheetahString::from("topic1"),
114            queue_id: 1,
115            extra_info: CheetahString::from("info"),
116            offset: 12345,
117            invisible_time: 67890,
118            lite_topic: Some(CheetahString::from("lite_topic")),
119            suspend: true,
120            topic_request_header: Some(TopicRequestHeader {
121                rpc_request_header: None,
122                lo: None,
123            }),
124        };
125        assert_eq!(
126            format!("{}", header),
127            "ChangeInvisibleTimeRequestHeader { consumer_group: group1, topic: topic1, queue_id: 1, extra_info: info, \
128             offset: 12345, invisible_time: 67890, lite_topic: Some(\"lite_topic\"), suspend: true }"
129        );
130    }
131
132    #[test]
133    fn change_invisible_time_request_header_serialize() {
134        let header = ChangeInvisibleTimeRequestHeader {
135            consumer_group: CheetahString::from("group1"),
136            topic: CheetahString::from("topic1"),
137            queue_id: 1,
138            extra_info: CheetahString::from("info"),
139            offset: 12345,
140            invisible_time: 67890,
141            lite_topic: Some(CheetahString::from("lite_topic")),
142            suspend: true,
143            topic_request_header: None,
144        };
145        let serialized = serde_json::to_string(&header).unwrap();
146        assert_eq!(
147            serialized,
148            r#"{"consumerGroup":"group1","topic":"topic1","queueId":1,"extraInfo":"info","offset":12345,"invisibleTime":67890,"liteTopic":"lite_topic","suspend":true}"#
149        );
150    }
151
152    #[test]
153    fn change_invisible_time_request_header_deserialize() {
154        let json = r#"{"consumerGroup":"group1","topic":"topic1","queueId":1,"extraInfo":"info","offset":12345,"invisibleTime":67890,"liteTopic":"lite_topic","suspend":true}"#;
155        let header: ChangeInvisibleTimeRequestHeader = serde_json::from_str(json).unwrap();
156        assert_eq!(header.consumer_group, CheetahString::from("group1"));
157        assert_eq!(header.topic, CheetahString::from("topic1"));
158        assert_eq!(header.queue_id, 1);
159        assert_eq!(header.extra_info, CheetahString::from("info"));
160        assert_eq!(header.offset, 12345);
161        assert_eq!(header.invisible_time, 67890);
162        assert_eq!(header.lite_topic.as_deref(), Some("lite_topic"));
163        assert!(header.suspend);
164    }
165
166    #[test]
167    fn change_invisible_time_request_header_maps_lite_topic_and_suspend_like_java_header() {
168        let header = ChangeInvisibleTimeRequestHeader {
169            consumer_group: CheetahString::from("group1"),
170            topic: CheetahString::from("topic1"),
171            queue_id: 1,
172            extra_info: CheetahString::from("info"),
173            offset: 12345,
174            invisible_time: 67890,
175            lite_topic: Some(CheetahString::from("lite_topic")),
176            suspend: true,
177            topic_request_header: None,
178        };
179
180        let map = header.to_map().unwrap();
181        assert_eq!(map.get("liteTopic").map(|value| value.as_str()), Some("lite_topic"));
182        assert_eq!(map.get("suspend").map(|value| value.as_str()), Some("true"));
183
184        let decoded = <ChangeInvisibleTimeRequestHeader as FromMap>::from(&map).unwrap();
185        assert_eq!(decoded.lite_topic.as_deref(), Some("lite_topic"));
186        assert!(decoded.suspend);
187    }
188}
rocketmq_protocol/protocol/header/change_invisible_time_request_header.rs

rocketmq_protocol/protocol/header/
change_invisible_time_request_header.rs
