From dbb30671022bf2837a9da7405d9048dfbc7013a4 Mon Sep 17 00:00:00 2001
From: Fishtail <49390359+fuyuwei01@users.noreply.github.com>
Date: Fri, 1 Aug 2025 17:38:04 +0800
Subject: [PATCH] fix: polaris.discovery.heartbeat.enabled not effective.
 (#1694)

Co-authored-by: zihenzzz <131673437+zihenzzz@users.noreply.github.com>
---
 CHANGELOG.md                                  |  1 +
 .../polaris/PolarisDiscoveryProperties.java   | 14 +++++++++++
 .../registry/PolarisServiceRegistry.java      | 23 ++++++++++++-------
 ...itional-spring-configuration-metadata.json |  6 +++++
 .../PolarisDiscoveryPropertiesTest.java       |  1 +
 5 files changed, 37 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4729a3c06..11e7a48a4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -20,3 +20,4 @@
 - [feat:support fault injection.](https://github.com/Tencent/spring-cloud-tencent/pull/1691)
 - [feat: support config event and monitor address list.](https://github.com/Tencent/spring-cloud-tencent/pull/1692)
 - [feat:Modify the annotations.](https://github.com/Tencent/spring-cloud-tencent/pull/1693)
+- [fix: polaris.discovery.heartbeat.enabled not effective.](https://github.com/Tencent/spring-cloud-tencent/pull/1694)
diff --git a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/PolarisDiscoveryProperties.java b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/PolarisDiscoveryProperties.java
index 5c7b3b5fe..4eb8d1fe6 100644
--- a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/PolarisDiscoveryProperties.java
+++ b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/PolarisDiscoveryProperties.java
@@ -83,6 +83,11 @@ public class PolarisDiscoveryProperties {
 	@Value("${spring.cloud.polaris.discovery.register:#{true}}")
 	private Boolean registerEnabled;
 
+	/**
+	 * Enable heartbeat or not.
+	 */
+	private Boolean heartbeatEnabled = true;
+
 	/**
 	 * Heartbeat interval ( 0 < interval <= 60).
 	 * Time unit: second. Default: 5.
@@ -208,6 +213,14 @@ public class PolarisDiscoveryProperties {
 		this.serviceListRefreshInterval = serviceListRefreshInterval;
 	}
 
+	public Boolean getHeartbeatEnabled() {
+		return heartbeatEnabled;
+	}
+
+	public void setHeartbeatEnabled(Boolean heartbeatEnabled) {
+		this.heartbeatEnabled = heartbeatEnabled;
+	}
+
 	public Integer getHeartbeatInterval() {
 		if (this.heartbeatInterval <= 0 || this.heartbeatInterval > 60) {
 			heartbeatInterval = DEFAULT_REGISTRY_HEARTBEAT_TIME_INTERVAL;
@@ -291,6 +304,7 @@ public class PolarisDiscoveryProperties {
 				", protocol='" + protocol + '\'' +
 				", enabled=" + enabled +
 				", registerEnabled=" + registerEnabled +
+				", heartbeatEnabled=" + heartbeatEnabled +
 				", heartbeatInterval=" + heartbeatInterval +
 				", healthCheckUrl='" + healthCheckUrl + '\'' +
 				", serviceListRefreshInterval=" + serviceListRefreshInterval +
diff --git a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java
index 952b7c3be..58419a761 100644
--- a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java
+++ b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java
@@ -127,7 +127,6 @@ public class PolarisServiceRegistry implements ServiceRegistry<PolarisRegistrati
 		instanceRegisterRequest.setRegion(staticMetadataManager.getRegion());
 		instanceRegisterRequest.setZone(staticMetadataManager.getZone());
 		instanceRegisterRequest.setCampus(staticMetadataManager.getCampus());
-		instanceRegisterRequest.setTtl(polarisDiscoveryProperties.getHeartbeatInterval());
 		instanceRegisterRequest.setMetadata(registration.getMetadata());
 		instanceRegisterRequest.setExtendedMetadata(registration.getExtendedMetadata());
 		instanceRegisterRequest.setProtocol(polarisDiscoveryProperties.getProtocol());
@@ -144,16 +143,24 @@ public class PolarisServiceRegistry implements ServiceRegistry<PolarisRegistrati
 		try {
 			ProviderAPI providerClient = polarisSDKContextManager.getProviderAPI();
 			InstanceRegisterResponse instanceRegisterResponse;
-			if (StringUtils.isBlank(polarisDiscoveryProperties.getHealthCheckUrl())) {
-				instanceRegisterResponse = providerClient.registerInstance(instanceRegisterRequest);
+			if (polarisDiscoveryProperties.getHeartbeatEnabled()) {
+				instanceRegisterRequest.setTtl(polarisDiscoveryProperties.getHeartbeatInterval());
+				if (StringUtils.isBlank(polarisDiscoveryProperties.getHealthCheckUrl())) {
+					instanceRegisterResponse = providerClient.registerInstance(instanceRegisterRequest);
+				}
+				else {
+					instanceRegisterResponse = providerClient.register(instanceRegisterRequest);
+					InstanceHeartbeatRequest heartbeatRequest = new InstanceHeartbeatRequest();
+					BeanUtils.copyProperties(instanceRegisterRequest, heartbeatRequest);
+					heartbeatRequest.setInstanceID(instanceRegisterResponse.getInstanceId());
+					// Start the heartbeat thread after the registration is successful.
+					heartbeat(heartbeatRequest);
+				}
 			}
 			else {
+				// Heartbeat is disabled
 				instanceRegisterResponse = providerClient.register(instanceRegisterRequest);
-				InstanceHeartbeatRequest heartbeatRequest = new InstanceHeartbeatRequest();
-				BeanUtils.copyProperties(instanceRegisterRequest, heartbeatRequest);
-				heartbeatRequest.setInstanceID(instanceRegisterResponse.getInstanceId());
-				// Start the heartbeat thread after the registration is successful.
-				heartbeat(heartbeatRequest);
+				LOGGER.info("Registered instance without heartbeat.");
 			}
 			registration.setInstanceId(instanceRegisterResponse.getInstanceId());
 			LOGGER.info("polaris registry, {} {} {} {}:{} {} {} {} {} register finished", polarisDiscoveryProperties.getNamespace(),
diff --git a/spring-cloud-starter-tencent-polaris-discovery/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-cloud-starter-tencent-polaris-discovery/src/main/resources/META-INF/additional-spring-configuration-metadata.json
index c1ffb9f34..5f3416f97 100644
--- a/spring-cloud-starter-tencent-polaris-discovery/src/main/resources/META-INF/additional-spring-configuration-metadata.json
+++ b/spring-cloud-starter-tencent-polaris-discovery/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -24,6 +24,12 @@
       "defaultValue": true,
       "description": "enable polaris registration or not."
     },
+    {
+      "name": "spring.cloud.polaris.discovery.heartbeat-enabled",
+      "type": "java.lang.Boolean",
+      "defaultValue": true,
+      "description": "enable polaris heartbeat or not."
+    },
     {
       "name": "spring.cloud.polaris.discovery.heartbeat-interval",
       "type": "java.lang.Integer",
diff --git a/spring-cloud-starter-tencent-polaris-discovery/src/test/java/com/tencent/cloud/polaris/PolarisDiscoveryPropertiesTest.java b/spring-cloud-starter-tencent-polaris-discovery/src/test/java/com/tencent/cloud/polaris/PolarisDiscoveryPropertiesTest.java
index 5adbcec87..52f1affd8 100644
--- a/spring-cloud-starter-tencent-polaris-discovery/src/test/java/com/tencent/cloud/polaris/PolarisDiscoveryPropertiesTest.java
+++ b/spring-cloud-starter-tencent-polaris-discovery/src/test/java/com/tencent/cloud/polaris/PolarisDiscoveryPropertiesTest.java
@@ -110,6 +110,7 @@ public class PolarisDiscoveryPropertiesTest {
 						+ ", protocol='HTTP'"
 						+ ", enabled=true"
 						+ ", registerEnabled=true"
+						+ ", heartbeatEnabled=true"
 						+ ", heartbeatInterval=20"
 						+ ", healthCheckUrl='/health'"
 						+ ", serviceListRefreshInterval=1000"