[DOC EmbeddedRecordsMixin] Assert from JSONAPISerializer

[allthesignals]

Use of EmbeddedRecordsMixin and JSONAPISerializer together asserts instead of warns. Allows for setting "isEmbeddedRecordsMixinCompatible" on the serializer for when parts of the API are compatible.

Closes #6991

[allthesignals]

Probably want a test for allowing this

[hjdivad]

yep, also mention the opt-in flag in the assertion message

[hjdivad]

yep, also mention the opt-in flag in the assertion message

[hjdivad]

thanks for taking a look at this @allthesignals!

[allthesignals]

Looking at this again tonight, but I'm a bit stuck.

I need a way to assert based on values from both the mixed-in class and the mixin itself (check isEmbeddedRecordsMixin on the mixin and isEmbeddedRecordsMixinCompatible on the user class extension).

Right now, the EmbeddedRecordsMixin assertion lives on the JSONAPISerializer itself, and is run with the willMergeMixin hook (which I can't find documentation for).

There are some other assertions sprinkled throughout the JSONAPISerializer class, so I think my best bet is to move the assertion check there, unless there is a better approach.

Alright, I just put it into init. Not sure if there's a problem with that approach.

[hjdivad]

@runspired do we expect the IE11 asset size check to be this sensitive? it's complaining about a 50B (not Kb) increase.

[hjdivad]

LGTM assuming tests 🍏

[allthesignals]

Just guessing but maybe the inclusion of the code inside init means it doesn't get stripped out during some production build step? Might be why some of these other warns are added into the reopen inside the debug check.

Oh, interesting — the assertion does get stripped out but leaves the empty init:

init:function(){this._super.apply(this,arguments)}

And it's exactly 50 bytes.

Edit: Oh. I can just put it inside that reopen call and I think it'll get stripped out.

[hjdivad]

thanks @allthesignals!

[runspired]

@hjdivad we do expect it to be that sensitive. The idea is that any regression is one we are acutely aware of, vs allowing lots of tiny drift to be added over time unnoticed.