Both overviews carried the same toolbar twice, left-aligned, with a search
field permanently taking a row of width. One `OverviewToolbar` now serves
them: the search folds into an icon and expands again on click (Escape puts
it away and hands focus back), create is a `+`, and everything sits right of
the page. Each page keeps its own create dialog — the toolbar only renders
the trigger — so the testids the runtime spec and the capture script drive
stayed where they were.
Dashboards get the flow store's draft/publish split. The editor autosaves
`dashboard.draft.json` beside `dashboard.json`; `/view/{name}`, `bindings_for`
and `history_requirements` keep reading the published file, so a wall panel
sees an edit only once someone publishes it. `POST /dashboards/{name}/publish`
and `/discard` mirror the flow routes down to the version precondition and the
409, `GET /dashboards/{name}?draft=true` is what the editor asks for, and the
dock grows the same Publish button — which flushes a queued save first, so an
autosave in flight is not published around. Creating a dashboard still writes
the published file directly: an empty document on a panel is harmless, and it
keeps the store free of a never-published case.
"Publish all" is a checkmark in the toolbar, live only when something actually
has `has_draft`. A summary carries no version and publish needs the one it is
based on, so each document's detail is read immediately before its publish —
honest against a stale list, and no version-less backend path to maintain.
Failures are counted rather than swallowed: three of five fails says so and
names the three.
598 lines
18 KiB
TypeScript
598 lines
18 KiB
TypeScript
import { useMutation, useQueryClient } from "@tanstack/react-query"
|
|
import { useNavigate } from "@tanstack/react-router"
|
|
import {
|
|
Check,
|
|
ExternalLink,
|
|
Loader2,
|
|
Pencil,
|
|
Plus,
|
|
Settings2,
|
|
} from "lucide-react"
|
|
import { motion } from "motion/react"
|
|
import { type CSSProperties, useEffect, useRef, useState } from "react"
|
|
import {
|
|
GridLayout,
|
|
type Layout,
|
|
type Position,
|
|
setTransform,
|
|
} from "react-grid-layout"
|
|
import "react-grid-layout/css/styles.css"
|
|
|
|
import {
|
|
type ApiError,
|
|
type DashboardDef_Output,
|
|
DashboardsService,
|
|
type Placement,
|
|
type WidgetDef,
|
|
} from "@/client"
|
|
import { CanvasTitle } from "@/components/Flow/CanvasTitle"
|
|
import { Button } from "@/components/ui/button"
|
|
import {
|
|
Popover,
|
|
PopoverContent,
|
|
PopoverTrigger,
|
|
} from "@/components/ui/popover"
|
|
import { Separator } from "@/components/ui/separator"
|
|
import { Tabs, TabsList, TabsTrigger } from "@/components/ui/tabs"
|
|
import {
|
|
Tooltip,
|
|
TooltipContent,
|
|
TooltipTrigger,
|
|
} from "@/components/ui/tooltip"
|
|
import useCustomToast from "@/hooks/useCustomToast"
|
|
import { slideUp, transitions } from "@/lib/motion"
|
|
import { cn } from "@/lib/utils"
|
|
import { handleError } from "@/utils"
|
|
import {
|
|
CanvasSurface,
|
|
canvasOf,
|
|
columnsOf,
|
|
type Dashboard,
|
|
DashboardView,
|
|
GRID_GAP,
|
|
isPlaced,
|
|
pagesOf,
|
|
placement,
|
|
ROW_HEIGHT,
|
|
rowsOf,
|
|
sectionsOf,
|
|
widgetsOf,
|
|
} from "./DashboardView"
|
|
import { DashboardPanel, WidgetPanel } from "./panels"
|
|
import { dashboardKeys, usePublishDashboard, useSaveDashboard } from "./queries"
|
|
import {
|
|
WIDGET_LABELS,
|
|
WIDGET_SIZES,
|
|
WidgetBody,
|
|
WidgetFrame,
|
|
type WidgetKind,
|
|
widgetIssue,
|
|
} from "./widgets"
|
|
|
|
const KINDS = Object.keys(WIDGET_LABELS) as WidgetKind[]
|
|
|
|
/** How long to sit on edits before saving, so typing is not a save per key. */
|
|
const AUTOSAVE_MS = 800
|
|
|
|
/**
|
|
* Controls a widget owns. A press on one of these is the widget's own — a
|
|
* slider still slides in edit mode — so it never counts as picking the widget.
|
|
*/
|
|
const INTERACTIVE =
|
|
"button, a, input, select, textarea, [role='switch'], [role='combobox'], [role='slider'], .react-resizable-handle"
|
|
|
|
function nextId(dashboard: DashboardDef_Output, type: string): string {
|
|
const taken = new Set(
|
|
pagesOf(dashboard).flatMap((page) =>
|
|
sectionsOf(page).flatMap((section) =>
|
|
widgetsOf(section).map((widget) => widget.id),
|
|
),
|
|
),
|
|
)
|
|
let candidate = type
|
|
for (let i = 2; taken.has(candidate); i++) candidate = `${type}${i}`
|
|
return candidate
|
|
}
|
|
|
|
/**
|
|
* Positions for a dashboard nobody has arranged yet.
|
|
*
|
|
* Widths were the only thing the old editor set, so every widget sits at 0,0.
|
|
* Shelf-packing them into the grid is what the browser was doing implicitly;
|
|
* writing it down is what lets them be dragged from there.
|
|
*/
|
|
function packed(widgets: WidgetDef[], columns: number): Layout {
|
|
let x = 0
|
|
let y = 0
|
|
let shelf = 0
|
|
return widgets.map((widget) => {
|
|
const { w = 3, h = 2 } = placement(widget)
|
|
const width = Math.min(columns, Math.max(1, w))
|
|
if (x + width > columns) {
|
|
x = 0
|
|
y += shelf
|
|
shelf = 0
|
|
}
|
|
const item = { i: widget.id, x, y, w: width, h: Math.max(1, h) }
|
|
x += width
|
|
shelf = Math.max(shelf, item.h)
|
|
return item
|
|
})
|
|
}
|
|
|
|
function layoutOf(widgets: WidgetDef[], columns: number): Layout {
|
|
if (!isPlaced(widgets)) return packed(widgets, columns)
|
|
return widgets.map((widget) => {
|
|
const { x = 0, y = 0, w = 3, h = 2 } = placement(widget)
|
|
const width = Math.min(columns, Math.max(1, w))
|
|
return {
|
|
i: widget.id,
|
|
x: Math.min(columns - width, Math.max(0, x)),
|
|
y: Math.max(0, y),
|
|
w: width,
|
|
h: Math.max(1, h),
|
|
}
|
|
})
|
|
}
|
|
|
|
/**
|
|
* How the grid positions and drags items on a CSS-scaled surface.
|
|
*
|
|
* The library's own `createScaledStrategy` divides the drag delta by the scale
|
|
* but drops the container offset while doing it, so a widget jumps on pick-up.
|
|
* Leaving `calcDragPosition` unset keeps its parent-relative maths, which
|
|
* already divides by `scale` — the only thing that needed saying.
|
|
*/
|
|
const scaledStrategy = (scale: number) => ({
|
|
type: "transform" as const,
|
|
scale,
|
|
calcStyle: setTransform as (pos: Position) => CSSProperties,
|
|
})
|
|
|
|
const same = (a: Layout, b: Layout) =>
|
|
a.length === b.length &&
|
|
a.every((item, index) => {
|
|
const other = b[index]
|
|
return (
|
|
other &&
|
|
item.i === other.i &&
|
|
item.x === other.x &&
|
|
item.y === other.y &&
|
|
item.w === other.w &&
|
|
item.h === other.h
|
|
)
|
|
})
|
|
|
|
/**
|
|
* A dashboard, viewed or edited, over the same dotted canvas the flows use.
|
|
*
|
|
* View mode never mounts the grid library: a wall panel that only displays
|
|
* should not pay for the code that lets someone drag things around.
|
|
*/
|
|
export function DashboardEditor({
|
|
dashboard,
|
|
edit,
|
|
}: {
|
|
dashboard: Dashboard
|
|
edit: boolean
|
|
}) {
|
|
const [draft, setDraft] = useState<Dashboard>(dashboard)
|
|
const [selected, setSelected] = useState<string | null>(null)
|
|
const [settingsOpen, setSettingsOpen] = useState(false)
|
|
const [pageId, setPageId] = useState<string | undefined>(
|
|
() => pagesOf(dashboard)[0]?.id,
|
|
)
|
|
const navigate = useNavigate()
|
|
const queryClient = useQueryClient()
|
|
const save = useSaveDashboard(dashboard.name)
|
|
const publish = usePublishDashboard(dashboard.name)
|
|
const { showErrorToast } = useCustomToast()
|
|
const timer = useRef<ReturnType<typeof setTimeout> | null>(null)
|
|
// The save that is already on its way, so a publish waits for it instead of
|
|
// going out with the version it is about to replace.
|
|
const inflight = useRef<Promise<void> | null>(null)
|
|
// The saved version is what the next save is based on; without following it
|
|
// the second save of a session is always a conflict.
|
|
const version = useRef(dashboard.version)
|
|
|
|
useEffect(() => {
|
|
version.current = dashboard.version
|
|
}, [dashboard.version])
|
|
|
|
const store = (next: Dashboard) => {
|
|
const request = save
|
|
.mutateAsync({ ...next, version: version.current })
|
|
.then((saved) => {
|
|
version.current = saved.version
|
|
})
|
|
.catch((error) => handleError.call(showErrorToast, error as ApiError))
|
|
inflight.current = request
|
|
return request
|
|
}
|
|
|
|
const commit = (next: Dashboard) => {
|
|
setDraft(next)
|
|
if (timer.current) clearTimeout(timer.current)
|
|
timer.current = setTimeout(() => {
|
|
timer.current = null
|
|
void store(next)
|
|
}, AUTOSAVE_MS)
|
|
}
|
|
|
|
/** Send what is queued and wait for the server to have it. */
|
|
const flush = async () => {
|
|
if (timer.current) {
|
|
clearTimeout(timer.current)
|
|
timer.current = null
|
|
await store(draft)
|
|
return
|
|
}
|
|
await inflight.current
|
|
}
|
|
|
|
/** Put the stored draft live. Publishing what is queued means saving first. */
|
|
const publishDashboard = async () => {
|
|
await flush()
|
|
publish.mutate(version.current ?? 1)
|
|
}
|
|
|
|
const remove = useMutation({
|
|
mutationFn: () => DashboardsService.deleteDashboard({ name: draft.name }),
|
|
onSuccess: () => {
|
|
queryClient.invalidateQueries({ queryKey: dashboardKeys.all })
|
|
navigate({ to: "/dashboards" })
|
|
},
|
|
onError: handleError.bind(showErrorToast),
|
|
})
|
|
|
|
// What the server says about the stored document, not about the local edit:
|
|
// a save in flight is still "no unpublished changes" until it lands.
|
|
const hasDraft = Boolean(dashboard.has_draft)
|
|
const columns = columnsOf(draft)
|
|
const pages = pagesOf(draft)
|
|
const page = pages.find((candidate) => candidate.id === pageId) ?? pages[0]
|
|
const section = page ? sectionsOf(page)[0] : undefined
|
|
const widgets = section ? widgetsOf(section) : []
|
|
const canvas = canvasOf(draft)
|
|
|
|
const updateWidgets = (next: WidgetDef[]) => {
|
|
if (!page || !section) return
|
|
commit({
|
|
...draft,
|
|
pages: pagesOf(draft).map((candidate) =>
|
|
candidate.id !== page.id
|
|
? candidate
|
|
: {
|
|
...candidate,
|
|
sections: sectionsOf(candidate).map((existing) =>
|
|
existing.id !== section.id
|
|
? existing
|
|
: { ...existing, widgets: next },
|
|
),
|
|
},
|
|
),
|
|
})
|
|
}
|
|
|
|
const addWidget = (type: WidgetKind) => {
|
|
const id = nextId(draft, type)
|
|
const bottom = layoutOf(widgets, columns).reduce(
|
|
(lowest, item) => Math.max(lowest, item.y + item.h),
|
|
0,
|
|
)
|
|
updateWidgets([
|
|
...widgets,
|
|
{
|
|
id,
|
|
type,
|
|
title: WIDGET_LABELS[type],
|
|
layout: { lg: { x: 0, y: bottom, ...WIDGET_SIZES[type] } },
|
|
config: type === "chart" ? { series: [{}] } : {},
|
|
},
|
|
])
|
|
setSettingsOpen(false)
|
|
setSelected(id)
|
|
}
|
|
|
|
const patch = (id: string, changes: Partial<WidgetDef>) =>
|
|
updateWidgets(
|
|
widgets.map((widget) =>
|
|
widget.id === id ? { ...widget, ...changes } : widget,
|
|
),
|
|
)
|
|
|
|
const layout = layoutOf(widgets, columns)
|
|
|
|
/** Store what the grid ended up doing, unless it did nothing. */
|
|
const applyLayout = (next: Layout) => {
|
|
if (same(layout, next)) return
|
|
const byId = new Map(next.map((item) => [item.i, item]))
|
|
updateWidgets(
|
|
widgets.map((widget) => {
|
|
const item = byId.get(widget.id)
|
|
if (!item) return widget
|
|
const placed: Placement = {
|
|
x: item.x,
|
|
y: item.y,
|
|
w: item.w,
|
|
h: item.h,
|
|
}
|
|
return {
|
|
...widget,
|
|
layout: { ...(widget.layout ?? {}), lg: placed },
|
|
}
|
|
}),
|
|
)
|
|
}
|
|
|
|
const active = widgets.find((widget) => widget.id === selected) ?? null
|
|
const panelOpen = Boolean(active) || settingsOpen
|
|
|
|
const setEdit = (next: boolean) => {
|
|
setSelected(null)
|
|
setSettingsOpen(false)
|
|
navigate({
|
|
to: "/dashboards/$name",
|
|
params: { name: draft.name },
|
|
search: next ? { edit: true } : {},
|
|
})
|
|
}
|
|
|
|
const body = !page ? (
|
|
<p className="text-sm text-muted-foreground">
|
|
This dashboard has no pages yet.
|
|
</p>
|
|
) : edit && widgets.length === 0 ? (
|
|
<p className="text-sm text-muted-foreground" data-testid="dashboard-empty">
|
|
Nothing on this page yet. Add a widget from the bar below.
|
|
</p>
|
|
) : (
|
|
<CanvasSurface dashboard={draft} dots={edit}>
|
|
{(scale) =>
|
|
!edit ? (
|
|
<DashboardView dashboard={draft} pageId={page.id} />
|
|
) : (
|
|
<GridLayout
|
|
width={canvas.width}
|
|
layout={layout}
|
|
onLayoutChange={applyLayout}
|
|
positionStrategy={scaledStrategy(scale)}
|
|
gridConfig={{
|
|
cols: columns,
|
|
rowHeight: ROW_HEIGHT,
|
|
margin: [GRID_GAP, GRID_GAP],
|
|
containerPadding: [0, 0],
|
|
// The canvas is the constraint: nothing may be dragged off the
|
|
// panel it is being drawn for.
|
|
maxRows: rowsOf(draft),
|
|
}}
|
|
// Only the header moves a widget, so a slider under the cursor still
|
|
// slides and a switch still flips while the dashboard is being edited.
|
|
dragConfig={{ handle: ".widget-grip" }}
|
|
resizeConfig={{ handles: ["e", "s", "se"] }}
|
|
>
|
|
{widgets.map((widget) => (
|
|
<div key={widget.id}>
|
|
<WidgetFrame
|
|
title={widget.title}
|
|
issue={widgetIssue(widget)}
|
|
className={cn(
|
|
"cursor-pointer",
|
|
widget.id === selected && "ring-2 ring-primary",
|
|
)}
|
|
grip
|
|
onClick={(event) => {
|
|
if (!(event.target as Element).closest(INTERACTIVE)) {
|
|
setSettingsOpen(false)
|
|
setSelected(widget.id)
|
|
}
|
|
}}
|
|
>
|
|
<WidgetBody widget={widget} dashboard={draft.name} />
|
|
</WidgetFrame>
|
|
</div>
|
|
))}
|
|
</GridLayout>
|
|
)
|
|
}
|
|
</CanvasSurface>
|
|
)
|
|
|
|
return (
|
|
<>
|
|
<div
|
|
className={cn(
|
|
"absolute inset-0 overflow-hidden px-4 pb-24 pt-20 transition-[padding] duration-200",
|
|
panelOpen && "md:pr-[27rem]",
|
|
)}
|
|
data-testid="dashboard-canvas"
|
|
>
|
|
{body}
|
|
</div>
|
|
|
|
<div
|
|
className={cn(
|
|
"pointer-events-none absolute inset-0 transition-[right] duration-200",
|
|
panelOpen && "md:right-[27rem]",
|
|
)}
|
|
>
|
|
<CanvasTitle>
|
|
<span className="truncate px-3 py-1.5 text-sm font-medium">
|
|
{draft.title || draft.name}
|
|
</span>
|
|
{pages.length > 1 ? (
|
|
<Tabs value={page?.id} onValueChange={setPageId}>
|
|
<TabsList>
|
|
{pages.map((candidate) => (
|
|
<TabsTrigger key={candidate.id} value={candidate.id}>
|
|
{candidate.title || candidate.id}
|
|
</TabsTrigger>
|
|
))}
|
|
</TabsList>
|
|
</Tabs>
|
|
) : null}
|
|
</CanvasTitle>
|
|
|
|
<motion.div
|
|
variants={slideUp}
|
|
initial="hidden"
|
|
animate="visible"
|
|
exit="exit"
|
|
transition={transitions.emphasized}
|
|
className="pointer-events-auto absolute bottom-4 left-1/2 z-10 flex -translate-x-1/2 items-center gap-1 rounded-full border border-border bg-card/80 px-1.5 py-1 shadow-e2 backdrop-blur-md pb-[max(0.25rem,env(safe-area-inset-bottom))]"
|
|
>
|
|
{edit ? (
|
|
<>
|
|
<Popover>
|
|
<PopoverTrigger asChild>
|
|
<Button
|
|
variant="ghost"
|
|
size="icon"
|
|
className="size-11 text-muted-foreground md:size-8"
|
|
aria-label="Add widget"
|
|
data-testid="add-widget"
|
|
>
|
|
<Plus />
|
|
</Button>
|
|
</PopoverTrigger>
|
|
<PopoverContent align="center" className="w-56 p-2">
|
|
<p className="px-2 py-1.5 text-xs font-medium uppercase tracking-[0.5px] text-muted-foreground">
|
|
Add a widget
|
|
</p>
|
|
<div className="mt-1 grid gap-0.5">
|
|
{KINDS.map((kind) => (
|
|
<button
|
|
key={kind}
|
|
type="button"
|
|
className="rounded-sm px-2 py-1.5 text-left text-sm transition-colors hover:bg-accent/50"
|
|
data-testid={`add-widget-${kind}`}
|
|
onClick={() => addWidget(kind)}
|
|
>
|
|
{WIDGET_LABELS[kind]}
|
|
</button>
|
|
))}
|
|
</div>
|
|
</PopoverContent>
|
|
</Popover>
|
|
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<Button
|
|
variant="ghost"
|
|
size="icon"
|
|
className="size-11 text-muted-foreground md:size-8"
|
|
onClick={() => {
|
|
setSelected(null)
|
|
setSettingsOpen(true)
|
|
}}
|
|
aria-label="Dashboard settings"
|
|
data-testid="edit-dashboard"
|
|
>
|
|
<Settings2 />
|
|
</Button>
|
|
</TooltipTrigger>
|
|
<TooltipContent>Dashboard settings</TooltipContent>
|
|
</Tooltip>
|
|
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<span className="flex size-8 shrink-0 items-center justify-center text-muted-foreground">
|
|
{save.isPending ? (
|
|
<Loader2 className="size-3.5 animate-spin" />
|
|
) : (
|
|
<Check className="size-3.5" />
|
|
)}
|
|
</span>
|
|
</TooltipTrigger>
|
|
<TooltipContent>
|
|
{save.isPending
|
|
? "Saving"
|
|
: hasDraft
|
|
? "Saved — publish to put it on the panels"
|
|
: "All changes saved"}
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
|
|
{hasDraft ? (
|
|
<Button
|
|
variant="outline"
|
|
size="sm"
|
|
className="h-11 shrink-0 rounded-full md:h-8"
|
|
onClick={() => void publishDashboard()}
|
|
disabled={publish.isPending}
|
|
data-testid="publish-dashboard"
|
|
>
|
|
{publish.isPending ? "Publishing…" : "Publish"}
|
|
</Button>
|
|
) : null}
|
|
|
|
<Separator orientation="vertical" className="mx-0.5 !h-5" />
|
|
</>
|
|
) : null}
|
|
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<Button
|
|
variant="ghost"
|
|
size="icon"
|
|
className="size-11 text-muted-foreground md:size-8"
|
|
aria-label="Open the panel view"
|
|
data-testid="open-view"
|
|
asChild
|
|
>
|
|
<a
|
|
href={`/view/${draft.name}`}
|
|
target="_blank"
|
|
rel="noreferrer"
|
|
>
|
|
<ExternalLink />
|
|
</a>
|
|
</Button>
|
|
</TooltipTrigger>
|
|
<TooltipContent>Open what a wall panel sees</TooltipContent>
|
|
</Tooltip>
|
|
|
|
<Button
|
|
variant={edit ? "brand" : "secondary"}
|
|
size="sm"
|
|
className="h-11 gap-1.5 md:h-8"
|
|
onClick={() => setEdit(!edit)}
|
|
data-testid="toggle-edit"
|
|
>
|
|
{edit ? (
|
|
<Check className="size-4" />
|
|
) : (
|
|
<Pencil className="size-4" />
|
|
)}
|
|
{edit ? "Done" : "Edit"}
|
|
</Button>
|
|
</motion.div>
|
|
</div>
|
|
|
|
{edit ? (
|
|
<>
|
|
<WidgetPanel
|
|
widget={active}
|
|
onChange={(changes) => active && patch(active.id, changes)}
|
|
onDelete={() => {
|
|
if (!active) return
|
|
updateWidgets(widgets.filter((other) => other.id !== active.id))
|
|
setSelected(null)
|
|
}}
|
|
onClose={() => setSelected(null)}
|
|
/>
|
|
|
|
<DashboardPanel
|
|
open={settingsOpen}
|
|
dashboard={draft}
|
|
widgetCount={widgets.length}
|
|
onChange={(changes) => commit({ ...draft, ...changes })}
|
|
onDelete={() => remove.mutate()}
|
|
onClose={() => setSettingsOpen(false)}
|
|
/>
|
|
</>
|
|
) : null}
|
|
</>
|
|
)
|
|
}
|