Merge pull request #26 from emacs-lsp/add-test-debug

Add Dart/Flutter test debug

Author: ericdallo

Makefile

@@ -18,7 +18,7 @@ LINT="(progn \
 build:
 	cask install
 
-test: build compile checkdoc lint
+test: clean build compile checkdoc lint
 
 compile:
 	@echo "Compiling..."
@@ -57,7 +57,7 @@ lint:
 		*.el
 
 clean:
-	rm -rf .cask
+	rm -rf .cask *.elc
 
 tag:
 	$(eval TAG := $(filter-out $@,$(MAKECMDGOALS)))

README.md

@@ -65,15 +65,14 @@ Besides the `lsp-mode` features, `lsp-dart` implements the [custom methods featu
 
 ![flutter-outline](images/flutter-outline.gif)
 
-### Run tests
+### Run/Debug tests
 
 `lsp-dart-run-test-file` - Run all tests from current test buffer.
-
-`lsp-dart-run-test-at-point` - Run single test at point. [:warning:*](#features-only-available-for-dart-sdk-version-280-currently-the-dev-branch-or-above)
-
+`lsp-dart-run-test-at-point` - Run single test at point.
+`lsp-dart-debug-test-at-point` - Debug single test at point.
 `lsp-dart-visit-last-test` - Go to last ran test.
-
 `lsp-dart-run-last-test` - Run last ran test.
+`lsp-dart-debug-last-test` - Debug last ran test.
 
 Running a test interactively: 
 
@@ -162,12 +161,15 @@ You can also open the [Dart DevTools](https://dart.dev/tools/dart-devtools) on t
 | `lsp-dart-flutter-fringe-colors`                 | Enable the Flutter colors on fringe.                                                                    | `t`                                   |
 | `lsp-dart-flutter-widget-guides`                 | Enable the Flutter widget guide lines from parent to child widgets                                      | `t`                                   |
 | `lsp-dart-test-code-lens`                        | Enable the `Run` code lens on tests.                                                                    | `t`                                   |
-| `lsp-dart-dap-extension-version`                 | The debugger extension version.                                                                         | 3.9.1                                 |
+| `lsp-dart-dap-extension-version`                 | The debugger extension version.                                                                         | 3.10.1                                |
 | `lsp-dart-dap-debugger-path`                     | The debugger extension path                                                                             | Check source file                     |
 | `lsp-dart-dap-dart-debugger-program`             | The command to execute the debugger extension on dart projects.                                         | Check source file                     |
+| `lsp-dart-dap-dart-test-debugger-program`        | The command to execute the test debugger extension on dart projects.                                    | Check source file                     |
 | `lsp-dart-dap-flutter-debugger-program`          | The command to execute the debugger extension on flutter projects.                                      | Check source file                     |
+| `lsp-dart-dap-flutter-test-debugger-program`     | The command to execute the test debugger extension on flutter projects.                                 | Check source file                     |
 | `lsp-dart-dap-debug-external-libraries`          | Whether to enable the debug on external libraries                                                       | `nil`                                 |
 | `lsp-dart-dap-debug-sdk-libraries`               | Whether to enable the debug on Dart SDK libraries                                                       | `nil`                                 |
+| `lsp-dart-dap-vm-additional-args`                | Additional args for dart debugging VM when the debugging.                                               | `""`                                  |
 | `lsp-dart-dap-flutter-track-widget-creation`     | Whether to pass –track-widget-creation to Flutter apps. Required to support 'Inspect Widget'.           | `t`                                   |
 | `lsp-dart-dap-flutter-structured-errors`         | Whether to use Flutter’s structured error support for improve error display.                            | `t`                                   |
 | `lsp-dart-dap-flutter-verbose-log`               | Whether to enable verbose logs from Flutter DAP                                                         | `nil`                                 |

images/run-test.gif

@@ -79,7 +79,7 @@ If URI is not found on buffer, schedule re-check."
 (defun lsp-dart-dap-devtools--activated-p ()
   "Return non-nil if devtools is activated otherwise nil."
   (lsp-dart-dap-devtools--clean-buffer lsp-dart-dap-devtools--pub-list-packages-buffer-name)
-  (let* ((pub (lsp-dart-project-get-pub-command))
+  (let* ((pub (lsp-dart-project-pub-command))
          (_proc (call-process pub
                               nil
                               lsp-dart-dap-devtools--pub-list-packages-buffer-name
@@ -91,7 +91,7 @@ If URI is not found on buffer, schedule re-check."
 (defun lsp-dart-dap-devtools--activate (callback)
   "Activate Dart Devtools via pub then call CALLBACK."
   (lsp-dart-dap-devtools-log "Activating...")
-  (let ((pub (lsp-dart-project-get-pub-command)))
+  (let ((pub (lsp-dart-project-pub-command)))
     (lsp-async-start-process
      (lambda ()
        (lsp-dart-dap-devtools-log "Activated successfully!")
@@ -123,7 +123,7 @@ If it is already activated or after activated successfully, call CALLBACK."
    (lambda ()
      (if-let ((uri (lsp-workspace-get-metadata "dart-debug-devtools-uri")))
       (funcall callback uri)
-    (let* ((pub (lsp-dart-project-get-pub-command))
+    (let* ((pub (lsp-dart-project-pub-command))
            (proc (start-process "Start DevTools"
                                 lsp-dart-dap-devtools--buffer-name
                                 pub "global" "run" "devtools"

lsp-dart-dap-devtools.el

@@ -50,12 +50,24 @@
   :group 'lsp-dart
   :type '(repeat string))
 
+(defcustom lsp-dart-dap-dart-test-debugger-program
+  `("node" ,(f-join lsp-dart-dap-debugger-path "extension/out/src/debug/dart_test_debug_entry.js"))
+  "The path to the dart test debugger."
+  :group 'lsp-dart
+  :type '(repeat string))
+
 (defcustom lsp-dart-dap-flutter-debugger-program
   `("node" ,(f-join lsp-dart-dap-debugger-path "extension/out/src/debug/flutter_debug_entry.js"))
   "The path to the Flutter debugger."
   :group 'lsp-dart
   :type '(repeat string))
 
+(defcustom lsp-dart-dap-flutter-test-debugger-program
+  `("node" ,(f-join lsp-dart-dap-debugger-path "extension/out/src/debug/flutter_test_debug_entry.js"))
+  "The path to the dart test debugger."
+  :group 'lsp-dart
+  :type '(repeat string))
+
 (defcustom lsp-dart-dap-debug-external-libraries nil
   "If non-nil, enable the debug on external libraries."
   :group 'lsp-dart
@@ -66,6 +78,11 @@
   :group 'lsp-dart
   :type 'boolean)
 
+(defcustom lsp-dart-dap-vm-additional-args ""
+  "Additional args for dart debugging VM."
+  :group 'lsp-dart
+  :type 'string)
+
 (defcustom lsp-dart-dap-flutter-track-widget-creation t
   "Whether to pass –track-widget-creation to Flutter apps.
 Required to support 'Inspect Widget'."
@@ -103,6 +120,23 @@ Required to support 'Inspect Widget'."
    "npm" "install" "--prefix" (f-join lsp-dart-dap-debugger-path "extension")
    "--no-package-lock" "--silent" "--no-save"))
 
+(defun lsp-dart-dap--base-debugger-args (conf)
+  "Return the base args for debugging merged with CONF."
+  (-> conf
+      (dap--put-if-absent :request "launch")
+      (dap--put-if-absent :dartPath (lsp-dart-project-dart-command))
+      (dap--put-if-absent :cwd (lsp-dart-project-get-root))
+      (dap--put-if-absent :pubPath (lsp-dart-project-pub-command))
+      (dap--put-if-absent :pubSnapshotPath (lsp-dart-project-pub-snapshot-command))
+      (dap--put-if-absent :vmAdditionalArgs lsp-dart-dap-vm-additional-args)
+      (dap--put-if-absent :debugExternalLibraries lsp-dart-dap-debug-external-libraries)
+      (dap--put-if-absent :debugSdkLibraries lsp-dart-dap-debug-sdk-libraries)
+      (dap--put-if-absent :flutterPath (lsp-dart-project-get-flutter-path))
+      (dap--put-if-absent :flutterTrackWidgetCreation lsp-dart-dap-flutter-track-widget-creation)
+      (dap--put-if-absent :useFlutterStructuredErrors lsp-dart-dap-flutter-structured-errors)))
+
+;; Dart
+
 (dap-utils-github-extension-setup-function
  "dap-dart"
  "Dart-Code"
@@ -114,20 +148,28 @@ Required to support 'Inspect Widget'."
 (defun lsp-dart-dap--populate-dart-start-file-args (conf)
   "Populate CONF with the required arguments for dart debug."
   (-> conf
+      lsp-dart-dap--base-debugger-args
       (dap--put-if-absent :type "dart")
       (dap--put-if-absent :name "Dart")
-      (dap--put-if-absent :request "launch")
       (dap--put-if-absent :dap-server-path lsp-dart-dap-dart-debugger-program)
-      (dap--put-if-absent :cwd (lsp-dart-project-get-root))
-      (dap--put-if-absent :program (buffer-file-name))
-      (dap--put-if-absent :dartPath (lsp-dart-project-dart-command))
-      (dap--put-if-absent :debugExternalLibraries lsp-dart-dap-debug-external-libraries)
-      (dap--put-if-absent :debugSdkLibraries lsp-dart-dap-debug-sdk-libraries)))
+      (dap--put-if-absent :program (buffer-file-name))))
 
 (dap-register-debug-provider "dart" 'lsp-dart-dap--populate-dart-start-file-args)
 (dap-register-debug-template "Dart :: Debug"
                              (list :type "dart"))
 
+(defun lsp-dart-dap-debug-dart-test (path args)
+  "Start dart test debugging from PATH with ARGS."
+  (-> (list :type "dart"
+            :name "Dart Tests"
+            :dap-server-path lsp-dart-dap-dart-test-debugger-program
+            :program path
+            :noDebug nil
+            :shouldConnectDebugger t
+            :args args)
+      lsp-dart-dap--base-debugger-args
+      dap-start-debugging))
+
 ;; Flutter
 
 (declare-function all-the-icons-faicon "ext:all-the-icons")
@@ -160,18 +202,11 @@ Call CALLBACK when the device is chosen and started successfully."
 (defun lsp-dart-dap--populate-flutter-start-file-args (conf)
   "Populate CONF with the required arguments for Flutter debug."
   (let ((pre-conf (-> conf
+                      lsp-dart-dap--base-debugger-args
                       (dap--put-if-absent :type "flutter")
-                      (dap--put-if-absent :request "launch")
                       (dap--put-if-absent :flutterMode "debug")
                       (dap--put-if-absent :dap-server-path lsp-dart-dap-flutter-debugger-program)
-                      (dap--put-if-absent :cwd (lsp-dart-project-get-root))
-                      (dap--put-if-absent :program (lsp-dart-project-get-entrypoint))
-                      (dap--put-if-absent :dartPath (lsp-dart-project-dart-command))
-                      (dap--put-if-absent :flutterPath (lsp-dart-project-get-flutter-path))
-                      (dap--put-if-absent :flutterTrackWidgetCreation lsp-dart-dap-flutter-track-widget-creation)
-                      (dap--put-if-absent :useFlutterStructuredErrors lsp-dart-dap-flutter-structured-errors)
-                      (dap--put-if-absent :debugExternalLibraries lsp-dart-dap-debug-external-libraries)
-                      (dap--put-if-absent :debugSdkLibraries lsp-dart-dap-debug-sdk-libraries))))
+                      (dap--put-if-absent :program (lsp-dart-project-get-entrypoint)))))
     (lambda (start-debugging-callback)
       (lsp-dart-dap--flutter-get-or-create-device
        (-lambda ((&hash "id" device-id "name" device-name))
@@ -257,6 +292,22 @@ Call CALLBACK when the device is chosen and started successfully."
 (cl-defmethod dap-handle-event ((_event (eql dart.navigate)) _session _params)
   "Ignore this event.")
 
+(cl-defmethod dap-handle-event ((_event (eql dart.testRunNotification)) _session _params)
+  "Ignore this event.")
+
+(defun lsp-dart-dap-debug-flutter-test (path args)
+  "Start dart test debugging from PATH with ARGS."
+  (-> (list :name "Flutter Tests"
+            :type "flutter"
+            :dap-server-path lsp-dart-dap-flutter-test-debugger-program
+            :program path
+            :noDebug nil
+            :shouldConnectDebugger t
+            :flutterMode "debug"
+            :args args)
+      lsp-dart-dap--base-debugger-args
+      dap-start-debugging))
+
 ;;;###autoload
 (defun lsp-dart-dap-flutter-hot-restart ()
   "Hot restart current Flutter debug session."

lsp-dart-dap.el

@@ -66,12 +66,18 @@ flutter cache dir."
             (locate-dominating-file "bin")
             file-truename))))
 
-(defun lsp-dart-project-get-pub-command ()
+(defun lsp-dart-project-pub-command ()
   "Return the pub executable path from dart SDK path."
   (-> (lsp-dart-project-get-sdk-dir)
       file-name-as-directory
       (concat "bin/pub")))
 
+(defun lsp-dart-project-pub-snapshot-command ()
+  "Return the pub snapshot executable path from dart SDK path."
+  (-> (lsp-dart-project-get-sdk-dir)
+      file-name-as-directory
+      (concat "bin/snapshots/pub.dart.snapshot")))
+
 (defun lsp-dart-project-dart-command ()
   "Return the dart executable from dart SDK dir."
   (expand-file-name "bin/dart" (lsp-dart-project-get-sdk-dir)))

lsp-dart-project.el

@@ -28,6 +28,7 @@
 (require 'lsp-mode)
 
 (require 'lsp-dart-project)
+(require 'lsp-dart-dap)
 
 (defconst lsp-dart-test-support-tests-buffer-name "*LSP Dart tests*")
 
@@ -40,6 +41,11 @@
   (position nil)
   (kind nil))
 
+(defface lsp-dart-code-lens-separator
+  '((t :height 0.3))
+  "The face used for separate code lens overlays."
+  :group 'lsp-dart-test-support)
+
 (defun lsp-dart-test-support--test-kind-p (kind)
   "Return non-nil if KIND is a test type."
   (or (string= kind "UNIT_TEST_TEST")
@@ -100,9 +106,8 @@ otherwise the dart command."
     escaped-str))
 
 (defun lsp-dart-test-support-run (test)
-  "Run Dart/Flutter test command in a compilation buffer for BUFFER file.
+  "Run Dart/Flutter test command in a compilation buffer.
 If TEST is non nil, it will run only this test."
-  (interactive)
   (lsp-dart-test-support--from-project-root
    (let* ((file-name (lsp-dart-test-file-name test))
           (buffer (get-file-buffer file-name))
@@ -125,6 +130,22 @@ If TEST is non nil, it will run only this test."
                         t
                         (lambda (_) lsp-dart-test-support-tests-buffer-name)))))
 
+(defun lsp-dart-test-support-debug (test)
+  "Debug Dart/Flutter TEST."
+  (let* ((file-name (lsp-dart-test-file-name test))
+         (names (lsp-dart-test-names test))
+         (kind (lsp-dart-test-kind test))
+         (test-name (lsp-dart-test-support--build-test-name names))
+         (group-kind? (string= kind "UNIT_TEST_GROUP"))
+         (regex (concat "^"
+                        (lsp-dart-test-support--escape-test-name test-name)
+                        (unless group-kind? "$")))
+         (test-arg `("--name" ,regex)))
+    (lsp-workspace-set-metadata "last-ran-test" test)
+    (if (lsp-dart-test-support--flutter-test-file-p (get-file-buffer file-name))
+        (lsp-dart-dap-debug-flutter-test file-name test-arg)
+      (lsp-dart-dap-debug-dart-test file-name test-arg))))
+
 (defun lsp-dart-test-support--build-overlay (buffer names kind range test-range)
   "Build an overlay in BUFFER for a test NAMES of KIND.
 RANGE is the overlay range to build.
@@ -138,20 +159,33 @@ TEST-RANGE is the test method range."
           (test (make-lsp-dart-test :file-name (buffer-file-name buffer)
                                     :names names
                                     :position beg
-                                    :kind kind)))
+                                    :kind kind))
+          (separator (propertize " " 'font-lock-face 'lsp-dart-code-lens-separator)))
     (overlay-put overlay 'lsp-dart-test-code-lens t)
     (overlay-put overlay 'lsp-dart-test test)
     (overlay-put overlay 'lsp-dart-test-overlay-test-range (lsp--range-to-region test-range))
     (overlay-put overlay 'before-string
                  (concat spaces
-                         (propertize "Run\n"
+                         (propertize "Run"
                                      'help-echo "mouse-1: Run this test"
                                      'mouse-face 'lsp-lens-mouse-face
                                      'local-map (-doto (make-sparse-keymap)
-                                                 (define-key [mouse-1] (lambda ()
+                                                  (define-key [mouse-1] (lambda ()
                                                                           (interactive)
                                                                           (lsp-dart-test-support-run test))))
-                                     'font-lock-face 'lsp-lens-face)))))
+                                     'font-lock-face 'lsp-lens-face)
+                         separator
+                         (propertize "|" 'font-lock-face 'lsp-lens-face)
+                         separator
+                         (propertize "Debug"
+                                     'help-echo "mouse-1: Debug this test"
+                                     'mouse-face 'lsp-lens-mouse-face
+                                     'local-map (-doto (make-sparse-keymap)
+                                                  (define-key [mouse-1] (lambda ()
+                                                                          (interactive)
+                                                                          (lsp-dart-test-support-debug test))))
+                                     'font-lock-face 'lsp-lens-face)
+                         "\n"))))
 
 (defun lsp-dart-test-support--add-code-lens (buffer items &optional names)
   "Add test code lens to BUFFER for ITEMS.
@@ -183,12 +217,32 @@ PARAMS is the notification data from outline."
   "Return non-nil if FILE-NAME is a dart test files."
   (string-match "_test.dart" file-name))
 
+(defun lsp-dart-test-support-test-overlay-at-point ()
+  "Return test overlay at point.
+Return the overlay which has the smallest range of all test overlays in
+the current buffer."
+  (-some--> (overlays-in (point-min) (point-max))
+    (--filter (when (overlay-get it 'lsp-dart-test-code-lens)
+                (-let* (((beg . end) (overlay-get it 'lsp-dart-test-overlay-test-range)))
+                  (and (>= (point) beg)
+                       (<= (point) end)))) it)
+    (--min-by (-let* (((beg1 . end1) (overlay-get it 'lsp-dart-test-overlay-test-range))
+                      ((beg2 . end2) (overlay-get other 'lsp-dart-test-overlay-test-range)))
+                (and (< beg1 beg2)
+                     (> end1 end2))) it)))
+
 (defun lsp-dart-test-support-run-last-test ()
-  "Visit the last ran test going to the test definition."
+  "Run last ran test."
   (if-let ((test (lsp-workspace-get-metadata "last-ran-test")))
       (lsp-dart-test-support-run test)
     (lsp-dart-project-log "No last test found.")))
 
+(defun lsp-dart-test-support-debug-last-test ()
+  "Debug last ran test."
+  (if-let ((test (lsp-workspace-get-metadata "last-ran-test")))
+      (lsp-dart-test-support-debug test)
+    (lsp-dart-project-log "No last test found.")))
+
 (defun lsp-dart-test-support-visit-last-test ()
   "Visit the last ran test going to the test definition."
   (-if-let* ((test (lsp-workspace-get-metadata "last-ran-test"))