Skip to content

Commit 4e5fad4

Browse files
authored
feat: add Vaadin Nonnull annotation (#11341)
Adds a `@Nonnull` annotation that is applicable to not only fields/methods/parameters like `javax.annotation.Nonnull` but also to type parameters. It gives more control over the generated Typescript code. It is still possible to use any other annotation with the case-insensitive `nonnull` name.
1 parent fad444d commit 4e5fad4

24 files changed

Lines changed: 322 additions & 86 deletions

‎fusion-endpoint/src/main/java/com/vaadin/fusion/EndpointUtil.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,11 @@
1515
*/
1616
package com.vaadin.fusion;
1717

18+
import javax.servlet.http.HttpServletRequest;
1819
import java.lang.reflect.Method;
1920
import java.util.Map;
2021
import java.util.Optional;
2122

22-
import javax.servlet.http.HttpServletRequest;
23-
24-
import com.vaadin.fusion.auth.VaadinConnectAccessChecker;
25-
2623
import org.springframework.beans.factory.annotation.Autowired;
2724
import org.springframework.http.server.PathContainer;
2825
import org.springframework.http.server.RequestPath;
@@ -32,6 +29,8 @@
3229
import org.springframework.web.util.pattern.PathPattern.PathMatchInfo;
3330
import org.springframework.web.util.pattern.PathPatternParser;
3431

32+
import com.vaadin.fusion.auth.VaadinConnectAccessChecker;
33+
3534
/**
3635
* A util class related to {@link Endpoint}.
3736
*/
@@ -91,7 +90,7 @@ private Optional<Method> getEndpoint(HttpServletRequest request) {
9190

9291
/**
9392
* Checks if the given request goes to an anonymous (public) endpoint.
94-
*
93+
*
9594
* @param request
9695
* the HTTP request to check
9796
* @return <code>true</code> if the request goes to an anonymous endpoint,

‎fusion-endpoint/src/main/java/com/vaadin/fusion/ExplicitNullableTypeChecker.java‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
package com.vaadin.fusion;
1818

19+
import java.lang.annotation.Annotation;
1920
import java.lang.reflect.AnnotatedElement;
2021
import java.lang.reflect.Field;
2122
import java.lang.reflect.Method;
@@ -40,22 +41,33 @@ public class ExplicitNullableTypeChecker {
4041
* @return a result of check
4142
*/
4243
public static boolean isRequired(AnnotatedElement element) {
43-
boolean isPrimitive = (element instanceof Field
44+
if ((element instanceof Field
4445
&& ((Field) element).getType().isPrimitive())
4546
|| (element instanceof Parameter
46-
&& ((Parameter) element).getType().isPrimitive());
47+
&& ((Parameter) element).getType().isPrimitive())) {
48+
return true;
49+
}
4750

48-
return isPrimitive || Stream.of(element.getAnnotations())
49-
.anyMatch(annotation -> "nonnull".equalsIgnoreCase(
50-
annotation.annotationType().getSimpleName()));
51+
Stream<Annotation> annotations = Stream.of(element.getAnnotations());
52+
53+
if (element instanceof Field) {
54+
annotations = Stream.concat(annotations, Stream
55+
.of(((Field) element).getAnnotatedType().getAnnotations()));
56+
} else if (element instanceof Parameter) {
57+
annotations = Stream.concat(annotations, Stream.of(
58+
((Parameter) element).getAnnotatedType().getAnnotations()));
59+
}
60+
61+
return annotations.anyMatch(annotation -> "nonnull"
62+
.equalsIgnoreCase(annotation.annotationType().getSimpleName()));
5163
}
5264

5365
/**
54-
* Checks if the OpenAPI schema node should be required (not nullable) in
55-
* the generated Typescript code based on annotations.
66+
* Checks if the parsed node should be required (not nullable) in the
67+
* generated Typescript code based on the list of annotations.
5668
*
5769
* @param annotations
58-
* a list of annotations to check
70+
* a list of node annotations to check
5971
* @return a result of check
6072
*/
6173
public static boolean isRequired(List<AnnotationExpr> annotations) {
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* Copyright 2000-2021 Vaadin Ltd.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
5+
* use this file except in compliance with the License. You may obtain a copy of
6+
* the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13+
* License for the specific language governing permissions and limitations under
14+
* the License.
15+
*/
16+
package com.vaadin.fusion;
17+
18+
import java.lang.annotation.Documented;
19+
import java.lang.annotation.ElementType;
20+
import java.lang.annotation.Retention;
21+
import java.lang.annotation.RetentionPolicy;
22+
import java.lang.annotation.Target;
23+
24+
/**
25+
* Annotation to mark either field, method, parameter or type parameter as
26+
* non-nullable. It is used by Typescript Generator as a source of type
27+
* nullability information.
28+
*
29+
* Since Typescript Generator works with any annotation with case-insensitive
30+
* `nonnull` name, this annotation exists only for convenience because the
31+
* traditional `javax.annotation.Nonnull` annotation is not applicable to type
32+
* parameters.
33+
*/
34+
@Documented
35+
@Retention(RetentionPolicy.RUNTIME)
36+
@Target({ ElementType.TYPE_USE })
37+
public @interface Nonnull {
38+
}

‎fusion-endpoint/src/main/java/com/vaadin/fusion/VaadinConnectController.java‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515
*/
1616
package com.vaadin.fusion;
1717

18+
import javax.servlet.ServletContext;
19+
import javax.servlet.http.HttpServletRequest;
20+
import javax.validation.ConstraintViolation;
21+
import javax.validation.Validation;
22+
import javax.validation.Validator;
1823
import java.io.IOException;
1924
import java.lang.reflect.InvocationTargetException;
2025
import java.lang.reflect.Method;
@@ -31,32 +36,13 @@
3136
import java.util.stream.Collectors;
3237
import java.util.stream.Stream;
3338

34-
import javax.servlet.ServletContext;
35-
import javax.servlet.http.HttpServletRequest;
36-
import javax.validation.ConstraintViolation;
37-
import javax.validation.Validation;
38-
import javax.validation.Validator;
39-
4039
import com.fasterxml.jackson.annotation.JsonAutoDetect;
4140
import com.fasterxml.jackson.annotation.PropertyAccessor;
4241
import com.fasterxml.jackson.core.JsonProcessingException;
4342
import com.fasterxml.jackson.databind.JsonNode;
4443
import com.fasterxml.jackson.databind.ObjectMapper;
4544
import com.fasterxml.jackson.databind.node.ObjectNode;
4645
import com.googlecode.gentyref.GenericTypeReflector;
47-
import com.vaadin.flow.internal.CurrentInstance;
48-
import com.vaadin.flow.server.VaadinRequest;
49-
import com.vaadin.flow.server.VaadinService;
50-
import com.vaadin.flow.server.VaadinServletContext;
51-
import com.vaadin.flow.server.VaadinServletRequest;
52-
import com.vaadin.flow.server.VaadinServletService;
53-
import com.vaadin.fusion.EndpointRegistry.VaadinEndpointData;
54-
import com.vaadin.fusion.auth.VaadinConnectAccessChecker;
55-
import com.vaadin.fusion.exception.EndpointException;
56-
import com.vaadin.fusion.exception.EndpointValidationException;
57-
import com.vaadin.fusion.exception.EndpointValidationException.ValidationErrorData;
58-
import com.vaadin.flow.server.startup.ApplicationConfiguration;
59-
6046
import org.slf4j.Logger;
6147
import org.slf4j.LoggerFactory;
6248
import org.springframework.beans.factory.annotation.Autowired;
@@ -75,6 +61,19 @@
7561
import org.springframework.web.bind.annotation.RequestBody;
7662
import org.springframework.web.bind.annotation.RestController;
7763

64+
import com.vaadin.flow.internal.CurrentInstance;
65+
import com.vaadin.flow.server.VaadinRequest;
66+
import com.vaadin.flow.server.VaadinService;
67+
import com.vaadin.flow.server.VaadinServletContext;
68+
import com.vaadin.flow.server.VaadinServletRequest;
69+
import com.vaadin.flow.server.VaadinServletService;
70+
import com.vaadin.flow.server.startup.ApplicationConfiguration;
71+
import com.vaadin.fusion.EndpointRegistry.VaadinEndpointData;
72+
import com.vaadin.fusion.auth.VaadinConnectAccessChecker;
73+
import com.vaadin.fusion.exception.EndpointException;
74+
import com.vaadin.fusion.exception.EndpointValidationException;
75+
import com.vaadin.fusion.exception.EndpointValidationException.ValidationErrorData;
76+
7877
/**
7978
* The controller that is responsible for processing Vaadin endpoint requests.
8079
* Each class that is annotated with {@link Endpoint} gets its public methods

‎fusion-endpoint/src/main/java/com/vaadin/fusion/VaadinConnectControllerConfiguration.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@
1818

1919
import java.lang.reflect.Method;
2020

21-
import com.vaadin.flow.server.auth.AccessAnnotationChecker;
22-
import com.vaadin.fusion.auth.CsrfChecker;
23-
import com.vaadin.fusion.auth.VaadinConnectAccessChecker;
24-
2521
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
2622
import org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations;
2723
import org.springframework.context.annotation.Bean;
@@ -30,6 +26,10 @@
3026
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
3127
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
3228

29+
import com.vaadin.flow.server.auth.AccessAnnotationChecker;
30+
import com.vaadin.fusion.auth.CsrfChecker;
31+
import com.vaadin.fusion.auth.VaadinConnectAccessChecker;
32+
3333
/**
3434
* A configuration class for customizing the {@link VaadinConnectController}
3535
* class.

‎fusion-endpoint/src/main/java/com/vaadin/fusion/auth/CsrfChecker.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,16 @@
1515
*/
1616
package com.vaadin.fusion.auth;
1717

18-
import java.nio.charset.StandardCharsets;
19-
import java.security.MessageDigest;
20-
2118
import javax.servlet.http.HttpServletRequest;
2219
import javax.servlet.http.HttpSession;
23-
24-
import com.vaadin.flow.server.VaadinService;
20+
import java.nio.charset.StandardCharsets;
21+
import java.security.MessageDigest;
2522

2623
import org.slf4j.Logger;
2724
import org.slf4j.LoggerFactory;
2825

26+
import com.vaadin.flow.server.VaadinService;
27+
2928
/**
3029
* Handles checking of a CSRF token in endpoint requests.
3130
*/
@@ -44,7 +43,7 @@ public class CsrfChecker {
4443
* <p>
4544
* Note! If CSRF protection is disabled, this method will always return
4645
* {@code true}.
47-
*
46+
*
4847
* @param request
4948
* the request to validate
5049
* @return {@code true} if the CSRF token is ok or checking is disabled or

‎fusion-endpoint/src/main/java/com/vaadin/fusion/auth/VaadinConnectAccessChecker.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,11 @@
1616

1717
package com.vaadin.fusion.auth;
1818

19-
import java.lang.reflect.Method;
20-
2119
import javax.annotation.security.DenyAll;
2220
import javax.annotation.security.PermitAll;
2321
import javax.annotation.security.RolesAllowed;
2422
import javax.servlet.http.HttpServletRequest;
23+
import java.lang.reflect.Method;
2524

2625
import com.vaadin.flow.server.VaadinService;
2726
import com.vaadin.flow.server.auth.AccessAnnotationChecker;
@@ -81,7 +80,7 @@ public class VaadinConnectAccessChecker {
8180

8281
/**
8382
* Creates a new instance.
84-
*
83+
*
8584
* @param csrfChecker
8685
* the csrf checker to use
8786
* @param accessAnnotationChecker
@@ -139,7 +138,7 @@ public void enableCsrf(boolean xsrfProtectionEnabled) {
139138

140139
/**
141140
* Returns the instance used for checking access based on annotations.
142-
*
141+
*
143142
* @return the instance used for checking access based on annotations
144143
*/
145144
public AccessAnnotationChecker getAccessAnnotationChecker() {

‎fusion-endpoint/src/main/java/com/vaadin/fusion/generator/OpenApiObjectGenerator.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,6 @@
6363
import com.github.javaparser.utils.Pair;
6464
import com.github.javaparser.utils.SourceRoot;
6565
import com.github.javaparser.utils.SourceRoot.Callback;
66-
import com.vaadin.fusion.Endpoint;
67-
import com.vaadin.fusion.EndpointExposed;
68-
import com.vaadin.fusion.EndpointNameChecker;
6966
import io.swagger.v3.oas.models.Components;
7067
import io.swagger.v3.oas.models.OpenAPI;
7168
import io.swagger.v3.oas.models.Operation;
@@ -93,6 +90,9 @@
9390
import org.slf4j.LoggerFactory;
9491

9592
import com.vaadin.flow.server.auth.AnonymousAllowed;
93+
import com.vaadin.fusion.Endpoint;
94+
import com.vaadin.fusion.EndpointExposed;
95+
import com.vaadin.fusion.EndpointNameChecker;
9696

9797
/**
9898
* Java parser class which scans for all {@link Endpoint} classes and produces

‎fusion-endpoint/src/main/java/com/vaadin/fusion/generator/VaadinConnectTsGenerator.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@
3636
import com.github.jknack.handlebars.Helper;
3737
import com.github.jknack.handlebars.Options;
3838
import com.github.jknack.handlebars.Template;
39-
import com.vaadin.fusion.EndpointNameChecker;
4039
import io.swagger.codegen.v3.ClientOptInput;
4140
import io.swagger.codegen.v3.CodegenModel;
4241
import io.swagger.codegen.v3.CodegenOperation;
@@ -71,6 +70,7 @@
7170
import org.slf4j.LoggerFactory;
7271

7372
import com.vaadin.flow.server.frontend.FrontendUtils;
73+
import com.vaadin.fusion.EndpointNameChecker;
7474

7575
/**
7676
* Vaadin fusion JavaScript generator implementation for swagger-codegen. Some

‎fusion-endpoint/src/main/java/com/vaadin/fusion/startup/ConnectEndpointsValidator.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,14 @@
1818
import javax.servlet.ServletContext;
1919
import javax.servlet.ServletException;
2020
import javax.servlet.annotation.HandlesTypes;
21-
2221
import java.io.Serializable;
2322
import java.util.Set;
2423
import java.util.stream.Collectors;
2524

26-
import com.vaadin.fusion.Endpoint;
2725
import com.vaadin.flow.server.frontend.scanner.ClassFinder;
2826
import com.vaadin.flow.server.frontend.scanner.ClassFinder.DefaultClassFinder;
2927
import com.vaadin.flow.server.startup.ClassLoaderAwareServletContainerInitializer;
28+
import com.vaadin.fusion.Endpoint;
3029

3130
/**
3231
* Validation class that is run during servlet container initialization which

0 commit comments

Comments
 (0)