[stacktrace] Allow inspecting ex-data directly

Author: alexander-yakushev

cider-inspector.el

@@ -252,11 +252,16 @@ See `cider-sync-request:inspect-push' and `cider-inspector--render-value'"
       (push (point) cider-inspector-location-stack)
       (cider-inspector--render-value result :next-inspectable))))
 
-(defun cider-inspector-inspect-last-exception (index)
-  "Inspects the exception in the cause stack identified by INDEX."
+(defun cider-inspector-inspect-last-exception (index &optional ex-data)
+  "Inspects the exception in the cause stack identified by INDEX.
+If EX-DATA is true, inspect ex-data of the exception instead."
   (interactive)
   (cl-assert (numberp index))
-  (let ((result (cider-sync-request:inspect-last-exception index)))
+  (let ((result (cider-nrepl-send-sync-request `("op" "inspect-last-exception"
+                                                 "index" ,index
+                                                 ,@(when ex-data
+                                                     `("ex-data" "true")))
+                                               (cider-current-repl))))
     (when (nrepl-dict-get result "value")
       (setq cider-inspector-location-stack nil)
       (cider-inspector--render-value result :next-inspectable))))
@@ -423,14 +428,6 @@ current-namespace."
   (cider-nrepl-send-sync-request `("op" "inspect-previous-sibling")
                                  (cider-current-repl)))
 
-;;;###autoload
-(defun cider-sync-request:inspect-last-exception (index)
-  "Inspects the exception in the cause stack identified by INDEX."
-  (cl-assert (numberp index))
-  (cider-nrepl-send-sync-request `("op" "inspect-last-exception"
-                                   "index" ,index)
-                                 (cider-current-repl)))
-
 (defun cider-sync-request:inspect-next-sibling ()
   "Inspect the next sibling value within a sequential parent."
   (cider-nrepl-send-sync-request `("op" "inspect-next-sibling")

cider-stacktrace.el

@@ -796,27 +796,44 @@ the NAME.  The whole group is prefixed by string INDENT."
 
 (declare-function cider-inspector-inspect-last-exception "cider-inspector")
 
-(defun cider-stacktrace--inspect-class (event)
+(defun cider-stacktrace--inspect-mouse (event &optional ex-data)
   "Mouse handler for EVENT."
   (interactive "e")
   (let* ((pos (posn-point (event-end event)))
          (window (posn-window (event-end event)))
          (buffer (window-buffer window))
          (inspect-index (with-current-buffer buffer
                           (get-text-property pos 'inspect-index))))
-    (cider-inspector-inspect-last-exception inspect-index)))
+    (cider-inspector-inspect-last-exception inspect-index ex-data)))
 
-(defun cider-stacktrace--inspect-class-kbd ()
+(defun cider-stacktrace--inspect-kbd (&optional ex-data)
   "Keyboard handler."
   (interactive)
   (when-let ((inspect-index (get-text-property (point) 'inspect-index)))
-    (cider-inspector-inspect-last-exception inspect-index)))
+    (cider-inspector-inspect-last-exception inspect-index ex-data)))
+
+(defun cider-stacktrace--inspect-ex-data-mouse (event)
+  (interactive "e")
+  (cider-stacktrace--inspect-mouse event t))
+
+(defun cider-stacktrace--inspect-ex-data-kbd ()
+  (interactive)
+  (cider-stacktrace--inspect-kbd t))
 
 (defvar cider-stacktrace-exception-map
   (let ((map (make-sparse-keymap)))
-    (define-key map [mouse-1] #'cider-stacktrace--inspect-class)
-    (define-key map (kbd "p") #'cider-stacktrace--inspect-class-kbd)
-    (define-key map (kbd "i") #'cider-stacktrace--inspect-class-kbd)
+    (define-key map [mouse-1] #'cider-stacktrace--inspect-mouse)
+    (define-key map (kbd "p") #'cider-stacktrace--inspect-kbd)
+    (define-key map (kbd "i") #'cider-stacktrace--inspect-kbd)
+    (define-key map (kbd "RET") #'cider-stacktrace--inspect-kbd)
+    map))
+
+(defvar cider-stacktrace-ex-data-map
+  (let ((map (make-sparse-keymap)))
+    (define-key map [mouse-1] #'cider-stacktrace--inspect-ex-data-mouse)
+    (define-key map (kbd "p") #'cider-stacktrace--inspect-ex-data-kbd)
+    (define-key map (kbd "i") #'cider-stacktrace--inspect-ex-data-kbd)
+    (define-key map (kbd "RET") #'cider-stacktrace--inspect-ex-data-kbd)
     map))
 
 (defun cider-stacktrace-render-cause (buffer cause num note &optional inspect-index)
@@ -839,10 +856,10 @@ make INSPECT-INDEX actionable if present."
                                      ,cider-stacktrace-exception-map)
             (insert (format "%d. " num)
                     (propertize note 'font-lock-face 'font-lock-comment-face) " "
-                    (propertize class 'font-lock-face class-face 'mouse-face 'highlight)))
+                    (propertize class 'font-lock-face class-face 'mouse-face 'highlight)
+                    "\n"))
           ;; Detail level 1: message + ex-data
           (cider-propertize-region '(detail 1)
-            (insert "\n")
             (if (equal class "clojure.lang.Compiler$CompilerException")
                 (cider-stacktrace-render-compile-error buffer cause)
               (cider-stacktrace-emit-indented
@@ -859,18 +876,25 @@ make INSPECT-INDEX actionable if present."
               (cider-stacktrace--emit-spec-problems spec (concat indent "  ")))
             (when data
               (insert "\n")
-              (cider-stacktrace-emit-indented data indent nil t)))
+              (cider-propertize-region `(inspect-index
+                                         ,inspect-index
+                                         keymap
+                                         ,cider-stacktrace-ex-data-map
+                                         mouse-face
+                                         highlight)
+                (cider-stacktrace-emit-indented data indent nil t)))
+            (insert "\n"))
           ;; Detail level 2: stacktrace
           (cider-propertize-region '(detail 2)
             (let ((beg (point))
                   (bg `(:background ,cider-stacktrace-frames-background-color :extend t)))
               (dolist (frame stacktrace)
-                (insert "\n")
-                (cider-stacktrace-render-frame buffer frame))
+                (cider-stacktrace-render-frame buffer frame)
+                (insert "\n"))
               (overlay-put (make-overlay beg (point)) 'font-lock-face bg)))
           ;; Add line break between causes, even when collapsed.
           (cider-propertize-region '(detail 0)
-            (insert "\n\n")))))))
+            (insert "\n")))))))
 
 (defun cider-stacktrace-initialize (causes)
   "Set and apply CAUSES initial visibility, filters, and cursor position."

doc/modules/ROOT/pages/usage/dealing_with_errors.adoc

@@ -212,18 +212,19 @@ for instance:
 
 == Inspector integration
 
-Within `*cider-error*`, when clicking directly a top-level exception (any of them in the cause chain),
-that specific exception will be inspected with the CIDER xref:debugging/inspector.adoc[Inspector].
+Within `*cider-error*`, when clicking directly a top-level exception (any of
+them in the cause chain), that specific exception will be inspected with the
+CIDER xref:debugging/inspector.adoc[Inspector]. You can also click on the
+rendered exception data to inspect it directly.
 
-This allows you to better understand intrincate `ex-data`.
-
-This clicking is defined and customizable in `cider-stacktrace-exception-map`, which has the following defaults:
+This clicking is defined and customizable in `cider-stacktrace-exception-map`
+and `cider-stacktrace-ex-data-map`.
 
 === Keybindings
 
 |===
 | Action | Description
 
-| kbd:[click] or kbd:[i] or kbd:[p] 
-| Open the given exception in the Inspector.
+| kbd:[click] or kbd:[i] or kbd:[p] or kbd:[Return]
+| Open the given exception or ex-data in the Inspector.
 |===