GH-106 - Avoid intercepting Object and proxy-related methods for module interaction tracing.

We now skip Object methods and ones declared on Spring's Advised or TargetClassAware types when intercepting invocations to trigger a module entry.
This commit is contained in:
Oliver Drotbohm
2023-01-05 17:18:40 +01:00
parent 91c746c63c
commit 262efb5828
7 changed files with 136 additions and 6 deletions

View File

@@ -0,0 +1,27 @@
/*
* Copyright 2023 the original author or authors.
*
* 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
*
* https://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 example.sample;
import org.springframework.stereotype.Component;
/**
* @author Oliver Drotbohm
*/
@Component
public class SampleComponent {
void someMethod() {}
}

View File

@@ -0,0 +1,60 @@
/*
* Copyright 2023 the original author or authors.
*
* 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
*
* https://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 org.springframework.modulith.observability;
import static org.assertj.core.api.Assertions.*;
import example.sample.SampleComponent;
import org.junit.jupiter.api.Test;
import org.springframework.aop.framework.Advised;
import org.springframework.modulith.model.ApplicationModule;
import org.springframework.modulith.model.ApplicationModules;
import org.springframework.modulith.model.ArchitecturallyEvidentType;
import org.springframework.modulith.test.TestApplicationModules;
import org.springframework.util.ReflectionUtils;
/**
* Unit tests for {@link ObservedModuleType}.
*
* @author Oliver Drotbohm
*/
public class ObservedModuleTypeUnitTests {
static final ApplicationModules modules = TestApplicationModules.of("example");
ApplicationModule module = modules.getModuleByName("sample").orElseThrow();
ArchitecturallyEvidentType type = module.getArchitecturallyEvidentType(SampleComponent.class);
ObservedModuleType observedType = new ObservedModuleType(modules, new DefaultObservedModule(module), type);
@Test // GH-106
void onlyExposesUserMethodsAsToBeIntercepted() {
assertThat(observedType.getMethodsToIntercept()).satisfies(it -> {
assertThat(it.test(ReflectionUtils.findMethod(SampleComponent.class, "someMethod"))).isTrue();
assertThat(it.test(ReflectionUtils.findMethod(Object.class, "toString"))).isFalse();
assertThat(it.test(ReflectionUtils.findMethod(Advised.class, "getTargetClass"))).isFalse();
});
}
@Test // GH-106
void considersExposedTypeAsToBeIntercepted() {
assertThat(observedType.shouldBeTraced()).isTrue();
}
}