Throw an error if a circular layout chain is detected #2076
Conversation
| let cfgKey = this.config.keys.layout; | ||
| let map = []; | ||
| let mapEntry = await this.getTemplateLayoutMapEntry(); | ||
|
|
||
| // Keep track of every layout we see so we can detect cyclical layout chains (e.g., a => b => c => a). | ||
| const seenLayoutKeys = new Set(); | ||
| seenLayoutKeys.add(mapEntry.key); | ||
| map.push(mapEntry); | ||
|
|
||
| while (mapEntry.frontMatterData && cfgKey in mapEntry.frontMatterData) { | ||
| // Layout of the current layout | ||
| const parentLayoutKey = mapEntry.frontMatterData[cfgKey]; | ||
| // Abort if a circular layout chain is detected. Otherwise, we'll time out and run out of memory. | ||
| if (seenLayoutKeys.has(parentLayoutKey)) { | ||
| throw new Error( | ||
| `Circular layout chain detected starting at ${map[0].key}. The layout ${parentLayoutKey} was specified twice in this layout chain.` | ||
| ); | ||
| } | ||
| // Keep track of this layout so we can detect duplicates in subsequent iterations | ||
| seenLayoutKeys.add(parentLayoutKey); | ||
| let layout = TemplateLayout.getTemplate( | ||
| mapEntry.frontMatterData[cfgKey], | ||
| parentLayoutKey, |
There was a problem hiding this comment.
Was getTemplateLayoutMap the right place to handle this logic, or is there a better method to put it in?
| // Abort if a circular layout chain is detected. Otherwise, we'll time out and run out of memory. | ||
| if (seenLayoutKeys.has(parentLayoutKey)) { | ||
| throw new Error( | ||
| `Circular layout chain detected starting at ${map[0].key}. The layout ${parentLayoutKey} was specified twice in this layout chain.` |
There was a problem hiding this comment.
Wasn't sure what error message to show. It might be helpful to show the full layout chain stack. Is there a way to do that? JSON.stringify?
AleksandrHovhannisyan
force-pushed
the
circular-layout-chains
branch
from
bb4600e
to
da4eba7
Compare
|
Hey, any particular reason this was closed? I think it’s still worthwhile—happy to update it! |
|
@zachleat Up to you! Closing it may have been premature on my part; I just figured maybe it wasn't solving a real problem. But now that I think about it, I suppose some users might not realize that a circular layout chain is the source of their problems. |
Thank you @AleksandrHovhannisyan!
|
I wasn’t able to get access to your deleted branch, but I did merge this code! It will ship with 2.0.0-canary.10 Thank you! |
Fixes #2064 to terminate the 11ty server if circular layout chains are detected