Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,19 @@ public Set<String> getCoprocessors() {
return returnValue;
}

/**
* Get the full class names of all loaded coprocessors. This method returns the complete class
* names including package information, which is useful for precise coprocessor identification and
* comparison.
*/
public Set<String> getCoprocessorClassNames() {
Set<String> returnValue = new TreeSet<>();
for (E e : coprocEnvironments) {
returnValue.add(e.getInstance().getClass().getName());
}
return returnValue;
}

/**
* Load system coprocessors once only. Read the class names from configuration. Called by
* constructor.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1054,7 +1054,7 @@ private void finishActiveMasterInitialization() throws IOException, InterruptedE
if (!maintenanceMode) {
startupTaskGroup.addTask("Initializing master coprocessors");
setQuotasObserver(conf);
initializeCoprocessorHost(conf);
this.cpHost = new MasterCoprocessorHost(this, conf);
}

// Checking if meta needs initializing.
Expand Down Expand Up @@ -4380,11 +4380,11 @@ public void onConfigurationChange(Configuration newConf) {
setQuotasObserver(newConf);
// update region server coprocessor if the configuration has changed.
if (
CoprocessorConfigurationUtil.checkConfigurationChange(getConfiguration(), newConf,
CoprocessorConfigurationUtil.checkConfigurationChange(this.cpHost, newConf,
CoprocessorHost.MASTER_COPROCESSOR_CONF_KEY) && !maintenanceMode
) {
LOG.info("Update the master coprocessor(s) because the configuration has changed");
initializeCoprocessorHost(newConf);
this.cpHost = new MasterCoprocessorHost(this, newConf);
}
}

Expand All @@ -4396,11 +4396,6 @@ private void setQuotasObserver(Configuration conf) {
}
}

private void initializeCoprocessorHost(Configuration conf) {
// initialize master side coprocessors before we start handling requests
this.cpHost = new MasterCoprocessorHost(this, conf);
}

@Override
public long flushTable(TableName tableName, List<byte[]> columnFamilies, long nonceGroup,
long nonce) throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8528,7 +8528,7 @@ public void onConfigurationChange(Configuration conf) {
this.storeHotnessProtector.update(conf);
// update coprocessorHost if the configuration has changed.
if (
CoprocessorConfigurationUtil.checkConfigurationChange(getReadOnlyConfiguration(), conf,
CoprocessorConfigurationUtil.checkConfigurationChange(this.coprocessorHost, conf,
CoprocessorHost.REGION_COPROCESSOR_CONF_KEY,
CoprocessorHost.USER_REGION_COPROCESSOR_CONF_KEY)
) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4010,7 +4010,7 @@ public void onConfigurationChange(Configuration newConf) {

// update region server coprocessor if the configuration has changed.
if (
CoprocessorConfigurationUtil.checkConfigurationChange(getConfiguration(), newConf,
CoprocessorConfigurationUtil.checkConfigurationChange(this.rsHost, newConf,
CoprocessorHost.REGIONSERVER_COPROCESSOR_CONF_KEY)
) {
LOG.info("Update region server coprocessors because the configuration has changed");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@
*/
package org.apache.hadoop.hbase.util;

import org.apache.commons.lang3.StringUtils;
import java.util.HashSet;
import java.util.Set;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.coprocessor.CoprocessorHost;
import org.apache.yetus.audience.InterfaceAudience;

import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;
import org.apache.hbase.thirdparty.com.google.common.base.Strings;

/**
* Helper class for coprocessor host when configuration changes.
Expand All @@ -32,19 +35,71 @@ public final class CoprocessorConfigurationUtil {
private CoprocessorConfigurationUtil() {
}

public static boolean checkConfigurationChange(Configuration oldConfig, Configuration newConfig,
String... configurationKey) {
/**
* Check configuration change by comparing current loaded coprocessors with configuration values.
* This method is useful when the configuration object has been updated but we need to determine
* if coprocessor configuration has actually changed compared to what's currently loaded.
* <p>
* <b>Note:</b> This method only detects changes in the set of coprocessor class names. It does
* <b>not</b> detect changes to priority or path for coprocessors that are already loaded with the
* same class name. If you need to update the priority or path of an existing coprocessor, you
* must restart the region/regionserver/master.
* @param coprocessorHost the coprocessor host to check current loaded coprocessors (can be null)
* @param conf the configuration to check
* @param configurationKey the configuration keys to check
* @return true if configuration has changed, false otherwise
*/
public static boolean checkConfigurationChange(CoprocessorHost<?, ?> coprocessorHost,
Configuration conf, String... configurationKey) {
Preconditions.checkArgument(configurationKey != null, "Configuration Key(s) must be provided");
boolean isConfigurationChange = false;
Preconditions.checkArgument(conf != null, "Configuration must be provided");

if (
!conf.getBoolean(CoprocessorHost.COPROCESSORS_ENABLED_CONF_KEY,
CoprocessorHost.DEFAULT_COPROCESSORS_ENABLED)
) {
return false;
}

if (coprocessorHost == null) {
// If no coprocessor host exists, check if any coprocessors are now configured
return hasCoprocessorsConfigured(conf, configurationKey);
}

// Get currently loaded coprocessor class names
Set<String> currentlyLoaded = coprocessorHost.getCoprocessorClassNames();

// Get coprocessor class names from configuration
// Only class names are compared; priority and path changes are not detected
Set<String> configuredClasses = new HashSet<>();
for (String key : configurationKey) {
String[] classes = conf.getStrings(key);
if (classes != null) {
for (String className : classes) {
// Handle the className|priority|path format
String[] classNameToken = className.split("\\|");
String actualClassName = classNameToken[0].trim();
if (!Strings.isNullOrEmpty(actualClassName)) {
configuredClasses.add(actualClassName);
}
}
}
}

// Compare the two sets
return !currentlyLoaded.equals(configuredClasses);
}

/**
* Helper method to check if there are any coprocessors configured.
*/
private static boolean hasCoprocessorsConfigured(Configuration conf, String... configurationKey) {
for (String key : configurationKey) {
String oldValue = oldConfig.get(key);
String newValue = newConfig.get(key);
// check if the coprocessor key has any difference
if (!StringUtils.equalsIgnoreCase(oldValue, newValue)) {
isConfigurationChange = true;
break;
String[] coprocessors = conf.getStrings(key);
if (coprocessors != null && coprocessors.length > 0) {
return true;
}
}
return isConfigurationChange;
return false;
}
Comment on lines +96 to 104
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hasCoprocessorsConfigured method does not properly validate coprocessor entries. It returns true if the array is non-empty, but doesn't check if the entries contain actual coprocessor class names (they could be empty strings or whitespace). This could cause the method to return true even when no valid coprocessors are configured.

Consider checking if any of the entries actually contain non-empty class names after parsing, similar to how configuredClasses is built in checkConfigurationChange.

Copilot uses AI. Check for mistakes.
}
Comment on lines +38 to 105
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The significantly modified checkConfigurationChange method and the new hasCoprocessorsConfigured helper method lack direct unit test coverage. Given that this utility has comprehensive logic for comparing coprocessor configurations and handles edge cases like parsing className|priority|path format, these methods should have dedicated unit tests to verify correctness.

Consider adding a TestCoprocessorConfigurationUtil test class to cover:

  • Checking configuration changes when coprocessor host is null
  • Checking configuration changes with various coprocessor class name formats
  • Handling className|priority|path format parsing
  • Verifying the behavior when coprocessors are enabled/disabled
  • Testing the hasCoprocessorsConfigured helper with various inputs

Copilot uses AI. Check for mistakes.
Original file line number Diff line number Diff line change
Expand Up @@ -230,18 +230,22 @@ public void testStoreConfigurationOnlineChange() {
@Test
public void testCoprocessorConfigurationOnlineChange() {
assertNull(rs1.getRegionServerCoprocessorHost().findCoprocessor(JMXListener.class.getName()));
conf.set(CoprocessorHost.REGIONSERVER_COPROCESSOR_CONF_KEY, JMXListener.class.getName());
rs1.getConfigurationManager().notifyAllObservers(conf);
// Update configuration directly to simulate dynamic configuration reload
Configuration rsConf = rs1.getConfiguration();
rsConf.set(CoprocessorHost.REGIONSERVER_COPROCESSOR_CONF_KEY, JMXListener.class.getName());
rs1.getConfigurationManager().notifyAllObservers(rsConf);
assertNotNull(
rs1.getRegionServerCoprocessorHost().findCoprocessor(JMXListener.class.getName()));
}

@Test
public void testCoprocessorConfigurationOnlineChangeOnMaster() {
assertNull(hMaster.getMasterCoprocessorHost().findCoprocessor(JMXListener.class.getName()));
conf.set(CoprocessorHost.MASTER_COPROCESSOR_CONF_KEY, JMXListener.class.getName());
// Update configuration directly to simulate dynamic configuration reload
Configuration masterConf = hMaster.getConfiguration();
masterConf.set(CoprocessorHost.MASTER_COPROCESSOR_CONF_KEY, JMXListener.class.getName());
assertFalse(hMaster.isInMaintenanceMode());
hMaster.getConfigurationManager().notifyAllObservers(conf);
hMaster.getConfigurationManager().notifyAllObservers(masterConf);
assertNotNull(hMaster.getMasterCoprocessorHost().findCoprocessor(JMXListener.class.getName()));
}

Expand Down