Add debug for dart and flutter

Author: ericdallo

lsp-dart-dap.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,8 @@ Required to support 'Inspect Widget'."
    "npm" "install" "--prefix" (f-join lsp-dart-dap-debugger-path "extension")
    "--no-package-lock" "--silent" "--no-save"))
 
+;; Dart
+
 (dap-utils-github-extension-setup-function
  "dap-dart"
  "Dart-Code"
@@ -121,13 +140,35 @@ Required to support 'Inspect Widget'."
       (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 :pubPath (lsp-dart-project-get-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-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 :name "Tests"
+            :type "dart"
+            :request "launch"
+            :dap-server-path lsp-dart-dap-dart-test-debugger-program
+            :noDebug nil
+            :shouldConnectDebugger t
+            :cwd (lsp-dart-project-get-root)
+            :dartPath (lsp-dart-project-dart-command)
+            :pubPath (lsp-dart-project-get-pub-command)
+            :pubSnapshotPath (lsp-dart-project-pub-snapshot-command)
+            :vmAdditionalArgs lsp-dart-dap-vm-additional-args
+            :debugExternalLibraries lsp-dart-dap-debug-external-libraries
+            :debugSdkLibraries lsp-dart-dap-debug-sdk-libraries
+            :program path
+            :args args)
+      dap-start-debugging))
+
 ;; Flutter
 
 (declare-function all-the-icons-faicon "ext:all-the-icons")
@@ -179,6 +220,7 @@ Call CALLBACK when the device is chosen and started successfully."
                   (-> pre-conf
                       (dap--put-if-absent :deviceId device-id)
                       (dap--put-if-absent :deviceName device-name)
+                      (dap--put-if-absent :vmAdditionalArgs lsp-dart-dap-vm-additional-args)
                       (dap--put-if-absent :flutterPlatform "default")
                       (dap--put-if-absent :name (concat "Flutter (" device-name ")")))))))))
 
@@ -257,6 +299,30 @@ 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 "Tests"
+            :type "flutter"
+            :request "launch"
+            :dap-server-path lsp-dart-dap-flutter-test-debugger-program
+            :noDebug nil
+            :shouldConnectDebugger t
+            :cwd (lsp-dart-project-get-root)
+            :dartPath (lsp-dart-project-dart-command)
+            :pubPath (lsp-dart-project-get-pub-command)
+            :pubSnapshotPath (lsp-dart-project-pub-snapshot-command)
+            :flutterPath (lsp-dart-project-get-flutter-path)
+            :flutterMode "debug"
+            :vmAdditionalArgs lsp-dart-dap-vm-additional-args
+            :debugExternalLibraries lsp-dart-dap-debug-external-libraries
+            :debugSdkLibraries lsp-dart-dap-debug-sdk-libraries
+            :program path
+            :args args)
+      dap-start-debugging))
+
 ;;;###autoload
 (defun lsp-dart-dap-flutter-hot-restart ()
   "Hot restart current Flutter debug session."

lsp-dart-project.el

@@ -72,6 +72,12 @@ flutter cache 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-test-support.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 in a compilation buffer."
+  (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.

lsp-dart.el

@@ -31,8 +31,8 @@
 (require 'lsp-mode)
 
 (require 'lsp-dart-project)
-(require 'lsp-dart-test-support)
 (require 'lsp-dart-dap)
+(require 'lsp-dart-test-support)
 (require 'lsp-dart-flutter-fringe)
 (require 'lsp-dart-flutter-widget-guide)