rocketmq_remoting/protocol/header/
peek_message_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(Clone, Debug, Serialize, Deserialize, RequestHeaderCodecV2)]
24#[serde(rename_all = "camelCase")]
25pub struct PeekMessageRequestHeader {
26    #[required]
27    pub consumer_group: CheetahString,
28
29    #[required]
30    pub topic: CheetahString,
31
32    /// If negative, peek from all queues
33    #[required]
34    pub queue_id: i32,
35
36    #[required]
37    pub max_msg_nums: i32,
38
39    #[serde(flatten)]
40    pub topic_request_header: Option<TopicRequestHeader>,
41}
42
43impl Default for PeekMessageRequestHeader {
44    fn default() -> Self {
45        PeekMessageRequestHeader {
46            consumer_group: CheetahString::new(),
47            topic: CheetahString::new(),
48            queue_id: 0,
49            max_msg_nums: 32,
50            topic_request_header: None,
51        }
52    }
53}
54
55impl TopicRequestHeaderTrait for PeekMessageRequestHeader {
56    fn set_lo(&mut self, lo: Option<bool>) {
57        if let Some(header) = self.topic_request_header.as_mut() {
58            header.lo = lo;
59        }
60    }
61
62    fn lo(&self) -> Option<bool> {
63        self.topic_request_header.as_ref().and_then(|h| h.lo)
64    }
65
66    fn set_topic(&mut self, topic: CheetahString) {
67        self.topic = topic;
68    }
69
70    fn topic(&self) -> &CheetahString {
71        &self.topic
72    }
73
74    fn broker_name(&self) -> Option<&CheetahString> {
75        self.topic_request_header
76            .as_ref()
77            .and_then(|h| h.rpc.as_ref())
78            .and_then(|h| h.broker_name.as_ref())
79    }
80
81    fn set_broker_name(&mut self, broker_name: CheetahString) {
82        if let Some(header) = self.topic_request_header.as_mut() {
83            if let Some(rpc_header) = header.rpc.as_mut() {
84                rpc_header.broker_name = Some(broker_name);
85            }
86        }
87    }
88
89    fn namespace(&self) -> Option<&str> {
90        self.topic_request_header
91            .as_ref()
92            .and_then(|h| h.rpc.as_ref())
93            .and_then(|r| r.namespace.as_deref())
94    }
95
96    fn set_namespace(&mut self, namespace: CheetahString) {
97        if let Some(header) = self.topic_request_header.as_mut() {
98            if let Some(rpc_header) = header.rpc.as_mut() {
99                rpc_header.namespace = Some(namespace);
100            }
101        }
102    }
103
104    fn namespaced(&self) -> Option<bool> {
105        self.topic_request_header
106            .as_ref()
107            .and_then(|h| h.rpc.as_ref())
108            .and_then(|r| r.namespaced)
109    }
110
111    fn set_namespaced(&mut self, namespaced: bool) {
112        if let Some(header) = self.topic_request_header.as_mut() {
113            if let Some(rpc_header) = header.rpc.as_mut() {
114                rpc_header.namespaced = Some(namespaced);
115            }
116        }
117    }
118
119    fn oneway(&self) -> Option<bool> {
120        self.topic_request_header
121            .as_ref()
122            .and_then(|h| h.rpc.as_ref())
123            .and_then(|r| r.oneway)
124    }
125
126    fn set_oneway(&mut self, oneway: bool) {
127        if let Some(header) = self.topic_request_header.as_mut() {
128            if let Some(rpc_header) = header.rpc.as_mut() {
129                rpc_header.oneway = Some(oneway);
130            }
131        }
132    }
133
134    fn queue_id(&self) -> i32 {
135        self.queue_id
136    }
137
138    fn set_queue_id(&mut self, queue_id: i32) {
139        self.queue_id = queue_id;
140    }
141}
142
143#[cfg(test)]
144mod tests {
145    use super::*;
146    use crate::rpc::rpc_request_header::RpcRequestHeader;
147
148    #[test]
149    fn test_default_implementation() {
150        let header = PeekMessageRequestHeader::default();
151        assert_eq!(header.consumer_group, CheetahString::new());
152        assert_eq!(header.topic, CheetahString::new());
153        assert_eq!(header.queue_id, 0);
154        assert_eq!(header.max_msg_nums, 32);
155        assert!(header.topic_request_header.is_none());
156    }
157    #[test]
158    fn test_topic_request_header_trait_methods() {
159        let mut header = PeekMessageRequestHeader::default();
160
161        // Test set_topic and topic
162        let test_topic = CheetahString::from("test_topic");
163        header.set_topic(test_topic.clone());
164        assert_eq!(header.topic(), &test_topic);
165
166        // Test set_queue_id and queue_id
167        header.set_queue_id(10);
168        assert_eq!(header.queue_id(), 10);
169
170        // Test with topic_request_header set
171        let rpc_header = RpcRequestHeader {
172            broker_name: Some(CheetahString::from("test_broker")),
173            namespace: Some(CheetahString::from("test_namespace")),
174            namespaced: Some(true),
175            oneway: Some(false),
176        };
177
178        let topic_request_header = TopicRequestHeader {
179            lo: Some(true),
180            rpc: Some(rpc_header),
181        };
182
183        header.topic_request_header = Some(topic_request_header);
184
185        // Test broker_name
186        assert_eq!(header.broker_name(), Some(&CheetahString::from("test_broker")));
187
188        let new_broker = CheetahString::from("new_broker");
189        header.set_broker_name(new_broker.clone());
190        assert_eq!(header.broker_name(), Some(&new_broker));
191
192        // Test namespace
193        assert_eq!(header.namespace(), Some("test_namespace"));
194
195        let new_namespace = CheetahString::from("new_namespace");
196        header.set_namespace(new_namespace);
197        assert_eq!(header.namespace(), Some("new_namespace"));
198
199        // Test namespaced
200        assert_eq!(header.namespaced(), Some(true));
201        header.set_namespaced(false);
202        assert_eq!(header.namespaced(), Some(false));
203
204        // Test oneway
205        assert_eq!(header.oneway(), Some(false));
206        header.set_oneway(true);
207        assert_eq!(header.oneway(), Some(true));
208
209        // Test lo
210        assert_eq!(header.lo(), Some(true));
211        header.set_lo(Some(false));
212        assert_eq!(header.lo(), Some(false));
213    }
214
215    #[test]
216    fn test_serialization_deserialization() {
217        let header = PeekMessageRequestHeader {
218            consumer_group: CheetahString::from("test_consumer_group"),
219            topic: CheetahString::from("test_topic"),
220            queue_id: 10,
221            max_msg_nums: 32,
222            ..Default::default()
223        };
224
225        // Serialize to JSON
226        let json = serde_json::to_string(&header).unwrap();
227
228        // Deserialize from JSON
229        let deserialized: PeekMessageRequestHeader = serde_json::from_str(&json).unwrap();
230
231        assert_eq!(deserialized.consumer_group, header.consumer_group);
232        assert_eq!(deserialized.topic, header.topic);
233        assert_eq!(deserialized.queue_id, header.queue_id);
234        assert_eq!(deserialized.max_msg_nums, header.max_msg_nums);
235    }
236}
rocketmq_remoting/protocol/header/peek_message_request_header.rs

rocketmq_remoting/protocol/header/
peek_message_request_header.rs
