feat: initial commit

Author: ChristianRich1

.commitlintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+coverage

.eslintrc.js

@@ -0,0 +1,37 @@
+module.exports = {
+  env: {
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    'airbnb-base',
+    'eslint:recommended',
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    'plugin:import/typescript',
+    'plugin:@typescript-eslint/recommended',
+    'prettier/@typescript-eslint',
+    'plugin:prettier/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 12,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    'import/prefer-default-export': 'off',
+    'import/extensions': 'off',
+    'prettier/prettier': 'error',
+    'no-shadow': 'off',
+    'no-use-before-define': 'off',
+    'lines-between-class-members': 'off',
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true, // always try to resolve types under `<roo/>@types` directory even it doesn't contain any source code, like `@types/unist`
+      },
+    },
+  },
+};

.gitignore

@@ -0,0 +1,22 @@
+# package directories
+node_modules
+jspm_packages
+
+# Serverless directories
+.serverless
+
+# Webpack directories
+.webpack
+
+# Yarn
+yarn-error.log
+
+# Coverage
+coverage
+
+# Dotenv
+!.env.example
+.env*
+.esbuild
+.env
+.DS_Store

.huskyrc.js

@@ -0,0 +1,8 @@
+const tasks = (arr) => arr.join(' && ');
+
+module.exports = {
+  hooks: {
+    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS',
+    'pre-commit': tasks(['lint-staged', 'yarn test']),
+  },
+};

.lintstagedrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  '*.{js,ts}': ['eslint --fix', 'prettier --write'],
+};

.prettierignore

@@ -0,0 +1,2 @@
+node_modules
+coverage

.prettierrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  singleQuote: true,
+  trailingComma: 'all',
+};

package.json

@@ -0,0 +1,56 @@
+{
+  "name": "powertools-logger-ts",
+  "version": "1.0.0",
+  "description": "AWS Powertools logger TypeScript integration example",
+  "scripts": {
+    "start": "serverless offline",
+    "deploy:dev": "serverless deploy --aws-profile personal --stage dev",
+    "deploy:production": "serverless deploy --aws-profile personal --stage production",
+    "test": "exit 0",
+    "lint": "eslint '*/**/*.{js,ts}'",
+    "prettier": "prettier --write '*/**/*.{js,ts}'"
+  },
+  "engines": {
+    "node": "16.x",
+    "yarn": ">= 1.19.1"
+  },
+  "dependencies": {
+    "@aws-lambda-powertools/logger": "1.4.1",
+    "@middy/core": "3.6.2",
+    "aws-lambda": "1.0.7",
+    "http-errors": "2.0.0",
+    "serverless": "3.23.0",
+    "source-map-support": "0.5.19"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "11.0.0",
+    "@commitlint/config-conventional": "11.0.0",
+    "@serverless/typescript": "3.21.0",
+    "@types/aws-lambda": "8.10.108",
+    "@types/lodash": "4.14.186",
+    "@types/node": "14.14.6",
+    "@typescript-eslint/eslint-plugin": "4.13.0",
+    "@typescript-eslint/parser": "4.13.0",
+    "commitlint": "11.0.0",
+    "esbuild": "0.15.12",
+    "eslint": "7.17.0",
+    "eslint-config-airbnb-base": "14.2.1",
+    "eslint-config-prettier": "7.1.0",
+    "eslint-import-resolver-typescript": "2.3.0",
+    "eslint-plugin-import": "2.22.1",
+    "eslint-plugin-prettier": "3.3.1",
+    "husky": "4.3.7",
+    "lint-staged": "10.5.3",
+    "prettier": "2.2.1",
+    "serverless-esbuild": "1.33.0",
+    "serverless-offline": "11.2.1",
+    "serverless-prune-plugin": "1.5.0",
+    "serverless-webpack": "5.2.0",
+    "ts-loader": "8.0.10",
+    "ts-node": "9.1.1",
+    "tsconfig-paths-webpack-plugin": "3.3.0",
+    "typescript": "4.0.5"
+  },
+  "author": "Christian Rich",
+  "license": "MIT"
+}

serverless.yaml

@@ -0,0 +1,41 @@
+service: ${file(./package.json):name}
+frameworkVersion: "3"
+plugins:
+  - serverless-esbuild
+  - serverless-offline
+  - serverless-prune-plugin
+package:
+  individually: true
+provider:
+  name: aws
+  region: ap-southeast-2
+  runtime: nodejs16.x
+  environment:
+    AWS_NODEJS_CONNECTION_REUSE_ENABLED: "1"
+    NODE_OPTIONS: "--enable-source-maps --stack-trace-limit=1000"
+    STAGE: ${sls:stage}
+custom:
+  serverless-offline:
+    allowCache: true
+    useChildProcesses: true
+    httpPort: 3000
+  prune:
+    automatic: true
+    number: 3
+  esbuild:
+    bundle: true
+    minify: false
+    sourcemap: true
+    exclude:
+      - aws-sdk
+    target: node16
+    platform: node
+    concurrency: 10
+functions:
+  myFunction:
+    handler: src/handlers/my-handler.handler
+    events:
+      - http:
+          path: /
+          method: get
+          cors: true

src/handlers/my-handler.ts

@@ -0,0 +1,25 @@
+import { APIGatewayProxyResult } from 'aws-lambda';
+import logger from '@/services/logger';
+import middy from '@middy/core';
+import { setLoggerContext } from '@/middleware/set-logger-context';
+
+export const baseHandler = async (): Promise<APIGatewayProxyResult> => {
+  try {
+    logger.info('Invoking Lambda handler function', { data: { type: 'user' } });
+    return {
+      statusCode: 200,
+      body: JSON.stringify({ OK: 200 }),
+    };
+  } catch (error) {
+    const { message } = error;
+    logger.error('Error Invoking Lambda handler function', {
+      data: { message },
+    });
+    return {
+      statusCode: 500,
+      body: JSON.stringify({ message }),
+    };
+  }
+};
+
+export const handler = middy(baseHandler).use(setLoggerContext(logger));

src/middleware/set-logger-context.ts

@@ -0,0 +1,20 @@
+import type { Logger } from '@aws-lambda-powertools/logger';
+import middy from '@middy/core';
+import {
+  APIGatewayProxyEvent,
+  APIGatewayProxyResult,
+  Context,
+} from 'aws-lambda';
+
+export const setLoggerContext = (
+  logger: Logger,
+): middy.MiddlewareObj<APIGatewayProxyEvent, APIGatewayProxyResult> => {
+  const before = (request: middy.Request): void => {
+    const { context }: { context: Context } = request;
+    logger.addContext(context);
+  };
+
+  return {
+    before,
+  };
+};

src/services/env/index.ts

@@ -0,0 +1,14 @@
+export const isLocalhost = (env: NodeJS.ProcessEnv = process.env): boolean =>
+  !isAWS(env);
+
+export const isOffline = (env: NodeJS.ProcessEnv = process.env): boolean =>
+  env.IS_OFFLINE === 'true';
+
+export const isAWS = (env: NodeJS.ProcessEnv = process.env): boolean =>
+  'AWS_LAMBDA_FUNCTION_NAME' in env &&
+  'LAMBDA_TASK_ROOT' in env &&
+  !isOffline();
+
+export const getNodeEnv = (
+  env: NodeJS.ProcessEnv = process.env,
+): string | undefined => env.NODE_ENV;

src/services/logger/formatters/aws.ts

@@ -0,0 +1,32 @@
+import { LogFormatter } from '@aws-lambda-powertools/logger';
+import {
+  LogAttributes,
+  UnformattedAttributes,
+} from '@aws-lambda-powertools/logger/lib/types';
+
+export class DetailedLogFormatter extends LogFormatter {
+  public formatAttributes(attr: UnformattedAttributes): LogAttributes {
+    return {
+      message: attr.message,
+      service: attr.serviceName,
+      environment: attr.environment,
+      awsRegion: attr.awsRegion,
+      correlationIds: {
+        awsRequestId: attr.lambdaContext?.awsRequestId,
+        xRayTraceId: attr.xRayTraceId,
+      },
+      lambdaFunction: {
+        name: attr.lambdaContext?.functionName,
+        arn: attr.lambdaContext?.invokedFunctionArn,
+        memoryLimitInMB: attr.lambdaContext?.memoryLimitInMB,
+        version: attr.lambdaContext?.functionVersion,
+        coldStart: attr.lambdaContext?.coldStart,
+      },
+      logLevel: attr.logLevel,
+      timestamp: this.formatTimestamp(attr.timestamp),
+      logger: {
+        sampleRateValue: attr.sampleRateValue,
+      },
+    };
+  }
+}

src/services/logger/formatters/local.ts

@@ -0,0 +1,15 @@
+import { LogFormatter } from '@aws-lambda-powertools/logger';
+import {
+  LogAttributes,
+  UnformattedAttributes,
+} from '@aws-lambda-powertools/logger/lib/types';
+
+export class LocalhostLogFormatter extends LogFormatter {
+  // eslint-disable-next-line class-methods-use-this
+  public formatAttributes(attr: UnformattedAttributes): LogAttributes {
+    return {
+      logLevel: attr.logLevel,
+      message: attr.message,
+    };
+  }
+}

src/services/logger/index.ts

@@ -0,0 +1,19 @@
+import { LogFormatter, Logger } from '@aws-lambda-powertools/logger';
+import { isAWS } from '../env';
+import { DetailedLogFormatter } from './formatters/aws';
+import { LocalhostLogFormatter } from './formatters/local';
+
+// Log format is driven by the current runtime environment
+const logFormatter: LogFormatter = isAWS()
+  ? new DetailedLogFormatter() // Highly detailed logs for AWS
+  : new LocalhostLogFormatter(); // Just a few key fields for localhost
+
+const logger: Logger = new Logger({
+  logFormatter,
+  logLevel: process.env.LOG_LEVEL || 'DEBUG',
+  serviceName: process.env.AWS_LAMBDA_FUNCTION_NAME,
+});
+
+// Singleton getter
+const getLogger = (): Logger => logger;
+export default getLogger();

tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "extends": "./tsconfig.paths.json",
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "moduleResolution": "node",
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "removeComments": true,
+    "sourceMap": true,
+    "target": "es2017",
+    "outDir": "lib",
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": [
+    "node_modules/**/*",
+    ".serverless/**/*",
+    ".webpack/**/*",
+    "_warmup/**/*",
+    ".vscode/**/*"
+  ]
+}

tsconfig.paths.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": [
+        "src/*"
+      ]
+    }
+  }
+}