rocketmq_remoting/protocol/header/
query_consumer_offset_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::RequestHeaderCodecV2;
17use serde::Deserialize;
18use serde::Serialize;
19
20use crate::protocol::header::message_operation_header::TopicRequestHeaderTrait;
21use crate::protocol::header::namesrv::topic_operation_header::TopicRequestHeader;
22
23#[derive(Debug, Clone, Serialize, Deserialize, RequestHeaderCodecV2, Default)]
24#[serde(rename_all = "camelCase")]
25pub struct QueryConsumerOffsetRequestHeader {
26    pub consumer_group: CheetahString,
27
28    pub topic: CheetahString,
29
30    pub queue_id: i32,
31
32    pub set_zero_if_not_found: Option<bool>,
33
34    #[serde(flatten)]
35    pub topic_request_header: Option<TopicRequestHeader>,
36}
37
38impl QueryConsumerOffsetRequestHeader {
39    pub fn new(consumer_group: impl Into<CheetahString>, topic: impl Into<CheetahString>, queue_id: i32) -> Self {
40        Self {
41            consumer_group: consumer_group.into(),
42            topic: topic.into(),
43            queue_id,
44            set_zero_if_not_found: None,
45            topic_request_header: None,
46        }
47    }
48}
49
50impl TopicRequestHeaderTrait for QueryConsumerOffsetRequestHeader {
51    fn set_lo(&mut self, lo: Option<bool>) {
52        if let Some(header) = self.topic_request_header.as_mut() {
53            header.lo = lo;
54        }
55    }
56
57    fn lo(&self) -> Option<bool> {
58        self.topic_request_header.as_ref().and_then(|h| h.lo)
59    }
60
61    fn set_topic(&mut self, topic: CheetahString) {
62        self.topic = topic;
63    }
64
65    fn topic(&self) -> &CheetahString {
66        &self.topic
67    }
68
69    fn broker_name(&self) -> Option<&CheetahString> {
70        self.topic_request_header
71            .as_ref()
72            .and_then(|h| h.rpc.as_ref())
73            .and_then(|h| h.broker_name.as_ref())
74    }
75
76    fn set_broker_name(&mut self, broker_name: CheetahString) {
77        if let Some(header) = self.topic_request_header.as_mut() {
78            if let Some(rpc_header) = header.rpc.as_mut() {
79                rpc_header.broker_name = Some(broker_name);
80            }
81        }
82    }
83
84    fn namespace(&self) -> Option<&str> {
85        self.topic_request_header
86            .as_ref()
87            .and_then(|h| h.rpc.as_ref())
88            .and_then(|r| r.namespace.as_deref())
89    }
90
91    fn set_namespace(&mut self, namespace: CheetahString) {
92        if let Some(header) = self.topic_request_header.as_mut() {
93            if let Some(rpc_header) = header.rpc.as_mut() {
94                rpc_header.namespace = Some(namespace);
95            }
96        }
97    }
98
99    fn namespaced(&self) -> Option<bool> {
100        self.topic_request_header
101            .as_ref()
102            .and_then(|h| h.rpc.as_ref())
103            .and_then(|r| r.namespaced)
104    }
105
106    fn set_namespaced(&mut self, namespaced: bool) {
107        if let Some(header) = self.topic_request_header.as_mut() {
108            if let Some(rpc_header) = header.rpc.as_mut() {
109                rpc_header.namespaced = Some(namespaced);
110            }
111        }
112    }
113
114    fn oneway(&self) -> Option<bool> {
115        self.topic_request_header
116            .as_ref()
117            .and_then(|h| h.rpc.as_ref())
118            .and_then(|r| r.oneway)
119    }
120
121    fn set_oneway(&mut self, oneway: bool) {
122        if let Some(header) = self.topic_request_header.as_mut() {
123            if let Some(rpc_header) = header.rpc.as_mut() {
124                rpc_header.oneway = Some(oneway);
125            }
126        }
127    }
128
129    fn queue_id(&self) -> i32 {
130        self.queue_id
131    }
132
133    fn set_queue_id(&mut self, queue_id: i32) {
134        self.queue_id = queue_id;
135    }
136}
137
138#[cfg(test)]
139mod tests {
140    use std::collections::HashMap;
141
142    use super::*;
143    use crate::protocol::command_custom_header::FromMap;
144    use crate::rpc::rpc_request_header::RpcRequestHeader;
145
146    #[test]
147    fn query_consumer_offset_request_header_default() {
148        let header = QueryConsumerOffsetRequestHeader::default();
149        assert_eq!(header.consumer_group, "");
150        assert_eq!(header.topic, "");
151        assert_eq!(header.queue_id, 0);
152        assert!(header.set_zero_if_not_found.is_none());
153        assert!(header.topic_request_header.is_none());
154    }
155
156    #[test]
157    fn query_consumer_offset_request_header_new() {
158        let header = QueryConsumerOffsetRequestHeader::new("group", "topic", 1);
159        assert_eq!(header.consumer_group, "group");
160        assert_eq!(header.topic, "topic");
161        assert_eq!(header.queue_id, 1);
162        assert!(header.set_zero_if_not_found.is_none());
163        assert!(header.topic_request_header.is_none());
164    }
165
166    #[test]
167    fn query_consumer_offset_request_header_trait_impl() {
168        let mut header = QueryConsumerOffsetRequestHeader::default();
169
170        assert!(header.lo().is_none());
171        header.topic_request_header = Some(TopicRequestHeader::default());
172        header.set_lo(Some(true));
173        assert_eq!(header.lo(), Some(true));
174
175        header.set_topic(CheetahString::from("test_topic"));
176        assert_eq!(header.topic(), &CheetahString::from("test_topic"));
177
178        assert!(header.broker_name().is_none());
179        header.topic_request_header.as_mut().unwrap().rpc = Some(RpcRequestHeader::default());
180        header.set_broker_name(CheetahString::from("broker"));
181        assert_eq!(header.broker_name(), Some(&CheetahString::from("broker")));
182
183        assert!(header.namespace().is_none());
184        header.set_namespace(CheetahString::from("ns"));
185        assert_eq!(header.namespace(), Some("ns"));
186
187        assert!(header.namespaced().is_none());
188        header.set_namespaced(true);
189        assert_eq!(header.namespaced(), Some(true));
190
191        assert!(header.oneway().is_none());
192        header.set_oneway(true);
193        assert_eq!(header.oneway(), Some(true));
194
195        header.set_queue_id(1);
196        assert_eq!(header.queue_id(), 1);
197    }
198
199    #[test]
200    fn query_consumer_offset_request_header_serialization() {
201        let header = QueryConsumerOffsetRequestHeader {
202            consumer_group: CheetahString::from("group"),
203            topic: CheetahString::from("topic"),
204            queue_id: 1,
205            set_zero_if_not_found: Some(true),
206            topic_request_header: Some(TopicRequestHeader {
207                lo: Some(true),
208                ..Default::default()
209            }),
210        };
211        let json = serde_json::to_string(&header).unwrap();
212        assert!(json.contains("\"consumerGroup\":\"group\""));
213        assert!(json.contains("\"topic\":\"topic\""));
214        assert!(json.contains("\"queueId\":1"));
215        assert!(json.contains("\"setZeroIfNotFound\":true"));
216        assert!(json.contains("\"lo\":true"));
217    }
218
219    #[test]
220    fn query_consumer_offset_request_header_deserialization() {
221        let json = r#"{"consumerGroup":"group","topic":"topic","queueId":1,"setZeroIfNotFound":true,"lo":true}"#;
222        let header: QueryConsumerOffsetRequestHeader = serde_json::from_str(json).unwrap();
223        assert_eq!(header.consumer_group, "group");
224        assert_eq!(header.topic, "topic");
225        assert_eq!(header.queue_id, 1);
226        assert_eq!(header.set_zero_if_not_found, Some(true));
227        assert_eq!(header.topic_request_header.unwrap().lo, Some(true));
228    }
229
230    #[test]
231    fn query_consumer_offset_request_header_from_map() {
232        let mut map = HashMap::new();
233        map.insert(CheetahString::from("consumerGroup"), CheetahString::from("group1"));
234        map.insert(CheetahString::from("topic"), CheetahString::from("topic1"));
235        map.insert(CheetahString::from("queueId"), CheetahString::from("2"));
236        map.insert(CheetahString::from("setZeroIfNotFound"), CheetahString::from("true"));
237        map.insert(CheetahString::from("lo"), CheetahString::from("true"));
238
239        let header = <QueryConsumerOffsetRequestHeader as FromMap>::from(&map).unwrap();
240        assert_eq!(header.consumer_group, "group1");
241        assert_eq!(header.topic, "topic1");
242        assert_eq!(header.queue_id, 2);
243        assert_eq!(header.set_zero_if_not_found, Some(true));
244        assert_eq!(header.topic_request_header.unwrap().lo, Some(true));
245    }
246}
rocketmq_remoting/protocol/header/query_consumer_offset_request_header.rs

rocketmq_remoting/protocol/header/
query_consumer_offset_request_header.rs
