Upstream issue #11961: alternative de-duplication approach

sphinx/themes/basic/static/searchtools.js

@@ -179,7 +179,8 @@ const Search = {
     if (Search._queued_query !== null) {
       const query = Search._queued_query;
       Search._queued_query = null;
-      Search.query(query);
+      let { results, searchTerms, highlightTerms } = Search.query(query);
+      _displayNextItem(results, results.length, searchTerms, highlightTerms);
     }
   },
 
@@ -227,8 +228,12 @@ const Search = {
     Search.startPulse();
 
     // index already loaded, the browser was quick!
-    if (Search.hasIndex()) Search.query(query);
-    else Search.deferQuery(query);
+    if (Search.hasIndex()) { 
+      let { results, searchTerms, highlightTerms } = Search.query(query);
+      _displayNextItem(results, results.length, searchTerms, highlightTerms);
+    } else {
+      Search.deferQuery(query);
+    }
   },
 
   /**
@@ -345,7 +350,8 @@ const Search = {
     // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
     let seen = new Set();
     results = results.reverse().reduce((acc, result) => {
-      let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+      const [docName, _title, anchor, descr, _score, filename] = result;
+      const resultStr = `${docName},${anchor},${descr},${filename}`;
       if (!seen.has(resultStr)) {
         acc.push(result);
         seen.add(resultStr);
@@ -359,8 +365,7 @@ const Search = {
     //Search.lastresults = results.slice();  // a copy
     // console.info("search results:", Search.lastresults);
 
-    // print the results
-    _displayNextItem(results, results.length, searchTerms);
+    return { results, searchTerms, highlightTerms };
   },
 
   /**

tests/js/documentation_options.js

@@ -1 +1,9 @@
 const DOCUMENTATION_OPTIONS = {};
+
+// stub Stemmer / stopWords
+function Stemmer() {
+    this.stemWord = function (word) {
+        return word;
+    }
+};
+let stopwords = [];

tests/js/searchtools.js

@@ -29,6 +29,31 @@ describe('Basic html theme search', function() {
 
   });
 
+  describe('query', function() {
+    it("should not duplicate on title and content", function() {
+      index = {
+        alltitles: {
+          'Main Page': [[0, 'main-page']],
+        },
+        docnames:["index"],
+        filenames:["index.rst"],
+        indexentries:{},
+        objects:{},
+        objtypes: {},
+        objnames: {},
+        terms:{main:0, page:0},
+        titles:["Main Page"],
+        titleterms:{ main:0, page:0 }
+      }
+      Search.setIndex(index);
+      let { results } = Search.query('main page');
+      // should only be one result
+      expect(results).toEqual([
+        [ 'index', 'Main Page', '#main-page', null, 100, 'index.rst' ],
+      ]);
+    });
+  })
+
 });
 
 // This is regression test for https://github.com/sphinx-doc/sphinx/issues/3150