Files
ComfyUI_frontend/src/composables/useImageCrop.ts
Kelly Yang cf98013c18 test: expand Image Crop E2E and fix loading overlay deadlock (#11193)
## Summary

Expands Playwright coverage for the **ImageCropV2** widget (Levels 1–3
from the image crop E2E plan), fixes **loading / image mount** behavior
when `imageUrl` changes, adds **stable resize-handle selectors**, and
adds a **small Vitest** for URL→loading transitions.

## Changes

- [x] **Level 1 (E2E)** — Empty state: assert resize handle hidden;
screenshot baseline `image-crop-empty-state.png`; pointer drag on empty
state does not change widget bounds.
- [x] **Level 1 (E2E)** — After run: assert **8 visible** resize handles
with `data-testid` + `filter({ visible: true })`; broken `img.src`
returns to empty state (`crop-empty-state`, no overlay).
- [x] **Level 1 (E2E)** — **Slow `/api/view`** route (delay only
`example.png`) to assert **“Loading…”** then hidden after image loads;
comment clarifies delay is in the route handler, not
`page.waitForTimeout`.
- [x] **Level 2 (E2E)** — Drag clamps to **right/bottom** and
**top-left** image bounds via `setCropBounds` + `expect.poll` on natural
bounds.
- [x] **Level 3 (E2E)** — Free resize: right / left / bottom / top
edges; SE and NW corners; `MIN_CROP_SIZE` (16px); right-edge boundary
clamp; **8 handles** screenshot `image-crop-eight-handles.png`; SE/NW
screenshots (`image-crop-resize-se.png`, `image-crop-resize-nw.png`).
- [x] **E2E helpers** — Shared `getCropValue`, `setCropBounds`,
`dragOnLocator`, `POINTER_OPTS`; drag regression uses **`expect.poll`**
instead of `toPass` where appropriate.
- [x] **`WidgetImageCrop.vue`** — When `imageUrl` is set, **always
render `<img>`**; show loading as an **absolute overlay** (fixes
deadlock where `isLoading` blocked `<img>` so `@load` never ran); add
**`data-testid="crop-resize-{direction}"`** on resize handles.
- [x] **`useImageCrop.ts`** — Watch `imageUrl` and drive `isLoading`;
extract **`imageCropLoadingAfterUrlChange`** (`boolean | null`) for
clear semantics and tests.
- [x] **`useImageCrop.test.ts`** — Vitest coverage for
`imageCropLoadingAfterUrlChange` (null URL, URL change, first URL,
unchanged URL).

## Screenshot / CI notes

- [ ] **Linux screenshot expectations** for new/updated
`toHaveScreenshot(...)` names must be produced on **CI (Linux)** — add
the **`New Browser Test Expectation`** label (or equivalent workflow);
**do not** commit local **Darwin** golden files.
- [x] Existing Linux baselines under `imageCrop.spec.ts-snapshots/` for
prior tests are unchanged where applicable; new baselines are expected
from CI after merge workflow.

## Files

- [x] `browser_tests/tests/vueNodes/widgets/imageCrop.spec.ts`
- [x] `src/components/imagecrop/WidgetImageCrop.vue`
- [x] `src/composables/useImageCrop.ts`
- [x] `src/composables/useImageCrop.test.ts` (new)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Touches interactive crop UI rendering and `isLoading` state
transitions, which can affect user-visible behavior and input handling;
changes are mitigated by extensive new E2E and unit tests.
> 
> **Overview**
> Improves the `WidgetImageCrop` loading behavior by always rendering
the preview `<img>` when `imageUrl` is set and showing “Loading…” as an
absolute overlay, preventing a deadlock where `isLoading` could block
the `@load` event. Adds stable `data-testid="crop-resize-{direction}"`
selectors for resize handles and hardens pointer-capture handling in
`useImageCrop`.
> 
> Greatly expands automated coverage: the Playwright spec now tests
empty-state rendering/screenshot, drag/resize interactions (edge/corner,
min size, and clamping to image bounds), aspect-ratio lock handle
visibility, slow `/api/view` loading overlay behavior, and broken image
fetch recovery. Adds a new Vitest suite for `useImageCrop` (including
`imageCropLoadingAfterUrlChange`) to unit-test URL→loading transitions
and core drag/resize/aspect-ratio logic.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
c4f88a42b5. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-11193-test-expand-Image-Crop-E2E-and-fix-loading-overlay-deadlock-3416d73d365081eb99dae577c939baa9)
by [Unito](https://www.unito.io)

---------

Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: github-actions <github-actions@github.com>
2026-04-17 20:22:05 -07:00

630 lines
17 KiB
TypeScript

import { useResizeObserver } from '@vueuse/core'
import type { Ref } from 'vue'
import { computed, onMounted, ref, watch } from 'vue'
import type { LGraphNode, NodeId } from '@/lib/litegraph/src/LGraphNode'
import type { Bounds } from '@/renderer/core/layout/types'
import { useNodeOutputStore } from '@/stores/nodeOutputStore'
import { resolveNode } from '@/utils/litegraphUtil'
type ResizeDirection =
| 'top'
| 'bottom'
| 'left'
| 'right'
| 'nw'
| 'ne'
| 'sw'
| 'se'
const HANDLE_SIZE = 8
const CORNER_SIZE = 10
/** Minimum crop width/height in source image pixel space. */
const MIN_CROP_SIZE = 16
const CROP_BOX_BORDER = 2
/**
* Next `isLoading` when `imageUrl` transitions. `null` means do not change
* `isLoading` (e.g. same URL).
*/
export function imageCropLoadingAfterUrlChange(
url: string | null,
previous: string | null | undefined
): boolean | null {
if (url == null) return false
if (url !== previous) return true
return null
}
export const ASPECT_RATIOS = {
'1:1': 1,
'3:4': 3 / 4,
'4:3': 4 / 3,
'16:9': 16 / 9,
'9:16': 9 / 16,
custom: null
} as const
interface UseImageCropOptions {
imageEl: Ref<HTMLImageElement | null>
containerEl: Ref<HTMLDivElement | null>
modelValue: Ref<Bounds>
}
export function useImageCrop(nodeId: NodeId, options: UseImageCropOptions) {
const { imageEl, containerEl, modelValue } = options
const nodeOutputStore = useNodeOutputStore()
const node = ref<LGraphNode | null>(null)
const imageUrl = ref<string | null>(null)
const isLoading = ref(false)
const naturalWidth = ref(0)
const naturalHeight = ref(0)
const displayedWidth = ref(0)
const displayedHeight = ref(0)
const scaleFactor = ref(1)
const imageOffsetX = ref(0)
const imageOffsetY = ref(0)
const cropX = computed({
get: () => modelValue.value.x,
set: (v: number) => {
modelValue.value.x = v
}
})
const cropY = computed({
get: () => modelValue.value.y,
set: (v: number) => {
modelValue.value.y = v
}
})
const cropWidth = computed({
get: () => modelValue.value.width || 512,
set: (v: number) => {
modelValue.value.width = v
}
})
const cropHeight = computed({
get: () => modelValue.value.height || 512,
set: (v: number) => {
modelValue.value.height = v
}
})
const isDragging = ref(false)
const dragStartX = ref(0)
const dragStartY = ref(0)
const dragStartCropX = ref(0)
const dragStartCropY = ref(0)
const isResizing = ref(false)
const resizeDirection = ref<ResizeDirection | null>(null)
const resizeStartX = ref(0)
const resizeStartY = ref(0)
const resizeStartCropX = ref(0)
const resizeStartCropY = ref(0)
const resizeStartCropWidth = ref(0)
const resizeStartCropHeight = ref(0)
const lockedRatio = ref<number | null>(null)
const selectedRatio = computed({
get: () => {
if (lockedRatio.value == null) return 'custom'
const entry = Object.entries(ASPECT_RATIOS).find(
([, v]) => v === lockedRatio.value
)
return entry ? entry[0] : 'custom'
},
set: (key: string) => {
if (key === 'custom') {
lockedRatio.value = null
return
}
lockedRatio.value =
ASPECT_RATIOS[key as keyof typeof ASPECT_RATIOS] ?? null
applyLockedRatio()
}
})
const isLockEnabled = computed({
get: () => lockedRatio.value != null,
set: (locked: boolean) => {
if (locked && lockedRatio.value == null) {
lockedRatio.value = cropWidth.value / cropHeight.value
}
if (!locked) {
lockedRatio.value = null
}
}
})
function applyLockedRatio() {
if (lockedRatio.value == null) return
const ratio = lockedRatio.value
const w = cropWidth.value
let newHeight = Math.round(w / ratio)
if (cropY.value + newHeight > naturalHeight.value) {
newHeight = naturalHeight.value - cropY.value
const newWidth = Math.round(newHeight * ratio)
cropWidth.value = Math.max(MIN_CROP_SIZE, newWidth)
}
cropHeight.value = Math.max(MIN_CROP_SIZE, newHeight)
}
useResizeObserver(containerEl, () => {
if (imageEl.value && imageUrl.value) {
updateDisplayedDimensions()
}
})
const getInputImageUrl = (): string | null => {
if (!node.value) return null
let sourceNode = node.value.getInputNode(0)
if (!sourceNode) return null
if (sourceNode.isSubgraphNode()) {
const link = node.value.getInputLink(0)
if (!link) return null
const resolved = sourceNode.resolveSubgraphOutputLink(link.origin_slot)
sourceNode = resolved?.outputNode ?? null
if (!sourceNode) return null
}
const urls = nodeOutputStore.getNodeImageUrls(sourceNode)
if (urls?.length) {
return urls[0]
}
return null
}
const updateImageUrl = () => {
imageUrl.value = getInputImageUrl()
}
watch(imageUrl, (url, previous) => {
const next = imageCropLoadingAfterUrlChange(url, previous)
if (next !== null) {
isLoading.value = next
}
})
const updateDisplayedDimensions = () => {
if (!imageEl.value || !containerEl.value) return
const img = imageEl.value
const container = containerEl.value
naturalWidth.value = img.naturalWidth
naturalHeight.value = img.naturalHeight
if (naturalWidth.value <= 0 || naturalHeight.value <= 0) {
scaleFactor.value = 1
return
}
const containerWidth = container.clientWidth
const containerHeight = container.clientHeight
const imageAspect = naturalWidth.value / naturalHeight.value
const containerAspect = containerWidth / containerHeight
if (imageAspect > containerAspect) {
displayedWidth.value = containerWidth
displayedHeight.value = containerWidth / imageAspect
imageOffsetX.value = 0
imageOffsetY.value = (containerHeight - displayedHeight.value) / 2
} else {
displayedHeight.value = containerHeight
displayedWidth.value = containerHeight * imageAspect
imageOffsetX.value = (containerWidth - displayedWidth.value) / 2
imageOffsetY.value = 0
}
if (naturalWidth.value <= 0 || displayedWidth.value <= 0) {
scaleFactor.value = 1
} else {
scaleFactor.value = displayedWidth.value / naturalWidth.value
}
}
const getEffectiveScale = (): number => {
const container = containerEl.value
if (!container || naturalWidth.value <= 0 || displayedWidth.value <= 0) {
return 1
}
const rect = container.getBoundingClientRect()
const clientWidth = container.clientWidth
if (!clientWidth || !rect.width) return 1
const renderedDisplayedWidth =
(displayedWidth.value / clientWidth) * rect.width
return renderedDisplayedWidth / naturalWidth.value
}
const cropBoxStyle = computed(() => ({
left: `${imageOffsetX.value + cropX.value * scaleFactor.value - CROP_BOX_BORDER}px`,
top: `${imageOffsetY.value + cropY.value * scaleFactor.value - CROP_BOX_BORDER}px`,
width: `${cropWidth.value * scaleFactor.value}px`,
height: `${cropHeight.value * scaleFactor.value}px`
}))
interface ResizeHandle {
direction: ResizeDirection
class: string
style: {
left: string
top: string
width?: string
height?: string
}
}
const CORNER_DIRECTIONS = new Set<ResizeDirection>(['nw', 'ne', 'sw', 'se'])
const allResizeHandles = computed<ResizeHandle[]>(() => {
const x = imageOffsetX.value + cropX.value * scaleFactor.value
const y = imageOffsetY.value + cropY.value * scaleFactor.value
const w = cropWidth.value * scaleFactor.value
const h = cropHeight.value * scaleFactor.value
return [
{
direction: 'top',
class: 'h-2 cursor-ns-resize',
style: {
left: `${x + HANDLE_SIZE}px`,
top: `${y - HANDLE_SIZE / 2}px`,
width: `${Math.max(0, w - HANDLE_SIZE * 2)}px`
}
},
{
direction: 'bottom',
class: 'h-2 cursor-ns-resize',
style: {
left: `${x + HANDLE_SIZE}px`,
top: `${y + h - HANDLE_SIZE / 2}px`,
width: `${Math.max(0, w - HANDLE_SIZE * 2)}px`
}
},
{
direction: 'left',
class: 'w-2 cursor-ew-resize',
style: {
left: `${x - HANDLE_SIZE / 2}px`,
top: `${y + HANDLE_SIZE}px`,
height: `${Math.max(0, h - HANDLE_SIZE * 2)}px`
}
},
{
direction: 'right',
class: 'w-2 cursor-ew-resize',
style: {
left: `${x + w - HANDLE_SIZE / 2}px`,
top: `${y + HANDLE_SIZE}px`,
height: `${Math.max(0, h - HANDLE_SIZE * 2)}px`
}
},
{
direction: 'nw',
class: 'cursor-nwse-resize rounded-sm bg-white/80',
style: {
left: `${x - CORNER_SIZE / 2}px`,
top: `${y - CORNER_SIZE / 2}px`,
width: `${CORNER_SIZE}px`,
height: `${CORNER_SIZE}px`
}
},
{
direction: 'ne',
class: 'cursor-nesw-resize rounded-sm bg-white/80',
style: {
left: `${x + w - CORNER_SIZE / 2}px`,
top: `${y - CORNER_SIZE / 2}px`,
width: `${CORNER_SIZE}px`,
height: `${CORNER_SIZE}px`
}
},
{
direction: 'sw',
class: 'cursor-nesw-resize rounded-sm bg-white/80',
style: {
left: `${x - CORNER_SIZE / 2}px`,
top: `${y + h - CORNER_SIZE / 2}px`,
width: `${CORNER_SIZE}px`,
height: `${CORNER_SIZE}px`
}
},
{
direction: 'se',
class: 'cursor-nwse-resize rounded-sm bg-white/80',
style: {
left: `${x + w - CORNER_SIZE / 2}px`,
top: `${y + h - CORNER_SIZE / 2}px`,
width: `${CORNER_SIZE}px`,
height: `${CORNER_SIZE}px`
}
}
]
})
const resizeHandles = computed<ResizeHandle[]>(() => {
if (!isLockEnabled.value) return allResizeHandles.value
return allResizeHandles.value.filter((h) =>
CORNER_DIRECTIONS.has(h.direction)
)
})
const handleImageLoad = () => {
isLoading.value = false
updateDisplayedDimensions()
}
const handleImageError = () => {
isLoading.value = false
imageUrl.value = null
}
const capturePointer = (e: PointerEvent) => {
if (e.target instanceof HTMLElement) e.target.setPointerCapture(e.pointerId)
}
const releasePointer = (e: PointerEvent) => {
if (e.target instanceof HTMLElement)
e.target.releasePointerCapture(e.pointerId)
}
const handleDragStart = (e: PointerEvent) => {
if (!imageUrl.value) return
isDragging.value = true
dragStartX.value = e.clientX
dragStartY.value = e.clientY
dragStartCropX.value = cropX.value
dragStartCropY.value = cropY.value
capturePointer(e)
}
const handleDragMove = (e: PointerEvent) => {
if (!isDragging.value) return
const effectiveScale = getEffectiveScale()
if (effectiveScale === 0) return
const deltaX = (e.clientX - dragStartX.value) / effectiveScale
const deltaY = (e.clientY - dragStartY.value) / effectiveScale
const maxX = naturalWidth.value - cropWidth.value
const maxY = naturalHeight.value - cropHeight.value
cropX.value = Math.round(
Math.max(0, Math.min(maxX, dragStartCropX.value + deltaX))
)
cropY.value = Math.round(
Math.max(0, Math.min(maxY, dragStartCropY.value + deltaY))
)
}
const handleDragEnd = (e: PointerEvent) => {
if (!isDragging.value) return
isDragging.value = false
releasePointer(e)
}
const handleResizeStart = (e: PointerEvent, direction: ResizeDirection) => {
if (!imageUrl.value) return
e.stopPropagation()
isResizing.value = true
resizeDirection.value = direction
resizeStartX.value = e.clientX
resizeStartY.value = e.clientY
resizeStartCropX.value = cropX.value
resizeStartCropY.value = cropY.value
resizeStartCropWidth.value = cropWidth.value
resizeStartCropHeight.value = cropHeight.value
capturePointer(e)
}
const handleResizeMove = (e: PointerEvent) => {
if (!isResizing.value || !resizeDirection.value) return
const effectiveScale = getEffectiveScale()
if (effectiveScale === 0) return
const dir = resizeDirection.value
const deltaX = (e.clientX - resizeStartX.value) / effectiveScale
const deltaY = (e.clientY - resizeStartY.value) / effectiveScale
const ratioValue = isLockEnabled.value ? lockedRatio.value : null
if (ratioValue != null && CORNER_DIRECTIONS.has(dir)) {
handleConstrainedResize(dir, deltaX, deltaY, ratioValue)
return
}
const affectsLeft = dir === 'left' || dir === 'nw' || dir === 'sw'
const affectsRight = dir === 'right' || dir === 'ne' || dir === 'se'
const affectsTop = dir === 'top' || dir === 'nw' || dir === 'ne'
const affectsBottom = dir === 'bottom' || dir === 'sw' || dir === 'se'
let newX = resizeStartCropX.value
let newY = resizeStartCropY.value
let newWidth = resizeStartCropWidth.value
let newHeight = resizeStartCropHeight.value
if (affectsLeft) {
const maxDeltaX = resizeStartCropWidth.value - MIN_CROP_SIZE
const minDeltaX = -resizeStartCropX.value
const clampedDeltaX = Math.max(minDeltaX, Math.min(maxDeltaX, deltaX))
newX = resizeStartCropX.value + clampedDeltaX
newWidth = resizeStartCropWidth.value - clampedDeltaX
} else if (affectsRight) {
const maxWidth = naturalWidth.value - resizeStartCropX.value
newWidth = Math.max(
MIN_CROP_SIZE,
Math.min(maxWidth, resizeStartCropWidth.value + deltaX)
)
}
if (affectsTop) {
const maxDeltaY = resizeStartCropHeight.value - MIN_CROP_SIZE
const minDeltaY = -resizeStartCropY.value
const clampedDeltaY = Math.max(minDeltaY, Math.min(maxDeltaY, deltaY))
newY = resizeStartCropY.value + clampedDeltaY
newHeight = resizeStartCropHeight.value - clampedDeltaY
} else if (affectsBottom) {
const maxHeight = naturalHeight.value - resizeStartCropY.value
newHeight = Math.max(
MIN_CROP_SIZE,
Math.min(maxHeight, resizeStartCropHeight.value + deltaY)
)
}
if (affectsLeft || affectsRight) {
cropX.value = Math.round(newX)
cropWidth.value = Math.round(newWidth)
}
if (affectsTop || affectsBottom) {
cropY.value = Math.round(newY)
cropHeight.value = Math.round(newHeight)
}
}
function handleConstrainedResize(
dir: ResizeDirection,
deltaX: number,
deltaY: number,
ratio: number
) {
const affectsLeft = dir === 'nw' || dir === 'sw'
const affectsTop = dir === 'nw' || dir === 'ne'
const sx = affectsLeft ? -1 : 1
const sy = affectsTop ? -1 : 1
const invRatio = 1 / ratio
const dot = deltaX * sx + deltaY * sy * invRatio
const lenSq = 1 + invRatio * invRatio
const widthDelta = dot / lenSq
let newWidth = Math.round(resizeStartCropWidth.value + widthDelta)
let newHeight = Math.round(newWidth / ratio)
if (newWidth < MIN_CROP_SIZE) {
newWidth = MIN_CROP_SIZE
newHeight = Math.round(newWidth / ratio)
}
if (newHeight < MIN_CROP_SIZE) {
newHeight = MIN_CROP_SIZE
newWidth = Math.round(newHeight * ratio)
}
let newX = resizeStartCropX.value
let newY = resizeStartCropY.value
if (affectsLeft) {
newX = resizeStartCropX.value + resizeStartCropWidth.value - newWidth
}
if (affectsTop) {
newY = resizeStartCropY.value + resizeStartCropHeight.value - newHeight
}
if (newX < 0) {
newWidth += newX
newX = 0
newHeight = Math.round(newWidth / ratio)
}
if (newY < 0) {
newHeight += newY
newY = 0
newWidth = Math.round(newHeight * ratio)
}
if (newX + newWidth > naturalWidth.value) {
newWidth = naturalWidth.value - newX
newHeight = Math.round(newWidth / ratio)
}
if (newY + newHeight > naturalHeight.value) {
newHeight = naturalHeight.value - newY
newWidth = Math.round(newHeight * ratio)
}
cropX.value = Math.round(newX)
cropY.value = Math.round(newY)
cropWidth.value = Math.max(MIN_CROP_SIZE, newWidth)
cropHeight.value = Math.max(MIN_CROP_SIZE, newHeight)
}
const handleResizeEnd = (e: PointerEvent) => {
if (!isResizing.value) return
isResizing.value = false
resizeDirection.value = null
releasePointer(e)
}
const initialize = () => {
if (nodeId != null) {
node.value = resolveNode(nodeId) ?? null
}
updateImageUrl()
}
watch(
() => nodeOutputStore.nodeOutputs,
() => updateImageUrl(),
{ deep: true }
)
watch(
() => nodeOutputStore.nodePreviewImages,
() => updateImageUrl(),
{ deep: true }
)
onMounted(initialize)
return {
imageUrl,
isLoading,
cropX,
cropY,
cropWidth,
cropHeight,
selectedRatio,
isLockEnabled,
cropBoxStyle,
resizeHandles,
handleImageLoad,
handleImageError,
handleDragStart,
handleDragMove,
handleDragEnd,
handleResizeStart,
handleResizeMove,
handleResizeEnd
}
}