PackageRank

.github/workflows/haskell-ci.yml

@@ -8,18 +8,24 @@
 #
 # For more information, see https://github.com/haskell-CI/haskell-ci
 #
-# version: 0.14.3.20220416
+# version: 0.15.20220822
 #
-# REGENDATA ("0.14.3.20220416",["github","hackage-server.cabal"])
+# REGENDATA ("0.15.20220822",["github","hackage-server.cabal"])
 #
 name: Haskell-CI
 on:
-  - push
-  - pull_request
+  push:
+    branches:
+      - master
+      - ci*
+  pull_request:
+    branches:
+      - master
+      - ci*
 jobs:
   linux:
     name: Haskell-CI - Linux - ${{ matrix.compiler }}
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     timeout-minutes:
       60
     container:
@@ -28,9 +34,9 @@ jobs:
     strategy:
       matrix:
         include:
-          - compiler: ghc-9.2.2
+          - compiler: ghc-9.2.4
             compilerKind: ghc
-            compilerVersion: 9.2.2
+            compilerVersion: 9.2.4
             setup-method: ghcup
             allow-failure: false
           - compiler: ghc-9.0.2
@@ -56,20 +62,20 @@ jobs:
           apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common libtinfo5
           if [ "${{ matrix.setup-method }}" = ghcup ]; then
             mkdir -p "$HOME/.ghcup/bin"
-            curl -sL https://downloads.haskell.org/ghcup/0.1.17.5/x86_64-linux-ghcup-0.1.17.5 > "$HOME/.ghcup/bin/ghcup"
+            curl -sL https://downloads.haskell.org/ghcup/0.1.18.0/x86_64-linux-ghcup-0.1.18.0 > "$HOME/.ghcup/bin/ghcup"
             chmod a+x "$HOME/.ghcup/bin/ghcup"
-            "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER"
-            "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0
+            "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER" || (cat "$HOME"/.ghcup/logs/*.* && false)
+            "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0 || (cat "$HOME"/.ghcup/logs/*.* && false)
             apt-get update
             apt-get install -y libbrotli-dev
           else
             apt-add-repository -y 'ppa:hvr/ghc'
             apt-get update
             apt-get install -y "$HCNAME" libbrotli-dev
             mkdir -p "$HOME/.ghcup/bin"
-            curl -sL https://downloads.haskell.org/ghcup/0.1.17.5/x86_64-linux-ghcup-0.1.17.5 > "$HOME/.ghcup/bin/ghcup"
+            curl -sL https://downloads.haskell.org/ghcup/0.1.18.0/x86_64-linux-ghcup-0.1.18.0 > "$HOME/.ghcup/bin/ghcup"
             chmod a+x "$HOME/.ghcup/bin/ghcup"
-            "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0
+            "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0 || (cat "$HOME"/.ghcup/logs/*.* && false)
           fi
         env:
           HCKIND: ${{ matrix.compilerKind }}
@@ -212,7 +218,7 @@ jobs:
           ${CABAL} -vnormal check
       - name: haddock
         run: |
-          $CABAL v2-haddock $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
+          $CABAL v2-haddock --haddock-all $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
       - name: unconstrained build
         run: |
           rm -f cabal.project.local

.github/workflows/nix-shell.yml

@@ -1,7 +1,13 @@
 name: "Test nix-shell"
 on:
-  - push
-  - pull_request
+  push:
+    branches:
+      - master
+      - ci*
+  pull_request:
+    branches:
+      - master
+      - ci*
 jobs:
   nix-shell:
     runs-on: ubuntu-latest

cabal.haskell-ci

@@ -1,3 +1,5 @@
+branches: master ci*
+
 installed: +all -Cabal -text -parsec
 
 -- -- irc-channels works with GHA, but why send to a channel
@@ -11,4 +13,9 @@ installed: +all -Cabal -text -parsec
 -- Use Ubuntu 20.04
 distribution: focal
 
-apt: libbrotli-dev
+apt: libbrotli-dev
+
+-- Make sure the haddock step is included,
+-- even though we don't define any library.
+haddock-components: all
+  -- since haskell-ci 0.15.20220822

datafiles/static/browse.js

@@ -134,6 +134,7 @@ const replaceRows = (response) => {
     tr.appendChild(createTags(row.tags));
     tr.appendChild(createLastUpload(row.lastUpload));
     tr.appendChild(createMaintainers(row.maintainers));
+    tr.appendChild(createSimpleText(row.packageRank));
     l.appendChild(tr);
   }
 };

datafiles/templates/Html/browse.html.st

@@ -130,6 +130,9 @@
     #arrow-maintainers {
       width: 100px;
     }
+    #arrow-packageRank {
+      width: 150px;
+    }
     .lastUpload, #sliderAndOutput {
       white-space: nowrap;
     }
@@ -250,6 +253,7 @@
               <th id=arrow-tags><a href="javascript: sort('tags')">Tags</a></th>
               <th id=arrow-lastUpload><a href="javascript: sort('lastUpload')">Last U/L</a></th>
               <th id=arrow-maintainers><a href="javascript: sort('maintainers')">Maintainers</a></th>
+              <th id=arrow-packageRank><a href="javascript: sort('packageRank')">Package Rank</a></th>
             </tr>
           </thead>
           <tbody id="listing"></tbody>

datafiles/templates/Html/noscript-search-form.html.st

@@ -23,6 +23,7 @@
         <option $if(tags)$        selected $endif$ value=tags>tags</option>
         <option $if(lastUpload)$  selected $endif$ value=lastUpload>date of last upload</option>
         <option $if(maintainers)$ selected $endif$ value=maintainers>maintainers</option>
+        <option $if(packageRank)$ selected $endif$ value=packageRank>rank of the package</option>
       </select>
     </label>
   </div>

hackage-server.cabal

@@ -27,7 +27,7 @@ copyright:    2008-2015 Duncan Coutts,
 license:      BSD-3-Clause
 license-file: LICENSE
 
-tested-with: GHC == { 9.2.2, 9.0.2, 8.10.7, 8.8.4 }
+tested-with: GHC == { 9.2.4, 9.0.2, 8.10.7, 8.8.4 }
 
 data-dir: datafiles
 data-files:
@@ -116,8 +116,11 @@ common defaults
     , scientific
   -- other dependencies shared by most components
   build-depends:
-    , aeson                 ^>= 2.0.3.0
+    , aeson                 ^>= 2.0.3.0 || ^>= 2.1.0.0
     , Cabal                 ^>= 3.6.3.0
+    , Cabal-syntax          ^>= 3.6.0.0
+        -- Cabal-syntax needs to be bound to constrain hackage-security
+        -- see https://github.com/haskell/hackage-server/issues/1130
     , fail                  ^>= 4.9.0
       -- we use Control.Monad.Except, introduced in mtl-2.2.1
     , network               >=  3 && < 3.2
@@ -126,7 +129,7 @@ common defaults
     , parsec                ^>= 3.1.13
     , tar                   ^>= 0.5
     , unordered-containers  ^>= 0.2.10
-    , vector                ^>= 0.12
+    , vector                ^>= 0.12 || ^>= 0.13.0.0
     , zlib                  ^>= 0.6.2
 
   ghc-options: -Wall -fwarn-tabs -fno-warn-unused-do-bind -fno-warn-deprecated-flags -funbox-strict-fields
@@ -307,6 +310,8 @@ library lib-server
       Distribution.Server.Features.PackageCandidates.Backup
       Distribution.Server.Features.PackageFeed
       Distribution.Server.Features.PackageList
+      Distribution.Server.Features.PackageList.PackageRank
+      Distribution.Server.Features.PackageList.MStats
       Distribution.Server.Features.Distro
       Distribution.Server.Features.Distro.Distributions
       Distribution.Server.Features.Distro.Backup
@@ -374,7 +379,7 @@ library lib-server
     , async                 ^>= 2.2.1
     -- requires bumping http-io-streams
     , attoparsec            ^>= 0.14.4
-    , attoparsec-iso8601    ^>= 1.0
+    , attoparsec-iso8601    ^>= 1.0       || ^>= 1.1.0.0
     , base16-bytestring     ^>= 1.0
     -- requires bumping http-io-streams
     , base64-bytestring     ^>= 1.2.1.0
@@ -390,18 +395,23 @@ library lib-server
     , cryptohash-sha256     ^>= 0.11.100
     , csv                   ^>= 0.1
     , ed25519               ^>= 0.0.5
-    , hackage-security      ^>= 0.6
+    , hackage-security       >= 0.6 && < 0.7
+        -- N.B: hackage-security-0.6.2 uses Cabal-syntax-3.8.1.0
+        -- see https://github.com/haskell/hackage-server/issues/1130
+        -- Thus, we need to include Cabal-syntax as dependency explicitly
     , hackage-security-HTTP ^>= 0.1.1
-    , haddock-library       > 1.7 && < 2
-    , happstack-server      ^>= 7.7.1
-    , hashable              ^>= 1.3 || ^>= 1.4
+    , haddock-library       ^>= 1.11.0
+        -- haddock-library-1.11.0 changed type of markupOrderedList
+        -- see https://github.com/haskell/hackage-server/issues/1128
+    , happstack-server      ^>= 7.7.1     || ^>= 7.8.0
+    , hashable              ^>= 1.3       || ^>= 1.4
     , hslogger              ^>= 1.3.1
     , lifted-base           ^>= 0.2.1
     , mime-mail             ^>= 0.5
     , random                ^>= 1.2
     , rss                   ^>= 3000.2.0.7
     , safecopy              ^>= 0.10
-    , semigroups            ^>= 0.19
+    , semigroups            ^>= 0.20
     , split                 ^>= 0.2
     , stm                   ^>= 2.5.0
     , tagged                ^>= 0.8.5

src/Distribution/Server/Features.hs

@@ -285,6 +285,8 @@ initHackageFeatures env@ServerEnv{serverVerbosity = verbosity} = do
                          versionsFeature
                          usersFeature
                          uploadFeature
+                         documentationCoreFeature
+                         tarIndexCacheFeature
 
     searchFeature   <- mkSearchFeature
                          coreFeature

src/Distribution/Server/Features/Browse.hs

@@ -9,6 +9,7 @@ import qualified Data.Set as S
 import Data.Time (getCurrentTime)
 import Data.Time.Format.ISO8601 (iso8601Show)
 import System.FilePath ((</>))
+import GHC.Float.RealFracMethods (roundFloatInteger)
 
 import Data.Aeson (Value(Array), object, toJSON, (.=))
 import qualified Data.Aeson.Key as Key
@@ -138,7 +139,7 @@ packageIndexInfoToValue :: CoreResource -> TagsResource -> UserResource -> Packa
 packageIndexInfoToValue
   coreResource tagsResource userResource
   PackageItem{itemName, itemDownloads, itemVotes,
-    itemDesc, itemTags, itemLastUpload, itemMaintainer} =
+    itemDesc, itemTags, itemLastUpload, itemMaintainer, itemPackageRank} =
   object
     [ Key.fromString "name" .= renderPackage itemName
     , Key.fromString "downloads" .= itemDownloads
@@ -147,6 +148,7 @@ packageIndexInfoToValue
     , Key.fromString "tags" .= map renderTag (S.toAscList itemTags)
     , Key.fromString "lastUpload" .= iso8601Show itemLastUpload
     , Key.fromString "maintainers" .= map renderUser itemMaintainer
+    , Key.fromString "packageRank" .= (roundFloatInteger (1000 * itemPackageRank))
     ]
   where
   renderTag :: Tag -> Value

src/Distribution/Server/Features/Browse/ApplyFilter.hs

@@ -64,6 +64,7 @@ sort isSearch sortColumn sortDirection =
             Tags -> comparing (S.toAscList . itemTags)
             LastUpload -> comparing itemLastUpload
             Maintainers -> comparing itemMaintainer
+            PackageRank -> comparing itemPackageRank
        in sortBy (maybeReverse comparer)
   where
     maybeReverse =

src/Distribution/Server/Features/Browse/Options.hs

@@ -9,7 +9,7 @@ import Distribution.Server.Features.Browse.Parsers (Filter, conditions, condsToF
 
 data IsSearch = IsSearch | IsNotSearch
 
-data NormalColumn = Name | Downloads | Rating | Description | Tags | LastUpload | Maintainers
+data NormalColumn = Name | Downloads | Rating | Description | Tags | LastUpload | Maintainers | PackageRank
   deriving (Show, Eq)
 
 data Column = DefaultColumn | NormalColumn NormalColumn
@@ -37,6 +37,7 @@ instance FromJSON Column where
         "tags" -> pure $ NormalColumn Tags
         "lastUpload" -> pure $ NormalColumn LastUpload
         "maintainers" -> pure $ NormalColumn Maintainers
+        "packageRank" -> pure $ NormalColumn PackageRank
         t -> fail $ "Column invalid: " ++ T.unpack t
 
 columnToTemplateName :: Column -> String
@@ -49,6 +50,7 @@ columnToTemplateName = \case
   NormalColumn Tags -> "tags"
   NormalColumn LastUpload -> "lastUpload"
   NormalColumn Maintainers -> "maintainers"
+  NormalColumn PackageRank -> "packageRank"
 
 instance FromJSON Direction where
   parseJSON =

src/Distribution/Server/Features/HaskellPlatform.hs

@@ -1,6 +1,6 @@
 {-# LANGUAGE RankNTypes, NamedFieldPuns, RecordWildCards #-}
 module Distribution.Server.Features.HaskellPlatform (
-    PlatformFeature,
+    PlatformFeature(..),
     PlatformResource(..),
     initPlatformFeature,
   ) where