Backtestshugorun-20261024-162305#15199
related: Add option to tokenize headings
Our patch was judged better than the merged fix.
In this judgment, Patch A = our agent, Patch B = the merged fix.
Patch A implements exactly what the issue specifies: `tokenize` only affects heading titles in `fragments` indices (the tokenizing helper is only invoked inside the `TypeFragments` branch), heading identifiers are still indexed as `FragmentKeyword` alongside new `FragmentTokenKeyword` tokens, so exact-identifier matching (e.g. `pagerefs: ['something-else']`) keeps working with tokenize on, and definition terms are untouched. It strips HTML tags and unescapes entities before splitting (heading titles like `Running <em>hugo</em>` tokenize correctly), respects `ToLower`, dedups tokens per document, and extends the `applyFilter` path with a distinct keyword type so filtered headings are computed by re-tokenizing titles. It adds docs, a config-decode assertion, a unit test for the tokenizer, and an integration test covering on/off, HTML in headings, definition terms, and exact-ID matching. Patch B diverges from the spec and has correctness bugs. It applies tokenization to basic indices via `ToKeywords` (string and []string), contradicting "Currently applies to heading titles in indices of type `fragments`"; the independent test TestBtJudgeTokenizeScopedToFragmentsIndices fails on B for exactly this reason. When tokenize is on it `continue`s past the heading identifier, so headings are no longer indexed by ID, breaking cross-page exact-identifier references on that index. Tokens are produced via `stringToKeyword` (a `StringKeyword`), yet the applyFilter branch only collects words from `kw.(FragmentKeyword)`, so `ff.words` is never populated and heading filtering silently stops working with tokenize enabled; B's own TestRelatedFragmentsTokenizeApplyFilter appears unable to pass as written. `splitWords` does not strip HTML tags, so a title containing `<em>hugo</em>` yields a garbage token like `em>hugo</em`. B also adds an unrequested `minTokenLength` option and no documentation, and includes whitespace churn in existing tests. On correctness, scope, and tests A is clearly better; the one independent test that separates them does so for a reason the issue explicitly states.
Four judges ruled on this ticket in parallel, and the verdict comes from counting their votes. Each saw the issue and the two patches, labelled A and B in random order (two of them saw ours as A), with issue links and version numbers removed. Where tests could check the fix, they also saw the results of tests a separate agent wrote for the issue, run on both patches. None was told which patch was ours. The reasoning above is one judge's, shown verbatim.
Solve
1h 4m
Wall-clock time in the container
Full test suite
No new failures
900 passed · 1 skipped · 906 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
210vs 462 merged
Changed lines, ours vs merged
The issue
View on GitHubSee <https://discourse.gohugo.io/t/related-posts-based-on-heading/57467>.
I suggest using the name tokenize, documented as follows:
(
bool) Whether to split multi-word values into individual keywords for indexing and matching. Currently applies to heading titles in indices of typefragments; non-heading fragments such as definition terms continue to use exact-identifier matching regardless of this setting. This increases index size in proportion to the average number of words per heading; usecardinalityThresholdto prune common words and reduce build time. Default isfalse.
The two patches
docs/content/en/configuration/related-content.mdindex 92cf92e8a..496c33b08 100644@@ -48,6 +48,9 @@ This is the default configuration: `toLower` : (`bool`) Whether to transform keywords in both the indexes and the queries to lower case. This may give more accurate results at a slight performance penalty. Default is `false`. +`tokenize`+: (`bool`) Whether to split multi-word values into individual keywords for indexing and matching. Currently applies to heading titles in indices of type `fragments`; non-heading fragments such as definition terms continue to use exact-identifier matching regardless of this setting. This increases index size in proportion to the average number of words per heading; use `cardinalityThreshold` to prune common words and reduce build time. Default is `false`.+ `type` : (`string`) One of `basic` or `fragments`. Default is `basic`. related/inverted_index.goindex c6c65d97f..9378eee77 100644@@ -18,12 +18,14 @@ import ( "context" "errors" "fmt"+ "html" "maps" "math" "sort" "strings" "sync" "time"+ "unicode" "github.com/gohugoio/hugo/common/collections" "github.com/gohugoio/hugo/common/hmaps"@@ -125,6 +127,12 @@ type IndexConfig struct { // Will lower case all string values in and queries tothis index. // May get better accurate results, but at a slight performance cost. ToLower bool++ // Whether to split multi-word values into individual keywords for indexing and matching.+ // Currently applies to heading titles in indices of type "fragments";+ // non-heading fragments such as definition terms continue to use+ // exact-identifier matching regardless of this setting.+ Tokenize bool } // Document is the interface an indexable document in Hugo must fulfill.@@ -220,9 +228,9 @@ func (idx *InvertedIndex) Add(ctx context.Context, docs ...Document) error { if config.Type == TypeFragments { if fp, ok := doc.(FragmentProvider); ok {- for _, fragment := range fp.Fragments(ctx).Identifiers {+ for _, keyword := range config.fragmentsToKeywords(fp.Fragments(ctx)) { added = true- setm[FragmentKeyword(fragment)] = append(setm[FragmentKeyword(fragment)], doc)+ setm[keyword] = append(setm[keyword], doc) } } }@@ -377,9 +385,7 @@ func (idx *InvertedIndex) Search(ctx context.Context, opts SearchOpts) ([]Docume } if opts.Document != nil { if fp, ok := opts.Document.(FragmentProvider); ok {- for _, fragment := range fp.Fragments(ctx).Identifiers {- keywords = append(keywords, FragmentKeyword(fragment))- }+ keywords = append(keywords, cfg.fragmentsToKeywords(fp.Fragments(ctx))...) } } @@ -423,6 +429,74 @@ func (cfg IndexConfig) stringToKeyword(s string) Keyword { return StringKeyword(s) } +// fragmentsToKeywords returns the keywords to index and match for the given fragments.+// All fragment identifiers are returned as FragmentKeyword.+// If Tokenize is enabled, the words in each heading title are also returned+// as FragmentTokenKeyword, each word only once.+func (cfg IndexConfig) fragmentsToKeywords(fragments *tableofcontents.Fragments) []Keyword {+ if fragments == nil {+ return nil+ }+ keywords := make([]Keyword, 0, len(fragments.Identifiers))+ for _, id := range fragments.Identifiers {+ keywords = append(keywords, FragmentKeyword(id))+ }+ if !cfg.Tokenize {+ return keywords+ }++ seen := make(map[string]bool)+ // Only headings are tokenized; other fragments, e.g. definition terms,+ // are matched by their identifier only.+ headings := fragments.Headings.FilterBy(func(*tableofcontents.Heading) bool { return true })+ for _, h := range headings {+ for _, token := range cfg.tokenizeHeadingTitle(h.Title) {+ if seen[token] {+ continue+ }+ seen[token] = true+ keywords = append(keywords, FragmentTokenKeyword(token))+ }+ }++ return keywords+}++// tokenizeHeadingTitle splits the given heading title into words.+// Any HTML tags are removed and HTML entities unescaped before splitting+// on all characters that are not letters, marks or numbers.+func (cfg IndexConfig) tokenizeHeadingTitle(title string) []string {+ s := html.UnescapeString(stripHTMLTags(title))+ if cfg.ToLower {+ s = strings.ToLower(s)+ }+ return strings.FieldsFunc(s, func(r rune) bool {+ return !unicode.IsLetter(r) && !unicode.IsMark(r) && !unicode.IsNumber(r)+ })+}++// stripHTMLTags replaces any HTML tags in s with a space.+func stripHTMLTags(s string) string {+ if strings.IndexByte(s, '<') == -1 {+ return s+ }+ var b strings.Builder+ b.Grow(len(s))+ inTag := false+ for _, r := range s {+ switch {+ case r == '<':+ inTag = true+ case r == '>' && inTag:+ inTag = false+ b.WriteRune(' ')+ case !inTag:+ b.WriteRune(r)+ }+ }+ return b.String()+}+ // ToKeywords returns a Keyword slice of the given input. func (cfg IndexConfig) ToKeywords(v any) ([]Keyword, error) { var keywords []Keyword@@ -467,6 +541,9 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa applyDateFilter := !idx.cfg.IncludeNewer && !upperDate.IsZero() var fragmentsFilter collections.SortedStringSlice+ // Matched heading title tokens, keyed by the ToLower setting of the index+ // they were matched in, so heading titles can be tokenized the same way when filtering.+ var fragmentTokensFilter map[bool]map[string]bool for _, el := range query { setm, found := idx.index[el.Index]@@ -494,8 +571,17 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa } if config.Type == TypeFragments && config.ApplyFilter {- if fkw, ok := kw.(FragmentKeyword); ok {+ switch fkw := kw.(type) {+ case FragmentKeyword: fragmentsFilter = append(fragmentsFilter, string(fkw))+ case FragmentTokenKeyword:+ if fragmentTokensFilter == nil {+ fragmentTokensFilter = make(map[bool]map[string]bool)+ }+ if fragmentTokensFilter[config.ToLower] == nil {+ fragmentTokensFilter[config.ToLower] = make(map[string]bool)+ }+ fragmentTokensFilter[config.ToLower][string(fkw)] = true } } @@ -535,10 +621,20 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa for i, m := range matches { result[i] = m.Doc - if len(fragmentsFilter) > 0 {+ if len(fragmentsFilter) > 0 || len(fragmentTokensFilter) > 0 { if dp, ok := result[i].(FragmentProvider); ok { result[i] = dp.ApplyFilterToHeadings(ctx, func(h *tableofcontents.Heading) bool {- return fragmentsFilter.Contains(h.ID)+ if fragmentsFilter.Contains(h.ID) {+ return true+ }+ for toLower, tokens := range fragmentTokensFilter {+ for _, token := range (IndexConfig{ToLower: toLower}).tokenizeHeadingTitle(h.Title) {+ if tokens[token] {+ return true+ }+ }+ }+ return false }) } }@@ -613,6 +709,14 @@ func (f FragmentKeyword) String() string { return string(f) } +// FragmentTokenKeyword represents a word in a document fragment's title,+// used for indices of type "fragments" with Tokenize enabled.+type FragmentTokenKeyword string++func (f FragmentTokenKeyword) String() string {+ return string(f)+}+ // Keyword is the interface a keyword in the search index must implement. type Keyword interface { String() stringrelated/inverted_index_test.goindex b33d42955..95cb88e60 100644@@ -283,6 +283,7 @@ func TestDecodeConfig(t *testing.T) { pattern = '' toLower = false type = 'fragments'+ tokenize = true weight = 80 ` @@ -294,6 +295,22 @@ func TestDecodeConfig(t *testing.T) { c.Assert(conf.IncludeNewer, qt.IsTrue) first := conf.Indices[0] c.Assert(first.Name, qt.Equals, "keywords")+ c.Assert(first.Tokenize, qt.IsFalse)+ c.Assert(conf.Indices[2].Tokenize, qt.IsTrue)+}++func TestTokenizeHeadingTitle(t *testing.T) {+ c := qt.New(t)++ cfg := IndexConfig{Type: TypeFragments, Tokenize: true}+ c.Assert(cfg.tokenizeHeadingTitle("Installing Hugo on Linux"), qt.DeepEquals, []string{"Installing", "Hugo", "on", "Linux"})+ c.Assert(cfg.tokenizeHeadingTitle("Running <code>hugo</code>&friends, v0.150"), qt.DeepEquals, []string{"Running", "hugo", "friends", "v0", "150"})+ c.Assert(cfg.tokenizeHeadingTitle("<em>Ünïcode</em>-wörds"), qt.DeepEquals, []string{"Ünïcode", "wörds"})+ c.Assert(cfg.tokenizeHeadingTitle("Cafe\u0301 हिन्दी"), qt.DeepEquals, []string{"Cafe\u0301", "हिन्दी"})+ c.Assert(cfg.tokenizeHeadingTitle(""), qt.HasLen, 0)++ cfg.ToLower = true+ c.Assert(cfg.tokenizeHeadingTitle("Installing Hugo"), qt.DeepEquals, []string{"installing", "hugo"}) } func TestToKeywordsAnySlice(t *testing.T) {related/related_integration_test.goindex e1387d3c5..dedb810ce 100644@@ -186,3 +186,73 @@ keywords: ['k%d'] bb.Build() } }++func TestRelatedFragmentsTokenize(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+baseURL = "http://example.com/"+disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT"]+[markup.goldmark.parser]+autoDefinitionTermID = true+[related]+ includeNewer = true+ threshold = 20+ toLower = true+[[related.indices]]+ name = 'pagerefs'+ type = 'fragments'+ applyFilter = true+ tokenize = TOKENIZE+ weight = 100+-- content/p1.md --+---+title: p1+---+## Installing Hugo on Linux+-- content/p2.md --+---+title: p2+---+## Running *hugo* & friends++## Unrelated section+-- content/p3.md --+---+title: p3+---+## Something else+-- content/p4.md --+---+title: p4+---+Installing Hugo+: A definition term.+-- content/p5.md --+---+title: p5+pagerefs: ['something-else']+---+## Nothing+-- layouts/single.html --+{{ $related := site.RegularPages.Related . }}+Related: {{ range $related }}{{ .Title }}: {{ range .HeadingsFiltered }}{{ .Title }}|{{ end }};{{ end }}::END+`++ b := hugolib.Test(t, strings.ReplaceAll(files, "TOKENIZE", "true"))++ // p1 and p2 share the word "hugo" in their heading titles.+ b.AssertFileContent("public/p1/index.html", "Related: p2: Running <em>hugo</em> &amp; friends|;::END")+ b.AssertFileContent("public/p2/index.html", "Related: p1: Installing Hugo on Linux|;::END")+ // Definition terms are not tokenized, so "Installing Hugo" in p4 matches nothing.+ b.AssertFileContent("public/p4/index.html", "Related: ::END")+ // Exact identifier matching still works.+ b.AssertFileContent("public/p5/index.html", "Related: p3: Something else|;::END")++ b = hugolib.Test(t, strings.ReplaceAll(files, "TOKENIZE", "false"))++ b.AssertFileContent("public/p1/index.html", "Related: ::END")+ b.AssertFileContent("public/p2/index.html", "Related: ::END")+ b.AssertFileContent("public/p5/index.html", "Related: p3: Something else|;::END")+}
related/inverted_index.goindex c6c65d97f..568880107 100644@@ -18,12 +18,15 @@ import ( "context" "errors" "fmt"+ "html" "maps" "math" "sort" "strings" "sync" "time"+ "unicode"+ "unicode/utf8" "github.com/gohugoio/hugo/common/collections" "github.com/gohugoio/hugo/common/hmaps"@@ -122,9 +125,15 @@ type IndexConfig struct { // used in more than 50% of the documents in the index. CardinalityThreshold int - // Will lower case all string values in and queries tothis index.+ // Will lower case all string values in and queries to this index. // May get better accurate results, but at a slight performance cost. ToLower bool++ // Whether to split multi-word values into individual keywords.+ Tokenize bool++ // Minimum token length in Unicode code points when tokenizing.+ MinTokenLength int } // Document is the interface an indexable document in Hugo must fulfill.@@ -220,8 +229,24 @@ func (idx *InvertedIndex) Add(ctx context.Context, docs ...Document) error { if config.Type == TypeFragments { if fp, ok := doc.(FragmentProvider); ok {- for _, fragment := range fp.Fragments(ctx).Identifiers {+ frags := fp.Fragments(ctx)+ seenKW := make(map[Keyword]bool)+ for _, fragment := range frags.Identifiers { added = true+ if config.Tokenize {+ if h, found := frags.HeadingsMap[fragment]; found {+ for _, word := range splitWords(h.Title) {+ if !config.shouldSkipToken(word) {+ kw := config.stringToKeyword(word)+ if !seenKW[kw] {+ seenKW[kw] = true+ setm[kw] = append(setm[kw], doc)+ }+ }+ }+ continue+ }+ } setm[FragmentKeyword(fragment)] = append(setm[FragmentKeyword(fragment)], doc) } }@@ -377,7 +402,23 @@ func (idx *InvertedIndex) Search(ctx context.Context, opts SearchOpts) ([]Docume } if opts.Document != nil { if fp, ok := opts.Document.(FragmentProvider); ok {- for _, fragment := range fp.Fragments(ctx).Identifiers {+ frags := fp.Fragments(ctx)+ seenKW := make(map[Keyword]bool)+ for _, fragment := range frags.Identifiers {+ if cfg.Tokenize {+ if h, found := frags.HeadingsMap[fragment]; found {+ for _, word := range splitWords(h.Title) {+ if !cfg.shouldSkipToken(word) {+ kw := cfg.stringToKeyword(word)+ if !seenKW[kw] {+ seenKW[kw] = true+ keywords = append(keywords, kw)+ }+ }+ }+ continue+ }+ } keywords = append(keywords, FragmentKeyword(fragment)) } }@@ -423,19 +464,41 @@ func (cfg IndexConfig) stringToKeyword(s string) Keyword { return StringKeyword(s) } +func (cfg IndexConfig) shouldSkipToken(word string) bool {+ return cfg.MinTokenLength > 0 && utf8.RuneCountInString(word) < cfg.MinTokenLength+}+ // ToKeywords returns a Keyword slice of the given input. func (cfg IndexConfig) ToKeywords(v any) ([]Keyword, error) { var keywords []Keyword switch vv := v.(type) { case string:- keywords = append(keywords, cfg.stringToKeyword(vv))+ if cfg.Tokenize {+ for _, word := range splitWords(vv) {+ if !cfg.shouldSkipToken(word) {+ keywords = append(keywords, cfg.stringToKeyword(word))+ }+ }+ } else {+ keywords = append(keywords, cfg.stringToKeyword(vv))+ } case []string:- vvv := make([]Keyword, len(vv))- for i := range vvv {- vvv[i] = cfg.stringToKeyword(vv[i])+ if !cfg.Tokenize {+ kw := make([]Keyword, len(vv))+ for i, s := range vv {+ kw[i] = cfg.stringToKeyword(s)+ }+ keywords = append(keywords, kw...)+ } else {+ for _, s := range vv {+ for _, word := range splitWords(s) {+ if !cfg.shouldSkipToken(word) {+ keywords = append(keywords, cfg.stringToKeyword(word))+ }+ }+ } }- keywords = append(keywords, vvv...) case []any: return cfg.ToKeywords(cast.ToStringSlice(vv)) case time.Time:@@ -466,7 +529,12 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa }() applyDateFilter := !idx.cfg.IncludeNewer && !upperDate.IsZero()- var fragmentsFilter collections.SortedStringSlice+ // Bundled into one struct so the closure below causes only one heap escape.+ var ff struct {+ ids collections.SortedStringSlice+ words collections.SortedStringSlice+ toLower bool+ } for _, el := range query { setm, found := idx.index[el.Index]@@ -479,6 +547,10 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa return []Document{}, fmt.Errorf("index config for %q not found", el.Index) } + if config.Type == TypeFragments && config.ApplyFilter && config.Tokenize {+ ff.toLower = config.ToLower+ }+ for _, kw := range el.Keywords { if docs, found := setm[kw]; found { for _, doc := range docs {@@ -495,10 +567,13 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa if config.Type == TypeFragments && config.ApplyFilter { if fkw, ok := kw.(FragmentKeyword); ok {- fragmentsFilter = append(fragmentsFilter, string(fkw))+ if config.Tokenize {+ ff.words = append(ff.words, string(fkw))+ } else {+ ff.ids = append(ff.ids, string(fkw))+ } } }- r, found := matchm[doc] if !found { r = getRank(doc, config.Weight)@@ -528,17 +603,31 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa } sort.Stable(matches)- sort.Strings(fragmentsFilter)+ sort.Strings(ff.ids)+ sort.Strings(ff.words) result := make([]Document, len(matches)) for i, m := range matches { result[i] = m.Doc - if len(fragmentsFilter) > 0 {+ if len(ff.ids) > 0 || len(ff.words) > 0 { if dp, ok := result[i].(FragmentProvider); ok { result[i] = dp.ApplyFilterToHeadings(ctx, func(h *tableofcontents.Heading) bool {- return fragmentsFilter.Contains(h.ID)+ if ff.ids.Contains(h.ID) {+ return true+ }+ if len(ff.words) > 0 {+ for _, word := range splitWords(h.Title) {+ if ff.toLower {+ word = strings.ToLower(word)+ }+ if ff.words.Contains(word) {+ return true+ }+ }+ }+ return false }) } }@@ -618,6 +707,31 @@ type Keyword interface { String() string } +// splitWords splits s into normalized words, stripping HTML entities and+// leading/trailing punctuation from each word.+func splitWords(title string) []string {+ // Fast path: no whitespace or HTML entities means at most one token.+ if strings.IndexFunc(title, unicode.IsSpace) == -1 && strings.IndexByte(title, '&') == -1 {+ title = strings.TrimFunc(html.UnescapeString(title), func(r rune) bool { return !unicode.IsLetter(r) && !unicode.IsDigit(r) })+ if title == "" {+ return nil+ }+ return []string{title}+ }+ raw := strings.Fields(html.UnescapeString(title))+ words := raw[:0]+ for _, w := range raw {+ w = strings.TrimFunc(w, func(r rune) bool { return !unicode.IsLetter(r) && !unicode.IsDigit(r) })+ if w != "" {+ words = append(words, w)+ }+ }+ if len(words) == 0 {+ return nil+ }+ return words+}+ // StringsToKeywords converts the given slice of strings to a slice of Keyword. func (cfg IndexConfig) StringsToKeywords(s ...string) []Keyword { kw := make([]Keyword, len(s))related/inverted_index_test.goindex b33d42955..6bb561112 100644@@ -309,6 +309,38 @@ func TestToKeywordsAnySlice(t *testing.T) { }) } +func TestSplitWords(t *testing.T) {+ c := qt.New(t)++ tests := []struct {+ in string+ want []string+ }{+ {"", nil},+ {" ", nil},+ {"hello world", []string{"hello", "world"}},+ // leading/trailing punctuation stripped+ {"...hello...", []string{"hello"}},+ {",hello, world!", []string{"hello", "world"}},+ // digits preserved+ {"go1.24", []string{"go1.24"}},+ // HTML entities decoded+ {"foo &bar", []string{"foo", "bar"}},+ // fast path: single token, no whitespace+ {"&foo&", []string{"foo"}},+ // and similar entities that decode to whitespace must not use the fast path+ {"Apples and oranges!", []string{"Apples", "and", "oranges"}},+ // punctuation-only tokens dropped+ {"hello --- world", []string{"hello", "world"}},+ // mixed spaces+ {" foo bar ", []string{"foo", "bar"}},+ }++ for _, tt := range tests {+ c.Assert(splitWords(tt.in), qt.DeepEquals, tt.want, qt.Commentf("input: %q", tt.in))+ }+}+ func BenchmarkRelatedNewIndex(b *testing.B) { pages := make([]*testDoc, 100) numkeywords := 30related/related_integration_test.goindex e1387d3c5..038d955cc 100644@@ -40,7 +40,7 @@ disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT"] weight = 90 [[related.indices]] name = 'keywords'- weight = 80 + weight = 80 -- content/p1.md -- --- title: p1@@ -112,13 +112,13 @@ Related 2: {{ template "list-related" $related2 }} -- layouts/single.html -- Content: {{ .Content }} - + ` b := hugolib.Test(t, files) expect := `-P1 Fragments: [p1-title] +P1 Fragments: [p1-title] P2 Fragments: [p2-title-1 p2-title-2 ref1] Len Related 1: 1 Related 2: 2@@ -128,12 +128,288 @@ Related 2: 2 b.AssertFileContent("public/"+p+"/index.html", expect) } - b.AssertFileContent("public/p1/index.html",+ b.AssertFileContent(+ "public/p1/index.html", "Related 1: 0: p2: h0: First title|ref1|::END", "Related 2: 0: p5: h0: Common p3, p4, p5|common-p3-p4-p5|::END 1: p4: h0: Common p3, p4, p5|common-p3-p4-p5|::END", ) } +// See issue 15199.+func TestRelatedFragmentsTokenize(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+disableKinds = ['home', 'section', 'taxonomy', 'term', 'rss', 'sitemap']+[related]+ includeNewer = true+ threshold = 80+ toLower = true+[[related.indices]]+ type = 'fragments'+ weight = 100+ tokenize = true+-- content/p1.md --+---+title: p1+---+## Hugo Templates Overview+-- content/p2.md --+---+title: p2+---+## Templates in Hugo+-- content/p3.md --+---+title: p3+---+## JavaScript and CSS+-- layouts/page.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }} {{ end }}+`+ b := hugolib.Test(t, files)++ b.AssertFileContent("public/p1/index.html", "Related: p2")+ b.AssertFileContent("public/p2/index.html", "Related: p1")+ b.AssertFileContent("public/p3/index.html", "Related: ")+}++// See issue 15199.+func TestRelatedFragmentsTokenizeHTMLEntities(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+baseURL = "http://example.com/"+disableKinds = ["home", "section", "taxonomy", "term", "rss", "sitemap"]+[related]+ includeNewer = true+ threshold = 80+ toLower = true+[[related.indices]]+ type = 'fragments'+ weight = 100+ tokenize = true+-- content/p1.md --+---+title: p1+---+## Types of apples+-- content/p2.md --+---+title: p2+---+## Something about "apples"+-- layouts/page.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }} {{ end }}+`+ b := hugolib.Test(t, files)++ b.AssertFileContent("public/p1/index.html", "Related: p2")+ b.AssertFileContent("public/p2/index.html", "Related: p1")+}++// See issue 15199.+func TestRelatedBasicTokenize(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+disableKinds = ['home', 'section', 'taxonomy', 'term', 'rss', 'sitemap']+[related]+ includeNewer = true+ threshold = 80+ toLower = true+[[related.indices]]+ name = 'title'+ weight = 100+ tokenize = true+-- content/p1.md --+---+title: Hugo Templates Overview+---+-- content/p2.md --+---+title: Templates in Hugo+---+-- content/p3.md --+---+title: JavaScript and CSS+---+-- layouts/page.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }} {{ end }}+`+ b := hugolib.Test(t, files)++ b.AssertFileContent("public/p1/index.html", "Related: Templates in Hugo")+ b.AssertFileContent("public/p2/index.html", "Related: Hugo Templates Overview")+ b.AssertFileContent("public/p3/index.html", "Related: ")+}++// See issue 15199.+func TestRelatedFragmentsTokenizeApplyFilter(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+disableKinds = ['home', 'section', 'taxonomy', 'term', 'rss', 'sitemap']+[related]+ includeNewer = true+ threshold = 80+ toLower = true+[[related.indices]]+ type = 'fragments'+ weight = 100+ applyFilter = true+ tokenize = true+-- content/p1.md --+---+title: p1+---+## Hugo Templates Overview+-- content/p2.md --+---+title: p2+---+## Templates in Hugo++## Unrelated Topic+-- layouts/page.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }}:{{ with .HeadingsFiltered }}{{ range . }}{{ .Title }}|{{ end }}{{ end }}::END {{ end }}+`+ b := hugolib.Test(t, files)++ b.AssertFileContent("public/p1/index.html", "Related: p2:Templates in Hugo|::END")+ b.AssertFileContent("public/p2/index.html", "Related: p1:Hugo Templates Overview|::END")+}++// See issue 15199.+func TestRelatedTokenizeCaseSensitive(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+disableKinds = ['home', 'section', 'taxonomy', 'term', 'rss', 'sitemap']+[related]+ includeNewer = true+ threshold = 80+ toLower = false+[[related.indices]]+ type = 'fragments'+ weight = 100+ tokenize = true+-- content/p1.md --+---+title: p1+---+## Hugo Templates+-- content/p2.md --+---+title: p2+---+## hugo templates+-- layouts/page.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }} {{ end }}+`+ b := hugolib.Test(t, files)++ // toLower=false: "Hugo" != "hugo", so no match.+ b.AssertFileContent("public/p1/index.html", "Related: ")+ b.AssertFileContent("public/p2/index.html", "Related: ")+}++// See issue 15238.+func TestRelatedTokenizeMinTokenLength(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+disableKinds = ['home', 'section', 'taxonomy', 'term', 'rss', 'sitemap']+[related]+ includeNewer = true+ threshold = 80+ toLower = true+[[related.indices]]+ name = 'title'+ weight = 100+ tokenize = true+ minTokenLength = 4+-- content/p1.md --+---+title: The long journey home+---+-- content/p2.md --+---+title: Planning your next big journey+---+-- content/p3.md --+---+title: Go to the top+---+-- layouts/page.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }} {{ end }}+`+ b := hugolib.Test(t, files)++ // p1 and p2 share "journey" (>= minTokenLength=4); short words are filtered.+ b.AssertFileContent("public/p1/index.html", "Related: Planning your next big journey")+ b.AssertFileContent("public/p2/index.html", "Related: The long journey home")+ // All tokens in p3's title ("go", "to", "the", "top") are < minTokenLength=4.+ b.AssertFileContent("public/p3/index.html", "Related: ")+}++// Repetitive headings must not inflate a document's rank above a document+// that matches on an additional index.+func TestRelatedFragmentsTokenizeDeduplication(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+disableKinds = ['home', 'section', 'taxonomy', 'term', 'rss', 'sitemap']+[related]+ includeNewer = true+ threshold = 80+ toLower = true+[[related.indices]]+ type = 'fragments'+ weight = 100+ tokenize = true+[[related.indices]]+ name = 'keywords'+ weight = 100+-- content/p1.md --+---+title: p1+keywords: ['fruit']+---+## I love apples, apples and more apples+-- content/p2.md --+---+title: p2+keywords: ['fruit']+---+## I love apples, apples and more apples+## I love apples, apples and more apples+## I love apples, apples and more apples+-- content/p3.md --+---+title: p3+---+## I love apples, apples and more apples+## I love apples, apples and more apples+## I love apples, apples and more apples+-- layouts/page.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }} {{ end }}+`+ b := hugolib.Test(t, files)++ // p1 and p3 share the same unique fragment tokens; p1 also matches on+ // keywords ("fruit"). Without deduplication, p3's repeated headings+ // inflate its weight above p1's combined fragment+keywords weight.+ b.AssertFileContent("public/p2/index.html", "Related: p1 p3")+}+ func BenchmarkRelatedSite(b *testing.B) { var files strings.Builder files.WriteString(`@@ -146,11 +422,11 @@ disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT"] toLower = false [[related.indices]] name = 'keywords'- weight = 70 + weight = 70 [[related.indices]] name = 'pagerefs' type = 'fragments'- weight = 30 + weight = 30 -- layouts/single.html -- Len related: {{ site.RegularPages.Related . | len }} `)