From 8277c9353a1041f07cd757c6dece44a0620d6bf5 Mon Sep 17 00:00:00 2001
From: soulomoon <patrickwalesss@gmail.com>
Date: Tue, 24 Jun 2025 03:13:45 +0800
Subject: [PATCH] Fix reference fields gives too many results

References to record fields gives too many results
This commit adds tests for references to record fields and
updates the symbol retrieval logic to ensure that references to record
fields are handled correctly. The changes is small:
- The `getNamesAtPoint` function in `AtPoint.hs` now
  only searches for `Name` that are in the source node from `HieAst`.
---
 ghcide-test/data/references/Fields.hs       | 18 +++++++++++++++++
 ghcide-test/data/references/Main.hs         |  5 ++++-
 ghcide-test/data/references/hie.yaml        |  2 +-
 ghcide-test/exe/ReferenceTests.hs           | 22 +++++++++++++++++++++
 ghcide/src/Development/IDE/Spans/AtPoint.hs |  2 +-
 5 files changed, 46 insertions(+), 3 deletions(-)
 create mode 100644 ghcide-test/data/references/Fields.hs

diff --git a/ghcide-test/data/references/Fields.hs b/ghcide-test/data/references/Fields.hs
new file mode 100644
index 0000000000..1b935f31c9
--- /dev/null
+++ b/ghcide-test/data/references/Fields.hs
@@ -0,0 +1,18 @@
+{-# LANGUAGE RecordWildCards #-}
+module Fields where
+
+data Foo = MkFoo
+  {
+    barr :: String,
+    bazz :: String
+  }
+
+fooUse0 :: Foo -> String
+fooUse0 MkFoo{barr} = "5"
+
+fooUse1 :: Foo -> String
+fooUse1 MkFoo{..} = "6"
+
+fooUse2 :: String -> String -> Foo
+fooUse2 bar baz =
+  MkFoo{..}
diff --git a/ghcide-test/data/references/Main.hs b/ghcide-test/data/references/Main.hs
index 4a976f3fd0..aae14355d4 100644
--- a/ghcide-test/data/references/Main.hs
+++ b/ghcide-test/data/references/Main.hs
@@ -1,7 +1,7 @@
 module Main where
 
 import References
-
+import Fields
 main :: IO ()
 main = return ()
 
@@ -12,3 +12,6 @@ b = a + 1
 
 acc :: Account
 acc = Savings
+
+fooUse3 :: String -> String -> Foo
+fooUse3 bar baz = MkFoo{barr = bar, bazz = baz}
diff --git a/ghcide-test/data/references/hie.yaml b/ghcide-test/data/references/hie.yaml
index db42bad0c0..9e68765ba1 100644
--- a/ghcide-test/data/references/hie.yaml
+++ b/ghcide-test/data/references/hie.yaml
@@ -1 +1 @@
-cradle: {direct: {arguments: ["Main","OtherModule","OtherOtherModule","References"]}}
+cradle: {direct: {arguments: ["Main","OtherModule","OtherOtherModule","References", "Fields"]}}
diff --git a/ghcide-test/exe/ReferenceTests.hs b/ghcide-test/exe/ReferenceTests.hs
index cdbf8e472d..758506e54d 100644
--- a/ghcide-test/exe/ReferenceTests.hs
+++ b/ghcide-test/exe/ReferenceTests.hs
@@ -156,6 +156,28 @@ tests = testGroup "references"
                           , ("References.hs", 16, 0)
                           ]
           ]
+        -- Fields.hs does not depend on Main.hs
+        -- so we can only find references in Fields.hs
+        , testGroup "references to record fields"
+          [ referenceTest "references record fields in the same file"
+                          ("Fields.hs", 5, 4)
+                          YesIncludeDeclaration
+                          [ ("Fields.hs", 5, 4)
+                          , ("Fields.hs", 10, 14)
+                          , ("Fields.hs", 13, 14)
+                          ]
+
+          -- Main.hs depends on Fields.hs, so we can find references
+          -- from Main.hs to Fields.hs
+          , referenceTest "references record fields cross modules"
+                          ("Main.hs", 16, 24)
+                          YesIncludeDeclaration
+                          [ ("Fields.hs", 5, 4)
+                          , ("Fields.hs", 10, 14)
+                          , ("Fields.hs", 13, 14)
+                          , ("Main.hs", 16, 24)
+                          ]
+          ]
     ]
 
 -- | When we ask for all references to symbol "foo", should the declaration "foo
diff --git a/ghcide/src/Development/IDE/Spans/AtPoint.hs b/ghcide/src/Development/IDE/Spans/AtPoint.hs
index a577cae32e..16b4f65b11 100644
--- a/ghcide/src/Development/IDE/Spans/AtPoint.hs
+++ b/ghcide/src/Development/IDE/Spans/AtPoint.hs
@@ -113,7 +113,7 @@ foiReferencesAtPoint file pos (FOIReferences asts) =
 
 getNamesAtPoint :: HieASTs a -> Position -> PositionMapping -> [Name]
 getNamesAtPoint hf pos mapping =
-  concat $ pointCommand hf posFile (rights . M.keys . getNodeIds)
+  concat $ pointCommand hf posFile (rights . M.keys . getSourceNodeIds)
     where
       posFile = fromMaybe pos $ fromCurrentPosition mapping pos