Find all references does not find all references #3147

Activity

1. eltix

   added

   status: needs triage

   type: bugSomething isn't right: doesn't work as intended, documentation is missing/outdated, etc..Something isn't right: doesn't work as intended, documentation is missing/outdated, etc..

   on Sep 7, 2022
2. wz1000 commented on Sep 7, 2022

   

   wz1000

   on Sep 7, 2022

   Collaborator

   More actions

   HLS tries to typecheck/index all files on startup by default (though this is configurable). However, this depends on us knowing all the targets which exist, which need to be enumerated by the hie-bios cradle. I think cabal and stack cradles do this by default. You should check that your cradle lists out all the targets (module names or file names) in the options that it passes to HLS, using something like hie-bios flags src/File.hs
3. wz1000

   added

   status: needs infoNot actionable, because there's missing informationNot actionable, because there's missing information

   and removed

   status: needs triage

   on Sep 7, 2022
4. kokobd commented on Sep 7, 2022

   

   kokobd

   on Sep 7, 2022

   Collaborator

   More actions

   Maybe we should have an option to load all components on start by default?
5. eltix commented on Sep 7, 2022

   

   eltix

   on Sep 7, 2022

   Author

   More actions

   @wz1000 Thank you for your answer. We will investigate this further on our side and will either come back with more info or close the issue.
6. guibou

   added a commit that references this issue on Nov 20, 2022

   This is a reproduction for #3147

   ...

   89a3e62
7. guibou commented on Nov 20, 2022

   

   guibou

   on Nov 20, 2022

   Collaborator

   More actions

   I can confirm that all the files and flags are correctly passed to HLS using a hie.yaml file as simple as:

   cradle:
     bios:
       shell: "generate_flags_for_project > $HIE_BIOS_OUTPUT"

   The generate_flags_for_project generate a static list of flags: it does not depend on the file being observed and always return the flags / files for the complete project.

   Even when waiting for the end of the indexing phase from HLS (It can take a few minutes), the different references from other files are not available.

   However, as @eltix already described it, opening a file which contains a reference fix the reference informations. I also observed that removing the symbol we care about from export list of the module then adding it again does "update" the DB.
8. guibou commented on Nov 20, 2022

   

   guibou

   on Nov 20, 2022

   Collaborator

   More actions

   The problem is perfectly reproducible when the use of the symbol is in a Main module and when you have multiples Main module in the environment. I'm still trying to reproduce this in a different context.

   In 89a3e62 I designed a reproduction.

   There are two non-Main modules: dirA/A.hs and dirB/B.hs which are named A and B.

   Then C.hs and D.hs are Main modules which reference a and b from A and B. Note that a is also referenced in B.

   • Start your editor and load A.hs and look for reference to a, it will only find the references in B and D.
   • Now open C.hs and go back to A.hs and look for reference to a, it will find one in B, C, but not D anymore.
   • Open D.hs and go back to A.hs and look for reference to a. it will find one in B, C, and D

   I observed the hiedb file and it is interesting:

   After opening A.hs the first time, it shows a reference in Main at line 13.

   hiedb -D ~/.cache/ghcide/1634d290c00070ae2b558ef43dc6d2a8855d6436-hls_repro_reverse_search-9.0.2-1.hiedb name-refs a
   B:5:5-5:6
   Main:13:10-13:11
   A:3:1-3:2
   

   But after opening C.hs, the reference change:

   hiedb -D ~/.cache/ghcide/1634d290c00070ae2b558ef43dc6d2a8855d6436-hls_repro_reverse_search-9.0.2-1.hiedb name-refs a
   B:5:5-5:6
   A:3:1-3:2
   Main:5:10-5:11
   

   My conclusion here is that references are stored in the db using module name, and if we have multiples modules with the same name, this leads to conflict.

   Should this be considered a bug in HLS or a bug in the way we are using HLS?
9. michaelpj

   added

   multi-componentIssues relating to multi-component supportIssues relating to multi-component support

   on Jan 16, 2024