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
10 changes: 7 additions & 3 deletions browser_tests/fixtures/components/Topbar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,14 @@ export class Topbar {
return classes ? !classes.includes('invisible') : false
}

getWorkflowTabLabel(tabName: string): Locator {
return this.page.locator(
`.workflow-tabs .workflow-label:has-text("${tabName}")`
)
}

getWorkflowTab(tabName: string): Locator {
return this.page
.locator(`.workflow-tabs .workflow-label:has-text("${tabName}")`)
.locator('..')
return this.getWorkflowTabLabel(tabName).locator('..')
}

getTab(index: number): Locator {
Expand Down
28 changes: 28 additions & 0 deletions browser_tests/tests/canvas/copyPasteAfterTextSelection.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import {
comfyExpect as expect,
comfyPageFixture as test
} from '@e2e/fixtures/ComfyPage'

test.describe(
'Copy and paste after selecting text outside the canvas',
{ tag: ['@canvas', '@node'] },
() => {
test('a node clicked on the classic canvas copies and pastes while topbar text is selected', async ({
comfyPage
}) => {
const before = await comfyPage.nodeOps.getGraphNodesCount()
const [node] = await comfyPage.nodeOps.getNodeRefsByTitle('KSampler')

await comfyPage.menu.topbar
.getWorkflowTabLabel('Unsaved Workflow')
.selectText()
await node.click('title')
await comfyPage.clipboard.copy()
await comfyPage.clipboard.paste()

await expect
.poll(() => comfyPage.nodeOps.getGraphNodesCount())
.toBe(before + 1)
})
}
)
14 changes: 13 additions & 1 deletion src/components/graph/GraphCanvas.vue
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,10 @@ import { ChangeTracker } from '@/scripts/changeTracker'
import { IS_CONTROL_WIDGET, updateControlWidgetLabel } from '@/scripts/widgets'
import { useColorPaletteService } from '@/services/colorPaletteService'
import { useNewUserService } from '@/services/useNewUserService'
import { shouldIgnoreCopyPaste } from '@/workbench/eventHelpers'
import {
collapseOutsideSelectionOnPrimaryPointerDown,
shouldIgnoreCopyPaste
} from '@/workbench/eventHelpers'
import { storeToRefs } from 'pinia'

import { useBootstrapStore } from '@/stores/bootstrapStore'
Expand Down Expand Up @@ -617,7 +620,16 @@ onUnmounted(() => {
cleanupErrorHooks?.()
cleanupErrorHooks = null
})

useEventListener(
canvasRef,
'pointerdown',
collapseOutsideSelectionOnPrimaryPointerDown,
{ capture: true }
)

function forwardPointerDownPanEvent(e: PointerEvent) {
collapseOutsideSelectionOnPrimaryPointerDown(e)
forwardPanEvent(e, isMiddlePointerInput)
}

Expand Down
200 changes: 161 additions & 39 deletions src/composables/useCopy.test.ts
Original file line number Diff line number Diff line change
@@ -1,55 +1,64 @@
import { beforeEach, describe, expect, it, vi } from 'vitest'
import {
assert,
beforeEach,
describe,
expect,
it,
onTestFinished,
vi
} from 'vitest'
import { effectScope } from 'vue'
import { useCopy } from './useCopy'
import { useCanvasStore } from '@/renderer/core/canvas/canvasStore'
import type { LGraphCanvas } from '@/lib/litegraph/src/litegraph'
import { fromPartial } from '@total-typescript/shoehorn'

const copyMocks = vi.hoisted(() => ({
copyHandler: undefined as ((event: ClipboardEvent) => unknown) | undefined,
const copyMocks = {
canvas: {
selectedItems: new Set<object>([{}]),
copyToClipboard: vi.fn()
}
}))

vi.mock('@vueuse/core', () => ({
useEventListener: vi.fn(
(
_target: EventTarget,
event: string,
handler: (event: ClipboardEvent) => unknown
) => {
if (event === 'copy') copyMocks.copyHandler = handler
return vi.fn()
}
)
}))
}

vi.mock('@/renderer/core/canvas/canvasStore', () => ({
useCanvasStore: () => ({
canvas: copyMocks.canvas
})
}))
const multiChunkPayloadLength = 0x8000 * 6 + 123
const canvasClipboardKey = 'litegrapheditor_clipboard'
const canvasClipboardIdKey = 'litegrapheditor_clipboard_id'

vi.mock('@/workbench/eventHelpers', () => ({
shouldIgnoreCopyPaste: vi.fn(() => false)
}))
function mountCopy(): void {
const scope = effectScope()
scope.run(useCopy)
onTestFinished(() => scope.stop())
}

const multiChunkPayloadLength = 0x8000 * 6 + 123
function dispatchCopy(target: EventTarget = document): DataTransfer {
const dataTransfer = new DataTransfer()
target.dispatchEvent(
new ClipboardEvent('copy', { clipboardData: dataTransfer, bubbles: true })
)

return dataTransfer
}

function copySerializedData(serializedData: string): DataTransfer {
copyMocks.canvas.copyToClipboard.mockReturnValue(serializedData)
return dispatchCopy()
}

useCopy()

const dataTransfer = new DataTransfer()
const event = new ClipboardEvent('copy', {
clipboardData: dataTransfer
function selectDocumentText(selectedCharacters: number): void {
const paragraph = document.createElement('p')
const text = document.createTextNode('Transcript text')
paragraph.append(text)
document.body.append(paragraph)
const range = document.createRange()
range.setStart(text, 0)
range.setEnd(text, selectedCharacters)
const selection = window.getSelection()
assert.exists(selection)
selection.addRange(range)
onTestFinished(() => {
selection.removeAllRanges()
paragraph.remove()
})
const copyHandler = copyMocks.copyHandler
expect(copyHandler).toBeDefined()
if (!copyHandler) throw new Error('Expected copy handler to be registered')

expect(() => copyHandler(event)).not.toThrow()

return dataTransfer
}

function readSerializedClipboardMetadata(dataTransfer: DataTransfer): string {
Expand All @@ -66,7 +75,8 @@ function readSerializedClipboardMetadata(dataTransfer: DataTransfer): string {

describe('useCopy', () => {
beforeEach(() => {
copyMocks.copyHandler = undefined
useCanvasStore().canvas = fromPartial<LGraphCanvas>(copyMocks.canvas)
mountCopy()
})

it('should write large serialized node data to clipboard metadata', () => {
Expand All @@ -90,4 +100,116 @@ describe('useCopy', () => {

expect(readSerializedClipboardMetadata(dataTransfer)).toBe(serializedData)
})

describe('copy on a target the canvas ignores', () => {
const keyboardNode = '{"nodes":[{"type":"LoadImage"}]}'
const contextMenuNode = '{"nodes":[{"type":"SaveImage"}]}'
let copyId = 0

function writeCanvasClipboard(serializedData: string): void {
localStorage.setItem(canvasClipboardKey, serializedData)
localStorage.setItem(canvasClipboardIdKey, String(++copyId))
}

function copyNodeWithKeyboard(): void {
copyMocks.canvas.copyToClipboard.mockImplementation(() => {
writeCanvasClipboard(keyboardNode)
return keyboardNode
})
dispatchCopy()
}

function copyNodeFromContextMenu(
serializedData: string = contextMenuNode
): void {
writeCanvasClipboard(serializedData)
}

beforeEach(() => {
copyId = 0
onTestFinished(() => {
localStorage.removeItem(canvasClipboardKey)
localStorage.removeItem(canvasClipboardIdKey)
})
})

it.for([
{
slot: 'a keyboard node copy',
writeSlot: [copyNodeWithKeyboard],
selection: 'selected document text',
selectedCharacters: 'Transcript'.length,
slotAfter: null
},
{
slot: 'a keyboard node copy',
writeSlot: [copyNodeWithKeyboard],
selection: 'a collapsed caret',
selectedCharacters: 0,
slotAfter: keyboardNode
},
{
slot: 'a context-menu copy',
writeSlot: [copyNodeFromContextMenu],
selection: 'selected document text',
selectedCharacters: 'Transcript'.length,
slotAfter: contextMenuNode
},
{
slot: 'a context-menu copy after a keyboard node copy',
writeSlot: [copyNodeWithKeyboard, copyNodeFromContextMenu],
selection: 'selected document text',
selectedCharacters: 'Transcript'.length,
slotAfter: contextMenuNode
},
{
slot: 'an equal context-menu copy after a keyboard node copy',
writeSlot: [
copyNodeWithKeyboard,
() => copyNodeFromContextMenu(keyboardNode)
],
selection: 'selected document text',
selectedCharacters: 'Transcript'.length,
slotAfter: keyboardNode
}
])(
'with $selection after $slot leaves the canvas clipboard slot as $slotAfter',
({ writeSlot, selectedCharacters, slotAfter }) => {
for (const write of writeSlot) write()
copyMocks.canvas.copyToClipboard.mockClear()
selectDocumentText(selectedCharacters)
const textarea = document.createElement('textarea')
document.body.append(textarea)
onTestFinished(() => textarea.remove())

const dataTransfer = dispatchCopy(textarea)

expect(localStorage.getItem(canvasClipboardKey)).toBe(slotAfter)
expect(dataTransfer.getData('text/html')).toBe('')
expect(copyMocks.canvas.copyToClipboard).not.toHaveBeenCalled()
}
)

it.for([
{ name: 'textarea', make: () => document.createElement('textarea') },
{
name: 'search input',
make: () =>
Object.assign(document.createElement('input'), { type: 'search' })
}
])(
'clears a keyboard node copy after copying selected $name text',
({ make }) => {
copyNodeWithKeyboard()
const input = make()
input.value = 'selected text'
document.body.append(input)
input.setSelectionRange(0, 'selected'.length)

dispatchCopy(input)

expect(localStorage.getItem(canvasClipboardKey)).toBeNull()
}
)
})
})
19 changes: 18 additions & 1 deletion src/composables/useCopy.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
import { useEventListener } from '@vueuse/core'

import { useCanvasStore } from '@/renderer/core/canvas/canvasStore'
import { shouldIgnoreCopyPaste } from '@/workbench/eventHelpers'
import {
hasTextSelection,
shouldIgnoreCopyPaste
} from '@/workbench/eventHelpers'

const CANVAS_CLIPBOARD_KEY = 'litegrapheditor_clipboard'
const CANVAS_CLIPBOARD_ID_KEY = 'litegrapheditor_clipboard_id'

const clipboardHTMLWrapper = [
'<meta charset="utf-8"><div><span data-metadata="',
Expand Down Expand Up @@ -36,16 +42,27 @@ function encodeClipboardData(data: string): string {
*/
export const useCopy = () => {
const canvasStore = useCanvasStore()
let keyboardCopyId: string | null = null

useEventListener(document, 'copy', (e) => {
if (shouldIgnoreCopyPaste(e.target)) {
// Default system copy
if (
keyboardCopyId !== null &&
hasTextSelection(e.target) &&
localStorage.getItem(CANVAS_CLIPBOARD_ID_KEY) === keyboardCopyId
) {
localStorage.removeItem(CANVAS_CLIPBOARD_KEY)
localStorage.removeItem(CANVAS_CLIPBOARD_ID_KEY)
keyboardCopyId = null
}
return
}
// copy nodes and clear clipboard
const canvas = canvasStore.canvas
if (canvas?.selectedItems) {
const serializedData = canvas.copyToClipboard()
keyboardCopyId = localStorage.getItem(CANVAS_CLIPBOARD_ID_KEY)
try {
const base64Data = encodeClipboardData(serializedData)
// clearData doesn't remove images from clipboard
Expand Down
29 changes: 28 additions & 1 deletion src/lib/litegraph/src/LGraphCanvas.clipboard.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ import {

import { flushProxyWidgetMigration } from '@/core/graph/subgraph/migration/proxyWidgetMigration'
import { autoExposeKnownPreviewNodes } from '@/core/graph/subgraph/promotionUtils'
import { enableSubgraphNodeCreation } from '@/lib/litegraph/src/subgraph/__fixtures__/subgraphHelpers'
import { createTestNode } from '@/lib/litegraph/src/__fixtures__/nodeHelpers'
import {
createTestRootGraph,
enableSubgraphNodeCreation
} from '@/lib/litegraph/src/subgraph/__fixtures__/subgraphHelpers'
import {
LGraph,
LGraphCanvas,
Expand Down Expand Up @@ -473,6 +477,29 @@ describe('_deserializeItems paste-time migration & auto-expose', () => {
})
})

describe('copyToClipboard', () => {
it('stamps every copy with a new clipboard id, even for an equal payload', () => {
const rootGraph = createTestRootGraph()
const node = createTestNode(rootGraph, [], ['number'])
const canvas = createCanvas(rootGraph)
onTestFinished(() => {
localStorage.removeItem('litegrapheditor_clipboard')
localStorage.removeItem('litegrapheditor_clipboard_id')
})

const first = canvas.copyToClipboard([node])
const firstId = localStorage.getItem('litegrapheditor_clipboard_id')
const second = canvas.copyToClipboard([node])

expect(second).toBe(first)
expect(localStorage.getItem('litegrapheditor_clipboard')).toBe(second)
expect(firstId).toMatch(/^[0-9a-f-]{36}$/)
expect(localStorage.getItem('litegrapheditor_clipboard_id')).not.toBe(
firstId
)
})
})

describe('clipboard reroute id integrity', () => {
const carrierType = 'test/reroute-carrier'

Expand Down
1 change: 1 addition & 0 deletions src/lib/litegraph/src/LGraphCanvas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4061,6 +4061,7 @@ export class LGraphCanvas implements CustomEventDispatcher<LGraphCanvasEventMap>
copyToClipboard(items?: Iterable<Positionable>): string {
const serializedData = JSON.stringify(this._serializeItems(items))
localStorage.setItem('litegrapheditor_clipboard', serializedData)
localStorage.setItem('litegrapheditor_clipboard_id', createUuidv4())
return serializedData
}

Expand Down
Loading
Loading