Skip to content

HBASE-30247 Validate negative client timeout configuration #8458

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

Open
velpro-8620 wants to merge 1 commit into
base: master
Choose a base branch
from
+75 −19
Open

HBASE-30247 Validate negative client timeout configuration #8458

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
47 changes: 28 additions & 19 deletions hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,15 @@ public class ConnectionConfiguration {
// toggle for async/sync prefetch
private final boolean clientScannerAsyncPrefetch;

private static int getNonNegativeInt(Configuration conf, String key, int defaultValue) {
int value = conf.getInt(key, defaultValue);
if (value < 0) {
throw new IllegalArgumentException(
"The " + key + " must be non-negative, current value is " + value);
}
return value;
}

/**
* Constructor
* @param conf Configuration object
Expand All @@ -93,28 +102,27 @@ public class ConnectionConfiguration {
this.writeBufferPeriodicFlushTimerTickMs = conf.getLong(
WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS, WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS_DEFAULT);

this.metaOperationTimeout = conf.getInt(HConstants.HBASE_CLIENT_META_OPERATION_TIMEOUT,
conf.getInt(HConstants.HBASE_CLIENT_OPERATION_TIMEOUT,
HConstants.DEFAULT_HBASE_CLIENT_OPERATION_TIMEOUT));

this.operationTimeout = conf.getInt(HConstants.HBASE_CLIENT_OPERATION_TIMEOUT,
this.operationTimeout = getNonNegativeInt(conf, HConstants.HBASE_CLIENT_OPERATION_TIMEOUT,
HConstants.DEFAULT_HBASE_CLIENT_OPERATION_TIMEOUT);

this.metaOperationTimeout = getNonNegativeInt(conf,
HConstants.HBASE_CLIENT_META_OPERATION_TIMEOUT, operationTimeout);

this.scannerCaching = conf.getInt(HConstants.HBASE_CLIENT_SCANNER_CACHING,
HConstants.DEFAULT_HBASE_CLIENT_SCANNER_CACHING);

this.scannerMaxResultSize = conf.getLong(HConstants.HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY,
HConstants.DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE);

this.primaryCallTimeoutMicroSecond =
conf.getInt(PRIMARY_CALL_TIMEOUT_MICROSECOND, PRIMARY_CALL_TIMEOUT_MICROSECOND_DEFAULT);
this.primaryCallTimeoutMicroSecond = getNonNegativeInt(conf, PRIMARY_CALL_TIMEOUT_MICROSECOND,
PRIMARY_CALL_TIMEOUT_MICROSECOND_DEFAULT);

this.replicaCallTimeoutMicroSecondScan =
conf.getInt(PRIMARY_SCAN_TIMEOUT_MICROSECOND, PRIMARY_SCAN_TIMEOUT_MICROSECOND_DEFAULT);
this.replicaCallTimeoutMicroSecondScan = getNonNegativeInt(conf, PRIMARY_SCAN_TIMEOUT_MICROSECOND,
PRIMARY_SCAN_TIMEOUT_MICROSECOND_DEFAULT);
Comment on lines +120 to +121

this.metaReplicaCallTimeoutMicroSecondScan =
conf.getInt(HConstants.HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT,
HConstants.HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT_DEFAULT);
this.metaReplicaCallTimeoutMicroSecondScan = getNonNegativeInt(conf,
HConstants.HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT,
HConstants.HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT_DEFAULT);

this.retries = conf.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER,
HConstants.DEFAULT_HBASE_CLIENT_RETRIES_NUMBER);
Expand All @@ -127,16 +135,17 @@ public class ConnectionConfiguration {
this.bufferedMutatorMaxMutations =
conf.getInt(BUFFERED_MUTATOR_MAX_MUTATIONS_KEY, BUFFERED_MUTATOR_MAX_MUTATIONS_DEFAULT);

this.rpcTimeout =
conf.getInt(HConstants.HBASE_RPC_TIMEOUT_KEY, HConstants.DEFAULT_HBASE_RPC_TIMEOUT);
this.rpcTimeout = getNonNegativeInt(conf, HConstants.HBASE_RPC_TIMEOUT_KEY,
HConstants.DEFAULT_HBASE_RPC_TIMEOUT);

this.readRpcTimeout = conf.getInt(HConstants.HBASE_RPC_READ_TIMEOUT_KEY,
conf.getInt(HConstants.HBASE_RPC_TIMEOUT_KEY, HConstants.DEFAULT_HBASE_RPC_TIMEOUT));
this.readRpcTimeout =
getNonNegativeInt(conf, HConstants.HBASE_RPC_READ_TIMEOUT_KEY, rpcTimeout);

this.metaReadRpcTimeout = conf.getInt(HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY, readRpcTimeout);
this.metaReadRpcTimeout =
getNonNegativeInt(conf, HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY, readRpcTimeout);

this.writeRpcTimeout = conf.getInt(HConstants.HBASE_RPC_WRITE_TIMEOUT_KEY,
conf.getInt(HConstants.HBASE_RPC_TIMEOUT_KEY, HConstants.DEFAULT_HBASE_RPC_TIMEOUT));
this.writeRpcTimeout =
getNonNegativeInt(conf, HConstants.HBASE_RPC_WRITE_TIMEOUT_KEY, rpcTimeout);
}

/**
Expand Down
47 changes: 47 additions & 0 deletions hbase-client/src/test/java/org/apache/hadoop/hbase/client/TestConnectionConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@
package org.apache.hadoop.hbase.client;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Arrays;
import java.util.List;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.HBaseConfiguration;
import org.apache.hadoop.hbase.HConstants;
Expand All @@ -44,4 +48,47 @@ public void testDefaultMetaOperationTimeout() {
assertEquals(clientOperationTimeoutMs, config.getMetaOperationTimeout());
}

@Test
public void testNegativeTimeoutsThrow() {
List<String> timeoutKeys = Arrays.asList(HConstants.HBASE_CLIENT_META_OPERATION_TIMEOUT,
HConstants.HBASE_CLIENT_OPERATION_TIMEOUT, ConnectionConfiguration.PRIMARY_CALL_TIMEOUT_MICROSECOND,
ConnectionConfiguration.PRIMARY_SCAN_TIMEOUT_MICROSECOND,
HConstants.HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT, HConstants.HBASE_RPC_TIMEOUT_KEY,
HConstants.HBASE_RPC_READ_TIMEOUT_KEY, ConnectionConfiguration.HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY,
HConstants.HBASE_RPC_WRITE_TIMEOUT_KEY);
Comment on lines +53 to +58

for (String key : timeoutKeys) {
Configuration conf = HBaseConfiguration.create();
conf.setInt(key, -1);
IllegalArgumentException error =
assertThrows(IllegalArgumentException.class, () -> new ConnectionConfiguration(conf), key);
assertTrue(error.getMessage().contains(key), key);
}
}

@Test
public void testZeroTimeoutsAreAllowed() {
Configuration conf = HBaseConfiguration.create();
conf.setInt(HConstants.HBASE_CLIENT_OPERATION_TIMEOUT, 0);
conf.setInt(HConstants.HBASE_CLIENT_META_OPERATION_TIMEOUT, 0);
conf.setInt(ConnectionConfiguration.PRIMARY_CALL_TIMEOUT_MICROSECOND, 0);
conf.setInt(ConnectionConfiguration.PRIMARY_SCAN_TIMEOUT_MICROSECOND, 0);
conf.setInt(HConstants.HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT, 0);
conf.setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, 0);
conf.setInt(HConstants.HBASE_RPC_READ_TIMEOUT_KEY, 0);
conf.setInt(ConnectionConfiguration.HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY, 0);
conf.setInt(HConstants.HBASE_RPC_WRITE_TIMEOUT_KEY, 0);

ConnectionConfiguration config = new ConnectionConfiguration(conf);
assertEquals(0, config.getOperationTimeout());
assertEquals(0, config.getMetaOperationTimeout());
assertEquals(0, config.getPrimaryCallTimeoutMicroSecond());
assertEquals(0, config.getReplicaCallTimeoutMicroSecondScan());
assertEquals(0, config.getMetaReplicaCallTimeoutMicroSecondScan());
assertEquals(0, config.getRpcTimeout());
assertEquals(0, config.getReadRpcTimeout());
assertEquals(0, config.getMetaReadRpcTimeout());
assertEquals(0, config.getWriteRpcTimeout());
}

}
Loading