Have ConfigCache distinguish between local and upstream src #2147

Author: mgsloan

src/Stack/Build/ConstructPlan.hs

@@ -352,6 +352,7 @@ addFinal lp package isAllInOne = do
                 , taskPresent = present
                 , taskType = TTLocal lp
                 , taskAllInOne = isAllInOne
+                , taskCachePkgSrc = CacheSrcLocal
                 }
     tell mempty { wFinals = Map.singleton (packageName package) res }
 
@@ -552,6 +553,7 @@ installPackageGivenDeps isAllInOne ps package minstalled (missing, present, minL
                     PSLocal lp -> TTLocal lp
                     PSUpstream _ loc _ _ sha -> TTUpstream package (loc <> minLoc) sha
             , taskAllInOne = isAllInOne
+            , taskCachePkgSrc = toCachePkgSrc ps
             }
 
 -- Update response in the lib map. If it is an error, and there's
@@ -684,6 +686,7 @@ checkDirtiness ps installed package present wanted = do
                 shouldHaddockPackage buildOpts wanted (packageName package) ||
                 -- Disabling haddocks when old config had haddocks doesn't make dirty.
                 maybe False configCacheHaddock moldOpts
+            , configCachePkgSrc = toCachePkgSrc ps
             }
     let mreason =
             case moldOpts of
@@ -703,6 +706,10 @@ checkDirtiness ps installed package present wanted = do
 
 describeConfigDiff :: Config -> ConfigCache -> ConfigCache -> Maybe Text
 describeConfigDiff config old new
+    | configCachePkgSrc old /= configCachePkgSrc new = Just $
+        "switching from " <>
+        pkgSrcName (configCachePkgSrc old) <> " to " <>
+        pkgSrcName (configCachePkgSrc new)
     | not (configCacheDeps new `Set.isSubsetOf` configCacheDeps old) = Just "dependencies changed"
     | not $ Set.null newComponents =
         Just $ "components added: " `T.append` T.intercalate ", "
@@ -760,6 +767,9 @@ describeConfigDiff config old new
 
     newComponents = configCacheComponents new `Set.difference` configCacheComponents old
 
+    pkgSrcName CacheSrcLocal = "local source"
+    pkgSrcName CacheSrcUpstream = "upstream source"
+
 psForceDirty :: PackageSource -> Bool
 psForceDirty (PSLocal lp) = lpForceDirty lp
 psForceDirty PSUpstream{} = False

src/Stack/Build/Execute.hs

@@ -790,6 +790,7 @@ getConfigCache ExecuteEnv {..} Task {..} installedMap enableTest enableBench = d
                     TTUpstream{} -> Set.empty
             , configCacheHaddock =
                 shouldHaddockPackage eeBuildOpts eeWanted (packageIdentifierName taskProvides)
+            , configCachePkgSrc = taskCachePkgSrc
             }
         allDepsMap = Map.union missing' taskPresent
     return (allDepsMap, cache)

src/Stack/SDist.hs

@@ -239,6 +239,7 @@ getSDistFileList lp =
             }
         , taskPresent = Map.empty
         , taskAllInOne = True
+        , taskCachePkgSrc = CacheSrcLocal
         }
 
 normalizeTarballPaths :: (StackM env m) => [FilePath] -> m [FilePath]

src/Stack/Types/Build.hs

@@ -35,6 +35,8 @@ module Stack.Types.Build
     ,ConfigCache(..)
     ,configCacheVC
     ,configureOpts
+    ,CachePkgSrc (..)
+    ,toCachePkgSrc
     ,isStackOpt
     ,wantedLocalPackages
     ,FileCacheInfo (..)
@@ -393,13 +395,23 @@ data ConfigCache = ConfigCache
       -- is a convenient way to force compilation when the components change.
     , configCacheHaddock :: !Bool
       -- ^ Are haddocks to be built?
+    , configCachePkgSrc :: !CachePkgSrc
     }
     deriving (Generic, Eq, Show, Data, Typeable)
 instance Store ConfigCache
 instance NFData ConfigCache
 
+data CachePkgSrc = CacheSrcUpstream | CacheSrcLocal
+    deriving (Generic, Eq, Show, Data, Typeable)
+instance Store CachePkgSrc
+instance NFData CachePkgSrc
+
+toCachePkgSrc :: PackageSource -> CachePkgSrc
+toCachePkgSrc PSLocal{} = CacheSrcLocal
+toCachePkgSrc PSUpstream{} = CacheSrcUpstream
+
 configCacheVC :: VersionConfig ConfigCache
-configCacheVC = storeVersionConfig "config-v1" "NMEzMXpksE1h7STRzlQ2f6Glkjo="
+configCacheVC = storeVersionConfig "config-v2" "IU16Mr9HCSnOm0APqrPUvCW0adw="
 
 -- | A task to perform when building
 data Task = Task
@@ -412,6 +424,7 @@ data Task = Task
     -- ^ GhcPkgIds of already-installed dependencies
     , taskAllInOne        :: !Bool
     -- ^ indicates that the package can be built in one step
+    , taskCachePkgSrc     :: !CachePkgSrc
     }
     deriving Show