Fix code suggestion for unresolved-symbol (#2018)

* Add test scenario for issue 2017

* Remove local var definitions from suggestions

* Refactor test to use matcher-combinators

* Update CHANGELOG

* Update lib/src/clojure_lsp/feature/add_missing_libspec.clj

Co-authored-by: Eric Dallo <[email protected]>

* Refactor thread last as transducer

* Move matcher-combinators dependency to test profile

* Make tests to pass on Windows

* 💅

---------

Co-authored-by: Eric Dallo <[email protected]>

Author: acamargo

CHANGELOG.md

@@ -7,6 +7,7 @@
   - Bump clj-kondo to `2025.04.07`.
 - Editor
   - Improve timbre context log.
+  - Fix suggestion for add require code action. #2017
 
 ## 2025.03.27-20.21.36
 

lib/deps.edn

@@ -26,7 +26,8 @@
  :aliases {:test {:extra-deps {clojure-lsp/common-test {:local/root "../common-test"}
                                lambdaisland/kaocha {:mvn/version "1.91.1392"}
                                com.taoensso/timbre {:mvn/version "6.7.0-alpha1"}
-                               org.clojure/test.check {:mvn/version "1.1.1"}}
+                               org.clojure/test.check {:mvn/version "1.1.1"}
+                               nubank/matcher-combinators {:mvn/version "3.9.1"}}
                   :jvm-opts ["-XX:-OmitStackTraceInFastThrow"]
                   :extra-paths ["test"]
                   :main-opts ["-m" "kaocha.runner"]}

lib/src/clojure_lsp/feature/add_missing_libspec.clj

@@ -576,18 +576,24 @@
           namespace-suggestions (find-namespace-suggestions
                                   (or cursor-namespace-str cursor-name-str)
                                   (find-alias-ns-pairs db uri))
+          uri-nses (->> (get-in db [:analysis uri :namespace-definitions])
+                        (map :name)
+                        set)
           suggestions (if (namespace cursor-sym)
                         namespace-suggestions
                         (concat
                           namespace-suggestions
                           (if-let [common-refer (get common-sym/common-refers->info (symbol cursor-name-str))]
                             [{:ns (name common-refer)
                               :refer cursor-name-str}]
-                            (->> (q/find-all-var-definitions db)
-                                 (filter #(= cursor-name-str (str (:name %))))
-                                 (map (fn [element]
-                                        {:ns (str (:ns element))
-                                         :refer cursor-name-str}))))))]
+                            (into []
+                                  (comp
+                                    (remove #(uri-nses (:ns %)))
+                                    (filter #(= cursor-name-str (str (:name %))))
+                                    (map (fn [element]
+                                           {:ns (str (:ns element))
+                                            :refer cursor-name-str})))
+                                  (q/find-all-var-definitions db)))))]
       suggestions)))
 
 (defn ^:private find-forms [zloc p?]

lib/test/clojure_lsp/feature/code_actions_test.clj

@@ -7,7 +7,9 @@
    [clojure-lsp.test-helper :as h]
    [clojure.java.io :as io]
    [clojure.string :as string]
-   [clojure.test :refer [deftest is testing]]))
+   [clojure.test :refer [deftest is testing]]
+   [matcher-combinators.matchers :as m]
+   [matcher-combinators.test :refer [match?]]))
 
 (h/reset-components-before-test)
 
@@ -35,6 +37,25 @@
                                  {:workspace {:workspace-edit true}}
                                  (h/db))))))
 
+(deftest avoid-self-refer-suggestion
+  (h/load-code-and-locs (h/code "(ns baz)"
+                                "(defn func-2 []"
+                                "  (func-1))"
+                                "(defn func-1 [] ())"))
+  (testing "Given a unresolved-var because the function is declared after its use
+            When I ask for code actions
+            Then I don't get an 'Add require' suggestion"
+    (is (match? (m/mismatch [{:title "Add require '[baz :refer [func-1]]'"}])
+                (f.code-actions/all (zloc-of h/default-uri)
+                                    h/default-uri
+                                    3
+                                    4
+                                    [{:code "unresolved-symbol"
+                                      :message "Unresolved symbol: func-1"
+                                      :range {:start {:line 2 :character 3}}}]
+                                    {}
+                                    (h/db))))))
+
 (deftest add-alias-suggestion-code-actions
   (h/load-code-and-locs "(ns clojure.set)" (h/file-uri "file:///clojure.core.clj"))
   (h/load-code-and-locs "(ns medley.core)" (h/file-uri "file:///medley.core.clj"))

lib/test/clojure_lsp/feature/diagnostics_test.clj

@@ -5,7 +5,8 @@
    [clojure-lsp.shared :as shared]
    [clojure-lsp.test-helper :as h]
    [clojure.core.async :as async]
-   [clojure.test :refer [deftest is testing]]))
+   [clojure.test :refer [deftest is testing]]
+   [matcher-combinators.test :refer [match?]]))
 
 (def findings (atom []))
 
@@ -121,7 +122,7 @@
                 {:clojure-lsp/unused-public-var
                  {:level :info
                   :ignore-test-references? false}}}})
-    (h/assert-submaps [] @findings))
+    (is (match? [] @findings)))
   (testing "Given a public var foo/bar in a src namespace
             And being referenced in a test namespace foo-test
             When linter level is :info
@@ -137,17 +138,16 @@
                 {:clojure-lsp/unused-public-var
                  {:level :info
                   :ignore-test-references? true}}}})
-    (h/assert-submaps
-      [{:end-row 1
-        :type :clojure-lsp/unused-public-var
-        :level :info
-        :filename "/project/src/foo.clj"
-        :col 16
-        :uri "file:///project/src/foo.clj"
-        :end-col 19
-        :message "Unused public var 'foo/bar'"
-        :row 1}]
-      @findings)))
+    (is (match? [{:end-row 1
+                  :type :clojure-lsp/unused-public-var
+                  :level :info
+                  :filename (h/file-path "/project/src/foo.clj")
+                  :col 16
+                  :uri (h/file-uri "file:///project/src/foo.clj")
+                  :end-col 19
+                  :message "Unused public var 'foo/bar'"
+                  :row 1}]
+                @findings))))
 
 (deftest unused-public-var-declared-inside-test-namespace
   (swap! (h/db*) merge {:project-root-uri (h/file-uri "file:///project")
@@ -167,17 +167,16 @@
                 {:clojure-lsp/unused-public-var
                  {:level :info
                   :ignore-test-references? false}}}})
-    (h/assert-submaps
-      [{:end-row 1
-        :type :clojure-lsp/unused-public-var
-        :level :info
-        :filename "/project/test/foo_test.clj"
-        :col 21
-        :uri "file:///project/test/foo_test.clj"
-        :end-col 27
-        :message "Unused public var 'foo-test/helper'"
-        :row 1}]
-      @findings))
+    (is (match? [{:end-row 1
+                  :type :clojure-lsp/unused-public-var
+                  :level :info
+                  :filename (h/file-path "/project/test/foo_test.clj")
+                  :col 21
+                  :uri (h/file-uri "file:///project/test/foo_test.clj")
+                  :end-col 27
+                  :message "Unused public var 'foo-test/helper'"
+                  :row 1}]
+                @findings)))
   (testing "Given a public var foo-test/helper in a test namespace
             When linter level is :info
             And the :ignore-test-references? flag is on
@@ -190,17 +189,16 @@
        :config {:linters {:clojure-lsp/unused-public-var
                           {:level :info
                            :ignore-test-references? true}}}})
-    (h/assert-submaps
-      [{:end-row 1
-        :type :clojure-lsp/unused-public-var
-        :level :info
-        :filename "/project/test/foo_test.clj"
-        :col 21
-        :uri "file:///project/test/foo_test.clj"
-        :end-col 27
-        :message "Unused public var 'foo-test/helper'"
-        :row 1}]
-      @findings))
+    (is (match? [{:end-row 1
+                  :type :clojure-lsp/unused-public-var
+                  :level :info
+                  :filename (h/file-path "/project/test/foo_test.clj")
+                  :col 21
+                  :uri (h/file-uri "file:///project/test/foo_test.clj")
+                  :end-col 27
+                  :message "Unused public var 'foo-test/helper'"
+                  :row 1}]
+                @findings)))
   (testing "Given a public var bar-test/baz in a test namespace
             When linter level is :info
             And the :ignore-test-references? flag is on
@@ -215,7 +213,7 @@
        :config {:linters {:clojure-lsp/unused-public-var
                           {:level :info
                            :ignore-test-references? true}}}})
-    (h/assert-submaps [] @findings)))
+    (is (match? [] @findings))))
 
 (deftest lint-project-public-vars
   (swap! (h/db*) merge {:project-root-uri (h/file-uri "file:///project")