[OS-17] JSON Schema validation

[Marahin]

Unknown(s), to debate(s), discussables:

• Where should we raise JsonApi::Parameters translator errors? In which cases? This is important, because if we do not raise an error, then in the default behaviour - no validation will happen.
• How to handle JSON Schema invalidation / updates?

[Marahin]

Things left to do:

• make the schema more liberal for root path keys OR handle removal of action, controller and other Rails-specific middleware parameters that are added during the request cycle to the ActionController::Parameters object instance (right now they are validated as well and the schema makes a note about it that these are not recognized or expected keys),
• find out how to handle this as a major or minor (non-breaking) version

[ipepe]

The current version works "good enough" for us at LL, there are exactly 3 tests failing and they are just nontypical usage of jsonapi-parameters . Our recommendation is for the current version to be merged but with at least the "MINOR" version increase

[Marahin]

@ipepe I'm wondering whether other users may see a breaking change while updating. If I understand correctly, you are experiencing this, so this would imply a breaking change version bump.

Could you share (perhaps in a confidential environment) what are the non-typical usages? Specific code lines where you execute jsonapi_parameters translation?

Maybe this way we could provide an interface that would not enforce the change so the existing users would be able to take control over the update.

[choosen]

there is draft -07

[Marahin]

Even now 07 is not edge: http://json-schema.org/draft/2019-09/release-notes.html

I believe we should resolve the subject of version update (and whether it can be minor upgrade) in our library and then we can think about moving on to next version of schema.

[choosen]

https://json-schema.org/draft/2019-09/schema
that's right. Therefore the draft was upgraded also in article linked in repo 👍

[choosen]

davishmcclurg/json_schemer#44
is supporting max draft-07 currently according to readme

[Marahin]

Therefore the draft was upgraded also in article linked in repo 👍

I have no clue which article or link you are talking about.

[choosen]

https://github.com/davishmcclurg/json_schemer

[choosen]

oh wrong link: https://polythematik.de/2020/02/17/ruby-json-schema/

[choosen]

validate! has been provided by rails >= 5.0
So this solution limits the benefits for rails 4.0, which are not maintained anymore.
Michał Książek is coding solution to change that

[Marahin]

That should be pretty easy to overcome, as #validate is present since Rails 4.2.1: https://apidock.com/rails/v4.2.1/ActiveModel/Validations/validate

So perhaps it is worth to check whether this method is defined, and if not, then just call validate and raise on failure.

[Marahin]

Since we already limit ourselves to >= 4.1.8, we might as well limit ourselves to 4.2.1.

https://github.com/visualitypl/jsonapi_parameters/blob/master/jsonapi_parameters.gemspec#L25

[choosen]

We spoke with Michał to drop activeModel validation at all - it does not provide big value

[Marahin]

Indeed from what I can see in the upcoming PR to this branch, this seems like a move in good direction. We just have to ensure this will be a solid solution, as this will be something technically "invented here" whereas up until this point we have used proven and well tested ActiveModel validations.