-
Notifications
You must be signed in to change notification settings - Fork 91
Move statements before super(..) in Java constructor #733 #736
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
Open
rkampani
wants to merge
5
commits into
openrewrite:main
Choose a base branch
from
rkampani:feature/733-move_superJDK25
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+304
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
69cbb3a
Move statements before super(..) in Java constructor #733
rkampani 9b9aed6
Apply suggestions from code review
timtebeek 7f18dbe
Update RelocateSuperCallTest.java
timtebeek 007be73
Merge branch 'main' into feature/733-move_superJDK25
timtebeek d69ad7d
Moved the file out of the util package and updated the JDK 25 rewrite…
rkampani File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
83 changes: 83 additions & 0 deletions
83
src/main/java/org/openrewrite/java/migrate/RelocateSuperCall.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
/* | ||
* Copyright 2025 the original author or authors. | ||
* <p> | ||
* Licensed under the Moderne Source Available License (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* <p> | ||
* https://docs.moderne.io/licensing/moderne-source-available-license | ||
* <p> | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.openrewrite.java.migrate; | ||
|
||
|
||
import lombok.EqualsAndHashCode; | ||
import lombok.Value; | ||
import org.openrewrite.ExecutionContext; | ||
import org.openrewrite.Preconditions; | ||
import org.openrewrite.Recipe; | ||
import org.openrewrite.TreeVisitor; | ||
import org.openrewrite.java.JavaIsoVisitor; | ||
import org.openrewrite.java.search.UsesJavaVersion; | ||
import org.openrewrite.java.tree.J; | ||
import org.openrewrite.java.tree.Statement; | ||
|
||
import java.util.List; | ||
|
||
@EqualsAndHashCode(callSuper = false) | ||
@Value | ||
public class RelocateSuperCall extends Recipe { | ||
|
||
@Override | ||
public String getDisplayName() { | ||
return "Move `super()` after conditionals (Java 25+)"; | ||
} | ||
|
||
@Override | ||
public String getDescription() { | ||
return "Relocates `super()` calls to take advantage of the early construction context introduced by JEP 513 in Java 25+, allowing statements before constructor calls."; | ||
} | ||
|
||
@Override | ||
public TreeVisitor<?, ExecutionContext> getVisitor() { | ||
return Preconditions.check( | ||
new UsesJavaVersion<>(25), | ||
new RelocateSuperCallVisitor()); | ||
} | ||
|
||
private static class RelocateSuperCallVisitor extends JavaIsoVisitor<ExecutionContext> { | ||
|
||
@Override | ||
public J.MethodDeclaration visitMethodDeclaration(J.MethodDeclaration method, ExecutionContext ctx) { | ||
if (!method.isConstructor() || method.getBody() == null) { | ||
return method; | ||
} | ||
|
||
List<Statement> statements = method.getBody().getStatements(); | ||
if (statements.size() < 2) { | ||
return method; | ||
} | ||
|
||
Statement first = statements.get(0); | ||
if (!(first instanceof J.MethodInvocation)) { | ||
return method; | ||
} | ||
J.MethodInvocation methodInvocation = (J.MethodInvocation) first; | ||
if (!"super".equals(methodInvocation.getSimpleName())) { | ||
return method; | ||
} | ||
|
||
// Move super() to the end | ||
List<Statement> updated = new java.util.ArrayList<>(statements); | ||
updated.remove(0); | ||
updated.add(methodInvocation); | ||
|
||
return method.withBody(method.getBody().withStatements(updated)); | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
220 changes: 220 additions & 0 deletions
220
src/test/java/org/openrewrite/java/migrate/RelocateSuperCallTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,220 @@ | ||
/* | ||
* Copyright 2025 the original author or authors. | ||
* <p> | ||
* Licensed under the Moderne Source Available License (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* <p> | ||
* https://docs.moderne.io/licensing/moderne-source-available-license | ||
* <p> | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.openrewrite.java.migrate; | ||
|
||
import org.junit.jupiter.api.Test; | ||
import org.openrewrite.DocumentExample; | ||
import org.openrewrite.test.RecipeSpec; | ||
import org.openrewrite.test.RewriteTest; | ||
|
||
import static org.openrewrite.java.Assertions.java; | ||
import static org.openrewrite.java.Assertions.javaVersion; | ||
|
||
class RelocateSuperCallTest implements RewriteTest { | ||
|
||
@Override | ||
public void defaults(RecipeSpec spec) { | ||
spec.recipe(new RelocateSuperCall()) | ||
.allSources(src -> src.markers(javaVersion(25))); | ||
|
||
} | ||
|
||
@DocumentExample | ||
@Test | ||
void relocateSuperAfterIf() { | ||
rewriteRun( | ||
java( | ||
""" | ||
class A { | ||
public A(String bar) { | ||
super(); | ||
if(bar.equals("test")) | ||
throw new RuntimeException(); | ||
} | ||
} | ||
""", | ||
""" | ||
class A { | ||
public A(String bar) { | ||
if(bar.equals("test")) | ||
throw new RuntimeException(); | ||
super(); | ||
} | ||
} | ||
""" | ||
) | ||
); | ||
} | ||
|
||
@Test | ||
void relocateSuperAfterIfStatement() { | ||
rewriteRun( | ||
java( | ||
// language=java | ||
""" | ||
class Person { | ||
final int age; | ||
public Person(int age) { | ||
if (age < 0) { | ||
throw new IllegalArgumentException("Invalid age"); | ||
} | ||
this.age = age; | ||
} | ||
} | ||
|
||
class Employee extends Person { | ||
public Employee(int age) { | ||
super(age); | ||
if (age < 18 || age > 67) { | ||
throw new IllegalArgumentException("Invalid employee age"); | ||
} | ||
} | ||
} | ||
""", | ||
// Expected output | ||
""" | ||
class Person { | ||
final int age; | ||
public Person(int age) { | ||
if (age < 0) { | ||
throw new IllegalArgumentException("Invalid age"); | ||
} | ||
this.age = age; | ||
} | ||
} | ||
|
||
class Employee extends Person { | ||
public Employee(int age) { | ||
if (age < 18 || age > 67) { | ||
throw new IllegalArgumentException("Invalid employee age"); | ||
} | ||
super(age); | ||
} | ||
} | ||
""" | ||
) | ||
); | ||
} | ||
|
||
@Test | ||
void relocateSuperWithSafeFieldAssignmentOnly() { | ||
rewriteRun( | ||
java( | ||
""" | ||
class Outer { | ||
class Inner { | ||
int x; | ||
int y = 100; | ||
|
||
Inner(int input) { | ||
super(); | ||
x = input; | ||
y = 200; | ||
} | ||
} | ||
} | ||
""", | ||
// Note: `y = 200` is illegal under early construction context since `y` has initializer | ||
// So the expected result is same as input if `super()` is already last. | ||
""" | ||
class Outer { | ||
class Inner { | ||
int x; | ||
int y = 100; | ||
|
||
Inner(int input) { | ||
x = input; | ||
y = 200; | ||
super(); | ||
} | ||
} | ||
} | ||
""" | ||
) | ||
); | ||
} | ||
|
||
@Test | ||
void nprelocateSuperInInnerClassIfAlreadyAsLast_withSafeAssignments() { | ||
rewriteRun( | ||
java( | ||
// language=java (before transformation) | ||
""" | ||
class Outer { | ||
class Inner { | ||
int x; | ||
int y; | ||
|
||
Inner(int input) { | ||
var tmp = input * 2; | ||
x = tmp; | ||
y = 42; | ||
super(); | ||
} | ||
} | ||
} | ||
""", | ||
// // No Change expected as super() valid with JDK25 version | ||
spec -> spec.markers(javaVersion(25)) | ||
) | ||
); | ||
} | ||
|
||
@Test | ||
void noRelocateSuperAfterIf_givenBelowJDK25Version() { | ||
rewriteRun( | ||
java( | ||
// Input | ||
""" | ||
class A { | ||
public A(String bar) { | ||
super(); | ||
if(bar.equals("test")) | ||
throw new RuntimeException(); | ||
} | ||
} | ||
""", | ||
// Simulate Java 8 environment | ||
spec -> spec.markers(javaVersion(8)) | ||
) | ||
); | ||
} | ||
|
||
@Test | ||
void relocateSuperInInnerClass_withSafeAssignments() { | ||
rewriteRun( | ||
java( | ||
// language=java (before transformation) | ||
""" | ||
class Outer { | ||
class Inner { | ||
int x; | ||
int y; | ||
|
||
Inner(int input) { | ||
super(); | ||
var tmp = input * 2; | ||
x = tmp; | ||
y = 42; | ||
} | ||
} | ||
} | ||
""", | ||
spec -> spec.markers(javaVersion(8)) | ||
) | ||
); | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ATM you move the
super()
call to the very end of a constructor call. If i recall correctly there are limitations regarding the reference to instance fields. Could you please revisit JEP 513s section about Early-construction-contexts and verify that we are producing JLS compliant code?