VienDesu/schemars
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use oneOf for enums when possible (#108)

Browse source
This commit is contained in:
Adam Leventhal 2021-09-26 10:02:44 -07:00 • committed by GitHub
parent dec8bcc3b7
commit 0a1200baac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 302 additions and 276 deletions
Download patch file Download diff file Expand all files Collapse all files

10
schemars/tests/expected/deprecated-enum.json
View file

@ -2,7 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DeprecatedEnum",
"deprecated": true,
"anyOf": [
"oneOf": [
{
"type": "string",
"enum": [
@ -24,13 +24,13 @@
"foo"
],
"properties": {
"foo": {
"type": "integer",
"format": "int32"
},
"deprecated_field": {
"deprecated": true,
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
}
}
}

2
schemars/tests/expected/doc_comments_enum.json
View file

@ -2,7 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "This is the enum's title",
"description": "This is the enum's description.",
"anyOf": [
"oneOf": [
{
"type": "string",
"enum": [

78
schemars/tests/expected/enum-adjacent-tagged-duf.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Adjacent",
"anyOf": [
"oneOf": [
{
"type": "object",
"required": [
@ -24,17 +24,17 @@
"t"
],
"properties": {
"t": {
"type": "string",
"enum": [
"StringMap"
]
},
"c": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"t": {
"type": "string",
"enum": [
"StringMap"
]
}
},
"additionalProperties": false
@ -46,14 +46,14 @@
"t"
],
"properties": {
"c": {
"$ref": "#/definitions/UnitStruct"
},
"t": {
"type": "string",
"enum": [
"UnitStructNewType"
]
},
"c": {
"$ref": "#/definitions/UnitStruct"
}
},
"additionalProperties": false
@ -65,14 +65,14 @@
"t"
],
"properties": {
"c": {
"$ref": "#/definitions/Struct"
},
"t": {
"type": "string",
"enum": [
"StructNewType"
]
},
"c": {
"$ref": "#/definitions/Struct"
}
},
"additionalProperties": false
@ -84,12 +84,6 @@
"t"
],
"properties": {
"t": {
"type": "string",
"enum": [
"Struct"
]
},
"c": {
"type": "object",
"required": [
@ -97,15 +91,21 @@
"foo"
],
"properties": {
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
},
"bar": {
"type": "boolean"
}
},
"additionalProperties": false
},
"t": {
"type": "string",
"enum": [
"Struct"
]
}
},
"additionalProperties": false
@ -117,12 +117,6 @@
"t"
],
"properties": {
"t": {
"type": "string",
"enum": [
"Tuple"
]
},
"c": {
"type": "array",
"items": [
@ -136,6 +130,12 @@
],
"maxItems": 2,
"minItems": 2
},
"t": {
"type": "string",
"enum": [
"Tuple"
]
}
},
"additionalProperties": false
@ -162,24 +162,21 @@
"t"
],
"properties": {
"c": {
"type": "integer",
"format": "int32"
},
"t": {
"type": "string",
"enum": [
"WithInt"
]
},
"c": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
],
"definitions": {
"UnitStruct": {
"type": "null"
},
"Struct": {
"type": "object",
"required": [
@ -187,14 +184,17 @@
"foo"
],
"properties": {
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
}
}
},
"bar": {
"type": "boolean"
}
}
"UnitStruct": {
"type": "null"
}
}
}

80
schemars/tests/expected/enum-adjacent-tagged.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Adjacent",
"anyOf": [
"oneOf": [
{
"type": "object",
"required": [
@ -23,17 +23,17 @@
"t"
],
"properties": {
"t": {
"type": "string",
"enum": [
"StringMap"
]
},
"c": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"t": {
"type": "string",
"enum": [
"StringMap"
]
}
}
},
@ -44,14 +44,14 @@
"t"
],
"properties": {
"c": {
"$ref": "#/definitions/UnitStruct"
},
"t": {
"type": "string",
"enum": [
"UnitStructNewType"
]
},
"c": {
"$ref": "#/definitions/UnitStruct"
}
}
},
@ -62,14 +62,14 @@
"t"
],
"properties": {
"c": {
"$ref": "#/definitions/Struct"
},
"t": {
"type": "string",
"enum": [
"StructNewType"
]
},
"c": {
"$ref": "#/definitions/Struct"
}
}
},
@ -80,12 +80,6 @@
"t"
],
"properties": {
"t": {
"type": "string",
"enum": [
"Struct"
]
},
"c": {
"type": "object",
"required": [
@ -93,14 +87,20 @@
"foo"
],
"properties": {
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
}
}
},
"bar": {
"type": "boolean"
}
}
"t": {
"type": "string",
"enum": [
"Struct"
]
}
}
},
@ -111,12 +111,6 @@
"t"
],
"properties": {
"t": {
"type": "string",
"enum": [
"Tuple"
]
},
"c": {
"type": "array",
"items": [
@ -130,6 +124,12 @@
],
"maxItems": 2,
"minItems": 2
},
"t": {
"type": "string",
"enum": [
"Tuple"
]
}
}
},
@ -154,23 +154,20 @@
"t"
],
"properties": {
"c": {
"type": "integer",
"format": "int32"
},
"t": {
"type": "string",
"enum": [
"WithInt"
]
},
"c": {
"type": "integer",
"format": "int32"
}
}
}
],
"definitions": {
"UnitStruct": {
"type": "null"
},
"Struct": {
"type": "object",
"required": [
@ -178,14 +175,17 @@
"foo"
],
"properties": {
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
}
}
},
"bar": {
"type": "boolean"
}
}
"UnitStruct": {
"type": "null"
}
}
}

22
schemars/tests/expected/enum-external-duf.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "External",
"anyOf": [
"oneOf": [
{
"type": "string",
"enum": [
@ -61,12 +61,12 @@
"foo"
],
"properties": {
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
},
"bar": {
"type": "boolean"
}
},
"additionalProperties": false
@ -112,9 +112,6 @@
}
],
"definitions": {
"UnitStruct": {
"type": "null"
},
"Struct": {
"type": "object",
"required": [
@ -122,14 +119,17 @@
"foo"
],
"properties": {
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
}
}
},
"bar": {
"type": "boolean"
}
}
"UnitStruct": {
"type": "null"
}
}
}

22
schemars/tests/expected/enum-external.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "External",
"anyOf": [
"oneOf": [
{
"type": "string",
"enum": [
@ -61,12 +61,12 @@
"foo"
],
"properties": {
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
},
"bar": {
"type": "boolean"
}
}
}
@ -111,9 +111,6 @@
}
],
"definitions": {
"UnitStruct": {
"type": "null"
},
"Struct": {
"type": "object",
"required": [
@ -121,14 +118,17 @@
"foo"
],
"properties": {
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
}
}
},
"bar": {
"type": "boolean"
}
}
"UnitStruct": {
"type": "null"
}
}
}

30
schemars/tests/expected/enum-internal-duf.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Internal",
"anyOf": [
"oneOf": [
{
"type": "object",
"required": [
@ -55,18 +55,18 @@
"typeProperty"
],
"properties": {
"typeProperty": {
"type": "string",
"enum": [
"StructNewType"
]
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
},
"bar": {
"type": "boolean"
"typeProperty": {
"type": "string",
"enum": [
"StructNewType"
]
}
}
},
@ -78,18 +78,18 @@
"typeProperty"
],
"properties": {
"typeProperty": {
"type": "string",
"enum": [
"Struct"
]
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
},
"bar": {
"type": "boolean"
"typeProperty": {
"type": "string",
"enum": [
"Struct"
]
}
},
"additionalProperties": false

30
schemars/tests/expected/enum-internal.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Internal",
"anyOf": [
"oneOf": [
{
"type": "object",
"required": [
@ -55,18 +55,18 @@
"typeProperty"
],
"properties": {
"typeProperty": {
"type": "string",
"enum": [
"StructNewType"
]
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
},
"bar": {
"type": "boolean"
"typeProperty": {
"type": "string",
"enum": [
"StructNewType"
]
}
}
},
@ -78,18 +78,18 @@
"typeProperty"
],
"properties": {
"typeProperty": {
"type": "string",
"enum": [
"Struct"
]
"bar": {
"type": "boolean"
},
"foo": {
"type": "integer",
"format": "int32"
},
"bar": {
"type": "boolean"
"typeProperty": {
"type": "string",
"enum": [
"Struct"
]
}
}
},

2
schemars/tests/expected/macro_built_enum.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "OuterEnum",
"anyOf": [
"oneOf": [
{
"type": "object",
"required": [

38
schemars/tests/expected/schema_with-enum-adjacent-tagged.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Adjacent",
"anyOf": [
"oneOf": [
{
"type": "object",
"required": [
@ -9,12 +9,6 @@
"t"
],
"properties": {
"t": {
"type": "string",
"enum": [
"Struct"
]
},
"c": {
"type": "object",
"required": [
@ -25,6 +19,12 @@
"type": "boolean"
}
}
},
"t": {
"type": "string",
"enum": [
"Struct"
]
}
}
},
@ -35,14 +35,14 @@
"t"
],
"properties": {
"c": {
"type": "boolean"
},
"t": {
"type": "string",
"enum": [
"NewType"
]
},
"c": {
"type": "boolean"
}
}
},
@ -53,12 +53,6 @@
"t"
],
"properties": {
"t": {
"type": "string",
"enum": [
"Tuple"
]
},
"c": {
"type": "array",
"items": [
@ -72,6 +66,12 @@
],
"maxItems": 2,
"minItems": 2
},
"t": {
"type": "string",
"enum": [
"Tuple"
]
}
}
},
@ -82,14 +82,14 @@
"t"
],
"properties": {
"c": {
"type": "boolean"
},
"t": {
"type": "string",
"enum": [
"Unit"
]
},
"c": {
"type": "boolean"
}
}
}

2
schemars/tests/expected/schema_with-enum-external.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "External",
"anyOf": [
"oneOf": [
{
"type": "object",
"required": [

8
schemars/tests/expected/schema_with-enum-internal.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Internal",
"anyOf": [
"oneOf": [
{
"type": "object",
"required": [
@ -9,14 +9,14 @@
"typeProperty"
],
"properties": {
"foo": {
"type": "boolean"
},
"typeProperty": {
"type": "string",
"enum": [
"Struct"
]
},
"foo": {
"type": "boolean"
}
}
},

2
schemars/tests/expected/skip_enum_variants.json
View file

@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "MyEnum",
"anyOf": [
"oneOf": [
{
"type": "string",
"enum": [

4
schemars/tests/util/mod.rs
View file

@ -22,7 +22,7 @@ pub fn test_schema(actual: &RootSchema, file: &str) -> TestResult {
let expected_json = match fs::read_to_string(format!("tests/expected/{}.json", file)) {
Ok(j) => j,
Err(e) => {
write_actual_to_file(&actual, file)?;
write_actual_to_file(actual, file)?;
return Err(Box::from(e));
}
};
@ -32,7 +32,7 @@ pub fn test_schema(actual: &RootSchema, file: &str) -> TestResult {
write_actual_to_file(actual, file)?;
}
assert_eq!(actual, expected);
assert_eq!(expected, actual);
Ok(())
}

80
schemars_derive/src/schema_exprs.rs
View file

@ -1,3 +1,5 @@
use std::collections::HashSet;
use crate::{ast::*, attr::WithAttr, metadata::SchemaMetadata};
use proc_macro2::{Span, TokenStream};
use serde_derive_internals::ast::Style;
@ -140,8 +142,14 @@ fn expr_for_external_tagged_enum<'a>(
variants: impl Iterator<Item = &'a Variant<'a>>,
deny_unknown_fields: bool,
) -> TokenStream {
let (unit_variants, complex_variants): (Vec<_>, Vec<_>) =
variants.partition(|v| v.is_unit() && v.attrs.with.is_none());
let mut unique_names = HashSet::<String>::new();
let mut count = 0;
let (unit_variants, complex_variants): (Vec<_>, Vec<_>) = variants
.inspect(|v| {
unique_names.insert(v.name());
count += 1;
})
.partition(|v| v.is_unit() && v.attrs.with.is_none());
let unit_names = unit_variants.iter().map(|v| v.name());
let unit_schema = schema_object(quote! {
@ -188,12 +196,7 @@ fn expr_for_external_tagged_enum<'a>(
schema_expr
}));
schema_object(quote! {
subschemas: Some(Box::new(schemars::schema::SubschemaValidation {
any_of: Some(vec![#(#schemas),*]),
..Default::default()
})),
})
variant_subschemas(unique_names.len() == count, schemas)
}
fn expr_for_internal_tagged_enum<'a>(
@ -201,7 +204,13 @@ fn expr_for_internal_tagged_enum<'a>(
tag_name: &str,
deny_unknown_fields: bool,
) -> TokenStream {
let variant_schemas = variants.map(|variant| {
let mut unique_names = HashSet::new();
let mut count = 0;
let variant_schemas = variants
.map(|variant| {
unique_names.insert(variant.name());
count += 1;
let name = variant.name();
let type_schema = schema_object(quote! {
instance_type: Some(schemars::schema::InstanceType::String.into()),
@ -228,27 +237,24 @@ fn expr_for_internal_tagged_enum<'a>(
variant.attrs.as_metadata().apply_to_schema(&mut tag_schema);
if let Some(variant_schema) =
expr_for_untagged_enum_variant_for_flatten(&variant, deny_unknown_fields)
expr_for_untagged_enum_variant_for_flatten(variant, deny_unknown_fields)
{
tag_schema.extend(quote!(.flatten(#variant_schema)))
}
tag_schema
});
schema_object(quote! {
subschemas: Some(Box::new(schemars::schema::SubschemaValidation {
any_of: Some(vec![#(#variant_schemas),*]),
..Default::default()
})),
})
.collect();
variant_subschemas(unique_names.len() == count, variant_schemas)
}
fn expr_for_untagged_enum<'a>(
variants: impl Iterator<Item = &'a Variant<'a>>,
deny_unknown_fields: bool,
) -> TokenStream {
let schemas = variants.map(|variant| {
let schemas = variants
.map(|variant| {
let mut schema_expr = expr_for_untagged_enum_variant(variant, deny_unknown_fields);
variant
@ -257,14 +263,12 @@ fn expr_for_untagged_enum<'a>(
.apply_to_schema(&mut schema_expr);
schema_expr
});
schema_object(quote! {
subschemas: Some(Box::new(schemars::schema::SubschemaValidation {
any_of: Some(vec![#(#schemas),*]),
..Default::default()
})),
})
.collect();
// Untagged enums can easily have variants whose schemas overlap; rather
// that checking the exclusivity of each subschema we simply us `any_of`.
variant_subschemas(false, schemas)
}
fn expr_for_adjacent_tagged_enum<'a>(
@ -273,7 +277,13 @@ fn expr_for_adjacent_tagged_enum<'a>(
content_name: &str,
deny_unknown_fields: bool,
) -> TokenStream {
let schemas = variants.map(|variant| {
let mut unique_names = HashSet::new();
let mut count = 0;
let schemas = variants
.map(|variant| {
unique_names.insert(variant.name());
count += 1;
let content_schema = if variant.is_unit() && variant.attrs.with.is_none() {
None
} else {
@ -329,8 +339,23 @@ fn expr_for_adjacent_tagged_enum<'a>(
.apply_to_schema(&mut outer_schema);
outer_schema
});
})
.collect();
variant_subschemas(unique_names.len() == count, schemas)
}
/// Callers must determine if all subschemas are mutually exclusive. This can
/// be done for most tagging regimes by checking that all tag names are unique.
fn variant_subschemas(unique: bool, schemas: Vec<TokenStream>) -> TokenStream {
if unique {
schema_object(quote! {
subschemas: Some(Box::new(schemars::schema::SubschemaValidation {
one_of: Some(vec![#(#schemas),*]),
..Default::default()
})),
})
} else {
schema_object(quote! {
subschemas: Some(Box::new(schemars::schema::SubschemaValidation {
any_of: Some(vec![#(#schemas),*]),
@ -338,6 +363,7 @@ fn expr_for_adjacent_tagged_enum<'a>(
})),
})
}
}
fn expr_for_untagged_enum_variant(variant: &Variant, deny_unknown_fields: bool) -> TokenStream {
if let Some(with_attr) = &variant.attrs.with {