The Open Standard for Generative UI
Persist devtools config across sessions (#993)
ABb8562e5ad16b
diff --git a/packages/devtools/package.json b/packages/devtools/package.jsonindex 569c68623..468753a1b 100644--- a/packages/devtools/package.json+++ b/packages/devtools/package.json@@ -1,6 +1,6 @@{"name": "@openuidev/devtools",- "version": "0.0.5",+ "version": "0.0.6","description": "Development-only UI widget for OpenUI apps: surfaces errors captured by @openuidev/observability","license": "MIT","type": "module",@@ -67,9 +67,9 @@"@types/node": "catalog:","@types/react": "catalog:","@types/react-dom": "catalog:",+ "jsdom": "catalog:","react": "catalog:","react-dom": "catalog:",- "jsdom": "catalog:","vitest": "^4.1.0"},"dependencies": {diff --git a/packages/devtools/src/OpenUIDevtools.test.ts b/packages/devtools/src/OpenUIDevtools.test.tsindex e4ad3758a..0f4a4bf61 100644--- a/packages/devtools/src/OpenUIDevtools.test.ts+++ b/packages/devtools/src/OpenUIDevtools.test.ts@@ -12,6 +12,7 @@ let container: HTMLDivElement;let root: Root;beforeEach(() => {+ window.localStorage.clear();container = document.createElement("div");document.body.appendChild(container);root = createRoot(container);@@ -44,6 +45,21 @@ function buttonByText(text: string): HTMLButtonElement | undefined {HTMLButtonElement | undefined;}+function checkboxLabeled(text: string): HTMLInputElement {+ const label = [...container.querySelectorAll("label")].find((el) =>+ el.textContent?.includes(text),+ );+ const input = label?.querySelector<HTMLInputElement>('input[type="checkbox"]');+ if (!input) throw new Error(`checkbox "${text}" not found`);+ return input;+}++function remount(props: OpenUIDevtoolsProps): void {+ act(() => root.unmount());+ root = createRoot(container);+ render(props);+}+describe("OpenUIDevtools", () => {it("renders nothing when disabled", () => {render({ enabled: false });@@ -81,6 +97,34 @@ describe("OpenUIDevtools", () => {expect(toggle().getAttribute("aria-expanded")).toBe("false");});+ it("restores auto-open on error from a previous session", () => {+ render({ enabled: true, autoOpenOnError: true });+ expect(checkboxLabeled("Auto-open on error").checked).toBe(true);++ act(() => checkboxLabeled("Auto-open on error").click());+ expect(checkboxLabeled("Auto-open on error").checked).toBe(false);++ remount({ enabled: true, autoOpenOnError: true });+ expect(checkboxLabeled("Auto-open on error").checked).toBe(false);++ act(() => observability.error({ kind: "boom" }));+ expect(toggle().getAttribute("aria-expanded")).toBe("false");+ });++ it("restores the errors-only filter from a previous session", () => {+ render({ enabled: true, errorsOnly: false });+ act(() => checkboxLabeled("Errors only").click());+ expect(checkboxLabeled("Errors only").checked).toBe(true);++ remount({ enabled: true, errorsOnly: false });+ expect(checkboxLabeled("Errors only").checked).toBe(true);++ act(() => observability.info({ kind: "just-info" }));+ act(() => observability.error({ kind: "real-error" }));+ expect(container.textContent).not.toContain("just-info");+ expect(container.textContent).toContain("real-error");+ });+it("filters out info events when errorsOnly is set", () => {render({ enabled: true, errorsOnly: true });act(() => observability.info({ kind: "just-info" }));diff --git a/packages/devtools/src/OpenUIDevtools.tsx b/packages/devtools/src/OpenUIDevtools.tsxindex 53b0e8cff..1b673d92e 100644--- a/packages/devtools/src/OpenUIDevtools.tsx+++ b/packages/devtools/src/OpenUIDevtools.tsx@@ -6,12 +6,13 @@ import {type ObservabilityEvent,} from "@openuidev/observability";import { ArrowLeft, Check, Copy, WrapText, X } from "lucide-react";-import { useEffect, useRef, useState, type CSSProperties } from "react";+import { useEffect, useState, type CSSProperties } from "react";import { getQuotaError, QuotaErrorRow } from "./QuotaErrorRow";import { getReactLangStreamDetail, ReactLangStreamEventRow } from "./ReactLangStreamEventRow";import { ShiroLogo } from "./ShiroLogo";import { addOrReplaceEvent } from "./eventBuffer";import { useDevtoolsSingleton } from "./singleton";+import { useDevtoolsConfig } from "./useDevtoolsConfig";export type DevtoolsPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right";@@ -59,20 +60,20 @@ export function OpenUIDevtools({const [selected, setSelected] = useState<ObservabilityEvent | null>(null);const [wrapStack, setWrapStack] = useState(false);const [copied, setCopied] = useState(false);- const [autoOpen, setAutoOpen] = useState(autoOpenOnError);- const [onlyErrors, setOnlyErrors] = useState(errorsOnly);-- // Read the live checkbox values inside the (stable) subscription without re-subscribing.- const autoOpenRef = useRef(autoOpen);- autoOpenRef.current = autoOpen;+ const { config, setConfig, configRef } = useDevtoolsConfig({+ autoOpen: autoOpenOnError,+ onlyErrors: errorsOnly,+ });+ const { autoOpen, onlyErrors } = config;+ // Read configRef inside the (stable) subscription without re-subscribing.useEffect(() => {if (!isEnabled) return;return observability.listenAll((event) => {setEvents((prev) => addOrReplaceEvent(prev, event, maxEvents));- if (event.level === "error" && autoOpenRef.current) setOpen(true);+ if (event.level === "error" && configRef.current.autoOpen) setOpen(true);});- }, [isEnabled, maxEvents]);+ }, [isEnabled, maxEvents, configRef]);// Escape steps back: stack view → list, list → closed.useEffect(() => {@@ -207,7 +208,7 @@ export function OpenUIDevtools({<inputtype="checkbox"checked={autoOpen}- onChange={(event) => setAutoOpen(event.target.checked)}+ onChange={(event) => setConfig({ autoOpen: event.target.checked })}/>Auto-open on error</label>@@ -215,7 +216,7 @@ export function OpenUIDevtools({<inputtype="checkbox"checked={onlyErrors}- onChange={(event) => setOnlyErrors(event.target.checked)}+ onChange={(event) => setConfig({ onlyErrors: event.target.checked })}/>Errors only</label>diff --git a/packages/devtools/src/useDevtoolsConfig.ts b/packages/devtools/src/useDevtoolsConfig.tsnew file mode 100644index 000000000..7c9dfa0d2--- /dev/null+++ b/packages/devtools/src/useDevtoolsConfig.ts@@ -0,0 +1,77 @@+import { useCallback, useEffect, useRef, useState } from "react";++const STORAGE_KEY = "openui.devtools.config";++/** Add a boolean here when a new drawer setting should persist. */+const BOOLEAN_KEYS = ["autoOpen", "onlyErrors"] as const;++export type DevtoolsConfig = { [K in (typeof BOOLEAN_KEYS)[number]]: boolean };++function readStored(): Partial<DevtoolsConfig> {+ if (typeof window === "undefined") return {};+ try {+ const raw = window.localStorage.getItem(STORAGE_KEY);+ if (!raw) return {};+ const parsed: unknown = JSON.parse(raw);+ if (typeof parsed !== "object" || parsed === null) return {};+ const record = parsed as Record<string, unknown>;+ const config: Partial<DevtoolsConfig> = {};+ for (const key of BOOLEAN_KEYS) {+ if (typeof record[key] === "boolean") config[key] = record[key];+ }+ return config;+ } catch {+ return {};+ }+}++function writeStored(patch: Partial<DevtoolsConfig>): void {+ if (typeof window === "undefined") return;+ try {+ window.localStorage.setItem(STORAGE_KEY, JSON.stringify({ ...readStored(), ...patch }));+ } catch {+ // private mode / quota / disabled storage+ }+}++function merge(base: DevtoolsConfig, patch: Partial<DevtoolsConfig>): DevtoolsConfig {+ const next = { ...base };+ for (const key of BOOLEAN_KEYS) {+ const value = patch[key];+ if (typeof value === "boolean") next[key] = value;+ }+ return next;+}++/**+ * Drawer checkbox state as one object, restored from localStorage.+ * `setConfig({ autoOpen: false })` patches and persists; add keys to+ * `BOOLEAN_KEYS` when a new setting should survive refresh.+ */+export function useDevtoolsConfig(defaults: DevtoolsConfig) {+ const [config, setConfigState] = useState(() => merge(defaults, readStored()));+ const configRef = useRef(config);+ configRef.current = config;++ // After SSR hydration the lazy initializer reused the server snapshot+ // (prop defaults). Re-read storage so a previous session's checkboxes win.+ useEffect(() => {+ const stored = readStored();+ setConfigState((prev) => {+ const next = merge(prev, stored);+ configRef.current = next;+ return next;+ });+ }, []);++ const setConfig = useCallback((patch: Partial<DevtoolsConfig>) => {+ setConfigState((prev) => {+ const next = merge(prev, patch);+ configRef.current = next;+ writeStored(patch);+ return next;+ });+ }, []);++ return { config, setConfig, configRef };+}