alef 0.58.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

use super::*;
use alef::core::config::NewAlefConfig;
use alef::core::ir::{MethodDef, ReceiverKind};

fn streaming_config() -> ResolvedCrateConfig {
    let toml = r#"
[workspace]
languages = ["php"]

[[crates]]
name = "test-lib"
sources = ["src/lib.rs"]

[crates.php]
extension_name = "test_lib"

[[crates.adapters]]
name = "crawl_stream"
pattern = "streaming"
core_path = "crawl_stream"
owner_type = "CrawlEngineHandle"
item_type = "CrawlEvent"
error_type = "TestError"

[[crates.adapters]]
name = "batch_crawl_stream"
pattern = "streaming"
core_path = "batch_crawl_stream"
owner_type = "CrawlEngineHandle"
item_type = "CrawlEvent"
error_type = "TestError"
"#;
    let cfg: NewAlefConfig = toml::from_str(toml).expect("test config must parse");
    cfg.resolve().expect("test config must resolve").remove(0)
}

fn streaming_method(name: &str) -> MethodDef {
    MethodDef {
        name: name.to_string(),
        params: vec![],
        return_type: TypeRef::Unit,
        is_async: true,
        is_static: false,
        error_type: Some("TestError".to_string()),
        doc: String::new(),
        sanitized: false,
        returns_ref: false,
        returns_cow: false,
        return_newtype_wrapper: None,
        receiver: Some(ReceiverKind::Ref),
        trait_source: None,
        has_default_impl: false,
        binding_excluded: false,
        binding_exclusion_reason: None,
        version: Default::default(),
    }
}

fn streaming_api() -> ApiSurface {
    ApiSurface {
        crate_name: "test-lib".to_string(),
        version: "0.1.0".to_string(),
        types: vec![TypeDef {
            name: "CrawlEngineHandle".to_string(),
            rust_path: "test_lib::CrawlEngineHandle".to_string(),
            original_rust_path: String::new(),
            fields: vec![],
            methods: vec![streaming_method("crawl_stream"), streaming_method("batch_crawl_stream")],
            is_opaque: true,
            is_clone: false,
            is_copy: false,
            is_trait: false,
            has_default: false,
            has_stripped_cfg_fields: false,
            is_return_type: false,
            serde_rename_all: None,
            has_serde: false,
            super_traits: vec![],
            doc: String::new(),
            cfg: None,
            binding_excluded: false,
            binding_exclusion_reason: None,
            is_variant_wrapper: false,
            has_lifetime_params: false,
            has_private_fields: false,
            version: Default::default(),
        }],
        functions: vec![],
        ..Default::default()
    }
}

fn emitted_streaming_method_order(lib_rs: &str) -> Vec<&str> {
    ["crawl_stream", "batch_crawl_stream"]
        .into_iter()
        .filter_map(|name| lib_rs.find(&format!("pub fn {name}(")).map(|at| (at, name)))
        .collect::<std::collections::BTreeMap<_, _>>()
        .into_values()
        .collect()
}

/// The `#[php_impl]` block must emit streaming methods in the order their adapters are declared in
/// `alef.toml`. The keys used to be collected into an `AHashSet` and iterated, and because ahash
/// seeds itself per process, regenerating an unchanged tree could swap `crawl_stream` and
/// `batch_crawl_stream` — a spurious diff that made the freshness gate intermittently red.
#[test]
fn php_streaming_methods_are_emitted_in_adapter_declaration_order() {
    let files = PhpBackend
        .generate_bindings(&streaming_api(), &streaming_config())
        .expect("php bindings must generate");
    let lib_rs = files
        .iter()
        .find(|f| f.path.to_string_lossy().ends_with("lib.rs"))
        .map(|f| f.content.as_str())
        .expect("generated lib.rs must exist");

    assert_eq!(
        emitted_streaming_method_order(lib_rs),
        vec!["crawl_stream", "batch_crawl_stream"],
        "streaming methods must follow adapter declaration order:\n{lib_rs}"
    );
}

/// Guards the same defect from the other side: repeated generation inside one process must produce
/// byte-identical output. Each `AHashSet` built in a process gets its own seed, so a hash-ordered
/// emission would disagree with itself well before this loop finished.
#[test]
fn php_streaming_method_emission_is_stable_across_repeated_generation() {
    let api = streaming_api();
    let config = streaming_config();
    let generate = || {
        let files = PhpBackend
            .generate_bindings(&api, &config)
            .expect("php bindings must generate");
        files
            .iter()
            .find(|f| f.path.to_string_lossy().ends_with("lib.rs"))
            .map(|f| f.content.clone())
            .expect("generated lib.rs must exist")
    };

    let first = generate();
    for attempt in 1..16 {
        assert_eq!(generate(), first, "generation {attempt} differed from the first");
    }
}