Erase bootstrap (#1753)

raphw · web-flow · commit 4a9d3c2b227f · 2025-01-17T14:20:50.000+01:00
* Add test for erased bootstrap.

* Add basic test.

* Create test that fails for erasure.

* Retain array structure on erasure.

* Improve erasure mechanism.

* Refactor towards erasure.

* More refactoring.

* Fix type token.

* Refactor last support API to use of type token.

* More refactoring.

* More refactoring.

* Fix up checkstyle.

* More cleanup.

* Remove visitor from member substitution.

* Clean up return handler.

* Add missing javadoc.

* Avoid intermediate store of type token.

* Increase version number.

* Fix tests.
diff --git a/byte-buddy-agent/pom.xml b/byte-buddy-agent/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>net.bytebuddy</groupId>
         <artifactId>byte-buddy-parent</artifactId>
-        <version>1.15.12-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>byte-buddy-agent</artifactId>
diff --git a/byte-buddy-android-test/pom.xml b/byte-buddy-android-test/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>net.bytebuddy</groupId>
         <artifactId>byte-buddy-parent</artifactId>
-        <version>1.15.12-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>byte-buddy-android-test</artifactId>
diff --git a/byte-buddy-android/pom.xml b/byte-buddy-android/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>net.bytebuddy</groupId>
         <artifactId>byte-buddy-parent</artifactId>
-        <version>1.15.12-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>byte-buddy-android</artifactId>
diff --git a/byte-buddy-benchmark/pom.xml b/byte-buddy-benchmark/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>net.bytebuddy</groupId>
         <artifactId>byte-buddy-parent</artifactId>
-        <version>1.15.12-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>byte-buddy-benchmark</artifactId>
diff --git a/byte-buddy-dep/pom.xml b/byte-buddy-dep/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>net.bytebuddy</groupId>
         <artifactId>byte-buddy-parent</artifactId>
-        <version>1.15.12-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
 
     <!--
diff --git a/byte-buddy-dep/src/main/java/net/bytebuddy/asm/Advice.java b/byte-buddy-dep/src/main/java/net/bytebuddy/asm/Advice.java
diff --git a/byte-buddy-dep/src/main/java/net/bytebuddy/asm/MemberSubstitution.java b/byte-buddy-dep/src/main/java/net/bytebuddy/asm/MemberSubstitution.java
diff --git a/byte-buddy-dep/src/main/java/net/bytebuddy/description/type/TypeDescription.java b/byte-buddy-dep/src/main/java/net/bytebuddy/description/type/TypeDescription.java
@@ -793,7 +793,8 @@ public Generic onNonGenericType(Generic typeDescription) {
             }
 
             /**
-             * A visitor that generalizes all reference types to {@link Object} but retains primitive types.
+             * A visitor that generalizes all reference types to {@link Object} but retains primitive types. Arrays
+             * are retained as such.
              */
             enum Generalizing implements Visitor<Generic> {
 
@@ -805,8 +806,14 @@ enum Generalizing implements Visitor<Generic> {
                 /**
                  * {@inheritDoc}
                  */
+                @SuppressFBWarnings(value = "NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE", justification = "Assuming component type for array type.")
                 public Generic onGenericArray(Generic genericArray) {
-                    return Sort.describe(Object.class);
+                    int arity = 0;
+                    do {
+                        arity++;
+                        genericArray = genericArray.getComponentType();
+                    } while (genericArray.isArray());
+                    return ArrayProjection.of(TypeDescription.ForLoadedType.of(Object.class), arity).asGenericType();
                 }
 
                 /**
@@ -820,23 +827,30 @@ public Generic onWildcard(Generic wildcard) {
                  * {@inheritDoc}
                  */
                 public Generic onParameterizedType(Generic parameterizedType) {
-                    return Sort.describe(Object.class);
+                    return TypeDescription.ForLoadedType.of(Object.class).asGenericType();
                 }
 
                 /**
                  * {@inheritDoc}
                  */
                 public Generic onTypeVariable(Generic typeVariable) {
-                    return Sort.describe(Object.class);
+                    return TypeDescription.ForLoadedType.of(Object.class).asGenericType();
                 }
 
                 /**
                  * {@inheritDoc}
                  */
+                @SuppressFBWarnings(value = "NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE", justification = "Assuming component type for array type.")
                 public Generic onNonGenericType(Generic typeDescription) {
-                    return typeDescription.isPrimitive()
+                    int arity = 0;
+                    Generic componentType = typeDescription;
+                    while (componentType.isArray()) {
+                        arity++;
+                        componentType = componentType.getComponentType();
+                    }
+                    return componentType.isPrimitive()
                             ? typeDescription
-                            : Sort.describe(Object.class);
+                            : ArrayProjection.of(TypeDescription.ForLoadedType.of(Object.class), arity).asGenericType();
                 }
             }
 
diff --git a/byte-buddy-dep/src/test/java-7/net/bytebuddy/test/precompiled/v7/AdviceBootstrapErased.java b/byte-buddy-dep/src/test/java-7/net/bytebuddy/test/precompiled/v7/AdviceBootstrapErased.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2014 - Present Rafael Winterhalter
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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 net.bytebuddy.test.precompiled.v7;
+
+import java.lang.invoke.ConstantCallSite;
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.MethodType;
+
+public class AdviceBootstrapErased {
+
+    public static ConstantCallSite bootstrap(MethodHandles.Lookup lookup,
+                                             String invokedMethodName,
+                                             MethodType erasedMethodType,
+                                             String invokedClassName,
+                                             String invokedMethodDescriptor) throws Exception {
+        return new ConstantCallSite(lookup.findStatic(Class.forName(invokedClassName, false, lookup.lookupClass().getClassLoader()),
+                invokedMethodName,
+                MethodType.fromMethodDescriptorString(invokedMethodDescriptor, lookup.lookupClass().getClassLoader())).asType(erasedMethodType));
+    }
+}
diff --git a/byte-buddy-dep/src/test/java/net/bytebuddy/asm/AdviceTest.java b/byte-buddy-dep/src/test/java/net/bytebuddy/asm/AdviceTest.java
@@ -1,6 +1,7 @@
 package net.bytebuddy.asm;
 
 import net.bytebuddy.ByteBuddy;
+import net.bytebuddy.description.annotation.AnnotationDescription;
 import net.bytebuddy.description.method.MethodDescription;
 import net.bytebuddy.description.modifier.Ownership;
 import net.bytebuddy.description.modifier.Visibility;
@@ -20,7 +21,9 @@
 import net.bytebuddy.matcher.ElementMatchers;
 import net.bytebuddy.pool.TypePool;
 import net.bytebuddy.test.packaging.AdviceTestHelper;
+import net.bytebuddy.test.utility.DebuggingWrapper;
 import net.bytebuddy.test.utility.JavaVersionRule;
+import net.bytebuddy.utility.JavaConstant;
 import net.bytebuddy.utility.JavaType;
 import org.junit.Rule;
 import org.junit.Test;
@@ -272,6 +275,37 @@ public void testTrivialAdviceWithDelegationBootstrapped() throws Exception {
         assertThat(type.getDeclaredField(EXIT).get(null), is((Object) 1));
     }
 
+    @Test
+    @JavaVersionRule.Enforce(value = 7, target = TypedAdviceDelegation.class)
+    public void testErasedAdviceWithDelegationBootstrapped() throws Exception {
+        Class<?> bootstrap = Class.forName("net.bytebuddy.test.precompiled.v7.AdviceBootstrapErased");
+        Class<?> type = new ByteBuddy()
+                .redefine(TypedAdviceDelegation.class)
+                .visit(DebuggingWrapper.makeDefault())
+                .visit(Advice.withCustomMapping().bootstrap(bootstrap.getMethod("bootstrap",
+                        JavaType.METHOD_HANDLES_LOOKUP.load(),
+                        String.class,
+                        JavaType.METHOD_TYPE.load(),
+                        String.class,
+                        String.class), new Advice.BootstrapArgumentResolver.Factory() {
+                    public Advice.BootstrapArgumentResolver resolve(final MethodDescription.InDefinedShape adviceMethod, boolean exit) {
+                        return new Advice.BootstrapArgumentResolver() {
+                            public List<JavaConstant> resolve(TypeDescription instrumentedType, MethodDescription instrumentedMethod) {
+                                return Arrays.asList(
+                                        JavaConstant.Simple.ofLoaded(adviceMethod.getDeclaringType().getName()),
+                                        JavaConstant.Simple.ofLoaded(adviceMethod.getDescriptor()));
+                            }
+                        };
+                    }
+                }, TypeDescription.Generic.Visitor.Generalizing.INSTANCE).to(TypedAdviceDelegation.class).on(named(FOO)))
+                .make()
+                .load(bootstrap.getClassLoader(), ClassLoadingStrategy.Default.CHILD_FIRST)
+                .getLoaded();
+        assertThat(type.getDeclaredMethod(FOO, String.class).invoke(type.getDeclaredConstructor().newInstance(), FOO), is((Object) FOO));
+        assertThat(type.getDeclaredField(ENTER).get(null), is((Object) 1));
+        assertThat(type.getDeclaredField(EXIT).get(null), is((Object) 1));
+    }
+
     @Test
     public void testTrivialAdviceWithSuppression() throws Exception {
         Class<?> type = new ByteBuddy()
@@ -1643,7 +1677,9 @@ public void testAssigningEnterPostProcessorInline() throws Exception {
         Class<?> type = new ByteBuddy()
                 .redefine(PostProcessorInline.class)
                 .visit(Advice.withCustomMapping().with(new Advice.PostProcessor.Factory() {
-                    public Advice.PostProcessor make(final MethodDescription.InDefinedShape advice, boolean exit) {
+                    public Advice.PostProcessor make(List<? extends AnnotationDescription> annotations,
+                                                     final TypeDescription returnType,
+                                                     boolean exit) {
                         return new Advice.PostProcessor() {
                             public StackManipulation resolve(TypeDescription instrumentedType,
                                                              MethodDescription instrumentedMethod,
@@ -1652,7 +1688,7 @@ public StackManipulation resolve(TypeDescription instrumentedType,
                                                              Advice.StackMapFrameHandler.ForPostProcessor stackMapFrameHandler,
                                                              StackManipulation exceptionHandler) {
                                 return new StackManipulation.Compound(
-                                        MethodVariableAccess.of(advice.getReturnType()).loadFrom(argumentHandler.enter()),
+                                        MethodVariableAccess.of(returnType).loadFrom(argumentHandler.enter()),
                                         MethodVariableAccess.store(instrumentedMethod.getParameters().get(0))
                                 );
                             }
@@ -1670,7 +1706,9 @@ public void testAssigningEnterPostProcessorDelegate() throws Exception {
         Class<?> type = new ByteBuddy()
                 .redefine(PostProcessorDelegate.class)
                 .visit(Advice.withCustomMapping().with(new Advice.PostProcessor.Factory() {
-                    public Advice.PostProcessor make(final MethodDescription.InDefinedShape advice, boolean exit) {
+                    public Advice.PostProcessor make(List<? extends AnnotationDescription> annotations,
+                                                     final TypeDescription returnType,
+                                                     boolean exit) {
                         return new Advice.PostProcessor() {
                             public StackManipulation resolve(TypeDescription instrumentedType,
                                                              MethodDescription instrumentedMethod,
@@ -1679,7 +1717,7 @@ public StackManipulation resolve(TypeDescription instrumentedType,
                                                              Advice.StackMapFrameHandler.ForPostProcessor stackMapFrameHandler,
                                                              StackManipulation exceptionHandler) {
                                 return new StackManipulation.Compound(
-                                        MethodVariableAccess.of(advice.getReturnType()).loadFrom(argumentHandler.enter()),
+                                        MethodVariableAccess.of(returnType).loadFrom(argumentHandler.enter()),
                                         MethodVariableAccess.store(instrumentedMethod.getParameters().get(0))
                                 );
                             }
@@ -2467,6 +2505,34 @@ private static void exit() {
         }
     }
 
+
+    @SuppressWarnings("unused")
+    public static class TypedAdviceDelegation {
+
+        public static int enter, exit;
+
+        public String foo(String argument) {
+            return argument;
+        }
+
+        @Advice.OnMethodEnter(inline = false)
+        private static String enter(@Advice.Argument(0) String argument) {
+            if (!FOO.equals(argument)) {
+                throw new AssertionError();
+            }
+            enter++;
+            return BAR;
+        }
+
+        @Advice.OnMethodExit(inline = false, onThrowable = Exception.class)
+        private static void exit(@Advice.Enter String enter) {
+            if (!BAR.equals(enter)) {
+                throw new AssertionError();
+            }
+            exit++;
+        }
+    }
+
     @SuppressWarnings("unused")
     public static class EmptyMethod {
 
diff --git a/byte-buddy-dep/src/test/java/net/bytebuddy/description/type/TypeDescriptionGenericVisitorTypeGeneralizingTest.java b/byte-buddy-dep/src/test/java/net/bytebuddy/description/type/TypeDescriptionGenericVisitorTypeGeneralizingTest.java
@@ -17,17 +17,14 @@ public class TypeDescriptionGenericVisitorTypeGeneralizingTest {
     public MethodRule mockitoRule = MockitoJUnit.rule().silent();
 
     @Mock
-    private TypeDescription.Generic typeDescription, rawType;
+    private TypeDescription.Generic typeDescription, componentType;
 
-    @Before
-    public void setUp() throws Exception {
-        when(typeDescription.asRawType()).thenReturn(rawType);
-    }
 
     @Test
     public void testGenericArray() throws Exception {
+        when(typeDescription.getComponentType()).thenReturn(componentType);
         assertThat(TypeDescription.Generic.Visitor.Generalizing.INSTANCE.onGenericArray(typeDescription),
-                is(TypeDefinition.Sort.describe(Object.class)));
+                is(TypeDefinition.Sort.describe(Object[].class)));
     }
 
     @Test(expected = IllegalArgumentException.class)
@@ -53,9 +50,23 @@ public void testNonGeneric() throws Exception {
                 is(TypeDefinition.Sort.describe(Object.class)));
     }
 
+    @Test
+    public void testNonGenericArray() throws Exception {
+        when(typeDescription.isArray()).thenReturn(true);
+        when(typeDescription.getComponentType()).thenReturn(componentType);
+        assertThat(TypeDescription.Generic.Visitor.Generalizing.INSTANCE.onNonGenericType(typeDescription),
+                is(TypeDefinition.Sort.describe(Object[].class)));
+    }
+
     @Test
     public void testNonGenericPrimitive() throws Exception {
         assertThat(TypeDescription.Generic.Visitor.Generalizing.INSTANCE.onNonGenericType(TypeDefinition.Sort.describe(int.class)),
                 is(TypeDefinition.Sort.describe(int.class)));
     }
+
+    @Test
+    public void testNonGenericPrimitiveArray() throws Exception {
+        assertThat(TypeDescription.Generic.Visitor.Generalizing.INSTANCE.onNonGenericType(TypeDefinition.Sort.describe(int[].class)),
+                is(TypeDefinition.Sort.describe(int[].class)));
+    }
 }
diff --git a/byte-buddy-dep/src/test/precompiled-7/net/bytebuddy/test/precompiled/v7/AdviceBootstrapErased.class b/byte-buddy-dep/src/test/precompiled-7/net/bytebuddy/test/precompiled/v7/AdviceBootstrapErased.class
diff --git a/byte-buddy-gradle-plugin/pom.xml b/byte-buddy-gradle-plugin/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>net.bytebuddy</groupId>
         <artifactId>byte-buddy-parent</artifactId>
-        <version>1.15.12-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>byte-buddy-gradle-plugin</artifactId>
diff --git a/byte-buddy-maven-plugin/pom.xml b/byte-buddy-maven-plugin/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>net.bytebuddy</groupId>
         <artifactId>byte-buddy-parent</artifactId>
-        <version>1.15.12-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>byte-buddy-maven-plugin</artifactId>
diff --git a/byte-buddy/pom.xml b/byte-buddy/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>net.bytebuddy</groupId>
         <artifactId>byte-buddy-parent</artifactId>
-        <version>1.15.12-SNAPSHOT</version>
+        <version>1.16.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>byte-buddy</artifactId>
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
     <groupId>net.bytebuddy</groupId>
     <artifactId>byte-buddy-parent</artifactId>
-    <version>1.15.12-SNAPSHOT</version>
+    <version>1.16.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <inceptionYear>2014</inceptionYear>
