Validate event document URLs as URIs#192
Open
c-tonneslan wants to merge 1 commit into
Open
Conversation
The event documents schema treated url as a plain non-empty string
and put it at the top level of each document, which didn't match
what add_document actually writes (note + classification + a links
array of {url, media_type}). The result was that a relative path
like '/whatever/124.html' would pass validation silently, and the
real URL never got the format: uri check at all.
Restructure the documents item schema to mirror bill versions and
the existing event media schema: classification + nested links
with uri-validated urls. Added a regression test that asserts
e.add_document(url='/relative.html') now fails validation.
Closes openstates/issues#1298.
Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The event documents schema (
schemas/event.py) puturlat the top level of each document as a plain non-empty string. That didn't match whatEvent.add_documentactually writes (which isnote+classification+ alinksarray of{url, media_type}, via_add_associated_link), so the real url never hit theformat: uricheck and a relative path like/whatever/124.htmlsilently passed validation.Restructure the documents item schema to mirror what's already in the bill
versions_or_documentsand the eventmedia_schema: aclassificationfield plus a nestedlinksarray with uri-validated URLs. Added a regression test that assertse.add_document(url='/relative.html')now failsvalidate().Closes openstates/issues#1298.