Support step filters when stepping

com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/DebugUtility.java

@@ -24,7 +24,6 @@
 
 import org.apache.commons.lang3.StringUtils;
 
-import com.sun.jdi.Location;
 import com.sun.jdi.Method;
 import com.sun.jdi.ObjectCollectedException;
 import com.sun.jdi.ThreadReference;
@@ -37,7 +36,6 @@
 import com.sun.jdi.connect.LaunchingConnector;
 import com.sun.jdi.connect.VMStartException;
 import com.sun.jdi.event.MethodEntryEvent;
-import com.sun.jdi.event.StepEvent;
 import com.sun.jdi.request.EventRequest;
 import com.sun.jdi.request.EventRequestManager;
 import com.sun.jdi.request.MethodEntryRequest;
@@ -192,67 +190,52 @@ public static IDebugSession attach(VirtualMachineManager vmManager, String hostN
     }
 
     /**
-     * Steps over newly pushed frames.
-     *
+     * Create a step over request on the specified thread.
      * @param thread
-     *            the target thread.
-     * @param eventHub
-     *            the {@link IEventHub} instance.
-     * @return the new {@link Location} of the execution flow of the specified
-     *         thread.
+     *              the target thread.
+     * @param stepFilters
+     *              the step filters when stepping.
+     * @return the new step request.
      */
-    public static CompletableFuture<Location> stepOver(ThreadReference thread, IEventHub eventHub) {
-        return DebugUtility.step(thread, eventHub, StepRequest.STEP_LINE, StepRequest.STEP_OVER);
+    public static StepRequest createStepOverRequest(ThreadReference thread, String[] stepFilters) {
+        return createStepRequest(thread, StepRequest.STEP_LINE, StepRequest.STEP_OVER, stepFilters);
     }
 
     /**
-     * Steps into newly pushed frames.
-     *
+     * Create a step into request on the specified thread.
      * @param thread
-     *            the target thread.
-     * @param eventHub
-     *            the {@link IEventHub} instance.
-     * @return the new {@link Location} of the execution flow of the specified
-     *         thread.
+     *              the target thread.
+     * @param stepFilters
+     *              the step filters when stepping.
+     * @return the new step request.
      */
-    public static CompletableFuture<Location> stepInto(ThreadReference thread, IEventHub eventHub) {
-        return DebugUtility.step(thread, eventHub, StepRequest.STEP_LINE, StepRequest.STEP_INTO);
+    public static StepRequest createStepIntoRequest(ThreadReference thread, String[] stepFilters) {
+        return createStepRequest(thread, StepRequest.STEP_LINE, StepRequest.STEP_INTO, stepFilters);
     }
 
     /**
-     * Steps out of the current frame.
-     *
+     * Create a step out request on the specified thread.
      * @param thread
-     *            the target thread.
-     * @param eventHub
-     *            the {@link IEventHub} instance.
-     * @return the new {@link Location} of the execution flow of the specified
-     *         thread.
+     *              the target thread.
+     * @param stepFilters
+     *              the step filters when stepping.
+     * @return the new step request.
      */
-    public static CompletableFuture<Location> stepOut(ThreadReference thread, IEventHub eventHub) {
-        return DebugUtility.step(thread, eventHub, StepRequest.STEP_LINE, StepRequest.STEP_OUT);
+    public static StepRequest createStepOutRequest(ThreadReference thread, String[] stepFilters) {
+        return createStepRequest(thread, StepRequest.STEP_LINE, StepRequest.STEP_OUT, stepFilters);
     }
 
-    private static CompletableFuture<Location> step(ThreadReference thread, IEventHub eventHub, int stepSize,
-            int stepDepth) {
-        CompletableFuture<Location> future = new CompletableFuture<>();
-
-        StepRequest request = thread.virtualMachine().eventRequestManager().createStepRequest(thread, stepSize,
-                stepDepth);
-
-        eventHub.stepEvents().filter(debugEvent -> request.equals(debugEvent.event.request())).take(1)
-                .subscribe(debugEvent -> {
-                    StepEvent event = (StepEvent) debugEvent.event;
-                    future.complete(event.location());
-                    deleteEventRequestSafely(thread.virtualMachine().eventRequestManager(), request);
-                });
+    private static StepRequest createStepRequest(ThreadReference thread, int stepSize, int stepDepth, String[] stepFilters) {
+        StepRequest request = thread.virtualMachine().eventRequestManager().createStepRequest(thread, stepSize, stepDepth);
+        if (stepFilters != null) {
+            for (String stepFilter : stepFilters) {
+                request.addClassExclusionFilter(stepFilter);
+            }
+        }
         request.setSuspendPolicy(EventRequest.SUSPEND_EVENT_THREAD);
         request.addCountFilter(1);
-        request.enable();
 
-        thread.resume();
-
-        return future;
+        return request;
     }
 
     /**

com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/DebugAdapter.java

@@ -32,6 +32,7 @@
 import com.microsoft.java.debug.core.adapter.handler.SetVariableRequestHandler;
 import com.microsoft.java.debug.core.adapter.handler.SourceRequestHandler;
 import com.microsoft.java.debug.core.adapter.handler.StackTraceRequestHandler;
+import com.microsoft.java.debug.core.adapter.handler.StepRequestHandler;
 import com.microsoft.java.debug.core.adapter.handler.ThreadsRequestHandler;
 import com.microsoft.java.debug.core.adapter.handler.VariablesRequestHandler;
 import com.microsoft.java.debug.core.protocol.IProtocolServer;
@@ -97,6 +98,7 @@ private void initialize() {
         registerHandler(new SetExceptionBreakpointsRequestHandler());
         registerHandler(new SourceRequestHandler());
         registerHandler(new ThreadsRequestHandler());
+        registerHandler(new StepRequestHandler());
         registerHandler(new StackTraceRequestHandler());
         registerHandler(new ScopesRequestHandler());
         registerHandler(new VariablesRequestHandler());

com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/DebugAdapterContext.java

@@ -19,6 +19,7 @@
 import com.microsoft.java.debug.core.adapter.variables.IVariableFormatter;
 import com.microsoft.java.debug.core.adapter.variables.VariableFormatterFactory;
 import com.microsoft.java.debug.core.protocol.IProtocolServer;
+import com.microsoft.java.debug.core.protocol.Requests.StepFilters;
 
 public class DebugAdapterContext implements IDebugAdapterContext {
     private static final int MAX_CACHE_ITEMS = 10000;
@@ -38,6 +39,7 @@ public class DebugAdapterContext implements IDebugAdapterContext {
     private transient boolean vmTerminated;
     private boolean isVmStopOnEntry = false;
     private String mainClass;
+    private StepFilters stepFilters;
 
     private IdCollection<String> sourceReferences = new IdCollection<>();
     private RecyclableObjectPool<Long, Object> recyclableIdPool = new RecyclableObjectPool<>();
@@ -212,4 +214,14 @@ public void setMainClass(String mainClass) {
     public String getMainClass() {
         return this.mainClass;
     }
+
+    @Override
+    public void setStepFilters(StepFilters stepFilters) {
+        this.stepFilters = stepFilters;
+    }
+
+    @Override
+    public StepFilters getStepFilters() {
+        return stepFilters;
+    }
 }

com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/ErrorCode.java

@@ -28,7 +28,8 @@ public enum ErrorCode {
     EMPTY_DEBUG_SESSION(1011),
     INVALID_ENCODING(1012),
     VM_TERMINATED(1013),
-    LAUNCH_IN_TERMINAL_FAILURE(1014);
+    LAUNCH_IN_TERMINAL_FAILURE(1014),
+    STEP_FAILURE(1015);
 
     private int id;
 

com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/IDebugAdapterContext.java

@@ -17,6 +17,7 @@
 import com.microsoft.java.debug.core.IDebugSession;
 import com.microsoft.java.debug.core.adapter.variables.IVariableFormatter;
 import com.microsoft.java.debug.core.protocol.IProtocolServer;
+import com.microsoft.java.debug.core.protocol.Requests.StepFilters;
 
 public interface IDebugAdapterContext {
     IProtocolServer getProtocolServer();
@@ -94,4 +95,8 @@ public interface IDebugAdapterContext {
     void setMainClass(String mainClass);
 
     String getMainClass();
+
+    void setStepFilters(StepFilters stepFilters);
+
+    StepFilters getStepFilters();
 }

com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/AttachRequestHandler.java

@@ -51,6 +51,7 @@ public CompletableFuture<Response> handle(Command command, Arguments arguments,
         context.setAttached(true);
         context.setSourcePaths(attachArguments.sourcePaths);
         context.setDebuggeeEncoding(StandardCharsets.UTF_8); // Use UTF-8 as debuggee's default encoding format.
+        context.setStepFilters(attachArguments.stepFilters);
 
         IVirtualMachineManagerProvider vmProvider = context.getProvider(IVirtualMachineManagerProvider.class);
 

com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/ConfigurationDoneRequestHandler.java

@@ -100,10 +100,6 @@ private void handleDebugEvent(DebugEvent debugEvent, IDebugSession debugSession,
                 context.getProtocolServer().sendEvent(new Events.StoppedEvent("breakpoint", bpThread.uniqueID()));
                 debugEvent.shouldResume = false;
             }
-        } else if (event instanceof StepEvent) {
-            ThreadReference stepThread = ((StepEvent) event).thread();
-            context.getProtocolServer().sendEvent(new Events.StoppedEvent("step", stepThread.uniqueID()));
-            debugEvent.shouldResume = false;
         } else if (event instanceof ExceptionEvent) {
             ThreadReference thread = ((ExceptionEvent) event).thread();
             context.getProtocolServer().sendEvent(new Events.StoppedEvent("exception", thread.uniqueID()));

com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/LaunchRequestHandler.java

@@ -84,6 +84,7 @@ public CompletableFuture<Response> handle(Command command, Arguments arguments,
         context.setSourcePaths(launchArguments.sourcePaths);
         context.setVmStopOnEntry(launchArguments.stopOnEntry);
         context.setMainClass(parseMainClassWithoutModuleName(launchArguments.mainClass));
+        context.setStepFilters(launchArguments.stepFilters);
 
         if (StringUtils.isBlank(launchArguments.encoding)) {
             context.setDebuggeeEncoding(StandardCharsets.UTF_8);