zilliz 0.1.1

TUI and CLI tool for managing Zilliz Cloud clusters and Milvus operations
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

/// Return a user-friendly hint for a common API error, or None if no hint applies.
pub fn get_error_hint(
    status_code: Option<u16>,
    error_code: i64,
    message: &str,
) -> Option<String> {
    let msg_lower = message.to_lowercase();

    if matches!(status_code, Some(401) | Some(403)) || error_code == 80001 {
        return Some(
            "Check your API key with `zilliz configure` or re-run `zilliz login`.".to_string(),
        );
    }

    if msg_lower.contains("permissiondenied") || msg_lower.contains("permission deny") {
        return Some(
            "This may require a Dedicated cluster plan, or your API key may lack the required permissions.".to_string(),
        );
    }

    if matches!(status_code, Some(429)) || msg_lower.contains("rate limit") {
        return Some(
            "Rate limit reached. Wait a moment and retry, or reduce request frequency.".to_string(),
        );
    }

    if msg_lower.contains("timeout") || msg_lower.contains("timed out") {
        return Some(
            "Request timed out. Check your network connection and try again.".to_string(),
        );
    }

    if msg_lower.contains("connection") || msg_lower.contains("connect") {
        return Some(
            "Connection failed. Check your network and that the endpoint is reachable.".to_string(),
        );
    }

    if matches!(status_code, Some(500..=599)) {
        return Some(
            "Server error. This is usually temporary -- retry in a few seconds.".to_string(),
        );
    }

    None
}

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

    #[test]
    fn test_auth_error() {
        let hint = get_error_hint(Some(401), 0, "Unauthorized");
        assert!(hint.is_some());
        assert!(hint.unwrap().contains("API key"));
    }

    #[test]
    fn test_error_code_80001() {
        let hint = get_error_hint(None, 80001, "some message");
        assert!(hint.is_some());
        assert!(hint.unwrap().contains("API key"));
    }

    #[test]
    fn test_rate_limit() {
        let hint = get_error_hint(Some(429), 0, "Too many requests");
        assert!(hint.is_some());
        assert!(hint.unwrap().contains("Rate limit"));
    }

    #[test]
    fn test_server_error() {
        let hint = get_error_hint(Some(502), 0, "Bad Gateway");
        assert!(hint.is_some());
        assert!(hint.unwrap().contains("Server error"));
    }

    #[test]
    fn test_no_hint() {
        let hint = get_error_hint(Some(200), 0, "Success");
        assert!(hint.is_none());
    }

    #[test]
    fn test_permission_denied_case_insensitive() {
        let hint = get_error_hint(None, 0, "PermissionDenied: access not allowed");
        assert!(hint.is_some());
        assert!(hint.unwrap().contains("Dedicated"));
    }

    #[test]
    fn test_timeout_hint() {
        let hint = get_error_hint(None, 0, "Request Timed Out after 30s");
        assert!(hint.is_some());
        assert!(hint.unwrap().contains("timed out"));
    }

    #[test]
    fn test_connection_hint() {
        let hint = get_error_hint(None, 0, "Connection refused");
        assert!(hint.is_some());
        assert!(hint.unwrap().contains("Connection failed"));
    }
}