c36262d7b6
Widgets configured on one dashboard (e.g., a Grafana service's Overview)
can now be live-referenced on other dashboards. Editing the widget config
updates it everywhere it's referenced. References can be detached into
independent clones.
Backend: new widget_references table (dashboard_scope, widget_id,
sort_order) with ON DELETE CASCADE. CRUD methods + 4 endpoints:
GET/POST /api/widgets/references, DELETE /api/widgets/references/{id},
POST /api/widgets/references/{id}/detach (clones the widget into a
standalone instance, then removes the reference).
Frontend: WidgetConfigDialog gains a dashboardScope prop. When set
(the main Dashboard passes 'main'), the dialog shows:
- Owned + referenced widgets in a combined list, with a link badge on
references.
- 'Add existing widget' picker: searchable list of ALL widget instances
not already on this dashboard. Click to create a reference.
- Detach button on references: clones the widget (service_id=NULL) and
removes the reference.
- Delete on a reference removes the REFERENCE (not the original widget).
Dashboard renders referenced widgets alongside owned widgets.
Detaching a service-bound widget clones it with service_id=NULL — the
clone may need re-binding to a service to render correctly. Named
dashboards don't pass dashboardScope yet (pinned-links-only); when they
gain widget support, the backend already handles any scope string.
282 backend tests pass (+2 reference lifecycle); 127 frontend tests
pass; ruff/eslint/tsc/vite all green.
118 lines
3.7 KiB
TypeScript
118 lines
3.7 KiB
TypeScript
import { describe, it, expect, vi, beforeEach } from "vitest";
|
|
import { render, screen } from "@testing-library/react";
|
|
import userEvent from "@testing-library/user-event";
|
|
import { Dashboard } from "../Dashboard";
|
|
import type { DashboardShortcut } from "../../types";
|
|
|
|
// Stub the composed widgets so the test exercises Dashboard's own behavior
|
|
// (shortcut CRUD) without rendering widgets or their data queries.
|
|
vi.mock("../../components/WidgetInstance", () => ({
|
|
WidgetInstanceCard: () => <div data-testid="widget-stub" />,
|
|
}));
|
|
vi.mock("../../components/WidgetConfigDialog", () => ({
|
|
WidgetConfigDialog: () => <div data-testid="widget-config-stub" />,
|
|
}));
|
|
|
|
const navigate = vi.fn();
|
|
vi.mock("react-router-dom", () => ({
|
|
useNavigate: () => navigate,
|
|
}));
|
|
|
|
vi.mock("../../hooks/useSettings", () => ({
|
|
useMonitoringSettings: () => ({ data: [] }),
|
|
}));
|
|
vi.mock("../../hooks/useWidgets", () => ({
|
|
useWidgetInstances: () => ({ data: [] }),
|
|
useWidgetReferences: () => ({ data: [] }),
|
|
}));
|
|
vi.mock("../../hooks/useServices", () => ({
|
|
useServiceInstances: () => ({ data: [] }),
|
|
}));
|
|
|
|
const saveShortcutMutate = vi.fn().mockResolvedValue({});
|
|
const deleteShortcutMutate = vi.fn();
|
|
|
|
let shortcuts: DashboardShortcut[] = [];
|
|
|
|
vi.mock("../../hooks/useDashboard", () => ({
|
|
useActivity: () => ({ data: undefined }),
|
|
useDashboardShortcuts: () => ({ data: shortcuts }),
|
|
useSaveDashboardShortcut: () => ({ mutateAsync: saveShortcutMutate }),
|
|
useDeleteDashboardShortcut: () => ({ mutate: deleteShortcutMutate }),
|
|
}));
|
|
|
|
function websiteShortcut(
|
|
overrides: Partial<DashboardShortcut> = {},
|
|
): DashboardShortcut {
|
|
return {
|
|
id: "s1",
|
|
label: "Wiki",
|
|
shortcut_type: "website",
|
|
enabled: true,
|
|
icon: "📚",
|
|
url: "example.com",
|
|
task_id: "",
|
|
machine_id: "",
|
|
user_id: "",
|
|
notes: "Team wiki",
|
|
created_at: 0,
|
|
updated_at: 0,
|
|
...overrides,
|
|
} as DashboardShortcut;
|
|
}
|
|
|
|
beforeEach(() => {
|
|
navigate.mockReset();
|
|
saveShortcutMutate.mockClear();
|
|
deleteShortcutMutate.mockClear();
|
|
shortcuts = [];
|
|
});
|
|
|
|
describe("Dashboard", () => {
|
|
it("shows the empty-state alert when there are no shortcuts", () => {
|
|
render(<Dashboard />);
|
|
expect(screen.getByText(/No shortcuts yet/)).toBeInTheDocument();
|
|
expect(
|
|
screen.getByRole("button", { name: "Add shortcut" }),
|
|
).toBeInTheDocument();
|
|
});
|
|
|
|
it("renders a shortcut card and deletes it via the confirm dialog", async () => {
|
|
shortcuts = [websiteShortcut()];
|
|
render(<Dashboard />);
|
|
|
|
expect(screen.getByText("Wiki")).toBeInTheDocument();
|
|
|
|
// Open the delete confirm.
|
|
await userEvent.click(screen.getByRole("button", { name: "Delete" }));
|
|
expect(screen.getByText("Delete shortcut?")).toBeInTheDocument();
|
|
|
|
// Confirm deletion -> delete mutation fires with the shortcut id.
|
|
const dialogs = screen.getAllByRole("button", { name: "Delete" });
|
|
// The card "Delete" plus the confirm "Delete"; confirm is the last one.
|
|
await userEvent.click(dialogs[dialogs.length - 1]);
|
|
expect(deleteShortcutMutate).toHaveBeenCalledTimes(1);
|
|
expect(deleteShortcutMutate).toHaveBeenCalledWith("s1");
|
|
});
|
|
|
|
it("creates a shortcut via the dialog and saves it", async () => {
|
|
render(<Dashboard />);
|
|
|
|
await userEvent.click(screen.getByRole("button", { name: "Add shortcut" }));
|
|
|
|
// Edit dialog opens in "New shortcut" mode.
|
|
expect(screen.getByText("New shortcut")).toBeInTheDocument();
|
|
|
|
// Fill the label and save.
|
|
await userEvent.type(screen.getByLabelText("Label"), "Grafana");
|
|
await userEvent.click(
|
|
screen.getByRole("button", { name: "Save shortcut" }),
|
|
);
|
|
|
|
expect(saveShortcutMutate).toHaveBeenCalledTimes(1);
|
|
const saved = saveShortcutMutate.mock.calls[0][0];
|
|
expect(saved.label).toBe("Grafana");
|
|
expect(saved.shortcut_type).toBe("website");
|
|
});
|
|
});
|