Support structured diagnostics 2 #4433

noughtmare · 2024-10-17T08:13:03Z

This is my attempt at finishing the work of @dylan-thinnes on !4311.

Addresses #2014

Should hopefully enable #3246

These are two things Dylan listed as work for future PRs:

Replacing regexes with structured diagnostic checks
Improve typing so that it can be known that an error has a structured diagnostic, instead of defaulting to Maybe

Some future work discovered in reviews of this PR:

requireDiagnostic could take a more structured error code query type as argument. See Support structured diagnostics 2 #4433 (comment)
The HTTP work should be un-reverted in a future PR: 1bc221c
Check that tests using requireDiagnostics and related functions use explicit error codes if possible

noughtmare · 2024-10-17T09:35:36Z

All failures in the jobs of e651d41 seem to be spurious (except for the stylish-haskell formatting failure).

noughtmare · 2024-10-17T15:39:08Z

I think the remaining failures are not caused by this PR. Are these kinds of spurious failures common in HLS?

Also, I would really like to get this merged before the next release, because I want to develop a VS Code extension which uses these diagnostic numbers.

fendor · 2024-10-18T07:05:18Z

Are these kinds of spurious failures common in HLS?

Yes, they unfortunately are

fendor · 2024-10-18T09:28:29Z

Some errors in ghc 9.4 seem to be genuine, though. Many tests are seemingly time outing for some reason.

noughtmare · 2024-10-18T12:01:57Z

You're right. Can anyone give me some tips on how to profile HLS to see where these timeouts are coming from?

fendor · 2024-10-18T12:27:26Z

@noughtmare Profiling is likely not necessary, I think the tests are waiting for an LSP message that never arrives, and then just wait for 60s and time out.

Use HLS_TEST_LOG_STDERR=1 cabal test ... and TASTY_PATTERN to run a specific test with all HLS logging enabled.
Printf debugging also works quite well to figure out where the tests gets stuck.
To get the raw LSP messages, you can use LSP_TEST_LOG_MESSAGES=1 or LSP_TEST_LOG_STDERR=1 (they do the same thign)

noughtmare · 2024-10-18T12:33:06Z

Ah, I was thinking there was some inefficiency somewhere that only GHC 9.6 and later could properly optimize. However, I think you're suggesting an alternative explanation: that one of the conditional CPP blocks contains an actual correctness issue. Perhaps I could just visually inspect those first; I don't think that would be that much work.

Edit: no obvious loops or anything, so perhaps some tracing would indeed be better.

ghcide/src/Development/IDE/GHC/Compat.hs

ghcide/src/Development/IDE/GHC/Compat/Driver.hs

noughtmare · 2024-10-22T21:10:29Z

I've decided to make the tests ignore all error codes on GHC 9.4. I think some errors already have codes in 9.4, so we could do a bit more, but I don't think it is worth the effort.

noughtmare · 2024-10-23T07:34:27Z

The remaining MacOS failure seems like a compiler bug. The linker is throwing an error.

Edit: https://gitlab.haskell.org/ghc/ghc/-/issues/24648

Adding the compiler flag -ld_classic might be a workaround.

noughtmare · 2024-10-23T11:40:55Z

@fendor do you think we could try setting the -ld_classic flag? If so, where should I put it?

noughtmare · 2024-10-23T11:45:02Z

Oh, I see we already have that exact workaround in some places. I'll just copy that to the hlint plugin.

noughtmare · 2024-10-23T13:34:29Z

Yay, it has finally passed CI! Should I squash the commits? I'm not sure what to write in the message as I don't really know the details of what exactly Dylan did.

We're leaving the TODOs for either later in this PR or in another PR

This reverts commit 0776c65.

fendor

It took me long enough, but I am happy with the PR now.

I still have to address my own comments, and likely I have to revert any changes to the plugins and split these commits off into a separate PR.

ghcide/src/Development/IDE/Core/Compile.hs

ghcide/src/Development/IDE/Core/RuleTypes.hs

ghcide/src/Development/IDE/GHC/Compat/Outputable.hs

ghcide/src/Development/IDE/GHC/Warnings.hs

fendor · 2024-12-01T17:33:00Z

@noughtmare Is there anythign else you need or want from this PR?

noughtmare · 2024-12-01T17:54:41Z

I personally just wanted access to the diagnostic codes. So I'm more than satisfied!

soulomoon

LGTM, Just two questions

plugins/hls-class-plugin/src/Ide/Plugin/Class/CodeAction.hs

plugins/hls-class-plugin/src/Ide/Plugin/Class/Types.hs

Implement 'rangesOverlap' function which checks whether two 'Range's overlap in any way. Implement two new plugin utility functions which allow to conveniently get all currently displayed diagnostics for a given 'Range'.

Add compatibility module for GHC's structured error messages. Introduce 'Prism's and 'Lens's to easily access nested structures. Expand documentation for 'StructuredMessage'

Fixes haskell#4440 Fixes test for disabling deferred-type-errors.

Co-authored-by: Mergify <37929162+mergify[bot]@users.noreply.github.com>

* new tests * change codeAction title * more tests and docs --------- Co-authored-by: fendor <[email protected]>

Allows HLS to 'Goto Definition' for Note references.

…d-diagnostics

noughtmare requested review from 0rphee, santiweight, eddiemundo, fendor and wz1000 as code owners October 17, 2024 08:13

noughtmare commented Oct 18, 2024

View reviewed changes

ghcide/src/Development/IDE/GHC/Compat.hs Outdated Show resolved Hide resolved

noughtmare commented Oct 20, 2024

View reviewed changes

ghcide/src/Development/IDE/GHC/Compat/Driver.hs Outdated Show resolved Hide resolved

noughtmare requested a review from michaelpj as a code owner October 23, 2024 13:36

noughtmare force-pushed the support-structured-diagnostics branch from 7773572 to 469d8a7 Compare October 23, 2024 13:37

dylan-thinnes added 9 commits October 23, 2024 15:38

Change FileDiagnostic type synonym to a datatype

bd1404f

Make ideErrorWithSource produce FileDiagnostic by adding filepath arg

e684905

Supply structured error wherever we easily can - TODOs for hard parts

9d4cad1

We're leaving the TODOs for either later in this PR or in another PR

Fix UnitTests for new FileDiagnostic struct

e6a0b09

Remove explicit uses of FileDiagnostic, add codes to LSP diagnostics

d87c246

Add field for expected error codes in ghcide tests

cc2188c

Expect GHC-83865 for "type error" test - basic test

d2cbe55

Return structured warnings in TcModuleResult by copying from Driver

6e1eab7

Store FileDiagnostic instead of LSP Diagnostic in Shake store

dcf9397

fendor added 3 commits November 21, 2024 16:18

Revert "Remove StructuredDiagnostic"

65300ef

This reverts commit 0776c65.

Remove the unused parameter from 'ideErrorText'

649e2ba

Add documentation to diagnostic helpers

4c9e7a3

fendor force-pushed the support-structured-diagnostics branch 3 times, most recently from af550e3 to f4d5c24 Compare November 30, 2024 15:17

fendor mentioned this pull request Dec 1, 2024

Update python read-the-docs dependencies to latest #4457

Merged

fendor approved these changes Dec 1, 2024

View reviewed changes

soulomoon reviewed Dec 2, 2024

View reviewed changes

plugins/hls-class-plugin/src/Ide/Plugin/Class/CodeAction.hs Outdated Show resolved Hide resolved

plugins/hls-class-plugin/src/Ide/Plugin/Class/Types.hs Outdated Show resolved Hide resolved

fendor and others added 13 commits December 23, 2024 11:15

Add action to query active diagnostics for a given Range

af34f06

Implement 'rangesOverlap' function which checks whether two 'Range's overlap in any way. Implement two new plugin utility functions which allow to conveniently get all currently displayed diagnostics for a given 'Range'.

Use lens for updating Diagnostic

92c8b4f

Add GHC Structured Error compatibility module

d3b7fe6

Add compatibility module for GHC's structured error messages. Introduce 'Prism's and 'Lens's to easily access nested structures. Expand documentation for 'StructuredMessage'

Remove unused imports

164dfe5

Don't suggest -Wno-deferred-out-of-scope-variables (haskell#4441)

31d1cee

Fixes haskell#4440 Fixes test for disabling deferred-type-errors.

Build HLS with GHC 9.8.3 (haskell#4444)

49b0ce1

ci(mergify): upgrade configuration to current format (haskell#4454)

1feb07d

Co-authored-by: Mergify <37929162+mergify[bot]@users.noreply.github.com>

More tests and better docs for cabal-add (haskell#4455)

3ce3cfb

* new tests * change codeAction title * more tests and docs --------- Co-authored-by: fendor <[email protected]>

Fix compatibility with GHC 9.4 and rename function

54576e1

Use GHC Note syntax and reference Note in docs

abd1a39

Allows HLS to 'Goto Definition' for Note references.

Add doc comment for 'tmrWarnings'

ada6ed6

Push CPP statements to compatibility module

1398a0b

Merge remote-tracking branch 'upstream/master' into support-structure…

95f65d9

…d-diagnostics

fendor force-pushed the support-structured-diagnostics branch from 6b1f66e to 95f65d9 Compare December 23, 2024 10:27

fendor mentioned this pull request Dec 23, 2024

Draft: Migrate hls-class-plugin to use structured diagnostics #4472

Draft

Fix formatting in Development.IDE.GHC.Compat.Error

371896a

fendor force-pushed the support-structured-diagnostics branch from c1513bd to 371896a Compare December 23, 2024 10:45

fendor mentioned this pull request Dec 23, 2024

Support structured diagnostics #4311

Closed

5 tasks

Merge branch 'master' into support-structured-diagnostics

803067a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support structured diagnostics 2 #4433

Support structured diagnostics 2 #4433

noughtmare commented Oct 17, 2024 •

edited

Loading

noughtmare commented Oct 17, 2024

noughtmare commented Oct 17, 2024

fendor commented Oct 18, 2024 •

edited

Loading

fendor commented Oct 18, 2024 •

edited

Loading

noughtmare commented Oct 18, 2024

fendor commented Oct 18, 2024

noughtmare commented Oct 18, 2024 •

edited

Loading

noughtmare commented Oct 22, 2024 •

edited

Loading

noughtmare commented Oct 23, 2024 •

edited

Loading

noughtmare commented Oct 23, 2024

noughtmare commented Oct 23, 2024 •

edited

Loading

noughtmare commented Oct 23, 2024 •

edited

Loading

fendor left a comment

fendor commented Dec 1, 2024

noughtmare commented Dec 1, 2024

soulomoon left a comment

Support structured diagnostics 2 #4433

Are you sure you want to change the base?

Support structured diagnostics 2 #4433

Conversation

noughtmare commented Oct 17, 2024 • edited Loading

noughtmare commented Oct 17, 2024

noughtmare commented Oct 17, 2024

fendor commented Oct 18, 2024 • edited Loading

fendor commented Oct 18, 2024 • edited Loading

noughtmare commented Oct 18, 2024

fendor commented Oct 18, 2024

noughtmare commented Oct 18, 2024 • edited Loading

noughtmare commented Oct 22, 2024 • edited Loading

noughtmare commented Oct 23, 2024 • edited Loading

noughtmare commented Oct 23, 2024

noughtmare commented Oct 23, 2024 • edited Loading

noughtmare commented Oct 23, 2024 • edited Loading

fendor left a comment

Choose a reason for hiding this comment

fendor commented Dec 1, 2024

noughtmare commented Dec 1, 2024

soulomoon left a comment

Choose a reason for hiding this comment

noughtmare commented Oct 17, 2024 •

edited

Loading

fendor commented Oct 18, 2024 •

edited

Loading

fendor commented Oct 18, 2024 •

edited

Loading

noughtmare commented Oct 18, 2024 •

edited

Loading

noughtmare commented Oct 22, 2024 •

edited

Loading

noughtmare commented Oct 23, 2024 •

edited

Loading

noughtmare commented Oct 23, 2024 •

edited

Loading

noughtmare commented Oct 23, 2024 •

edited

Loading