`cider-test-jump` doesn't work properly from test report

[rrudakov]

Expected behavior

When I hit RET on a failed test in *cider-test-report* buffer I jump to corresponding failed test source.

Actual behavior

There are 2 possible problems. Assuming the following test report:

Results

com.example.app-test
1 non-passing tests:

Fail in foo-test

expected: (= {:one 1, :two 2, :three 3, :five 5, :six 6} {:four 4})
  actual: (not (= {:one 1, :two 2, :three 3, :five 5, :six 6} {:four 4}))          

• If the point is on expected word, I'm getting Symbol ‘com.example.app-test/foo-test’ not resolved error in the minibuffer.
• If the point is inside of the expected value I'm getting a prompt in the minibuffer No comment syntax is defined. Use: . After setting ;, I'm getting Symbol not resolved error again.

Steps to reproduce the problem

Project files:
deps.edn:

{:paths   ["src"]
 :deps    {}
 :aliases {:test {:extra-paths ["test"]}}}

src/com/example/app.clj:

(ns com.example.app)

(defn foo
  [bar]
  (println bar))

test/com/example/app_test.clj:

(ns com.example.app-test
  (:require
   [clojure.test :refer [deftest is]]))

(deftest foo-test
  (is (= {:one   1
          :two   2
          :three 3
          :five  5
          :six   6}
         {:four 4})))

1. Jack-in to the project (enable :test alias additionally)
2. Run faulty test
3. Try to navigate from test report buffer to the failed test source.

Environment & Version information

CIDER version information

;; CIDER 1.8.2 (Geneva), nREPL 1.0.0
;; Clojure 1.11.1, Java 17.0.8.1

Lein / Clojure CLI version

Clojure CLI 1.11.1

Emacs version

GNU Emacs 29.1.50 (build 1, aarch64-apple-darwin23.0.0, NS appkit-2487.00 Version 14.0 (Build 23A344)) of 2023-10-06

Operating system

MacOS 14 Sonoma

JDK distribution

openjdk version "17.0.8.1" 2023-08-24
OpenJDK Runtime Environment Homebrew (build 17.0.8.1+0)
OpenJDK 64-Bit Server VM Homebrew (build 17.0.8.1+0, mixed mode, sharing)

[vemv]

I tried it just now and it works for me.

Try placing the cursor over foo-test (from Fail in foo-test) and M-x describe-char.

You should see ns and var info, denoting an existing and loaded var:

Is it not the case for you?

[vemv]

The error message comes from either of these:

(defun cider--find-var-other-window (var &optional line)
  "Find the definition of VAR, optionally at a specific LINE.

Display the results in a different window."
  (if-let* ((info (cider-var-info var)))
      (progn
        (if line (setq info (nrepl-dict-put info "line" line)))
        (cider--jump-to-loc-from-info info t))
    (user-error "Symbol `%s' not resolved" var)))

(defun cider--find-var (var &optional line)
  "Find the definition of VAR, optionally at a specific LINE."
  (if-let* ((info (cider-var-info var)))
      (progn
        (if line (setq info (nrepl-dict-put info "line" line)))
        (cider--jump-to-loc-from-info info))
    (user-error "Symbol `%s' not resolved" var)))

Therefore, please enable nrepl message logging and attach the nrepl logs here.

Thanks - V

[rrudakov]

Thanks for the quick response @vemv. Here's the requested data:

Describe char

There are text properties here:
  actual               "(not (= {:one 1, :two 2, :three 3, :five 5, :six 6} {:four 4}))\n"
  context              nil
  elapsed-time         (dict "humanized" "Completed in 7 ms" "ms" 7)
  expected             "(= {:one 1, :two 2, :three 3, :five 5, :six 6} {:four 4})\n"
  file                 "app_test.clj"
  font-lock-face       font-lock-function-name-face
  index                0
  line                 6
  message              ""
  ns                   "com.example.app-test"
  type                 "fail"
  var                  "foo-test"

Nrepl log messages

When I hit RET in the test report buffer I don't see any new messages in the log BTW.

nrepl-log-messages

(-->
  id         "11"
  op         "load-file"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:26:57.098964000"
  file       "(ns com.example.app-test
  (:require
   [clojure.test :refer..."
  file-name  "app_test.clj"
  file-path  "/Users/rrudakov/Personal/Projects/clj-bug/test/com/example/a..."
)
(<--
  id         "11"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:26:57.324723000"
  value      "#'com.example.app-test/foo-test"
)
(<--
  id         "11"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:26:57.327089000"
  status     ("done")
)
(-->
  id         "12"
  op         "classpath"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:26:57.556363000"
)
(<--
  id         "12"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:26:57.564491000"
  classpath  ("/Users/rrudakov/Personal/Projects/clj-bug/test" "/Users/rrudakov/Personal/Projects/clj-bug/src" "/Users/rrudakov/.m2/repository/cider/cider-nrepl/0.40.0/cider-nrepl-0.40.0.jar" "/Users/rrudakov/.m2/repository/nrepl/nrepl/1.0.0/nrepl-1.0.0.jar" "/Users/rrudakov/.m2/repository/org/clojure/clojure/1.11.1/clojure-1.11.1.jar" "/Users/rrudakov/.m2/repository/refactor-nrepl/refactor-nrepl/3.9.0/refactor-nrepl-3.9.0.jar" "/Users/rrudakov/.m2/repository/cider/orchard/0.16.1/orchard-0.16.1.jar" "/Users/rrudakov/.m2/repository/mx/cider/logjam/0.1.1/logjam-0.1.1.jar" "/Users/rrudakov/.m2/repository/org/clojure/core.specs.alpha/0.2.62/core.specs.alpha-0.2.62.jar" "/Users/rrudakov/.m2/repository/org/clojure/spec.alpha/0.3.218/spec.alpha-0.3.218.jar")
  status     ("done")
)
(-->
  id              "13"
  op              "ns-list"
  session         "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp      "2023-10-17 13:26:57.623745000"
  exclude-regexps ("^cider.nrepl" "^refactor-nrepl" "^nrepl")
)
(<--
  id         "13"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:26:57.648918000"
  ns-list    ("cider.nrepl" ...)
  status     ("done")
)
(<--
  id                 "11"
  session            "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp         "2023-10-17 13:26:57.709883000"
  changed-namespaces (dict ...)
  repl-type          "clj"
  status             ("state")
)
(-->
  id         "14"
  op         "info"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:27:11.518092000"
  context    "nil"
  ns         #("com.example.app-test" 0 20 (face font-lock-type-face cider-block-dynamic-font-lock t cider-locals nil fontified t))
  sym        "com.example.app-test/foo-test"
)
(<--
  id         "14"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:27:11.743880000"
  column     1
  file       "file:/Users/rrudakov/Personal/Projects/clj-bug/test/com/exam..."
  line       5
  name       "foo-test"
  ns         "com.example.app-test"
  status     ("done")
)
(-->
  id         "15"
  op         "test"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:27:11.798929000"
  fail-fast  "true"
  load?      "true"
  ns         #("com.example.app-test" 0 20 (face font-lock-type-face cider-block-dynamic-font-lock t cider-locals nil fontified t))
  tests      ("foo-test")
)
(<--
  id               "15"
  session          "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp       "2023-10-17 13:27:11.846249000"
  elapsed-time     (dict ...)
  gen-input        nil
  ns-elapsed-time  (dict ...)
  results          (dict ...)
  summary          (dict ...)
  testing-ns       "com.example.app-test"
  var-elapsed-time (dict ...)
)
(-->
  id         "16"
  op         "info"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:27:11.846654000"
  context    ":same"
  ns         "user"
  sym        "com.example.app-test/foo-test"
)
(<--
  id         "15"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:27:11.848141000"
  status     ("done")
)
(<--
  id         "16"
  session    "e4726101-37e7-4ba1-bbfa-b2aa80d65f58"
  time-stamp "2023-10-17 13:27:11.848296000"
  column     1
  file       "file:/Users/rrudakov/Personal/Projects/clj-bug/test/com/exam..."
  line       5
  name       "foo-test"
  ns         "com.example.app-test"
  status     ("done")
)

Screenshot

[vemv]

What if you M-: (cider-var-info "foo-test") while POINT is anywhere in the test .clj buffer?

It should result in a successful request being logged.

[rrudakov]

nrepl logs

(-->
  id         "11"
  op         "load-file"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:39:53.770214000"
  file       "(ns com.example.app-test
  (:require
   [clojure.test :refer..."
  file-name  "app_test.clj"
  file-path  "/Users/rrudakov/Personal/Projects/clj-bug/test/com/example/a..."
)
(<--
  id         "11"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:39:53.991295000"
  value      "#'com.example.app-test/foo-test"
)
(<--
  id         "11"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:39:53.993647000"
  status     ("done")
)
(-->
  id         "12"
  op         "classpath"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:39:54.232972000"
)
(<--
  id         "12"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:39:54.240529000"
  classpath  ("/Users/rrudakov/Personal/Projects/clj-bug/test" "/Users/rrudakov/Personal/Projects/clj-bug/src" "/Users/rrudakov/.m2/repository/cider/cider-nrepl/0.40.0/cider-nrepl-0.40.0.jar" "/Users/rrudakov/.m2/repository/nrepl/nrepl/1.0.0/nrepl-1.0.0.jar" "/Users/rrudakov/.m2/repository/org/clojure/clojure/1.11.1/clojure-1.11.1.jar" "/Users/rrudakov/.m2/repository/refactor-nrepl/refactor-nrepl/3.9.0/refactor-nrepl-3.9.0.jar" "/Users/rrudakov/.m2/repository/cider/orchard/0.16.1/orchard-0.16.1.jar" "/Users/rrudakov/.m2/repository/mx/cider/logjam/0.1.1/logjam-0.1.1.jar" "/Users/rrudakov/.m2/repository/org/clojure/core.specs.alpha/0.2.62/core.specs.alpha-0.2.62.jar" "/Users/rrudakov/.m2/repository/org/clojure/spec.alpha/0.3.218/spec.alpha-0.3.218.jar")
  status     ("done")
)
(-->
  id              "13"
  op              "ns-list"
  session         "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp      "2023-10-17 13:39:54.302728000"
  exclude-regexps ("^cider.nrepl" "^refactor-nrepl" "^nrepl")
)
(<--
  id         "13"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:39:54.327877000"
  ns-list    ("cider.nrepl" ...)
  status     ("done")
)
(<--
  id                 "11"
  session            "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp         "2023-10-17 13:39:54.754141000"
  changed-namespaces (dict ...)
  repl-type          "clj"
  status             ("state")
)
(-->
  id         "14"
  op         "eldoc"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:40:06.406749000"
  context    "(deftest __prefix__
  (is (= {:one   1
          :two   2
  ..."
  ns         #("com.example.app-test" 0 20 (face font-lock-type-face cider-block-dynamic-font-lock t cider-locals nil fontified t))
  sym        "foo-test"
)
(-->
  id         "15"
  op         "eldoc"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:40:06.596965000"
  context    "(__prefix__ foo-test
  (is (= {:one   1
          :two   2
 ..."
  ns         #("com.example.app-test" 0 20 (face font-lock-type-face cider-block-dynamic-font-lock t cider-locals nil fontified t))
  sym        "deftest"
)
(<--
  id         "14"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:40:06.691189000"
  docstring  nil
  name       "foo-test"
  ns         "com.example.app-test"
  status     ("done")
  type       "variable"
)
(<--
  id         "15"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:40:06.731593000"
  docstring  "Defines a test function with no arguments.  Test functions m..."
  eldoc      (("name" "&" "body"))
  name       "deftest"
  ns         "clojure.test"
  status     ("done")
  type       "macro"
)
(-->
  id         "16"
  op         "eldoc"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:40:07.486164000"
  context    "(deftest __prefix__
  (is (= {:one   1
          :two   2
  ..."
  ns         #("com.example.app-test" 0 20 (face font-lock-type-face cider-block-dynamic-font-lock t cider-locals nil fontified t))
  sym        "foo-test"
)
(<--
  id         "16"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:40:07.499497000"
  docstring  nil
  name       "foo-test"
  ns         "com.example.app-test"
  status     ("done")
  type       "variable"
)
(-->
  id         "17"
  op         "info"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:40:22.003575000"
  context    "nil"
  ns         #("com.example.app-test" 0 20 (face font-lock-type-face cider-block-dynamic-font-lock t cider-locals nil fontified t))
  sym        "foo-test"
)
(<--
  id         "17"
  session    "1da9b704-4723-42f1-b05e-7e30aea09155"
  time-stamp "2023-10-17 13:40:22.018045000"
  column     1
  file       "file:/Users/rrudakov/Personal/Projects/clj-bug/test/com/exam..."
  line       5
  name       "foo-test"
  ns         "com.example.app-test"
  status     ("done")
)

Result of evaluation:

(dict "status" ("done") "column" 1 "file" "file:/Users/rrudakov/Personal/Projects/clj-bug/test/com/example/app_test.clj" "id" "17" "line" 5 "name" ...)

[vemv]

Thanks!

I'd recommend restarting emacs, enabling nrepl logging in advance, jacking in and retrying.

We're hunting for a "info" request which wasn't successful.

There's the possibility no request was sent at all, but let's go step by step.

[vemv]

...Note that cider-var-info has:

(defun cider-var-info (var &optional all)
  "Return VAR's info as an alist with list cdrs.
When multiple matching vars are returned you'll be prompted to select one,
unless ALL is truthy."
+  (when (and var (not (string= var "")))

So that's a possible reason for the request not being sent.

You can debug with message, cl-assert, etc.

[rrudakov]

After edebugging cider-var-info and cider-sync-request:info I figured out that wrong CIDER session was used (I had another project running).I closed all other REPLs, and now I'm getting another error: No linked CIDER session (even though REPL is running).

[rrudakov]

I've started a fresh emacs session using emacs -q and tried to reproduce the issue. Now jumping works fine from expected word, but if I hit RET from the inside of expected map, I'm still being asked to specify comment syntax:

[rrudakov]

Looks like there is a problem when more than 1 REPL is running and buffer *cider-test-report* is being re-used. If I run tests for the first project, dismiss *cider-test-report* buffer and then run tests from another project I'm getting either No linked CIDER session error or Symbol not found depends on whether the REPL for an old project is still running.

[vemv]

Thanks! So it all seems to boil down to Sesman session linking.

We've fixed a bunch of those this summer, but not this one in particular.

I'll see what I can do - should be feasible.

No comment syntax is defined is unrelated. I wish I knew how to fix it 😅 we have an open issue for it.

[vemv]

Note to self.

A possible algo for determining session friendliness is:

• grab the namespaces from *cider-test-report* buffer contents (as text properties)
• Check if any of those namespaces belongs to the cached (all-ns) list.

---

Edit: or we could just save the current repl as a buffer-local variable.

[rrudakov]

No comment syntax is defined is unrelated. I wish I knew how to fix it 😅 we have an open issue for it.

So, I tracked down where it comes from.

cider-var-info has the following code:

(cider-sync-request:info var nil nil (cider-completion-get-context t))

and cider-completion-get-context at some point calls cider-completion-get-info-context-at-point, which tries to get a context if the following condition returns true:

(when (save-excursion
          (condition-case _
              (progn
                (up-list)
                (check-parens)
                t)
            (scan-error nil)
            (user-error nil)))

I'm not 100% sure, but it looks like it returns true if point is inside of parenthesis, and because it actually is, we're trying to get context and at some point the following coder from clojure-mode is called:

(defun clojure--looking-at-non-logical-sexp ()
  "Return non-nil if text after point is \"non-logical\" sexp.
\"Non-logical\" sexp are ^metadata and #reader.macros."
  (comment-normalize-vars)
  (comment-forward (point-max))
  (looking-at-p "\\(?:#?\\^\\)\\|#:?:?[[:alpha:]]"))

Maybe we could just check if the major mode is cider-test-report-mode and not requesting completion context in this case?