Skip to content

Conversation

@BYK
Copy link
Member

@BYK BYK commented Dec 31, 2025

Before submitting a pull request, please take a look at our
Contributing guidelines and verify:

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).
  • Link an issue if there is one related to your pull request. If no issue is linked, one will be auto-generated and linked.

Closes #issue_link_here

This PR documents key learnings and best practices for E2E testing within the Sentry JavaScript SDKs, focusing on common pitfalls and setup requirements.

Why these changes?
To improve the developer experience for E2E testing by providing clear guidance on Verdaccio setup, the critical .npmrc file, bundler-specific behaviors, and debugging strategies, thereby reducing common issues and debugging time.

What was changed?

  • CONTRIBUTING.md: Added a new section "Running E2E Tests Locally" with prerequisites, step-by-step instructions, and troubleshooting.
  • CLAUDE.md & .cursor/rules/sdk_development.mdc: Added an "E2E Testing" section under "Development Guidelines," explaining Verdaccio, .npmrc requirements, how to run single tests, and common pitfalls.
  • dev-packages/e2e-tests/README.md: Expanded existing documentation with detailed .npmrc explanations, a comprehensive troubleshooting guide, and notes on bundler-specific environment variable handling (Webpack, Vite, Next.js) and import.meta.env behavior.

Open in Cursor Open in Web

Closes #18651 (added automatically)

@cursor
Copy link

cursor bot commented Dec 31, 2025

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@cursor cursor bot force-pushed the cursor/e2e-testing-documentation-updates-9b87 branch from f866733 to 36807c8 Compare December 31, 2025 21:34
@BYK BYK marked this pull request as ready for review January 1, 2026 07:55
@github-actions github-actions bot mentioned this pull request Jan 1, 2026
3 tasks
Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I'm not the biggest fan of the AI "accent" here, so I had some suggestions to remove the fluff. In general it's valuable content though, so thanks for adding it!

@Lms24 Lms24 changed the title E2E testing documentation updates doc: E2E testing documentation updates Jan 2, 2026
@BYK BYK requested a review from Lms24 January 6, 2026 13:57
@BYK BYK enabled auto-merge (squash) January 6, 2026 13:58
@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

Scenario Requests/s % of Baseline Prev. Requests/s Change %
GET Baseline 9,426 - 9,106 +4%
GET With Sentry 1,741 18% 1,665 +5%
GET With Sentry (error only) 6,179 66% 6,085 +2%
POST Baseline 1,203 - 1,169 +3%
POST With Sentry 570 47% 556 +3%
POST With Sentry (error only) 1,038 86% 1,045 -1%
MYSQL Baseline 3,314 - 3,326 -0%
MYSQL With Sentry 459 14% 435 +6%
MYSQL With Sentry (error only) 2,713 82% 2,691 +1%

View base workflow run

@BYK BYK merged commit 747e212 into develop Jan 6, 2026
208 checks passed
@BYK BYK deleted the cursor/e2e-testing-documentation-updates-9b87 branch January 6, 2026 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

E2E testing documentation updates

4 participants