Skip to content

Fixed UDF jar metadata handling in UDFInfo when multiple UDFs share the same jar #17732

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
Caideyipi wants to merge 2 commits into
base: master
Choose a base branch
from
+101 −27
Open

Fixed UDF jar metadata handling in UDFInfo when multiple UDFs share the same jar #17732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e822a94
UDF Fix
Caideyipi May 21, 2026
2c62c39
sp
Caideyipi May 21, 2026
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
36 changes: 34 additions & 2 deletions iotdb-core/confignode/src/main/java/org/apache/iotdb/confignode/persistence/UDFInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@

private final UDFTable udfTable;
private final Map<String, String> existedJarToMD5;
private final Map<String, Integer> existedJarToReferenceCount;

private final UDFExecutableManager udfExecutableManager;

Expand All @@ -78,6 +79,7 @@
public UDFInfo() throws IOException {
udfTable = new UDFTable();
existedJarToMD5 = new HashMap<>();
existedJarToReferenceCount = new HashMap<>();
udfExecutableManager =
UDFExecutableManager.setupAndGetInstance(
CONFIG_NODE_CONF.getUdfTemporaryLibDir(), CONFIG_NODE_CONF.getUdfDir());
Expand Down Expand Up @@ -135,7 +137,7 @@
final UDFInformation udfInformation = physicalPlan.getUdfInformation();
udfTable.addUDFInformation(udfInformation.getFunctionName(), udfInformation);
if (udfInformation.isUsingURI()) {
existedJarToMD5.put(udfInformation.getJarName(), udfInformation.getJarMD5());
addJarReference(udfInformation.getJarName(), udfInformation.getJarMD5());
if (physicalPlan.getJarFile() != null) {
udfExecutableManager.saveToInstallDir(
ByteBuffer.wrap(physicalPlan.getJarFile().getValues()), udfInformation.getJarName());
Expand Down Expand Up @@ -185,7 +187,10 @@

public TSStatus dropFunction(Model model, String functionName) {
if (udfTable.containsUDF(model, functionName)) {
existedJarToMD5.remove(udfTable.getUDFInformation(model, functionName).getJarName());
final UDFInformation udfInformation = udfTable.getUDFInformation(model, functionName);
if (udfInformation.isUsingURI()) {
removeJarReference(udfInformation.getJarName());
}
udfTable.removeUDFInformation(model, functionName);
}
return new TSStatus(TSStatusCode.SUCCESS_STATUS.getStatusCode());
Expand Down Expand Up @@ -248,6 +253,7 @@
deserializeExistedJarToMD5(fileInputStream);

udfTable.deserializeUDFTable(fileInputStream);
rebuildJarMetadataFromUDFTable();
Copy link
Copy Markdown
Member

@luoluoyuyu luoluoyuyu May 27, 2026

Choose a reason for hiding this comment

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

After deserializeExistedJarToMD5, rebuildJarMetadataFromUDFTable() clears both maps and rebuilds from udfTable. That makes udfTable the source of truth on load.

A short comment here explaining that deserialized existedJarToMD5 is intentionally discarded would help future readers.

} finally {
releaseUDFTableLock();
}
Expand All @@ -272,6 +278,32 @@

public void clear() {
existedJarToMD5.clear();
existedJarToReferenceCount.clear();
udfTable.clear();
}

private void addJarReference(String jarName, String jarMD5) {
existedJarToMD5.putIfAbsent(jarName, jarMD5);
Copy link
Copy Markdown
Member

@luoluoyuyu luoluoyuyu May 27, 2026

Choose a reason for hiding this comment

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

putIfAbsent keeps the first MD5 for a jar name but always increments the reference count. That is fine when validate() runs before addUDFInTable, but if addJarReference is ever called without that check, ref count and MD5 could diverge.

Consider rejecting a conflicting MD5 inside addJarReference (same check as in validate() at lines 107-115) so this helper is safe on its own.

existedJarToReferenceCount.merge(jarName, 1, Integer::sum);
}

private void removeJarReference(String jarName) {
final Integer referenceCount = existedJarToReferenceCount.get(jarName);
if (referenceCount == null || referenceCount <= 1) {
existedJarToReferenceCount.remove(jarName);
existedJarToMD5.remove(jarName);
return;
}
existedJarToReferenceCount.put(jarName, referenceCount - 1);
}

private void rebuildJarMetadataFromUDFTable() {

Check warning on line 300 in iotdb-core/confignode/src/main/java/org/apache/iotdb/confignode/persistence/UDFInfo.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Abbreviation in name 'rebuildJarMetadataFromUDFTable' must contain no more than '2' consecutive capital letters. 


See more on https://sonarcloud.io/project/issues?id=apache_iotdb&issues=AZ5Imge8RiG7CBVeO-Sc&open=AZ5Imge8RiG7CBVeO-Sc&pullRequest=17732
existedJarToMD5.clear();
existedJarToReferenceCount.clear();
for (UDFInformation udfInformation : udfTable.getAllInformationList()) {
if (udfInformation.isUsingURI()) {
addJarReference(udfInformation.getJarName(), udfInformation.getJarMD5());
}
}
}
}
92 changes: 67 additions & 25 deletions iotdb-core/confignode/src/test/java/org/apache/iotdb/confignode/persistence/UDFInfoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import org.apache.iotdb.common.rpc.thrift.FunctionType;
import org.apache.iotdb.common.rpc.thrift.Model;
import org.apache.iotdb.commons.exception.IllegalPathException;
import org.apache.iotdb.commons.exception.IoTDBRuntimeException;
import org.apache.iotdb.commons.udf.UDFInformation;
import org.apache.iotdb.commons.udf.UDFType;
import org.apache.iotdb.confignode.consensus.request.write.function.CreateFunctionPlan;
Expand All @@ -41,6 +42,10 @@

public class UDFInfoTest {

private static final String SHARED_JAR_NAME = "shared.jar";
private static final String SHARED_JAR_MD5 = "12345";
private static final String DIFFERENT_JAR_MD5 = "54321";

private static UDFInfo udfInfo;
private static UDFInfo udfInfoSaveBefore;
private static final File snapshotDir = new File(BASE_OUTPUT_PATH, "snapshot");
Expand All @@ -63,37 +68,74 @@ public static void cleanup() throws IOException {
}

@Test
public void testSnapshot() throws TException, IOException, IllegalPathException {
UDFInformation udfInformation =
new UDFInformation(
"test1",
"test1",
UDFType.of(Model.TREE, FunctionType.NONE, true),
true,
"test1.jar",
"12345");
CreateFunctionPlan createFunctionPlan =
new CreateFunctionPlan(udfInformation, new Binary(new byte[] {1, 2, 3}));
udfInfo.addUDFInTable(createFunctionPlan);
udfInfoSaveBefore.addUDFInTable(createFunctionPlan);

udfInformation =
new UDFInformation(
"test2",
"test2",
UDFType.of(Model.TREE, FunctionType.NONE, true),
true,
"test2.jar",
"123456");
createFunctionPlan = new CreateFunctionPlan(udfInformation, new Binary(new byte[] {1, 2, 3}));
udfInfo.addUDFInTable(createFunctionPlan);
udfInfoSaveBefore.addUDFInTable(createFunctionPlan);
public void testDropOneSharedJarReferenceKeepsJarMetadata()
throws TException, IOException, IllegalPathException {
clearUdfInfos();

udfInfo.addUDFInTable(createFunctionPlan("test1", SHARED_JAR_NAME, SHARED_JAR_MD5, true));
udfInfo.addUDFInTable(createFunctionPlan("test2", SHARED_JAR_NAME, SHARED_JAR_MD5, false));

udfInfo.dropFunction(Model.TREE, "test1");

Assert.assertFalse(udfInfo.needToSaveJar(SHARED_JAR_NAME));
Assert.assertEquals(1, udfInfo.getRawExistedJarToMD5().size());
Assert.assertEquals(SHARED_JAR_MD5, udfInfo.getRawExistedJarToMD5().get(SHARED_JAR_NAME));

udfInfo.validate(Model.TREE, "test3", SHARED_JAR_NAME, SHARED_JAR_MD5);
try {
udfInfo.validate(Model.TREE, "test3", SHARED_JAR_NAME, DIFFERENT_JAR_MD5);
Assert.fail("Expected shared jar conflict after dropping only one referenced UDF.");
} catch (IoTDBRuntimeException e) {
Assert.assertEquals(
org.apache.iotdb.rpc.TSStatusCode.UDF_ALREADY_EXISTS.getStatusCode(), e.getErrorCode());
}
}

@Test
public void testSnapshotRebuildsSharedJarReferences()
throws TException, IOException, IllegalPathException {
clearUdfInfos();
FileUtils.cleanDirectory(snapshotDir);

CreateFunctionPlan createFunctionPlan1 =
createFunctionPlan("test1", SHARED_JAR_NAME, SHARED_JAR_MD5, true);
CreateFunctionPlan createFunctionPlan2 =
createFunctionPlan("test2", SHARED_JAR_NAME, SHARED_JAR_MD5, false);

udfInfo.addUDFInTable(createFunctionPlan1);
udfInfo.addUDFInTable(createFunctionPlan2);
udfInfoSaveBefore.addUDFInTable(createFunctionPlan1);
udfInfoSaveBefore.addUDFInTable(createFunctionPlan2);

udfInfo.processTakeSnapshot(snapshotDir);
udfInfo.clear();
udfInfo.processLoadSnapshot(snapshotDir);

Assert.assertEquals(udfInfoSaveBefore.getRawExistedJarToMD5(), udfInfo.getRawExistedJarToMD5());
Assert.assertEquals(udfInfoSaveBefore.getRawUDFTable(), udfInfo.getRawUDFTable());

udfInfo.dropFunction(Model.TREE, "test1");
Assert.assertFalse(udfInfo.needToSaveJar(SHARED_JAR_NAME));
Assert.assertEquals(SHARED_JAR_MD5, udfInfo.getRawExistedJarToMD5().get(SHARED_JAR_NAME));
}

private static void clearUdfInfos() {
udfInfo.clear();
udfInfoSaveBefore.clear();
}

private static CreateFunctionPlan createFunctionPlan(
String functionName, String jarName, String jarMD5, boolean includeJarFile)
throws IllegalPathException {
UDFInformation udfInformation =
new UDFInformation(
functionName,
functionName,
UDFType.of(Model.TREE, FunctionType.NONE, true),
true,
jarName,
jarMD5);
return new CreateFunctionPlan(
udfInformation, includeJarFile ? new Binary(new byte[] {1, 2, 3}) : null);
}
}
Loading