Add a forceIgnoring mechanism and apply it to the plugins (Spring Clo…

CHANGES.md

@@ -12,6 +12,7 @@ Release Notes.
 * Fix typos in `URLParser`.
 * Add support for `Derby`/`Sybase`/`SQLite`/`DB2`/`OceanBase` jdbc url format in `URLParser`.
 * Optimize spring-plugins:scheduled-annotation-plugin compatibility about Spring 6.1.x support.
+* Add a forceIgnoring mechanism in a CROSS_THREAD scenario.
 
 All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/213?closed=1)
 

apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/context/AbstractTracerContext.java

@@ -138,4 +138,10 @@ public interface AbstractTracerContext {
      * Get current primary endpoint name
      */
     String getPrimaryEndpointName();
+
+    /**
+     *  Change the current context to IgnoredTracerContext.
+     */
+    AbstractTracerContext forceIgnoring();
+
 }

apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/context/ContextManager.java

@@ -163,7 +163,12 @@ public static void continued(ContextSnapshot snapshot) {
             throw new IllegalArgumentException("ContextSnapshot can't be null.");
         }
         if (!snapshot.isFromCurrent()) {
-            get().continued(snapshot);
+            if (snapshot.isValid()) {
+                get().continued(snapshot);
+            } else {
+                AbstractTracerContext context = get().forceIgnoring();
+                CONTEXT.set(context);
+            }
         }
     }
 

apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/context/IgnoredTracerContext.java

@@ -34,14 +34,21 @@ public class IgnoredTracerContext implements AbstractTracerContext {
     private static final NoopSpan NOOP_SPAN = new NoopSpan();
     private static final String IGNORE_TRACE = "Ignored_Trace";
 
+    private LinkedList<AbstractSpan> activeSpanStack;
+
     private final CorrelationContext correlationContext;
     private final ExtensionContext extensionContext;
     private final ProfileStatusContext profileStatusContext;
 
-    private int stackDepth;
-
     public IgnoredTracerContext() {
-        this.stackDepth = 0;
+        this.activeSpanStack = new LinkedList<>();
+        this.correlationContext = new CorrelationContext();
+        this.extensionContext = new ExtensionContext();
+        this.profileStatusContext = ProfileStatusContext.createWithNone();
+    }
+
+    public IgnoredTracerContext(LinkedList<AbstractSpan> activeSpanStack) {
+        this.activeSpanStack = activeSpanStack;
         this.correlationContext = new CorrelationContext();
         this.extensionContext = new ExtensionContext();
         this.profileStatusContext = ProfileStatusContext.createWithNone();
@@ -84,34 +91,35 @@ public int getSpanId() {
 
     @Override
     public AbstractSpan createEntrySpan(String operationName) {
-        stackDepth++;
+        activeSpanStack.addLast(NOOP_SPAN);
         return NOOP_SPAN;
     }
 
     @Override
     public AbstractSpan createLocalSpan(String operationName) {
-        stackDepth++;
+        activeSpanStack.addLast(NOOP_SPAN);
         return NOOP_SPAN;
     }
 
     @Override
     public AbstractSpan createExitSpan(String operationName, String remotePeer) {
-        stackDepth++;
+        activeSpanStack.addLast(NOOP_SPAN);
         return NOOP_SPAN;
     }
 
     @Override
     public AbstractSpan activeSpan() {
-        return NOOP_SPAN;
+        return activeSpanStack.getLast();
     }
 
     @Override
     public boolean stopSpan(AbstractSpan span) {
-        stackDepth--;
-        if (stackDepth == 0) {
+        activeSpanStack.removeLast();
+        if (activeSpanStack.isEmpty()) {
             ListenerManager.notifyFinish(this);
         }
-        return stackDepth == 0;
+
+        return activeSpanStack.isEmpty();
     }
 
     @Override
@@ -134,6 +142,11 @@ public String getPrimaryEndpointName() {
         return null;
     }
 
+    @Override
+    public AbstractTracerContext forceIgnoring() {
+        return this;
+    }
+
     public static class ListenerManager {
         private static List<IgnoreTracerContextListener> LISTENERS = new LinkedList<>();
 

apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/context/TracingContext.java

@@ -419,6 +419,12 @@ public String getPrimaryEndpointName() {
         return primaryEndpoint.getName();
     }
 
+    @Override
+    public AbstractTracerContext forceIgnoring() {
+
+        return new IgnoredTracerContext(activeSpanStack);
+    }
+
     /**
      * Re-check current trace need profiling, encase third part plugin change the operation name.
      *

apm-sniffer/apm-agent-core/src/test/java/org/apache/skywalking/apm/agent/core/context/ContinuedContextTest.java

@@ -0,0 +1,97 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.apache.skywalking.apm.agent.core.context;
+
+import org.apache.skywalking.apm.agent.core.boot.ServiceManager;
+import org.apache.skywalking.apm.agent.core.conf.Config;
+import org.apache.skywalking.apm.agent.core.context.ids.NewDistributedTraceId;
+import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan;
+import org.apache.skywalking.apm.agent.core.context.trace.NoopSpan;
+import org.apache.skywalking.apm.agent.core.profile.ProfileStatusContext;
+import org.apache.skywalking.apm.agent.core.test.tools.AgentServiceRule;
+import org.apache.skywalking.apm.agent.core.test.tools.SegmentStorage;
+import org.apache.skywalking.apm.agent.core.test.tools.SegmentStoragePoint;
+import org.apache.skywalking.apm.agent.core.test.tools.TracingSegmentRunner;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.Assert;
+
+@RunWith(TracingSegmentRunner.class)
+public class ContinuedContextTest {
+
+    @SegmentStoragePoint
+    private SegmentStorage tracingData;
+
+    @Rule
+    public AgentServiceRule agentServiceRule = new AgentServiceRule();
+
+    @BeforeClass
+    public static void beforeClass() {
+        Config.Agent.KEEP_TRACING = true;
+    }
+
+    @AfterClass
+    public static void afterClass() {
+        Config.Agent.KEEP_TRACING = false;
+        ServiceManager.INSTANCE.shutdown();
+    }
+
+    @Test
+    public void testContinued() {
+
+        NewDistributedTraceId distributedTraceId = new NewDistributedTraceId();
+        ContextSnapshot snapshot = new ContextSnapshot(
+                "1, 2, 3",
+                1,
+                distributedTraceId,
+                "/for-test-continued",
+                new CorrelationContext(),
+                new ExtensionContext(),
+                ProfileStatusContext.createWithNone()
+        );
+
+        AbstractSpan span = ContextManager.createLocalSpan("test-span");
+        ContextManager.continued(snapshot);
+
+        Assert.assertEquals(distributedTraceId.getId(), ContextManager.getGlobalTraceId());
+        ContextManager.stopSpan();
+    }
+
+    @Test
+    public void testContinuedWithIgnoredSnapshot() {
+
+        ContextSnapshot snapshot =
+                new ContextSnapshot(null, -1, null, null, new CorrelationContext(), new ExtensionContext(), ProfileStatusContext.createWithNone());
+
+        AbstractSpan span = ContextManager.createLocalSpan("test-span");
+        ContextManager.continued(snapshot);
+
+        Assert.assertEquals(ContextManager.activeSpan(), span);
+
+        AbstractSpan span2 = ContextManager.createLocalSpan("test-span2");
+        Assert.assertTrue(span2 instanceof NoopSpan);
+
+        ContextManager.stopSpan();
+        ContextManager.stopSpan();
+    }
+
+}