Merge branch 'main' into feat/parser

Author: am29d

.github/scripts/setup_tmp_layer_files.sh

@@ -56,7 +56,7 @@ for file in $files; do
     # arn:aws:lambda:{env.region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:39
     if [[ "$line" == *"eu-central-1"* ]]; then
       # These are all the framework pseudo parameters currently found in the docs
-      for pseudo_region in '{region}' '${AWS::Region}' '${aws::region}' '{aws::region}' '{env.region}' '${cdk.Stack.of(this).region}' '${aws.getRegionOutput().name}'; do
+      for pseudo_region in '{region}' '${AWS::Region}' '${aws:region}' '{aws::region}' '{env.region}' '${cdk.Stack.of(this).region}' '${aws.getRegionOutput().name}'; do
         prefix_pseudo_region=$(echo "$prefix" | sed "s/eu-central-1/${pseudo_region}/")
         # prefix_pseudo_region = arn:aws:lambda:${AWS::Region}:094274105915:layer:AWSLambdaPowertoolsTypeScript
 

.github/scripts/update_layer_arn.sh

@@ -0,0 +1,77 @@
+name: Make Release v2 (pre-release)
+on:
+  workflow_dispatch: {}
+concurrency:
+  group: on-release-publish
+jobs:
+  run-unit-tests:
+    uses: ./.github/workflows/reusable-run-linting-check-and-unit-tests.yml
+  publish-npm:
+    needs: run-unit-tests
+    # Needed as recommended by npm docs on publishing with provenance https://docs.npmjs.com/generating-provenance-statements
+    permissions:
+      id-token: write
+      contents: write
+    runs-on: ubuntu-latest
+    outputs:
+      RELEASE_VERSION: ${{ steps.set-release-version.outputs.RELEASE_VERSION }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
+      - name: Setup NodeJS
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
+        with:
+          node-version: '18'
+          cache: 'npm'
+      - name: Setup auth tokens
+        run: |
+          npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}"
+      - name: Setup dependencies
+        uses: ./.github/actions/cached-node-modules
+      - name: Version
+        run: |
+          # Version all packages to next major version (2.0.0) without pushing to git, generating changelog or running commit hooks
+          # Since the version stored in the lerna.json will always be a 1.x.x version, we manually set the version to 2.0.0
+          npx lerna version major --force-publish --no-push --no-git-tag-version --no-commit-hooks --no-changelog --yes
+      - name: Set alpha iteration
+        run: |
+          # Get the current alpha version from npm i.e 2.0.0-alpha.0 -> 0, 2.0.0-alpha.1 -> 1 (default to -1 if no alpha versions exist = first pre-release)
+          ITERATION=$(npm show @aws-lambda-powertools/commons time --json | jq -r 'to_entries | map(select(.key | startswith("2.0.0-alpha"))) | sort_by(.key) | last | .key // "-1"')
+          # Write the new version to the file
+          echo "{ \"iteration\": $((ITERATION + 1)) }" > v2.json
+      - name: Increment version in UA
+        run: |
+          # Increment the version in the UA
+          echo "// this file is auto generated, do not modify\nexport const PT_VERSION = '2.0.0-alpha.$(jq -r '.iteration' v2.json)';" > packages/commons/src/version.ts
+      - name: Build
+        run: |
+          npm run build:prod -w packages/batch \
+            -w packages/commons \
+            -w packages/idempotency \
+            -w packages/logger \
+            -w packages/metrics \
+            -w packages/parameters \
+            -w packages/tracer
+      - name: Pack packages
+        run: |
+          npm pack -w packages/batch \
+            -w packages/commons \
+            -w packages/idempotency \
+            -w packages/logger \
+            -w packages/metrics \
+            -w packages/parameters \
+            -w packages/tracer
+      - name: Publish to npm
+        run: |
+          npm publish aws-lambda-powertools-batch-*.tgz --tag next --provenance
+          npm publish aws-lambda-powertools-commons-*.tgz --tag next --provenance
+          npm publish aws-lambda-powertools-idempotency-*.tgz --tag next --provenance
+          npm publish aws-lambda-powertools-logger-*.tgz --tag next --provenance
+          npm publish aws-lambda-powertools-metrics-*.tgz --tag next --provenance
+          npm publish aws-lambda-powertools-parameters-*.tgz --tag next --provenance
+          npm publish aws-lambda-powertools-tracer-*.tgz --tag next --provenance
+      - name: Set release version
+        id: set-release-version
+        run: |
+          VERSION="2.0.0-alpha.$(cat v2.json | jq .iteration -r)"
+          echo RELEASE_VERSION="$VERSION" >> "$GITHUB_OUTPUT"

.github/workflows/make-v2-release.yml

@@ -42,10 +42,6 @@ jobs:
           node-version: "18"
       - name: Setup dependencies
         uses: ./.github/actions/cached-node-modules
-      - name: Create layer files
-        run: |
-          export VERSION=${{ inputs.latest_published_version }}
-          bash .github/scripts/setup_tmp_layer_files.sh
       - name: CDK build
         run: npm run cdk -w layers -- synth --context PowertoolsPackageVersion=${{ inputs.latest_published_version }} -o cdk.out
       - name: Zip output

.github/workflows/publish_layer.yml

@@ -69,10 +69,6 @@ jobs:
         uses: ./.github/actions/cached-node-modules
       - name: Run linting
         run: npm run lint -w layers
-      - name: Create layer files
-        run: |
-          export VERSION=latest
-          bash .github/scripts/setup_tmp_layer_files.sh
       - name: Run tests
         run: npm run test:unit -w layers
   check-docs-snippets:

.github/workflows/reusable-run-linting-check-and-unit-tests.yml

@@ -4,9 +4,9 @@ on:
   workflow_dispatch:
     inputs:
       prNumber:
-        description: "(Optional) PR Number. If you specify a value the value of the branch field will be ignored."
+        description: '(Optional) PR Number. If you specify a value the value of the branch field will be ignored.'
         required: false
-        default: ""
+        default: ''
 
 jobs:
   run-e2e-tests-on-utils:
@@ -19,12 +19,21 @@ jobs:
       contents: read
     strategy:
       matrix:
-        package: [layers, packages/logger, packages/metrics, packages/tracer, packages/parameters, packages/idempotency]
+        package:
+          [
+            layers,
+            packages/logger,
+            packages/metrics,
+            packages/tracer,
+            packages/parameters,
+            packages/idempotency,
+          ]
         version: [14, 16, 18]
+        arch: [x86_64, arm64]
       fail-fast: false
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab  # v3.5.2
+        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
       # If we pass a PR Number when triggering the workflow we will retrieve the PR info and get its headSHA
       - name: Extract PR details
         id: extract_PR_details
@@ -38,7 +47,7 @@ jobs:
       # we checkout the PR at that point in time
       - name: Checkout PR code
         if: ${{ inputs.prNumber != '' }}
-        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab  # v3.5.2
+        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
         with:
           ref: ${{ steps.extract_PR_details.outputs.headSHA }}
       - name: Setup NodeJS
@@ -55,14 +64,10 @@ jobs:
           role-to-assume: ${{ secrets.AWS_ROLE_ARN_TO_ASSUME }}
           aws-region: eu-west-1
           mask-aws-account-id: true
-      - name: Create layer files
-        if: ${{ matrix.package == 'layers' }}
-        run: |
-          export VERSION=latest
-          bash .github/scripts/setup_tmp_layer_files.sh
       - name: Run integration tests on utils
         env:
           RUNTIME: nodejs${{ matrix.version }}x
           CI: true
+          ARCH: ${{ matrix.arch }}
           JSII_SILENCE_WARNING_DEPRECATED_NODE_VERSION: true
         run: npm run test:e2e -w ${{ matrix.package }}

.github/workflows/run-e2e-tests.yml

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21)
+
+### Bug Fixes
+
+- **maintenance:** remove upper peer dependency Middy ([#1705](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1705)) ([df21ec8](https://github.com/aws-powertools/powertools-lambda-typescript/commit/df21ec8761b1be511c13c28fedd41bf0e2851061))
+
 # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18)
 
 ### Bug Fixes

CHANGELOG.md

@@ -129,16 +129,22 @@ When using the `captureLambdaHandler` decorator or middleware, Tracer performs t
 === "Annotations"
     You can add annotations using `putAnnotation` method.
 
-    ```typescript hl_lines="9"
+    ```typescript hl_lines="12"
     --8<-- "docs/snippets/tracer/putAnnotation.ts"
     ```
+
+    1. When Lambda starts an invocation [the X-Ray SDk creates a segment called `facade`](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-subsegments.html#xray-sdk-nodejs-subsegments-lambda). This segment cannot be annotated or modified by your code, so you need to create a new subsegment. This is done automatically by Tracer when using the [decorator or middleware patterns](./tracer.md/#lambda-handler)
+    2. To correctly trace the current and subsequent invocations you need to restore the original segment, this is done automatically by Tracer when using the [decorator or middleware patterns](./tracer.md/#lambda-handler).
 === "Metadata"
     You can add metadata using `putMetadata` method.
 
-    ```typescript hl_lines="9-11"
+    ```typescript hl_lines="12-14"
     --8<-- "docs/snippets/tracer/putMetadata.ts"
     ```
 
+    1. When Lambda starts an invocation [the X-Ray SDk creates a segment called `facade`](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-subsegments.html#xray-sdk-nodejs-subsegments-lambda). This segment cannot be modified by your code, so you need to create a new subsegment. This is done automatically by Tracer when using the [decorator or middleware patterns](./tracer.md/#lambda-handler)
+    2. To correctly trace the current and subsequent invocations you need to restore the original segment, this is done automatically by Tracer when using the [decorator or middleware patterns](./tracer.md/#lambda-handler).
+
 <figure>
   <img src="../../media/tracer_utility_showcase_2.png" loading="lazy" alt="Screenshot of the Amazon CloudWatch Console showing an example of segments and subsegments generated and with metadata set for the handler"/>
   <figcaption>Tracer showcase - Handler Metadata</figcaption>