treat cdk examples as any other modules

Author: flochaz

examples/cdk/bin/cdk-app.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import 'source-map-support/register';
 import * as cdk from 'aws-cdk-lib';
-import { CdkAppStack } from '../lib/example-stack';
+import { CdkAppStack } from '../src/example-stack';
 
 const app = new cdk.App();
 new CdkAppStack(app, 'CdkAppStack', {});

examples/cdk/jest.config.js

@@ -1,7 +1,7 @@
 module.exports = {
   testEnvironment: 'node',
-  roots: ['<rootDir>/test'],
-  testMatch: ['**/*.test.ts'],
+  roots: ['<rootDir>/tests'],
+  testMatch: ['**/*.tests.ts'],
   transform: {
     '^.+\\.tsx?$': 'ts-jest'
   }

examples/cdk/package-lock.json

@@ -1,13 +1,13 @@
 {
   "name": "cdk-app",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "bin": {
     "cdk-app": "bin/cdk-app.js"
   },
   "scripts": {
     "build": "tsc --skipLibCheck",
     "watch": "tsc -w",
-    "test": "jest",
+    "test": "jest --passWithNoTests",
     "cdk": "cdk"
   },
   "devDependencies": {

examples/cdk/package.json

@@ -12,7 +12,7 @@ const metrics = new Metrics({ namespace: namespace, serviceName: serviceName });
 const logger = new Logger({ logLevel: 'INFO', serviceName: serviceName });
 const tracer = new Tracer({ serviceName: serviceName });
 
-const lambdaHandler = async (event: typeof Events.Custom.CustomEvent, context: Context) => {
+const lambdaHandler = async (event: typeof Events.Custom.CustomEvent, context: Context): Promise<unknown> => {
   // ### Experiment with Logger
   // AWS Lambda context is automatically injected by the middleware
 
@@ -32,7 +32,7 @@ const lambdaHandler = async (event: typeof Events.Custom.CustomEvent, context: C
   const metricWithItsOwnDimensions = metrics.singleMetric();
   metricWithItsOwnDimensions.addDimension('InnerDimension', 'true');
   metricWithItsOwnDimensions.addMetric('single-metric', MetricUnits.Percent, 50);
-  
+
   // ### Experiment with Tracer
 
   // Service & Cold Start annotations will be added for you by the decorator/middleware
@@ -58,16 +58,18 @@ const lambdaHandler = async (event: typeof Events.Custom.CustomEvent, context: C
     tracer.setSegment(handlerSegment);
     // The main segment (facade) will be closed for you at the end by the decorator/middleware
   }
-  
+
   return res;
-}
+};
 
 // We instrument the handler with the various Middy middlewares
 export const handler = middy(lambdaHandler)
   .use(captureLambdaHandler(tracer))
-  .use(logMetrics(metrics, {
-    captureColdStartMetric: true,
-    throwOnEmptyMetrics: true,
-    defaultDimensions: { environment: 'example', type: 'withDecorator' },
-  }))
-  .use(injectLambdaContext(logger));
+  .use(
+    logMetrics(metrics, {
+      captureColdStartMetric: true,
+      throwOnEmptyMetrics: true,
+      defaultDimensions: { environment: 'example', type: 'withDecorator' },
+    })
+  )
+  .use(injectLambdaContext(logger));

examples/cdk/lib/example-function.MyFunction.ts renamed to examples/cdk/src/example-function.MyFunction.ts

@@ -7,19 +7,19 @@ import { captureLambdaHandler, Tracer } from '@aws-lambda-powertools/tracer';
 const tracer = new Tracer({ serviceName: 'tracerDisabledFn', enabled: false });
 
 // In this example we are using the middleware pattern but the same applies also the captureLambdaHandler decorator or to manual instrumentation
-const lambdaHandler = async (event: typeof Events.Custom.CustomEvent, context: Context) => {
+const lambdaHandler = async (event: typeof Events.Custom.CustomEvent, context: Context): Promise<unknown> => {
   // No tracing will be done and the commands will be ignored, this is useful for testing
   tracer.putAnnotation('awsRequestId', context.awsRequestId);
   tracer.putMetadata('eventPayload', event);
-  
+
   let res;
   try {
     res = { foo: 'bar' };
   } catch (err) {
     throw err;
   }
-  
+
   return res;
-}
+};
 
-export const handler = middy(lambdaHandler).use(captureLambdaHandler(tracer));
+export const handler = middy(lambdaHandler).use(captureLambdaHandler(tracer));

examples/cdk/lib/example-function.MyFunctionWithDecorator.ts renamed to examples/cdk/src/example-function.MyFunctionWithDecorator.ts

@@ -7,24 +7,24 @@ const tracer = new Tracer({ serviceName: 'tracerMiddlewareFn' });
 // Alternatively, you can also set the service name using the POWERTOOLS_SERVICE_NAME environment variable
 // Learn more at: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html
 
-const lambdaHandler = async (event: typeof Events.Custom.CustomEvent, context: Context) => {
+const lambdaHandler = async (event: typeof Events.Custom.CustomEvent, context: Context): Promise<unknown> => {
   // Add custom annotation & metadata
   tracer.putAnnotation('awsRequestId', context.awsRequestId);
   tracer.putMetadata('eventPayload', event);
-  
+
   let res;
   try {
     res = { foo: 'bar' };
   } catch (err) {
     throw err;
   }
-  
+
   return res;
-}
+};
 
 // We instrument the handler with the Middy middleware and the Tracer will automatically:
 // * handle the lifecycle of the subsegment
 // * create a ColdStart annotation to easily filter traces that have had an initialization overhead
 // * create a Service annotation to easily filter traces that have a specific service name
 // * captures any response, or full exceptions generated by the handler, and include them as tracing metadata
-export const handler = middy(lambdaHandler).use(captureLambdaHandler(tracer));
+export const handler = middy(lambdaHandler).use(captureLambdaHandler(tracer));

examples/cdk/lib/example-function.MyFunctionWithMiddy.ts renamed to examples/cdk/src/example-function.MyFunctionWithMiddy.ts

@@ -12,7 +12,6 @@ interface ExampleFunctionProps {
 }
 
 class ExampleFunction extends Construct {
-  public function: NodejsFunction;
 
   public constructor(scope: Construct, id: string, props: ExampleFunctionProps) {
     super(scope, id);

examples/cdk/lib/example-function.Tracer.CaptureErrorDisabled.ts renamed to examples/cdk/src/example-function.Tracer.CaptureErrorDisabled.ts

@@ -2,6 +2,6 @@
 // import { Template } from 'aws-cdk-lib/assertions';
 // import * as CdkApp from '../lib/cdk-app-stack';
 
-test('It Deploys', () => {
-  // TODO: implement tests
-});
+// test('It Deploys', () => {
+//   // TODO: implement tests
+// });

examples/cdk/lib/example-function.Tracer.CaptureResponseDisabled.ts renamed to examples/cdk/src/example-function.Tracer.CaptureResponseDisabled.ts

@@ -1,29 +1,30 @@
 {
   "compilerOptions": {
-    "target": "ES2018",
+    "experimentalDecorators": true,
+    "noImplicitAny": true,
+    "target": "ES2020",
     "module": "commonjs",
-    "skipLibCheck": true,
-    "lib": [
-      "es2018"
-    ],
     "declaration": true,
+    "outDir": "lib",
     "strict": true,
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": false,
     "inlineSourceMap": true,
-    "inlineSources": true,
-    "experimentalDecorators": true,
-    "strictPropertyInitialization": false,
-    "types": []
-  },
-  "exclude": [
-    "node_modules",
-    "cdk.out"
-  ]
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "pretty": true,
+    "baseUrl": "src/",
+    "rootDirs": [ "src/" ],
+    "esModuleInterop": true
+},
+"include": [ "src/**/*" ],
+"exclude": [ "./node_modules", "cdk.out"],
+"watchOptions": {
+    "watchFile": "useFsEvents",
+    "watchDirectory": "useFsEvents",
+    "fallbackPolling": "dynamicPriority"
+},
+"lib": [ "es2020" ],
+"types": [
+    "jest",
+    "node"
+]
 }

examples/cdk/lib/example-function.Tracer.Decorator.ts renamed to examples/cdk/src/example-function.Tracer.Decorator.ts

@@ -1,6 +1,7 @@
 {
   "packages": [
-    "packages/*"
+    "packages/*",
+    "examples/cdk"
   ],
   "version": "0.3.1",
   "npmClient": "npm",