Rename fields of ConfigureOpts, and related

Author: mpilgrem

.stan.toml

@@ -83,14 +83,14 @@
 
 # Anti-pattern: Data.ByteString.Char8.pack
 [[ignore]]
-  id = "OBS-STAN-0203-tuE+RG-226:21"
+  id = "OBS-STAN-0203-tuE+RG-228:21"
 # ✦ Description:   Usage of 'pack' function that doesn't handle Unicode characters
 # ✦ Category:      #AntiPattern
 # ✦ File:          src\Stack\Build\ExecutePackage.hs
 #
-#   225 ┃
-#   226 ┃   newProjectRoot <- S8.pack . toFilePath <$> view projectRootL
-#   227 ┃                     ^^^^^^^
+#   227 ┃
+#   228 ┃   newProjectRoot <- S8.pack . toFilePath <$> view projectRootL
+#   229 ┃                     ^^^^^^^
 
 # Anti-pattern: Data.ByteString.Char8.pack
 [[ignore]]

src/Stack/Build/Cache.hs

@@ -347,7 +347,7 @@ getPrecompiledCacheKey ::
   -> ConfigureOpts
   -> Bool -- ^ build haddocks
   -> RIO env PrecompiledCacheKey
-getPrecompiledCacheKey loc copts buildHaddocks = do
+getPrecompiledCacheKey loc configureOpts buildHaddocks = do
   compiler <- view actualCompilerVersionL
   cabalVersion <- view cabalVersionL
 
@@ -361,8 +361,9 @@ getPrecompiledCacheKey loc copts buildHaddocks = do
   -- In Cabal versions 1.22 and later, the configure options contain the
   -- installed package IDs, which is what we need for a unique hash. See also
   -- issue: https://github.com/commercialhaskell/stack/issues/1103
-  let input = copts.noDirs
-      optionsHash = Mem.convert $ hashWith SHA256 $ encodeUtf8 $ tshow input
+  let optionsToHash = configureOpts.nonPathRelated
+      optionsHash =
+        Mem.convert $ hashWith SHA256 $ encodeUtf8 $ tshow optionsToHash
 
   pure $ precompiledCacheKey
     platformGhcDir compiler cabalVersion packageKey optionsHash buildHaddocks

src/Stack/Build/ConstructPlan.hs

@@ -60,7 +60,8 @@ import           Stack.Types.CompilerPaths
                    ( CompilerPaths (..), HasCompiler (..) )
 import           Stack.Types.Config ( Config (..), HasConfig (..), stackRootL )
 import           Stack.Types.ConfigureOpts
-                   ( BaseConfigOpts (..), ConfigureOpts (..), configureOpts )
+                   ( BaseConfigOpts (..), ConfigureOpts (..) )
+import qualified Stack.Types.ConfigureOpts as ConfigureOpts
 import           Stack.Types.Curator ( Curator (..) )
 import           Stack.Types.Dependency ( DepValue (..), isDepTypeLibrary )
 import           Stack.Types.DumpPackage ( DumpPackage (..), dpParentLibIdent )
@@ -440,7 +441,7 @@ addFinal lp package isAllInOne buildHaddocks = do
       pure $ Right Task
         { configOpts = TaskConfigOpts missing $ \missing' ->
             let allDeps = Map.union present missing'
-            in  configureOpts
+            in  ConfigureOpts.configureOpts
                   (view envConfigL ctx)
                   ctx.baseConfigOpts
                   allDeps
@@ -753,7 +754,7 @@ installPackageGivenDeps isAllInOne buildHaddocks ps package minstalled
       Nothing -> ADRToInstall Task
         { configOpts = TaskConfigOpts missing $ \missing' ->
             let allDeps = Map.union present missing'
-            in  configureOpts
+            in  ConfigureOpts.configureOpts
                   (view envConfigL ctx)
                   ctx.baseConfigOpts
                   allDeps
@@ -1009,22 +1010,22 @@ checkDirtiness ::
 checkDirtiness ps installed package present buildHaddocks = do
   ctx <- ask
   moldOpts <- runRIO ctx $ tryGetFlagCache installed
-  let configOpts = configureOpts
+  let configureOpts = ConfigureOpts.configureOpts
         (view envConfigL ctx)
         ctx.baseConfigOpts
         present
         (psLocal ps)
         (installLocationIsMutable $ psLocation ps) -- should be Local i.e. mutable always
         package
+      components = case ps of
+        PSFilePath lp ->
+          Set.map (encodeUtf8 . renderComponent) lp.components
+        PSRemote{} -> Set.empty
       wantConfigCache = ConfigCache
-        { opts = configOpts
+        { configureOpts
         , deps = Set.fromList $ Map.elems present
-        , components =
-            case ps of
-              PSFilePath lp ->
-                Set.map (encodeUtf8 . renderComponent) lp.components
-              PSRemote{} -> Set.empty
-        , haddock = buildHaddocks
+        , components
+        , buildHaddocks
         , pkgSrc = toCachePkgSrc ps
         , pathEnvVar = ctx.pathEnvVar
         }
@@ -1061,7 +1062,7 @@ describeConfigDiff config old new
   | not $ Set.null newComponents =
       Just $ "components added: " `T.append` T.intercalate ", "
           (map (decodeUtf8With lenientDecode) (Set.toList newComponents))
-  | not old.haddock && new.haddock =
+  | not old.buildHaddocks && new.buildHaddocks =
       Just "rebuilding with haddocks"
   | oldOpts /= newOpts = Just $ T.pack $ concat
       [ "flags changed from "
@@ -1099,7 +1100,7 @@ describeConfigDiff config old new
                 else stripGhcOptions)
            . map T.pack
            . (\(ConfigureOpts x y) -> x ++ y)
-           . (.opts)
+           . (.configureOpts)
    where
     -- options set by Stack
     isStackOpt :: Text -> Bool

src/Stack/Build/ExecutePackage.hs

@@ -186,17 +186,19 @@ getConfigCache ee task installedMap enableTest enableBench = do
       TaskConfigOpts missing mkOpts = task.configOpts
   missingMapList <- traverse getMissing $ toList missing
   let missing' = Map.unions missingMapList
-      opts = mkOpts missing'
-      allDeps = Set.fromList $ Map.elems missing' ++ Map.elems task.present
+      configureOpts' = mkOpts missing'
+      configureOpts = configureOpts'
+        { nonPathRelated = configureOpts'.nonPathRelated ++ map T.unpack extra }
+      deps = Set.fromList $ Map.elems missing' ++ Map.elems task.present
+      components = case task.taskType of
+        TTLocalMutable lp ->
+          Set.map (encodeUtf8 . renderComponent) lp.components
+        TTRemotePackage{} -> Set.empty
       cache = ConfigCache
-        { opts = opts { noDirs = opts.noDirs ++ map T.unpack extra }
-        , deps = allDeps
-        , components =
-            case task.taskType of
-              TTLocalMutable lp ->
-                Set.map (encodeUtf8 . renderComponent) lp.components
-              TTRemotePackage{} -> Set.empty
-        , haddock = task.buildHaddocks
+        { configureOpts
+        , deps
+        , components
+        , buildHaddocks = task.buildHaddocks
         , pkgSrc = task.cachePkgSrc
         , pathEnvVar = ee.pathEnvVar
         }
@@ -264,7 +266,6 @@ ensureConfig newConfigCache pkgDir buildOpts announce cabal cabalFP task = do
           || mOldCabalMod /= Just newCabalMod
           || mOldSetupConfigMod /= newSetupConfigMod
           || mOldProjectRoot /= Just newProjectRoot
-  let ConfigureOpts dirs nodirs = newConfigCache.opts
 
   when task.buildTypeConfig $
     -- When build-type is Configure, we need to have a configure script in the
@@ -292,8 +293,8 @@ ensureConfig newConfigCache pkgDir buildOpts announce cabal cabalFP task = do
     -- Stack.Types.Build.ureOpts
     cabal KeepTHLoading $ "configure" : concat
       [ concat exes
-      , dirs
-      , nodirs
+      , newConfigCache.configureOpts.pathRelated
+      , newConfigCache.configureOpts.nonPathRelated
       ]
     -- Only write the cache for local packages.  Remote packages are built in a
     -- temporary directory so the cache would never be used anyway.
@@ -685,8 +686,8 @@ singleBuild
         writePrecompiledCache
           ee.baseConfigOpts
           loc
-          cache.opts
-          cache.haddock
+          cache.configureOpts
+          cache.buildHaddocks
           mpkgid
           subLibsPkgIds
           (buildableExes package)
@@ -762,8 +763,8 @@ getPrecompiled cache taskType bcoSnapInstallRoot =
     TTRemotePackage Immutable _ loc -> do
       mpc <- readPrecompiledCache
                 loc
-                cache.opts
-                cache.haddock
+                cache.configureOpts
+                cache.buildHaddocks
       case mpc of
         Nothing -> pure Nothing
         -- Only pay attention to precompiled caches that refer to packages

src/Stack/Storage/Project.hs

@@ -115,19 +115,19 @@ readConfigCache ::
   -> ReaderT SqlBackend (RIO env) ConfigCache
 readConfigCache (Entity parentId configCacheParent) = do
   let pkgSrc = configCacheParent.configCacheParentPkgSrc
-  dirs <-
+  pathRelated <-
     map ((.configCacheDirOptionValue) . entityVal) <$>
     selectList
       [ConfigCacheDirOptionParent ==. parentId]
       [Asc ConfigCacheDirOptionIndex]
-  noDirs <-
+  nonPathRelated <-
     map ((.configCacheNoDirOptionValue) . entityVal) <$>
     selectList
       [ConfigCacheNoDirOptionParent ==. parentId]
       [Asc ConfigCacheNoDirOptionIndex]
-  let opts = ConfigureOpts
-        { dirs
-        , noDirs
+  let configureOpts = ConfigureOpts
+        { pathRelated
+        , nonPathRelated
         }
   deps <-
     Set.fromList . map ((.configCacheDepValue) . entityVal) <$>
@@ -136,12 +136,12 @@ readConfigCache (Entity parentId configCacheParent) = do
     Set.fromList . map ((.configCacheComponentValue) . entityVal) <$>
     selectList [ConfigCacheComponentParent ==. parentId] []
   let pathEnvVar = configCacheParent.configCacheParentPathEnvVar
-  let haddock = configCacheParent.configCacheParentHaddock
+  let buildHaddocks = configCacheParent.configCacheParentHaddock
   pure ConfigCache
-    { opts
+    { configureOpts
     , deps
     , components
-    , haddock
+    , buildHaddocks
     , pkgSrc
     , pathEnvVar
     }
@@ -181,7 +181,7 @@ saveConfigCache key@(UniqueConfigCacheParent dir type_) new =
               , configCacheParentPkgSrc = new.pkgSrc
               , configCacheParentActive = True
               , configCacheParentPathEnvVar = new.pathEnvVar
-              , configCacheParentHaddock = new.haddock
+              , configCacheParentHaddock = new.buildHaddocks
               }
         Just parentEntity@(Entity parentId _) -> do
           old <- readConfigCache parentEntity
@@ -197,15 +197,15 @@ saveConfigCache key@(UniqueConfigCacheParent dir type_) new =
       ConfigCacheDirOptionParent
       parentId
       ConfigCacheDirOptionIndex
-      (maybe [] (.opts.dirs) mold)
-      new.opts.dirs
+      (maybe [] (.configureOpts.pathRelated) mold)
+      new.configureOpts.pathRelated
     updateList
       ConfigCacheNoDirOption
       ConfigCacheNoDirOptionParent
       parentId
       ConfigCacheNoDirOptionIndex
-      (maybe [] (.opts.noDirs) mold)
-      new.opts.noDirs
+      (maybe [] (.configureOpts.nonPathRelated) mold)
+      new.configureOpts.nonPathRelated
     updateSet
       ConfigCacheDep
       ConfigCacheDepParent

src/Stack/Types/Build.hs

@@ -84,8 +84,8 @@ instance NFData BuildCache
 
 -- | Stored on disk to know whether the flags have changed.
 data ConfigCache = ConfigCache
-  { opts :: !ConfigureOpts
-    -- ^ All options used for this package.
+  { configureOpts :: !ConfigureOpts
+    -- ^ All Cabal configure options used for this package.
   , deps :: !(Set GhcPkgId)
     -- ^ The GhcPkgIds of all of the dependencies. Since Cabal doesn't take
     -- the complete GhcPkgId (only a PackageIdentifier) in the configure
@@ -95,7 +95,7 @@ data ConfigCache = ConfigCache
     -- ^ The components to be built. It's a bit of a hack to include this in
     -- here, as it's not a configure option (just a build option), but this
     -- is a convenient way to force compilation when the components change.
-  , haddock :: !Bool
+  , buildHaddocks :: !Bool
     -- ^ Are haddocks to be built?
   , pkgSrc :: !CachePkgSrc
   , pathEnvVar :: !Text

src/Stack/Types/ConfigureOpts.hs

@@ -7,8 +7,8 @@ module Stack.Types.ConfigureOpts
   ( ConfigureOpts (..)
   , BaseConfigOpts (..)
   , configureOpts
-  , configureOptsDirs
-  , configureOptsNoDir
+  , configureOptsPathRelated
+  , configureOptsNonPathRelated
   ) where
 
 import qualified Data.Map as Map
@@ -50,24 +50,26 @@ data BaseConfigOpts = BaseConfigOpts
   deriving Show
 
 -- | Render a @BaseConfigOpts@ to an actual list of options
-configureOpts :: EnvConfig
-              -> BaseConfigOpts
-              -> Map PackageIdentifier GhcPkgId -- ^ dependencies
-              -> Bool -- ^ local non-extra-dep?
-              -> IsMutable
-              -> Package
-              -> ConfigureOpts
+configureOpts ::
+     EnvConfig
+  -> BaseConfigOpts
+  -> Map PackageIdentifier GhcPkgId -- ^ dependencies
+  -> Bool -- ^ local non-extra-dep?
+  -> IsMutable
+  -> Package
+  -> ConfigureOpts
 configureOpts econfig bco deps isLocal isMutable package = ConfigureOpts
-  { dirs = configureOptsDirs bco isMutable package
-  , noDirs = configureOptsNoDir econfig bco deps isLocal package
+  { pathRelated = configureOptsPathRelated bco isMutable package
+  , nonPathRelated =
+      configureOptsNonPathRelated econfig bco deps isLocal package
   }
 
-
-configureOptsDirs :: BaseConfigOpts
-                  -> IsMutable
-                  -> Package
-                  -> [String]
-configureOptsDirs bco isMutable package = concat
+configureOptsPathRelated ::
+     BaseConfigOpts
+  -> IsMutable
+  -> Package
+  -> [String]
+configureOptsPathRelated bco isMutable package = concat
   [ ["--user", "--package-db=clear", "--package-db=global"]
   , map (("--package-db=" ++) . toFilePathNoTrailingSep) $ case isMutable of
       Immutable -> bco.extraDBs ++ [bco.snapDB]
@@ -97,14 +99,14 @@ configureOptsDirs bco isMutable package = concat
     )
 
 -- | Same as 'configureOpts', but does not include directory path options
-configureOptsNoDir ::
+configureOptsNonPathRelated ::
      EnvConfig
   -> BaseConfigOpts
   -> Map PackageIdentifier GhcPkgId -- ^ Dependencies.
   -> Bool -- ^ Is this a local, non-extra-dep?
   -> Package
   -> [String]
-configureOptsNoDir econfig bco deps isLocal package = concat
+configureOptsNonPathRelated econfig bco deps isLocal package = concat
   [ depOptions
   , [ "--enable-library-profiling"
     | bopts.libProfile || bopts.exeProfile
@@ -192,13 +194,14 @@ configureOptsNoDir econfig bco deps isLocal package = concat
       LSubLibName cn ->
         unPackageName subPkgName <> ":" <> unUnqualComponentName cn
 
--- | Configure options to be sent to Setup.hs configure
+-- | Configure options to be sent to Setup.hs configure.
 data ConfigureOpts = ConfigureOpts
-  { dirs :: ![String]
+  { pathRelated :: ![String]
     -- ^ Options related to various paths. We separate these out since they do
-    -- not have an impact on the contents of the compiled binary for checking
+    -- not have an effect on the contents of the compiled binary for checking
     -- if we can use an existing precompiled cache.
-  , noDirs :: ![String]
+  , nonPathRelated :: ![String]
+    -- ^ Options other than path-related options.
   }
   deriving (Data, Eq, Generic, Show, Typeable)