mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-07 16:40:05 +00:00
* [fix] Enable mouse gestures over video previews - fixes ctrl+scroll zoom and space+drag panning 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * [improve] Enhance code clarity in media gesture handling with descriptive constants * [clean] Remove dangling comment in handlePointer method * [improve] Use satisfies and partial mocking for better type safety in tests - Replace 'as any' with vi.mocked({partial: true}) for store mocks - Use 'satisfies Partial<Event>' for better event type checking - Remove 'not.toThrow' test as it tests default behavior - Improve test readability and type safety per review feedback * [improve] Test actual canvas existence check instead of side effects - Replace vague 'graceful handling' test with specific 'early return' test - Verify that getCanvas() is actually called to check canvas existence - Test early return behavior when canvas is null rather than just preventDefault side effect - More robust test that validates the intended logic flow * [refactor] Use localized mocking instead of global mock functions - Replace global mockGetCanvas and mockGet with in-situ vi.mocked() calls - Extract store functions directly in test cases for better locality - Follow DrJKL's suggestion for cleaner test structure - Maintains same test coverage with improved readability --------- Co-authored-by: Claude <noreply@anthropic.com>
190 lines
5.7 KiB
TypeScript
190 lines
5.7 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { useCanvasInteractions } from '@/composables/graph/useCanvasInteractions'
|
|
import { useCanvasStore } from '@/stores/graphStore'
|
|
import { useSettingStore } from '@/stores/settingStore'
|
|
|
|
// Mock stores
|
|
vi.mock('@/stores/graphStore')
|
|
vi.mock('@/stores/settingStore')
|
|
vi.mock('@/scripts/app', () => ({
|
|
app: {
|
|
canvas: {
|
|
canvas: {
|
|
dispatchEvent: vi.fn()
|
|
}
|
|
}
|
|
}
|
|
}))
|
|
|
|
describe('useCanvasInteractions', () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks()
|
|
vi.mocked(useCanvasStore, { partial: true }).mockReturnValue({
|
|
getCanvas: vi.fn()
|
|
})
|
|
vi.mocked(useSettingStore, { partial: true }).mockReturnValue({
|
|
get: vi.fn()
|
|
})
|
|
})
|
|
|
|
describe('handlePointer', () => {
|
|
it('should forward space+drag events to canvas when read_only is true', () => {
|
|
// Setup
|
|
const mockCanvas = { read_only: true }
|
|
const { getCanvas } = useCanvasStore()
|
|
vi.mocked(getCanvas).mockReturnValue(mockCanvas as any)
|
|
|
|
const { handlePointer } = useCanvasInteractions()
|
|
|
|
// Create mock pointer event
|
|
const mockEvent = {
|
|
buttons: 1, // Left mouse button
|
|
preventDefault: vi.fn(),
|
|
stopPropagation: vi.fn()
|
|
} satisfies Partial<PointerEvent>
|
|
|
|
// Test
|
|
handlePointer(mockEvent as unknown as PointerEvent)
|
|
|
|
// Verify
|
|
expect(mockEvent.preventDefault).toHaveBeenCalled()
|
|
expect(mockEvent.stopPropagation).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should forward middle mouse button events to canvas', () => {
|
|
// Setup
|
|
const mockCanvas = { read_only: false }
|
|
const { getCanvas } = useCanvasStore()
|
|
vi.mocked(getCanvas).mockReturnValue(mockCanvas as any)
|
|
|
|
const { handlePointer } = useCanvasInteractions()
|
|
|
|
// Create mock pointer event with middle button
|
|
const mockEvent = {
|
|
buttons: 4, // Middle mouse button
|
|
preventDefault: vi.fn(),
|
|
stopPropagation: vi.fn()
|
|
} satisfies Partial<PointerEvent>
|
|
|
|
// Test
|
|
handlePointer(mockEvent as unknown as PointerEvent)
|
|
|
|
// Verify
|
|
expect(mockEvent.preventDefault).toHaveBeenCalled()
|
|
expect(mockEvent.stopPropagation).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should not prevent default when canvas is not in read_only mode and not middle button', () => {
|
|
// Setup
|
|
const mockCanvas = { read_only: false }
|
|
const { getCanvas } = useCanvasStore()
|
|
vi.mocked(getCanvas).mockReturnValue(mockCanvas as any)
|
|
|
|
const { handlePointer } = useCanvasInteractions()
|
|
|
|
// Create mock pointer event
|
|
const mockEvent = {
|
|
buttons: 1, // Left mouse button
|
|
preventDefault: vi.fn(),
|
|
stopPropagation: vi.fn()
|
|
} satisfies Partial<PointerEvent>
|
|
|
|
// Test
|
|
handlePointer(mockEvent as unknown as PointerEvent)
|
|
|
|
// Verify - should not prevent default (let media handle normally)
|
|
expect(mockEvent.preventDefault).not.toHaveBeenCalled()
|
|
expect(mockEvent.stopPropagation).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should return early when canvas is null', () => {
|
|
// Setup
|
|
const { getCanvas } = useCanvasStore()
|
|
vi.mocked(getCanvas).mockReturnValue(null as any)
|
|
|
|
const { handlePointer } = useCanvasInteractions()
|
|
|
|
// Create mock pointer event that would normally trigger forwarding
|
|
const mockEvent = {
|
|
buttons: 1, // Left mouse button - would trigger space+drag if canvas had read_only=true
|
|
preventDefault: vi.fn(),
|
|
stopPropagation: vi.fn()
|
|
} satisfies Partial<PointerEvent>
|
|
|
|
// Test
|
|
handlePointer(mockEvent as unknown as PointerEvent)
|
|
|
|
// Verify early return - no event methods should be called at all
|
|
expect(getCanvas).toHaveBeenCalled()
|
|
expect(mockEvent.preventDefault).not.toHaveBeenCalled()
|
|
expect(mockEvent.stopPropagation).not.toHaveBeenCalled()
|
|
})
|
|
})
|
|
|
|
describe('handleWheel', () => {
|
|
it('should forward ctrl+wheel events to canvas in standard nav mode', () => {
|
|
// Setup
|
|
const { get } = useSettingStore()
|
|
vi.mocked(get).mockReturnValue('standard')
|
|
|
|
const { handleWheel } = useCanvasInteractions()
|
|
|
|
// Create mock wheel event with ctrl key
|
|
const mockEvent = {
|
|
ctrlKey: true,
|
|
metaKey: false,
|
|
preventDefault: vi.fn()
|
|
} satisfies Partial<WheelEvent>
|
|
|
|
// Test
|
|
handleWheel(mockEvent as unknown as WheelEvent)
|
|
|
|
// Verify
|
|
expect(mockEvent.preventDefault).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should forward all wheel events to canvas in legacy nav mode', () => {
|
|
// Setup
|
|
const { get } = useSettingStore()
|
|
vi.mocked(get).mockReturnValue('legacy')
|
|
|
|
const { handleWheel } = useCanvasInteractions()
|
|
|
|
// Create mock wheel event without modifiers
|
|
const mockEvent = {
|
|
ctrlKey: false,
|
|
metaKey: false,
|
|
preventDefault: vi.fn()
|
|
} satisfies Partial<WheelEvent>
|
|
|
|
// Test
|
|
handleWheel(mockEvent as unknown as WheelEvent)
|
|
|
|
// Verify
|
|
expect(mockEvent.preventDefault).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should not prevent default for regular wheel events in standard nav mode', () => {
|
|
// Setup
|
|
const { get } = useSettingStore()
|
|
vi.mocked(get).mockReturnValue('standard')
|
|
|
|
const { handleWheel } = useCanvasInteractions()
|
|
|
|
// Create mock wheel event without modifiers
|
|
const mockEvent = {
|
|
ctrlKey: false,
|
|
metaKey: false,
|
|
preventDefault: vi.fn()
|
|
} satisfies Partial<WheelEvent>
|
|
|
|
// Test
|
|
handleWheel(mockEvent as unknown as WheelEvent)
|
|
|
|
// Verify - should not prevent default (let component handle normally)
|
|
expect(mockEvent.preventDefault).not.toHaveBeenCalled()
|
|
})
|
|
})
|
|
})
|