Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat : upgrade to springboot 3.4 #1480

Merged
merged 3 commits into from
Nov 1, 2024
Merged

feat : upgrade to springboot 3.4 #1480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0fe553
feat : upgrade to springboot 3.4
rajadilipkolli Nov 1, 2024
f90d163
fix : issues
rajadilipkolli Nov 1, 2024
16569f7
adds metadata
rajadilipkolli Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions httpClients/boot-restclient/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.3.5</version>
<version>3.4.0-RC1</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example.restclient</groupId>
Expand Down Expand Up @@ -72,7 +72,7 @@
<configuration>
<java>
<googleJavaFormat>
<version>1.22.0</version>
<version>1.24.0</version>
<style>AOSP</style>
</googleJavaFormat>
<importOrder/>
Expand Down
107 changes: 107 additions & 0 deletions ...ain/java/com/example/restclient/bootrestclient/config/ClientLoggerRequestInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
package com.example.restclient.bootrestclient.config;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpRequest;
import org.springframework.http.HttpStatusCode;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.util.StreamUtils;

@Component
public class ClientLoggerRequestInterceptor implements ClientHttpRequestInterceptor {

private static final Logger log = LoggerFactory.getLogger(ClientLoggerRequestInterceptor.class);

@Override
public ClientHttpResponse intercept(
HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
throws IOException {
logRequest(request, body);
ClientHttpResponse response = execution.execute(request, body);
return logResponse(response);
}

private BufferingClientHttpResponseWrapper logResponse(ClientHttpResponse response)
throws IOException {
log.info(
"============================response begin==========================================");
log.info("Status code : {}", response.getStatusCode());
log.info("Status text : {}", response.getStatusText());
logHeaders(response.getHeaders());

String responseBody =
StreamUtils.copyToString(response.getBody(), Charset.defaultCharset());
log.info("Response body: {}", responseBody);
log.info(
"=======================response end=================================================");
return new BufferingClientHttpResponseWrapper(response, responseBody);
}

private void logRequest(HttpRequest request, byte[] body) {

log.info(
"===========================request begin================================================");
log.info("URI : {}", request.getURI());
log.info("Method : {}", request.getMethod());
logHeaders(request.getHeaders());
if (body.length > 0) {
log.info("Request body: {}", new String(body, StandardCharsets.UTF_8));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Avoid logging sensitive information in request bodies

Logging the request body may expose sensitive data such as credentials or personal information. It's a security risk to log request bodies without sanitization.

Apply this diff to remove logging of the request body:

-        if (body.length > 0) {
-            log.info("Request body: {}", new String(body, StandardCharsets.UTF_8));
-        }

Committable suggestion skipped: line range outside the PR's diff.

}
log.info(
"==========================request end================================================");
}

private void logHeaders(HttpHeaders headers) {
log.info("Headers : ");
headers.forEach((name, values) -> values.forEach(value -> log.info("{}={}", name, value)));
}

private static class BufferingClientHttpResponseWrapper implements ClientHttpResponse {
private final ClientHttpResponse response;
private final String body;

public BufferingClientHttpResponseWrapper(ClientHttpResponse response, String body) {
this.response = response;
this.body = body;
}

@Override
public InputStream getBody() {
return new ByteArrayInputStream(body.getBytes());
}

@Override
public HttpHeaders getHeaders() {
return response.getHeaders();
}

@Override
public HttpStatusCode getStatusCode() throws IOException {
return response.getStatusCode();
}

@Override
public int getRawStatusCode() throws IOException {
return response.getRawStatusCode();
}

@Override
public String getStatusText() throws IOException {
return response.getStatusText();
}

@Override
public void close() {
response.close();
}
}
}
74 changes: 3 additions & 71 deletions ...t/src/main/java/com/example/restclient/bootrestclient/config/RestClientConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,12 @@
package com.example.restclient.bootrestclient.config;

import java.io.IOException;
import java.net.http.HttpClient;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.List;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.web.client.RestClientCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpRequest;
import org.springframework.http.MediaType;
import org.springframework.http.client.BufferingClientHttpRequestFactory;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.http.client.JdkClientHttpRequestFactory;
import org.springframework.lang.NonNull;
import org.springframework.retry.annotation.EnableRetry;
import org.springframework.util.StreamUtils;
import org.springframework.web.client.RestClient;
import org.springframework.web.util.DefaultUriBuilderFactory;

Expand All @@ -34,7 +23,7 @@ RestClient restClient(RestClient.Builder restClientBuilder) {
@Bean
RestClientCustomizer restClientCustomizer(
ApplicationProperties applicationProperties,
@NonNull BufferingClientHttpRequestFactory bufferingClientHttpRequestFactory) {
ClientLoggerRequestInterceptor clientLoggerRequestInterceptor) {
DefaultUriBuilderFactory factory =
new DefaultUriBuilderFactory(applicationProperties.getExternalCallUrl());
factory.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.URI_COMPONENT);
Expand All @@ -45,64 +34,7 @@ RestClientCustomizer restClientCustomizer(
httpHeaders -> {
httpHeaders.setContentType(MediaType.APPLICATION_JSON);
httpHeaders.setAccept(List.of(MediaType.APPLICATION_JSON));
});
// .requestFactory(bufferingClientHttpRequestFactory)
// .requestInterceptor(
// (request, body, execution) -> {
// logRequest(request, body);
// ClientHttpResponse response = execution.execute(request, body);
// logResponse(response);
// return response;
// });
}

private void logResponse(ClientHttpResponse response) throws IOException {
log.info(
"============================response begin==========================================");
log.info("Status code : {}", response.getStatusCode());
log.info("Status text : {}", response.getStatusText());
log.info("Headers : {}", response.getHeaders());
log.info(
"Response body: {}",
StreamUtils.copyToString(response.getBody(), Charset.defaultCharset()));
log.info(
"=======================response end=================================================");
}

private void logRequest(HttpRequest request, byte[] body) {

log.info(
"===========================request begin================================================");
log.info("URI : {}", request.getURI());
log.info("Method : {}", request.getMethod());
log.info("Headers : {}", request.getHeaders());
log.info("Request body: {}", new String(body, StandardCharsets.UTF_8));
log.info(
"==========================request end================================================");
}

@Bean
HttpClient jdkClient() {
return HttpClient.newBuilder()
.version(HttpClient.Version.HTTP_2)
.connectTimeout(Duration.ofSeconds(30))
.followRedirects(HttpClient.Redirect.NORMAL)
.build();
}

@Bean
JdkClientHttpRequestFactory jdkClientHttpRequestFactory(@NonNull HttpClient jdkClient) {
JdkClientHttpRequestFactory jdkClientHttpRequestFactory =
new JdkClientHttpRequestFactory(jdkClient);
jdkClientHttpRequestFactory.setReadTimeout(Duration.ofSeconds(60));
return jdkClientHttpRequestFactory;
}

// BufferingClientHttpRequestFactory allows us to read the response body multiple times for a
// single request.
@Bean
BufferingClientHttpRequestFactory bufferingClientHttpRequestFactory(
@NonNull JdkClientHttpRequestFactory jdkClientHttpRequestFactory) {
return new BufferingClientHttpRequestFactory(jdkClientHttpRequestFactory);
})
.requestInterceptor(clientLoggerRequestInterceptor);
}
}
9 changes: 9 additions & 0 deletions ...boot-restclient/src/main/resources/META-INF/additional-spring-configuration-metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"properties": [
{
"name": "application.external-call-url",
"type": "java.lang.String",
"description": "URL to which call should be made."
}
]
}
4 changes: 4 additions & 0 deletions httpClients/boot-restclient/src/main/resources/application.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ spring.mvc.problemdetails.enabled=true
spring.threads.virtual.enabled=true

application.external-call-url=https://jsonplaceholder.typicode.com

spring.http.client.factory=jdk
spring.http.client.connect-timeout=PT30S
spring.http.client.read-timeout=PT1M
12 changes: 10 additions & 2 deletions ...tclient/src/test/java/com/example/restclient/bootrestclient/services/PostServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
package com.example.restclient.bootrestclient.services;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.*;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.header;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.method;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

import com.example.restclient.bootrestclient.config.ClientLoggerRequestInterceptor;
import com.example.restclient.bootrestclient.config.RestClientConfiguration;
import com.example.restclient.bootrestclient.model.response.PostDto;
import com.fasterxml.jackson.core.JsonProcessingException;
Expand All @@ -18,7 +21,12 @@
import org.springframework.test.web.client.MockRestServiceServer;

@RestClientTest(
components = {PostService.class, HttpClientService.class, RestClientConfiguration.class})
components = {
PostService.class,
HttpClientService.class,
RestClientConfiguration.class,
ClientLoggerRequestInterceptor.class
})
class PostServiceTest {

@Autowired private MockRestServiceServer mockRestServiceServer;
Expand Down