Skip to content

fix(clerk-js): Display alert on plan details error #6384

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jul 31, 2025
Merged

fix(clerk-js): Display alert on plan details error #6384

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
01eb35a
fix(clerk-js): Display alert on plan details error
panteliselef Jul 24, 2025
9edfad5
fix(clerk-js): Display alert on plan details error
panteliselef Jul 24, 2025
4f648b2
address feedback
panteliselef Jul 24, 2025
12a55c1
Merge branch 'main' into elef/com-1068-handle-plan-not-found-in-pland…
panteliselef Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/eighty-breads-knock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Display alert on plan details error
76 changes: 65 additions & 11 deletions packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,32 @@
import { useClerk } from '@clerk/shared/react';
import type { __internal_PlanDetailsProps, CommercePlanResource, CommerceSubscriptionPlanPeriod } from '@clerk/types';
import type {
__internal_PlanDetailsProps,
ClerkAPIResponseError,
CommercePlanResource,
CommerceSubscriptionPlanPeriod,
} from '@clerk/types';
import * as React from 'react';
import { useMemo, useState } from 'react';
import useSWR from 'swr';

import { Alert } from '@/ui/elements/Alert';
import { Avatar } from '@/ui/elements/Avatar';
import { Drawer } from '@/ui/elements/Drawer';
import { Switch } from '@/ui/elements/Switch';

import { SubscriberTypeContext } from '../../contexts';
import { Box, Col, descriptors, Flex, Heading, localizationKeys, Span, Spinner, Text } from '../../customizables';
import {
Box,
Col,
descriptors,
Flex,
Heading,
localizationKeys,
Span,
Spinner,
Text,
useLocalizations,
} from '../../customizables';

export const PlanDetails = (props: __internal_PlanDetailsProps) => {
return (
Expand All @@ -19,6 +36,38 @@ export const PlanDetails = (props: __internal_PlanDetailsProps) => {
);
};

const BodyFiller = ({ children }: { children: React.ReactNode }) => {
return (
<Drawer.Body>
Copy link
Member

@alexcarpenter alexcarpenter Jul 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we apply the padding to the body? Instead of needing the nested flex container without a descriptor?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

possibly add a new variant prop to body padded? to create a consistent padding usage

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the variant does not make much sense, I think it is better to use space.$4 everywhere. There are other places using this long with other settings. I will increase complexity to try to support both.

<Flex
align={'center'}
justify={'center'}
sx={t => ({
height: '100%',
padding: t.space.$4,
fontSize: t.fontSizes.$md,
})}
>
{children}
</Flex>
</Drawer.Body>
);
};

const PlanDetailsError = ({ error }: { error: ClerkAPIResponseError }) => {
const { translateError } = useLocalizations();
return (
<BodyFiller>
<Alert
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be full width?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to force it ? If the error message is large enough it will occupy the necessary space.

Copy link
Member

@alexcarpenter alexcarpenter Jul 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, just kind of feels weird at the size imo. Not a blocker though.

Here is a another error rendering full width already.

Screenshot 2025-07-24 at 3 29 39 PM

variant='danger'
colorScheme='danger'
>
{translateError(error.errors[0])}
</Alert>
</BodyFiller>
);
};

const PlanDetailsInternal = ({
planId,
plan: initialPlan,
Expand All @@ -27,29 +76,34 @@ const PlanDetailsInternal = ({
const clerk = useClerk();
const [planPeriod, setPlanPeriod] = useState<CommerceSubscriptionPlanPeriod>(initialPlanPeriod);

const { data: plan, isLoading } = useSWR(
const {
data: plan,
isLoading,
error,
} = useSWR<CommercePlanResource, ClerkAPIResponseError>(
planId || initialPlan ? { type: 'plan', id: planId || initialPlan?.id } : null,
// @ts-expect-error we are handling it above
() => clerk.billing.getPlan({ id: planId || initialPlan?.id }),
{
fallbackData: initialPlan,
revalidateOnFocus: false,
shouldRetryOnError: false,
keepPreviousData: true,
},
);

if (isLoading && !initialPlan) {
return (
<Flex
justify='center'
align='center'
sx={{
height: '100%',
}}
>
<BodyFiller>
<Spinner />
</Flex>
</BodyFiller>
);
}

if (!plan && error) {
return <PlanDetailsError error={error} />;
}

if (!plan) {
return null;
}
Expand Down
Loading