BertrandBordage
commented
5 years ago Hi @robertsoakes and thanks for your contribution!
It’s very interesting, before you I didn’t know some people still had performance issues after switching to react-streamfield!
Your pull request is outdated, especially it’s not compatible with Wagtail 2.6. I will review it soon and see it’s not possible to do something simpler. To clarify, it seems a bit too complicated for just a caching, and I don’t want to add too much complexity to an already hard codebase just for a performance boost when the vast majority of users find it fast enough now.
This merge request provides an optional cache for block definitions. For complex stream fields with deeply nested blocks, this can speed up the load of the page editor (Wagtail admin) by one or two orders of magnitudes. The cache is enabled by using a
BlockCacheStreamFieldPanel. The cache is created on the the binding of the model instance to the page/streamfield, and resets between page loads.We have tested the system in two production systems, and have not yet seen any errors with other Wagtail React StreamField functionality: errors, notifications, and values work as expected.
The block definition hashing is controlled by the type of block, the icon, help text, and features (for rich text fields). I'm sure a more robust signature method will probably be needed at some point, but this is working well for our current use-cases.