type-bridge-orm 1.5.8

Async ORM for TypeDB built on type-bridge-core-lib
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
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
//! Explicit runtime descriptor registry.

use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
use std::sync::{Arc, RwLock};

use sha2::{Digest, Sha256};
use type_bridge_core_lib::compiler::is_valid_typeql_label;

use crate::descriptor::{EntityDescriptor, RelationDescriptor, TypeDescriptor, TypeDescriptorRef};
use crate::error::{OrmError, Result};
use crate::match_request::ids::{DescriptorId, FieldId, RoleId, SchemaFingerprint};

/// Canonical descriptor/member identities from one registry snapshot.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescriptorIdentitySnapshot {
    /// Kind-qualified descriptor identity.
    pub descriptor_id: DescriptorId,
    /// Owner-qualified fields in canonical member-name order.
    pub fields: Vec<FieldId>,
    /// Owner-qualified roles in canonical role-name order.
    pub roles: Vec<RoleId>,
}

/// One root of a request-relevant descriptor closure.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescriptorFingerprintRoot {
    /// Descriptor referenced by the request.
    pub descriptor_id: DescriptorId,
    /// Whether registered subtypes of this target affect the request.
    pub include_subtypes: bool,
}

impl DescriptorFingerprintRoot {
    /// Create one request-relevant fingerprint root.
    pub fn new(descriptor_id: DescriptorId, include_subtypes: bool) -> Self {
        Self {
            descriptor_id,
            include_subtypes,
        }
    }
}

/// Thread-safe registry for runtime entity and relation descriptors.
///
/// The registry is intentionally standalone: it has no database, transaction,
/// manager, Python, or TypeScript dependency. Bindings normalize their metadata
/// into descriptors before registration.
#[derive(Debug, Default)]
pub struct DescriptorRegistry {
    descriptors: RwLock<HashMap<String, TypeDescriptorRef>>,
}

impl DescriptorRegistry {
    /// Create an empty registry.
    pub fn new() -> Self {
        Self::default()
    }

    /// Register an entity descriptor.
    ///
    /// Identical re-registration is idempotent and returns the canonical stored
    /// descriptor. Conflicting shapes or type-kind conflicts return typed ORM
    /// errors.
    pub fn register_entity(&self, descriptor: EntityDescriptor) -> Result<Arc<EntityDescriptor>> {
        validate_entity_descriptor(&descriptor)?;

        let mut descriptors = self.descriptors.write().map_err(lock_error)?;
        match descriptors.get(&descriptor.type_name) {
            Some(TypeDescriptorRef::Entity(existing)) if existing.as_ref() == &descriptor => {
                Ok(Arc::clone(existing))
            }
            Some(TypeDescriptorRef::Entity(_)) => Err(OrmError::DescriptorConflict {
                type_name: descriptor.type_name,
                message: "entity descriptor shape differs from registered descriptor".into(),
            }),
            Some(TypeDescriptorRef::Relation(_)) => Err(OrmError::DescriptorConflict {
                type_name: descriptor.type_name,
                message: "type name is already registered as a relation".into(),
            }),
            None => {
                let descriptor = Arc::new(descriptor);
                descriptors.insert(
                    descriptor.type_name.clone(),
                    TypeDescriptorRef::Entity(Arc::clone(&descriptor)),
                );
                Ok(descriptor)
            }
        }
    }

    /// Register a relation descriptor.
    ///
    /// Identical re-registration is idempotent and returns the canonical stored
    /// descriptor. Conflicting shapes or type-kind conflicts return typed ORM
    /// errors.
    pub fn register_relation(
        &self,
        descriptor: RelationDescriptor,
    ) -> Result<Arc<RelationDescriptor>> {
        validate_relation_descriptor(&descriptor)?;

        let mut descriptors = self.descriptors.write().map_err(lock_error)?;
        match descriptors.get(&descriptor.type_name) {
            Some(TypeDescriptorRef::Relation(existing)) if existing.as_ref() == &descriptor => {
                Ok(Arc::clone(existing))
            }
            Some(TypeDescriptorRef::Relation(_)) => Err(OrmError::DescriptorConflict {
                type_name: descriptor.type_name,
                message: "relation descriptor shape differs from registered descriptor".into(),
            }),
            Some(TypeDescriptorRef::Entity(_)) => Err(OrmError::DescriptorConflict {
                type_name: descriptor.type_name,
                message: "type name is already registered as an entity".into(),
            }),
            None => {
                let descriptor = Arc::new(descriptor);
                descriptors.insert(
                    descriptor.type_name.clone(),
                    TypeDescriptorRef::Relation(Arc::clone(&descriptor)),
                );
                Ok(descriptor)
            }
        }
    }

    /// Lookup an entity descriptor by TypeDB type name.
    pub fn entity(&self, type_name: &str) -> Result<Arc<EntityDescriptor>> {
        match self.get(type_name) {
            Some(TypeDescriptorRef::Entity(descriptor)) => Ok(descriptor),
            Some(TypeDescriptorRef::Relation(_)) => Err(OrmError::DescriptorConflict {
                type_name: type_name.to_string(),
                message: "requested entity but descriptor is a relation".into(),
            }),
            None => Err(OrmError::DescriptorNotFound(type_name.to_string())),
        }
    }

    /// Lookup a relation descriptor by TypeDB type name.
    pub fn relation(&self, type_name: &str) -> Result<Arc<RelationDescriptor>> {
        match self.get(type_name) {
            Some(TypeDescriptorRef::Relation(descriptor)) => Ok(descriptor),
            Some(TypeDescriptorRef::Entity(_)) => Err(OrmError::DescriptorConflict {
                type_name: type_name.to_string(),
                message: "requested relation but descriptor is an entity".into(),
            }),
            None => Err(OrmError::DescriptorNotFound(type_name.to_string())),
        }
    }

    /// Lookup any descriptor by TypeDB type name.
    pub fn get(&self, type_name: &str) -> Option<TypeDescriptorRef> {
        self.descriptors
            .read()
            .ok()
            .and_then(|descriptors| descriptors.get(type_name).cloned())
    }

    /// Return an owned snapshot of all registered descriptors.
    pub fn snapshot(&self) -> Vec<TypeDescriptor> {
        let mut descriptors: Vec<_> = self
            .descriptors
            .read()
            .map(|descriptors| {
                descriptors
                    .values()
                    .map(TypeDescriptorRef::to_owned_descriptor)
                    .collect()
            })
            .unwrap_or_default();
        descriptors.sort_by(|left, right| left.type_name().cmp(right.type_name()));
        descriptors
    }

    /// Return the deterministic kind-qualified identity for a registered type.
    pub fn descriptor_id(&self, type_name: &str) -> Option<DescriptorId> {
        self.get(type_name)
            .as_ref()
            .map(descriptor_id_for_reference)
    }

    /// Resolve one validated kind-qualified descriptor identity to its TypeDB name.
    ///
    /// Language result materializers use this after canonical result validation;
    /// they never parse the descriptor-ID spelling themselves.
    #[doc(hidden)]
    pub fn descriptor_type_name(&self, descriptor_id: &DescriptorId) -> Option<String> {
        self.descriptor_by_id(descriptor_id)
            .map(|descriptor| descriptor.type_name().to_owned())
    }

    /// Resolve an owner-qualified field identity by binding-facing field name
    /// or TypeDB attribute name.
    pub fn field_id(&self, owner: &DescriptorId, field_name: &str) -> Option<FieldId> {
        let descriptor = self.descriptor_by_id(owner)?;
        let attribute = match &descriptor {
            TypeDescriptorRef::Entity(descriptor) => descriptor.attribute(field_name),
            TypeDescriptorRef::Relation(descriptor) => descriptor.attribute(field_name),
        }?;
        Some(FieldId::new(owner.clone(), attribute.field_name.clone()))
    }

    /// Resolve an owner-qualified role identity from a relation descriptor.
    pub fn role_id(&self, owner: &DescriptorId, role_name: &str) -> Option<RoleId> {
        let TypeDescriptorRef::Relation(descriptor) = self.descriptor_by_id(owner)? else {
            return None;
        };
        let role = descriptor.role(role_name)?;
        Some(RoleId::new(owner.clone(), role.role_name.clone()))
    }

    /// Whether a field reference owned by `reference_owner` denotes the same
    /// effective field on `binding_owner`.
    ///
    /// A parent-owned reference is valid for a registered subtype only when the
    /// subtype's flattened descriptor still contains the identical ownership.
    /// This rejects unrelated same-label fields and child shadows while keeping
    /// inherited references nominally meaningful.
    pub(crate) fn field_reference_is_compatible(
        &self,
        binding_owner: &DescriptorId,
        reference_owner: &DescriptorId,
        field_name: &str,
    ) -> bool {
        if !self.is_same_or_subtype(binding_owner, reference_owner) {
            return false;
        }
        let Some(binding_descriptor) = self.descriptor_by_id(binding_owner) else {
            return false;
        };
        let Some(reference_descriptor) = self.descriptor_by_id(reference_owner) else {
            return false;
        };
        let binding_attribute = match &binding_descriptor {
            TypeDescriptorRef::Entity(descriptor) => descriptor.attribute(field_name),
            TypeDescriptorRef::Relation(descriptor) => descriptor.attribute(field_name),
        };
        let reference_attribute = match &reference_descriptor {
            TypeDescriptorRef::Entity(descriptor) => descriptor.attribute(field_name),
            TypeDescriptorRef::Relation(descriptor) => descriptor.attribute(field_name),
        };
        binding_attribute.is_some() && binding_attribute == reference_attribute
    }

    /// Whether a relation-role reference owned by `reference_owner` denotes
    /// the same effective role on `binding_owner`.
    pub(crate) fn role_reference_is_compatible(
        &self,
        binding_owner: &DescriptorId,
        reference_owner: &DescriptorId,
        role_name: &str,
    ) -> bool {
        if !self.is_same_or_subtype(binding_owner, reference_owner) {
            return false;
        }
        let Some(TypeDescriptorRef::Relation(binding_descriptor)) =
            self.descriptor_by_id(binding_owner)
        else {
            return false;
        };
        let Some(TypeDescriptorRef::Relation(reference_descriptor)) =
            self.descriptor_by_id(reference_owner)
        else {
            return false;
        };
        let binding_role = binding_descriptor.role(role_name);
        let reference_role = reference_descriptor.role(role_name);
        binding_role.is_some() && binding_role == reference_role
    }

    pub(crate) fn is_same_or_subtype(
        &self,
        actual: &DescriptorId,
        expected: &DescriptorId,
    ) -> bool {
        let Some(mut current) = self.descriptor_by_id(actual) else {
            return false;
        };
        let Some(expected_descriptor) = self.descriptor_by_id(expected) else {
            return false;
        };
        if !same_descriptor_kind(&current, &expected_descriptor) {
            return false;
        }

        let expected_name = expected_descriptor.type_name();
        let mut visited = BTreeSet::new();
        loop {
            if current.type_name() == expected_name {
                return true;
            }
            if !visited.insert(current.type_name().to_owned()) {
                return false;
            }
            let Some(parent) = descriptor_parent_ref(&current) else {
                return false;
            };
            let Some(parent_descriptor) = self.get(parent) else {
                return false;
            };
            if !same_descriptor_kind(&current, &parent_descriptor) {
                return false;
            }
            current = parent_descriptor;
        }
    }

    /// Return a deterministic descriptor/member identity snapshot.
    ///
    /// Registration order, hash-map iteration order, and allocation addresses
    /// cannot affect this result.
    pub fn identity_snapshot(&self) -> Result<Vec<DescriptorIdentitySnapshot>> {
        let descriptors = self.descriptors.read().map_err(lock_error)?;
        let mut snapshot: Vec<_> = descriptors
            .values()
            .map(|descriptor| {
                let descriptor_id = descriptor_id_for_reference(descriptor);
                let mut fields = descriptor_attributes(descriptor)
                    .iter()
                    .map(|attribute| {
                        FieldId::new(descriptor_id.clone(), attribute.field_name.clone())
                    })
                    .collect::<Vec<_>>();
                fields.sort();

                let mut roles = match descriptor {
                    TypeDescriptorRef::Entity(_) => Vec::new(),
                    TypeDescriptorRef::Relation(relation) => relation
                        .roles
                        .iter()
                        .map(|role| RoleId::new(descriptor_id.clone(), role.role_name.clone()))
                        .collect(),
                };
                roles.sort();

                DescriptorIdentitySnapshot {
                    descriptor_id,
                    fields,
                    roles,
                }
            })
            .collect();
        snapshot.sort_by(|left, right| left.descriptor_id.cmp(&right.descriptor_id));
        Ok(snapshot)
    }

    /// Fingerprint the complete registered descriptor snapshot.
    pub fn schema_fingerprint(&self) -> Result<SchemaFingerprint> {
        let descriptors = self.owned_snapshot()?;
        Ok(fingerprint_descriptors(descriptors.values()))
    }

    /// Fingerprint only the descriptor facts relevant to the supplied roots.
    ///
    /// Every root includes its registered ancestors. Roots marked
    /// `include_subtypes` also include their registered subtype closure. Role
    /// player types, their ancestors, and their registered subtypes are always
    /// included because those facts determine role-player compatibility.
    /// Fields and effective relation roles are encoded in each included
    /// descriptor. An unrelated registration therefore cannot stale this
    /// fingerprint.
    pub fn request_relevant_fingerprint(
        &self,
        roots: &[DescriptorFingerprintRoot],
    ) -> Result<SchemaFingerprint> {
        let descriptors = self.owned_snapshot()?;
        let mut included = BTreeSet::new();
        let mut subtype_closure = BTreeSet::new();

        for root in roots {
            let type_name = resolve_descriptor_id(&descriptors, &root.descriptor_id)?;
            included.insert(type_name.clone());
            if root.include_subtypes {
                subtype_closure.insert(type_name);
            }
        }

        loop {
            let mut changed = false;
            let current: Vec<_> = included.iter().cloned().collect();

            for type_name in current {
                let descriptor = descriptors
                    .get(&type_name)
                    .ok_or_else(|| OrmError::DescriptorNotFound(type_name.clone()))?;

                if let Some(parent_type) = descriptor_parent(descriptor) {
                    require_registered(&descriptors, parent_type)?;
                    changed |= included.insert(parent_type.to_string());
                }

                if let TypeDescriptor::Relation(relation) = descriptor {
                    for role in &relation.roles {
                        for player_type in &role.player_type_names {
                            require_registered(&descriptors, player_type)?;
                            changed |= included.insert(player_type.clone());
                            changed |= subtype_closure.insert(player_type.clone());
                        }
                    }
                }
            }

            let subtype_parents = subtype_closure.clone();
            for (type_name, descriptor) in &descriptors {
                if descriptor_parent(descriptor)
                    .is_some_and(|parent| subtype_parents.contains(parent))
                {
                    changed |= included.insert(type_name.clone());
                    changed |= subtype_closure.insert(type_name.clone());
                }
            }

            if !changed {
                break;
            }
        }

        Ok(fingerprint_descriptors(
            included
                .iter()
                .filter_map(|type_name| descriptors.get(type_name)),
        ))
    }

    fn descriptor_by_id(&self, descriptor_id: &DescriptorId) -> Option<TypeDescriptorRef> {
        self.descriptors.read().ok().and_then(|descriptors| {
            descriptors
                .values()
                .find(|descriptor| descriptor_id_for_reference(descriptor) == *descriptor_id)
                .cloned()
        })
    }

    fn owned_snapshot(&self) -> Result<BTreeMap<String, TypeDescriptor>> {
        let descriptors = self.descriptors.read().map_err(lock_error)?;
        Ok(descriptors
            .iter()
            .map(|(type_name, descriptor)| (type_name.clone(), descriptor.to_owned_descriptor()))
            .collect())
    }
}

fn descriptor_id_for_reference(descriptor: &TypeDescriptorRef) -> DescriptorId {
    match descriptor {
        TypeDescriptorRef::Entity(descriptor) => {
            DescriptorId::new(format!("entity:{}", descriptor.type_name))
        }
        TypeDescriptorRef::Relation(descriptor) => {
            DescriptorId::new(format!("relation:{}", descriptor.type_name))
        }
    }
}

fn descriptor_id_for_owned(descriptor: &TypeDescriptor) -> DescriptorId {
    match descriptor {
        TypeDescriptor::Entity(descriptor) => {
            DescriptorId::new(format!("entity:{}", descriptor.type_name))
        }
        TypeDescriptor::Relation(descriptor) => {
            DescriptorId::new(format!("relation:{}", descriptor.type_name))
        }
    }
}

fn descriptor_attributes(
    descriptor: &TypeDescriptorRef,
) -> &[crate::descriptor::OwnedAttributeDescriptor] {
    match descriptor {
        TypeDescriptorRef::Entity(descriptor) => &descriptor.owned_attributes,
        TypeDescriptorRef::Relation(descriptor) => &descriptor.owned_attributes,
    }
}

fn descriptor_parent_ref(descriptor: &TypeDescriptorRef) -> Option<&str> {
    match descriptor {
        TypeDescriptorRef::Entity(descriptor) => descriptor.parent_type.as_deref(),
        TypeDescriptorRef::Relation(descriptor) => descriptor.parent_type.as_deref(),
    }
}

fn same_descriptor_kind(left: &TypeDescriptorRef, right: &TypeDescriptorRef) -> bool {
    matches!(
        (left, right),
        (TypeDescriptorRef::Entity(_), TypeDescriptorRef::Entity(_))
            | (
                TypeDescriptorRef::Relation(_),
                TypeDescriptorRef::Relation(_)
            )
    )
}

fn descriptor_parent(descriptor: &TypeDescriptor) -> Option<&str> {
    match descriptor {
        TypeDescriptor::Entity(descriptor) => descriptor.parent_type.as_deref(),
        TypeDescriptor::Relation(descriptor) => descriptor.parent_type.as_deref(),
    }
}

fn resolve_descriptor_id(
    descriptors: &BTreeMap<String, TypeDescriptor>,
    descriptor_id: &DescriptorId,
) -> Result<String> {
    descriptors
        .iter()
        .find_map(|(type_name, descriptor)| {
            (descriptor_id_for_owned(descriptor) == *descriptor_id).then(|| type_name.clone())
        })
        .ok_or_else(|| OrmError::DescriptorNotFound(descriptor_id.as_str().to_string()))
}

fn require_registered(
    descriptors: &BTreeMap<String, TypeDescriptor>,
    type_name: &str,
) -> Result<()> {
    if descriptors.contains_key(type_name) {
        Ok(())
    } else {
        Err(OrmError::DescriptorNotFound(type_name.to_string()))
    }
}

fn fingerprint_descriptors<'a>(
    descriptors: impl IntoIterator<Item = &'a TypeDescriptor>,
) -> SchemaFingerprint {
    let mut descriptors: Vec<_> = descriptors.into_iter().collect();
    descriptors.sort_by_key(|descriptor| descriptor_id_for_owned(descriptor));

    let mut records = Vec::new();
    for descriptor in descriptors {
        append_descriptor_records(descriptor, &mut records);
    }
    records.sort();

    let payload = records.join("\n");
    let digest = Sha256::digest(payload.as_bytes());
    let digest = digest
        .iter()
        .map(|byte| format!("{byte:02x}"))
        .collect::<String>();
    SchemaFingerprint::new(format!("schema-sha256-v1:{digest}"))
}

fn append_descriptor_records(descriptor: &TypeDescriptor, records: &mut Vec<String>) {
    let descriptor_id = descriptor_id_for_owned(descriptor);
    let (kind, is_abstract, parent_type, attributes) = match descriptor {
        TypeDescriptor::Entity(descriptor) => (
            "entity",
            descriptor.is_abstract,
            descriptor.parent_type.as_deref(),
            descriptor.owned_attributes.as_slice(),
        ),
        TypeDescriptor::Relation(descriptor) => (
            "relation",
            descriptor.is_abstract,
            descriptor.parent_type.as_deref(),
            descriptor.owned_attributes.as_slice(),
        ),
    };
    records.push(canonical_record(&[
        "descriptor",
        descriptor_id.as_str(),
        kind,
        bool_text(is_abstract),
        parent_type.unwrap_or(""),
    ]));

    let mut attributes: Vec<_> = attributes.iter().collect();
    attributes.sort_by(|left, right| left.field_name.cmp(&right.field_name));
    for attribute in attributes {
        let mut annotations: Vec<_> = attribute
            .annotations
            .iter()
            .map(|annotation| {
                serde_json::to_string(annotation).expect("annotation serialization cannot fail")
            })
            .collect();
        annotations.sort();
        records.push(canonical_record(&[
            "field",
            descriptor_id.as_str(),
            &attribute.field_name,
            &attribute.attr_name,
            &serde_json::to_string(&attribute.value_type)
                .expect("value-type serialization cannot fail"),
            bool_text(attribute.is_optional),
            bool_text(attribute.is_ordered),
            &canonical_list(&annotations),
        ]));
    }

    if let TypeDescriptor::Relation(relation) = descriptor {
        let mut roles: Vec<_> = relation.roles.iter().collect();
        roles.sort_by(|left, right| left.role_name.cmp(&right.role_name));
        for role in roles {
            let mut player_types = role.player_type_names.clone();
            player_types.sort();
            records.push(canonical_record(&[
                "role",
                descriptor_id.as_str(),
                &role.role_name,
                &canonical_list(&player_types),
                &cardinality_text(role.cardinality),
                role.overrides.as_deref().unwrap_or(""),
                bool_text(role.is_abstract),
                bool_text(role.ordered),
                bool_text(role.distinct),
                &cardinality_text(role.plays_cardinality),
            ]));
        }
    }
}

fn canonical_record(parts: &[&str]) -> String {
    parts
        .iter()
        .map(|part| format!("{}:{part}", part.len()))
        .collect::<Vec<_>>()
        .join("|")
}

fn canonical_list(parts: &[String]) -> String {
    canonical_record(&parts.iter().map(String::as_str).collect::<Vec<_>>())
}

fn bool_text(value: bool) -> &'static str {
    if value { "true" } else { "false" }
}

fn cardinality_text(cardinality: Option<(u32, Option<u32>)>) -> String {
    match cardinality {
        None => "none".to_string(),
        Some((minimum, Some(maximum))) => format!("{minimum}..{maximum}"),
        Some((minimum, None)) => format!("{minimum}.."),
    }
}

fn validate_entity_descriptor(descriptor: &EntityDescriptor) -> Result<()> {
    validate_type_name(&descriptor.type_name)?;
    if let Some(parent_type) = &descriptor.parent_type {
        validate_type_name(parent_type)?;
    }
    validate_attributes(&descriptor.type_name, &descriptor.owned_attributes)
}

fn validate_relation_descriptor(descriptor: &RelationDescriptor) -> Result<()> {
    validate_type_name(&descriptor.type_name)?;
    if let Some(parent_type) = &descriptor.parent_type {
        validate_type_name(parent_type)?;
    }
    validate_attributes(&descriptor.type_name, &descriptor.owned_attributes)?;

    let mut role_names = HashSet::new();
    for role in &descriptor.roles {
        validate_typeql_label(&descriptor.type_name, "role name", &role.role_name)?;
        if !role_names.insert(role.role_name.as_str()) {
            return Err(OrmError::DescriptorValidation {
                type_name: descriptor.type_name.clone(),
                message: format!("duplicate role name '{}'", role.role_name),
            });
        }
        for player_type_name in &role.player_type_names {
            validate_type_name(player_type_name)?;
        }
        if let Some(overrides) = &role.overrides {
            validate_typeql_label(&descriptor.type_name, "overridden role name", overrides)?;
        }
    }

    Ok(())
}

fn validate_attributes(
    type_name: &str,
    attributes: &[crate::descriptor::OwnedAttributeDescriptor],
) -> Result<()> {
    let mut field_names = HashSet::new();
    let mut attr_names = HashSet::new();
    for attr in attributes {
        validate_non_empty(type_name, "field name", &attr.field_name)?;
        validate_typeql_label(type_name, "attribute name", &attr.attr_name)?;
        if !field_names.insert(attr.field_name.as_str()) {
            return Err(OrmError::DescriptorValidation {
                type_name: type_name.to_string(),
                message: format!("duplicate field name '{}'", attr.field_name),
            });
        }
        if !attr_names.insert(attr.attr_name.as_str()) {
            return Err(OrmError::DescriptorValidation {
                type_name: type_name.to_string(),
                message: format!("duplicate attribute name '{}'", attr.attr_name),
            });
        }
    }
    let collision = attributes
        .iter()
        .enumerate()
        .flat_map(|(field_index, field)| {
            attributes
                .iter()
                .enumerate()
                .filter(move |(attribute_index, attribute)| {
                    field_index != *attribute_index && field.field_name == attribute.attr_name
                })
                .map(move |(_, attribute)| {
                    (
                        field.field_name.as_str(),
                        field.attr_name.as_str(),
                        attribute.field_name.as_str(),
                    )
                })
        })
        .min();
    if let Some((name, field_attribute, conflicting_field)) = collision {
        return Err(OrmError::DescriptorValidation {
            type_name: type_name.to_string(),
            message: format!(
                "field name '{name}' (attribute '{field_attribute}') conflicts with attribute name '{name}' declared by field '{conflicting_field}'"
            ),
        });
    }
    Ok(())
}

fn validate_type_name(type_name: &str) -> Result<()> {
    validate_typeql_label(type_name, "type name", type_name)
}

fn validate_typeql_label(type_name: &str, label: &str, value: &str) -> Result<()> {
    if !is_valid_typeql_label(value) {
        return Err(OrmError::DescriptorValidation {
            type_name: type_name.to_string(),
            message: format!("{label} {value:?} is not a canonical TypeQL label"),
        });
    }
    Ok(())
}

fn validate_non_empty(type_name: &str, label: &str, value: &str) -> Result<()> {
    if value.trim().is_empty() {
        return Err(OrmError::DescriptorValidation {
            type_name: type_name.to_string(),
            message: format!("{label} cannot be empty"),
        });
    }
    Ok(())
}

fn lock_error<T>(_: std::sync::PoisonError<T>) -> OrmError {
    OrmError::DescriptorValidation {
        type_name: "<registry>".into(),
        message: "descriptor registry lock is poisoned".into(),
    }
}