fix(docs): remove overrides, introduce changes to code-snippets

aws-powertools · Jan 25, 2023 · cc8d108 · cc8d108
1 parent 07c548d
commit cc8d108
Show file tree

Hide file tree

Showing 53 changed files with 11,510 additions and 14,781 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -64,16 +64,5 @@ module.exports = {
     'prefer-arrow-callback': 'error',
     quotes: [ 'error', 'single', { allowTemplateLiterals: true } ],
     semi: [ 'error', 'always' ]
-  },
-  overrides:[
-    {
-      files:['docs/snippets/**/*.ts'],
-      rules:{
-        '@typescript-eslint/no-explicit-any': 'warn',
-        '@typescript-eslint/no-unused-vars': 'warn',
-        '@typescript-eslint/explicit-member-accessibility': 'warn',
-        '@typescript-eslint/no-var-requires': 'warn'
-      }
-    }
-  ]
+  }
 };
diff --git a/.github/workflows/reusable-run-linting-check-and-unit-tests.yml b/.github/workflows/reusable-run-linting-check-and-unit-tests.yml
@@ -42,9 +42,9 @@ jobs:
         if: steps.cache-node-modules.outputs.cache-hit == 'true'
         run: |
           npm run build -w packages/commons
-          npm run build -w packages/logger & npm run build -w packages/tracer & npm run build -w packages/metrics & npm run build -w packages/parameters & npm run build -w packages/idempotency
+          npm run build -w packages/logger & npm run build -w packages/tracer & npm run build -w packages/metrics & npm run build -w packages/parameters & npm run build -w packages/idempotency & npm run build -w docs/snippets
       - name: Run linting
-        run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency
+        run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency -w docs/snippets
       - name: Run unit tests
         run: npm t -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency
   check-examples:

diff --git a/docs/snippets/logger/appendKeys.ts b/docs/snippets/logger/appendKeys.ts
@@ -24,7 +24,7 @@ const logger = new Logger({
 //     extra_key: "some-value"
 // });    
 
-export const handler = async (_event: any, _context: any): Promise<unknown> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<unknown> => {
 
   // If you don't want to log the "extra_key" attribute in your logs, you can remove it
   logger.removeKeys(['extra_key']);

diff --git a/docs/snippets/logger/basicUsage.ts b/docs/snippets/logger/basicUsage.ts
@@ -3,5 +3,5 @@ import { Logger } from '@aws-lambda-powertools/logger';
 const logger = new Logger({ serviceName: 'serverlessAirline' });
 
 export const handler = async (_event, _context): Promise<void> => {
-  // ...
+  logger.info('Hello World');
 };
diff --git a/docs/snippets/logger/clearStateDecorator.ts b/docs/snippets/logger/clearStateDecorator.ts
@@ -14,7 +14,7 @@ const logger = new Logger({
 class Lambda implements LambdaInterface {
   // Enable the clear state flag
   @logger.injectLambdaContext({ clearState: true })
-  public async handler(_event: any, _context: any): Promise<void> {
+  public async handler(event: unknown, _context: unknown): Promise<void> {
     // Persistent attributes added inside the handler will NOT be cached
     // across invocations
     if (event['special_key'] === '123456'){

diff --git a/docs/snippets/logger/clearStateMiddy.ts b/docs/snippets/logger/clearStateMiddy.ts
@@ -11,7 +11,7 @@ const logger = new Logger({
   }
 });
 
-const lambdaHandler = async (event: { special_key: string }, _context: any): Promise<void> => {
+const lambdaHandler = async (event: { special_key: string }, _context: unknown): Promise<void> => {
   // Persistent attributes added inside the handler will NOT be cached
   // across invocations
   if (event['special_key'] === '123456') {

diff --git a/docs/snippets/logger/createChild.ts b/docs/snippets/logger/createChild.ts
@@ -10,7 +10,7 @@ const childLogger = logger.createChild({
   logLevel: 'ERROR'
 });
 
-export const handler = async (_event: any, _context: any): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
 
   logger.info('This is an INFO log, from the parent logger');
   logger.error('This is an ERROR log, from the parent logger');

diff --git a/docs/snippets/logger/decorator.ts b/docs/snippets/logger/decorator.ts
@@ -6,7 +6,7 @@ const logger = new Logger();
 class Lambda implements LambdaInterface {
   // Decorate your handler class method
   @logger.injectLambdaContext()
-  public async handler(_event: any, _context: any): Promise<void> {
+  public async handler(_event: unknown, _context: unknown): Promise<void> {
     logger.info('This is an INFO log with some context');
   }
 

diff --git a/docs/snippets/logger/eventDecorator.ts b/docs/snippets/logger/eventDecorator.ts
@@ -6,7 +6,7 @@ const logger = new Logger();
 class Lambda implements LambdaInterface {
   // Set the log event flag to true
   @logger.injectLambdaContext({ logEvent: true })
-  public async handler(_event: any, _context: any): Promise<void> {
+  public async handler(_event: unknown, _context: unknown): Promise<void> {
     logger.info('This is an INFO log with some context');
   }
 

diff --git a/docs/snippets/logger/eventMiddy.ts b/docs/snippets/logger/eventMiddy.ts
@@ -3,7 +3,7 @@ import middy from '@middy/core';
 
 const logger = new Logger();
 
-const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
+const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
   logger.info('This is an INFO log with some context');
 };
 

diff --git a/docs/snippets/logger/extraData.ts b/docs/snippets/logger/extraData.ts
@@ -2,7 +2,7 @@ import { Logger } from '@aws-lambda-powertools/logger';
 
 const logger = new Logger();
 
-export const handler = async (event: any, _context: any): Promise<unknown> => {
+export const handler = async (event: unknown, _context: unknown): Promise<unknown> => {
 
   const myImportantVariable = {
     foo: 'bar'

diff --git a/docs/snippets/logger/logError.ts b/docs/snippets/logger/logError.ts
@@ -2,7 +2,7 @@ import { Logger } from '@aws-lambda-powertools/logger';
 
 const logger = new Logger();
 
-export const handler = async (_event: any, _context: any): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
 
   try {
     throw new Error('Unexpected error #1');

diff --git a/docs/snippets/logger/logSampling.ts b/docs/snippets/logger/logSampling.ts
@@ -6,7 +6,7 @@ const logger = new Logger({
   sampleRateValue: 0.5
 });
 
-export const handler = async (_event: any, _context: any): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
 
   // This log item (equal to log level 'ERROR') will be printed to standard output
   // in all Lambda invocations

diff --git a/docs/snippets/logger/middy.ts b/docs/snippets/logger/middy.ts
@@ -3,7 +3,7 @@ import middy from '@middy/core';
 
 const logger = new Logger();
 
-const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
+const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
   logger.info('This is an INFO log with some context');
 };
 

diff --git a/docs/snippets/logger/sam.ts b/docs/snippets/logger/sam.ts
@@ -2,6 +2,7 @@ import { Logger } from '@aws-lambda-powertools/logger';
 
 // Logger parameters fetched from the environment variables (see template.yaml tab)
 const logger = new Logger();
+logger.info('Hello World');
 
 // You can also pass the parameters in the constructor
 // const logger = new Logger({

diff --git a/docs/snippets/logger/unitTesting.ts b/docs/snippets/logger/unitTesting.ts
@@ -1,17 +1,4 @@
-const dummyContext = {
-  callbackWaitsForEmptyEventLoop: true,
-  functionVersion: '$LATEST',
-  functionName: 'foo-bar-function',
-  memoryLimitInMB: '128',
-  logGroupName: '/aws/lambda/foo-bar-function',
-  logStreamName: '2021/03/09/[$LATEST]abcdef123456abcdef123456abcdef123456',
-  invokedFunctionArn: 'arn:aws:lambda:eu-west-1:123456789012:function:foo-bar-function',
-  awsRequestId: 'c6af9ac6-7b61-11e6-9a41-93e812345678',
-  getRemainingTimeInMillis: () => 1234,
-  done: () => console.log('Done!'),
-  fail: () => console.log('Failed!'),
-  succeed: () => console.log('Succeeded!'),
-};
+import { ContextExamples as dummyContext } from '@aws-lambda-powertools/commons';
 
 describe('MyUnitTest', () => {
 

diff --git a/docs/snippets/metrics/addMetadata.ts b/docs/snippets/metrics/addMetadata.ts
@@ -3,7 +3,7 @@ import middy from '@middy/core';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
+const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
   metrics.addMetadata('bookingId', '7051cd10-6283-11ec-90d6-0242ac120003');
 };

diff --git a/docs/snippets/metrics/basicUsage.ts b/docs/snippets/metrics/basicUsage.ts
@@ -1,7 +1,7 @@
-import { Metrics } from '@aws-lambda-powertools/metrics';
+import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
 export const handler = async (_event, _context): Promise<void> => {
-  // ...
+  metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
 };
diff --git a/docs/snippets/metrics/captureColdStartMetricDecorator.ts b/docs/snippets/metrics/captureColdStartMetricDecorator.ts
@@ -6,7 +6,7 @@ const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orde
 export class MyFunction implements LambdaInterface {
 
   @metrics.logMetrics({ captureColdStartMetric: true })
-  public async handler(_event: any, _context: any): Promise<void> {
+  public async handler(_event: unknown, _context: unknown): Promise<void> {
     metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
   }
 }
diff --git a/docs/snippets/metrics/captureColdStartMetricMiddy.ts b/docs/snippets/metrics/captureColdStartMetricMiddy.ts
@@ -3,7 +3,7 @@ import middy from '@middy/core';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
+const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
 };
 

diff --git a/docs/snippets/metrics/createMetrics.ts b/docs/snippets/metrics/createMetrics.ts
@@ -2,7 +2,7 @@ import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-export const handler = async (_event: any, _context: any): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
   metrics.publishStoredMetrics();
 };
diff --git a/docs/snippets/metrics/customDimensions.ts b/docs/snippets/metrics/customDimensions.ts
@@ -2,7 +2,7 @@ import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-export const handler = async (_event: any, _context: any): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addDimension('environment', 'prod');
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
   metrics.publishStoredMetrics();

diff --git a/docs/snippets/metrics/decorator.ts b/docs/snippets/metrics/decorator.ts
@@ -6,7 +6,7 @@ const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orde
 class Lambda implements LambdaInterface {
 
   @metrics.logMetrics()
-  public async handler(_event: any, _context: any): Promise<void> {
+  public async handler(_event: unknown, _context: unknown): Promise<void> {
     metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
   }
 }

diff --git a/docs/snippets/metrics/defaultDimensions.ts b/docs/snippets/metrics/defaultDimensions.ts
@@ -6,6 +6,6 @@ const metrics = new Metrics({
   defaultDimensions: { 'environment': 'prod', 'foo': 'bar' } 
 });
 
-export const handler = async (_event: any, _context: any): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
 };
diff --git a/docs/snippets/metrics/defaultDimensionsDecorator.ts b/docs/snippets/metrics/defaultDimensionsDecorator.ts
@@ -7,7 +7,7 @@ const DEFAULT_DIMENSIONS = { 'environment': 'prod', 'foo': 'bar' };
 export class Lambda implements LambdaInterface {
   // Decorate your handler class method
   @metrics.logMetrics({ defaultDimensions: DEFAULT_DIMENSIONS })
-  public async handler(_event: any, _context: any): Promise<void> {
+  public async handler(_event: unknown, _context: unknown): Promise<void> {
     metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
   }
 }

diff --git a/docs/snippets/metrics/defaultDimensionsMiddy.ts b/docs/snippets/metrics/defaultDimensionsMiddy.ts
@@ -3,7 +3,7 @@ import middy from '@middy/core';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
+const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
 };
 

diff --git a/docs/snippets/metrics/manual.ts b/docs/snippets/metrics/manual.ts
@@ -2,7 +2,7 @@ import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-export const handler = async (_event: any, _context: any): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 10);
   metrics.publishStoredMetrics();
 };
diff --git a/docs/snippets/metrics/middy.ts b/docs/snippets/metrics/middy.ts
@@ -3,7 +3,7 @@ import middy from '@middy/core';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
+const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
 };
 

diff --git a/docs/snippets/metrics/multiValueMetrics.ts b/docs/snippets/metrics/multiValueMetrics.ts
@@ -1,9 +1,8 @@
 import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
-import { Context } from 'aws-lambda'; 
 
 const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
 
-export const handler = async (event: any, context: Context): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('performedActionA', MetricUnits.Count, 2);
   // do something else...
   metrics.addMetric('performedActionA', MetricUnits.Count, 1);

diff --git a/docs/snippets/metrics/sam.ts b/docs/snippets/metrics/sam.ts
@@ -1,7 +1,8 @@
-import { Metrics } from '@aws-lambda-powertools/metrics';
+import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
 
 // Metrics parameters fetched from the environment variables (see template.yaml tab)
 const metrics = new Metrics();
+metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
 
 // You can also pass the parameters in the constructor
 // const metrics = new Metrics({

diff --git a/docs/snippets/metrics/setDefaultDimensions.ts b/docs/snippets/metrics/setDefaultDimensions.ts
@@ -3,6 +3,6 @@ import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 metrics.setDefaultDimensions({ 'environment': 'prod', 'foo': 'bar' });
 
-export const handler = async (event: any, _context: any): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
 };
diff --git a/docs/snippets/metrics/singleMetricDifferentDimsDecorator.ts b/docs/snippets/metrics/singleMetricDifferentDimsDecorator.ts
@@ -6,7 +6,7 @@ const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orde
 class Lambda implements LambdaInterface {
 
   @metrics.logMetrics()
-  public async handler(_event: any, _context: any): Promise<void> {
+  public async handler(_event: unknown, _context: unknown): Promise<void> {
     metrics.addDimension('metricUnit', 'milliseconds');
     // This metric will have the "metricUnit" dimension, and no "metricType" dimension:
     metrics.addMetric('latency', MetricUnits.Milliseconds, 56);

diff --git a/docs/snippets/metrics/singleMetricDifferentDimsMiddy.ts b/docs/snippets/metrics/singleMetricDifferentDimsMiddy.ts
@@ -3,7 +3,7 @@ import middy from '@middy/core';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
+const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addDimension('metricUnit', 'milliseconds');
   // This metric will have the "metricUnit" dimension, and no "metricType" dimension:
   metrics.addMetric('latency', MetricUnits.Milliseconds, 56);

diff --git a/docs/snippets/metrics/throwOnEmptyMetrics.ts b/docs/snippets/metrics/throwOnEmptyMetrics.ts
@@ -3,7 +3,7 @@ import middy from '@middy/core';
 
 const metrics = new Metrics({ namespace: 'serverlessAirline', serviceName: 'orders' });
 
-const lambdaHandler = async (_event: any, _context: any): Promise<void> => {
+const lambdaHandler = async (_event: unknown, _context: unknown): Promise<void> => {
   metrics.addMetric('successfulBooking', MetricUnits.Count, 1);
 };
 

diff --git a/docs/snippets/package.json b/docs/snippets/package.json
@@ -25,9 +25,9 @@
   "devDependencies": {
     "@aws-sdk/client-appconfigdata": "^3.245.0",
     "@aws-sdk/client-dynamodb": "^3.245.0",
-    "@aws-sdk/client-s3": "^3.254.0",
     "@aws-sdk/client-secrets-manager": "^3.250.0",
     "@aws-sdk/client-ssm": "^3.245.0",
-    "@aws-sdk/util-dynamodb": "^3.245.0"
+    "@aws-sdk/util-dynamodb": "^3.245.0",
+    "axios": "^1.2.4"
   }
 }
diff --git a/docs/snippets/tracer/accessRootTraceId.ts b/docs/snippets/tracer/accessRootTraceId.ts
@@ -2,7 +2,7 @@ import { Tracer } from '@aws-lambda-powertools/tracer';
 
 const tracer = new Tracer({ serviceName: 'serverlessAirline' });
 
-export const handler = async (event: unknown, context: Context): Promise<void> => {
+export const handler = async (_event: unknown, _context: unknown): Promise<void> => {
   try {
 
   } catch (err) {

diff --git a/docs/snippets/tracer/basicUsage.ts b/docs/snippets/tracer/basicUsage.ts
@@ -3,5 +3,5 @@ import { Tracer } from '@aws-lambda-powertools/tracer';
 const tracer = new Tracer({ serviceName: 'serverlessAirline' });
 
 export const handler = async (_event, _context): Promise<void> => {
-  // ...
+  tracer.getSegment();
 };
diff --git a/docs/snippets/tracer/captureAWS.ts b/docs/snippets/tracer/captureAWS.ts
@@ -2,4 +2,4 @@ import { S3 } from 'aws-sdk';
 import { Tracer } from '@aws-lambda-powertools/tracer';
 
 const tracer = new Tracer({ serviceName: 'serverlessAirline' });
-const s3 = tracer.captureAWSClient(new S3());
+tracer.captureAWSClient(new S3());
diff --git a/docs/snippets/tracer/captureAWSAll.ts b/docs/snippets/tracer/captureAWSAll.ts
@@ -1,4 +1,4 @@
-import { Tracer } from '@aws-lambda-powertools/tracer';
+// import { Tracer } from '@aws-lambda-powertools/tracer';
 
-const tracer = new Tracer({ serviceName: 'serverlessAirline' });
-const AWS = tracer.captureAWS(require('aws-sdk'));
+// const tracer = new Tracer({ serviceName: 'serverlessAirline' });
+// const AWS = tracer.captureAWS(require('aws-sdk'));
diff --git a/docs/snippets/tracer/captureAWSv3.ts b/docs/snippets/tracer/captureAWSv3.ts
@@ -1,5 +1,5 @@
-import { S3Client } from '@aws-sdk/client-s3';
+import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
 import { Tracer } from '@aws-lambda-powertools/tracer';
 
 const tracer = new Tracer({ serviceName: 'serverlessAirline' });
-const client = tracer.captureAWSv3Client(new S3Client({}));
+tracer.captureAWSv3Client(new SecretsManagerClient({}));