| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441 |
- import { zodResolver } from '@hookform/resolvers/zod'
- import { useParams } from 'common'
- import { useEffect, useRef, useState } from 'react'
- import { useForm, type SubmitHandler } from 'react-hook-form'
- import { toast } from 'sonner'
- import {
- Button,
- Dialog,
- DialogContent,
- DialogFooter,
- DialogHeader,
- DialogSection,
- DialogSectionSeparator,
- DialogTitle,
- Form,
- FormControl,
- FormField,
- FormMessage,
- Input,
- Select,
- SelectContent,
- SelectItem,
- SelectTrigger,
- SelectValue,
- Switch,
- } from 'ui'
- import { Admonition } from 'ui-patterns'
- import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
- import { z } from 'zod'
- import { StorageSizeUnits } from '@/components/interfaces/Storage/StorageSettings/StorageSettings.constants'
- import {
- convertFromBytes,
- convertToBytes,
- } from '@/components/interfaces/Storage/StorageSettings/StorageSettings.utils'
- import { InlineLink } from '@/components/ui/InlineLink'
- import { useProjectStorageConfigQuery } from '@/data/config/project-storage-config-query'
- import { useBucketUpdateMutation } from '@/data/storage/bucket-update-mutation'
- import { Bucket } from '@/data/storage/buckets-query'
- import { DOCS_URL, IS_PLATFORM } from '@/lib/constants'
- export interface EditBucketModalProps {
- visible: boolean
- bucket: Bucket
- onClose: () => void
- }
- const BucketSchema = z.object({
- name: z.string(),
- public: z.boolean().default(false),
- has_file_size_limit: z.boolean().default(false),
- formatted_size_limit: z.coerce
- .number()
- .min(0, 'File size upload limit has to be at least 0')
- .optional(),
- allowed_mime_types: z.string().trim().default(''),
- })
- const formId = 'edit-storage-bucket-form'
- export const EditBucketModal = ({ visible, bucket, onClose }: EditBucketModalProps) => {
- const { ref } = useParams()
- const { data } = useProjectStorageConfigQuery({ projectRef: ref }, { enabled: IS_PLATFORM })
- const { value, unit } = convertFromBytes(data?.fileSizeLimit ?? 0)
- const formattedGlobalUploadLimit = `${value} ${unit}`
- const bucketIdRef = useRef<string | null>(null)
- const [selectedUnit, setSelectedUnit] = useState<string>(StorageSizeUnits.MB)
- const { value: fileSizeLimit } = convertFromBytes(bucket?.file_size_limit ?? 0)
- const { mutate: updateBucket, isPending: isUpdating } = useBucketUpdateMutation({
- onSuccess: () => {
- toast.success(`Successfully updated bucket "${bucket?.name}"`)
- onClose()
- },
- onError: (error) => {
- // Handle specific error cases for inline display
- const errorMessage = error.message?.toLowerCase() || ''
- if (
- errorMessage.includes('exceeded the maximum allowed size') ||
- errorMessage.includes('maximum allowed size') ||
- errorMessage.includes('entity too large') ||
- errorMessage.includes('payload too large')
- ) {
- // Set form error for the file size limit field
- form.setError('formatted_size_limit', {
- type: 'manual',
- message: `Exceeds global limit of ${formattedGlobalUploadLimit}.`,
- })
- } else if (
- errorMessage.includes('mime type') &&
- (errorMessage.includes('is not supported') || errorMessage.includes('not supported'))
- ) {
- // Set form error for the MIME types field
- form.setError('allowed_mime_types', {
- type: 'manual',
- message: 'Invalid MIME type format. Please check your input.',
- })
- } else {
- // For other errors, show a toast as fallback
- toast.error(`Failed to update bucket: ${error.message || 'Unknown error'}`)
- }
- },
- })
- const defaultValues = {
- name: bucket?.name ?? '',
- public: bucket?.public,
- has_file_size_limit: Boolean(bucket?.file_size_limit),
- formatted_size_limit: bucket?.file_size_limit ? (fileSizeLimit ?? 0) : undefined,
- allowed_mime_types: (bucket?.allowed_mime_types ?? []).join(', '),
- }
- const form = useForm<z.infer<typeof BucketSchema>>({
- resolver: zodResolver(BucketSchema as any),
- defaultValues,
- values: defaultValues,
- mode: 'onSubmit',
- })
- const { formatted_size_limit: formattedSizeLimitError } = form.formState.errors
- const isPublicBucket = form.watch('public')
- const hasFileSizeLimit = form.watch('has_file_size_limit')
- const [hasAllowedMimeTypes, setHasAllowedMimeTypes] = useState(
- Boolean(bucket?.allowed_mime_types?.length)
- )
- const isChangingBucketVisibility = bucket?.public !== isPublicBucket
- const isMakingBucketPrivate = bucket?.public && !isPublicBucket
- const isMakingBucketPublic = !bucket?.public && isPublicBucket
- const closeModal = () => {
- form.reset()
- onClose()
- }
- const onSubmit: SubmitHandler<z.infer<typeof BucketSchema>> = async (values) => {
- if (bucket === undefined) return console.error('Bucket is required')
- if (ref === undefined) return console.error('Project ref is required')
- // Client-side validation: Check if bucket limit exceeds global limit
- // [Joshen] Should shift this into superRefine in the form schema
- if (
- values.has_file_size_limit &&
- values.formatted_size_limit !== undefined &&
- data?.fileSizeLimit
- ) {
- const bucketLimitInBytes = convertToBytes(
- values.formatted_size_limit,
- selectedUnit as StorageSizeUnits
- )
- if (bucketLimitInBytes > data.fileSizeLimit) {
- return form.setError('formatted_size_limit', {
- type: 'manual',
- message: 'exceed_global_limit',
- })
- }
- }
- updateBucket({
- projectRef: ref,
- id: bucket.id,
- isPublic: values.public,
- file_size_limit:
- values.has_file_size_limit && values.formatted_size_limit
- ? convertToBytes(values.formatted_size_limit, selectedUnit as StorageSizeUnits)
- : null,
- allowed_mime_types: hasAllowedMimeTypes
- ? values.allowed_mime_types.length > 0
- ? values.allowed_mime_types.split(',').map((x: string) => x.trim())
- : null
- : null,
- })
- }
- useEffect(() => {
- if (visible && bucket) {
- // Only set the selectedUnit when the bucket changes (different bucket ID)
- // This preserves the user's unit selection when reopening the modal for the same bucket
- if (bucketIdRef.current !== bucket.id && bucket.file_size_limit) {
- const { unit } = convertFromBytes(bucket.file_size_limit)
- setSelectedUnit(unit)
- bucketIdRef.current = bucket.id
- }
- }
- }, [visible, bucket, form])
- return (
- <Dialog
- open={visible}
- onOpenChange={(open) => {
- if (!open) closeModal()
- }}
- >
- <DialogContent>
- <DialogHeader>
- <DialogTitle>{`Edit bucket “${bucket?.name}”`}</DialogTitle>
- </DialogHeader>
- <DialogSectionSeparator />
- <Form {...form}>
- <form id={formId} onSubmit={form.handleSubmit(onSubmit)}>
- <DialogSection className="space-y-6">
- <FormField
- key="name"
- name="name"
- control={form.control}
- render={({ field }) => (
- <FormItemLayout
- hideMessage
- name="name"
- label="Bucket name"
- labelOptional="Cannot be changed after creation"
- >
- <FormControl>
- <Input id="name" {...field} disabled />
- </FormControl>
- </FormItemLayout>
- )}
- />
- <div className="flex flex-col gap-y-3">
- <FormField
- key="public"
- name="public"
- control={form.control}
- render={({ field }) => (
- <FormItemLayout
- hideMessage
- name="public"
- label="Public bucket"
- description="Allow anyone to read objects without authorization"
- layout="flex"
- >
- <FormControl>
- <Switch
- id="public"
- size="large"
- checked={field.value}
- onCheckedChange={field.onChange}
- />
- </FormControl>
- </FormItemLayout>
- )}
- />
- {isChangingBucketVisibility && (
- <Admonition
- type="warning"
- title={`Warning: Making bucket ${isMakingBucketPublic ? 'public' : 'private'}`}
- description={
- <>
- {isMakingBucketPublic && (
- <p>This will make all objects in your bucket publicly accessible.</p>
- )}
- {isMakingBucketPrivate && (
- <>
- <p className="mb-2 leading-normal!">
- All objects in your bucket will only accessible via signed URLs, or
- downloaded with the right authorization headers.
- </p>
- <p className="leading-normal!">
- Assets cached in the CDN may still be publicly accessible. You can
- consider{' '}
- <InlineLink
- href={`${DOCS_URL}/guides/storage/cdn/smart-cdn#cache-eviction`}
- >
- purging the cache
- </InlineLink>{' '}
- or moving your assets to a new bucket.
- </p>
- </>
- )}
- </>
- }
- />
- )}
- </div>
- </DialogSection>
- <DialogSectionSeparator />
- <DialogSection className="space-y-2">
- <FormField
- key="has_file_size_limit"
- name="has_file_size_limit"
- control={form.control}
- render={({ field }) => (
- <FormItemLayout
- name="has_file_size_limit"
- label="Restrict file size"
- description="Prevent uploading of files larger than a specified limit"
- layout="flex"
- >
- <FormControl>
- <Switch
- id="has_file_size_limit"
- size="large"
- checked={field.value}
- onCheckedChange={field.onChange}
- />
- </FormControl>
- </FormItemLayout>
- )}
- />
- {hasFileSizeLimit && (
- <div>
- <FormField
- key="formatted_size_limit"
- name="formatted_size_limit"
- control={form.control}
- render={({ field }) => (
- <FormItemLayout
- hideMessage
- name="formatted_size_limit"
- label="File size limit"
- >
- <div className="grid grid-cols-12 gap-x-2">
- <div className="col-span-8">
- <FormControl>
- <Input
- id="formatted_size_limit"
- aria-label="File size limit"
- type="number"
- min={0}
- placeholder="0"
- {...field}
- />
- </FormControl>
- </div>
- <div className="col-span-4">
- <Select value={selectedUnit} onValueChange={setSelectedUnit}>
- <SelectTrigger aria-label="File size limit unit" size="small">
- <SelectValue>{selectedUnit}</SelectValue>
- </SelectTrigger>
- <SelectContent>
- {Object.values(StorageSizeUnits).map((unit: string) => (
- <SelectItem key={unit} value={unit} className="text-xs">
- {unit}
- </SelectItem>
- ))}
- </SelectContent>
- </Select>
- </div>
- </div>
- </FormItemLayout>
- )}
- />
- {formattedSizeLimitError?.message === 'exceed_global_limit' && (
- <FormMessage className="mt-2">
- Exceeds global limit of {formattedGlobalUploadLimit}. Increase limit in{' '}
- <InlineLink
- className="text-destructive decoration-destructive-500 hover:decoration-destructive"
- href={`/project/${ref}/storage/settings`}
- onClick={onClose}
- >
- Storage Settings
- </InlineLink>{' '}
- first.
- </FormMessage>
- )}
- {IS_PLATFORM && (
- <p className="text-sm text-foreground-lighter mt-2">
- This project has a{' '}
- <InlineLink
- className="text-foreground-light hover:text-foreground"
- href={`/project/${ref}/storage/settings`}
- onClick={onClose}
- >
- global file size limit
- </InlineLink>{' '}
- of {formattedGlobalUploadLimit}.
- </p>
- )}
- </div>
- )}
- </DialogSection>
- <DialogSectionSeparator />
- <DialogSection className="space-y-2">
- <FormItemLayout
- name="has_allowed_mime_types"
- label="Restrict MIME types"
- description="Allow only certain types of files to be uploaded"
- layout="flex"
- >
- <FormControl>
- <Switch
- id="has_allowed_mime_types"
- size="large"
- checked={hasAllowedMimeTypes}
- onCheckedChange={setHasAllowedMimeTypes}
- />
- </FormControl>
- </FormItemLayout>
- {hasAllowedMimeTypes && (
- <FormField
- key="allowed_mime_types"
- name="allowed_mime_types"
- control={form.control}
- render={({ field }) => (
- <FormItemLayout
- name="allowed_mime_types"
- label="Allowed MIME types"
- labelOptional="Comma separated values"
- description="Wildcards are allowed, e.g. image/*."
- >
- <FormControl>
- <Input
- id="allowed_mime_types"
- {...field}
- placeholder="e.g image/jpeg, image/png, audio/mpeg, video/mp4, etc"
- />
- </FormControl>
- </FormItemLayout>
- )}
- />
- )}
- </DialogSection>
- </form>
- </Form>
- <DialogFooter>
- <Button type="default" disabled={isUpdating} onClick={closeModal}>
- Cancel
- </Button>
- <Button form={formId} htmlType="submit" loading={isUpdating}>
- Save
- </Button>
- </DialogFooter>
- </DialogContent>
- </Dialog>
- )
- }
|