Files
supabase/apps/studio/components/grid/hooks/useOperationQueueActions.ts
T
Joshen Lim f90f3b4d14 Revert "Revert "Fix queue operations stale state + refactor to reuse existing…" (#42291)
TBD

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* OS-aware modifier-key label shown in UI (⌘ on macOS, Ctrl+ on others)
  * Tooltips added to operation queue actions for improved usability

* **Bug Fixes**
  * Warns before applying non-primary-key sorts on large tables
  * Clarified access error messages for organizations and projects

* **Refactor**
  * Redesigned hotkey handling and operation-queue shortcuts
* Operation queue view toggle and save flow refined (panel auto-closes
after save)

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-01-30 10:44:42 +08:00

82 lines
2.9 KiB
TypeScript

import { useQueryClient } from '@tanstack/react-query'
import { tableRowKeys } from 'data/table-rows/keys'
import { useOperationQueueSaveMutation } from 'data/table-rows/operation-queue-save-mutation'
import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
import { useCallback } from 'react'
import { toast } from 'sonner'
import { useGetImpersonatedRoleState } from 'state/role-impersonation-state'
import { useTableEditorStateSnapshot } from 'state/table-editor'
import { QueuedOperation } from 'state/table-editor-operation-queue.types'
interface UseOperationQueueActionsOptions {
onSaveSuccess?: () => void
onCancelSuccess?: () => void
}
/**
* Hook that provides save and cancel actions for the operation queue.
* Consolidates the logic used by both the useSaveQueueToast hook and OperationQueueSidePanel.
*/
export function useOperationQueueActions(options: UseOperationQueueActionsOptions = {}) {
const { onSaveSuccess, onCancelSuccess } = options
const queryClient = useQueryClient()
const { data: project } = useSelectedProjectQuery()
const snap = useTableEditorStateSnapshot()
const getImpersonatedRoleState = useGetImpersonatedRoleState()
const { mutate: saveOperationQueue, isPending: isMutationPending } =
useOperationQueueSaveMutation({
onSuccess: () => {
snap.clearQueue()
snap.closeSidePanel()
toast.success('Changes saved successfully')
onSaveSuccess?.()
},
onError: (error) => {
snap.setQueueStatus('idle')
toast.error(`Failed to save changes: ${error.message}`)
},
})
const isSaving = snap.operationQueue.status === 'saving' || isMutationPending
const operations = snap.operationQueue.operations as readonly QueuedOperation[]
const handleSave = useCallback(() => {
if (!project || operations.length === 0) return
snap.setQueueStatus('saving')
saveOperationQueue({
projectRef: project.ref,
connectionString: project.connectionString,
operations,
roleImpersonationState: getImpersonatedRoleState(),
})
}, [snap, project, operations, saveOperationQueue, getImpersonatedRoleState])
const handleCancel = useCallback(() => {
// Get unique table IDs from the queue before clearing
const operations = snap.operationQueue.operations as readonly QueuedOperation[]
const tableIds = [...new Set(operations.map((op) => op.tableId))]
// Clear the queue and invalidate queries to revert optimistic updates
snap.clearQueue()
if (project) {
// Invalidate queries for each table that had pending operations
tableIds.forEach((tableId) => {
queryClient.invalidateQueries({
queryKey: tableRowKeys.tableRowsAndCount(project.ref, tableId),
})
})
}
onCancelSuccess?.()
}, [snap, project, queryClient, onCancelSuccess])
return {
handleSave,
handleCancel,
isSaving,
}
}