feat: validate latitude and longitude #16
Merged
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
It is now impossible to encode/decode a position with an invalid latitude or longitude. There are two motivations for this change: 1. General correctness. 2. `@mapeo/mock-data` is currently generating invalid latitudes and longitudes because of the schema in this repo. That causes [some workarounds if you need valid coordinates][0], and I plan to add more tests that will require similar workarounds. I felt that fixing the problem here, at the source, was best. [0]: https://github.com/digidem/comapeo-cloud/blob/d6ab53197ac3970ee8f287ddb30663a04c6449d1/test/add-alerts-endpoint.js#L240-L243
|
The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).
|
This was referenced Nov 26, 2024
gmaclennan
reviewed
Nov 27, 2024
There was a problem hiding this comment.
JSON schema change looks good, however it doesn't quite feel right to validate as part of the encode step. I don't think we validate anything other than the types in the encode step for other things, and instead we rely on the ajv validate function when writing data. Not sure why we would do this differently here?
|
Removed the encode validation in 71e08c2. |
gmaclennan
approved these changes
Dec 9, 2024
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.
It is now impossible to encode/decode a position with an invalid latitude or longitude.
There are two motivations for this change:
General correctness.
@mapeo/mock-datais currently generating invalid latitudes and longitudes because of the schema in this repo. That causes some workarounds if you need valid coordinates, and I plan to add more tests that will require similar workarounds. I felt that fixing the problem here, at the source, was best.