Files
supabase/apps/studio/components/interfaces/Reports/CreateReportModal.tsx
Gildas Garcia 96d43099bb chore: refactor Button API so that it can be used a standard button (#46880)
## Problem

Our `<Button>` component breaks the default `button` contract by
redefining the `type` prop to set its variant (`primary`, `default`,
etc) instead of the button type (`submit`, `button`, etc).
This is confusing and forces to write more code when using it with
shadcn components that expect/inject the standard button props.

## Solution

- rename the `type` prop to `variant`
- rename the `htmlType` prop to `type`
- propagate the changes where necessary
- format code

## How to test

As this is just prop renaming, if it builds it's ok

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
2026-06-16 23:59:58 +02:00

170 lines
5.2 KiB
TypeScript

import { zodResolver } from '@hookform/resolvers/zod'
import { useRouter } from 'next/router'
import { useMemo } from 'react'
import { SubmitHandler, useForm } from 'react-hook-form'
import { toast } from 'sonner'
import {
Button,
Dialog,
DialogContent,
DialogFooter,
DialogHeader,
DialogSection,
DialogSectionSeparator,
DialogTitle,
Form,
FormControl,
FormField,
Input,
Textarea,
} from 'ui'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import * as z from 'zod'
import { useContentUpsertMutation } from '@/data/content/content-upsert-mutation'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { uuidv4 } from '@/lib/helpers'
import { useProfile } from '@/lib/profile'
export interface CreateReportModal {
visible: boolean
onCancel: () => void
afterSubmit: () => void
}
const formSchema = z.object({
name: z.string().min(1, 'Required'),
description: z.string().optional(),
})
type CustomReport = z.infer<typeof formSchema>
export const CreateReportModal = ({ visible, onCancel, afterSubmit }: CreateReportModal) => {
const router = useRouter()
const { profile } = useProfile()
const { data: project } = useSelectedProjectQuery()
const ref = project?.ref ?? 'default'
// Preserve date range query parameters when navigating to new report
const preservedQueryParams = useMemo(() => {
const { its, ite, isHelper, helperText } = router.query
const params = new URLSearchParams()
if (its && typeof its === 'string') params.set('its', its)
if (ite && typeof ite === 'string') params.set('ite', ite)
if (isHelper && typeof isHelper === 'string') params.set('isHelper', isHelper)
if (helperText && typeof helperText === 'string') params.set('helperText', helperText)
const queryString = params.toString()
return queryString ? `?${queryString}` : ''
}, [router.query])
const { mutate: upsertContent, isPending: isCreating } = useContentUpsertMutation({
onSuccess: (_, vars) => {
toast.success('Successfully created new report')
const newReportId = vars.payload.id
router.push(`/project/${ref}/observability/${newReportId}${preservedQueryParams}`)
afterSubmit()
},
onError: (error) => {
toast.error(`Failed to create report: ${error.message}`)
},
})
const createCustomReport: SubmitHandler<CustomReport> = async ({ name, description }) => {
if (!ref) return console.error('Project ref is required')
if (!profile) return console.error('Profile is required')
upsertContent({
projectRef: ref,
payload: {
id: uuidv4(),
type: 'report',
name,
description: description || '',
visibility: 'project',
owner_id: profile?.id,
content: {
schema_version: 1,
period_start: {
time_period: '7d',
date: '',
},
period_end: {
time_period: 'today',
date: '',
},
interval: '1d',
layout: [],
},
},
})
}
const handleCancel = () => {
onCancel()
form.reset()
}
const form = useForm<CustomReport>({
resolver: zodResolver(formSchema),
defaultValues: { name: '', description: '' },
})
const { isDirty } = form.formState
return (
<Dialog open={visible} onOpenChange={handleCancel}>
<DialogContent size="small">
<DialogHeader>
<DialogTitle>Create a custom report</DialogTitle>
</DialogHeader>
<DialogSectionSeparator />
<Form {...form}>
<form onSubmit={form.handleSubmit(createCustomReport)} noValidate>
<DialogSection>
<FormField
control={form.control}
name="name"
render={({ field }) => (
<FormItemLayout name="name" layout="vertical" label="Name">
<FormControl>
<Input {...field} id="name" />
</FormControl>
</FormItemLayout>
)}
/>
</DialogSection>
<DialogSection>
<FormField
control={form.control}
name="description"
render={({ field }) => (
<FormItemLayout name="description" layout="vertical" label="Description">
<FormControl>
<Textarea
{...field}
id="description"
rows={4}
placeholder="Describe your custom report"
className="resize-none"
/>
</FormControl>
</FormItemLayout>
)}
/>
</DialogSection>
<DialogFooter>
<Button type="reset" variant="default" onClick={handleCancel} disabled={isCreating}>
Cancel
</Button>
<Button type="submit" loading={isCreating} disabled={isCreating || !isDirty}>
Create report
</Button>
</DialogFooter>
</form>
</Form>
</DialogContent>
</Dialog>
)
}