Skip to content

Commit 2a0fc96

Browse files
committed
fix(admin): reset readiness on every fresh registration, not only when the selector handle changes (#8042)
1 parent 1518ad4 commit 2a0fc96

2 files changed

Lines changed: 88 additions & 2 deletions

File tree

‎shenyu-admin/src/main/java/org/apache/shenyu/admin/service/register/AbstractShenyuClientRegisterServiceImpl.java‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,9 +218,12 @@ public String doRegisterURI(final String selectorName, final List<URIRegisterDTO
218218
selectorData.setHandle(handler);
219219
// update db
220220
selectorService.updateSelective(selectorDO);
221-
// publish change event.
222-
doDiscoveryLocal(selectorDO, pluginName, validUriList);
223221
}
222+
// the registration-owned readiness reset runs whether or not the selector handle
223+
// changed: a duplicate registration of an unchanged endpoint takes the buildHandle
224+
// null path, and a restarted client that never sends an explicit READY would stay
225+
// excluded by its persisted markers forever otherwise (#8042)
226+
doDiscoveryLocal(selectorDO, pluginName, validUriList);
224227
return ShenyuResultMessage.SUCCESS;
225228
}
226229

‎shenyu-admin/src/test/java/org/apache/shenyu/admin/service/register/AbstractShenyuClientRegisterServiceImplTest.java‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
import org.mockito.junit.jupiter.MockitoSettings;
5353
import org.mockito.quality.Strictness;
5454
import org.springframework.context.ApplicationEventPublisher;
55+
import org.springframework.test.util.ReflectionTestUtils;
5556

5657
import java.util.ArrayList;
5758
import java.util.Collections;
@@ -198,6 +199,49 @@ public void testDoRegisterURI() {
198199
assertEquals(ShenyuResultMessage.SUCCESS, abstractShenyuClientRegisterService.doRegisterURI("Selector_Name", Collections.singletonList(uriRegisterDTO), SYS_DEFAULT_NAMESPACE_ID));
199200
}
200201

202+
@Test
203+
public void testDoRegisterURIResetsReadinessWhenTheHandleIsUnchanged() {
204+
final UnchangedHandleShenyuClientRegisterServiceImpl unchangedHandleService =
205+
new UnchangedHandleShenyuClientRegisterServiceImpl();
206+
ReflectionTestUtils.setField(unchangedHandleService, "selectorService", selectorService);
207+
ReflectionTestUtils.setField(unchangedHandleService, "discoveryUpstreamService", discoveryUpstreamService);
208+
ReflectionTestUtils.setField(unchangedHandleService, "eventPublisher", eventPublisher);
209+
ReflectionTestUtils.setField(unchangedHandleService, "discoveryService", mock(org.apache.shenyu.admin.service.DiscoveryService.class));
210+
ReflectionTestUtils.setField(unchangedHandleService, "namespacePluginRelMapper", namespacePluginRelMapper);
211+
ReflectionTestUtils.setField(unchangedHandleService, "pluginMapper", pluginMapper);
212+
213+
PluginDO pluginDO = new PluginDO();
214+
pluginDO.setId("1");
215+
pluginDO.setName(PluginEnum.GRPC.getName());
216+
when(pluginMapper.selectByName(PluginEnum.GRPC.getName())).thenReturn(pluginDO);
217+
NamespacePluginVO namespacePluginVO = new NamespacePluginVO();
218+
namespacePluginVO.setPluginId("1");
219+
namespacePluginVO.setNamespaceId(SYS_DEFAULT_NAMESPACE_ID);
220+
when(namespacePluginRelMapper.selectByPluginIdAndNamespaceId(pluginDO.getId(), SYS_DEFAULT_NAMESPACE_ID)).thenReturn(namespacePluginVO);
221+
SelectorDO selectorDO = new SelectorDO();
222+
selectorDO.setId("selector-1");
223+
selectorDO.setSelectorName("Selector_Name");
224+
when(selectorService.findByNameAndPluginNameAndNamespaceId(any(), any(), any())).thenReturn(selectorDO);
225+
URIRegisterDTO uriRegisterDTO = URIRegisterDTO.builder().build();
226+
uriRegisterDTO.setPort(8080);
227+
uriRegisterDTO.setHost("Host");
228+
uriRegisterDTO.setProtocol("dubbo://");
229+
230+
assertEquals(ShenyuResultMessage.SUCCESS,
231+
unchangedHandleService.doRegisterURI("Selector_Name", Collections.singletonList(uriRegisterDTO), SYS_DEFAULT_NAMESPACE_ID));
232+
233+
// the unchanged-handle path must still release the persisted admission markers…
234+
verify(discoveryUpstreamService).markReadyBySelectorIdAndUrl(eq("selector-1"), anyString());
235+
// …and publish the refreshed discovery snapshot
236+
org.mockito.ArgumentCaptor<org.apache.shenyu.admin.listener.DataChangedEvent> eventCaptor =
237+
org.mockito.ArgumentCaptor.forClass(org.apache.shenyu.admin.listener.DataChangedEvent.class);
238+
verify(eventPublisher).publishEvent(eventCaptor.capture());
239+
org.apache.shenyu.admin.listener.DataChangedEvent event = eventCaptor.getValue();
240+
assertEquals(org.apache.shenyu.common.enums.ConfigGroupEnum.DISCOVER_UPSTREAM, event.getGroupKey());
241+
assertEquals(org.apache.shenyu.common.enums.DataEventTypeEnum.UPDATE,
242+
org.springframework.test.util.ReflectionTestUtils.getField(event, "eventType"));
243+
}
244+
201245
@Test
202246
public void testCheckNamespacePluginRelWhenPluginMissing() {
203247
String pluginName = "missing-plugin";
@@ -264,6 +308,45 @@ public void testDoNotReadyAndDoReady() {
264308
verify(discoveryUpstreamService).markReadyBySelectorIdAndUrl(eq("selector-1"), anyString());
265309
}
266310

311+
/**
312+
* A registration whose selector handle does not change: buildHandle returns null
313+
* exactly the way a duplicate Divide registration of an unchanged healthy endpoint
314+
* does, while the real doDiscoveryLocal (readiness reset + snapshot publish) runs.
315+
*/
316+
static class UnchangedHandleShenyuClientRegisterServiceImpl extends AbstractShenyuClientRegisterServiceImpl {
317+
318+
UnchangedHandleShenyuClientRegisterServiceImpl() {
319+
}
320+
321+
@Override
322+
public String rpcType() {
323+
return "grpc";
324+
}
325+
326+
@Override
327+
protected String selectorHandler(final MetaDataRegisterDTO metaDataDTO) {
328+
return "Selector_Handler";
329+
}
330+
331+
@Override
332+
protected String ruleHandler() {
333+
return "Rule_Handler";
334+
}
335+
336+
@Override
337+
protected void registerMetadata(final MetaDataRegisterDTO metaDataDTO) {
338+
}
339+
340+
@Override
341+
protected String buildHandle(final List<URIRegisterDTO> uriList, final SelectorDO selectorDO) {
342+
return null;
343+
}
344+
345+
@Override
346+
protected void removeDiscoveryUpstream(final String selectorId, final String url) {
347+
}
348+
}
349+
267350
static class MockAbstractShenyuClientRegisterServiceImpl extends AbstractShenyuClientRegisterServiceImpl {
268351

269352
@Override

0 commit comments

Comments
 (0)