rocketmq-model 1.0.0

Runtime-neutral RocketMQ domain models
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
// Copyright 2023 The RocketMQ Rust Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::any::Any;
use std::collections::HashMap;
use std::fmt;
use std::fmt::Debug;
use std::fmt::Formatter;
use std::net::SocketAddr;

use bytes::Bytes;
use cheetah_string::CheetahString;

use crate::codec::message_properties_to_string;
use crate::common::hasher::string_hasher::JavaStringHasher;
use crate::common::message::message_ext::MessageExt;
use crate::common::message::MessageTrait;
use crate::common::message::MessageVersion;
use crate::common::TopicFilterType;
use crate::MessageUtils;

#[derive(Default)]
pub struct MessageExtBrokerInner {
    pub message_ext_inner: MessageExt,
    pub properties_string: CheetahString,
    pub tags_code: i64,
    pub encoded_buff: Option<bytes::BytesMut>,
    pub encode_completed: bool,
    pub version: MessageVersion,
}

impl MessageExtBrokerInner {
    #[inline]
    pub fn delete_property(&mut self, name: impl Into<CheetahString>) {
        let name = name.into();
        self.message_ext_inner.message.clear_property(name.as_str());
        self.properties_string =
            MessageUtils::delete_property_to_cheetah_string(&self.properties_string, name.as_str());
    }

    #[inline]
    pub fn with_version(&mut self, version: MessageVersion) {
        self.version = version;
    }

    #[inline]
    pub fn version(&self) -> MessageVersion {
        self.version
    }

    #[inline]
    pub fn topic(&self) -> &CheetahString {
        self.message_ext_inner.topic()
    }

    #[inline]
    pub fn get_topic(&self) -> &CheetahString {
        self.message_ext_inner.topic()
    }

    #[inline]
    pub fn born_host(&self) -> SocketAddr {
        self.message_ext_inner.born_host()
    }

    #[inline]
    pub fn store_host(&self) -> SocketAddr {
        self.message_ext_inner.store_host()
    }

    #[inline]
    pub fn with_born_host_v6_flag(&mut self) {
        self.message_ext_inner.with_born_host_v6_flag()
    }

    #[inline]
    pub fn with_store_host_v6_flag(&mut self) {
        self.message_ext_inner.with_store_host_v6_flag()
    }

    #[inline]
    pub fn body(&self) -> Option<bytes::Bytes> {
        self.message_ext_inner.body()
    }

    #[inline]
    pub fn sys_flag(&self) -> i32 {
        self.message_ext_inner.sys_flag()
    }

    #[inline]
    pub fn body_crc(&self) -> u32 {
        self.message_ext_inner.body_crc()
    }

    #[inline]
    pub fn queue_id(&self) -> i32 {
        self.message_ext_inner.queue_id()
    }

    #[inline]
    pub fn flag(&self) -> i32 {
        self.message_ext_inner.flag()
    }

    #[inline]
    pub fn born_timestamp(&self) -> i64 {
        self.message_ext_inner.born_timestamp()
    }

    #[inline]
    pub fn store_timestamp(&self) -> i64 {
        self.message_ext_inner.store_timestamp()
    }

    #[inline]
    pub fn born_host_bytes(&self) -> bytes::Bytes {
        self.message_ext_inner.born_host_bytes()
    }

    #[inline]
    pub fn store_host_bytes(&self) -> bytes::Bytes {
        self.message_ext_inner.born_store_bytes()
    }

    #[inline]
    pub fn reconsume_times(&self) -> i32 {
        self.message_ext_inner.reconsume_times()
    }

    #[inline]
    pub fn prepared_transaction_offset(&self) -> i64 {
        self.message_ext_inner.prepared_transaction_offset()
    }

    #[inline]
    pub fn property(&self, name: &str) -> Option<CheetahString> {
        self.message_ext_inner.properties().get(name).cloned()
    }

    #[inline]
    pub fn properties_string(&self) -> &str {
        self.properties_string.as_str()
    }

    #[inline]
    pub fn queue_offset(&self) -> i64 {
        self.message_ext_inner.queue_offset()
    }

    #[inline]
    pub fn tags_string2tags_code(_filter: &TopicFilterType, tags: &str) -> i64 {
        if tags.is_empty() {
            return 0;
        }
        JavaStringHasher::hash_str(tags) as i64
    }

    #[inline]
    pub fn tags_string_to_tags_code(tags: &str) -> i64 {
        if tags.is_empty() {
            return 0;
        }
        JavaStringHasher::hash_str(tags) as i64
    }

    #[inline]
    pub fn get_tags(&self) -> Option<CheetahString> {
        self.message_ext_inner.get_tags()
    }

    #[inline]
    pub fn get_transaction_id(&self) -> Option<&CheetahString> {
        self.message_ext_inner.get_transaction_id()
    }

    #[inline]
    pub fn is_wait_store_msg_ok(&self) -> bool {
        self.message_ext_inner.message.is_wait_store_msg_ok()
    }

    #[inline]
    pub fn body_len(&self) -> usize {
        self.message_ext_inner.message.body_slice().len()
    }
}

impl fmt::Display for MessageExtBrokerInner {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "MessageExtBrokerInner{{topic='{}', queueId={}, queueOffset={}, flag={}, sysFlag={}, bodyLen={}, \
             propertyCount={}, msgId='{}', encodeCompleted={}, version={}}}",
            self.topic(),
            self.queue_id(),
            self.queue_offset(),
            self.flag(),
            self.sys_flag(),
            self.body_len(),
            self.message_ext_inner.message.properties().len(),
            self.message_ext_inner.msg_id(),
            self.encode_completed,
            self.version,
        )
    }
}

impl Debug for MessageExtBrokerInner {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.debug_struct("MessageExtBrokerInner")
            .field("topic", self.topic())
            .field("queue_id", &self.queue_id())
            .field("queue_offset", &self.queue_offset())
            .field("flag", &self.flag())
            .field("sys_flag", &self.sys_flag())
            .field("body_len", &self.body_len())
            .field("property_count", &self.message_ext_inner.message.properties().len())
            .field("msg_id", self.message_ext_inner.msg_id())
            .field("encode_completed", &self.encode_completed)
            .field("version", &self.version)
            .finish()
    }
}

impl MessageTrait for MessageExtBrokerInner {
    #[inline]
    fn put_property(&mut self, key: CheetahString, value: CheetahString) {
        self.message_ext_inner.put_property(key, value);
        self.properties_string = message_properties_to_string(self.message_ext_inner.get_properties());
    }

    #[inline]
    fn clear_property(&mut self, name: &str) {
        self.delete_property(name);
    }

    #[inline]
    fn property(&self, name: &CheetahString) -> Option<CheetahString> {
        self.message_ext_inner.property(name)
    }

    fn property_ref(&self, name: &CheetahString) -> Option<&CheetahString> {
        self.message_ext_inner.property_ref(name)
    }

    #[inline]
    fn topic(&self) -> &CheetahString {
        self.message_ext_inner.topic()
    }

    #[inline]
    fn set_topic(&mut self, topic: CheetahString) {
        self.message_ext_inner.set_topic(topic);
    }

    #[inline]
    fn get_flag(&self) -> i32 {
        self.message_ext_inner.get_flag()
    }

    #[inline]
    fn set_flag(&mut self, flag: i32) {
        self.message_ext_inner.set_flag(flag);
    }

    #[inline]
    fn get_body(&self) -> Option<&Bytes> {
        self.message_ext_inner.get_body()
    }

    #[inline]
    fn set_body(&mut self, body: Bytes) {
        self.message_ext_inner.set_body(body);
    }

    #[inline]
    fn get_properties(&self) -> &HashMap<CheetahString, CheetahString> {
        self.message_ext_inner.get_properties()
    }

    #[inline]
    fn set_properties(&mut self, properties: HashMap<CheetahString, CheetahString>) {
        self.message_ext_inner.set_properties(properties.clone());
        self.properties_string = message_properties_to_string(&properties);
    }

    #[inline]
    fn transaction_id(&self) -> Option<&CheetahString> {
        self.message_ext_inner.transaction_id()
    }

    #[inline]
    fn set_transaction_id(&mut self, transaction_id: CheetahString) {
        self.message_ext_inner.set_transaction_id(transaction_id);
    }

    #[inline]
    fn get_compressed_body_mut(&mut self) -> Option<&mut Bytes> {
        self.message_ext_inner.get_compressed_body_mut()
    }

    #[inline]
    fn get_compressed_body(&self) -> Option<&Bytes> {
        self.message_ext_inner.get_compressed_body()
    }

    #[inline]
    fn set_compressed_body_mut(&mut self, compressed_body: Bytes) {
        self.message_ext_inner.set_compressed_body_mut(compressed_body);
    }

    #[inline]
    fn take_body(&mut self) -> Option<Bytes> {
        self.message_ext_inner.take_body()
    }

    #[inline]
    fn as_any(&self) -> &dyn Any {
        self
    }

    #[inline]
    fn as_any_mut(&mut self) -> &mut dyn Any {
        self
    }
}

// Conversion to new BrokerMessage type
impl From<MessageExtBrokerInner> for crate::common::message::broker_message::BrokerMessage {
    fn from(inner: MessageExtBrokerInner) -> Self {
        use crate::common::message::broker_message::BrokerMessage;
        use crate::common::message::message_envelope::MessageEnvelope;

        let envelope = MessageEnvelope::from(inner.message_ext_inner);

        BrokerMessage::new(envelope, inner.tags_code, inner.properties_string, inner.version)
    }
}

// Conversion from new BrokerMessage type
impl From<crate::common::message::broker_message::BrokerMessage> for MessageExtBrokerInner {
    fn from(broker_msg: crate::common::message::broker_message::BrokerMessage) -> Self {
        use crate::common::message::message_ext::MessageExt;

        let message_ext_inner = MessageExt::from(broker_msg.envelope().clone());

        Self {
            message_ext_inner,
            properties_string: CheetahString::from_slice(broker_msg.properties_string()),
            tags_code: broker_msg.tags_code(),
            encoded_buff: broker_msg.encoded_buff().cloned(),
            encode_completed: broker_msg.is_encode_completed(),
            version: broker_msg.version(),
        }
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use super::MessageExtBrokerInner;
    use crate::codec::string_to_message_properties;
    use crate::common::message::MessageTrait;
    use cheetah_string::CheetahString;

    #[test]
    fn message_ext_broker_inner_get_transaction_id_delegates_to_inner_message() {
        let mut message = MessageExtBrokerInner::default();
        MessageTrait::set_transaction_id(&mut message, CheetahString::from("tx-123"));

        assert_eq!(message.get_transaction_id(), Some(&CheetahString::from("tx-123")));
    }

    #[test]
    fn message_ext_broker_inner_put_property_updates_properties_string() {
        let mut message = MessageExtBrokerInner::default();

        message.put_property(CheetahString::from("k"), CheetahString::from("v"));

        let decoded = string_to_message_properties(Some(&CheetahString::from(message.properties_string())));
        assert_eq!(decoded.get("k").map(CheetahString::as_str), Some("v"));
    }

    #[test]
    fn message_ext_broker_inner_set_properties_updates_properties_string() {
        let mut message = MessageExtBrokerInner::default();
        let properties = HashMap::from([(CheetahString::from("k"), CheetahString::from("v"))]);

        message.set_properties(properties);

        let decoded = string_to_message_properties(Some(&CheetahString::from(message.properties_string())));
        assert_eq!(decoded.get("k").map(CheetahString::as_str), Some("v"));
    }

    #[test]
    fn message_ext_broker_inner_body_len_returns_zero_for_empty_body() {
        let message = MessageExtBrokerInner::default();

        assert_eq!(message.body_len(), 0);
    }
}