Merge pull request #1259 from pippotadde/pr_yellow_tests

Testing of a search pattern containing a space

include/spelling_correction.h

@@ -32,7 +32,7 @@ class Archive;
 
 namespace Xapian
 {
-class WritableDatabase;
+class Database;
 }
 
 namespace kiwix
@@ -50,7 +50,7 @@ public: // functions
   std::vector<std::string> getSpellingCorrections(const std::string& word, uint32_t maxCount) const;
 
 private: // data
-  std::unique_ptr<Xapian::WritableDatabase> impl_;
+  std::unique_ptr<Xapian::Database> impl_;
 };
 
 } // namespace kiwix

src/spelling_correction.cpp

@@ -43,11 +43,15 @@ std::vector<std::string> getAllTitles(const zim::Archive& a)
 void createXapianDB(std::string path, const zim::Archive& archive)
 {
   const int flags = Xapian::DB_BACKEND_GLASS|Xapian::DB_CREATE;
-  Xapian::WritableDatabase db(path, flags);
+  const auto tmpDbPath = path + ".tmp";
+  Xapian::WritableDatabase db(tmpDbPath, flags);
   for (const auto& t : getAllTitles(archive)) {
     db.add_spelling(t);
   }
   db.commit();
+  db.compact(path, Xapian::DBCOMPACT_SINGLE_FILE);
+  db.close();
+  std::filesystem::remove_all(tmpDbPath);
 }
 
 std::string spellingsDBPathForZIMArchive(std::filesystem::path cacheDirPath, const zim::Archive& a)
@@ -55,27 +59,24 @@ std::string spellingsDBPathForZIMArchive(std::filesystem::path cacheDirPath, con
   // The version of spellings DB must be updated each time an important change
   // to the implementation is made that renders using the previous version
   // impossible or undesirable.
-  const char SPELLINGS_DB_VERSION[] = "0.2";
+  const char SPELLINGS_DB_VERSION[] = "0.1";
 
   std::ostringstream filename;
   filename << a.getUuid() << ".spellingsdb.v" << SPELLINGS_DB_VERSION;
   return (cacheDirPath / filename.str()).string();
 }
 
-std::unique_ptr<Xapian::WritableDatabase> openOrCreateXapianDB(std::filesystem::path cacheDirPath, const zim::Archive& archive)
+std::unique_ptr<Xapian::Database> openOrCreateXapianDB(std::filesystem::path cacheDirPath, const zim::Archive& archive)
 {
   const auto path = spellingsDBPathForZIMArchive(cacheDirPath, archive);
   try
   {
-    {
-      Xapian::Database checkIfDbAlreadyExists(path);
-    }
-    return std::make_unique<Xapian::WritableDatabase>(path);
+    return std::make_unique<Xapian::Database>(path);
   }
   catch (const Xapian::DatabaseOpeningError& )
   {
     createXapianDB(path, archive);
-    return std::make_unique<Xapian::WritableDatabase>(path);
+    return std::make_unique<Xapian::Database>(path);
   }
 }
 
@@ -92,23 +93,15 @@ SpellingsDB::~SpellingsDB()
 
 std::vector<std::string> SpellingsDB::getSpellingCorrections(const std::string& word, uint32_t maxCount) const
 {
+  if ( maxCount > 1 ) {
+    throw std::runtime_error("More than one spelling correction was requested");
+  }
+
   std::vector<std::string> result;
-  while ( result.size() < maxCount ) {
-    const auto term = impl_->get_spelling_suggestion(word, 3);
-    if ( term.empty() )
-      break;
-
+  const auto term = impl_->get_spelling_suggestion(word, 3);
+  if ( !term.empty() ) {
     result.push_back(term);
-
-    // temporarily remove this term so that another spellings could be obtained
-    impl_->remove_spelling(term);
   }
-
-  // restore temporarily removed terms
-  for (const auto& t : result) {
-    impl_->add_spelling(t);
-  }
-
   return result;
 }
 

static/skin/viewer.js

@@ -83,6 +83,7 @@ function quasiUriEncode(s, specialSymbols) {
 
 function performSearch() {
   const searchbox = document.getElementById('kiwixsearchbox');
+  if (!searchbox.value.trim()) { return;}
   const q = encodeURIComponent(searchbox.value);
   gotoUrl(`/search?books.name=${currentBook}&pattern=${q}&userlang=${viewerState.uiLanguage}`);
 }

test/server.cpp

@@ -77,7 +77,7 @@ const ResourceCollection resources200Compressible{
   { DYNAMIC_CONTENT, "/ROOT%23%3F/skin/taskbar.css" },
   { STATIC_CONTENT,  "/ROOT%23%3F/skin/taskbar.css?cacheid=42e90cb9" },
   { DYNAMIC_CONTENT, "/ROOT%23%3F/skin/viewer.js" },
-  { STATIC_CONTENT,  "/ROOT%23%3F/skin/viewer.js?cacheid=00e0fdf3" },
+  { STATIC_CONTENT,  "/ROOT%23%3F/skin/viewer.js?cacheid=6192cae1" },
   { DYNAMIC_CONTENT, "/ROOT%23%3F/skin/fonts/Poppins.ttf" },
   { STATIC_CONTENT,  "/ROOT%23%3F/skin/fonts/Poppins.ttf?cacheid=af705837" },
   { DYNAMIC_CONTENT, "/ROOT%23%3F/skin/fonts/Roboto.ttf" },
@@ -338,7 +338,7 @@ R"EXPECTEDRESULT(    <link type="text/css" href="./skin/kiwix.css?cacheid=b4e29e
     <script type="text/javascript" src="./skin/polyfills.js?cacheid=a0e0343d"></script>
     <script type="module" src="./skin/i18n.js?cacheid=e9a10ac1" defer></script>
     <script type="text/javascript" src="./skin/languages.js?cacheid=08955948" defer></script>
-    <script type="text/javascript" src="./skin/viewer.js?cacheid=00e0fdf3" defer></script>
+    <script type="text/javascript" src="./skin/viewer.js?cacheid=6192cae1" defer></script>
     <script type="text/javascript" src="./skin/autoComplete/autoComplete.min.js?cacheid=1191aaaf"></script>
       const blankPageUrl = root + "/skin/blank.html?cacheid=6b1fa032";
           <label for="kiwix_button_show_toggle"><img src="./skin/caret.png?cacheid=22b942b4" alt=""></label>

test/server_search.cpp

@@ -689,6 +689,24 @@ bool isSubSnippet(std::string subSnippet, const std::string& superSnippet)
 #define  RAYCHARLESZIMID "6f1d19d0-633f-087b-fb55-7ac324ff9baf"
 #define  EXAMPLEZIMID    "5dc0b3af-5df2-0925-f0ca-d2bf75e78af6"
 
+const std::vector<SearchResult> YELLOW_SEARCH_RESULTS = {
+  SEARCH_RESULT(
+    /*link*/        "/ROOT%23%3F/content/zimfile/A/Eleanor_Rigby",
+    /*title*/       "Eleanor Rigby",
+    /*snippet*/     R"SNIPPET(...-side "<b>Yellow</b> Submarine" (double A-side) Released 5)SNIPPET" "\xC2\xA0" "August" "\xC2\xA0" "1966" "\xC2\xA0" R"SNIPPET((1966-08-05) Format 7-inch single Recorded 28–29 April &amp; 6 June 1966 Studio EMI, London Genre Baroque pop, art rock Length 2:08 Label Parlophone (UK), Capitol (US) Songwriter(s) Lennon–McCartney Producer(s) George Martin The Beatles singles chronology "Paperback Writer" (1966) "Eleanor Rigby" / "<b>Yellow</b> Submarine" (1966) "Strawberry Fields Forever" / "Penny Lane" (1967) Music video "Eleanor Rigby" on YouTube The song continued the......)SNIPPET",
+    /*bookTitle*/  "Ray Charles",
+    /*wordCount*/  "201"
+  ),
+
+  SEARCH_RESULT(
+    /*link*/        "/ROOT%23%3F/content/zimfile/A/If_You_Go_Away",
+    /*title*/       "If You Go Away",
+    /*snippet*/     R"SNIPPET(...standard and has been recorded by many artists, including Greta Keller, for whom some say McKuen wrote the lyrics. "If You Go Away" Single by Damita Jo from the album If You Go Away B-side "<b>Yellow</b> Days" Released 1966 Genre Jazz Length 3:49 Label Epic Records Songwriter(s) Jacques Brel, Rod McKuen Producer(s) Bob Morgan Damita Jo singles chronology "Gotta Travel On" (1965) "If You Go Away" (1966) "Walk Away" (1967) Damita Jo reached #10 on the Adult Contemporary chart and #68 on the Billboard Hot 100 in 1966 for her version of the song. Terry Jacks recorded a version of the song which was released as a single in 1974 and reached #29 on the Adult Contemporary chart, #68 on the......)SNIPPET",
+    /*bookTitle*/  "Ray Charles",
+    /*wordCount*/  "204"
+  )
+};
+
 struct TestData
 {
   struct PaginationEntry
@@ -980,23 +998,7 @@ TEST(ServerSearchTest, searchResults)
       /* resultsPerPage */   0,
       /* totalResultCount */ 2,
       /* firstResultIndex */ 0,
-      /* results */ {
-        SEARCH_RESULT(
-          /*link*/       "/ROOT%23%3F/content/zimfile/A/Eleanor_Rigby",
-          /*title*/      "Eleanor Rigby",
-          /*snippet*/    R"SNIPPET(...-side "<b>Yellow</b> Submarine" (double A-side) Released 5 August 1966 (1966-08-05) Format 7-inch single Recorded 28–29 April &amp; 6 June 1966 Studio EMI, London Genre Baroque pop, art rock Length 2:08 Label Parlophone (UK), Capitol (US) Songwriter(s) Lennon–McCartney Producer(s) George Martin The Beatles singles chronology "Paperback Writer" (1966) "Eleanor Rigby" / "<b>Yellow</b> Submarine" (1966) "Strawberry Fields Forever" / "Penny Lane" (1967) Music video "Eleanor Rigby" on YouTube The song continued the......)SNIPPET",
-          /*bookTitle*/  "Ray Charles",
-          /*wordCount*/  "201"
-        ),
-
-        SEARCH_RESULT(
-          /*link*/       "/ROOT%23%3F/content/zimfile/A/If_You_Go_Away",
-          /*title*/      "If You Go Away",
-          /*snippet*/    R"SNIPPET(...standard and has been recorded by many artists, including Greta Keller, for whom some say McKuen wrote the lyrics. "If You Go Away" Single by Damita Jo from the album If You Go Away B-side "<b>Yellow</b> Days" Released 1966 Genre Jazz Length 3:49 Label Epic Records Songwriter(s) Jacques Brel, Rod McKuen Producer(s) Bob Morgan Damita Jo singles chronology "Gotta Travel On" (1965) "If You Go Away" (1966) "Walk Away" (1967) Damita Jo reached #10 on the Adult Contemporary chart and #68 on the Billboard Hot 100 in 1966 for her version of the song. Terry Jacks recorded a version of the song which was released as a single in 1974 and reached #29 on the Adult Contemporary chart, #68 on the......)SNIPPET",
-          /*bookTitle*/  "Ray Charles",
-          /*wordCount*/  "204"
-        )
-      },
+      /* results */          YELLOW_SEARCH_RESULTS,
       /* pagination */ {}
     },
 
@@ -1006,23 +1008,7 @@ TEST(ServerSearchTest, searchResults)
       /* resultsPerPage */   0,
       /* totalResultCount */ 2,
       /* firstResultIndex */ 0,
-      /* results */ {
-        SEARCH_RESULT(
-          /*link*/       "/ROOT%23%3F/content/zimfile/A/Eleanor_Rigby",
-          /*title*/      "Eleanor Rigby",
-          /*snippet*/    R"SNIPPET(...-side "<b>Yellow</b> Submarine" (double A-side) Released 5 August 1966 (1966-08-05) Format 7-inch single Recorded 28–29 April &amp; 6 June 1966 Studio EMI, London Genre Baroque pop, art rock Length 2:08 Label Parlophone (UK), Capitol (US) Songwriter(s) Lennon–McCartney Producer(s) George Martin The Beatles singles chronology "Paperback Writer" (1966) "Eleanor Rigby" / "<b>Yellow</b> Submarine" (1966) "Strawberry Fields Forever" / "Penny Lane" (1967) Music video "Eleanor Rigby" on YouTube The song continued the......)SNIPPET",
-          /*bookTitle*/  "Ray Charles",
-          /*wordCount*/  "201"
-        ),
-
-        SEARCH_RESULT(
-          /*link*/       "/ROOT%23%3F/content/zimfile/A/If_You_Go_Away",
-          /*title*/      "If You Go Away",
-          /*snippet*/    R"SNIPPET(...standard and has been recorded by many artists, including Greta Keller, for whom some say McKuen wrote the lyrics. "If You Go Away" Single by Damita Jo from the album If You Go Away B-side "<b>Yellow</b> Days" Released 1966 Genre Jazz Length 3:49 Label Epic Records Songwriter(s) Jacques Brel, Rod McKuen Producer(s) Bob Morgan Damita Jo singles chronology "Gotta Travel On" (1965) "If You Go Away" (1966) "Walk Away" (1967) Damita Jo reached #10 on the Adult Contemporary chart and #68 on the Billboard Hot 100 in 1966 for her version of the song. Terry Jacks recorded a version of the song which was released as a single in 1974 and reached #29 on the Adult Contemporary chart, #68 on the......)SNIPPET",
-          /*bookTitle*/  "Ray Charles",
-          /*wordCount*/  "204"
-        )
-      },
+      /* results */         YELLOW_SEARCH_RESULTS,
       /* pagination */ {}
     },
 
@@ -1032,23 +1018,7 @@ TEST(ServerSearchTest, searchResults)
       /* resultsPerPage */   0,
       /* totalResultCount */ 2,
       /* firstResultIndex */ 0,
-      /* results */ {
-        SEARCH_RESULT(
-          /*link*/       "/ROOT%23%3F/content/zimfile/A/Eleanor_Rigby",
-          /*title*/      "Eleanor Rigby",
-          /*snippet*/    R"SNIPPET(...-side "<b>Yellow</b> Submarine" (double A-side) Released 5 August 1966 (1966-08-05) Format 7-inch single Recorded 28–29 April &amp; 6 June 1966 Studio EMI, London Genre Baroque pop, art rock Length 2:08 Label Parlophone (UK), Capitol (US) Songwriter(s) Lennon–McCartney Producer(s) George Martin The Beatles singles chronology "Paperback Writer" (1966) "Eleanor Rigby" / "<b>Yellow</b> Submarine" (1966) "Strawberry Fields Forever" / "Penny Lane" (1967) Music video "Eleanor Rigby" on YouTube The song continued the......)SNIPPET",
-          /*bookTitle*/  "Ray Charles",
-          /*wordCount*/  "201"
-        ),
-
-        SEARCH_RESULT(
-          /*link*/       "/ROOT%23%3F/content/zimfile/A/If_You_Go_Away",
-          /*title*/      "If You Go Away",
-          /*snippet*/    R"SNIPPET(...standard and has been recorded by many artists, including Greta Keller, for whom some say McKuen wrote the lyrics. "If You Go Away" Single by Damita Jo from the album If You Go Away B-side "<b>Yellow</b> Days" Released 1966 Genre Jazz Length 3:49 Label Epic Records Songwriter(s) Jacques Brel, Rod McKuen Producer(s) Bob Morgan Damita Jo singles chronology "Gotta Travel On" (1965) "If You Go Away" (1966) "Walk Away" (1967) Damita Jo reached #10 on the Adult Contemporary chart and #68 on the Billboard Hot 100 in 1966 for her version of the song. Terry Jacks recorded a version of the song which was released as a single in 1974 and reached #29 on the Adult Contemporary chart, #68 on the......)SNIPPET",
-          /*bookTitle*/  "Ray Charles",
-          /*wordCount*/  "204"
-        )
-      },
+      /* results */          YELLOW_SEARCH_RESULTS,
       /* pagination */ {}
     },
 
@@ -1062,6 +1032,16 @@ TEST(ServerSearchTest, searchResults)
       /* pagination */ {}
     },
 
+    {
+      /* query */          "pattern=yellow%20submarine&books.id=" RAYCHARLESZIMID,
+      /* start */            0,
+      /* resultsPerPage */   0,
+      /* totalResultCount */ 1,
+      /* firstResultIndex */ 0,
+      /* results */          { YELLOW_SEARCH_RESULTS[0] },
+      /* pagination */       {}
+    },
+
     {
       /* query */          "pattern=jazz&books.id=" RAYCHARLESZIMID
                            "&userlang=test",

test/spelling_correction.cpp

@@ -173,7 +173,8 @@ void testSpellingCorrections(const kiwix::SpellingsDB& spellingsDB)
   EXPECT_SPELLING_CORRECTION("Loremipsum", 1, ({"Lorem ipsum"}));
 
   // Only one spelling correction can be requested
-  EXPECT_SPELLING_CORRECTION("Kung",  2, ({"King", "Kong"}));
+  // EXPECT_SPELLING_CORRECTION("Kung",  2, ({"King", "Kong"}));
+  EXPECT_THROW(spellingsDB.getSpellingCorrections("Kung", 2), std::runtime_error);
 }
 
 using StrCollection = std::vector<std::string>;
@@ -189,21 +190,21 @@ StrCollection directoryEntries(std::filesystem::path dirPath)
 
 TEST_F(SpellingCorrectionTest, allInOne)
 {
-  //const auto tmpDirModTime0 = std::filesystem::last_write_time(tmpDirPath);
+  const auto tmpDirModTime0 = std::filesystem::last_write_time(tmpDirPath);
   ASSERT_TRUE(directoryEntries(tmpDirPath).empty());
   {
     const kiwix::SpellingsDB spellingsDB(*archive, tmpDirPath);
     testSpellingCorrections(spellingsDB);
   }
 
-  //const auto tmpDirModTime1 = std::filesystem::last_write_time(tmpDirPath);
+  const auto tmpDirModTime1 = std::filesystem::last_write_time(tmpDirPath);
 
-  const auto spellingsDbPath = tmpDirPath / "554c9707-897e-097a-53ba-1b1306d8bb88.spellingsdb.v0.2";
+  const auto spellingsDbPath = tmpDirPath / "554c9707-897e-097a-53ba-1b1306d8bb88.spellingsdb.v0.1";
 
   const StrCollection EXPECTED_DIR_CONTENT{ spellingsDbPath.string() };
   ASSERT_EQ(directoryEntries(tmpDirPath), EXPECTED_DIR_CONTENT);
-  //ASSERT_LT(tmpDirModTime0, tmpDirModTime1);
-  //const auto fileModTime = std::filesystem::last_write_time(spellingsDbPath);
+  ASSERT_LT(tmpDirModTime0, tmpDirModTime1);
+  const auto fileModTime = std::filesystem::last_write_time(spellingsDbPath);
 
   {
     const kiwix::SpellingsDB spellingsDB(*archive, tmpDirPath);
@@ -211,6 +212,6 @@ TEST_F(SpellingCorrectionTest, allInOne)
   }
 
   ASSERT_EQ(directoryEntries(tmpDirPath), EXPECTED_DIR_CONTENT );
-  //ASSERT_EQ(tmpDirModTime1, std::filesystem::last_write_time(tmpDirPath));
-  //ASSERT_EQ(fileModTime,    std::filesystem::last_write_time(spellingsDbPath));
+  ASSERT_EQ(tmpDirModTime1, std::filesystem::last_write_time(tmpDirPath));
+  ASSERT_EQ(fileModTime,    std::filesystem::last_write_time(spellingsDbPath));
 }