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

Add session tracking support to vert.x 3/4 #7953

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

Add session tracking support to vert.x 3/4 #7953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
912ab82
Add session tracking support to vert.x 3/4
manuel-alvarez-alvarez Nov 14, 2024
68af1e0
Add testing endpoints in RX vert.x
manuel-alvarez-alvarez Nov 14, 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
24 changes: 24 additions & 0 deletions ...tion/vertx-rx-3.5/src/test/groovy/server/VertxRxCircuitBreakerHttpServerForkedTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import io.vertx.reactivex.core.MultiMap
import io.vertx.reactivex.ext.web.Router
import io.vertx.reactivex.ext.web.RoutingContext
import io.vertx.reactivex.ext.web.handler.BodyHandler
import io.vertx.reactivex.ext.web.handler.CookieHandler
import io.vertx.reactivex.ext.web.handler.SessionHandler
import io.vertx.reactivex.ext.web.sstore.LocalSessionStore

import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.BODY_MULTIPART
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.BODY_URLENCODED
Expand All @@ -22,6 +25,7 @@ import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.QUERY_
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.QUERY_ENCODED_QUERY
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.QUERY_PARAM
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.REDIRECT
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.SESSION_ID
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.SUCCESS
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.USER_BLOCK
import static server.VertxTestServer.CONFIG_HTTP_SERVER_PORT
Expand Down Expand Up @@ -233,6 +237,26 @@ class VertxRxCircuitBreakerHttpServerForkedTest extends VertxHttpServerForkedTes
})
}

router.route(SESSION_ID.getPath()).handler(CookieHandler.create())
final LocalSessionStore sessionStorage = LocalSessionStore.create(super.@vertx)
router
.route(SESSION_ID.getPath())
.handler(SessionHandler.create(sessionStorage).setCookieSecureFlag(true).setCookieHttpOnlyFlag(true))
router
.route(SESSION_ID.getPath())
.handler { ctx ->
controller(SESSION_ID) {
final session = ctx.session()
if (!session) {
ctx.response()
.setStatusCode(500)
.end('Cookie/Session handlers not present')
} else {
ctx.response().setStatusCode(SESSION_ID.getStatus()).end(session.id())
}
}
}

[email protected](new HttpServerOptions().setHandle100ContinueAutomatically(true))
.requestHandler { router.accept(it) }
.listen(port) { startFuture.complete() }
Expand Down
22 changes: 22 additions & 0 deletions ...nt/instrumentation/vertx-rx-3.5/src/test/groovy/server/VertxRxHttpServerForkedTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import io.vertx.core.AbstractVerticle
import io.vertx.core.Future
import io.vertx.core.http.HttpServerOptions
import io.vertx.ext.web.Router
import io.vertx.ext.web.handler.CookieHandler
import io.vertx.ext.web.handler.SessionHandler
import io.vertx.ext.web.sstore.LocalSessionStore
import spock.lang.Ignore

import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.ERROR
Expand All @@ -12,6 +15,7 @@ import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.FORWAR
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.PATH_PARAM
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.QUERY_PARAM
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.REDIRECT
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.SESSION_ID
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.SUCCESS
import static server.VertxTestServer.CONFIG_HTTP_SERVER_PORT

Expand Down Expand Up @@ -72,6 +76,24 @@ class VertxRxHttpServerForkedTest extends VertxHttpServerForkedTest {
}
}

router.route(SESSION_ID.getPath()).handler(CookieHandler.create())
final LocalSessionStore sessionStorage = LocalSessionStore.create(vertx)
router
.route(SESSION_ID.getPath())
.handler(SessionHandler.create(sessionStorage).setCookieSecureFlag(true).setCookieHttpOnlyFlag(true))
router.route(SESSION_ID.getPath()).handler { ctx ->
controller(SESSION_ID) {
final session = ctx.session()
if (session == null) {
ctx.response()
.setStatusCode(500)
.end('Cookie/Session handlers not present')
} else {
ctx.response().setStatusCode(SESSION_ID.getStatus()).end(session.id())
}
}
}

[email protected](new HttpServerOptions().setHandle100ContinueAutomatically(true))
.requestHandler { router.accept(it) }
.listen(port) { startFuture.complete() }
Expand Down
4 changes: 4 additions & 0 deletions ...ava/datadog/trace/instrumentation/vertx_3_4/server/RoutingContextImplInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
import static datadog.trace.instrumentation.vertx_3_4.server.VertxVersionMatcher.PARSABLE_HEADER_VALUE;
import static datadog.trace.instrumentation.vertx_3_4.server.VertxVersionMatcher.VIRTUAL_HOST_HANDLER;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
import static net.bytebuddy.matcher.ElementMatchers.takesArguments;

import com.google.auto.service.AutoService;
Expand Down Expand Up @@ -33,5 +34,8 @@ public void methodAdvice(MethodTransformer transformer) {
transformer.applyAdvice(
named("getBodyAsJson").or(named("getBodyAsJsonArray")).and(takesArguments(0)),
packageName + ".RoutingContextJsonAdvice");
transformer.applyAdvice(
named("setSession").and(takesArgument(0, named("io.vertx.ext.web.Session"))),
packageName + ".RoutingContextSessionAdvice");
}
}
54 changes: 54 additions & 0 deletions ...main/java/datadog/trace/instrumentation/vertx_3_4/server/RoutingContextSessionAdvice.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package datadog.trace.instrumentation.vertx_3_4.server;

import static datadog.trace.api.gateway.Events.EVENTS;

import datadog.appsec.api.blocking.BlockingException;
import datadog.trace.advice.ActiveRequestContext;
import datadog.trace.advice.RequiresRequestContext;
import datadog.trace.api.gateway.BlockResponseFunction;
import datadog.trace.api.gateway.CallbackProvider;
import datadog.trace.api.gateway.Flow;
import datadog.trace.api.gateway.RequestContext;
import datadog.trace.api.gateway.RequestContextSlot;
import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
import io.vertx.ext.web.Session;
import java.util.function.BiFunction;
import net.bytebuddy.asm.Advice;

@RequiresRequestContext(RequestContextSlot.APPSEC)
class RoutingContextSessionAdvice {
@Advice.OnMethodExit(suppress = Throwable.class, onThrowable = Throwable.class)
static void after(
@Advice.Argument(0) final Session session,
@ActiveRequestContext RequestContext reqCtx,
@Advice.Thrown(readOnly = false) Throwable throwable) {
if (session == null || session.id() == null) {
return;
}

final CallbackProvider cbp = AgentTracer.get().getCallbackProvider(RequestContextSlot.APPSEC);
BiFunction<RequestContext, String, Flow<Void>> callback =
cbp.getCallback(EVENTS.requestSession());
if (callback == null) {
return;
}

Flow<Void> flow = callback.apply(reqCtx, session.id());
Flow.Action action = flow.getAction();
if (action instanceof Flow.Action.RequestBlockingAction) {
BlockResponseFunction blockResponseFunction = reqCtx.getBlockResponseFunction();
if (blockResponseFunction == null) {
return;
}
Flow.Action.RequestBlockingAction rba = (Flow.Action.RequestBlockingAction) action;
blockResponseFunction.tryCommitBlockingResponse(
reqCtx.getTraceSegment(),
rba.getStatusCode(),
rba.getBlockingContentType(),
rba.getExtraHeaders());
if (throwable == null) {
throwable = new BlockingException("Blocked request (for sessionId)");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should you need to change the throwable in this case or just not apply the advice at all?

}
Comment on lines +29 to +51
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not related with this PR but I have the feeling that we are repeating this pice of code every time we need to block something 😅

}
}
}
5 changes: 5 additions & 0 deletions ...ent/instrumentation/vertx-web-3.4/src/test/groovy/server/VertxHttpServerForkedTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ class VertxHttpServerForkedTest extends HttpServerTest<Vertx> {
return false
}

@Override
boolean testSessionId() {
true
}

@Override
int spanCount(ServerEndpoint endpoint) {
if (endpoint == NOT_FOUND) {
Expand Down
31 changes: 31 additions & 0 deletions dd-java-agent/instrumentation/vertx-web-3.4/src/test/java/server/VertxTestServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.QUERY_ENCODED_QUERY;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.QUERY_PARAM;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.REDIRECT;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.SESSION_ID;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.SUCCESS;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.UNKNOWN;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.USER_BLOCK;
Expand All @@ -30,7 +31,11 @@
import io.vertx.core.json.JsonObject;
import io.vertx.ext.web.Router;
import io.vertx.ext.web.RoutingContext;
import io.vertx.ext.web.Session;
import io.vertx.ext.web.handler.BodyHandler;
import io.vertx.ext.web.handler.CookieHandler;
import io.vertx.ext.web.handler.SessionHandler;
import io.vertx.ext.web.sstore.LocalSessionStore;

public class VertxTestServer extends AbstractVerticle {
public static final String CONFIG_HTTP_SERVER_PORT = "http.server.port";
Expand Down Expand Up @@ -195,6 +200,32 @@ public void start(final Future<Void> startFuture) {
.route(EXCEPTION.getPath())
.handler(ctx -> controller(ctx, EXCEPTION, VertxTestServer::exception));

router.route(SESSION_ID.getPath()).handler(CookieHandler.create());
final LocalSessionStore sessionStorage = LocalSessionStore.create(vertx);
router
.route(SESSION_ID.getPath())
.handler(
SessionHandler.create(sessionStorage)
.setCookieSecureFlag(true)
.setCookieHttpOnlyFlag(true));
router
.route(SESSION_ID.getPath())
.handler(
ctx ->
controller(
ctx,
SESSION_ID,
() -> {
final Session session = ctx.session();
if (session == null) {
ctx.response()
.setStatusCode(500)
.end("Cookie/Session handlers not present");
} else {
ctx.response().setStatusCode(SESSION_ID.getStatus()).end(session.id());
}
}));

router = customizeAfterRoutes(router);

vertx
Expand Down
3 changes: 3 additions & 0 deletions ...ava/datadog/trace/instrumentation/vertx_4_0/server/RoutingContextImplInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,8 @@ public void methodAdvice(MethodTransformer transformer) {
.and(takesArguments(1))
.and(takesArgument(0, int.class)),
packageName + ".RoutingContextJsonAdvice");
transformer.applyAdvice(
named("setSession").and(takesArgument(0, named("io.vertx.ext.web.Session"))),
packageName + ".RoutingContextSessionAdvice");
}
}
54 changes: 54 additions & 0 deletions ...main/java/datadog/trace/instrumentation/vertx_4_0/server/RoutingContextSessionAdvice.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package datadog.trace.instrumentation.vertx_4_0.server;

import static datadog.trace.api.gateway.Events.EVENTS;

import datadog.appsec.api.blocking.BlockingException;
import datadog.trace.advice.ActiveRequestContext;
import datadog.trace.advice.RequiresRequestContext;
import datadog.trace.api.gateway.BlockResponseFunction;
import datadog.trace.api.gateway.CallbackProvider;
import datadog.trace.api.gateway.Flow;
import datadog.trace.api.gateway.RequestContext;
import datadog.trace.api.gateway.RequestContextSlot;
import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
import io.vertx.ext.web.Session;
import java.util.function.BiFunction;
import net.bytebuddy.asm.Advice;

@RequiresRequestContext(RequestContextSlot.APPSEC)
class RoutingContextSessionAdvice {
@Advice.OnMethodExit(suppress = Throwable.class, onThrowable = Throwable.class)
static void after(
@Advice.Argument(0) final Session session,
@ActiveRequestContext RequestContext reqCtx,
@Advice.Thrown(readOnly = false) Throwable throwable) {
if (session == null || session.id() == null) {
return;
}

final CallbackProvider cbp = AgentTracer.get().getCallbackProvider(RequestContextSlot.APPSEC);
BiFunction<RequestContext, String, Flow<Void>> callback =
cbp.getCallback(EVENTS.requestSession());
if (callback == null) {
return;
}

Flow<Void> flow = callback.apply(reqCtx, session.id());
Flow.Action action = flow.getAction();
if (action instanceof Flow.Action.RequestBlockingAction) {
BlockResponseFunction blockResponseFunction = reqCtx.getBlockResponseFunction();
if (blockResponseFunction == null) {
return;
}
Flow.Action.RequestBlockingAction rba = (Flow.Action.RequestBlockingAction) action;
blockResponseFunction.tryCommitBlockingResponse(
reqCtx.getTraceSegment(),
rba.getStatusCode(),
rba.getBlockingContentType(),
rba.getExtraHeaders());
if (throwable == null) {
throwable = new BlockingException("Blocked request (for sessionId)");
}
}
}
}
5 changes: 5 additions & 0 deletions ...ent/instrumentation/vertx-web-4.0/src/test/groovy/server/VertxHttpServerForkedTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ class VertxHttpServerForkedTest extends HttpServerTest<Vertx> {
return false
}

@Override
boolean testSessionId() {
true
}

@Override
int spanCount(ServerEndpoint endpoint) {
if (endpoint == NOT_FOUND) {
Expand Down
29 changes: 29 additions & 0 deletions dd-java-agent/instrumentation/vertx-web-4.0/src/test/java/server/VertxTestServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.QUERY_ENCODED_QUERY;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.QUERY_PARAM;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.REDIRECT;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.SESSION_ID;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.SUCCESS;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.UNKNOWN;
import static datadog.trace.agent.test.base.HttpServerTest.ServerEndpoint.USER_BLOCK;
Expand All @@ -30,7 +31,10 @@
import io.vertx.core.json.JsonObject;
import io.vertx.ext.web.Router;
import io.vertx.ext.web.RoutingContext;
import io.vertx.ext.web.Session;
import io.vertx.ext.web.handler.BodyHandler;
import io.vertx.ext.web.handler.SessionHandler;
import io.vertx.ext.web.sstore.LocalSessionStore;

public class VertxTestServer extends AbstractVerticle {
public static final String CONFIG_HTTP_SERVER_PORT = "http.server.port";
Expand Down Expand Up @@ -198,6 +202,31 @@ public void start(final Promise<Void> startPromise) {
.route(EXCEPTION.getPath())
.handler(ctx -> controller(ctx, EXCEPTION, VertxTestServer::exception));

final LocalSessionStore sessionStorage = LocalSessionStore.create(vertx);
router
.route(SESSION_ID.getPath())
.handler(
SessionHandler.create(sessionStorage)
.setCookieSecureFlag(true)
.setCookieHttpOnlyFlag(true));
router
.route(SESSION_ID.getPath())
.handler(
ctx ->
controller(
ctx,
SESSION_ID,
() -> {
final Session session = ctx.session();
if (session == null) {
ctx.response()
.setStatusCode(500)
.end("Cookie/Session handlers not present");
} else {
ctx.response().setStatusCode(SESSION_ID.getStatus()).end(session.id());
}
}));

router = customizeAfterRoutes(router);

vertx
Expand Down
Loading