From 14186cef85b13aca5d551d4387165b2310ec5250 Mon Sep 17 00:00:00 2001
From: Matthew Wilson <98319962+MatthewVaadin@users.noreply.github.com>
Date: Tue, 10 Jan 2023 16:05:05 +0200
Subject: [PATCH] feat: Make the kit compatible with Vaadin 14 (#145)
These changes allow the agent to be used with a V14 application.
---
.../java/com/vaadin/extension/Constants.java | 2 +
.../com/vaadin/extension/HttpStatusCode.java | 299 ++++++++++++++++++
.../extension/InstrumentationHelper.java | 1 -
...ScriptBootstrapHandlerInstrumentation.java | 6 +-
...EventHandlerRpcHandlerInstrumentation.java | 3 +-
.../StaticFileServerInstrumentation.java | 2 +-
...ptBootstrapHandlerInstrumentationTest.java | 11 +-
.../StaticFileServerInstrumentationTest.java | 2 +-
.../VaadinServletInstrumentationTest.java | 4 +-
9 files changed, 313 insertions(+), 17 deletions(-)
create mode 100644 src/main/java/com/vaadin/extension/HttpStatusCode.java
diff --git a/src/main/java/com/vaadin/extension/Constants.java b/src/main/java/com/vaadin/extension/Constants.java
index 67521af5..57cf1ec1 100644
--- a/src/main/java/com/vaadin/extension/Constants.java
+++ b/src/main/java/com/vaadin/extension/Constants.java
@@ -20,4 +20,6 @@ public class Constants {
public static final String SESSION_ID = "vaadin.session.id";
public static final String REQUEST_TYPE = "vaadin.request.type";
public static final String FLOW_VERSION = "vaadin.flow.version";
+
+ public static final String REQUEST_LOCATION_PARAMETER = "location";
}
diff --git a/src/main/java/com/vaadin/extension/HttpStatusCode.java b/src/main/java/com/vaadin/extension/HttpStatusCode.java
new file mode 100644
index 00000000..4909f291
--- /dev/null
+++ b/src/main/java/com/vaadin/extension/HttpStatusCode.java
@@ -0,0 +1,299 @@
+package com.vaadin.extension;
+
+import java.util.stream.Stream;
+
+public enum HttpStatusCode {
+
+ /**
+ * Status code (100) indicating the client can continue.
+ */
+ CONTINUE(100),
+
+ /**
+ * Status code (101) indicating the server is switching protocols according
+ * to Upgrade header.
+ */
+ SWITCHING_PROTOCOLS(101),
+
+ /**
+ * Status code (200) indicating the request succeeded normally.
+ */
+ OK(200),
+
+ /**
+ * Status code (201) indicating the request succeeded and created a new
+ * resource on the server.
+ */
+ CREATED(201),
+
+ /**
+ * Status code (202) indicating that a request was accepted for processing,
+ * but was not completed.
+ */
+ ACCEPTED(202),
+
+ /**
+ * Status code (203) indicating that the meta information presented by the
+ * client did not originate from the server.
+ */
+ NON_AUTHORITATIVE_INFORMATION(203),
+
+ /**
+ * Status code (204) indicating that the request succeeded but that there
+ * was no new information to return.
+ */
+ NO_CONTENT(204),
+
+ /**
+ * Status code (205) indicating that the agent SHOULD reset the
+ * document view which caused the request to be sent.
+ */
+ RESET_CONTENT(205),
+
+ /**
+ * Status code (206) indicating that the server has fulfilled the partial
+ * GET request for the resource.
+ */
+ PARTIAL_CONTENT(206),
+
+ /**
+ * Status code (300) indicating that the requested resource corresponds to
+ * any one of a set of representations, each with its own specific location.
+ */
+ MULTIPLE_CHOICES(300),
+
+ /**
+ * Status code (301) indicating that the resource has permanently moved to a
+ * new location, and that future references should use a new URI with their
+ * requests.
+ */
+ MOVED_PERMANENTLY(301),
+
+ /**
+ * Status code (302) indicating that the resource has temporarily moved to
+ * another location, but that future references should still use the
+ * original URI to access the resource.
+ *
+ * This definition is being retained for backwards compatibility. FOUND is
+ * now the preferred definition.
+ */
+ MOVED_TEMPORARILY(302),
+
+ /**
+ * Status code (302) indicating that the resource reside temporarily under a
+ * different URI. Since the redirection might be altered on occasion, the
+ * client should continue to use the Request-URI for future
+ * requests.(HTTP/1.1) To represent the status code (302), it is recommended
+ * to use this variable.
+ */
+ FOUND(302),
+
+ /**
+ * Status code (303) indicating that the response to the request can be
+ * found under a different URI.
+ */
+ SEE_OTHER(303),
+
+ /**
+ * Status code (304) indicating that a conditional GET operation found that
+ * the resource was available and not modified.
+ */
+ NOT_MODIFIED(304),
+
+ /**
+ * Status code (305) indicating that the requested resource MUST be
+ * accessed through the proxy given by the Location
+ * field.
+ */
+ USE_PROXY(305),
+
+ /**
+ * Status code (307) indicating that the requested resource resides
+ * temporarily under a different URI. The temporary URI SHOULD be
+ * given by the Location
field in the response.
+ */
+ TEMPORARY_REDIRECT(307),
+
+ /**
+ * Status code (400) indicating the request sent by the client was
+ * syntactically incorrect.
+ */
+ BAD_REQUEST(400),
+
+ /**
+ * Status code (401) indicating that the request requires HTTP
+ * authentication.
+ */
+ UNAUTHORIZED(401),
+
+ /**
+ * Status code (402) reserved for future use.
+ */
+ PAYMENT_REQUIRED(402),
+
+ /**
+ * Status code (403) indicating the server understood the request but
+ * refused to fulfill it.
+ */
+ FORBIDDEN(403),
+
+ /**
+ * Status code (404) indicating that the requested resource is not
+ * available.
+ */
+ NOT_FOUND(404),
+
+ /**
+ * Status code (405) indicating that the method specified in the
+ * Request-Line
is not allowed for the resource
+ * identified by the Request-URI
.
+ */
+ METHOD_NOT_ALLOWED(405),
+
+ /**
+ * Status code (406) indicating that the resource identified by the request
+ * is only capable of generating response entities which have content
+ * characteristics not acceptable according to the accept headers sent in
+ * the request.
+ */
+ NOT_ACCEPTABLE(406),
+
+ /**
+ * Status code (407) indicating that the client MUST first
+ * authenticate itself with the proxy.
+ */
+ PROXY_AUTHENTICATION_REQUIRED(407),
+
+ /**
+ * Status code (408) indicating that the client did not produce a request
+ * within the time that the server was prepared to wait.
+ */
+ REQUEST_TIMEOUT(408),
+
+ /**
+ * Status code (409) indicating that the request could not be completed due
+ * to a conflict with the current state of the resource.
+ */
+ CONFLICT(409),
+
+ /**
+ * Status code (410) indicating that the resource is no longer available at
+ * the server and no forwarding address is known. This condition
+ * SHOULD be considered permanent.
+ */
+ GONE(410),
+
+ /**
+ * Status code (411) indicating that the request cannot be handled without a
+ * defined Content-Length
.
+ */
+ LENGTH_REQUIRED(411),
+
+ /**
+ * Status code (412) indicating that the precondition given in one or more
+ * of the request-header fields evaluated to false when it was tested on the
+ * server.
+ */
+ PRECONDITION_FAILED(412),
+
+ /**
+ * Status code (413) indicating that the server is refusing to process the
+ * request because the request entity is larger than the server is willing
+ * or able to process.
+ */
+ REQUEST_ENTITY_TOO_LARGE(413),
+
+ /**
+ * Status code (414) indicating that the server is refusing to service the
+ * request because the Request-URI
is longer than the
+ * server is willing to interpret.
+ */
+ REQUEST_URI_TOO_LONG(414),
+
+ /**
+ * Status code (415) indicating that the server is refusing to service the
+ * request because the entity of the request is in a format not supported by
+ * the requested resource for the requested method.
+ */
+ UNSUPPORTED_MEDIA_TYPE(415),
+
+ /**
+ * Status code (416) indicating that the server cannot serve the requested
+ * byte range.
+ */
+ REQUESTED_RANGE_NOT_SATISFIABLE(416),
+
+ /**
+ * Status code (417) indicating that the server could not meet the
+ * expectation given in the Expect request header.
+ */
+ EXPECTATION_FAILED(417),
+
+ /**
+ * Status code (500) indicating an error inside the HTTP server which
+ * prevented it from fulfilling the request.
+ */
+ INTERNAL_SERVER_ERROR(500),
+
+ /**
+ * Status code (501) indicating the HTTP server does not support the
+ * functionality needed to fulfill the request.
+ */
+ NOT_IMPLEMENTED(501),
+
+ /**
+ * Status code (502) indicating that the HTTP server received an invalid
+ * response from a server it consulted when acting as a proxy or gateway.
+ */
+ BAD_GATEWAY(502),
+
+ /**
+ * Status code (503) indicating that the HTTP server is temporarily
+ * overloaded, and unable to handle the request.
+ */
+ SERVICE_UNAVAILABLE(503),
+
+ /**
+ * Status code (504) indicating that the server did not receive a timely
+ * response from the upstream server while acting as a gateway or proxy.
+ */
+ GATEWAY_TIMEOUT(504),
+
+ /**
+ * Status code (505) indicating that the server does not support or refuses
+ * to support the HTTP protocol version that was used in the request
+ * message.
+ */
+ HTTP_VERSION_NOT_SUPPORTED(505);
+
+ private final int code;
+
+ HttpStatusCode(int code) {
+ this.code = code;
+ }
+
+ /**
+ * Gets the integer representation of the HTTP status code.
+ *
+ * @return integer representation of the HTTP status code.
+ */
+ public int getCode() {
+ return code;
+ }
+
+ /**
+ * Checks if the given status code is valid.
+ *
+ * The only valid status codes are the ones listed in this enumeration.
+ *
+ * @param statusCode
+ * status code to be checked
+ * @return {@literal true} if the status code is valid, otherwise
+ * {@literal false}.
+ */
+ public static boolean isValidStatusCode(int statusCode) {
+ return Stream.of(HttpStatusCode.values())
+ .anyMatch(st -> st.code == statusCode);
+ }
+
+}
diff --git a/src/main/java/com/vaadin/extension/InstrumentationHelper.java b/src/main/java/com/vaadin/extension/InstrumentationHelper.java
index ed1b4183..dcb0ef66 100644
--- a/src/main/java/com/vaadin/extension/InstrumentationHelper.java
+++ b/src/main/java/com/vaadin/extension/InstrumentationHelper.java
@@ -19,7 +19,6 @@
import com.vaadin.flow.component.UI;
import com.vaadin.flow.router.RouteConfiguration;
import com.vaadin.flow.server.HandlerHelper;
-import com.vaadin.flow.server.HttpStatusCode;
import com.vaadin.flow.server.Version;
import com.vaadin.flow.shared.ApplicationConstants;
diff --git a/src/main/java/com/vaadin/extension/instrumentation/communication/JavaScriptBootstrapHandlerInstrumentation.java b/src/main/java/com/vaadin/extension/instrumentation/communication/JavaScriptBootstrapHandlerInstrumentation.java
index 00e639f4..2071d0db 100644
--- a/src/main/java/com/vaadin/extension/instrumentation/communication/JavaScriptBootstrapHandlerInstrumentation.java
+++ b/src/main/java/com/vaadin/extension/instrumentation/communication/JavaScriptBootstrapHandlerInstrumentation.java
@@ -13,9 +13,9 @@
import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
import static net.bytebuddy.matcher.ElementMatchers.named;
+import com.vaadin.extension.Constants;
import com.vaadin.extension.InstrumentationHelper;
import com.vaadin.flow.server.VaadinRequest;
-import com.vaadin.flow.shared.ApplicationConstants;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.context.Context;
@@ -70,8 +70,8 @@ public static void onEnter(@Advice.Argument(1) VaadinRequest request,
Span localRootSpan = LocalRootSpan
.fromContextOrNull(Context.current());
if (localRootSpan != null) {
- String location = request.getParameter(
- ApplicationConstants.REQUEST_LOCATION_PARAMETER);
+ String location = request
+ .getParameter(Constants.REQUEST_LOCATION_PARAMETER);
String route = "/" + InstrumentationHelper
.getRouteTemplateForLocation(location).orElse("");
diff --git a/src/main/java/com/vaadin/extension/instrumentation/communication/rpc/PublishedServerEventHandlerRpcHandlerInstrumentation.java b/src/main/java/com/vaadin/extension/instrumentation/communication/rpc/PublishedServerEventHandlerRpcHandlerInstrumentation.java
index 49af999f..5ceda9cd 100644
--- a/src/main/java/com/vaadin/extension/instrumentation/communication/rpc/PublishedServerEventHandlerRpcHandlerInstrumentation.java
+++ b/src/main/java/com/vaadin/extension/instrumentation/communication/rpc/PublishedServerEventHandlerRpcHandlerInstrumentation.java
@@ -68,8 +68,7 @@ public void transform(TypeTransformer transformer) {
named("java.lang.reflect.Method")))
.and(takesArgument(2,
named("elemental.json.JsonArray")))
- .and(takesArgument(3, int.class))
- .and(takesArgument(4, boolean.class)),
+ .and(takesArgument(3, int.class)),
this.getClass().getName() + "$InvokeAdvice");
}
diff --git a/src/main/java/com/vaadin/extension/instrumentation/server/StaticFileServerInstrumentation.java b/src/main/java/com/vaadin/extension/instrumentation/server/StaticFileServerInstrumentation.java
index 7f0de58d..b1a54fbb 100644
--- a/src/main/java/com/vaadin/extension/instrumentation/server/StaticFileServerInstrumentation.java
+++ b/src/main/java/com/vaadin/extension/instrumentation/server/StaticFileServerInstrumentation.java
@@ -14,8 +14,8 @@
import static net.bytebuddy.matcher.ElementMatchers.named;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+import com.vaadin.extension.HttpStatusCode;
import com.vaadin.extension.InstrumentationHelper;
-import com.vaadin.flow.server.HttpStatusCode;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.StatusCode;
diff --git a/src/test/java/com/vaadin/extension/instrumentation/communication/JavaScriptBootstrapHandlerInstrumentationTest.java b/src/test/java/com/vaadin/extension/instrumentation/communication/JavaScriptBootstrapHandlerInstrumentationTest.java
index 53fd5146..d0a87b22 100644
--- a/src/test/java/com/vaadin/extension/instrumentation/communication/JavaScriptBootstrapHandlerInstrumentationTest.java
+++ b/src/test/java/com/vaadin/extension/instrumentation/communication/JavaScriptBootstrapHandlerInstrumentationTest.java
@@ -2,9 +2,9 @@
import static org.junit.jupiter.api.Assertions.*;
+import com.vaadin.extension.Constants;
import com.vaadin.extension.instrumentation.AbstractInstrumentationTest;
import com.vaadin.flow.server.VaadinRequest;
-import com.vaadin.flow.shared.ApplicationConstants;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
@@ -24,8 +24,7 @@ public void setup() {
@Test
public void synchronizedHandleRequest_createsSpan() {
- Mockito.when(request
- .getParameter(ApplicationConstants.REQUEST_LOCATION_PARAMETER))
+ Mockito.when(request.getParameter(Constants.REQUEST_LOCATION_PARAMETER))
.thenReturn("test-route");
JavaScriptBootstrapHandlerInstrumentation.SynchronizedHandleRequestAdvice
@@ -39,8 +38,7 @@ public void synchronizedHandleRequest_createsSpan() {
@Test
public void synchronizedHandleRequest_updatesRootSpan() {
- Mockito.when(request
- .getParameter(ApplicationConstants.REQUEST_LOCATION_PARAMETER))
+ Mockito.when(request.getParameter(Constants.REQUEST_LOCATION_PARAMETER))
.thenReturn("test-route");
try (var ignored = withRootContext()) {
@@ -58,8 +56,7 @@ public void synchronizedHandleRequest_updatesRootSpan() {
@Test
public void synchronizedHandleRequest_withException_setsErrorStatus() {
- Mockito.when(request
- .getParameter(ApplicationConstants.REQUEST_LOCATION_PARAMETER))
+ Mockito.when(request.getParameter(Constants.REQUEST_LOCATION_PARAMETER))
.thenReturn("test-route");
JavaScriptBootstrapHandlerInstrumentation.SynchronizedHandleRequestAdvice
diff --git a/src/test/java/com/vaadin/extension/instrumentation/server/StaticFileServerInstrumentationTest.java b/src/test/java/com/vaadin/extension/instrumentation/server/StaticFileServerInstrumentationTest.java
index dda1cf64..c7340aa7 100644
--- a/src/test/java/com/vaadin/extension/instrumentation/server/StaticFileServerInstrumentationTest.java
+++ b/src/test/java/com/vaadin/extension/instrumentation/server/StaticFileServerInstrumentationTest.java
@@ -2,11 +2,11 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
+import com.vaadin.extension.HttpStatusCode;
import com.vaadin.extension.instrumentation.AbstractInstrumentationTest;
import com.vaadin.flow.component.ClientCallable;
import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.Tag;
-import com.vaadin.flow.server.HttpStatusCode;
import com.vaadin.flow.server.StaticFileServer;
import io.opentelemetry.api.common.AttributeKey;
diff --git a/src/test/java/com/vaadin/extension/instrumentation/server/VaadinServletInstrumentationTest.java b/src/test/java/com/vaadin/extension/instrumentation/server/VaadinServletInstrumentationTest.java
index 373a3fc2..4e85c279 100644
--- a/src/test/java/com/vaadin/extension/instrumentation/server/VaadinServletInstrumentationTest.java
+++ b/src/test/java/com/vaadin/extension/instrumentation/server/VaadinServletInstrumentationTest.java
@@ -5,10 +5,10 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
+import com.vaadin.extension.HttpStatusCode;
import com.vaadin.extension.conf.TraceLevel;
import com.vaadin.extension.instrumentation.AbstractInstrumentationTest;
import com.vaadin.flow.server.HandlerHelper;
-import com.vaadin.flow.server.HttpStatusCode;
import com.vaadin.flow.shared.ApplicationConstants;
import io.opentelemetry.api.common.AttributeKey;
@@ -168,4 +168,4 @@ public void service_throwsException_setsErrorStatus() {
SpanData span = getExportedSpan(0);
assertEquals(StatusCode.ERROR, span.getStatus().getStatusCode());
}
-}
\ No newline at end of file
+}