Merge pull request #120 from eclipse/msp_issue119

Send full stack trace to remote endpoint on internal error

Author: spoenemann

org.eclipse.lsp4j.jsonrpc/src/main/java/org/eclipse/lsp4j/jsonrpc/RemoteEndpoint.java

@@ -7,6 +7,8 @@
  *******************************************************************************/
 package org.eclipse.lsp4j.jsonrpc;
 
+import java.io.ByteArrayOutputStream;
+import java.io.PrintWriter;
 import java.lang.reflect.InvocationTargetException;
 import java.util.LinkedHashMap;
 import java.util.Map;
@@ -47,8 +49,13 @@ public class RemoteEndpoint implements Endpoint, MessageConsumer, MethodProvider
 		} else {
 			LOG.log(Level.SEVERE, "Internal error: " + throwable.getMessage(), throwable);
 			ResponseError error = new ResponseError();
-			error.setMessage("Internal error, please look at the server's logs.");
+			error.setMessage("Internal error.");
 			error.setCode(ResponseErrorCode.InternalError);
+			ByteArrayOutputStream stackTrace = new ByteArrayOutputStream();
+			PrintWriter stackTraceWriter = new PrintWriter(stackTrace);
+			throwable.printStackTrace(stackTraceWriter);
+			stackTraceWriter.flush();
+			error.setData(stackTrace.toString());
 			return error;
 		}
 	};

org.eclipse.lsp4j.jsonrpc/src/test/java/org/eclipse/lsp4j/jsonrpc/test/IntegrationTest.java

@@ -261,7 +261,7 @@ public void testUnknownMessages() throws Exception {
 		// intercept log messages
 		LogMessageAccumulator logMessages = new LogMessageAccumulator();
 		try {
-			logMessages.registerTo(GenericEndpoint.class.getName());
+			logMessages.registerTo(GenericEndpoint.class);
 
 			// create client messages
 			String clientMessage1 = "{\"jsonrpc\":\"2.0\","
@@ -304,7 +304,7 @@ public void testUnknownOptionalMessages() throws Exception {
 		// intercept log messages
 		LogMessageAccumulator logMessages = new LogMessageAccumulator();
 		try {
-			logMessages.registerTo(GenericEndpoint.class.getName());
+			logMessages.registerTo(GenericEndpoint.class);
 
 			// create client messages
 			String clientMessage1 = "{\"jsonrpc\":\"2.0\","
@@ -352,7 +352,7 @@ public void testUnexpectedParams() throws Exception {
 		// intercept log messages
 		LogMessageAccumulator logMessages = new LogMessageAccumulator();
 		try {
-			logMessages.registerTo(GenericEndpoint.class.getName());
+			logMessages.registerTo(GenericEndpoint.class);
 
 			// create client messages
 			String notificationMessage = "{\"jsonrpc\":\"2.0\","

org.eclipse.lsp4j.jsonrpc/src/test/java/org/eclipse/lsp4j/jsonrpc/test/LogMessageAccumulator.java

@@ -26,6 +26,10 @@ public class LogMessageAccumulator extends Handler {
 
 	private final List<Logger> registeredLoggers = new ArrayList<>();
 
+	public Logger registerTo(Class<?> clazz) {
+		return registerTo(clazz.getName());
+	}
+	
 	public Logger registerTo(String name) {
 		Logger logger = Logger.getLogger(name);
 		logger.setUseParentHandlers(false);

org.eclipse.lsp4j.jsonrpc/src/test/java/org/eclipse/lsp4j/jsonrpc/test/RemoteEndpointTest.java

@@ -117,7 +117,38 @@ public void consume(Message message) {
 		assertNotNull(error);
 		assertEquals(error.getCode(), ResponseErrorCode.RequestCancelled.getValue());
 		assertEquals(error.getMessage(), "The request (id: 1, method: 'foo') has been cancelled");
-
+	}
+	
+	@Test public void testException() {
+		LogMessageAccumulator logMessages = new LogMessageAccumulator();
+		try {
+			// Don't show the exception in the test execution log
+			logMessages.registerTo(RemoteEndpoint.class);
+			
+			TestEndpoint endp = new TestEndpoint() {
+				@Override
+				public CompletableFuture<Object> request(String method, Object parameter) {
+					throw new RuntimeException("BAAZ");
+				}
+			};
+			TestMessageConsumer consumer = new TestMessageConsumer();
+			RemoteEndpoint endpoint = new RemoteEndpoint(consumer, endp);
+			
+			endpoint.consume(new RequestMessage() {{
+				setId("1");
+				setMethod("foo");
+				setParams("myparam");
+			}});
+			
+			ResponseMessage response = (ResponseMessage) consumer.messages.get(0);
+			assertEquals("Internal error.", response.getError().getMessage());
+			assertEquals(ResponseErrorCode.InternalError.getValue(), response.getError().getCode());
+			String exception = (String) response.getError().getData();
+			String expected = "java.lang.RuntimeException: BAAZ\n\tat org.eclipse.lsp4j.jsonrpc.test.RemoteEndpointTest";
+			assertEquals(expected, exception.substring(0, expected.length()));
+		} finally {
+			logMessages.unregister();
+		}
 	}
 
 }

org.eclipse.lsp4j.jsonrpc/src/test/java/org/eclipse/lsp4j/jsonrpc/test/annotations/impl/GenericEndpointTest.java

@@ -105,7 +105,7 @@ protected void testZeroParams(Object params, Predicate<String> predicate) throws
 		try {
 			if (predicate != null) {
 				logMessages = new LogMessageAccumulator();
-				logMessages.registerTo(GenericEndpoint.class.getName());
+				logMessages.registerTo(GenericEndpoint.class);
 			}
 			GenericEndpoint endpoint = new GenericEndpoint(new Object() {
 
@@ -156,7 +156,7 @@ protected void testSingleParams(Object params, String expectedString, Predicate<
 		try {
 			if (predicate != null) {
 				logMessages = new LogMessageAccumulator();
-				logMessages.registerTo(GenericEndpoint.class.getName());
+				logMessages.registerTo(GenericEndpoint.class);
 			}
 			GenericEndpoint endpoint = new GenericEndpoint(new Object() {
 
@@ -208,7 +208,7 @@ protected void testMultiParams(Object params, String expectedString, Integer exp
 		try {
 			if (predicate != null) {
 				logMessages = new LogMessageAccumulator();
-				logMessages.registerTo(GenericEndpoint.class.getName());
+				logMessages.registerTo(GenericEndpoint.class);
 			}
 
 			GenericEndpoint endpoint = new GenericEndpoint(new Object() {