Uh oh!
There was an error while loading. Please reload this page.
chore(e2e): Add e2e claude skill#18957
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| --- | ||
| name: e2e | ||
| description: Run E2E tests for Sentry JavaScript SDK test applications | ||
| argument-hint: <test-app-name> [--variant <variant-name>] | ||
| --- | ||
| # E2E Test Runner Skill | ||
| This skill runs end-to-end tests for Sentry JavaScript SDK test applications. It ensures SDK packages are built before running tests. | ||
| ## Input | ||
| The user provides a test application name and optionally a variant: | ||
| - `e2e-tests/test-applications/nextjs-app-dir` (full path) | ||
| - `nextjs-app-dir` (just the app name) | ||
| - `nextjs-app-dir --variant nextjs-15` (with variant) | ||
| ## Workflow | ||
| ### Step 1: Parse the Test Application Name | ||
| Extract the test app name from user input: | ||
| - Strip `e2e-tests/test-applications/` prefix if present | ||
| - Extract variant flag if provided (e.g., `--variant nextjs-15`) | ||
| - Store the clean app name (e.g., `nextjs-app-dir`) | ||
| ### Step 2: Determine Which Packages Need Rebuilding | ||
| If the user recently edited files in `packages/*`, identify which packages were modified: | ||
| ```bash | ||
| # Check which packages have uncommitted changes | ||
| git status --porcelain | grep "^[ MARC][ MD] packages/" | cut -d'/' -f2 | sort -u | ||
| ``` | ||
| For each modified package, rebuild its tarball: | ||
| ```bash | ||
| cd packages/<package-name> | ||
| yarn build && yarn build:tarball | ||
| cd ../.. | ||
| ``` | ||
| **Option C: User Specifies Packages** | ||
| If the user says "I changed @sentry/node" or similar, rebuild just that package: | ||
| ```bash | ||
| cd packages/node | ||
| yarn build && yarn build:tarball | ||
| cd ../.. | ||
| ``` | ||
There was a problem hiding this comment. Missing tarball existence check causes first-run failuresMedium Severity The main workflow Step 2 only detects modified packages via Additional Locations (1) | ||
| ### Step 3: Verify Test Application Exists | ||
| Check that the test app exists: | ||
| ```bash | ||
| ls -d dev-packages/e2e-tests/test-applications/<app-name> | ||
| ``` | ||
| If it doesn't exist, list available test apps: | ||
| ```bash | ||
| ls dev-packages/e2e-tests/test-applications/ | ||
| ``` | ||
| Ask the user which one they meant. | ||
| ### Step 4: Run the E2E Test | ||
| Navigate to the e2e-tests directory and run the test: | ||
| ```bash | ||
| cd dev-packages/e2e-tests | ||
| yarn test:run <app-name> | ||
| ``` | ||
| If a variant was specified: | ||
| ```bash | ||
| cd dev-packages/e2e-tests | ||
| yarn test:run <app-name> --variant <variant-name> | ||
| ``` | ||
| ### Step 5: Report Results | ||
| After the test completes, provide a summary: | ||
| **If tests passed:** | ||
| ``` | ||
| ✅ E2E tests passed for <app-name> | ||
| All tests completed successfully. Your SDK changes work correctly with this test application. | ||
| ``` | ||
| **If tests failed:** | ||
| ``` | ||
| ❌ E2E tests failed for <app-name> | ||
| [Include relevant error output] | ||
| ``` | ||
| **If package rebuild was needed:** | ||
| ``` | ||
| 📦 Rebuilt SDK packages: <list of packages> | ||
| 🧪 Running E2E tests for <app-name>... | ||
| ``` | ||
| ## Error Handling | ||
| - **No tarballs found**: Run `yarn build && yarn build:tarball` at repository root | ||
| - **Test app not found**: List available apps and ask user to clarify | ||
| - **Verdaccio not running**: Tests should start Verdaccio automatically, but if issues occur, check Docker | ||
| - **Build failures**: Fix build errors before running tests | ||
| ## Common Test Applications | ||
| Here are frequently tested applications: | ||
| - `nextjs-app-dir` - Next.js App Router | ||
| - `nextjs-15` - Next.js 15.x | ||
| - `react-create-hash-router` - React with React Router | ||
| - `node-express-esm-loader` - Node.js Express with ESM | ||
| - `sveltekit-2` - SvelteKit 2.x | ||
| - `remix-2` - Remix 2.x | ||
| - `nuxt-3` - Nuxt 3.x | ||
| To see all available test apps: | ||
| ```bash | ||
| ls dev-packages/e2e-tests/test-applications/ | ||
| ``` | ||
| ## Example Workflows | ||
| ### Example 1: After modifying @sentry/node | ||
| ```bash | ||
| # User: "Run e2e tests for node-express-esm-loader" | ||
| # Step 1: Detect recent changes to packages/node | ||
| # Step 2: Rebuild the modified package | ||
| cd packages/node | ||
| yarn build && yarn build:tarball | ||
| cd ../.. | ||
| # Step 3: Run the test | ||
| cd dev-packages/e2e-tests | ||
| yarn test:run node-express-esm-loader | ||
| ``` | ||
| ### Example 2: First-time test run | ||
| ```bash | ||
| # User: "Run e2e tests for nextjs-app-dir" | ||
| # Step 1: Check for existing tarballs | ||
| # Step 2: None found, build all packages | ||
| yarn build && yarn build:tarball | ||
| # Step 3: Run the test | ||
| cd dev-packages/e2e-tests | ||
| yarn test:run nextjs-app-dir | ||
| ``` | ||
| ### Example 3: With variant | ||
| ```bash | ||
| # User: "Run e2e tests for nextjs-app-dir with nextjs-15 variant" | ||
| # Step 1: Rebuild if needed | ||
| # Step 2: Run with variant | ||
| cd dev-packages/e2e-tests | ||
| yarn test:run nextjs-app-dir --variant nextjs-15 | ||
| ``` | ||
| ## Tips | ||
| - **Always rebuild after SDK changes**: Tarballs contain the compiled SDK code | ||
| - **Watch build output**: Build errors must be fixed before testing | ||
| ## Integration with Development Workflow | ||
| This skill integrates with the standard SDK development workflow: | ||
| 1. Make changes to SDK code in `packages/*` | ||
| 2. Run `/e2e <app-name>` to test your changes | ||
| 3. Fix any test failures | ||
| The skill automates the tedious parts of: | ||
| - Remembering to rebuild tarballs | ||
| - Navigating to the correct directory | ||
| - Running tests with the right flags | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Git command misses untracked new files in packages
Medium Severity
The git command
grep "^[ MARC][ MD] packages/"only matches certain status codes but misses untracked files which use??. When a developer adds a new file to an SDK package, it appears as?? packages/node/newfile.tsingit status --porcelainoutput. Since?is not in the character class[ MARC], these packages won't be detected as modified, causing the skill to skip rebuilding them. The E2E test would then run against stale code.