From b2c18fdfb91fe3e9e81e4afd14ebfa5d5a47711a Mon Sep 17 00:00:00 2001 From: PrithMDP Date: Wed, 14 Oct 2026 00:52:20 -0400 Subject: [PATCH] Fix DEFAULT quota leak on undefined-type release (#3192) release() returned global quota only when the raw quota type was configured. Tasks with a null or undefined quota type are scheduled as DEFAULT, so assign() deducted from global DEFAULT but release() never restored it. Each such task leaked one unit until global capacity was recomputed, eventually blocking DEFAULT scheduling. Return the quota to the type that was actually deducted, and do not inflate DEFAULT when a quota type was removed while its task ran. --- .../helix/task/AssignableInstanceManager.java | 12 +- ...AssignableInstanceManagerQuotaRelease.java | 145 ++++++++++++++++++ 2 files changed, 155 insertions(+), 2 deletions(-) create mode 100644 helix-core/src/test/java/org/apache/helix/task/TestAssignableInstanceManagerQuotaRelease.java diff --git a/helix-core/src/main/java/org/apache/helix/task/AssignableInstanceManager.java b/helix-core/src/main/java/org/apache/helix/task/AssignableInstanceManager.java index 39ea6002994..5a285b71a6d 100644 --- a/helix-core/src/main/java/org/apache/helix/task/AssignableInstanceManager.java +++ b/helix-core/src/main/java/org/apache/helix/task/AssignableInstanceManager.java @@ -502,8 +502,16 @@ public void release(String instanceName, TaskConfig taskConfig, String quotaType _assignableInstanceMap.get(instanceName).release(taskConfig, quotaType); } - if (_globalThreadBasedQuotaMap.containsKey(quotaType)) { - _globalThreadBasedQuotaMap.put(quotaType, _globalThreadBasedQuotaMap.get(quotaType) + 1); + // Return global quota to the type that assign() actually deducted from. tryAssign() already + // maps an undefined quota type to DEFAULT in the stored TaskAssignResult. A quota type that + // was removed while the task was running is no longer in the global map, so nothing is + // returned for it (and DEFAULT is not inflated). + TaskAssignResult assigned = _taskAssignResultMap.get(taskConfig.getId()); + String globalQuotaType = + assigned != null && assigned.getQuotaType() != null ? assigned.getQuotaType() : quotaType; + if (_globalThreadBasedQuotaMap.containsKey(globalQuotaType)) { + _globalThreadBasedQuotaMap.put(globalQuotaType, + _globalThreadBasedQuotaMap.get(globalQuotaType) + 1); } } diff --git a/helix-core/src/test/java/org/apache/helix/task/TestAssignableInstanceManagerQuotaRelease.java b/helix-core/src/test/java/org/apache/helix/task/TestAssignableInstanceManagerQuotaRelease.java new file mode 100644 index 00000000000..93161778fd5 --- /dev/null +++ b/helix-core/src/test/java/org/apache/helix/task/TestAssignableInstanceManagerQuotaRelease.java @@ -0,0 +1,145 @@ +package org.apache.helix.task; + +/* + * 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. + */ + +import java.util.HashMap; +import java.util.Map; + +import org.apache.helix.model.ClusterConfig; +import org.apache.helix.model.InstanceConfig; +import org.apache.helix.model.LiveInstance; +import org.apache.helix.task.assigner.AssignableInstance; +import org.apache.helix.task.assigner.TaskAssignResult; +import org.testng.Assert; +import org.testng.annotations.Test; + +public class TestAssignableInstanceManagerQuotaRelease { + private static final String INSTANCE = "Instance_0"; + + private AssignableInstanceManager buildManager() { + ClusterConfig clusterConfig = new ClusterConfig("TestCluster_0"); + Map liveInstances = new HashMap<>(); + Map instanceConfigs = new HashMap<>(); + LiveInstance liveInstance = new LiveInstance(INSTANCE); + liveInstance.setCurrentTaskThreadPoolSize(10); + liveInstances.put(INSTANCE, liveInstance); + instanceConfigs.put(INSTANCE, new InstanceConfig(INSTANCE)); + + AssignableInstanceManager manager = new AssignableInstanceManager(); + manager.buildAssignableInstances(clusterConfig, new TaskDataCache4Test("TestCluster_0"), + liveInstances, instanceConfigs); + return manager; + } + + /** + * A task with a quota type that is not configured is assigned as DEFAULT. Releasing it with the + * original (undefined) quota type must return the global DEFAULT quota. + */ + @Test + public void testReleaseUndefinedQuotaTypeRestoresGlobalDefault() { + AssignableInstanceManager manager = buildManager(); + int before = manager.getGlobalCapacityMap().get(AssignableInstance.DEFAULT_QUOTA_TYPE); + + TaskConfig taskConfig = new TaskConfig.Builder().setTaskId("Job_0_Task_0").build(); + TaskAssignResult result = manager.tryAssign(INSTANCE, taskConfig, "UndefinedType"); + Assert.assertTrue(result.isSuccessful()); + Assert.assertEquals(result.getQuotaType(), AssignableInstance.DEFAULT_QUOTA_TYPE); + + manager.assign(INSTANCE, result); + Assert.assertEquals( + (int) manager.getGlobalCapacityMap().get(AssignableInstance.DEFAULT_QUOTA_TYPE), + before - 1); + + manager.release(INSTANCE, taskConfig, "UndefinedType"); + Assert.assertEquals( + (int) manager.getGlobalCapacityMap().get(AssignableInstance.DEFAULT_QUOTA_TYPE), before); + } + + /** Same as above for a null quota type. */ + @Test + public void testReleaseNullQuotaTypeRestoresGlobalDefault() { + AssignableInstanceManager manager = buildManager(); + int before = manager.getGlobalCapacityMap().get(AssignableInstance.DEFAULT_QUOTA_TYPE); + + TaskConfig taskConfig = new TaskConfig.Builder().setTaskId("Job_0_Task_1").build(); + TaskAssignResult result = manager.tryAssign(INSTANCE, taskConfig, null); + Assert.assertTrue(result.isSuccessful()); + + manager.assign(INSTANCE, result); + manager.release(INSTANCE, taskConfig, null); + Assert.assertEquals( + (int) manager.getGlobalCapacityMap().get(AssignableInstance.DEFAULT_QUOTA_TYPE), before); + } + + /** + * A quota type removed from the cluster config while its task is still running must not cause + * the global DEFAULT quota to be inflated when the task is released. + */ + @Test + public void testReleaseRemovedQuotaTypeDoesNotInflateDefault() { + ClusterConfig withType = new ClusterConfig("TestCluster_0"); + withType.setTaskQuotaRatio(AssignableInstance.DEFAULT_QUOTA_TYPE, 1); + withType.setTaskQuotaRatio("TypeX", 1); + + Map liveInstances = new HashMap<>(); + Map instanceConfigs = new HashMap<>(); + LiveInstance liveInstance = new LiveInstance(INSTANCE); + liveInstance.setCurrentTaskThreadPoolSize(10); + liveInstances.put(INSTANCE, liveInstance); + instanceConfigs.put(INSTANCE, new InstanceConfig(INSTANCE)); + + AssignableInstanceManager manager = new AssignableInstanceManager(); + manager.buildAssignableInstances(withType, new TaskDataCache4Test("TestCluster_0"), + liveInstances, instanceConfigs); + + TaskConfig taskConfig = new TaskConfig.Builder().setTaskId("Job_0_Task_2").build(); + TaskAssignResult result = manager.tryAssign(INSTANCE, taskConfig, "TypeX"); + Assert.assertTrue(result.isSuccessful()); + Assert.assertEquals(result.getQuotaType(), "TypeX"); + manager.assign(INSTANCE, result); + + // Remove TypeX from the cluster config while the task is still running + ClusterConfig withoutType = new ClusterConfig("TestCluster_0"); + withoutType.setTaskQuotaRatio(AssignableInstance.DEFAULT_QUOTA_TYPE, 1); + manager.updateAssignableInstances(withoutType, liveInstances, instanceConfigs); + int defaultBefore = manager.getGlobalCapacityMap().get(AssignableInstance.DEFAULT_QUOTA_TYPE); + + manager.release(INSTANCE, taskConfig, "TypeX"); + Assert.assertEquals( + (int) manager.getGlobalCapacityMap().get(AssignableInstance.DEFAULT_QUOTA_TYPE), + defaultBefore); + } + + private static class TaskDataCache4Test extends org.apache.helix.common.caches.TaskDataCache { + TaskDataCache4Test(String clusterName) { + super(clusterName); + } + + @Override + public Map getJobConfigMap() { + return new HashMap<>(); + } + + @Override + public Map getWorkflowConfigMap() { + return new HashMap<>(); + } + } +}