Parse 'installed' constraints

Cabal constraints, like those returned from stackage's cabal.config
endpoint, can specify packages in a number of ways, including
e.g. 'mtl installed'. Previously we were ignoring such constraints.

We now parse these too.

Author: tbidne

cabal.project

@@ -17,7 +17,6 @@ program-options
     -Wprepositive-qualified-module
     -Wredundant-constraints
     -Wunused-binds
-    -Wunused-packages
     -Wunused-type-patterns
     -Wno-unticked-promoted-constructors
 

clc-stackage.cabal

@@ -24,7 +24,6 @@ common common-lang
   if os(windows)
     cpp-options: -DWINDOWS
 
-  build-depends:      base >=4.16.0.0 && <4.22
   default-language:   GHC2021
 
 library utils
@@ -35,15 +34,19 @@ library utils
     CLC.Stackage.Utils.JSON
     CLC.Stackage.Utils.Logging
     CLC.Stackage.Utils.OS
+    CLC.Stackage.Utils.Package
     CLC.Stackage.Utils.Paths
 
   build-depends:
     , aeson            >=2.0       && <2.3
     , aeson-pretty     ^>=0.8.9
+    , base             >=4.16.0.0  && <4.22
     , bytestring       >=0.10.12.0 && <0.13
+    , deepseq          >=1.4.6.0   && <1.6
     , directory        ^>=1.3.5.0
     , file-io          ^>=0.1.0.0
     , filepath         >=1.4.100.0 && <1.6
+    , megaparsec       >=9.5.0     && <9.8
     , pretty-terminal  ^>=0.1.0.0
     , text             >=1.2.3.2   && <2.2
     , time             >=1.9.3     && <1.15
@@ -61,30 +64,32 @@ library parser
 
   build-depends:
     , aeson
+    , base
     , bytestring
     , containers       >=0.6.3.1 && <0.9
-    , deepseq          >=1.4.6.0 && <1.6
+    , deepseq
     , filepath
     , http-client      >=0.5.9   && <0.8
     , http-client-tls  ^>=0.3
     , http-types       ^>=0.12.3
+    , megaparsec
     , text
     , utils
 
   hs-source-dirs:  src/parser
+  ghc-options:     -Wunused-packages
 
 library builder
   import:          common-lang
   exposed-modules:
     CLC.Stackage.Builder
     CLC.Stackage.Builder.Batch
     CLC.Stackage.Builder.Env
-    CLC.Stackage.Builder.Package
     CLC.Stackage.Builder.Process
     CLC.Stackage.Builder.Writer
 
   build-depends:
-    , aeson
+    , base
     , containers
     , directory
     , filepath
@@ -93,6 +98,7 @@ library builder
     , utils
 
   hs-source-dirs:  src/builder
+  ghc-options:     -Wunused-packages
 
 library runner
   import:          common-lang
@@ -104,6 +110,7 @@ library runner
 
   build-depends:
     , aeson
+    , base
     , builder
     , containers
     , directory
@@ -116,17 +123,19 @@ library runner
     , utils
 
   hs-source-dirs:  src/runner
+  ghc-options:     -Wunused-packages
 
 executable clc-stackage
   import:         common-lang
   main-is:        Main.hs
   build-depends:
+    , base
     , runner
     , terminal-size  ^>=0.3.4
     , utils
 
   hs-source-dirs: ./app
-  ghc-options:    -threaded -with-rtsopts=-N
+  ghc-options:    -threaded -with-rtsopts=-N Wunused-packages
 
 library test-utils
   import:          common-lang
@@ -137,6 +146,7 @@ library test-utils
     , tasty-golden  ^>=2.3.1.1
 
   hs-source-dirs:  test/utils
+  ghc-options:     -Wunused-packages
 
 test-suite unit
   import:         common-lang
@@ -146,6 +156,7 @@ test-suite unit
     Unit.CLC.Stackage.Parser.API
     Unit.CLC.Stackage.Runner.Env
     Unit.CLC.Stackage.Runner.Report
+    Unit.CLC.Stackage.Utils.Package
     Unit.Prelude
 
   build-depends:
@@ -165,7 +176,7 @@ test-suite unit
     , utils
 
   hs-source-dirs: test/unit
-  ghc-options:    -threaded -with-rtsopts=-N
+  ghc-options:    -threaded -with-rtsopts=-N Wunused-packages
 
 test-suite functional
   import:         common-lang
@@ -187,3 +198,7 @@ test-suite functional
     , utils
 
   hs-source-dirs: test/functional
+
+-- For some reason -Wunused-packages is complaining about clc-stackage
+-- being an unnecessary dep for the functional test suite...hence it is
+-- removed from cabal.project and added manually to other targets.

src/builder/CLC/Stackage/Builder/Batch.hs

@@ -10,7 +10,7 @@ import CLC.Stackage.Builder.Env
         packagesToBuild
       ),
   )
-import CLC.Stackage.Builder.Package (Package)
+import CLC.Stackage.Utils.Package (Package)
 import Data.Bifunctor (Bifunctor (first))
 import Data.List qualified as L
 import Data.List.NonEmpty (NonEmpty ((:|)), (<|))

src/builder/CLC/Stackage/Builder/Env.hs

@@ -6,8 +6,8 @@ module CLC.Stackage.Builder.Env
   )
 where
 
-import CLC.Stackage.Builder.Package (Package)
 import CLC.Stackage.Utils.Logging qualified as Logging
+import CLC.Stackage.Utils.Package (Package)
 import Data.IORef (IORef)
 import Data.List.NonEmpty (NonEmpty)
 import Data.Set (Set)

src/builder/CLC/Stackage/Builder/Package.hs

@@ -18,10 +18,10 @@ import CLC.Stackage.Builder.Env
     WriteLogs (WriteLogsCurrent, WriteLogsNone, WriteLogsSaveFailures),
   )
 import CLC.Stackage.Builder.Env qualified as Env
-import CLC.Stackage.Builder.Package qualified as Package
 import CLC.Stackage.Builder.Writer qualified as Writer
 import CLC.Stackage.Utils.IO qualified as IO
 import CLC.Stackage.Utils.Logging qualified as Logging
+import CLC.Stackage.Utils.Package qualified as Package
 import CLC.Stackage.Utils.Paths qualified as Paths
 import Control.Exception (throwIO)
 import Control.Monad (when)
@@ -115,7 +115,7 @@ buildProject env idx pkgs = do
       mconcat
         [ T.pack $ show idx,
           ": ",
-          T.intercalate ", " (Package.toText <$> pkgsList)
+          T.intercalate ", " (Package.toTextInstalled <$> pkgsList)
         ]
     pkgsList = NE.toList pkgs.unPackageGroup
     pkgsSet = Set.fromList pkgsList

src/builder/CLC/Stackage/Builder/Process.hs

@@ -5,9 +5,9 @@ module CLC.Stackage.Builder.Writer
 where
 
 import CLC.Stackage.Builder.Batch (PackageGroup (unPackageGroup))
-import CLC.Stackage.Builder.Package (Package)
-import CLC.Stackage.Builder.Package qualified as Package
 import CLC.Stackage.Utils.IO qualified as IO
+import CLC.Stackage.Utils.Package (Package)
+import CLC.Stackage.Utils.Package qualified as Package
 import CLC.Stackage.Utils.Paths qualified as Paths
 import Data.List.NonEmpty qualified as NE
 import Data.Text (Text)
@@ -33,7 +33,7 @@ writeCabalProjectLocal pkgs = IO.writeBinaryFile path constraintsSrc
     path = Paths.generatedCabalProjectLocalPath
     constraintsSrc = TEnc.encodeUtf8 constraintsTxt
     constraintsTxt = T.unlines $ "constraints:" : constraints
-    constraints = (\p -> "  " <> Package.toText p <> ",") <$> pkgs
+    constraints = (\p -> "  " <> Package.toCabalConstraintsText p) <$> pkgs
 
 -- | Writes the package set to a cabal file for building. This will be called
 -- for each group we want to build.
@@ -60,7 +60,7 @@ mkCabalFile pkgs =
            "    default-language: Haskell2010"
          ]
   where
-    pkgsTxt = (\p -> pkgsIndent <> Package.toDepText p) <$> NE.toList pkgs.unPackageGroup
+    pkgsTxt = (\p -> pkgsIndent <> Package.toCabalDepText p) <$> NE.toList pkgs.unPackageGroup
 
 -- build-depends is indented 4, then 2 for the package itself.
 pkgsIndent :: Text

src/builder/CLC/Stackage/Builder/Writer.hs

@@ -11,8 +11,7 @@ module CLC.Stackage.Parser
 where
 
 import CLC.Stackage.Parser.API
-  ( PackageResponse (name, version),
-    StackageResponse (packages),
+  ( StackageResponse (packages),
   )
 import CLC.Stackage.Parser.API qualified as API
 import CLC.Stackage.Parser.API.CabalConfig qualified as CabalConfig
@@ -21,6 +20,8 @@ import CLC.Stackage.Utils.JSON qualified as JSON
 import CLC.Stackage.Utils.Logging qualified as Logging
 import CLC.Stackage.Utils.OS (Os (Linux, Osx, Windows))
 import CLC.Stackage.Utils.OS qualified as OS
+import CLC.Stackage.Utils.Package (Package)
+import CLC.Stackage.Utils.Package qualified as Package
 import Control.Monad (when)
 import Data.Aeson (FromJSON, ToJSON)
 import Data.Foldable (for_)
@@ -33,13 +34,13 @@ import System.OsPath (OsPath, osp)
 
 -- | Retrieves the list of packages, based on
 -- 'CLC.Stackage.Parser.API.stackageUrl'.
-getPackageList :: Logging.Handle -> Maybe OsPath -> IO [PackageResponse]
+getPackageList :: Logging.Handle -> Maybe OsPath -> IO [Package]
 getPackageList hLogger msnapshotPath =
   getPackageListByOs hLogger msnapshotPath OS.currentOs
 
 -- | Prints the package list to a file.
-printPackageList :: Bool -> Maybe Os -> IO ()
-printPackageList incVers mOs = do
+printPackageList :: Maybe Os -> IO ()
+printPackageList mOs = do
   case mOs of
     Just os -> printOsList os
     Nothing -> for_ [minBound .. maxBound] printOsList
@@ -49,23 +50,18 @@ printPackageList incVers mOs = do
     file Windows = [osp|pkgs_windows.txt|]
 
     printOsList os = do
-      pkgs <- getPackageListByOsFmt incVers os
+      pkgs <- getPackageListByOsFmt os
       let txt = T.unlines pkgs
       IO.writeFileUtf8 (file os) txt
 
 -- | Retrieves the package list formatted to text.
-getPackageListByOsFmt :: Bool -> Os -> IO [Text]
-getPackageListByOsFmt incVers =
-  (fmap . fmap) toText
+getPackageListByOsFmt :: Os -> IO [Text]
+getPackageListByOsFmt =
+  (fmap . fmap) Package.toTextInstalled
     . getPackageListByOs Logging.mkDefaultLogger Nothing
-  where
-    toText r =
-      if incVers
-        then r.name <> "-" <> r.version
-        else r.name
 
 -- | Helper in case we want to see what the package set for a given OS is.
-getPackageListByOs :: Logging.Handle -> Maybe OsPath -> Os -> IO [PackageResponse]
+getPackageListByOs :: Logging.Handle -> Maybe OsPath -> Os -> IO [Package]
 getPackageListByOs hLogger msnapshotPath os = do
   excludedPkgs <- getExcludedPkgs os
   let filterExcluded = flip Set.notMember excludedPkgs . (.name)

src/parser/CLC/Stackage/Parser.hs

@@ -2,7 +2,6 @@
 module CLC.Stackage.Parser.API
   ( -- * Querying stackage
     StackageResponse (..),
-    PackageResponse (..),
     getStackage,
 
     -- ** Exceptions
@@ -22,7 +21,6 @@ import CLC.Stackage.Parser.API.Common
         ReasonReadBody,
         ReasonStatus
       ),
-    PackageResponse (name, version),
     StackageException (MkStackageException),
     StackageResponse (MkStackageResponse, packages),
   )