mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-01 13:59:54 +00:00
* WIP
* WIP: UI design for right click menu
* feat: add composable for node customization and information handling
* fix: correct v-show directive in MaskEditorButton and enhance MoreOptions functionality
* feat: add selection and subgraph operations composables for enhanced graph management
* fix: update computed properties to use 'void' for non-reactive calls and add MenuOptionItem component
* feat: add composables for More Options menu and submenu positioning logic
* feat: refactor MoreOptions component to use MenuOptionItem for menu rendering and streamline submenu handling
* feat: implement SubmenuPopover component for enhanced submenu functionality and selection handling
* feat: add 'More Options' label and enhance shape options in localization file
* refactor: simplify shape name handling by removing Pascal case conversion and using localized names
* refactor: enhance submenu handling by dynamically setting refs and improving key assignment
* feat: implement useNodeArrangement composable for node alignment and distribution functionality
* feat: enhance useMoreOptionsMenu with image node operations and alignment options
* feat: localize context menu options and enhance submenu handling
* refactor: improve type safety for title assignment in selection operations and enhance color option retrieval in node customization
* fix: adjust component order in SelectionToolbox for improved layout
* feat: update FrameNodes button visibility and tooltip, and add localization for frameNodes
* feat: enhance button visibility logic in SelectionToolbox based on selection types
* refactor: reorganize properties panel option in More Options menu for single nodes
* remove excessive logging and alerts
* fix component tests
* ad browser tests
* feat: enhance popover behavior in MoreOptions component to manage visibility state during selection overlay changes
* refactor: update visibility logic for buttons in SelectionToolbox and ExecuteButton components
* refactor: remove duplicate shape option and clean up shapeOptions array
* refactor: update help toggle logic in InfoButton and useMoreOptionsMenu to manage sidebar and help state
* refactor: streamline node info handling and integrate output node filtering in useNodeInfo and useMoreOptionsMenu
* Added useSelectionState composable consolidating all selection-derived state and the node help toggle
* Updated toolbox buttons (InfoButton, BookmarkButton, BypassButton, MaskEditorButton, ConvertToSubgraphButton, PinButton, DeleteButton, ColorPickerButton, ExecuteButton, FrameNodes, Load3DViewerButton) to remove duplicated selection logic and use useSelectionState
* Introduced HideReason ('manual' | 'drag') to differentiate drag-induced hides from manual/outside hides in MoreOptions
* refactor: enhance popover visibility handling during drag events using canvas state
* fix: update shape option name from 'default' to 'box' and add localization for 'box'
* refactor: streamline BypassButton logic and enhance MoreOptions menu with state bumping
* refactor: remove toast notifications from subgraph operations for cleaner logic
* refactor: ensure menu options re-compute when selection flags change
* feat: Enhance MoreOptions behavior with drag-and-drop support
* fix: Update mask icon class for consistent styling in MaskEditorButton
* refactor: Standardize icon sizes and classes across selection toolbox buttons
* refactor: Update layout and styling in SelectionToolbox and MoreOptions components
* refactor: Improve selection toolbox behavior with more options state management
* Refactor: Remove unused imports and conditionally add subgraph option in menu
* Enhance popover behavior: add show/hide event handlers and improve positioning logic
* Cleanup: Remove debug comments from popover functions for clarity
* Refactor: Clean up FrameNodes component and add MenuOptionBadge for better option display
* Cleanup: Remove debug comments from useSelectionToolboxPosition for clarity
* Add useFrameNodes composable for grouping selected nodes
* Refactor: Update shape options in useNodeCustomization and localize frame nodes label
* fix tests
* Cleanup: Remove packageManager entry from package.json
* Refactor: Replace ILucide icons with named imports from lucide-vue-next
* Refactor: Update shape selection and improve color picker behavior in selection toolbox
* Update test expectations [skip ci]
* feat: Enhance More Options Menu for group node management and update localization strings
* refactor: Comment out PublishButton
* refactor: Comment out test for bookmark button visibility in SelectionToolbox
* refactor: Update class names for dark theme compatibility in ExecuteButton and MenuOptionItem components
* refactor: Modularize menu options by creating dedicated composables for group, image, node, and selection operations
* refactor: Update selectors in tests to match design changes
* refactor: Update help button selector in Node Help tests
* refactor: Update getGroupColorOptions to accept groupContext and bump parameters
* Update test expectations [skip ci]
* refactor: Center KSampler node before interaction in More Options submenu tests
* refactor: Adjust KSampler node positioning and simplify button click in More Options submenu tests
* refactor: Rename comfyPageFixture import for clarity
* refactor: use gap-1 instead of the explicit gap-[4px]
* refactor: Replace app.canvas with canvasStore.getCanvas for state management
* refactor: Simplify prop access by removing 'props.' prefix in MenuOptionItem component
* refactor: Remove explicit type annotation for item in buildSelectionSignature function
* refactor: Replace Lucide icons with string-based icon references in menu options
* refactor: Remove export from interface declarations for improved clarity
* refactor: Simplify class binding in BypassButton component for improved readability
* refactor: Update button class for consistent sizing in ExecuteButton component
* refactor: Update help button locator class for consistency in Node Help tests
* fix node help test
* refactor: Remove unused imports and simplify visibility conditions in selection toolbox components
* feat: Add 3D node selection logic and cleanup on unmount for selection toolbox
* refactor: Update help button locator to use consistent data-testid in Node Help tests
* fix: Correct help button locator syntax in Node Help tests
* refactor: Change resetMoreOptionsState to an internal function in useSelectionToolboxPosition
* test: Add Load3D node visibility logic for ColorPickerButton and remove redundant test case
* fix: Increase tooltip show delay for ColorPickerButton
* fix: Update selectedOutputNodes computation to filter by isLGraphNode
* fix: Remove unused nodeDef reference from InfoButton and submenu trigger from MenuOptionItem
* fix: Update showInfoButton logic to depend on nodeDef value
* refactor: Remove deprecated getBasicNodeOptions function for cleaner code
* refactor: Replace useNodeInfo with useSelectedNodeActions
* refactor: Integrate useNodeDefStore for improved node definition handling in SelectionToolbox and InfoButton tests
* refactor: Introduce useCanvasRefresh composable for consistent canvas refresh logic across node operations
* refactor: Remove irrelevant append-to attribute from Popover
* refactor: Use storeToRefs for selectedItems in useSelectionState and add tests for selection logic
* refactor: Update ExecuteButton to use hasOutputNodesSelected for visibility and remove unnecessary computed property
* refactor: move display of execution button tests to selectionToolbox
---------
Co-authored-by: github-actions <github-actions@github.com>
271 lines
8.3 KiB
TypeScript
271 lines
8.3 KiB
TypeScript
import { createPinia, setActivePinia } from 'pinia'
|
|
import { beforeEach, describe, expect, test, vi } from 'vitest'
|
|
import { type Ref, ref } from 'vue'
|
|
|
|
import { useSelectionState } from '@/composables/graph/useSelectionState'
|
|
import { useNodeLibrarySidebarTab } from '@/composables/sidebarTabs/useNodeLibrarySidebarTab'
|
|
import { LGraphEventMode } from '@/lib/litegraph/src/litegraph'
|
|
import { useCanvasStore } from '@/stores/graphStore'
|
|
import { useNodeDefStore } from '@/stores/nodeDefStore'
|
|
import { useNodeHelpStore } from '@/stores/workspace/nodeHelpStore'
|
|
import { useSidebarTabStore } from '@/stores/workspace/sidebarTabStore'
|
|
import { isImageNode, isLGraphNode } from '@/utils/litegraphUtil'
|
|
import { filterOutputNodes } from '@/utils/nodeFilterUtil'
|
|
|
|
// Test interfaces
|
|
interface TestNodeConfig {
|
|
type?: string
|
|
mode?: LGraphEventMode
|
|
flags?: { collapsed?: boolean }
|
|
pinned?: boolean
|
|
removable?: boolean
|
|
}
|
|
|
|
interface TestNode {
|
|
type: string
|
|
mode: LGraphEventMode
|
|
flags?: { collapsed?: boolean }
|
|
pinned?: boolean
|
|
removable?: boolean
|
|
isSubgraphNode: () => boolean
|
|
}
|
|
|
|
type MockedItem = TestNode | { type: string; isNode: boolean }
|
|
|
|
// Mock all stores
|
|
vi.mock('@/stores/graphStore', () => ({
|
|
useCanvasStore: vi.fn()
|
|
}))
|
|
|
|
vi.mock('@/stores/nodeDefStore', () => ({
|
|
useNodeDefStore: vi.fn()
|
|
}))
|
|
|
|
vi.mock('@/stores/workspace/sidebarTabStore', () => ({
|
|
useSidebarTabStore: vi.fn()
|
|
}))
|
|
|
|
vi.mock('@/stores/workspace/nodeHelpStore', () => ({
|
|
useNodeHelpStore: vi.fn()
|
|
}))
|
|
|
|
vi.mock('@/composables/sidebarTabs/useNodeLibrarySidebarTab', () => ({
|
|
useNodeLibrarySidebarTab: vi.fn()
|
|
}))
|
|
|
|
vi.mock('@/utils/litegraphUtil', () => ({
|
|
isLGraphNode: vi.fn(),
|
|
isImageNode: vi.fn()
|
|
}))
|
|
|
|
vi.mock('@/utils/nodeFilterUtil', () => ({
|
|
filterOutputNodes: vi.fn()
|
|
}))
|
|
|
|
const createTestNode = (config: TestNodeConfig = {}): TestNode => {
|
|
return {
|
|
type: config.type || 'TestNode',
|
|
mode: config.mode || LGraphEventMode.ALWAYS,
|
|
flags: config.flags,
|
|
pinned: config.pinned,
|
|
removable: config.removable,
|
|
isSubgraphNode: () => false
|
|
}
|
|
}
|
|
|
|
// Mock comment/connection objects
|
|
const mockComment = { type: 'comment', isNode: false }
|
|
const mockConnection = { type: 'connection', isNode: false }
|
|
|
|
describe('useSelectionState', () => {
|
|
// Mock store instances
|
|
let mockSelectedItems: Ref<MockedItem[]>
|
|
|
|
beforeEach(() => {
|
|
vi.clearAllMocks()
|
|
setActivePinia(createPinia())
|
|
|
|
// Setup mock canvas store with proper ref
|
|
mockSelectedItems = ref([])
|
|
vi.mocked(useCanvasStore).mockReturnValue({
|
|
selectedItems: mockSelectedItems,
|
|
// Add minimal required properties for the store
|
|
$id: 'canvas',
|
|
$state: {} as any,
|
|
$patch: vi.fn(),
|
|
$reset: vi.fn(),
|
|
$subscribe: vi.fn(),
|
|
$onAction: vi.fn(),
|
|
$dispose: vi.fn(),
|
|
_customProperties: new Set(),
|
|
_p: {} as any
|
|
} as any)
|
|
|
|
// Setup mock node def store
|
|
vi.mocked(useNodeDefStore).mockReturnValue({
|
|
fromLGraphNode: vi.fn((node: TestNode) => {
|
|
if (node?.type === 'TestNode') {
|
|
return { nodePath: 'test.TestNode', name: 'TestNode' }
|
|
}
|
|
return null
|
|
}),
|
|
// Add minimal required properties for the store
|
|
$id: 'nodeDef',
|
|
$state: {} as any,
|
|
$patch: vi.fn(),
|
|
$reset: vi.fn(),
|
|
$subscribe: vi.fn(),
|
|
$onAction: vi.fn(),
|
|
$dispose: vi.fn(),
|
|
_customProperties: new Set(),
|
|
_p: {} as any
|
|
} as any)
|
|
|
|
// Setup mock sidebar tab store
|
|
const mockToggleSidebarTab = vi.fn()
|
|
vi.mocked(useSidebarTabStore).mockReturnValue({
|
|
activeSidebarTabId: null,
|
|
toggleSidebarTab: mockToggleSidebarTab,
|
|
// Add minimal required properties for the store
|
|
$id: 'sidebarTab',
|
|
$state: {} as any,
|
|
$patch: vi.fn(),
|
|
$reset: vi.fn(),
|
|
$subscribe: vi.fn(),
|
|
$onAction: vi.fn(),
|
|
$dispose: vi.fn(),
|
|
_customProperties: new Set(),
|
|
_p: {} as any
|
|
} as any)
|
|
|
|
// Setup mock node help store
|
|
const mockOpenHelp = vi.fn()
|
|
const mockCloseHelp = vi.fn()
|
|
const mockNodeHelpStore = {
|
|
isHelpOpen: false,
|
|
currentHelpNode: null,
|
|
openHelp: mockOpenHelp,
|
|
closeHelp: mockCloseHelp,
|
|
// Add minimal required properties for the store
|
|
$id: 'nodeHelp',
|
|
$state: {} as any,
|
|
$patch: vi.fn(),
|
|
$reset: vi.fn(),
|
|
$subscribe: vi.fn(),
|
|
$onAction: vi.fn(),
|
|
$dispose: vi.fn(),
|
|
_customProperties: new Set(),
|
|
_p: {} as any
|
|
}
|
|
vi.mocked(useNodeHelpStore).mockReturnValue(mockNodeHelpStore as any)
|
|
|
|
// Setup mock composables
|
|
vi.mocked(useNodeLibrarySidebarTab).mockReturnValue({
|
|
id: 'node-library-tab',
|
|
title: 'Node Library',
|
|
type: 'custom',
|
|
render: () => null
|
|
} as any)
|
|
|
|
// Setup mock utility functions
|
|
vi.mocked(isLGraphNode).mockImplementation((item: unknown) => {
|
|
const typedItem = item as { isNode?: boolean }
|
|
return typedItem?.isNode !== false
|
|
})
|
|
vi.mocked(isImageNode).mockImplementation((node: unknown) => {
|
|
const typedNode = node as { type?: string }
|
|
return typedNode?.type === 'ImageNode'
|
|
})
|
|
vi.mocked(filterOutputNodes).mockImplementation(
|
|
(nodes: TestNode[]) => nodes.filter((n) => n.type === 'OutputNode') as any
|
|
)
|
|
})
|
|
|
|
describe('Selection Detection', () => {
|
|
test('should return false when nothing selected', () => {
|
|
const { hasAnySelection } = useSelectionState()
|
|
expect(hasAnySelection.value).toBe(false)
|
|
})
|
|
|
|
test('should return true when items selected', () => {
|
|
// Update the mock data before creating the composable
|
|
const node1 = createTestNode()
|
|
const node2 = createTestNode()
|
|
mockSelectedItems.value = [node1, node2]
|
|
|
|
const { hasAnySelection } = useSelectionState()
|
|
expect(hasAnySelection.value).toBe(true)
|
|
})
|
|
})
|
|
|
|
describe('Node Type Filtering', () => {
|
|
test('should pick only LGraphNodes from mixed selections', () => {
|
|
// Update the mock data before creating the composable
|
|
const graphNode = createTestNode()
|
|
mockSelectedItems.value = [graphNode, mockComment, mockConnection]
|
|
|
|
const { selectedNodes } = useSelectionState()
|
|
expect(selectedNodes.value).toHaveLength(1)
|
|
expect(selectedNodes.value[0]).toEqual(graphNode)
|
|
})
|
|
})
|
|
|
|
describe('Node State Computation', () => {
|
|
test('should detect bypassed nodes', () => {
|
|
// Update the mock data before creating the composable
|
|
const bypassedNode = createTestNode({ mode: LGraphEventMode.BYPASS })
|
|
mockSelectedItems.value = [bypassedNode]
|
|
|
|
const { selectedNodes } = useSelectionState()
|
|
const isBypassed = selectedNodes.value.some(
|
|
(n) => n.mode === LGraphEventMode.BYPASS
|
|
)
|
|
expect(isBypassed).toBe(true)
|
|
})
|
|
|
|
test('should detect pinned/collapsed states', () => {
|
|
// Update the mock data before creating the composable
|
|
const pinnedNode = createTestNode({ pinned: true })
|
|
const collapsedNode = createTestNode({ flags: { collapsed: true } })
|
|
mockSelectedItems.value = [pinnedNode, collapsedNode]
|
|
|
|
const { selectedNodes } = useSelectionState()
|
|
const isPinned = selectedNodes.value.some((n) => n.pinned === true)
|
|
const isCollapsed = selectedNodes.value.some(
|
|
(n) => n.flags?.collapsed === true
|
|
)
|
|
const isBypassed = selectedNodes.value.some(
|
|
(n) => n.mode === LGraphEventMode.BYPASS
|
|
)
|
|
expect(isPinned).toBe(true)
|
|
expect(isCollapsed).toBe(true)
|
|
expect(isBypassed).toBe(false)
|
|
})
|
|
|
|
test('should provide non-reactive state computation', () => {
|
|
// Update the mock data before creating the composable
|
|
const node = createTestNode({ pinned: true })
|
|
mockSelectedItems.value = [node]
|
|
|
|
const { selectedNodes } = useSelectionState()
|
|
const isPinned = selectedNodes.value.some((n) => n.pinned === true)
|
|
const isCollapsed = selectedNodes.value.some(
|
|
(n) => n.flags?.collapsed === true
|
|
)
|
|
const isBypassed = selectedNodes.value.some(
|
|
(n) => n.mode === LGraphEventMode.BYPASS
|
|
)
|
|
|
|
expect(isPinned).toBe(true)
|
|
expect(isCollapsed).toBe(false)
|
|
expect(isBypassed).toBe(false)
|
|
|
|
// Test with empty selection using new composable instance
|
|
mockSelectedItems.value = []
|
|
const { selectedNodes: newSelectedNodes } = useSelectionState()
|
|
const newIsPinned = newSelectedNodes.value.some((n) => n.pinned === true)
|
|
expect(newIsPinned).toBe(false)
|
|
})
|
|
})
|
|
})
|