Introduce Resilience to your Application
Introduce resilience to your application using the SAP Cloud SDK.
Overview
You will learn
- Why you should care about resilience
- How to make the call to the OData service resilient by using resilience decorators
- How to write Tests for code decorated with the new resilience decorators
- To deploy the application on the Business Technology Platform Cloud Foundry
Prerequisites
Steps
Consider the following situation: you are developing a cloud application to provide a service to your customers. In order to keep your customers happy, you’re of course interested in achieving the highest possible availability of your application.
However, cloud applications, possibly spanned across multiple services, are inherently complex. So it is safe to assume that something, somewhere will fail at some point in time. For example a call to your database might fail and cause one part of your application to fail. If other parts of your application rely on the part that has failed, these parts will fail as well. So a single failure might cascade through the whole system and break it. This is especially critical for multi-tenancy applications, where a single instance of your application serves multiple customers. A typical S/4HANA multi-tenancy application involves many downstream services, such as on-premise S/4HANA ERP systems.
Let’s look at a concrete example: Suppose you have 30 systems your cloud application is dependent on and each system has a “perfect” availability of 99.99%. This means each service is unavailable for 4.32 minutes each month (43200 min * (1 – 0.9999) = 4.32 min).
Now assume failures are cascading, so one service being unavailable means the whole application becomes unavailable. Given the equation used above, the situation now looks like this:
43200 min * (1 – 0.9999^30) = 43200 min * (1 – 0.997) = 129.6 min
So your multi-tenancy application is unavailable for more than two hours every month for every customer!
In order to avoid such scenarios, you need to equip applications with the ability to deal with failure. If an application can deal with failures, it is called resilient. So resilience is the means by which availability is achieved.
The SAP Cloud SDK builds upon the Resilience4j library in order to provide resilience for your cloud applications.
Resilience4j comes with many modules to protect your application from failures. The most important ones are timeouts, bulkheads, and circuit breakers.
Timeouts:
Resilience4jallows setting custom timeout durations for every remote service. If the response time of a remote service exceeds the specified timeout duration, the remote service call is considered as failure. This value should be adapted according to the mean response time of the remote service.Bulkheads: These allow for restricting the number of concurrent requests to a remote service. If the number of concurrent incoming requests exceed the configured threshold, the bulkhead is said to be saturated. In this case, further requests are automatically stopped until existing requests are completed.
Circuit Breakers:
Resilience4juses the circuit breaker pattern to determine whether a remote service is currently available. Breakers are closed by default. If a remote service call fails too many times,Resilience4jwill open/trip the breaker. This means that any further calls that should be made to the same remote service are automatically stopped.Resilience4jwill periodically check if the service is available again, and close the open breaker again accordingly. For more information on the circuit breaker pattern, check this article by Martin Fowler.
The other resilience patterns available are Retry and Rate Limiter which are rather self-explanatory.
Additionally, the SAP Cloud SDK enables you to provide fallback functions. So if a call fails, for example because the bulkhead is saturated or the circuit breaker is open/tripped, the SDK will check whether a fallback is implemented and call it automatically. So even if a service is unavailable you can still provide some useful result, e.g. by serving cached data.
If you want to gain a deeper understanding of the inner workings, checkout the Resilience4j User Guide.
Now that you know why resilience is important, it’s finally time to introduce it into your application. In the last tutorial you created a controller that uses the SDK’s Virtual Data Model (VDM) and other helpful abstractions to retrieve business partners from an ERP system. In order to make this VDM call resilient, you have to wrap the code using the ResilienceDecorator class provided by the SAP Cloud SDK.
At the same time you will also separate the VDM call itself into another class for better readability and easier maintenance in future tutorials.
So first create the following class:
./application/src/main/java/com/sap/cloud/sdk/tutorial/GetBusinessPartnersCommand.java
package com.sap.cloud.sdk.tutorial;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.time.Duration;
import java.util.Collections;
import java.util.List;
import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
import com.sap.cloud.sdk.cloudplatform.resilience.ResilienceConfiguration;
import com.sap.cloud.sdk.cloudplatform.resilience.ResilienceDecorator;
import com.sap.cloud.sdk.cloudplatform.resilience.ResilienceIsolationMode;
import com.sap.cloud.sdk.cloudplatform.resilience.ResilienceRuntimeException;
import com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException;
import com.sap.cloud.sdk.datamodel.odata.helper.Order;
import com.sap.cloud.sdk.tutorial.datamodel.odata.namespaces.businesspartner.BusinessPartner;
import com.sap.cloud.sdk.tutorial.datamodel.odata.services.BusinessPartnerService;
import com.sap.cloud.sdk.tutorial.datamodel.odata.services.DefaultBusinessPartnerService;
public class GetBusinessPartnersCommand {
private static final Logger logger = LoggerFactory.getLogger(GetBusinessPartnersCommand.class);
// TODO: uncomment the lines below and insert your API key, if you are using the sandbox service
// private static final String APIKEY_HEADER = "apikey";
// private static final String SANDBOX_APIKEY = "";
private static final String CATEGORY_PERSON = "1";
private final Destination destination;
private final BusinessPartnerService businessPartnerService;
private final ResilienceConfiguration myResilienceConfig;
public GetBusinessPartnersCommand(Destination destination) {
this(destination, new DefaultBusinessPartnerService());
}
public GetBusinessPartnersCommand(Destination destination, BusinessPartnerService service) {
this.destination = destination;
businessPartnerService = service;
myResilienceConfig = ResilienceConfiguration.of(BusinessPartnerService.class)
.isolationMode(ResilienceIsolationMode.TENANT_AND_USER_OPTIONAL)
.timeLimiterConfiguration(
ResilienceConfiguration.TimeLimiterConfiguration.of()
.timeoutDuration(Duration.ofSeconds(10)))
.bulkheadConfiguration(
ResilienceConfiguration.BulkheadConfiguration.of()
.maxConcurrentCalls(20));
}
public List<BusinessPartner> execute() {
return ResilienceDecorator.executeSupplier(this::run, myResilienceConfig, e -> {
logger.warn("Fallback called because of exception.", e);
return Collections.emptyList();
});
}
private List<BusinessPartner> run() {
try {
return businessPartnerService
.getAllBusinessPartner()
.select(BusinessPartner.BUSINESS_PARTNER,
BusinessPartner.LAST_NAME,
BusinessPartner.FIRST_NAME,
BusinessPartner.MALE,
BusinessPartner.FEMALE,
BusinessPartner.CREATED_ON
)
.filter(BusinessPartner.BP_CATEGORY.eq(CATEGORY_PERSON))
.orderBy(BusinessPartner.LAST_NAME, Order.ASC)
.top(200)
// TODO: uncomment the line below, if you are using the sandbox service
// .withHeader(APIKEY_HEADER, SANDBOX_APIKEY)
.executeRequest(destination);
} catch (final ODataException e) {
throw new ResilienceRuntimeException(e);
}
}
}To use the ResilienceDecorator you need at least two things:
The code you want to execute in a resilient manner. It can be either a
Supplier,Callable,Supplier<Future>, method reference, or a simple lambda function. As you might have noticed already, the example simply takes the VDM-based code that calls the OData service from the previous tutorial, and puts it into a separate run() method. TheResilienceDecoratoroffers methods that simply wrap the provided function and returns a new function (decorateSupplier,decorateCallable, etc.), plus methods that also start execution of the function immediately (executeSupplier,executeCallable, etc.). HereexecuteSupplieris used with a method reference to the VDM-based code.An instance of
ResilienceConfigurationwith identifier parameter set. Here the example uses the class reference, but a string identifier can also be used. Besides the mandatory identifier parameter, the SAP Cloud SDK comes with a default resilience configuration, so you don’t need to perform any other configuration on your own. In most cases the default configuration will suffice. However, if you need to change the resilience configuration, you can find more information on this topic in SAP Cloud SDK Javadoc
Here is an example of a custom resilience configuration. Here the isolation mode is set to optional tenant + user, the bulkhead maximum concurrent calls to 20, and the execution timeout to 10 seconds.
myResilienceConfig = ResilienceConfiguration.of(BusinessPartnerService.class)
.isolationMode(ResilienceIsolationMode.TENANT_AND_USER_OPTIONAL)
.timeLimiterConfiguration(
ResilienceConfiguration.TimeLimiterConfiguration.of()
.timeoutDuration(Duration.ofSeconds(10)))
.bulkheadConfiguration(
ResilienceConfiguration.BulkheadConfiguration.of()
.maxConcurrentCalls(20));Additionally, the decorate... and execute... methods of ResilienceDecorator support an optional third parameter for a fallback function, in case the remote service call should fail. In this case a lambda function that returns an empty list is used. You could also serve static data or check whether a response to this call has already been cached. Best practice is to at least log the provided Throwable.
Update your resilience configuration to match the above configuration. Now that you have a working command, you need to adapt your BusinessPartnerController to use the newly created command:
./application/src/main/java/com/sap/cloud/sdk/tutorial/controllers/BusinessPartnerController.java
package com.sap.cloud.sdk.tutorial.controllers;
import com.google.gson.Gson;
import com.sap.cloud.sdk.tutorial.GetBusinessPartnersCommand;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
import com.sap.cloud.sdk.cloudplatform.connectivity.DestinationAccessor;
import com.sap.cloud.sdk.tutorial.datamodel.odata.namespaces.businesspartner.BusinessPartner;
@RestController
@RequestMapping( "/businesspartners" )
public class BusinessPartnerController
{
private static final Logger logger = LoggerFactory.getLogger(BusinessPartnerController.class);
private static final String DESTINATION_NAME = "MyErpSystem";
@RequestMapping( method = RequestMethod.GET , produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<?> getBusinessPartner()
{
try {
final Destination destination = DestinationAccessor.getDestination(DESTINATION_NAME);
final List<BusinessPartner> businessPartners =
new GetBusinessPartnersCommand(destination).execute();
return ResponseEntity.ok( new Gson().toJson(businessPartners));
} catch (final Exception e) {
logger.error(e.getMessage(), e);
return ResponseEntity.internalServerError().body("Failed to fetch business partners.");
}
}
}Thanks to your new GetBusinessPartnersCommand, you can now simply create a new command and execute it. As before, you’ll get a list of business partners as result. But now you can be sure that your application will not stop working all-together if the OData service is temporarily unavailable for any tenant.
Let’s now write an integration test to check, if your fallback is working correctly. Add testWithFallback() to your BusinessPartnerControllerTest class:
application/src/test/java/com/sap/cloud/sdk/tutorial/BusinessPartnerControllerTest.java:
package com.sap.cloud.sdk.tutorial;
import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
import com.github.tomakehurst.wiremock.junit5.WireMockTest;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import com.sap.cloud.sdk.cloudplatform.connectivity.DefaultDestinationLoader;
import com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination;
import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
import com.sap.cloud.sdk.cloudplatform.connectivity.DestinationAccessor;
import static com.github.tomakehurst.wiremock.client.WireMock.anyUrl;
import static com.github.tomakehurst.wiremock.client.WireMock.get;
import static com.github.tomakehurst.wiremock.client.WireMock.okJson;
import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
@WireMockTest
@ExtendWith(SpringExtension.class)
@SpringBootTest
@AutoConfigureMockMvc
public class BusinessPartnerControllerTest {
private static final String DESTINATION_NAME = "MyErpSystem";
private Destination destination;
@Autowired
private MockMvc mockMvc;
private static final String ODATA_RESPONSE_JSON = """
{
"d": {
"results": [
{
"__metadata": {
"id": "https://127.0.0.1/path/to/service(100)",
"uri": "https://127.0.0.1/path/to/service(100)",
"type": "API_BUSINESS_PARTNER.A_BusinessPartnerType"
},
"BusinessPartner": "100",
"CreationDate": "/Date(1662336000000)/",
"FirstName": "John",
"LastName": "Peter",
"IsMale": "true",
"IsFemale": "false"
}
]
}
}
""";
private static final String RESPONSE_JSON = """
[{
"BusinessPartner":"100",
"FirstName":"John",
"IsMale":false,
"IsFemale":false,
"LastName":"Peter",
"CreationDate":"/Date(1662336000000)/"
}]""";
@BeforeEach
void before( final WireMockRuntimeInfo wm ){
destination = DefaultHttpDestination.builder(wm.getHttpBaseUrl()).name(DESTINATION_NAME).build();
final DefaultDestinationLoader defaultDestinationLoader = new DefaultDestinationLoader().registerDestination(destination);
DestinationAccessor.prependDestinationLoader(defaultDestinationLoader);
}
@Test
public void testService() throws Exception {
stubFor(get(anyUrl())
.willReturn(okJson(ODATA_RESPONSE_JSON)));
mockMvc.perform(MockMvcRequestBuilders.get("/businesspartners"))
.andExpect(MockMvcResultMatchers.status().isOk())
.andExpect(MockMvcResultMatchers.content().json(RESPONSE_JSON));
}
@Test
public void testWithFallback() throws Exception {
// Assure an empty list is returned as fallback
mockMvc.perform(MockMvcRequestBuilders.get("/businesspartners"))
.andExpect(MockMvcResultMatchers.status().isOk())
.andExpect(MockMvcResultMatchers.content().json("[]"));
}
}With testWithFallback() you added a test to test your resilience. The example intentionally provides a dummy destination that does not provide the OData service endpoint in order to make the command fail. Since you implemented a fallback for your command that returns an empty list, you can assert that the response actually contains an empty list.
Simply run mvn clean install as in the previous tutorials to test and build your application.
Simply run mvn clean install as in the previous tutorials to test and build your application and then run cf push to deploy your updated application to Cloud Foundry!
This wraps up the tutorial on making your sample application resilient using Resilience4j and the SAP Cloud SDK. Continue with the next tutorial Step 6: Caching and also explore other tutorial posts on topics like security!
Resources
Discussion
Share feedback on this tutorial or join the conversation in SAP Community.