Merge remote-tracking branch 'origin/master' into HEAD

Author: willyyhuang

.github/ISSUE_TEMPLATE/unreliable_test_report.md

@@ -0,0 +1,17 @@
+---
+name: unreliable test
+about: Help us monitor our test suite by reporting flaky tests.
+labels: tests-ci-cd
+---
+
+## Test Details
+
+-   Name of test:
+-   OS of failure:
+-   VSCode version of failure (minimum/insider/stable):
+-   Link to failing run:
+-   Link to failing test:
+
+## Log of Test Failure
+
+## Additional Information

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,6 +6,7 @@
 
 ---
 
-<!--- REMINDER: Ensure that your PR meets the guidelines in CONTRIBUTING.md -->
+- Treat all work as PUBLIC. Private `feature/x` branches will not be squash-merged at release time.
+- Your code changes must meet the guidelines in [CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines).
 
 License: I confirm that my contribution is made under the terms of the Apache 2.0 license.

.github/workflows/copyPasteDetection.yml

@@ -1,86 +1,86 @@
-# github actions: https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-nodejs
-# setup-node: https://github.com/actions/setup-node
+# # github actions: https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-nodejs
+# # setup-node: https://github.com/actions/setup-node
 
-name: Copy-Paste Detection
+# name: Copy-Paste Detection
 
-on:
-    pull_request:
-        branches: [master, feature/*, staging]
+# on:
+#     pull_request:
+#         branches: [master, feature/*, staging]
 
-jobs:
-    jscpd:
-        runs-on: ubuntu-latest
-        strategy:
-            matrix:
-                node-version: [18.x]
-        env:
-            NODE_OPTIONS: '--max-old-space-size=8192'
+# jobs:
+#     jscpd:
+#         runs-on: ubuntu-latest
+#         strategy:
+#             matrix:
+#                 node-version: [18.x]
+#         env:
+#             NODE_OPTIONS: '--max-old-space-size=8192'
 
-        steps:
-            - uses: actions/checkout@v4
-              with:
-                  fetch-depth: 0
+#         steps:
+#             - uses: actions/checkout@v4
+#               with:
+#                   fetch-depth: 0
 
-            - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@v4
-              with:
-                  node-version: ${{ matrix.node-version }}
+#             - name: Use Node.js ${{ matrix.node-version }}
+#               uses: actions/setup-node@v4
+#               with:
+#                   node-version: ${{ matrix.node-version }}
 
-            - name: Fetch fork upstream
-              run: |
-                  git remote add forkUpstream https://github.com/${{ github.event.pull_request.head.repo.full_name }}  # URL of the fork
-                  git fetch forkUpstream  # Fetch fork
+#             - name: Fetch fork upstream
+#               run: |
+#                   git remote add forkUpstream https://github.com/${{ github.event.pull_request.head.repo.full_name }}  # URL of the fork
+#                   git fetch forkUpstream  # Fetch fork
 
-            - name: Determine base and target branches for comparison.
-              run: |
-                  echo "CURRENT_BRANCH=${{ github.head_ref }}" >> $GITHUB_ENV
-                  echo "TARGET_BRANCH=${{ github.event.pull_request.base.ref }}" >> $GITHUB_ENV
-            - run: git diff --name-only origin/$TARGET_BRANCH forkUpstream/$CURRENT_BRANCH > diff_output.txt
-            - run: |
-                  npm install -g jscpd
+#             - name: Determine base and target branches for comparison.
+#               run: |
+#                   echo "CURRENT_BRANCH=${{ github.head_ref }}" >> $GITHUB_ENV
+#                   echo "TARGET_BRANCH=${{ github.event.pull_request.base.ref }}" >> $GITHUB_ENV
+#             - run: git diff --name-only origin/$TARGET_BRANCH forkUpstream/$CURRENT_BRANCH > diff_output.txt
+#             - run: |
+#                   npm install -g jscpd
 
-            - run: jscpd --config "$GITHUB_WORKSPACE/.github/workflows/jscpd.json"
+#             - run: jscpd --config "$GITHUB_WORKSPACE/.github/workflows/jscpd.json"
 
-            - if: always()
-              uses: actions/upload-artifact@v4
-              with:
-                  name: unfiltered-jscpd-report
-                  path: ./jscpd-report.json
+#             - if: always()
+#               uses: actions/upload-artifact@v4
+#               with:
+#                   name: unfiltered-jscpd-report
+#                   path: ./jscpd-report.json
 
-            - name: Filter jscpd report for changed files
-              run: |
-                  if [ ! -f ./jscpd-report.json ]; then
-                    echo "jscpd-report.json not found"
-                    exit 1
-                  fi
-                  echo "Filtering jscpd report for changed files..."
-                  CHANGED_FILES=$(jq -R -s -c 'split("\n")[:-1]' diff_output.txt)
-                  echo "Changed files: $CHANGED_FILES"
-                  jq --argjson changed_files "$CHANGED_FILES" '
-                  .duplicates | map(select(
-                      (.firstFile?.name as $fname | $changed_files | any(. == $fname)) or
-                      (.secondFile?.name as $sname | $changed_files | any(. == $sname))
-                  ))
-                  ' ./jscpd-report.json > filtered-jscpd-report.json
-                  cat filtered-jscpd-report.json
+#             - name: Filter jscpd report for changed files
+#               run: |
+#                   if [ ! -f ./jscpd-report.json ]; then
+#                     echo "jscpd-report.json not found"
+#                     exit 1
+#                   fi
+#                   echo "Filtering jscpd report for changed files..."
+#                   CHANGED_FILES=$(jq -R -s -c 'split("\n")[:-1]' diff_output.txt)
+#                   echo "Changed files: $CHANGED_FILES"
+#                   jq --argjson changed_files "$CHANGED_FILES" '
+#                   .duplicates | map(select(
+#                       (.firstFile?.name as $fname | $changed_files | any(. == $fname)) or
+#                       (.secondFile?.name as $sname | $changed_files | any(. == $sname))
+#                   ))
+#                   ' ./jscpd-report.json > filtered-jscpd-report.json
+#                   cat filtered-jscpd-report.json
 
-            - name: Check for duplicates
-              run: |
-                  if [ $(wc -l < ./filtered-jscpd-report.json) -gt 1 ]; then
-                    echo "filtered_report_exists=true" >> $GITHUB_ENV
-                  else
-                    echo "filtered_report_exists=false" >> $GITHUB_ENV
-                  fi
-            - name: upload filtered report (if applicable)
-              if: env.filtered_report_exists == 'true'
-              uses: actions/upload-artifact@v4
-              with:
-                  name: filtered-jscpd-report
-                  path: ./filtered-jscpd-report.json
+#             - name: Check for duplicates
+#               run: |
+#                   if [ $(wc -l < ./filtered-jscpd-report.json) -gt 1 ]; then
+#                     echo "filtered_report_exists=true" >> $GITHUB_ENV
+#                   else
+#                     echo "filtered_report_exists=false" >> $GITHUB_ENV
+#                   fi
+#             - name: upload filtered report (if applicable)
+#               if: env.filtered_report_exists == 'true'
+#               uses: actions/upload-artifact@v4
+#               with:
+#                   name: filtered-jscpd-report
+#                   path: ./filtered-jscpd-report.json
 
-            - name: Fail and log found duplicates.
-              if: env.filtered_report_exists == 'true'
-              run: |
-                  cat ./filtered-jscpd-report.json
-                  echo "Duplications found, failing the check."
-                  exit 1
+#             - name: Fail and log found duplicates.
+#               if: env.filtered_report_exists == 'true'
+#               run: |
+#                   cat ./filtered-jscpd-report.json
+#                   echo "Duplications found, failing the check."
+#                   exit 1

.github/workflows/node.js.yml

@@ -85,7 +85,7 @@ jobs:
                   # Unset NODE_OPTIONS because of https://github.com/codecov/uploader/issues/475
                   NODE_OPTIONS: ''
               if: ${{ github.repository == 'aws/aws-toolkit-vscode' && github.ref == 'master' }}
-              uses: codecov/codecov-action@v4
+              uses: codecov/codecov-action@v5
               with:
                   flags: macos-toolkit-unittests
                   verbose: true
@@ -96,7 +96,7 @@ jobs:
                   # Unset NODE_OPTIONS because of https://github.com/codecov/uploader/issues/475
                   NODE_OPTIONS: ''
               if: ${{ github.repository == 'aws/aws-toolkit-vscode' && github.ref == 'master' }}
-              uses: codecov/codecov-action@v4
+              uses: codecov/codecov-action@v5
               with:
                   flags: macos-amazonq-unittests
                   verbose: true
@@ -155,7 +155,7 @@ jobs:
                   # Unset NODE_OPTIONS because of https://github.com/codecov/uploader/issues/475
                   NODE_OPTIONS: ''
               if: ${{ github.repository == 'aws/aws-toolkit-vscode' && github.ref == 'master' }}
-              uses: codecov/codecov-action@v4
+              uses: codecov/codecov-action@v5
               with:
                   flags: windows-unittests
                   verbose: true

CONTRIBUTING.md

@@ -238,9 +238,12 @@ You can find documentation to create VSCode IDE settings for CodeCatalyst bluepr
 
 Before sending a pull request:
 
+1. Treat all work as PUBLIC. Private `feature/x` branches will _not_ be squash-merged at release time. This has several benefits:
+    - Avoids mistakes (accidental exposure to public)!
+    - Avoids needing to erase (squash-merge) history.
 1. Check that you are working against the latest source on the `master` branch.
-2. Check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. Open an issue to discuss any significant work.
+1. Check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+1. Open an issue to discuss any significant work.
 
 To send a pull request:
 

buildspec/release/35opengate.yml

@@ -0,0 +1,18 @@
+version: 0.2
+
+phases:
+    install:
+        runtime-versions:
+            nodejs: 16
+
+    pre_build:
+        commands:
+            - STAGE_NAME=SourceWithGit
+            - PIPELINE=$(echo $CODEBUILD_INITIATOR | sed -e 's/codepipeline\///')
+    build:
+        commands:
+            - |
+                aws codepipeline enable-stage-transition \
+                  --pipeline-name "$PIPELINE" \
+                  --stage-name "$STAGE_NAME" \
+                  --transition-type "Inbound"

buildspec/shared/common.sh

@@ -6,13 +6,9 @@
 
 # Ignore these patterns when deciding if the build should fail.
 #   - "waiting for browser": from `ssoAccessTokenProvider.test.ts`, unclear how to fix it.
-#   - "Webview is disposed": only happens on vscode "minimum" (1.68.0)
 #   - "HTTPError: Response code …": caused by github rate-limiting.
 #   - "npm WARN deprecated querystring": transitive dep of aws sdk v2 (check `npm ls querystring`), so that's blocked until we migrate to v3.
 _ignore_pat='Timed-out waiting for browser login flow\|HTTPError: Response code 403\|HTTPError: Response code 404\|npm WARN deprecated querystring\|npm WARN deprecated'
-if [ "$VSCODE_TEST_VERSION" = 'minimum' ]; then
-    _ignore_pat="$_ignore_pat"'\|Webview is disposed'
-fi
 
 # Do not print (noisy) lines matching these patterns.
 #   - "ERROR:bus… Failed to connect to the bus": noise related to "xvfb". https://github.com/cypress-io/cypress/issues/19299

docs/telemetry.md

@@ -142,20 +142,23 @@ Finally, if `setupStep2()` was the thing that failed we would see a metric like:
 
 ## Adding a "Stack Trace" to your metric
 
-### Problem
+When errors are thrown we do not attach the stack trace in telemetry. We only know about the error itself, but
+not the path it took to get there. We sometimes need this stack trace to debug, and only have telemetry to get insight on what happened since we do not have access to logs.
+
+### Scenario
 
 Common example: _"I have a function, `thisFailsSometimes()` that is called in multiple places. The function sometimes fails, I know from telemetry, but I do not know if it is failing when it is a specific caller. If I knew the call stack/trace that it took to call my function that would help me debug."_
 
 ```typescript
-function outerA() {
+function runsSuccessfully() {
     thisFailsSometimes(1) // this succeeds
 }
 
-function outerB() {
+function thisThrows() {
     thisFailsSometimes(0) // this fails
 }
 
-function thisFailsSometimes(num: number) {
+function failsDependingOnInput(num: number) {
     return telemetry.my_Metric.run(() => {
         if (number === 0) {
             throw Error('Cannot be 0')
@@ -167,31 +170,61 @@ function thisFailsSometimes(num: number) {
 
 ### Solution
 
-Add a value to `function` in the options of a `run()`. This will result in a stack of functions identifiers that were previously called
-before `thisFailsSometimes()` was run. You can then retrieve the stack in the `run()` of your final metric using `getFunctionStack()`.
+On class methods, use the `@withTelemetryContext()` decorator to add context to the execution. Depending on the args set, it provides features like emitting the result, or adding it's context to errors.
+
+> NOTE: Decorators are currently only supported for methods and not functions
+
+```typescript
+class MyClass {
+    @withTelemetryContext({ name: 'runsSuccessfully', class: 'MyClass' })
+    public runsSuccessfully() {
+        failsDependingOnInput(1)
+    }
+
+    @withTelemetryContext({ name: 'thisThrows', class: 'MyClass', errorCtx: true })
+    public thisThrows() {
+        failsDependingOnInput(0)
+    }
+
+    @withTelemetryContext({ name: 'failsDependingOnInput' class: 'MyClass', emit: true, errorCtx: true})
+    private failsDependingOnInput(num: number) {
+        if (number === 0) {
+            throw Error('Cannot be 0')
+        }
+        ...
+    }
+}
+
+// Results in a metric: { source: 'MyClass#thisThrows,failsDependingOnInput', result: 'Failed' }
+// Results in an error that has context about the methods that lead up to it.
+new MyClass().thisThrows()
+```
+
+Separately if you must use a function, add a value to `function` in the options of a `run()`. This will result in a stack of functions identifiers that were previously called
+before `failsDependingOnInput()` was run. You can then retrieve the stack in the `run()` of your final metric using `getFunctionStack()`.
 
 ```typescript
-function outerA() {
-    telemetry.my_Metric.run(() => thisFailsSometimes(1), { functionId: { name: 'outerA' }})
+function runsSuccessfully() {
+    telemetry.my_Metric.run(() => failsDependingOnInput(1), { functionId: { name: 'runsSuccessfully' }})
 }
 
-function outerB() {
-    telemetry.my_Metric.run(() => thisFailsSometimes(0), { functionId: { source: 'outerB' }})
+function thisThrows() {
+    telemetry.my_Metric.run(() => failsDependingOnInput(0), { functionId: { source: 'thisThrows' }})
 }
 
-function thisFailsSometimes(num: number) {
+function failsDependingOnInput(num: number) {
     return telemetry.my_Metric.run(() => {
         telemetry.record({ theCallStack: asStringifiedStack(telemetry.getFunctionStack())})
         if (number === 0) {
             throw Error('Cannot be 0')
         }
         ...
-    }, { functionId: { name: 'thisFailsSometimes' }})
+    }, { functionId: { name: 'failsDependingOnInput' }})
 }
 
-// Results in a metric: { theCallStack: 'outerB:thisFailsSometimes', result: 'Failed' }
-// { theCallStack: 'outerB:thisFailsSometimes' } implies 'outerB' was run first, then 'thisFailsSometimes'. See docstrings for more info.
-outerB()
+// Results in a metric: { theCallStack: 'thisThrows:failsDependingOnInput', result: 'Failed' }
+// { theCallStack: 'thisThrows:failsDependingOnInput' } implies 'thisThrows' was run first, then 'failsDependingOnInput'. See docstrings for more info.
+thisThrows()
 ```
 
 ### Important Notes
@@ -216,25 +249,6 @@ outerB()
     c() // result: 'a:c', note that 'b' is not included
     ```
 
--   If you are using `run()` with a class method, you can also add the class to the entry for more context
-
-    ```typescript
-    class A {
-        a() {
-            return telemetry.my_Metric.run(() => this.b(), { functionId: { name: 'a', class: 'A' } })
-        }
-
-        b() {
-            return telemetry.my_Metric.run(() => asStringifiedStack(telemetry.getFunctionStack()), {
-                functionId: { name: 'b', class: 'A' },
-            })
-        }
-    }
-
-    const inst = new A()
-    inst.a() // 'A#a,b'
-    ```
-
 -   If you do not want your `run()` to emit telemetry, set `emit: false` in the options
 
     ```typescript