Merge branch 'master' into filter-atpoint-results

Author: pepeiborra

.github/actions/setup-build/action.yml

@@ -23,7 +23,7 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - uses: haskell/actions/setup@v1
+    - uses: haskell/actions/setup@v2
       id: HaskEnvSetup
       with:
         ghc-version  : ${{ inputs.ghc   }}
@@ -74,7 +74,7 @@ runs:
     # We have to restore package sources before `cabal update`
     # because it overwrites the hackage index with the cached one
     - name: Hackage sources cache
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       env:
         cache-name: hackage-sources
       with:
@@ -99,7 +99,7 @@ runs:
 
     - name: Compiled deps cache
       id: compiled-deps
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       env:
         cache-name: compiled-deps
       with:

.github/workflows/caching.yml

@@ -80,7 +80,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ghc: [ "9.2.4"
+        # This list of GHC versions must fit to the list of GHC versions
+        # specified in 'test.yml'
+        ghc: [ "9.4.2"
+             , "9.4.1"
+             , "9.2.4"
              , "9.2.3"
              , "9.0.2"
              , "8.10.7"
@@ -89,6 +93,9 @@ jobs:
             , "macOS-latest"
             , "windows-latest"
             ]
+        exclude:
+          - os: windows-latest
+            ghc: '9.4.1'
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/pre-commit.yml

@@ -26,6 +26,8 @@ jobs:
     - uses: actions/checkout@v3
     - uses: ./.github/actions/setup-build
       with:
+        # select a stable GHC version
+        ghc: 9.2.5
         os: ${{ runner.os }}
         shorten-hls: false
 

.github/workflows/test.yml

@@ -56,6 +56,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: true
+      # when you edit this list of GHC versions,
+      # **don't forget**
+      # to update the ghc versions in 'caching.yml'.
       matrix:
         ghc: [ "9.4.2"
              , "9.4.1"
@@ -66,7 +69,15 @@ jobs:
              ]
         os: [ "ubuntu-latest"
             , "macOS-latest"
+            , "windows-latest"
             ]
+        # don't build these versions
+        # they are broken for good reasons, e.g. compiler is bugged
+        # on that platform.
+        exclude:
+           - os: windows-latest
+             ghc: '9.4.1'
+        # Mark which GHC versions on which platform we want to test.
         include:
            # only test supported ghc major versions
            - os: ubuntu-latest
@@ -93,9 +104,6 @@ jobs:
            - os: windows-latest
              ghc: '8.10.7'
              test: true
-           # only build rest of supported ghc versions for windows
-           - os: windows-latest
-             ghc: '9.2.3'
 
     steps:
       - uses: actions/checkout@v3
@@ -115,7 +123,7 @@ jobs:
         run: |
           echo "TEST_OPTS=-j1 --rerun-update --rerun-filter failures,exceptions" >> $GITHUB_ENV
 
-      - name: Cache test log bewteen attempts of the same run
+      - name: Cache test log between attempts of the same run
         uses: actions/cache@v3
         env:
           cache-name: cache-test-log

docs/contributing/releases.md

@@ -1,19 +1,21 @@
 # Releases and distributable binaries
 
 Starting with 0.2.1.0 haskell-language-server provides pre-built binaries on
-each [GitHub
-release](https://github.com/haskell/haskell-language-server/releases). These
-binaries are used by the [vscode-hie-server
-extension](https://github.com/alanz/vscode-hie-server) to provide automatic
-installation for users on VS Code, but they can also be installed manually
+each [GitHub release](https://github.com/haskell/haskell-language-server/releases).
+These binaries are used by the [vscode-haskell extension](https://github.com/haskell/vscode-haskell)
+to provide automatic installation for users on VS Code, but they can also be installed manually
 when added to the path.
 
 Starting with 0.8.0.0 haskell-language-server and all its related packages
-(core libraries like ghcide, plugins and hls itself) is being released in
+(core libraries like ghcide, plugins and hls itself) is being released on
 [hackage](https://hackage.haskell.org/package/haskell-language-server) as well.
-This allow cabal users to install it with `cabal install haskell-language-server`
+This allows cabal users to install it with `cabal install haskell-language-server`
 and it is being used in nix environments.
 
+Since 1.7.0.0, HLS binaries are no longer uploaded to GitHub but to [downloads.haskell.org](https://downloads.haskell.org/~hls/).
+[GHCup](https://www.haskell.org/ghcup/) uses these binaries to enable automatic installation of HLS binaries in
+various lsp-client plugins, such as [vscode-haskell](https://github.com/haskell/vscode-haskell).
+
 ## Minimal checklist
 
 ### prerelease sanity checks

hls-test-utils/src/Test/Hls/Util.hs

@@ -6,37 +6,40 @@
 {-# LANGUAGE OverloadedStrings     #-}
 {-# LANGUAGE TypeOperators         #-}
 module Test.Hls.Util
-  (
+  (  -- * Test Capabilities
       codeActionSupportCaps
     , expectCodeAction
-    , dontExpectCodeAction
-    , expectDiagnostic
-    , expectNoMoreDiagnostics
-    , expectSameLocations
-    , failIfSessionTimeout
-    , flushStackEnvironment
-    , fromAction
-    , fromCommand
-    , getCompletionByLabel
+    -- * Environment specifications
+    -- for ignoring tests
     , ghcVersion, GhcVersion(..)
     , hostOS, OS(..)
     , matchesCurrentEnv, EnvSpec(..)
-    , noLiteralCaps
     , ignoreForGhcVersions
     , ignoreInEnv
     , onlyRunForGhcVersions
-    , inspectCodeAction
-    , inspectCommand
-    , inspectDiagnostic
     , knownBrokenOnWindows
     , knownBrokenForGhcVersions
     , knownBrokenInEnv
     , onlyWorkForGhcVersions
-    , setupBuildToolFiles
+    -- * Extract code actions
+    , fromAction
+    , fromCommand
+    -- * Session Assertion Helpers
+    , dontExpectCodeAction
+    , expectDiagnostic
+    , expectNoMoreDiagnostics
+    , expectSameLocations
+    , failIfSessionTimeout
+    , getCompletionByLabel
+    , noLiteralCaps
+    , inspectCodeAction
+    , inspectCommand
+    , inspectDiagnostic
     , SymbolLocation
     , waitForDiagnosticsFrom
     , waitForDiagnosticsFromSource
     , waitForDiagnosticsFromSourceWithTimeout
+    -- * Temporary directories
     , withCurrentDirectoryInTmp
     , withCurrentDirectoryInTmp'
     , withCanonicalTempDir
@@ -61,7 +64,6 @@ import qualified Language.LSP.Types.Capabilities as C
 import           Language.LSP.Types.Lens         (textDocument)
 import qualified Language.LSP.Types.Lens         as L
 import           System.Directory
-import           System.Environment
 import           System.FilePath
 import           System.Info.Extra               (isMac, isWindows)
 import qualified System.IO.Extra
@@ -87,34 +89,9 @@ codeActionSupportCaps = def & textDocument ?~ textDocumentCaps
     literalSupport = CodeActionLiteralSupport def
 
 -- ---------------------------------------------------------------------
-
-setupBuildToolFiles :: IO ()
-setupBuildToolFiles = do
-  forM_ files setupDirectFilesIn
-
-setupDirectFilesIn :: FilePath -> IO ()
-setupDirectFilesIn f =
-  writeFile (f ++ "hie.yaml") hieYamlCradleDirectContents
-
-
+-- Environment specification for ignoring tests
 -- ---------------------------------------------------------------------
 
-files :: [FilePath]
-files =
-  [  "./test/testdata/"
-   -- , "./test/testdata/addPackageTest/cabal-exe/"
-   -- , "./test/testdata/addPackageTest/hpack-exe/"
-   -- , "./test/testdata/addPackageTest/cabal-lib/"
-   -- , "./test/testdata/addPackageTest/hpack-lib/"
-   -- , "./test/testdata/addPragmas/"
-   -- , "./test/testdata/badProjects/cabal/"
-   -- , "./test/testdata/completion/"
-   -- , "./test/testdata/definition/"
-   -- , "./test/testdata/gototest/"
-   -- , "./test/testdata/redundantImportTest/"
-   -- , "./test/testdata/wErrorTest/"
-  ]
-
 data EnvSpec = HostOS OS | GhcVer GhcVersion
     deriving (Show, Eq)
 
@@ -168,30 +145,6 @@ onlyRunForGhcVersions vers =
 
 -- ---------------------------------------------------------------------
 
-hieYamlCradleDirectContents :: String
-hieYamlCradleDirectContents = unlines
-  [ "# WARNING: THIS FILE IS AUTOGENERATED IN test/utils/TestUtils.hs. IT WILL BE OVERWRITTEN ON EVERY TEST RUN"
-  , "cradle:"
-  , "  direct:"
-  , "    arguments:"
-  , "      - -i."
-  ]
-
-
--- ---------------------------------------------------------------------
-
-flushStackEnvironment :: IO ()
-flushStackEnvironment = do
-  -- We need to clear these environment variables to prevent
-  -- collisions with stack usages
-  -- See https://github.com/commercialhaskell/stack/issues/4875
-  unsetEnv "GHC_PACKAGE_PATH"
-  unsetEnv "GHC_ENVIRONMENT"
-  unsetEnv "HASKELL_PACKAGE_SANDBOX"
-  unsetEnv "HASKELL_PACKAGE_SANDBOXES"
-
--- ---------------------------------------------------------------------
-
 -- | Like 'withCurrentDirectory', but will copy the directory over to the system
 -- temporary directory first to avoid haskell-language-server's source tree from
 -- interfering with the cradle.

plugins/hls-refactor-plugin/src/Development/IDE/Plugin/CodeAction.hs

@@ -1841,7 +1841,19 @@ smallerRangesForBindingExport lies b =
     ranges' _ = []
 
 rangesForBinding' :: String -> LIE GhcPs -> [SrcSpan]
-rangesForBinding' b (L (locA -> l) x@IEVar{}) | T.unpack (printOutputable x) == b = [l]
+#if !MIN_VERSION_ghc(9,2,0)
+rangesForBinding' b (L (locA -> l) (IEVar _ nm))
+  | L _ (IEPattern (L _ b')) <- nm
+  , T.unpack (printOutputable b') == b
+  = [l]
+#else
+rangesForBinding' b (L (locA -> l) (IEVar _ nm))
+  | L _ (IEPattern _ (L _ b')) <- nm
+  , T.unpack (printOutputable b') == b
+  = [l]
+#endif
+rangesForBinding' b (L (locA -> l) x@IEVar{})
+  | T.unpack (printOutputable x) == b = [l]
 rangesForBinding' b (L (locA -> l) x@IEThingAbs{}) | T.unpack (printOutputable x) == b = [l]
 rangesForBinding' b (L (locA -> l) (IEThingAll _ x)) | T.unpack (printOutputable x) == b = [l]
 #if !MIN_VERSION_ghc(9,2,0)

test/functional/FunctionalCodeAction.hs

@@ -106,7 +106,6 @@ importTests = testGroup "import suggestions" [
 packageTests :: TestTree
 packageTests = testGroup "add package suggestions" [
     ignoreTestBecause "no support for adding dependent packages via code action" $ testCase "adds to .cabal files" $ do
-        flushStackEnvironment
         runSession hlsCommand fullCaps "test/testdata/addPackageTest/cabal-exe" $ do
             doc <- openDoc "AddPackage.hs" "haskell"
 
@@ -177,16 +176,21 @@ redundantImportTests = testGroup "redundant import code actions" [
             doc <- openDoc "src/CodeActionRedundant.hs" "haskell"
 
             diags <- waitForDiagnosticsFromSource doc "typecheck"
-            liftIO $ expectDiagnostic diags ["The import of", "Data.List", "is redundant"]
+            liftIO $ expectDiagnostic diags [ "The import of", "Data.List", "is redundant" ]
+            liftIO $ expectDiagnostic diags [ "Empty", "from module", "Data.Sequence" ]
 
             mActions <- getAllCodeActions doc
 
             let allActions = map fromAction mActions
                 actionTitles = map (view L.title) allActions
 
-            liftIO $ actionTitles `shouldContain` ["Remove import", "Remove all redundant imports"]
+            liftIO $ actionTitles `shouldContain`
+              [ "Remove import"
+              , "Remove Empty from import"
+              , "Remove all redundant imports"
+              ]
 
-            let mbRemoveAction = find (\x -> x ^. L.title == "Remove import") allActions
+            let mbRemoveAction = find (\x -> x ^. L.title == "Remove all redundant imports") allActions
 
             case mbRemoveAction of
                 Just removeAction -> do
@@ -203,7 +207,17 @@ redundantImportTests = testGroup "redundant import code actions" [
             -- provides workspace edit property which skips round trip to
             -- the server
             contents <- documentContents doc
-            liftIO $ contents @?= "{-# OPTIONS_GHC -Wunused-imports #-}\nmodule CodeActionRedundant where\nmain :: IO ()\nmain = putStrLn \"hello\"\n"
+            liftIO $ contents @?= T.unlines
+              [ "{-# OPTIONS_GHC -Wunused-imports #-}"
+              , "{-# LANGUAGE PatternSynonyms #-}"
+              , "module CodeActionRedundant where"
+              , "-- We need a non-reduntant import in the import list"
+              , "-- to properly test the removal of the singular redundant item"
+              , "import Data.Sequence (singleton)"
+              , "main :: IO ()"
+              , "main = putStrLn \"hello\""
+              , "  where unused = Data.Sequence.singleton 42"
+              ]
 
     , testCase "doesn't touch other imports" $ runSession hlsCommand noLiteralCaps "test/testdata/redundantImportTest/" $ do
         doc <- openDoc "src/MultipleImports.hs" "haskell"

test/testdata/redundantImportTest/src/CodeActionRedundant.hs

@@ -1,5 +1,10 @@
 {-# OPTIONS_GHC -Wunused-imports #-}
+{-# LANGUAGE PatternSynonyms #-}
 module CodeActionRedundant where
 import Data.List
+-- We need a non-reduntant import in the import list
+-- to properly test the removal of the singular redundant item
+import Data.Sequence (pattern Empty, singleton)
 main :: IO ()
 main = putStrLn "hello"
+  where unused = Data.Sequence.singleton 42

test/wrapper/Main.hs

@@ -5,9 +5,7 @@ import           System.Process
 import           Test.Hls
 
 main :: IO ()
-main = do
-  flushStackEnvironment
-  defaultTestRunner $ testGroup "haskell-language-server-wrapper" [projectGhcVersionTests]
+main = defaultTestRunner $ testGroup "haskell-language-server-wrapper" [projectGhcVersionTests]
 
 projectGhcVersionTests :: TestTree
 projectGhcVersionTests = testGroup "--project-ghc-version"