Skip to content

Fix build and tests with GHC-9.4.3 and 9.2.5 #3364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 16 commits into from
Closed

Fix build and tests with GHC-9.4.3 and 9.2.5 #3364

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
efba374
Fix build and tests with GHC-9.4.3.
mouse07410 Nov 24, 2022
322c03b
Update .github/workflows/test.yml
mouse07410 Nov 24, 2022
5e51777
Address @pepeiborra suggestions
mouse07410 Nov 24, 2022
b3d0bd2
Address @pepeiborra suggestions
mouse07410 Nov 24, 2022
3e6d8ca
Merge branch 'master' of https://github.com/mouse07410/haskell-langua…
mouse07410 Nov 24, 2022
12efbd6
Disable GHC-9.4.3 on WIndows for now - test complains it can't instal…
mouse07410 Nov 24, 2022
4b5bdb8
Attempt to work around fourmolu 0.9.0.0 build failure in Windows test
mouse07410 Nov 25, 2022
f1e2481
Add build with GHC-9.2.5
mouse07410 Nov 25, 2022
eca61d1
Merge remote-tracking branch 'upstream/master'
mouse07410 Nov 25, 2022
4e489cb
Temporarily disable GHC-9.2.5 for Windows
mouse07410 Nov 25, 2022
362b8d2
Merge remote-tracking branch 'upstream/master'
mouse07410 Nov 27, 2022
23a6279
Update haskell-language-server.cabal
mouse07410 Nov 27, 2022
c359743
Merge remote-tracking branch 'upstream/master'
mouse07410 Nov 28, 2022
c6f1a0a
Merge remote-tracking branch 'upstream/master'
mouse07410 Dec 9, 2022
8a491f5
Merge branch 'master' into master
pepeiborra Dec 13, 2022
b474547
Merge branch 'master' into master
pepeiborra Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 20 additions & 21 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,7 @@ jobs:
strategy:
fail-fast: true
matrix:
ghc: [ "9.4.2"
, "9.4.1"
ghc: [ "9.4.3"
, "9.2.4"
, "9.2.3"
, "9.0.2"
Expand All @@ -70,7 +69,7 @@ jobs:
include:
# only test supported ghc major versions
- os: ubuntu-latest
ghc: '9.4.2'
ghc: '9.4.3'
test: true
- os: ubuntu-latest
ghc: '9.2.4'
Expand All @@ -81,9 +80,9 @@ jobs:
- os: ubuntu-latest
ghc: '8.10.7'
test: true
- os: windows-latest
ghc: '9.4.2'
test: true
#- os: windows-latest
# ghc: '9.4.3' # apparently cannot install GHC-9.4.3 on Windows?
# test: true
- os: windows-latest
ghc: '9.2.4'
test: true
Expand Down Expand Up @@ -150,15 +149,15 @@ jobs:
HLS_WRAPPER_TEST_EXE: hls-wrapper
run: cabal test wrapper-test --test-options="$TEST_OPTS --rerun-log-file .tasty-rerun-log-wrapper"

- if: matrix.test && matrix.ghc != '9.2.4' && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.2.4' && matrix.ghc != '9.4.3'
name: Test hls-brittany-plugin
run: cabal test hls-brittany-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-brittany-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-refactor-plugin
run: cabal test hls-refactor-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-refactor-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-floskell-plugin
run: cabal test hls-floskell-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-floskell-plugin --test-options="$TEST_OPTS"

Expand All @@ -170,31 +169,31 @@ jobs:
name: Test hls-pragmas-plugin
run: cabal test hls-pragmas-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-pragmas-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-eval-plugin
run: cabal test hls-eval-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-eval-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.2.4' && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.2.4' && matrix.ghc != '9.4.3'
name: Test hls-haddock-comments-plugin
run: cabal test hls-haddock-comments-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-haddock-comments-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-splice-plugin
run: cabal test hls-splice-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-splice-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-stylish-haskell-plugin
run: cabal test hls-stylish-haskell-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-stylish-haskell-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-ormolu-plugin
run: cabal test hls-ormolu-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-ormolu-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-fourmolu-plugin
run: cabal test hls-fourmolu-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-fourmolu-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.2.4' && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.2.4' && matrix.ghc != '9.4.3'
name: Test hls-tactics-plugin test suite
run: cabal test hls-tactics-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-tactics-plugin --test-options="$TEST_OPTS"

Expand All @@ -210,15 +209,15 @@ jobs:
name: Test hls-call-hierarchy-plugin test suite
run: cabal test hls-call-hierarchy-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-call-hierarchy-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.os != 'windows-latest' && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.os != 'windows-latest' && matrix.ghc != '9.4.3'
name: Test hls-rename-plugin test suite
run: cabal test hls-rename-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-rename-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-hlint-plugin test suite
run: cabal test hls-hlint-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-hlint-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.0.1' && matrix.ghc != '9.0.2' && matrix.ghc != '9.2.4' && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.0.1' && matrix.ghc != '9.0.2' && matrix.ghc != '9.2.4' && matrix.ghc != '9.4.3'
name: Test hls-stan-plugin test suite
run: cabal test hls-stan-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-stan-plugin --test-options="$TEST_OPTS"

Expand All @@ -234,15 +233,15 @@ jobs:
name: Test hls-qualify-imported-names-plugin test suite
run: cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test
name: Test hls-code-range-plugin test suite
run: cabal test hls-code-range-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-code-range-plugin --test-options="$TEST_OPTS"

- if: matrix.test
name: Test hls-change-type-signature test suite
run: cabal test hls-change-type-signature-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-change-type-signature-plugin --test-options="$TEST_OPTS"

- if: matrix.test && matrix.ghc != '9.4.2'
- if: matrix.test && matrix.ghc != '9.4.3'
name: Test hls-gadt-plugin test suit
run: cabal test hls-gadt-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-gadt-plugin --test-options="$TEST_OPTS"

Expand Down
2 changes: 1 addition & 1 deletion cabal.project
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ package *

write-ghc-environment-files: never

index-state: 2022-10-07T12:19:15Z
index-state: 2022-11-20T20:19:15Z

constraints:
-- For GHC 9.4, older versions of entropy fail to build on Windows
Expand Down
1 change: 1 addition & 0 deletions ghcide/ghcide.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ library
hashable,
hie-compat ^>= 0.3.0.0,
hls-plugin-api ^>= 1.5,
implicit-hie >= 0.1.2.7 && < 0.1.3,
lens,
list-t,
hiedb == 0.4.2.*,
Expand Down
3 changes: 3 additions & 0 deletions haskell-language-server.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,9 @@ executable haskell-language-server

default-language: Haskell2010
default-extensions: DataKinds, TypeOperators

if impl(ghc >= 9.4)
build-depends: ghc-exactprint >= 1.6.1
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this needed?

Copy link
Author

@mouse07410 mouse07410 Nov 24, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, a good question. Without this seemingly unnecessary constraint, Cabal somehow manages to pull ghc-exactprint-1.6.0 - presumably because there's a dependency of dependency that's asking for it. And CI tests kept failing.

With this addition, all the relevant tests passed (that is - at least, until I started applying changes to address suggestions ;).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really think this needs to go in the right place. It shouldn't be that hard to figure out. At the very least it needs a clear comment explaining this.

Copy link
Author

@mouse07410 mouse07410 Nov 25, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really think this needs to go in the right place

I attempted to find the right place - starting with attempts to put it in plugins/hls-refactor-plugin and ghcide. Failed miserably in both cases - tests kept failing. Please feel free to pitch a hand and locate that right place - I don't know nearly enough to dig deeper. I tried to search/grep for exactprint, and did not come up with anything helpful (besides the above, which did not help either).

If you do know that right place, please share. Or, perhaps, create a new PR - I'm already up to my ears in the bog of CI that I don't understand.

The current workaround was prompted by observation that

$ ghcup compile hls -g master --ghc 9.4.3 -- --index-state=@<current_date> --constraint="ghc-exactprint >= 1.6.1"

works.

How would you want me to explain it? Just copy-paste this post into the .cabal file?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not necessary, afaict, this worked for me out of the box:

> cabal update
> cabal build -w ghc-9.4.3 exe:haskell-language-server

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting - perhaps, index-state changed since...? Should I update index-state in this PR too?

Also, have you tried just cabal build -w ghc-9.4.3 (to build whatever's there)?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you updated the index-state in cabal.project, you locally need to make sure your global index-state is newer than the one in cabal.project (which you added). So just running cabal update in the project or outside of it should do the trick.

Yeah, works just the same. It'd be weird if cabal didn't choose the most recent version of 'ghc-exactprint'.


executable haskell-language-server-wrapper
import: common-deps
Expand Down
5 changes: 5 additions & 0 deletions plugins/hls-fourmolu-plugin/hls-fourmolu-plugin.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ library
, process-extras >= 0.7.1
, text

if impl(ghc >= 9.2)
build-depends: fourmolu ^>= 0.8.2
if impl(ghc >= 9.4)
build-depends: fourmolu ^>= 0.9

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused by exactly why this is done this way (same as #3364 (comment), basically). But if it passes CI I'm fine with it.

I'll revisit all these bounds next time I come along to bump the version.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused by exactly why this is done this way

Mainly, because I don't know any better. It seemed to be a crude but correct way to get tests pass.

I'll be happy if somebody with more knowledge fixes this the right way.

default-language: Haskell2010

test-suite tests
Expand Down