endpoint-validator 0.1.0

Interactive test harness for endpoint-libs WebSocket RPC services: reads the endpoint description generated by endpoint-gen and exercises every endpoint with preset parameters.
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

//! Types for reading `services.json`, the machine-readable endpoint description
//! written by `endpoint-gen`.
//!
//! The schema types are **not** redefined here. They are re-exported from
//! [`endpoint_libs::model`], which is where `endpoint-gen` gets them from when it
//! writes the file. This crate previously kept hand-copied duplicates, which
//! silently rotted: `EnumVariant.comment` was renamed to `description` upstream
//! and the copy here never followed, so every current `services.json` failed to
//! parse with `missing field 'comment'`. The vendored `Type` had also drifted
//! badly — it still listed `Date`, `Int`, `BigInt`, `Numeric`, `Inet` and
//! `DataTable`, none of which exist upstream, and was missing `UInt32`, `Int32`,
//! `Int64`, `Float64`, `NanoId`, `IpAddr` and `StructTable`.
//!
//! Anything describing the wire schema belongs upstream. Only this tool's own
//! config types are defined here.

use std::collections::HashMap;

use serde::Deserialize;

pub use endpoint_libs::model::{EndpointSchema, EnumVariant, Field, Service, Type};

/// The whole of `services.json`.
///
/// `enums` and `structs` deserialize as bare [`Type`]s because that is literally
/// what they are: serde's external tagging renders `Type::Enum` as
/// `{"Enum": {...}}` and `Type::Struct` as `{"Struct": {...}}`, exactly as the
/// file contains them.
///
/// Note the file holds only `frontend_facing` endpoints — `endpoint-gen`'s
/// deliberate choice, so this tool sees the public surface and nothing else.
#[derive(Debug, Deserialize)]
pub struct Services {
    #[serde(default)]
    pub enums: Vec<Type>,
    pub services: Vec<Service>,
    #[serde(default)]
    pub structs: Vec<Type>,
}

/// One endpoint, flattened into what the driver needs to issue a call.
#[derive(Debug, Clone)]
pub struct EndpointMetadata {
    pub service_name: String,
    pub method_id: u32,
    pub params: Vec<ParameterMetadata>,
    pub is_stream: bool,
}

#[derive(Debug, Clone)]
pub struct ParameterMetadata {
    pub name: String,
    pub ty: Type,
}

/// `config.toml` — preset parameter values, keyed by endpoint.
#[derive(Debug, Deserialize)]
pub struct Config {
    #[serde(flatten)]
    pub endpoints: HashMap<String, EndpointData>,
}

#[derive(Debug, Deserialize)]
pub struct EndpointData {
    pub name: String,
    #[serde(default)]
    pub params: HashMap<String, ParamValue>,
}

#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum ParamValue {
    String(String),
    Number(i64),
    Bool(bool),
    Object(HashMap<String, ParamValue>),
    Array(Vec<ParamValue>),
}