chore: replay metrics

.github/workflows/build.yml

@@ -40,6 +40,15 @@ env:
 
   BUILD_CACHE_KEY: ${{ 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 master 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-refs/heads/master
+    nx-Linux
+
 jobs:
   job_get_metadata:
     name: Get Metadata
@@ -120,6 +129,11 @@ jobs:
       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_master: ${{ github.ref == 'refs/heads/master' }}
+      is_release: ${{ startsWith(github.ref, 'refs/heads/release/') }}
+      force_skip_cache:
+        ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'ci-skip-cache') }}
 
   job_install_deps:
     name: Install Dependencies
@@ -139,14 +153,19 @@ jobs:
       - name: Compute dependency cache key
         id: compute_lockfile_hash
         run: echo "hash=${{ hashFiles('yarn.lock') }}" >> "$GITHUB_OUTPUT"
+
+      # When the `ci-skip-cache` label is added to a PR, we always want to skip dependency cache
       - name: Check dependency cache
         uses: actions/cache@v3
         id: cache_dependencies
+        if: needs.job_get_metadata.outputs.force_skip_cache == 'false'
         with:
           path: ${{ env.CACHED_DEPENDENCY_PATHS }}
           key: ${{ steps.compute_lockfile_hash.outputs.hash }}
+
       - name: Install dependencies
-        if: steps.cache_dependencies.outputs.cache-hit == ''
+        if:
+          steps.cache_dependencies.outputs.cache-hit == '' || needs.job_get_metadata.outputs.force_skip_cache == 'true'
         run: yarn install --ignore-engines --frozen-lockfile
     outputs:
       dependency_cache_key: ${{ steps.compute_lockfile_hash.outputs.hash }}
@@ -168,12 +187,31 @@ jobs:
         with:
           path: ${{ env.CACHED_DEPENDENCY_PATHS }}
           key: ${{ needs.job_install_deps.outputs.dependency_cache_key }}
+
       - name: Check build cache
         uses: actions/cache@v3
         id: cache_built_packages
+        if: needs.job_get_metadata.outputs.force_skip_cache == 'false'
         with:
           path: ${{ env.CACHED_BUILD_PATHS }}
           key: ${{ env.BUILD_CACHE_KEY }}
+
+      - name: NX cache
+        uses: actions/cache@v3
+        # Disable cache when:
+        # - on master
+        # - on release branches
+        # - when PR has `ci-skip-cache` label
+        if: |
+          needs.job_get_metadata.outputs.is_release == 'false' &&
+          needs.job_get_metadata.outputs.force_skip_cache == 'false'
+        with:
+          path: node_modules/.cache/nx
+          key: nx-Linux-${{ github.ref }}-${{ env.HEAD_COMMIT }}
+          # On master 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_master == 'false' && env.NX_CACHE_RESTORE_KEYS || 'nx-never-restore'}}
+
       - name: Build packages
         # Under normal circumstances, using the git SHA as a cache key, there shouldn't ever be a cache hit on the built
         # packages, and so `yarn build` should always run. This `if` check is therefore only there for testing CI issues
@@ -232,7 +270,7 @@ jobs:
     timeout-minutes: 15
     runs-on: ubuntu-20.04
     # Size Check will error out outside of the context of a PR
-    if: github.event_name == 'pull_request' || github.ref == 'refs/heads/master'
+    if: github.event_name == 'pull_request' || needs.job_get_metadata.outputs.is_master == 'true'
     steps:
       - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
         uses: actions/checkout@v3
@@ -258,7 +296,7 @@ jobs:
       - name: Check bundle sizes
         uses: getsentry/size-limit-action@v5
         # Don't run size check on release branches - at that point, we're already committed
-        if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
+        if: needs.job_get_metadata.outputs.is_release == 'false'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           skip_step: build
@@ -320,7 +358,7 @@ jobs:
     needs: [job_get_metadata, job_build]
     runs-on: ubuntu-20.04
     # Build artifacts are only needed for releasing workflow.
-    if: startsWith(github.ref, 'refs/heads/release/')
+    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@v3
@@ -339,7 +377,7 @@ jobs:
           path: ${{ env.CACHED_BUILD_PATHS }}
           key: ${{ env.BUILD_CACHE_KEY }}
       - name: Pack
-        run: yarn build:npm
+        run: yarn build:tarball
       - name: Archive artifacts
         uses: actions/upload-artifact@v3.1.1
         with:
@@ -505,6 +543,7 @@ jobs:
     if: needs.job_get_metadata.outputs.changed_browser_integration == 'true' || github.event_name != 'pull_request'
     runs-on: ubuntu-20.04
     strategy:
+      fail-fast: false
       matrix:
         bundle:
           - esm
@@ -540,13 +579,34 @@ jobs:
         with:
           path: ${{ env.CACHED_BUILD_PATHS }}
           key: ${{ env.BUILD_CACHE_KEY }}
+      - name: Get npm cache directory
+        id: npm-cache-dir
+        run: |
+          echo "::set-output name=dir::$(npm config get cache)"
+      - name: Get Playwright version
+        id: playwright-version
+        run: |
+          echo "::set-output name=version::$(node -p "require('@playwright/test/package.json').version")"
+      - uses: actions/cache@v3
+        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 }}
           PW_TRACING_ONLY: ${{ matrix.tracing_only }}
         run: |
           cd packages/integration-tests
-          yarn run playwright install-deps webkit
           yarn test:ci
 
   job_browser_integration_tests:
@@ -755,3 +815,51 @@ jobs:
         if: contains(needs.*.result, 'failure')
         run: |
           echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1
+
+  replay_metrics:
+    name: Replay 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@v3
+        with:
+          ref: ${{ env.HEAD_COMMIT }}
+      - name: Set up Node
+        uses: volta-cli/action@v4
+      - name: Check dependency cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.CACHED_DEPENDENCY_PATHS }}
+          key: ${{ needs.job_build.outputs.dependency_cache_key }}
+      - name: Check build cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.CACHED_BUILD_PATHS }}
+          key: ${{ env.BUILD_CACHE_KEY }}
+
+      - name: Setup
+        run: yarn install
+        working-directory: packages/replay/metrics
+
+      - name: Collect
+        run: yarn ci:collect
+        working-directory: packages/replay/metrics
+
+      - name: Process
+        id: process
+        run: yarn ci:process
+        working-directory: packages/replay/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@v3
+        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 }}

.gitignore

@@ -47,4 +47,4 @@ tmp.js
 
 # eslint
 .eslintcache
-eslintcache/*
+**/eslintcache/*

.size-limit.js

@@ -46,7 +46,7 @@ module.exports = [
   },
   {
     name: '@sentry/nextjs Client - Webpack (gzipped + minified)',
-    path: 'packages/nextjs/build/esm/index.client.js',
+    path: 'packages/nextjs/build/esm/client/index.js',
     import: '{ init }',
     gzip: true,
     limit: '57 KB',

.vscode/launch.json

@@ -37,6 +37,22 @@
       "internalConsoleOptions": "openOnSessionStart",
       "outputCapture": "std"
     },
+    {
+        "type": "node",
+        "name": "Debug replay metrics collection script",
+        "request": "launch",
+        "cwd": "${workspaceFolder}/packages/replay/metrics/",
+        "program": "${workspaceFolder}/packages/replay/metrics/configs/dev/collect.ts",
+        "preLaunchTask": "Build Replay metrics script",
+    },
+    {
+        "type": "node",
+        "name": "Debug replay metrics processing script",
+        "request": "launch",
+        "cwd": "${workspaceFolder}/packages/replay/metrics/",
+        "program": "${workspaceFolder}/packages/replay/metrics/configs/dev/process.ts",
+        "preLaunchTask": "Build Replay metrics script",
+    },
     // Run rollup using the config file which is in the currently active tab.
     {
       "name": "Debug rollup (config from open file)",

.vscode/tasks.json

@@ -7,7 +7,13 @@
 			"type": "npm",
 			"script": "predebug",
 			"path": "packages/nextjs/test/integration/",
-			"detail": "Link the SDK (if not already linked) and build test app"
+			"detail": "Link the SDK (if not already linked) and build test app",
+		},
+		{
+			"label": "Build Replay metrics script",
+			"type": "npm",
+			"script": "build",
+			"path": "packages/replay/metrics",
 		}
 	]
 }

CHANGELOG.md

@@ -4,6 +4,26 @@
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
+## 7.30.0
+
+- feat(core): Add `addIntegration` method to client (#6651)
+- feat(core): Add `replay_event` type for events (#6481)
+- feat(gatsby): Support Gatsby v5 (#6635)
+- feat(integrations): Add HTTPClient integration (#6500)
+- feat(node): Add `LocalVariables` integration to capture local variables to stack frames (#6478)
+- feat(node): Check for invalid url in node transport (#6623)
+- feat(replay): Remove `replayType` from tags and into `replay_event` (#6658)
+- feat(transport): Return result through Transport send (#6626)
+- fix(nextjs): Don't wrap `res.json` and `res.send` (#6674)
+- fix(nextjs): Don't write to `res.end` to fix `next export` (#6682)
+- fix(nextjs): Exclude SDK from Edge runtime bundles (#6683)
+- fix(replay): Allow Replay to be used in Electron renderers with nodeIntegration enabled (#6644)
+- fix(utils): Ignore stack frames over 1kb (#6627)
+- ref(angular) Add error-like objects handling (#6446)
+- ref(nextjs): Remove `instrumentSever` (#6592)
+
+Work in this release contributed by @rjoonas, @Naddiseo, and @theofidry. Thank you for your contributions!
+
 ## 7.29.0
 
 This update includes a change to the `@sentry/nextjs` SDK that may increase response times of requests in applications

docs/event-sending.md

@@ -77,8 +77,8 @@ This document gives an outline for how event sending works, and which which plac
 ## Replay (WIP)
 
 * `replay.sendReplayRequest()`
-  * `createPayload()`
-  * `getReplayEvent()`
+  * `createRecordingData()`
+  * `prepareReplayEvent()`
     * `client._prepareEvent()` (see baseclient)
       * `baseclient._applyClientOptions()`
       * `baseclient._applyIntegrationsMetadata()`

docs/new-sdk-release-checklist.md

@@ -21,7 +21,7 @@ This page serves as a checklist of what to do when releasing a new SDK for the f
 - [ ]  Make sure that the `LICENSE` file exists and has the correct license (We default to the `MIT` license)
     - [ ]  Also check, that the same license is mentioned in `package.json`
 
-- [ ]  Make sure that the tarball (`yarn build:npm`) has all the necessary contents
+- [ ]  Make sure that the tarball (`yarn build:tarball`) has all the necessary contents
 
     For basic SDKs, this means that the tarball has at least these files:
 

lerna.json

@@ -1,7 +1,7 @@
 {
-  "lerna": "3.4.0",
-  "version": "7.29.0",
-  "packages": "packages/*",
+  "$schema": "node_modules/lerna/schemas/lerna-schema.json",
+  "version": "7.30.0",
+  "packages": ["packages/*"],
   "npmClient": "yarn",
   "useWorkspaces": true
 }