Skip to content

Fix HexString JSON schema for empty byte strings #3029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
weifanglab wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Fix HexString JSON schema for empty byte strings #3029

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions crates/rollup-interface/src/common/hex_string.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ impl schemars::JsonSchema for HexString {
fn json_schema(_gen: &mut schemars::SchemaGenerator) -> schemars::Schema {
schemars::json_schema!({
"type": "string",
"pattern": "^0x(?:[a-fA-F0-9]{2})+$",
"description": "A `0x`-prefixed hexadecimal string (uppercase or lowercase) of variable length, with an even number of hex digits.",
"pattern": "^0x(?:[a-fA-F0-9]{2})*$",
"description": "A `0x`-prefixed hexadecimal string (uppercase or lowercase) of variable length, including zero bytes, with an even number of hex digits.",
})
}
}
Expand Down Expand Up @@ -273,4 +273,21 @@ mod tests {
fn hex_string_str_roundtrip(item: HexString) {
test_str_roundtrip(item);
}

#[test]
fn variable_length_hex_string_json_schema_allows_empty_string() {
let empty_hex = HexString(Vec::<u8>::new());

assert_eq!(serde_json::to_string(&empty_hex).unwrap(), "\"0x\"");
assert_eq!(
HexString::<Vec<u8>>::from_str("0x").unwrap(),
HexString(Vec::new())
);

let mut schema_generator = schemars::SchemaGenerator::default();
let schema = <HexString as schemars::JsonSchema>::json_schema(&mut schema_generator);
let schema = serde_json::to_value(schema).unwrap();

assert_eq!(schema["pattern"], "^0x(?:[a-fA-F0-9]{2})*$");
}
}
Loading