fix: added local testing behavior

aws-powertools · Jan 7, 2022 · e11c3b6 · e11c3b6
1 parent f0c3161
commit e11c3b6
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 6 deletions.
diff --git a/packages/tracing/src/Tracer.ts b/packages/tracing/src/Tracer.ts
@@ -128,8 +128,8 @@ class Tracer implements TracerInterface {
   private tracingEnabled: boolean = true;
 
   public constructor(options: TracerOptions = {}) {
-    this.setOptions(options);
     this.provider = new ProviderService();
+    this.setOptions(options);
   }
 
   /**
@@ -458,7 +458,10 @@ class Tracer implements TracerInterface {
    * @returns segment - The active segment or subsegment in the current scope.
    */
   public getSegment(): Segment | Subsegment {
-    const segment = this.provider.getSegment();
+    let segment = this.provider.getSegment();
+    if (segment === undefined && this.isTracingEnabled() === false) {
+      segment = new Subsegment('## Dummy segment');
+    }
     if (segment === undefined) {
       throw new Error('Failed to get the current sub/segment from the context.');
     }
@@ -567,6 +570,8 @@ class Tracer implements TracerInterface {
    * @param segment - Subsegment to set as the current segment
    */
   public setSegment(segment: Segment | Subsegment): void {
+    if (this.isTracingEnabled() === false) return;
+
     return this.provider.setSegment(segment);
   }
 
@@ -730,26 +735,30 @@ class Tracer implements TracerInterface {
   private setTracingEnabled(enabled?: boolean): void {
     if (enabled !== undefined && enabled === false) {
       this.tracingEnabled = enabled;
+      this.provider.setContextMissingStrategy(() => undefined);
 
       return;
     }
 
     const customConfigValue = this.getCustomConfigService()?.getTracingEnabled();
     if (customConfigValue !== undefined && customConfigValue.toLowerCase() === 'false') {
       this.tracingEnabled = false;
+      this.provider.setContextMissingStrategy(() => undefined);
 
       return;
     }
 
     const envVarsValue = this.getEnvVarsService()?.getTracingEnabled();
     if (envVarsValue.toLowerCase() === 'false') {
       this.tracingEnabled = false;
+      this.provider.setContextMissingStrategy(() => undefined);
 
       return;
     }
 
     if (this.isLambdaSamCli() || this.isLambdaExecutionEnv() === false) {
       this.tracingEnabled = false;
+      this.provider.setContextMissingStrategy(() => undefined);
     }
   }
 

diff --git a/packages/tracing/tests/unit/Tracer.test.ts b/packages/tracing/tests/unit/Tracer.test.ts
@@ -274,7 +274,7 @@ describe('Class: Tracer', () => {
 
   describe('Method: getSegment', () => {
 
-    test('when called outside of a namespace or without parent segment, it throws an error', () => {
+    test('when called outside of a namespace or without parent segment, and Tracer is active, it throws an error', () => {
 
       // Prepare
       const tracer: Tracer = new Tracer();
@@ -286,7 +286,7 @@ describe('Class: Tracer', () => {
 
     });
 
-    test('when called outside of a namespace or without parent segment, it throws an error', () => {
+    test('when called and no segment is returned, while Tracer is active, it throws an error', () => {
 
       // Prepare
       const tracer: Tracer = new Tracer();
@@ -298,7 +298,22 @@ describe('Class: Tracer', () => {
       }).toThrow('Failed to get the current sub/segment from the context.');
 
     });
-
+
+    test('when called outside of a namespace or without parent segment, and Tracer is NOT active, it returns a dummy subsegment', () => {
+
+      // Prepare
+      delete process.env.AWS_EXECUTION_ENV; // This will disable the tracer, simulating local execution
+      const tracer: Tracer = new Tracer();
+
+      // Act
+      const segment = tracer.getSegment();
+
+      // Assess
+      expect(segment).toBeInstanceOf(Subsegment);
+      expect(segment.name).toBe('## Dummy segment');
+
+    });
+
     test('when called within a namespace, it returns the parent segment', () => {
 
       // Prepare
@@ -320,7 +335,7 @@ describe('Class: Tracer', () => {
   });
 
   describe('Method: setSegment', () => {
-    test('when called outside of a namespace or without parent segment, it throws an error', () => {
+    test('when called outside of a namespace or without parent segment, and Tracer is enabled, it throws an error', () => {
 
       // Prepare
       const tracer: Tracer = new Tracer();
@@ -332,6 +347,22 @@ describe('Class: Tracer', () => {
       }).toThrow('No context available. ns.run() or ns.bind() must be called first.');
     });
 
+    test('when called outside of a namespace or without parent segment, and Tracer is NOT enabled, it does nothing', () => {
+
+      // Prepare
+      delete process.env.AWS_EXECUTION_ENV; // This will disable the tracer, simulating local execution
+      const tracer: Tracer = new Tracer();
+      const setSegmentSpy = jest.spyOn(tracer.provider, 'setSegment');
+
+      // Act
+      const newSubsegment = new Subsegment('## foo.bar');
+      tracer.setSegment(newSubsegment);
+
+      // Assess
+      expect(setSegmentSpy).toBeCalledTimes(0);
+
+    });
+
     test('when called within a namespace, it sets the segment', () => {
 
       // Prepare