Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function makeEl(id: string, clip: string): HTMLElement {

function render(
el: HTMLElement,
onStyleCommit: (property: string, value: string) => Promise<void> | void = () => undefined,
onStyleCommit: (property: string, value: string) => Promise<unknown> | void = () => undefined,
): { root: Root; rerender: (next: HTMLElement) => void } {
const host = document.createElement("div");
document.body.append(host);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ interface CropGestureState {
interface DomEditCropHandlesProps {
selection: DomEditSelection;
overlayRect: OverlayRect;
onStyleCommit?: (property: string, value: string) => Promise<void> | void;
onStyleCommit?: (property: string, value: string) => Promise<unknown> | void;
}

// Hit-strip size (px) for an edge crop handle: THICKNESS extends outward from
Expand Down
2 changes: 1 addition & 1 deletion packages/studio/src/components/editor/DomEditOverlay.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ interface DomEditOverlayProps {
restore?: () => void,
) => Promise<void> | void;
onRotationCommit: (selection: DomEditSelection, next: { angle: number }) => Promise<void> | void;
onStyleCommit?: (property: string, value: string) => Promise<void> | void;
onStyleCommit?: (property: string, value: string) => Promise<unknown> | void;
gridVisible?: boolean;
gridSpacing?: number;
recordingState?: GestureRecordingState;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ interface DomEditSelectionChromeProps {
groupSelectionCount: number;
blockedMoveRef: RefObject<BlockedMoveState | null>;
gestures: GestureHandlers;
onStyleCommit?: (property: string, value: string) => Promise<void> | void;
onStyleCommit?: (property: string, value: string) => Promise<unknown> | void;
onBoxMouseDown: (e: React.MouseEvent) => void;
onBoxClick: (event: React.MouseEvent<HTMLDivElement>) => void;
/** The canvas' text-editing session: what opens one, and whether one is open. */
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// @vitest-environment happy-dom

import { afterEach, describe, expect, it, vi } from "vitest";
import { DomEditSaveQueueOpenError } from "../../utils/domEditSaveQueue";
import type { DomEditSelection } from "./domEditing";
import type { GestureState, UseDomEditOverlayGesturesOptions } from "./domEditOverlayGestures";

Expand Down Expand Up @@ -75,7 +76,9 @@ interface CommitCall {
offset: { x: number; y: number } | undefined;
}

function buildHarness() {
function buildHarness(
onBoxSizeCommit?: UseDomEditOverlayGesturesOptions["onBoxSizeCommitRef"]["current"],
) {
const element = document.createElement("div");
document.body.append(element);

Expand Down Expand Up @@ -136,9 +139,12 @@ function buildHarness() {
onManualDragStartRef: ref(() => {}),
onPathOffsetCommitRef: ref(() => {}),
onGroupPathOffsetCommitRef: ref(() => {}),
onBoxSizeCommitRef: ref((_s, size, offset) => {
commits.push({ size, offset });
}),
onBoxSizeCommitRef: ref(
onBoxSizeCommit ??
((_s, size, offset) => {
commits.push({ size, offset });
}),
),
onRotationCommitRef: ref(() => {}),
onCanvasPointerMoveRef: ref(() => Promise.resolve(null)),
onCanvasMouseDown: () => {},
Expand Down Expand Up @@ -172,6 +178,15 @@ function evt(clientX: number, clientY: number) {
} as unknown as React.PointerEvent<HTMLDivElement>;
}

async function finishResize(handlers: ReturnType<typeof createDomEditOverlayGestureHandlers>) {
handlers.startGesture("resize", evt(ORIGIN_CENTER.x + 100, ORIGIN_CENTER.y), {
resizeHandle: "se",
});
handlers.onPointerMove(evt(ORIGIN_CENTER.x + 150, ORIGIN_CENTER.y));
handlers.onPointerUp(evt(ORIGIN_CENTER.x + 150, ORIGIN_CENTER.y));
await Promise.resolve();
}

afterEach(() => {
document.body.innerHTML = "";
});
Expand Down Expand Up @@ -211,4 +226,23 @@ describe("anchored corner resize — the release commit feeds the center-pin off
expect(offset.x).toBeCloseTo(-(size.width - ORIGIN.width) / 2, 0);
expect(offset.y).toBeCloseTo(-(size.height - ORIGIN.height) / 2, 0);
});

it("does not log a paused save queue as an ordinary resize failure", async () => {
const consoleError = vi.spyOn(console, "error").mockImplementation(() => {});
const { handlers } = buildHarness(() => Promise.reject(new DomEditSaveQueueOpenError()));

await finishResize(handlers);

expect(consoleError).not.toHaveBeenCalled();
});

it("still logs an ordinary resize failure", async () => {
const failure = new Error("save failed");
const consoleError = vi.spyOn(console, "error").mockImplementation(() => {});
const { handlers } = buildHarness(() => Promise.reject(failure));

await finishResize(handlers);

expect(consoleError).toHaveBeenCalledWith("resize commit failed", failure);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export function CommitField({
liveCommit?: boolean;
align?: "left" | "right";
onPreview?: (nextValue: string) => void;
onCommit: (nextValue: string) => void | Promise<void>;
onCommit: (nextValue: string) => void | Promise<unknown>;
}) {
const [draft, setDraft] = useState(value);
const valueRef = useRef(value);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ export function LayoutZIndexRow({
onSetStyle,
}: {
styles: Record<string, string>;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
}) {
const zIndex = String(parseInt(styles["z-index"] || "auto", 10) || 0);
return (
Expand All @@ -200,7 +200,7 @@ export function LayoutFlexBlock({
disabled,
}: {
styles: Record<string, string>;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
disabled: boolean;
}) {
const isFlex = styles.display === "flex" || styles.display === "inline-flex";
Expand Down Expand Up @@ -337,7 +337,7 @@ interface FlatLayoutSectionProps
> {
element: DomEditSelection;
styles: Record<string, string>;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
disabled: boolean;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export function FlatMaskInsetRows({
clipPathValue: string;
radiusValue: number;
disabled: boolean;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
}) {
const clipPathPreset = inferClipPathPreset(clipPathValue);
const parsedClipInsets = parseInsetClipPathSides(clipPathValue);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export function FlatMediaSection({
projectDir: string | null;
element: DomEditSelection;
styles: Record<string, string>;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
onSetAttribute: (attr: string, value: string) => void | Promise<void>;
onSetHtmlAttribute: (attr: string, value: string | null) => void | Promise<void>;
/** A volume lane in the timeline drives the level; the slider cannot. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export function FlatRow({
/** Renders a trailing 10px caret-down, for select-backed rows. */
dropdown?: boolean;
onPreview?: (nextValue: string) => void;
onCommit: (nextValue: string) => void | Promise<void>;
onCommit: (nextValue: string) => void | Promise<unknown>;
onReset?: () => void;
}) {
const track = useTrackDesignInput();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ function FlatFillFields({
element: DomEditSelection;
styles: Record<string, string>;
assets: string[];
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
onPreviewStyle?: (prop: string, value: string) => void;
onImportAssets?: (files: FileList) => Promise<string[]>;
}) {
Expand Down Expand Up @@ -156,7 +156,7 @@ function FlatStrokeRow({
}: {
styles: Record<string, string>;
disabled: boolean;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
}) {
const borderWidthValue =
parsePxMetricValue(styles["border-width"] ?? "") ??
Expand Down Expand Up @@ -236,7 +236,7 @@ function FlatRadiusRow({
styles: Record<string, string>;
gsapBorderRadius?: { tl: number; tr: number; br: number; bl: number } | null;
disabled: boolean;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
}) {
const radiusValue = parseNumericValue(styles["border-radius"]) ?? 0;
const radiusTL =
Expand Down Expand Up @@ -286,7 +286,7 @@ function FlatShadowBlendRows({
}: {
styles: Record<string, string>;
disabled: boolean;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
}) {
const boxShadowPreset = inferBoxShadowPreset(styles["box-shadow"]);
const blendValue = styles["mix-blend-mode"] || "normal";
Expand Down Expand Up @@ -332,7 +332,7 @@ function FlatBlurSliders({
}: {
styles: Record<string, string>;
disabled: boolean;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
}) {
const filterBlurValue = getCssFilterFunctionPx(styles.filter, "blur");
const backdropBlurValue = getCssFilterFunctionPx(styles["backdrop-filter"], "blur");
Expand Down Expand Up @@ -378,7 +378,7 @@ function FlatOverflowMaskRows({
}: {
styles: Record<string, string>;
disabled: boolean;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
}) {
const radiusValue = parseNumericValue(styles["border-radius"]) ?? 0;
const clipPathValue = styles["clip-path"] || "none";
Expand Down Expand Up @@ -432,7 +432,7 @@ function FlatOpacitySlider({
}: {
styles: Record<string, string>;
disabled: boolean;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
}) {
const opacityValue = Math.round((parseNumericValue(styles.opacity) ?? 1) * 100);

Expand Down Expand Up @@ -464,7 +464,7 @@ export function FlatStyleSection({
element: DomEditSelection;
styles: Record<string, string>;
assets: string[];
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
onPreviewStyle?: (prop: string, value: string) => void;
onImportAssets?: (files: FileList) => Promise<string[]>;
gsapBorderRadius?: { tl: number; tr: number; br: number; bl: number } | null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export function MediaSection({
projectDir: string | null;
element: DomEditSelection;
styles: Record<string, string>;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
onSetAttribute: (attr: string, value: string) => void | Promise<void>;
onSetHtmlAttribute: (attr: string, value: string | null) => void | Promise<void>;
onRemoveBackground?: (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export function MetricField({
scrub?: boolean;
suffix?: string;
tooltip?: string;
onCommit: (nextValue: string) => void | Promise<void>;
onCommit: (nextValue: string) => void | Promise<unknown>;
}) {
const track = useTrackDesignInput();
const scrubRef = useRef<{ startX: number; startValue: number; pointerId: number } | null>(null);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export function StyleSections({
element: DomEditSelection;
styles: Record<string, string>;
assets: string[];
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
onImportAssets?: (files: FileList) => Promise<string[]>;
gsapBorderRadius?: { tl: number; tr: number; br: number; bl: number } | null;
// When true, the Flex `Section` is suppressed. The flat inspector renders
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export interface PropertyPanelProps {
copiedAgentPrompt: boolean;
onClearSelection: () => void;
onUngroup?: () => void;
onSetStyle: (prop: string, value: string) => void | Promise<void>;
onSetStyle: (prop: string, value: string) => void | Promise<unknown>;
onPreviewStyle?: (prop: string, value: string) => void;
onSetAttribute: (attr: string, value: string) => void | Promise<void>;
/** Commits several data-* attributes on the SAME element in ONE atomic
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ import {
import { logResize, logResizeMove, logResizeSettle } from "../../utils/resizeDebug";
import { logDrag, logDragSettle, readDragPositions } from "../../utils/dragDebug";
import { createGroupDragMover } from "./groupDragMove";
import { DomEditSaveQueueOpenError } from "../../utils/domEditSaveQueue";

function logGestureCommitFailure(message: string, error: unknown): void {
if (error instanceof DomEditSaveQueueOpenError) return;
console.error(message, error);
}

export function createDomEditOverlayGestureHandlers(opts: UseDomEditOverlayGesturesOptions) {
const setDraftOverlayRect = (next: OverlayRect) => {
Expand Down Expand Up @@ -409,7 +415,7 @@ export function createDomEditOverlayGestureHandlers(opts: UseDomEditOverlayGestu
}
void Promise.resolve(opts.onRotationCommitRef.current(sel, finalRotation))
.catch((error) => {
console.error("rotate commit failed", error);
logGestureCommitFailure("rotate commit failed", error);
if (
g.manualEditDragToken &&
isStudioManualEditGestureCurrent(sel.element, g.manualEditDragToken)
Expand Down Expand Up @@ -493,7 +499,7 @@ export function createDomEditOverlayGestureHandlers(opts: UseDomEditOverlayGestu
opts.onBoxSizeCommitRef.current(sel, finalSize, finalOffset ?? undefined, restore),
)
.catch((error) => {
console.error("resize commit failed", error);
logGestureCommitFailure("resize commit failed", error);
})
.finally(() => {
if (member) endManualOffsetDragMembers([member]);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useCallback, useEffect, useRef, useState } from "react";

function isPromiseCommit(result: void | Promise<void>): result is Promise<void> {
function isPromiseCommit(result: void | Promise<unknown>): result is Promise<unknown> {
return Boolean(result && typeof result.then === "function");
}

Expand All @@ -12,7 +12,7 @@ export function useInspectorGestureTransaction<T>({
}: {
sourceValue: T;
onPreview: (value: T) => void;
onCommit: (value: T) => void | Promise<void>;
onCommit: (value: T) => void | Promise<unknown>;
}) {
const sourceRef = useRef(sourceValue);
const activeRef = useRef<{ before: T; latest: T } | null>(null);
Expand Down Expand Up @@ -122,7 +122,7 @@ export function useInspectorGestureDraft<T>({
}: {
sourceValue: T;
onPreview: (value: T) => void;
onCommit: (value: T) => void | Promise<void>;
onCommit: (value: T) => void | Promise<unknown>;
}) {
const [draft, setDraft] = useState(sourceValue);
const transaction = useInspectorGestureTransaction({
Expand Down
47 changes: 47 additions & 0 deletions packages/studio/src/hooks/domEditCommitRunner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,50 @@ export async function runDomEditCommit(config: DomEditCommitRunnerConfig): Promi
if (!config.shouldResync()) return;
await config.resync();
}

/**
* Why a DOM edit commit did not change the file.
*
* `runDomEditCommit` resolves on persist failure by design (see its contract
* above), so a caller cannot learn whether the write landed by awaiting it — a
* failed persist and a successful one are indistinguishable. Capture and apply
* bugs still reject. The human path does not need to ask about handled persist
* failures, because `onError` already put a toast on screen. A programmatic
* caller has no screen, so it has to be told.
*/
export type DomEditCommitDeclineReason =
| "no-project"
| "no-selection"
| "geometry-property"
| "styles-not-editable"
| "not-text-editable"
| "preview-stale"
| "persist-failed";

export type DomEditCommitOutcome = { ok: true } | { ok: false; reason: DomEditCommitDeclineReason };

export function domEditCommitDeclined(reason: DomEditCommitDeclineReason): DomEditCommitOutcome {
return { ok: false, reason };
}

/**
* `runDomEditCommit`, reporting whether the write actually landed.
*
* Owns `onSettled` to do it, and forwards to a caller-supplied one rather than
* dropping it. `runDomEditCommit` calls `onSettled` exactly once on both the
* success and the failure path, so the flag is always set by the time it
* resolves.
*/
export async function runReportedDomEditCommit(
config: DomEditCommitRunnerConfig,
): Promise<DomEditCommitOutcome> {
let landed = false;
await runDomEditCommit({
...config,
onSettled: (ok) => {
landed = ok;
config.onSettled?.(ok);
},
});
return landed ? { ok: true } : domEditCommitDeclined("persist-failed");
}
Loading
Loading