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

// 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.

pub struct FAQUrl;

impl FAQUrl {
    pub const APPLY_TOPIC_URL: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const CLIENT_PARAMETER_CHECK_URL: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const CLIENT_SERVICE_NOT_OK: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const GROUP_NAME_DUPLICATE_URL: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const LOAD_JSON_EXCEPTION: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    const MORE_INFORMATION: &'static str = "For more information, please visit the url, ";
    pub const MQLIST_NOT_EXIST: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const NAME_SERVER_ADDR_NOT_EXIST_URL: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    // FAQ: No route info of this topic, TopicABC
    pub const NO_TOPIC_ROUTE_INFO: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const SAME_GROUP_DIFFERENT_TOPIC: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const SEND_MSG_FAILED: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const SUBSCRIPTION_GROUP_NOT_EXIST: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    const TIP_STRING_BEGIN: &'static str = "\nSee ";
    const TIP_STRING_END: &'static str = " for further details.";
    pub const UNEXPECTED_EXCEPTION_URL: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";
    pub const UNKNOWN_HOST_EXCEPTION: &'static str = "https://rocketmq.apache.org/docs/bestPractice/06FAQ";

    pub fn suggest_todo(url: &'static str) -> String {
        format!("{}{}{}", Self::TIP_STRING_BEGIN, url, Self::TIP_STRING_END)
    }

    pub fn attach_default_url(error_message: Option<&str>) -> String {
        if let Some(err_msg) = error_message {
            let already_has_see_tip = err_msg.contains(Self::TIP_STRING_BEGIN);
            let already_has_default = err_msg.contains(Self::MORE_INFORMATION);
            if !already_has_see_tip && !already_has_default {
                return format!(
                    "{}\n{}{}",
                    err_msg,
                    Self::MORE_INFORMATION,
                    Self::UNEXPECTED_EXCEPTION_URL
                );
            }
        }
        error_message.unwrap_or_default().to_string()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn attach_default_url_is_idempotent_and_preserves_format() {
        let ordinary_error = "Test error";
        let first_message = FAQUrl::attach_default_url(Some(ordinary_error));
        assert_eq!(
            first_message,
            format!(
                "{}\n{}{}",
                ordinary_error,
                FAQUrl::MORE_INFORMATION,
                FAQUrl::UNEXPECTED_EXCEPTION_URL
            )
        );
        let second_message = FAQUrl::attach_default_url(Some(&first_message));
        assert_eq!(second_message, first_message);
        let err_message_with_tip = format!("Error with tip {}", FAQUrl::TIP_STRING_BEGIN);
        assert_eq!(
            err_message_with_tip,
            FAQUrl::attach_default_url(Some(&err_message_with_tip))
        );
        assert_eq!("", FAQUrl::attach_default_url(None));
    }
}