deer-flow/frontend/tests/unit/components/workspace/sidecar-delete-gating.dom.test.tsx
hataa ec0ac474c4
feat(authz): gate thread-delete and run-cancel UI on effective permissions (Phase 4, #4063) (#5294)
* feat(authz): gate thread-delete and run-cancel UI on effective permissions (Phase 4, #4063)

Consume the effective route permissions surfaced by #5228 so the UI hides
actions the caller's role cannot perform:

- threads:delete hides the sidebar thread-row Delete menu item and the
  sidecar panel delete button (every useDeleteThread consumer)
- runs:cancel disables the composer stop affordance; all three stop entry
  points converge on one check inside handleStopStreaming

hasPermission treats an absent/null/unresolved permission list as
permissive, so a mixed old-backend/new-frontend deploy never hides actions
the caller can still perform. The Gateway @require_permission guards
remain the single enforcement point.

* fix(authz): review follow-ups for stop gating (comment accuracy, a11y, tests)

- Correct the defense-in-depth comment: the submit-button click is the
  only live entry into handleStopStreaming (handleSubmit returns early
  with the pleaseWaitStreaming toast while streaming, so the kind==="stop"
  branch is unreachable); the handler gate stays as future-proofing.
- Explain the disabled stop affordance with aria-label + title (Radix
  tooltips don't fire on disabled buttons), with en-US/zh-CN strings.
- Add the composer stop-gating DOM tests (disabled + onStop never fires +
  permissive default) and the sidebar delete-menu gating tests, so all
  gated surfaces carry wiring tests.

* fix(authz): stop conditional aria-label from stripping the submit name

The stop-gating follow-up (1612855b) explained the disabled stop
affordance with aria-label/title but passed explicitly-undefined
values in the non-denied case. PromptInputSubmit declares its default
aria-label="Submit" before {...props}, so the undefined key landed in
the spread and clobbered the default: React omits the attribute
entirely and the submit control lost its accessible name in every
state, which broke the sidecar e2e layout helper (it locates the
button by its "Submit" label).

Spread the attributes conditionally so they only attach when
stopDenied, and lock the invariant with a DOM test asserting the base
"Submit" name survives when stop is not denied (mutation-verified:
reverting the conditional spread turns the new test red).

* test(authz): drop unused rerenderWith helper, guard accessible name by role query

Address the review nit on the stop-gating DOM tests: the
rerenderWith helper was never called, and a second render() would
append a composer instead of updating the first one anyway — drop it
(the sidecar-delete-gating tests already demonstrate the correct
rerender pattern if a granted->denied flip test is ever needed).

Also resolve the accessible-name regression guard through
getByRole("button", { name: "Submit" }) so it fails exactly the way
e2e and assistive tech consume the control (mutation-verified: the
explicitly-undefined aria-label form turns it red).

---------

Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
2026-09-12 10:40:54 +08:00

149 lines
4.7 KiB
TypeScript

import { afterEach, describe, expect, it, rs } from "@rstest/core";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { cleanup, render, screen, waitFor } from "@testing-library/react";
import { useEffect, type ReactNode } from "react";
import { ThreadContext } from "@/components/workspace/messages/context";
import {
SidecarProvider,
useSidecar,
} from "@/components/workspace/sidecar/context";
import { SidecarPanel } from "@/components/workspace/sidecar/sidecar-panel";
import { AuthProvider, useAuth } from "@/core/auth/AuthProvider";
import type { User } from "@/core/auth/types";
import { DEFAULT_LOCALE } from "@/core/i18n";
import { I18nProvider } from "@/core/i18n/context";
// AuthProvider and the panel both reach into next/navigation. Keep it inert
// under happy-dom (banner-test pattern).
rs.mock("next/navigation", () => ({
useRouter: () => ({ push: rs.fn(), replace: rs.fn(), refresh: rs.fn() }),
usePathname: () => "/workspace",
useSearchParams: () => new URLSearchParams(),
}));
// The panel's model list is irrelevant to the delete-button gating; keep the
// react-query machinery out of the way entirely.
rs.mock("@/core/models/hooks", () => ({
useModels: () => ({
models: [],
tokenUsageEnabled: false,
isLoading: false,
isFetching: false,
error: null,
refetch: rs.fn(),
}),
}));
function makeUser(permissions: string[] | null | undefined): User {
return {
id: "user-1",
email: "user@example.test",
system_role: "user",
needs_setup: false,
oauth_provider: null,
...(permissions === undefined ? {} : { permissions }),
} as User;
}
/** Sets the provider's sidecarThreadId so the panel switches out of its
* empty state — the delete button only renders for a live sidecar thread. */
function SidecarThreadProbe() {
const sidecar = useSidecar();
useEffect(() => {
sidecar.setSidecarThreadId("sidecar-thread-1");
}, [sidecar]);
return null;
}
/** Replaces the authenticated user in place via the auth context. */
function FlipUserProbe({ to }: { to: User }) {
const { applyUser } = useAuth();
useEffect(() => {
applyUser(to);
}, [applyUser, to]);
return null;
}
function buildTree(
initialUser: User,
{
withFlip = false,
flipTo = makeUser(["threads:read"]),
queryClient = new QueryClient({
defaultOptions: {
queries: { retry: false },
mutations: { retry: false },
},
}),
} = {},
): ReactNode {
return (
<I18nProvider initialLocale={DEFAULT_LOCALE}>
<QueryClientProvider client={queryClient}>
<AuthProvider initialUser={initialUser}>
{withFlip && <FlipUserProbe to={flipTo} />}
<ThreadContext.Provider
value={{ thread: { messages: [] } as never, isMock: true }}
>
<SidecarProvider
parentThreadId="parent-1"
isMock
context={{ thread_id: "parent-1" } as never}
>
<SidecarThreadProbe />
<SidecarPanel />
</SidecarProvider>
</ThreadContext.Provider>
</AuthProvider>
</QueryClientProvider>
</I18nProvider>
);
}
afterEach(() => {
rs.restoreAllMocks();
cleanup();
});
describe("SidecarPanel delete-button permission gating", () => {
it("renders the delete button for a role holding threads:delete", async () => {
render(buildTree(makeUser(["threads:read", "threads:delete"])));
expect(await screen.findByTestId("sidecar-delete-button")).not.toBeNull();
});
it("keeps the delete button for an unresolved permission list (pre-Phase-4 backend)", async () => {
render(buildTree(makeUser(undefined)));
expect(await screen.findByTestId("sidecar-delete-button")).not.toBeNull();
});
it("hides the delete button once the resolved list denies threads:delete", async () => {
// Anchor on presence first, then flip only the permission list in place —
// the disappearance is then provably caused by the gating, not by the
// sidecar thread never mounting. The shared queryClient keeps the rerender
// a true in-place update rather than a provider remount.
const queryClient = new QueryClient({
defaultOptions: {
queries: { retry: false },
mutations: { retry: false },
},
});
const { rerender } = render(
buildTree(makeUser(["threads:delete"]), { queryClient }),
);
expect(await screen.findByTestId("sidecar-delete-button")).not.toBeNull();
rerender(
buildTree(makeUser(["threads:delete"]), {
withFlip: true,
flipTo: makeUser(["threads:read"]),
queryClient,
}),
);
await waitFor(() => {
expect(screen.queryByTestId("sidecar-delete-button")).toBeNull();
});
});
});