Merge branch 'monday-improvements'

haskell · Nov 14, 2023 · b110698 · b110698
2 parents dee5444 + cd8ce9a
commit b110698
Show file tree

Hide file tree

Showing 16 changed files with 13,703 additions and 12,756 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -322,7 +322,7 @@ jobs:
         with:
           name: testfiles
           path: |
-            ./test/golden/unix/GHCupInfo*json
+            ./test/ghcup-test/golden/unix/GHCupInfo*json
 
   test-arm:
     name: Test ARM
@@ -389,7 +389,7 @@ jobs:
         with:
           name: testfiles
           path: |
-            ./test/golden/unix/GHCupInfo*json
+            ./test/ghcup-test/golden/unix/GHCupInfo*json
 
   test-macwin:
     name: Test Mac/Win
@@ -458,15 +458,15 @@ jobs:
         with:
           name: testfiles
           path: |
-            ./test/golden/windows/GHCupInfo*json
+            ./test/ghcup-test/golden/windows/GHCupInfo*json
 
       - if: failure() && runner.os != 'Windows'
         name: Upload artifact
         uses: actions/upload-artifact@v3
         with:
           name: testfiles
           path: |
-            ./test/golden/unix/GHCupInfo*json
+            ./test/ghcup-test/golden/unix/GHCupInfo*json
   hls:
     name: hls
     needs: build-linux

diff --git a/app/ghcup/BrickMain.hs b/app/ghcup/BrickMain.hs
@@ -683,7 +683,7 @@ settings' = unsafePerformIO $ do
   newIORef $ AppState defaultSettings
                       dirs
                       defaultKeyBindings
-                      (GHCupInfo mempty mempty mempty)
+                      (GHCupInfo mempty mempty Nothing)
                       (PlatformRequest A_64 Darwin Nothing)
                       loggerConfig
 

diff --git a/app/ghcup/Main.hs b/app/ghcup/Main.hs
@@ -261,7 +261,7 @@ Report bugs at <https://github.com/haskell/ghcup-hs/issues>|]
                          Just _ -> pure ()
 
                 -- TODO: always run for windows
-                siletRunLogger (flip runReaderT s' $ runE ensureGlobalTools) >>= \case
+                siletRunLogger (flip runReaderT s' $ runE ensureShimGen) >>= \case
                   VRight _ -> pure ()
                   VLeft e -> do
                     runLogger

diff --git a/lib/GHCup/Download.hs b/lib/GHCup/Download.hs
@@ -158,7 +158,7 @@ getDownloadsF pfreq@(PlatformRequest arch plat _) = do
                             catchE @JSONError (\(JSONDecodeError _) -> do
                                 logDebug $ "Couldn't decode " <> T.pack base <> " as GHCupInfo, trying as SetupInfo: "
                                 Right <$> decodeMetadata @Stack.SetupInfo base)
-                              $ fmap Left $ decodeMetadata @GHCupInfo base
+                              $ fmap Left (decodeMetadata @GHCupInfo base >>= \gI -> warnOnMetadataUpdate uri gI >> pure gI)
 
   fromStackSetupInfo :: MonadThrow m
                      => Stack.SetupInfo
@@ -170,7 +170,7 @@ getDownloadsF pfreq@(PlatformRequest arch plat _) = do
     (ghcupInfo' :: M.Map GHCTargetVersion DownloadInfo) <-
       M.mapKeys mkTVer <$> M.traverseMaybeWithKey (\_ a -> pure $ fromStackDownloadInfo a) ghcVersions
     let ghcupDownloads' = M.singleton GHC (M.map fromDownloadInfo ghcupInfo')
-    pure (GHCupInfo mempty ghcupDownloads' mempty)
+    pure (GHCupInfo mempty ghcupDownloads' Nothing)
    where
     fromDownloadInfo :: DownloadInfo -> VersionInfo
     fromDownloadInfo dli = let aspec = M.singleton arch (M.singleton plat (M.singleton Nothing dli))
@@ -189,9 +189,8 @@ getDownloadsF pfreq@(PlatformRequest arch plat _) = do
   mergeGhcupInfo [] = fail "mergeGhcupInfo: internal error: need at least one GHCupInfo"
   mergeGhcupInfo xs@(GHCupInfo{}: _) =
     let newDownloads   = M.unionsWith (M.unionWith (\_ b2 -> b2)) (_ghcupDownloads   <$> xs)
-        newGlobalTools = M.unionsWith (\_ a2 -> a2              ) (_globalTools      <$> xs)
         newToolReqs    = M.unionsWith (M.unionWith (\_ b2 -> b2)) (_toolRequirements <$> xs)
-    in pure $ GHCupInfo newToolReqs newDownloads newGlobalTools
+    in pure $ GHCupInfo newToolReqs newDownloads Nothing
 
 
 
@@ -308,6 +307,36 @@ getBase uri = do
 
       pure f
 
+warnOnMetadataUpdate ::
+           ( MonadReader env m
+           , MonadIO m
+           , HasLog env
+           , HasDirs env
+           )
+        => URI
+        -> GHCupInfo
+        -> m ()
+warnOnMetadataUpdate uri (GHCupInfo { _metadataUpdate = Just newUri })
+  | scheme' uri == "file"
+  , urlBase' uri /= urlBase' newUri = do
+      confFile <- getConfigFilePath'
+      logWarn $ "New metadata version detected"
+                           <> "\n    old URI: " <> (decUTF8Safe . serializeURIRef') uri
+                           <> "\n    new URI: " <> (decUTF8Safe . serializeURIRef') newUri
+                           <> "\nYou might need to update your " <> T.pack confFile
+  | scheme' uri /= "file"
+  , uri /= newUri = do
+      confFile <- getConfigFilePath'
+      logWarn $ "New metadata version detected"
+                           <> "\n    old URI: " <> (decUTF8Safe . serializeURIRef') uri
+                           <> "\n    new URI: " <> (decUTF8Safe . serializeURIRef') newUri
+                           <> "\nYou might need to update your " <> T.pack confFile
+ where
+  scheme' = view (uriSchemeL' % schemeBSL')
+  urlBase' = T.unpack . decUTF8Safe . urlBaseName . view pathL'
+warnOnMetadataUpdate _ _ = pure ()
+
+
 decodeMetadata :: forall j m env .
                ( MonadReader env m
                , HasDirs env

diff --git a/lib/GHCup/Errors.hs b/lib/GHCup/Errors.hs
@@ -209,7 +209,6 @@ instance HFErrorProject NoCompatiblePlatform where
 
 -- | Unable to find a download for the requested version/distro.
 data NoDownload = NoDownload GHCTargetVersion Tool (Maybe PlatformRequest)
-                | NoDownload' GlobalTool
   deriving Show
 
 instance Pretty NoDownload where
@@ -227,7 +226,6 @@ instance Pretty NoDownload where
              <> T.unpack (prettyVer vv)
              <> "'"
     | otherwise = text $ "Unable to find a download for " <> T.unpack (tVerToText tver)
-  pPrint (NoDownload' globalTool) = text $ "Unable to find a download for " <> prettyShow globalTool
 
 instance HFErrorProject NoDownload where
   eBase _ = 10

diff --git a/lib/GHCup/GHC.hs b/lib/GHCup/GHC.hs
@@ -763,7 +763,8 @@ rmGHCVer ver = do
 
   Dirs {..} <- lift getDirs
 
-  lift $ hideError doesNotExistErrorType $ rmDirectoryLink (fromGHCupPath baseDir </> "share")
+  when isSetGHC $ do
+    lift $ hideError doesNotExistErrorType $ rmDirectoryLink (fromGHCupPath baseDir </> "share")
 
 
 

diff --git a/lib/GHCup/Prelude/File.hs b/lib/GHCup/Prelude/File.hs
@@ -387,7 +387,7 @@ rmLink fp
 --
 -- This overwrites previously existing files.
 --
--- On windows, this requires that 'ensureGlobalTools' was run beforehand.
+-- On windows, this requires that 'ensureShimGen' was run beforehand.
 createLink :: ( MonadMask m
               , MonadThrow m
               , HasLog env

diff --git a/lib/GHCup/Types.hs b/lib/GHCup/Types.hs
@@ -74,7 +74,7 @@ data KeyCombination = KeyCombination { key :: Key, mods :: [Modifier] }
 data GHCupInfo = GHCupInfo
   { _toolRequirements :: ToolRequirements
   , _ghcupDownloads   :: GHCupDownloads
-  , _globalTools      :: Map GlobalTool DownloadInfo
+  , _metadataUpdate   :: Maybe URI
   }
   deriving (Show, GHC.Generic, Eq)
 
@@ -136,14 +136,6 @@ instance Pretty Tool where
 
 instance NFData Tool
 
-data GlobalTool = ShimGen
-  deriving (Eq, GHC.Generic, Ord, Show, Enum, Bounded)
-
-instance NFData GlobalTool
-
-instance Pretty GlobalTool where
-  pPrint ShimGen = text "shimgen"
-
 
 -- | All necessary information of a tool version, including
 -- source download and per-architecture downloads.

diff --git a/lib/GHCup/Types/JSON.hs b/lib/GHCup/Types/JSON.hs
@@ -59,7 +59,6 @@ deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''Chunk
 deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''Release
 deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''SemVer
 deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''Tool
-deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''GlobalTool
 deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''KeepDirs
 deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''Downloader
 deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''GPGSetting
@@ -158,12 +157,6 @@ instance ToJSONKey Tool where
 instance FromJSONKey Tool where
   fromJSONKey = genericFromJSONKey defaultJSONKeyOptions
 
-instance ToJSONKey GlobalTool where
-  toJSONKey = genericToJSONKey defaultJSONKeyOptions
-
-instance FromJSONKey GlobalTool where
-  fromJSONKey = genericFromJSONKey defaultJSONKeyOptions
-
 instance ToJSON TarDir where
   toJSON (RealDir  p) = toJSON p
   toJSON (RegexDir r) = object ["RegexDir" .= r]
@@ -288,9 +281,9 @@ deriveJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''Versio
 instance FromJSON GHCupInfo where
   parseJSON = withObject "GHCupInfo" $ \o -> do
     toolRequirements' <- o .:? "toolRequirements"
-    globalTools'      <- o .:? "globalTools"
+    metadataUpdate    <- o .:? "metadataUpdate"
     ghcupDownloads'   <- o .:  "ghcupDownloads"
-    pure (GHCupInfo (fromMaybe mempty toolRequirements') ghcupDownloads' (fromMaybe mempty globalTools'))
+    pure (GHCupInfo (fromMaybe mempty toolRequirements') ghcupDownloads' metadataUpdate)
 
 deriveToJSON defaultOptions { fieldLabelModifier = removeLensFieldLabel } ''GHCupInfo
 

diff --git a/lib/GHCup/Utils.hs b/lib/GHCup/Utils.hs
@@ -1199,24 +1199,22 @@ getVersionInfo v' tool =
     )
 
 
-ensureGlobalTools :: ( MonadMask m
-                     , MonadThrow m
-                     , HasLog env
-                     , MonadIO m
-                     , MonadReader env m
-                     , HasDirs env
-                     , HasSettings env
-                     , HasGHCupInfo env
-                     , MonadUnliftIO m
-                     , MonadFail m
-                     )
-                  => Excepts '[GPGError, DigestError, ContentLengthError, DownloadFailed, NoDownload] m ()
-ensureGlobalTools
+ensureShimGen :: ( MonadMask m
+                 , MonadThrow m
+                 , HasLog env
+                 , MonadIO m
+                 , MonadReader env m
+                 , HasDirs env
+                 , HasSettings env
+                 , HasGHCupInfo env
+                 , MonadUnliftIO m
+                 , MonadFail m
+                 )
+              => Excepts '[GPGError, DigestError, ContentLengthError, DownloadFailed, NoDownload] m ()
+ensureShimGen
   | isWindows = do
-      (GHCupInfo _ _ gTools) <- lift getGHCupInfo
       dirs <- lift getDirs
-      shimDownload <- liftE $ lE @_ @'[NoDownload]
-        $ maybe (Left (NoDownload' ShimGen)) Right $ Map.lookup ShimGen gTools
+      let shimDownload = DownloadInfo shimGenURL Nothing shimGenSHA Nothing Nothing
       let dl = downloadCached' shimDownload (Just "gs.exe") Nothing
       void $ (\DigestError{} -> do
           lift $ logWarn "Digest doesn't match, redownloading gs.exe..."

diff --git a/lib/GHCup/Utils/Dirs.hs b/lib/GHCup/Utils/Dirs.hs
@@ -29,6 +29,7 @@ module GHCup.Utils.Dirs
   , relativeSymlink
   , withGHCupTmpDir
   , getConfigFilePath
+  , getConfigFilePath'
   , useXDG
   , cleanupTrash
 
@@ -360,6 +361,12 @@ getConfigFilePath = do
   confDir <- liftIO ghcupConfigDir
   pure $ fromGHCupPath confDir </> "config.yaml"
 
+getConfigFilePath' :: (MonadReader env m, HasDirs env) => m FilePath
+getConfigFilePath' = do
+  Dirs {..} <- getDirs
+  pure $ fromGHCupPath confDir </> "config.yaml"
+
+
 ghcupConfigFile :: (MonadIO m)
                 => Excepts '[JSONError] m UserSettings
 ghcupConfigFile = do

diff --git a/lib/GHCup/Version.hs b/lib/GHCup/Version.hs
@@ -39,6 +39,12 @@ ghcupURL = [uri|https://raw.githubusercontent.com/haskell/ghcup-metadata/master/
 stackSetupURL :: URI
 stackSetupURL = [uri|https://raw.githubusercontent.com/commercialhaskell/stackage-content/master/stack/stack-setup-2.yaml|]
 
+shimGenURL :: URI
+shimGenURL = [uri|https://downloads.haskell.org/~ghcup/shimgen/shim-2.exe|]
+
+shimGenSHA :: T.Text
+shimGenSHA = T.pack "7c55e201f71860c5babea886007c8fa44b861abf50d1c07e5677eb0bda387a70"
+
 -- | The current ghcup version.
 ghcUpVer :: V.PVP
 ghcUpVer = V.PVP . NE.fromList . fmap fromIntegral $ versionBranch version

diff --git a/scripts/dev/update-shell-completions.sh b/scripts/dev/update-shell-completions.sh
@@ -0,0 +1,8 @@
+#!/bin/sh
+
+set -xue
+
+cabal --verbose=0 run ghcup:exe:ghcup -- --bash-completion-script ghcup > scripts/shell-completions/bash
+cabal --verbose=0 run ghcup:exe:ghcup -- --zsh-completion-script ghcup > scripts/shell-completions/zsh
+cabal --verbose=0 run ghcup:exe:ghcup -- --fish-completion-script ghcup > scripts/shell-completions/fish
+
diff --git a/test/ghcup-test/GHCup/ArbitraryTypes.hs b/test/ghcup-test/GHCup/ArbitraryTypes.hs
@@ -175,10 +175,6 @@ instance Arbitrary Tool where
   arbitrary = genericArbitrary
   shrink    = genericShrink
 
-instance Arbitrary GlobalTool where
-  arbitrary = genericArbitrary
-  shrink    = genericShrink
-
 instance Arbitrary GHCupInfo where
   arbitrary = genericArbitrary
   shrink    = genericShrink