-
Notifications
You must be signed in to change notification settings - Fork 382
fix(e2e): Patch flaky billing tests #6681
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🦋 Changeset detectedLatest commit: 5eeac89 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughAdds a changeset metadata file and updates a pricing table integration test to increase UI timeouts, add explicit checkout progression steps, and wait for navigation to the root URL before continuing test steps. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Tester as Test Runner
participant Page as Browser Page
participant App as App (UI)
participant Pay as Checkout Service
Tester->>Page: Trigger checkout (Pay/Subscribe)
Page->>Pay: Submit payment
Pay-->>Page: Payment success
Page->>App: checkout.confirmAndContinue()
Note over Page,App: New explicit step to advance flow
Page->>App: Wait for navigation to '/'
Note over Page,App: page.waitForAppUrl('/')
Page->>App: Wait for "Trial started" / "Payment was successful!" (15s)
Note over Tester,Page: Increased visibility timeouts
Tester->>Page: Navigate to Profile page (after root reached)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
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.
Actionable comments posted: 1
🧹 Nitpick comments (2)
integration/tests/pricing-table.test.ts (2)
424-424
: Standardize wait helper usage (u.page vs u.po.page).Elsewhere in this file you use
u.page.waitForAppUrl
, here it’su.po.page.waitForAppUrl
. Pick one for consistency; suggest aligning tou.page
like the other occurrences.- await u.po.page.waitForAppUrl('/'); + await u.page.waitForAppUrl('/');
489-491
: Extend success-toast timeout and scope to checkout root for consistency.Consider scoping like line 623 and centralizing the 15_000 timeout in a shared constant to keep assertions uniform.
- await expect(u.po.page.getByText('Payment was successful!')).toBeVisible({ + await expect(u.po.checkout.root.getByText('Payment was successful!')).toBeVisible({ timeout: 15_000, });Also consider applying the same timeout/scoping to other success checks (e.g., Lines 168, 536, 645).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.changeset/chilly-kids-fly.md
(1 hunks)integration/tests/pricing-table.test.ts
(4 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/chilly-kids-fly.md
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}
: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
integration/tests/pricing-table.test.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
integration/tests/pricing-table.test.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}
: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidany
type - preferunknown
when type is uncertain, then narrow with type guards
Useinterface
for object shapes that might be extended
Usetype
for unions, primitives, and computed types
Preferreadonly
properties for immutable data structures
Useprivate
for internal implementation details
Useprotected
for inheritance hierarchies
Usepublic
explicitly for clarity in public APIs
Preferreadonly
for properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertions
for literal types:as const
Usesatisfies
operator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noany
types without justification
Proper error handling with typed errors
Consistent use ofreadonly
for immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
integration/tests/pricing-table.test.ts
integration/**
📄 CodeRabbit inference engine (.cursor/rules/global.mdc)
Framework integration templates and E2E tests should be placed under the integration/ directory
Files:
integration/tests/pricing-table.test.ts
integration/**/*
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
End-to-end tests and integration templates must be located in the 'integration/' directory.
Files:
integration/tests/pricing-table.test.ts
integration/**/*.{test,spec}.{js,ts}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Integration tests should use Playwright.
Files:
integration/tests/pricing-table.test.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
integration/tests/pricing-table.test.ts
🪛 LanguageTool
.changeset/chilly-kids-fly.md
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ---
(QB_NEW_DE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
integration/tests/pricing-table.test.ts (2)
294-296
: Good call increasing timeout for the trial-start toast.This should reduce flakiness around delayed webhook/processing.
446-448
: Confirm-and-continue + wait for app URL is the right sequencing.This addresses races between checkout completion and route change.
--- | ||
--- |
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.
💡 Verification agent
🧩 Analysis chain
Empty changeset front matter is invalid and will fail Changesets parsing/CI.
Either remove the file (test-only PR; no release) or replace with a valid changeset targeting the correct package(s) and bump type. If a changeset is required but no release should occur, follow the repo’s “no release” policy (e.g., label-based skip or a “none” bump if supported by your setup). Please confirm project policy.
🏁 Script executed:
#!/bin/bash
ls -la .changeset
Length of output: 1676
Fix or remove empty changeset front matter
File “.changeset/chilly-kids-fly.md” contains only empty front matter (---\n---
), which will break Changesets. Either delete this file if no release is intended, or fill in a valid front matter with the appropriate package(s) and bump type. If you need a no-release changeset, apply the repo’s “no release” policy (e.g. a “none” bump or label-based skip).
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ---
(QB_NEW_DE)
🤖 Prompt for AI Agents
In .changeset/chilly-kids-fly.md lines 1-2 there is only empty front matter
(---\n---) which will break Changesets; fix it by either deleting this file if
no release is intended, or replace the empty front matter with valid changeset
front matter listing the affected package(s) and a bump type (major/minor/patch
or your repo’s “none”/no-release convention), or apply the repository’s
no-release policy (e.g., use a “none” bump or add the required label) so
Changesets can process it correctly.
Description
Checklist
pnpm test
runs as expected.pnpm build
runs as expected.Type of change
Summary by CodeRabbit
Tests
Chores