Backtestshugorun-20261013-011256#15199
related: Add option to tokenize headings
Our patch was judged better than the merged fix.
In this judgment, Patch B = our agent, Patch A = the merged fix.
Patch B is the more correct fix. **Patch B** - Keeps the existing exact `FragmentKeyword` identifiers and adds heading-word tokens as a separate `fragmentTokenKeyword` type. A word can therefore never collide with a fragment ID, and non-heading fragments such as definition terms keep exact matching, exactly as the issue's documentation says. - Tokenization strips HTML tags from sanitized titles, unescapes entities, honors `ToLower`, and preserves combining marks. - It walks all headings, including nested ones, and dedupes words per document so `cardinalityThreshold` counts documents correctly. - It extends `applyFilter` to work with tokens. - It adds the requested docs entry. - Tests: - a unit test for keyword generation and tokenization; - a config decode test; - an integration test that runs with tokenize both true and false, checking `HeadingsFiltered`, `cardinalityThreshold` pruning of 'introduction', and that definition-term refs still match. **Patch A has a functional bug in `applyFilter`** - Tokenized words are created via `stringToKeyword`, which yields `StringKeyword`. - `searchDate` only collects filter terms when `kw.(FragmentKeyword)` succeeds, so `ff.words` is never populated. - As a result, heading filtering silently does nothing when `tokenize` and `applyFilter` are combined, and its own ApplyFilter test should not pass as written. **Other problems in Patch A** - It replaces heading identifiers with tokens (`continue`), dropping exact-ID matching for headings. This breaks front-matter references to heading IDs in tokenized indices. - It does not strip HTML tags from heading titles. - It goes beyond the ask by applying `Tokenize` to all basic string indices and adding an unrequested `MinTokenLength` option. This increases risk and behavioral surface. - It adds no documentation. - It includes whitespace churn in existing tests.
The judge saw only the two patches, labelled A and B in random order, with issue links and version numbers removed. The reasoning above is shown verbatim.
Solve
1h 13m
Wall-clock time in the container
Full test suite
No new failures
948 passed · 25 skipped · 977 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
271vs 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..945523696 100644@@ -45,6 +45,10 @@ This is the default configuration: `pattern` : (`string`) This is currently only relevant for dates. When listing related content, we may want to list content that is also close in time. Setting "2006" (default value for date indexes) as the pattern for a date index will add weight to pages published in the same year. For busier blogs, "200601" (year and month) may be a better default. +`tokenize`+: {{< new-in 0.166.0 />}}+: (`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`.+ `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`. markup/tableofcontents/tableofcontents.goindex 6c40c9a59..65df158ef 100644@@ -89,6 +89,14 @@ func (h Headings) FilterBy(fn func(*Heading) bool) Headings { return out } +// Walk calls fn for all headings, including nested headings, in document order.+// For internal use only.+func (h Headings) Walk(fn func(*Heading)) {+ for _, h := range h {+ h.walk(fn)+ }+}+ // Heading holds the data about a heading and its children. type Heading struct { ID stringrelated/inverted_index.goindex c6c65d97f..44f9c622d 100644@@ -18,12 +18,15 @@ import ( "context" "errors" "fmt"+ "html" "maps" "math"+ "slices" "sort" "strings" "sync" "time"+ "unicode" "github.com/gohugoio/hugo/common/collections" "github.com/gohugoio/hugo/common/hmaps"@@ -125,6 +128,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 +229,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.fragmentKeywords(fp.Fragments(ctx)) { added = true- setm[FragmentKeyword(fragment)] = append(setm[FragmentKeyword(fragment)], doc)+ setm[keyword] = append(setm[keyword], doc) } } }@@ -377,9 +386,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.fragmentKeywords(fp.Fragments(ctx))...) } } @@ -413,6 +420,71 @@ func (idx *InvertedIndex) Search(ctx context.Context, opts SearchOpts) ([]Docume return idx.search(ctx, queryElements...) } +// fragmentKeywords returns the keywords for the given fragments,+// the fragment identifiers and, if Tokenize is enabled, the individual words+// of the heading titles.+func (cfg IndexConfig) fragmentKeywords(fragments *tableofcontents.Fragments) []Keyword {+ keywords := make([]Keyword, 0, len(fragments.Identifiers))+ for _, id := range fragments.Identifiers {+ keywords = append(keywords, FragmentKeyword(id))+ }+ if !cfg.Tokenize {+ return keywords+ }++ // Each word is added once per document, so cardinalityThreshold+ // operates on the number of documents using a word.+ seen := make(map[string]bool)+ fragments.Headings.Walk(func(h *tableofcontents.Heading) {+ for _, token := range cfg.tokenizeHeadingTitle(h.Title) {+ if !seen[token] {+ seen[token] = true+ keywords = append(keywords, fragmentTokenKeyword(token))+ }+ }+ })++ return keywords+}++// tokenizeHeadingTitle splits the given heading title, which may contain+// sanitized HTML, into individual words.+func (cfg IndexConfig) tokenizeHeadingTitle(title string) []string {+ if title == "" {+ return nil+ }+ s := html.UnescapeString(stripHTMLTags(title))+ if cfg.ToLower {+ s = strings.ToLower(s)+ }+ return strings.FieldsFunc(s, func(r rune) bool {+ // Combining marks are part of words in e.g. Indic scripts and decomposed text.+ return !unicode.IsLetter(r) && !unicode.IsNumber(r) && !unicode.IsMark(r)+ })+}++// stripHTMLTags replaces all HTML tags in s with a space.+func stripHTMLTags(s string) string {+ if !strings.ContainsRune(s, '<') {+ 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()+}+ func (cfg IndexConfig) stringToKeyword(s string) Keyword { if cfg.ToLower { s = strings.ToLower(s)@@ -467,6 +539,11 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa applyDateFilter := !idx.cfg.IncludeNewer && !upperDate.IsZero() var fragmentsFilter collections.SortedStringSlice+ // Words matched in tokenized heading titles and the configs used to tokenize them.+ var (+ tokensFilter map[string]bool+ tokenizeConfigs []IndexConfig+ ) 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 tokensFilter == nil {+ tokensFilter = make(map[string]bool)+ }+ tokensFilter[string(fkw)] = true+ if !slices.ContainsFunc(tokenizeConfigs, func(c IndexConfig) bool { return c.Name == config.Name }) {+ tokenizeConfigs = append(tokenizeConfigs, config)+ } } } @@ -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(tokensFilter) > 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 _, c := range tokenizeConfigs {+ for _, token := range c.tokenizeHeadingTitle(h.Title) {+ if tokensFilter[token] {+ return true+ }+ }+ }+ return false }) } }@@ -613,6 +709,14 @@ func (f FragmentKeyword) String() string { return string(f) } +// fragmentTokenKeyword represents a single word in a heading title.+// It is a separate type from FragmentKeyword so a word never matches a fragment identifier.+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..d92aec002 100644@@ -23,6 +23,7 @@ import ( qt "github.com/frankban/quicktest" "github.com/gohugoio/hugo/config"+ "github.com/gohugoio/hugo/markup/tableofcontents" ) type testDoc struct {@@ -296,6 +297,60 @@ func TestDecodeConfig(t *testing.T) { c.Assert(first.Name, qt.Equals, "keywords") } +func TestDecodeConfigTokenize(t *testing.T) {+ c := qt.New(t)++ configToml := `+[related]+ threshold = 20+ [[related.indices]]+ name = 'fragmentrefs'+ type = 'fragments'+ tokenize = true+ weight = 80+ [[related.indices]]+ name = 'keywords'+ weight = 100+`++ 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.Indices[0].Tokenize, qt.IsTrue)+ c.Assert(conf.Indices[1].Tokenize, qt.IsFalse)+}++func TestFragmentKeywordsTokenize(t *testing.T) {+ c := qt.New(t)++ var b tableofcontents.Builder+ b.AddAt(&tableofcontents.Heading{ID: "getting-started", Level: 2, Title: "Getting <code>Started</code> & more"}, 0, 0)+ b.AddAt(&tableofcontents.Heading{ID: "started-again", Level: 3, Title: "Started again"}, 0, 1)+ b.SetIdentifiers([]string{"getting-started", "started-again", "my-term"})+ fragments := b.Build()++ c.Assert(IndexConfig{Type: TypeFragments}.fragmentKeywords(fragments), qt.DeepEquals, []Keyword{+ FragmentKeyword("getting-started"),+ FragmentKeyword("my-term"),+ FragmentKeyword("started-again"),+ })++ c.Assert(IndexConfig{Type: TypeFragments, Tokenize: true, ToLower: true}.fragmentKeywords(fragments), qt.DeepEquals, []Keyword{+ FragmentKeyword("getting-started"),+ FragmentKeyword("my-term"),+ FragmentKeyword("started-again"),+ fragmentTokenKeyword("getting"),+ fragmentTokenKeyword("started"),+ fragmentTokenKeyword("more"),+ fragmentTokenKeyword("again"),+ })++ c.Assert(IndexConfig{Tokenize: true}.tokenizeHeadingTitle("Hugo's <em>Tokenizer</em>, v2"), qt.DeepEquals, []string{"Hugo", "s", "Tokenizer", "v2"})+ // Combining marks must not split words.+ c.Assert(IndexConfig{Tokenize: true}.tokenizeHeadingTitle("हिन्दी व्याकरण cafe\u0301"), qt.DeepEquals, []string{"हिन्दी", "व्याकरण", "cafe\u0301"})+}+ func TestToKeywordsAnySlice(t *testing.T) { c := qt.New(t) var config IndexConfigrelated/related_integration_test.goindex e1387d3c5..5e1d1efbd 100644@@ -134,6 +134,90 @@ Related 2: 2 ) } +func TestRelatedFragmentsTokenize(t *testing.T) {+ t.Parallel()++ filesTemplate := `+-- 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 = 'fragmentrefs'+ type = 'fragments'+ applyFilter = true+ cardinalityThreshold = 60+ tokenize = TOKENIZE+ weight = 80+-- content/p1.md --+---+title: p1+---+## Introduction++## Installing Hugo on Linux++My term+: Definition.+-- content/p2.md --+---+title: p2+---+## Introduction++## Hugo installation guide++## Linux tips++## Unrelated *heading*+-- content/p3.md --+---+title: p3+---+## Introduction++## Cooking pasta+-- content/p4.md --+---+title: p4+fragmentrefs: ['my-term']+---+## Introduction++## Baking bread+-- layouts/single.html --+{{ $related := site.RegularPages.Related . }}+Related: {{ range $related }}{{ .Title }}: {{ range .HeadingsFiltered }}{{ .Title }}|{{ end }}::END {{ end }}:RELATED_END+`++ for _, tokenize := range []bool{true, false} {+ t.Run(fmt.Sprintf("tokenize=%t", tokenize), func(t *testing.T) {+ t.Parallel()+ files := strings.Replace(filesTemplate, "TOKENIZE", fmt.Sprint(tokenize), 1)+ b := hugolib.Test(t, files)++ if tokenize {+ // Common words in heading titles find related pages, and the filtered headings are the ones sharing words.+ b.AssertFileContent("public/p1/index.html", "Related: p2: Hugo installation guide|Linux tips|::END p4: ::END :RELATED_END")+ b.AssertFileContent("public/p2/index.html", "Related: p1: Installing Hugo on Linux|::END :RELATED_END")+ } else {+ b.AssertFileContent("public/p1/index.html", "Related: p4: ::END :RELATED_END")+ b.AssertFileContent("public/p2/index.html", "Related: :RELATED_END")+ }++ // "introduction" is used by all pages and is pruned by cardinalityThreshold.+ b.AssertFileContent("public/p3/index.html", "Related: :RELATED_END")+ // Non-heading fragments (definition terms) use exact identifier matching.+ b.AssertFileContent("public/p4/index.html", "Related: p1: ::END :RELATED_END")+ })+ }+}+ func BenchmarkRelatedSite(b *testing.B) { var files strings.Builder files.WriteString(`
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 }} `)