Fix some related content issues with content adapters

Fixes #13443

Author: bep

hugolib/page.go

@@ -151,6 +151,20 @@ func (p *pageState) Key() string {
 	return "page-" + strconv.FormatUint(p.pid, 10)
 }
 
+// RelatedKeywords implements the related.Document interface needed for fast page searches.
+func (p *pageState) RelatedKeywords(cfg related.IndexConfig) ([]related.Keyword, error) {
+	v, found, err := page.NamedPageMetaValue(p, cfg.Name)
+	if err != nil {
+		return nil, err
+	}
+
+	if !found {
+		return nil, nil
+	}
+
+	return cfg.ToKeywords(v)
+}
+
 func (p *pageState) resetBuildState() {
 	// Nothing to do for now.
 }

hugolib/page__common.go

@@ -68,7 +68,6 @@ type pageCommon struct {
 	page.PageMetaInternalProvider
 	page.Positioner
 	page.RawContentProvider
-	page.RelatedKeywordsProvider
 	page.RefProvider
 	page.ShortcodeInfoProvider
 	page.SitesProvider

hugolib/page__meta.go

@@ -27,8 +27,6 @@ import (
 	"github.com/gohugoio/hugo/markup/converter"
 	xmaps "golang.org/x/exp/maps"
 
-	"github.com/gohugoio/hugo/related"
-
 	"github.com/gohugoio/hugo/source"
 
 	"github.com/gohugoio/hugo/common/constants"
@@ -215,16 +213,6 @@ func (p *pageMeta) PathInfo() *paths.Path {
 	return p.pathInfo
 }
 
-// RelatedKeywords implements the related.Document interface needed for fast page searches.
-func (p *pageMeta) RelatedKeywords(cfg related.IndexConfig) ([]related.Keyword, error) {
-	v, err := p.Param(cfg.Name)
-	if err != nil {
-		return nil, err
-	}
-
-	return cfg.ToKeywords(v)
-}
-
 func (p *pageMeta) IsSection() bool {
 	return p.Kind() == kinds.KindSection
 }

hugolib/page__new.go

@@ -202,7 +202,6 @@ func (h *HugoSites) doNewPage(m *pageMeta) (*pageState, *paths.Path, error) {
 				ResourceParamsProvider:    m,
 				PageMetaProvider:          m,
 				PageMetaInternalProvider:  m,
-				RelatedKeywordsProvider:   m,
 				OutputFormatsProvider:     page.NopPage,
 				ResourceTypeProvider:      pageTypesProvider,
 				MediaTypeProvider:         pageTypesProvider,

hugolib/pagesfromdata/pagesfromgotmpl_integration_test.go

@@ -1,4 +1,4 @@
-// Copyright 2024 The Hugo Authors. All rights reserved.
+// Copyright 2025 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.
@@ -23,6 +23,7 @@ import (
 	"github.com/gohugoio/hugo/markup/asciidocext"
 	"github.com/gohugoio/hugo/markup/pandoc"
 	"github.com/gohugoio/hugo/markup/rst"
+	"github.com/gohugoio/hugo/related"
 )
 
 const filesPagesFromDataTempleBasic = `
@@ -73,10 +74,11 @@ Pfile Content
 {{ $title := printf "%s:%s" $pd $pp }}
 {{ $date := "2023-03-01" | time.AsTime }}
 {{ $dates := dict "date" $date }}
+{{ $keywords := slice "foo" "Bar"}}
 {{ $contentMarkdown := dict "value" "**Hello World**"  "mediaType" "text/markdown" }}
 {{ $contentMarkdownDefault := dict "value" "**Hello World Default**" }}
 {{ $contentHTML := dict "value" "<b>Hello World!</b> No **markdown** here." "mediaType" "text/html" }}
-{{ $.AddPage  (dict "kind" "page" "path" "P1" "title" $title "dates" $dates "content" $contentMarkdown "params" (dict "param1" "param1v" ) ) }}
+{{ $.AddPage  (dict "kind" "page" "path" "P1" "title" $title "dates" $dates "keywords" $keywords "content" $contentMarkdown "params" (dict "param1" "param1v" ) ) }}
 {{ $.AddPage  (dict "kind" "page" "path" "p2" "title" "p2title" "dates" $dates "content" $contentHTML ) }}
 {{ $.AddPage  (dict "kind" "page" "path" "p3" "title" "p3title" "dates" $dates "content" $contentMarkdownDefault "draft" false ) }}
 {{ $.AddPage  (dict "kind" "page" "path" "p4" "title" "p4title" "dates" $dates "content" $contentMarkdownDefault "draft" $data.draft ) }}
@@ -329,6 +331,24 @@ func TestPagesFromGoTmplRemoveGoTmpl(t *testing.T) {
 	b.AssertFileContent("public/docs/index.html", "RegularPagesRecursive: pfile:/docs/pfile|$")
 }
 
+// Issue #13443.
+func TestPagesFromGoRelatedKeywords(t *testing.T) {
+	t.Parallel()
+	b := hugolib.Test(t, filesPagesFromDataTempleBasic)
+
+	p1 := b.H.Sites[0].RegularPages()[0]
+	icfg := related.IndexConfig{
+		Name: "keywords",
+	}
+	k, err := p1.RelatedKeywords(icfg)
+	b.Assert(err, qt.IsNil)
+	b.Assert(k, qt.DeepEquals, icfg.StringsToKeywords("foo", "Bar"))
+	icfg.Name = "title"
+	k, err = p1.RelatedKeywords(icfg)
+	b.Assert(err, qt.IsNil)
+	b.Assert(k, qt.DeepEquals, icfg.StringsToKeywords("p1:p1"))
+}
+
 func TestPagesFromGoTmplLanguagePerFile(t *testing.T) {
 	filesTemplate := `
 -- hugo.toml --

related/inverted_index.go

@@ -582,6 +582,9 @@ func DecodeConfig(m maps.Params) (Config, error) {
 		}
 	}
 	for i := range c.Indices {
+		// Lower case name.
+		c.Indices[i].Name = strings.ToLower(c.Indices[i].Name)
+
 		icfg := c.Indices[i]
 		if icfg.Type == "" {
 			c.Indices[i].Type = TypeBasic

related/inverted_index_test.go

@@ -21,6 +21,7 @@ import (
 	"time"
 
 	qt "github.com/frankban/quicktest"
+	"github.com/gohugoio/hugo/config"
 )
 
 type testDoc struct {
@@ -249,6 +250,50 @@ func TestToKeywordsToLower(t *testing.T) {
 	})
 }
 
+func TestDecodeConfig(t *testing.T) {
+	c := qt.New(t)
+
+	configToml := `
+[related]
+  includeNewer = true
+  threshold = 32
+  toLower = false
+  [[related.indices]]
+    applyFilter = false
+    cardinalityThreshold = 0
+    name = 'KeyworDs'
+    pattern = ''
+    toLower = false
+    type = 'basic'
+    weight = 100
+  [[related.indices]]
+    applyFilter = true
+    cardinalityThreshold = 32
+    name = 'date'
+    pattern = ''
+    toLower = false
+    type = 'basic'
+    weight = 10
+  [[related.indices]]
+    applyFilter = false
+    cardinalityThreshold = 0
+    name = 'tags'
+    pattern = ''
+    toLower = false
+    type = 'fragments'
+    weight = 80
+`
+
+	m, err := config.FromConfigString(configToml, "toml")
+	c.Assert(err, qt.IsNil)
+	conf, err := DecodeConfig(m.GetParams("related"))
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(conf.IncludeNewer, qt.IsTrue)
+	first := conf.Indices[0]
+	c.Assert(first.Name, qt.Equals, "keywords")
+}
+
 func TestToKeywordsAnySlice(t *testing.T) {
 	c := qt.New(t)
 	var config IndexConfig

resources/page/page.go

@@ -180,6 +180,11 @@ type PageFragment interface {
 	resource.ResourceNameTitleProvider
 }
 
+type PageMetaResource interface {
+	PageMetaProvider
+	resource.Resource
+}
+
 // PageMetaProvider provides page metadata, typically provided via front matter.
 type PageMetaProvider interface {
 	// The 4 page dates
@@ -251,6 +256,68 @@ type PageMetaProvider interface {
 	Weight() int
 }
 
+// NamedPageMetaValue returns a named metadata value from a PageMetaResource.
+// This is currently only used to generate keywords for related content.
+// If nameLower is not one of the metadata interface methods, we
+// look in Params.
+func NamedPageMetaValue(p PageMetaResource, nameLower string) (any, bool, error) {
+	var (
+		v   any
+		err error
+	)
+
+	switch nameLower {
+	case "kind":
+		v = p.Kind()
+	case "bundletype":
+		v = p.BundleType()
+	case "mediatype":
+		v = p.MediaType()
+	case "section":
+		v = p.Section()
+	case "lang":
+		v = p.Lang()
+	case "aliases":
+		v = p.Aliases()
+	case "name":
+		v = p.Name()
+	case "keywords":
+		v = p.Keywords()
+	case "description":
+		v = p.Description()
+	case "title":
+		v = p.Title()
+	case "linktitle":
+		v = p.LinkTitle()
+	case "slug":
+		v = p.Slug()
+	case "date":
+		v = p.Date()
+	case "publishdate":
+		v = p.PublishDate()
+	case "expirydate":
+		v = p.ExpiryDate()
+	case "lastmod":
+		v = p.Lastmod()
+	case "draft":
+		v = p.Draft()
+	case "type":
+		v = p.Type()
+	case "layout":
+		v = p.Layout()
+	case "weight":
+		v = p.Weight()
+	default:
+		// Try params.
+		v, err = resource.Param(p, nil, nameLower)
+		if v == nil {
+			return nil, false, nil
+		}
+	}
+
+	return v, err == nil, err
+}
+
 // PageMetaInternalProvider provides internal page metadata.
 type PageMetaInternalProvider interface {
 	// This is for internal use only.