Fix PATH changes not triggering REPL reconfiguration (#2015)

When a user's PATH environment variable changes between Cabal commands,
the environment in the REPL becomes incorrect. This occurs because
during initial package configuration, the current PATH is captured via
`programSearchPathAsPATHVar` and then stored in the `programOverrideEnv`
field of a ConfiguredProgram. These `ConfiguredProgram`s are subsequently
serialized into the setup-config file, effectively baking in the PATH
environment from the time of configuration.

The issue manifests when `PATH` is updated after initial configuration.
Although the solver re-runs when detecting `PATH` changes, the
`dryRunLocalPkg` function examines `ElaboratedConfiguredPackage` and
incorrectly determines that nothing has changed that would require
reconfiguration. This decision is incorrect because `setup-config` now
contains a stale reference to the original `PATH` value, which no longer
matches the current environment.

To fix this problem, we need to store the `ConfiguredProgram`s directly in
`ElaboratedConfiguredPackage`. This approach will ensure that when `PATH`
changes, the `ConfiguredProgram`s will also change, properly triggering
reconfiguration. While this solution will cause more recompilations when
`PATH` changes, it guarantees that the correct environment is always used
during builds and REPL sessions.

An alternative approach would be to stop baking the `PATH` variable into
the environment of programs, but this would require more substantial
changes to how Cabal manages environment variables.

Fixes #2015

Author: mpickering

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

@@ -2327,6 +2327,7 @@ elaborateInstallPlan
                 ]
                 <> perPkgOptionMapMappend pkgid packageConfigProgramArgs
             elabProgramPathExtra = perPkgOptionNubList pkgid packageConfigProgramPathExtra
+            elabConfiguredPrograms = configuredPrograms compilerprogdb
             elabConfigureScriptArgs = perPkgOptionList pkgid packageConfigConfigureArgs
             elabExtraLibDirs = perPkgOptionList pkgid packageConfigExtraLibDirs
             elabExtraLibDirsStatic = perPkgOptionList pkgid packageConfigExtraLibDirsStatic

cabal-install/src/Distribution/Client/ProjectPlanning/Types.hs

@@ -274,6 +274,7 @@ data ElaboratedConfiguredPackage = ElaboratedConfiguredPackage
   , elabProgramPaths :: Map String FilePath
   , elabProgramArgs :: Map String [String]
   , elabProgramPathExtra :: [FilePath]
+  , elabConfiguredPrograms :: [ConfiguredProgram]
   , elabConfigureScriptArgs :: [String]
   , elabExtraLibDirs :: [FilePath]
   , elabExtraLibDirsStatic :: [FilePath]

cabal-testsuite/PackageTests/PathRecomp/PathRecomp.cabal

@@ -0,0 +1,13 @@
+name:                PathRecomp
+version:             0.1.0.0
+license:             BSD3
+author:              Test Author
+maintainer:          [email protected]
+build-type:          Simple
+cabal-version:       >=1.10
+
+library
+  exposed-modules:     Lib
+  hs-source-dirs:      src
+  build-depends:       base
+  default-language:    Haskell2010

cabal-testsuite/PackageTests/PathRecomp/Setup.hs

@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain

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

@@ -0,0 +1,21 @@
+import Test.Cabal.Prelude
+import qualified Data.Map as Map
+import qualified Control.Monad.IO.Class as IO
+import System.Environment (getEnvironment)
+
+main = cabalTest $ recordMode DoNotRecord $ do
+    -- First run cabal repl with the normal PATH
+    env <- IO.liftIO getEnvironment
+    let originalPath = maybe "" id (lookup "PATH" env)
+
+    -- Run repl with original PATH
+    cabal' "repl" ["lib:PathRecomp"] >>= assertOutputContains "module loaded"
+
+    -- Now modify the PATH by prefixing with a dummy directory
+    -- This simulates a user modifying their PATH between cabal commands
+    let modifiedPath = "/dummy/path:" ++ originalPath
+    withEnv [("PATH", Just modifiedPath)] $ do
+        -- Run repl with modified PATH - this should still work
+        r <- cabalWithStdin "repl" ["lib:PathRecomp"] "(Prelude.fmap . Prelude.fmap) (\"/dummy/path\" `Data.List.isInfixOf`) (System.Environment.lookupEnv \"PATH\")"
+        assertOutputContains "module loaded" r
+        assertOutputContains "Just True" r

cabal-testsuite/PackageTests/PathRecomp/src/Lib.hs

@@ -0,0 +1,6 @@
+module Lib
+    ( someFunc
+    ) where
+
+someFunc :: IO ()
+someFunc = putStrLn "someFunc"

changelog.d/pr-10817

@@ -0,0 +1,19 @@
+synopsis: Fix PATH changes not triggering REPL reconfiguration
+packages: cabal-install
+prs: #10817
+issues: #2015
+
+When a user's PATH environment variable changes between Cabal commands, the REPL
+environment would become incorrect. This happens because during initial package
+configuration, the current PATH value is captured and stored in the
+`programOverrideEnv` field of ConfiguredPrograms, which gets serialized into
+setup-config.
+
+If PATH is updated after configuration, the solver re-runs but `dryRunLocalPkg`
+doesn't detect the need for reconfiguration, leaving the REPL with stale PATH
+references.
+
+This fix stores ConfiguredPrograms directly in ElaboratedConfiguredPackage,
+ensuring that when PATH changes, the ConfiguredPrograms also change, properly
+triggering reconfiguration. While this causes more rebuilds when PATH changes,
+it guarantees that the correct environment is always used during REPL sessions.