diff --git a/litellm/proxy/management_endpoints/key_management_endpoints.py b/litellm/proxy/management_endpoints/key_management_endpoints.py index 72c2d32c20b..bcb93f2d2ef 100644 --- a/litellm/proxy/management_endpoints/key_management_endpoints.py +++ b/litellm/proxy/management_endpoints/key_management_endpoints.py @@ -3412,6 +3412,7 @@ async def _process_single_key_update( """ # Validate max_budget _validate_max_budget(update_key_request.max_budget) + validate_budget_duration(update_key_request.budget_duration) check_permissions_caller_permission( data=update_key_request, @@ -4468,6 +4469,8 @@ async def bulk_update_keys( - key: str - The key identifier (token) to update - budget_id: Optional[str] - Budget ID associated with the key - max_budget: Optional[float] - Max budget for key + - budget_duration: Optional[str] - Budget reset period, or null to stop resetting + - user_id: Optional[str] - Owner user ID, or null to remove the owner - team_id: Optional[str] - Team ID associated with key - tags: Optional[List[str]] - Tags for organizing keys - object_permission: Optional[LiteLLM_ObjectPermissionBase] - key-specific object permission, as on /key/update diff --git a/litellm/types/proxy/management_endpoints/key_management_endpoints.py b/litellm/types/proxy/management_endpoints/key_management_endpoints.py index d4f41b538e6..234ae48635e 100644 --- a/litellm/types/proxy/management_endpoints/key_management_endpoints.py +++ b/litellm/types/proxy/management_endpoints/key_management_endpoints.py @@ -35,6 +35,8 @@ class BulkUpdateKeyRequestItem(LiteLLMBaseModel): key: str # Key identifier (token) budget_id: str | None = None # Budget ID associated with the key max_budget: float | None = None # Max budget for key + budget_duration: str | None = None + user_id: str | None = None team_id: str | None = None # Team ID associated with key tags: list[str] | None = None # Tags for organizing keys object_permission: LiteLLM_ObjectPermissionBase | None = None diff --git a/litellm/ui/litellm-dashboard/src/app/(dashboard)/hooks/keys/useKeys.ts b/litellm/ui/litellm-dashboard/src/app/(dashboard)/hooks/keys/useKeys.ts index 32dac9c2f65..c702ad628a1 100644 --- a/litellm/ui/litellm-dashboard/src/app/(dashboard)/hooks/keys/useKeys.ts +++ b/litellm/ui/litellm-dashboard/src/app/(dashboard)/hooks/keys/useKeys.ts @@ -1,5 +1,6 @@ import { keepPreviousData, + type QueryClient, useInfiniteQuery, useQuery, UseQueryResult, @@ -145,6 +146,12 @@ export const useInfiniteKeys = (pageSize: number, options: KeyListCallOptions = }; export const deletedKeyKeys = createQueryKeys("deletedKeys"); + +export const invalidateKeyQueries = (queryClient: QueryClient) => + Promise.allSettled( + [keyKeys, deletedKeyKeys, infiniteKeyKeys].map((keys) => queryClient.invalidateQueries({ queryKey: keys.all })), + ); + export const useDeletedKeys = ( page: number, pageSize: number, diff --git a/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysBulkActions.tsx b/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysBulkActions.tsx new file mode 100644 index 00000000000..e98fb262c3f --- /dev/null +++ b/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysBulkActions.tsx @@ -0,0 +1,253 @@ +"use client"; + +import { useIsMutating, useMutation, useQueryClient } from "@tanstack/react-query"; +import type { Table } from "@tanstack/react-table"; +import type { TFunction } from "i18next"; +import { ChevronDown, DollarSign, ListChecks, Trash2, UserRound, UsersRound } from "lucide-react"; +import { useState } from "react"; +import { useTranslation } from "react-i18next"; + +import { invalidateKeyQueries } from "@/app/(dashboard)/hooks/keys/useKeys"; +import DeleteResourceModal from "@/components/common_components/DeleteResourceModal"; +import type { KeyResponse } from "@/components/key_team_helpers/key_list"; +import { keyBulkUpdateCall, keyDeleteCall, type BulkKeyUpdateResponse } from "@/components/networking"; +import { parseErrorMessage } from "@/components/shared/errorUtils"; +import { Button } from "@/components/ui/button"; +import { + DropdownMenu, + DropdownMenuContent, + DropdownMenuItem, + DropdownMenuSeparator, + DropdownMenuTrigger, +} from "@/components/ui/dropdown-menu"; +import { toast } from "@/lib/toast"; +import { VirtualKeysBulkEditDialog, type BulkKeyEditAction, type BulkKeyEditValues } from "./VirtualKeysBulkEditDialog"; + +const BULK_MUTATION_KEY = ["keys", "bulkAction"] as const; +type KeyTarget = Readonly>; +type BulkDialog = { + action: BulkKeyEditAction | "delete"; + targets: readonly KeyTarget[]; + failures?: BulkKeyUpdateResponse["failed_updates"]; +}; + +interface VirtualKeysBulkActionsProps { + table: Table; + accessToken: string; + disabled: boolean; + canEdit: boolean; + selectionMode: boolean; + onSelectionModeChange: (enabled: boolean) => void; +} + +function targetsAreEligible(table: Table, dialog: BulkDialog | null): boolean { + if (!dialog || dialog.targets.length === 0) return false; + return dialog.targets.every((target) => { + const row = table.getRowModel().rows.find((row) => row.original.token === target.token); + if (!row) return dialog.action !== "delete"; + if (!row.getCanSelect()) return false; + return dialog.action !== "team" || !row.original.project_id; + }); +} + +function bulkActionError(error: unknown, selectionChanged: boolean, isDelete: boolean, t: TFunction): string | null { + if (error) return parseErrorMessage(error); + if (!selectionChanged) return null; + return t( + isDelete + ? "apiKeys.virtualKeysTable.bulkDelete.selectionChanged" + : "apiKeys.virtualKeysTable.bulkEdit.selectionChanged", + ); +} + +export function VirtualKeysBulkActions({ + table, + accessToken, + disabled, + canEdit, + selectionMode, + onSelectionModeChange, +}: VirtualKeysBulkActionsProps) { + const { t } = useTranslation(); + const queryClient = useQueryClient(); + const [dialog, setDialog] = useState(null); + const targets = dialog?.targets ?? []; + const isDelete = dialog?.action === "delete"; + const isPending = useIsMutating({ mutationKey: BULK_MUTATION_KEY }) > 0; + const deleteOptions = { + mutationKey: [...BULK_MUTATION_KEY, "delete"], + mutationFn: (keys: readonly KeyTarget[]) => + keyDeleteCall( + accessToken, + keys.map((key) => key.token), + ), + retry: false, + onSuccess: (_: unknown, keys: readonly KeyTarget[]) => + toast.success(t("apiKeys.virtualKeysTable.bulkDelete.success", { count: keys.length })), + onSettled: () => invalidateKeyQueries(queryClient), + }; + const deletion = useMutation(deleteOptions); + const updateOptions = { + mutationKey: [...BULK_MUTATION_KEY, "update"], + mutationFn: ({ keys, values }: { keys: readonly KeyTarget[]; values: BulkKeyEditValues }) => + keyBulkUpdateCall( + accessToken, + keys.map((key) => ({ key: key.token, ...values })), + ), + retry: false, + onSuccess: (result: BulkKeyUpdateResponse) => { + if (result.successful_updates.length > 0) { + toast.success(t("apiKeys.virtualKeysTable.bulkEdit.success", { count: result.successful_updates.length })); + } + }, + onSettled: () => invalidateKeyQueries(queryClient), + }; + const update = useMutation(updateOptions); + + const selectedRows = table.getSelectedRowModel().rows; + const canOpen = !disabled && selectedRows.length > 0 && selectedRows.every((row) => row.getCanSelect()); + const canMoveToTeam = selectedRows.every(({ original }) => !original.project_id); + const actionAllowed = isDelete || canEdit; + const canConfirm = !disabled && actionAllowed && targetsAreEligible(table, dialog); + + const openDialog = (action: BulkDialog["action"]) => { + if (!canOpen || isPending) return; + if (action !== "delete" && !canEdit) return; + if (action === "team" && !canMoveToTeam) return; + deletion.reset(); + update.reset(); + setDialog({ + action, + targets: selectedRows.map(({ original }) => ({ token: original.token, key_alias: original.key_alias })), + }); + }; + + const closeDialog = () => { + if (queryClient.isMutating({ mutationKey: BULK_MUTATION_KEY }) > 0) return; + setDialog(null); + deletion.reset(); + update.reset(); + }; + + const confirmDelete = () => { + if (!canConfirm || queryClient.isMutating({ mutationKey: BULK_MUTATION_KEY }) > 0) return; + deletion.mutate(targets, { + onSuccess: () => { + table.resetRowSelection(); + setDialog(null); + }, + }); + }; + const confirmUpdate = (values: BulkKeyEditValues) => { + if (!dialog || !canConfirm) return; + if (!canEdit || queryClient.isMutating({ mutationKey: BULK_MUTATION_KEY }) > 0) return; + update.mutate( + { keys: dialog.targets, values }, + { + onSuccess: (result) => { + const succeeded = new Set(result.successful_updates.map((key) => key.key)); + table.setRowSelection((current) => + Object.fromEntries(Object.entries(current).filter(([token]) => !succeeded.has(token))), + ); + const remaining = dialog.targets.filter((target) => !succeeded.has(target.token)); + setDialog(remaining.length > 0 ? { ...dialog, targets: remaining, failures: result.failed_updates } : null); + }, + }, + ); + }; + + const mutationError = isDelete ? deletion.error : update.error; + const selectionChanged = Boolean(dialog) && !disabled && !canConfirm; + const displayError = bulkActionError(mutationError, selectionChanged, isDelete, t); + + if (!selectionMode) { + return ( + + ); + } + + return ( + <> + + {t("apiKeys.virtualKeysTable.bulkDelete.selected", { count: selectedRows.length })} + + + {selectedRows.length > 0 && ( + + } disabled={!canOpen || isPending}> + {t("apiKeys.virtualKeysTable.bulkActions.menu")} + + + + {canEdit && ( + <> + openDialog("team")} + disabled={!canMoveToTeam} + title={!canMoveToTeam ? t("apiKeys.virtualKeysTable.bulkEdit.projectTeamLocked") : undefined} + > + + {t("apiKeys.virtualKeysTable.bulkEdit.team")} + + openDialog("user")}> + + {t("apiKeys.virtualKeysTable.bulkEdit.user")} + + openDialog("budget")}> + + {t("apiKeys.virtualKeysTable.bulkEdit.budget")} + + + + )} + openDialog("delete")}> + + {t("apiKeys.virtualKeysTable.bulkDelete.action", { count: selectedRows.length })} + + + + )} + [ + { + label: t("apiKeys.virtualKeysTable.bulkDelete.keyAlias", { number: index + 1 }), + value: target.key_alias || t("apiKeys.virtualKeysTable.bulkDelete.noAlias"), + }, + { + label: t("apiKeys.virtualKeysTable.bulkDelete.keyId", { number: index + 1 }), + value: target.token, + code: true, + }, + ])} + onCancel={closeDialog} + onOk={confirmDelete} + confirmLoading={isPending} + confirmDisabled={!canConfirm} + requiredConfirmation={t("apiKeys.virtualKeysTable.bulkDelete.requiredConfirmation")} + errorMessage={displayError} + /> + {dialog && dialog.action !== "delete" && ( + + )} + + ); +} diff --git a/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysBulkEditDialog.tsx b/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysBulkEditDialog.tsx new file mode 100644 index 00000000000..e5654fae5fd --- /dev/null +++ b/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysBulkEditDialog.tsx @@ -0,0 +1,198 @@ +"use client"; + +import { useId, useState, type FormEvent } from "react"; +import { useTranslation } from "react-i18next"; + +import BudgetDurationDropdown from "@/components/common_components/budget_duration_dropdown"; +import TeamDropdown from "@/components/common_components/team_dropdown"; +import UserDropdown from "@/components/common_components/UserDropdown"; +import { Button } from "@/components/ui/button"; +import { + Dialog, + DialogContent, + DialogDescription, + DialogFooter, + DialogHeader, + DialogTitle, +} from "@/components/ui/dialog"; +import { Field, FieldError, FieldLabel, FieldSet } from "@/components/ui/field"; +import { Input } from "@/components/ui/input"; + +export type BulkKeyEditAction = "team" | "user" | "budget"; +export type BulkKeyEditValues = + | { team_id: string } + | { user_id: string } + | { max_budget: number; budget_duration: string }; + +interface VirtualKeysBulkEditDialogProps { + action: BulkKeyEditAction; + targets: readonly { token: string; key_alias?: string | null }[]; + pending: boolean; + disabled: boolean; + errorMessage?: string | null; + failures?: readonly { key: string; failed_reason: string }[]; + onCancel: () => void; + onConfirm: (values: BulkKeyEditValues) => void; +} + +const parseBudget = (input: string): number | null => { + if (input.trim() === "") return null; + const amount = Number(input); + return Number.isFinite(amount) && amount >= 0 ? amount : null; +}; + +export function VirtualKeysBulkEditDialog({ + action, + targets, + pending, + disabled, + errorMessage, + failures = [], + onCancel, + onConfirm, +}: VirtualKeysBulkEditDialogProps) { + const { t } = useTranslation(); + const fieldId = useId(); + const [teamId, setTeamId] = useState(null); + const [userId, setUserId] = useState(null); + const [budgetInput, setBudgetInput] = useState(""); + const [duration, setDuration] = useState("30d"); + const locked = pending || disabled; + const budget = parseBudget(budgetInput); + const invalidBudget = budgetInput !== "" && budget === null; + const valuesByAction: Record = { + team: teamId ? { team_id: teamId } : null, + user: userId ? { user_id: userId } : null, + budget: budget !== null && duration ? { max_budget: budget, budget_duration: duration } : null, + }; + const values = valuesByAction[action]; + const canApply = !locked && values !== null && targets.length > 0; + + const cancel = () => { + if (!pending) onCancel(); + }; + + const submit = (event: FormEvent) => { + event.preventDefault(); + if (!canApply || !values) return; + onConfirm(values); + }; + + return ( + !open && cancel()}> + + + {t(`apiKeys.virtualKeysTable.bulkEdit.${action}`)} + {t(`apiKeys.virtualKeysTable.bulkEdit.descriptions.${action}`)} + +
+

{t("apiKeys.virtualKeysTable.bulkEdit.selected", { count: targets.length })}

+
    + {targets.map((target) => ( +
  • + {target.key_alias || target.token} +
  • + ))} +
+
+
+
+ {action === "team" && ( + + + {t("apiKeys.virtualKeysTable.bulkEdit.fields.team")} + + !locked && setTeamId(value)} + disabled={locked} + /> + + )} + {action === "user" && ( + + + {t("apiKeys.virtualKeysTable.bulkEdit.fields.user")} + + !locked && setUserId(value)} + disabled={locked} + /> + + )} + {action === "budget" && ( + <> + + + {t("apiKeys.virtualKeysTable.bulkEdit.fields.budget")} + + !locked && setBudgetInput(event.target.value)} + disabled={locked} + aria-invalid={invalidBudget} + aria-describedby={invalidBudget ? `${fieldId}-budget-error` : undefined} + /> + {invalidBudget && ( + + {t("apiKeys.virtualKeysTable.bulkEdit.invalidBudget")} + + )} + + + + {t("apiKeys.virtualKeysTable.bulkEdit.fields.resetPeriod")} + + !locked && setDuration(value)} + placeholder={t("apiKeys.virtualKeysTable.bulkEdit.resetPeriodPlaceholder")} + /> + {duration === null && ( + {t("apiKeys.virtualKeysTable.bulkEdit.resetPeriodRequired")} + )} + + + )} +
+ {errorMessage && {errorMessage}} + {failures.length > 0 && ( +
+

{t("apiKeys.virtualKeysTable.bulkEdit.partialFailure", { count: failures.length })}

+
    + {failures.map((failure) => ( +
  • +

    + {targets.find((target) => target.token === failure.key)?.key_alias || failure.key} +

    +

    {failure.failed_reason}

    +
  • + ))} +
+
+ )} + + + + +
+
+
+ ); +} diff --git a/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysTable.integration.test.tsx b/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysTable.integration.test.tsx new file mode 100644 index 00000000000..37b23fc0c5e --- /dev/null +++ b/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysTable.integration.test.tsx @@ -0,0 +1,323 @@ +import { act, fireEvent, screen, waitFor, within } from "@testing-library/react"; +import userEvent from "@testing-library/user-event"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import type { KeyResponse } from "../key_team_helpers/key_list"; +import { chooseSelectOption, renderWithProviders, testQueryClient } from "../../../tests/test-utils"; +import { VirtualKeysTable } from "./VirtualKeysTable"; + +vi.unmock("@/app/(dashboard)/hooks/useAuthorized"); +vi.mock("next/navigation", () => ({ + usePathname: () => "/ui/api-keys/", + useRouter: () => ({ push: vi.fn() }), +})); + +const keys = ["First key", "Second key", "Keep key"].map((key_alias, index) => ({ + token: `hashed-token-${index}`, + key_alias, + user_id: "user-1", + models: [], + spend: 0, + max_budget: 100, +})) satisfies Partial[]; + +const keyPage = (rows: readonly Partial[] = keys, total = rows.length, page = 1, size = 50) => { + const response = { keys: rows, total_count: total, current_page: page, total_pages: Math.ceil(total / size) }; + return Response.json(response); +}; + +const updatedKeysResponse = (rows = keys.slice(0, 2)) => + Response.json({ + total_requested: rows.length, + successful_updates: rows.map(({ token }) => ({ key: token, key_info: {} })), + failed_updates: [], + }); + +const installApi = (rows: readonly Partial[] = keys, role = "proxy_admin") => { + const list = vi.fn<() => Response | Promise>(() => keyPage(rows)); + const remove = vi.fn<() => Promise>(async () => Response.json({ deleted_keys: [] })); + const update = vi.fn<(request: Request) => Promise>(async () => updatedKeysResponse()); + const responses: Record = { + "/ui/litellm-runtime-config.json": {}, + "/litellm/.well-known/litellm-ui-config": { + server_root_path: "/", + proxy_base_url: null, + gateway_base_url: null, + admin_ui_disabled: false, + }, + "/management/v1/users/me": { user_id: "user-1", user_email: "user@example.com", user_role: role }, + "/get/ui_settings": { values: {} }, + "/organization/list": [], + "/v2/team/list": { teams: [], total: 0, page: 1, page_size: 100, total_pages: 1 }, + }; + const fetch: typeof globalThis.fetch = async (input, init) => { + const request = + input instanceof Request ? input : new Request(new URL(String(input), window.location.origin), init); + const path = new URL(request.url).pathname; + if (path === "/key/list") return list(); + if (path === "/key/delete") return remove(); + if (path === "/key/bulk_update") return update(request); + if (path in responses) return Response.json(responses[path]); + throw new Error(`Unexpected request: ${request.method} ${path}`); + }; + vi.stubGlobal("fetch", fetch); + return { list, remove, update, responses }; +}; + +const rowCheckbox = (alias: string) => + within(screen.getByRole("row", { name: new RegExp(alias) })).getByRole("checkbox"); + +const selectFirstTwo = async () => { + await screen.findByRole("row", { name: /First key/ }, { timeout: 5000 }); + expect(screen.queryByRole("checkbox")).not.toBeInTheDocument(); + fireEvent.click(await screen.findByRole("button", { name: "Select keys", exact: true })); + expect(screen.queryByRole("button", { name: "Actions", exact: true })).not.toBeInTheDocument(); + await waitFor(() => expect(rowCheckbox("First key")).not.toHaveAttribute("aria-disabled", "true")); + fireEvent.click(rowCheckbox("First key")); + fireEvent.click(rowCheckbox("Second key")); +}; + +const openAction = async (user: ReturnType, action: "delete" | "budget") => { + const option = action === "delete" ? "Delete selected (2)" : "Set budget"; + await chooseSelectOption(user, screen.getByRole("button", { name: "Actions", exact: true }), option, "menuitem"); + const dialog = await screen.findByRole("dialog"); + if (action === "budget") { + fireEvent.change(within(dialog).getByRole("spinbutton", { name: "Budget per key (USD)" }), { + target: { value: "25" }, + }); + } + return dialog; +}; + +beforeEach(() => { + testQueryClient.clear(); + localStorage.clear(); + const token = `${btoa("{}")}.${btoa(JSON.stringify({ key: "test-token", premium_user: true }))}.test`; + document.cookie = `token=${token}; path=/`; +}); + +afterEach(() => { + testQueryClient.clear(); + document.cookie = "token=; Max-Age=0; path=/"; + vi.unstubAllGlobals(); +}); + +describe("Virtual Keys bulk actions", () => { + it("keeps selection unavailable when the initial key request fails", async () => { + const api = installApi(); + api.list.mockRejectedValue(new TypeError("Key list unavailable")); + renderWithProviders(); + expect(await screen.findByRole("alert", {}, { timeout: 5000 })).toHaveTextContent("Failed to load"); + expect(await screen.findByRole("button", { name: "Select keys", exact: true })).toBeDisabled(); + expect(screen.queryByRole("checkbox")).not.toBeInTheDocument(); + }); + + it("requires exact delete confirmation and clears it on cancel and reopen without losing selection", async () => { + const api = installApi(); + const user = userEvent.setup(); + renderWithProviders(); + await selectFirstTwo(); + const dialog = await openAction(user, "delete"); + const submit = within(dialog).getByRole("button", { name: "Delete", exact: true }); + expect(submit).toBeDisabled(); + for (const value of ["delete", "Confirm delete", "confirm delete "]) { + fireEvent.change(within(dialog).getByRole("textbox"), { target: { value } }); + expect(submit).toBeDisabled(); + } + fireEvent.change(within(dialog).getByRole("textbox"), { target: { value: "confirm delete" } }); + expect(submit).toBeEnabled(); + await user.click(within(dialog).getByRole("button", { name: "Cancel", exact: true })); + expect(rowCheckbox("First key")).toBeChecked(); + expect(rowCheckbox("Second key")).toBeChecked(); + const reopened = await openAction(user, "delete"); + expect(within(reopened).getByRole("textbox")).toHaveValue(""); + expect(within(reopened).getByRole("button", { name: "Delete", exact: true })).toBeDisabled(); + await user.click(within(reopened).getByRole("button", { name: "Cancel", exact: true })); + await user.click(screen.getByRole("button", { name: "Cancel selection" })); + expect(screen.queryByRole("checkbox")).not.toBeInTheDocument(); + await user.click(await screen.findByRole("button", { name: "Select keys", exact: true })); + expect(screen.queryAllByRole("checkbox", { checked: true })).toHaveLength(0); + expect(screen.queryByRole("button", { name: "Actions", exact: true })).not.toBeInTheDocument(); + expect(api.remove).not.toHaveBeenCalled(); + }); + + it("blocks a confirmed deletion if selected rows disappear on refetch", async () => { + const api = installApi(); + const user = userEvent.setup(); + renderWithProviders(); + await selectFirstTwo(); + const dialog = await openAction(user, "delete"); + fireEvent.change(within(dialog).getByRole("textbox"), { target: { value: "confirm delete" } }); + const submit = within(dialog).getByRole("button", { name: "Delete", exact: true }); + expect(submit).toBeEnabled(); + api.list.mockReturnValue(keyPage([keys[2]])); + await act(async () => testQueryClient.invalidateQueries({ queryKey: ["keys"] })); + await waitFor(() => expect(submit).toBeDisabled()); + expect(api.remove).not.toHaveBeenCalled(); + }); + + it.each(["delete", "budget"] as const)( + "preserves selection after mutation and list errors and locks pending %s retries", + async (action) => { + const api = installApi(); + const pending = Promise.withResolvers(); + const mutation = action === "delete" ? api.remove : api.update; + mutation.mockRejectedValueOnce(new TypeError("Network connection lost")).mockReturnValueOnce(pending.promise); + const user = userEvent.setup(); + renderWithProviders(); + await selectFirstTwo(); + const firstCheckbox = rowCheckbox("First key"); + const secondCheckbox = rowCheckbox("Second key"); + const cancelSelection = screen.getByRole("button", { name: "Cancel selection" }); + const dialog = await openAction(user, action); + if (action === "delete") { + fireEvent.change(within(dialog).getByRole("textbox"), { target: { value: "confirm delete" } }); + } + const submit = within(dialog).getByRole("button", { + name: action === "delete" ? "Delete" : "Apply to 2 keys", + exact: true, + }); + api.list.mockRejectedValueOnce(new TypeError("Key list unavailable")); + await user.click(submit); + expect(await within(dialog).findByText("Network connection lost")).toBeVisible(); + expect(api.list).toHaveBeenCalledTimes(2); + expect(firstCheckbox).toBeInTheDocument(); + expect(firstCheckbox).toBeChecked(); + expect(secondCheckbox).toBeInTheDocument(); + expect(secondCheckbox).toBeChecked(); + expect(submit).toBeEnabled(); + expect(mutation).toHaveBeenCalledOnce(); + + await user.dblClick(submit); + expect(submit).toBeDisabled(); + expect(cancelSelection).toBeDisabled(); + const cancel = within(dialog).getByRole("button", { name: "Cancel", exact: true }); + expect(cancel).toBeDisabled(); + await user.click(cancel); + await user.keyboard("{Escape}"); + expect(dialog).toBeInTheDocument(); + expect(mutation).toHaveBeenCalledTimes(2); + await act(async () => + pending.resolve(action === "delete" ? Response.json({ deleted_keys: [] }) : updatedKeysResponse()), + ); + await waitFor(() => expect(screen.queryByRole("dialog")).not.toBeInTheDocument()); + expect(screen.getByText("0 keys selected")).toBeVisible(); + expect(rowCheckbox("First key")).not.toBeChecked(); + expect(screen.queryByRole("button", { name: "Actions", exact: true })).not.toBeInTheDocument(); + expect(mutation).toHaveBeenCalledTimes(2); + }, + ); + + it.each(["off-page", "failed"])("retries only the failed key snapshot after %s refetch", async (refetch) => { + const api = installApi(); + api.list.mockReturnValue(keyPage(keys.slice(0, 2), 3, 1, 2)); + const response = { + total_requested: 2, + successful_updates: [{ key: keys[0].token, key_info: {} }], + failed_updates: [{ key: keys[1].token, key_info: null, failed_reason: "Budget exceeds team limit" }], + }; + api.update.mockResolvedValueOnce(Response.json(response)).mockResolvedValueOnce(updatedKeysResponse([keys[1]])); + const user = userEvent.setup(); + renderWithProviders(, { searchParams: "?page_size=2&sort_by=max_budget&sort_order=asc" }); + await selectFirstTwo(); + const firstCheckbox = rowCheckbox("First key"); + const secondCheckbox = rowCheckbox("Second key"); + const dialog = await openAction(user, "budget"); + if (refetch === "failed") { + api.list.mockRejectedValue(new TypeError("Key list unavailable")); + } else { + api.list.mockImplementation(() => keyPage([{ ...keys[0], max_budget: 25 }, keys[2]], 3, 1, 2)); + } + await user.click(within(dialog).getByRole("button", { name: "Apply to 2 keys" })); + + await waitFor(() => expect(firstCheckbox).not.toBeChecked()); + if (refetch === "failed") expect(secondCheckbox).toBeChecked(); + else expect(secondCheckbox).not.toBeInTheDocument(); + expect(firstCheckbox).toBeInTheDocument(); + expect(within(dialog).getByText("Budget exceeds team limit")).toBeInTheDocument(); + expect(dialog).toHaveTextContent("Second key"); + expect(within(dialog).queryByText("First key")).not.toBeInTheDocument(); + const retry = within(dialog).getByRole("button", { name: /Apply to 1 key/ }); + expect(retry).toBeEnabled(); + await user.click(retry); + + await waitFor(() => expect(screen.queryByRole("dialog")).not.toBeInTheDocument()); + expect(api.update).toHaveBeenCalledTimes(2); + const body: { keys: { key: string }[] } = await api.update.mock.calls[1][0].clone().json(); + expect(body.keys.map(({ key }) => key)).toEqual([keys[1].token]); + }); + + it.each(["internal_user", "proxy_admin_viewer", "internal_user_viewer"])( + "restricts bulk actions for %s", + async (role) => { + installApi(keys, role); + const user = userEvent.setup(); + renderWithProviders(); + await screen.findByRole("row", { name: /First key/ }); + if (role === "internal_user") { + await selectFirstTwo(); + await user.click(screen.getByRole("button", { name: "Actions", exact: true })); + expect(await screen.findByRole("menuitem", { name: "Delete selected (2)" })).not.toHaveAttribute( + "aria-disabled", + "true", + ); + } else { + expect(screen.queryByRole("checkbox")).not.toBeInTheDocument(); + expect(screen.queryByRole("button", { name: "Select keys", exact: true })).not.toBeInTheDocument(); + } + expect( + screen.queryByRole("menuitem", { name: /Move to team|Assign to user|Set budget/ }), + ).not.toBeInTheDocument(); + }, + ); + + it("excludes deleted rows from select-all and prevents moving selected project keys to a team", async () => { + installApi([{ ...keys[0], project_id: "project-1" }, keys[1], { ...keys[2], deleted_at: "2026-01-02T00:00:00Z" }]); + const user = userEvent.setup(); + renderWithProviders(); + await screen.findByRole("row", { name: /First key/ }); + await user.click(await screen.findByRole("button", { name: "Select keys", exact: true })); + await waitFor(() => expect(rowCheckbox("First key")).not.toHaveAttribute("aria-disabled", "true")); + fireEvent.click(screen.getByRole("checkbox", { name: "Select all rows" })); + expect(rowCheckbox("First key")).toBeChecked(); + expect(rowCheckbox("Keep key")).toHaveAttribute("aria-disabled", "true"); + expect(rowCheckbox("Keep key")).not.toBeChecked(); + await user.click(screen.getByRole("button", { name: "Actions", exact: true })); + expect(await screen.findByRole("menuitem", { name: "Move to team" })).toHaveAttribute("aria-disabled", "true"); + expect(screen.getByRole("menuitem", { name: "Assign to user" })).not.toHaveAttribute("aria-disabled", "true"); + expect(screen.getByRole("menuitem", { name: "Set budget" })).not.toHaveAttribute("aria-disabled", "true"); + }); + + it.each(["search", "page", "status", "auth"] as const)("exits selection when the %s scope changes", async (scope) => { + const api = installApi(); + api.list.mockReturnValue(keyPage(keys, 51)); + const user = userEvent.setup(); + renderWithProviders(); + await selectFirstTwo(); + const pending = Promise.withResolvers(); + api.list.mockReturnValueOnce(pending.promise); + if (scope === "search") { + fireEvent.change(screen.getByTestId("datatable-search"), { target: { value: "Keep" } }); + expect(screen.getByRole("button", { name: "Select keys", exact: true })).toBeDisabled(); + } else if (scope === "page") { + await user.click(screen.getByRole("button", { name: "Go to next page" })); + } else if (scope === "auth") { + api.responses["/management/v1/users/me"] = { user_id: "user-2", user_role: "proxy_admin" }; + await act(async () => testQueryClient.invalidateQueries({ queryKey: ["currentUser"] })); + } else { + await user.click(screen.getByRole("button", { name: "Filters" })); + await chooseSelectOption(user, screen.getByRole("combobox", { name: "Status" }), "Deleted"); + await user.click(screen.getByTestId("filter-drawer-apply")); + } + await waitFor(() => expect(screen.queryByRole("button", { name: "Cancel selection" })).not.toBeInTheDocument()); + expect(screen.queryByRole("button", { name: "Actions", exact: true })).not.toBeInTheDocument(); + expect(screen.queryByRole("checkbox")).not.toBeInTheDocument(); + expect(api.update).not.toHaveBeenCalled(); + expect(api.remove).not.toHaveBeenCalled(); + if (scope === "auth") return; + await waitFor(() => expect(api.list).toHaveBeenCalledTimes(2)); + const nextRow = scope === "status" ? { ...keys[2], deleted_at: "2026-01-02T00:00:00Z" } : keys[2]; + await act(async () => pending.resolve(keyPage([nextRow], scope === "page" ? 51 : 1, scope === "page" ? 2 : 1))); + await screen.findByRole("row", { name: /Keep key/ }); + expect(screen.queryByRole("checkbox")).not.toBeInTheDocument(); + }); +}); diff --git a/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysTable.tsx b/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysTable.tsx index ec55b160b6b..e98ed60510e 100644 --- a/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysTable.tsx +++ b/litellm/ui/litellm-dashboard/src/components/VirtualKeysPage/VirtualKeysTable.tsx @@ -2,12 +2,14 @@ import { useKeyInfo } from "@/app/(dashboard)/hooks/keys/useKeyInfo"; import { useKeys } from "@/app/(dashboard)/hooks/keys/useKeys"; +import useAuthorized from "@/app/(dashboard)/hooks/useAuthorized"; import { useOrganizations } from "@/app/(dashboard)/hooks/organizations/useOrganizations"; import { useTeamMemberBudgets } from "@/app/(dashboard)/hooks/teams/useTeamMemberBudgets"; import { useApplyUserBudgetToTeamKeys } from "@/app/(dashboard)/hooks/uiSettings/useApplyUserBudgetToTeamKeys"; import { useAllTeams } from "@/app/(dashboard)/hooks/teams/useTeams"; import { DEBOUNCE_WAIT_MS } from "@/utils/debounceConstants"; import { + createSelectionColumn, DataTable, DataTableFilterDrawer, DataTableFilterField, @@ -23,17 +25,26 @@ import { PageHeader, PageHeaderControls, PageHeaderDescription, PageHeaderTitle import { Input } from "@/components/ui/input"; import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@/components/ui/select"; import { useDebouncedValue } from "@tanstack/react-pacer/debouncer"; -import { ColumnFiltersState, functionalUpdate, OnChangeFn } from "@tanstack/react-table"; +import { + ColumnFiltersState, + functionalUpdate, + OnChangeFn, + type Row, + type RowSelectionState, +} from "@tanstack/react-table"; import { KeyRound } from "lucide-react"; import { parseAsString, useQueryState } from "nuqs"; import { useResetDetailState } from "@/hooks/useUrlTab"; import React, { useCallback, useMemo, useState } from "react"; import type { ParseKeys } from "i18next"; import { useTranslation } from "react-i18next"; +import { canModifyKey } from "@/utils/keyPermissions"; +import { isProxyAdminRole } from "@/utils/roles"; import { KeyResponse, Team } from "../key_team_helpers/key_list"; import KeyInfoView from "../templates/key_info_view"; import { getKeyTableColumns, KEY_TABLE_HIDDEN_COLUMNS, KEY_TABLE_SORT_FIELDS } from "./keyTableColumns"; +import { VirtualKeysBulkActions } from "./VirtualKeysBulkActions"; interface VirtualKeysTableProps { headerActions?: React.ReactNode; @@ -92,8 +103,30 @@ const appliedFilter = (filters: ColumnFiltersState, column: FilterColumn): strin return typeof value === "string" ? value : undefined; }; +function useScopedRowSelection(scope: string) { + const [selection, setSelection] = useState<{ scope: string; enabled: boolean; rows: RowSelectionState }>({ + scope, + enabled: false, + rows: {}, + }); + if (selection.scope !== scope) { + setSelection({ scope, enabled: false, rows: {} }); + } + const selectionMode = selection.scope === scope && selection.enabled; + const rowSelection = selection.scope === scope ? selection.rows : {}; + const setSelectionMode = (enabled: boolean) => setSelection({ scope, enabled, rows: {} }); + const onRowSelectionChange: OnChangeFn = (updater) => + setSelection((current) => ({ + scope, + enabled: current.scope === scope && current.enabled, + rows: functionalUpdate(updater, current.scope === scope ? current.rows : {}), + })); + return { rowSelection, onRowSelectionChange, selectionMode, setSelectionMode }; +} + export function VirtualKeysTable({ headerActions }: VirtualKeysTableProps) { const { t } = useTranslation(); + const { accessToken, token, userId, userRole, isViewOnly, isAuthorized, isLoading: isAuthLoading } = useAuthorized(); const { data: fetchedOrganizations } = useOrganizations(); const organizations = useMemo(() => fetchedOrganizations ?? [], [fetchedOrganizations]); const { data: fetchedTeams } = useAllTeams(); @@ -171,7 +204,41 @@ export function VirtualKeysTable({ headerActions }: VirtualKeysTableProps) { }), [allTeams, organizations, teamMemberBudgets, setSelectedKeyId, applyUserBudgetToTeamKeys, resetDetailState], ); - const columns = useMemo(() => getKeyTableColumns(columnDeps, t), [columnDeps, t]); + const isReadOnly = isViewOnly || !isAuthorized || isAuthLoading; + const bulkSelectionAllowed = Boolean(accessToken && userId) && !isReadOnly && keyListOptions.status !== "deleted"; + const hasCurrentRows = !isPending && !isPlaceholderData && keys !== undefined; + const selectionReady = bulkSelectionAllowed && hasCurrentRows && searchInput === searchQuery; + const selectionScope = JSON.stringify([ + token, + accessToken, + userId, + userRole, + isViewOnly, + isAuthorized, + isAuthLoading, + pagination, + sorting, + searchInput, + searchQuery, + columnFilters, + selectedKeyId, + ]); + const { rowSelection, onRowSelectionChange, selectionMode, setSelectionMode } = useScopedRowSelection(selectionScope); + const isRowSelectable = (row: Row) => { + if (!selectionMode || !selectionReady || !row.original.token || row.original.deleted_at) return false; + return canModifyKey(row.original, allTeams, userId, userRole); + }; + const columns = useMemo(() => { + const keyColumns = getKeyTableColumns(columnDeps, t); + if (!bulkSelectionAllowed || !selectionMode) return keyColumns; + return [ + createSelectionColumn({ + rowAriaLabel: ({ original }) => + t("apiKeys.virtualKeysTable.bulkDelete.selectKey", { key: original.key_alias || original.token }), + }), + ...keyColumns, + ]; + }, [columnDeps, t, bulkSelectionAllowed, selectionMode]); const selectedKeyFromList = useMemo( () => keyList.find((key) => key.token === selectedKeyId), @@ -267,6 +334,9 @@ export function VirtualKeysTable({ headerActions }: VirtualKeysTableProps) { data={keyList} columns={columns} getRowId={(row) => row.token} + enableRowSelection={isRowSelectable} + rowSelection={rowSelection} + onRowSelectionChange={onRowSelectionChange} columnVisibility={columnVisibility} onColumnVisibilityChange={onColumnVisibilityChange} sortingMode="server" @@ -299,7 +369,19 @@ export function VirtualKeysTable({ headerActions }: VirtualKeysTableProps) { onOpenFilters={() => setFiltersOpen(true)} filterLabels={filterLabels} formatFilterValue={formatFilterValue} - /> + > + {bulkSelectionAllowed && accessToken && ( + + )} + void; onOk: () => void; confirmLoading: boolean; + confirmDisabled?: boolean; requiredConfirmation?: string; errorMessage?: string | null; } @@ -35,11 +36,13 @@ export default function DeleteResourceModal({ onCancel, onOk, confirmLoading, + confirmDisabled = false, requiredConfirmation, errorMessage, }: DeleteResourceModalProps) { const { t } = useTranslation(); const [requiredConfirmationInput, setRequiredConfirmationInput] = useState(""); + const confirmationMissing = Boolean(requiredConfirmation && requiredConfirmationInput !== requiredConfirmation); useEffect(() => { if (isOpen) { @@ -115,7 +118,7 @@ export default function DeleteResourceModal({