wip: Support sub-library dependencies

kk-hainq · philderbeast · commit 9ddf6f1afa90 · 2022-08-29T12:19:57.000-04:00
diff --git a/src/Stack/Build.hs b/src/Stack/Build.hs
@@ -32,8 +32,6 @@ import qualified Data.Text.IO as TIO
 import           Data.Text.Read (decimal)
 import qualified Data.Vector as V
 import qualified Data.Yaml as Yaml
-import qualified Distribution.PackageDescription as C
-import           Distribution.Types.Dependency (depLibraries)
 import           Distribution.Version (mkVersion)
 import           Path (parent)
 import           Stack.Build.ConstructPlan
@@ -69,8 +67,6 @@ build msetLocalFiles = do
     depsLocals <- localDependencies
     let allLocals = locals <> depsLocals
 
-    checkSubLibraryDependencies (Map.elems $ smProject sourceMap)
-
     boptsCli <- view $ envConfigL.to envConfigBuildOptsCLI
     -- Set local files, necessary for file watching
     stackYaml <- view stackYamlL
@@ -353,29 +349,4 @@ checkComponentsBuildable lps =
         [ (packageName (lpPackage lp), c)
         | lp <- lps
         , c <- Set.toList (lpUnbuildable lp)
-        ]
-
--- | Find if sublibrary dependency exist in each project
-checkSubLibraryDependencies :: HasLogFunc env => [ProjectPackage] -> RIO env ()
-checkSubLibraryDependencies proj = do
-  forM_ proj $ \p -> do
-    C.GenericPackageDescription _ _ _ lib subLibs foreignLibs exes tests benches <- liftIO $ cpGPD . ppCommon $ p
-
-    let dependencies = concatMap getDeps subLibs <>
-                       concatMap getDeps foreignLibs <>
-                       concatMap getDeps exes <>
-                       concatMap getDeps tests <>
-                       concatMap getDeps benches <>
-                       maybe [] C.condTreeConstraints lib
-        libraries = concatMap (toList . depLibraries) dependencies
-
-    when (subLibDepExist libraries)
-      (logWarn "SubLibrary dependency is not supported, this will almost certainly fail")
-  where
-    getDeps (_, C.CondNode _ dep _) = dep
-    subLibDepExist lib =
-      any (\x ->
-        case x of
-          C.LSubLibName _ -> True
-          C.LMainLibName  -> False
-      ) lib
+        ]
diff --git a/src/Stack/Package.hs b/src/Stack/Package.hs
@@ -1,14 +1,15 @@
-{-# LANGUAGE NoImplicitPrelude   #-}
-{-# LANGUAGE CPP                 #-}
-{-# LANGUAGE DataKinds           #-}
-{-# LANGUAGE DeriveDataTypeable  #-}
-{-# LANGUAGE FlexibleContexts    #-}
-{-# LANGUAGE FlexibleInstances   #-}
-{-# LANGUAGE OverloadedStrings   #-}
-{-# LANGUAGE RankNTypes          #-}
-{-# LANGUAGE RecordWildCards     #-}
+{-# LANGUAGE CPP #-}
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# LANGUAGE TupleSections #-}
 {-# LANGUAGE ScopedTypeVariables #-}
-{-# LANGUAGE TupleSections       #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE RankNTypes #-}
+{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE LambdaCase #-}
 
 -- | Dealing with Cabal.
 
@@ -32,6 +33,7 @@ import           Data.List (find, isPrefixOf, unzip)
 import qualified Data.Map.Strict as M
 import qualified Data.Set as S
 import qualified Data.Text as T
+import qualified Distribution.Compat.NonEmptySet as NES
 import           Distribution.CabalSpecVersion
 import           Distribution.Compiler
 import           Distribution.ModuleName (ModuleName)
@@ -144,6 +146,7 @@ packageFromPackageDescription packageConfig pkgFlags (PackageDescriptionPair pkg
     , packageDefaultFlags = M.fromList
       [(flagName flag, flagDefault flag) | flag <- pkgFlags]
     , packageAllDeps = S.fromList (M.keys deps)
+    , packageSubLibDeps = subLibDeps
     , packageLibraries =
         let mlib = do
               lib <- library pkg
@@ -258,6 +261,13 @@ packageFromPackageDescription packageConfig pkgFlags (PackageDescriptionPair pkg
         (M.fromList . map (depPkgName &&& depVerRange) . setupDepends)
         (setupBuildInfo pkg)
 
+    -- TODO: Should merge this calculation with deps.
+    subLibDeps = S.fromList $ concatMap
+      (\(Dependency n _ libs) -> mapMaybe (getSubLibName n) (NES.toList libs))
+      (concatMap targetBuildDepends (allBuildInfo' pkg))
+    getSubLibName pn (LSubLibName cn) = Just (T.pack (unPackageName pn <> ":" <> Cabal.unUnqualComponentName cn))
+    getSubLibName _ _ = Nothing
+
     asLibrary range = DepValue
       { dvVersionRange = range
       , dvType = AsLibrary
diff --git a/src/Stack/Types/Build.hs b/src/Stack/Types/Build.hs
@@ -60,6 +60,7 @@ import           Database.Persist.Sql            (PersistField(..)
 import           Distribution.PackageDescription (TestSuiteInterface)
 import           Distribution.System             (Arch)
 import qualified Distribution.Text               as C
+import           Distribution.Types.PackageName  (mkPackageName, unPackageName)
 import           Distribution.Version            (mkVersion)
 import           Path                            (parseRelDir, (</>), parent)
 import           Path.Extra                      (toFilePathNoTrailingSep)
@@ -692,7 +693,14 @@ configureOptsNoDir econfig bco deps isLocal package = concat
     -- with --exact-configuration.
     flags = packageFlags package `Map.union` packageDefaultFlags package
 
-    depOptions = map (uncurry toDepOption) $ Map.toList deps
+    -- FIXME: drunk code
+    sublibDeps = flip mapMaybe (Set.toList (packageSubLibDeps package)) $ \sublib ->
+        let subname = T.unpack sublib
+        in case find (\(PackageIdentifier pn _, _) -> unPackageName pn == takeWhile (/= ':') subname) (Map.toList deps) of
+            Just (PackageIdentifier _ v, gid) -> Just (PackageIdentifier (mkPackageName subname) v, gid)
+            _ -> Nothing
+
+    depOptions = map (uncurry toDepOption) (Map.toList deps <> sublibDeps)
       where
         toDepOption = if newerCabal then toDepOption1_22 else toDepOption1_18
 
diff --git a/src/Stack/Types/Package.hs b/src/Stack/Types/Package.hs
@@ -102,6 +102,8 @@ data Package =
           ,packageDeps :: !(Map PackageName DepValue)     -- ^ Packages that the package depends on, both as libraries and build tools.
           ,packageUnknownTools :: !(Set ExeName)          -- ^ Build tools specified in the legacy manner (build-tools:) that failed the hard-coded lookup.
           ,packageAllDeps :: !(Set PackageName)           -- ^ Original dependencies (not sieved).
+          -- FIXME: Having `packageDeps`, `packageAllDeps`, and `packageSubLibDeps` seem redundant.
+          ,packageSubLibDeps :: !(Set Text)               -- ^ Original sub-library dependencies (not sieved).
           ,packageGhcOptions :: ![Text]                   -- ^ Ghc options used on package.
           ,packageCabalConfigOpts :: ![Text]              -- ^ Additional options passed to ./Setup.hs configure
           ,packageFlags :: !(Map FlagName Bool)           -- ^ Flags used on package.
diff --git a/stack.yaml b/stack.yaml
@@ -1,3 +1,4 @@
+
 # GHC 9.2.4
 resolver: nightly-2022-08-02
 
@@ -34,7 +35,5 @@ ghc-options:
 user-message: |
   If building Stack on macOS, you are advised to use stack-macos.yaml as the
   project-level configuration file, and command:
-
   stack --stack-yaml stack-macos.yaml build
-
   See that configuration file for further information.
diff --git a/stack.yaml.lock b/stack.yaml.lock
@@ -7,20 +7,20 @@ packages:
 - completed:
     hackage: hi-file-parser-0.1.3.0@sha256:b868e1bcb73fffe5963de6879f0a0a4c5ced97e08fc09c2c9428af884cdcaa74,2488
     pantry-tree:
-      sha256: 43b8556254dde11c40335bf05e3f8ae5fa6e198fcf37d2cf51da141fe218be31
       size: 1929
+      sha256: 43b8556254dde11c40335bf05e3f8ae5fa6e198fcf37d2cf51da141fe218be31
   original:
     hackage: hi-file-parser-0.1.3.0@sha256:b868e1bcb73fffe5963de6879f0a0a4c5ced97e08fc09c2c9428af884cdcaa74,2488
 - completed:
     hackage: pantry-0.5.7@sha256:f96119ad2cc3771fe0891939d8a29c7f089fb333a70646e8deb2ec60532ea948,3914
     pantry-tree:
-      sha256: c96fe10d96d1b1a9439c473bf27eeb2d94ad2fdbb93ccc4d9f0c69643b868c6d
       size: 2524
+      sha256: c96fe10d96d1b1a9439c473bf27eeb2d94ad2fdbb93ccc4d9f0c69643b868c6d
   original:
     hackage: pantry-0.5.7@sha256:f96119ad2cc3771fe0891939d8a29c7f089fb333a70646e8deb2ec60532ea948,3914
 snapshots:
 - completed:
-    sha256: ce4257dd36ba3b96eeee64cfb08884ddb46dd73f81f8b25a71658834edc607e2
     size: 619227
     url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/nightly/2022/8/2.yaml
+    sha256: ce4257dd36ba3b96eeee64cfb08884ddb46dd73f81f8b25a71658834edc607e2
   original: nightly-2022-08-02
diff --git a/test/integration/tests/cabal-sublibrary-dependency/Main.hs b/test/integration/tests/cabal-sublibrary-dependency/Main.hs
@@ -1,14 +1,4 @@
-import Control.Monad (unless)
-import Data.List (isInfixOf)
 import StackTest
 
 main :: IO ()
-main = do
-  putStrLn "Disabled: CI doesn't have GHC 8.8.1"
-  {-
-  stackErrStderr ["build"] $ \str ->
-    let msg = "SubLibrary dependency is not supported, this will almost certainly fail" in
-
-    unless (msg `isInfixOf` str) $
-    error $ "Expected a warning: \n" ++ show msg
-  -}
+main = stack ["build", "--install-ghc"]
diff --git a/test/integration/tests/cabal-sublibrary-dependency/files/stack.yaml b/test/integration/tests/cabal-sublibrary-dependency/files/stack.yaml
@@ -1,7 +1,4 @@
-resolver: nightly-2020-01-17
+resolver: nightly-2021-06-19
 packages:
 - .
 - subproject
-extra-deps:
-- github: snoyberg/filelock
-  commit: 4f080496d8bf153fbe26e64d1f52cf73c7db25f6
diff --git a/test/integration/tests/cabal-sublibrary-dependency/files/subproject/subproject.cabal b/test/integration/tests/cabal-sublibrary-dependency/files/subproject/subproject.cabal
@@ -1,7 +1,7 @@
+cabal-version:       3.0
 name:                subproject
 version:             0.1.0.0
 build-type:          Simple
-cabal-version:       >=1.10
 
 library
   hs-source-dirs:      src
@@ -10,6 +10,7 @@ library
   default-language:    Haskell2010
 
 library sub
+  visibility:          public
   hs-source-dirs:      src
   exposed-modules:     SubLib
   build-depends:       base >= 4.7 && < 5
