Flow canvas draws panel I/O ports as panel:<id>:<port> endpoints that open their panel in the Panels dialog

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WgBfkm4rCmtd1T4vHWjEPx
This commit is contained in:
2026-10-15 16:31:33 +02:00
co-authored by Claude Opus 5.5
parent d825acb768
commit af796f7a02
12 changed files with 132 additions and 31 deletions
+30 -7
View File
@@ -38,7 +38,7 @@ from fluksio.flow.controller import NODE_TYPES, FlowController
from fluksio.flow.dashboards import DashboardStore from fluksio.flow.dashboards import DashboardStore
from fluksio.flow.events import event_bus from fluksio.flow.events import event_bus
from fluksio.flow.messages import flow_of, qualify from fluksio.flow.messages import flow_of, qualify
from fluksio.flow.panels import messages_for from fluksio.flow.panels import messages_for, read_config
from fluksio.flow.pipeline import ValidationIssue from fluksio.flow.pipeline import ValidationIssue
from fluksio.flow.runs import RunRejected from fluksio.flow.runs import RunRejected
from fluksio.flow.schemas import ( from fluksio.flow.schemas import (
@@ -78,18 +78,19 @@ ws_router = APIRouter(prefix="/flows", tags=["flows"])
class Endpoint(BaseModel): class Endpoint(BaseModel):
"""Something wired into this flow that is not a node in it. """Something wired into this flow that is not a node in it.
A dashboard control setting one of its messages, a tile showing one, or a A dashboard control setting one of its messages, a tile showing one, a
node in another flow on the far side of a dotted name. The canvas draws port on a panel's own hardware, or a node in another flow on the far side
these so a value never appears to come from nowhere — or worse, appears to of a dotted name. The canvas draws these so a value never appears to come
come from whichever node happens to be drawn as a producer. from nowhere — or worse, appears to come from whichever node happens to be
drawn as a producer.
""" """
#: dashboard or flow. #: dashboard, panel or flow.
kind: str kind: str
#: Stable within its kind, and used as the canvas node id. #: Stable within its kind, and used as the canvas node id.
id: str id: str
label: str label: str
#: What sort of widget, or the node type in the other flow. #: What sort of widget, the panel, or the node type in the other flow.
detail: str = "" detail: str = ""
#: Messages of this flow it publishes, and ones it reads. #: Messages of this flow it publishes, and ones it reads.
provides: list[str] = [] provides: list[str] = []
@@ -155,6 +156,28 @@ def _endpoints(controller: FlowController, definition: FlowDef) -> list[Endpoint
requires=binding["requires"], requires=binding["requires"],
) )
# A panel's own hardware: an ``in`` port publishes like a control, an
# ``out`` port reads like a tile. The id is the source id the device
# publishes under, so its edges pulse for its values.
prefix = f"{flow}."
for panel in read_config().panels:
for port in panel.io:
if not port.message.startswith(prefix):
continue
key = f"panel:{panel.id}:{port.port}"
endpoint = found.setdefault(
key,
Endpoint(
kind="panel",
id=key,
label=port.port,
detail=panel.title or panel.id,
),
)
side = endpoint.provides if port.direction == "in" else endpoint.requires
if port.message not in side:
side.append(port.message)
def _flow_endpoint(key: str, detail: str) -> Endpoint: def _flow_endpoint(key: str, detail: str) -> Endpoint:
"""One label per node on the far side, however many names reach it.""" """One label per node on the far side, however many names reach it."""
return found.setdefault( return found.setdefault(
+34
View File
@@ -10,8 +10,10 @@ from pathlib import Path
import pytest import pytest
from fluksio.api.routes.flows import _endpoints from fluksio.api.routes.flows import _endpoints
from fluksio.core.config import settings
from fluksio.flow.controller import FlowController from fluksio.flow.controller import FlowController
from fluksio.flow.messages import DType, MessageSpec from fluksio.flow.messages import DType, MessageSpec
from fluksio.flow.panels import PanelDef, PanelPort, PanelsConfig, write_config
from fluksio.flow.schemas import FlowDef, NodeDef from fluksio.flow.schemas import FlowDef, NodeDef
from fluksio.flow.store import FlowStore from fluksio.flow.store import FlowStore
@@ -109,3 +111,35 @@ def test_the_wiring_index_is_read_once_per_store_revision(controller):
controller.store.write_flow(FlowDef(name="shed", nodes=[])) controller.store.write_flow(FlowDef(name="shed", nodes=[]))
_endpoints(controller, controller.store.read_flow("house")) _endpoints(controller, controller.store.read_flow("house"))
assert reads == 2 assert reads == 2
def test_a_panel_port_is_drawn_on_the_side_it_wires(controller, tmp_path, monkeypatch):
monkeypatch.setattr(settings, "PANELS_FILE", tmp_path / "panels.json")
write_config(
PanelsConfig(
panels=[
PanelDef(
id="hall",
title="Hall",
io=[
PanelPort(port="gpio.4", message="house.temp", direction="in"),
PanelPort(
port="backlight", message="house.temp", direction="out"
),
PanelPort(port="mic", message="garage.open", direction="in"),
],
)
]
)
)
endpoints = {
one.id: one
for one in _endpoints(controller, controller.store.read_flow("house"))
}
# The id is what the device publishes under, so its edges pulse for it.
assert endpoints["panel:hall:gpio.4"].provides == ["house.temp"]
assert endpoints["panel:hall:backlight"].requires == ["house.temp"]
assert endpoints["panel:hall:backlight"].detail == "Hall"
assert "panel:hall:mic" not in endpoints
+3 -1
View File
@@ -437,7 +437,9 @@ message:
The credential may publish to its `in` messages even when a dashboard is The credential may publish to its `in` messages even when a dashboard is
locked, and may upload an artifact named after one locked, and may upload an artifact named after one
(`PUT /artifacts?name=<message>`), which is how a microphone sends a recording. (`PUT /artifacts?name=<message>`), which is how a microphone sends a recording.
`out` messages are read only. `out` messages are read only. The flow canvas draws each port as an endpoint,
an `in` port feeding the nodes that consume its message and an `out` port fed
by the nodes that produce it.
!!! note "If the local link is wrong" !!! note "If the local link is wrong"
+5 -4
View File
@@ -9,10 +9,11 @@ The graph runs left to right on desktop and top to bottom on phones.
- **Nodes** show their execution status. - **Nodes** show their execution status.
- **Edges** pulse when values pass through. Click one to inspect its payload. - **Edges** pulse when values pass through. Click one to inspect its payload.
- **Endpoints** show flow inputs, dashboard widgets and nodes in other flows - **Endpoints** show flow inputs, dashboard widgets, panel I/O ports and nodes
that exchange messages with this flow. A value passing lights one up in a in other flows that exchange messages with this flow. A value passing lights
sweep: left to right when it sends into the flow, right to left when it reads one up in a sweep: left to right when it sends into the flow, right to left
out of it. when it reads out of it. Click a panel port to open its panel in the Panels
dialog.
Values update over a websocket. A connection banner tells you when the editor Values update over a websocket. A connection banner tells you when the editor
cannot reach the engine. cannot reach the engine.
+5 -4
View File
@@ -952,10 +952,11 @@ export const EndpointSchema = {
title: 'Endpoint', title: 'Endpoint',
description: `Something wired into this flow that is not a node in it. description: `Something wired into this flow that is not a node in it.
A dashboard control setting one of its messages, a tile showing one, or a A dashboard control setting one of its messages, a tile showing one, a
node in another flow on the far side of a dotted name. The canvas draws port on a panel's own hardware, or a node in another flow on the far side
these so a value never appears to come from nowhere — or worse, appears to of a dotted name. The canvas draws these so a value never appears to come
come from whichever node happens to be drawn as a producer.` from nowhere — or worse, appears to come from whichever node happens to be
drawn as a producer.`
} as const; } as const;
export const EnrollBodySchema = { export const EnrollBodySchema = {
+5 -4
View File
@@ -257,10 +257,11 @@ export type DType = 'float' | 'int' | 'str' | 'bool' | 'json' | 'series' | 'reco
/** /**
* Something wired into this flow that is not a node in it. * Something wired into this flow that is not a node in it.
* *
* A dashboard control setting one of its messages, a tile showing one, or a * A dashboard control setting one of its messages, a tile showing one, a
* node in another flow on the far side of a dotted name. The canvas draws * port on a panel's own hardware, or a node in another flow on the far side
* these so a value never appears to come from nowhere — or worse, appears to * of a dotted name. The canvas draws these so a value never appears to come
* come from whichever node happens to be drawn as a producer. * from nowhere — or worse, appears to come from whichever node happens to be
* drawn as a producer.
*/ */
export type Endpoint = { export type Endpoint = {
kind: string; kind: string;
@@ -182,7 +182,10 @@ export function GlobalSearch({
// Panels are managed in a dialog on the dashboards screen, which opens // Panels are managed in a dialog on the dashboards screen, which opens
// itself when the address says so. // itself when the address says so.
case "panel": case "panel":
return navigate({ to: "/dashboards", search: { panels: true } }) return navigate({
to: "/dashboards",
search: { panels: true, panel: entry.name },
})
case "secret": case "secret":
return navigate({ to: "/secrets" }) return navigate({ to: "/secrets" })
case "module": case "module":
@@ -1,6 +1,6 @@
import { useMutation, useQuery } from "@tanstack/react-query" import { useMutation, useQuery } from "@tanstack/react-query"
import { Plus, Trash2, X } from "lucide-react" import { Plus, Trash2, X } from "lucide-react"
import { useState } from "react" import { useEffect, useState } from "react"
import { import {
type ApiError, type ApiError,
@@ -72,7 +72,7 @@ const objectOnly = (value: unknown) =>
* publish, so it lives in a dialog over the dashboards list instead of a page * publish, so it lives in a dialog over the dashboards list instead of a page
* of its own. Every change saves as it is made — there is no form to submit. * of its own. Every change saves as it is made — there is no form to submit.
*/ */
export function PanelsDialog() { export function PanelsDialog({ focus }: { focus?: string } = {}) {
const { data: config } = useQuery(panelsQueryOptions()) const { data: config } = useQuery(panelsQueryOptions())
const { data: dashboards } = useQuery(dashboardsQueryOptions()) const { data: dashboards } = useQuery(dashboardsQueryOptions())
const { user } = useAuth() const { user } = useAuth()
@@ -125,6 +125,15 @@ export function PanelsDialog() {
const newId = slugify(name) const newId = slugify(name)
const taken = panels.some((panel) => panel.id === newId) const taken = panels.some((panel) => panel.id === newId)
// Arriving about one panel, from its port on a flow canvas, lands on it.
const focusLoaded = Boolean(config) && Boolean(focus)
useEffect(() => {
if (!focusLoaded) return
document
.querySelector(`[data-testid="panel-${focus}"]`)
?.scrollIntoView({ block: "start" })
}, [focusLoaded, focus])
return ( return (
<DialogContent className="max-h-[80vh] overflow-y-auto sm:max-w-lg"> <DialogContent className="max-h-[80vh] overflow-y-auto sm:max-w-lg">
<DialogHeader> <DialogHeader>
@@ -146,6 +155,7 @@ export function PanelsDialog() {
<PanelRow <PanelRow
key={panel.id} key={panel.id}
panel={panel} panel={panel}
focused={panel.id === focus}
host={host} host={host}
remoteHost={remoteHost} remoteHost={remoteHost}
canEdit={canEdit} canEdit={canEdit}
@@ -211,6 +221,7 @@ export function PanelsDialog() {
function PanelRow({ function PanelRow({
panel, panel,
focused,
host, host,
remoteHost, remoteHost,
canEdit, canEdit,
@@ -219,6 +230,8 @@ function PanelRow({
onRemove, onRemove,
}: { }: {
panel: PanelDef panel: PanelDef
/** The one a link arrived about, marked so it is found at a glance. */
focused: boolean
/** Where this instance answers, as it knows itself. */ /** Where this instance answers, as it knows itself. */
host: string host: string
/** Where the portal serves this instance, when it is enrolled. */ /** Where the portal serves this instance, when it is enrolled. */
@@ -288,7 +301,14 @@ function PanelRow({
: `Remove ${panel.id}` : `Remove ${panel.id}`
return ( return (
<div className="grid gap-3" data-testid={`panel-${panel.id}`}> <div
className={cn(
"grid scroll-mt-2 gap-3",
// An outline rather than a border, so the row does not shift.
focused && "rounded-md outline-2 outline-offset-4 outline-primary/40",
)}
data-testid={`panel-${panel.id}`}
>
<div className="flex items-center gap-2"> <div className="flex items-center gap-2">
<Input <Input
value={panel.title} value={panel.title}
@@ -1,5 +1,11 @@
import { Handle, type NodeProps, Position } from "@xyflow/react" import { Handle, type NodeProps, Position } from "@xyflow/react"
import { LayoutDashboard, LogIn, LogOut, Workflow } from "lucide-react" import {
LayoutDashboard,
LogIn,
LogOut,
MonitorSmartphone,
Workflow,
} from "lucide-react"
import { memo, useEffect, useMemo, useRef, useState } from "react" import { memo, useEffect, useMemo, useRef, useState } from "react"
import { useIsMobile } from "@/hooks/useMobile" import { useIsMobile } from "@/hooks/useMobile"
@@ -10,6 +16,8 @@ import { useLiveValues } from "./liveStore"
const KIND_ICONS = { const KIND_ICONS = {
dashboard: LayoutDashboard, dashboard: LayoutDashboard,
// The same glyph the dashboards screen opens its panels with.
panel: MonitorSmartphone,
flow: Workflow, flow: Workflow,
input: LogIn, input: LogIn,
output: LogOut, output: LogOut,
@@ -487,6 +487,12 @@ function FlowEditorInner({
to: "/dashboards/$name", to: "/dashboards/$name",
params: { name: (rest ?? "").split(":")[0] }, params: { name: (rest ?? "").split(":")[0] },
}) })
} else if (kind === "panel") {
// A panel has no page of its own, only its row in the Panels dialog.
navigate({
to: "/dashboards",
search: { panels: true, panel: (rest ?? "").split(":")[0] },
})
} else if (kind === "flow") { } else if (kind === "flow") {
navigate({ navigate({
to: "/flows/$flowName", to: "/flows/$flowName",
+3 -3
View File
@@ -7,8 +7,8 @@ import { displayName, portOf, qualify } from "./deriveEdges"
/** /**
* Canvas elements for things wired into a flow that are not nodes in it. * Canvas elements for things wired into a flow that are not nodes in it.
* *
* A dashboard control setting one of its messages, a tile showing one, or a * A dashboard control setting one of its messages, a tile showing one, a port
* node in another flow across a dotted name. Without these the canvas shows a * on a panel's own hardware, or a node in another flow across a dotted name. Without these the canvas shows a
* value changing with nothing to account for it — and pulses whichever node * value changing with nothing to account for it — and pulses whichever node
* happens to be drawn as a producer, which did nothing. * happens to be drawn as a producer, which did nothing.
* *
@@ -21,7 +21,7 @@ import { displayName, portOf, qualify } from "./deriveEdges"
export const ENDPOINT_TYPE = "endpoint" export const ENDPOINT_TYPE = "endpoint"
/** The id prefixes an endpoint may carry, none of which is a node id. */ /** The id prefixes an endpoint may carry, none of which is a node id. */
const PREFIXES = ["dashboard:", "flow:", "input:", "output:"] const PREFIXES = ["dashboard:", "panel:", "flow:", "input:", "output:"]
export type EndpointNodeData = { export type EndpointNodeData = {
label: string label: string
@@ -35,7 +35,7 @@ import {
import useCustomToast from "@/hooks/useCustomToast" import useCustomToast from "@/hooks/useCustomToast"
import { handleError } from "@/utils" import { handleError } from "@/utils"
type Search = { panels?: boolean } type Search = { panels?: boolean; panel?: string }
export const Route = createFileRoute("/_layout/dashboards/")({ export const Route = createFileRoute("/_layout/dashboards/")({
component: Dashboards, component: Dashboards,
@@ -43,6 +43,8 @@ export const Route = createFileRoute("/_layout/dashboards/")({
// else — the global search among them — arrives at it. // else — the global search among them — arrives at it.
validateSearch: (search: Record<string, unknown>): Search => ({ validateSearch: (search: Record<string, unknown>): Search => ({
panels: search.panels === true || search.panels === "true" || undefined, panels: search.panels === true || search.panels === "true" || undefined,
// Which panel to scroll to, for a link that is about one of them.
panel: typeof search.panel === "string" ? search.panel : undefined,
}), }),
}) })
@@ -57,7 +59,7 @@ function Dashboards() {
const [deleteOpen, setDeleteOpen] = useState(false) const [deleteOpen, setDeleteOpen] = useState(false)
// Which screens exist is a question with an address, so anything can link to // Which screens exist is a question with an address, so anything can link to
// it — the global search lands a panel here. // it — the global search lands a panel here.
const { panels: panelsOpen } = Route.useSearch() const { panels: panelsOpen, panel: panelFocus } = Route.useSearch()
const setPanelsOpen = (open: boolean) => const setPanelsOpen = (open: boolean) =>
navigate({ to: "/dashboards", search: open ? { panels: true } : {} }) navigate({ to: "/dashboards", search: open ? { panels: true } : {} })
@@ -122,7 +124,7 @@ function Dashboards() {
{/* Its own root rather than a nested one: which screens exist is a {/* Its own root rather than a nested one: which screens exist is a
different question from which dashboards do. */} different question from which dashboards do. */}
<Dialog open={panelsOpen ?? false} onOpenChange={setPanelsOpen}> <Dialog open={panelsOpen ?? false} onOpenChange={setPanelsOpen}>
<PanelsDialog /> <PanelsDialog focus={panelFocus} />
</Dialog> </Dialog>
<Dialog open={dialogOpen} onOpenChange={setDialogOpen}> <Dialog open={dialogOpen} onOpenChange={setDialogOpen}>