Rename 'new-browse' to 'browse', remove dead search explanation code

ysangkok · ysangkok · commit b6abd00ba06e · 2022-03-24T23:55:19.000-05:00
diff --git a/datafiles/static/browse.js b/datafiles/static/browse.js
@@ -2,7 +2,7 @@ const d = document;
 
 const initialParams = new URL(d.location).searchParams;
 // This parameter is named 'terms' because it is from before filters were
-// introduced. But we will parse it a normal search string (including filters)
+// introduced. But we will parse it as a normal search string (including filters)
 const initialSearchQuery = initialParams.has('terms') ? initialParams.get('terms') : ''
 d.querySelector("#searchQuery").value = initialSearchQuery;
 
@@ -212,9 +212,9 @@ const refresh = async () => {
   container.appendChild(createIndexIndicator());
   container.appendChild(createPaginator());
   if (state.searchQuery.trim() === "") {
-    d.querySelector("#newBrowseFooter").style.display = "none";
+    d.querySelector("#browseFooter").style.display = "none";
   } else {
-    d.querySelector("#newBrowseFooter").style.display = "block";
+    d.querySelector("#browseFooter").style.display = "block";
     const url = new URL(hoogleNoParam);
     url.searchParams.set("hoogle", state.searchQuery);
     d.querySelector("#hoogleLink").setAttribute("href", url);
diff --git a/datafiles/templates/Html/browse.html.st b/datafiles/templates/Html/browse.html.st
@@ -9,7 +9,7 @@
       width: 50vw;
       margin-left: 0;
     }
-    #newBrowse th a {
+    #browseTable th a {
       display:block;
       color: inherit;
       text-decoration: inherit;
@@ -29,26 +29,26 @@
     .commaList li:last-child::after {
       content: "";
     }
-    #newBrowse {
+    #browseTable {
       width: 100%;
       margin-top: 3em;
     }
-    #newBrowse th, #newBrowse td {
+    #browseTable th, #browseTable td {
       padding: 4px 17px 4px 4px;
     }
-    #newBrowse th {
+    #browseTable th {
       border-bottom: 1px solid #111;
     }
-    #newBrowse th {
+    #browseTable th {
       background-repeat: no-repeat;
       background-image: url(/static/images/sort_both.png);
       background-position: center right;
       padding-right: 0;
     }
-    #newBrowse th.ascending {
+    #browseTable th.ascending {
       background-image: url(/static/images/sort_asc.png);
     }
-    #newBrowse th.descending {
+    #browseTable th.descending {
       background-image: url(/static/images/sort_desc.png);
     }
     .paginator {
@@ -133,7 +133,7 @@
     .lastUpload, #sliderAndOutput {
       white-space: nowrap;
     }
-    #newBrowseFooter {
+    #browseFooter {
       display: none;
     }
     #toggleAdvanced {
@@ -225,7 +225,7 @@
         <dd>Only show packages that are available in the Debian distribution. See the <a href="/distros">full list of available distributions</a>.</dd>
       </dl>
       </div>
-      <table id=newBrowse class=fancy>
+      <table id=browseTable class=fancy>
         <thead>
           <tr>
             <th id=arrow-name><a href="javascript: sort('name')">Name</a></th>
@@ -242,7 +242,7 @@
       <script type=module>
       import { sort, submitSearch, toggleAdvanced, appendDeprecated, appendAgeOfLastUL,
                appendTag, appendRating, validateAgeOfLastUL, validateTag }
-             from "/static/new-browse.js";
+             from "/static/browse.js";
       window.sort = sort;
       window.submitSearch = submitSearch;
       window.toggleAdvanced = toggleAdvanced;
@@ -255,7 +255,7 @@
       </script>
       <div id=paginatorContainer>
       </div>
-      <div id=newBrowseFooter>
+      <div id=browseFooter>
       Alternatively, if you are looking for a particular function then try <a href="#" id=hoogleLink target=_blank>Hoogle</a>.
       </div>
     </div>
diff --git a/src/Distribution/Server/Features.hs b/src/Distribution/Server/Features.hs
@@ -21,7 +21,7 @@ import Distribution.Server.Features.Upload   (initUploadFeature)
 import Distribution.Server.Features.Mirror   (initMirrorFeature)
 
 #ifndef MINIMAL
-import Distribution.Server.Features.Browse (initNewBrowseFeature)
+import Distribution.Server.Features.Browse              (initBrowseFeature)
 import Distribution.Server.Features.TarIndexCache       (initTarIndexCacheFeature)
 import Distribution.Server.Features.Html                (initHtmlFeature)
 import Distribution.Server.Features.PackageCandidates   (initPackageCandidatesFeature, candidatesCoreResource, queryGetCandidateIndex)
@@ -153,8 +153,8 @@ initHackageFeatures env@ServerEnv{serverVerbosity = verbosity} = do
                                initSitemapFeature env
     mkPackageFeedFeature    <- logStartup "package feed" $
                                initPackageFeedFeature env
-    mkNewBrowseFeature      <- logStartup "new browse" $
-                               initNewBrowseFeature env
+    mkBrowseFeature         <- logStartup "browse" $
+                               initBrowseFeature env
     mkPackageJSONFeature    <- logStartup "package info JSON" $
                                initPackageInfoJSONFeature env
 #endif
@@ -330,7 +330,7 @@ initHackageFeatures env@ServerEnv{serverVerbosity = verbosity} = do
                             usersFeature
                             tarIndexCacheFeature
 
-    browseFeature <- mkNewBrowseFeature
+    browseFeature <- mkBrowseFeature
                        coreFeature
                        usersFeature
                        tagsFeature
diff --git a/src/Distribution/Server/Features/Browse.hs b/src/Distribution/Server/Features/Browse.hs
@@ -1,5 +1,5 @@
 {-# LANGUAGE BlockArguments, NamedFieldPuns, TupleSections #-}
-module Distribution.Server.Features.Browse (initNewBrowseFeature, PaginationConfig(..), StartIndex(..), NumElems(..), paginate) where
+module Distribution.Server.Features.Browse (initBrowseFeature, PaginationConfig(..), StartIndex(..), NumElems(..), paginate) where
 
 import Control.Arrow (left)
 import Control.Monad.Except (ExceptT, liftIO, throwError)
@@ -40,8 +40,8 @@ type BrowseFeature =
     -> DistroFeature
     -> IO HackageFeature
 
-initNewBrowseFeature :: ServerEnv -> IO BrowseFeature
-initNewBrowseFeature _env =
+initBrowseFeature :: ServerEnv -> IO BrowseFeature
+initBrowseFeature _env =
   pure \coreFeature userFeature tagsFeature listFeature searchFeature distroFeature ->
     pure $
       (emptyHackageFeature "json")
diff --git a/src/Distribution/Server/Features/Html.hs b/src/Distribution/Server/Features/Html.hs
@@ -60,14 +60,13 @@ import Distribution.Package
 import Distribution.Version
 import Distribution.Text (display)
 
-import Data.Char (toLower)
 import Data.List (intercalate, intersperse, insert)
 import Data.Function (on)
 import qualified Data.Map as Map
 import qualified Data.Set as Set
 import qualified Data.Vector as Vec
 import qualified Data.Text as T
-import qualified Data.ByteString.Lazy.Char8 as BS (ByteString, pack)
+import qualified Data.ByteString.Lazy.Char8 as BS (ByteString)
 import qualified Network.URI as URI
 
 import Text.XHtml.Strict
@@ -129,11 +128,11 @@ initHtmlFeature env@ServerEnv{serverTemplatesDir, serverTemplatesMode,
                    , "tag-edit.html"
                    , "candidate-page.html"
                    , "candidate-index.html"
-                   , "new-browse.html"
+                   , "browse.html"
                    ]
 
 
-    return $ \user@UserFeature{groupChangedHook} core@CoreFeature{packageChangeHook}
+    return $ \user core@CoreFeature{packageChangeHook}
               packages upload
               candidates versions
               -- [reverse index disabled] reverse
@@ -147,7 +146,7 @@ initHtmlFeature env@ServerEnv{serverTemplatesDir, serverTemplatesMode,
               reportsCore
               usersdetails -> do
       -- do rec, tie the knot
-      rec let (feature, packageIndex, packagesPage, browseTable) =
+      rec let (feature, packageIndex, packagesPage) =
                 htmlFeature env user core
                             packages upload
                             candidates versions
@@ -160,7 +159,7 @@ initHtmlFeature env@ServerEnv{serverTemplatesDir, serverTemplatesMode,
                             reportsCore
                             usersdetails
                             (htmlUtilities core candidates tags user)
-                            mainCache namesCache browseCache
+                            mainCache namesCache
                             templates
 
           -- Index page caches
@@ -178,23 +177,13 @@ initHtmlFeature env@ServerEnv{serverTemplatesDir, serverTemplatesMode,
                             asyncCacheUpdateDelay  = serverCacheDelay,
                             asyncCacheLogVerbosity = verbosity
                           }
-          browseCache <- newAsyncCacheNF browseTable
-                          defaultAsyncCachePolicy {
-                            asyncCacheName = "browse packages",
-                            asyncCacheUpdateDelay  = serverCacheDelay,
-                            asyncCacheLogVerbosity = verbosity
-                          }
 
       registerHook itemUpdate $ \_ -> do
         prodAsyncCache mainCache  "item update"
         prodAsyncCache namesCache "item update"
-        prodAsyncCache browseCache "item update"
       registerHook packageChangeHook $ \_ -> do
         prodAsyncCache mainCache  "package change"
         prodAsyncCache namesCache "package change"
-        prodAsyncCache browseCache "package change"
-      registerHook groupChangedHook $ \_ -> do
-        prodAsyncCache browseCache "package change"
 
       return feature
 
@@ -220,9 +209,8 @@ htmlFeature :: ServerEnv
             -> HtmlUtilities
             -> AsyncCache Response
             -> AsyncCache Response
-            -> AsyncCache BS.ByteString
             -> Templates
-            -> (HtmlFeature, IO Response, IO Response, IO BS.ByteString)
+            -> (HtmlFeature, IO Response, IO Response)
 
 htmlFeature env@ServerEnv{..}
             user
@@ -232,17 +220,17 @@ htmlFeature env@ServerEnv{..}
             -- [reverse index disabled] ReverseFeature{..}
             tags download
             rank
-            list@ListFeature{getAllLists, makeItemList}
+            list@ListFeature{getAllLists}
             names
             mirror distros
             docsCore docsCandidates
             tarIndexCache
             reportsCore
             usersdetails
             utilities@HtmlUtilities{..}
-            cachePackagesPage cacheNamesPage cacheBrowseTable
+            cachePackagesPage cacheNamesPage
             templates
-  = (HtmlFeature{..}, packageIndex, packagesPage, browseTable)
+  = (HtmlFeature{..}, packageIndex, packagesPage)
   where
     htmlFeatureInterface = (emptyHackageFeature "html") {
         featureResources = htmlResources
@@ -256,10 +244,6 @@ htmlFeature env@ServerEnv{..}
              cacheDesc       = "packages page by name",
              getCacheMemSize = memSize <$> readAsyncCache cacheNamesPage
            }
-         , CacheComponent {
-             cacheDesc       = "package browse page",
-             getCacheMemSize = memSize <$> readAsyncCache cacheBrowseTable
-           }
          ]
       , featurePostInit = syncAsyncCache cachePackagesPage
       , featureReloadFiles = reloadTemplates templates
@@ -283,7 +267,6 @@ htmlFeature env@ServerEnv{..}
                                       htmlPreferred
                                       cachePackagesPage
                                       cacheNamesPage
-                                      cacheBrowseTable
                                       templates
                                       names
                                       candidates
@@ -430,15 +413,6 @@ htmlFeature env@ServerEnv{..}
                 ]
         return htmlpage
 
-    browseTable :: IO BS.ByteString
-    browseTable = do
-      pkgIndex <- queryGetPackageIndex
-      let packageNames = sortOn (map toLower . unPackageName) $ Pages.toPackageNames pkgIndex
-      pkgDetails <- makeItemList packageNames
-      let rowList = map makeRow pkgDetails
-          tabledata = "" +++ rowList +++ ""
-      return . BS.pack . showHtmlFragment $ tabledata
-
     {-
     -- Currently unused, mainly because not all web browsers use eager authentication-sending
     -- Setting a cookie might work here, albeit one that's stateless for the server, is not
@@ -484,7 +458,6 @@ mkHtmlCore :: ServerEnv
            -> HtmlPreferred
            -> AsyncCache Response
            -> AsyncCache Response
-           -> AsyncCache BS.ByteString
            -> Templates
            -> SearchFeature
            -> PackageCandidatesFeature
@@ -511,7 +484,6 @@ mkHtmlCore ServerEnv{serverBaseURI, serverBlobStore}
            HtmlPreferred{..}
            cachePackagesPage
            cacheNamesPage
-           _cacheBrowseTable
            templates
            SearchFeature{..}
            PackageCandidatesFeature{..}
@@ -566,7 +538,7 @@ mkHtmlCore ServerEnv{serverBaseURI, serverBlobStore}
 
     serveBrowsePage :: DynamicPath -> ServerPartE Response
     serveBrowsePage _dpath = do
-      template <- getTemplate templates "new-browse.html"
+      template <- getTemplate templates "browse.html"
       return $ toResponse $ template
           [ "heading" $= "Browse and search packages" ]
 
diff --git a/src/Distribution/Server/Features/Search.hs b/src/Distribution/Server/Features/Search.hs
@@ -1,13 +1,7 @@
-{-# LANGUAGE RankNTypes, NamedFieldPuns, RecordWildCards, RecursiveDo #-}
+{-# LANGUAGE RankNTypes, NamedFieldPuns, RecordWildCards #-}
 module Distribution.Server.Features.Search (
-    SearchFeature(..),
+    SearchFeature(SearchFeature, searchPackages, searchPackagesResource),
     initSearchFeature,
-
-    -- * Search parameters
-    defaultSearchRankParameters,
-    SearchEngine.SearchRankParameters(..),
-    PkgDocField, PkgDocFeatures,
-    BM25F.Explanation(..),
   ) where
 
 import Distribution.Server.Framework
@@ -17,9 +11,7 @@ import Distribution.Server.Features.Core
 import Distribution.Server.Features.PackageList
 
 import Distribution.Server.Features.Search.PkgSearch
-import Distribution.Server.Features.Search.SearchEngine (SearchRankParameters(..))
 import qualified Distribution.Server.Features.Search.SearchEngine as SearchEngine
-import qualified Distribution.Server.Features.Search.BM25F as BM25F
 import qualified Distribution.Server.Packages.PackageIndex as PackageIndex
 
 import Distribution.Server.Packages.Types
@@ -38,13 +30,7 @@ data SearchFeature = SearchFeature {
 
     searchPackagesResource :: Resource,
 
-    searchPackages        :: forall m. MonadIO m => [String] -> m [PackageName],
-    searchPackagesExplain :: forall m. MonadIO m
-                          => SearchRankParameters PkgDocField PkgDocFeatures
-                          -> [String]
-                          -> m (Maybe PackageName,
-                               [(BM25F.Explanation PkgDocField PkgDocFeatures T.Text
-                                ,PackageName)])
+    searchPackages        :: forall m. MonadIO m => [String] -> m [PackageName]
 }
 
 instance IsHackageFeature SearchFeature where
@@ -156,17 +142,6 @@ searchFeature ServerEnv{serverBaseURI} CoreFeature{..} ListFeature{getAllLists}
         let results = SearchEngine.query se (map T.pack terms)
         return results
 
-    searchPackagesExplain :: MonadIO m
-                          => SearchRankParameters PkgDocField PkgDocFeatures
-                          -> [String]
-                          -> m (Maybe PackageName, [(BM25F.Explanation PkgDocField PkgDocFeatures T.Text, PackageName)])
-    searchPackagesExplain params terms = do
-        se <- readMemState searchEngineState
-        let results = SearchEngine.queryExplain
-                        (SearchEngine.setRankParams params se)
-                        (map T.pack terms)
-        return results
-
     handlerGetOpenSearch :: DynamicPath -> ServerPartE Response
     handlerGetOpenSearch _ = do
       template <- getTemplate templates "opensearch.xml"
diff --git a/src/Distribution/Server/Features/Search/BM25F.hs b/src/Distribution/Server/Features/Search/BM25F.hs
diff --git a/src/Distribution/Server/Features/Search/PkgSearch.hs b/src/Distribution/Server/Features/Search/PkgSearch.hs
diff --git a/src/Distribution/Server/Features/Search/SearchEngine.hs b/src/Distribution/Server/Features/Search/SearchEngine.hs
