Refator IDebugSession & IProvider (microsoft#91)

yaohaizh · web-flow · commit 40b632560d93 · 2017-11-03T13:26:32.000+08:00
diff --git a/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/DebugSession.java b/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/DebugSession.java
@@ -78,12 +78,12 @@ public void terminate() {
 
     @Override
     public IBreakpoint createBreakpoint(String className, int lineNumber) {
-        return new Breakpoint(vm, this.eventHub(), className, lineNumber);
+        return new Breakpoint(vm, this.getEventHub(), className, lineNumber);
     }
 
     @Override
     public IBreakpoint createBreakpoint(String className, int lineNumber, int hitCount) {
-        return new Breakpoint(vm, this.eventHub(), className, lineNumber, hitCount);
+        return new Breakpoint(vm, this.getEventHub(), className, lineNumber, hitCount);
     }
 
     @Override
@@ -102,12 +102,17 @@ public Process process() {
     }
 
     @Override
-    public List<ThreadReference> allThreads() {
+    public List<ThreadReference> getAllThreads() {
         return vm.allThreads();
     }
 
     @Override
-    public IEventHub eventHub() {
+    public IEventHub getEventHub() {
         return eventHub;
     }
+
+    @Override
+    public VirtualMachine getVM() {
+        return vm;
+    }
 }
diff --git a/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/DebugUtility.java b/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/DebugUtility.java
@@ -228,7 +228,7 @@ public static ThreadReference getThread(IDebugSession debugSession, long threadI
     public static List<ThreadReference> getAllThreadsSafely(IDebugSession debugSession) {
         if (debugSession != null) {
             try {
-                return debugSession.allThreads();
+                return debugSession.getAllThreads();
             } catch (VMDisconnectedException ex) {
                 // do nothing.
             }
diff --git a/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/IDebugSession.java b/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/IDebugSession.java
@@ -14,6 +14,7 @@
 import java.util.List;
 
 import com.sun.jdi.ThreadReference;
+import com.sun.jdi.VirtualMachine;
 
 public interface IDebugSession {
     void start();
@@ -37,8 +38,9 @@ public interface IDebugSession {
 
     Process process();
 
-    List<ThreadReference> allThreads();
+    List<ThreadReference> getAllThreads();
 
-    IEventHub eventHub();
-}
+    IEventHub getEventHub();
 
+    VirtualMachine getVM();
+}
diff --git a/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/IProvider.java b/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/IProvider.java
@@ -11,24 +11,18 @@
 
 package com.microsoft.java.debug.core.adapter;
 
-import java.util.HashMap;
 import java.util.Map;
 
+import com.microsoft.java.debug.core.IDebugSession;
+
 public interface IProvider {
     /**
      * Initialize this provider.
-     * @param options the options
-     */
-    default void initialize(Map<String, Object> options) {
-
-    }
-
-    /**
-     * Get the default options for this provider.
-     *
-     * @return The default options.
+     * @param debugSession
+     *            The associated debug session
+     * @param options
+     *            the options
      */
-    default Map<String, Object> getDefaultOptions() {
-        return new HashMap<>();
+    default void initialize(IDebugSession debugSession, Map<String, Object> options) {
     }
 }
diff --git a/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/AttachRequestHandler.java b/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/AttachRequestHandler.java
@@ -14,6 +14,7 @@
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.logging.Logger;
@@ -50,25 +51,25 @@ public void handle(Command command, Arguments arguments, Response response, IDeb
         context.setDebuggeeEncoding(StandardCharsets.UTF_8); // Use UTF-8 as debuggee's default encoding format.
 
         IVirtualMachineManagerProvider vmProvider = context.getProvider(IVirtualMachineManagerProvider.class);
-        ISourceLookUpProvider sourceProvider = context.getProvider(ISourceLookUpProvider.class);
-        Map<String, Object> options = sourceProvider.getDefaultOptions();
-        options.put(Constants.DEBUGGEE_ENCODING, context.getDebuggeeEncoding());
-        if (attachArguments.projectName != null) {
-            options.put(Constants.PROJECTNAME, attachArguments.projectName);
-        }
-        sourceProvider.initialize(options);
 
         try {
-            logger.info(String.format("Trying to attach to remote debuggee VM %s:%d .",
-                    attachArguments.hostName, attachArguments.port));
-            IDebugSession debugSession = DebugUtility.attach(vmProvider.getVirtualMachineManager(),
-                    attachArguments.hostName, attachArguments.port, attachArguments.timeout);
+            logger.info(String.format("Trying to attach to remote debuggee VM %s:%d .", attachArguments.hostName, attachArguments.port));
+            IDebugSession debugSession = DebugUtility.attach(vmProvider.getVirtualMachineManager(), attachArguments.hostName, attachArguments.port,
+                    attachArguments.timeout);
             context.setDebugSession(debugSession);
             logger.info("Attaching to debuggee VM succeeded.");
         } catch (IOException | IllegalConnectorArgumentsException e) {
             AdapterUtils.setErrorResponse(response, ErrorCode.ATTACH_FAILURE,
                     String.format("Failed to attach to remote debuggee VM. Reason: %s", e.toString()));
         }
+
+        Map<String, Object> options = new HashMap<>();
+        options.put(Constants.DEBUGGEE_ENCODING, context.getDebuggeeEncoding());
+        if (attachArguments.projectName != null) {
+            options.put(Constants.PROJECTNAME, attachArguments.projectName);
+        }
+        ISourceLookUpProvider sourceProvider = context.getProvider(ISourceLookUpProvider.class);
+        sourceProvider.initialize(context.getDebugSession(), options);
     }
 
 }
diff --git a/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/ConfigurationDoneRequestHandler.java b/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/ConfigurationDoneRequestHandler.java
@@ -48,7 +48,7 @@ public void handle(Command command, Arguments arguments, Response response, IDeb
         IDebugSession debugSession = context.getDebugSession();
         if (debugSession != null) {
             // This is a global event handler to handle the JDI Event from Virtual Machine.
-            debugSession.eventHub().events().subscribe(debugEvent -> {
+            debugSession.getEventHub().events().subscribe(debugEvent -> {
                 handleDebugEvent(debugEvent, debugSession, context);
             });
             // configuration is done, and start debug session.
@@ -72,7 +72,7 @@ private void handleDebugEvent(DebugEvent debugEvent, IDebugSession debugSession,
             context.sendEventAsync(new Events.TerminatedEvent());
             // Terminate eventHub thread.
             try {
-                debugSession.eventHub().close();
+                debugSession.getEventHub().close();
             } catch (Exception e) {
                 // do nothing.
             }
diff --git a/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/LaunchRequestHandler.java b/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/LaunchRequestHandler.java
@@ -87,13 +87,7 @@ public void handle(Command command, Arguments arguments, Response response, IDeb
 
 
         IVirtualMachineManagerProvider vmProvider = context.getProvider(IVirtualMachineManagerProvider.class);
-        ISourceLookUpProvider sourceProvider = context.getProvider(ISourceLookUpProvider.class);
-        Map<String, Object> options = sourceProvider.getDefaultOptions();
-        options.put(Constants.DEBUGGEE_ENCODING, context.getDebuggeeEncoding());
-        if (launchArguments.projectName != null) {
-            options.put(Constants.PROJECTNAME, launchArguments.projectName);
-        }
-        sourceProvider.initialize(options);
+
 
         // Append environment to native environment.
         String[] envVars = null;
@@ -142,5 +136,13 @@ public void handle(Command command, Arguments arguments, Response response, IDeb
             AdapterUtils.setErrorResponse(response, ErrorCode.LAUNCH_FAILURE,
                     String.format("Failed to launch debuggee VM. Reason: %s", e.toString()));
         }
+
+        ISourceLookUpProvider sourceProvider = context.getProvider(ISourceLookUpProvider.class);
+        Map<String, Object> options = new HashMap<>();
+        options.put(Constants.DEBUGGEE_ENCODING, context.getDebuggeeEncoding());
+        if (launchArguments.projectName != null) {
+            options.put(Constants.PROJECTNAME, launchArguments.projectName);
+        }
+        sourceProvider.initialize(context.getDebugSession(), options);
     }
 }
diff --git a/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/ThreadsRequestHandler.java b/com.microsoft.java.debug.core/src/main/java/com/microsoft/java/debug/core/adapter/handler/ThreadsRequestHandler.java
@@ -77,7 +77,7 @@ public void handle(Command command, Arguments arguments, Response response, IDeb
     private void threads(Requests.ThreadsArguments arguments, Response response, IDebugAdapterContext context) {
         ArrayList<Types.Thread> threads = new ArrayList<>();
         try {
-            for (ThreadReference thread : context.getDebugSession().allThreads()) {
+            for (ThreadReference thread : context.getDebugSession().getAllThreads()) {
                 if (thread.isCollected()) {
                     continue;
                 }
@@ -94,23 +94,23 @@ private void threads(Requests.ThreadsArguments arguments, Response response, IDe
     private void stepIn(Requests.StepInArguments arguments, Response response, IDebugAdapterContext context) {
         ThreadReference thread = DebugUtility.getThread(context.getDebugSession(), arguments.threadId);
         if (thread != null) {
-            DebugUtility.stepInto(thread, context.getDebugSession().eventHub());
+            DebugUtility.stepInto(thread, context.getDebugSession().getEventHub());
             checkThreadRunningAndRecycleIds(thread, context);
         }
     }
 
     private void stepOut(Requests.StepOutArguments arguments, Response response, IDebugAdapterContext context) {
         ThreadReference thread = DebugUtility.getThread(context.getDebugSession(), arguments.threadId);
         if (thread != null) {
-            DebugUtility.stepOut(thread, context.getDebugSession().eventHub());
+            DebugUtility.stepOut(thread, context.getDebugSession().getEventHub());
             checkThreadRunningAndRecycleIds(thread, context);
         }
     }
 
     private void next(Requests.NextArguments arguments, Response response, IDebugAdapterContext context) {
         ThreadReference thread = DebugUtility.getThread(context.getDebugSession(), arguments.threadId);
         if (thread != null) {
-            DebugUtility.stepOver(thread, context.getDebugSession().eventHub());
+            DebugUtility.stepOver(thread, context.getDebugSession().getEventHub());
             checkThreadRunningAndRecycleIds(thread, context);
         }
     }
diff --git a/com.microsoft.java.debug.core/src/test/java/com/microsoft/java/debug/core/AbstractJdiTestCase.java b/com.microsoft.java.debug.core/src/test/java/com/microsoft/java/debug/core/AbstractJdiTestCase.java
@@ -43,7 +43,7 @@ protected BreakpointEvent waitForBreakPointEvent(String breakpointAtClass, int l
             System.out.println("Breakpoint is accepted.");
         });
         debugSession.start();
-        debugSession.eventHub().breakpointEvents().subscribe(breakpoint -> {
+        debugSession.getEventHub().breakpointEvents().subscribe(breakpoint -> {
             System.out.println("Breakpoint is hit.");
             breakpoint.shouldResume = false;
             staticBreakpointEvent = (BreakpointEvent) breakpoint.event;
diff --git a/com.microsoft.java.debug.core/src/test/java/com/microsoft/java/debug/core/DebugSessionFactory.java b/com.microsoft.java.debug.core/src/test/java/com/microsoft/java/debug/core/DebugSessionFactory.java
@@ -53,10 +53,10 @@ public static IDebugSession getDebugSession(String projectName, String mainClass
             try {
                 final IDebugSession debugSession = DebugUtility.launch(Bootstrap.virtualMachineManager(), mainClass, "", "",
                         new File(projectRoot, "bin").getAbsolutePath(), null, null);
-                debugSession.eventHub().events().subscribe(debugEvent -> {
+                debugSession.getEventHub().events().subscribe(debugEvent -> {
                     if (debugEvent.event instanceof VMDisconnectEvent) {
                         try {
-                            debugSession.eventHub().close();
+                            debugSession.getEventHub().close();
                         } catch (Exception e) {
                             // do nothing.
                         }
diff --git a/com.microsoft.java.debug.plugin/src/main/java/com/microsoft/java/debug/plugin/internal/JdtSourceLookUpProvider.java b/com.microsoft.java.debug.plugin/src/main/java/com/microsoft/java/debug/plugin/internal/JdtSourceLookUpProvider.java
@@ -55,6 +55,7 @@
 
 import com.microsoft.java.debug.core.Configuration;
 import com.microsoft.java.debug.core.DebugException;
+import com.microsoft.java.debug.core.IDebugSession;
 import com.microsoft.java.debug.core.adapter.AdapterUtils;
 import com.microsoft.java.debug.core.adapter.Constants;
 import com.microsoft.java.debug.core.adapter.ISourceLookUpProvider;
@@ -64,14 +65,14 @@ public class JdtSourceLookUpProvider implements ISourceLookUpProvider {
     private static final String JDT_SCHEME = "jdt";
     private static final String PATH_SEPARATOR = "/";
 
-    private HashMap<String, Object> context = new HashMap<String, Object>();
+    private HashMap<String, Object> options = new HashMap<String, Object>();
 
     @Override
-    public void initialize(Map<String, Object> props) {
+    public void initialize(IDebugSession debugSession, Map<String, Object> props) {
         if (props == null) {
             throw new IllegalArgumentException("argument is null");
         }
-        context.putAll(props);
+        options.putAll(props);
     }
 
     @Override
@@ -110,7 +111,7 @@ public String[] getFullyQualifiedName(String uri, int[] lines, int[] columns) th
         String filePath = AdapterUtils.toPath(uri);
         // For file uri, read the file contents directly and pass them to the ast parser.
         if (filePath != null && Files.isRegularFile(Paths.get(filePath))) {
-            Charset cs = (Charset) this.context.get(Constants.DEBUGGEE_ENCODING);
+            Charset cs = (Charset) this.options.get(Constants.DEBUGGEE_ENCODING);
             if (cs == null) {
                 cs = Charset.defaultCharset();
             }
@@ -130,11 +131,11 @@ public String[] getFullyQualifiedName(String uri, int[] lines, int[] columns) th
              * See the java doc for { @link ASTParser#setSource(char[]) },
              * the user need specify the compiler options explicitly.
              */
-            Map<String, String> options = JavaCore.getOptions();
-            options.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_1_8);
-            options.put(JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM, JavaCore.VERSION_1_8);
-            options.put(JavaCore.COMPILER_COMPLIANCE, JavaCore.VERSION_1_8);
-            parser.setCompilerOptions(options);
+            Map<String, String> javaOptions = JavaCore.getOptions();
+            javaOptions.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_1_8);
+            javaOptions.put(JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM, JavaCore.VERSION_1_8);
+            javaOptions.put(JavaCore.COMPILER_COMPLIANCE, JavaCore.VERSION_1_8);
+            parser.setCompilerOptions(javaOptions);
             astUnit = (CompilationUnit) parser.createAST(null);
         } else {
             // For non-file uri (e.g. jdt://contents/rt.jar/java.io/PrintStream.class),
@@ -223,7 +224,7 @@ private IJavaProject getJavaProjectFromName(String projectName) throws CoreExcep
     }
 
     private String searchDeclarationFileByFqn(String fullyQualifiedName) {
-        String projectName = (String) context.get(Constants.PROJECTNAME);
+        String projectName = (String) options.get(Constants.PROJECTNAME);
         try {
             IJavaSearchScope searchScope = projectName != null
                 ? createSearchScope(getJavaProjectFromName(projectName))
diff --git a/com.microsoft.java.debug.plugin/src/main/java/com/microsoft/java/debug/plugin/internal/JdtVirtualMachineManagerProvider.java b/com.microsoft.java.debug.plugin/src/main/java/com/microsoft/java/debug/plugin/internal/JdtVirtualMachineManagerProvider.java
@@ -11,8 +11,6 @@
 
 package com.microsoft.java.debug.plugin.internal;
 
-import java.util.Map;
-
 import com.microsoft.java.debug.core.adapter.IVirtualMachineManagerProvider;
 import com.sun.jdi.VirtualMachineManager;
 
@@ -26,8 +24,4 @@ public synchronized VirtualMachineManager getVirtualMachineManager() {
         }
         return vmManager;
     }
-
-    @Override
-    public void initialize(Map<String, Object> props) {
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -78,12 +78,12 @@ public void terminate() {`
`78`	`78`
`79`	`79`	`@Override`
`80`	`80`	`public IBreakpoint createBreakpoint(String className, int lineNumber) {`
`81`		`- return new Breakpoint(vm, this.eventHub(), className, lineNumber);`
	`81`	`+ return new Breakpoint(vm, this.getEventHub(), className, lineNumber);`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`@Override`
`85`	`85`	`public IBreakpoint createBreakpoint(String className, int lineNumber, int hitCount) {`
`86`		`- return new Breakpoint(vm, this.eventHub(), className, lineNumber, hitCount);`
	`86`	`+ return new Breakpoint(vm, this.getEventHub(), className, lineNumber, hitCount);`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`@Override`
`@@ -102,12 +102,17 @@ public Process process() {`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`@Override`
`105`		`- public List<ThreadReference> allThreads() {`
	`105`	`+ public List<ThreadReference> getAllThreads() {`
`106`	`106`	`return vm.allThreads();`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`@Override`
`110`		`- public IEventHub eventHub() {`
	`110`	`+ public IEventHub getEventHub() {`
`111`	`111`	`return eventHub;`
`112`	`112`	`}`
	`113`	`+`
	`114`	`+ @Override`
	`115`	`+ public VirtualMachine getVM() {`
	`116`	`+ return vm;`
	`117`	`+ }`
`113`	`118`	`}`
Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,7 @@ public static ThreadReference getThread(IDebugSession debugSession, long threadI`
`228`	`228`	`public static List<ThreadReference> getAllThreadsSafely(IDebugSession debugSession) {`
`229`	`229`	`if (debugSession != null) {`
`230`	`230`	`try {`
`231`		`- return debugSession.allThreads();`
	`231`	`+ return debugSession.getAllThreads();`
`232`	`232`	`} catch (VMDisconnectedException ex) {`
`233`	`233`	`// do nothing.`
`234`	`234`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public void handle(Command command, Arguments arguments, Response response, IDeb`
`77`	`77`	`private void threads(Requests.ThreadsArguments arguments, Response response, IDebugAdapterContext context) {`
`78`	`78`	`ArrayList<Types.Thread> threads = new ArrayList<>();`
`79`	`79`	`try {`
`80`		`- for (ThreadReference thread : context.getDebugSession().allThreads()) {`
	`80`	`+ for (ThreadReference thread : context.getDebugSession().getAllThreads()) {`
`81`	`81`	`if (thread.isCollected()) {`
`82`	`82`	`continue;`
`83`	`83`	`}`
`@@ -94,23 +94,23 @@ private void threads(Requests.ThreadsArguments arguments, Response response, IDe`
`94`	`94`	`private void stepIn(Requests.StepInArguments arguments, Response response, IDebugAdapterContext context) {`
`95`	`95`	`ThreadReference thread = DebugUtility.getThread(context.getDebugSession(), arguments.threadId);`
`96`	`96`	`if (thread != null) {`
`97`		`- DebugUtility.stepInto(thread, context.getDebugSession().eventHub());`
	`97`	`+ DebugUtility.stepInto(thread, context.getDebugSession().getEventHub());`
`98`	`98`	`checkThreadRunningAndRecycleIds(thread, context);`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`private void stepOut(Requests.StepOutArguments arguments, Response response, IDebugAdapterContext context) {`
`103`	`103`	`ThreadReference thread = DebugUtility.getThread(context.getDebugSession(), arguments.threadId);`
`104`	`104`	`if (thread != null) {`
`105`		`- DebugUtility.stepOut(thread, context.getDebugSession().eventHub());`
	`105`	`+ DebugUtility.stepOut(thread, context.getDebugSession().getEventHub());`
`106`	`106`	`checkThreadRunningAndRecycleIds(thread, context);`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`private void next(Requests.NextArguments arguments, Response response, IDebugAdapterContext context) {`
`111`	`111`	`ThreadReference thread = DebugUtility.getThread(context.getDebugSession(), arguments.threadId);`
`112`	`112`	`if (thread != null) {`
`113`		`- DebugUtility.stepOver(thread, context.getDebugSession().eventHub());`
	`113`	`+ DebugUtility.stepOver(thread, context.getDebugSession().getEventHub());`
`114`	`114`	`checkThreadRunningAndRecycleIds(thread, context);`
`115`	`115`	`}`
`116`	`116`	`}`