Backtestshugorun-20261009-153657#7515
Related content: Partial-text indexing
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 better fix. It is correct, tested, documented and lower risk. Patch A also tries to tokenize fragments and has a likely correctness bug there. **Patch A** Correctness: - Tokenizing basic string values in `ToKeywords` does address the issue. - The fragments path is shaky. Tokenized heading words become `StringKeyword` (via `stringToKeyword`), but the ApplyFilter branch only collects `ff.words` when `kw.(FragmentKeyword)` succeeds. So `ff.words` is never populated, and heading filtering by tokenized words cannot work. Its own `TestRelatedFragmentsTokenizeApplyFilter` therefore appears unlikely to pass as written. - Mixing `StringKeyword` and `FragmentKeyword` in the same fragments index adds further risk. - Basic-index tokenization does not deduplicate. A title like "apples apples" adds the document to the same posting list several times, inflating its rank. The patch deduplicates only for fragments. Scope and craft: - It adds an unrequested `MinTokenLength` option. - It makes whitespace-only edits to existing tests. - It adds no config validation and no documentation. **Patch B** Correctness: - It adds a `SplitWords` option that splits on any non-letter, non-number, non-mark rune. This is Unicode-aware and suits the issue's i18n concern. - It deduplicates words within a value. - It routes both `ToKeywords` and `StringsToKeywords` through one path, so indexing and querying behave consistently. - It explicitly rejects the unsupported fragments type in `DecodeConfig` with a clear error, rather than shipping a half-working fragments mode. - It handles the issue's common-word concern sensibly: the docs and an integration test recommend `cardinalityThreshold`. Tests: - Unit tests cover tokenization, including Unicode and deduplication. - Unit tests cover search and config decoding, including rejection of fragments. - Integration tests cover `Related`, `RelatedTo`, cardinality pruning, and the default-off behavior. Scope and craft: - It is opt-in as the issue asks. - It includes documentation and is minimal and clean.
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
17m 18s
Wall-clock time in the container
Full test suite
No new failures
858 passed · 25 skipped · 883 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
236vs 462 merged
Changed lines, ours vs merged
The issue
View on GitHubWhen specifying the indices for related content, it would be useful to specify that some of them were split by word, so that their text could be matched partially. This would allow the title to be used for more in-depth indexing, rather than requiring the user to specify tags / keywords.
This would likely increase memory usage and decrease performance, so should definitely be opt-in!
I suspect common words (a, an, the etc) might want to be ignored? Although doing that in a sane, i18n-friendly manner might be a challenge!
The two patches
docs/content/en/configuration/related-content.mdindex 92cf92e8a..d9d0d8f1f 100644@@ -45,6 +45,9 @@ 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. +`splitWords`+: (`bool`) Whether to split string values in both the indexes and the queries into words, allowing partial matching of values such as `title`. Words are separated by any character that is not a letter, number, or mark. Duplicate words in a value are only indexed once. This increases memory usage and indexing time. Common words (e.g., "a", "the") will also be indexed; use `cardinalityThreshold` to remove words that occur in too many documents. Not supported for the `fragments` type. 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`. docs/data/docs.yamlindex 19b950dd5..66b82a5e2 100644@@ -2191,6 +2191,7 @@ config: cardinalityThreshold: 0 name: keywords pattern: ''+ splitWords: false toLower: false type: basic weight: 100@@ -2198,6 +2199,7 @@ config: cardinalityThreshold: 0 name: date pattern: ''+ splitWords: false toLower: false type: basic weight: 10@@ -2205,6 +2207,7 @@ config: cardinalityThreshold: 0 name: tags pattern: ''+ splitWords: false toLower: false type: basic weight: 80related/inverted_index.goindex c6c65d97f..beea7faa2 100644@@ -24,6 +24,7 @@ import ( "strings" "sync" "time"+ "unicode" "github.com/gohugoio/hugo/common/collections" "github.com/gohugoio/hugo/common/hmaps"@@ -125,6 +126,14 @@ 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++ // Will split all string values in and queries to this index into words,+ // allowing e.g. titles to be partially matched.+ // Word boundaries are any characters that are not letters, numbers or marks.+ // This increases the index size, so consider combining it with+ // CardinalityThreshold to remove common words.+ // Not supported for the "fragments" type.+ SplitWords bool } // Document is the interface an indexable document in Hugo must fulfill.@@ -423,19 +432,23 @@ func (cfg IndexConfig) stringToKeyword(s string) Keyword { return StringKeyword(s) } +func isWordSeparator(r rune) bool {+ return !unicode.IsLetter(r) && !unicode.IsNumber(r) && !unicode.IsMark(r)+}++func splitWords(s string) []string {+ return strings.FieldsFunc(s, isWordSeparator)+}+ // 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))+ keywords = cfg.StringsToKeywords(vv) case []string:- vvv := make([]Keyword, len(vv))- for i := range vvv {- vvv[i] = cfg.stringToKeyword(vv[i])- }- keywords = append(keywords, vvv...)+ keywords = cfg.StringsToKeywords(vv...) case []any: return cfg.ToKeywords(cast.ToStringSlice(vv)) case time.Time:@@ -591,6 +604,9 @@ func DecodeConfig(m hmaps.Params) (Config, error) { if !validTypes[c.Indices[i].Type] { return c, fmt.Errorf("invalid index type %q. Must be one of %v", c.Indices[i].Type, maps.Keys(validTypes)) }+ if icfg.SplitWords && c.Indices[i].Type == TypeFragments {+ return Config{}, fmt.Errorf("splitWords is not supported for index %q of type %q", c.Indices[i].Name, TypeFragments)+ } if icfg.CardinalityThreshold < 0 || icfg.CardinalityThreshold > 100 { return Config{}, errors.New("cardinalityThreshold threshold must be between 0 and 100") }@@ -619,12 +635,28 @@ type Keyword interface { } // StringsToKeywords converts the given slice of strings to a slice of Keyword.+// If SplitWords is enabled, the strings are split into words, and duplicate+// words are removed. func (cfg IndexConfig) StringsToKeywords(s ...string) []Keyword {- kw := make([]Keyword, len(s))+ if !cfg.SplitWords {+ kw := make([]Keyword, len(s))+ for i := range s {+ kw[i] = cfg.stringToKeyword(s[i])+ }+ return kw+ } + var kw []Keyword+ seen := make(map[string]bool) for i := range s {- kw[i] = cfg.stringToKeyword(s[i])+ for _, word := range splitWords(s[i]) {+ k := cfg.stringToKeyword(word)+ if seen[k.String()] {+ continue+ }+ seen[k.String()] = true+ kw = append(kw, k)+ } }- return kw }related/inverted_index_test.goindex b33d42955..29ec8be72 100644@@ -22,6 +22,7 @@ import ( "time" qt "github.com/frankban/quicktest"+ "github.com/gohugoio/hugo/common/types" "github.com/gohugoio/hugo/config" ) @@ -412,3 +413,100 @@ func BenchmarkRelatedMatchesIn(b *testing.B) { } } }++func TestToKeywordsSplitWords(t *testing.T) {+ c := qt.New(t)++ config := IndexConfig{Name: "title", ToLower: true, SplitWords: true}++ keywords, err := config.ToKeywords("The Go Programming Language: the 2nd edition, Café-crème")+ c.Assert(err, qt.IsNil)+ c.Assert(keywords, qt.DeepEquals, []Keyword{+ StringKeyword("the"),+ StringKeyword("go"),+ StringKeyword("programming"),+ StringKeyword("language"),+ StringKeyword("2nd"),+ StringKeyword("edition"),+ StringKeyword("café"),+ StringKeyword("crème"),+ })++ keywords, err = config.ToKeywords([]any{"Hugo rocks", "hugo templates", " "})+ c.Assert(err, qt.IsNil)+ c.Assert(keywords, qt.DeepEquals, []Keyword{+ StringKeyword("hugo"),+ StringKeyword("rocks"),+ StringKeyword("templates"),+ })++ // Not enabled: whole values are kept.+ config.SplitWords = false+ keywords, err = config.ToKeywords("Hugo rocks")+ c.Assert(err, qt.IsNil)+ c.Assert(keywords, qt.DeepEquals, []Keyword{StringKeyword("hugo rocks")})+}++func TestSearchSplitWords(t *testing.T) {+ c := qt.New(t)+ ctx := context.Background()++ config := Config{+ Threshold: 10,+ Indices: IndicesConfig{+ IndexConfig{Name: "title", Weight: 100, ToLower: true, SplitWords: true},+ },+ }++ idx := NewInvertedIndex(config)+ icfg := config.Indices[0]++ newDoc := func(name, title string) *testDoc {+ return &testDoc{name: name, keywords: map[string][]Keyword{"title": icfg.StringsToKeywords(title)}}+ }++ doc1 := newDoc("doc1", "Getting started with Hugo")+ doc2 := newDoc("doc2", "Hugo templates")+ doc3 := newDoc("doc3", "Baking bread")++ c.Assert(idx.Add(ctx, doc1, doc2, doc3), qt.IsNil)++ m, err := idx.Search(ctx, SearchOpts{Document: doc2})+ c.Assert(err, qt.IsNil)+ c.Assert(len(m), qt.Equals, 1)+ c.Assert(m[0], qt.Equals, Document(doc1))++ m, err = idx.Search(ctx, SearchOpts{NamedSlices: []types.KeyValues{{Key: "title", Values: []any{"Bread and HUGO"}}}})+ c.Assert(err, qt.IsNil)+ c.Assert(len(m), qt.Equals, 3)+}++func TestDecodeConfigSplitWords(t *testing.T) {+ c := qt.New(t)++ m, err := config.FromConfigString(`+[related]+ threshold = 80+ [[related.indices]]+ name = 'title'+ splitWords = true+ weight = 100+`, "toml")+ c.Assert(err, qt.IsNil)+ conf, err := DecodeConfig(m.GetParams("related"))+ c.Assert(err, qt.IsNil)+ c.Assert(conf.Indices[0].SplitWords, qt.IsTrue)++ m, err = config.FromConfigString(`+[related]+ threshold = 80+ [[related.indices]]+ name = 'pagerefs'+ type = 'fragments'+ splitWords = true+ weight = 100+`, "toml")+ c.Assert(err, qt.IsNil)+ _, err = DecodeConfig(m.GetParams("related"))+ c.Assert(err, qt.ErrorMatches, `.*splitWords is not supported.*`)+}related/related_integration_test.goindex e1387d3c5..2fbbde9c5 100644@@ -134,6 +134,88 @@ Related 2: 2 ) } +func TestRelatedSplitWords(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+baseURL = "http://example.com/"+disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT", "home", "section"]+[related]+ includeNewer = true+ threshold = 80+ toLower = true+[[related.indices]]+ name = 'title'+ splitWords = true+ # "with" is used in 60% of the pages and gets removed.+ cardinalityThreshold = 50+ weight = 100+-- content/p1.md --+---+title: "Getting started with Hugo"+---+-- content/p2.md --+---+title: "Hugo templates"+---+-- content/p3.md --+---+title: "Baking bread with sourdough"+---+-- content/p4.md --+---+title: "Sourdough starter"+---+-- content/p5.md --+---+title: "Gardening with kids"+---+-- layouts/single.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }}|{{ end }}$+RelatedTo: {{ range site.RegularPages.RelatedTo (keyVals "title" "hugo SOURDOUGH") }}{{ .Title }}|{{ end }}$+`++ b := hugolib.Test(t, files)++ b.AssertFileContent("public/p1/index.html", "Related: Hugo templates|$")+ b.AssertFileContent("public/p2/index.html", "Related: Getting started with Hugo|$")+ b.AssertFileContent("public/p3/index.html", "Related: Sourdough starter|$")+ b.AssertFileContent("public/p5/index.html", "Related: $")+ b.AssertFileContent("public/p5/index.html", "Getting started with Hugo|", "Hugo templates|", "Baking bread with sourdough|", "Sourdough starter|")+}++func TestRelatedSplitWordsDisabledByDefault(t *testing.T) {+ t.Parallel()++ files := `+-- hugo.toml --+baseURL = "http://example.com/"+disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT", "home", "section"]+[related]+ includeNewer = true+ threshold = 80+ toLower = true+[[related.indices]]+ name = 'title'+ weight = 100+-- content/p1.md --+---+title: "Getting started with Hugo"+---+-- content/p2.md --+---+title: "Hugo templates"+---+-- layouts/single.html --+Related: {{ range site.RegularPages.Related . }}{{ .Title }}|{{ end }}$+`++ b := hugolib.Test(t, files)++ b.AssertFileContent("public/p1/index.html", "Related: $")+}+ 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 }} `)