Skip to content

Support virtual threads #215

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.

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

Merged
merged 7 commits into from
Jun 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ openapi.validation.validation-report-metric-additional-tags=service=example,team
# Fail requests on request/response violations. Defaults to false.
openapi.validation.should-fail-on-request-violation=true
openapi.validation.should-fail-on-response-violation=true

# Enable virtual threads for async validation. Defaults to false.
openapi.validation.enable-virtual-threads=true
```

### DataDog metrics
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,26 @@
import java.net.URLDecoder;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.concurrent.Executor;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.ThreadPoolExecutor;
import javax.annotation.Nullable;
import lombok.extern.slf4j.Slf4j;
import org.apache.http.client.utils.URLEncodedUtils;

@Slf4j
public class OpenApiRequestValidator {
private final ThreadPoolExecutor threadPoolExecutor;
private final Executor executor;
private final OpenApiInteractionValidatorWrapper validator;
private final ValidationReportToOpenApiViolationsMapper mapper;

public OpenApiRequestValidator(
ThreadPoolExecutor threadPoolExecutor,
Executor executor,
MetricsReporter metricsReporter,
OpenApiInteractionValidatorWrapper validator,
ValidationReportToOpenApiViolationsMapper mapper,
OpenApiRequestValidationConfiguration configuration
) {
this.threadPoolExecutor = threadPoolExecutor;
this.executor = executor;
this.validator = validator;
this.mapper = mapper;

Expand Down Expand Up @@ -74,7 +74,7 @@ public void validateResponseObjectAsync(

private void executeAsync(Runnable command) {
try {
threadPoolExecutor.execute(command);
executor.execute(command);
} catch (RejectedExecutionException ignored) {
// ignored
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package com.getyourguide.openapi.validation.core.executor;

import java.util.concurrent.Executor;
import java.util.concurrent.atomic.AtomicInteger;

public class VirtualThreadLimitedExecutor implements Executor {
private static final int DEFAULT_MAX_CONCURRENT = 2;
private final int maxConcurrent;
private final AtomicInteger runningCount = new AtomicInteger(0);

public VirtualThreadLimitedExecutor() {
this(DEFAULT_MAX_CONCURRENT);
}

public VirtualThreadLimitedExecutor(int maxConcurrent) {
checkVirtualThreadSupport();
this.maxConcurrent = maxConcurrent;
}

public static boolean isSupported() {
try {
checkVirtualThreadSupport();
return true;
} catch (UnsupportedOperationException | NoSuchMethodError e) {
return false;
}
}

private static void checkVirtualThreadSupport() {
// This will throw NoSuchMethodError on Java < 21
//noinspection ResultOfMethodCallIgnored
Thread.ofVirtual();
}

@Override
public void execute(Runnable command) {
if (runningCount.get() >= maxConcurrent) {
return;
}

if (runningCount.incrementAndGet() > maxConcurrent) {
runningCount.decrementAndGet();
return;
}

Thread.ofVirtual().start(() -> {
try {
command.run();
} finally {
runningCount.decrementAndGet();
}
});
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,30 @@
import java.net.URI;
import java.util.HashMap;
import java.util.List;
import java.util.concurrent.Executor;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.ThreadPoolExecutor;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.Mockito;

public class OpenApiRequestValidatorTest {

private ThreadPoolExecutor threadPoolExecutor;
private Executor executor;
private OpenApiInteractionValidatorWrapper validator;

private OpenApiRequestValidator openApiRequestValidator;

@BeforeEach
public void setup() {
threadPoolExecutor = mock();
executor = mock();
validator = mock();
MetricsReporter metricsReporter = mock();
var mapper = mock(ValidationReportToOpenApiViolationsMapper.class);
when(mapper.map(any(), any(), any(), any(), any())).thenReturn(List.of());

openApiRequestValidator = new OpenApiRequestValidator(
threadPoolExecutor,
executor,
metricsReporter,
validator,
mapper,
Expand All @@ -47,7 +47,7 @@ public void setup() {

@Test
public void testWhenThreadPoolExecutorRejectsExecutionThenItShouldNotThrow() {
Mockito.doThrow(new RejectedExecutionException()).when(threadPoolExecutor).execute(any());
Mockito.doThrow(new RejectedExecutionException()).when(executor).execute(any());

openApiRequestValidator.validateRequestObjectAsync(mock(), null, null, mock());
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public class OpenApiValidationApplicationProperties {
private List<String> excludedHeaders;
private Boolean shouldFailOnRequestViolation;
private Boolean shouldFailOnResponseViolation;
private Boolean enableVirtualThreads;

public double getSampleRate() {
return sampleRate != null ? sampleRate : SAMPLE_RATE_DEFAULT;
Expand Down Expand Up @@ -84,6 +85,10 @@ public List<ExcludedHeader> getExcludedHeaders() {
.toList();
}

public boolean isEnableVirtualThreads() {
return enableVirtualThreads != null ? enableVirtualThreads : false;
}

public OpenApiRequestValidationConfiguration toOpenApiRequestValidationConfiguration() {
return OpenApiRequestValidationConfiguration.builder()
.sampleRate(getSampleRate())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@
import com.getyourguide.openapi.validation.core.OpenApiInteractionValidatorFactory;
import com.getyourguide.openapi.validation.core.OpenApiRequestValidator;
import com.getyourguide.openapi.validation.core.exclusions.InternalViolationExclusions;
import com.getyourguide.openapi.validation.core.executor.VirtualThreadLimitedExecutor;
import com.getyourguide.openapi.validation.core.log.DefaultOpenApiViolationHandler;
import com.getyourguide.openapi.validation.core.log.ExclusionsOpenApiViolationHandler;
import com.getyourguide.openapi.validation.core.log.ThrottlingOpenApiViolationHandler;
import com.getyourguide.openapi.validation.core.mapper.ValidationReportToOpenApiViolationsMapper;
import com.getyourguide.openapi.validation.core.metrics.DefaultMetricsReporter;
import java.util.Optional;
import java.util.concurrent.Executor;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
Expand Down Expand Up @@ -104,14 +106,7 @@ public OpenApiRequestValidator openApiRequestValidator(
MetricsReporter metricsReporter,
ValidatorConfiguration validatorConfiguration
) {
var threadPoolExecutor = new ThreadPoolExecutor(
2,
2,
1000L,
TimeUnit.MILLISECONDS,
new LinkedBlockingQueue<>(10),
new ThreadPoolExecutor.DiscardPolicy()
);
var threadPoolExecutor = createThreadPoolExecutor();

return new OpenApiRequestValidator(
threadPoolExecutor,
Expand All @@ -122,4 +117,20 @@ public OpenApiRequestValidator openApiRequestValidator(
properties.toOpenApiRequestValidationConfiguration()
);
}

private Executor createThreadPoolExecutor() {
if (properties.isEnableVirtualThreads() && VirtualThreadLimitedExecutor.isSupported()) {
return new VirtualThreadLimitedExecutor();
}

// Fallback to ThreadPoolExecutor with regular threads
return new ThreadPoolExecutor(
2,
2,
1000L,
TimeUnit.MILLISECONDS,
new LinkedBlockingQueue<>(10),
new ThreadPoolExecutor.DiscardPolicy()
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ void getters() {
EXCLUDED_PATHS,
EXCLUDED_HEADERS,
true,
false
false,
true
);

assertEquals(SAMPLE_RATE, loggingConfiguration.getSampleRate());
Expand Down
Loading