raf-source 0.0.0

Workspace source index: a Tree file seam with disk and memory backends under canonical path containment.
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
// SPDX-FileCopyrightText: 2026 Blackcat InformaticsĀ® Inc. <paudley@blackcatinformatics.ca>
// SPDX-License-Identifier: MIT OR Apache-2.0 OR MulanPSL-2.0

//! Strict package/edge profile over the supplied native TOML arena.

use purrdf_hash::hex;
use purrdf_lex::allocation::{Admission, Memory};
use purrdf_lex::walk::{try_equal_range_by, try_sort_unstable_by};

use super::{BuildError, LockedPackage, LockedPackageId, LockedSource, LockedSourceKind, invalid};
use crate::manifest::native::{self, field as get};
use crate::meter::Meter;
use crate::{LoadError, RelPath};
use purrdf_toml::{Document, Kind, Node, Scalar};

type Rows = (Vec<LockedPackage>, Vec<LockedPackageId>);

pub(super) fn catalog<S: Admission + ?Sized>(
    text: &str,
    memory: &mut Memory<'_, S>,
    meter: &Meter,
    path: &RelPath,
) -> Result<Rows, BuildError> {
    let document = native::read(text).map_err(|source| {
        match memory.format(&format_args!("invalid TOML: {source}")) {
            Ok(message) => BuildError::Invalid {
                field: "lock",
                message,
                source: Some(Box::new(source)),
            },
            Err(error) => BuildError::Storage(error),
        }
    })?;
    let raw = package_rows(&document, memory, meter, path)?;
    let mut packages = Vec::new();
    memory.reserve(&mut packages, raw.len())?;
    for (index, value) in raw.iter().enumerate() {
        meter.work(1, path, None)?;
        let row = table(&document.nodes()[*value], memory)?;
        keys(
            &document,
            row,
            &["name", "version", "source", "checksum", "dependencies"],
            "package",
            memory,
            meter,
            path,
        )?;
        let package = package(&document, row, LockedPackageId(index), memory)?;
        memory.push(&mut packages, package)?;
    }
    let order = package_order(&packages, memory, meter, path)?;
    for (index, value) in raw.iter().enumerate() {
        let references =
            dependencies(&document, table(&document.nodes()[*value], memory)?, memory)?;
        let mut selected = Vec::new();
        memory.reserve(&mut selected, references.len())?;
        for value in references {
            meter.work(1, path, None)?;
            let Some(text) = native::string(&document.nodes()[*value]) else {
                return Err(invalid(
                    memory,
                    "package.dependencies",
                    format_args!("each dependency must be a string"),
                ));
            };
            let reference = Reference::parse(text, memory)?;
            let selection = Selection {
                packages: &packages,
                order: &order,
                from: index,
                meter,
                path,
            };
            let target = reference.select(&selection, text, memory)?;
            reference.release(memory)?;
            memory.push(&mut selected, target)?;
        }
        try_sort_unstable_by(&mut selected, |left, right| {
            meter.work(1, path, None)?;
            Ok::<_, LoadError>(left.cmp(right))
        })?;
        for pair in selected.windows(2) {
            meter.work(1, path, None)?;
            if pair[0] == pair[1] {
                return Err(invalid(
                    memory,
                    "package.dependencies",
                    format_args!(
                        "{} {} repeats outgoing package row {}",
                        packages[index].name,
                        packages[index].version,
                        pair[0].index()
                    ),
                ));
            }
        }
        packages[index].dependencies = selected;
    }
    Ok((packages, order))
}

fn package_rows<'a, S: Admission + ?Sized>(
    document: &'a Document<'_>,
    memory: &mut Memory<'_, S>,
    meter: &Meter,
    path: &RelPath,
) -> Result<&'a [usize], BuildError> {
    let root = &document.nodes()[0];
    keys(
        document,
        root,
        &["version", "package"],
        "lock",
        memory,
        meter,
        path,
    )?;
    if !get(document, root, "version")
        .is_some_and(|node| matches!(node.kind, Kind::Scalar(Scalar::Integer(3 | 4))))
    {
        return Err(invalid(
            memory,
            "version",
            format_args!("supported lock profile versions are 3 and 4"),
        ));
    }
    match get(document, root, "package") {
        None => Ok(&[]),
        Some(Node {
            kind: Kind::Array | Kind::ArrayOfTables,
            children: rows,
            ..
        }) => Ok(rows.as_slice()),
        Some(_) => Err(invalid(
            memory,
            "package",
            format_args!("must be an array of package tables"),
        )),
    }
}

fn package_order<S: Admission + ?Sized>(
    packages: &[LockedPackage],
    memory: &mut Memory<'_, S>,
    meter: &Meter,
    path: &RelPath,
) -> Result<Vec<LockedPackageId>, BuildError> {
    let mut order = Vec::new();
    memory.reserve(&mut order, packages.len())?;
    for index in 0..packages.len() {
        memory.push(&mut order, LockedPackageId(index))?;
    }
    try_sort_unstable_by(&mut order, |left, right| {
        meter.work(1, path, None)?;
        Ok::<_, LoadError>(
            packages[left.index()]
                .key()
                .cmp(&packages[right.index()].key()),
        )
    })?;
    for pair in order.windows(2) {
        meter.work(1, path, None)?;
        let first = &packages[pair[0].index()];
        let second = &packages[pair[1].index()];
        if first.key() == second.key() {
            return Err(invalid(
                memory,
                "package",
                format_args!(
                    "duplicate complete package identity for {} {}; rows {} and {}",
                    first.name,
                    first.version,
                    first.id.index(),
                    second.id.index()
                ),
            ));
        }
    }
    Ok(order)
}

fn table<'a, S: Admission + ?Sized>(
    value: &'a Node,
    memory: &mut Memory<'_, S>,
) -> Result<&'a Node, BuildError> {
    native::table(value).ok_or_else(|| {
        invalid(
            memory,
            "package",
            format_args!("each package must be a table"),
        )
    })
}

fn keys<S: Admission + ?Sized>(
    document: &Document<'_>,
    table: &Node,
    allowed: &[&str],
    field: &'static str,
    memory: &mut Memory<'_, S>,
    meter: &Meter,
    path: &RelPath,
) -> Result<(), BuildError> {
    for (key, _) in native::entries(document, table) {
        meter.work(1, path, None)?;
        if !allowed.contains(&key) {
            return Err(invalid(
                memory,
                field,
                format_args!(
                    "unsupported field {key:?}; replacements and other lock profiles require explicit support"
                ),
            ));
        }
    }
    Ok(())
}

fn string<'a, S: Admission + ?Sized>(
    document: &'a Document<'_>,
    table: &Node,
    key: &'static str,
    memory: &mut Memory<'_, S>,
) -> Result<&'a str, BuildError> {
    get(document, table, key)
        .and_then(native::string)
        .filter(|text| !text.is_empty())
        .ok_or_else(|| invalid(memory, key, format_args!("a nonempty string is required")))
}

fn package<S: Admission + ?Sized>(
    document: &Document<'_>,
    row: &Node,
    id: LockedPackageId,
    memory: &mut Memory<'_, S>,
) -> Result<LockedPackage, BuildError> {
    let raw_name = string(document, row, "name", memory)?;
    let name = memory.string(raw_name)?;
    let raw_version = string(document, row, "version", memory)?;
    let version = crate::cargo_version::Version::parse(raw_version).map_err(|error| {
        invalid(
            memory,
            "version",
            format_args!("invalid package version: {error}"),
        )
    })?;
    let version = memory.format(&format_args!("{version}"))?;
    let source = get(document, row, "source")
        .map(|value| {
            let text = native::string(value)
                .ok_or_else(|| invalid(memory, "source", format_args!("must be a string")))?;
            LockedSource::parse(text, memory)
        })
        .transpose()?;
    if source
        .as_ref()
        .is_some_and(|source| source.kind() == LockedSourceKind::Git && source.revision().is_none())
    {
        return Err(invalid(
            memory,
            "source",
            format_args!("a Git package must record its full selected revision"),
        ));
    }
    let checksum = get(document, row, "checksum")
        .map(|value| {
            native::string(value)
                .and_then(hex::decode_32)
                .ok_or_else(|| {
                    invalid(
                        memory,
                        "checksum",
                        format_args!("must be exactly 64 ASCII hexadecimal digits"),
                    )
                })
        })
        .transpose()?;
    Ok(LockedPackage {
        id,
        name,
        version,
        source,
        checksum,
        dependencies: Vec::new(),
    })
}

fn dependencies<'a, S: Admission + ?Sized>(
    document: &'a Document<'_>,
    row: &Node,
    memory: &mut Memory<'_, S>,
) -> Result<&'a [usize], BuildError> {
    let values = match get(document, row, "dependencies") {
        None => &[][..],
        Some(Node {
            kind: Kind::Array | Kind::ArrayOfTables,
            children: values,
            ..
        }) => values.as_slice(),
        Some(_) => {
            return Err(invalid(
                memory,
                "package.dependencies",
                format_args!("must be an array of dependency strings"),
            ));
        }
    };
    Ok(values)
}

struct Reference<'a> {
    name: &'a str,
    version: Option<String>,
    source: Option<LockedSource>,
}

struct Selection<'a> {
    packages: &'a [LockedPackage],
    order: &'a [LockedPackageId],
    from: usize,
    meter: &'a Meter,
    path: &'a RelPath,
}

impl<'a> Reference<'a> {
    fn parse<S: Admission + ?Sized>(
        text: &'a str,
        memory: &mut Memory<'_, S>,
    ) -> Result<Self, BuildError> {
        let (head, source) = match text.split_once(" (") {
            Some((head, suffix)) => {
                let source = suffix.strip_suffix(')').ok_or_else(|| {
                    invalid(
                        memory,
                        "package.dependencies",
                        format_args!("source qualification must end in ')'"),
                    )
                })?;
                (head, Some(LockedSource::parse(source, memory)?))
            }
            None => (text, None),
        };
        let mut words = head.split_ascii_whitespace();
        let name = words.next().ok_or_else(|| {
            invalid(
                memory,
                "package.dependencies",
                format_args!("dependency name is required"),
            )
        })?;
        let version = words
            .next()
            .map(|text| {
                let version = crate::cargo_version::Version::parse(text).map_err(|error| {
                    invalid(
                        memory,
                        "package.dependencies",
                        format_args!("invalid dependency version: {error}"),
                    )
                })?;
                Ok::<_, BuildError>(memory.format(&format_args!("{version}"))?)
            })
            .transpose()?;
        if words.next().is_some() {
            return Err(invalid(
                memory,
                "package.dependencies",
                format_args!("expected name, optional version and optional source qualification"),
            ));
        }
        Ok(Self {
            name,
            version,
            source,
        })
    }

    fn select<S: Admission + ?Sized>(
        &self,
        selection: &Selection<'_>,
        text: &str,
        memory: &mut Memory<'_, S>,
    ) -> Result<LockedPackageId, BuildError> {
        let Selection {
            packages,
            order,
            from,
            meter,
            path,
        } = *selection;
        let range = try_equal_range_by(order, |id| {
            meter.work(1, path, None)?;
            Ok::<_, LoadError>(packages[id.index()].name.as_str().cmp(self.name))
        })?;
        let mut selected = None;
        for id in &order[range] {
            meter.work(1, path, None)?;
            let package = &packages[id.index()];
            if self
                .version
                .as_ref()
                .is_some_and(|version| *version != package.version)
                || self
                    .source
                    .as_ref()
                    .is_some_and(|source| Some(source) != package.source.as_ref())
            {
                continue;
            }
            if selected.is_some() {
                return Err(invalid(
                    memory,
                    "package.dependencies",
                    format_args!(
                        "{} {}: reference {text:?} is ambiguous; qualify its complete version and source",
                        packages[from].name, packages[from].version
                    ),
                ));
            }
            selected = Some(*id);
        }
        selected.ok_or_else(|| invalid(memory, "package.dependencies", format_args!("{} {}: reference {text:?} selects no complete locked package; regenerate the lock from its declarations", packages[from].name, packages[from].version)))
    }

    fn release<S: Admission + ?Sized>(self, memory: &mut Memory<'_, S>) -> Result<(), BuildError> {
        if let Some(version) = self.version {
            memory.release_string(version)?;
        }
        if let Some(source) = self.source {
            source.release(memory)?;
        }
        Ok(())
    }
}