Skip to content

fix: record the credentials request metric with the token request's attributes #410

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

Open
cvas22 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: record the credentials request metric with the token request's attributes #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions src/main/java/dev/openfga/sdk/api/auth/OAuth2Client.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
import java.net.URI;
import java.net.http.HttpRequest;
import java.time.Instant;
import java.util.HashMap;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.atomic.AtomicReference;

Expand Down Expand Up @@ -88,7 +87,6 @@ public CompletableFuture<String> getAccessToken() throws FgaInvalidParameterExce
snapshot.set(new AccessToken(token, Instant.now().plusSeconds(response.getExpiresInSeconds())));
inFlight.set(null);
promise.complete(token);
telemetry.metrics().credentialsRequest(1L, new HashMap<>());
}
});
} catch (Exception e) {
Expand All @@ -112,10 +110,14 @@ private CompletableFuture<CredentialsFlowResponse> exchangeToken()
ApiClient.formRequestBuilder("POST", "", this.authRequest.buildFormRequestBody(), config);
HttpRequest request = requestBuilder.build();

return new HttpRequestAttempt<>(
request, "exchangeToken", CredentialsFlowResponse.class, apiClient, config, telemetry)
.attemptHttpRequest()
.thenApply(ApiResponse::getData);
HttpRequestAttempt<CredentialsFlowResponse> attempt = new HttpRequestAttempt<>(
request, "exchangeToken", CredentialsFlowResponse.class, apiClient, config, telemetry);

return attempt.attemptHttpRequest().thenApply(response -> {
// Record the token request with the attributes of its HTTP request, e.g. the host and status code
telemetry.metrics().credentialsRequest(1L, attempt.getTelemetryAttributes());
return response.getData();
});
}

private static String buildApiTokenIssuer(String issuer) throws FgaInvalidParameterException {
Expand Down
35 changes: 35 additions & 0 deletions src/test/java/dev/openfga/sdk/api/auth/OAuth2ClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
import static org.hamcrest.core.StringContains.containsString;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.mockConstruction;
import static org.mockito.Mockito.mockingDetails;
import static org.mockito.Mockito.when;

import com.github.tomakehurst.wiremock.junit5.*;
Expand All @@ -15,19 +17,26 @@
import dev.openfga.sdk.api.configuration.*;
import dev.openfga.sdk.constants.FgaConstants;
import dev.openfga.sdk.errors.FgaInvalidParameterException;
import dev.openfga.sdk.telemetry.Attribute;
import dev.openfga.sdk.telemetry.Attributes;
import dev.openfga.sdk.telemetry.Metrics;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.mockito.MockedConstruction;
import org.mockito.invocation.Invocation;

@WireMockTest
class OAuth2ClientTest {
Expand Down Expand Up @@ -368,6 +377,32 @@ public void apiTokenIssuers_invalidURI(String invalidApiTokenIssuer) {
assertInstanceOf(IllegalArgumentException.class, exception.getCause());
}

@Test
public void credentialsRequestMetricHasTheTokenRequestAttributes() throws Exception {
try (MockedConstruction<Metrics> metrics = mockConstruction(Metrics.class)) {
// Given
OAuth2Client auth0 = newAuth0Client("https://issuer.fga.example");
mockHttpClient
.onPost("https://issuer.fga.example/oauth/token")
.doReturn(200, String.format("{\"access_token\":\"%s\"}", ACCESS_TOKEN));

// When
auth0.getAccessToken().get();

// Then
List<Invocation> credentialsRequests = metrics.constructed().stream()
.flatMap(m -> mockingDetails(m).getInvocations().stream())
.filter(invocation -> invocation.getMethod().getName().equals("credentialsRequest"))
.collect(Collectors.toList());
assertEquals(1, credentialsRequests.size());

Map<Attribute, String> attributes = credentialsRequests.get(0).getArgument(1);
assertEquals("issuer.fga.example", attributes.get(Attributes.HTTP_HOST));
assertEquals("200", attributes.get(Attributes.HTTP_RESPONSE_STATUS_CODE));
assertEquals("POST", attributes.get(Attributes.HTTP_REQUEST_METHOD));
}
}

private OAuth2Client newAuth0Client(String apiTokenIssuer) throws FgaInvalidParameterException {
return newClientCredentialsClient(
apiTokenIssuer,
Expand Down