Fix repl discarding --build-depends (#8732)

* Fix repl discarding `build-depends` argument

Previously the function `\f -> L.allCondTrees $ traverseCondTreeC f` was
used to add the dependencies, but manipulating `CondTree` this way does
not update the nested fields `targetBuildDepends` of the tree, only the
conditions. It worked merely by chance if one does not further process
these fields: this explains why options like `--allow-newer` or
`allow-older` were incompatible with `--build-depends`.

Using `L.traverseBuildInfos . L.targetBuildDepends` ensures
`targetBuildDepends` fields and conditions are all updated consistently.

* Add test

* Add changelog

* Cleanup

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: wismill

Cabal-syntax/src/Distribution/Types/GenericPackageDescription.hs

@@ -1,7 +1,6 @@
 {-# LANGUAGE DeriveDataTypeable #-}
 {-# LANGUAGE DeriveGeneric #-}
 {-# LANGUAGE FlexibleContexts #-}
-{-# LANGUAGE GeneralizedNewtypeDeriving #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 
 module Distribution.Types.GenericPackageDescription (
@@ -86,15 +85,14 @@ instance L.HasBuildInfos GenericPackageDescription where
             <*> (traverse . L._2 . traverseCondTreeBuildInfo) f x4
             <*> (traverse . L._2 . traverseCondTreeBuildInfo) f x5
             <*> (traverse . L._2 . traverseCondTreeBuildInfo) f x6
-      where
 
 -- We use this traversal to keep [Dependency] field in CondTree up to date.
 traverseCondTreeBuildInfo
     :: forall f comp v. (Applicative f, L.HasBuildInfo comp)
     => LensLike' f (CondTree v [Dependency] comp) L.BuildInfo
 traverseCondTreeBuildInfo g = node where
     mkCondNode :: comp -> [CondBranch v [Dependency] comp] -> CondTree v [Dependency] comp
-    mkCondNode comp branches = CondNode comp (view L.targetBuildDepends comp) branches
+    mkCondNode comp = CondNode comp (view L.targetBuildDepends comp)
 
     node (CondNode comp _ branches) = mkCondNode
         <$> L.buildInfo g comp

cabal-install/src/Distribution/Client/CmdRepl.hs

@@ -75,7 +75,7 @@ import Distribution.Types.BuildInfo
 import Distribution.Types.ComponentName
          ( componentNameString )
 import Distribution.Types.CondTree
-         ( CondTree(..), traverseCondTreeC )
+         ( CondTree(..) )
 import Distribution.Types.Dependency
          ( Dependency(..), mainLibSet )
 import Distribution.Types.Library
@@ -338,7 +338,12 @@ addDepsToProjectTarget deps pkgId ctx =
       | packageId pkg /= pkgId = SpecificSourcePackage pkg
       | SourcePackage{..} <- pkg =
         SpecificSourcePackage $ pkg { srcpkgDescription =
-          srcpkgDescription & (\f -> L.allCondTrees $ traverseCondTreeC f)
+          -- New dependencies are added to the original ones found in the
+          -- `targetBuildDepends` field.
+          -- `traverseBuildInfos` is used in order to update _all_ the
+          -- occurrences of the field `targetBuildDepends`. It ensures that
+          -- fields depending on the latter are also consistently updated.
+          srcpkgDescription &  (L.traverseBuildInfos . L.targetBuildDepends)
                             %~ (deps ++)
         }
     addDeps spec = spec

cabal-testsuite/PackageTests/ReplBuildDepends/Foo.hs

@@ -0,0 +1,4 @@
+module Foo where
+
+a :: Int
+a = 42

cabal-testsuite/PackageTests/ReplBuildDepends/cabal.allow-newer.out

@@ -0,0 +1,2 @@
+# cabal clean
+# cabal repl

cabal-testsuite/PackageTests/ReplBuildDepends/cabal.allow-older.out

@@ -0,0 +1,2 @@
+# cabal clean
+# cabal repl

cabal-testsuite/PackageTests/ReplBuildDepends/cabal.normal.out

@@ -0,0 +1,2 @@
+# cabal clean
+# cabal repl

cabal-testsuite/PackageTests/ReplBuildDepends/cabal.project

@@ -0,0 +1 @@
+packages: .

cabal-testsuite/PackageTests/ReplBuildDepends/cabal.test.hs

@@ -0,0 +1,19 @@
+import Test.Cabal.Prelude
+
+-- Test “repl --build-depends”
+main = do
+  testWithByteString "normal" []
+  -- See https://github.com/haskell/cabal/issues/6859
+  testWithByteString "allow-newer" ["--allow-newer"]
+  -- See https://github.com/haskell/cabal/issues/6859
+  testWithByteString "allow-older" ["--allow-older"]
+  where
+  testWithByteString label extraArgs = cabalTest' label $ do
+    cabal' "clean" []
+    res <- cabalWithStdin
+        "repl"
+        ("-v2" : "--build-depends" : "bytestring" : extraArgs)
+        "import qualified Data.ByteString as BS"
+    assertOutputContains "Ok, one module loaded." res
+    -- Ensure we can load ‘bytestring’
+    assertOutputDoesNotContain "Could not load" res

cabal-testsuite/PackageTests/ReplBuildDepends/pkg.cabal

@@ -0,0 +1,7 @@
+cabal-version:      2.4
+name:               pkg
+version:            0.1.0.0
+library
+    exposed-modules:  Foo
+    build-depends:    base
+    default-language: Haskell2010

changelog.d/pr-8732

@@ -0,0 +1,10 @@
+synopsis: Fix repl discarding --build-depends
+packages: cabal-install
+prs: #8732
+issues: #6859 #7081
+
+description: {
+
+- Fix `repl` command discarding `--build-depends` argument when using 
+  `allow-newer` or `allow-older`.
+}