HLS suggests quick fixes but cannot apply them

[mfriley]

Your environment

• Arch Linux
• Emacs 28.2 + Eglot (also tested: lsp-mode, VSCode OSS with Haskell LSP plugin 2.2.1)
• GHC 9.2.4
• HLS 1.8.0.0
• Cabal 3.6.2.0
• Stack 2.9.1

Steps to reproduce

Write any code that HLS will suggest a quick fix for, such as: f x = id x.

Expected behaviour

HLS should suggest a quick fix, then apply the change after selecting the quick fix.

Actual behaviour

HLS offers the appropriate code actions, but quick fixes throw errors instead of applying the changes to the code. Other code actions, such as "Ignore hint ... in this module" still work. Other HLS features also work.
I have tested this with both Emacs LSP packages as well as VSCode, with identical results in all three cases.

Debug information

Error condition, please check your setup and/or the issue tracker: ReactorMessageActionException ExitFailure 1

[michaelpj]

Can you be more specific about the action that fails and get us the logs, ideally in debug mode?

[mfriley]

Sure. When I initiate a code action, and select the "Apply hint" option:

It throws these errors:

LSP :: Error condition, please check your setup and/or the [issue tracker](https://github.com/haskell/haskell-language-server/issues): 
ReactorMessageActionException
ExitFailure 1
Error running timer: (error "‘workspace/executeCommand’ with ‘3050:hlint:applyOne’ failed.

(error \"ExitFailure 1\")")

This is the debug output in hls.log:

2022-10-04T17:13:04.542597Z | Debug | Getting hlint ideas for  NormalizedFilePath "/home/<name>/Projects/HaskellBook/applicative1.hs"
2022-10-04T17:13:04.543003Z | Debug | Using extensions for  NormalizedFilePath "/home/<name>/Projects/HaskellBook/applicative1.hs": [ MonomorphismRestriction
                                                                                               , RelaxedPolyRec
                                                                                               , ForeignFunctionInterface
                                                                                               , ImplicitPrelude
                                                                                               , ScopedTypeVariables
                                                                                               , BangPatterns
                                                                                               , RecordPuns
                                                                                               , GADTSyntax
                                                                                               , DoAndIfThenElse
                                                                                               , ConstraintKinds
                                                                                               , PolyKinds
                                                                                               , InstanceSigs
                                                                                               , StandaloneDeriving
                                                                                               , DeriveDataTypeable
                                                                                               , DeriveFunctor
                                                                                               , DeriveTraversable
                                                                                               , DeriveFoldable
                                                                                               , DeriveGeneric
                                                                                               , DeriveLift
                                                                                               , TypeSynonymInstances
                                                                                               , FlexibleContexts
                                                                                               , FlexibleInstances
                                                                                               , ConstrainedClassMethods
                                                                                               , MultiParamTypeClasses
                                                                                               , ExistentialQuantification
                                                                                               , EmptyDataDecls
                                                                                               , KindSignatures
                                                                                               , GeneralizedNewtypeDeriving
                                                                                               , PostfixOperators
                                                                                               , TupleSections
                                                                                               , PatternGuards
                                                                                               , RankNTypes
                                                                                               , TypeOperators
                                                                                               , ExplicitForAll
                                                                                               , TraditionalRecordSyntax
                                                                                               , BinaryLiterals
                                                                                               , HexFloatLiterals
                                                                                               , EmptyCase
                                                                                               , NamedWildCards
                                                                                               , TypeApplications
                                                                                               , EmptyDataDeriving
                                                                                               , NumericUnderscores
                                                                                               , StarIsType
                                                                                               , ImportQualifiedPost
                                                                                               , StandaloneKindSignatures
                                                                                               , FieldSelectors ]
2022-10-04T17:13:04.545305Z | Debug | Finished: applyHint Took: 0.00s
2022-10-04T17:13:04.545411Z | Debug | Generated hlint ideas for for NormalizedFilePath "/home/<name>/Projects/HaskellBook/applicative1.hs": [[Replace {rtype = Expr, pos = SrcSpan {startLine = 42, startCol = 12, endLine = 42, endCol = 41}, subts = [("f",SrcSpan {startLine = 42, startCol = 17, endLine = 42, endCol = 20}),("x",SrcSpan {startLine = 42, startCol = 23, endLine = 42, endCol = 41})], orig = "f <$> x"}]]
2022-10-04T17:13:04.592577Z | Debug | Finished: applyHint Took: 0.00s
2022-10-04T17:13:04.592772Z | Debug | Finished: applyHint Took: 0.00s
2022-10-04T17:13:04.593079Z | Debug | Finished: applyHint Took: 0.00s
2022-10-04T17:13:04.593505Z | Error | ReactorMessageActionException
ExitFailure 1

[michaelpj]

That is quite odd.

[brandonmlusk]

I seem to have the same problem as well on Fedora. It is quite odd because everything else seems to work besides the quick fixes.

[michaelpj]

Does hlint --refactor work from the CLI?

[bristermitten]

Same issue for me, hlint --refactor does work

[AndreiDuma]

Same here on HLS 1.8.0.0, GHC 9.2.4, hlint v3.5 and refactor v0.10.0.0. I'm using Emacs with eglot as an LSP client. Eglot reports this exchange of messages with HLS:

[client-request] (id:6) Tue Oct 11 09:45:13 2022:
(:jsonrpc "2.0" :id 6 :method "textDocument/codeAction" :params
	  (:textDocument
	   (:uri "file:///Users/andrei/dev/_/haskell/eulerhs/src/Main.hs")
	   :range
	   (:start
	    (:line 0 :character 21)
	    :end
	    (:line 0 :character 21))
	   :context
	   (:diagnostics
	    [(:code "refact:Unused LANGUAGE pragma" :message "Unused LANGUAGE pragma\nFound:\n  {-# LANGUAGE LambdaCase #-}\nWhy not:\n  \n" :range
		    (:end
		     (:character 27 :line 0)
		     :start
		     (:character 0 :line 0))
		    :severity 3 :source "hlint")])))

[server-reply] (id:6) Tue Oct 11 09:45:13 2022:
(:id 6 :jsonrpc "2.0" :result
     [(:diagnostics
       []
       :edit
       (:changes
	(:file:///Users/andrei/dev/_/haskell/eulerhs/src/Main\.hs
	 [(:newText "{-# LANGUAGE LambdaCase #-}\n" :range
		    (:end
		     (:character 0 :line 1)
		     :start
		     (:character 0 :line 1)))]))
       :kind "quickfix" :title "Add \"LambdaCase\"")
      (:command
       (:arguments
	[(:file "file:///Users/andrei/dev/_/haskell/eulerhs/src/Main.hs" :hintTitle "Unused LANGUAGE pragma" :start_pos
		(:character 0 :line 0))]
	:command "90894:hlint:applyOne" :title "Apply hint \"Unused LANGUAGE pragma\"")
       :diagnostics
       [(:code "refact:Unused LANGUAGE pragma" :message "Unused LANGUAGE pragma\nFound:\n  {-# LANGUAGE LambdaCase #-}\nWhy not:\n  \n" :range
	       (:end
		(:character 27 :line 0)
		:start
		(:character 0 :line 0))
	       :severity 3 :source "hlint")]
       :isPreferred t :kind "quickfix" :title "Apply hint \"Unused LANGUAGE pragma\"")
      (:diagnostics
       [(:code "refact:Unused LANGUAGE pragma" :message "Unused LANGUAGE pragma\nFound:\n  {-# LANGUAGE LambdaCase #-}\nWhy not:\n  \n" :range
	       (:end
		(:character 27 :line 0)
		:start
		(:character 0 :line 0))
	       :severity 3 :source "hlint")]
       :edit
       (:changes
	(:file:///Users/andrei/dev/_/haskell/eulerhs/src/Main\.hs
	 [(:newText "{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}\n{-# HLINT ignore \"Unused LANGUAGE pragma\" #-}\n" :range
		    (:end
		     (:character 0 :line 1)
		     :start
		     (:character 0 :line 1)))]))
       :isPreferred :json-false :kind "quickfix" :title "Ignore hint \"Unused LANGUAGE pragma\" in this module")])

[client-request] (id:7) Tue Oct 11 09:45:17 2022:
(:jsonrpc "2.0" :id 7 :method "workspace/executeCommand" :params
	  (:command "90894:hlint:applyOne" :arguments
		    [(:file "file:///Users/andrei/dev/_/haskell/eulerhs/src/Main.hs" :hintTitle "Unused LANGUAGE pragma" :start_pos
			    (:character 0 :line 0))]))

[stderr] Missing file: /private/var/lib/gitlab-runner/builds/7KQsmDei/0/haskell/haskell-language-server/toolchain/.ghcup/ghc/9.2.4/lib/ghc-9.2.4/lib/settings

[server-notification] Tue Oct 11 09:45:17 2022:
(:jsonrpc "2.0" :method "window/showMessage" :params
	  (:message "Error condition, please check your setup and/or the [issue tracker](https://github.com/haskell/haskell-language-server/issues): \nReactorMessageActionException\nExitFailure 1" :type 1))

[server-notification] Tue Oct 11 09:45:17 2022:
(:jsonrpc "2.0" :method "window/logMessage" :params
	  (:message "ReactorMessageActionException\nExitFailure 1" :type 1))

[server-reply] (id:7) ERROR Tue Oct 11 09:45:17 2022:
(:error
 (:code -32603 :message "ExitFailure 1")
 :id 7 :jsonrpc "2.0")

[stderr] 2022-10-11T06:45:17.144114Z | Error | ReactorMessageActionException
[stderr] ExitFailure 1

I added some lines for clarity. I hope this helps.

[michaelpj]

Aha! That reveals a suspicious line:

[stderr] Missing file: /private/var/lib/gitlab-runner/builds/7KQsmDei/0/haskell/haskell-language-server/toolchain/.ghcup/ghc/9.2.4/lib/ghc-9.2.4/lib/settings

So maybe this is an installation problem? @hasufell do you know what might cause this?

[michaelpj]

It sounds like maybe something is compiling in the location of a GHC settings file and somehow getting the absolute path to where it was on the gitlab builder that build the bindist 🤔

[hasufell]

I don't know. This is something to ask the GHC folks @mpickering @bgamari

[mpickering]

Is there something in HLS depending on ghc-paths?