Skip to content

Commit 76122a4

Browse files
authored
fix(tcp): fix ignored proxy selector port and property updates (#7497)
1 parent 562017c commit 76122a4

7 files changed

Lines changed: 441 additions & 57 deletions

File tree

‎shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/ProxySelectorServiceImpl.java‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import org.apache.shenyu.admin.discovery.DiscoveryLevel;
2323
import org.apache.shenyu.admin.discovery.DiscoveryProcessor;
2424
import org.apache.shenyu.admin.discovery.DiscoveryProcessorHolder;
25+
import org.apache.shenyu.admin.listener.DataChangedEvent;
2526
import org.apache.shenyu.admin.mapper.DiscoveryHandlerMapper;
2627
import org.apache.shenyu.admin.mapper.DiscoveryMapper;
2728
import org.apache.shenyu.admin.mapper.DiscoveryRelMapper;
@@ -51,10 +52,13 @@
5152
import org.apache.shenyu.admin.utils.ShenyuResultMessage;
5253
import org.apache.shenyu.admin.utils.Assert;
5354
import org.apache.shenyu.common.dto.ProxySelectorData;
55+
import org.apache.shenyu.common.enums.ConfigGroupEnum;
56+
import org.apache.shenyu.common.enums.DataEventTypeEnum;
5457
import org.apache.shenyu.common.utils.UUIDUtils;
5558
import org.jetbrains.annotations.NotNull;
5659
import org.slf4j.Logger;
5760
import org.slf4j.LoggerFactory;
61+
import org.springframework.context.ApplicationEventPublisher;
5862
import org.springframework.stereotype.Service;
5963
import org.springframework.transaction.annotation.Transactional;
6064
import org.springframework.transaction.support.TransactionSynchronization;
@@ -98,11 +102,13 @@ public class ProxySelectorServiceImpl implements ProxySelectorService {
98102

99103
private final DiscoveryProcessorHolder discoveryProcessorHolder;
100104

105+
private final ApplicationEventPublisher eventPublisher;
106+
101107
public ProxySelectorServiceImpl(final ProxySelectorMapper proxySelectorMapper, final DiscoveryMapper discoveryMapper,
102108
final DiscoveryUpstreamMapper discoveryUpstreamMapper, final DiscoveryHandlerMapper discoveryHandlerMapper,
103109
final DiscoveryRelMapper discoveryRelMapper,
104110
final SelectorMapper selectorMapper,
105-
final DiscoveryProcessorHolder discoveryProcessorHolder) {
111+
final DiscoveryProcessorHolder discoveryProcessorHolder, final ApplicationEventPublisher eventPublisher) {
106112

107113
this.proxySelectorMapper = proxySelectorMapper;
108114
this.discoveryMapper = discoveryMapper;
@@ -111,6 +117,7 @@ public ProxySelectorServiceImpl(final ProxySelectorMapper proxySelectorMapper, f
111117
this.discoveryHandlerMapper = discoveryHandlerMapper;
112118
this.selectorMapper = selectorMapper;
113119
this.discoveryProcessorHolder = discoveryProcessorHolder;
120+
this.eventPublisher = eventPublisher;
114121
}
115122

116123
/**
@@ -427,6 +434,21 @@ public String update(final ProxySelectorAddDTO proxySelectorAddDTO) {
427434
.map(DiscoveryTransfer.INSTANCE::mapToDTO).collect(Collectors.toList());
428435
DiscoveryProcessor discoveryProcessor = discoveryProcessorHolder.chooseProcessor(discoveryDO.getDiscoveryType());
429436
discoveryProcessor.changeUpstream(DiscoveryTransfer.INSTANCE.mapToDTO(proxySelectorDO), fetchAll);
437+
DataChangedEvent event = new DataChangedEvent(ConfigGroupEnum.PROXY_SELECTOR, DataEventTypeEnum.UPDATE,
438+
Collections.singletonList(DiscoveryTransfer.INSTANCE.mapToData(DiscoveryTransfer.INSTANCE.mapToDTO(proxySelectorDO))));
439+
if (TransactionSynchronizationManager.isSynchronizationActive()) {
440+
TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() {
441+
@Override
442+
public void afterCompletion(final int status) {
443+
// Completion runs after synchronization is cleared, so the cluster dispatcher does not defer the event again.
444+
if (status == STATUS_COMMITTED) {
445+
eventPublisher.publishEvent(event);
446+
}
447+
}
448+
});
449+
} else {
450+
eventPublisher.publishEvent(event);
451+
}
430452
return ShenyuResultMessage.UPDATE_SUCCESS;
431453
}
432454

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

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
import org.apache.shenyu.admin.discovery.DiscoveryProcessor;
2121
import org.apache.shenyu.admin.discovery.DiscoveryProcessorHolder;
22+
import org.apache.shenyu.admin.listener.DataChangedEvent;
2223
import org.apache.shenyu.admin.exception.ValidFailException;
2324
import org.apache.shenyu.admin.mapper.DiscoveryHandlerMapper;
2425
import org.apache.shenyu.admin.mapper.DiscoveryMapper;
@@ -39,6 +40,7 @@
3940
import org.apache.shenyu.admin.service.impl.ProxySelectorServiceImpl;
4041
import org.apache.shenyu.admin.utils.ShenyuResultMessage;
4142
import org.apache.shenyu.common.dto.ProxySelectorData;
43+
import org.apache.shenyu.common.enums.ConfigGroupEnum;
4244
import org.junit.jupiter.api.BeforeEach;
4345
import org.junit.jupiter.api.Test;
4446
import org.junit.jupiter.api.extension.ExtendWith;
@@ -49,6 +51,9 @@
4951
import org.mockito.junit.jupiter.MockitoExtension;
5052
import org.mockito.junit.jupiter.MockitoSettings;
5153
import org.mockito.quality.Strictness;
54+
import org.springframework.context.ApplicationEventPublisher;
55+
import org.springframework.transaction.support.TransactionSynchronization;
56+
import org.springframework.transaction.support.TransactionSynchronizationManager;
5257

5358
import java.sql.Timestamp;
5459
import java.util.ArrayList;
@@ -102,11 +107,14 @@ class ProxySelectorServiceTest {
102107
@Mock
103108
private DiscoveryProcessorHolder discoveryProcessorHolder;
104109

110+
@Mock
111+
private ApplicationEventPublisher eventPublisher;
112+
105113
@BeforeEach
106114
void testSetUp() {
107115

108116
proxySelectorService = new ProxySelectorServiceImpl(proxySelectorMapper, discoveryMapper, discoveryUpstreamMapper,
109-
discoveryHandlerMapper, discoveryRelMapper, selectorMapper, discoveryProcessorHolder);
117+
discoveryHandlerMapper, discoveryRelMapper, selectorMapper, discoveryProcessorHolder, eventPublisher);
110118
}
111119

112120
@Test
@@ -246,14 +254,17 @@ void testCreateOrUpdate() {
246254
assertEquals(proxySelectorService.createOrUpdate(proxySelectorDTO), ShenyuResultMessage.CREATE_SUCCESS);
247255
}
248256

249-
@Test
250-
void testUpdateWithNullDiscoveryUpstreams() {
257+
@ParameterizedTest
258+
@ValueSource(booleans = {false, true})
259+
void testUpdatePublishesListenerConfigurationAfterCommit(final boolean commit) {
251260

252261
ProxySelectorAddDTO proxySelectorDTO = new ProxySelectorAddDTO();
253262
proxySelectorDTO.setId("proxy-1");
254263
proxySelectorDTO.setName("test");
255-
proxySelectorDTO.setPluginName("test");
264+
proxySelectorDTO.setPluginName("tcp");
256265
proxySelectorDTO.setForwardPort(8080);
266+
proxySelectorDTO.setNamespaceId("namespace-1");
267+
proxySelectorDTO.setProps("{\"loadBalance\":\"roundRobin\"}");
257268
proxySelectorDTO.setDiscovery(new ProxySelectorAddDTO.Discovery());
258269

259270
DiscoveryRelDO discoveryRelDO = new DiscoveryRelDO();
@@ -273,8 +284,30 @@ void testUpdateWithNullDiscoveryUpstreams() {
273284
given(discoveryProcessorHolder.chooseProcessor("local")).willReturn(discoveryProcessor);
274285
given(discoveryUpstreamMapper.selectByDiscoveryHandlerId("handler-1")).willReturn(Collections.emptyList());
275286

276-
assertEquals(proxySelectorService.update(proxySelectorDTO), ShenyuResultMessage.UPDATE_SUCCESS);
277-
verify(discoveryUpstreamMapper, never()).deleteByDiscoveryHandlerId(any());
287+
TransactionSynchronizationManager.initSynchronization();
288+
try {
289+
assertEquals(proxySelectorService.update(proxySelectorDTO), ShenyuResultMessage.UPDATE_SUCCESS);
290+
verify(discoveryUpstreamMapper, never()).deleteByDiscoveryHandlerId(any());
291+
verifyNoInteractions(eventPublisher);
292+
int status = commit ? TransactionSynchronization.STATUS_COMMITTED : TransactionSynchronization.STATUS_ROLLED_BACK;
293+
TransactionSynchronizationManager.getSynchronizations().forEach(synchronization -> synchronization.afterCompletion(status));
294+
if (!commit) {
295+
verifyNoInteractions(eventPublisher);
296+
return;
297+
}
298+
ArgumentCaptor<DataChangedEvent> captor = ArgumentCaptor.forClass(DataChangedEvent.class);
299+
verify(eventPublisher).publishEvent(captor.capture());
300+
DataChangedEvent event = captor.getValue();
301+
assertEquals(ConfigGroupEnum.PROXY_SELECTOR, event.getGroupKey());
302+
List<?> payload = (List<?>) event.getSource();
303+
assertEquals(1, payload.size());
304+
ProxySelectorData data = (ProxySelectorData) payload.get(0);
305+
assertEquals("test", data.getName());
306+
assertEquals(8080, data.getForwardPort());
307+
assertEquals("roundRobin", data.getProps().getProperty("loadBalance"));
308+
} finally {
309+
TransactionSynchronizationManager.clearSynchronization();
310+
}
278311
}
279312

280313
@ParameterizedTest

0 commit comments

Comments
 (0)