tina-core 0.0.2

Tina platform
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
//! 请求日志参数
use crate::serde::Serialize;
use crate::tina::data::json::{JsonToString, ToJson};
use crate::tina::util::string::{CharIndex, StringExt};
use serde_json::{Map, Value};
use std::borrow::Cow;
use std::error::Error;
use std::fmt::{Display, Formatter};
use std::mem::swap;
use std::ops::Deref;
use std::sync::atomic::{AtomicBool, AtomicI64, AtomicUsize, Ordering};
use std::sync::{Arc, RwLock};
use tracing::Level;

/// 请求日志参数
pub struct RequestLogParam {
    level: RwLock<Level>,
    contains_sensitive_param: AtomicBool,
    user_id: RwLock<String>,
    request_uri: RwLock<String>,
    remote_ip_address: RwLock<String>,
    http_method: RwLock<String>,
    handler_name: RwLock<String>,
    max_param_len: AtomicUsize,
    start_time_millis: AtomicI64,
    end_time_millis: AtomicI64,
    raw_param: RwLock<Arc<String>>,
    param: RwLock<Arc<Value>>,
    result: RwLock<Arc<Value>>,
    err: RwLock<Option<Arc<Value>>>,
}

impl Default for RequestLogParam {
    fn default() -> Self {
        Self::new()
    }
}

impl RequestLogParam {
    /// 构建
    pub fn new() -> RequestLogParam {
        RequestLogParam {
            level: RwLock::new(Level::DEBUG),
            contains_sensitive_param: Default::default(),
            user_id: RwLock::new("unkown".to_string()),
            request_uri: RwLock::new("unkown".to_string()),
            remote_ip_address: RwLock::new("unkown".to_string()),
            http_method: RwLock::new("unkown".to_string()),
            handler_name: Default::default(),
            max_param_len: Default::default(),
            start_time_millis: Default::default(),
            end_time_millis: Default::default(),
            raw_param: Default::default(),
            param: RwLock::new(Arc::new(Default::default())),
            result: RwLock::new(Arc::new(Default::default())),
            err: Default::default(),
        }
    }

    /// 设置日志级别
    pub fn set_log_level(&self, level: Level) {
        match self.level.write() {
            Ok(mut v) => (*v) = level,
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 获取日志级别
    pub fn get_log_level(&self) -> Level {
        match self.level.read() {
            Ok(v) => *v,
            Err(err) => {
                tracing::error!("{}", err);
                Level::DEBUG
            }
        }
    }

    /// 设置是否包含敏感信息
    pub fn set_contains_sensitive_param(&self, contains_sensitive_param: bool) {
        self.contains_sensitive_param.store(contains_sensitive_param, Ordering::Relaxed);
    }

    /// 设置用户ID
    pub fn set_user_id(&self, user_id: String) {
        match self.user_id.write() {
            Ok(mut v) => (*v) = user_id,
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 设置请求URI
    pub fn set_request_uri(&self, request_uri: String) {
        match self.request_uri.write() {
            Ok(mut v) => (*v) = request_uri,
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 设置请求源IP
    pub fn set_remote_ip_address(&self, remote_ip_address: String) {
        match self.remote_ip_address.write() {
            Ok(mut v) => (*v) = remote_ip_address,
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 设置Http Method
    pub fn set_http_method(&self, http_method: String) {
        match self.http_method.write() {
            Ok(mut v) => (*v) = http_method,
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 设置接口方法名
    pub fn set_handler_name(&self, handler_name: String) {
        match self.handler_name.write() {
            Ok(mut v) => (*v) = handler_name,
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 设置参数最大长度
    pub fn set_max_param_len(&self, max_param_len: usize) {
        self.max_param_len.store(max_param_len, Ordering::Relaxed);
    }

    /// 设置请求开始时间
    pub fn set_start_time_millis(&self, start_time_millis: i64) {
        self.start_time_millis.store(start_time_millis, Ordering::Relaxed);
    }

    /// 设置请求结束时间
    pub fn set_end_time_millis(&self, end_time_millis: i64) {
        self.end_time_millis.store(end_time_millis, Ordering::Relaxed);
    }

    /// 设置请求参数
    pub fn set_param(&self, param: Arc<Value>) {
        match self.param.write() {
            Ok(mut v) => (*v) = param,
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 设置请求参数
    pub fn set_param_val<T: Serialize>(&self, param: &T) {
        let mut value = param.to_json_value();
        filter_non_null(&mut value);
        self.set_param(Arc::new(value));
    }

    /// 获取请求参数
    pub fn get_param(&self) -> Option<Arc<Value>> {
        match self.param.read() {
            Ok(v) => Some((*v).clone()),
            Err(err) => {
                tracing::error!("{}", err);
                None
            }
        }
    }

    /// 设置请求参数
    pub fn set_raw_param(&self, param: String) {
        match self.raw_param.write() {
            Ok(mut v) => (*v) = Arc::new(param),
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 设置请求参数
    pub fn set_raw_param_lossy(&self, param: Cow<'_, str>) {
        match self.raw_param.write() {
            Ok(mut v) => {
                (*v) = match param {
                    Cow::Borrowed(s) => Arc::new(s.to_string()),
                    Cow::Owned(s) => Arc::new(s),
                }
            }
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 获取请求参数
    pub fn get_raw_param(&self) -> Option<Arc<String>> {
        match self.raw_param.read() {
            Ok(v) => Some((*v).clone()),
            Err(err) => {
                tracing::error!("{}", err);
                None
            }
        }
    }

    /// 设置请求结果
    pub fn set_result(&self, result: Arc<Value>) {
        match self.result.write() {
            Ok(mut v) => (*v) = result,
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 设置请求结果
    pub fn set_result_val<T: Serialize>(&self, result: &T) {
        let mut value = result.to_json_value();
        filter_non_null(&mut value);
        self.set_result(Arc::new(value));
    }

    /// 获取请求参数
    pub fn get_result(&self) -> Option<Arc<Value>> {
        match self.result.read() {
            Ok(v) => Some((*v).clone()),
            Err(err) => {
                tracing::error!("{}", err);
                None
            }
        }
    }

    /// 设置异常
    pub fn set_err(&self, err: impl Error) {
        match self.err.write() {
            Ok(mut v) => (*v) = Some(Arc::new(Value::String(format!("{}", err)))),
            Err(err) => {
                tracing::error!("{}", err);
            }
        }
    }

    /// 获取请求参数
    pub fn get_err(&self) -> Option<Arc<Value>> {
        match self.err.read() {
            Ok(v) => (*v).clone(),
            Err(err) => {
                tracing::error!("{}", err);
                None
            }
        }
    }

    /// 获取请求执行时间
    pub fn get_execution_time_millis(&self) -> i64 {
        self.end_time_millis.load(Ordering::Relaxed) - self.start_time_millis.load(Ordering::Relaxed)
    }
}

fn filter_non_null(value: &mut Value) {
    match value {
        Value::Null => {}
        Value::Bool(_) => {}
        Value::Number(_) => {}
        Value::String(_) => {}
        Value::Array(v) => {
            for item in v.iter_mut() {
                filter_non_null(item);
            }
        }
        Value::Object(map) => {
            let mut tmp = Map::new();
            swap(map, &mut tmp);
            for (k, v) in tmp.into_iter() {
                match v {
                    Value::Null => {}
                    Value::Array(mut arr) => {
                        for item in arr.iter_mut() {
                            filter_non_null(item);
                        }
                        map.insert(k, Value::Array(arr));
                    }
                    Value::Object(item) => {
                        let mut v = Value::Object(item);
                        filter_non_null(&mut v);
                        map.insert(k, v);
                    }
                    _ => {
                        map.insert(k, v);
                    }
                }
            }
        }
    }
}

impl Display for RequestLogParam {
    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        let contains_sensitive_param = self.contains_sensitive_param.load(Ordering::Relaxed);
        let handler_name = match self.handler_name.read() {
            Ok(v) => v.deref().to_string(),
            Err(err) => {
                tracing::error!("{}", err);
                "[锁异常]".to_owned()
            }
        };
        let raw_param = match contains_sensitive_param {
            true => "[包含敏感信息, 不显示内容]".to_owned(),
            false => match self.raw_param.read() {
                Ok(param) => param.deref().to_string(),
                Err(err) => {
                    tracing::error!("{}", err);
                    "[锁异常]".to_owned()
                }
            },
        };
        let param = match contains_sensitive_param {
            true => "[包含敏感信息, 不显示内容]".to_owned(),
            false => match self.param.read() {
                Ok(param) => param.deref().to_json_string(),
                Err(err) => {
                    tracing::error!("{}", err);
                    "[锁异常]".to_owned()
                }
            },
        };
        let mut result = match contains_sensitive_param {
            true => "[包含敏感信息, 不显示内容]".to_owned(),
            false => match self.result.read() {
                Ok(result) => result.deref().to_json_string(),
                Err(err) => {
                    tracing::error!("{}", err);
                    "[锁异常]".to_owned()
                }
            },
        };
        let err = self.get_err().map(|v| {
            let mut str_val = v.to_string_value();
            if str_val.is_empty() {
                str_val = v.to_json_string();
            }
            str_val
        });
        if let Some(err) = err {
            result = err;
        }
        let max_len = self.max_param_len.load(Ordering::Relaxed);
        let raw_param = match raw_param.char_length() > CharIndex::value_of(max_len) {
            true => (raw_param.substring(CharIndex::ZERO..CharIndex::value_of(max_len)), Cow::Borrowed(" (参数过长)...")),
            false => (Cow::Borrowed(raw_param.as_str()), Cow::Borrowed("")),
        };
        let param = match param.char_length() > CharIndex::value_of(max_len) {
            true => (param.substring(CharIndex::ZERO..CharIndex::value_of(max_len)), Cow::Borrowed(" (参数过长)...")),
            false => (Cow::Borrowed(param.as_str()), Cow::Borrowed("")),
        };
        let result = match result.char_length() > CharIndex::value_of(max_len) {
            true => (result.substring(CharIndex::ZERO..CharIndex::value_of(max_len)), Cow::Borrowed(" (参数过长)...")),
            false => (Cow::Borrowed(result.as_str()), Cow::Borrowed("")),
        };
        let execution_time_seconds = (self.get_execution_time_millis() as f64) / 1000f64;
        let execution_time_seconds = match execution_time_seconds > 0f64 {
            true => execution_time_seconds,
            false => 0f64,
        };

        let user_id = match self.user_id.read() {
            Ok(v) => v.deref().to_string(),
            Err(err) => {
                tracing::error!("{}", err);
                "[锁异常]".to_owned()
            }
        };
        let remote_ip_address = match self.remote_ip_address.read() {
            Ok(v) => v.deref().to_string(),
            Err(err) => {
                tracing::error!("{}", err);
                "[锁异常]".to_owned()
            }
        };
        let http_method = match self.http_method.read() {
            Ok(v) => v.deref().to_string(),
            Err(err) => {
                tracing::error!("{}", err);
                "[锁异常]".to_owned()
            }
        };
        let request_uri = match self.request_uri.read() {
            Ok(v) => v.deref().to_string(),
            Err(err) => {
                tracing::error!("{}", err);
                "[锁异常]".to_owned()
            }
        };

        let sep = match cfg!(debug_assertions) {
            true => "\r\n",
            false => " | ",
        };
        let msg = format!(
            "用户: {} | 来源({}) | 请求{}接口: {} | 方法名: {}{}原始参数: {}{}{}有效参数: {}{}{}返回结果: {}{}{}运行时间: {}",
            user_id,
            remote_ip_address,
            http_method,
            request_uri,
            handler_name,
            sep,
            raw_param.0,
            raw_param.1,
            sep,
            param.0,
            param.1,
            sep,
            result.0,
            result.1,
            sep,
            execution_time_seconds
        );
        f.write_str(msg.as_str())
    }
}