Skip to content

E2E testing documentation updates #18651

@github-actions

Description

@github-actions

Note

The pull request "E2E testing documentation updates" was created by @BYK but did not reference an issue. Therefore this issue was created for better visibility in external tools like Linear.

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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions