salvo-oapi 0.92.0

OpenApi support for Salvo web framework
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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
use std::any::TypeId;
use std::collections::BTreeMap;
use std::sync::LazyLock;

use parking_lot::{RwLock, RwLockReadGuard};
use regex::Regex;

/// NameRule is used to specify the rule of naming.
#[derive(Default, Debug, Clone, Copy)]
pub enum NameRule {
    /// Auto generate name by namer.
    #[default]
    Auto,
    /// Force to use the given name.
    Force(&'static str),
}

static GLOBAL_NAMER: LazyLock<RwLock<Box<dyn Namer>>> =
    LazyLock::new(|| RwLock::new(Box::new(FlexNamer::new())));
static NAME_TYPES: LazyLock<RwLock<BTreeMap<String, (TypeId, &'static str)>>> =
    LazyLock::new(Default::default);

/// Set global namer.
///
/// Set global namer, all the types will be named by this namer. You should call this method before
/// at before you generate OpenAPI schema.
///
/// # Example
///
/// ```rust
/// # use salvo_oapi::extract::*;
/// # use salvo_core::prelude::*;
/// # #[tokio::main]
/// # async fn main() {
/// salvo_oapi::naming::set_namer(
///     salvo_oapi::naming::FlexNamer::new()
///         .short_mode(true)
///         .generic_delimiter('_', '_'),
/// );
/// # }
/// ```
pub fn set_namer(namer: impl Namer) {
    *GLOBAL_NAMER.write() = Box::new(namer);
    NAME_TYPES.write().clear();
}

/// Reset global naming state to defaults.
///
/// This clears all registered type names and resets the namer to default `FlexNamer`.
/// Primarily useful for testing to ensure test isolation.
#[cfg(test)]
pub fn reset_global_state() {
    *GLOBAL_NAMER.write() = Box::new(FlexNamer::new());
    NAME_TYPES.write().clear();
}

#[doc(hidden)]
pub fn namer() -> RwLockReadGuard<'static, Box<dyn Namer>> {
    GLOBAL_NAMER.read()
}

/// Get type info by name.
pub fn type_info_by_name(name: &str) -> Option<(TypeId, &'static str)> {
    NAME_TYPES.read().get(name).cloned()
}

/// Get registered name by rust type name (from `std::any::type_name`).
///
/// This searches through NAME_TYPES to find if a type with the given rust type name
/// has been registered with a custom name.
pub fn name_by_type_name(type_name: &str) -> Option<String> {
    NAME_TYPES
        .read()
        .iter()
        .find(|(_, (_, registered_type_name))| *registered_type_name == type_name)
        .map(|(name, _)| name.clone())
}

/// Resolve generic type parameters to their registered names.
///
/// This function recursively processes a type name string and replaces any
/// generic type parameters with their registered names from NAME_TYPES.
///
/// For example, if `CityDTO` is registered as `City`, then:
/// - `Response<CityDTO>` becomes `Response<City>`
/// - `Vec<HashMap<String, CityDTO>>` becomes `Vec<HashMap<String, City>>`
#[must_use]
pub fn resolve_generic_names(type_name: &str) -> String {
    // First check if the entire type (without generics) has a registered name
    if let Some(registered_name) = name_by_type_name(type_name) {
        return registered_name;
    }

    // Find the position of the first '<' to separate base type from generic params
    let Some(generic_start) = type_name.find('<') else {
        // No generics, return as-is
        return type_name.to_owned();
    };

    // Extract base type and generic part
    let base_type = &type_name[..generic_start];
    let generic_part = &type_name[generic_start..];

    // Parse and resolve each generic parameter
    let resolved_generic = resolve_generic_part(generic_part);

    format!("{base_type}{resolved_generic}")
}

/// Parse generic part like `<A, B<C, D>, E>` and resolve each type parameter.
fn resolve_generic_part(generic_part: &str) -> String {
    if !generic_part.starts_with('<') || !generic_part.ends_with('>') {
        return generic_part.to_owned();
    }

    // Remove outer < and >
    let inner = &generic_part[1..generic_part.len() - 1];

    // Split by top-level commas (not nested in <>)
    let params = split_generic_params(inner);

    let resolved_params: Vec<String> = params
        .into_iter()
        .map(|param| {
            let param = param.trim();
            // Check if this exact type has a registered name
            if let Some(registered_name) = name_by_type_name(param) {
                registered_name
            } else if param.contains('<') {
                // Recursively resolve nested generics
                resolve_generic_names(param)
            } else {
                // Use short name for unregistered types (like primitive types)
                // e.g., "alloc::string::String" -> "String"
                short_type_name(param).to_owned()
            }
        })
        .collect();

    format!("<{}>", resolved_params.join(", "))
}

/// Split generic parameters at top-level commas, respecting nested angle brackets.
fn split_generic_params(s: &str) -> Vec<&str> {
    let mut result = Vec::new();
    let mut depth = 0;
    let mut start = 0;

    for (i, c) in s.char_indices() {
        match c {
            '<' => depth += 1,
            '>' => depth -= 1,
            ',' if depth == 0 => {
                result.push(&s[start..i]);
                start = i + 1;
            }
            _ => {}
        }
    }

    // Don't forget the last segment
    if start < s.len() {
        result.push(&s[start..]);
    }

    result
}

/// Extract the short name from a fully qualified type path.
///
/// For example:
/// - `alloc::string::String` -> `String`
/// - `std::collections::HashMap` -> `HashMap`
/// - `my_crate::module::MyType` -> `MyType`
fn short_type_name(type_name: &str) -> &str {
    // Find the last `::` and return everything after it
    type_name
        .rfind("::")
        .map(|pos| &type_name[pos + 2..])
        .unwrap_or(type_name)
}

/// Set type info by name.
pub fn set_name_type_info(
    name: String,
    type_id: TypeId,
    type_name: &'static str,
) -> Option<(TypeId, &'static str)> {
    NAME_TYPES.write().insert(name, (type_id, type_name))
}

/// Assign name to type and returns the name.
///
/// If the type is already named, return the existing name.
pub fn assign_name<T: 'static>(rule: NameRule) -> String {
    let type_id = TypeId::of::<T>();
    let type_name = std::any::type_name::<T>();
    for (name, (exist_id, _)) in NAME_TYPES.read().iter() {
        if *exist_id == type_id {
            return name.clone();
        }
    }
    namer().assign_name(type_id, type_name, rule)
}

/// Get the name of the type. Panic if the name is not exist.
pub fn get_name<T: 'static>() -> String {
    let type_id = TypeId::of::<T>();
    for (name, (exist_id, _)) in NAME_TYPES.read().iter() {
        if *exist_id == type_id {
            return name.clone();
        }
    }
    panic!(
        "Type not found in the name registry: {:?}",
        std::any::type_name::<T>()
    );
}

fn type_generic_part(type_name: &str) -> String {
    if let Some(pos) = type_name.find('<') {
        type_name[pos..].to_owned()
    } else {
        String::new()
    }
}

/// Resolve generic part and format it according to namer settings.
fn resolve_and_format_generic_part(type_name: &str, short_mode: bool) -> String {
    let generic_part = type_generic_part(type_name);
    if generic_part.is_empty() {
        return generic_part;
    }

    // Resolve registered names in generic parameters
    let resolved = resolve_generic_part(&generic_part);

    // Apply formatting (:: -> . for non-short mode, or strip module paths for short mode)
    if short_mode {
        let re = Regex::new(r"([^<>, ]*::)+").expect("Invalid regex");
        re.replace_all(&resolved, "").into_owned()
    } else {
        resolved.replace("::", ".")
    }
}
/// Namer is used to assign names to types.
pub trait Namer: Sync + Send + 'static {
    /// Assign name to type.
    fn assign_name(&self, type_id: TypeId, type_name: &'static str, rule: NameRule) -> String;
}

/// A namer that generates wordy names.
#[derive(Default, Clone, Debug)]
pub struct FlexNamer {
    short_mode: bool,
    generic_delimiter: Option<(String, String)>,
}
impl FlexNamer {
    /// Create a new FlexNamer.
    #[must_use]
    pub fn new() -> Self {
        Default::default()
    }

    /// Set the short mode.
    #[must_use]
    pub fn short_mode(mut self, short_mode: bool) -> Self {
        self.short_mode = short_mode;
        self
    }

    /// Set the delimiter for generic types.
    #[must_use]
    pub fn generic_delimiter(mut self, open: impl Into<String>, close: impl Into<String>) -> Self {
        self.generic_delimiter = Some((open.into(), close.into()));
        self
    }
}
impl Namer for FlexNamer {
    fn assign_name(&self, type_id: TypeId, type_name: &'static str, rule: NameRule) -> String {
        let name = match rule {
            NameRule::Auto => {
                // First resolve any registered names in generic parameters
                let resolved_type_name = resolve_generic_names(type_name);

                let mut base = if self.short_mode {
                    let re = Regex::new(r"([^<>, ]*::)+").expect("Invalid regex");
                    re.replace_all(&resolved_type_name, "").into_owned()
                } else {
                    resolved_type_name.replace("::", ".")
                };
                if let Some((open, close)) = &self.generic_delimiter {
                    base = base.replace('<', open).replace('>', close);
                }
                let mut name = base.clone();
                let mut count = 1;
                while let Some(exist_id) = type_info_by_name(&name).map(|t| t.0) {
                    if exist_id != type_id {
                        count += 1;
                        name = format!("{base}{count}");
                    } else {
                        break;
                    }
                }
                name
            }
            NameRule::Force(force_name) => {
                // Resolve registered names in generic parameters
                let resolved_generic = resolve_and_format_generic_part(type_name, self.short_mode);

                let mut base = if self.short_mode {
                    // In short mode with Force, use the forced name + resolved generics
                    format!("{force_name}{resolved_generic}")
                } else {
                    format!("{force_name}{resolved_generic}")
                };
                if let Some((open, close)) = &self.generic_delimiter {
                    base = base.replace('<', open).replace('>', close);
                }
                let mut name = base.clone();
                let mut count = 1;
                while let Some((exist_id, exist_name)) = type_info_by_name(&name) {
                    if exist_id != type_id {
                        count += 1;
                        tracing::error!("Duplicate name for types: {}, {}", exist_name, type_name);
                        name = format!("{base}{count}");
                    } else {
                        break;
                    }
                }
                name
            }
        };
        set_name_type_info(name.clone(), type_id, type_name);
        name
    }
}

#[cfg(test)]
mod tests {
    use serial_test::serial;

    #[test]
    #[serial]
    fn test_name() {
        use super::*;

        // Reset global state to ensure deterministic test results
        reset_global_state();

        struct MyString;
        mod nest {
            pub(crate) struct MyString;
        }

        let name = assign_name::<String>(NameRule::Auto);
        assert_eq!(name, "alloc.string.String");
        let name = assign_name::<Vec<String>>(NameRule::Auto);
        assert_eq!(name, "alloc.vec.Vec<alloc.string.String>");

        let name = assign_name::<MyString>(NameRule::Auto);
        assert!(
            name.contains("MyString") && !name.contains("nest"),
            "Expected name containing 'MyString' but not 'nest', got: {name}"
        );
        let name = assign_name::<nest::MyString>(NameRule::Auto);
        assert!(
            name.contains("nest") && name.contains("MyString"),
            "Expected name containing 'nest.MyString', got: {name}"
        );
    }

    #[test]
    #[serial]
    fn test_resolve_generic_names() {
        use super::*;

        // Reset global state to ensure deterministic test results
        reset_global_state();

        // Simulate registering CityDTO as "City"
        let city_type_name = "test_module::CityDTO";
        set_name_type_info(
            "City".to_owned(),
            TypeId::of::<()>(), // dummy TypeId
            city_type_name,
        );

        // Test resolve_generic_names with registered type
        let resolved = resolve_generic_names("Response<test_module::CityDTO>");
        assert_eq!(resolved, "Response<City>");

        // Test nested generics - unregistered types get short names
        let resolved = resolve_generic_names("Vec<HashMap<String, test_module::CityDTO>>");
        assert_eq!(resolved, "Vec<HashMap<String, City>>");

        // Test multiple generic parameters
        let resolved = resolve_generic_names("Tuple<test_module::CityDTO, test_module::CityDTO>");
        assert_eq!(resolved, "Tuple<City, City>");
    }

    #[test]
    #[serial]
    fn test_resolve_primitive_types() {
        use super::*;

        // Reset global state to ensure deterministic test results
        reset_global_state();

        // Test with primitive types (not registered, should use short names in generic params)
        let resolved = resolve_generic_names("Response<alloc::string::String>");
        assert_eq!(resolved, "Response<String>");

        // Note: The base type (Vec) keeps its path, only generic params are shortened
        // FlexNamer::assign_name handles the full path transformation later
        let resolved = resolve_generic_names("Vec<alloc::vec::Vec<alloc::string::String>>");
        assert_eq!(resolved, "Vec<alloc::vec::Vec<String>>");

        // Test HashMap with primitive types
        let resolved =
            resolve_generic_names("std::collections::HashMap<alloc::string::String, i32>");
        assert_eq!(resolved, "std::collections::HashMap<String, i32>");

        // Test that nested generic base types are also shortened in their generics
        let resolved = resolve_generic_names("Option<Vec<alloc::string::String>>");
        assert_eq!(resolved, "Option<Vec<String>>");
    }

    #[test]
    fn test_short_type_name() {
        use super::*;

        assert_eq!(short_type_name("alloc::string::String"), "String");
        assert_eq!(short_type_name("std::collections::HashMap"), "HashMap");
        assert_eq!(short_type_name("MyType"), "MyType");
        assert_eq!(short_type_name("my_crate::module::submodule::Type"), "Type");
    }

    #[test]
    fn test_split_generic_params() {
        use super::*;

        let params = split_generic_params("A, B, C");
        assert_eq!(params, vec!["A", " B", " C"]);

        let params = split_generic_params("A<X, Y>, B, C<Z>");
        assert_eq!(params, vec!["A<X, Y>", " B", " C<Z>"]);

        let params = split_generic_params("A<X<Y, Z>>, B");
        assert_eq!(params, vec!["A<X<Y, Z>>", " B"]);
    }

    #[test]
    #[serial]
    fn test_assign_name_with_generic_resolution() {
        use super::*;

        // Reset global state to ensure deterministic test results
        reset_global_state();

        // Define unique test types for this test to avoid conflicts with other tests
        mod test_generic_resolution {
            pub(super) struct CityDTO;
            pub(super) struct Response<T>(std::marker::PhantomData<T>);
            pub(super) struct Wrapper<T>(std::marker::PhantomData<T>);
        }
        use test_generic_resolution::*;

        // First, register CityDTO with a custom name "City"
        let city_name = assign_name::<CityDTO>(NameRule::Force("City"));
        assert_eq!(city_name, "City");

        // Now register Response<CityDTO> with Force("Response")
        // It should resolve CityDTO to "City" in the generic parameter
        let response_name = assign_name::<Response<CityDTO>>(NameRule::Force("Response"));
        assert_eq!(response_name, "Response<City>");

        // Test with Auto mode - should also resolve generic parameters
        let wrapper_name = assign_name::<Wrapper<CityDTO>>(NameRule::Auto);
        // The base type will have full path, but CityDTO should be resolved to City
        assert!(
            wrapper_name.contains("<City>"),
            "Expected wrapper name to contain '<City>', got: {wrapper_name}"
        );
    }

    #[test]
    #[serial]
    fn test_assign_name_with_primitive_generics() {
        use super::*;

        // Reset global state to ensure deterministic test results
        reset_global_state();

        mod test_primitive_generics {
            pub(super) struct Response<T>(std::marker::PhantomData<T>);
        }
        use test_primitive_generics::*;

        // Test Response<String> with Force("Response")
        // String is not registered, but should be shortened to "String"
        let response_name = assign_name::<Response<String>>(NameRule::Force("Response"));
        assert_eq!(response_name, "Response<String>");

        // Test Response<Vec<String>> - nested generics with primitives
        let response_vec_name =
            assign_name::<Response<Vec<String>>>(NameRule::Force("ResponseVec"));
        assert!(
            response_vec_name.contains("<String>"),
            "Expected name to contain '<String>', got: {response_vec_name}"
        );
    }
}