Files
supabase/apps/studio/components/interfaces/Settings/Addons/IPv4SidePanel.tsx
Alaister Young 5f533247e1 Update docs url to env var (#38772)
* Update Supabase docs URLs to use env variable

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for documentation links

This change centralizes documentation links using a new DOCS_URL constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* Refactor: Use DOCS_URL constant for all documentation links

This change replaces hardcoded documentation URLs with a centralized constant, improving maintainability and consistency.

Co-authored-by: a <a@alaisteryoung.com>

* replace more instances

* ci: Autofix updates from GitHub workflow

* remaining instances

* fix duplicate useRouter

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: alaister <10985857+alaister@users.noreply.github.com>
2025-09-26 10:16:33 +00:00

261 lines
10 KiB
TypeScript

import { PermissionAction } from '@supabase/shared-types/out/constants'
import { ExternalLink } from 'lucide-react'
import Link from 'next/link'
import { useEffect, useState } from 'react'
import { toast } from 'sonner'
import { useParams } from 'common'
import { InlineLink } from 'components/ui/InlineLink'
import { useProjectAddonRemoveMutation } from 'data/subscriptions/project-addon-remove-mutation'
import { useProjectAddonUpdateMutation } from 'data/subscriptions/project-addon-update-mutation'
import { useProjectAddonsQuery } from 'data/subscriptions/project-addons-query'
import type { AddonVariantId } from 'data/subscriptions/types'
import { useAsyncCheckPermissions } from 'hooks/misc/useCheckPermissions'
import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
import { useIsAwsCloudProvider } from 'hooks/misc/useSelectedProject'
import { DOCS_URL } from 'lib/constants'
import { formatCurrency } from 'lib/helpers'
import { useAddonsPagePanel } from 'state/addons-page'
import { Button, Radio, SidePanel, cn } from 'ui'
import { Admonition } from 'ui-patterns'
const IPv4SidePanel = () => {
const isAws = useIsAwsCloudProvider()
const { ref: projectRef } = useParams()
const { data: organization } = useSelectedOrganizationQuery()
const [selectedOption, setSelectedOption] = useState<string>('ipv4_none')
const { can: canUpdateIPv4 } = useAsyncCheckPermissions(
PermissionAction.BILLING_WRITE,
'stripe.subscriptions'
)
const { panel, closePanel } = useAddonsPagePanel()
const visible = panel === 'ipv4'
const { data: addons, isLoading } = useProjectAddonsQuery({ projectRef })
const { mutate: updateAddon, isLoading: isUpdating } = useProjectAddonUpdateMutation({
onSuccess: () => {
toast.success(`Successfully enabled IPv4`)
closePanel()
},
onError: (error) => {
toast.error(`Unable to enable IPv4: ${error.message}`)
},
})
const { mutate: removeAddon, isLoading: isRemoving } = useProjectAddonRemoveMutation({
onSuccess: () => {
toast.success(`Successfully disabled IPv4.`)
closePanel()
},
onError: (error) => {
toast.error(`Unable to disable IPv4: ${error.message}`)
},
})
const isSubmitting = isUpdating || isRemoving
const subscriptionIpV4Option = (addons?.selected_addons ?? []).find(
(addon) => addon.type === 'ipv4'
)
const availableOptions =
(addons?.available_addons ?? []).find((addon) => addon.type === 'ipv4')?.variants ?? []
const isFreePlan = organization?.plan?.id === 'free'
const hasChanges = selectedOption !== (subscriptionIpV4Option?.variant.identifier ?? 'ipv4_none')
const selectedIPv4 = availableOptions.find((option) => option.identifier === selectedOption)
const isPgBouncerEnabled = !isFreePlan
useEffect(() => {
if (visible) {
if (subscriptionIpV4Option !== undefined) {
setSelectedOption(subscriptionIpV4Option.variant.identifier)
} else {
setSelectedOption('ipv4_none')
}
}
}, [visible, isLoading])
const onConfirm = async () => {
if (!projectRef) return console.error('Project ref is required')
if (selectedOption === 'ipv4_none' && subscriptionIpV4Option !== undefined) {
removeAddon({ projectRef, variant: subscriptionIpV4Option.variant.identifier })
} else {
updateAddon({ projectRef, type: 'ipv4', variant: selectedOption as AddonVariantId })
}
}
return (
<SidePanel
size="large"
visible={visible}
onCancel={closePanel}
onConfirm={onConfirm}
loading={isLoading || isSubmitting}
disabled={isFreePlan || isLoading || !hasChanges || isSubmitting || !canUpdateIPv4 || !isAws}
tooltip={
isFreePlan
? 'Unable to enable IPv4 on a Free Plan'
: !canUpdateIPv4
? 'You do not have permission to update IPv4'
: undefined
}
header={
<div className="flex items-center justify-between">
<h4>Dedicated IPv4 address</h4>
<Button asChild type="default" icon={<ExternalLink strokeWidth={1.5} />}>
<Link
href={`${DOCS_URL}/guides/platform/ipv4-address`}
target="_blank"
rel="noreferrer"
>
About dedicated IPv4 addresses
</Link>
</Button>
</div>
}
>
<SidePanel.Content>
<div className="py-6 space-y-4">
<p className="text-sm">
Direct connections to the database only work if your client is able to resolve IPv6
addresses. Enabling the dedicated IPv4 add-on allows you to directly connect to your
database via a IPv4 address.
</p>
{!isAws && (
<Admonition
type="default"
title="Dedicated IPv4 address is only available for AWS projects"
/>
)}
{isPgBouncerEnabled ? (
<Admonition
type="default"
title="The Dedicated Pooler does not support IPv4 addresses"
description="If you are connecting to your database via the Dedicated Pooler, you may need this add-on if your network does not support communicating via IPv6. Alternatively, you may consider using our Shared Pooler."
/>
) : (
<p className="text-sm">
If you are connecting via the Shared connection pooler, you do not need this add-on as
our pooler resolves to IPv4 addresses. You can check your connection info in your{' '}
<InlineLink href={`/project/${projectRef}/database/settings#connection-pooler`}>
project database settings
</InlineLink>
.
</p>
)}
<div className={cn('!mt-8 pb-4', isFreePlan && 'opacity-75')}>
<Radio.Group
type="large-cards"
size="tiny"
id="ipv4"
onChange={(event: any) => setSelectedOption(event.target.value)}
>
<Radio
name="ipv4"
checked={selectedOption === 'ipv4_none'}
className="col-span-4 !p-0"
label="No IPv4"
value="ipv4_none"
>
<div className="w-full group">
<div className="border-b border-default px-4 py-2 group-hover:border-control">
<p className="text-sm">No IPv4 address</p>
</div>
<div className="px-4 py-2 flex flex-col justify-between">
<p className="text-foreground-light">
Use connection pooler or IPv6 for direct connections
</p>
<div className="flex items-center space-x-1 mt-2">
<p className="text-foreground text-sm">$0</p>
<p className="text-foreground-light translate-y-[1px]"> / month</p>
</div>
</div>
</div>
</Radio>
{availableOptions.map((option) => (
<Radio
className="col-span-4 !p-0"
name="ipv4"
key={option.identifier}
disabled={isFreePlan || !isAws}
checked={selectedOption === option.identifier}
label={option.name}
value={option.identifier}
>
<div className="w-full group">
<div className="border-b border-default px-4 py-2 group-hover:border-control">
<p className="text-sm">Dedicated IPv4 address</p>
</div>
<div className="px-4 py-2">
<p className="text-foreground-light">
Allow direct database connections via IPv4 address
</p>
<div className="flex items-center space-x-1 mt-2">
<p className="text-foreground text-sm" translate="no">
{formatCurrency(option.price)}
</p>
<p className="text-foreground-light translate-y-[1px]">
/ month / database
</p>
</div>
</div>
</div>
</Radio>
))}
</Radio.Group>
</div>
{hasChanges && (
<>
<Admonition
type="note"
title="Potential downtime"
description="There might be some downtime when enabling the add-on since some DNS clients might
have cached the old DNS entry. Generally, this should be less than a minute."
/>
{selectedOption !== 'ipv4_none' && (
<p className="text-sm text-foreground-light">
By default, this is only applied to the Primary database for your project. If{' '}
<Link
href="/docs/guides/platform/read-replicas"
className="text-brand"
target="_blank"
>
Read replicas
</Link>{' '}
are used, each replica also gets its own IPv4 address, with a corresponding{' '}
<span className="text-foreground">{formatCurrency(selectedIPv4?.price)}</span>{' '}
charge.
</p>
)}
<p className="text-sm text-foreground-light">
There are no immediate charges. The addon is billed at the end of your billing cycle
based on your usage and prorated to the hour.
</p>
</>
)}
{isFreePlan && (
<Admonition type="note" title="IPv4 add-on is unavailable on the Free Plan">
<p>Upgrade your plan to enable a IPv4 address for your project</p>
<Button asChild type="default">
<Link
href={`/org/${organization?.slug}/billing?panel=subscriptionPlan&source=ipv4SidePanel`}
>
View available plans
</Link>
</Button>
</Admonition>
)}
</div>
</SidePanel.Content>
</SidePanel>
)
}
export default IPv4SidePanel