rocketmq_protocol/protocol/header/
heartbeat_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 rocketmq_macros::RequestHeaderCodec;
16use serde::Deserialize;
17use serde::Serialize;
18
19use crate::rpc::rpc_request_header::RpcRequestHeader;
20
21#[derive(Serialize, Deserialize, Debug, Default, RequestHeaderCodec)]
22#[header(
23    type_id = "rocketmq_protocol::protocol::header::heartbeat_request_header::HeartbeatRequestHeader",
24    java_class = "org.apache.rocketmq.remoting.protocol.header.HeartbeatRequestHeader"
25)]
26#[serde(rename_all = "camelCase")]
27pub struct HeartbeatRequestHeader {
28    #[serde(flatten)]
29    #[header(flatten, presence = "always")]
30    pub rpc_request: Option<RpcRequestHeader>,
31}
32
33#[cfg(test)]
34mod tests {
35    use std::collections::HashMap;
36
37    use cheetah_string::CheetahString;
38
39    use super::*;
40    use crate::protocol::command_custom_header::FromMap;
41
42    #[test]
43    fn serde_flattens_the_java_rpc_keys() {
44        let header = HeartbeatRequestHeader {
45            rpc_request: Some(RpcRequestHeader {
46                namespace: Some(CheetahString::from("namespace-a")),
47                namespaced: Some(true),
48                broker_name: Some(CheetahString::from("broker-a")),
49                oneway: Some(false),
50            }),
51        };
52        let value = serde_json::to_value(&header).unwrap();
53
54        assert_eq!(
55            value,
56            serde_json::json!({
57                "ns": "namespace-a",
58                "nsd": true,
59                "bname": "broker-a",
60                "oway": false
61            })
62        );
63
64        let decoded: HeartbeatRequestHeader = serde_json::from_value(value).unwrap();
65        let rpc = decoded.rpc_request.unwrap();
66        assert_eq!(rpc.namespace.as_deref(), Some("namespace-a"));
67        assert_eq!(rpc.namespaced, Some(true));
68        assert_eq!(rpc.broker_name.as_deref(), Some("broker-a"));
69        assert_eq!(rpc.oneway, Some(false));
70    }
71
72    #[test]
73    fn empty_inputs_still_create_the_always_present_rpc_envelope() {
74        assert_eq!(
75            serde_json::to_string(&HeartbeatRequestHeader { rpc_request: None }).unwrap(),
76            "{}"
77        );
78
79        let serde_decoded: HeartbeatRequestHeader = serde_json::from_str("{}").unwrap();
80        assert!(serde_decoded.rpc_request.is_some());
81
82        let map_decoded = <HeartbeatRequestHeader as FromMap>::from(&HashMap::new()).unwrap();
83        assert!(map_decoded.rpc_request.is_some());
84    }
85
86    #[test]
87    fn request_header_codec_decodes_partial_rpc_fields() {
88        let map = HashMap::from([
89            ("namespace".into(), "namespace-a".into()),
90            ("brokerName".into(), "broker-a".into()),
91        ]);
92        let decoded = <HeartbeatRequestHeader as FromMap>::from(&map).unwrap();
93        let rpc = decoded.rpc_request.unwrap();
94
95        assert_eq!(rpc.namespace.as_deref(), Some("namespace-a"));
96        assert_eq!(rpc.broker_name.as_deref(), Some("broker-a"));
97        assert_eq!(rpc.namespaced, None);
98        assert_eq!(rpc.oneway, None);
99    }
100}
rocketmq_protocol/protocol/header/heartbeat_request_header.rs

rocketmq_protocol/protocol/header/
heartbeat_request_header.rs
