mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-17 21:01:26 +02:00
Introduce a tree map for all content
This commit introduces a new data structure to store pages and their resources. This data structure is backed by radix trees. This simplies tree operations, makes all pages a bundle, and paves the way for #6310. It also solves a set of annoying issues (see list below). Not a motivation behind this, but this commit also makes Hugo in general a little bit faster and more memory effective (see benchmarks). Especially for partial rebuilds on content edits, but also when taxonomies is in use. ``` name old time/op new time/op delta SiteNew/Bundle_with_image/Edit-16 1.32ms ± 8% 1.00ms ± 9% -24.42% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 1.28ms ± 0% 0.94ms ± 0% -26.26% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 33.9ms ± 2% 21.8ms ± 1% -35.67% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 40.6ms ± 1% 37.7ms ± 3% -7.20% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 56.7ms ± 0% 51.7ms ± 1% -8.82% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 19.9ms ± 2% 18.3ms ± 3% -7.64% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 37.9ms ± 4% 34.0ms ± 2% -10.28% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 10.7ms ± 0% 10.6ms ± 0% -1.15% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 10.8ms ± 0% 10.7ms ± 0% -1.05% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 43.2ms ± 1% 39.6ms ± 1% -8.35% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 47.6ms ± 1% 47.3ms ± 0% ~ (p=0.057 n=4+4) SiteNew/Deep_content_tree-16 73.0ms ± 1% 74.2ms ± 1% ~ (p=0.114 n=4+4) SiteNew/Many_HTML_templates-16 37.9ms ± 0% 38.1ms ± 1% ~ (p=0.114 n=4+4) SiteNew/Page_collections-16 53.6ms ± 1% 54.7ms ± 1% +2.09% (p=0.029 n=4+4) name old alloc/op new alloc/op delta SiteNew/Bundle_with_image/Edit-16 486kB ± 0% 430kB ± 0% -11.47% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 265kB ± 0% 209kB ± 0% -21.06% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 13.6MB ± 0% 8.8MB ± 0% -34.93% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 66.5MB ± 0% 63.9MB ± 0% -3.95% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 28.8MB ± 0% 25.8MB ± 0% -10.55% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 6.16MB ± 0% 5.56MB ± 0% -9.86% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 16.9MB ± 0% 16.0MB ± 0% -5.19% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 2.28MB ± 0% 2.29MB ± 0% +0.35% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 2.07MB ± 0% 2.07MB ± 0% ~ (p=0.114 n=4+4) SiteNew/Tags_and_categories-16 14.3MB ± 0% 13.2MB ± 0% -7.30% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 69.1MB ± 0% 69.0MB ± 0% ~ (p=0.343 n=4+4) SiteNew/Deep_content_tree-16 31.3MB ± 0% 31.8MB ± 0% +1.49% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 10.8MB ± 0% 10.9MB ± 0% +1.11% (p=0.029 n=4+4) SiteNew/Page_collections-16 21.4MB ± 0% 21.6MB ± 0% +1.15% (p=0.029 n=4+4) name old allocs/op new allocs/op delta SiteNew/Bundle_with_image/Edit-16 4.74k ± 0% 3.86k ± 0% -18.57% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 4.73k ± 0% 3.85k ± 0% -18.58% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 301k ± 0% 198k ± 0% -34.14% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 389k ± 0% 373k ± 0% -4.07% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 338k ± 0% 262k ± 0% -22.63% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 102k ± 0% 88k ± 0% -13.81% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 176k ± 0% 152k ± 0% -13.32% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 26.8k ± 0% 26.8k ± 0% +0.05% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 26.8k ± 0% 26.8k ± 0% +0.05% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 273k ± 0% 245k ± 0% -10.36% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 396k ± 0% 398k ± 0% +0.39% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 317k ± 0% 325k ± 0% +2.53% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 146k ± 0% 147k ± 0% +0.98% (p=0.029 n=4+4) SiteNew/Page_collections-16 210k ± 0% 215k ± 0% +2.44% (p=0.029 n=4+4) ``` Fixes #6312 Fixes #6087 Fixes #6738 Fixes #6412 Fixes #6743 Fixes #6875 Fixes #6034 Fixes #6902 Fixes #6173 Fixes #6590
This commit is contained in:
Bjørn Erik Pedersen
@@ -17,6 +17,7 @@ import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"path"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
qt "github.com/frankban/quicktest"
|
||||
@@ -60,29 +61,33 @@ func TestCascade(t *testing.T) {
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
b.AssertFileContent("public/index.html", `
|
||||
12|taxonomy|categories/cool/_index.md|Cascade Category|cat.png|categories|HTML-|
|
||||
12|taxonomy|categories/catsect1|catsect1|cat.png|categories|HTML-|
|
||||
12|taxonomy|categories/funny|funny|cat.png|categories|HTML-|
|
||||
12|taxonomyTerm|categories/_index.md|My Categories|cat.png|categories|HTML-|
|
||||
32|taxonomy|categories/sad/_index.md|Cascade Category|sad.png|categories|HTML-|
|
||||
42|taxonomy|tags/blue|blue|home.png|tags|HTML-|
|
||||
42|section|sect3|Cascade Home|home.png|sect3|HTML-|
|
||||
42|taxonomyTerm|tags|Cascade Home|home.png|tags|HTML-|
|
||||
42|page|bundle1/index.md|Cascade Home|home.png|page|HTML-|
|
||||
42|page|p2.md|Cascade Home|home.png|page|HTML-|
|
||||
42|page|sect2/p2.md|Cascade Home|home.png|sect2|HTML-|
|
||||
42|page|sect3/p1.md|Cascade Home|home.png|sect3|HTML-|
|
||||
42|taxonomy|tags/green|green|home.png|tags|HTML-|
|
||||
42|home|_index.md|Home|home.png|page|HTML-|
|
||||
42|page|p1.md|p1|home.png|page|HTML-|
|
||||
42|section|sect1/_index.md|Sect1|sect1.png|stype|HTML-|
|
||||
42|section|sect1/s1_2/_index.md|Sect1_2|sect1.png|stype|HTML-|
|
||||
42|page|sect1/s1_2/p1.md|Sect1_2_p1|sect1.png|stype|HTML-|
|
||||
42|page|sect1/s1_2/p2.md|Sect1_2_p2|sect1.png|stype|HTML-|
|
||||
42|section|sect2/_index.md|Sect2|home.png|sect2|HTML-|
|
||||
42|page|sect2/p1.md|Sect2_p1|home.png|sect2|HTML-|
|
||||
52|page|sect4/p1.md|Cascade Home|home.png|sect4|RSS-|
|
||||
52|section|sect4/_index.md|Sect4|home.png|sect4|RSS-|
|
||||
12|taxonomy|categories/cool/_index.md|Cascade Category|cat.png|categories|HTML-|
|
||||
12|taxonomy|categories/catsect1|catsect1|cat.png|categories|HTML-|
|
||||
12|taxonomy|categories/funny|funny|cat.png|categories|HTML-|
|
||||
12|taxonomyTerm|categories/_index.md|My Categories|cat.png|categories|HTML-|
|
||||
32|taxonomy|categories/sad/_index.md|Cascade Category|sad.png|categories|HTML-|
|
||||
42|taxonomy|tags/blue|blue|home.png|tags|HTML-|
|
||||
42|taxonomyTerm|tags|Cascade Home|home.png|tags|HTML-|
|
||||
42|section|sectnocontent|Cascade Home|home.png|sectnocontent|HTML-|
|
||||
42|section|sect3|Cascade Home|home.png|sect3|HTML-|
|
||||
42|page|bundle1/index.md|Cascade Home|home.png|page|HTML-|
|
||||
42|page|p2.md|Cascade Home|home.png|page|HTML-|
|
||||
42|page|sect2/p2.md|Cascade Home|home.png|sect2|HTML-|
|
||||
42|page|sect3/nofrontmatter.md|Cascade Home|home.png|sect3|HTML-|
|
||||
42|page|sect3/p1.md|Cascade Home|home.png|sect3|HTML-|
|
||||
42|page|sectnocontent/p1.md|Cascade Home|home.png|sectnocontent|HTML-|
|
||||
42|section|sectnofrontmatter/_index.md|Cascade Home|home.png|sectnofrontmatter|HTML-|
|
||||
42|taxonomy|tags/green|green|home.png|tags|HTML-|
|
||||
42|home|_index.md|Home|home.png|page|HTML-|
|
||||
42|page|p1.md|p1|home.png|page|HTML-|
|
||||
42|section|sect1/_index.md|Sect1|sect1.png|stype|HTML-|
|
||||
42|section|sect1/s1_2/_index.md|Sect1_2|sect1.png|stype|HTML-|
|
||||
42|page|sect1/s1_2/p1.md|Sect1_2_p1|sect1.png|stype|HTML-|
|
||||
42|page|sect1/s1_2/p2.md|Sect1_2_p2|sect1.png|stype|HTML-|
|
||||
42|section|sect2/_index.md|Sect2|home.png|sect2|HTML-|
|
||||
42|page|sect2/p1.md|Sect2_p1|home.png|sect2|HTML-|
|
||||
52|page|sect4/p1.md|Cascade Home|home.png|sect4|RSS-|
|
||||
52|section|sect4/_index.md|Sect4|home.png|sect4|RSS-|
|
||||
`)
|
||||
|
||||
// Check that type set in cascade gets the correct layout.
|
||||
@@ -106,43 +111,131 @@ func TestCascadeEdit(t *testing.T) {
|
||||
title: P1
|
||||
---
|
||||
`
|
||||
b := newTestSitesBuilder(t).Running()
|
||||
b.WithTemplatesAdded("_default/single.html", `Banner: {{ .Params.banner }}|Layout: {{ .Layout }}|Type: {{ .Type }}|Content: {{ .Content }}`)
|
||||
b.WithContent("post/_index.md", `
|
||||
|
||||
indexContentNoCascade := `
|
||||
---
|
||||
title: Post
|
||||
title: Home
|
||||
---
|
||||
`
|
||||
|
||||
indexContentCascade := `
|
||||
---
|
||||
title: Section
|
||||
cascade:
|
||||
banner: post.jpg
|
||||
layout: postlayout
|
||||
type: posttype
|
||||
---
|
||||
`)
|
||||
`
|
||||
|
||||
b.WithContent("post/dir/_index.md", `
|
||||
---
|
||||
title: Dir
|
||||
---
|
||||
`, "post/dir/p1.md", p1Content)
|
||||
b.Build(BuildCfg{})
|
||||
layout := `Banner: {{ .Params.banner }}|Layout: {{ .Layout }}|Type: {{ .Type }}|Content: {{ .Content }}`
|
||||
|
||||
assert := func() {
|
||||
b.Helper()
|
||||
b.AssertFileContent("public/post/dir/p1/index.html",
|
||||
`Banner: post.jpg|`,
|
||||
`Layout: postlayout`,
|
||||
`Type: posttype`,
|
||||
)
|
||||
newSite := func(t *testing.T, cascade bool) *sitesBuilder {
|
||||
b := newTestSitesBuilder(t).Running()
|
||||
b.WithTemplates("_default/single.html", layout)
|
||||
b.WithTemplates("_default/list.html", layout)
|
||||
if cascade {
|
||||
b.WithContent("post/_index.md", indexContentCascade)
|
||||
} else {
|
||||
b.WithContent("post/_index.md", indexContentNoCascade)
|
||||
}
|
||||
b.WithContent("post/dir/p1.md", p1Content)
|
||||
|
||||
return b
|
||||
}
|
||||
|
||||
assert()
|
||||
t.Run("Edit descendant", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
b.EditFiles("content/post/dir/p1.md", p1Content+"\ncontent edit")
|
||||
b.Build(BuildCfg{})
|
||||
b := newSite(t, true)
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
assert()
|
||||
b.AssertFileContent("public/post/dir/p1/index.html",
|
||||
`content edit`,
|
||||
)
|
||||
assert := func() {
|
||||
b.Helper()
|
||||
b.AssertFileContent("public/post/dir/p1/index.html",
|
||||
`Banner: post.jpg|`,
|
||||
`Layout: postlayout`,
|
||||
`Type: posttype`,
|
||||
)
|
||||
}
|
||||
|
||||
assert()
|
||||
|
||||
b.EditFiles("content/post/dir/p1.md", p1Content+"\ncontent edit")
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
assert()
|
||||
b.AssertFileContent("public/post/dir/p1/index.html",
|
||||
`content edit
|
||||
Banner: post.jpg`,
|
||||
)
|
||||
})
|
||||
|
||||
t.Run("Edit ancestor", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
b := newSite(t, true)
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
b.AssertFileContent("public/post/dir/p1/index.html", `Banner: post.jpg|Layout: postlayout|Type: posttype|Content:`)
|
||||
|
||||
b.EditFiles("content/post/_index.md", strings.Replace(indexContentCascade, "post.jpg", "edit.jpg", 1))
|
||||
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
b.AssertFileContent("public/post/index.html", `Banner: edit.jpg|Layout: postlayout|Type: posttype|`)
|
||||
b.AssertFileContent("public/post/dir/p1/index.html", `Banner: edit.jpg|Layout: postlayout|Type: posttype|`)
|
||||
})
|
||||
|
||||
t.Run("Edit ancestor, add cascade", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
b := newSite(t, true)
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
b.AssertFileContent("public/post/dir/p1/index.html", `Banner: post.jpg`)
|
||||
|
||||
b.EditFiles("content/post/_index.md", indexContentCascade)
|
||||
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
b.AssertFileContent("public/post/index.html", `Banner: post.jpg|Layout: postlayout|Type: posttype|`)
|
||||
b.AssertFileContent("public/post/dir/p1/index.html", `Banner: post.jpg|Layout: postlayout|`)
|
||||
})
|
||||
|
||||
t.Run("Edit ancestor, remove cascade", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
b := newSite(t, false)
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
b.AssertFileContent("public/post/dir/p1/index.html", `Banner: |Layout: |`)
|
||||
|
||||
b.EditFiles("content/post/_index.md", indexContentNoCascade)
|
||||
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
b.AssertFileContent("public/post/index.html", `Banner: |Layout: |Type: post|`)
|
||||
b.AssertFileContent("public/post/dir/p1/index.html", `Banner: |Layout: |`)
|
||||
})
|
||||
|
||||
t.Run("Edit ancestor, content only", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
b := newSite(t, true)
|
||||
b.Build(BuildCfg{})
|
||||
|
||||
b.EditFiles("content/post/_index.md", indexContentCascade+"\ncontent edit")
|
||||
|
||||
counters := &testCounters{}
|
||||
b.Build(BuildCfg{testCounters: counters})
|
||||
// As we only changed the content, not the cascade front matter, make
|
||||
// only the home page is re-rendered.
|
||||
b.Assert(int(counters.contentRenderCounter), qt.Equals, 1)
|
||||
|
||||
b.AssertFileContent("public/post/index.html", `Banner: post.jpg|Layout: postlayout|Type: posttype|Content: <p>content edit</p>`)
|
||||
b.AssertFileContent("public/post/dir/p1/index.html", `Banner: post.jpg|Layout: postlayout|`)
|
||||
})
|
||||
}
|
||||
|
||||
func newCascadeTestBuilder(t testing.TB, langs []string) *sitesBuilder {
|
||||
@@ -247,6 +340,12 @@ defaultContentLanguageInSubDir = false
|
||||
}),
|
||||
"sect2/p2.md", p(map[string]interface{}{}),
|
||||
"sect3/p1.md", p(map[string]interface{}{}),
|
||||
|
||||
// No front matter, see #6855
|
||||
"sect3/nofrontmatter.md", `**Hello**`,
|
||||
"sectnocontent/p1.md", `**Hello**`,
|
||||
"sectnofrontmatter/_index.md", `**Hello**`,
|
||||
|
||||
"sect4/_index.md", p(map[string]interface{}{
|
||||
"title": "Sect4",
|
||||
"cascade": map[string]interface{}{
|
||||
|
||||
Reference in New Issue
Block a user