Files
supabase/apps/studio/data/database-columns/database-column-update-mutation.ts
Joshen Lim 163263c3c5 First round of wrapping RQ errors with handleError (#26384)
* First round of wrapping RQ errors with handleError

* Remove the throw before the handleError usage.

* Make the handling of an API error more versatile. Add logging in Sentry if the error is of unknown type.

* Remove throwing of the handleError function.

* Add return type to the handleError function to be never so that we're sure it always throws.

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
2024-05-17 16:30:55 +08:00

67 lines
1.8 KiB
TypeScript

import { useMutation, UseMutationOptions } from '@tanstack/react-query'
import { toast } from 'react-hot-toast'
import type { components } from 'data/api'
import { handleError, patch } from 'data/fetchers'
import type { ResponseError } from 'types'
export type UpdateColumnBody = components['schemas']['UpdateColumnBody']
export type DatabaseColumnUpdateVariables = {
projectRef: string
connectionString?: string
id: string
payload: components['schemas']['UpdateColumnBody']
}
export async function updateDatabaseColumn({
projectRef,
connectionString,
id,
payload,
}: DatabaseColumnUpdateVariables) {
let headers = new Headers()
if (connectionString) headers.set('x-connection-encrypted', connectionString)
const { data, error } = await patch('/platform/pg-meta/{ref}/columns', {
params: {
header: { 'x-connection-encrypted': connectionString! },
path: { ref: projectRef },
query: { id },
},
body: payload,
headers,
})
if (error) handleError(error)
return data
}
type DatabaseColumnUpdateData = Awaited<ReturnType<typeof updateDatabaseColumn>>
export const useDatabaseColumnUpdateMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseMutationOptions<DatabaseColumnUpdateData, ResponseError, DatabaseColumnUpdateVariables>,
'mutationFn'
> = {}) => {
return useMutation<DatabaseColumnUpdateData, ResponseError, DatabaseColumnUpdateVariables>(
(vars) => updateDatabaseColumn(vars),
{
async onSuccess(data, variables, context) {
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to update database column: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
}
)
}