feat: map expires_in in TokenRepresentation (#4131)

* feat: map expires_in in TokenRepresentation * chore: deps file * chore: fix checkstyle
eclipse-edc · Apr 22, 2024 · 5bae31c · 5bae31c
1 parent 41a22c1
commit 5bae31c
Show file tree

Hide file tree

Showing 2 changed files with 101 additions and 12 deletions.
diff --git a/...auth2/oauth2-client/src/main/java/org/eclipse/edc/iam/oauth2/client/Oauth2ClientImpl.java b/...auth2/oauth2-client/src/main/java/org/eclipse/edc/iam/oauth2/client/Oauth2ClientImpl.java
@@ -26,8 +26,10 @@
 import org.jetbrains.annotations.NotNull;
 
 import java.io.IOException;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 
 import static org.eclipse.edc.http.spi.FallbackFactories.retryWhenStatusIsNot;
 
@@ -38,6 +40,7 @@ public class Oauth2ClientImpl implements Oauth2Client {
     private static final String FORM_URLENCODED = "application/x-www-form-urlencoded";
     private static final String APPLICATION_JSON = "application/json";
     private static final String RESPONSE_ACCESS_TOKEN_CLAIM = "access_token";
+    private static final String RESPONSE_EXPIRES_IN_CLAIM = "expires_in";
 
     private final EdcHttpClient httpClient;
     private final TypeManager typeManager;
@@ -47,18 +50,6 @@ public Oauth2ClientImpl(EdcHttpClient httpClient, TypeManager typeManager) {
         this.typeManager = typeManager;
     }
 
-    @Override
-    public Result<TokenRepresentation> requestToken(Oauth2CredentialsRequest request) {
-        return httpClient.execute(toRequest(request), List.of(retryWhenStatusIsNot(200)), this::handleResponse);
-    }
-
-    private Result<TokenRepresentation> handleResponse(Response response) {
-        return getStringBody(response)
-                .map(it -> typeManager.readValue(it, Map.class))
-                .map(it -> it.get(RESPONSE_ACCESS_TOKEN_CLAIM).toString())
-                .map(it -> TokenRepresentation.Builder.newInstance().token(it).build());
-    }
-
     private static Request toRequest(Oauth2CredentialsRequest request) {
         return new Request.Builder()
                 .url(request.getUrl())
@@ -76,6 +67,39 @@ private static FormBody createRequestBody(Oauth2CredentialsRequest request) {
         return builder.build();
     }
 
+    @Override
+    public Result<TokenRepresentation> requestToken(Oauth2CredentialsRequest request) {
+        return httpClient.execute(toRequest(request), List.of(retryWhenStatusIsNot(200)), this::handleResponse);
+    }
+
+    private Result<TokenRepresentation> handleResponse(Response response) {
+        return getStringBody(response)
+                .map(it -> typeManager.readValue(it, Map.class))
+                .map(this::mapResponse);
+    }
+
+    private TokenRepresentation mapResponse(Map<String, Object> response) {
+        var builder = TokenRepresentation.Builder.newInstance();
+        builder.token(response.get(RESPONSE_ACCESS_TOKEN_CLAIM).toString());
+
+        Optional.ofNullable(response.get(RESPONSE_EXPIRES_IN_CLAIM))
+                .flatMap(expiresIn -> {
+                    if (expiresIn instanceof Number n) {
+                        return Optional.of(n.longValue());
+                    }
+                    return Optional.empty();
+                })
+                .ifPresent(builder::expiresIn);
+
+        var additional = new HashMap<>(response);
+        additional.remove(RESPONSE_EXPIRES_IN_CLAIM);
+        additional.remove(RESPONSE_ACCESS_TOKEN_CLAIM);
+
+        builder.additional(additional);
+
+        return builder.build();
+    }
+
     @NotNull
     private Result<String> getStringBody(Response response) {
         try (var body = response.body()) {

diff --git a/...2/oauth2-client/src/test/java/org/eclipse/edc/iam/oauth2/client/Oauth2ClientImplTest.java b/...2/oauth2-client/src/test/java/org/eclipse/edc/iam/oauth2/client/Oauth2ClientImplTest.java
@@ -69,6 +69,71 @@ void verifyRequestTokenSuccess() {
         assertThat(result.getContent().getToken()).isEqualTo("token");
     }
 
+    @Test
+    void verifyRequestTokenSuccess_withExpiresIn() {
+        var request = createRequest();
+
+        var formParameters = new Parameters(
+                request.getParams().entrySet().stream()
+                        .map(entry -> Parameter.param(entry.getKey(), entry.getValue()))
+                        .collect(Collectors.toList())
+        );
+
+        var expectedRequest = HttpRequest.request().withBody(new ParameterBody(formParameters));
+        var responseBody = typeManager.writeValueAsString(Map.of("access_token", "token", "expires_in", 1800));
+        server.when(expectedRequest).respond(HttpResponse.response().withBody(responseBody, APPLICATION_JSON));
+
+        var result = client.requestToken(request);
+
+        assertThat(result.succeeded()).isTrue();
+        assertThat(result.getContent().getToken()).isEqualTo("token");
+        assertThat(result.getContent().getExpiresIn()).isEqualTo(1800);
+        assertThat(result.getContent().getAdditional()).doesNotContainKeys("token", "expires_in");
+    }
+
+    @Test
+    void verifyRequestTokenSuccess_withExpiresIn_whenNotNumber() {
+        var request = createRequest();
+
+        var formParameters = new Parameters(
+                request.getParams().entrySet().stream()
+                        .map(entry -> Parameter.param(entry.getKey(), entry.getValue()))
+                        .collect(Collectors.toList())
+        );
+
+        var expectedRequest = HttpRequest.request().withBody(new ParameterBody(formParameters));
+        var responseBody = typeManager.writeValueAsString(Map.of("access_token", "token", "expires_in", "wrong"));
+        server.when(expectedRequest).respond(HttpResponse.response().withBody(responseBody, APPLICATION_JSON));
+
+        var result = client.requestToken(request);
+
+        assertThat(result.succeeded()).isTrue();
+        assertThat(result.getContent().getToken()).isEqualTo("token");
+        assertThat(result.getContent().getExpiresIn()).isNull();
+    }
+
+    @Test
+    void verifyRequestTokenSuccess_withAdditionalProperties() {
+        var request = createRequest();
+
+        var formParameters = new Parameters(
+                request.getParams().entrySet().stream()
+                        .map(entry -> Parameter.param(entry.getKey(), entry.getValue()))
+                        .collect(Collectors.toList())
+        );
+
+        var expectedRequest = HttpRequest.request().withBody(new ParameterBody(formParameters));
+        var responseBody = typeManager.writeValueAsString(Map.of("access_token", "token", "expires_in", 1800, "scope", "test"));
+        server.when(expectedRequest).respond(HttpResponse.response().withBody(responseBody, APPLICATION_JSON));
+
+        var result = client.requestToken(request);
+
+        assertThat(result.succeeded()).isTrue();
+        assertThat(result.getContent().getToken()).isEqualTo("token");
+        assertThat(result.getContent().getExpiresIn()).isEqualTo(1800);
+        assertThat(result.getContent().getAdditional()).containsEntry("scope", "test");
+    }
+
     @Test
     void verifyFailureIfServerCallFails() {
         var request = createRequest();