alef 0.75.0

Opinionated polyglot binding generator for Rust libraries
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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
use crate::cli::registry;
use crate::core::config::{Language, ResolvedCrateConfig};
use crate::core::ir::{ApiSurface, DefaultValue, TypeRef};
use crate::core::validation::{ValidatedApiSurface, ValidationCode, ValidationDiagnostic, ValidationSeverity};

pub(super) fn validate_generation_api<'a>(
    api: &'a ApiSurface,
    config: &ResolvedCrateConfig,
    languages: &[Language],
) -> anyhow::Result<ValidatedApiSurface<'a>> {
    let bridged_trait_names: ahash::AHashSet<&str> = config
        .trait_bridges
        .iter()
        .map(|bridge| bridge.trait_name.as_str())
        .collect();
    let validation_report = crate::core::validation::validate_api_surface_for_resolved_languages(
        api,
        &bridged_trait_names,
        Some(languages),
    );
    let language_diagnostics = language_backend_readiness_diagnostics(api, config, languages);
    for diagnostic in language_diagnostics
        .iter()
        .filter(|diagnostic| diagnostic.severity == ValidationSeverity::Warning)
    {
        tracing::warn!("{diagnostic}");
    }
    // `validation_report`'s own warnings (e.g. SerdeContainerConversionUnsupported) previously
    // had no print path at all here -- only its Errors were ever consulted (for the fatal/
    // suppressed handling below), so a Warning-severity diagnostic from
    // `backend_readiness_diagnostics` was silently dropped before reaching the user. Mirrors
    // the language_diagnostics loop above, and the same suppression precedent as the
    // fatal-error handling below: a consumer's own `suppress_validation_codes` entry still
    // demotes this to `debug!` rather than reprinting what they explicitly opted out of. ~keep
    for diagnostic in validation_report
        .diagnostics
        .iter()
        .filter(|diagnostic| diagnostic.severity == ValidationSeverity::Warning)
    {
        if config
            .suppress_validation_codes
            .iter()
            .any(|code| code == &diagnostic.code.to_string())
        {
            tracing::debug!("[suppressed] {diagnostic}");
        } else {
            tracing::warn!("{diagnostic}");
        }
    }
    let fatal: Vec<_> = validation_report
        .errors()
        .filter(|diagnostic| {
            crate::core::validation::is_critical_unsuppressible(diagnostic.code)
                || !config
                    .suppress_validation_codes
                    .iter()
                    .any(|code| code == &diagnostic.code.to_string())
        })
        .collect();
    let fatal_language_diagnostics: Vec<_> = language_diagnostics
        .iter()
        .filter(|diagnostic| diagnostic.severity == ValidationSeverity::Error)
        .collect();
    for diagnostic in validation_report.errors().filter(|diagnostic| {
        !crate::core::validation::is_critical_unsuppressible(diagnostic.code)
            && config
                .suppress_validation_codes
                .iter()
                .any(|code| code == &diagnostic.code.to_string())
    }) {
        // The consumer explicitly opted into suppress_validation_codes for this diagnostic;
        // re-printing it at warn level defeats their own declared setting. ~keep
        tracing::debug!("[suppressed] {diagnostic}");
    }
    if !fatal.is_empty() || !fatal_language_diagnostics.is_empty() {
        let formatted = fatal
            .iter()
            .copied()
            .chain(fatal_language_diagnostics.iter().copied())
            .map(|diagnostic| {
                let path = diagnostic
                    .item_path
                    .as_deref()
                    .map(|p| format!(" item `{p}`"))
                    .unwrap_or_default();
                format!("- [{}]{path} {}", diagnostic.code, diagnostic.reason)
            })
            .collect::<Vec<_>>()
            .join("\n");
        anyhow::bail!("{formatted}");
    }
    ValidatedApiSurface::new_with_bridged_traits(api, &config.suppress_validation_codes, &bridged_trait_names)
        .map_err(|report| anyhow::anyhow!(report.format_errors()))
}

fn language_backend_readiness_diagnostics(
    api: &ApiSurface,
    config: &ResolvedCrateConfig,
    languages: &[Language],
) -> Vec<ValidationDiagnostic> {
    let mut diagnostics = Vec::new();
    diagnostics.extend(service_api_capability_diagnostics(api, config, languages));
    diagnostics.extend(ffi_json_return_diagnostics(api, config, languages));
    diagnostics.extend(unconsumed_custom_modules_diagnostics(config));
    diagnostics.extend(unreadable_field_default_diagnostics(api, config));
    diagnostics
}

/// Refuse to generate a binding for a field whose Rust default alef could not read.
///
/// This is the doctrine already established for `DefaultValue::FunctionCall` in
/// [`crate::codegen::config_gen::validate_rust_default_functions`] — a binding must never
/// silently ship a value that differs from the source crate's — extended to the case the
/// extractor reports as [`DefaultValue::Unresolved`]. Without it, every backend that spells a
/// per-field initializer (C#, Java, Kotlin, Swift, Python, Dart, Ruby, Elixir, Go, Wasm) emits
/// its own target-language zero, and it does so directly beneath a generated doc comment
/// quoting the real Rust default, because the doc prose and the initializer are produced from
/// different sources.
///
/// Deliberately not scoped to the languages being generated. The zero only *crosses* the FFI
/// for a per-field-literal backend, but the unreadable default also lands in the generated
/// docs for every target, and the classification of which backends carry a literal lives in
/// one place (`backends::default_agreement_tests::carries_per_field_default`) that this must
/// not fork. A crate that genuinely wants the type-zero opts out per-crate with
/// `suppress_validation_codes = ["unreadable_field_default"]`. ~keep
fn unreadable_field_default_diagnostics(api: &ApiSurface, config: &ResolvedCrateConfig) -> Vec<ValidationDiagnostic> {
    // Suppression is honoured here, not by the caller: `validate_generation_api` applies
    // `suppress_validation_codes` only to `validation_report.errors()`, and every
    // language-readiness diagnostic is fatal unconditionally. Emitting an unsuppressible error
    // would leave a crate that genuinely accepts the type-zero with no way forward. ~keep
    if config
        .suppress_validation_codes
        .iter()
        .any(|code| code == &ValidationCode::UnreadableFieldDefault.to_string())
    {
        return Vec::new();
    }

    let mut diagnostics = Vec::new();
    for typ in api.types.iter().filter(|typ| !typ.binding_excluded) {
        // Each field is named with the *expression* alef could not read, because the two cases
        // that reach here need different fixes and the payload is what tells them apart: a whole
        // unreadable `fn default()` body repeats the same text on every field, whereas a single
        // unreadable initializer inside a readable struct literal names just that one. ~keep
        let unreadable: Vec<String> = typ
            .fields
            .iter()
            .filter(|field| !field.binding_excluded)
            .filter_map(|field| match &field.typed_default {
                Some(DefaultValue::Unresolved(source)) => Some(format!("{} (`{source}`)", field.name)),
                _ => None,
            })
            .collect();
        if unreadable.is_empty() {
            continue;
        }
        diagnostics.push(ValidationDiagnostic {
            severity: ValidationSeverity::Error,
            code: ValidationCode::UnreadableFieldDefault,
            crate_name: config.name.clone(),
            language: None,
            item_path: Some(typ.rust_path.clone()),
            reason: format!(
                "`impl Default for {}` could not be read into concrete values for {} {}; every \
                 binding would emit its own target-language zero underneath a doc comment quoting \
                 the real Rust default.",
                typ.name,
                if unreadable.len() == 1 { "field" } else { "fields" },
                unreadable.join(", "),
            ),
            suggested_fix: "spell the defaults as literals in the `fn default()` struct literal, or delegate to an \
                            associated function in the same module that returns a struct literal built from \
                            the literal arguments passed (`Self::new(\"en\")`), or accept the type-zero \
                            explicitly with `suppress_validation_codes = [\"unreadable_field_default\"]`"
                .to_string(),
        });
    }
    diagnostics
}

/// Languages that accept a `[custom_modules].<lang>` list in config but whose
/// backend never reads it, so any entries silently do nothing. Only pyo3
/// (python), ffi, php, magnus (ruby), rustler (elixir), and extendr (r) consume
/// `custom_modules`; the entries below parse cleanly and are dead config (#183).
const UNCONSUMED_CUSTOM_MODULE_LANGUAGES: [Language; 5] = [
    Language::Node,
    Language::Wasm,
    Language::Go,
    Language::Java,
    Language::Csharp,
];

/// Warn when `[custom_modules].<lang>` carries entries for a language whose
/// backend does not consume them. Keyed off what the user actually wrote in
/// config (not the current run's language set), so a stray `[custom_modules].wasm`
/// is flagged even when wasm is not part of this generation run.
fn unconsumed_custom_modules_diagnostics(config: &ResolvedCrateConfig) -> Vec<ValidationDiagnostic> {
    UNCONSUMED_CUSTOM_MODULE_LANGUAGES
        .into_iter()
        .filter(|&language| !config.custom_modules.for_language(language).is_empty())
        .map(|language| {
            let suggested_fix = if language == Language::Wasm {
                "remove the entries; for hand-written Rust modules under wasm use `[crates.wasm].custom_rust_modules` instead".to_string()
            } else {
                format!("remove the `[custom_modules].{language}` entries; no backend consumes them")
            };
            ValidationDiagnostic::warning(
                ValidationCode::UnconsumedConfig,
                config.name.clone(),
                Some(language),
                Some("custom_modules".to_string()),
                format!(
                    "`[custom_modules].{language}` has entries but the {language} backend does not consume `custom_modules`, so they have no effect"
                ),
                suggested_fix,
            )
        })
        .collect()
}

fn service_api_capability_diagnostics(
    api: &ApiSurface,
    config: &ResolvedCrateConfig,
    languages: &[Language],
) -> Vec<ValidationDiagnostic> {
    if api.services.is_empty() {
        return Vec::new();
    }

    languages
        .iter()
        .filter_map(|&language| {
            if !service_api_requested_for_language(api, config, language) {
                return None;
            }
            let backend = registry::try_get_backend(language)?;
            (!backend.capabilities().supports_service_api).then(|| ValidationDiagnostic {
                severity: ValidationSeverity::Error,
                code: ValidationCode::UnsupportedBackendCapability,
                crate_name: config.name.clone(),
                language: Some(language),
                item_path: Some("service_api".to_string()),
                reason: format!(
                    "configured services require service API generation, but backend `{}` does not support it",
                    backend.name()
                ),
                suggested_fix: "remove the language from this generation run, opt it out in service config, or implement service API support for the backend".to_string(),
            })
        })
        .collect()
}

fn service_api_requested_for_language(api: &ApiSurface, config: &ResolvedCrateConfig, language: Language) -> bool {
    api.services.iter().any(|service| {
        config
            .services
            .iter()
            .find(|service_config| service_config.owner_type == service.name)
            .is_none_or(|service_config| !service_config.skip_languages.contains(&language.to_string()))
    })
}

fn ffi_json_return_diagnostics(
    api: &ApiSurface,
    config: &ResolvedCrateConfig,
    languages: &[Language],
) -> Vec<ValidationDiagnostic> {
    let readiness_languages: Vec<_> = languages
        .iter()
        .copied()
        .filter(|language| ffi_json_return_readiness_applies(*language))
        .collect();
    if readiness_languages.is_empty() {
        return Vec::new();
    }

    let mut diagnostics = Vec::new();
    for function in &api.functions {
        if function.binding_excluded {
            continue;
        }
        if non_serde_named_in_ffi_json_return(api, &function.return_type) {
            for language in &readiness_languages {
                diagnostics.push(ffi_json_return_diagnostic(
                    config,
                    *language,
                    &format!("function {}", function.name),
                    &function.return_type,
                ));
            }
        }
    }
    for typ in &api.types {
        if typ.binding_excluded {
            continue;
        }
        for method in &typ.methods {
            if method.binding_excluded {
                continue;
            }
            if non_serde_named_in_ffi_json_return(api, &method.return_type) {
                for language in &readiness_languages {
                    diagnostics.push(ffi_json_return_diagnostic(
                        config,
                        *language,
                        &format!("method {}.{}", typ.name, method.name),
                        &method.return_type,
                    ));
                }
            }
        }
    }
    diagnostics
}

fn ffi_json_return_readiness_applies(language: Language) -> bool {
    matches!(
        language,
        Language::Ffi
            | Language::Go
            | Language::Java
            | Language::Jni
            | Language::Csharp
            | Language::KotlinAndroid
            | Language::Swift
            | Language::R
            | Language::Zig
    )
}

fn non_serde_named_in_ffi_json_return(api: &ApiSurface, ty: &TypeRef) -> bool {
    match ty {
        TypeRef::Vec(inner) => named_lacks_serde(api, inner),
        TypeRef::Map(key, value) => named_lacks_serde(api, key) || named_lacks_serde(api, value),
        TypeRef::Optional(inner) => non_serde_named_in_ffi_json_return(api, inner),
        _ => false,
    }
}

fn named_lacks_serde(api: &ApiSurface, ty: &TypeRef) -> bool {
    match ty {
        TypeRef::Named(name) => {
            if let Some(typ) = api.types.iter().find(|typ| typ.name == *name) {
                return !typ.has_serde;
            }
            if let Some(enum_def) = api.enums.iter().find(|enum_def| enum_def.name == *name) {
                return !enum_def.has_serde;
            }
            false
        }
        TypeRef::Optional(inner) | TypeRef::Vec(inner) => named_lacks_serde(api, inner),
        TypeRef::Map(key, value) => named_lacks_serde(api, key) || named_lacks_serde(api, value),
        _ => false,
    }
}

fn ffi_json_return_diagnostic(
    config: &ResolvedCrateConfig,
    language: Language,
    item_path: &str,
    return_type: &TypeRef,
) -> ValidationDiagnostic {
    ValidationDiagnostic {
        severity: ValidationSeverity::Error,
        code: ValidationCode::BackendStubPath,
        crate_name: config.name.clone(),
        language: Some(language),
        item_path: Some(item_path.to_string()),
        reason: format!(
            "FFI-dependent generation cannot safely marshal return type `{}` because a nested named type lacks serde metadata",
            type_ref_label(return_type)
        ),
        suggested_fix: "derive Serialize/Deserialize on the named return type, expose a binding-safe DTO, or exclude/bridge the item explicitly".to_string(),
    }
}

fn type_ref_label(ty: &TypeRef) -> String {
    match ty {
        TypeRef::Named(name) => name.clone(),
        TypeRef::Vec(inner) => format!("Vec<{}>", type_ref_label(inner)),
        TypeRef::Optional(inner) => format!("Option<{}>", type_ref_label(inner)),
        TypeRef::Map(key, value) => format!("Map<{}, {}>", type_ref_label(key), type_ref_label(value)),
        _ => format!("{ty:?}"),
    }
}

#[cfg(test)]
mod validation_tests {
    use super::*;
    use crate::core::config::service::ServiceConfig;
    use crate::core::ir::{MethodDef, ServiceDef, TypeDef};

    fn method_def(name: &str, return_type: TypeRef) -> MethodDef {
        MethodDef {
            name: name.to_string(),
            params: Vec::new(),
            return_type,
            is_async: false,
            is_static: true,
            error_type: None,
            doc: String::new(),
            receiver: None,
            cfg: None,
            sanitized: false,
            trait_source: None,
            returns_ref: false,
            returns_cow: false,
            return_newtype_wrapper: None,
            has_default_impl: false,
            binding_excluded: false,
            binding_exclusion_reason: None,
            version: Default::default(),
        }
    }

    #[test]
    fn ffi_dependent_generation_rejects_vec_named_return_without_serde_metadata() {
        let api = ApiSurface {
            crate_name: "sample-lib".to_string(),
            types: vec![TypeDef {
                name: "Payload".to_string(),
                rust_path: "sample_lib::Payload".to_string(),
                has_serde: false,
                ..TypeDef::default()
            }],
            functions: vec![crate::core::ir::FunctionDef {
                name: "list_payloads".to_string(),
                rust_path: "sample_lib::list_payloads".to_string(),
                original_rust_path: String::new(),
                params: Vec::new(),
                return_type: TypeRef::Vec(Box::new(TypeRef::Named("Payload".to_string()))),
                is_async: false,
                error_type: None,
                doc: String::new(),
                cfg: None,
                sanitized: false,
                return_sanitized: false,
                returns_ref: false,
                returns_cow: false,
                return_newtype_wrapper: None,
                binding_excluded: false,
                binding_exclusion_reason: None,
                version: Default::default(),
            }],
            ..ApiSurface::default()
        };
        let config = ResolvedCrateConfig {
            name: "sample-lib".to_string(),
            ..ResolvedCrateConfig::default()
        };

        let error = validate_generation_api(&api, &config, &[Language::Ffi]).expect_err("missing serde must fail");

        assert!(
            error.to_string().contains("backend_stub_path") && error.to_string().contains("function list_payloads"),
            "expected FFI backend-readiness error, got {error}"
        );
    }

    #[test]
    fn unconsumed_custom_modules_for_wasm_warns_and_points_at_custom_rust_modules() {
        let config = ResolvedCrateConfig {
            name: "sample-lib".to_string(),
            custom_modules: crate::core::config::CustomModulesConfig {
                wasm: vec!["bridge".to_string(), "engine".to_string()],
                ..Default::default()
            },
            ..ResolvedCrateConfig::default()
        };

        let diagnostics = unconsumed_custom_modules_diagnostics(&config);

        assert_eq!(diagnostics.len(), 1, "exactly one unconsumed-language warning");
        let diagnostic = &diagnostics[0];
        assert_eq!(diagnostic.severity, ValidationSeverity::Warning);
        assert_eq!(diagnostic.code, ValidationCode::UnconsumedConfig);
        assert_eq!(diagnostic.language, Some(Language::Wasm));
        assert!(
            diagnostic.suggested_fix.contains("custom_rust_modules"),
            "wasm fix must point at custom_rust_modules, got {}",
            diagnostic.suggested_fix
        );
    }

    #[test]
    fn consumed_custom_modules_for_python_produce_no_warning() {
        let config = ResolvedCrateConfig {
            name: "sample-lib".to_string(),
            custom_modules: crate::core::config::CustomModulesConfig {
                python: vec!["helpers".to_string()],
                ..Default::default()
            },
            ..ResolvedCrateConfig::default()
        };

        assert!(
            unconsumed_custom_modules_diagnostics(&config).is_empty(),
            "python custom_modules are consumed by pyo3, so no warning"
        );
    }

    #[test]
    fn service_api_generation_rejects_selected_backend_without_capability() {
        let api = ApiSurface {
            crate_name: "sample-lib".to_string(),
            types: vec![TypeDef {
                name: "App".to_string(),
                rust_path: "sample_lib::App".to_string(),
                ..TypeDef::default()
            }],
            services: vec![ServiceDef {
                name: "App".to_string(),
                rust_path: "sample_lib::App".to_string(),
                constructor: method_def("new", TypeRef::Named("App".to_string())),
                configurators: Vec::new(),
                registrations: Vec::new(),
                entrypoints: Vec::new(),
                doc: String::new(),
                cfg: None,
            }],
            ..ApiSurface::default()
        };
        let config = ResolvedCrateConfig {
            name: "sample-lib".to_string(),
            services: vec![ServiceConfig {
                owner_type: "App".to_string(),
                constructor: Some("new".to_string()),
                configurators: Vec::new(),
                registrations: Vec::new(),
                entrypoints: Vec::new(),
                skip_languages: Vec::new(),
                host_app_inner_accessor: None,
            }],
            ..ResolvedCrateConfig::default()
        };

        let error = validate_generation_api(&api, &config, &[Language::KotlinAndroid])
            .expect_err("unsupported service backend must fail");

        assert!(
            error.to_string().contains("unsupported_backend_capability")
                && error.to_string().contains("kotlin_android"),
            "expected unsupported backend capability error, got {error}"
        );
    }
}