ref: Fix circular dependency checks & setup (#12159) #24469
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: 'CI: Build & Test' | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| - master | |
| - release/** | |
| pull_request: | |
| merge_group: | |
| types: [checks_requested] | |
| workflow_dispatch: | |
| inputs: | |
| commit: | |
| description: If the commit you want to test isn't the head of a branch, provide its SHA here | |
| required: false | |
| schedule: | |
| # Run every day at midnight (without cache) | |
| - cron: '0 0 * * *' | |
| # Cancel in progress workflows on pull_requests. | |
| # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| env: | |
| HEAD_COMMIT: ${{ github.event.inputs.commit || github.sha }} | |
| # WARNING: this disables cross os caching as ~ and | |
| # github.workspace evaluate to differents paths | |
| CACHED_DEPENDENCY_PATHS: | | |
| ${{ github.workspace }}/node_modules | |
| ${{ github.workspace }}/packages/*/node_modules | |
| ${{ github.workspace }}/dev-packages/*/node_modules | |
| ~/.cache/ms-playwright/ | |
| ~/.cache/mongodb-binaries/ | |
| # DEPENDENCY_CACHE_KEY: can't be set here because we don't have access to yarn.lock | |
| # WARNING: this disables cross os caching as ~ and | |
| # github.workspace evaluate to differents paths | |
| # packages/utils/cjs and packages/utils/esm: Symlinks to the folders inside of `build`, needed for tests | |
| CACHED_BUILD_PATHS: | | |
| ${{ github.workspace }}/dev-packages/*/build | |
| ${{ github.workspace }}/packages/*/build | |
| ${{ github.workspace }}/packages/ember/*.d.ts | |
| ${{ github.workspace }}/packages/gatsby/*.d.ts | |
| ${{ github.workspace }}/packages/core/src/version.ts | |
| ${{ github.workspace }}/packages/utils/cjs | |
| ${{ github.workspace }}/packages/utils/esm | |
| BUILD_CACHE_KEY: build-cache-${{ github.event.inputs.commit || github.sha }} | |
| BUILD_CACHE_TARBALL_KEY: tarball-${{ github.event.inputs.commit || github.sha }} | |
| # GH will use the first restore-key it finds that matches | |
| # So it will start by looking for one from the same branch, else take the newest one it can find elsewhere | |
| # We want to prefer the cache from the current develop branch, if we don't find any on the current branch | |
| NX_CACHE_RESTORE_KEYS: | | |
| nx-Linux-${{ github.ref }}-${{ github.event.inputs.commit || github.sha }} | |
| nx-Linux-${{ github.ref }} | |
| nx-Linux | |
| jobs: | |
| job_get_metadata: | |
| name: Get Metadata | |
| runs-on: ubuntu-20.04 | |
| permissions: | |
| pull-requests: read | |
| steps: | |
| - name: Check out current commit | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| # We need to check out not only the fake merge commit between the PR and the base branch which GH creates, but | |
| # also its parents, so that we can pull the commit message from the head commit of the PR | |
| fetch-depth: 2 | |
| - name: Get metadata | |
| id: get_metadata | |
| # We need to try a number of different options for finding the head commit, because each kind of trigger event | |
| # stores it in a different location | |
| run: | | |
| COMMIT_SHA=$(git rev-parse --short ${{ github.event.pull_request.head.sha || github.event.head_commit.id || env.HEAD_COMMIT }}) | |
| echo "COMMIT_SHA=$COMMIT_SHA" >> $GITHUB_ENV | |
| echo "COMMIT_MESSAGE=$(git log -n 1 --pretty=format:%s $COMMIT_SHA)" >> $GITHUB_ENV | |
| - name: Determine changed packages | |
| uses: dorny/[email protected] | |
| id: changed | |
| with: | |
| filters: | | |
| workflow: &workflow | |
| - '.github/**' | |
| shared: &shared | |
| - *workflow | |
| - '*.{js,ts,json,yml,lock}' | |
| - 'CHANGELOG.md' | |
| - 'jest/**' | |
| - 'scripts/**' | |
| - 'packages/core/**' | |
| - 'packages/rollup-utils/**' | |
| - 'packages/utils/**' | |
| - 'packages/types/**' | |
| browser: &browser | |
| - *shared | |
| - 'packages/browser/**' | |
| - 'packages/browser-utils/**' | |
| - 'packages/replay/**' | |
| - 'packages/replay-canvas/**' | |
| - 'packages/feedback/**' | |
| - 'packages/wasm/**' | |
| browser_integration: | |
| - *shared | |
| - *browser | |
| - 'dev-packages/browser-integration-tests/**' | |
| ember: | |
| - *shared | |
| - *browser | |
| - 'packages/ember/**' | |
| node: | |
| - *shared | |
| - 'packages/node/**' | |
| - 'dev-packages/node-integration-tests/**' | |
| nextjs: | |
| - *shared | |
| - *browser | |
| - 'packages/nextjs/**' | |
| - 'packages/node/**' | |
| - 'packages/react/**' | |
| remix: | |
| - *shared | |
| - *browser | |
| - 'packages/remix/**' | |
| - 'packages/node/**' | |
| - 'packages/react/**' | |
| profiling_node: | |
| - *shared | |
| - 'packages/node/**' | |
| - 'packages/profiling-node/**' | |
| - 'dev-packages/e2e-tests/test-applications/node-profiling/**' | |
| profiling_node_bindings: | |
| - 'packages/profiling-node/**' | |
| - 'dev-packages/e2e-tests/test-applications/node-profiling/**' | |
| deno: | |
| - *shared | |
| - *browser | |
| - 'packages/deno/**' | |
| any_code: | |
| - '!**/*.md' | |
| - name: Get PR labels | |
| id: pr-labels | |
| uses: mydea/pr-labels-action@fn/bump-node20 | |
| outputs: | |
| commit_label: '${{ env.COMMIT_SHA }}: ${{ env.COMMIT_MESSAGE }}' | |
| changed_nextjs: ${{ steps.changed.outputs.nextjs }} | |
| changed_ember: ${{ steps.changed.outputs.ember }} | |
| changed_remix: ${{ steps.changed.outputs.remix }} | |
| changed_node: ${{ steps.changed.outputs.node }} | |
| changed_profiling_node: ${{ steps.changed.outputs.profiling_node }} | |
| changed_profiling_node_bindings: ${{ steps.changed.outputs.profiling_node_bindings }} | |
| changed_deno: ${{ steps.changed.outputs.deno }} | |
| changed_browser: ${{ steps.changed.outputs.browser }} | |
| changed_browser_integration: ${{ steps.changed.outputs.browser_integration }} | |
| changed_any_code: ${{ steps.changed.outputs.any_code }} | |
| # Note: These next three have to be checked as strings ('true'/'false')! | |
| is_develop: ${{ github.ref == 'refs/heads/develop' }} | |
| is_release: ${{ startsWith(github.ref, 'refs/heads/release/') }} | |
| # When merging into master, or from master | |
| is_gitflow_sync: ${{ github.head_ref == 'master' || github.ref == 'refs/heads/master' }} | |
| has_gitflow_label: | |
| ${{ github.event_name == 'pull_request' && contains(steps.pr-labels.outputs.labels, ' Gitflow ') }} | |
| force_skip_cache: | |
| ${{ github.event_name == 'schedule' || (github.event_name == 'pull_request' && | |
| contains(steps.pr-labels.outputs.labels, ' ci-skip-cache ')) }} | |
| job_install_deps: | |
| name: Install Dependencies | |
| needs: job_get_metadata | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 15 | |
| if: | | |
| (needs.job_get_metadata.outputs.is_gitflow_sync == 'false' && needs.job_get_metadata.outputs.has_gitflow_label == 'false') | |
| steps: | |
| - name: 'Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})' | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| # we use a hash of yarn.lock as our cache key, because if it hasn't changed, our dependencies haven't changed, | |
| # so no need to reinstall them | |
| - name: Compute dependency cache key | |
| id: compute_lockfile_hash | |
| run: echo "hash=${{ hashFiles('yarn.lock', '**/package.json') }}" >> "$GITHUB_OUTPUT" | |
| - name: Check dependency cache | |
| uses: actions/cache@v4 | |
| id: cache_dependencies | |
| with: | |
| path: ${{ env.CACHED_DEPENDENCY_PATHS }} | |
| key: ${{ steps.compute_lockfile_hash.outputs.hash }} | |
| - name: Install dependencies | |
| if: steps.cache_dependencies.outputs.cache-hit != 'true' | |
| run: yarn install --ignore-engines --frozen-lockfile | |
| outputs: | |
| dependency_cache_key: ${{ steps.compute_lockfile_hash.outputs.hash }} | |
| job_check_branches: | |
| name: Check PR branches | |
| needs: job_get_metadata | |
| runs-on: ubuntu-20.04 | |
| if: github.event_name == 'pull_request' | |
| permissions: | |
| pull-requests: write | |
| steps: | |
| - name: PR is opened against master | |
| uses: mshick/add-pr-comment@dd126dd8c253650d181ad9538d8b4fa218fc31e8 | |
| if: ${{ github.base_ref == 'master' && !startsWith(github.head_ref, 'prepare-release/') }} | |
| with: | |
| message: | | |
| ⚠️ This PR is opened against **master**. You probably want to open it against **develop**. | |
| job_build: | |
| name: Build | |
| needs: [job_get_metadata, job_install_deps] | |
| runs-on: ubuntu-20.04-large-js | |
| timeout-minutes: 30 | |
| if: | | |
| (needs.job_get_metadata.outputs.changed_any_code == 'true' || github.event_name != 'pull_request') | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Check dependency cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ env.CACHED_DEPENDENCY_PATHS }} | |
| key: ${{ needs.job_install_deps.outputs.dependency_cache_key }} | |
| fail-on-cache-miss: true | |
| - name: Check build cache | |
| uses: actions/cache@v4 | |
| id: cache_built_packages | |
| with: | |
| path: ${{ env.CACHED_BUILD_PATHS }} | |
| key: ${{ env.BUILD_CACHE_KEY }} | |
| - name: NX cache | |
| uses: actions/cache@v4 | |
| # Disable cache when: | |
| # - on release branches | |
| # - when PR has `ci-skip-cache` label or on nightly builds | |
| if: | | |
| needs.job_get_metadata.outputs.is_release == 'false' && | |
| needs.job_get_metadata.outputs.force_skip_cache == 'false' | |
| with: | |
| path: .nxcache | |
| key: nx-Linux-${{ github.ref }}-${{ env.HEAD_COMMIT || github.sha }} | |
| # On develop branch, we want to _store_ the cache (so it can be used by other branches), but never _restore_ from it | |
| restore-keys: | |
| ${{needs.job_get_metadata.outputs.is_develop == 'false' && env.NX_CACHE_RESTORE_KEYS || 'nx-never-restore'}} | |
| - name: Build packages | |
| # Set the CODECOV_TOKEN for Bundle Analysis | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| run: yarn build | |
| outputs: | |
| # this needs to be passed on, because the `needs` context only looks at direct ancestors (so steps which depend on | |
| # `job_build` can't see `job_install_deps` and what it returned) | |
| dependency_cache_key: ${{ needs.job_install_deps.outputs.dependency_cache_key }} | |
| job_size_check: | |
| name: Size Check | |
| needs: [job_get_metadata, job_build] | |
| timeout-minutes: 15 | |
| runs-on: ubuntu-20.04 | |
| if: | |
| github.event_name == 'pull_request' || needs.job_get_metadata.outputs.is_develop == 'true' || | |
| needs.job_get_metadata.outputs.is_release == 'true' | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Check bundle sizes | |
| uses: ./dev-packages/size-limit-gh-action | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # Only run comparison against develop if this is a PR | |
| comparison_branch: ${{ (github.event_name == 'pull_request' && github.base_ref) || ''}} | |
| job_lint: | |
| name: Lint | |
| # Even though the linter only checks source code, not built code, it needs the built code in order check that all | |
| # inter-package dependencies resolve cleanly. | |
| needs: [job_get_metadata, job_build] | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Lint source files | |
| run: yarn lint:lerna | |
| - name: Lint C++ files | |
| run: yarn lint:clang | |
| job_check_format: | |
| name: Check file formatting | |
| needs: [job_get_metadata, job_install_deps] | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Check dependency cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ env.CACHED_DEPENDENCY_PATHS }} | |
| key: ${{ needs.job_install_deps.outputs.dependency_cache_key }} | |
| fail-on-cache-miss: true | |
| - name: Check file formatting | |
| run: yarn lint:prettier && yarn lint:biome | |
| job_circular_dep_check: | |
| name: Circular Dependency Check | |
| needs: [job_get_metadata, job_build] | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Run madge | |
| run: yarn circularDepCheck | |
| job_artifacts: | |
| name: Upload Artifacts | |
| needs: [job_get_metadata, job_build, job_compile_bindings_profiling_node] | |
| runs-on: ubuntu-20.04 | |
| # Build artifacts are only needed for releasing workflow. | |
| if: needs.job_get_metadata.outputs.is_release == 'true' | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Extract Profiling Node Prebuilt Binaries | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: profiling-node-binaries-${{ github.sha }} | |
| path: ${{ github.workspace }}/packages/profiling-node/lib/ | |
| - name: Pack tarballs | |
| run: yarn build:tarball | |
| - name: Archive artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ github.sha }} | |
| path: | | |
| ${{ github.workspace }}/packages/browser/build/bundles/** | |
| ${{ github.workspace }}/packages/replay/build/bundles/** | |
| ${{ github.workspace }}/packages/replay-canvas/build/bundles/** | |
| ${{ github.workspace }}/packages/feedback/build/bundles/** | |
| ${{ github.workspace }}/packages/**/*.tgz | |
| ${{ github.workspace }}/packages/aws-serverless/build/aws/dist-serverless/*.zip | |
| job_browser_unit_tests: | |
| name: Browser Unit Tests | |
| needs: [job_get_metadata, job_build] | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Run tests | |
| env: | |
| NODE_VERSION: 16 | |
| run: yarn test-ci-browser | |
| - name: Compute test coverage | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| job_bun_unit_tests: | |
| name: Bun Unit Tests | |
| needs: [job_get_metadata, job_build] | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-20.04 | |
| strategy: | |
| fail-fast: false | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Set up Bun | |
| uses: oven-sh/setup-bun@v1 | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Run tests | |
| run: | | |
| yarn test-ci-bun | |
| job_deno_unit_tests: | |
| name: Deno Unit Tests | |
| needs: [job_get_metadata, job_build] | |
| if: needs.job_get_metadata.outputs.changed_deno == 'true' || github.event_name != 'pull_request' | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-20.04 | |
| strategy: | |
| fail-fast: false | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Set up Deno | |
| uses: denoland/[email protected] | |
| with: | |
| deno-version: v1.38.5 | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Run tests | |
| run: | | |
| cd packages/deno | |
| yarn build | |
| yarn test | |
| job_node_unit_tests: | |
| name: Node (${{ matrix.node }}) Unit Tests | |
| needs: [job_get_metadata, job_build] | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-20.04 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| node: [14, 16, 18, 20, 22] | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Run tests | |
| env: | |
| NODE_VERSION: ${{ matrix.node }} | |
| run: yarn test-ci-node | |
| - name: Compute test coverage | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| job_profiling_node_unit_tests: | |
| name: Node Profiling Unit Tests | |
| needs: [job_get_metadata, job_build] | |
| if: needs.job_get_metadata.outputs.changed_node == 'true' || needs.job_get_metadata.outputs.changed_profiling_node == 'true' || github.event_name != 'pull_request' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Check out current commit | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11.7' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Build Configure node-gyp | |
| run: yarn lerna run build:bindings:configure --scope @sentry/profiling-node | |
| - name: Build Bindings for Current Environment | |
| run: yarn build --scope @sentry/profiling-node | |
| - name: Unit Test | |
| run: yarn lerna run test --scope @sentry/profiling-node | |
| job_nextjs_integration_test: | |
| name: Nextjs (Node ${{ matrix.node }}) Tests | |
| needs: [job_get_metadata, job_build] | |
| if: needs.job_get_metadata.outputs.changed_nextjs == 'true' || github.event_name != 'pull_request' | |
| timeout-minutes: 25 | |
| runs-on: ubuntu-20.04 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| node: [14, 16, 18, 20, 22] | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Get npm cache directory | |
| id: npm-cache-dir | |
| run: echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT | |
| - name: Get Playwright version | |
| id: playwright-version | |
| run: echo "version=$(node -p "require('@playwright/test/package.json').version")" >> $GITHUB_OUTPUT | |
| - uses: actions/cache@v4 | |
| name: Check if Playwright browser is cached | |
| id: playwright-cache | |
| with: | |
| path: ${{ steps.npm-cache-dir.outputs.dir }} | |
| key: ${{ runner.os }}-Playwright-${{steps.playwright-version.outputs.version}} | |
| - name: Install Playwright browser if not cached | |
| if: steps.playwright-cache.outputs.cache-hit != 'true' | |
| run: npx playwright install --with-deps | |
| env: | |
| PLAYWRIGHT_BROWSERS_PATH: ${{steps.npm-cache-dir.outputs.dir}} | |
| - name: Install OS dependencies of Playwright if cache hit | |
| if: steps.playwright-cache.outputs.cache-hit == 'true' | |
| run: npx playwright install-deps | |
| - name: Run tests | |
| env: | |
| NODE_VERSION: ${{ matrix.node }} | |
| run: | | |
| cd packages/nextjs | |
| yarn test:integration | |
| job_browser_playwright_tests: | |
| name: Playwright (${{ matrix.bundle }}${{ matrix.shard && format(' {0}/{1}', matrix.shard, matrix.shards) || ''}}) Tests | |
| needs: [job_get_metadata, job_build] | |
| if: needs.job_get_metadata.outputs.changed_browser_integration == 'true' || github.event_name != 'pull_request' | |
| runs-on: ubuntu-20.04-large-js | |
| timeout-minutes: 25 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| bundle: | |
| - esm | |
| - bundle | |
| - bundle_min | |
| - bundle_replay | |
| - bundle_tracing | |
| - bundle_tracing_replay | |
| - bundle_tracing_replay_feedback | |
| - bundle_tracing_replay_feedback_min | |
| project: | |
| - chromium | |
| include: | |
| # Only check all projects for esm & full bundle | |
| # We also shard the tests as they take the longest | |
| - bundle: bundle_tracing_replay_feedback_min | |
| project: '' | |
| shard: 1 | |
| shards: 2 | |
| - bundle: bundle_tracing_replay_feedback_min | |
| project: '' | |
| shard: 2 | |
| shards: 2 | |
| - bundle: esm | |
| project: '' | |
| shard: 1 | |
| shards: 3 | |
| - bundle: esm | |
| shard: 2 | |
| shards: 3 | |
| - bundle: esm | |
| project: '' | |
| shard: 3 | |
| shards: 3 | |
| exclude: | |
| # Do not run the default chromium-only tests | |
| - bundle: bundle_tracing_replay_feedback_min | |
| project: 'chromium' | |
| - bundle: esm | |
| project: 'chromium' | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Get npm cache directory | |
| id: npm-cache-dir | |
| run: echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT | |
| - name: Get Playwright version | |
| id: playwright-version | |
| run: echo "version=$(node -p "require('@playwright/test/package.json').version")" >> $GITHUB_OUTPUT | |
| - uses: actions/cache@v4 | |
| name: Check if Playwright browser is cached | |
| id: playwright-cache | |
| with: | |
| path: ${{ steps.npm-cache-dir.outputs.dir }} | |
| key: ${{ runner.os }}-Playwright-${{steps.playwright-version.outputs.version}} | |
| - name: Install Playwright browser if not cached | |
| if: steps.playwright-cache.outputs.cache-hit != 'true' | |
| run: npx playwright install --with-deps | |
| env: | |
| PLAYWRIGHT_BROWSERS_PATH: ${{steps.npm-cache-dir.outputs.dir}} | |
| - name: Install OS dependencies of Playwright if cache hit | |
| if: steps.playwright-cache.outputs.cache-hit == 'true' | |
| run: npx playwright install-deps | |
| - name: Run Playwright tests | |
| env: | |
| PW_BUNDLE: ${{ matrix.bundle }} | |
| working-directory: dev-packages/browser-integration-tests | |
| run: yarn test:ci${{ matrix.project && format(' --project={0}', matrix.project) || '' }}${{ matrix.shard && format(' --shard={0}/{1}', matrix.shard, matrix.shards) || '' }} | |
| - name: Upload Playwright Traces | |
| uses: actions/upload-artifact@v3 | |
| if: always() | |
| with: | |
| name: playwright-traces | |
| path: dev-packages/browser-integration-tests/test-results | |
| job_browser_loader_tests: | |
| name: Playwright Loader (${{ matrix.bundle }}) Tests | |
| needs: [job_get_metadata, job_build] | |
| if: needs.job_get_metadata.outputs.changed_browser_integration == 'true' || github.event_name != 'pull_request' | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 15 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| bundle: | |
| - loader_base | |
| - loader_eager | |
| - loader_debug | |
| - loader_tracing | |
| - loader_replay | |
| - loader_tracing_replay | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Get npm cache directory | |
| id: npm-cache-dir | |
| run: echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT | |
| - name: Get Playwright version | |
| id: playwright-version | |
| run: echo "version=$(node -p "require('@playwright/test/package.json').version")" >> $GITHUB_OUTPUT | |
| - uses: actions/cache@v4 | |
| name: Check if Playwright browser is cached | |
| id: playwright-cache | |
| with: | |
| path: ${{ steps.npm-cache-dir.outputs.dir }} | |
| key: ${{ runner.os }}-Playwright-${{steps.playwright-version.outputs.version}} | |
| - name: Install Playwright browser if not cached | |
| if: steps.playwright-cache.outputs.cache-hit != 'true' | |
| run: npx playwright install --with-deps | |
| env: | |
| PLAYWRIGHT_BROWSERS_PATH: ${{steps.npm-cache-dir.outputs.dir}} | |
| - name: Install OS dependencies of Playwright if cache hit | |
| if: steps.playwright-cache.outputs.cache-hit == 'true' | |
| run: npx playwright install-deps | |
| - name: Run Playwright Loader tests | |
| env: | |
| PW_BUNDLE: ${{ matrix.bundle }} | |
| run: | | |
| cd dev-packages/browser-integration-tests | |
| yarn test:loader | |
| - name: Upload Playwright Traces | |
| uses: actions/upload-artifact@v3 | |
| if: always() | |
| with: | |
| name: playwright-traces | |
| path: dev-packages/browser-integration-tests/test-results | |
| job_browser_build_tests: | |
| name: Browser Build Tests | |
| needs: [job_get_metadata, job_build] | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Run browser build tests | |
| run: | | |
| cd packages/browser | |
| yarn test:package | |
| - name: Run utils build tests | |
| run: | | |
| cd packages/utils | |
| yarn test:package | |
| job_check_for_faulty_dts: | |
| name: Check for faulty .d.ts files | |
| needs: [job_get_metadata, job_build] | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Check for dts files that reference stuff in the temporary build folder | |
| run: | | |
| if grep -r --include "*.d.ts" --exclude-dir ".nxcache" 'import("@sentry(-internal)?/[^/]*/build' .; then | |
| echo "Found illegal TypeScript import statement." | |
| exit 1 | |
| fi | |
| job_node_integration_tests: | |
| name: | |
| Node (${{ matrix.node }})${{ (matrix.typescript && format(' (TS {0})', matrix.typescript)) || '' }} Integration | |
| Tests | |
| needs: [job_get_metadata, job_build] | |
| if: needs.job_get_metadata.outputs.changed_node == 'true' || github.event_name != 'pull_request' | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 15 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| node: [14, 16, 18, 20, 22] | |
| typescript: | |
| - false | |
| include: | |
| # Only check typescript for latest version (to streamline CI) | |
| - node: 22 | |
| typescript: '3.8' | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Overwrite typescript version | |
| if: matrix.typescript | |
| run: yarn add --dev --ignore-workspace-root-check typescript@${{ matrix.typescript }} | |
| - name: Run integration tests | |
| env: | |
| NODE_VERSION: ${{ matrix.node }} | |
| TS_VERSION: ${{ matrix.typescript }} | |
| run: | | |
| cd dev-packages/node-integration-tests | |
| yarn test | |
| job_remix_integration_tests: | |
| name: Remix v${{ matrix.remix }} (Node ${{ matrix.node }}) Tests | |
| needs: [job_get_metadata, job_build] | |
| if: needs.job_get_metadata.outputs.changed_remix == 'true' || github.event_name != 'pull_request' | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 10 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| node: [18, 20, 22] | |
| remix: [1, 2] | |
| # Remix v2 only supports Node 18+, so run Node 14, 16 tests separately | |
| include: | |
| - node: 14 | |
| remix: 1 | |
| - node: 16 | |
| remix: 1 | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Run integration tests | |
| env: | |
| NODE_VERSION: ${{ matrix.node }} | |
| REMIX_VERSION: ${{ matrix.remix }} | |
| run: | | |
| cd packages/remix | |
| yarn test:integration:ci | |
| job_e2e_prepare: | |
| name: Prepare E2E tests | |
| # We want to run this if: | |
| # - The build job was successful, not skipped | |
| # - AND if the profiling node bindings were either successful or skipped | |
| if: | | |
| always() && needs.job_build.result == 'success' && | |
| (needs.job_compile_bindings_profiling_node.result == 'success' || needs.job_compile_bindings_profiling_node.result == 'skipped') && | |
| (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository) | |
| needs: [job_get_metadata, job_build, job_compile_bindings_profiling_node] | |
| runs-on: ubuntu-20.04-large-js | |
| timeout-minutes: 15 | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: NX cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: .nxcache | |
| key: nx-Linux-${{ github.ref }}-${{ env.HEAD_COMMIT }} | |
| # On develop branch, we want to _store_ the cache (so it can be used by other branches), but never _restore_ from it | |
| restore-keys: ${{ env.NX_CACHE_RESTORE_KEYS }} | |
| # Rebuild profiling by compiling TS and pull the precompiled binary artifacts | |
| - name: Build Profiling Node | |
| if: | | |
| (needs.job_get_metadata.outputs.changed_profiling_node_bindings == 'true') || | |
| (needs.job_get_metadata.outputs.is_release == 'true') || | |
| (github.event_name != 'pull_request') | |
| run: yarn lerna run build:lib --scope @sentry/profiling-node | |
| - name: Extract Profiling Node Prebuilt Binaries | |
| # @TODO: v4 breaks convenient merging of same name artifacts | |
| # https://github.com/actions/upload-artifact/issues/478 | |
| if: | | |
| (needs.job_get_metadata.outputs.changed_profiling_node_bindings == 'true') || | |
| (needs.job_get_metadata.outputs.is_release == 'true') || | |
| (github.event_name != 'pull_request') | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: profiling-node-binaries-${{ github.sha }} | |
| path: ${{ github.workspace }}/packages/profiling-node/lib/ | |
| - name: Build Profiling tarball | |
| run: yarn build:tarball | |
| # End rebuild profiling | |
| - name: Stores tarballs in cache | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: ${{ github.workspace }}/packages/*/*.tgz | |
| key: ${{ env.BUILD_CACHE_TARBALL_KEY }} | |
| job_e2e_tests: | |
| name: E2E ${{ matrix.label || matrix.test-application }} Test | |
| # We only run E2E tests for non-fork PRs because the E2E tests require secrets to work and they can't be accessed from forks | |
| # We need to add the `always()` check here because the previous step has this as well :( | |
| # See: https://github.com/actions/runner/issues/2205 | |
| if: | |
| always() && needs.job_e2e_prepare.result == 'success' && | |
| (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository) | |
| needs: [job_get_metadata, job_build, job_e2e_prepare] | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 10 | |
| env: | |
| E2E_TEST_AUTH_TOKEN: ${{ secrets.E2E_TEST_AUTH_TOKEN }} | |
| E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }} | |
| # Needed because some apps expect a certain prefix | |
| NEXT_PUBLIC_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }} | |
| PUBLIC_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }} | |
| REACT_APP_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }} | |
| E2E_TEST_SENTRY_ORG_SLUG: 'sentry-javascript-sdks' | |
| E2E_TEST_SENTRY_TEST_PROJECT: 'sentry-javascript-e2e-tests' | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| is_dependabot: | |
| - ${{ github.actor == 'dependabot[bot]' }} | |
| test-application: | |
| [ | |
| 'angular-17', | |
| 'cloudflare-astro', | |
| 'node-express', | |
| 'create-react-app', | |
| 'create-next-app', | |
| 'create-remix-app', | |
| 'create-remix-app-v2', | |
| 'create-remix-app-express', | |
| 'create-remix-app-express-vite-dev', | |
| 'debug-id-sourcemaps', | |
| 'node-express-esm-loader', | |
| 'node-express-esm-without-loader', | |
| 'nextjs-app-dir', | |
| 'nextjs-14', | |
| 'react-create-hash-router', | |
| 'react-router-6-use-routes', | |
| 'react-router-5', | |
| 'standard-frontend-react', | |
| 'svelte-5', | |
| 'sveltekit', | |
| 'sveltekit-2', | |
| 'sveltekit-2-svelte-5', | |
| 'generic-ts3.8', | |
| 'node-fastify', | |
| 'node-hapi', | |
| 'node-nestjs', | |
| 'node-exports-test-app', | |
| 'node-koa', | |
| 'node-connect', | |
| 'vue-3', | |
| 'webpack-4', | |
| 'webpack-5' | |
| ] | |
| build-command: | |
| - false | |
| label: | |
| - false | |
| # Add any variations of a test app here | |
| # You should provide an alternate build-command as well as a matching label | |
| include: | |
| - test-application: 'create-react-app' | |
| build-command: 'test:build-ts3.8' | |
| label: 'create-react-app (TS 3.8)' | |
| - test-application: 'standard-frontend-react' | |
| build-command: 'test:build-ts3.8' | |
| label: 'standard-frontend-react (TS 3.8)' | |
| - test-application: 'create-next-app' | |
| build-command: 'test:build-13' | |
| label: 'create-next-app (next@13)' | |
| - test-application: 'nextjs-app-dir' | |
| build-command: 'test:build-13' | |
| label: 'nextjs-app-dir (next@13)' | |
| exclude: | |
| - is_dependabot: true | |
| test-application: 'cloudflare-astro' | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - uses: pnpm/action-setup@v2 | |
| with: | |
| version: 8.3.1 | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'dev-packages/e2e-tests/package.json' | |
| - name: Set up Bun | |
| if: matrix.test-application == 'node-exports-test-app' | |
| uses: oven-sh/setup-bun@v1 | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Restore tarball cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/packages/*/*.tgz | |
| key: ${{ env.BUILD_CACHE_TARBALL_KEY }} | |
| - name: Get node version | |
| id: versions | |
| run: | | |
| echo "echo node=$(jq -r '.volta.node' dev-packages/e2e-tests/package.json)" >> $GITHUB_OUTPUT | |
| - name: Validate Verdaccio | |
| run: yarn test:validate | |
| working-directory: dev-packages/e2e-tests | |
| - name: Prepare Verdaccio | |
| run: yarn test:prepare | |
| working-directory: dev-packages/e2e-tests | |
| env: | |
| E2E_TEST_PUBLISH_SCRIPT_NODE_VERSION: ${{ steps.versions.outputs.node }} | |
| - name: Build E2E app | |
| working-directory: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }} | |
| timeout-minutes: 5 | |
| run: yarn ${{ matrix.build-command || 'test:build' }} | |
| - name: Run E2E test | |
| working-directory: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }} | |
| timeout-minutes: 5 | |
| run: yarn test:assert | |
| - name: Deploy Astro to Cloudflare | |
| uses: cloudflare/pages-action@v1 | |
| if: matrix.test-application == 'cloudflare-astro' | |
| with: | |
| apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} | |
| accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} | |
| projectName: ${{ secrets.CLOUDFLARE_PROJECT_NAME }} | |
| directory: dist | |
| workingDirectory: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }} | |
| job_profiling_e2e_tests: | |
| name: E2E ${{ matrix.label || matrix.test-application }} Test | |
| # We only run E2E tests for non-fork PRs because the E2E tests require secrets to work and they can't be accessed from forks | |
| # Dependabot specifically also has access to secrets | |
| # We need to add the `always()` check here because the previous step has this as well :( | |
| # See: https://github.com/actions/runner/issues/2205 | |
| if: | |
| # Only run profiling e2e tests if profiling node bindings have changed | |
| always() && needs.job_e2e_prepare.result == 'success' && | |
| (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository) && | |
| ( | |
| (needs.job_get_metadata.outputs.changed_profiling_node_bindings == 'true') || | |
| (needs.job_get_metadata.outputs.is_release == 'true') || | |
| (github.event_name != 'pull_request') | |
| ) | |
| needs: [job_get_metadata, job_build, job_e2e_prepare] | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 10 | |
| env: | |
| E2E_TEST_AUTH_TOKEN: ${{ secrets.E2E_TEST_AUTH_TOKEN }} | |
| E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }} | |
| E2E_TEST_SENTRY_ORG_SLUG: 'sentry-javascript-sdks' | |
| E2E_TEST_SENTRY_TEST_PROJECT: 'sentry-javascript-e2e-tests' | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| test-application: ['node-profiling'] | |
| build-command: | |
| - false | |
| label: | |
| - false | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - uses: pnpm/action-setup@v2 | |
| with: | |
| version: 8.3.1 | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'dev-packages/e2e-tests/package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Build Profiling Node | |
| run: yarn lerna run build:lib --scope @sentry/profiling-node | |
| - name: Extract Profiling Node Prebuilt Binaries | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: profiling-node-binaries-${{ github.sha }} | |
| path: ${{ github.workspace }}/packages/profiling-node/lib/ | |
| - name: Restore tarball cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/packages/*/*.tgz | |
| key: ${{ env.BUILD_CACHE_TARBALL_KEY }} | |
| fail-on-cache-miss : true | |
| - name: Get node version | |
| id: versions | |
| run: | | |
| echo "echo node=$(jq -r '.volta.node' dev-packages/e2e-tests/package.json)" >> $GITHUB_OUTPUT | |
| - name: Validate Verdaccio | |
| run: yarn test:validate | |
| working-directory: dev-packages/e2e-tests | |
| - name: Prepare Verdaccio | |
| run: yarn test:prepare | |
| working-directory: dev-packages/e2e-tests | |
| env: | |
| E2E_TEST_PUBLISH_SCRIPT_NODE_VERSION: ${{ steps.versions.outputs.node }} | |
| - name: Build E2E app | |
| working-directory: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }} | |
| timeout-minutes: 5 | |
| run: yarn ${{ matrix.build-command || 'test:build' }} | |
| - name: Run E2E test | |
| working-directory: dev-packages/e2e-tests/test-applications/${{ matrix.test-application }} | |
| timeout-minutes: 5 | |
| run: yarn test:assert | |
| job_required_jobs_passed: | |
| name: All required jobs passed or were skipped | |
| needs: | |
| [ | |
| job_build, | |
| job_compile_bindings_profiling_node, | |
| job_browser_build_tests, | |
| job_browser_unit_tests, | |
| job_bun_unit_tests, | |
| job_deno_unit_tests, | |
| job_node_unit_tests, | |
| job_profiling_node_unit_tests, | |
| job_nextjs_integration_test, | |
| job_node_integration_tests, | |
| job_browser_playwright_tests, | |
| job_browser_loader_tests, | |
| job_remix_integration_tests, | |
| job_e2e_tests, | |
| job_profiling_e2e_tests, | |
| job_artifacts, | |
| job_lint, | |
| job_check_format, | |
| job_circular_dep_check, | |
| ] | |
| # Always run this, even if a dependent job failed | |
| if: always() | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Check for failures | |
| if: contains(needs.*.result, 'failure') | |
| run: | | |
| echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1 | |
| overhead_metrics: | |
| name: Overhead metrics | |
| needs: [job_get_metadata, job_build] | |
| runs-on: ubuntu-20.04 | |
| timeout-minutes: 30 | |
| if: | | |
| contains(github.event.pull_request.labels.*.name, 'ci-overhead-measurements') | |
| steps: | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: 'package.json' | |
| - name: Restore caches | |
| uses: ./.github/actions/restore-cache | |
| env: | |
| DEPENDENCY_CACHE_KEY: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| - name: Collect | |
| run: yarn ci:collect | |
| working-directory: dev-packages/overhead-metrics | |
| - name: Process | |
| id: process | |
| run: yarn ci:process | |
| working-directory: dev-packages/overhead-metrics | |
| # Don't run on forks - the PR comment cannot be added. | |
| if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| - name: Upload results | |
| uses: actions/upload-artifact@v4 | |
| if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository | |
| with: | |
| name: ${{ steps.process.outputs.artifactName }} | |
| path: ${{ steps.process.outputs.artifactPath }} | |
| job_compile_bindings_profiling_node: | |
| name: Compile & Test Profiling Bindings (v${{ matrix.node }}) ${{ matrix.target_platform || matrix.os }}, ${{ matrix.node || matrix.container }}, ${{ matrix.arch || matrix.container }}, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc' }} | |
| needs: [job_get_metadata, job_install_deps, job_build] | |
| # Compiling bindings can be very slow (especially on windows), so only run precompile | |
| # Skip precompile unless we are on a release branch as precompile slows down CI times. | |
| if: | | |
| (needs.job_get_metadata.outputs.changed_profiling_node_bindings == 'true') || | |
| (needs.job_get_metadata.outputs.is_release == 'true') || | |
| (github.event_name != 'pull_request') | |
| runs-on: ${{ matrix.os }} | |
| container: ${{ matrix.container }} | |
| timeout-minutes: 30 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| # x64 glibc | |
| - os: ubuntu-20.04 | |
| node: 16 | |
| - os: ubuntu-20.04 | |
| node: 18 | |
| - os: ubuntu-20.04 | |
| node: 20 | |
| - os: ubuntu-20.04 | |
| node: 22 | |
| # x64 musl | |
| - os: ubuntu-20.04 | |
| container: node:16-alpine3.16 | |
| node: 16 | |
| - os: ubuntu-20.04 | |
| container: node:18-alpine3.17 | |
| node: 18 | |
| - os: ubuntu-20.04 | |
| container: node:20-alpine3.17 | |
| node: 20 | |
| - os: ubuntu-20.04 | |
| container: node:22-alpine3.18 | |
| node: 22 | |
| # arm64 glibc | |
| - os: ubuntu-20.04 | |
| arch: arm64 | |
| node: 16 | |
| - os: ubuntu-20.04 | |
| arch: arm64 | |
| node: 18 | |
| - os: ubuntu-20.04 | |
| arch: arm64 | |
| node: 20 | |
| - os: ubuntu-20.04 | |
| arch: arm64 | |
| node: 22 | |
| # arm64 musl | |
| - os: ubuntu-20.04 | |
| container: node:16-alpine3.16 | |
| arch: arm64 | |
| node: 16 | |
| - os: ubuntu-20.04 | |
| arch: arm64 | |
| container: node:18-alpine3.17 | |
| node: 18 | |
| - os: ubuntu-20.04 | |
| arch: arm64 | |
| container: node:20-alpine3.17 | |
| node: 20 | |
| - os: ubuntu-20.04 | |
| arch: arm64 | |
| container: node:22-alpine3.18 | |
| node: 22 | |
| # macos x64 | |
| - os: macos-11 | |
| node: 16 | |
| arch: x64 | |
| - os: macos-11 | |
| node: 18 | |
| arch: x64 | |
| - os: macos-11 | |
| node: 20 | |
| arch: x64 | |
| - os: macos-11 | |
| node: 22 | |
| arch: x64 | |
| # macos arm64 | |
| - os: macos-12 | |
| arch: arm64 | |
| node: 16 | |
| target_platform: darwin | |
| - os: macos-12 | |
| arch: arm64 | |
| node: 18 | |
| target_platform: darwin | |
| - os: macos-12 | |
| arch: arm64 | |
| node: 20 | |
| target_platform: darwin | |
| - os: macos-12 | |
| arch: arm64 | |
| node: 22 | |
| target_platform: darwin | |
| # windows x64 | |
| - os: windows-2022 | |
| node: 16 | |
| arch: x64 | |
| - os: windows-2022 | |
| node: 18 | |
| arch: x64 | |
| - os: windows-2022 | |
| node: 20 | |
| arch: x64 | |
| - os: windows-2022 | |
| node: 22 | |
| arch: x64 | |
| steps: | |
| - name: Setup (alpine) | |
| if: contains(matrix.container, 'alpine') | |
| run: | | |
| apk add --no-cache build-base git g++ make curl python3 | |
| ln -sf python3 /usr/bin/python | |
| - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }}) | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ env.HEAD_COMMIT }} | |
| - name: Restore dependency cache | |
| uses: actions/cache/restore@v4 | |
| id: restore-dependencies | |
| with: | |
| path: ${{ env.CACHED_DEPENDENCY_PATHS }} | |
| key: ${{ needs.job_install_deps.outputs.dependency_cache_key }} | |
| enableCrossOsArchive: true | |
| - name: Restore build cache | |
| uses: actions/cache/restore@v4 | |
| id: restore-build | |
| with: | |
| path: ${{ env.CACHED_BUILD_PATHS }} | |
| key: ${{ needs.job_build.outputs.dependency_cache_key }} | |
| enableCrossOsArchive: true | |
| - name: Configure safe directory | |
| run: | | |
| git config --global --add safe.directory "*" | |
| - name: Install yarn | |
| run: npm i -g [email protected] --force | |
| - name: Increase yarn network timeout on Windows | |
| if: contains(matrix.os, 'windows') | |
| run: yarn config set network-timeout 600000 -g | |
| - name: Setup python | |
| uses: actions/setup-python@v5 | |
| if: ${{ !contains(matrix.container, 'alpine') }} | |
| id: python-setup | |
| with: | |
| python-version: '3.8.10' | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| - name: Install Dependencies | |
| if: steps.restore-dependencies.outputs.cache-hit != 'true' | |
| run: yarn install --frozen-lockfile --ignore-engines --ignore-scripts | |
| - name: Setup (arm64| ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc' }}) | |
| if: matrix.arch == 'arm64' && !contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin' | |
| run: | | |
| sudo apt-get update | |
| sudo apt install -y gcc-aarch64-linux-gnu g++-aarch64-linux-gnu | |
| - name: Setup Musl | |
| if: contains(matrix.container, 'alpine') | |
| run: | | |
| cd packages/profiling-node | |
| curl -OL https://musl.cc/aarch64-linux-musl-cross.tgz | |
| tar -xzvf aarch64-linux-musl-cross.tgz | |
| $(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-gcc --version | |
| # configure node-gyp | |
| - name: Configure node-gyp | |
| if: matrix.arch != 'arm64' | |
| run: | | |
| cd packages/profiling-node | |
| yarn build:bindings:configure | |
| - name: Configure node-gyp (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc' }}) | |
| if: matrix.arch == 'arm64' && matrix.target_platform != 'darwin' | |
| run: | | |
| cd packages/profiling-node | |
| yarn build:bindings:configure:arm64 | |
| - name: Configure node-gyp (arm64, darwin) | |
| if: matrix.arch == 'arm64' && matrix.target_platform == 'darwin' | |
| run: | | |
| cd packages/profiling-node | |
| yarn build:bindings:configure:arm64 | |
| # build bindings | |
| - name: Build Bindings | |
| if: matrix.arch != 'arm64' | |
| run: | | |
| yarn lerna run build:bindings --scope @sentry/profiling-node | |
| - name: Build Bindings (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc' }}) | |
| if: matrix.arch == 'arm64' && contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin' | |
| run: | | |
| cd packages/profiling-node | |
| CC=$(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-gcc \ | |
| CXX=$(pwd)/aarch64-linux-musl-cross/bin/aarch64-linux-musl-g++ \ | |
| BUILD_ARCH=arm64 \ | |
| yarn build:bindings | |
| - name: Build Bindings (arm64, ${{ contains(matrix.container, 'alpine') && 'musl' || 'glibc' }}) | |
| if: matrix.arch == 'arm64' && !contains(matrix.container, 'alpine') && matrix.target_platform != 'darwin' | |
| run: | | |
| cd packages/profiling-node | |
| CC=aarch64-linux-gnu-gcc \ | |
| CXX=aarch64-linux-gnu-g++ \ | |
| BUILD_ARCH=arm64 \ | |
| yarn build:bindings:arm64 | |
| - name: Build Bindings (arm64, darwin) | |
| if: matrix.arch == 'arm64' && matrix.target_platform == 'darwin' | |
| run: | | |
| cd packages/profiling-node | |
| BUILD_PLATFORM=darwin \ | |
| BUILD_ARCH=arm64 \ | |
| yarn build:bindings:arm64 | |
| - name: Build Monorepo | |
| if: steps.restore-build.outputs.cache-hit != 'true' | |
| run: yarn build --scope @sentry/profiling-node | |
| - name: Test Bindings | |
| if: matrix.arch != 'arm64' | |
| run: | | |
| yarn lerna run test --scope @sentry/profiling-node | |
| - name: Archive Binary | |
| # @TODO: v4 breaks convenient merging of same name artifacts | |
| # https://github.com/actions/upload-artifact/issues/478 | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: profiling-node-binaries-${{ github.sha }} | |
| path: | | |
| ${{ github.workspace }}/packages/profiling-node/lib/*.node |