This is an automated email from the ASF dual-hosted git repository.
Aias00 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shenyu.git
The following commit(s) were added to refs/heads/master by this push:
new 7086afaffd [ISSUE #7716] Normalize instance information across
reporting paths. (#7785)
7086afaffd is described below
commit 7086afaffd3a249015e09d3cc9d40a6838638d33
Author: Laomo <[email protected]>
AuthorDate: Mon Oct 19 09:33:08 2026 +0800
[ISSUE #7716] Normalize instance information across reporting paths. (#7785)
* fix(admin): normalize instance information reporting (#7716)
* fix(admin): harden instance reports and clarify JSON compatibility
---
.../http/HttpLongPollingDataChangedListener.java | 3 +-
.../listener/websocket/WebsocketCollector.java | 49 +++++++++-----
.../admin/service/impl/InstanceCheckService.java | 3 +-
.../service/impl/InstanceInfoServiceImpl.java | 4 +-
.../shenyu/admin/utils/InstanceInfoUtils.java | 64 ++++++++++++++++++
.../HttpLongPollingDataChangedListenerTest.java | 36 ++++++++++-
.../listener/websocket/WebsocketCollectorTest.java | 67 ++++++++++++++++++-
.../admin/mapper/InstanceInfoMapperTest.java | 14 ++++
.../admin/service/InstanceInfoServiceTest.java | 19 ++++++
.../service/impl/InstanceCheckServiceTest.java | 45 +++++++++++++
.../shenyu/admin/utils/InstanceInfoUtilsTest.java | 75 ++++++++++++++++++++++
11 files changed, 358 insertions(+), 21 deletions(-)
diff --git
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/listener/http/HttpLongPollingDataChangedListener.java
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/listener/http/HttpLongPollingDataChangedListener.java
index f93b942660..9379a9b39c 100644
---
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/listener/http/HttpLongPollingDataChangedListener.java
+++
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/listener/http/HttpLongPollingDataChangedListener.java
@@ -143,13 +143,14 @@ public class HttpLongPollingDataChangedListener extends
AbstractDataChangedListe
List<ConfigGroupEnum> changedGroup = compareChangedGroup(request);
final String clientIp = getRemoteIp(request);
final String namespaceId = getNamespaceId(request);
+ // The header already contains JSON text; encoding it again adds a
string wrapper.
final String bootstrapInfo =
StringUtils.defaultString(request.getHeader(InstanceTypeConstants.BOOTSTRAP_INSTANCE_INFO),
"");
final String clientPort =
StringUtils.defaultString(request.getHeader(X_REAL_PORT), StringUtils.EMPTY);
if (!CLIENT_PORT_ZERO.equals(clientPort)) {
InstanceInfoReportEvent instanceInfoReportEvent =
InstanceInfoReportEvent.builder()
.instanceIp(clientIp)
.instancePort(clientPort)
-
.instanceInfo(GsonUtils.getInstance().toJson(bootstrapInfo))
+ .instanceInfo(bootstrapInfo)
.instanceType(InstanceTypeConstants.BOOTSTRAP_INSTANCE_TYPE)
.instanceState(1)
.namespaceId(namespaceId)
diff --git
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/listener/websocket/WebsocketCollector.java
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/listener/websocket/WebsocketCollector.java
index 57570604cf..4169242baa 100644
---
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/listener/websocket/WebsocketCollector.java
+++
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/listener/websocket/WebsocketCollector.java
@@ -19,6 +19,9 @@ package org.apache.shenyu.admin.listener.websocket;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParseException;
import org.apache.commons.collections4.MapUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.shenyu.admin.config.properties.ClusterProperties;
@@ -194,21 +197,7 @@ public class WebsocketCollector {
return;
}
if (message.contains(InstanceTypeConstants.BOOTSTRAP_INSTANCE_INFO)) {
- if (LOG.isDebugEnabled()) {
- LOG.debug("bootstrap report instance info: {}", message);
- }
- String namespaceId = getNamespaceId(session);
- Map<String, Object> infoMap =
GsonUtils.getInstance().convertToMap(message);
- Object o =
infoMap.get(InstanceTypeConstants.BOOTSTRAP_INSTANCE_INFO);
- InstanceInfoReportEvent instanceInfoRegisterDTO =
InstanceInfoReportEvent.builder()
- .instanceIp(getClientIp(session))
- .instancePort(getClientPort(session))
-
.instanceType(InstanceTypeConstants.BOOTSTRAP_INSTANCE_TYPE)
- .instanceInfo(GsonUtils.getInstance().toJson(o))
- .instanceState(1)
- .namespaceId(namespaceId)
- .build();
-
SpringBeanUtils.getInstance().getBean(InstanceInfoReportEventPublisher.class).publish(instanceInfoRegisterDTO);
+ reportInstanceInfo(message, session);
return;
}
@@ -359,6 +348,36 @@ public class WebsocketCollector {
}
+ private void reportInstanceInfo(final String message, final Session
session) {
+ JsonObject infoMap;
+ try {
+ infoMap = GsonUtils.getInstance().fromJson(message,
JsonObject.class);
+ } catch (JsonParseException ex) {
+ LOG.warn("Ignoring malformed bootstrap instance information
frame");
+ return;
+ }
+ if (Objects.isNull(infoMap)) {
+ return;
+ }
+ LOG.debug("Received bootstrap instance information report");
+ JsonElement information =
infoMap.get(InstanceTypeConstants.BOOTSTRAP_INSTANCE_INFO);
+ String instanceInfo = null;
+ if (Objects.nonNull(information) && !information.isJsonNull()) {
+ // Read only the outer frame; JSON-looking strings inside the
object must stay strings.
+ instanceInfo = information.isJsonPrimitive() &&
information.getAsJsonPrimitive().isString()
+ ? information.getAsString() : information.toString();
+ }
+ InstanceInfoReportEvent instanceInfoRegisterDTO =
InstanceInfoReportEvent.builder()
+ .instanceIp(getClientIp(session))
+ .instancePort(getClientPort(session))
+ .instanceType(InstanceTypeConstants.BOOTSTRAP_INSTANCE_TYPE)
+ .instanceInfo(instanceInfo)
+ .instanceState(1)
+ .namespaceId(getNamespaceId(session))
+ .build();
+
SpringBeanUtils.getInstance().getBean(InstanceInfoReportEventPublisher.class).publish(instanceInfoRegisterDTO);
+ }
+
private void initialSync(final String requestId, final Session session) {
try {
UUID.fromString(requestId);
diff --git
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/InstanceCheckService.java
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/InstanceCheckService.java
index 9b6fbb8ccb..cbcf4d520c 100644
---
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/InstanceCheckService.java
+++
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/InstanceCheckService.java
@@ -24,6 +24,7 @@ import
org.apache.shenyu.admin.model.vo.InstanceDataVisualLineVO;
import org.apache.shenyu.admin.model.vo.InstanceDataVisualVO;
import org.apache.shenyu.admin.model.vo.InstanceInfoVO;
import org.apache.shenyu.admin.service.InstanceInfoService;
+import org.apache.shenyu.admin.utils.InstanceInfoUtils;
import org.apache.shenyu.common.concurrent.ShenyuThreadFactory;
import org.apache.shenyu.common.enums.InstanceStatusEnum;
import org.apache.shenyu.register.common.dto.InstanceBeatInfoDTO;
@@ -128,7 +129,7 @@ public class InstanceCheckService {
InstanceInfoVO instanceInfoVO = new InstanceInfoVO();
instanceInfoVO.setInstanceIp(instanceBeatInfoDTO.getInstanceIp());
instanceInfoVO.setInstanceState(InstanceStatusEnum.ONLINE.getCode());
-
instanceInfoVO.setInstanceInfo(instanceBeatInfoDTO.getInstanceInfo());
+
instanceInfoVO.setInstanceInfo(InstanceInfoUtils.normalize(instanceBeatInfoDTO.getInstanceInfo()));
instanceInfoVO.setInstanceType(instanceBeatInfoDTO.getInstanceType());
instanceInfoVO.setLastHeartBeatTime(System.currentTimeMillis());
instanceInfoVO.setInstancePort(instanceBeatInfoDTO.getInstancePort());
diff --git
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/InstanceInfoServiceImpl.java
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/InstanceInfoServiceImpl.java
index c777e14cb7..d3ff27c1a1 100644
---
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/InstanceInfoServiceImpl.java
+++
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/service/impl/InstanceInfoServiceImpl.java
@@ -25,6 +25,7 @@ import org.apache.shenyu.admin.model.page.PageResultUtils;
import org.apache.shenyu.admin.model.query.InstanceQuery;
import org.apache.shenyu.admin.model.vo.InstanceInfoVO;
import org.apache.shenyu.admin.service.InstanceInfoService;
+import org.apache.shenyu.admin.utils.InstanceInfoUtils;
import org.apache.shenyu.common.utils.GsonUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -111,7 +112,8 @@ public class InstanceInfoServiceImpl implements
InstanceInfoService {
instanceInfoVO.setInstanceIp(instanceInfoDO.getInstanceIp());
instanceInfoVO.setInstancePort(instanceInfoDO.getInstancePort());
instanceInfoVO.setInstanceType(instanceInfoDO.getInstanceType());
- instanceInfoVO.setInstanceInfo(instanceInfoDO.getInstanceInfo());
+ // Normalize legacy rows for display without rewriting the stored
value.
+
instanceInfoVO.setInstanceInfo(InstanceInfoUtils.normalize(instanceInfoDO.getInstanceInfo()));
instanceInfoVO.setInstanceState(instanceInfoDO.getInstanceState());
instanceInfoVO.setNamespaceId(instanceInfoDO.getNamespaceId());
instanceInfoVO.setDateCreated(instanceInfoDO.getDateCreated());
diff --git
a/shenyu-admin/src/main/java/org/apache/shenyu/admin/utils/InstanceInfoUtils.java
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/utils/InstanceInfoUtils.java
new file mode 100644
index 0000000000..49e028f961
--- /dev/null
+++
b/shenyu-admin/src/main/java/org/apache/shenyu/admin/utils/InstanceInfoUtils.java
@@ -0,0 +1,64 @@
+/*
+ * 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.
+ */
+
+package org.apache.shenyu.admin.utils;
+
+import com.google.gson.JsonElement;
+import com.google.gson.JsonParseException;
+import com.google.gson.JsonParser;
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Canonical representation of optional instance information.
+ */
+public final class InstanceInfoUtils {
+
+ private static final Logger LOG =
LoggerFactory.getLogger(InstanceInfoUtils.class);
+
+ private InstanceInfoUtils() {
+ }
+
+ /**
+ * Normalize optional instance information to JSON object text.
+ *
+ * @param information reported or persisted instance information
+ * @return JSON object text that consumers can parse once
+ */
+ public static String normalize(final String information) {
+ if (StringUtils.isBlank(information)) {
+ return "{}";
+ }
+ try {
+ JsonElement element = JsonParser.parseString(information);
+ // Older reporters may wrap the object text in one JSON string.
+ if (element.isJsonPrimitive() &&
element.getAsJsonPrimitive().isString()) {
+ element = JsonParser.parseString(element.getAsString());
+ }
+ if (element.isJsonObject()) {
+ // Compact whitespace without decoding nested string values or
sorting keys.
+ return element.toString();
+ }
+ } catch (JsonParseException | IllegalStateException ex) {
+ LOG.debug("Ignoring malformed optional instance information");
+ return "{}";
+ }
+ LOG.debug("Ignoring optional instance information that is not a JSON
object");
+ return "{}";
+ }
+}
diff --git
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/listener/http/HttpLongPollingDataChangedListenerTest.java
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/listener/http/HttpLongPollingDataChangedListenerTest.java
index a888f0e7d7..b926e8beb1 100644
---
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/listener/http/HttpLongPollingDataChangedListenerTest.java
+++
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/listener/http/HttpLongPollingDataChangedListenerTest.java
@@ -22,10 +22,12 @@ import jakarta.servlet.http.HttpServletRequest;
import org.apache.shenyu.admin.config.properties.HttpSyncProperties;
import org.apache.shenyu.admin.listener.AbstractDataChangedListener;
import org.apache.shenyu.admin.listener.ConfigDataCache;
+import org.apache.shenyu.admin.model.event.instance.InstanceInfoReportEvent;
import org.apache.shenyu.admin.model.result.ShenyuAdminResult;
import
org.apache.shenyu.admin.service.publish.InstanceInfoReportEventPublisher;
import org.apache.shenyu.admin.spring.SpringBeanUtils;
import org.apache.shenyu.admin.utils.ShenyuResultMessage;
+import org.apache.shenyu.common.constant.InstanceTypeConstants;
import org.apache.shenyu.common.dto.AppAuthData;
import org.apache.shenyu.common.dto.DiscoverySyncData;
import org.apache.shenyu.common.dto.MetaData;
@@ -41,6 +43,7 @@ import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
+import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.jupiter.MockitoExtension;
@@ -65,7 +68,6 @@ import java.util.concurrent.ConcurrentMap;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertSame;
-import static org.mockito.ArgumentMatchers.any;
/**
* The TestCase for {@link HttpLongPollingDataChangedListener}.
@@ -423,15 +425,45 @@ public final class HttpLongPollingDataChangedListenerTest
{
this.httpServletRequest.setParameter(group, "clientMd5,500");
this.httpServletRequest.addHeader("X-Real-PORT", "8080");
this.httpServletRequest.addHeader(X_REAL_IP, "10.0.0.1");
+ String information = "{\"cpu\":4,\"os\":\"Windows\"}";
+
this.httpServletRequest.addHeader(InstanceTypeConstants.BOOTSTRAP_INSTANCE_INFO,
information);
listener.doLongPolling(this.httpServletRequest,
this.httpServletResponse);
- Mockito.verify(instanceInfoReportEventPublisher).publish(any());
+ ArgumentCaptor<InstanceInfoReportEvent> event =
ArgumentCaptor.forClass(InstanceInfoReportEvent.class);
+
Mockito.verify(instanceInfoReportEventPublisher).publish(event.capture());
+ assertEquals(information, event.getValue().getInstanceInfo());
assertEquals(200, this.httpServletResponse.getStatus());
clearAllGroupsInCache(DEFAULT_NAMESPACE);
}
+ /**
+ * test doLongPolling without optional instance information.
+ */
+ @Test
+ public void testDoLongPollingWithoutInstanceInformation() throws Exception
{
+ populateAllGroupsInCache(DEFAULT_NAMESPACE, "serverMd5");
+ try {
+ setAllGroupParamsDefault(this.httpServletRequest);
+
this.httpServletRequest.setParameter(ConfigGroupEnum.PLUGIN.name(),
"clientMd5,500");
+ this.httpServletRequest.addHeader("X-Real-PORT", "8080");
+ this.httpServletRequest.addHeader(X_REAL_IP, "10.0.0.1");
+
+ listener.doLongPolling(this.httpServletRequest,
this.httpServletResponse);
+
+ ArgumentCaptor<InstanceInfoReportEvent> event =
ArgumentCaptor.forClass(InstanceInfoReportEvent.class);
+
Mockito.verify(instanceInfoReportEventPublisher).publish(event.capture());
+ assertEquals("", event.getValue().getInstanceInfo());
+ assertEquals("10.0.0.1", event.getValue().getInstanceIp());
+ assertEquals("8080", event.getValue().getInstancePort());
+ assertEquals(1, event.getValue().getInstanceState());
+ assertEquals(200, this.httpServletResponse.getStatus());
+ } finally {
+ clearAllGroupsInCache(DEFAULT_NAMESPACE);
+ }
+ }
+
/**
* test doLongPolling with no changed groups (async path).
*/
diff --git
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/listener/websocket/WebsocketCollectorTest.java
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/listener/websocket/WebsocketCollectorTest.java
index 2cab5b9805..86d5a3a870 100644
---
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/listener/websocket/WebsocketCollectorTest.java
+++
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/listener/websocket/WebsocketCollectorTest.java
@@ -17,12 +17,14 @@
package org.apache.shenyu.admin.listener.websocket;
+import com.google.gson.JsonObject;
import jakarta.websocket.RemoteEndpoint;
import jakarta.websocket.SendHandler;
import jakarta.websocket.SendResult;
import jakarta.websocket.Session;
import org.apache.shenyu.admin.config.properties.ClusterProperties;
import org.apache.shenyu.admin.mode.cluster.service.ClusterSelectMasterService;
+import org.apache.shenyu.admin.model.event.instance.InstanceInfoReportEvent;
import org.apache.shenyu.admin.service.SyncDataService;
import
org.apache.shenyu.admin.service.publish.InstanceInfoReportEventPublisher;
import org.apache.shenyu.admin.spring.SpringBeanUtils;
@@ -39,6 +41,9 @@ import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.NullAndEmptySource;
+import org.junit.jupiter.params.provider.ValueSource;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockedStatic;
@@ -342,10 +347,70 @@ public final class WebsocketCollectorTest {
String bootstrapMsg = "{\"" +
InstanceTypeConstants.BOOTSTRAP_INSTANCE_INFO + "\":{\"key\":\"val\"}}";
websocketCollector.onMessage(bootstrapMsg, session);
- verify(publisher,
times(1)).publish(isA(org.apache.shenyu.admin.model.event.instance.InstanceInfoReportEvent.class));
+ verify(publisher,
times(1)).publish(isA(InstanceInfoReportEvent.class));
websocketCollector.onClose(session);
}
+ @ParameterizedTest
+ @ValueSource(strings = {"{\"cpu\":4,\"os\":\"Windows\"}",
"{\"note\":\"{\\\"nested\\\":true}\"}"})
+ void testBootstrapInstanceInfoPreservesJsonString(final String
information) {
+ InstanceInfoReportEventPublisher publisher =
mock(InstanceInfoReportEventPublisher.class);
+
when(SpringBeanUtils.getInstance().getBean(InstanceInfoReportEventPublisher.class)).thenReturn(publisher);
+ String message =
GsonUtils.getInstance().toJson(Map.of(InstanceTypeConstants.BOOTSTRAP_INSTANCE_INFO,
information));
+
+ websocketCollector.onMessage(message, session);
+
+ ArgumentCaptor<InstanceInfoReportEvent> event =
ArgumentCaptor.forClass(InstanceInfoReportEvent.class);
+ verify(publisher).publish(event.capture());
+ assertEquals(information, event.getValue().getInstanceInfo());
+ }
+
+ @Test
+ @SuppressWarnings("unchecked")
+ void testBootstrapObjectInformationIsPreserved() {
+ InstanceInfoReportEventPublisher publisher =
mock(InstanceInfoReportEventPublisher.class);
+
when(SpringBeanUtils.getInstance().getBean(InstanceInfoReportEventPublisher.class)).thenReturn(publisher);
+ String message =
"{\"bootstrapInstanceInfo\":{\"note\":\"{\\\"nested\\\":true}\"}}";
+
+ websocketCollector.onMessage(message, session);
+
+ ArgumentCaptor<InstanceInfoReportEvent> event =
ArgumentCaptor.forClass(InstanceInfoReportEvent.class);
+ verify(publisher).publish(event.capture());
+ Map<String, Object> information =
GsonUtils.getInstance().fromJson(event.getValue().getInstanceInfo(), Map.class);
+ assertEquals("{\"nested\":true}", information.get("note"));
+ }
+
+ @ParameterizedTest
+ @NullAndEmptySource
+ @ValueSource(strings = {"{broken}", "not-json", "[]"})
+ void testMalformedOptionalInformationStillPublishesHeartbeat(final String
information) {
+ InstanceInfoReportEventPublisher publisher =
mock(InstanceInfoReportEventPublisher.class);
+
when(SpringBeanUtils.getInstance().getBean(InstanceInfoReportEventPublisher.class)).thenReturn(publisher);
+ JsonObject message = new JsonObject();
+ message.addProperty(InstanceTypeConstants.BOOTSTRAP_INSTANCE_INFO,
information);
+
+ assertDoesNotThrow(() ->
websocketCollector.onMessage(message.toString(), session));
+
+ verify(publisher).publish(isA(InstanceInfoReportEvent.class));
+ }
+
+ @Test
+ void testMalformedBootstrapFrameDoesNotPreventNextHeartbeat() {
+ InstanceInfoReportEventPublisher publisher =
mock(InstanceInfoReportEventPublisher.class);
+
when(SpringBeanUtils.getInstance().getBean(InstanceInfoReportEventPublisher.class)).thenReturn(publisher);
+ String[] messages = {"{\"bootstrapInstanceInfo\":",
"[\"bootstrapInstanceInfo\"]", "\"bootstrapInstanceInfo\"", "null /*
bootstrapInstanceInfo */"};
+ for (String message : messages) {
+ assertDoesNotThrow(() -> websocketCollector.onMessage(message,
session));
+ }
+ verify(publisher, never()).publish(any(InstanceInfoReportEvent.class));
+
+
websocketCollector.onMessage("{\"bootstrapInstanceInfo\":\"{\\\"cpu\\\":4}\"}",
session);
+
+ ArgumentCaptor<InstanceInfoReportEvent> event =
ArgumentCaptor.forClass(InstanceInfoReportEvent.class);
+ verify(publisher).publish(event.capture());
+ assertEquals("{\"cpu\":4}", event.getValue().getInstanceInfo());
+ }
+
@Test
void testOnClose() {
websocketCollector.onOpen(session);
diff --git
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/mapper/InstanceInfoMapperTest.java
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/mapper/InstanceInfoMapperTest.java
index 74801a12d2..a6148bebef 100644
---
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/mapper/InstanceInfoMapperTest.java
+++
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/mapper/InstanceInfoMapperTest.java
@@ -20,6 +20,8 @@ package org.apache.shenyu.admin.mapper;
import org.apache.shenyu.admin.AbstractSpringIntegrationTest;
import org.apache.shenyu.admin.model.entity.InstanceInfoDO;
import org.apache.shenyu.admin.model.query.InstanceQuery;
+import org.apache.shenyu.admin.service.impl.InstanceInfoServiceImpl;
+import org.apache.shenyu.common.utils.GsonUtils;
import org.apache.shenyu.common.utils.UUIDUtils;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
@@ -125,6 +127,18 @@ public final class InstanceInfoMapperTest extends
AbstractSpringIntegrationTest
assertEquals(1, deleted);
}
+ @Test
+ void testLegacyInformationIsReadableWithoutRewritingTheStoredRow() {
+ String information = "{\"cpu\":4}";
+ String stored = GsonUtils.getInstance().toJson(information);
+ instance.setInstanceInfo(stored);
+ instanceInfoMapper.updateById(instance);
+ InstanceInfoServiceImpl service = new
InstanceInfoServiceImpl(instanceInfoMapper);
+
+ assertEquals(information,
service.findById(instance.getId()).getInstanceInfo());
+ assertEquals(stored,
instanceInfoMapper.selectById(instance.getId()).getInstanceInfo());
+ }
+
@Test
void updateById() {
instance.setInstanceType("http");
diff --git
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/service/InstanceInfoServiceTest.java
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/service/InstanceInfoServiceTest.java
index 2b0aa293f7..e76892ce3b 100644
---
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/service/InstanceInfoServiceTest.java
+++
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/service/InstanceInfoServiceTest.java
@@ -25,6 +25,7 @@ import org.apache.shenyu.admin.model.page.PageParameter;
import org.apache.shenyu.admin.model.query.InstanceQuery;
import org.apache.shenyu.admin.model.vo.InstanceInfoVO;
import org.apache.shenyu.admin.service.impl.InstanceInfoServiceImpl;
+import org.apache.shenyu.common.utils.GsonUtils;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
@@ -112,6 +113,24 @@ public final class InstanceInfoServiceTest {
assertEquals(instanceInfoDO.getNamespaceId(),
instanceInfoVO.getNamespaceId());
}
+ @Test
+ void testLegacyInstanceInformationIsNormalizedOnRead() {
+ String information = "{\"cpu\":4,\"os\":\"Windows\"}";
+ InstanceInfoDO stored = buildDO();
+ stored.setInstanceInfo(GsonUtils.getInstance().toJson(information));
+ when(instanceInfoMapper.selectById("id-1")).thenReturn(stored);
+ when(instanceInfoMapper.selectAll()).thenReturn(List.of(stored));
+
when(instanceInfoMapper.selectByQuery(any())).thenReturn(List.of(stored));
+ InstanceQuery query = new InstanceQuery();
+ query.setPageParameter(new PageParameter(1, 10));
+
+ assertEquals(information,
instanceInfoService.findById("id-1").getInstanceInfo());
+ assertEquals(information,
instanceInfoService.list().get(0).getInstanceInfo());
+ assertEquals(information,
instanceInfoService.listByPage(query).getDataList().get(0).getInstanceInfo());
+ assertEquals(GsonUtils.getInstance().toJson(information),
stored.getInstanceInfo());
+ verify(instanceInfoMapper, never()).updateById(any());
+ }
+
@Test
void testFindByIdNotFound() {
when(instanceInfoMapper.selectById("not-exist")).thenReturn(null);
diff --git
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/service/impl/InstanceCheckServiceTest.java
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/service/impl/InstanceCheckServiceTest.java
index 18f924c256..64fd81fac2 100644
---
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/service/impl/InstanceCheckServiceTest.java
+++
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/service/impl/InstanceCheckServiceTest.java
@@ -21,10 +21,14 @@ import
org.apache.shenyu.admin.model.event.instance.InstanceInfoReportEvent;
import org.apache.shenyu.admin.model.vo.InstanceDataVisualVO;
import org.apache.shenyu.admin.model.vo.InstanceInfoVO;
import org.apache.shenyu.admin.service.InstanceInfoService;
+import org.apache.shenyu.common.utils.GsonUtils;
import org.apache.shenyu.register.common.dto.InstanceBeatInfoDTO;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.NullAndEmptySource;
+import org.junit.jupiter.params.provider.ValueSource;
import org.springframework.test.util.ReflectionTestUtils;
import org.mockito.InjectMocks;
import org.mockito.Mock;
@@ -67,6 +71,47 @@ public final class InstanceCheckServiceTest {
vo = buildVO("127.0.0.1", "8080", "grpc", "ns");
}
+ @Test
+ void testHeartbeatNormalizesLegacyInformation() {
+ String information = "{\"cpu\":4,\"os\":\"Windows\"}";
+ InstanceBeatInfoDTO dto = buildDTO("127.0.0.1", "8080", "http", "ns");
+ dto.setInstanceInfo(GsonUtils.getInstance().toJson(information));
+
+ instanceCheckService.handleBeatInfo(dto);
+
+ InstanceInfoVO actual =
instanceCheckService.getInstanceHealthBeatInfo(dto);
+ assertEquals(information, actual.getInstanceInfo());
+ assertEquals(1, actual.getInstanceState());
+ }
+
+ @Test
+ void testCurrentHeartbeatInformationIsPreserved() {
+ String information = "{\"cpu\":4}";
+ InstanceBeatInfoDTO dto = buildDTO("127.0.0.1", "8080", "http", "ns");
+ dto.setInstanceInfo(information);
+
+ instanceCheckService.handleBeatInfo(dto);
+
+ assertEquals(information,
instanceCheckService.getInstanceHealthBeatInfo(dto).getInstanceInfo());
+ }
+
+ @ParameterizedTest
+ @NullAndEmptySource
+ @ValueSource(strings = {"{broken}", "[]", "true", "not-json"})
+ void testInvalidOptionalInformationDoesNotStopHeartbeats(final String
information) {
+ InstanceBeatInfoDTO dto = buildDTO("127.0.0.1", "8080", "http", "ns");
+ dto.setInstanceInfo(information);
+
+ assertDoesNotThrow(() -> instanceCheckService.handleBeatInfo(dto));
+
+ InstanceInfoVO actual =
instanceCheckService.getInstanceHealthBeatInfo(dto);
+ assertEquals("{}", actual.getInstanceInfo());
+ assertEquals(1, actual.getInstanceState());
+ actual.setLastHeartBeatTime(0L);
+ assertDoesNotThrow(() -> instanceCheckService.handleBeatInfo(dto));
+ assertThat(actual.getLastHeartBeatTime(), greaterThan(0L));
+ }
+
@Test
void testFetchInstanceDataAndGetInstanceHealthBeatInfo() {
when(instanceInfoService.list()).thenReturn(Collections.singletonList(vo));
diff --git
a/shenyu-admin/src/test/java/org/apache/shenyu/admin/utils/InstanceInfoUtilsTest.java
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/utils/InstanceInfoUtilsTest.java
new file mode 100644
index 0000000000..bd449d9871
--- /dev/null
+++
b/shenyu-admin/src/test/java/org/apache/shenyu/admin/utils/InstanceInfoUtilsTest.java
@@ -0,0 +1,75 @@
+/*
+ * 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.
+ */
+
+package org.apache.shenyu.admin.utils;
+
+import com.google.gson.JsonParser;
+import org.apache.shenyu.common.utils.GsonUtils;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.NullAndEmptySource;
+import org.junit.jupiter.params.provider.ValueSource;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * Tests the instance information contract and its bounded legacy
compatibility.
+ */
+class InstanceInfoUtilsTest {
+
+ @Test
+ void testCurrentAndLegacyInformationHaveTheSameRepresentation() {
+ String information = "{\"cpu\":4,\"os\":\"Windows\"}";
+ String legacy = GsonUtils.getInstance().toJson(information);
+
+ assertEquals(information, InstanceInfoUtils.normalize(information));
+ assertEquals(information, InstanceInfoUtils.normalize(legacy));
+ assertEquals(information,
InstanceInfoUtils.normalize(InstanceInfoUtils.normalize(legacy)));
+ }
+
+ @Test
+ void testFormattedInformationIsCompacted() {
+ String information = "{\n \"os\": \"Windows\",\n \"cpu\": 4\n}";
+ String compact = "{\"os\":\"Windows\",\"cpu\":4}";
+
+ assertEquals(compact, InstanceInfoUtils.normalize(information));
+ assertEquals(compact,
InstanceInfoUtils.normalize(GsonUtils.getInstance().toJson(information)));
+ assertEquals(compact, InstanceInfoUtils.normalize(compact));
+ }
+
+ @Test
+ void testNestedStringsAreNotDecoded() {
+ String information =
"{\"note\":\"{\\\"nested\\\":true}\",\"path\":\"C:\\\\test\",\"label\":\"机器\"}";
+
+ assertEquals(JsonParser.parseString(information),
JsonParser.parseString(InstanceInfoUtils.normalize(information)));
+ }
+
+ @Test
+ void testOnlyOneLegacyWrapperIsDecoded() {
+ String information = "{\"cpu\":4}";
+ String overEncoded =
GsonUtils.getInstance().toJson(GsonUtils.getInstance().toJson(information));
+
+ assertEquals("{}", InstanceInfoUtils.normalize(overEncoded));
+ }
+
+ @ParameterizedTest
+ @NullAndEmptySource
+ @ValueSource(strings = {" ", "null", "[]", "true", "42", "not-json",
"{broken}", "\"plain text\""})
+ void testInvalidOptionalInformationBecomesAnEmptyObject(final String
information) {
+ assertEquals("{}", InstanceInfoUtils.normalize(information));
+ }
+}
