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
use std::{fs::File, io::BufReader, path::Path, sync::OnceLock};
use serde_json::Value;
use snafu::Snafu;
use vector_config_common::{
attributes::CustomAttribute,
constants,
schema::{InstanceType, RootSchema, Schema, SchemaObject, SingleOrVec},
};
#[derive(Debug, Snafu)]
#[snafu(module, context(suffix(false)))]
pub enum QueryError {
#[snafu(display("I/O error during opening schema: {source}"), context(false))]
Io { source: std::io::Error },
#[snafu(display("deserialization failed: {source}"), context(false))]
Deserialization { source: serde_json::Error },
#[snafu(display("no schemas matched the query"))]
NoMatches,
#[snafu(display("multiple schemas matched the query ({len})"))]
MultipleMatches { len: usize },
#[snafu(display("found matching attribute but was not a flag"))]
AttributeNotFlag,
#[snafu(display(
"found matching attribute but expected single value; multiple values present"
))]
AttributeMultipleValues,
}
pub struct SchemaQuerier {
schema: RootSchema,
}
impl SchemaQuerier {
/// Creates a `SchemaQuerier` based on the schema file located at `schema_path`.
///
/// # Errors
///
/// If no file exists at the given schema path, or there is an I/O error during loading the file
/// (permissions, etc), then an error variant will be returned.
///
/// If the file does not contain valid JSON, or cannot be deserialized as a schema, then an
/// error variant will be returned.
pub fn from_schema<P: AsRef<Path>>(schema_path: P) -> Result<Self, QueryError> {
let reader = File::open(schema_path).map(BufReader::new)?;
let schema = serde_json::from_reader(reader)?;
Ok(Self { schema })
}
pub fn query(&self) -> SchemaQueryBuilder<'_> {
SchemaQueryBuilder::from_schema(&self.schema)
}
}
/// A query builder for querying against a root schema.
///
/// All constraints are applied in a boolean AND fashion.
pub struct SchemaQueryBuilder<'a> {
schema: &'a RootSchema,
attributes: Vec<CustomAttribute>,
}
impl<'a> SchemaQueryBuilder<'a> {
fn from_schema(schema: &'a RootSchema) -> Self {
Self {
schema,
attributes: Vec::new(),
}
}
/// Adds a constraint on the given custom attribute key/value.
///
/// Can be used multiple times to match schemas against multiple attributes.
///
/// Custom attributes are strongly matched: a flag attribute can only match a flag attribute,
/// not a key/value attribute, and vice versa. For key/value attributes where the attribute in
/// the schema itself has multiple values, the schema is considered a match so long as it
/// contains the value specified in the query.
pub fn with_custom_attribute_kv<K, V>(mut self, key: K, value: V) -> Self
where
K: Into<String>,
V: Into<Value>,
{
self.attributes.push(CustomAttribute::KeyValue {
key: key.into(),
value: value.into(),
});
self
}
/// Executes the query, returning all matching schemas.
pub fn run(self) -> Vec<SimpleSchema<'a>> {
let mut matches = Vec::new();
// Search through all defined schemas.
'schema: for schema_definition in self.schema.definitions.values() {
match schema_definition {
// We don't match against boolean schemas because there's nothing to match against.
Schema::Bool(_) => continue,
Schema::Object(schema_object) => {
// If we have custom attribute matches defined, but the schema has no metadata,
// it's not possible for it to match, so just bail out early.
let has_attribute_matchers = !self.attributes.is_empty();
let schema_metadata = schema_object.extensions.get(constants::METADATA);
if has_attribute_matchers && schema_metadata.is_none() {
continue 'schema;
}
if let Some(Value::Object(schema_attributes)) = schema_metadata {
for self_attribute in &self.attributes {
let attr_matched = match self_attribute {
CustomAttribute::Flag(key) => schema_attributes
.get(key)
.map_or(false, |value| matches!(value, Value::Bool(true))),
CustomAttribute::KeyValue {
key,
value: attr_value,
} => {
schema_attributes
.get(key)
.map_or(false, |value| match value {
// Check string values directly.
Value::String(schema_attr_value) => {
schema_attr_value == attr_value
}
// For arrays, try and convert each item to a string, and
// for the values that are strings, see if they match.
Value::Array(schema_attr_values) => {
schema_attr_values.iter().any(|value| {
value
.as_str()
.map_or(false, |s| s == attr_value)
})
}
_ => false,
})
}
};
if !attr_matched {
continue 'schema;
}
}
}
matches.push(schema_object.into());
}
}
}
matches
}
/// Executes the query, returning a single matching schema.
///
/// # Errors
///
/// If no schemas match, or more than one schema matches, then an error variant will be
/// returned.
pub fn run_single(self) -> Result<SimpleSchema<'a>, QueryError> {
let mut matches = self.run();
match matches.len() {
0 => Err(QueryError::NoMatches),
1 => Ok(matches.remove(0)),
len => Err(QueryError::MultipleMatches { len }),
}
}
}
pub enum OneOrMany<T> {
One(T),
Many(Vec<T>),
}
pub enum SchemaType<'a> {
/// A set of subschemas in which all must match.
///
/// Referred to as an `allOf` schema in JSON Schema.
///
/// For a given input, the input is only valid if it is valid against all specified subschemas.
AllOf(Vec<SimpleSchema<'a>>),
/// A set of subschemas in which only one must match.
///
/// Referred to as a `oneOf` schema in JSON Schema.
///
/// For a given input, the input is only valid if it is valid against exactly one of the
/// specified subschemas.
OneOf(Vec<SimpleSchema<'a>>),
/// A set of subschemas in which at least one must match.
///
/// Referred to as a `anyOf` schema in JSON Schema.
///
/// For a given input, the input is only valid if it is valid against at least one of the
/// specified subschemas.
AnyOf(Vec<SimpleSchema<'a>>),
/// A schema that matches a well-known, constant value.
///
/// Referred to by the `const` field in JSON Schema.
///
/// For a given input, the input is only valid if it matches the value specified by `const`
/// exactly. The value can be any valid JSON value.
Constant(&'a Value),
/// A schema that matches one of many well-known, constant values.
///
/// Referred to by the `enum` field in JSON Schema.
///
/// For a given input, the input is only valid if it matches one of the values specified by
/// `enum` exactly. The values can be any valid JSON value.
Enum(&'a Vec<Value>),
/// A typed schema that matches a JSON data type.
///
/// Referred to by the `type` field in JSON Schema.
///
/// For a given input, the input is only valid if it is the same type as one of the types
/// specified by `type`. A schema can allow multiple data types.
Typed(OneOrMany<InstanceType>),
}
pub trait QueryableSchema {
fn schema_type(&self) -> SchemaType;
fn description(&self) -> Option<&str>;
fn title(&self) -> Option<&str>;
fn get_attributes(&self, key: &str) -> Option<OneOrMany<CustomAttribute>>;
fn get_attribute(&self, key: &str) -> Result<Option<CustomAttribute>, QueryError>;
fn has_flag_attribute(&self, key: &str) -> Result<bool, QueryError>;
}
impl<'a, T> QueryableSchema for &'a T
where
T: QueryableSchema,
{
fn schema_type(&self) -> SchemaType {
(*self).schema_type()
}
fn description(&self) -> Option<&str> {
(*self).description()
}
fn title(&self) -> Option<&str> {
(*self).title()
}
fn get_attributes(&self, key: &str) -> Option<OneOrMany<CustomAttribute>> {
(*self).get_attributes(key)
}
fn get_attribute(&self, key: &str) -> Result<Option<CustomAttribute>, QueryError> {
(*self).get_attribute(key)
}
fn has_flag_attribute(&self, key: &str) -> Result<bool, QueryError> {
(*self).has_flag_attribute(key)
}
}
impl<'a> QueryableSchema for &'a SchemaObject {
fn schema_type(&self) -> SchemaType {
// TODO: Technically speaking, it is allowed to use the "X of" schema types in conjunction
// with other schema types i.e. `allOf` in conjunction with specifying a `type`.
//
// Right now, the configuration schema codegen should not actually be emitting anything like
// this, so our logic below is written against what we generate, not against what is
// technically possible. This _may_ need to change in the future if we end up using any "X
// of" schema composition mechanisms for richer validation (i.e. sticking special validation
// logic in various subschemas under `allOf`, while defining the main data schema via
// `type`, etc.)
if let Some(subschemas) = self.subschemas.as_ref() {
// Of all the possible "subschema" validation mechanism, we only support `allOf` and
// `oneOf`, based on what the configuration schema codegen will spit out.
if let Some(all_of) = subschemas.all_of.as_ref() {
return SchemaType::AllOf(all_of.iter().map(schema_to_simple_schema).collect());
} else if let Some(one_of) = subschemas.one_of.as_ref() {
return SchemaType::OneOf(one_of.iter().map(schema_to_simple_schema).collect());
} else if let Some(any_of) = subschemas.any_of.as_ref() {
return SchemaType::AnyOf(any_of.iter().map(schema_to_simple_schema).collect());
} else {
panic!("Encountered schema with subschema validation that wasn't one of the supported types: allOf, oneOf, anyOf.");
}
}
if let Some(instance_types) = self.instance_type.as_ref() {
return match instance_types {
SingleOrVec::Single(single) => SchemaType::Typed(OneOrMany::One(*single.clone())),
SingleOrVec::Vec(many) => SchemaType::Typed(OneOrMany::Many(many.clone())),
};
}
if let Some(const_value) = self.const_value.as_ref() {
return SchemaType::Constant(const_value);
}
if let Some(enum_values) = self.enum_values.as_ref() {
return SchemaType::Enum(enum_values);
}
panic!("Schema type was not able to be detected!");
}
fn description(&self) -> Option<&str> {
self.metadata
.as_ref()
.and_then(|metadata| metadata.description.as_deref())
}
fn title(&self) -> Option<&str> {
self.metadata
.as_ref()
.and_then(|metadata| metadata.title.as_deref())
}
fn get_attributes(&self, key: &str) -> Option<OneOrMany<CustomAttribute>> {
self.extensions.get(constants::METADATA)
.map(|metadata| match metadata {
Value::Object(attributes) => attributes,
_ => panic!("Found metadata extension in schema that was not of type 'object'."),
})
.and_then(|attributes| attributes.get(key))
.map(|attribute| match attribute {
Value::Bool(b) => match b {
true => OneOrMany::One(CustomAttribute::flag(key)),
false => panic!("Custom attribute flags should never be false."),
},
Value::String(s) => OneOrMany::One(CustomAttribute::kv(key, s)),
Value::Array(values) => {
let mapped = values.iter()
.map(|value| if let Value::String(s) = value {
CustomAttribute::kv(key, s)
} else {
panic!("Custom attribute key/value pair had array of values with a non-string value.")
})
.collect();
OneOrMany::Many(mapped)
},
_ => panic!("Custom attribute had unexpected non-flag/non-KV value."),
})
}
fn get_attribute(&self, key: &str) -> Result<Option<CustomAttribute>, QueryError> {
self.get_attributes(key)
.map(|attrs| match attrs {
OneOrMany::One(attr) => Ok(attr),
OneOrMany::Many(_) => Err(QueryError::AttributeMultipleValues),
})
.transpose()
}
fn has_flag_attribute(&self, key: &str) -> Result<bool, QueryError> {
self.get_attribute(key)
.and_then(|maybe_attr| match maybe_attr {
None => Ok(false),
Some(attr) => {
if attr.is_flag() {
Ok(true)
} else {
Err(QueryError::AttributeNotFlag)
}
}
})
}
}
pub struct SimpleSchema<'a> {
schema: &'a SchemaObject,
}
impl<'a> SimpleSchema<'a> {
pub fn into_inner(self) -> &'a SchemaObject {
self.schema
}
}
impl<'a> From<&'a SchemaObject> for SimpleSchema<'a> {
fn from(schema: &'a SchemaObject) -> Self {
Self { schema }
}
}
impl<'a> QueryableSchema for SimpleSchema<'a> {
fn schema_type(&self) -> SchemaType {
self.schema.schema_type()
}
fn description(&self) -> Option<&str> {
self.schema.description()
}
fn title(&self) -> Option<&str> {
self.schema.title()
}
fn get_attributes(&self, key: &str) -> Option<OneOrMany<CustomAttribute>> {
self.schema.get_attributes(key)
}
fn get_attribute(&self, key: &str) -> Result<Option<CustomAttribute>, QueryError> {
self.schema.get_attribute(key)
}
fn has_flag_attribute(&self, key: &str) -> Result<bool, QueryError> {
self.schema.has_flag_attribute(key)
}
}
fn schema_to_simple_schema(schema: &Schema) -> SimpleSchema<'_> {
static TRUE_SCHEMA_OBJECT: OnceLock<SchemaObject> = OnceLock::new();
static FALSE_SCHEMA_OBJECT: OnceLock<SchemaObject> = OnceLock::new();
let schema_object = match schema {
Schema::Bool(bool) => {
if *bool {
TRUE_SCHEMA_OBJECT.get_or_init(|| Schema::Bool(true).into_object())
} else {
FALSE_SCHEMA_OBJECT.get_or_init(|| Schema::Bool(false).into_object())
}
}
Schema::Object(object) => object,
};
SimpleSchema {
schema: schema_object,
}
}