Debugging in Cider #1019

Malabarba · 2015-03-15T13:39:04Z

This PR goes along with clojure-emacs/cider-nrepl#170, please see there for instructions.

bbatsov · 2015-03-15T14:53:36Z

Adding a menu for this would be nice. You might also post an animated gif showcasing the prototype as some users might have a hard time updating the client and the middleware by themselves.

Malabarba · 2015-03-15T16:16:21Z

Added gif on both posts.

Malabarba · 2015-03-15T16:16:51Z

When you say menu, do you mean an item under the Cider menu-bar?

bbatsov · 2015-03-15T16:43:49Z

Yes. And maybe a separate debug menu when the debugger is enabled (as in
edebug).

On 15 March 2015 at 18:16, Artur Malabarba notifications@github.com wrote:

When you say menu, do you mean an item under the Cider menu-bar?

—
Reply to this email directly or view it on GitHub
#1019 (comment).

Best Regards,
Bozhidar Batsov

http://www.batsov.com

vspinu · 2015-03-19T09:16:19Z

nrepl-client.el

@@ -786,6 +786,26 @@ for functionality like pretty-printing won't clobber the values of *1, *2, etc."
 (defvar nrepl-err-handler 'cider-default-err-handler
  "Evaluation error handler.")

+(defvar-local nrepl--input-handler-queue nil


BTW, nrepl-client.el already loads queue.el. You might consider using that data structure.

Thanks for the pointer. Will do.

vspinu · 2015-03-19T10:06:37Z

@Bruce-Connor thanks. Truly great job!

Let's bind this to C-u C-M-x to mimic edebug. Printing could be shifted to C-u C-u. Not a big deal.

vspinu · 2015-03-19T10:13:23Z

cider-debug.el

+    (nrepl-request:stdin
+     ;; For now we immediately try to read-char. Ideally, this will
+     ;; be done in a minor-mode (like edebug does) so that the user
+     ;; isn't blocked from doing anything else.


Yes, and also bound to some rarely used but easelly accessible combos (like C-Q and C-C) to avoidinterference with the editing. The only thing I dislike about edebug is the read-only lock.

Making it read-only is a precaution we might need as well. The way it's currently designed, if the user edits the source file inside or before the instrumented sexp, then the debugger will start to misbehave. It will probably place point in the wrong places and might end up throwing an error while trying to navigate the code (due to calling forward-sexp in an invalid location).

if the user edits the source file inside or before the instrumented sexp, then the debugger will start to misbehave.

The debugging can be aborted if that happens, similarly to what edebug does when the source has been modified.

Alternatively we can check the region for modifications, and if there have been such since the last instrumentation, re-instrument the definition in the background. Not sure if that's possible at debugger.core level.

Malabarba · 2015-03-19T10:29:15Z

Let's bind this to C-u C-M-x to mimic edebug. Printing could be shifted to C-u C-u. Not a big deal.

I agree. Printing can also always be done with C-u C-x C-e anyway.

bbatsov · 2015-03-26T07:08:59Z

@Malabarba Love the new handle. :-)

Malabarba · 2015-03-26T09:03:04Z

Thanks. Just hoping I'll stop being called Bruce now.
Even changed the email on my profile to the blog's domain, even though it only does forwarding. =P

bbatsov · 2015-03-26T09:07:03Z

Well, to be honest I thought your name was Bruce Connor for a while myself. :-)

Malabarba · 2015-03-26T09:57:44Z

Exactly. :-) It's my own fault, of course.
Just an old nick from my gaming era which stuck around a little too long.

Malabarba · 2015-03-28T11:19:29Z

Squashed. I can remove the keybind if it's not ok.

bbatsov · 2015-03-28T11:27:46Z

Please, drop the . in the second commit's title (titles are not sentences) and mention the debugger in both the changelog and the readme.

Malabarba · 2015-03-28T11:57:04Z

Please, drop the . in the second commit's title (titles are not sentences) and mention the debugger in
both the changelog and the readme.

Done

bbatsov · 2015-03-28T12:20:10Z

Hmm, now the branch can't be merged. Guess it was not in sync with the current master, so you'll have to rebase.

It allows cider modules to specify a function that will handle the next need-input event.

Add cider-debug-defun-at-point to the menu-bar. Bind cider-debug-defun-at-point to cider-eval-defun-at-point with a prefix. This needs debug.clj at cider-nrepl to work. Invoke M-x cider-debug-defun-at-point to see it in action.

Malabarba · 2015-03-28T13:21:16Z

Rebased

Debugging in Cider

bbatsov · 2015-03-28T14:18:06Z

🎉

Malabarba · 2015-03-28T14:53:48Z

🍺

arichiardi · 2015-03-28T15:34:23Z

Good job!

arrdem · 2015-03-28T18:51:31Z

🍻

DesmondHayes · 2015-03-31T08:15:29Z

Thanks for the great work. Happy to see debugging capabilities in Cider.
Here, I've found some issues for you to solve:) (Should I open a new issue?):
1.

(defn factorial
  [n]
  (loop [cnt n acc 1]
    (if (zero? cnt)
      acc
      (recur (dec cnt) (* acc cnt)))))

C-u C-c C-c to debug factorial gives an error in cider buffer:

Failed to instrument  (recur # #)
CompilerException java.lang.UnsupportedOperationException: Can only recur from tail position, compiling:(blah-blah-blah)

(defn foo
  [v]
  (do v))

C-u C-c C-c to debug foo gives an error in cider buffer:

Failed to instrument  (do v)

and also sometimes hangs cider repl so that only C-c C-c can stop it (at which point it gives a huge error with a stacktrace).

bbatsov · 2015-03-31T08:21:06Z

Open a new issue.

On Tuesday, March 31, 2015, Desmond Hayes notifications@github.com wrote:

Thanks for the great work. Happy to see debugging capabilities in Cider.
Here, I've found some issues for you to solve:) (Should I open a new
issue?):
1.

(defn factorial
[n](loop [cnt n acc 1]
%28if %28zero? cnt%29
acc
%28recur %28dec cnt%29 %28* acc cnt%29%29%29))

C-u C-c C-c to debug factorial gives an error in cider buffer:

Failed to instrument (recur # #)
CompilerException java.lang.UnsupportedOperationException: Can only recur from tail position, compiling:(blah-blah-blah)

(defn foo
[v](do v))

C-u C-c C-c to debug foo gives an error in cider buffer:

Failed to instrument (do v)

and also sometimes hangs cider repl so that only C-c C-c can stop it (at
which point it gives a huge error with a stacktrace).

—
Reply to this email directly or view it on GitHub
#1019 (comment).

Best Regards,
Bozhidar Batsov

http://www.batsov.com

Malabarba · 2015-03-31T09:03:18Z

@DesmondHayes thanks for catching these, could you open a new issue for them?

Item 2 is probably an easy fix, we should be able to instrument that for sure.
Item 1 is more of a conceptual challenge. We'll have to discuss a solution.

Malabarba · 2015-03-31T17:04:12Z

@DesmondHayes Nevermind. These should both be fixed on PR clojure-emacs/cider-nrepl#177

DesmondHayes · 2015-04-01T08:48:41Z

@Malabarba I've actually opened issue #1048. Also, have you seen #1049?

johnbendi · 2015-06-13T03:26:47Z

Please how do I turn it off?

Malabarba · 2015-06-13T06:48:33Z

@johnbendi What do you mean by that? The debugger is off until you activate it.

johnbendi · 2015-06-13T22:41:52Z

                                                                                  @malabarba how do I deactivate?                                                                                                                                                                                                                                                                                                                                         Sent from my BlackBerry 10 smartphone.                                                                                                                                                                                                                From: Artur MalabarbaSent: Saturday, June 13, 2015 7:48 AMTo: clojure-emacs/ciderReply To: clojure-emacs/ciderCc: John ChijiokeSubject: Re: [cider] Debugging in Cider (#1019)@johnbendi What do you mean by that? The debugger is off until you activate it.

—Reply to this email directly or view it on GitHub.

Malabarba · 2015-06-13T23:03:07Z

@johnbendi

If you mean "how do I quit in the middle of debugging something", then hit the q key.
If you mean "after I debug a function how do I stop it from activating the debugger every time it is called again?", then you just need to evaluate the function's defn normally (with C-M-x).

This was referenced Mar 15, 2015

Debugging in Cider clojure-emacs/cider-nrepl#170

Merged

Implement a debugger #694

Closed

vspinu reviewed Mar 19, 2015
View reviewed changes

Malabarba added 2 commits March 28, 2015 12:58

nrepl-client.el: Add an input-handler queue

f014583

It allows cider modules to specify a function that will handle the next need-input event.

Add cider-debug.el: Interactive debugger similar to edebug

d6b6d77

Add cider-debug-defun-at-point to the menu-bar. Bind cider-debug-defun-at-point to cider-eval-defun-at-point with a prefix. This needs debug.clj at cider-nrepl to work. Invoke M-x cider-debug-defun-at-point to see it in action.

bbatsov added a commit that referenced this pull request Mar 28, 2015

Merge pull request #1019 from Malabarba/debug

b22a523

Debugging in Cider

bbatsov merged commit b22a523 into clojure-emacs:master Mar 28, 2015

mohitleo9 mentioned this pull request Mar 30, 2015

Integration of cider-debugger tpope/vim-fireplace#200

Open

Malabarba deleted the debug branch April 1, 2015 14:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Debugging in Cider #1019

Debugging in Cider #1019

Malabarba commented Mar 15, 2015

bbatsov commented Mar 15, 2015

Malabarba commented Mar 15, 2015

Malabarba commented Mar 15, 2015

bbatsov commented Mar 15, 2015

vspinu Mar 19, 2015

Malabarba Mar 19, 2015

vspinu commented Mar 19, 2015

vspinu Mar 19, 2015

Malabarba Mar 19, 2015

vspinu Mar 19, 2015

Malabarba commented Mar 19, 2015

bbatsov commented Mar 26, 2015

Malabarba commented Mar 26, 2015

bbatsov commented Mar 26, 2015

Malabarba commented Mar 26, 2015

Malabarba commented Mar 28, 2015

bbatsov commented Mar 28, 2015

Malabarba commented Mar 28, 2015

bbatsov commented Mar 28, 2015

Malabarba commented Mar 28, 2015

bbatsov commented Mar 28, 2015

Malabarba commented Mar 28, 2015

arichiardi commented Mar 28, 2015

arrdem commented Mar 28, 2015

DesmondHayes commented Mar 31, 2015

bbatsov commented Mar 31, 2015

Malabarba commented Mar 31, 2015

Malabarba commented Mar 31, 2015

DesmondHayes commented Apr 1, 2015

johnbendi commented Jun 13, 2015

Malabarba commented Jun 13, 2015

johnbendi commented Jun 13, 2015

Malabarba commented Jun 13, 2015

Debugging in Cider #1019

Debugging in Cider #1019

Conversation

Malabarba commented Mar 15, 2015

bbatsov commented Mar 15, 2015

Malabarba commented Mar 15, 2015

Malabarba commented Mar 15, 2015

bbatsov commented Mar 15, 2015

vspinu Mar 19, 2015

Choose a reason for hiding this comment

Malabarba Mar 19, 2015

Choose a reason for hiding this comment

vspinu commented Mar 19, 2015

vspinu Mar 19, 2015

Choose a reason for hiding this comment

Malabarba Mar 19, 2015

Choose a reason for hiding this comment

vspinu Mar 19, 2015

Choose a reason for hiding this comment

Malabarba commented Mar 19, 2015

bbatsov commented Mar 26, 2015

Malabarba commented Mar 26, 2015

bbatsov commented Mar 26, 2015

Malabarba commented Mar 26, 2015

Malabarba commented Mar 28, 2015

bbatsov commented Mar 28, 2015

Malabarba commented Mar 28, 2015

bbatsov commented Mar 28, 2015

Malabarba commented Mar 28, 2015

bbatsov commented Mar 28, 2015

Malabarba commented Mar 28, 2015

arichiardi commented Mar 28, 2015

arrdem commented Mar 28, 2015

DesmondHayes commented Mar 31, 2015

bbatsov commented Mar 31, 2015

Malabarba commented Mar 31, 2015

Malabarba commented Mar 31, 2015

DesmondHayes commented Apr 1, 2015

johnbendi commented Jun 13, 2015

Malabarba commented Jun 13, 2015

johnbendi commented Jun 13, 2015

Malabarba commented Jun 13, 2015