Merge branch '751-feature-logger-pretty-printing-logs-in-local-and-non-prod-env' of https://github.com/shdq/aws-lambda-powertools-typescript into 751-feature-logger-pretty-printing-logs-in-local-and-non-prod-env

Author: shdq

Diff for: .devcontainer/devcontainer.json

@@ -26,7 +26,7 @@
     "ms-azuretools.vscode-docker"
   ],
   // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "npm ci --foreground-scripts; cd examples/cdk; npm ci; cd ../sam; npm ci; cd ../../; npm run init-environment",
+  "postCreateCommand": "npm run setup-local",
   // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
   "remoteUser": "node"
 }

Diff for: .github/ISSUE_TEMPLATE/maintenance.yml

@@ -53,7 +53,7 @@ body:
       options:
         - label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets)
           required: true
-        - label: Should this be considered in other Lambda Powertools languages? i.e. [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/)
+        - label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/)
           required: false
   - type: markdown
     attributes:

Diff for: .github/workflows/make-release.yml

@@ -5,7 +5,7 @@ concurrency:
   group: on-release-publish
 jobs:
   run-unit-tests:
-    uses: ./.github/workflows/reusable-run-unit-tests.yml
+    uses: ./.github/workflows/reusable-run-linting-check-and-unit-tests.yml
   publish-npm:
     needs: run-unit-tests
     runs-on: ubuntu-latest

Diff for: .github/workflows/on-merge-to-main.yml

@@ -20,7 +20,7 @@ jobs:
   run-unit-tests:
     needs: get_pr_details
     if: ${{ needs.get_pr_details.outputs.prIsMerged == 'true' }}
-    uses: ./.github/workflows/reusable-run-unit-tests.yml
+    uses: ./.github/workflows/reusable-run-linting-check-and-unit-tests.yml
   publish:
     needs:
       [get_pr_details, run-unit-tests]

Diff for: .github/workflows/pr_lint_and_test.yml renamed to .github/workflows/pr-run-linting-check-and-unit-tests.yml

@@ -5,4 +5,4 @@ on:
     types: [opened, synchronize]
 jobs:
   run-unit-tests:
-    uses: ./.github/workflows/reusable-run-unit-tests.yml
+    uses: ./.github/workflows/reusable-run-linting-check-and-unit-tests.yml

Diff for: .github/workflows/reusable-run-unit-tests.yml renamed to .github/workflows/reusable-run-linting-check-and-unit-tests.yml

@@ -4,7 +4,7 @@ on:
   workflow_call:
 
 jobs:
-  run-unit-tests-on-utils:
+  run-linting-check-and-unit-tests-on-utilities:
     runs-on: ubuntu-latest
     env:
       NODE_ENV: dev
@@ -29,21 +29,21 @@ jobs:
           path: "./node_modules"
           # Use the combo between node version, name, and SHA-256 hash of the lock file as cache key so that
           # if one of them changes the cache is invalidated/discarded
-          key: ${{ matrix.version }}-cache-utils-node-modules-${{ hashFiles('./package-lock.json') }}
+          key: ${{ matrix.version }}-cache-utilities-node-modules-${{ hashFiles('./package-lock.json') }}
       - name: Install dependencies
-        # We can skip the install if there was a cache hit
+        # We can skip the installation if there was a cache hit
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
         # See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
         run: npm ci --foreground-scripts
       - name: Build packages
         # If there's a cache hit we still need to manually build the packages
         # this would otherwise have been done automatically as a part of the
-        # postinstall npm hook
+        # post-install npm hook
         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
-      - name: Lint
+      - name: Run linting
         run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics
       - name: Run unit tests
         run: npm t -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics
@@ -77,9 +77,11 @@ jobs:
           # invalidated/discarded for all.
           key: ${{ matrix.example }}-cache-examples-node-modules-${{ hashFiles('./examples/*/package-lock.json') }}
       - name: Install dependencies
-        # We can skip the install if there was a cache hit
+        # We can skip the installation if there was a cache hit
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
         run: npm ci
+      - name: Run linting
+        run: npm run lint
       - name: Run tests
         run: npm t
   check-layer-publisher:
@@ -103,8 +105,12 @@ jobs:
         with:
           path: "./layer-publisher/node_modules"
           # Use the combo between example, name, and SHA-256 hash of the layer-publisher lock files as cache key.
-          key: cache-layer-publisher-node-modules-${{ hashFiles('./layer-publisher/*/package-lock.json') }}
+          key: cache-layer-publisher-node-modules-${{ hashFiles('./layer-publisher/package-lock.json') }}
       - name: Install Layer publisher
-        # We can skip the install if there was a cache hit
+        # We can skip the installation if there was a cache hit
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
         run: npm ci
+      - name: Run linting
+        run: npm run lint
+      - name: Run tests
+        run: npm t

Diff for: .gitpod.yml

@@ -5,22 +5,13 @@ tasks:
       nvm use
       # Install npm 8.x
       npm i -g npm@next-8
-      # Install monorepo packages
-      npm ci --foreground-scripts
-      # Install CDK exampels dependencies
-      cd examples/cdk
-      npm ci
-      # Install SAM exampels dependencies
-      cd ../sam
-      npm ci
       # Install AWS SAM CLI
       wget https://github.com/aws/aws-sam-cli/releases/latest/download/aws-sam-cli-linux-x86_64.zip
       unzip aws-sam-cli-linux-x86_64.zip -d sam-installation
       sudo ./sam-installation/install
       rm -rf sam-installation aws-sam-cli-linux-*
-      cd ../../
-      # Setup husky hooks
-      npm run init-environment
+      # Install repo dependencies
+      npm run setup-local
 vscode:
   extensions:
     - dbaeumer.vscode-eslint

Diff for: .husky/pre-commit

@@ -1,4 +1,10 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run lerna-lint-fix
+npm run lint-fix -ws
+cd examples/sam && npm run lint-fix
+cd ../..
+cd examples/cdk && npm run lint-fix
+cd ../..
+cd layer-publisher && npm run lint-fix
+cd ..

Diff for: .husky/pre-push

@@ -1,5 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run lerna-lint-fix
-npm run test
+npm t -ws

Diff for: CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.4.1](https://github.com/awslabs/aws-lambda-powertools-typescript/compare/v1.4.0...v1.4.1) (2022-11-09)
+
+
+### Bug Fixes
+
+* **metrics:** store service name in defaultDimensions to avoid clearing it ([#1146](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/1146)) ([a979202](https://github.com/awslabs/aws-lambda-powertools-typescript/commit/a979202ae0563f8ce00dee98bbf15d0bcfcfd3cc))
+
+
+
+
+
 # [1.4.0](https://github.com/awslabs/aws-lambda-powertools-typescript/compare/v1.3.0...v1.4.0) (2022-10-27)
 
 

Diff for: CONTRIBUTING.md

@@ -88,7 +88,7 @@ the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeu
 ### Repo Layout
 
 The AWS Lambda Powertools is a npm project written in [TypeScript](https://www.typescriptlang.org/).
-More specifically, it is a [monorepo managed using lerna](https://github.com/lerna/lerna#about).
+More specifically, it is a [monorepo managed using npm workspaces](https://docs.npmjs.com/cli/v8/using-npm/workspaces).
 If you're unfamiliar with any of these technologies, it is useful to learn about them and will make understanding the codebase easier but strictly not necessary for simple contributions.
 
 The repo contains `packages/` directory that contains the Powertools utilities modules. For instance, the source code for the Logger utility can be found at the location `packages/logger` and so on.
@@ -126,9 +126,8 @@ As mentioned before, tests are split into groups thanks to [jest-runner-groups](
 
 To run unit tests, you can either use:
 
-* npm task `lerna-test:unit` (`npm run lerna-test:unit`) in root folder to run them all
-* npm task `test:unit` (`npm run test:unit`) in module folder (for example: `packages/metrics`) to run the module specific ones
-* jest directly `npx jest --group=unit` in module folder to run the module specific ones (You can run selective tests by restricting the group to the one you want. For instance `npx jest --group=unit/metrics/class`)
+* `npm test -ws` while in the root folder to run them all
+* `npm test -w packages/metrics` while in the root folder to run the module specific ones
 
 #### e2e tests
 
@@ -156,9 +155,8 @@ See `metrics/tests/e2e/basicFeatures.decorator.test.ts` as an example.
 
 To run e2e tests, you can either use:
 
-* npm task `lerna-test:e2e` (`npm run lerna-test:e2e`) in root folder
-* npm task `test:e2e` (`npm run test:e2e`) in module folder (for example: `packages/metrics`) to run the module specific ones
-* jest directly `npx jest --group=e2e` in module folder. (You can run selective tests by restricting the group to the one you want. For instance `npx jest --group=e2e/metrics/decorator`)
+* `npm test:e2e -ws` while in the root folder to run them all
+* `npm test:e2e -w packages/metrics` while in the root folder to run the module specific ones
 
 Three important environment variables can be used:
 
@@ -200,7 +198,7 @@ As part of the repo you will find an examples folder at the root. This folder co
 
 To test your updates with these examples, you just have to:
 
-1. Build your local version of *aws-lambda-powertools-typescript* npm packages with `npm run lerna-package` while in the root folder
+1. Build your local version of *aws-lambda-powertools-typescript* npm packages with `npm run package -ws` while in the root folder
 2. Move to the examples folder of your choice
     ```sh
     cd packages/examples/cdk

Diff for: docs/core/logger.md

@@ -105,7 +105,7 @@ Your Logger will include the following keys to your structured logging (default
 | **error**: `Object`         | `{ name: "Error", location: "/my-project/handler.ts:18", message: "Unexpected error #1", stack: "[stacktrace]"}` | Optional - An object containing information about the Error passed to the logger                                                                                                                                                |
 
 ???+ info
-    When `POWERTOOLS_DEV` environment variable is present and set to `"true"`, Logger will pretty-print log messages for easier readability. It is for debugging purposes and is not supposed to use in production environment.
+    When `POWERTOOLS_DEV` environment variable is present and set to `"true"` or `"1"`, Logger will pretty-print log messages for easier readability. We recommend to use this setting only when debugging on local environments.
 
 ### Capturing Lambda context info
 

Diff for: docs/core/tracer.md

@@ -75,7 +75,7 @@ The `Tracer` utility is instantiated outside of the Lambda handler. In doing thi
 
     // You can also pass the parameter in the constructor
     // const tracer = new Tracer({
-    //     serviceName: "serverlessAirline"
+    //     serviceName: 'serverlessAirline'
     // });
     ```
 
@@ -510,7 +510,7 @@ Tracer exposes a `getRootXrayTraceId()` method that allows you to retrieve the [
             return {
                 statusCode: 500,
                 body: `Internal Error - Please contact support and quote the following id: ${rootTraceId}`,
-                headers: { "_X_AMZN_TRACE_ID": rootTraceId },
+                headers: { '_X_AMZN_TRACE_ID': rootTraceId },
             };
         }
     };