-
-
Notifications
You must be signed in to change notification settings - Fork 471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Throw an error if a circular layout chain is detected #2076
Closed
AleksandrHovhannisyan
wants to merge
2
commits into
11ty:master
from
AleksandrHovhannisyan:circular-layout-chains
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -70,11 +70,25 @@ class TemplateLayout extends TemplateContent { | |
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, | ||
Comment on lines
70
to
+91
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Was |
||
mapEntry.inputDir, | ||
this.config, | ||
this.extensionMap | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
layout: layouts/layout-cycle-b.njk | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
layout: layouts/layout-cycle-c.njk | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
layout: layouts/layout-cycle-a.njk | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
layout: layouts/layout-cycle-self.njk | ||
--- |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?