Skip to content

Commit

Permalink
added diagnostic logs and unit tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sachin-Mamoru
Sachin-Mamoru committed Apr 9, 2024
1 parent dc7ea3e commit afe4342
Show file tree
Hide file tree
Showing 7 changed files with 488 additions and 58 deletions.
36 changes: 36 additions & 0 deletions ...main/java/org/wso2/carbon/identity/conditional/auth/functions/common/utils/Constants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,40 @@ public class Constants {
public static final String HTTP_FUNCTION_ALLOWED_DOMAINS = "AdaptiveAuth.HTTPFunctionAllowedDomains.Domain";
public static final String CHOREO_DOMAINS = "AdaptiveAuth.ChoreoDomains.Domain";
public static final String CHOREO_TOKEN_ENDPOINT = "AdaptiveAuth.ChoreoTokenEndpoint";

/**
* Define logging constants.
*/
public static class LogConstants {

public static final String ADAPTIVE_AUTH_SERVICE = "adaptive-auth-service";
public static final String FAILED = "FAILED";

/**
* Define action IDs for diagnostic logs.
*/
public static class ActionIDs {

public static final String RECEIVE_TOKEN = "receive-token";
public static final String RECEIVE_API_RESPONSE = "receive-api-response";
}

/**
* Define common and reusable Input keys for diagnostic logs.
*/
public static class InputKeys {

public static final String TOKEN_ENDPOINT = "token endpoint";
public static final String EXTERNAL_API = "external api";
}

/**
* Define common and reusable Configuration keys for diagnostic logs.
*/
public static class ConfigKeys {

public static final String SUPPORTED_GRANT_TYPES = "supported grant types";

}
}
}
140 changes: 103 additions & 37 deletions ...n/java/org/wso2/carbon/identity/conditional/auth/functions/http/AbstractHTTPFunction.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,15 @@
import org.json.simple.parser.ParseException;
import org.wso2.carbon.identity.application.authentication.framework.AsyncProcess;
import org.wso2.carbon.identity.application.authentication.framework.config.model.graph.JsGraphBuilder;
import org.wso2.carbon.identity.central.log.mgt.utils.LoggerUtils;
import org.wso2.carbon.identity.conditional.auth.functions.common.utils.ConfigProvider;
import org.wso2.carbon.identity.conditional.auth.functions.common.utils.Constants;
import org.wso2.carbon.identity.conditional.auth.functions.http.util.AuthConfig;
import org.wso2.carbon.identity.conditional.auth.functions.http.util.AuthConfigFactory;
import org.wso2.carbon.identity.conditional.auth.functions.http.util.AuthConfigModel;
import org.wso2.carbon.identity.core.util.IdentityUtil;
import org.wso2.carbon.identity.secret.mgt.core.exception.SecretManagementException;
import org.wso2.carbon.utils.DiagnosticLog;

import java.io.IOException;
import java.net.SocketTimeoutException;
Expand Down Expand Up @@ -109,11 +111,34 @@ protected void executeHttpMethod(HttpUriRequest clientRequest, Map<String, Objec
LOG.error("Provided Url does not contain a allowed domain. Invalid Url: " + endpointURL);
asyncReturn.accept(context, Collections.emptyMap(), Constants.OUTCOME_FAIL);
} else {
Pair<String, JSONObject> result = executeRequestWithRetries
(request, endpointURL, maxRequestAttemptsForAPIEndpointTimeout);
Pair<String, JSONObject> result = executeRequest(request, endpointURL);
if (result.getLeft().equals(Constants.OUTCOME_FAIL)) {
if (LoggerUtils.isDiagnosticLogsEnabled()) {
DiagnosticLog.DiagnosticLogBuilder diagnosticLogBuilder = new
DiagnosticLog.DiagnosticLogBuilder(Constants.LogConstants.ADAPTIVE_AUTH_SERVICE,
Constants.LogConstants.ActionIDs.RECEIVE_API_RESPONSE);
diagnosticLogBuilder.inputParam(Constants.LogConstants.InputKeys.EXTERNAL_API, endpointURL)
.resultMessage("Error while calling endpoint, proceeding with retry attempts.")
.logDetailLevel(DiagnosticLog.LogDetailLevel.APPLICATION)
.resultStatus(DiagnosticLog.ResultStatus.FAILED);
LoggerUtils.triggerDiagnosticLogEvent(diagnosticLogBuilder);
}
LOG.error("Error while calling endpoint. Url: " + endpointURL);
result = executeRequestWithRetries(request, endpointURL, maxRequestAttemptsForAPIEndpointTimeout);
} else {
if (LoggerUtils.isDiagnosticLogsEnabled()) {
DiagnosticLog.DiagnosticLogBuilder diagnosticLogBuilder = new
DiagnosticLog.DiagnosticLogBuilder(Constants.LogConstants.ADAPTIVE_AUTH_SERVICE,
Constants.LogConstants.ActionIDs.RECEIVE_API_RESPONSE);
diagnosticLogBuilder.inputParam(Constants.LogConstants.InputKeys.EXTERNAL_API, endpointURL)
.resultMessage("Successfully called the external endpoint.")
.logDetailLevel(DiagnosticLog.LogDetailLevel.APPLICATION)
.resultStatus(DiagnosticLog.ResultStatus.SUCCESS);
LoggerUtils.triggerDiagnosticLogEvent(diagnosticLogBuilder);
}
}
outcome = result.getLeft();
JSONObject json = result.getRight();

asyncReturn.accept(context, json != null ? json : Collections.emptyMap(), outcome);
}
} catch (SecretManagementException e) {
Expand All @@ -136,49 +161,90 @@ protected void executeHttpMethod(HttpUriRequest clientRequest, Map<String, Objec
* @return Pair of outcome and json.
*/
private Pair<String, JSONObject> executeRequestWithRetries(HttpUriRequest request, String endpointURL, int maxRetries) {

JSONObject json = null;
String outcome = Constants.OUTCOME_FAIL;
int attempts = 0;

while (attempts < maxRetries) {
attempts++;
try (CloseableHttpResponse response = client.execute(request)) {
int responseCode = response.getStatusLine().getStatusCode();
if (responseCode >= 200 && responseCode < 300) {
outcome = Constants.OUTCOME_SUCCESS;
if (response.getEntity() != null) {
Header contentType = response.getEntity().getContentType();
String jsonString = EntityUtils.toString(response.getEntity());
if (contentType != null && contentType.getValue().contains(TYPE_TEXT_PLAIN)) {
json = new JSONObject();
json.put(RESPONSE, jsonString);
} else {
JSONParser parser = new JSONParser();
json = (JSONObject) parser.parse(jsonString);
}
}
return Pair.of(outcome, json); // Success, return immediately
} else if (responseCode == HTTP_STATUS_UNAUTHORIZED) {
LOG.warn("Received 401 response from external API call. Url: " + endpointURL);
return Pair.of(Constants.OUTCOME_FAIL, null); // Unauthorized, no retry
} else {
outcome = Constants.OUTCOME_FAIL; // Other client or server error, retry if attempts left
LOG.warn("Retrying the request. Attempt: " + attempts + " for endpoint: " + endpointURL);
if (LoggerUtils.isDiagnosticLogsEnabled()) {
DiagnosticLog.DiagnosticLogBuilder diagnosticLogBuilder = new
DiagnosticLog.DiagnosticLogBuilder(Constants.LogConstants.ADAPTIVE_AUTH_SERVICE,
Constants.LogConstants.ActionIDs.RECEIVE_API_RESPONSE);
diagnosticLogBuilder.inputParam(Constants.LogConstants.InputKeys.EXTERNAL_API, endpointURL)
.resultMessage("Retrying the request for external endpoint.")
.logDetailLevel(DiagnosticLog.LogDetailLevel.APPLICATION)
.resultStatus(DiagnosticLog.ResultStatus.FAILED);
LoggerUtils.triggerDiagnosticLogEvent(diagnosticLogBuilder);
}
Pair<String, JSONObject> result = executeRequest(request, endpointURL);
if (result.getLeft().equals(Constants.OUTCOME_SUCCESS)) {
if (LoggerUtils.isDiagnosticLogsEnabled()) {
DiagnosticLog.DiagnosticLogBuilder diagnosticLogBuilder = new
DiagnosticLog.DiagnosticLogBuilder(Constants.LogConstants.ADAPTIVE_AUTH_SERVICE,
Constants.LogConstants.ActionIDs.RECEIVE_API_RESPONSE);
diagnosticLogBuilder.inputParam(Constants.LogConstants.InputKeys.EXTERNAL_API, endpointURL)
.resultMessage("Successfully called the external endpoint.")
.logDetailLevel(DiagnosticLog.LogDetailLevel.APPLICATION)
.resultStatus(DiagnosticLog.ResultStatus.SUCCESS);
LoggerUtils.triggerDiagnosticLogEvent(diagnosticLogBuilder);
}
} catch (Exception e) {
// Log the error based on its type
if (e instanceof IllegalArgumentException) {
LOG.error("Invalid Url: " + endpointURL, e);
} else if (e instanceof ConnectTimeoutException) {
LOG.error("Error while waiting to connect to " + endpointURL, e);
} else if (e instanceof SocketTimeoutException) {
LOG.error("Error while waiting for data from " + endpointURL, e);
} else if (e instanceof IOException) {
LOG.error("Error while calling endpoint. ", e);
} else if (e instanceof ParseException) {
LOG.error("Error while parsing response. ", e);
return result;
}
}
return Pair.of(outcome, json); // Return outcome and json (which might be null if never successful)
}

/**
* Execute the request.
*
* @param request HttpUriRequest.
* @param endpointURL Endpoint URL.
* @return Pair of outcome and json.
*/
private Pair<String, JSONObject> executeRequest(HttpUriRequest request, String endpointURL) {

JSONObject json = null;
String outcome;

try (CloseableHttpResponse response = client.execute(request)) {
int responseCode = response.getStatusLine().getStatusCode();
if (responseCode >= 200 && responseCode < 300) {
outcome = Constants.OUTCOME_SUCCESS;
if (response.getEntity() != null) {
Header contentType = response.getEntity().getContentType();
String jsonString = EntityUtils.toString(response.getEntity());
if (contentType != null && contentType.getValue().contains(TYPE_TEXT_PLAIN)) {
json = new JSONObject();
json.put(RESPONSE, jsonString);
} else {
JSONParser parser = new JSONParser();
json = (JSONObject) parser.parse(jsonString);
}
}
outcome = Constants.OUTCOME_FAIL; // Mark as fail and check if retry is possible
return Pair.of(outcome, json); // Success, return immediately
} else if (responseCode == HTTP_STATUS_UNAUTHORIZED) {
LOG.warn("Received 401 response from external API call. Url: " + endpointURL);
return Pair.of(Constants.OUTCOME_FAIL, null); // Unauthorized, no retry
} else {
outcome = Constants.OUTCOME_FAIL; // Other client or server error, retry if attempts left
}
} catch (Exception e) {
// Log the error based on its type
if (e instanceof IllegalArgumentException) {
LOG.error("Invalid Url: " + endpointURL, e);
} else if (e instanceof ConnectTimeoutException) {
LOG.error("Error while waiting to connect to " + endpointURL, e);
} else if (e instanceof SocketTimeoutException) {
LOG.error("Error while waiting for data from " + endpointURL, e);
} else if (e instanceof IOException) {
LOG.error("Error while calling endpoint. ", e);
} else if (e instanceof ParseException) {
LOG.error("Error while parsing response. ", e);
}
outcome = Constants.OUTCOME_FAIL; // Mark as fail and check if retry is possible
}
return Pair.of(outcome, json); // Return outcome and json (which might be null if never successful)
}
Expand Down
Loading

0 comments on commit afe4342

Please sign in to comment.