Ensure the validator can handle the payload being JSON #68
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
davidgisbey
force-pushed
the
ensure-validator-works-with-object-or-json-passed-in
branch
2 times, most recently
from
5f6ada0 to
f4f69f7
Compare
ollietreend
reviewed
Jul 22, 2022
lib/govuk_schemas/validator.rb
Outdated
Comment on lines
9
to
10
| @payload = payload | ||
| ensure_payload_is_json |
There was a problem hiding this comment.
It might be nicer to implement this as a method which returns a JSON string – rather than a method with side effects.
e.g.
Suggested change
| @payload = payload | |
| ensure_payload_is_json | |
| @payload = ensure_json(payload) |
It feels a bit weird to be setting @payload and then immediately updating it in ensure_payload_is_json.
There was a problem hiding this comment.
hmm yea i think that's a good shout actually. Will update now 👍
lib/govuk_schemas/version.rb
Outdated
| @@ -1,4 +1,4 @@ | |||
| module GovukSchemas | |||
| # @private | |||
| VERSION = "4.4.0".freeze | |||
| VERSION = "4.5.0".freeze | |||
There was a problem hiding this comment.
I wonder if this is more suited to being a patch release rather than a minor release. It seems like this is a bug-fix rather than a new feature. 🤔
Suggested change
| VERSION = "4.5.0".freeze | |
| VERSION = "4.4.1".freeze |
What do you think?
There was a problem hiding this comment.
yea good shout. Will update 👍
At the moment, there's some disparity between how applications that user Minitest and applications that use RSpec pass their payloads. RSpec applications pass the payload as JSON and Minitest applications pass it as a Hash. Currently, the payload is being converted to JSON before being validated by `JSON.fully_validate`. If the object is already JSON then .to_json is called again. This means when JSON.parse is called on the object it does not convert it back to a hash. This commit updates the validator to ensure that the payload is converted to JSON if the object passed is not a string.
davidgisbey
force-pushed
the
ensure-validator-works-with-object-or-json-passed-in
branch
from
f4f69f7 to
72e1e6e
Compare
davidgisbey
deleted the
ensure-validator-works-with-object-or-json-passed-in
branch
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.
Description
At the moment, there's some disparity between how applications that user Minitest and applications that use RSpec pass their payloads.
RSpec applications pass the payload as JSON and Minitest applications pass it as a Hash.
Currently, the payload is being converted to JSON before being validated by
JSON.fully_validate. If the object is already JSON then .to_json is called again. This means when JSON.parse is called withinJSON.fully_validateon the payload it does not convert it to a hash.This commit updates the validator to ensure that the payload not converted to JSON if it is already a string.
Trello card
https://trello.com/c/Q9O5rXnz/550-stop-using-the-deprecated-govuk-content-schema-test-helpers-gem