Updated examples + added unit test groups

Author: dreamorosi

examples/cdk/lib/example-function.MyFunctionWithMiddy.ts

@@ -1,4 +1,4 @@
-import middy from '@middy/core'
+import middy from '@middy/core';
 import { Callback, Context } from 'aws-lambda';
 import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
 

examples/cdk/lib/example-function.Tracer.Decorator.ts

@@ -7,7 +7,7 @@ const tracer = new Tracer({ serviceName: 'tracerDecoratorFn' });
 
 export class MyFunctionWithDecorator {  
   // We instrument the handler with the decorator and the tracer will automatically create a subsegment and capture relevant annotations and metadata
-  @tracer.captureLambdaHanlder()
+  @tracer.captureLambdaHandler()
   public handler(event: typeof Events.Custom.CustomEvent, context: Context, _callback: Callback<unknown>): void | Promise<unknown> {
     // Add custom annotation & metadata
     tracer.putAnnotation('awsRequestId', context.awsRequestId);

examples/cdk/lib/example-function.Tracer.Manual.ts

@@ -5,7 +5,7 @@ import { Tracer } from '@aws-lambda-powertools/tracer';
 // process.env.POWERTOOLS_SERVICE_NAME = 'tracerManualFn'; // Alternative to setting the service name in the constructor
 const tracer = new Tracer({ serviceName: 'tracerManualFn' });
 
-export const handler = async (event: typeof Events.Custom.CustomEvent, context: Context) => {
+export const handler = async (event: typeof Events.Custom.CustomEvent, context: Context): Promise<unknown> => {
   const segment = tracer.getSegment(); // This is the facade segment (the one that is created by AWS Lambda)
   // Create subsegment for the function & set it as active
   const subsegment = segment.addNewSubsegment(`## ${process.env._HANDLER}`);
@@ -21,19 +21,19 @@ export const handler = async (event: typeof Events.Custom.CustomEvent, context:
 
   let res;
   try {
-      res = { foo: 'bar' };
-      // Add the response as metadata 
-      tracer.addResponseAsMetadata(res, process.env._HANDLER);
+    res = { foo: 'bar' };
+    // Add the response as metadata 
+    tracer.addResponseAsMetadata(res, process.env._HANDLER);
   } catch (err) {
-      // Add the error as metadata
-      tracer.addErrorAsMetadata(err as Error);
-      throw err;
+    // Add the error as metadata
+    tracer.addErrorAsMetadata(err as Error);
+    throw err;
+  } finally {
+    // Close subsegment (the AWS Lambda one is closed automatically)
+    subsegment.close();
+    // Set the facade segment as active again
+    tracer.setSegment(segment);
   }
 
-  // Close subsegment (the AWS Lambda one is closed automatically)
-  subsegment.close();
-  // Set the facade segment as active again
-  tracer.setSegment(segment);
-
   return res;
 };

examples/cdk/lib/example-function.Tracer.Middleware.ts

@@ -1,4 +1,4 @@
-import middy from '@middy/core'
+import middy from '@middy/core';
 import { Context } from 'aws-lambda';
 import { Events } from '@aws-lambda-powertools/commons';
 import { captureLambdaHandler, Tracer } from '@aws-lambda-powertools/tracer';

examples/cdk/lib/example-function.ts

@@ -5,16 +5,16 @@ import { NodejsFunction, NodejsFunctionProps } from 'aws-cdk-lib/aws-lambda-node
 import { Tracing } from 'aws-cdk-lib/aws-lambda';
 
 interface ExampleFunctionProps {
-  readonly functionName: string;
-  readonly tracingActive?: boolean;
-  readonly invocations?: number;
-  readonly fnProps?: Partial<NodejsFunctionProps>;
+  readonly functionName: string
+  readonly tracingActive?: boolean
+  readonly invocations?: number
+  readonly fnProps?: Partial<NodejsFunctionProps>
 }
 
 class ExampleFunction extends Construct {
-  function: NodejsFunction;
+  public function: NodejsFunction;
 
-  constructor(scope: Construct, id: string, props: ExampleFunctionProps) {
+  public constructor(scope: Construct, id: string, props: ExampleFunctionProps) {
     super(scope, id);
 
     const { functionName, tracingActive, invocations, fnProps } = Object.assign({
@@ -54,5 +54,5 @@ class ExampleFunction extends Construct {
 }
 
 export {
- ExampleFunction
+  ExampleFunction
 };

examples/cdk/lib/example-stack.ts

@@ -3,7 +3,7 @@ import { Construct } from 'constructs';
 import { ExampleFunction } from './example-function';
 
 export class CdkAppStack extends Stack {
-  constructor(scope: Construct, id: string, props?: StackProps) {
+  public constructor(scope: Construct, id: string, props?: StackProps) {
     super(scope, id, props);
 
     new ExampleFunction(this, 'MyFunction', {
@@ -22,7 +22,7 @@ export class CdkAppStack extends Stack {
     });
 
     new ExampleFunction(this, 'Tracer.Disabled', {
-      functionName: 'Tracer.CaptureDisabled',
+      functionName: 'Tracer.Disabled',
       tracingActive: true,
     });
 

packages/tracing/jest.config.js

@@ -3,6 +3,7 @@ module.exports = {
     name: 'AWS Lambda Powertools utility: TRACER',
     color: 'cyan',
   },
+  'runner': 'groups',
   'preset': 'ts-jest',
   'transform': {
     '^.+\\.ts?$': 'ts-jest',
@@ -23,7 +24,6 @@ module.exports = {
   'testEnvironment': 'node',
   'coveragePathIgnorePatterns': [
     '/node_modules/',
-    '/types/',
   ],
   'coverageThreshold': {
     'global': {