-
Notifications
You must be signed in to change notification settings - Fork 448
[fix] Enable mouse gestures over video previews #5279
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
bde82f7
[fix] Enable mouse gestures over video previews - fixes ctrl+scroll z…
christian-byrne d8f6021
[improve] Enhance code clarity in media gesture handling with descrip…
christian-byrne 8333a8a
[clean] Remove dangling comment in handlePointer method
christian-byrne de7ed89
[improve] Use satisfies and partial mocking for better type safety in…
christian-byrne 71884de
[improve] Test actual canvas existence check instead of side effects
christian-byrne b1bdc53
[refactor] Use localized mocking instead of global mock functions
christian-byrne File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
215 changes: 137 additions & 78 deletions
215
tests-ui/tests/composables/graph/useCanvasInteractions.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,126 +1,185 @@ | ||
| import { beforeEach, describe, expect, it, vi } from 'vitest' | ||
|
|
||
| import { useCanvasInteractions } from '@/composables/graph/useCanvasInteractions' | ||
| import { app } from '@/scripts/app' | ||
| import * as settingStore from '@/stores/settingStore' | ||
| import { useCanvasStore } from '@/stores/graphStore' | ||
| import { useSettingStore } from '@/stores/settingStore' | ||
|
|
||
| // Mock the app and canvas | ||
| // Mock stores | ||
| vi.mock('@/stores/graphStore') | ||
| vi.mock('@/stores/settingStore') | ||
| vi.mock('@/scripts/app', () => ({ | ||
| app: { | ||
| canvas: { | ||
| canvas: null as HTMLCanvasElement | null | ||
| canvas: { | ||
| dispatchEvent: vi.fn() | ||
| } | ||
| } | ||
| } | ||
| })) | ||
|
|
||
| // Mock the setting store | ||
| vi.mock('@/stores/settingStore', () => ({ | ||
| useSettingStore: vi.fn() | ||
| })) | ||
|
|
||
| describe('useCanvasInteractions', () => { | ||
| let mockCanvas: HTMLCanvasElement | ||
| let mockSettingStore: { get: ReturnType<typeof vi.fn> } | ||
| let canvasInteractions: ReturnType<typeof useCanvasInteractions> | ||
| const mockGetCanvas = vi.fn() | ||
| const mockGet = vi.fn() | ||
|
|
||
| beforeEach(() => { | ||
| // Clear mocks | ||
| vi.clearAllMocks() | ||
| vi.mocked(useCanvasStore, { partial: true }).mockReturnValue({ | ||
| getCanvas: mockGetCanvas | ||
| }) | ||
| vi.mocked(useSettingStore, { partial: true }).mockReturnValue({ | ||
| get: mockGet | ||
| }) | ||
| }) | ||
|
|
||
| // Create mock canvas element | ||
| mockCanvas = document.createElement('canvas') | ||
| mockCanvas.dispatchEvent = vi.fn() | ||
| app.canvas!.canvas = mockCanvas | ||
| describe('handlePointer', () => { | ||
| it('should forward space+drag events to canvas when read_only is true', () => { | ||
| // Setup | ||
| const mockCanvas = { read_only: true } | ||
| mockGetCanvas.mockReturnValue(mockCanvas) | ||
|
|
||
| // Mock setting store | ||
| mockSettingStore = { get: vi.fn() } | ||
| vi.mocked(settingStore.useSettingStore).mockReturnValue( | ||
| mockSettingStore as any | ||
| ) | ||
| const { handlePointer } = useCanvasInteractions() | ||
|
|
||
| canvasInteractions = useCanvasInteractions() | ||
| }) | ||
| // Create mock pointer event | ||
| const mockEvent = { | ||
| buttons: 1, // Left mouse button | ||
| preventDefault: vi.fn(), | ||
| stopPropagation: vi.fn() | ||
| } satisfies Partial<PointerEvent> | ||
|
|
||
| describe('handleWheel', () => { | ||
| it('should check navigation mode from settings', () => { | ||
| mockSettingStore.get.mockReturnValue('standard') | ||
| // Test | ||
| handlePointer(mockEvent as unknown as PointerEvent) | ||
|
|
||
| const wheelEvent = new WheelEvent('wheel', { | ||
| ctrlKey: true, | ||
| deltaY: -100 | ||
| }) | ||
| // Verify | ||
| expect(mockEvent.preventDefault).toHaveBeenCalled() | ||
| expect(mockEvent.stopPropagation).toHaveBeenCalled() | ||
| }) | ||
|
|
||
| it('should forward middle mouse button events to canvas', () => { | ||
| // Setup | ||
| const mockCanvas = { read_only: false } | ||
| mockGetCanvas.mockReturnValue(mockCanvas) | ||
|
|
||
| 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> | ||
|
|
||
| canvasInteractions.handleWheel(wheelEvent) | ||
| // Test | ||
| handlePointer(mockEvent as unknown as PointerEvent) | ||
|
|
||
| expect(mockSettingStore.get).toHaveBeenCalledWith( | ||
| 'Comfy.Canvas.NavigationMode' | ||
| ) | ||
| // Verify | ||
| expect(mockEvent.preventDefault).toHaveBeenCalled() | ||
| expect(mockEvent.stopPropagation).toHaveBeenCalled() | ||
| }) | ||
|
|
||
| it('should not forward regular wheel events in standard mode', () => { | ||
| mockSettingStore.get.mockReturnValue('standard') | ||
| it('should not prevent default when canvas is not in read_only mode and not middle button', () => { | ||
| // Setup | ||
| const mockCanvas = { read_only: false } | ||
| mockGetCanvas.mockReturnValue(mockCanvas) | ||
|
|
||
| const wheelEvent = new WheelEvent('wheel', { | ||
| deltaY: -100 | ||
| }) | ||
| const { handlePointer } = useCanvasInteractions() | ||
|
|
||
| canvasInteractions.handleWheel(wheelEvent) | ||
| // Create mock pointer event | ||
| const mockEvent = { | ||
| buttons: 1, // Left mouse button | ||
| preventDefault: vi.fn(), | ||
| stopPropagation: vi.fn() | ||
| } satisfies Partial<PointerEvent> | ||
|
|
||
| expect(mockCanvas.dispatchEvent).not.toHaveBeenCalled() | ||
| // 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 forward all wheel events to canvas in legacy mode', () => { | ||
| mockSettingStore.get.mockReturnValue('legacy') | ||
| it('should return early when canvas is null', () => { | ||
| // Setup | ||
| mockGetCanvas.mockReturnValue(null) | ||
|
|
||
| const { handlePointer } = useCanvasInteractions() | ||
|
|
||
| const wheelEvent = new WheelEvent('wheel', { | ||
| deltaY: -100, | ||
| cancelable: true | ||
| }) | ||
| // 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> | ||
|
|
||
| canvasInteractions.handleWheel(wheelEvent) | ||
| // Test | ||
| handlePointer(mockEvent as unknown as PointerEvent) | ||
|
|
||
| expect(mockCanvas.dispatchEvent).toHaveBeenCalled() | ||
| // Verify early return - no event methods should be called at all | ||
| expect(mockGetCanvas).toHaveBeenCalled() | ||
| expect(mockEvent.preventDefault).not.toHaveBeenCalled() | ||
| expect(mockEvent.stopPropagation).not.toHaveBeenCalled() | ||
| }) | ||
| }) | ||
|
|
||
| it('should handle missing canvas gracefully', () => { | ||
| ;(app.canvas as any).canvas = null | ||
| mockSettingStore.get.mockReturnValue('standard') | ||
| describe('handleWheel', () => { | ||
| it('should forward ctrl+wheel events to canvas in standard nav mode', () => { | ||
| // Setup | ||
| mockGet.mockReturnValue('standard') | ||
|
|
||
| const { handleWheel } = useCanvasInteractions() | ||
|
|
||
| const wheelEvent = new WheelEvent('wheel', { | ||
| // Create mock wheel event with ctrl key | ||
| const mockEvent = { | ||
| ctrlKey: true, | ||
| deltaY: -100 | ||
| }) | ||
| metaKey: false, | ||
| preventDefault: vi.fn() | ||
| } satisfies Partial<WheelEvent> | ||
|
|
||
| // Test | ||
| handleWheel(mockEvent as unknown as WheelEvent) | ||
|
|
||
| expect(() => { | ||
| canvasInteractions.handleWheel(wheelEvent) | ||
| }).not.toThrow() | ||
| // Verify | ||
| expect(mockEvent.preventDefault).toHaveBeenCalled() | ||
| }) | ||
| }) | ||
|
|
||
| describe('forwardEventToCanvas', () => { | ||
| it('should dispatch event to canvas element', () => { | ||
| const wheelEvent = new WheelEvent('wheel', { | ||
| deltaY: -100, | ||
| ctrlKey: true | ||
| }) | ||
| it('should forward all wheel events to canvas in legacy nav mode', () => { | ||
| // Setup | ||
| mockGet.mockReturnValue('legacy') | ||
|
|
||
| const { handleWheel } = useCanvasInteractions() | ||
|
|
||
| // Create mock wheel event without modifiers | ||
| const mockEvent = { | ||
| ctrlKey: false, | ||
| metaKey: false, | ||
| preventDefault: vi.fn() | ||
| } satisfies Partial<WheelEvent> | ||
|
|
||
| canvasInteractions.forwardEventToCanvas(wheelEvent) | ||
| // Test | ||
| handleWheel(mockEvent as unknown as WheelEvent) | ||
|
|
||
| expect(mockCanvas.dispatchEvent).toHaveBeenCalledWith( | ||
| expect.any(WheelEvent) | ||
| ) | ||
| // Verify | ||
| expect(mockEvent.preventDefault).toHaveBeenCalled() | ||
| }) | ||
|
|
||
| it('should handle missing canvas gracefully', () => { | ||
| ;(app.canvas as any).canvas = null | ||
| it('should not prevent default for regular wheel events in standard nav mode', () => { | ||
| // Setup | ||
| mockGet.mockReturnValue('standard') | ||
|
|
||
| const { handleWheel } = useCanvasInteractions() | ||
|
|
||
| // Create mock wheel event without modifiers | ||
| const mockEvent = { | ||
| ctrlKey: false, | ||
| metaKey: false, | ||
| preventDefault: vi.fn() | ||
| } satisfies Partial<WheelEvent> | ||
|
|
||
| const wheelEvent = new WheelEvent('wheel', { | ||
| deltaY: -100 | ||
| }) | ||
| // Test | ||
| handleWheel(mockEvent as unknown as WheelEvent) | ||
|
|
||
| expect(() => { | ||
| canvasInteractions.forwardEventToCanvas(wheelEvent) | ||
| }).not.toThrow() | ||
| // Verify - should not prevent default (let component handle normally) | ||
| expect(mockEvent.preventDefault).not.toHaveBeenCalled() | ||
| }) | ||
| }) | ||
| }) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.