chore(e2e): Test for downgrading/upgrading/resubscribing on free trial #6670
Conversation
🦋 Changeset detectedLatest commit: eaa922b 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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✨ 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
|
@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.
Actionable comments posted: 1
🧹 Nitpick comments (3)
integration/tests/pricing-table.test.ts (3)
351-355: Harden text assertions to reduce brittleness.Use case-insensitive regex and anchor where appropriate; product copy often changes subtly.
Apply:
- await expect(u.po.checkout.root.getByText('Checkout')).toBeVisible(); - await expect(u.po.checkout.root.getByText('Free trial')).toBeHidden(); - await expect(u.po.checkout.root.getByText('Total Due after')).toBeHidden(); - await expect(u.po.checkout.root.getByText('Total Due Today')).toBeVisible(); + await expect(u.po.checkout.root.getByText(/^checkout$/i)).toBeVisible(); + await expect(u.po.checkout.root.getByText(/free trial/i)).toBeHidden(); + await expect(u.po.checkout.root.getByText(/total due after/i)).toBeHidden(); + await expect(u.po.checkout.root.getByText(/total due today/i)).toBeVisible();
365-385: Avoid XPath parent hops; prefer structural selectors with :has for stability.Climbing with "xpath=.." is fragile against DOM changes. Target the list item that contains the label and then assert on descendants.
Apply:
- await expect( - u.po.page - .locator('.cl-profileSectionContent__subscriptionsList') - .getByText(/Trial/i) - .locator('xpath=..') - .getByText(/Free trial/i), - ).toBeHidden(); + const trialItem = u.po.page + .locator('.cl-profileSectionContent__subscriptionsList') + .locator('[role="listitem"]', { hasText: /Trial/i }); + await expect(trialItem.getByText(/Free trial/i)).toBeHidden(); - // Verify the Free plan with Upcoming status exists - await expect( - u.po.page - .locator('.cl-profileSectionContent__subscriptionsList') - .getByText('Free') - .locator('xpath=..') - .getByText('Upcoming'), - ).toBeHidden(); + // Verify the Free plan with Upcoming status is hidden + const freeItem = u.po.page + .locator('.cl-profileSectionContent__subscriptionsList') + .locator('[role="listitem"]', { hasText: /^Free$/i }); + await expect(freeItem.getByText(/^Upcoming$/i)).toBeHidden();
441-444: Assert success and continue before navigating — increases determinism.The previous flows assert the success toast and press Continue; mirror that here to avoid races.
Apply:
await u.po.checkout.root.getByRole('button', { name: /^pay\s\$/i }).waitFor({ state: 'visible' }); await u.po.checkout.clickPayOrSubscribe(); + await expect(u.po.page.getByText(/Payment was successful!/i)).toBeVisible(); + await u.po.checkout.confirmAndContinue();
📜 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/silent-bees-wear.md(1 hunks)integration/tests/pricing-table.test.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/silent-bees-wear.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
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor 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 assertionsfor literal types:as const
Usesatisfiesoperator 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 ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor 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
🧬 Code graph analysis (1)
integration/tests/pricing-table.test.ts (1)
integration/testUtils/index.ts (1)
createTestUtils(24-86)
🪛 LanguageTool
.changeset/silent-bees-wear.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). (27)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (tanstack-react-router, chrome)
- GitHub Check: Integration Tests (machine, chrome)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Integration Tests (quickstart, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Unit Tests (22, **)
- GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
- GitHub Check: Publish with pkg-pr-new
- GitHub Check: Static analysis
- 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)
| --- | ||
| --- |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Invalid Changeset frontmatter (empty) — will fail Changesets CI.
Frontmatter must list at least one package with a release type (or explicitly mark none). Also add a short summary body.
Proposed fix (replace file contents; adjust package name(s) as appropriate for this monorepo):
----
----
+---
+'@clerk/your-package-here': none
+---
+
+chore(e2e): Add E2E cases for downgrading/upgrading/resubscribing on free trial. No publishable changes.Please run “pnpm changeset status” locally to verify the changeset parses and CI will pass.
🏁 Script executed:
#!/bin/bash
# Display the first 10 lines of the changeset to verify frontmatter
if [ -f .changeset/silent-bees-wear.md ]; then
sed -n '1,10p' .changeset/silent-bees-wear.md
else
echo "File not found: .changeset/silent-bees-wear.md"
fiLength of output: 97
Add valid frontmatter and summary to the changeset
Frontmatter can’t be empty—must list at least one package with its release type (or none) and include a one-line summary.
--- .changeset/silent-bees-wear.md
---
----
----
+---
+'@clerk/your-package-here': none
+---
+
+chore(e2e): Add E2E cases for downgrading/upgrading/resubscribing on free trial. No publishable changes.Run pnpm changeset status locally to confirm the changeset parses and CI will pass.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ---
(QB_NEW_DE)
🤖 Prompt for AI Agents
In .changeset/silent-bees-wear.md around lines 1 to 2, the changeset frontmatter
is empty; add valid YAML frontmatter listing at least one package with its
release type (or `none`) and include a one-line summary beneath the frontmatter.
Edit the file to include e.g. a packages array with the package name and release
type, then a short summary sentence, save, and run `pnpm changeset status`
locally to verify parsing and CI will pass.
…
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Tests
Chores