Skip to content

[ISSUE 15677] Support method level TPS in DefaultTPSLimiter #15679

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

Merged
zrlw merged 2 commits into from
Sep 18, 2025
Merged

[ISSUE 15677] Support method level TPS in DefaultTPSLimiter #15679

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
cbd4978
Implement method-level TPS configuration in DefaultTPSLimiter and add…
Sep 9, 2025
e10b010
format the code
Sep 9, 2025
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
21 changes: 13 additions & 8 deletions dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/tps/DefaultTPSLimiter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,27 +39,32 @@ public class DefaultTPSLimiter implements TPSLimiter {

@Override
public boolean isAllowable(URL url, Invocation invocation) {
boolean isMethodLevelTpsConfigured =
url.hasMethodParameter(RpcUtils.getMethodName(invocation), TPS_LIMIT_RATE_KEY);
String key = isMethodLevelTpsConfigured
? url.getServiceKey() + "#" + RpcUtils.getMethodName(invocation)
: url.getServiceKey();
Comment on lines +44 to +46
Copy link

Copilot AI Sep 10, 2025

Choose a reason for hiding this comment

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

[nitpick] The hardcoded '#' separator could be extracted as a constant to improve maintainability and make the key format more explicit.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

@oxsean oxsean Sep 18, 2025

Choose a reason for hiding this comment

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

It doesn’t support method overloading here, but that should be fine.

int rate = url.getMethodParameter(RpcUtils.getMethodName(invocation), TPS_LIMIT_RATE_KEY, -1);
long interval = url.getMethodParameter(
RpcUtils.getMethodName(invocation), TPS_LIMIT_INTERVAL_KEY, DEFAULT_TPS_LIMIT_INTERVAL);
String serviceKey = url.getServiceKey();

if (rate > 0) {
StatItem statItem = stats.get(serviceKey);
StatItem statItem = stats.get(key);
if (statItem == null) {
stats.putIfAbsent(serviceKey, new StatItem(serviceKey, rate, interval));
statItem = stats.get(serviceKey);
stats.putIfAbsent(key, new StatItem(key, rate, interval));
statItem = stats.get(key);
} else {
// rate or interval has changed, rebuild
if (statItem.getRate() != rate || statItem.getInterval() != interval) {
stats.put(serviceKey, new StatItem(serviceKey, rate, interval));
statItem = stats.get(serviceKey);
stats.put(key, new StatItem(key, rate, interval));
statItem = stats.get(key);
}
}
return statItem.isAllowable();
} else {
StatItem statItem = stats.get(serviceKey);
StatItem statItem = stats.get(key);
if (statItem != null) {
stats.remove(serviceKey);
stats.remove(key);
}
}

Expand Down
42 changes: 41 additions & 1 deletion ...pc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/filter/tps/DefaultTPSLimiterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,52 @@ void testIsNotAllowable() {
}

@Test
void testTPSLimiterForMethodLevelConfig() {
void testMethodLevelTpsOverridesServiceLevel() {
Invocation invocation = new MockInvocation();
URL url = URL.valueOf("test://test");
url = url.addParameter(INTERFACE_KEY, "org.apache.dubbo.rpc.file.TpsService");
url = url.addParameter(TPS_LIMIT_RATE_KEY, TEST_LIMIT_RATE);
int tpsConfigForMethodLevel = 3;
url = url.addParameter("tps", 1);
url = url.addParameter("echo.tps", tpsConfigForMethodLevel);
url = url.addParameter(TPS_LIMIT_INTERVAL_KEY, 1000);
for (int i = 1; i <= tpsConfigForMethodLevel + 1; i++) {
if (i == tpsConfigForMethodLevel + 1) {
Assertions.assertFalse(defaultTPSLimiter.isAllowable(url, invocation));
} else {
Assertions.assertTrue(defaultTPSLimiter.isAllowable(url, invocation));
}
}
}

@Test
void testServiceLevelTpsWhenOtherMethodsHaveTps() {
Invocation invocation = new MockInvocation();
URL url = URL.valueOf("test://test");
url = url.addParameter(INTERFACE_KEY, "org.apache.dubbo.rpc.file.TpsService");
url = url.addParameter(TPS_LIMIT_RATE_KEY, TEST_LIMIT_RATE);
int tpsConfigForServiceLevel = 3;
url = url.addParameter("tps", tpsConfigForServiceLevel);
url = url.addParameter("otherMethod.tps", 1);
url = url.addParameter(TPS_LIMIT_INTERVAL_KEY, 1000);
for (int i = 1; i <= tpsConfigForServiceLevel + 1; i++) {
if (i == tpsConfigForServiceLevel + 1) {
Assertions.assertFalse(defaultTPSLimiter.isAllowable(url, invocation));
} else {
Assertions.assertTrue(defaultTPSLimiter.isAllowable(url, invocation));
}
}
}

@Test
void testMethodLevelTpsIsolation() {
Invocation invocation = new MockInvocation();
URL url = URL.valueOf("test://test");
url = url.addParameter(INTERFACE_KEY, "org.apache.dubbo.rpc.file.TpsService");
url = url.addParameter(TPS_LIMIT_RATE_KEY, TEST_LIMIT_RATE);
int tpsConfigForMethodLevel = 3;
url = url.addParameter("tps", 1);
url = url.addParameter("otherMethod.tps", 2);
url = url.addParameter("echo.tps", tpsConfigForMethodLevel);
url = url.addParameter(TPS_LIMIT_INTERVAL_KEY, 1000);
for (int i = 1; i <= tpsConfigForMethodLevel + 1; i++) {
Expand Down
Loading