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

Jump to bottom

Fix performance issue in OpenAPI Schema validation logic #12494

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix performance issue in OpenAPI Schema validation logic #12494

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
0712b13
Fix performance issue in schema validation
imesh94 Jul 16, 2024
49e0c7b
Add comments
imesh94 Jul 16, 2024
395f36b
Move get validator logic to a separate method
imesh94 Jul 16, 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
38 changes: 32 additions & 6 deletions ...teway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/security/SchemaValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import io.swagger.util.Json;
import io.swagger.v3.oas.models.OpenAPI;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.synapse.MessageContext;
Expand All @@ -31,6 +32,8 @@
import org.wso2.carbon.apimgt.gateway.handlers.security.model.OpenAPIResponse;
import org.wso2.carbon.apimgt.gateway.utils.GatewayUtils;

import java.util.HashMap;

/**
* This SchemaValidator handler validates the request/response messages against schema defined in the swagger.
*/
Expand All @@ -40,6 +43,7 @@ public class SchemaValidator extends AbstractHandler {
private static final Log logger = LogFactory.getLog(SchemaValidator.class);
private static final String HTTP_SC_CODE = "400";
public static final String REG_TIME_MODULE = "register.timeModule";
public static HashMap<String, OpenApiInteractionValidator> validatorMap = new HashMap<>();

/**
* Method to generate OpenApiInteractionValidator when the openAPI is provided.
Expand Down Expand Up @@ -69,10 +73,10 @@ public boolean handleRequest(MessageContext messageContext) {
}
logger.debug("Validating the API request Body content..");
OpenAPI openAPI = (OpenAPI) messageContext.getProperty(APIMgtGatewayConstants.OPEN_API_OBJECT);
if (openAPI != null) {
OpenApiInteractionValidator validator = getOpenAPIValidator(openAPI);
Object openAPIStringObject = messageContext.getProperty(APIMgtGatewayConstants.OPEN_API_STRING);
if (openAPI != null && openAPIStringObject != null) {
OpenApiInteractionValidator validator = getOpenApiValidator(openAPI, openAPIStringObject.toString());
OpenAPIRequest request = new OpenAPIRequest(messageContext);

ValidationReport validationReport = validator.validateRequest(request);
messageContext.setProperty(APIMgtGatewayConstants.SCHEMA_VALIDATION_REPORT, validationReport);
if (validationReport.hasErrors()) {
Expand All @@ -92,10 +96,10 @@ public boolean handleRequest(MessageContext messageContext) {
public boolean handleResponse(MessageContext messageContext) {

OpenAPI openAPI = (OpenAPI) messageContext.getProperty(APIMgtGatewayConstants.OPEN_API_OBJECT);
if (openAPI != null) {
OpenApiInteractionValidator validator = getOpenAPIValidator(openAPI);
Object openAPIStringObject = messageContext.getProperty(APIMgtGatewayConstants.OPEN_API_STRING);
if (openAPI != null && openAPIStringObject != null) {
OpenApiInteractionValidator validator = getOpenApiValidator(openAPI, openAPIStringObject.toString());
OpenAPIResponse response = new OpenAPIResponse(messageContext);

ValidationReport validationReport = validator.validateResponse(response.getPath(), response.getMethod(),
response);
if (validationReport.hasErrors()) {
Expand All @@ -110,4 +114,26 @@ public boolean handleResponse(MessageContext messageContext) {
}
return true;
}

/**
* Method to get OpenApiInteractionValidator for the given openAPI.
* If the validator is already created for the given openAPI, it will return the existing one.
* Created validators are mapped against the hash of the yaml.
*
* @param openAPI - OpenAPI object
* @param openAPIString - OpenAPI string (yaml)
* @return OpenApiInteractionValidator
*/
private OpenApiInteractionValidator getOpenApiValidator(OpenAPI openAPI, String openAPIString) {

OpenApiInteractionValidator validator;
String apiIdentifier = DigestUtils.md5Hex(openAPIString);
if (validatorMap.containsKey(apiIdentifier)) {
validator = validatorMap.get(apiIdentifier);
} else {
validator = getOpenAPIValidator(openAPI);
validatorMap.put(apiIdentifier, validator);
}
return validator;
}
}
12 changes: 2 additions & 10 deletions .../src/main/java/org/wso2/carbon/apimgt/gateway/handlers/security/model/OpenAPIRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,8 @@
import com.atlassian.oai.validator.model.Request;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import io.swagger.parser.OpenAPIParser;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Paths;
import io.swagger.v3.parser.core.models.ParseOptions;
import io.swagger.v3.parser.core.models.SwaggerParseResult;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.synapse.MessageContext;
Expand All @@ -33,7 +30,6 @@
import org.wso2.carbon.apimgt.gateway.handlers.security.utils.SchemaValidationUtils;

import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Locale;
Expand Down Expand Up @@ -73,12 +69,8 @@ public OpenAPIRequest(MessageContext messageContext) {
//Set Request path
path = SchemaValidationUtils.getRestSubRequestPath(
messageContext.getProperty(REST_SUB_REQUEST_PATH).toString());
String swagger = messageContext.getProperty(APIMgtGatewayConstants.OPEN_API_STRING).toString();
if (swagger != null) {
OpenAPIParser openAPIParser = new OpenAPIParser();
SwaggerParseResult swaggerParseResult =
openAPIParser.readContents(swagger, new ArrayList<>(), new ParseOptions());
OpenAPI openAPI = swaggerParseResult.getOpenAPI();
OpenAPI openAPI = (OpenAPI) messageContext.getProperty(APIMgtGatewayConstants.OPEN_API_OBJECT);
if (openAPI != null) {
validatePath(openAPI);
}
//extract transport headers
Expand Down
Loading