Skip to content

fix(dist): duplicate group routes in one batch must not throw NPE #298

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
ImDanXie wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(dist): duplicate group routes in one batch must not throw NPE #298

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
9b9a9df
fix(dist): assign the computed code to every recorded position for du…
ImDanXie Sep 24, 2026
2a9e2e6
test(dist): duplicate group routes in one batch must all receive OK (…
ImDanXie Sep 24, 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
37 changes: 23 additions & 14 deletions ...st/bifromq-dist-worker/src/main/java/org/apache/bifromq/dist/worker/DistWorkerCoProc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ private Runnable batchAddRoute(BatchMatchRequest request,
replyBuilder.setReqId(request.getReqId());
Map<String, AtomicInteger> normalRoutesAdded = new HashMap<>();
Map<String, AtomicInteger> sharedRoutesAdded = new HashMap<>();
Map<GlobalTopicFilter, Map<MatchRoute, Integer>> groupMatchRecords = new HashMap<>();
Map<GlobalTopicFilter, Map<MatchRoute, List<Integer>>> groupMatchRecords = new HashMap<>();
Map<String, BatchMatchReply.TenantBatch.Code[]> resultMap = new HashMap<>();
request.getRequestsMap().forEach((tenantId, tenantMatchRequest) -> {
BatchMatchReply.TenantBatch.Code[] codes = resultMap.computeIfAbsent(tenantId,
Expand Down Expand Up @@ -351,7 +351,7 @@ private Runnable batchAddRoute(BatchMatchRequest request,
ByteString groupRouteKey = toGroupRouteKey(tenantId, requestMatcher);
RouteDetail routeDetail = RouteDetailCache.get(groupRouteKey);
groupMatchRecords.computeIfAbsent(new GlobalTopicFilter(tenantId, routeDetail.matcher()),
k -> new HashMap<>()).put(route, i);
k -> new HashMap<>()).computeIfAbsent(route, key -> new ArrayList<>()).add(i);
}
}
});
Expand All @@ -367,23 +367,28 @@ private Runnable batchAddRoute(BatchMatchRequest request,
});
boolean updated = false;
int maxMembers = request.getRequestsMap().get(tenantId).getOption().getMaxReceiversPerSharedSubGroup();
for (MatchRoute route : newGroupMembers.keySet()) {
int resultIdx = newGroupMembers.get(route);
for (Map.Entry<MatchRoute, List<Integer>> entry : newGroupMembers.entrySet()) {
MatchRoute route = entry.getKey();
String receiverUrl = toReceiverUrl(route);
BatchMatchReply.TenantBatch.Code code;
if (!matchGroup.containsMembers(receiverUrl)) {
if (matchGroup.getMembersCount() < maxMembers) {
matchGroup.putMembers(receiverUrl, route.getIncarnation());
resultMap.get(tenantId)[resultIdx] = BatchMatchReply.TenantBatch.Code.OK;
updated = true;
code = BatchMatchReply.TenantBatch.Code.OK;
} else {
resultMap.get(tenantId)[resultIdx] = BatchMatchReply.TenantBatch.Code.EXCEED_LIMIT;
code = BatchMatchReply.TenantBatch.Code.EXCEED_LIMIT;
}
} else {
if (matchGroup.getMembersMap().get(receiverUrl) < route.getIncarnation()) {
matchGroup.putMembers(receiverUrl, route.getIncarnation());
updated = true;
}
resultMap.get(tenantId)[resultIdx] = BatchMatchReply.TenantBatch.Code.OK;
code = BatchMatchReply.TenantBatch.Code.OK;
}
// a route repeated in the same batch shares one result across all its positions
for (int resultIdx : entry.getValue()) {
resultMap.get(tenantId)[resultIdx] = code;
}
}
if (updated) {
Expand Down Expand Up @@ -421,7 +426,7 @@ private Runnable batchRemoveRoute(BatchUnmatchRequest request,
replyBuilder.setReqId(request.getReqId());
Map<String, AtomicInteger> normalRoutesRemoved = new HashMap<>();
Map<String, AtomicInteger> sharedRoutesRemoved = new HashMap<>();
Map<GlobalTopicFilter, Map<MatchRoute, Integer>> delGroupMatchRecords = new HashMap<>();
Map<GlobalTopicFilter, Map<MatchRoute, List<Integer>>> delGroupMatchRecords = new HashMap<>();
Map<String, BatchUnmatchReply.TenantBatch.Code[]> resultMap = new HashMap<>();
request.getRequestsMap().forEach((tenantId, tenantUnmatchRequest) -> {
BatchUnmatchReply.TenantBatch.Code[] codes = resultMap.computeIfAbsent(tenantId,
Expand Down Expand Up @@ -453,7 +458,7 @@ private Runnable batchRemoveRoute(BatchUnmatchRequest request,
ByteString groupRouteKey = toGroupRouteKey(tenantId, requestMatcher);
RouteDetail routeDetail = RouteDetailCache.get(groupRouteKey);
delGroupMatchRecords.computeIfAbsent(new GlobalTopicFilter(tenantId, routeDetail.matcher()),
k -> new HashMap<>()).put(route, i);
k -> new HashMap<>()).computeIfAbsent(route, key -> new ArrayList<>()).add(i);
}
}
});
Expand All @@ -467,13 +472,17 @@ private Runnable batchRemoveRoute(BatchUnmatchRequest request,
assert matching instanceof GroupMatching;
GroupMatching groupMatching = (GroupMatching) matching;
Map<String, Long> existing = Maps.newHashMap(groupMatching.receivers());
delGroupMembers.forEach((route, resultIdx) -> {
delGroupMembers.forEach((route, resultIdxs) -> {
String receiverUrl = toReceiverUrl(route);
BatchUnmatchReply.TenantBatch.Code code;
if (existing.containsKey(receiverUrl) && existing.get(receiverUrl) <= route.getIncarnation()) {
existing.remove(receiverUrl);
resultMap.get(tenantId)[resultIdx] = BatchUnmatchReply.TenantBatch.Code.OK;
code = BatchUnmatchReply.TenantBatch.Code.OK;
} else {
resultMap.get(tenantId)[resultIdx] = BatchUnmatchReply.TenantBatch.Code.NOT_EXISTED;
code = BatchUnmatchReply.TenantBatch.Code.NOT_EXISTED;
}
for (int resultIdx : resultIdxs) {
resultMap.get(tenantId)[resultIdx] = code;
}
});
if (existing.size() != groupMatching.receivers().size()) {
Expand All @@ -492,8 +501,8 @@ private Runnable batchRemoveRoute(BatchUnmatchRequest request,
.add(newGroupMatching);
}
} else {
delGroupMembers.forEach((detail, resultIdx) -> resultMap.get(tenantId)[resultIdx] =
BatchUnmatchReply.TenantBatch.Code.NOT_EXISTED);
delGroupMembers.forEach((detail, resultIdxs) -> resultIdxs.forEach(resultIdx ->
resultMap.get(tenantId)[resultIdx] = BatchUnmatchReply.TenantBatch.Code.NOT_EXISTED));
}
});
resultMap.forEach((tenantId, codes) -> {
Expand Down
98 changes: 98 additions & 0 deletions ...ifromq-dist-worker/src/test/java/org/apache/bifromq/dist/worker/DistWorkerCoProcTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,104 @@ public void testAddNormalRouteDuplicatedInOneBatchOnlyCountOnceAndRefresh() {
assertEquals(reply.getResultsOrThrow(tenantId).getCode(1), BatchMatchReply.TenantBatch.Code.OK);
}

@Test
public void testAddGroupRouteDuplicatedInOneBatchAllPositionsGetOk() {
long inc = 1L;
String tenantId = "tenantGD";
String topicFilter = "$share/group/dup/topic";

BatchMatchRequest.TenantBatch tenantBatch = BatchMatchRequest.TenantBatch.newBuilder()
.setOption(TenantOption.newBuilder().setMaxReceiversPerSharedSubGroup(10).build())
.addRoute(MatchRoute.newBuilder()
.setMatcher(TopicUtil.from(topicFilter))
.setBrokerId(1)
.setReceiverId("inboxGD")
.setDelivererKey("delivererGD")
.setIncarnation(inc)
.build())
.addRoute(MatchRoute.newBuilder()
.setMatcher(TopicUtil.from(topicFilter))
.setBrokerId(1)
.setReceiverId("inboxGD")
.setDelivererKey("delivererGD")
.setIncarnation(inc)
.build())
.build();

RWCoProcInput rwCoProcInput = RWCoProcInput.newBuilder().setDistService(
DistServiceRWCoProcInput.newBuilder()
.setBatchMatch(BatchMatchRequest.newBuilder()
.setReqId(3005)
.putRequests(tenantId, tenantBatch)
.build())
.build())
.build();

when(reader.get(any(ByteString.class))).thenReturn(Optional.empty());

Supplier<IKVRangeCoProc.MutationResult> resultSupplier = distWorkerCoProc.mutate(rwCoProcInput, reader, writer,
false);
IKVRangeCoProc.MutationResult result = resultSupplier.get();

// both positions must receive OK — the earlier index must not be silently null (NPE)
BatchMatchReply reply = result.output().getDistService().getBatchMatch();
assertEquals(reply.getReqId(), 3005);
assertEquals(reply.getResultsOrThrow(tenantId).getCode(0), BatchMatchReply.TenantBatch.Code.OK);
assertEquals(reply.getResultsOrThrow(tenantId).getCode(1), BatchMatchReply.TenantBatch.Code.OK);
}

@Test
public void testRemoveGroupRouteDuplicatedInOneBatchAllPositionsGetOk() {
long inc = 1L;
String tenantId = "tenantGR";
String topicFilter = "$share/group/rm/topic";

BatchUnmatchRequest.TenantBatch tenantBatch = BatchUnmatchRequest.TenantBatch.newBuilder()
.addRoute(MatchRoute.newBuilder()
.setMatcher(TopicUtil.from(topicFilter))
.setBrokerId(1)
.setReceiverId("inboxGR")
.setDelivererKey("delivererGR")
.setIncarnation(inc)
.build())
.addRoute(MatchRoute.newBuilder()
.setMatcher(TopicUtil.from(topicFilter))
.setBrokerId(1)
.setReceiverId("inboxGR")
.setDelivererKey("delivererGR")
.setIncarnation(inc)
.build())
.build();

RWCoProcInput rwCoProcInput = RWCoProcInput.newBuilder().setDistService(
DistServiceRWCoProcInput.newBuilder()
.setBatchUnmatch(BatchUnmatchRequest.newBuilder()
.setReqId(3006)
.putRequests(tenantId, tenantBatch)
.build())
.build())
.build();

// route exists in KV as a RouteGroup protobuf (receiverUrl -> incarnation)
// receiverUrl format: subBrokerId + NUL + receiverId + NUL + delivererKey
String receiverUrl = 1 + "\u0000" + "inboxGR" + "\u0000" + "delivererGR";
org.apache.bifromq.dist.rpc.proto.RouteGroup group =
org.apache.bifromq.dist.rpc.proto.RouteGroup.newBuilder()
.putMembers(receiverUrl, inc)
.build();
when(reader.get(any(ByteString.class))).thenReturn(Optional.of(group.toByteString()));

Supplier<IKVRangeCoProc.MutationResult> resultSupplier = distWorkerCoProc.mutate(rwCoProcInput, reader, writer,
false);
IKVRangeCoProc.MutationResult result = resultSupplier.get();

// both positions must receive OK — the earlier index must not be silently null (NPE)
BatchUnmatchReply reply = result.output().getDistService().getBatchUnmatch();
assertEquals(reply.getReqId(), 3006);
assertEquals(reply.getResultsOrThrow(tenantId).getCode(0), BatchUnmatchReply.TenantBatch.Code.OK);
assertEquals(reply.getResultsOrThrow(tenantId).getCode(1), BatchUnmatchReply.TenantBatch.Code.OK);
}

@Test
public void testAddNormalRouteUpgradeIncNoIncButRefreshCalled() {
long oldInc = 1L;
Expand Down