Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix JDK 20-ea build compatibility #3610

Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@
import static com.google.errorprone.refaster.Unifier.unifications;

import com.google.auto.value.AutoValue;
import com.google.common.base.VerifyException;
import com.google.errorprone.util.RuntimeVersion;
import com.sun.source.tree.EnhancedForLoopTree;
import com.sun.source.tree.Tree;
import com.sun.source.tree.TreeVisitor;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.JCTree.JCEnhancedForLoop;
import com.sun.tools.javac.tree.JCTree.JCExpression;
import com.sun.tools.javac.tree.JCTree.JCStatement;
import com.sun.tools.javac.tree.JCTree.JCVariableDecl;
import com.sun.tools.javac.tree.TreeMaker;
import java.lang.reflect.InvocationTargetException;
import java.util.Arrays;

/**
* A {@link UTree} representation of a {@link EnhancedForLoopTree}.
Expand All @@ -39,7 +37,69 @@
abstract class UEnhancedForLoop extends USimpleStatement implements EnhancedForLoopTree {
public static UEnhancedForLoop create(
UVariableDecl variable, UExpression elements, UStatement statement) {
return new AutoValue_UEnhancedForLoop(variable, elements, (USimpleStatement) statement);
// On JDK 20 and above the `EnhancedForLoopTree` interface contains a additional method
// `getDeclarationKind()`, referencing a type not available prior to JDK 20. AutoValue
// generates a corresponding field and accessor for this property. Here we find and invoke the
// generated constructor with the appropriate arguments, depending on context.
// See https://github.com/openjdk/jdk20/commit/2cb64a75578ccc15a1dfc8c2843aa11d05ca8aa7.
// TODO: Simplify this logic once JDK 19 and older are no longer supported.
return isCompiledWithJdk20Plus()
? createJdk20PlusEnhancedForLoop(variable, elements, statement)
: createPreJdk20EnhancedForLoop(variable, elements, statement);
Comment on lines +44 to +52
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not happy with all the reflection going on here, but found no better way.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've mostly been using reflection for similar workarounds recently.

I've been thinking about whether could use Multi-Release jars. At some point it may be worth branches source files like this when there are significant API changes, to avoid the reflection. But at least the last time I looked into it, setting maven up to build mr-jars didn't seem trivial.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using Multi-Release JARs might be a nice idea indeed! I currently don't have any experience with those, so can't comment on the effort required for Maven. (But this does sound like a nice topic to dive into; might also be nice for Error Prone Support, where we're also discussing how to depend on/use newer JDKs while still supporting JDK 11.)

}

private static boolean isCompiledWithJdk20Plus() {
return Arrays.stream(AutoValue_UEnhancedForLoop.class.getDeclaredMethods())
.anyMatch(m -> "getDeclarationKind".equals(m.getName()));
}

private static UEnhancedForLoop createPreJdk20EnhancedForLoop(
UVariableDecl variable, UExpression elements, UStatement statement) {
try {
return AutoValue_UEnhancedForLoop.class
.getDeclaredConstructor(UVariableDecl.class, UExpression.class, USimpleStatement.class)
.newInstance(variable, elements, statement);
} catch (IllegalAccessException
| InstantiationException
| InvocationTargetException
| NoSuchMethodException e) {
throw new LinkageError(e.getMessage(), e);
}
}

private static UEnhancedForLoop createJdk20PlusEnhancedForLoop(
UVariableDecl variable, UExpression elements, UStatement statement) {
Object declarationKind = getVariableDeclarationKind();
try {
return AutoValue_UEnhancedForLoop.class
.getDeclaredConstructor(
declarationKind.getClass(),
UVariableDecl.class,
UExpression.class,
USimpleStatement.class)
.newInstance(declarationKind, variable, elements, statement);
} catch (IllegalAccessException
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: ReflectiveOperationException

| InstantiationException
| InvocationTargetException
| NoSuchMethodException e) {
throw new LinkageError(e.getMessage(), e);
}
}

private static Object getVariableDeclarationKind() {
Class<?> declarationKind;
try {
declarationKind = Class.forName("com.sun.source.tree.EnhancedForLoopTree$DeclarationKind");
} catch (ClassNotFoundException e) {
throw new VerifyException("Cannot load `EnhancedForLoopTree.DeclarationKind` enum", e);
}
return Arrays.stream(declarationKind.getEnumConstants())
.filter(v -> "VARIABLE".equals(v.toString()))
.findFirst()
.orElseThrow(
() ->
new VerifyException(
"Enum value `EnhancedForLoopTree.DeclarationKind.VARIABLE` not found"));
}

@Override
Expand Down Expand Up @@ -68,31 +128,12 @@ public Kind getKind() {

@Override
public JCEnhancedForLoop inline(Inliner inliner) throws CouldNotResolveImportException {
return makeForeachLoop(
inliner.maker(),
getVariable().inline(inliner),
getExpression().inline(inliner),
getStatement().inline(inliner));
}

private static JCEnhancedForLoop makeForeachLoop(
TreeMaker maker, JCVariableDecl variable, JCExpression expression, JCStatement statement) {
try {
if (RuntimeVersion.isAtLeast20()) {
return (JCEnhancedForLoop)
TreeMaker.class
.getMethod("ForeachLoop", JCTree.class, JCExpression.class, JCStatement.class)
.invoke(maker, variable, expression, statement);
} else {
return (JCEnhancedForLoop)
TreeMaker.class
.getMethod(
"ForeachLoop", JCVariableDecl.class, JCExpression.class, JCStatement.class)
.invoke(maker, variable, expression, statement);
}
} catch (ReflectiveOperationException e) {
throw new LinkageError(e.getMessage(), e);
}
return inliner
.maker()
.ForeachLoop(
getVariable().inline(inliner),
getExpression().inline(inliner),
getStatement().inline(inliner));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cushon based on my tests (with JDK 20-ea build 28) the build also passes without these changes. Let me know if I should revert this part of the PR.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I prepared df033f0 to fix an error in the internal CI, which was building at the Java 11 language level and APIs and then running on a newer JDK. We might not need this with your patch, though. Let me think about this a little harder.

(I think there was some related discussion in an external bug about how our CI is compiling and testing at each JDK version, but we're only releasing one set of artifacts built at a fixed version, and maybe we should have the CI do one build that matches the releases and then run the tests at different versions.)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see a regression when testing this compiled against the Java 11 APIs, and running on the latest version. I think that makes sense: the change to TreeMaker#ForeachLoop is source-compatible here, but if it resolves the Java 11 version at compile-time and sees a different version at runtime it will fail.

I think the reflection is still necessary, and I should also try to add that configuration to the external CI.

java.lang.NoSuchMethodError: 'com.sun.tools.javac.tree.JCTree$JCEnhancedForLoop com.sun.tools.javac.tree.TreeMaker.ForeachLoop(com.sun.tools.javac.tree.JCTree$JCVariableDecl, com.sun.tools.javac.tree.JCTree$JCExpression, com.sun.tools.javac.tree.JCTree$JCStatement)'
	at com.google.errorprone.refaster.UEnhancedForLoop.inline([UEnhancedForLoop.java:125](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/UEnhancedForLoop.java:125&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.UEnhancedForLoop.inline([UEnhancedForLoop.java:34](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/UEnhancedForLoop.java:34&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.USimpleStatement.inlineStatements([USimpleStatement.java:34](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/USimpleStatement.java:34&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.BlockTemplate.replace([BlockTemplate.java:215](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/BlockTemplate.java:215&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.BlockTemplate.replace([BlockTemplate.java:48](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/BlockTemplate.java:48&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.scan([RefasterScanner.java:126](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:126&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.scan([RefasterScanner.java:51](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:51&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.source.util.TreeScanner.scanAndReduce([TreeScanner.java:96](https://cs.corp.google.com/#search/&q=f:com/sun/source/util/TreeScanner.java:96&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.source.util.TreeScanner.visitMethod([TreeScanner.java:224](https://cs.corp.google.com/#search/&q=f:com/sun/source/util/TreeScanner.java:224&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.visitMethod([RefasterScanner.java:88](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:88&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.visitMethod([RefasterScanner.java:51](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:51&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.tools.javac.tree.JCTree$JCMethodDecl.accept([JCTree.java:944](https://cs.corp.google.com/#search/&q=f:com/sun/tools/javac/tree/JCTree.java:944&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.visitClass([RefasterScanner.java:75](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:75&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.visitClass([RefasterScanner.java:51](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:51&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.tools.javac.tree.JCTree$JCClassDecl.accept([JCTree.java:851](https://cs.corp.google.com/#search/&q=f:com/sun/tools/javac/tree/JCTree.java:851&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.source.util.TreeScanner.scan([TreeScanner.java:92](https://cs.corp.google.com/#search/&q=f:com/sun/source/util/TreeScanner.java:92&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.scan([RefasterScanner.java:132](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:132&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.scan([RefasterScanner.java:51](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:51&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.source.util.TreeScanner.scan([TreeScanner.java:111](https://cs.corp.google.com/#search/&q=f:com/sun/source/util/TreeScanner.java:111&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.source.util.TreeScanner.scanAndReduce([TreeScanner.java:119](https://cs.corp.google.com/#search/&q=f:com/sun/source/util/TreeScanner.java:119&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.source.util.TreeScanner.visitCompilationUnit([TreeScanner.java:152](https://cs.corp.google.com/#search/&q=f:com/sun/source/util/TreeScanner.java:152&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.tools.javac.tree.JCTree$JCCompilationUnit.accept([JCTree.java:619](https://cs.corp.google.com/#search/&q=f:com/sun/tools/javac/tree/JCTree.java:619&ws=cushon/225130&snapshot=5))
	at jdk.compiler/com.sun.source.util.TreeScanner.scan([TreeScanner.java:92](https://cs.corp.google.com/#search/&q=f:com/sun/source/util/TreeScanner.java:92&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterScanner.scan([RefasterScanner.java:132](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterScanner.java:132&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.RefasterRule.apply([RefasterRule.java:139](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/RefasterRule.java:139&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.CodeTransformerTestHelper.transform([CodeTransformerTestHelper.java:75](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/CodeTransformerTestHelper.java:75&ws=cushon/225130&snapshot=5))
	at com.google.errorprone.refaster.TemplateIntegrationTest.expectTransforms([TemplateIntegrationTest.java:68](https://cs.corp.google.com/#search/&q=f:com/google/errorprone/refaster/TemplateIntegrationTest.java:68&ws=cushon/225130&snapshot=5))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could not reproduce this locally, but the stack trace speaks for itself. I added a commit to revert this section 👍

}

@Override
Expand Down
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@
<target>11</target>
<parameters />
<compilerArgs>
<arg>--add-exports=java.base/jdk.internal.javac=ALL-UNNAMED</arg>
<arg>--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED</arg>
<arg>--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED</arg>
<arg>--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED</arg>
Expand Down