Merge branch 'master' into hkobew/ui/refresh

Author: Hweinstock

.eslintrc.js

@@ -162,7 +162,8 @@ module.exports = {
         'aws-toolkits/no-incorrect-once-usage': 'error',
         'aws-toolkits/no-string-exec-for-child-process': 'error',
         'aws-toolkits/no-console-log': 'error',
-
+        'aws-toolkits/no-json-stringify-in-log': 'error',
+        'aws-toolkits/no-printf-mismatch': 'error',
         'no-restricted-imports': [
             'error',
             {
@@ -173,13 +174,19 @@ module.exports = {
                             "Avoid importing from the core lib's dist/ folders; please use directly from the core lib defined exports.",
                     },
                 ],
+                // The following will place an error on the `fs-extra` import since we do not want it to be used for browser compatibility reasons.
+                paths: [
+                    {
+                        name: 'fs-extra',
+                        message:
+                            'Avoid fs-extra, use shared/fs/fs.ts. Notify the Toolkit team if your required functionality is not available.',
+                    },
+                    {
+                        name: 'fs',
+                        message: 'Avoid node:fs and use shared/fs/fs.ts when possible.',
+                    },
+                ],
             },
-            // The following will place an error on the `fs-extra` import since we do not want it to be used for browser compatibility reasons.
-            // {
-            //     name: 'fs-extra',
-            //     message:
-            //         'Avoid fs-extra, use shared/fs/fs.ts. Notify the Toolkit team if your required functionality is not available.',
-            // },
         ],
     },
 }

.github/workflows/copyPasteDetection.yml

@@ -0,0 +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
+
+name: Copy-Paste Detection
+
+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'
+
+        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: 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
+
+            - 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
+
+            - 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: 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/jscpd.json

@@ -0,0 +1,9 @@
+{
+    "pattern": "packages/**/*.ts",
+    "ignore": ["**node_modules**", "**dist**", "**/scripts/**"],
+    "gitignore": true,
+    "threshold": 3.0,
+    "minLines": 3,
+    "output": "./",
+    "reporters": ["json"]
+}

.github/workflows/node.js.yml

@@ -41,7 +41,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                node-version: [16.x]
+                node-version: [18.x]
                 vscode-version: [stable]
         env:
             NODE_OPTIONS: '--max-old-space-size=8192'
@@ -62,7 +62,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                node-version: [16.x]
+                node-version: [18.x]
                 vscode-version: [minimum, stable, insiders]
         env:
             VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}
@@ -80,17 +80,6 @@ jobs:
               uses: coactions/setup-xvfb@v1
               with:
                   run: npm test
-            - name: Code coverage (Core)
-              env:
-                  # 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
-              with:
-                  flags: macos-core-unittests
-                  verbose: true
-                  file: ./coverage/core/lcov.info
-                  token: ${{ secrets.CODECOV_TOKEN }}
             - name: Code coverage (Toolkit)
               env:
                   # Unset NODE_OPTIONS because of https://github.com/codecov/uploader/issues/475
@@ -113,17 +102,6 @@ jobs:
                   verbose: true
                   file: ./coverage/amazonq/lcov.info
                   token: ${{ secrets.CODECOV_TOKEN }}
-            - name: Code coverage (CodeWhisperer)
-              env:
-                  # 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
-              with:
-                  flags: codewhisperer
-                  verbose: true
-                  file: ./coverage/core/lcov.info
-                  token: ${{ secrets.CODECOV_TOKEN }}
 
     web:
         needs: lint-commits
@@ -132,7 +110,7 @@ jobs:
         strategy:
             fail-fast: true
             matrix:
-                node-version: [16.x]
+                node-version: [18.x]
                 vscode-version: [stable, insiders]
         env:
             VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}
@@ -158,7 +136,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                node-version: [16.x]
+                node-version: [18.x]
                 vscode-version: [stable, insiders]
         env:
             VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}

.github/workflows/notification.yml

@@ -37,7 +37,7 @@ jobs:
               if: github.event_name == 'pull_request_target'
               with:
                   node-version: '20'
-            - name: Check for tests
+            - name: Comment about contribution guidelines
               uses: actions/github-script@v7
               if: github.event_name == 'pull_request_target'
               with:

.github/workflows/notify.js

@@ -6,9 +6,10 @@
 const { hasPath, dedupComment } = require('./utils')
 
 const testFilesMessage =
-    'This pull request modifies code in src/ but no tests were added/updated. Confirm whether tests should be added or ensure the PR description explains why tests are not required.'
+    '- This pull request modifies code in `src/*` but no tests were added/updated.\n    - Confirm whether tests should be added or ensure the PR description explains why tests are not required.\n'
 
-const changelogMessage = `This pull request implements a feature or fix, so it must include a changelog entry. See [CONTRIBUTING.md#changelog](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#changelog) for instructions.`
+const changelogMessage =
+    '- This pull request implements a `feat` or `fix`, so it must include a changelog entry (unless the fix is for an *unreleased* feature). Review the [changelog guidelines](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#changelog).\n    - Note: beta or "experiment" features that have active users *should* announce fixes in the changelog.\n    - If this is not a feature or fix, use an appropriate type from the [title guidelines](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#pull-request-title). For example, telemetry-only changes should use the `telemetry` type.\n'
 
 /**
  * Remind partner teams that tests are required. We don't need to remind them if:
@@ -44,12 +45,16 @@ module.exports = async ({ github, context }) => {
         issue_number: pullRequestId,
     })
 
+    let msg = ''
     if (shouldAddTestFileMessage) {
-        await dedupComment({ github, comments, owner, repo, pullRequestId, message: testFilesMessage })
+        msg += testFilesMessage
     }
-
     if (shouldAddChangelogMessage) {
-        await dedupComment({ github, comments, owner, repo, pullRequestId, message: changelogMessage })
+        msg += changelogMessage
+    }
+
+    if (shouldAddTestFileMessage || shouldAddChangelogMessage) {
+        await dedupComment({ github, comments, owner, repo, pullRequestId, message: msg })
     }
 }
 
@@ -69,7 +74,12 @@ function requiresChangelogMessage(filenames, title) {
  * Require the test files message if there are changes to source files but aren't any
  * changes to the test files
  */
-function requiresTestFilesMessage(filenames) {
+function requiresTestFilesMessage(filenames, title) {
+    if (/^\s*[mM]erge/.test(title)) {
+        console.log('"Merge" pull request')
+        return
+    }
+
     // Check if src directory changed
     if (!hasPath(filenames, 'src/')) {
         console.log('Did not find src files in the code changes')

CONTRIBUTING.md

@@ -188,11 +188,11 @@ To run a single test in VSCode, do any one of:
 
     -   Unix/macOS/POSIX shell:
         ```
-        TEST_FILE=src/test/foo.test.ts npm run test
+        TEST_FILE=../core/src/test/foo.test.ts npm run test
         ```
     -   Powershell:
         ```
-        $Env:TEST_FILE = "src/test/foo.test.ts"; npm run test
+        $Env:TEST_FILE = "../core/src/test/foo.test.ts"; npm run test
         ```
 
 -   To run all tests in a particular subdirectory, you can edit
@@ -209,16 +209,26 @@ To run tests against a specific folder in VSCode, do any one of:
 -   Run in your terminal
     -   Unix/macOS/POSIX shell:
         ```
-        TEST_DIR=src/test/foo npm run test
+        TEST_DIR=../core/src/test/foo npm run test
         ```
     -   Powershell:
         ```
-        $Env:TEST_DIR = "src/test/foo"; npm run test
+        $Env:TEST_DIR = "../core/src/test/foo"; npm run test
         ```
 
+#### Run jscpd ("Copy-Paste Detection")
+
+If the "Copy-Paste Detection" CI job fails, you will find it useful to check things locally. To
+check a specific file:
+
+    npx jscpd --config .github/workflows/jscpd.json --pattern packages/…/src/foo.ts
+
+See the [jscpd cli documentation](https://github.com/kucherenko/jscpd/tree/master/apps/jscpd) for
+more options.
+
 ### Coverage report
 
-You can find the coverage report at `./coverage/amazonq/lcov-report/index.html` and `./coverage/core/lcov-report/index.html` after running the tests. Tests ran from the workspace launch config won't generate a coverage report automatically because it can break file watching.
+You can find the coverage report at `./coverage/amazonq/lcov-report/index.html` and `./coverage/toolkit/lcov-report/index.html` after running the tests. Tests ran from the workspace launch config won't generate a coverage report automatically because it can break file watching.
 
 ### CodeCatalyst Blueprints
 
@@ -345,14 +355,16 @@ The `aws.dev.forceDevMode` setting enables or disables Toolkit "dev mode". Witho
     -   Example: `getLogger().error('topic: widget failed: %O', { foo: 'bar', baz: 42 })`
 -   Log messages are written to the extension Output channel, which you can view in vscode by visiting the "Output" panel and selecting `AWS Toolkit Logs` or `Amazon Q Logs`.
 -   Use the `aws.dev.logfile` setting to set the logfile path to a fixed location, so you can follow
-    and filter logs using shell tools like `tail` and `grep`. For example in settings.json,
-    ```
-    "aws.dev.logfile": "~/awstoolkit.log",
-    ```
-    then you can tail the logfile in your terminal:
-    ```
-    tail -F ~/awstoolkit.log
-    ```
+    and filter logs using shell tools like `tail` and `grep`.
+    -   Note: this always logs at **debug log-level** (though you can temporarily override that from the `AWS Toolkit Logs` UI).
+    -   Example `settings.json`:
+        ```
+        "aws.dev.logfile": "~/awstoolkit.log",
+        ```
+        then you can tail the logfile in your terminal:
+        ```
+        tail -F ~/awstoolkit.log
+        ```
 -   Use the `AWS (Developer): Watch Logs` command to watch and filter Toolkit logs (including
     telemetry) in VSCode.
     -   Only available if you enabled "dev mode" (`aws.dev.forceDevMode` setting, see above).

buildspec/lint.yml

@@ -26,7 +26,8 @@ phases:
     build:
         commands:
             - export HOME=/home/codebuild-user
-            - npm run testCompile
+            - npm run compile -w packages/core
+            - npm run testCompile -w packages/ --if-present
             - npm run lint
             - VCS_COMMIT_ID="${CODEBUILD_RESOLVED_SOURCE_VERSION}"
             - CI_BUILD_URL=$(echo $CODEBUILD_BUILD_URL | sed 's/#/%23/g') # Encode `#` in the URL because otherwise the url is clipped in the Codecov.io site

buildspec/linuxE2ETests.yml

@@ -41,7 +41,7 @@ phases:
             - VCS_COMMIT_ID="${CODEBUILD_RESOLVED_SOURCE_VERSION}"
             - CI_BUILD_URL=$(echo $CODEBUILD_BUILD_URL | sed 's/#/%23/g')
             - CI_BUILD_ID="${CODEBUILD_BUILD_ID}"
-            - test -n "${CODECOV_TOKEN}" && [ "$TARGET_BRANCH" = "master" ] && ./codecov --token=${CODECOV_TOKEN} --branch=${CODEBUILD_RESOLVED_SOURCE_VERSION} --repository=${CODEBUILD_SOURCE_REPO_URL} --file=./coverage/core/lcov.info --file=./coverage/amazonq/lcov.info --file=./coverage/toolkit/lcov.info
+            - test -n "${CODECOV_TOKEN}" && [ "$TARGET_BRANCH" = "master" ] && ./codecov --token=${CODECOV_TOKEN} --branch=${CODEBUILD_RESOLVED_SOURCE_VERSION} --repository=${CODEBUILD_SOURCE_REPO_URL} --file=./coverage/amazonq/lcov.info --file=./coverage/toolkit/lcov.info
         finally:
             - rm -rf ~/.aws/sso/cache || true
 reports:

buildspec/linuxIntegrationTests.yml

@@ -21,7 +21,7 @@ phases:
     install:
         run-as: root
         runtime-versions:
-            nodejs: 16
+            nodejs: 18
             dotnet: 6.0
             java: latest
 
@@ -75,7 +75,7 @@ phases:
             - VCS_COMMIT_ID="${CODEBUILD_RESOLVED_SOURCE_VERSION}"
             - CI_BUILD_URL=$(echo $CODEBUILD_BUILD_URL | sed 's/#/%23/g')
             - CI_BUILD_ID="${CODEBUILD_BUILD_ID}"
-            - test -n "${CODECOV_TOKEN}" && [ "$TARGET_BRANCH" = "master" ] && ./codecov --token=${CODECOV_TOKEN} --branch=${CODEBUILD_RESOLVED_SOURCE_VERSION} --repository=${CODEBUILD_SOURCE_REPO_URL} --file=./coverage/core/lcov.info --file=./coverage/amazonq/lcov.info --file=./coverage/toolkit/lcov.info
+            - test -n "${CODECOV_TOKEN}" && [ "$TARGET_BRANCH" = "master" ] && ./codecov --token=${CODECOV_TOKEN} --branch=${CODEBUILD_RESOLVED_SOURCE_VERSION} --repository=${CODEBUILD_SOURCE_REPO_URL} --file=./coverage/amazonq/lcov.info --file=./coverage/toolkit/lcov.info
     post_build:
         commands:
             # Destroy .netrc to avoid leaking $GITHUB_READONLY_TOKEN.