Skip to content
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

EJBCLIENT-485 Change the default for additional-node-timeout to 200 ms #599

Merged
merged 1 commit into from Jan 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -78,7 +78,7 @@ public final class DiscoveryEJBClientInterceptor implements EJBClientInterceptor
// This provides a way timeout a discovery, avoiding blocking on some edge cases. See EJBCLIENT-311.
private static final long DISCOVERY_TIMEOUT = SecurityUtils.getLong(SystemProperties.DISCOVERY_TIMEOUT, 0L);
//how long to wait if at least one node has already been discovered. This one is in ms rather than s
private static final long DISCOVERY_ADDITIONAL_TIMEOUT = SecurityUtils.getLong(SystemProperties.DISCOVERY_ADDITIONAL_NODE_TIMEOUT, 0L);
private static final long DISCOVERY_ADDITIONAL_TIMEOUT = SecurityUtils.getLong(SystemProperties.DISCOVERY_ADDITIONAL_NODE_TIMEOUT, 200L);

/**
* This interceptor's priority.
Expand Down Expand Up @@ -543,6 +543,7 @@ private List<Throwable> doAnyDiscovery(AbstractInvocationContext context, final
//one has already been discovered, we may want a shorter timeout for additional nodes
if (DISCOVERY_ADDITIONAL_TIMEOUT != 0) {
timeout = DISCOVERY_ADDITIONAL_TIMEOUT; //this one is actually in ms, you generally want it very short
Logs.MAIN.warnf(" DISCOVERY_ADDITIONAL_TIMEOUT = %s", timeout);
}
}
}
Expand Down
@@ -0,0 +1,138 @@
/*
* JBoss, Home of Professional Open Source.
* Copyright 2019 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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 org.jboss.ejb.client.test;

import java.net.InetAddress;
import java.net.ServerSocket;

import org.jboss.ejb.client.Affinity;
import org.jboss.ejb.client.EJBClient;
import org.jboss.ejb.client.EJBLocator;
import org.jboss.ejb.client.StatelessEJBLocator;
import org.jboss.ejb.client.legacy.JBossEJBProperties;
import org.jboss.ejb.client.test.common.Echo;
import org.jboss.ejb.client.test.common.Result;
import org.jboss.logging.Logger;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

/**
* Tests discovery timeouts in the default configuration.
*
* These tests are separate from the {@link NetworkBlackHoleInvocationTestCase} because the timeout configuration is loaded
* into static class fields. So once the configuration is set by one test, it cannot be changed by another test in the same
* test class.
*
* @author <a href="thofman@redhat.com">Tomas Hofman</a>
*/
public class DefaultConfigurationDiscoveryTestCase extends AbstractEJBClientTestCase {

private static final Logger logger = Logger.getLogger(DefaultConfigurationDiscoveryTestCase.class);
private static final String PROPERTIES_FILE = "broken-server-jboss-ejb-client.properties";

@BeforeClass
public static void beforeClass() throws Exception {
// trigger the static init of the correct properties file - this also depends on running in forkMode=always
JBossEJBProperties ejbProperties = JBossEJBProperties.fromClassPath(SimpleInvocationTestCase.class.getClassLoader(), PROPERTIES_FILE);
JBossEJBProperties.getContextManager().setGlobalDefault(ejbProperties);
}

@Before
public void beforeTest() throws Exception {
startServer(0, 6999);
startServer(1, 7099);

deployStateless(0);
deployStateless(1);

// define clusters
defineCluster(0, CLUSTER);
defineCluster(1, CLUSTER);
}

@After
public void afterTest() {
// wipe cluster
removeCluster(0, CLUSTER_NAME);
removeCluster(1, CLUSTER_NAME);

undeployStateless(0);
undeployStateless(1);

stopServer(0);
stopServer(1);
}

/**
* Tests that node discovery doesn't wait for additional nodes being discovered, if it already has one available node
* and the additional-node-timeout is not set.
*/
@Test(timeout = 4000)
public void testDiscoveryTimeoutWithoutAffinityNoTimeoutSet() throws Exception {
Assert.assertNull(System.getProperty("org.jboss.ejb.client.discovery.additional-node-timeout"));

logger.info("Starting testDiscoveryTimeoutWithoutAffinity");
testDiscoveryTimeout(Affinity.NONE);
}

private void testDiscoveryTimeout(final Affinity affinity) throws Exception {
final StatelessEJBLocator<Echo> locator = StatelessEJBLocator.create(Echo.class, STATELESS_IDENTIFIER, affinity);

// verify that client invocation works when both nodes are responsive
verifyClient(locator);

// stop second node and open a socket at the same port to simulate an unresponsive node
stopServer(1);
try (ServerSocket ignore = new ServerSocket(7099, 100, InetAddress.getByName("localhost"))) {
verifyClient(locator);
}
}

/**
* Creates the proxy to invoke the target ejb, and verifies that the
* invocation returns promptly (less than the maximum time).
* @param locator ejb locator for creating proxy
*/
private static void verifyClient(EJBLocator<Echo> locator) {
final Echo proxy = EJBClient.createProxy(locator);
Assert.assertNotNull("Received a null proxy", proxy);

logger.info("Invoking on proxy " + proxy);
// Invoke on the proxy. This should fail in 10 seconds or else it'll hang.
final String message = "hello!";

long invocationStart = System.currentTimeMillis();
Result<String> result = proxy.echo(message);
final long invocationTime = System.currentTimeMillis() - invocationStart;

assertInvocationTimeLessThan(invocationTime, result);
Assert.assertEquals(message, result.getValue());
}

private static void assertInvocationTimeLessThan(long invocationTime, Result<String> result) {
final long maximumInvocationTimeMs = 3000;
logger.infof("Invocation returned from %s in %d ms", result.getNode(), invocationTime);
if (invocationTime > maximumInvocationTimeMs) {
Assert.fail(String.format("org.jboss.ejb.client.discovery.additional-node-timeout ineffective: invocation time: %d > maximum expected invocation time: %d",
invocationTime, maximumInvocationTimeMs));
}
}
}