yifan-c commented on code in PR #303: URL: https://github.com/apache/cassandra-sidecar/pull/303#discussion_r2624255132
########## integration-tests/src/integrationTest/org/apache/cassandra/sidecar/health/JmxReconnectTest.java: ########## @@ -0,0 +1,252 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.cassandra.sidecar.health; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.lang.instrument.Instrumentation; +import java.lang.reflect.Field; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.rmi.NoSuchObjectException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.jar.JarEntry; +import java.util.jar.JarFile; +import java.util.jar.JarOutputStream; +import java.util.stream.Collectors; +import javax.management.remote.rmi.RMIConnector; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +import io.vertx.core.buffer.Buffer; +import io.vertx.ext.web.client.HttpResponse; +import net.bytebuddy.agent.ByteBuddyAgent; +import net.bytebuddy.agent.builder.AgentBuilder; +import net.bytebuddy.asm.Advice; +import org.apache.cassandra.sidecar.common.ApiEndpointsV1; +import org.apache.cassandra.sidecar.common.response.RingResponse; +import org.apache.cassandra.sidecar.testing.SharedClusterSidecarIntegrationTestBase; + +import static net.bytebuddy.matcher.ElementMatchers.isConstructor; +import static net.bytebuddy.matcher.ElementMatchers.named; +import static net.bytebuddy.matcher.ElementMatchers.none; +import static org.apache.cassandra.testing.utils.AssertionUtils.getBlocking; +import static org.assertj.core.api.Assertions.assertThat; + +public class JmxReconnectTest extends SharedClusterSidecarIntegrationTestBase +{ + @Override + protected void initializeSchemaForTest() + { + // NO schema needed + } + + static + { + Instrumentation inst = ByteBuddyAgent.install(); + + // Make Holder + CtorAdvice visible to bootstrap + File bootstrapJar = null; + try + { + bootstrapJar = createBootstrapJar(); + inst.appendToBootstrapClassLoaderSearch(new JarFile(bootstrapJar)); + } + catch (Exception e) + { + throw new RuntimeException(e); + } + + // Intercept RMIConnector's getAttribute method + new AgentBuilder.Default() + .ignore(none()) + .with(AgentBuilder.RedefinitionStrategy.RETRANSFORMATION) + .type(named("javax.management.remote.rmi.RMIConnector$RemoteMBeanServerConnection")) + .transform((builder, td, cl, m, i) -> + builder.visit(Advice.to(GetAttributeAdvice.class).on(named("getAttribute"))) + ) + .installOn(inst); + + // Intercept RMIClientCommunicatorAdmin's constructor to capture the object + new AgentBuilder.Default() + .ignore(none()) + .with(AgentBuilder.RedefinitionStrategy.RETRANSFORMATION) + .type(named("javax.management.remote.rmi.RMIConnector$RMIClientCommunicatorAdmin")) + .transform((builder, td, cl, m, i) -> + builder.visit(Advice.to(ConstructorAdvice.class).on(isConstructor())) + ) + .installOn(inst); + } + + /** + * Holder for a list of objects. + */ + // Must not reference any non-JDK types! + public static class ObjectHolder + { + public static List<Object> instance = new ArrayList<>(); + + public static void set(Object o) + { + instance.add(o); + } + } + + /** + * Interceptor for constructor of RMIConnector$RMIClientCommunicatorAdmin. + */ + public static class ConstructorAdvice + { + @Advice.OnMethodExit + static void after(@Advice.This Object self) + { + ObjectHolder.set(self); + } + } + + /** + * Interceptor for getAttribute method of RMIConnector. + */ + public static class GetAttributeAdvice + { + // Call RMIClientCommunicatorAdmin.gotIOException when RMIConnector.getAttribute is called + // and the stack trace has doStart method call. + @Advice.OnMethodEnter + static void before(@Advice.This Object self) + { + try + { + String str = Arrays.stream(Thread.currentThread().getStackTrace()).map(Object::toString).collect(Collectors.joining(System.lineSeparator())); + if (str.contains("doStart")) + { + // Get reference of RMIConnector outer class + Field this0field = self.getClass().getDeclaredField("this$0"); + this0field.setAccessible(true); + RMIConnector rmiConnector = (RMIConnector) this0field.get(self); + + // Get RMIClientCommunicatorAdmin object of RMIConnector + Field commAdminField = RMIConnector.class.getDeclaredField("communicatorAdmin"); + commAdminField.setAccessible(true); + Object obj = commAdminField.get(rmiConnector); + + // Call RMIClientCommunicatorAdmin.gotIOException + Method m = obj.getClass().getDeclaredMethod("gotIOException", IOException.class); + m.setAccessible(true); + m.invoke(obj, new NoSuchObjectException("injected")); + } + } + catch (Exception ex) + { + throw new RuntimeException(ex); + } + } + } + + private static File createBootstrapJar() throws Exception + { + File jar = File.createTempFile("bb-bootstrap", ".jar"); + jar.deleteOnExit(); + + try (JarOutputStream jos = new JarOutputStream(new FileOutputStream(jar))) + { + addClassToJar(jos, ObjectHolder.class); + addClassToJar(jos, ConstructorAdvice.class); + addClassToJar(jos, GetAttributeAdvice.class); + } + + return jar; + } + + private static void addClassToJar(JarOutputStream jos, Class<?> clazz) throws IOException + { + String name = clazz.getName().replace('.', '/') + ".class"; + jos.putNextEntry(new JarEntry(name)); + try (InputStream is = clazz.getClassLoader().getResourceAsStream(name)) + { + Assertions.assertNotNull(is); + is.transferTo(jos); + } + jos.closeEntry(); + } + + /** + * Tests JMX reconnection handling to prevent deadlocks in ClientCommunicatorAdmin.restart. Review Comment: Please add a reference to the jira ticket. It is a nit. The javadoc already did an excellent job regarding the bug. ########## integration-tests/src/integrationTest/org/apache/cassandra/sidecar/health/JmxReconnectTest.java: ########## @@ -0,0 +1,252 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.cassandra.sidecar.health; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.lang.instrument.Instrumentation; +import java.lang.reflect.Field; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.rmi.NoSuchObjectException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.jar.JarEntry; +import java.util.jar.JarFile; +import java.util.jar.JarOutputStream; +import java.util.stream.Collectors; +import javax.management.remote.rmi.RMIConnector; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +import io.vertx.core.buffer.Buffer; +import io.vertx.ext.web.client.HttpResponse; +import net.bytebuddy.agent.ByteBuddyAgent; +import net.bytebuddy.agent.builder.AgentBuilder; +import net.bytebuddy.asm.Advice; +import org.apache.cassandra.sidecar.common.ApiEndpointsV1; +import org.apache.cassandra.sidecar.common.response.RingResponse; +import org.apache.cassandra.sidecar.testing.SharedClusterSidecarIntegrationTestBase; + +import static net.bytebuddy.matcher.ElementMatchers.isConstructor; +import static net.bytebuddy.matcher.ElementMatchers.named; +import static net.bytebuddy.matcher.ElementMatchers.none; +import static org.apache.cassandra.testing.utils.AssertionUtils.getBlocking; +import static org.assertj.core.api.Assertions.assertThat; + +public class JmxReconnectTest extends SharedClusterSidecarIntegrationTestBase +{ + @Override + protected void initializeSchemaForTest() + { + // NO schema needed + } + + static + { + Instrumentation inst = ByteBuddyAgent.install(); + + // Make Holder + CtorAdvice visible to bootstrap + File bootstrapJar = null; + try + { + bootstrapJar = createBootstrapJar(); + inst.appendToBootstrapClassLoaderSearch(new JarFile(bootstrapJar)); + } + catch (Exception e) + { + throw new RuntimeException(e); + } + + // Intercept RMIConnector's getAttribute method + new AgentBuilder.Default() + .ignore(none()) + .with(AgentBuilder.RedefinitionStrategy.RETRANSFORMATION) + .type(named("javax.management.remote.rmi.RMIConnector$RemoteMBeanServerConnection")) + .transform((builder, td, cl, m, i) -> + builder.visit(Advice.to(GetAttributeAdvice.class).on(named("getAttribute"))) + ) + .installOn(inst); + + // Intercept RMIClientCommunicatorAdmin's constructor to capture the object + new AgentBuilder.Default() + .ignore(none()) + .with(AgentBuilder.RedefinitionStrategy.RETRANSFORMATION) + .type(named("javax.management.remote.rmi.RMIConnector$RMIClientCommunicatorAdmin")) + .transform((builder, td, cl, m, i) -> + builder.visit(Advice.to(ConstructorAdvice.class).on(isConstructor())) + ) + .installOn(inst); + } + + /** + * Holder for a list of objects. + */ + // Must not reference any non-JDK types! + public static class ObjectHolder + { + public static List<Object> instance = new ArrayList<>(); + + public static void set(Object o) + { + instance.add(o); + } + } + + /** + * Interceptor for constructor of RMIConnector$RMIClientCommunicatorAdmin. + */ + public static class ConstructorAdvice + { + @Advice.OnMethodExit + static void after(@Advice.This Object self) + { + ObjectHolder.set(self); + } + } + + /** + * Interceptor for getAttribute method of RMIConnector. + */ + public static class GetAttributeAdvice + { + // Call RMIClientCommunicatorAdmin.gotIOException when RMIConnector.getAttribute is called + // and the stack trace has doStart method call. + @Advice.OnMethodEnter + static void before(@Advice.This Object self) + { + try + { + String str = Arrays.stream(Thread.currentThread().getStackTrace()).map(Object::toString).collect(Collectors.joining(System.lineSeparator())); + if (str.contains("doStart")) + { + // Get reference of RMIConnector outer class + Field this0field = self.getClass().getDeclaredField("this$0"); + this0field.setAccessible(true); + RMIConnector rmiConnector = (RMIConnector) this0field.get(self); + + // Get RMIClientCommunicatorAdmin object of RMIConnector + Field commAdminField = RMIConnector.class.getDeclaredField("communicatorAdmin"); + commAdminField.setAccessible(true); + Object obj = commAdminField.get(rmiConnector); + + // Call RMIClientCommunicatorAdmin.gotIOException + Method m = obj.getClass().getDeclaredMethod("gotIOException", IOException.class); + m.setAccessible(true); + m.invoke(obj, new NoSuchObjectException("injected")); + } + } + catch (Exception ex) + { + throw new RuntimeException(ex); + } + } + } + + private static File createBootstrapJar() throws Exception + { + File jar = File.createTempFile("bb-bootstrap", ".jar"); + jar.deleteOnExit(); + + try (JarOutputStream jos = new JarOutputStream(new FileOutputStream(jar))) + { + addClassToJar(jos, ObjectHolder.class); + addClassToJar(jos, ConstructorAdvice.class); + addClassToJar(jos, GetAttributeAdvice.class); + } + + return jar; + } + + private static void addClassToJar(JarOutputStream jos, Class<?> clazz) throws IOException + { + String name = clazz.getName().replace('.', '/') + ".class"; + jos.putNextEntry(new JarEntry(name)); + try (InputStream is = clazz.getClassLoader().getResourceAsStream(name)) + { + Assertions.assertNotNull(is); + is.transferTo(jos); + } + jos.closeEntry(); + } Review Comment: 😬 no objection, but the approach is indeed hacky. ########## integration-tests/src/integrationTest/org/apache/cassandra/sidecar/health/JmxReconnectTest.java: ########## @@ -0,0 +1,252 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.cassandra.sidecar.health; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.lang.instrument.Instrumentation; +import java.lang.reflect.Field; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.rmi.NoSuchObjectException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.jar.JarEntry; +import java.util.jar.JarFile; +import java.util.jar.JarOutputStream; +import java.util.stream.Collectors; +import javax.management.remote.rmi.RMIConnector; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +import io.vertx.core.buffer.Buffer; +import io.vertx.ext.web.client.HttpResponse; +import net.bytebuddy.agent.ByteBuddyAgent; +import net.bytebuddy.agent.builder.AgentBuilder; +import net.bytebuddy.asm.Advice; +import org.apache.cassandra.sidecar.common.ApiEndpointsV1; +import org.apache.cassandra.sidecar.common.response.RingResponse; +import org.apache.cassandra.sidecar.testing.SharedClusterSidecarIntegrationTestBase; + +import static net.bytebuddy.matcher.ElementMatchers.isConstructor; +import static net.bytebuddy.matcher.ElementMatchers.named; +import static net.bytebuddy.matcher.ElementMatchers.none; +import static org.apache.cassandra.testing.utils.AssertionUtils.getBlocking; +import static org.assertj.core.api.Assertions.assertThat; + +public class JmxReconnectTest extends SharedClusterSidecarIntegrationTestBase Review Comment: The test is quite complex. Could you run it repeatedly to ensure no flakiness? I will do the same on my local. ########## server/src/main/java/org/apache/cassandra/sidecar/cluster/CassandraAdapterDelegate.java: ########## @@ -645,12 +645,8 @@ public void handleNotification(Notification notification, Object handback) switch (type) { case JMXConnectionNotification.OPENED: - // Do not notify here as we may not have set up our own delegate yet - // Instead, run the JMX Health Check, which will notify once we have - // created or updated the adapter. - jmxHealthCheck(); + LOGGER.debug("JMX connection opened"); Review Comment: Please document the jxm connection behavior and explain why no jmx connection should be attempted for this notification. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
