GHC 9.12 support (#4527)

* GHC 9.12 support

* cabal plugin

* Fix hls-call-hierarchy-plugin tests

* Fix hls-pragma-plugin tests

* Add golden files specific to GHC 9.12.2

* Apply stylish-haskell formatting

* Fix dodgy import in hls-semantic-token-plugin

* Remove all deriving (Typeable). It is done by default

* Fix view-pattern type sig warning

* Run hls-eval-plugin test on Windows for GHC 9.12 only

* Fix referenceImplementation for FuzzySearch tests

---------

Co-authored-by: fendor <[email protected]>
Co-authored-by: fendor <[email protected]>

Author: wz1000

Diff for: .github/workflows/supported-ghc-versions.json

@@ -1 +1 @@
-["9.10", "9.8", "9.6", "9.4"]
+["9.12", "9.10", "9.8", "9.6", "9.4"]

Diff for: .github/workflows/test.yml

@@ -134,12 +134,12 @@ jobs:
           HLS_WRAPPER_TEST_EXE: hls-wrapper
         run: cabal test wrapper-test
 
-      - if: matrix.test
+      - if: matrix.test && matrix.ghc != '9.12'
         name: Test hls-refactor-plugin
         run: cabal test hls-refactor-plugin-tests || cabal test hls-refactor-plugin-tests
 
       # TODO enable when it supports 9.10
-      - if: matrix.test && matrix.ghc != '9.10'
+      - if: matrix.test && matrix.ghc != '9.10' && matrix.ghc != '9.12'
         name: Test hls-floskell-plugin
         run: cabal test hls-floskell-plugin-tests || cabal test hls-floskell-plugin-tests
 
@@ -156,24 +156,24 @@ jobs:
         run: cabal test hls-eval-plugin-tests || cabal test hls-eval-plugin-tests
 
       # TODO enable when it supports 9.10
-      - if: matrix.test && matrix.ghc != '9.10'
+      - if: matrix.test && matrix.ghc != '9.10' && matrix.ghc != '9.12'
         name: Test hls-splice-plugin
         run: cabal test hls-splice-plugin-tests || cabal test hls-splice-plugin-tests
 
-      - if: matrix.test
+      - if: matrix.test && matrix.ghc != '9.12'
         name: Test hls-stan-plugin
         run: cabal test hls-stan-plugin-tests || cabal test hls-stan-plugin-tests
 
       # TODO enable when it supports 9.10
-      - if: matrix.test && matrix.ghc != '9.10'
+      - if: matrix.test && matrix.ghc != '9.10' && matrix.ghc != '9.12'
         name: Test hls-stylish-haskell-plugin
         run: cabal test hls-stylish-haskell-plugin-tests || cabal test hls-stylish-haskell-plugin-tests
 
-      - if: matrix.test
+      - if: matrix.test && matrix.ghc != '9.12'
         name: Test hls-ormolu-plugin
         run: cabal test hls-ormolu-plugin-tests || cabal test hls-ormolu-plugin-tests
 
-      - if: matrix.test
+      - if: matrix.test && matrix.ghc != '9.12'
         name: Test hls-fourmolu-plugin
         run: cabal test hls-fourmolu-plugin-tests || cabal test hls-fourmolu-plugin-tests
 
@@ -185,12 +185,12 @@ jobs:
         name: Test hls-call-hierarchy-plugin test suite
         run: cabal test hls-call-hierarchy-plugin-tests || cabal test hls-call-hierarchy-plugin-tests
 
-      - if: matrix.test && matrix.os != 'windows-latest'
+      - if: matrix.test && matrix.os != 'windows-latest' && matrix.ghc != '9.12'
         name: Test hls-rename-plugin test suite
         run: cabal test hls-rename-plugin-tests || cabal test hls-rename-plugin-tests
 
       # TODO enable when it supports 9.10
-      - if: matrix.test && matrix.ghc != '9.10'
+      - if: matrix.test && matrix.ghc != '9.10' && matrix.ghc != '9.12'
         name: Test hls-hlint-plugin test suite
         run: cabal test hls-hlint-plugin-tests || cabal test hls-hlint-plugin-tests
 
@@ -214,7 +214,7 @@ jobs:
         name: Test hls-change-type-signature test suite
         run: cabal test hls-change-type-signature-plugin-tests || cabal test hls-change-type-signature-plugin-tests
 
-      - if: matrix.test
+      - if: matrix.test && matrix.ghc != '9.12'
         name: Test hls-gadt-plugin test suit
         run: cabal test hls-gadt-plugin-tests || cabal test hls-gadt-plugin-tests
 
@@ -227,11 +227,11 @@ jobs:
         run: cabal test hls-explicit-record-fields-plugin-tests || cabal test hls-explicit-record-fields-plugin-tests
 
       # versions need to be limited since the tests depend on cabal-fmt which only builds with ghc <9.10
-      - if: matrix.test && matrix.ghc != '9.10'
+      - if: matrix.test && matrix.ghc != '9.10' && matrix.ghc != '9.12'
         name: Test hls-cabal-fmt-plugin test suite
         run: cabal test hls-cabal-fmt-plugin-tests --flag=isolateCabalfmtTests || cabal test hls-cabal-fmt-plugin-tests --flag=isolateCabalfmtTests
 
-      - if: matrix.test
+      - if: matrix.test && matrix.ghc != '9.12'
         name: Test hls-cabal-gild-plugin test suite
         run: cabal test hls-cabal-gild-plugin-tests --flag=isolateCabalGildTests || cabal test hls-cabal-gild-plugin-tests --flag=isolateCabalGildTests
 
@@ -240,7 +240,7 @@ jobs:
         run: cabal test hls-cabal-plugin-tests || cabal test hls-cabal-plugin-tests
 
       # TODO enable when it supports 9.10
-      - if: matrix.test && matrix.ghc != '9.10'
+      - if: matrix.test && matrix.ghc != '9.10' && matrix.ghc != '9.12'
         name: Test hls-retrie-plugin test suite
         run: cabal test hls-retrie-plugin-tests || cabal test hls-retrie-plugin-tests
 

Diff for: cabal.project

@@ -8,7 +8,7 @@ packages:
          ./hls-test-utils
 
 
-index-state:  2024-12-02T00:00:00Z
+index-state:  2025-03-20T00:00:00Z
 
 tests: True
 test-show-details: direct
@@ -59,3 +59,14 @@ if impl(ghc >= 9.8.4) && impl(ghc < 9.8.5)
     ghc-lib-parser:filepath
   constraints:
     ghc-lib-parser==9.8.4.20241130
+
+if impl(ghc >= 9.11)
+  benchmarks: False
+  allow-newer:
+    hiedb:base,
+    hiedb:ghc,
+    hie-bios:ghc,
+    ghc-trace-events:base,
+    tasty-hspec:base,
+    cabal-install-parsers:base,
+    cabal-install-parsers:time,

Diff for: ghcide-test/exe/ExceptionTests.hs

@@ -8,7 +8,7 @@ import           Control.Monad.Error.Class         (MonadError (throwError))
 import           Control.Monad.IO.Class            (liftIO)
 import qualified Data.Aeson                        as A
 import           Data.Default                      (Default (..))
-import           Data.Text                         as T
+import qualified Data.Text                         as T
 import           Development.IDE.Core.Shake        (IdeState (..))
 import qualified Development.IDE.LSP.Notifications as Notifications
 import           Development.IDE.Plugin.HLS        (toResponseError)

Diff for: ghcide-test/exe/FuzzySearch.hs

@@ -88,7 +88,7 @@ referenceImplementation :: forall s t.
   (t -> s) ->
   -- | The original value, rendered string and score.
   Maybe (Fuzzy t s)
-referenceImplementation pat t pre post extract =
+referenceImplementation pat' t pre post extract =
   if null pat then Just (Fuzzy t result totalScore) else Nothing
   where
     null :: (T.TextualMonoid s) => s -> Bool
@@ -119,7 +119,7 @@ referenceImplementation pat t pre post extract =
         ( 0,
           1, -- matching at the start gives a bonus (cur = 1)
           mempty,
-          pat,
+          pat',
           True
         )
         s

Diff for: ghcide-test/exe/UnitTests.hs

@@ -29,6 +29,8 @@ import qualified Progress
 import           System.IO.Extra                   hiding (withTempDir)
 import           System.Mem                        (performGC)
 import           Test.Hls                          (IdeState, def,
+                                                    ignoreForGhcVersions,
+                                                    GhcVersion(..),
                                                     runSessionWithServerInTmpDir,
                                                     waitForProgressDone)
 import           Test.Tasty

Diff for: ghcide/ghcide.cabal

@@ -87,6 +87,7 @@ library
     , mtl
     , opentelemetry                >=0.6.1
     , optparse-applicative
+    , os-string
     , parallel
     , prettyprinter                >=1.7
     , prettyprinter-ansi-terminal

Diff for: ghcide/session-loader/Development/IDE/Session.hs

@@ -124,6 +124,10 @@ import           GHC.Types.Error                     (errMsgDiagnostic,
                                                       singleMessage)
 import           GHC.Unit.State
 
+#if MIN_VERSION_ghc(9,13,0)
+import           GHC.Driver.Make                     (checkHomeUnitsClosed)
+#endif
+
 data Log
   = LogSettingInitialDynFlags
   | LogGetInitialGhcLibDirDefaultCradleFail !CradleError !FilePath !(Maybe FilePath) !(Cradle Void)
@@ -782,6 +786,11 @@ toFlagsMap TargetDetails{..} =
 setNameCache :: NameCache -> HscEnv -> HscEnv
 setNameCache nc hsc = hsc { hsc_NC = nc }
 
+#if MIN_VERSION_ghc(9,13,0)
+-- Moved back to implementation in GHC.
+checkHomeUnitsClosed' ::  UnitEnv -> OS.Set UnitId -> [DriverMessages]
+checkHomeUnitsClosed' ue _ = checkHomeUnitsClosed ue
+#elif MIN_VERSION_ghc(9,3,0)
 -- This function checks the important property that if both p and q are home units
 -- then any dependency of p, which transitively depends on q is also a home unit.
 -- GHC had an implementation of this function, but it was horribly inefficient
@@ -838,6 +847,7 @@ checkHomeUnitsClosed' ue home_id_set
                     Just depends ->
                       let todo'' = (depends OS.\\ done) `OS.union` todo'
                       in DigraphNode uid uid (OS.toList depends) : go (OS.insert uid done) todo''
+#endif
 
 -- | Create a mapping from FilePaths to HscEnvEqs
 -- This combines all the components we know about into