fix(visual-editor): handle circular pattern dependencies in the tree [SPA-2511] #946
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
When accidentally causing a loop in the chain of pattern dependencies, the SDK would crash and the browser tab becomes not responsible.
Approach
To address this, we want to render a similar error as we do for missing component definitions. To detect a loop during the render cycle, we pass through a list of
wrappingPatternIds
that gets extended when "diving into" a pattern node.To detect the loop as early as possible (and not pollute the canvas with multiple instances of a single pattern), we have to know the ID of the opened experience ID. When finding the same ID again deeper inside the tree, we stop immediately the rendering cycle and render the error message. To know the global experience ID, we leverage the
blockId
of the root node. So far, it was the same as the root node id. Using this for the entry ID sounds more reasonable to me and saves us from adding another attribute or message to the communication layer.Note: This handles only the editor case. For preview/ delivery, there will be a separate PR