Support functional setFunctionBreakpoints command

Author: st0012

lib/debug/server_dap.rb

@@ -249,8 +249,6 @@ def process
             end
           }
           send_response req, breakpoints: (bps.map do |bp| {verified: true,} end)
-        when 'setFunctionBreakpoints'
-          send_response req
         when 'setExceptionBreakpoints'
           process_filter = ->(filter_id) {
             case filter_id
@@ -354,7 +352,8 @@ def process
              'variables',
              'evaluate',
              'source',
-             'completions'
+             'completions',
+             'setFunctionBreakpoints'
           @q_msg << req
 
         else
@@ -430,6 +429,8 @@ def fail_response req, **kw
 
     def process_protocol_request req
       case req['command']
+      when 'setFunctionBreakpoints'
+        @tc << [:dap, :breakpoints, req]
       when 'stepBack'
         if @tc.recorder&.can_step_back?
           @tc << [:step, :back]
@@ -559,6 +560,17 @@ def dap_event args
           end
         }
         @ui.respond req, result
+      when :breakpoints
+        breakpoints = result[:breakpoints].map do |bp|
+          if bp
+            add_bp(bp)
+            { verified: true, message: bp.inspect }
+          else
+            { verified: false, message: nil }
+          end
+        end
+
+        @ui.respond req, breakpoints: breakpoints
       when :scopes
         frame_id = req.dig('arguments', 'frameId')
         local_scope = result[:scopes].first
@@ -613,6 +625,17 @@ def process_dap args
       req = args.shift
 
       case type
+      when :breakpoints
+        bps = req.dig("arguments", "breakpoints")
+        SESSION.clear_method_breakpoints
+
+        breakpoints = bps.map do |bp|
+          if bp["name"]&.match(Session::METHOD_SIGNATURE_REGEXP)
+            make_breakpoint [:method, $1, $2, $3]
+          end
+        end
+
+        event! :dap_result, :breakpoints, req, { breakpoints: breakpoints }
       when :backtrace
         event! :dap_result, :backtrace, req, {
           stackFrames: @target_frames.map{|frame|

lib/debug/session.rb

@@ -1282,6 +1282,8 @@ def parse_break arg
       expr
     end
 
+    METHOD_SIGNATURE_REGEXP = /\A(.+)([\.\#])(.+)\z/
+
     def repl_add_breakpoint arg
       expr = parse_break arg.strip
       cond = expr[:if]
@@ -1293,7 +1295,7 @@ def repl_add_breakpoint arg
         add_line_breakpoint @tc.location.path, $1.to_i, cond: cond, command: cmd
       when /\A(.+)[:\s+](\d+)\z/
         add_line_breakpoint $1, $2.to_i, cond: cond, command: cmd
-      when /\A(.+)([\.\#])(.+)\z/
+      when METHOD_SIGNATURE_REGEXP
         @tc << [:breakpoint, :method, $1, $2, $3, cond, cmd, path]
         return :noretry
       when nil
@@ -1324,6 +1326,12 @@ def repl_add_watch_breakpoint arg
       @tc << [:breakpoint, :watch, expr[:sig], cond, cmd, path]
     end
 
+    def add_method_breakpoint(method_signature)
+      if method_signature.match(METHOD_SIGNATURE_REGEXP)
+        @tc << [:breakpoint, :method, $1, $2, $3]
+      end
+    end
+
     def add_catch_breakpoint pat
       bp = CatchBreakpoint.new(pat)
       add_bp bp
@@ -1343,6 +1351,14 @@ def add_line_breakpoint file, line, **kw
       @ui.puts e.message
     end
 
+    def clear_method_breakpoints
+      @bps.delete_if do |k, bp|
+        if bp.is_a?(MethodBreakpoint)
+          bp.delete
+        end
+      end
+    end
+
     def clear_line_breakpoints path
       path = resolve_path(path)
       @bps.delete_if do |k, bp|

test/protocol/break_test.rb

@@ -16,7 +16,7 @@ class BreakTest1 < TestCase
       9| end
     RUBY
 
-    def test_break_stops_at_correct_place
+    def test_set_breakpoints_sets_line_breakpoints
       run_protocol_scenario PROGRAM do
         req_add_breakpoint 5
         req_continue
@@ -42,6 +42,30 @@ def test_break_stops_at_correct_place
         req_terminate_debuggee
       end
     end
+
+    def test_set_function_breakpoints_sets_method_breakpoints
+      run_protocol_scenario PROGRAM, cdp: false do
+        res_set_function_breakpoints([{ name: "Foo::Bar.a" }])
+        req_continue
+        assert_line_num 4
+
+        assert_locals_result(
+          [
+            { name: "%self", value: "Foo::Bar", type: "Class" }
+          ]
+        )
+
+        req_continue
+      end
+    end
+
+    def test_set_function_breakpoints_unsets_method_breakpoints
+      run_protocol_scenario PROGRAM, cdp: false do
+        res_set_function_breakpoints([{ name: "Foo::Bar.a" }])
+        res_set_function_breakpoints([])
+        req_continue
+      end
+    end
   end
 
   class BreakTest2 < TestCase

test/support/protocol_utils.rb

@@ -140,6 +140,13 @@ def req_set_exception_breakpoints
       end
     end
 
+    def res_set_function_breakpoints(breakpoints)
+      case ENV['RUBY_DEBUG_TEST_UI']
+      when 'vscode'
+        send_dap_request 'setFunctionBreakpoints', breakpoints: breakpoints
+      end
+    end
+
     def req_step_back
       case ENV['RUBY_DEBUG_TEST_UI']
       when 'vscode'