pylon_core/schema/

mod.rs

//
// This source file is part of the Pylon open source project.
//
// Copyright (c) 2026 Jaldis B.V.
//
// Licensed under the MIT OR Apache-2.0 license (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://opensource.org/licenses/MIT
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// ── Deletion policies ──────────────────────────────────────────────────────────

#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum DeleteSide {
    Target,
    Source,
}

#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum DeleteAction {
    Allow,
    Restrict,
    DeferredRestrict,
    DeleteSource,
    DeleteTarget,
    DeleteTargetIfOrphan,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct OnDeletePolicy {
    pub side: DeleteSide,
    pub action: DeleteAction,
}

// ── Mutation rewrites ──────────────────────────────────────────────────────────

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct RewriteEntry {
    /// Bitmask: 1=Insert, 2=Update, 4=Delete (mirrors Python On IntFlag).
    pub on: u8,
    /// PyQL expression evaluated as the new value.
    pub handler: String,
}

// ── Post-commit signal registrations ───────────────────────────────────────────

/// One `on=` registration for a type from the Python-side signal registry —
/// just the operation bitmask, never the handler itself (the actual
/// callable stays Python-only and never crosses into this descriptor).
/// Combined across every handler registered for a type, this drives
/// whether the DDL emitter attaches a capture trigger to that type's table
/// at all (see `export::signal_trigger_infos`).
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct SignalEntry {
    /// Bitmask: 1=Insert, 2=Update, 4=Delete (mirrors Python On IntFlag,
    /// same convention as `RewriteEntry.on`).
    pub on: u8,
}

// ── Pointer descriptors ────────────────────────────────────────────────────────

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct PropertyDescriptor {
    pub name: String,
    /// PostgreSQL column type, e.g. `text`, `int8`, `uuid`. Always a plain
    /// base type — every read/write/cast/comparison site relies on that, so
    /// a registered custom scalar's own DOMAIN name lives in `column_type`
    /// instead, never here.
    pub pg_type: String,
    pub nullable: bool,
    /// SQL expression for the column DEFAULT clause.
    pub default_sql: Option<String>,
    /// PyQL expression to be compiled to SQL at DDL-emit time.
    /// Takes precedence over `default_sql` when both could be set (they won't be).
    pub default_pyql: Option<String>,
    pub description: Option<String>,
    /// Pre-compiled SQL CHECK expressions, e.g. `"price >= 0"`.
    pub check_constraints: Vec<String>,
    /// True when a UNIQUE constraint applies to this column alone.
    pub is_exclusive: bool,
    /// True when this column is the table primary key.
    pub is_pk: bool,
    /// True when the transpiler should reject PyQL updates targeting this pointer.
    pub is_readonly: bool,
    pub rewrites: Vec<RewriteEntry>,
    /// `Some` only for a structural `pylon.Tuple[...]`-typed property — its
    /// element shape, for decode-time `ShapeNode` building. A *nominal*
    /// `@pylon.named_tuple`-typed property instead carries its shape via the
    /// `__nt__:module::Name` `pg_type` marker + `NamedTupleDescriptor.members`.
    /// An `Array[Tuple[...]]` property carries its *element's* member shape
    /// here, with the array-ness left to `pg_type`'s own `[]` suffix.
    pub tuple_members: Option<Vec<TupleMemberDescriptor>>,
    /// `Some("\"schema\".\"Name\"")` only when this property's scalar type is
    /// a *registered* custom scalar (see `pylon.scalar(..., name=...)` /
    /// the `@pylon.scalar` decorator form) — the schema-qualified name of
    /// the PostgreSQL DOMAIN that scalar compiles to (see
    /// `export::emit_scalars`). Consulted only for the column's own DDL
    /// type (`CREATE TABLE` / `ADD COLUMN`); every other use of this
    /// property (casts, comparisons, wire decode) keeps using `pg_type`'s
    /// plain base type, so a domain-typed column still round-trips exactly
    /// like its base type — Postgres enforces the domain's CHECK on writes
    /// regardless of which type name the read/write path itself uses.
    pub column_type: Option<String>,
}

/// A property's `pg_type` with the `__nt__:module::Name` nominal-tuple
/// marker resolved to the type that column really has — `jsonb`, or
/// `jsonb[]` for an `Array[SomeNamedTuple]`, which stores one jsonb tuple
/// per element. Every other `pg_type` passes through untouched.
pub fn resolved_pg_type(pg_type: &str) -> &str {
    match pg_type.strip_prefix("__nt__:") {
        Some(marker) if marker.ends_with("[]") => "jsonb[]",
        Some(_) => "jsonb",
        None => pg_type,
    }
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct LinkDescriptor {
    pub name: String,
    /// Qualified name of the target type, e.g. `catalog::Category`.
    pub target: String,
    pub nullable: bool,
    pub description: Option<String>,
    pub default_pyql: Option<String>,
    /// True when a UNIQUE constraint applies to this FK column alone.
    pub is_exclusive: bool,
    /// True when the transpiler should reject PyQL updates targeting this pointer.
    pub is_readonly: bool,
    pub rewrites: Vec<RewriteEntry>,
    pub on_delete: Vec<OnDeletePolicy>,
    /// Qualified name of the explicit junction type, if any — when set, this
    /// link is backed by a junction table (source, target, plus the
    /// junction's own properties) instead of a `{name}_id` FK column on the
    /// source table, the same storage MultiLink's own `through` already
    /// uses, just constrained to at most one row per source.
    pub through: Option<String>,
}

impl LinkDescriptor {
    pub fn is_junction_backed(&self) -> bool {
        self.through.is_some()
    }
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct MultiLinkDescriptor {
    pub name: String,
    /// Qualified name of the target type.
    pub target: String,
    /// Qualified name of the explicit junction type, if any.
    pub through: Option<String>,
    pub nullable: bool,
    pub description: Option<String>,
    pub default_pyql: Option<String>,
    pub on_delete: Vec<OnDeletePolicy>,
    /// True when a target may be linked from at most one source, which makes
    /// the backlink single.
    #[serde(default)]
    pub is_exclusive: bool,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct ComputedDescriptor {
    pub name: String,
    /// PyQL expression evaluated at query time.
    pub expression: String,
    /// PostgreSQL return type, if known at schema-build time.
    pub return_type: Option<String>,
    /// The qualified object type a link-valued computed selects
    /// (`Computed[Link[Email], "…"]`) — `None` for a scalar computed, whose
    /// type is `return_type` instead. A consumer that has only the schema to
    /// go on (the schema browser, an editor) cannot tell the two apart
    /// otherwise: both carry a bare expression string.
    #[serde(default)]
    pub link_target: Option<String>,
    /// Whether that link-valued computed selects many.
    #[serde(default)]
    pub link_multi: bool,
}

// ── Type-level constructs ──────────────────────────────────────────────────────

// ── Search index ───────────────────────────────────────────────────────────────

#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum SearchBackend {
    Postgres,
    OpenSearch,
    Meilisearch,
}

#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum SearchWeight {
    A,
    B,
    C,
    D,
}

impl SearchWeight {
    pub fn as_str(&self) -> &'static str {
        match self {
            SearchWeight::A => "A",
            SearchWeight::B => "B",
            SearchWeight::C => "C",
            SearchWeight::D => "D",
        }
    }
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct SearchPointerDescriptor {
    pub name: String,
    pub weight: SearchWeight,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct SearchIndexDescriptor {
    pub index_name: Option<String>,
    pub backend: SearchBackend,
    pub pointers: Vec<SearchPointerDescriptor>,
}

impl SearchIndexDescriptor {
    pub fn column_name(&self) -> String {
        match &self.index_name {
            None => "__search__".to_string(),
            Some(name) => format!("__search_{}__", name),
        }
    }

    /// Deferred search index name: `"module__table[__name]"` in lowercase.
    pub fn deferred_index_name(&self, module: &str, type_name: &str) -> String {
        let base = format!("{}__{}", module, type_name).to_lowercase();
        match &self.index_name {
            None => base,
            Some(n) => format!("{}__{}", base, n.to_lowercase()),
        }
    }
}

/// How a partitioned type's ranges are sized.
///
/// Range partitioning on a time column only — the case declarative
/// partitioning actually pays off for, and the only one that has a sensible
/// automatic maintenance story (create the next few ranges, drop the ones
/// past retention). List and hash partitioning need a key set known up
/// front, which is a different feature, not a parameter of this one.
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum PartitionInterval {
    Daily,
    Weekly,
    Monthly,
    Yearly,
}

impl PartitionInterval {
    /// The PostgreSQL interval literal for one partition's width.
    pub fn as_pg_interval(self) -> &'static str {
        match self {
            PartitionInterval::Daily => "1 day",
            PartitionInterval::Weekly => "1 week",
            PartitionInterval::Monthly => "1 month",
            PartitionInterval::Yearly => "1 year",
        }
    }

    pub fn as_str(self) -> &'static str {
        match self {
            PartitionInterval::Daily => "daily",
            PartitionInterval::Weekly => "weekly",
            PartitionInterval::Monthly => "monthly",
            PartitionInterval::Yearly => "yearly",
        }
    }

    pub fn parse(s: &str) -> Option<Self> {
        match s {
            "daily" => Some(PartitionInterval::Daily),
            "weekly" => Some(PartitionInterval::Weekly),
            "monthly" => Some(PartitionInterval::Monthly),
            "yearly" => Some(PartitionInterval::Yearly),
            _ => None,
        }
    }
}

/// Declarative range partitioning for one type, maintained by pg_partman.
///
/// A type carries at most one of these: a table has exactly one partition
/// key, so a second declaration isn't a refinement, it's a contradiction.
/// See `validate_partitions`.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct PartitionDescriptor {
    /// The property partitioned on. Must be a non-nullable date/timestamp
    /// property of this type — PostgreSQL requires the partition key to be
    /// part of the primary key and to never be NULL.
    pub pointer: String,
    pub interval: PartitionInterval,
    /// How many future partitions to keep pre-created. A write landing in a
    /// range that doesn't exist yet fails, so this is the safety margin
    /// against maintenance falling behind.
    pub premake: u32,
    /// Drop partitions older than this many intervals. `None` keeps
    /// everything — the safe default, since the alternative silently deletes
    /// data on a schedule.
    pub retention: Option<u32>,
}

impl PartitionDescriptor {
    /// `retention` as a PostgreSQL interval literal, for `part_config`.
    pub fn retention_interval(&self) -> Option<String> {
        self.retention.map(|n| match self.interval {
            PartitionInterval::Daily => format!("{n} days"),
            PartitionInterval::Weekly => format!("{n} weeks"),
            PartitionInterval::Monthly => format!("{n} months"),
            PartitionInterval::Yearly => format!("{n} years"),
        })
    }
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct VectorIndexDescriptor {
    /// `None` = default (bare) index; `Some(name)` = named index.
    pub index_name: Option<String>,
    /// Source pointers whose text is concatenated to form the embedding input.
    pub pointers: Vec<String>,
    /// Embedding model identifier, e.g. `"mistral-embed"`.
    pub model: String,
    /// Distance metric: `"cosine"` | `"euclidean"` | `"inner_product"`.
    pub metric: String,
    /// Embedding dimension, e.g. `1024`.
    pub dimensions: u32,
}

impl VectorIndexDescriptor {
    /// PostgreSQL column name for this index's vector column.
    pub fn column_name(&self) -> String {
        match &self.index_name {
            None => "__vector__".to_string(),
            Some(name) => format!("__vector_{}__", name),
        }
    }

    /// pgvector operator class for the configured metric.
    pub fn ops_class(&self) -> &'static str {
        match self.metric.as_str() {
            "euclidean" => "vector_l2_ops",
            "inner_product" => "vector_ip_ops",
            _ => "vector_cosine_ops",
        }
    }
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct IndexDescriptor {
    /// Pointer names for a simple or composite index; empty when is_expression=true.
    pub pointers: Vec<String>,
    /// PyQL expression for an expression index.
    pub expression: Option<String>,
    pub unique: bool,
    /// PyQL partial-index predicate.
    pub unless: Option<String>,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct TriggerDescriptor {
    /// Bitmask: 1=Insert, 2=Update, 4=Delete.
    pub on: u8,
    /// "Before" | "After" | "InsteadOf"
    pub timing: String,
    pub handler: String,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub enum TypeConstraint {
    /// Composite UNIQUE INDEX across multiple pointers.
    Exclusive {
        pointers: Vec<String>,
        unless: Option<String>,
    },
    /// Arbitrary CHECK constraint expressed as a PyQL boolean expression.
    Expression { expr: String },
}

// ── Type descriptor ────────────────────────────────────────────────────────────

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct TypeDescriptor {
    /// Unqualified name, e.g. `Product`.
    pub name: String,
    /// Pylon module, e.g. `catalog`.
    pub module: String,
    /// PostgreSQL table (or view) name, e.g. `catalog_product`.
    pub table: String,
    /// True for `@pylon.abstract` / `@pylon.interface`.
    pub abstract_: bool,
    /// True when a PostgreSQL VIEW is emitted (always true for `@pylon.interface`).
    pub materialized: bool,
    pub description: Option<String>,
    /// Qualified names of abstract (non-materialized) parents.
    pub parents: Vec<String>,
    /// Qualified names of interface parents.
    pub interfaces: Vec<String>,
    /// Qualified names of the concrete types this one extends, nearest first
    /// (`BrandAddonBundle` extends `BrandAddon`). Each has a table of its own,
    /// and reading one of them reads this type's rows too.
    #[serde(default)]
    pub bases: Vec<String>,
    /// Flattened properties (includes inherited from abstract parents).
    pub properties: Vec<PropertyDescriptor>,
    /// Flattened links.
    pub links: Vec<LinkDescriptor>,
    /// Flattened multi-links.
    pub multilinks: Vec<MultiLinkDescriptor>,
    /// Computed (virtual) pointers.
    pub computed: Vec<ComputedDescriptor>,
    /// Composite UNIQUE and CHECK constraints (own + inherited from abstract parents).
    pub constraints: Vec<TypeConstraint>,
    /// Non-unique indexes (own + inherited from abstract parents).
    pub indexes: Vec<IndexDescriptor>,
    /// Declarative range partitioning, at most one per type. `None` for an
    /// ordinary table.
    #[serde(default)]
    pub partition: Option<PartitionDescriptor>,
    /// Vector (embedding) indexes.
    pub vector_indexes: Vec<VectorIndexDescriptor>,
    /// Full-text search indexes.
    pub search_indexes: Vec<SearchIndexDescriptor>,
    /// Triggers (own + inherited from abstract parents).
    pub triggers: Vec<TriggerDescriptor>,
    /// True for `@pylon.junction` — type is a junction table for a MultiLink.
    pub junction: bool,
    /// Post-commit signal registrations from the Python-side registry — one
    /// entry per distinct `on=` bitmask a handler was registered with (not
    /// one per handler). Empty unless at least one signal targets this
    /// type; drives whether a capture trigger gets attached at all.
    pub signals: Vec<SignalEntry>,
}

// ── Scalar / enum / global descriptors ────────────────────────────────────────

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct ScalarDescriptor {
    /// Qualified scalar name, e.g. `default::Email`.
    pub name: String,
    pub module: String,
    /// Pylon base scalar, e.g. `Str`, `Int64`.
    pub base: String,
    /// PostgreSQL base type, e.g. `text`, `int8`.
    pub pg_type: String,
    /// Pre-compiled SQL CHECK expressions for the DOMAIN constraint.
    pub check_constraints: Vec<String>,
    /// True when the scalar extends `pylon.Sequence` — generates a PostgreSQL SEQUENCE.
    pub is_sequence: bool,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct EnumDescriptor {
    pub name: String,
    pub module: String,
    pub members: Vec<String>,
}

/// One member's type within a named-tuple/tuple-shaped value — recursive so a
/// member can itself be a nested tuple. Drives decode-time shape building
/// (`ShapeNode`) so a jsonb-backed tuple value decodes with real per-member
/// types instead of an opaque dict/list.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub enum TupleMemberKind {
    Scalar {
        pg_type: String,
    },
    Enum {
        module: String,
        name: String,
    },
    /// A member typed as a registered `@pylon.named_tuple` class.
    NamedTuple {
        module: String,
        name: String,
    },
    /// A member typed as a nested structural `pylon.Tuple[...]`.
    Tuple {
        members: Vec<TupleMemberDescriptor>,
    },
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct TupleMemberDescriptor {
    /// `None` for an unnamed/positional element of a structural tuple.
    pub name: Option<String>,
    pub kind: TupleMemberKind,
}

/// A registered (nominal) `@pylon.named_tuple` type — used both for cast-target
/// resolution (`<module::Name>expr` → jsonb) and, via `members`, for decoding a
/// value read back from a column/cast of this type with real per-member types
/// instead of an opaque dict.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct NamedTupleDescriptor {
    pub name: String,
    pub module: String,
    pub members: Vec<TupleMemberDescriptor>,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct GlobalDescriptor {
    pub name: String,
    pub module: String,
    pub scalar_type: String,
    pub required: bool,
    pub default_expr: Option<String>,
    /// PyQL expression string for computed globals (e.g. `select User filter .id = global current_user_id`).
    /// When set, the global is computed from this expression at query time rather than injected as a parameter.
    pub computed_expr: Option<String>,
}

// ── Function descriptors ────────────────────────────────────────────────────────

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct FunctionParamDescriptor {
    pub name: String,
    /// PostgreSQL type string, e.g. `int8`, `text`, `uuid`.
    pub pg_type: String,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct FunctionDescriptor {
    pub name: String,
    pub module: String,
    pub params: Vec<FunctionParamDescriptor>,
    /// For scalar returns: the PG type (e.g. `int8`).
    /// For object returns: the qualified type name (e.g. `default::Account`).
    pub return_pg_type: String,
    pub return_is_object: bool,
    /// True when the return is `set[T]`.
    pub return_is_set: bool,
    /// True when the return type is a polymorphic interface (abstract + materialized).
    pub return_is_polymorphic: bool,
    /// "immutable" | "stable" | "volatile"
    pub volatility: String,
    /// PyQL expression string (the function body from the docstring).
    pub body: String,
}

// ── Alias descriptor ───────────────────────────────────────────────────────────

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct AliasDescriptor {
    pub name: String,
    pub module: String,
    /// PyQL expression string (the alias body).
    pub expr: String,
}

// ── Channel descriptor ──────────────────────────────────────────────────────────

/// The shape of a `Channel`'s payload, as declared in the schema DSL.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub enum ChannelPayload {
    /// A registered object type, by its qualified name (e.g. `default::User`) —
    /// `notify()` sends the object, `listen()` decodes into that type.
    Type(String),
    /// A plain scalar's Postgres type (e.g. `text`, `int8`).
    Scalar(String),
    /// An ad hoc named-field payload (`pylon.Object(...)`) — field name to
    /// scalar Postgres type, in declaration order. No backing table; decodes
    /// client-side into a `pylon.Object` instance.
    Object(Vec<(String, String)>),
}

/// A PostgreSQL pub/sub channel (`NOTIFY`/`LISTEN`) declared in the schema.
/// Has zero physical DDL footprint — nothing here ever produces a DDL step
/// in `diff_schema_steps`; its mere presence in a schema is exactly the kind
/// of content-only change `schema_content_changed` exists to catch.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct ChannelDescriptor {
    pub name: String,
    pub module: String,
    /// The actual PostgreSQL NOTIFY/LISTEN channel identifier. Unlike every
    /// other named construct in this descriptor, Postgres channels have no
    /// schema namespacing at all — a flat, database-wide identifier — so
    /// this is already fully disambiguated (module folded in) by the time
    /// it gets here; see `pylon.schema._channels.wire_name_for_channel`.
    pub wire_name: String,
    pub payload: ChannelPayload,
    pub description: Option<String>,
}

// ── Top-level schema ───────────────────────────────────────────────────────────

#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
pub struct SchemaDescriptor {
    pub types: Vec<TypeDescriptor>,
    pub scalars: Vec<ScalarDescriptor>,
    pub enums: Vec<EnumDescriptor>,
    pub named_tuples: Vec<NamedTupleDescriptor>,
    pub globals: Vec<GlobalDescriptor>,
    pub functions: Vec<FunctionDescriptor>,
    pub aliases: Vec<AliasDescriptor>,
    pub channels: Vec<ChannelDescriptor>,
    /// `ir::functions_needing_globals`, which compiles every function body
    /// and is asked for by every compile that calls one. Filled on first use,
    /// so a schema must not change once it has been compiled against.
    #[serde(skip)]
    pub functions_needing_globals: Derived<std::collections::HashSet<String>>,
}

/// A value computed from the schema on first use. A clone starts out empty,
/// so a copy that is then changed never reads the original's value.
#[derive(Debug)]
pub struct Derived<T>(std::sync::OnceLock<T>);

impl<T> Derived<T> {
    pub fn get_or_init(&self, init: impl FnOnce() -> T) -> &T {
        self.0.get_or_init(init)
    }
}

impl<T> Default for Derived<T> {
    fn default() -> Self {
        Derived(std::sync::OnceLock::new())
    }
}

impl<T> Clone for Derived<T> {
    fn clone(&self) -> Self {
        Derived::default()
    }
}

impl SchemaDescriptor {
    /// Find a declared `Channel` by bare or `module::name` reference — the
    /// single lookup both `notify()` (`ir::compiler::Compiler::resolve_channel`)
    /// and `pylon-client`'s `Client::listen()` resolve a channel argument
    /// through, so a schema author's `notify(Foo, ...)` and a client's
    /// `listen("Foo")` agree on exactly the same name.
    pub fn find_channel(&self, name: &str) -> Option<&ChannelDescriptor> {
        self.channels
            .iter()
            .find(|c| c.name == name || format!("{}::{}", c.module, c.name) == name)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn schema_with_one_channel() -> SchemaDescriptor {
        SchemaDescriptor {
            channels: vec![ChannelDescriptor {
                name: "Pings".into(),
                module: "shop".into(),
                wire_name: "shop__pings".into(),
                payload: ChannelPayload::Scalar("text".into()),
                description: None,
            }],
            ..Default::default()
        }
    }

    #[test]
    fn find_channel_matches_bare_name() {
        let schema = schema_with_one_channel();
        assert_eq!(
            schema.find_channel("Pings").map(|c| c.wire_name.as_str()),
            Some("shop__pings")
        );
    }

    #[test]
    fn find_channel_matches_qualified_name() {
        let schema = schema_with_one_channel();
        assert_eq!(
            schema.find_channel("shop::Pings").map(|c| c.wire_name.as_str()),
            Some("shop__pings")
        );
    }

    #[test]
    fn find_channel_returns_none_for_unknown_name() {
        let schema = schema_with_one_channel();
        assert!(schema.find_channel("NoSuchChannel").is_none());
    }
}