Skip to content

Avaje-Http Plugin #72

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 2 commits into from
Jul 13, 2023
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
1 change: 0 additions & 1 deletion blackbox-test/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
<properties>
<maven.deploy.skip>true</maven.deploy.skip>
<java.release>17</java.release>
<inject.version>9.3-RC3</inject.version>
</properties>

<dependencies>
Expand Down
2 changes: 2 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@
<nexus.staging.autoReleaseAfterClose>true</nexus.staging.autoReleaseAfterClose>
<java.version>17</java.version>
<java.release>17</java.release>
<inject.version>9.3</inject.version>
</properties>

<modules>
<module>validator</module>
<module>validator-constraints</module>
<module>validator-generator</module>
<module>validator-http-plugin</module>
<module>validator-inject-plugin</module>
</modules>

Expand Down
62 changes: 62 additions & 0 deletions validator-http-plugin/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator-parent</artifactId>
<version>0.1-SNAPSHOT</version>
</parent>
<artifactId>avaje-validator-http-plugin</artifactId>
<name>validator-http-plugin</name>
<properties>
<http.version>1.45-SNAPSHOT</http.version>
</properties>
<dependencies>
<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator</artifactId>
<!-- TODO complete the circle later -->
<version>0.1-SNAPSHOT</version>
<scope>provided</scope>
<optional>true</optional>
</dependency>

<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator-inject-plugin</artifactId>
<version>${project.version}</version>
</dependency>

<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-inject</artifactId>
<version>${inject.version}</version>
<scope>provided</scope>
<optional>true</optional>
</dependency>

<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-http-api</artifactId>
<version>${http.version}</version>
<scope>provided</scope>
<optional>true</optional>
</dependency>

<dependency>
<groupId>io.avaje</groupId>
<artifactId>junit</artifactId>
<version>1.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-inject-test</artifactId>
<version>${inject.version}</version>
<scope>test</scope>
</dependency>
</dependencies>

</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
package io.avaje.validation.http;

import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Set;

import io.avaje.http.api.ValidationException;
import io.avaje.inject.BeanScope;
import io.avaje.inject.PostConstruct;
import io.avaje.validation.ConstraintViolation;
import io.avaje.validation.ConstraintViolationException;
import io.avaje.validation.Validator;

public class BeanValidator implements io.avaje.http.api.Validator {

private Validator validator;
private final Collection<Locale> locales;

public BeanValidator(Collection<Locale> locales) {
this.locales = locales;
}

@Override
public void validate(Object bean, String acceptLanguage, Class<?>... groups)
throws ValidationException {

final Locale language = resolveLocale(acceptLanguage, locales);
try {
validator.validate(bean, language, groups);
} catch (final ConstraintViolationException e) {
throwExceptionWith(e.violations());
}
}

@PostConstruct
void setValidator(BeanScope scope) {
this.validator = scope.get(Validator.class);
}

private void throwExceptionWith(Set<ConstraintViolation> violations) {

final Map<String, Object> errors = new LinkedHashMap<>();
for (final var violation : violations) {
final var path = violation.path();
final var message = violation.message();
errors.put(path, message);
}

throw new ValidationException(422, "Request failed validation", errors);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package io.avaje.validation.http;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Locale;

import io.avaje.http.api.Validator;
import io.avaje.inject.BeanScopeBuilder;

/** Plugin for avaje inject that provides a default Http Validator instance. */
public final class DefaultValidatorProvider implements io.avaje.inject.spi.Plugin {

@Override
public Class<?>[] provides() {
return new Class<?>[] {Validator.class};
}

@Override
public void apply(BeanScopeBuilder builder) {

final var props = builder.propertyPlugin();

final var locales = new ArrayList<Locale>();

props.get("validation.locale.default").map(Locale::forLanguageTag).ifPresent(locales::add);

props.get("validation.locale.addedLocales").stream()
.flatMap(s -> Arrays.stream(s.split(",")))
.map(Locale::forLanguageTag)
.forEach(locales::add);

final var beanValidator = new BeanValidator(locales);

builder.addPostConstructConsumerHook(beanValidator::setValidator);

builder.provideDefault(null, Validator.class, () -> beanValidator);
}
}
7 changes: 7 additions & 0 deletions validator-http-plugin/src/main/java/module-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module io.avaje.validation.http {

requires transitive io.avaje.validation.plugin;
requires transitive io.avaje.http.api;

provides io.avaje.inject.spi.Plugin with io.avaje.validation.http.DefaultValidatorProvider;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
io.avaje.validation.http.DefaultValidatorProvider
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package io.avaje.validation.http;

public record CrewMate(String assignedTasks) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package io.avaje.validation.http;

import java.util.Map;

import io.avaje.validation.adapter.ValidationAdapter;
import io.avaje.validation.adapter.ValidationContext;
import io.avaje.validation.adapter.ValidationContext.Message;
import io.avaje.validation.adapter.ValidationRequest;
import io.avaje.validation.spi.Generated;

@Generated
public final class CrewMateValidationAdapter implements ValidationAdapter<CrewMate> {

private final Message message;

public CrewMateValidationAdapter(ValidationContext ctx) {
this.message = ctx.message("ඞ", Map.of());
}

@Override
public boolean validate(CrewMate value, ValidationRequest request, String propertyName) {
if (value.assignedTasks().isBlank()) {
request.addViolation(message, propertyName);
}
return true;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
package io.avaje.validation.http;

import static org.junit.jupiter.api.Assertions.*;

import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import io.avaje.http.api.ValidationException;
import io.avaje.http.api.Validator;
import io.avaje.inject.BeanScope;
import io.avaje.inject.spi.Builder;
import io.avaje.inject.spi.Module;

class DefaultValidatorProviderTest {
Module mod =
new Module() {

@Override
public Class<?>[] classes() {
return new Class<?>[] {};
}

@Override
public void build(Builder builder) {}
};
private Validator validator;

@BeforeAll
static void setLocale() {
System.setProperty("validation.locale.default", "en-us");
}

@BeforeEach
void before() {
System.setProperty("validation.locale.default", "en-us");
final var v =
io.avaje.validation.Validator.builder()
.add(CrewMate.class, CrewMateValidationAdapter::new)
.build();
this.validator =
BeanScope.builder()
.modules(mod)
.bean(io.avaje.validation.Validator.class, v)
.build()
.get(Validator.class);
}

@Test
void test() {
assertAll(() -> validator.validate(new CrewMate("hmm"), "en-GB,en;q=0.9,en-US;q=0.8,de;q=0.7"));
}

@Test
void test2() {
assertThrows(
ValidationException.class,
() -> validator.validate(new CrewMate(""), "en-GB,en;q=0.9,en-US;q=0.8,de;q=0.7"));
}
}
5 changes: 1 addition & 4 deletions validator-inject-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@
</parent>
<artifactId>avaje-validator-inject-plugin</artifactId>
<name>validator-inject-plugin</name>
<properties>
<inject.version>9.3-RC2</inject.version>
</properties>
<dependencies>
<dependency>
<groupId>io.avaje</groupId>
Expand All @@ -26,7 +23,7 @@
<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-inject</artifactId>
<version>9.2</version>
<version>${inject.version}</version>
<scope>provided</scope>
<optional>true</optional>
</dependency>
Expand Down