Skip to content

[9.0][Entitlements] Fix "dynamic" instrumentation target class (#122197) #122394

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 12, 2025
Merged

[9.0][Entitlements] Fix "dynamic" instrumentation target class (#122197) #122394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 22 additions & 32 deletions ...n/java/org/elasticsearch/entitlement/instrumentation/impl/InstrumentationServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ public InstrumentationInfo lookupImplementationMethod(
) throws NoSuchMethodException, ClassNotFoundException {

var targetMethod = targetSuperclass.getDeclaredMethod(methodName, parameterTypes);
validateTargetMethod(implementationClass, targetMethod);
var implementationMethod = implementationClass.getMethod(targetMethod.getName(), targetMethod.getParameterTypes());
validateTargetMethod(implementationClass, targetMethod, implementationMethod);

var checkerAdditionalArguments = Stream.of(Class.class, targetSuperclass);
var checkMethodArgumentTypes = Stream.concat(checkerAdditionalArguments, Arrays.stream(parameterTypes))
Expand Down Expand Up @@ -169,15 +170,15 @@ public MethodVisitor visitMethod(

return new InstrumentationInfo(
new MethodKey(
Type.getInternalName(implementationClass),
targetMethod.getName(),
Type.getInternalName(implementationMethod.getDeclaringClass()),
implementationMethod.getName(),
Arrays.stream(parameterTypes).map(c -> Type.getType(c).getInternalName()).toList()
),
checkMethod[0]
);
}

private static void validateTargetMethod(Class<?> implementationClass, Method targetMethod) {
private static void validateTargetMethod(Class<?> implementationClass, Method targetMethod, Method implementationMethod) {
if (targetMethod.getDeclaringClass().isAssignableFrom(implementationClass) == false) {
throw new IllegalArgumentException(
String.format(
Expand Down Expand Up @@ -209,37 +210,26 @@ private static void validateTargetMethod(Class<?> implementationClass, Method ta
)
);
}
try {
var implementationMethod = implementationClass.getMethod(targetMethod.getName(), targetMethod.getParameterTypes());
var methodModifiers = implementationMethod.getModifiers();
if (Modifier.isAbstract(methodModifiers)) {
throw new IllegalArgumentException(
String.format(
Locale.ROOT,
"Not a valid instrumentation method: %s is abstract in %s",
targetMethod.getName(),
implementationClass.getName()
)
);
}
if (Modifier.isPublic(methodModifiers) == false) {
throw new IllegalArgumentException(
String.format(
Locale.ROOT,
"Not a valid instrumentation method: %s is not public in %s",
targetMethod.getName(),
implementationClass.getName()
)
);
}
} catch (NoSuchMethodException e) {
assert false
: String.format(
var methodModifiers = implementationMethod.getModifiers();
if (Modifier.isAbstract(methodModifiers)) {
throw new IllegalArgumentException(
String.format(
Locale.ROOT,
"Not a valid instrumentation method: %s cannot be found in %s",
"Not a valid instrumentation method: %s is abstract in %s",
targetMethod.getName(),
implementationClass.getName()
);
)
);
}
if (Modifier.isPublic(methodModifiers) == false) {
throw new IllegalArgumentException(
String.format(
Locale.ROOT,
"Not a valid instrumentation method: %s is not public in %s",
targetMethod.getName(),
implementationClass.getName()
)
);
}
}

Expand Down
47 changes: 46 additions & 1 deletion ...a/org/elasticsearch/entitlement/instrumentation/impl/InstrumentationServiceImplTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,16 @@ public void instanceMethod(int x, String y) {}

abstract static class TestTargetBaseClass {
abstract void instanceMethod(int x, String y);

abstract void instanceMethod2(int x, String y);
}

static class TestTargetImplementationClass extends TestTargetBaseClass {
abstract static class TestTargetIntermediateClass extends TestTargetBaseClass {
@Override
public void instanceMethod2(int x, String y) {}
}

static class TestTargetImplementationClass extends TestTargetIntermediateClass {
@Override
public void instanceMethod(int x, String y) {}
}
Expand Down Expand Up @@ -364,6 +371,44 @@ public void testLookupImplementationMethodWithBaseClass() throws ClassNotFoundEx
);
}

public void testLookupImplementationMethodWithInheritance() throws ClassNotFoundException, NoSuchMethodException {
var info = instrumentationService.lookupImplementationMethod(
TestTargetBaseClass.class,
"instanceMethod2",
TestTargetImplementationClass.class,
TestCheckerMixed.class,
"checkInstanceMethodManual",
int.class,
String.class
);

assertThat(
info.targetMethod(),
equalTo(
new MethodKey(
"org/elasticsearch/entitlement/instrumentation/impl/InstrumentationServiceImplTests$TestTargetIntermediateClass",
"instanceMethod2",
List.of("I", "java/lang/String")
)
)
);
assertThat(
info.checkMethod(),
equalTo(
new CheckMethod(
"org/elasticsearch/entitlement/instrumentation/impl/InstrumentationServiceImplTests$TestCheckerMixed",
"checkInstanceMethodManual",
List.of(
"Ljava/lang/Class;",
"Lorg/elasticsearch/entitlement/instrumentation/impl/InstrumentationServiceImplTests$TestTargetBaseClass;",
"I",
"Ljava/lang/String;"
)
)
)
);
}

public void testParseCheckerMethodSignatureStaticMethod() {
var methodKey = InstrumentationServiceImpl.parseCheckerMethodSignature(
"check$org_example_TestClass$$staticMethod",
Expand Down