Add page.Store

Fixes #9546

diff --git a/hugolib/page__common.go b/hugolib/page__common.go
index bf11ae7d6717e7103fbe369f101c3d2136a4ebc9..0294393e42b51b2827249576e4be0b6e08cc933b 100644 (file)
--- a/hugolib/page__common.go
+++ b/hugolib/page__common.go
@@ -60,6 +60,9 @@ type pageCommon struct {
        // Lazily initialized dependencies.
        init *lazy.Init
 
+       // Store holds state that survives server rebuilds.
+       store *maps.Scratch
+
        // All of these represents the common parts of a page.Page
        maps.Scratcher
        navigation.PageMenusProvider
@@ -134,6 +137,10 @@ type pageCommon struct {
        forceRender bool
 }
 
+func (p *pageCommon) Store() *maps.Scratch {
+       return p.store
+}
+
 type pagePages struct {
        pagesInit sync.Once
        pages     page.Pages

diff --git a/hugolib/page__new.go b/hugolib/page__new.go
index 5efebe4f59907031b7b5937ca37947a71048f6ef..91847784313f208f013a2b4fdc789a85760969d4 100644 (file)
--- a/hugolib/page__new.go
+++ b/hugolib/page__new.go
@@ -41,6 +41,7 @@ func newPageBase(metaProvider *pageMeta) (*pageState, error) {
                        FileProvider:            metaProvider,
                        AuthorProvider:          metaProvider,
                        Scratcher:               maps.NewScratcher(),
+                       store:                   maps.NewScratch(),
                        Positioner:              page.NopPage,
                        InSectionPositioner:     page.NopPage,
                        ResourceMetaProvider:    metaProvider,

diff --git a/hugolib/page_test.go b/hugolib/page_test.go
index 6b35e48144a3561232e66de257128f8b88510a00..1edef622bbe68a66112e2412854e228104d13734 100644 (file)
--- a/hugolib/page_test.go
+++ b/hugolib/page_test.go
@@ -1769,7 +1769,7 @@ Summary: In Chinese, 好 means good.
        b.AssertFileContent("public/p6/index.html", "WordCount: 7\nFuzzyWordCount: 100\nReadingTime: 1\nLen Plain: 638\nLen PlainWords: 7\nTruncated: false\nLen Summary: 637\nLen Content: 652")
 }
 
-func TestScratchSite(t *testing.T) {
+func TestScratch(t *testing.T) {
        t.Parallel()
 
        b := newTestSitesBuilder(t)
@@ -1796,6 +1796,50 @@ title: Scratch Me!
        b.AssertFileContent("public/scratchme/index.html", "C: cv")
 }
 
+func TestScratchRebuild(t *testing.T) {
+       t.Parallel()
+
+       files := `
+-- config.toml --
+-- content/p1.md --
+---
+title: "p1"
+---
+{{< scratchme >}}
+-- layouts/shortcodes/foo.html --
+notused
+-- layouts/shortcodes/scratchme.html --
+{{ .Page.Scratch.Set "scratch" "foo" }}
+{{ .Page.Store.Set "scratch" "bar" }}
+-- layouts/_default/single.html --
+{{ .Content }}
+Scratch: {{ .Scratch.Get "scratch" }}|
+Store: {{ .Store.Get "scratch" }}|
+`
+
+       b := NewIntegrationTestBuilder(
+               IntegrationTestConfig{
+                       T:           t,
+                       TxtarString: files,
+                       Running:     true,
+               },
+       ).Build()
+
+       b.AssertFileContent("public/p1/index.html", `
+Scratch: foo|
+Store: bar|
+       `)
+
+       b.EditFiles("layouts/shortcodes/foo.html", "edit")
+
+       b.Build()
+
+       b.AssertFileContent("public/p1/index.html", `
+Scratch: |
+Store: bar|
+       `)
+}
+
 func TestPageParam(t *testing.T) {
        t.Parallel()
 

diff --git a/resources/page/page.go b/resources/page/page.go
index d1790806eadc6ef2297d02ea6d66b1c147bcd247..1ad536e943691248bd72ead42d3a85ffd681a897 100644 (file)
--- a/resources/page/page.go
+++ b/resources/page/page.go
@@ -261,7 +261,15 @@ type PageWithoutContent interface {
        // Helper methods
        ShortcodeInfoProvider
        compare.Eqer
+
+       // Scratch returns a Scratch that can be used to store temporary state.
+       // Note that this Scratch gets reset on server rebuilds. See Store() for a variant that survives.
        maps.Scratcher
+
+       // Store returns a Scratch that can be used to store temporary state.
+       // In contrast to Scratch(), this Scratch is not reset on server rebuilds.
+       Store() *maps.Scratch
+
        RelatedKeywordsProvider
 
        // GetTerms gets the terms of a given taxonomy,

diff --git a/resources/page/page_nop.go b/resources/page/page_nop.go
index 011fabfc05cdd10bcffc3b1c77dc55293e2bebcf..fd706f99405b0a69daff3d8576c7012fe427de8c 100644 (file)
--- a/resources/page/page_nop.go
+++ b/resources/page/page_nop.go
@@ -418,6 +418,10 @@ func (p *nopPage) Scratch() *maps.Scratch {
        return nil
 }
 
+func (p *nopPage) Store() *maps.Scratch {
+       return nil
+}
+
 func (p *nopPage) RelatedKeywords(cfg related.IndexConfig) ([]related.Keyword, error) {
        return nil, nil
 }

diff --git a/resources/page/testhelpers_test.go b/resources/page/testhelpers_test.go
index 57077ecf8710e90a96933709113294bc17508e15..df4e79db484003fcbccca503af64399ea52a629d 100644 (file)
--- a/resources/page/testhelpers_test.go
+++ b/resources/page/testhelpers_test.go
@@ -498,6 +498,10 @@ func (p *testPage) Scratch() *maps.Scratch {
        panic("not implemented")
 }
 
+func (p *testPage) Store() *maps.Scratch {
+       panic("not implemented")
+}
+
 func (p *testPage) RelatedKeywords(cfg related.IndexConfig) ([]related.Keyword, error) {
        v, err := p.Param(cfg.Name)
        if err != nil {