[GR-41843] Prevent from NPE when client is not connected yet.

PullRequest: graal/12937

Author: entlicher

tools/src/com.oracle.truffle.tools.dap.test/src/com/oracle/truffle/tools/dap/test/DAPTestInstrument.java

@@ -47,7 +47,7 @@ public class DAPTestInstrument extends TruffleInstrument {
     protected void onCreate(final Env env) {
         env.registerService(new DAPSessionHandlerProvider() {
             @Override
-            public DAPSessionHandler getSessionHandler(final boolean suspend, final boolean inspectInternal, final boolean inspectInitialization) throws IOException {
+            public DAPSessionHandler getSessionHandler(final boolean suspend, final boolean inspectInternal, final boolean inspectInitialization, Runnable prolog) throws IOException {
                 return new DAPSessionHandler() {
 
                     private PipedOutputStream out;
@@ -59,7 +59,11 @@ DAPSessionHandler init() throws IOException {
                         this.out = new PipedOutputStream();
                         PipedOutputStream pos = new PipedOutputStream();
                         in = new PipedInputStream(pos, 2048);
-                        DebugProtocolServer.Session.connect(DebugProtocolServerImpl.create(context, suspend, inspectInternal, inspectInitialization), new PipedInputStream(this.out, 2048), pos,
+                        DebugProtocolServerImpl dapServer = DebugProtocolServerImpl.create(context, suspend, inspectInternal, inspectInitialization);
+                        if (prolog != null) {
+                            prolog.run();
+                        }
+                        DebugProtocolServer.Session.connect(dapServer, new PipedInputStream(this.out, 2048), pos,
                                         Executors.newSingleThreadExecutor());
                         return this;
                     }
@@ -81,7 +85,7 @@ public InputStream getInputStream() {
 }
 
 interface DAPSessionHandlerProvider {
-    DAPSessionHandler getSessionHandler(boolean suspend, boolean inspectInternal, boolean inspectInitialization) throws IOException;
+    DAPSessionHandler getSessionHandler(boolean suspend, boolean inspectInternal, boolean inspectInitialization, Runnable prolog) throws IOException;
 }
 
 interface DAPSessionHandler {

tools/src/com.oracle.truffle.tools.dap.test/src/com/oracle/truffle/tools/dap/test/DAPTester.java

@@ -41,6 +41,7 @@
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
 import org.graalvm.polyglot.Context;
@@ -62,18 +63,33 @@ public final class DAPTester {
     private final Context context;
     private Future<Value> lastValue;
 
-    private DAPTester(DAPSessionHandler handler, Engine engine) {
+    private DAPTester(DAPSessionHandler handler, Context context) {
         this.handler = handler;
-        this.context = Context.newBuilder().engine(engine).allowAllAccess(true).build();
+        this.context = context;
     }
 
     public static DAPTester start(boolean suspend) throws IOException {
+        return start(suspend, null);
+    }
+
+    public static DAPTester start(boolean suspend, Consumer<Context> prolog) throws IOException {
         final ProxyOutputStream err = new ProxyOutputStream(System.err);
         Engine engine = Engine.newBuilder().err(err).build();
+        Context context = Context.newBuilder().engine(engine).allowAllAccess(true).build();
+        Runnable runProlog;
+        if (prolog != null) {
+            runProlog = () -> prolog.accept(context);
+        } else {
+            runProlog = null;
+        }
         Instrument testInstrument = engine.getInstruments().get(DAPTestInstrument.ID);
         DAPSessionHandlerProvider sessionHandlerProvider = testInstrument.lookup(DAPSessionHandlerProvider.class);
-        DAPSessionHandler sessionHandler = sessionHandlerProvider.getSessionHandler(suspend, false, false);
-        return new DAPTester(sessionHandler, engine);
+        DAPSessionHandler sessionHandler = sessionHandlerProvider.getSessionHandler(suspend, false, false, runProlog);
+        return new DAPTester(sessionHandler, context);
+    }
+
+    Context getContext() {
+        return context;
     }
 
     public void finish() throws IOException {

tools/src/com.oracle.truffle.tools.dap.test/src/com/oracle/truffle/tools/dap/test/ITLDAPTest.java

@@ -133,6 +133,52 @@ public void testOutput() throws Exception {
         tester.finish();
     }
 
+    @Test
+    public void testOutputEarly() throws Exception {
+        Source source1 = Source.newBuilder(InstrumentationTestLanguage.ID, "ROOT(\n" +
+                        "  PRINT(OUT, \"Prologue to stdout\n\"),\n" +
+                        "  PRINT(ERR, \"Prologue to stderr\n\")" +
+                        ")\n", "TestOutput1.itl").internal(true).build();
+        Source source2 = Source.newBuilder(InstrumentationTestLanguage.ID, "ROOT(\n" +
+                        "  PRINT(OUT, \"Text to stdout\n\"),\n" +
+                        "  PRINT(ERR, \"Text to stderr\n\")" +
+                        ")\n", "TestOutput2.itl").build();
+        Source source3 = Source.newBuilder(InstrumentationTestLanguage.ID, "ROOT(\n" +
+                        "  PRINT(OUT, \"Epilogue to stdout\n\"),\n" +
+                        "  PRINT(ERR, \"Epilogue to stderr\n\")" +
+                        ")\n", "TestOutput3.itl").build();
+        tester = DAPTester.start(false, context -> context.eval(source1));
+        tester.sendMessage(
+                        "{\"command\":\"initialize\",\"arguments\":{\"clientID\":\"DAPTester\",\"clientName\":\"DAP Tester\",\"adapterID\":\"graalvm\",\"pathFormat\":\"path\",\"linesStartAt1\":true,\"columnsStartAt1\":true," +
+                                        "\"supportsVariableType\":true,\"supportsVariablePaging\":true,\"supportsRunInTerminalRequest\":true,\"locale\":\"en-us\",\"supportsProgressReporting\":true},\"type\":\"request\",\"seq\":1}");
+        tester.compareReceivedMessages(
+                        "{\"event\":\"initialized\",\"type\":\"event\"}",
+                        "{\"success\":true,\"type\":\"response\",\"body\":{\"supportsConditionalBreakpoints\":true,\"supportsLoadedSourcesRequest\":true,\"supportsFunctionBreakpoints\":true,\"supportsExceptionInfoRequest\":true," +
+                                        "\"supportsBreakpointLocationsRequest\":true,\"supportsHitConditionalBreakpoints\":true,\"supportsLogPoints\":true,\"supportsSetVariable\":true,\"supportsConfigurationDoneRequest\":true," +
+                                        "\"exceptionBreakpointFilters\":[{\"filter\":\"all\",\"label\":\"All Exceptions\"},{\"filter\":\"uncaught\",\"label\":\"Uncaught Exceptions\"}]},\"request_seq\":1,\"command\":\"initialize\"}");
+        tester.sendMessage(
+                        "{\"command\":\"attach\",\"arguments\":{\"type\":\"graalvm\",\"request\":\"attach\",\"name\":\"Attach\",\"port\":9229,\"protocol\":\"debugAdapter\"},\"type\":\"request\",\"seq\":2}");
+        tester.compareReceivedMessages("{\"event\":\"output\",\"body\":{\"output\":\"Debugger attached.\",\"category\":\"stderr\"},\"type\":\"event\"}",
+                        "{\"success\":true,\"type\":\"response\",\"request_seq\":2,\"command\":\"attach\"}");
+        tester.sendMessage("{\"command\":\"loadedSources\",\"type\":\"request\",\"seq\":3}");
+        tester.compareReceivedMessages("{\"success\":true,\"body\":{\"sources\":[]},\"type\":\"response\",\"request_seq\":3,\"command\":\"loadedSources\",\"seq\":5}");
+        tester.sendMessage("{\"command\":\"configurationDone\",\"type\":\"request\",\"seq\":4}");
+        tester.compareReceivedMessages("{\"success\":true,\"type\":\"response\",\"request_seq\":4,\"command\":\"configurationDone\",\"seq\":6}");
+        tester.eval(source2);
+        tester.compareReceivedMessages("{\"event\":\"thread\",\"body\":{\"threadId\":2,\"reason\":\"started\"},\"type\":\"event\",\"seq\":7}");
+        tester.compareReceivedMessages(
+                        "{\"event\":\"loadedSource\",\"body\":{\"reason\":\"new\",\"source\":{\"sourceReference\":1,\"name\":\"TestOutput2.itl\"}},\"type\":\"event\",\"seq\":8}");
+        tester.compareReceivedMessages(
+                        "{\"event\":\"output\",\"body\":{\"output\":\"Text to stdout\\n\",\"category\":\"stdout\"},\"type\":\"event\",\"seq\":9}");
+        tester.compareReceivedMessages(
+                        "{\"event\":\"output\",\"body\":{\"output\":\"Text to stderr\\n\",\"category\":\"stderr\"},\"type\":\"event\",\"seq\":10}");
+        tester.sendMessage("{\"command\":\"disconnect\",\"arguments\":{\"restart\":false},\"type\":\"request\",\"seq\":11}");
+        tester.compareReceivedMessages(
+                        "{\"success\":true,\"type\":\"response\",\"request_seq\":11,\"command\":\"disconnect\",\"seq\":11}");
+        tester.finish();
+        tester.getContext().eval(source3);
+    }
+
     @Test
     public void testMultiThreading() throws Exception {
         Source source = Source.newBuilder(InstrumentationTestLanguage.ID, new URL("file:///path/TestThreads.itl")).content("ROOT(\n" +

tools/src/com.oracle.truffle.tools.dap/src/com/oracle/truffle/tools/dap/server/DebugProtocolServerImpl.java

@@ -707,9 +707,12 @@ private class ConsoleOutputListener implements OutputHandler.Listener {
 
         @Override
         public void outputText(String text) {
-            OutputEvent.EventBody event = OutputEvent.EventBody.create(text);
-            event.setCategory(category);
-            context.getClient().output(event);
+            DebugProtocolClient debugClient = context.getClient();
+            if (client != null) {
+                OutputEvent.EventBody event = OutputEvent.EventBody.create(text);
+                event.setCategory(category);
+                debugClient.output(event);
+            }
         }
     }