Adding back depricated functions (#360)

* Adding back depricated functions

* Style check fixes

* Fixing fail fast on build

Author: atshaw43

.github/workflows/pr-build.yml

@@ -9,6 +9,7 @@ jobs:
     name: Build Java ${{ matrix.java }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         os:
           - macos-latest

aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/contexts/LambdaSegmentContext.java

@@ -60,16 +60,6 @@ private static FacadeSegment newFacadeSegment(AWSXRayRecorder recorder, String n
         return new FacadeSegment(recorder, traceHeader.getRootTraceId(), traceHeader.getParentId(), traceHeader.getSampled());
     }
 
-    @Override
-    public Subsegment beginSubsegmentWithoutSampling(
-            AWSXRayRecorder recorder,
-            String name) {
-
-        Subsegment subsegment = beginSubsegment(recorder, name);
-        subsegment.setSampledFalse();
-        return subsegment;
-    }
-
     @Override
     public Subsegment beginSubsegment(AWSXRayRecorder recorder, String name) {
         if (logger.isDebugEnabled()) {

aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/contexts/SegmentContext.java

@@ -20,6 +20,7 @@
 import com.amazonaws.xray.entities.Entity;
 import com.amazonaws.xray.entities.Segment;
 import com.amazonaws.xray.entities.Subsegment;
+import com.amazonaws.xray.internal.SamplingStrategyOverride;
 import java.util.Objects;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -65,9 +66,27 @@ default void clearTraceEntity() {
 
     Subsegment beginSubsegment(AWSXRayRecorder recorder, String name);
 
-    Subsegment beginSubsegmentWithoutSampling(
+    default Subsegment beginSubsegmentWithoutSampling(
             AWSXRayRecorder recorder,
-            String name);
+            String name)
+    {
+        Subsegment subsegment = beginSubsegment(recorder, name);
+        subsegment.setSampledFalse();
+        return subsegment;
+    }
+
+    @Deprecated
+    default Subsegment beginSubsegmentWithSamplingOverride(
+            AWSXRayRecorder recorder,
+            String name,
+            SamplingStrategyOverride samplingStrategyOverride) {
+
+        if (samplingStrategyOverride == SamplingStrategyOverride.DISABLED) {
+            return beginSubsegment(recorder, name);
+        } else {
+            return beginSubsegmentWithoutSampling(recorder, name);
+        }
+    }
 
     void endSubsegment(AWSXRayRecorder recorder);
 }

aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/contexts/ThreadLocalSegmentContext.java

@@ -32,15 +32,6 @@ public class ThreadLocalSegmentContext implements SegmentContext {
     private static final Log logger =
         LogFactory.getLog(ThreadLocalSegmentContext.class);
 
-    @Override
-    public Subsegment beginSubsegmentWithoutSampling(
-            AWSXRayRecorder recorder,
-            String name) {
-        Subsegment subsegment = beginSubsegment(recorder, name);
-        subsegment.setSampledFalse();
-        return subsegment;
-    }
-
     @Override
     public Subsegment beginSubsegment(AWSXRayRecorder recorder, String name) {
         Entity current = getTraceEntity();

aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/entities/DummySubsegment.java

@@ -16,6 +16,7 @@
 package com.amazonaws.xray.entities;
 
 import com.amazonaws.xray.AWSXRayRecorder;
+import com.amazonaws.xray.internal.SamplingStrategyOverride;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import java.util.ArrayList;
 import java.util.HashSet;
@@ -50,14 +51,27 @@ public class DummySubsegment implements Subsegment {
     @JsonIgnore
     private boolean isRecording;
 
+    @JsonIgnore
+    private SamplingStrategyOverride samplingStrategyOverride;
+
     public DummySubsegment(AWSXRayRecorder creator) {
         this(creator, TraceID.create(creator));
     }
 
     public DummySubsegment(AWSXRayRecorder creator, TraceID traceId) {
+        this(creator, traceId, SamplingStrategyOverride.DISABLED);
+    }
+
+    @Deprecated
+    public DummySubsegment(AWSXRayRecorder creator, TraceID traceId, SamplingStrategyOverride samplingStrategyOverride) {
         this.creator = creator;
         this.traceId = traceId;
         this.parentSegment = new DummySegment(creator);
+        this.isSampled = samplingStrategyOverride == SamplingStrategyOverride.DISABLED ?
+                parentSegment.isSampled() :
+                false;
+        this.isRecording = isSampled;
+        this.samplingStrategyOverride = samplingStrategyOverride;
     }
 
     @Override
@@ -412,4 +426,10 @@ public void setSampledFalse() {
         isSampled = false;
         isRecording = false;
     }
+
+    @Override
+    @Deprecated
+    public SamplingStrategyOverride getSamplingStrategyOverride() {
+        return samplingStrategyOverride;
+    }
 }

aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/entities/NoOpSubSegment.java

@@ -16,6 +16,7 @@
 package com.amazonaws.xray.entities;
 
 import com.amazonaws.xray.AWSXRayRecorder;
+import com.amazonaws.xray.internal.SamplingStrategyOverride;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import java.util.List;
 import java.util.Map;
@@ -38,19 +39,38 @@ class NoOpSubSegment implements Subsegment {
     @JsonIgnore
     private boolean isRecording;
 
+    @JsonIgnore
+    private SamplingStrategyOverride samplingStrategyOverride;
+
     NoOpSubSegment(Segment parentSegment, AWSXRayRecorder creator) {
         this(parentSegment, creator, true);
     }
 
+    NoOpSubSegment(Segment parentSegment, AWSXRayRecorder creator, boolean shouldPropagate) {
+        this(parentSegment, creator, shouldPropagate, SamplingStrategyOverride.DISABLED);
+    }
+
+    @Deprecated
+    NoOpSubSegment(Segment parentSegment, AWSXRayRecorder creator, SamplingStrategyOverride samplingStrategyOverride) {
+        this(parentSegment, creator, true, samplingStrategyOverride);
+    }
 
+    @Deprecated
     NoOpSubSegment(
             Segment parentSegment,
             AWSXRayRecorder creator,
-            boolean shouldPropagate) {
+            boolean shouldPropagate,
+            SamplingStrategyOverride samplingStrategyOverride) {
         this.parentSegment = parentSegment;
         this.creator = creator;
         this.shouldPropagate = shouldPropagate;
         parent = parentSegment;
+
+        this.isSampled = samplingStrategyOverride == SamplingStrategyOverride.DISABLED ?
+                parentSegment.isSampled() :
+                false;
+        this.isRecording = isSampled;
+        this.samplingStrategyOverride = samplingStrategyOverride;
     }
 
     @Override
@@ -401,4 +421,10 @@ public void setSampledFalse() {
         isSampled = false;
         isRecording = false;
     }
+
+    @Override
+    @Deprecated
+    public SamplingStrategyOverride getSamplingStrategyOverride() {
+        return samplingStrategyOverride;
+    }
 }

aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/entities/Subsegment.java

@@ -16,6 +16,7 @@
 package com.amazonaws.xray.entities;
 
 import com.amazonaws.xray.AWSXRayRecorder;
+import com.amazonaws.xray.internal.SamplingStrategyOverride;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import java.util.Set;
 import org.checkerframework.checker.nullness.qual.Nullable;
@@ -24,7 +25,17 @@ public interface Subsegment extends Entity {
     static Subsegment noOp(AWSXRayRecorder recorder) {
         return new NoOpSubSegment(Segment.noOp(TraceID.invalid(), recorder), recorder);
     }
-    
+
+    @Deprecated
+    static Subsegment noOp(AWSXRayRecorder recorder, boolean shouldPropagate, SamplingStrategyOverride samplingStrategyOverride) {
+        return new NoOpSubSegment(Segment.noOp(TraceID.invalid(), recorder), recorder, shouldPropagate, samplingStrategyOverride);
+    }
+
+    @Deprecated
+    static Subsegment noOp(Segment parent, AWSXRayRecorder recorder, SamplingStrategyOverride samplingStrategyOverride) {
+        return new NoOpSubSegment(parent, recorder, samplingStrategyOverride);
+    }
+
     static Subsegment noOp(AWSXRayRecorder recorder, boolean shouldPropagate) {
         return new NoOpSubSegment(Segment.noOp(TraceID.invalid(), recorder), recorder, shouldPropagate);
     }
@@ -121,4 +132,6 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) {
 
     @JsonIgnore
     void setSampledFalse();
+
+    SamplingStrategyOverride getSamplingStrategyOverride();
 }

aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/entities/SubsegmentImpl.java

@@ -16,6 +16,7 @@
 package com.amazonaws.xray.entities;
 
 import com.amazonaws.xray.AWSXRayRecorder;
+import com.amazonaws.xray.internal.SamplingStrategyOverride;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.node.ObjectNode;
@@ -43,20 +44,34 @@ public class SubsegmentImpl extends EntityImpl implements Subsegment {
     @JsonIgnore
     private boolean isRecording;
 
+    @JsonIgnore
+    private SamplingStrategyOverride samplingStrategyOverride;
+
     @SuppressWarnings("nullness")
     private SubsegmentImpl() {
         super();
     } // default constructor for jackson
 
     public SubsegmentImpl(AWSXRayRecorder creator, String name, Segment parentSegment) {
+        this(creator, name, parentSegment, SamplingStrategyOverride.DISABLED);
+    }
+
+    @Deprecated
+    public SubsegmentImpl(AWSXRayRecorder creator,
+                          String name,
+                          Segment parentSegment,
+                          SamplingStrategyOverride samplingStrategyOverride) {
         super(creator, name);
         this.parentSegment = parentSegment;
         parentSegment.incrementReferenceCount();
         this.precursorIds = new HashSet<>();
         this.shouldPropagate = true;
 
-        isSampled = parentSegment.isSampled();
-        isRecording = parentSegment.isRecording();
+        this.isSampled = samplingStrategyOverride == SamplingStrategyOverride.DISABLED ?
+                parentSegment.isSampled() :
+                false;
+        this.isRecording = isSampled;
+        this.samplingStrategyOverride = samplingStrategyOverride;
     }
 
     @Override
@@ -177,4 +192,10 @@ public void setSampledFalse() {
         isSampled = false;
         isRecording = false;
     }
+
+    @Override
+    @Deprecated
+    public SamplingStrategyOverride getSamplingStrategyOverride() {
+        return samplingStrategyOverride;
+    }
 }

aws-xray-recorder-sdk-core/src/main/java/com/amazonaws/xray/internal/SamplingStrategyOverride.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file 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 com.amazonaws.xray.internal;
+
+public enum SamplingStrategyOverride {
+    DISABLED, // Does not override the SamplingStrategy.
+    FALSE, // Overrides the SamplingStrategy and always chooses NOT to sample.
+}

aws-xray-recorder-sdk-lambda/src/test/java/com/amazonaws/xray/lambda/SQSMessageHelperTest.java

@@ -29,6 +29,7 @@ public void testSampled() {
         testTrue("Root=1-5759e988-bd862e3fe1be46a994272793;Sampled=1");
         testTrue("Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1");
 
+        testFalse("Root=1-632BB806-bd862e3fe1be46a994272793");
         testFalse("Root=1-632BB806-bd862e3fe1be46a994272793;Sampled=0");
         testFalse("Root=1-5759e988-bd862e3fe1be46a994272793;Sampled=0");
         testFalse("Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=0");