From 74a1cb92ba6df7410bdad27c828d7506b9a9607f Mon Sep 17 00:00:00 2001 From: "VOPEN.XYZ" Date: Fri, 22 Jul 2022 14:24:52 +0800 Subject: [PATCH] [Bugfix] Removed unused class for circuit-breaker module (2020) (#456) --- CHANGELOG.md | 1 + .../AbstractPolarisCircuitBreakAdapter.java | 92 -------------- .../PolarisCircuitBreakerProperties.java | 113 ----------------- ...bstractPolarisCircuitBreakAdapterTest.java | 117 ------------------ 4 files changed, 1 insertion(+), 322 deletions(-) delete mode 100644 spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/AbstractPolarisCircuitBreakAdapter.java delete mode 100644 spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/config/PolarisCircuitBreakerProperties.java delete mode 100644 spring-cloud-starter-tencent-polaris-circuitbreaker/src/test/java/com/tencent/cloud/polaris/circuitbreaker/AbstractPolarisCircuitBreakAdapterTest.java diff --git a/CHANGELOG.md b/CHANGELOG.md index 5fd31c88e..2652504ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,3 +7,4 @@ - [Add configurable heartbeat interval support](https://github.com/Tencent/spring-cloud-tencent/pull/443) - [feat:enhance Feign and RestTemplate and support Polaris monitor.](https://github.com/Tencent/spring-cloud-tencent/pull/446) - [Optimize feign & rest-template circuit-breaker logic](https://github.com/Tencent/spring-cloud-tencent/pull/453) +- [Bugfix: Removed unused class for circuit-breaker module](https://github.com/Tencent/spring-cloud-tencent/pull/456) diff --git a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/AbstractPolarisCircuitBreakAdapter.java b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/AbstractPolarisCircuitBreakAdapter.java deleted file mode 100644 index 42137fe62..000000000 --- a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/AbstractPolarisCircuitBreakAdapter.java +++ /dev/null @@ -1,92 +0,0 @@ -/* - * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. - * - * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved. - * - * Licensed under the BSD 3-Clause License (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://opensource.org/licenses/BSD-3-Clause - * - * 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 com.tencent.cloud.polaris.circuitbreaker; - -import java.util.List; -import java.util.Objects; - -import com.tencent.cloud.polaris.circuitbreaker.config.PolarisCircuitBreakerProperties; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import org.springframework.http.HttpStatus; -import org.springframework.lang.Nullable; - -import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR; - -/** - * Abstract Polaris Circuit-Break Adapter . - * - * @author Elve.Xu 2022-07-11 - */ -public abstract class AbstractPolarisCircuitBreakAdapter { - - private static final Logger LOG = LoggerFactory.getLogger(AbstractPolarisCircuitBreakAdapter.class); - - protected final PolarisCircuitBreakerProperties properties; - - /** - * Constructor With {@link PolarisCircuitBreakerProperties} . - * - * @param properties instance of {@link PolarisCircuitBreakerProperties}. - */ - protected AbstractPolarisCircuitBreakAdapter(PolarisCircuitBreakerProperties properties) { - this.properties = properties; - } - - /** - * Callback after completion of request processing, Check if business meltdown reporting is required. - * - * @param httpStatus request http status code - * @return true , otherwise return false . - */ - protected boolean apply(@Nullable HttpStatus httpStatus) { - if (Objects.isNull(httpStatus)) { - return false; - } - else { - // statuses > series - List status = properties.getStatuses(); - - if (status.isEmpty()) { - List series = properties.getSeries(); - // Check INTERNAL_SERVER_ERROR (500) status. - if (properties.getIgnoreInternalServerError() && Objects.equals(httpStatus, INTERNAL_SERVER_ERROR)) { - return false; - } - if (series.isEmpty()) { - return false; - } - else { - try { - return series.contains(HttpStatus.Series.valueOf(httpStatus)); - } - catch (Exception e) { - LOG.warn("Decode http status failed.", e); - } - } - } - else { - // Use the user-specified fuse status code. - return status.contains(httpStatus); - } - } - // DEFAULT RETURN FALSE. - return false; - } -} diff --git a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/config/PolarisCircuitBreakerProperties.java b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/config/PolarisCircuitBreakerProperties.java deleted file mode 100644 index a47ad20a7..000000000 --- a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/config/PolarisCircuitBreakerProperties.java +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. - * - * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved. - * - * Licensed under the BSD 3-Clause License (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://opensource.org/licenses/BSD-3-Clause - * - * 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 com.tencent.cloud.polaris.circuitbreaker.config; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.http.HttpStatus; - -import static org.springframework.http.HttpStatus.BAD_GATEWAY; -import static org.springframework.http.HttpStatus.BANDWIDTH_LIMIT_EXCEEDED; -import static org.springframework.http.HttpStatus.GATEWAY_TIMEOUT; -import static org.springframework.http.HttpStatus.HTTP_VERSION_NOT_SUPPORTED; -import static org.springframework.http.HttpStatus.INSUFFICIENT_STORAGE; -import static org.springframework.http.HttpStatus.LOOP_DETECTED; -import static org.springframework.http.HttpStatus.NETWORK_AUTHENTICATION_REQUIRED; -import static org.springframework.http.HttpStatus.NOT_EXTENDED; -import static org.springframework.http.HttpStatus.NOT_IMPLEMENTED; -import static org.springframework.http.HttpStatus.SERVICE_UNAVAILABLE; -import static org.springframework.http.HttpStatus.VARIANT_ALSO_NEGOTIATES; - -/** - * Properties of Polaris CircuitBreaker . - * - * @author Elve.Xu 2022-07-08 - */ -@ConfigurationProperties("spring.cloud.polaris.circuitbreaker") -public class PolarisCircuitBreakerProperties { - - /** - * If circuit-breaker enabled. - */ - private Boolean enabled = true; - - /** - * Specify the Http status code(s) that needs to be fused. - */ - private List statuses = toList(NOT_IMPLEMENTED, BAD_GATEWAY, - SERVICE_UNAVAILABLE, GATEWAY_TIMEOUT, HTTP_VERSION_NOT_SUPPORTED, VARIANT_ALSO_NEGOTIATES, - INSUFFICIENT_STORAGE, LOOP_DETECTED, BANDWIDTH_LIMIT_EXCEEDED, NOT_EXTENDED, NETWORK_AUTHENTICATION_REQUIRED); - - /** - * Specify List of HTTP status series. - */ - private List series = toList(HttpStatus.Series.SERVER_ERROR); - - /** - * Ignore Internal Server Error Http Status Code, - * Only takes effect if the attribute {@link PolarisCircuitBreakerProperties#series} is not empty. - */ - private Boolean ignoreInternalServerError = true; - - /** - * Convert items to List. - * - * @param items item arrays - * @param Object Generics. - * @return list - */ - @SafeVarargs - private static List toList(T... items) { - return new ArrayList<>(Arrays.asList(items)); - } - - public Boolean getEnabled() { - return enabled; - } - - public void setEnabled(Boolean enabled) { - this.enabled = enabled; - } - - public List getStatuses() { - return statuses; - } - - public void setStatuses(List statuses) { - this.statuses = statuses; - } - - public List getSeries() { - return series; - } - - public void setSeries(List series) { - this.series = series; - } - - public Boolean getIgnoreInternalServerError() { - return ignoreInternalServerError; - } - - public void setIgnoreInternalServerError(Boolean ignoreInternalServerError) { - this.ignoreInternalServerError = ignoreInternalServerError; - } -} diff --git a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/test/java/com/tencent/cloud/polaris/circuitbreaker/AbstractPolarisCircuitBreakAdapterTest.java b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/test/java/com/tencent/cloud/polaris/circuitbreaker/AbstractPolarisCircuitBreakAdapterTest.java deleted file mode 100644 index 0775c8313..000000000 --- a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/test/java/com/tencent/cloud/polaris/circuitbreaker/AbstractPolarisCircuitBreakAdapterTest.java +++ /dev/null @@ -1,117 +0,0 @@ -/* - * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. - * - * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved. - * - * Licensed under the BSD 3-Clause License (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://opensource.org/licenses/BSD-3-Clause - * - * 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 com.tencent.cloud.polaris.circuitbreaker; - -import com.tencent.cloud.polaris.circuitbreaker.config.PolarisCircuitBreakerProperties; -import org.assertj.core.api.Assertions; -import org.junit.Test; - -import org.springframework.http.HttpStatus; - -/** - * Test For {@link AbstractPolarisCircuitBreakAdapter}. - * - * @author Elve.Xu - * @version ${project.version} - 2022/7/11 - */ -public class AbstractPolarisCircuitBreakAdapterTest { - - @Test - public void testApplyWithDefaultConfig() { - PolarisCircuitBreakerProperties properties = new PolarisCircuitBreakerProperties(); - // Mock Condition - SimplePolarisCircuitBreakAdapter adapter = new SimplePolarisCircuitBreakAdapter(properties); - - // Assert - Assertions.assertThat(adapter.apply(HttpStatus.OK)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.INTERNAL_SERVER_ERROR)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.BAD_GATEWAY)).isEqualTo(true); - } - - @Test - public void testApplyWithoutIgnoreInternalServerError() { - PolarisCircuitBreakerProperties properties = new PolarisCircuitBreakerProperties(); - // Mock Condition - properties.getStatuses().clear(); - properties.setIgnoreInternalServerError(false); - - SimplePolarisCircuitBreakAdapter adapter = new SimplePolarisCircuitBreakAdapter(properties); - - // Assert - Assertions.assertThat(adapter.apply(HttpStatus.OK)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.INTERNAL_SERVER_ERROR)).isEqualTo(true); - Assertions.assertThat(adapter.apply(HttpStatus.BAD_GATEWAY)).isEqualTo(true); - } - - @Test - public void testApplyWithIgnoreInternalServerError() { - PolarisCircuitBreakerProperties properties = new PolarisCircuitBreakerProperties(); - // Mock Condition - properties.getStatuses().clear(); - properties.setIgnoreInternalServerError(true); - - SimplePolarisCircuitBreakAdapter adapter = new SimplePolarisCircuitBreakAdapter(properties); - - // Assert - Assertions.assertThat(adapter.apply(HttpStatus.OK)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.INTERNAL_SERVER_ERROR)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.BAD_GATEWAY)).isEqualTo(true); - } - - @Test - public void testApplyWithoutSeries() { - PolarisCircuitBreakerProperties properties = new PolarisCircuitBreakerProperties(); - // Mock Condition - properties.getStatuses().clear(); - properties.getSeries().clear(); - - SimplePolarisCircuitBreakAdapter adapter = new SimplePolarisCircuitBreakAdapter(properties); - - // Assert - Assertions.assertThat(adapter.apply(HttpStatus.OK)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.INTERNAL_SERVER_ERROR)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.BAD_GATEWAY)).isEqualTo(false); - } - - @Test - public void testApplyWithSeries() { - PolarisCircuitBreakerProperties properties = new PolarisCircuitBreakerProperties(); - // Mock Condition - properties.getStatuses().clear(); - properties.getSeries().clear(); - properties.getSeries().add(HttpStatus.Series.CLIENT_ERROR); - - SimplePolarisCircuitBreakAdapter adapter = new SimplePolarisCircuitBreakAdapter(properties); - - // Assert - Assertions.assertThat(adapter.apply(HttpStatus.OK)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.INTERNAL_SERVER_ERROR)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.BAD_GATEWAY)).isEqualTo(false); - Assertions.assertThat(adapter.apply(HttpStatus.FORBIDDEN)).isEqualTo(true); - } - - /** - * Simple Polaris CircuitBreak Adapter Implements . - */ - public static class SimplePolarisCircuitBreakAdapter extends AbstractPolarisCircuitBreakAdapter { - - public SimplePolarisCircuitBreakAdapter(PolarisCircuitBreakerProperties properties) { - super(properties); - } - } -}