Skip to main content

rocketmq_protocol/protocol/header/
query_topics_by_consumer_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::rpc_request_header::RpcRequestHeader;
21
22#[derive(Serialize, Deserialize, Debug, RequestHeaderCodec, Default)]
23#[header(
24    type_id = "rocketmq_protocol::protocol::header::query_topics_by_consumer_request_header::QueryTopicsByConsumerRequestHeader",
25    java_class = "org.apache.rocketmq.remoting.protocol.header.QueryTopicsByConsumerRequestHeader"
26)]
27pub struct QueryTopicsByConsumerRequestHeader {
28    #[header(required)]
29    #[serde(rename = "group")]
30    pub group: CheetahString,
31
32    #[serde(flatten)]
33    #[header(flatten, presence = "always")]
34    pub rpc_request_header: Option<RpcRequestHeader>,
35}
36
37impl QueryTopicsByConsumerRequestHeader {
38    pub fn new(group: impl Into<CheetahString>) -> Self {
39        Self {
40            group: group.into(),
41            rpc_request_header: None,
42        }
43    }
44
45    pub fn get_group(&self) -> &CheetahString {
46        &self.group
47    }
48
49    pub fn set_group(&mut self, group: CheetahString) {
50        self.group = group;
51    }
52}
53
54#[cfg(test)]
55mod tests {
56    use std::collections::HashMap;
57
58    use super::*;
59    use crate::protocol::command_custom_header::FromMap;
60
61    #[test]
62    fn serde_flattens_the_java_rpc_keys() {
63        let mut header = QueryTopicsByConsumerRequestHeader::new("initial-group");
64        assert_eq!(header.get_group(), "initial-group");
65        assert!(header.rpc_request_header.is_none());
66
67        header.set_group(CheetahString::from("group-a"));
68        header.rpc_request_header = Some(RpcRequestHeader {
69            namespace: Some(CheetahString::from("namespace-a")),
70            namespaced: Some(true),
71            broker_name: None,
72            oneway: None,
73        });
74        let value = serde_json::to_value(&header).unwrap();
75
76        assert_eq!(
77            value,
78            serde_json::json!({
79                "group": "group-a",
80                "ns": "namespace-a",
81                "nsd": true,
82                "bname": null,
83                "oway": null
84            })
85        );
86
87        let decoded: QueryTopicsByConsumerRequestHeader = serde_json::from_value(value).unwrap();
88        assert_eq!(decoded.get_group(), "group-a");
89        assert_eq!(
90            decoded.rpc_request_header.unwrap().namespace.as_deref(),
91            Some("namespace-a")
92        );
93    }
94
95    #[test]
96    fn request_header_codec_requires_the_group_and_decodes_the_rpc_envelope() {
97        let map = HashMap::from([
98            ("group".into(), "group-a".into()),
99            ("namespace".into(), "namespace-a".into()),
100        ]);
101        let decoded = <QueryTopicsByConsumerRequestHeader as FromMap>::from(&map).unwrap();
102
103        assert_eq!(decoded.group, "group-a");
104        assert_eq!(
105            decoded.rpc_request_header.unwrap().namespace.as_deref(),
106            Some("namespace-a")
107        );
108        assert!(<QueryTopicsByConsumerRequestHeader as FromMap>::from(&HashMap::new()).is_err());
109    }
110}