node.js.yml

# 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: CI

on:
    push:
        branches: [main]
    pull_request:
        # By default, CI will trigger on opened/synchronize/reopened event types.
        # https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#pull_request
        # Note: To re-run `lint-commits` after fixing the PR title, close-and-reopen the PR.
        branches: [main, feature/*]

permissions:
    contents: read

# Cancel old jobs when a pull request is updated.
concurrency:
    group: ${{ github.head_ref || github.run_id }}
    cancel-in-progress: true

jobs:
    lint-commits:
        # Note: To re-run `lint-commits` after fixing the PR title, close-and-reopen the PR.
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
              with:
                  fetch-depth: 20
            - uses: actions/setup-node@v4
              with:
                  node-version: '20'
            - name: Validate Branch name
              if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref != ''}}
              env:
                  BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
              run: |
                  node "$GITHUB_WORKSPACE/.github/workflows/lintbranch.js" run "$BRANCH_NAME"
            - name: Check PR title
              run: |
                  node "$GITHUB_WORKSPACE/.github/workflows/lintcommit.js"

    lint:
        needs: lint-commits
        runs-on: ubuntu-latest
        strategy:
            matrix:
                node-version: [18.x]
                vscode-version: [stable]
        env:
            NODE_OPTIONS: '--max-old-space-size=8192'
        steps:
            - uses: actions/checkout@v4
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v4
              with:
                  node-version: ${{ matrix.node-version }}
            - run: npm ci
            - run: npm run testCompile
            - run: npm run lint

    lint-duplicate-code:
        needs: lint-commits
        if: false # TODO: Disabled for amazon-q-vscode for now: ${{ github.event_name == 'pull_request'}}
        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
              env:
                  REPO_NAME: ${{ github.event.pull_request.head.repo.full_name }}
              run: |
                  git remote add forkUpstream https://github.com/$REPO_NAME  # URL of the fork
                  git fetch forkUpstream  # Fetch fork

            - name: Merge in target branch to avoid false negatives.
              env:
                  TARGET_BRANCH: ${{ github.event.pull_request.base.ref }}
              # Note: "git merge" should always succeed here, because GHA won't
              # start the job if there are merge conflicts. https://github.com/orgs/community/discussions/11265
              # Also, because `git merge` makes a commit, we need to establish an identity to avoid 'Committer identity unknown' error
              run: |
                  git config --global user.name "aws-toolkit-automation"
                  git config --global user.email "<>"
                  git merge origin/$TARGET_BRANCH

            - name: Compute git diff
              env:
                  CURRENT_BRANCH: ${{ github.head_ref }}
                  TARGET_BRANCH: ${{ github.event.pull_request.base.ref }}
              run: git diff 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: Check for Duplicates
              env:
                  COMMIT_HASH: ${{ github.sha}}
                  REPO_NAME: ${{ github.repository }}
              run: node "$GITHUB_WORKSPACE/.github/workflows/filterDuplicates.js" run diff_output.txt jscpd-report.json $COMMIT_HASH $REPO_NAME

    linux:
        needs: lint-commits
        name: test Linux
        runs-on: ubuntu-latest
        strategy:
            fail-fast: false
            matrix:
                node-version: [18.x]
                vscode-version: [minimum, stable, insiders]
                package: [amazonq]
        env:
            VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}
            NODE_OPTIONS: '--max-old-space-size=8192'
            AWS_TOOLKIT_TEST_CACHE_DIR: '/tmp/.vscode-test/'
            AWS_TOOLKIT_TEST_USER_DIR: '/tmp/.vscode-test/user-data/'
        steps:
            - uses: actions/checkout@v4
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v4
              with:
                  node-version: ${{ matrix.node-version }}
            - run: npm ci
            - name: Tests
              uses: coactions/setup-xvfb@v1
              with:
                  run: npm run test -w packages/${{ matrix.package }}
            - name: Code coverage for ${{ matrix.package }}
              env:
                  # Unset NODE_OPTIONS because of https://github.com/codecov/uploader/issues/475
                  NODE_OPTIONS: ''
              if: ${{ github.repository == 'Amazon-Q-Developer/amazon-q-vscode' && github.event_name == 'pull_request' && github.base_ref == 'main' }}
              uses: codecov/codecov-action@v5
              with:
                  flags: linux-${{ matrix.package }}-unittests
                  verbose: true
                  file: ./coverage/${{ matrix.package }}/lcov.info
                  token: ${{ secrets.CODECOV_TOKEN }}

    macos:
        needs: lint-commits
        name: test macOS
        runs-on: macos-latest
        strategy:
            fail-fast: false
            matrix:
                node-version: [18.x]
                vscode-version: [minimum, stable, insiders]
                package: [amazonq]
        env:
            VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}
            NODE_OPTIONS: '--max-old-space-size=8192'
            AWS_TOOLKIT_TEST_CACHE_DIR: '/tmp/.vscode-test/'
            AWS_TOOLKIT_TEST_USER_DIR: '/tmp/.vscode-test/user-data/'
        steps:
            - uses: actions/checkout@v4
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v4
              with:
                  node-version: ${{ matrix.node-version }}
            - run: npm ci
            - name: Tests
              uses: coactions/setup-xvfb@v1
              with:
                  run: npm run test -w packages/${{ matrix.package }}
            - name: Code coverage for ${{ matrix.package }}
              env:
                  # Unset NODE_OPTIONS because of https://github.com/codecov/uploader/issues/475
                  NODE_OPTIONS: ''
              if: ${{ github.repository == 'Amazon-Q-Developer/amazon-q-vscode' && github.event_name == 'pull_request' && github.base_ref == 'main' }}
              uses: codecov/codecov-action@v5
              with:
                  flags: macos-${{ matrix.package }}-unittests
                  verbose: true
                  file: ./coverage/${{ matrix.package }}/lcov.info
                  token: ${{ secrets.CODECOV_TOKEN }}

    web:
        needs: lint-commits
        name: test Web
        runs-on: ubuntu-latest
        strategy:
            fail-fast: true
            matrix:
                node-version: [18.x]
                vscode-version: [stable, insiders]
        env:
            VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}
            NODE_OPTIONS: '--max-old-space-size=8192'
            AWS_TOOLKIT_TEST_CACHE_DIR: '/tmp/.vscode-test/'
            AWS_TOOLKIT_TEST_USER_DIR: '/tmp/.vscode-test/user-data/'
        steps:
            - uses: actions/checkout@v4
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v4
              with:
                  node-version: ${{ matrix.node-version }}
            - run: npm ci
            - name: Tests
              uses: coactions/setup-xvfb@v1
              with:
                  run: npm run testWeb

    e2e:
        needs: lint-commits
        name: test E2E
        runs-on: ubuntu-latest
        strategy:
            fail-fast: false
            matrix:
                node-version: [18.x]
                vscode-version: [minimum, stable, insiders]
                package: [amazonq]
        env:
            VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}
            NODE_OPTIONS: '--max-old-space-size=8192'
            AWS_TOOLKIT_TEST_CACHE_DIR: '/tmp/.vscode-test/'
            AWS_TOOLKIT_TEST_USER_DIR: '/tmp/.vscode-test/user-data/'
        steps:
            - uses: actions/checkout@v4
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v4
              with:
                  node-version: ${{ matrix.node-version }}
            - run: npm ci
            - name: Increase file watchers
              run: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
            - name: Tests
              uses: coactions/setup-xvfb@v1
              with:
                  run: npm run testE2E -w packages/${{ matrix.package }}
            - name: Upload test reports
              if: always()
              uses: actions/upload-artifact@v4
              with:
                  name: e2e-test-reports-${{ matrix.vscode-version }}
                  path: .test-reports/
            - name: Code coverage for ${{ matrix.package }}
              env:
                  NODE_OPTIONS: ''
              if: ${{ github.repository == 'Amazon-Q-Developer/amazon-q-vscode' && github.event_name == 'pull_request' && github.base_ref == 'main' }}
              uses: codecov/codecov-action@v5
              with:
                  flags: linux-${{ matrix.package }}-e2e
                  verbose: true
                  file: ./coverage/${{ matrix.package }}/lcov.info
                  token: ${{ secrets.CODECOV_TOKEN }}

    package:
        needs: lint-commits
        name: package VSIX
        runs-on: ubuntu-latest
        strategy:
            matrix:
                node-version: [18.x]
        env:
            NODE_OPTIONS: '--max-old-space-size=8192'
        steps:
            - uses: actions/checkout@v4
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v4
              with:
                  node-version: ${{ matrix.node-version }}
            - run: npm ci
            - run: npm run createRelease -w packages/amazonq
            - run: npm run package -w packages/amazonq
            - name: Upload VSIX artifact
              uses: actions/upload-artifact@v4
              with:
                  name: amazonq-vsix
                  path: '*.vsix'

    windows:
        needs: lint-commits
        name: test Windows
        runs-on: windows-latest
        strategy:
            fail-fast: false
            matrix:
                # node-gyp >= 12.1.0 is required to detect Visual Studio 2026, but
                # node-gyp >= 12 requires Node >= 20.17, so this job runs on Node 20.x
                # (the rest of the matrix stays on 18.x). See the node-gyp step below.
                node-version: [20.x]
                vscode-version: [stable, insiders]
                package: [amazonq]
        env:
            VSCODE_TEST_VERSION: ${{ matrix.vscode-version }}
            NODE_OPTIONS: '--max-old-space-size=8192'
        steps:
            - uses: actions/checkout@v4
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v4
              with:
                  node-version: ${{ matrix.node-version }}
            # registry-js (a native dependency) builds via `prebuild-install ||
            # node-gyp rebuild`. npm's bundled node-gyp (v10/11) cannot detect Visual
            # Studio 2026 (version major 18 -> toolset v145); support landed in
            # node-gyp 12.1.0, and the PowerShell VS-detection maxBuffer crash was
            # fixed in 12.3.0 (Add-Type -IgnoreWarnings). npm_config_node_gyp is NOT
            # honored for a package's own install script, and `npm install` inside
            # npm's own dir fails (npm's internal deps aren't public), so install
            # node-gyp@12 in isolation (nested deps = self-contained) and drop it onto
            # the path npm resolves for native builds. node-gyp >= 12 needs Node >=
            # 20.17 (hence Node 20.x above). Remove once npm bundles node-gyp >= 12.1.0.
            - name: Replace npm's bundled node-gyp with v12 (Visual Studio 2026 support)
              shell: bash
              run: |
                  set -eo pipefail
                  WORK=/tmp/ng12
                  rm -rf "$WORK"; mkdir -p "$WORK"
                  ( cd "$WORK" && npm install node-gyp@12 --no-save --no-audit --no-fund --install-strategy=nested )
                  NPM_DIR="$(dirname "$(command -v node)")/node_modules/npm"
                  echo "Bundled npm dir: $NPM_DIR"
                  test -d "$NPM_DIR/node_modules/node-gyp"
                  rm -rf "$NPM_DIR/node_modules/node-gyp"
                  cp -r "$WORK/node_modules/node-gyp" "$NPM_DIR/node_modules/node-gyp"
                  echo "node-gyp version now in use:"
                  node "$NPM_DIR/node_modules/node-gyp/bin/node-gyp.js" --version
            - run: npm ci
            - name: Tests
              run: npm run test -w packages/${{ matrix.package }}
            - name: Code coverage for ${{ matrix.package }}
              env:
                  # Unset NODE_OPTIONS because of https://github.com/codecov/uploader/issues/475
                  NODE_OPTIONS: ''
              if: ${{ github.repository == 'Amazon-Q-Developer/amazon-q-vscode' && github.event_name == 'pull_request' && github.base_ref == 'main' }}
              uses: codecov/codecov-action@v5
              with:
                  flags: windows-${{ matrix.package }}-unittests
                  verbose: true
                  file: ./coverage/${{ matrix.package }}/lcov.info
                  token: ${{ secrets.CODECOV_TOKEN }}