ArraySchema: known issues

[endel]

ArraySchema is accumulating a number of known issues that only a re-write of how to sync arrays is capable of fixing. This issue is meant to track new issues and edge cases when using ArraySchema.

• Wrong callback order [Bug]: States are not triggered in the expected order #702
• [Bug]: Uncaught Error: ChangeTree: missing index for field "undefined" #689
• ArraySchema keys not updated when elements are removed schema#152
• ArraySchema: moving items results in wrong state schema#108
• ArraySchema push/splice/push, item added at wrong index. schema#94
• ArraySchema.splice() items to insert are ignored schema#101 (comment)
• ArraySchema: CLEAR + PUSH results in onAdd called twice schema#107
• https://github.com/orgs/colyseus/discussions/589
• [Bug]: ArraySchema.unshift() not working as intended. schema#170

(Fixing those is in the roadmap towards version 1.0: https://github.com/colyseus/colyseus/wiki/Public-Roadmap)

[Byloth]

Hi!
I landed here due to a malfunction in state synchronization.

I've already solved it by following this workaround: #510 (comment)
To be honest, I don't know if it's related to all types available in the Schema or it's related only to ArraySchema (I've experienced with it).

That said...
Since useDefineForClassFields needs to be set to true more and more often due to compatibility with other libraries, are you considering supporting it during this refactoring?

If I'm off-topic, I'd be happy to open a new Issue about it.
Just let me know.

Thank you. 🙃

[endel]

Hi @Byloth 👋 , can you create a new issue about this? Thank you!
I'm curious to know which libs require useDefineForClassFields to be true