Backtestshugorun-20261005-133023#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 and better-scoped fix. **Correctness.** - Patch B adds `fragmentsToKeywords`. With `tokenize` on, it walks the heading tree and splits each title into `FragmentKeyword` tokens. Before splitting, it strips HTML tags and unescapes entities, which matters because heading titles hold rendered HTML such as `<code>` and `"`. - Non-heading identifiers, such as definition terms, keep exact-ID matching. That is exactly what the proposed documentation says. - Keywords are de-duplicated on both the index and query side. - Explicit `opts.Fragments` are tokenized as well, so a heading ID can match tokenized titles. - ApplyFilter still works because the tokens remain `FragmentKeyword`s. The heading-title token filter is built per index config, so lowercasing stays consistent. Patch A has a real flaw. For heading words it uses `config.stringToKeyword(word)`, which returns a `StringKeyword`. But `searchDate` only collects filter entries when `kw.(FragmentKeyword)` succeeds. So with tokenize on, `ff.words` is never populated, and the ApplyFilter path for tokenized headings is effectively dead code. This also mixes keyword types within a fragments index. Patch A's `splitWords` also does not strip HTML tags. A title like `Upgrading <code>hugo</code>` would yield tokens like `<code>hugo</code>` trimmed to `code>hugo</code`. In addition, A does not tokenize `opts.Fragments`. **Scope.** - Patch A goes beyond the ask. It changes `ToKeywords` behaviour for basic indices and adds a `MinTokenLength` option that was not requested. It also makes whitespace-only churn in an existing test file. - Patch B stays focused on the ask and adds the requested documentation entry verbatim. **Tests.** - Patch B's integration test covers several cases with tokenize on and off: HTML in headings, `cardinalityThreshold` pruning of common words, definition terms keeping exact matching, ApplyFilter results, and querying by explicit fragment. It also adds a config-decode assertion. - Patch A has more tests, but its ApplyFilter test relies on the path that appears broken, and several tests exercise the out-of-scope features. Overall, Patch B wins.
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 4m
Wall-clock time in the container
Full test suite
No new failures
3,741 passed · 99 skipped · 3,845 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
272vs 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..e03cba6fb 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,11 @@ 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.+ // This is currently only used for heading titles in the "fragments" type;+ // non-heading fragments (e.g. definition terms) still use exact-identifier matching.+ Tokenize bool } // Document is the interface an indexable document in Hugo must fulfill.@@ -220,9 +227,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) } } }@@ -372,17 +379,24 @@ func (idx *InvertedIndex) Search(ctx context.Context, opts SearchOpts) ([]Docume keywords = append(keywords, k...) } if cfg.Type == TypeFragments {+ var fragmentKeywords []Keyword for _, fragment := range opts.Fragments {- keywords = append(keywords, FragmentKeyword(fragment))+ fragmentKeywords = append(fragmentKeywords, FragmentKeyword(fragment))+ if cfg.Tokenize {+ // Allow e.g. a heading ID to match the tokenized heading titles.+ fragmentKeywords = append(fragmentKeywords, cfg.tokenize(fragment)...)+ } } if opts.Document != nil { if fp, ok := opts.Document.(FragmentProvider); ok {- for _, fragment := range fp.Fragments(ctx).Identifiers {- keywords = append(keywords, FragmentKeyword(fragment))- }+ fragmentKeywords = append(fragmentKeywords, cfg.fragmentsToKeywords(fp.Fragments(ctx))...) } }-+ if cfg.Tokenize {+ // Avoid counting the same token more than once.+ fragmentKeywords = uniqueKeywords(fragmentKeywords)+ }+ keywords = append(keywords, fragmentKeywords...) } queryElements = append(queryElements, newQueryElement(cfg.Name, keywords...)) }@@ -413,6 +427,116 @@ func (idx *InvertedIndex) Search(ctx context.Context, opts SearchOpts) ([]Docume return idx.search(ctx, queryElements...) } +// fragmentsToKeywords returns the keywords to index or query for the given fragments+// in an index of type "fragments".+func (cfg IndexConfig) fragmentsToKeywords(fragments *tableofcontents.Fragments) []Keyword {+ if fragments == nil {+ return nil+ }++ if !cfg.Tokenize {+ keywords := make([]Keyword, len(fragments.Identifiers))+ for i, id := range fragments.Identifiers {+ keywords[i] = FragmentKeyword(id)+ }+ return keywords+ }++ var keywords []Keyword++ // Heading titles are split into individual words.+ headingIDs := make(map[string]bool)+ walkHeadings(fragments.Headings, func(h *tableofcontents.Heading) {+ if h.ID != "" {+ headingIDs[h.ID] = true+ }+ keywords = append(keywords, cfg.tokenizeHeadingTitle(h.Title)...)+ })++ // Non-heading fragments (e.g. definition terms) use exact-identifier matching.+ for _, id := range fragments.Identifiers {+ if !headingIDs[id] {+ keywords = append(keywords, FragmentKeyword(id))+ }+ }++ return uniqueKeywords(keywords)+}++// tokenizeHeadingTitle splits the given heading title, which may contain HTML, into keywords.+func (cfg IndexConfig) tokenizeHeadingTitle(title string) []Keyword {+ if title == "" {+ return nil+ }+ return cfg.tokenize(html.UnescapeString(stripTags(title)))+}++// tokenize splits s into words, using any character that is not a letter or a number as a separator.+func (cfg IndexConfig) tokenize(s string) []Keyword {+ if cfg.ToLower {+ s = strings.ToLower(s)+ }+ words := strings.FieldsFunc(s, func(r rune) bool {+ return !unicode.IsLetter(r) && !unicode.IsNumber(r)+ })+ keywords := make([]Keyword, len(words))+ for i, word := range words {+ keywords[i] = FragmentKeyword(word)+ }+ return keywords+}++// matchesHeadingTitle reports whether any of the words in the given heading title is in tokens.+func (cfg IndexConfig) matchesHeadingTitle(title string, tokens map[string]bool) bool {+ for _, kw := range cfg.tokenizeHeadingTitle(title) {+ if tokens[kw.String()] {+ return true+ }+ }+ return false+}++// stripTags removes any HTML tags from s.+func stripTags(s string) string {+ if !strings.ContainsRune(s, '<') {+ return s+ }+ var b strings.Builder+ var inTag bool+ for _, r := range s {+ switch {+ case r == '<':+ inTag = true+ // Make sure that words separated by tags only are kept apart.+ b.WriteRune(' ')+ case r == '>' && inTag:+ inTag = false+ case !inTag:+ b.WriteRune(r)+ }+ }+ return b.String()+}++func walkHeadings(headings tableofcontents.Headings, fn func(*tableofcontents.Heading)) {+ for _, h := range headings {+ fn(h)+ walkHeadings(h.Headings, fn)+ }+}++func uniqueKeywords(keywords []Keyword) []Keyword {+ seen := make(map[Keyword]bool, len(keywords))+ unique := keywords[:0]+ for _, kw := range keywords {+ if !seen[kw] {+ seen[kw] = true+ unique = append(unique, kw)+ }+ }+ return unique+}+ func (cfg IndexConfig) stringToKeyword(s string) Keyword { if cfg.ToLower { s = strings.ToLower(s)@@ -467,6 +591,8 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa applyDateFilter := !idx.cfg.IncludeNewer && !upperDate.IsZero() var fragmentsFilter collections.SortedStringSlice+ // Matched heading title tokens per tokenized fragments index config.+ var headingTokenFilters []headingTokenFilter for _, el := range query { setm, found := idx.index[el.Index]@@ -479,6 +605,11 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa return []Document{}, fmt.Errorf("index config for %q not found", el.Index) } + var tokenFilter headingTokenFilter+ if config.Type == TypeFragments && config.ApplyFilter && config.Tokenize {+ tokenFilter = headingTokenFilter{cfg: config, tokens: make(map[string]bool)}+ }+ for _, kw := range el.Keywords { if docs, found := setm[kw]; found { for _, doc := range docs {@@ -496,6 +627,9 @@ 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 tokenFilter.tokens != nil {+ tokenFilter.tokens[string(fkw)] = true+ } } } @@ -509,6 +643,10 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa } } }++ if len(tokenFilter.tokens) > 0 {+ headingTokenFilters = append(headingTokenFilters, tokenFilter)+ } } if len(matchm) == 0 {@@ -538,7 +676,15 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa if len(fragmentsFilter) > 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 _, f := range headingTokenFilters {+ if f.cfg.matchesHeadingTitle(h.Title, f.tokens) {+ return true+ }+ }+ return false }) } }@@ -547,6 +693,12 @@ func (idx *InvertedIndex) searchDate(ctx context.Context, self Document, upperDa return result, nil } +// headingTokenFilter holds the matched heading title tokens for a tokenized fragments index.+type headingTokenFilter struct {+ cfg IndexConfig+ tokens map[string]bool+}+ // normalizes num to a number between 0 and 100. func norm(num, min, max int) int { if min > max {related/inverted_index_test.goindex b33d42955..b07989227 100644@@ -282,6 +282,7 @@ func TestDecodeConfig(t *testing.T) { name = 'tags' pattern = '' toLower = false+ tokenize = true type = 'fragments' weight = 80 `@@ -294,6 +295,8 @@ 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 TestToKeywordsAnySlice(t *testing.T) {related/related_integration_test.goindex e1387d3c5..61f16c835 100644@@ -134,6 +134,104 @@ 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 = 'fragments'+ type = 'fragments'+ applyFilter = true+ tokenize = TOKENIZE+ cardinalityThreshold = 70+ weight = 100+-- content/p1.md --+---+title: p1+date: 2024-01-01+---++## Installing Hugo on Linux++## The Introduction++Shared Term+: A definition.++-- content/p2.md --+---+title: p2+date: 2024-01-02+---++## Upgrading <code>hugo</code> on Windows++## The Summary++-- content/p3.md --+---+title: p3+date: 2024-01-03+---++## Linux tips and tricks++## The Ending++-- content/p4.md --+---+title: p4+date: 2024-01-04+---++## Gardening++Shared Term+: Another definition.++-- layouts/single.html --+{{ $related := site.RegularPages.Related . }}+Related: {{ range $related }}{{ .Title }}: {{ range .HeadingsFiltered }}{{ .ID }}|{{ end }}::{{ end }}END+{{ $byFragment := site.RegularPages.Related (dict "indices" (slice "fragments") "fragments" (slice "linux-tips-and-tricks")) }}+ByFragment: {{ range $byFragment }}{{ .Title }}: {{ range .HeadingsFiltered }}{{ .ID }}|{{ end }}::{{ end }}END+`++ t.Run("tokenize", func(t *testing.T) {+ t.Parallel()+ b := hugolib.Test(t, strings.ReplaceAll(filesTemplate, "TOKENIZE", "true"))++ // "hugo" and "on" match the title with HTML markup in p2, "linux" matches p3,+ // "the" is in 75% of the documents and is removed by cardinalityThreshold,+ // and the definition term matches p4 by its exact identifier.+ b.AssertFileContent("public/p1/index.html",+ "Related: p2: upgrading-hugo-on-windows|::p4: ::p3: linux-tips-and-tricks|::END",+ "ByFragment: p3: linux-tips-and-tricks|::p1: installing-hugo-on-linux|::END",+ )+ b.AssertFileContent("public/p2/index.html", "Related: p1: installing-hugo-on-linux|::END")+ b.AssertFileContent("public/p4/index.html", "Related: p1: ::END")+ })++ t.Run("no tokenize", func(t *testing.T) {+ t.Parallel()+ b := hugolib.Test(t, strings.ReplaceAll(filesTemplate, "TOKENIZE", "false"))++ b.AssertFileContent("public/p1/index.html",+ "Related: p4: ::END",+ "ByFragment: p3: linux-tips-and-tricks|::END",+ )+ b.AssertFileContent("public/p2/index.html", "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 }} `)