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
68 changes: 68 additions & 0 deletions src/lib/litegraph/src/LGraph.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { describe, expect, it } from 'vitest'

import { LGraph, LGraphNode, LiteGraph } from '@/lib/litegraph/src/litegraph'
import {
createTestSubgraphData,
createTestSubgraphNode
} from './subgraph/__fixtures__/subgraphHelpers'

import { test } from './__fixtures__/testExtensions'

Expand Down Expand Up @@ -209,6 +213,70 @@ describe('Graph Clearing and Callbacks', () => {
})
})

describe('Subgraph Definition Garbage Collection', () => {
function createSubgraphWithNodes(rootGraph: LGraph, nodeCount: number) {
const subgraph = rootGraph.createSubgraph(createTestSubgraphData())

const innerNodes: LGraphNode[] = []
for (let i = 0; i < nodeCount; i++) {
const node = new LGraphNode(`Inner Node ${i}`)
subgraph.add(node)
innerNodes.push(node)
}

return { subgraph, innerNodes }
}

it('removing SubgraphNode fires onRemoved for inner nodes', () => {
const rootGraph = new LGraph()
const { subgraph, innerNodes } = createSubgraphWithNodes(rootGraph, 2)
const removedNodeIds = new Set<string>()

for (const node of innerNodes) {
node.onRemoved = () => removedNodeIds.add(String(node.id))
}

const subgraphNode = createTestSubgraphNode(subgraph, { pos: [100, 100] })
rootGraph.add(subgraphNode)

expect(subgraph.nodes.length).toBe(2)

rootGraph.remove(subgraphNode)

expect(removedNodeIds.size).toBe(2)
})

it('removing SubgraphNode fires onNodeRemoved callback', () => {
const rootGraph = new LGraph()
const { subgraph } = createSubgraphWithNodes(rootGraph, 2)
const graphRemovedNodeIds = new Set<string>()

subgraph.onNodeRemoved = (node) => graphRemovedNodeIds.add(String(node.id))

const subgraphNode = createTestSubgraphNode(subgraph, { pos: [100, 100] })
rootGraph.add(subgraphNode)

rootGraph.remove(subgraphNode)

expect(graphRemovedNodeIds.size).toBe(2)
})

it('subgraph definition is removed when SubgraphNode is removed', () => {
const rootGraph = new LGraph()
const { subgraph } = createSubgraphWithNodes(rootGraph, 1)
const subgraphId = subgraph.id

const subgraphNode = createTestSubgraphNode(subgraph, { pos: [100, 100] })
rootGraph.add(subgraphNode)

expect(rootGraph.subgraphs.has(subgraphId)).toBe(true)

rootGraph.remove(subgraphNode)

expect(rootGraph.subgraphs.has(subgraphId)).toBe(false)
})
Comment on lines +230 to +277
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add coverage for “definition retained when other references exist.”

The suite covers removal and callback behavior, but it doesn’t exercise the retention case where another SubgraphNode still references the same subgraph definition. That’s part of the stated objectives and is a key branch in the new GC logic.

Based on learnings, add a test that:

  1. creates two SubgraphNodes referencing the same subgraph definition,
  2. removes one, and
  3. asserts rootGraph.subgraphs still contains the definition.
🤖 Prompt for AI Agents
In `@src/lib/litegraph/src/LGraph.test.ts` around lines 230 - 277, Add a test that
ensures a subgraph definition is retained when another SubgraphNode still
references it: create an LGraph, call createSubgraphWithNodes(rootGraph, n) to
get a subgraph, then create two SubgraphNode instances for that same subgraph
via createTestSubgraphNode(subgraph, ...), add both to rootGraph, remove one
with rootGraph.remove(theFirstSubgraphNode), and assert that
rootGraph.subgraphs.has(subgraph.id) is still true; use the existing test style
and the same helpers (LGraph, createSubgraphWithNodes, createTestSubgraphNode,
rootGraph.subgraphs) so the new test covers the “definition retained when other
references exist” branch.

})

describe('Legacy LGraph Compatibility Layer', () => {
test('can be extended via prototype', ({ expect, minimalGraph }) => {
// @ts-expect-error Should always be an error.
Expand Down
10 changes: 10 additions & 0 deletions src/lib/litegraph/src/LGraph.ts
Original file line number Diff line number Diff line change
Expand Up @@ -992,6 +992,16 @@ export class LGraph
}
}

// Subgraph cleanup (use local const to avoid type narrowing affecting node.graph assignment)
const subgraphNode = node.isSubgraphNode() ? node : null
if (subgraphNode) {
for (const innerNode of subgraphNode.subgraph.nodes) {
innerNode.onRemoved?.()
subgraphNode.subgraph.onNodeRemoved?.(innerNode)
}
this.rootGraph.subgraphs.delete(subgraphNode.subgraph.id)
}

// callback
node.onRemoved?.()

Expand Down