]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
Make the cache eviction logic for stale entities more robust
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Fri, 3 May 2024 09:04:57 +0000 (11:04 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sat, 4 May 2024 17:45:43 +0000 (19:45 +0200)
Fixes #12458

12 files changed:
cache/dynacache/dynacache.go
cache/dynacache/dynacache_test.go
hugolib/content_map_page.go
hugolib/page__content.go
hugolib/page__per_output.go
hugolib/rebuild_test.go
hugolib/rendershortcodes_test.go
hugolib/site_benchmark_new_test.go
resources/resource.go
resources/resource/resourcetypes.go
resources/transform.go
tpl/transform/unmarshal.go

index 87ef68f5be28e9c6ce50e5afed5d486788b51640..6190dd23481bc7bc9a8c1b9b3122a8b493f4ce90 100644 (file)
@@ -385,13 +385,37 @@ type Partition[K comparable, V any] struct {
 
 // GetOrCreate gets or creates a value for the given key.
 func (p *Partition[K, V]) GetOrCreate(key K, create func(key K) (V, error)) (V, error) {
+       v, err := p.doGetOrCreate(key, create)
+       if err != nil {
+               return p.zero, err
+       }
+       if resource.StaleVersion(v) > 0 {
+               p.c.Delete(key)
+               return p.doGetOrCreate(key, create)
+       }
+       return v, err
+}
+
+func (p *Partition[K, V]) doGetOrCreate(key K, create func(key K) (V, error)) (V, error) {
        v, _, err := p.c.GetOrCreate(key, create)
        return v, err
 }
 
+func (p *Partition[K, V]) GetOrCreateWitTimeout(key K, duration time.Duration, create func(key K) (V, error)) (V, error) {
+       v, err := p.doGetOrCreateWitTimeout(key, duration, create)
+       if err != nil {
+               return p.zero, err
+       }
+       if resource.StaleVersion(v) > 0 {
+               p.c.Delete(key)
+               return p.doGetOrCreateWitTimeout(key, duration, create)
+       }
+       return v, err
+}
+
 // GetOrCreateWitTimeout gets or creates a value for the given key and times out if the create function
 // takes too long.
-func (p *Partition[K, V]) GetOrCreateWitTimeout(key K, duration time.Duration, create func(key K) (V, error)) (V, error) {
+func (p *Partition[K, V]) doGetOrCreateWitTimeout(key K, duration time.Duration, create func(key K) (V, error)) (V, error) {
        resultch := make(chan V, 1)
        errch := make(chan error, 1)
 
@@ -448,7 +472,7 @@ func (p *Partition[K, V]) clearOnRebuild(changeset ...identity.Identity) {
 
        shouldDelete := func(key K, v V) bool {
                // We always clear elements marked as stale.
-               if resource.IsStaleAny(v) {
+               if resource.StaleVersion(v) > 0 {
                        return true
                }
 
@@ -503,8 +527,8 @@ func (p *Partition[K, V]) Keys() []K {
 
 func (p *Partition[K, V]) clearStale() {
        p.c.DeleteFunc(func(key K, v V) bool {
-               isStale := resource.IsStaleAny(v)
-               if isStale {
+               staleVersion := resource.StaleVersion(v)
+               if staleVersion > 0 {
                        p.trace.Log(
                                logg.StringFunc(
                                        func() string {
@@ -514,7 +538,7 @@ func (p *Partition[K, V]) clearStale() {
                        )
                }
 
-               return isStale
+               return staleVersion > 0
        })
 }
 
index 275e63f0be65efc66de38f0eec68efa07a4deab3..a58a8d94b53a7008e5498e690e1b9d9d1ceb3474 100644 (file)
@@ -29,12 +29,12 @@ var (
 )
 
 type testItem struct {
-       name    string
-       isStale bool
+       name         string
+       staleVersion uint32
 }
 
-func (t testItem) IsStale() bool {
-       return t.isStale
+func (t testItem) StaleVersion() uint32 {
+       return t.staleVersion
 }
 
 func (t testItem) IdentifierBase() string {
@@ -109,7 +109,7 @@ func newTestCache(t *testing.T) *Cache {
 
        p2.GetOrCreate("clearBecauseStale", func(string) (testItem, error) {
                return testItem{
-                       isStale: true,
+                       staleVersion: 32,
                }, nil
        })
 
@@ -121,7 +121,7 @@ func newTestCache(t *testing.T) *Cache {
 
        p2.GetOrCreate("clearNever", func(string) (testItem, error) {
                return testItem{
-                       isStale: false,
+                       staleVersion: 0,
                }, nil
        })
 
index 5a6b49c55d0ebf31b2430838f703170f208fb6b7..a0bff7472452498b9d87ec29bbf656ea9969093c 100644 (file)
@@ -824,10 +824,10 @@ func (s *contentNodeShifter) Insert(old, new contentNodeI) contentNodeI {
                if !ok {
                        panic(fmt.Sprintf("unknown type %T", new))
                }
-               if newp != old {
-                       resource.MarkStale(old)
-               }
                if vv.s.languagei == newp.s.languagei {
+                       if newp != old {
+                               resource.MarkStale(old)
+                       }
                        return new
                }
                is := make(contentNodeIs, s.numLanguages)
@@ -843,7 +843,6 @@ func (s *contentNodeShifter) Insert(old, new contentNodeI) contentNodeI {
                if oldp != newp {
                        resource.MarkStale(oldp)
                }
-
                vv[newp.s.languagei] = new
                return vv
        case *resourceSource:
@@ -852,6 +851,9 @@ func (s *contentNodeShifter) Insert(old, new contentNodeI) contentNodeI {
                        panic(fmt.Sprintf("unknown type %T", new))
                }
                if vv.LangIndex() == newp.LangIndex() {
+                       if vv != newp {
+                               resource.MarkStale(vv)
+                       }
                        return new
                }
                rs := make(resourceSources, s.numLanguages)
@@ -1064,7 +1066,7 @@ func (h *HugoSites) resolveAndClearStateForIdentities(
        )
 
        for _, id := range changes {
-               if staler, ok := id.(resource.Staler); ok && !staler.IsStale() {
+               if staler, ok := id.(resource.Staler); ok {
                        var msgDetail string
                        if p, ok := id.(*pageState); ok && p.File() != nil {
                                msgDetail = fmt.Sprintf(" (%s)", p.File().Filename())
index f10c25d7b8b368aa42fc1be947e698a5b86cef49..99ed824cd5d1dc7197a9e5e7f1f93b8cda20c570 100644 (file)
@@ -418,6 +418,8 @@ func (c *cachedContent) mustSource() []byte {
 
 func (c *contentParseInfo) contentSource(s resource.StaleInfo) ([]byte, error) {
        key := c.sourceKey
+       versionv := s.StaleVersion()
+
        v, err := c.h.cacheContentSource.GetOrCreate(key, func(string) (*resources.StaleValue[[]byte], error) {
                b, err := c.readSourceAll()
                if err != nil {
@@ -426,8 +428,8 @@ func (c *contentParseInfo) contentSource(s resource.StaleInfo) ([]byte, error) {
 
                return &resources.StaleValue[[]byte]{
                        Value: b,
-                       IsStaleFunc: func() bool {
-                               return s.IsStale()
+                       StaleVersionFunc: func() uint32 {
+                               return s.StaleVersion() - versionv
                        },
                }, nil
        })
@@ -487,7 +489,7 @@ type contentPlainPlainWords struct {
 func (c *cachedContent) contentRendered(ctx context.Context, cp *pageContentOutput) (contentSummary, error) {
        ctx = tpl.Context.DependencyScope.Set(ctx, pageDependencyScopeGlobal)
        key := c.pi.sourceKey + "/" + cp.po.f.Name
-       versionv := cp.contentRenderedVersion
+       versionv := c.version(cp)
 
        v, err := c.pm.cacheContentRendered.GetOrCreate(key, func(string) (*resources.StaleValue[contentSummary], error) {
                cp.po.p.s.Log.Trace(logg.StringFunc(func() string {
@@ -504,8 +506,8 @@ func (c *cachedContent) contentRendered(ctx context.Context, cp *pageContentOutp
                }
 
                rs := &resources.StaleValue[contentSummary]{
-                       IsStaleFunc: func() bool {
-                               return c.IsStale() || cp.contentRenderedVersion != versionv
+                       StaleVersionFunc: func() uint32 {
+                               return c.version(cp) - versionv
                        },
                }
 
@@ -607,7 +609,7 @@ var setGetContentCallbackInContext = hcontext.NewContextDispatcher[func(*pageCon
 
 func (c *cachedContent) contentToC(ctx context.Context, cp *pageContentOutput) (contentTableOfContents, error) {
        key := c.pi.sourceKey + "/" + cp.po.f.Name
-       versionv := cp.contentRenderedVersion
+       versionv := c.version(cp)
 
        v, err := c.pm.contentTableOfContents.GetOrCreate(key, func(string) (*resources.StaleValue[contentTableOfContents], error) {
                source, err := c.pi.contentSource(c)
@@ -713,8 +715,8 @@ func (c *cachedContent) contentToC(ctx context.Context, cp *pageContentOutput) (
 
                return &resources.StaleValue[contentTableOfContents]{
                        Value: ct,
-                       IsStaleFunc: func() bool {
-                               return c.IsStale() || cp.contentRenderedVersion != versionv
+                       StaleVersionFunc: func() uint32 {
+                               return c.version(cp) - versionv
                        },
                }, nil
        })
@@ -725,16 +727,21 @@ func (c *cachedContent) contentToC(ctx context.Context, cp *pageContentOutput) (
        return v.Value, nil
 }
 
+func (c *cachedContent) version(cp *pageContentOutput) uint32 {
+       // Both of these gets incremented on change.
+       return c.StaleVersion() + cp.contentRenderedVersion
+}
+
 func (c *cachedContent) contentPlain(ctx context.Context, cp *pageContentOutput) (contentPlainPlainWords, error) {
        key := c.pi.sourceKey + "/" + cp.po.f.Name
 
-       versionv := cp.contentRenderedVersion
+       versionv := c.version(cp)
 
        v, err := c.pm.cacheContentPlain.GetOrCreateWitTimeout(key, cp.po.p.s.Conf.Timeout(), func(string) (*resources.StaleValue[contentPlainPlainWords], error) {
                var result contentPlainPlainWords
                rs := &resources.StaleValue[contentPlainPlainWords]{
-                       IsStaleFunc: func() bool {
-                               return c.IsStale() || cp.contentRenderedVersion != versionv
+                       StaleVersionFunc: func() uint32 {
+                               return c.version(cp) - versionv
                        },
                }
 
index 2adb5cbb7d7bab81b104dcbfc9cda26fcd6b3d67..6b4b8f55ed96cc826b4b74c5f5386f7de47f5fdf 100644 (file)
@@ -89,8 +89,8 @@ type pageContentOutput struct {
        // typically included with .RenderShortcodes.
        otherOutputs map[uint64]*pageContentOutput
 
-       contentRenderedVersion int  // Incremented on reset.
-       contentRendered        bool // Set on content render.
+       contentRenderedVersion uint32 // Incremented on reset.
+       contentRendered        bool   // Set on content render.
 
        // Renders Markdown hooks.
        renderHooks *renderHooks
index 542810b64f6a8cfafafe55d03a2e7c79b10500e0..0db418ee1d539a1e464ff7c81d902a4465e88950 100644 (file)
@@ -53,6 +53,11 @@ title: "Home"
 Home Content.
 -- content/hometext.txt --
 Home Text Content.
+-- content/myothersection/myothersectionpage.md --
+---
+title: "myothersectionpage"
+---
+myothersectionpage Content.
 -- layouts/_default/single.html --
 Single: {{ .Title }}|{{ .Content }}$
 Resources: {{ range $i, $e := .Resources }}{{ $i }}:{{ .RelPermalink }}|{{ .Content }}|{{ end }}$
@@ -135,8 +140,8 @@ func TestRebuildRenameTextFileInLeafBundle(t *testing.T) {
 
                b.RenameFile("content/mysection/mysectionbundle/mysectionbundletext.txt", "content/mysection/mysectionbundle/mysectionbundletext2.txt").Build()
                b.AssertFileContent("public/mysection/mysectionbundle/index.html", "mysectionbundletext2", "My Section Bundle Text 2 Content.", "Len Resources: 2|")
-               b.AssertRenderCountPage(3)
-               b.AssertRenderCountContent(3)
+               b.AssertRenderCountPage(5)
+               b.AssertRenderCountContent(6)
        })
 }
 
@@ -147,6 +152,19 @@ func TestRebuilEditContentFileInLeafBundle(t *testing.T) {
        b.AssertFileContent("public/mysection/mysectionbundle/index.html", "My Section Bundle Content Content Edited.")
 }
 
+func TestRebuilEditContentFileThenAnother(t *testing.T) {
+       b := TestRunning(t, rebuildFilesSimple)
+       b.EditFileReplaceAll("content/mysection/mysectionbundle/mysectionbundlecontent.md", "Content Content.", "Content Content Edited.").Build()
+       b.AssertFileContent("public/mysection/mysectionbundle/index.html", "My Section Bundle Content Content Edited.")
+       b.AssertRenderCountPage(1)
+       b.AssertRenderCountContent(2)
+
+       b.EditFileReplaceAll("content/myothersection/myothersectionpage.md", "myothersectionpage Content.", "myothersectionpage Content Edited.").Build()
+       b.AssertFileContent("public/myothersection/myothersectionpage/index.html", "myothersectionpage Content Edited")
+       b.AssertRenderCountPage(1)
+       b.AssertRenderCountContent(1)
+}
+
 func TestRebuildRenameTextFileInBranchBundle(t *testing.T) {
        b := TestRunning(t, rebuildFilesSimple)
        b.AssertFileContent("public/mysection/index.html", "My Section")
@@ -163,7 +181,7 @@ func TestRebuildRenameTextFileInHomeBundle(t *testing.T) {
 
        b.RenameFile("content/hometext.txt", "content/hometext2.txt").Build()
        b.AssertFileContent("public/index.html", "hometext2", "Home Text Content.")
-       b.AssertRenderCountPage(2)
+       b.AssertRenderCountPage(3)
 }
 
 func TestRebuildRenameDirectoryWithLeafBundle(t *testing.T) {
@@ -179,7 +197,7 @@ func TestRebuildRenameDirectoryWithBranchBundle(t *testing.T) {
        b.AssertFileContent("public/mysectionrenamed/index.html", "My Section")
        b.AssertFileContent("public/mysectionrenamed/mysectionbundle/index.html", "My Section Bundle")
        b.AssertFileContent("public/mysectionrenamed/mysectionbundle/mysectionbundletext.txt", "My Section Bundle Text 2 Content.")
-       b.AssertRenderCountPage(2)
+       b.AssertRenderCountPage(3)
 }
 
 func TestRebuildRenameDirectoryWithRegularPageUsedInHome(t *testing.T) {
@@ -278,7 +296,7 @@ func TestRebuildRenameDirectoryWithBranchBundleFastRender(t *testing.T) {
        b.AssertFileContent("public/mysectionrenamed/index.html", "My Section")
        b.AssertFileContent("public/mysectionrenamed/mysectionbundle/index.html", "My Section Bundle")
        b.AssertFileContent("public/mysectionrenamed/mysectionbundle/mysectionbundletext.txt", "My Section Bundle Text 2 Content.")
-       b.AssertRenderCountPage(2)
+       b.AssertRenderCountPage(3)
 }
 
 func TestRebuilErrorRecovery(t *testing.T) {
index 67b1a85ef6376a58c3f7b6bd24d1766ad96b2b82..313c80a73fc02c62e5e6250ddfbccc3203d1c7d9 100644 (file)
@@ -201,6 +201,43 @@ Myshort Original.
        b.AssertFileContent("public/p1/index.html", "Edited")
 }
 
+func TestRenderShortcodesEditSectionContentWithShortcodeInIncludedPageIssue12458(t *testing.T) {
+       t.Parallel()
+
+       files := `
+-- hugo.toml --
+disableLiveReload = true
+disableKinds = ["home", "taxonomy", "term", "rss", "sitemap", "robotsTXT", "404"]
+-- content/mysection/_index.md --
+---
+title: "My Section"
+---
+## p1-h1
+{{% include "p2" %}}
+-- content/mysection/p2.md --
+---
+title: "p2"
+---
+### Original
+{{% myshort %}}
+-- layouts/shortcodes/include.html --
+{{ $p := .Page.GetPage (.Get 0) }}
+{{ $p.RenderShortcodes }}
+-- layouts/shortcodes/myshort.html --
+Myshort Original.
+-- layouts/_default/list.html --
+ {{ .Content }}
+
+
+
+`
+       b := TestRunning(t, files)
+
+       b.AssertFileContent("public/mysection/index.html", "p1-h1")
+       b.EditFileReplaceAll("content/mysection/_index.md", "p1-h1", "p1-h1 Edited").Build()
+       b.AssertFileContent("public/mysection/index.html", "p1-h1 Edited")
+}
+
 func TestRenderShortcodesNestedPageContextIssue12356(t *testing.T) {
        t.Parallel()
 
index c028ca526fd076770c136e6113f54beaf9845d08..023d8e4d5f96c6df170c2261892385c2a7adbd99 100644 (file)
@@ -487,7 +487,7 @@ Edited!!`, p.Title()))
 
        // We currently rebuild all the language versions of the same content file.
        // We could probably optimize that case, but it's not trivial.
-       b.Assert(int(counters.contentRenderCounter.Load()), qt.Equals, 33)
+       b.Assert(int(counters.contentRenderCounter.Load()), qt.Equals, 4)
        b.AssertFileContent("public"+p.RelPermalink()+"index.html", "Edited!!")
 }
 
index 867b262fb02efc95a285c3584b5acbcbfa3388d4..0fee69cdd3445e618e9bdd9b27d2220d9bcf3574 100644 (file)
@@ -296,16 +296,19 @@ type hashProvider interface {
        hash() string
 }
 
+var _ resource.StaleInfo = (*StaleValue[any])(nil)
+
 type StaleValue[V any] struct {
        // The value.
        Value V
 
-       // IsStaleFunc reports whether the value is stale.
-       IsStaleFunc func() bool
+       // StaleVersionFunc reports the current version of the value.
+       // This always starts out at 0 and get incremented on staleness.
+       StaleVersionFunc func() uint32
 }
 
-func (s *StaleValue[V]) IsStale() bool {
-       return s.IsStaleFunc()
+func (s *StaleValue[V]) StaleVersion() uint32 {
+       return s.StaleVersionFunc()
 }
 
 type AtomicStaler struct {
@@ -313,11 +316,11 @@ type AtomicStaler struct {
 }
 
 func (s *AtomicStaler) MarkStale() {
-       atomic.StoreUint32(&s.stale, 1)
+       atomic.AddUint32(&s.stale, 1)
 }
 
-func (s *AtomicStaler) IsStale() bool {
-       return atomic.LoadUint32(&(s.stale)) > 0
+func (s *AtomicStaler) StaleVersion() uint32 {
+       return atomic.LoadUint32(&(s.stale))
 }
 
 // For internal use.
index 0766fe232c145c85880f5413ee91f17ec19138a4..5d9533223e21b19c45016012811b94a813384762 100644 (file)
@@ -233,17 +233,27 @@ type StaleMarker interface {
 
 // StaleInfo tells if a resource is marked as stale.
 type StaleInfo interface {
-       IsStale() bool
+       StaleVersion() uint32
 }
 
-// IsStaleAny reports whether any of the os is marked as stale.
-func IsStaleAny(os ...any) bool {
-       for _, o := range os {
-               if s, ok := o.(StaleInfo); ok && s.IsStale() {
-                       return true
+// StaleVersion returns the StaleVersion for the given os,
+// or 0 if not set.
+func StaleVersion(os any) uint32 {
+       if s, ok := os.(StaleInfo); ok {
+               return s.StaleVersion()
+       }
+       return 0
+}
+
+// StaleVersionSum calculates the sum of the StaleVersionSum for the given oss.
+func StaleVersionSum(oss ...any) uint32 {
+       var version uint32
+       for _, o := range oss {
+               if s, ok := o.(StaleInfo); ok && s.StaleVersion() > 0 {
+                       version += s.StaleVersion()
                }
        }
-       return false
+       return version
 }
 
 // MarkStale will mark any of the oses as stale, if possible.
index d9084b178ea3675129749f1df5a62e3b3fc152cc..b498924f584c3c82cf4d17d0fc245cc92f534bdd 100644 (file)
@@ -657,8 +657,9 @@ type resourceAdapterInner struct {
        *publishOnce
 }
 
-func (r *resourceAdapterInner) IsStale() bool {
-       return r.Staler.IsStale() || r.target.IsStale()
+func (r *resourceAdapterInner) StaleVersion() uint32 {
+       // Both of these are incremented on change.
+       return r.Staler.StaleVersion() + r.target.StaleVersion()
 }
 
 type resourceTransformations struct {
index d876c88d7d363ed3719ff64b8e7ac9daf0252693..dc9029c8d671c02dd267584c24a24d6ca9896143 100644 (file)
@@ -95,8 +95,8 @@ func (ns *Namespace) Unmarshal(args ...any) (any, error) {
 
                        return &resources.StaleValue[any]{
                                Value: v,
-                               IsStaleFunc: func() bool {
-                                       return resource.IsStaleAny(r)
+                               StaleVersionFunc: func() uint32 {
+                                       return resource.StaleVersion(r)
                                },
                        }, nil
                })
@@ -132,8 +132,8 @@ func (ns *Namespace) Unmarshal(args ...any) (any, error) {
 
                return &resources.StaleValue[any]{
                        Value: v,
-                       IsStaleFunc: func() bool {
-                               return false
+                       StaleVersionFunc: func() uint32 {
+                               return 0
                        },
                }, nil
        })