Fix binary evaluation compilation failures #275

The changeset tries to generate missing constructors and add imports for variable type that are visible in the evaluation __run method.
eclipse-jdt · Jul 9, 2023 · 6260d38 · 6260d38
1 parent fba705b
commit 6260d38
Show file tree

Hide file tree

Showing 6 changed files with 92 additions and 10 deletions.
diff --git a/org.eclipse.jdt.debug.tests/java8/GH275.java b/org.eclipse.jdt.debug.tests/java8/GH275.java
@@ -0,0 +1,9 @@
+import com.debug.test.Subject;
+import com.debug.test.Observation;
+
+public class GH275 {
+	public static void main(String[] args) {
+		Subject subject = new Subject("Name 1");
+		Observation.start(() -> subject, sub -> System.out.println(sub)).observe();
+	}
+}
diff --git a/org.eclipse.jdt.debug.tests/testjars/gh275/debug-lib-sources.jar b/org.eclipse.jdt.debug.tests/testjars/gh275/debug-lib-sources.jar
diff --git a/org.eclipse.jdt.debug.tests/testjars/gh275/debug-lib.jar b/org.eclipse.jdt.debug.tests/testjars/gh275/debug-lib.jar
diff --git a/org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/AbstractDebugTest.java b/org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/AbstractDebugTest.java
@@ -462,6 +462,9 @@ synchronized void assert18Project() {
         try {
 	        if (!loaded18) {
 	        	jp = createProject(ONE_EIGHT_PROJECT_NAME, JavaProjectHelper.TEST_1_8_SRC_DIR.toString(), JavaProjectHelper.JAVA_SE_1_8_EE_NAME, false);
+				IPath lib = new Path(JavaTestPlugin.getDefault().getFileInPlugin(new Path("testjars").append("gh275").append("debug-lib.jar")).getAbsolutePath());
+				JavaProjectHelper.addLibrary(jp, lib);
+
 	    		cfgs.add(createLaunchConfiguration(jp, "EvalTest18"));
 	    		cfgs.add(createLaunchConfiguration(jp, "FunctionalCaptureTest18"));
 	    		cfgs.add(createLaunchConfiguration(jp, "EvalTestIntf18"));
@@ -500,6 +503,7 @@ synchronized void assert18Project() {
 				cfgs.add(createLaunchConfiguration(jp, "Bug578145LambdaInAnonymous"));
 				cfgs.add(createLaunchConfiguration(jp, "Bug578145LambdaOnChainCalls"));
 				cfgs.add(createLaunchConfiguration(jp, "LambdaBreakpoints1"));
+				cfgs.add(createLaunchConfiguration(jp, "GH275"));
 	    		loaded18 = true;
 	    		waitForBuild();
 	        }

diff --git a/org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/eval/Java8Tests.java b/org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/eval/Java8Tests.java
@@ -241,4 +241,38 @@ public void testContextEvaluations() throws Exception {
 		}
 	}
 
+	public void testEvaluate_GH275_StaticBinaryMethod_EvaluateSnippetWithImportedTypes() throws Exception {
+		IJavaThread javaThread = null;
+		try {
+			IJavaLineBreakpoint bp = createLineBreakpoint(getType("com.debug.test.Observation"), 25);
+			javaThread = launchToLineBreakpoint("GH275", bp);
+			assertNotNull("The program did not suspend", javaThread);
+
+			String snippet = "new Observation((Object) subject, (Consumer) action)";
+			IValue value = doEval(javaThread, snippet);
+
+			assertNotNull("value is null", value);
+		} finally {
+			removeAllBreakpoints();
+			terminateAndRemove(javaThread);
+		}
+	}
+
+	public void testEvaluate_GH275_InstanceBinaryMethod_EvaluateSnippetWithImportedTypes() throws Exception {
+		IJavaThread javaThread = null;
+		try {
+			IJavaLineBreakpoint bp = createLineBreakpoint(getType("com.debug.test.Observation"), 19);
+			javaThread = launchToLineBreakpoint("GH275", bp);
+			assertNotNull("The program did not suspend", javaThread);
+
+			String snippet = "((Subject)this.subject).getName()";
+			IValue value = doEval(javaThread, snippet);
+
+			assertNotNull("value is null", value);
+			assertEquals("Return value doesn't match", "Name 1", value.getValueString());
+		} finally {
+			removeAllBreakpoints();
+			terminateAndRemove(javaThread);
+		}
+	}
 }
diff --git a/...debug/eval/org/eclipse/jdt/internal/debug/eval/ast/engine/BinaryBasedSourceGenerator.java b/...debug/eval/org/eclipse/jdt/internal/debug/eval/ast/engine/BinaryBasedSourceGenerator.java
@@ -14,8 +14,11 @@
  *******************************************************************************/
 package org.eclipse.jdt.internal.debug.eval.ast.engine;
 
+import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 import org.eclipse.jdt.core.Signature;
 import org.eclipse.jdt.debug.core.IJavaReferenceType;
@@ -50,6 +53,8 @@ public class BinaryBasedSourceGenerator {
 
 	private String fCompilationUnitName;
 
+	private Set<String> fImports;
+
 	/**
 	 * Level of source code to generate (major, minor). For example 1 and 4
 	 * indicates 1.4.
@@ -63,6 +68,7 @@ public BinaryBasedSourceGenerator(String[] localTypesNames,
 		fLocalVariableTypeNames = localTypesNames;
 		fLocalVariableNames = localVariables;
 		fIsInStaticMethod = isInStaticMethod;
+		fImports = new HashSet<>();
 		int index = sourceLevel.indexOf('.');
 		String num;
 		if (index != -1) {
@@ -101,9 +107,16 @@ public void buildSourceStatic(IJavaReferenceType type) {
 		fSource = buildTypeDeclaration(refType, buildRunMethod(refType), null,
 				false);
 		String packageName = getPackageName(refType.name());
+		int packageEndPos = 0;
 		if (packageName != null) {
 			fSource.insert(0, "package " + packageName + ";\n"); //$NON-NLS-1$ //$NON-NLS-2$
-			fCodeSnippetPosition += 10 + packageName.length();
+			packageEndPos = 10 + packageName.length();
+			fCodeSnippetPosition += packageEndPos;
+		}
+		if (!fImports.isEmpty()) {
+			String importBlock = fImports.stream().collect(Collectors.joining(";\nimport ", "import ", ";")).concat("\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
+			fSource.insert(packageEndPos, importBlock);
+			fCodeSnippetPosition += importBlock.length();
 		}
 		fCompilationUnitName = getSimpleName(refType.name());
 	}
@@ -128,7 +141,9 @@ private StringBuilder buildRunMethod(ReferenceType type) {
 		source.append(getUniqueMethodName(RUN_METHOD_NAME, type));
 		source.append('(');
 		for (int i = 0, length = fLocalVariableNames.length; i < length; i++) {
-			source.append(getDotName(fLocalVariableTypeNames[i]));
+			String varType = getDotName(fLocalVariableTypeNames[i]);
+			addToImports(varType);
+			source.append(varType);
 			source.append(' ');
 			source.append(fLocalVariableNames[i]);
 			if (i + 1 < length)
@@ -147,6 +162,12 @@ private StringBuilder buildRunMethod(ReferenceType type) {
 		return source;
 	}
 
+	private void addToImports(String type) {
+		if (!type.equals(getSimpleName(type))) {
+			fImports.add(Signature.getTypeErasure(type));
+		}
+	}
+
 	private StringBuilder buildTypeDeclaration(ReferenceType referenceType,
 			StringBuilder buffer, String nestedTypeName) {
 
@@ -164,9 +185,16 @@ private StringBuilder buildTypeDeclaration(ReferenceType referenceType,
 
 		if (thisField == null) {
 			String packageName = getPackageName(referenceType.name());
+			int packageEndPos = 0;
 			if (packageName != null) {
 				source.insert(0, "package " + packageName + ";\n"); //$NON-NLS-1$ //$NON-NLS-2$
-				fCodeSnippetPosition += 10 + packageName.length();
+				packageEndPos = 10 + packageName.length();
+				fCodeSnippetPosition += packageEndPos;
+			}
+			if (!fImports.isEmpty()) {
+				String importBlock = fImports.stream().collect(Collectors.joining(";\nimport ", "import ", ";")).concat("\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
+				source.insert(packageEndPos, importBlock);
+				fCodeSnippetPosition += importBlock.length();
 			}
 			if (isAnonymousTypeName(referenceType.name())) {
 				fCompilationUnitName = ANONYMOUS_CLASS_NAME;
@@ -338,6 +366,8 @@ && isSourceLevelGreaterOrEqual(1, 5)) {
 			if (!method.isConstructor() && !method.isStaticInitializer()
 				&& !method.isBridge()) {
 				source.append(buildMethodDeclaration(method));
+			} else if (method.isConstructor()) {
+				source.append(buildMethodDeclaration(method, getSimpleName(referenceType.name())));
 			}
 		}
 
@@ -394,6 +424,10 @@ private StringBuilder buildFieldDeclaration(Field field) {
 	}
 
 	private StringBuilder buildMethodDeclaration(Method method) {
+		return buildMethodDeclaration(method, null);
+	}
+
+	private StringBuilder buildMethodDeclaration(Method method, String methodName) {
 		StringBuilder source = new StringBuilder();
 
 		if (method.isFinal()) {
@@ -444,11 +478,10 @@ private StringBuilder buildMethodDeclaration(Method method) {
 				source.append("> "); //$NON-NLS-1$
 			}
 
-			source.append(
-					Signature.toString(
-							Signature.getReturnType(genericSignature)).replace(
-							'/', '.')).append(' ').append(method.name())
-					.append('(');
+			if (!method.isConstructor()) {
+				source.append(Signature.toString(Signature.getReturnType(genericSignature)).replace('/', '.')).append(' ');
+			}
+			source.append((methodName == null) ? method.name() : methodName).append('(');
 
 			String[] parameterTypes = Signature
 					.getParameterTypes(genericSignature);
@@ -481,8 +514,10 @@ private StringBuilder buildMethodDeclaration(Method method) {
 			}
 			source.append(')');
 		} else {
-			source.append(getDotName(method.returnTypeName())).append(' ')
-					.append(method.name()).append('(');
+			if (!method.isConstructor()) {
+				source.append(getDotName(method.returnTypeName())).append(' ');
+			}
+			source.append((methodName == null) ? method.name() : methodName).append('(');
 
 			List<String> arguments = method.argumentTypeNames();
 			int i = 0;