although it depends of the exact schema change
Did you ever encounter a breaking change? So your schema check test failed but you ended up having to keep the breaking change
I think that it's safer and in the long term faster to not make breaking changes
But sometimes it happens
so there might be various solutions for that
- Longer, but better. Send at first non-breaking change so the new payload together with the old one and try to handle both. You mark also old one as obsolete. Then you can have "contract" with the clients of your package (especially if they're other teams in your company) that they have eg. 2-4 weeks to adapt, then you'll remove the old payload.
at least that's the scenarios that I'd suggest
In Marten, we're also trying to avoid breaking changes as much as we can
so eg. class in the new namespace
and then also give some time for users to adapt
But it's more for the contract changes in eg. Rest or events
probably for the packages it won't be super effective, but it's also an option
Then after some time you just remove the old code and remove this feature toggle
We could then register all the classes we want to check (I don't need everything validated, only the ones in the external core library)
Might be a dud, whats your first impression?
as it might also impact deserialization
That'd be similar approach as I suggested with the json schema, but with custom schema format
If it's enough then it's fine, it's usually good to keep the things simple, although in the long term json schema would be imho easier to maintain (as it's common format)
You can also store some sample jsons
and then write the tests to verify if they deserialize properly
huh, I usually have too many ideas :P
It would be nice to have in Marten possibility to store json schemas of the documents/events
and then allow user to have opt in to check the schema during storing, appending
or as you said validation
But it's quite some work to provide full-fledged solution
I think that it'd be cool feature
Right so I have 2 things to do then, 1st I need to write a quick fix to protect us in the interim. 2nd I am going to try and get the company to allow some time for this, perhaps myself and one of my devs can work on this. Its a long shot but you never know.
seems legit :)