Update play mvc to use AdviceScope

instrumentation/play/play-mvc/play-mvc-2.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/play/v2_4/ActionInstrumentation.java

@@ -8,16 +8,13 @@
 import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface;
-import static io.opentelemetry.javaagent.instrumentation.play.v2_4.Play24Singletons.instrumenter;
-import static io.opentelemetry.javaagent.instrumentation.play.v2_4.Play24Singletons.updateSpan;
 import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.returns;
 import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
 
-import io.opentelemetry.context.Context;
-import io.opentelemetry.context.Scope;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import javax.annotation.Nullable;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;
@@ -50,17 +47,8 @@ public void transform(TypeTransformer transformer) {
   public static class ApplyAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
-    public static void onEnter(
-        @Advice.Argument(0) Request<?> req,
-        @Advice.Local("otelContext") Context context,
-        @Advice.Local("otelScope") Scope scope) {
-      Context parentContext = currentContext();
-      if (!instrumenter().shouldStart(parentContext, null)) {
-        return;
-      }
-
-      context = instrumenter().start(parentContext, null);
-      scope = context.makeCurrent();
+    public static AdviceScope onEnter(@Advice.Argument(0) Request<?> req) {
+      return AdviceScope.start(currentContext());
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
@@ -69,21 +57,12 @@ public static void stopTraceOnResponse(
         @Advice.Thrown Throwable throwable,
         @Advice.Argument(0) Request<?> req,
         @Advice.Return(readOnly = false) Future<Result> responseFuture,
-        @Advice.Local("otelContext") Context context,
-        @Advice.Local("otelScope") Scope scope) {
-      if (scope == null) {
+        @Advice.Enter @Nullable AdviceScope actionScope) {
+      if (actionScope == null) {
         return;
       }
-      scope.close();
 
-      updateSpan(context, req);
-      // span finished in RequestCompleteCallback
-      if (throwable == null) {
-        responseFuture.onComplete(
-            new RequestCompleteCallback(context), ((Action<?>) thisAction).executionContext());
-      } else {
-        instrumenter().end(context, null, null, throwable);
-      }
+      actionScope.end(throwable, responseFuture, (Action<?>) thisAction, req);
     }
   }
 }

instrumentation/play/play-mvc/play-mvc-2.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/play/v2_4/AdviceScope.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.play.v2_4;
+
+import static io.opentelemetry.javaagent.instrumentation.play.v2_4.Play24Singletons.instrumenter;
+import static io.opentelemetry.javaagent.instrumentation.play.v2_4.Play24Singletons.updateSpan;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.Scope;
+import javax.annotation.Nullable;
+import play.api.mvc.Action;
+import play.api.mvc.Request;
+import play.api.mvc.Result;
+import scala.concurrent.Future;
+
+/** Container used to carry state between enter and exit advices */
+public final class AdviceScope {
+
+  private final Context context;
+  private final Scope scope;
+
+  public AdviceScope(Context context, Scope scope) {
+    this.context = context;
+    this.scope = scope;
+  }
+
+  @Nullable
+  public static AdviceScope start(Context parentContext) {
+    if (!instrumenter().shouldStart(parentContext, null)) {
+      return null;
+    }
+
+    Context context = instrumenter().start(parentContext, null);
+    return new AdviceScope(context, context.makeCurrent());
+  }
+
+  public void closeScope() {
+    if (scope != null) {
+      scope.close();
+    }
+  }
+
+  public void end(
+      Throwable throwable, Future<Result> responseFuture, Action<?> thisAction, Request<?> req) {
+    closeScope();
+    updateSpan(context, req);
+
+    if (throwable == null) {
+      // span finished in RequestCompleteCallback
+      responseFuture.onComplete(
+          new RequestCompleteCallback(context), thisAction.executionContext());
+    } else {
+      instrumenter().end(context, null, null, throwable);
+    }
+  }
+}

instrumentation/play/play-mvc/play-mvc-2.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/play/v2_4/Play24Singletons.java

@@ -16,13 +16,16 @@
 import scala.Option;
 
 public final class Play24Singletons {
-
   private static final String SPAN_NAME = "play.request";
-  private static final Instrumenter<Void, Void> INSTRUMENTER =
-      Instrumenter.<Void, Void>builder(
-              GlobalOpenTelemetry.get(), "io.opentelemetry.play-mvc-2.4", s -> SPAN_NAME)
-          .setEnabled(ExperimentalConfig.get().controllerTelemetryEnabled())
-          .buildInstrumenter();
+  private static final Instrumenter<Void, Void> INSTRUMENTER;
+
+  static {
+    INSTRUMENTER =
+        Instrumenter.<Void, Void>builder(
+                GlobalOpenTelemetry.get(), "io.opentelemetry.play-mvc-2.4", s -> SPAN_NAME)
+            .setEnabled(ExperimentalConfig.get().controllerTelemetryEnabled())
+            .buildInstrumenter();
+  }
 
   public static Instrumenter<Void, Void> instrumenter() {
     return INSTRUMENTER;