- * ⚠️ This annotation relies on Spring annotation which is an exception to the rule of not using Framework in core. + * ⚠️ This annotation relies on Spring annotations which is an exception to the rule of not using Framework in core. *
*- * ⚠️ Transactions only supported when using JDBC repositories. + * ⚠️ If UseCase uses legacy services, @Retryable will be applied twice, first on the service itself and then on the use case. *
* * @see https://gravitee.slab.com/posts/%E2%9A%92%EF%B8%8F-better-software-architecture-of-the-management-api-yxtcvazk @@ -50,5 +54,14 @@ @Target({ ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) @Transactional(value = "graviteeTransactionManager", noRollbackFor = AbstractManagementException.class) +@Retryable( + retryFor = DataAccessException.class, + exceptionExpression = TransactionRetryableService.EXPRESSION, + maxAttemptsExpression = "${management.transaction.retry.maxAttempts:5}", + backoff = @Backoff( + delayExpression = "${management.transaction.retry.delayMs:100}", + maxDelayExpression = "${management.transaction.retry.maxDelayMs:500}" + ) +) public @interface UseCase { } diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/exceptions/TransactionRetryableService.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/exceptions/TransactionRetryableService.java new file mode 100644 index 00000000000..806180ee0fd --- /dev/null +++ b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/exceptions/TransactionRetryableService.java @@ -0,0 +1,43 @@ +/* + * Copyright © 2015 The Gravitee team (http://gravitee.io) + * + * Licensed 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 io.gravitee.rest.api.service.exceptions; + +import org.springframework.dao.DataAccessException; +import org.springframework.dao.NonTransientDataAccessException; +import org.springframework.dao.TransientDataAccessException; +import org.springframework.stereotype.Service; + +@Service +public class TransactionRetryableService { + + public static final String EXPRESSION = "@transactionRetryableService.shouldRetry(#root)"; + + public boolean shouldRetry(final DataAccessException ex) { + if (ex instanceof TransientDataAccessException) { + return true; + } + + if (ex instanceof NonTransientDataAccessException nonTransientDataAccessException) { + String message = nonTransientDataAccessException.getMessage(); + if (message == null) { + return false; + } + return message.contains("WriteConflict"); + } + + return false; + } +} diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/impl/TransactionalService.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/impl/TransactionalService.java index 8302e83723a..8fd9caa9362 100644 --- a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/impl/TransactionalService.java +++ b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/impl/TransactionalService.java @@ -16,6 +16,12 @@ package io.gravitee.rest.api.service.impl; import io.gravitee.rest.api.service.exceptions.AbstractManagementException; +import io.gravitee.rest.api.service.exceptions.TransactionRetryableService; +import org.springframework.dao.DataAccessException; +import org.springframework.dao.DataIntegrityViolationException; +import org.springframework.retry.annotation.Backoff; +import org.springframework.retry.annotation.Recover; +import org.springframework.retry.annotation.Retryable; import org.springframework.transaction.annotation.Transactional; /** @@ -23,4 +29,13 @@ * @author GraviteeSource Team */ @Transactional(value = "graviteeTransactionManager", noRollbackFor = AbstractManagementException.class) +@Retryable( + retryFor = DataAccessException.class, + exceptionExpression = TransactionRetryableService.EXPRESSION, + maxAttemptsExpression = "${management.transaction.retry.maxAttempts:5}", + backoff = @Backoff( + delayExpression = "${management.transaction.retry.delayMs:100}", + maxDelayExpression = "${management.transaction.retry.maxDelayMs:500}" + ) +) public class TransactionalService {} diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/spring/ServiceConfiguration.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/spring/ServiceConfiguration.java index cde1d221cc0..082f947c33c 100644 --- a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/spring/ServiceConfiguration.java +++ b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/spring/ServiceConfiguration.java @@ -48,6 +48,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.*; import org.springframework.core.env.Environment; +import org.springframework.retry.annotation.EnableRetry; import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; import org.springframework.transaction.annotation.EnableTransactionManagement; @@ -59,6 +60,7 @@ @Configuration @ComponentScan(basePackages = { "io.gravitee.rest.api.service" }) @EnableTransactionManagement +@EnableRetry @Import( { FetcherConfigurationConfiguration.class, diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-standalone/gravitee-apim-rest-api-standalone-distribution/src/main/resources/config/gravitee.yml b/gravitee-apim-rest-api/gravitee-apim-rest-api-standalone/gravitee-apim-rest-api-standalone-distribution/src/main/resources/config/gravitee.yml index 4469cc6b513..1b71a3c82de 100644 --- a/gravitee-apim-rest-api/gravitee-apim-rest-api-standalone/gravitee-apim-rest-api-standalone-distribution/src/main/resources/config/gravitee.yml +++ b/gravitee-apim-rest-api/gravitee-apim-rest-api-standalone/gravitee-apim-rest-api-standalone-distribution/src/main/resources/config/gravitee.yml @@ -109,12 +109,20 @@ http: # For more information about MongoDB configuration, please have a look to: # - http://mongodb.github.io/mongo-java-driver/4.1/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html management: +# Override configuration for retryable exceptions (transient) such as transaction conflict. +# transaction: +# retry: +# maxAttempts: 5 +# delayMs: 100 +# maxDelayMs: 500 + type: mongodb # repository type mongodb: # mongodb repository # prefix: # collections prefix dbname: ${ds.mongodb.dbname} # mongodb name (default gravitee) host: ${ds.mongodb.host} # mongodb host (default localhost) port: ${ds.mongodb.port} # mongodb port (default 27017) +# transactional: true # whether to enable transaction or not, true by default ## Client settings # description: # mongodb description (default gravitee.io) diff --git a/pom.xml b/pom.xml index b3407e4931b..8acbd1f60d5 100644 --- a/pom.xml +++ b/pom.xml @@ -134,7 +134,9 @@