Handle empty bodies in lexicon validation #2746
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 tasks
Vincentroland
approved these changes
Sep 5, 2024
bnewbold
added a commit
to bluesky-social/indigo
that referenced
this pull request
Oct 4, 2024
…e data validation (#420) This is currently a branch on top of #407 - [x] parse lexicon schema JSON - [x] load entire directories of schema JSON files from disk as a catalog - [x] check lexicon schema semantics (eg, can't have min greater than max) - [x] validate runtime data (`map[string]any`) against lexicons - [x] whole bunch of corner-case tests - [x] CLI tool for some live-network testing - [x] add support for `tid` and `record-key` lex formats (not in specs yet) - [x] configurable flexible to legacy blobs and lenient datetime parsing (?) - [x] comments and example code probably in a later iteration: - [ ] ensure empty body works (bluesky-social/atproto#2746) - [ ] validate rkey type against lexicon - [ ] CLI tool to validate prod firehose - [ ] CLI tool to validate CAR files - [x] clarify specs around unions: only `object` and `token` types? - [x] clarify specs around `unknown`: only `object` type? - [ ] validate other "primary" lexicon types: subscription, HTTP body, HTTP URL params, etc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There's a weird edge case in lexicon validation around a schema moving from having no output schema to having an output schema with all optional properties. This is allowed in Lexicon. And it actually works with the current code but not for the reasons we expect.
The existing code will parse the body as an empty array and then treat it as an object and do lexicon checks against it as if it is the parsed JSON of the response.
Instead, we parse an empty body with no content type as
undefined, and then in the higher level lexicon assertions (for validating output/input/params), pass instead pass theundefinedthrough as an empty JSON object.