Call hierarchy support #1955

July541 · 2021-06-21T12:39:44Z

Hello all,

This pr is about my GSoC 2021 project, call hierarchy support. I create a draft to show my progress to those who may be interested.

Progress

Prepare call hierarchy (working now)
Incoming calls
Outgoing calls

Known issues

Data family range error (see commented test)
Incoming/Outgoing test missing
Name display not optimized for DuplicateRecordFields

wz1000 · 2021-06-21T13:11:22Z

If I understand correctly, call hierarchy is meant to be global and project wide. However, you seem to be generating the tree using a single HieAst.

I think it would be a good idea to make use of hiedb for this rather than directly using .hie files/HieAst. Take a look at the getGraph, getReachable and getVertices functions in hiedb: https://github.com/wz1000/HieDb/blob/master/src/HieDb/Query.hs#L175

The code you have for traversing the HieAst could still be very useful - we only keep up to date version of files the user isn't currently editing in the hiedb. For the files the user has open in their editor (IsFileOfInterest => True), to get an accurate callgraph the information from the HieAst traversal would need to be combined with the information from hiedb.

July541 · 2021-06-21T13:27:48Z

If I understand correctly, call hierarchy is meant to be global and project wide. However, you seem to be generating the tree using a single HieAst.

You're right, currently, I just finished the part of prepare call hierarchy. This part only constructs the CallHierarchyItem without any relation to other statements. I think HieAst is enough now.

The hierarchy is queried at the incoming/outgoing steps, which I have not started, your suggestion is very feasible, I'll follow it in the next part.

…server into call-hierarchy

pepeiborra · 2021-07-07T20:04:18Z

@July541 I can see that you uploaded some commits yesterday. Care to share an update on what the recent changes are?

July541 · 2021-07-08T08:46:25Z

@pepeiborra It's about a prototype of the implementation of outgoing calls which has functionality but a bad code style. I'll show a complete call hierarchy after incoming calls are finished, it'll come soon.

July541 · 2021-07-11T13:56:04Z

2021-07-11.21-45-42.mp4

Recent progress, incoming calls and outgoing calls have basic functions, see demo above for details.

Current problems:

Duplication items(multi range merge)
Range of incoming/outgoing calls still exist problems
Test missing
Query will be broken if the target is a parameter

pepeiborra · 2021-07-11T14:46:27Z

This looks quite reasonable to me, nice job @July541 !
I would argue for landing it and then opening new tickets to fix the outstanding problems.
What do you think ?

wz1000 · 2021-07-11T15:02:02Z

plugins/hls-call-hierarchy-plugin/src/Ide/Plugin/CallHierarchy/Query.hs

+import           Name
+
+incomingCalls :: HieDb -> Symbol -> IO [Vertex]
+incomingCalls (getConn -> conn) symbol = do


It would be best to move these functions into hiedb.

July541 · 2021-07-12T05:49:03Z

@pepeiborra I agree with you. I think it can be reviewed after the break issue is fixed, not take long.

@wz1000 It turns out I wrote it in HieDb from the beginning. But the following questions bothered me and made me turn to the internal implementation:

The definition of Vertex is vague, we may need to rewrite the relevant parts, in which the compatibility comes at a high price to keep code elegant(for HieDb developer, not user).
The two calls(incoming/outgoing) seem to be domain-specific, and I'm not sure they will have other usages, so I wrote them inside the call hierarchy.

Honestly, I'm not sure it's a reasonable solution. if you think that move to HieDb is better, I'll transfer it.

pepeiborra · 2021-07-12T19:37:26Z

@pepeiborra I agree with you. I think it can be reviewed after the break issue is fixed, not take long.

Awesome, please shout if you need any help

isovector · 2021-07-13T20:34:36Z

Your CI appears to be blocked by #2016

…server into call-hierarchy

.github/workflows/test.yml

…server into call-hierarchy

plugins/hls-call-hierarchy-plugin/src/Ide/Plugin/CallHierarchy/Query.hs

July541 · 2021-07-27T16:26:12Z

I think the current fail can be fixed after the new lsp is released.

pepeiborra · 2021-07-27T19:32:47Z

This looks ready to merge, great job @July541 !!!
Do you want to do the honours @jneira ?

jneira · 2021-07-27T20:18:41Z

@July541 amazing work, hls users will be amazed, congrats
And thank you @pepeiborra for taking care, I had not all time I wish

July541 · 2021-07-28T05:32:11Z

@pepeiborra I noticed an unexpected ghcide fail on 8.6.5, not sure if it is caused by me.

jhrcek · 2021-07-28T06:31:45Z

I pulled master this morning and I'm also not able to do stack ./install.hs hls-8.8.4 locally.
It seems it's related to this PR.
I'm getting build failures similar to what I see in recent CI runs:
e.g. this

build failures in CI

Linking .stack-work/dist/x86_64-linux/Cabal-3.0.1.0/build/ghcide/ghcide ...
ghcide                           > /root/.stack/snapshots/x86_64-linux/26f5581bf7f9f176d3f7ba334912f1d717717a1ecee407868101798f77c5c139/8.8.3/lib/x86_64-linux-ghc-8.8.3/libHSlsp-1.2.0.0-LiIFgQ1fCTv73zSCj7uRmO-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziCallHierarchy_zdfFromJSONCallHierarchyOutgoingCallsParams_closure'
ghcide                           > /root/.stack/snapshots/x86_64-linux/26f5581bf7f9f176d3f7ba334912f1d717717a1ecee407868101798f77c5c139/8.8.3/lib/x86_64-linux-ghc-8.8.3/libHSlsp-1.2.0.0-LiIFgQ1fCTv73zSCj7uRmO-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziCallHierarchy_zdfFromJSONCallHierarchyIncomingCallsParams_closure'
ghcide                           > /root/.stack/snapshots/x86_64-linux/26f5581bf7f9f176d3f7ba334912f1d717717a1ecee407868101798f77c5c139/8.8.3/lib/x86_64-linux-ghc-8.8.3/libHSlsp-1.2.0.0-LiIFgQ1fCTv73zSCj7uRmO-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziCallHierarchy_zdfFromJSONCallHierarchyPrepareParams_closure'
ghcide                           > /root/.stack/snapshots/x86_64-linux/26f5581bf7f9f176d3f7ba334912f1d717717a1ecee407868101798f77c5c139/8.8.3/lib/x86_64-linux-ghc-8.8.3/libHSlsp-1.2.0.0-LiIFgQ1fCTv73zSCj7uRmO-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziMethod_zdfFromJSONSMethod54_closure'
ghcide                           > /root/.stack/snapshots/x86_64-linux/26f5581bf7f9f176d3f7ba334912f1d717717a1ecee407868101798f77c5c139/8.8.3/lib/x86_64-linux-ghc-8.8.3/libHSlsp-1.2.0.0-LiIFgQ1fCTv73zSCj7uRmO-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziMethod_zdfFromJSONSMethod55_closure'
ghcide                           > /root/.stack/snapshots/x86_64-linux/26f5581bf7f9f176d3f7ba334912f1d717717a1ecee407868101798f77c5c139/8.8.3/lib/x86_64-linux-ghc-8.8.3/libHSlsp-1.2.0.0-LiIFgQ1fCTv73zSCj7uRmO-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziMethod_zdWSTextDocumentPrepareCallHierarchy_closure'
ghcide                           > /root/build/ghcide/.stack-work/dist/x86_64-linux/Cabal-3.0.1.0/build/libHSghcide-1.4.0.3-GzSd9eXvctl5jyqcFJIb49-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziMethod_zdfShowSMethod114_closure'
ghcide                           > /root/build/ghcide/.stack-work/dist/x86_64-linux/Cabal-3.0.1.0/build/libHSghcide-1.4.0.3-GzSd9eXvctl5jyqcFJIb49-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziMethod_zdfShowSMethod112_closure'
ghcide                           > /root/build/ghcide/.stack-work/dist/x86_64-linux/Cabal-3.0.1.0/build/libHSghcide-1.4.0.3-GzSd9eXvctl5jyqcFJIb49-ghc8.8.3.so: error: undefined reference to 'lspzmtypeszm1zi2zi0zi0zmDHDZZnuOdhmBHZZjePkaCNbQ_LanguageziLSPziTypesziMethod_zdfShowSMethod116_closure'
ghcide                           > collect2: error: ld returned 1 exit status
ghcide                           > `gcc' failed in phase `Linker'. (Exit code: 1)

see failure in CI

pepeiborra · 2021-07-28T06:39:42Z

Have you tried stack clean ?

pepeiborra · 2021-07-28T06:41:13Z

@pepeiborra I noticed an unexpected ghcide fail on 8.6.5, not sure if it is caused by me.

Some tests are flaky in Windows, that's not caused by this PR

July541 · 2021-07-28T06:43:07Z

@jhrcek Ideally the updated dependencies are OK for the build.

haskell-language-server/stack-8.8.4.yaml

Lines 83 to 89 in d815d04

    
           - github: haskell/lsp 
        
             commit: ef59c28b41ed4c5775f0ab0c1e985839359cec96 
        
             subdirs: 
        
             - lsp-types 
        
             - lsp 
        
             - lsp-test 
        
           # https://github.com/haskell/lsp/pull/332

jneira · 2021-07-28T06:59:23Z

@jhrcek i hope #2044 (which remove .stack-work from cache, so equivalent to do a stack clean --full) will take ride of those circleci linker errors

pepeiborra · 2021-07-28T07:10:54Z

@jhrcek i hope #2044 (which remove .stack-work from cache, so equivalent to do a stack clean --full) will take ride of those circleci linker errors

Users will still be affected by the stack build problem though.

jhrcek · 2021-07-28T08:17:18Z

I tried stack clean --full in haskell-language-server repo, but still got build failure during linking.
In the end I removed all build snapshots from ~/.stack/snapshots/x86_64-linux-tinfo6/ and then it built correctly.
The call hierarchy seems to be working great. Thank you! ❤️

July541 added 6 commits June 3, 2021 16:39

Initialize structure

67ce370

Add basic tests

4b9a6e7

prepareCallHierarchy

f8cfe98

Add prepare call hierarchy tests

118acd7

resolve conflicts

38b5b47

Prepare call hierarchy support

7a8979d

July541 marked this pull request as draft June 21, 2021 13:01

pepeiborra mentioned this pull request Jul 3, 2021

Support for function call hierarchy #738

Closed

July541 added 3 commits July 6, 2021 22:33

Merge branch 'master' of https://github.com/haskell/haskell-language-…

0058639

…server into call-hierarchy

add outgoing calls

3c809f0

Rename incoming to outgoing

2b84f2d

Add incoming calls support

7a41397

wz1000 reviewed Jul 11, 2021

View reviewed changes

Fix panic error caused by parameters

0018dd0

Prepare callhierarchy tests

04679f1

July541 added 5 commits July 15, 2021 15:30

Duplication items support

59e2432

Format and add missing components for review

ad133b7

Use local lsp

db5bb4d

Add CI test

ec420ad

Fix typo

eec1c98

July541 marked this pull request as ready for review July 15, 2021 10:49

July541 added 7 commits July 21, 2021 22:59

Fix query error in data declaration

a529246

Add incoming/outgoing call tests

dcf8aab

Merge branch 'master' of https://github.com/haskell/haskell-language-…

68bc9e9

…server into call-hierarchy

Add flag for test ghc 9.0.1

649a70f

Ignore test on 9.0.1

6ca0629

Add 9.0.1 test

b6ead8f

Specifying lsp for cabal

fd11a10

jneira reviewed Jul 22, 2021

View reviewed changes

.github/workflows/test.yml Outdated Show resolved Hide resolved

July541 added 3 commits July 26, 2021 17:05

Merge branch 'master' of https://github.com/haskell/haskell-language-…

61d9df9

…server into call-hierarchy

Refresh hiedb before incoming/outgoing calls

c2bd211

Add moduleUnit on ghc 9.0.1

a7fee5f

pepeiborra requested changes Jul 26, 2021

View reviewed changes

plugins/hls-call-hierarchy-plugin/src/Ide/Plugin/CallHierarchy/Query.hs Outdated Show resolved Hide resolved

plugins/hls-call-hierarchy-plugin/src/Ide/Plugin/CallHierarchy/Query.hs Outdated Show resolved Hide resolved

July541 added 2 commits July 27, 2021 18:34

Compatible with ghc 9.0.1

09a8898

Add missing qualifier

0405d2f

pepeiborra approved these changes Jul 27, 2021

View reviewed changes

Remove ghcide capability test

492c48f

Merge branch 'master' into call-hierarchy

cbbd56e

pepeiborra mentioned this pull request Jul 27, 2021

Completions from non-imported modules #2040

Merged

pepeiborra merged commit d815d04 into haskell:master Jul 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Call hierarchy support #1955

Call hierarchy support #1955

July541 commented Jun 21, 2021 •

edited

wz1000 commented Jun 21, 2021

July541 commented Jun 21, 2021

pepeiborra commented Jul 7, 2021

July541 commented Jul 8, 2021

July541 commented Jul 11, 2021 •

edited

pepeiborra commented Jul 11, 2021

wz1000 Jul 11, 2021

July541 commented Jul 12, 2021

pepeiborra commented Jul 12, 2021

isovector commented Jul 13, 2021

July541 commented Jul 27, 2021

pepeiborra commented Jul 27, 2021

jneira commented Jul 27, 2021 •

edited

July541 commented Jul 28, 2021 •

edited

jhrcek commented Jul 28, 2021 •

edited

pepeiborra commented Jul 28, 2021 •

edited

pepeiborra commented Jul 28, 2021

July541 commented Jul 28, 2021

jneira commented Jul 28, 2021

pepeiborra commented Jul 28, 2021

jhrcek commented Jul 28, 2021

Call hierarchy support #1955

Call hierarchy support #1955

Conversation

July541 commented Jun 21, 2021 • edited

wz1000 commented Jun 21, 2021

July541 commented Jun 21, 2021

pepeiborra commented Jul 7, 2021

July541 commented Jul 8, 2021

July541 commented Jul 11, 2021 • edited

pepeiborra commented Jul 11, 2021

wz1000 Jul 11, 2021

Choose a reason for hiding this comment

July541 commented Jul 12, 2021

pepeiborra commented Jul 12, 2021

isovector commented Jul 13, 2021

July541 commented Jul 27, 2021

pepeiborra commented Jul 27, 2021

jneira commented Jul 27, 2021 • edited

July541 commented Jul 28, 2021 • edited

jhrcek commented Jul 28, 2021 • edited

pepeiborra commented Jul 28, 2021 • edited

pepeiborra commented Jul 28, 2021

July541 commented Jul 28, 2021

jneira commented Jul 28, 2021

pepeiborra commented Jul 28, 2021

jhrcek commented Jul 28, 2021

July541 commented Jun 21, 2021 •

edited

July541 commented Jul 11, 2021 •

edited

jneira commented Jul 27, 2021 •

edited

July541 commented Jul 28, 2021 •

edited

jhrcek commented Jul 28, 2021 •

edited

pepeiborra commented Jul 28, 2021 •

edited