[SuperEditor] Add test to demonstrate that changing layer builders does not re-layout #2388
Conversation
| MaterialApp( | ||
| home: Scaffold( | ||
| body: ValueListenableBuilder( | ||
| valueListenable: brightnessNotifier, |
There was a problem hiding this comment.
Looking at this widget tree, I'm a little confused about the build behavior.
Your description of the problem is that the overlay builders don't rebuild when the brightness changes.
I'm reading through this tree. I see the ValueListenableBuilder, which rebuilds whenever the brightness changes. When the ValueListenableBuilder rebuilds, it should construct a new SuperEditor instance, which then creates a new DefaultCaretOverlayBuilder. If we're rebuilding the ValueListenableBuilder, and rebuilding the SuperEditor, why isn't the DefaultCaretOverlayBuilder being built?
There was a problem hiding this comment.
Because none of the document nodes changed its content. Thus, we are not running another layout phase. We are only repainting the document components, without running a layout phase ContentLayers won't build the overlayers.
There was a problem hiding this comment.
Can you phrase that statement in terms of the chain of events that I described? What did I get wrong in that series of events? It's not clear what "none of the document nodes changed" has to do with my comment. If we're rebuilding SuperEditor then why isn't SuperEditor running build on its internal ContentLayers? Where are those two builds getting disconnected, such that SuperEditor runs widget build, but ContentLayers doesn't?
There was a problem hiding this comment.
This is the sequence of methods being called:
-> INITIAL BUILD
ValueListenableBuilder -> build
SuperEditor -> build
DocumentScaffold -> build
RenderContentLayers -> performLayout
ContentLayersElement -> buildLayers
RenderContentLayers -> performLayout
ContentLayersElement -> buildLayers
-> VALUE NOTIFIER CHANGED
ValueListenableBuilder -> build
SuperEditor -> build
DocumentScaffold -> build
ContentLayersElement -> update
The critical thing for us is that RenderContentLayers.performLayout is not called. It seems the subtree isn't considered dirty, so the layout does not run again.
[SuperEditor] Add test to demonstrate that changing layer builders does not re-layout
Changing
SuperEditoroverlay builders doesn't trigger a re-layout. An overlay can change, for example, to switch the caret color depending on the theme.This was discussed in #2042
This PR adds tests to demonstrate that issue. The first test, which only switches the theme, fails. The second test, that types a character after switching themes, passes.