Uh oh!
There was an error while loading. Please reload this page.
fix(shared,clerk-js,backend,ui): use duration in cycles in payments and statements - #9401
Conversation
🦋 Changeset detectedLatest commit: 5f52f54 The changes in this PR will be included in the next version bump. This PR includes changesets to release 23 packages
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.
|
…nd statements Right now, we are displaying "10% off first 2 months" for a case where the discount lasts 2 cycles, when it should be "10% off first 2 cycles"
5e56b47 to
5f52f54Compare@clerk/astro@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/electron@clerk/electron-passkeys@clerk/eslint-plugin@clerk/expo@clerk/expo-google-signin@clerk/expo-passkeys@clerk/express@clerk/fastify@clerk/hono@clerk/localizations@clerk/nextjs@clerk/nuxt@clerk/react@clerk/react-router@clerk/shared@clerk/tanstack-react-start@clerk/testing@clerk/ui@clerk/upgrade@clerk/vuecommit: |
📝 WalkthroughWalkthroughThe change adds optional nullable discount duration fields to shared billing types and JSON models. Backend and Clerk JS billing converters map Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/ui/src/utils/billing.ts (1)
27-32: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winUse cycle labels for discount duration.
getBillingPeriodLabel(planPeriod, cycles, t)returnsmonth(s)oryear(s). A two-cycle discount can therefore render as “first 2 months” or “first 2 years”, not “first 2 cycles”. Use a cycle-specific label or localization key forbilling.discountDuration.The PR objective requires discount duration to be displayed in cycles.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/ui/src/utils/billing.ts` around lines 27 - 32, Update the discount-duration path in the billing utility to use a cycle-specific label or localization key instead of the period returned by getBillingPeriodLabel. Ensure billing.discountDuration renders durations as cycles (for example, “first 2 cycles”), while preserving the existing no-cycles discountAmount behavior.
🧹 Nitpick comments (1)
packages/ui/src/utils/billing.ts (1)
14-19: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd an explicit return type to the exported utility.
Declare
getDiscountDescriptionwith a: stringreturn type.As per coding guidelines, public TypeScript functions must define explicit return types.
Based on learnings, exported functions and public APIs require explicit return annotations.
Proposed change
export function getDiscountDescription( discount: Discount, cycles: number | null | undefined, planPeriod: BillingSubscriptionPlanPeriod, { $, t }: Localizations, -) {+): string {🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/ui/src/utils/billing.ts` around lines 14 - 19, Update the exported getDiscountDescription function signature to explicitly declare a string return type with : string, preserving its existing parameters and implementation.Sources: Coding guidelines, Learnings
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@packages/ui/src/utils/billing.ts`:
- Around line 27-32: Update the discount-duration path in the billing utility to
use a cycle-specific label or localization key instead of the period returned by
getBillingPeriodLabel. Ensure billing.discountDuration renders durations as
cycles (for example, “first 2 cycles”), while preserving the existing no-cycles
discountAmount behavior.
---
Nitpick comments:
In `@packages/ui/src/utils/billing.ts`:
- Around line 14-19: Update the exported getDiscountDescription function
signature to explicitly declare a string return type with : string, preserving
its existing parameters and implementation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 10854210-e1c4-4131-8f08-e5ad80fe5ca0
📒 Files selected for processing (10)
.changeset/applied-discount-duration-cycles.mdpackages/backend/src/util/billing.tspackages/clerk-js/src/utils/__tests__/billing.test.tspackages/clerk-js/src/utils/billing.tspackages/shared/src/types/billing.tspackages/shared/src/types/json.tspackages/ui/src/components/Checkout/__tests__/Checkout.test.tsxpackages/ui/src/components/PaymentAttempts/PaymentAttemptPage.tsxpackages/ui/src/components/Statements/StatementPage.tsxpackages/ui/src/utils/billing.ts
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
clerk/clerk_go(manual)clerk/dashboard(manual)clerk/accounts(manual)clerk/backoffice(manual)clerk/clerk(manual)clerk/clerk-docs(manual)clerk/cloudflare-workers(manual)clerk/cli(auto-detected)clerk/clerk-ios(auto-detected)clerk/clerk-android(auto-detected)
API Changes Report
Summary
@clerk/sharedCurrent version: 4.28.1 Subpath |
Uh oh!
There was an error while loading. Please reload this page.
Right now, we are displaying "10% off first 2 months" for a case where the discount lasts 2 cycles, when it should be "10% off first 2 cycles"
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change