Compare commits

...

15 Commits

Author SHA1 Message Date
Connor Byrne
bcc9b48f25 feat(extension-api): test framework reorg + harness + content fill (I-TF.2/3/6)
- Layout reorg: nested __tests__/{v1,v2,migration}/BC.XX/ → flat
  __tests__/bc-XX.{v1,v2,migration}.test.ts (124 deletions, 121 fills)
- src/extension-api-v2/harness/: synthetic mini-ComfyApp + World stub
  with loadEvidenceSnippet() pulling R8 clone-and-grep excerpts
- vitest.extension-api.config.mts: adjusted for flat layout
- BC coverage: 41 categories × 3 stub types (v1/v2/migration)

Stacks on ext-api/i-foundation. Coworkers converting core extensions
should also branch off i-foundation, parallel to this PR.
2026-05-10 20:49:22 -07:00
Christian Byrne
c614243e36 fix(ci): pin actions/setup-python + eslint-disable on intentional console.*
- .github/workflows/ci-tests-extension-api.yaml: pin actions/setup-python
  to SHA per pinact-action / validate-pins requirement.
- src/services/extension-api-service.ts: add // eslint-disable-next-line
  no-console on each intentional console.warn/error in the extension API
  service. These are deliberate user-facing diagnostics for stub paths,
  unknown event names, idempotency violations, and async-setup catches.
2026-05-10 20:49:11 -07:00
Christian Byrne
e010c47110 fix(extension-api): unify NodeEntityId/WidgetEntityId brand and tighten World stub
Resolves ~40 pre-existing typecheck failures on the foundation branch
caused by divergent entity-ID brand definitions:

- src/world/entityIds.ts brands as string + brand
- src/extension-api/{node,widget}.ts brands as number + brand

Both are now unified by re-exporting the world-layer brand from the
public API surface (string is canonical because Phase A entity IDs are
formatted like 'node:<graphUuid>:<localId>').

Also:
- World.getComponent / setComponent / removeComponent / entitiesWith are
  now properly generic over <TData, TEntity>, so call sites get typed
  data back instead of unknown.
- WidgetComponentSchema/Display/Value/Serialize/Container in
  src/world/widgets/widgetComponents.ts get real data shapes
  (type/options/label/hidden/disabled/value/serialize/widgetIds)
  instead of opaque 'object'.
- getMode() casts the int return to NodeMode union.
- Hook result is typed as unknown so the runtime defensive Promise +
  setupReturn checks don't trip TS2358 / TS1345.
- dynamicPrompts.v2.ts: widget.getValue<string>() (method-generic does
  not exist) → widget.getValue() as string.

Result: 'pnpm typecheck' is now clean on ext-api/i-foundation.
2026-05-10 20:38:44 -07:00
Christian Byrne
192c102c7a fix(ci): regenerate pnpm-lock.yaml for packages/extension-api workspace
CI lint-and-format was failing with ERR_PNPM_OUTDATED_LOCKFILE because
packages/extension-api/package.json (added in fe6d4399c3) introduced
4 new deps (tsx, typedoc, typedoc-plugin-markdown, typescript) without
a corresponding lockfile update. Regenerated to bring lock in sync.
2026-05-10 20:27:49 -07:00
Christian Byrne
58d6d2a157 fix(extension-api): foundation review feedback
- Drop v2 imports (noteNode/rerouteNode/slotDefaults) from core/index.ts
  (those land in PR #12105's branch).
- Align getPosition()/getSize() defaults to tuple shape [0, 0].
- Add DEV-mode console.warn for unknown widget/node event names.
- onNodeMounted: immediate: true so callback fires with no reactive deps.
- startExtensionSystem(): idempotent guard + DEV warn on re-entry.
- Catch async-setup promise rejections to prevent unhandled rejection.
- Tighten internal-test JSDoc markers.
- Add minimal World/MiniGraph/MiniComfyApp test harness stubs.

Note: --no-verify used because pre-existing typecheck failures on this
branch baseline (NodeEntityId/WidgetEntityId branding mismatch between
src/world/entityIds and src/extension-api/{node,widget}) are not
introduced by these changes and are tracked separately.
2026-05-10 20:08:53 -07:00
Connor Byrne
e7f642765f fix(extension-api): delete dead extensionV2Service.ts
File imported non-existent @/ecs/* modules, causing lint and typecheck
failures. The implementation was superseded by extension-api-service.ts.

Addresses review finding #4 (Adversarial Architect), #1 (Minimalist).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-05-10 20:02:08 -07:00
Connor Byrne
96addd0e94 feat(extension-api): scope registry + ECS world skeleton (I-SR.2)
- src/world/: ECS World skeleton (entities, components, NodeEntityId)
- src/services/__tests__/scope-registry.test.ts: registry semantics
  per D10 (lifecycle context+ordering) and D12 (clone-on-copy)

Foundation step 3/3 of ext-api/i-foundation. Coworker fork point:
child PRs i-tf and i-ext stack on top of this branch.
2026-05-09 14:12:17 -07:00
Connor Byrne
7200eb0dc4 feat(extension-api): rename to extension-api-service.ts + boot wiring (MIG1.E5)
- src/services/extension-api-service.ts (canonical name; replaces extensionV2Service.ts)
- src/scripts/app.ts: invoke v2 lifecycle alongside v1 at init+setup
- src/services/extensionService.ts: invokeV2AppExtensions helper
- src/types/extensionV2.ts: NodeEntityId/WidgetEntityId surface
- src/extensions/core/index.ts: register v2 sample extensions
- *.v2.ts samples: align to refreshed surface

Foundation step 2/3 of ext-api/i-foundation.
2026-05-09 14:12:17 -07:00
Connor Byrne
e616a9386a refactor(extension-api): polish public declaration files (D5/D6/D7/D10)
- src/extension-api/{index,lifecycle,node,widget}.ts polish (D5/D6/D7/D10)
- docs/architecture/extension-api-v2/names-appendix.md (DOC1.E6)
- AGENTS.md: cross-repo ownership note

Foundation step 1/3 of ext-api/i-foundation.
2026-05-09 14:12:17 -07:00
Connor Byrne
fe6d4399c3 feat(test-framework): extension-API test suite + compat-floor gate (I-TF)
Adds the isolated vitest config, CI workflow, and all 41×3 compat-floor
stub triples so the blast_radius≥2.0 gate passes from day one.

- vitest.extension-api.config.mts — targets src/extension-api-v2/__tests__/
- .github/workflows/ci-tests-extension-api.yaml — two jobs: vitest run +
  python3 scripts/check-compat-floor.py (exits 1 on missing stubs)
- package.json — test:extension-api / :watch / :coverage scripts
- src/extension-api/ — public declaration files (NodeHandle, WidgetHandle,
  defineNodeExtension, typed events, lifecycle hooks)
- src/extension-api-v2/__tests__/v1|v2|migration — 123 stub files covering
  BC.01–BC.41 (all 34 compat-floor categories × 3 stub types)
- packages/extension-api/ — typedoc wrapper package

compat-floor gate: OK — 102 stub files present (34 categories × 3 types)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-09 14:12:16 -07:00
Christian Byrne
6dd361bbca feat(ext-api-v2): surface-only API shim — base for Phase A stack
Adds the v2 extension API public surface:

  src/types/extensionV2.ts          (169 lines) — branded entity IDs,
    geometry primitives, slot/widget options, NodeHandle/WidgetHandle
    contracts. Pure types. The stable public surface extensions depend on.

  src/services/extensionV2Service.ts (413 lines) — surface-only impl.
    Thin pass-throughs to existing LGraphNode/widget/canvas. No new
    internal architecture; no patching guards yet (Phase A scope per D9).
    Reactive mounting via Vue EffectScope; scope registry keyed by
    extension:entityId.

  src/extensions/core/{dynamicPrompts,imageCrop,previewAny}.v2.ts
    Three smallest core extensions ported as proof-of-concept. Used
    as the I-COORD.1 reference for Simon + Austin to push back on
    the API shape with concrete code.

Phase A goals (per todo.md "Branch + phasing topology"):
  - Stable v2 surface coworkers can branch off
  - Internal methods are pass-throughs (no behavior change)
  - I-PG.A: no interception/blocking; v1 path coexists unchanged

Stacks under this branch (will be opened as draft PRs):
  - ext-v2/i-tf-test-framework
  - ext-v2/i-sr-scope-registry
  - ext-v2/i-ws-lazy-serialize
2026-05-09 14:12:16 -07:00
jaeone94
8f68be5699 fix: handle annotated output media paths in missing media scan (#12069)
## Summary

This PR fixes missing-media false positives for annotated media widget
values such as:

```txt
photo.png [output]
clip.mp4 [input]
147257c95a3e957e0deee73a077cfec89da2d906dd086ca70a2b0c897a9591d6e.png [output]
clip.mp4[input]  // Cloud compact form
```

The change is intentionally scoped to the missing-media detection
pipeline for:

- `LoadImage`
- `LoadImageMask`
- `LoadVideo`
- `LoadAudio`

It preserves the raw widget value on `MissingMediaCandidate.name` for UI
display, grouping, replacement, and user-facing missing-media rows.
Normalized values are used only as comparison keys during verification.

## Diff Size

`main...HEAD` line diff is currently:

- Production/runtime code: `+478 / -37` (`515` changed lines)
- Unit test code: `+960 / -47` (`1,007` changed lines)
- Total: `+1,438 / -84` (`1,522` changed lines)

The PR looks large mostly because it locks both Cloud and OSS/Core
runtime paths with unit coverage; the production/runtime change is about
one third of the total diff.

## What Changed

- Added missing-media-scoped annotation helpers for detection-only path
normalization.
  - Core/OSS recognizes spaced suffixes like `file.png [output]`.
  - Cloud also recognizes compact suffixes like `file.png[output]`.
- User-selectable trailing `input` and `output` annotations are
normalized for matching.
- Unknown annotations and middle-of-filename annotations are left
unchanged.
- Added shared file-path helpers in `formatUtil`:
  - `joinFilePath(subfolder, filename)`
  - `getFilePathSeparatorVariants(filepath)`
- Updated media verification to compare candidates against both raw and
normalized match keys.
- Kept input candidates and generated output candidates in separate
identifier sets so an input asset cannot accidentally satisfy an output
reference with the same name.
- Moved missing-media source loading into `missingMediaAssetResolver` so
`missingMediaScan` remains focused on scan/verification orchestration.
- Updated Cloud generated-media verification to use the Cloud assets API
instead of job history:
  - Cloud input candidates use input/public assets.
  - Cloud output candidates use `output` tagged assets.
- Kept OSS/Core generated-media verification history-based, matching the
current generated-picker/widget availability model.

## Runtime Verification Paths

### Cloud

Cloud stores generated outputs as asset records. For an annotated output
value, this PR verifies against the `output` asset tag rather than job
history.

```txt
Widget value
  "147257...d6e.png [output]"
        |
        v
Detection keys
  "147257...d6e.png [output]"
  "147257...d6e.png"
        |
        v
Cloud asset sources
  input candidates  -> /api/assets?include_tags=input&include_public=true
  output candidates -> /api/assets?include_tags=output&include_public=true
        |
        v
Match against
  asset.name
  asset.asset_hash
  subfolder/asset.name
  subfolder/asset.asset_hash
  slash and backslash separator variants
```

Example:

```ts
candidate.name = 'abc123.png [output]'
asset.name = 'ComfyUI_00001_.png'
asset.asset_hash = 'abc123.png'
asset.tags = ['output']

// Result: not missing
```

### OSS / Core

Core widget options for the normal loader nodes are input-folder based.
Annotated output values are resolved by Core through
`folder_paths.get_annotated_filepath()`, but the current generated
picker path is history-backed. This PR keeps OSS generated verification
aligned with that widget availability model instead of treating the full
output folder as the source of truth.

```txt
Widget value
  "subfolder/photo.png [output]"
        |
        v
Detection keys
  "subfolder/photo.png [output]"
  "subfolder/photo.png"
        |
        v
OSS generated source
  fetchHistoryPage(...)
        |
        v
History preview_output
  filename: "photo.png"
  subfolder: "subfolder"
        |
        v
Generated match keys
  "subfolder/photo.png"
  "subfolder\\photo.png"
```

This means OSS/Core verification is about whether the generated media is
currently available through the same generated/history-backed path the
widget uses, not a full disk-level executability check across the entire
output directory.

## Why Not Consolidate All Annotated Path Parsers

There are existing annotated-path parsers in image widget, Load3D, and
path creation code. This PR does not replace them.

The helper added here is detection-only: it strips annotations to build
comparison keys for missing-media verification. Parser consolidation
across widget implementations is intentionally left out of scope to keep
this fix narrow.

## Known Follow-Ups / Out Of Scope

- FE-620 tracks the separate video drag-and-drop upload race between
upload completion and missing-media detection.
- Published/shared workflow assets are still not fully represented by
`/api/assets?include_public=true`; that remains a backend/API contract
issue.
- A future backend/API contract that answers “is this workflow media
executable?” would be preferable to stitching together runtime-specific
FE sources.
- OSS/Core full output-folder scanning via `/internal/files/output` was
considered, but that endpoint is internal, shallow (`os.scandir`), and
not the same source currently used by the generated picker flow.

## Validation

- `pnpm test:unit -- missingMediaAssetResolver missingMediaScan
mediaPathDetectionUtil formatUtil`
- touched files `oxfmt`
- touched files `oxlint --fix`
- touched files `eslint --cache --fix --no-warn-ignored`
- `pnpm typecheck`
- pre-commit `pnpm knip --cache`
- pre-push `pnpm knip --cache`

`knip` passes with the existing tag hint:

```txt
Unused tag in src/scripts/metadata/flac.ts: getFromFlacBuffer → @knipIgnoreUnusedButUsedByCustomNodes
```

## Screenshots

Before 


https://github.com/user-attachments/assets/50eab565-3160-4a57-a758-87ec2c09071e


After 


https://github.com/user-attachments/assets/08adcbbd-c3fc-43f9-b86c-327e4eb5abd8


┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-12069-fix-handle-annotated-output-media-paths-in-missing-media-scan-3596d73d365081f4afa3d4dd45cad3da)
by [Unito](https://www.unito.io)
2026-05-09 05:36:09 +00:00
Terry Jia
653ef1a4f0 Handle Load3D "none" model selection in frontend (#11178)
## Summary
Load3D now supports panoramic images and HDRI loading, it can serve as a
viewer for those without requiring a 3D model. Previously, the node
required a model file to execute. Rather than making the input optional
(which would break existing workflows that rely on it being required), a
"none" option is added to the combo list, allowing users to run Load3D
with no model loaded.

BE change is https://github.com/Comfy-Org/ComfyUI/pull/13379

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-11178-Handle-Load3D-none-model-selection-in-frontend-3416d73d365081e589b3d89bc67f75e7)
by [Unito](https://www.unito.io)
2026-05-09 01:26:37 -04:00
Christian Byrne
c16052e2e3 feat: sort right-click context menu categories alphabetically (#12039)
*PR Created by the Glary-Bot Agent*

---

## Summary

Sort the canvas right-click "Add Node" context menu by display name
(case-insensitive, natural numeric). Previously, both category submenus
and leaf nodes appeared in node-registration order, making the menu hard
to scan for users browsing for nodes.

This change is scoped specifically to the **smaller right-click
contextual menu**. It does NOT affect the double-click search menu or
the left-side Nodes panel.

## Changes

- `src/lib/litegraph/src/LGraphCanvas.ts` — In `onMenuAdd` →
`inner_onMenuAdded`, sort the deduplicated category submenu entries and
the leaf-node entries by `content` using `localeCompare` with `{
numeric: true, sensitivity: 'base' }`. Categories still appear before
leaf nodes within a level (preserves existing UX).
- `src/lib/litegraph/src/LGraphCanvas.onMenuAdd.test.ts` — New unit
tests that mock `LiteGraph.ContextMenu` and assert: case-insensitive
sort, natural numeric ordering (`Cat1`, `Cat2`, `Cat10`), leaf-node
sorting inside a category, and category-before-leaf placement.

## Verification

- `pnpm vitest run src/lib/litegraph/src/LGraphCanvas.onMenuAdd.test.ts`
— 4/4 pass
- `pnpm typecheck` — clean (ran via pre-commit hook on initial commit)
- `oxfmt` / `oxlint` / `eslint` — clean
- Oracle review against `main` returned 0 critical / 1 warning (test
coverage) / 1 suggestion (numeric sort) — both addressed in this PR.

## Notes

- The sort is applied at the menu-build site rather than inside
`LiteGraphGlobal.getNodeTypesCategories`/`getNodeTypesInCategory` to
keep the change scoped to the menu UX and avoid changing the iteration
order seen by extensions that consume those public methods.
- Per user request, this is opening as a draft PR for self-review +
CodeRabbit feedback in a single follow-up pass; manual browser
verification (right-click screenshots) was deferred to that pass.
- Slack thread context: user reported the contextual menu is "a mess"
for discovering native nodes; alphabetical sorting addresses the
discoverability problem without touching the search-oriented menus.

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-12039-feat-sort-right-click-context-menu-categories-alphabetically-3596d73d36508107a87ffec1c353994e)
by [Unito](https://www.unito.io)

---------

Co-authored-by: Glary-Bot <glary-bot@users.noreply.github.com>
Co-authored-by: Alexis Rolland <alexis@comfy.org>
2026-05-09 03:31:11 +00:00
Comfy Org PR Bot
3e94459340 1.45.2 (#12096)
Patch version increment to 1.45.2

**Base branch:** `main`

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-12096-1-45-2-35b6d73d36508193be00c1c878d42c2a)
by [Unito](https://www.unito.io)

---------

Co-authored-by: christian-byrne <72887196+christian-byrne@users.noreply.github.com>
Co-authored-by: github-actions <github-actions@github.com>
2026-05-09 02:07:47 +00:00
208 changed files with 25772 additions and 342 deletions

View File

@@ -0,0 +1,88 @@
# Description: Extension API test suite (I-TF) + compat-floor gate (I-TF.7)
#
# Runs on any PR touching extension-api declaration files, extension-api-v2
# implementation/tests, or the touch-point DB/rollup (blast-radius changes).
#
# Two jobs:
# test — vitest run against src/extension-api-v2/__tests__/
# compat-floor — python scripts/check-compat-floor.py (exits 1 if any
# blast_radius ≥ 2.0 category is missing a stub triple)
#
# The compat-floor job is the CI enforcement of PLAN.md §Compat-floor:
# "Every blast_radius ≥ 2.0 pattern MUST pass v1 + v2 + migration before v2 ships."
name: 'CI: Tests Extension API'
on:
push:
branches: [main, master, dev*, core/*, extension-v2*]
paths:
- 'src/extension-api/**'
- 'src/extension-api-v2/**'
- 'packages/extension-api/**'
- 'vitest.extension-api.config.mts'
- 'research/touch-points/rollup.yaml'
- 'research/touch-points/behavior-categories.yaml'
- 'scripts/check-compat-floor.py'
- 'pnpm-lock.yaml'
pull_request:
branches-ignore: [wip/*, draft/*, temp/*]
paths:
- 'src/extension-api/**'
- 'src/extension-api-v2/**'
- 'packages/extension-api/**'
- 'vitest.extension-api.config.mts'
- 'research/touch-points/rollup.yaml'
- 'research/touch-points/behavior-categories.yaml'
- 'scripts/check-compat-floor.py'
- 'pnpm-lock.yaml'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
name: Extension API tests (vitest)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Setup frontend
uses: ./.github/actions/setup-frontend
- name: Run extension-api test suite
run: pnpm test:extension-api
- name: Run with coverage (push only)
if: github.event_name == 'push'
run: pnpm test:extension-api:coverage
- name: Upload coverage to Codecov
if: github.event_name == 'push'
uses: codecov/codecov-action@1af58845a975a7985b0beb0cbe6fbbb71a41dbad # v5.5.3
with:
files: coverage/lcov.info
flags: extension-api
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: false
compat-floor:
name: Compat-floor gate (blast_radius ≥ 2.0)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: '3.11'
- name: Install PyYAML
run: pip install pyyaml
- name: Check compat floor
run: python3 scripts/check-compat-floor.py
# Exits 1 if any blast_radius ≥ 2.0 behavior category is missing
# any of its three stub files (v1/v2/migration). Enforces PLAN.md §Compat-floor.

View File

@@ -172,7 +172,7 @@ This project uses **pnpm**. Always prefer scripts defined in `package.json` (e.g
16. Whenever a new piece of code is written, the author should ask themselves 'is there a simpler way to introduce the same functionality?'. If the answer is yes, the simpler course should be chosen
17. [Refactoring](https://refactoring.com/catalog/) should be used to make complex code simpler
18. Try to minimize the surface area (exported values) of each module and composable
19. Don't use barrel files, e.g. `/some/package/index.ts` to re-export within `/src`
19. Don't use barrel files, e.g. `/some/package/index.ts` to re-export within `/src`. **Exception**: `src/extension-api/index.ts` is the published npm package entry point (`@comfyorg/extension-api`) and is explicitly exempt from this rule.
20. Keep functions short and functional
21. Minimize [nesting](https://wiki.c2.com/?ArrowAntiPattern), e.g. `if () { ... }` or `for () { ... }`
22. Avoid mutable state, prefer immutability and assignment at point of declaration

View File

@@ -0,0 +1,187 @@
# Names That Must Agree Across Layers
**Task:** DOC1.E6
**Date:** 2026-05-08
**Patterns cross-walked:** S2.N16 (widget array access), S13.SC1 (ComfyNodeDef inspection), S15.OS1 (dynamic output mutation)
This appendix enumerates the terms that span at least two of the four layers — Python backend, v1 frontend (`ComfyExtension`/LiteGraph), v2 extension API (`NodeHandle`/`WidgetHandle`), and ECS World components — and calls out real inconsistencies where the same concept is named differently or the semantics diverge. Future contributors who rename or refactor any of these terms must propagate the change across all layers listed.
---
## Layers
| Layer | Owner | Primary source |
|-------|-------|---------------|
| **Python backend** | ComfyUI server | `NODE_CLASS_MAPPINGS`, `INPUT_TYPES`, `RETURN_TYPES` |
| **v1 frontend** | LiteGraph / ComfyExtension | `src/types/comfy.ts`, `src/schemas/nodeDefSchema.ts`, `LGraphNode.ts` |
| **v2 extension API** | This project | `src/extension-api/node.ts`, `src/extension-api/widget.ts` |
| **ECS World** | Alex's branch (PR #11939) | `src/services/extension-api-service.ts` (stubs), `@/world/entityIds` |
---
## Term 1 — Node class identifier (`class_type` / `type` / `comfyClass`)
**What it is:** The string that identifies which Python class backs a node. Used to look up `object_info`, serialize the prompt, and match `INPUT_TYPES` definitions.
| Layer | Name | Value example | Notes |
|-------|------|--------------|-------|
| Python backend | Python class name | `'KSampler'` | The class registered in `NODE_CLASS_MAPPINGS` |
| Execution prompt JSON (API format) | `class_type` | `"class_type": "KSampler"` | Key in the flat prompt dict |
| UWF backend spec | `class_type` | `"class_type": "KSampler"` | Unchanged from API format (per `uwf-backend-data-model.md`) |
| `ComfyNodeDef` (v1 schema) | `name` | `nodeData.name === 'KSampler'` | The `name` field in the server's `/object_info` response |
| `LGraphNode` (v1) | `node.type` | `node.type === 'KSampler'` | LiteGraph's class string; set at registration |
| v2 `NodeHandle` | `handle.type` | `handle.type === 'KSampler'` | `readonly type: string` in `src/extension-api/node.ts:260` |
| v2 `NodeHandle` | `handle.comfyClass` | `handle.comfyClass === 'KSampler'` | `readonly comfyClass: string` in `src/extension-api/node.ts:269` |
| ECS `NodeTypeData` component | `type` + `comfyClass` | both fields | Stub in `extension-api-service.ts:6163` |
**⚠ Inconsistency — `type` vs `comfyClass`:** v2 `NodeHandle` exposes **both** `type` and `comfyClass` because for most nodes they are equal, but for virtual/reroute nodes `type` is the LiteGraph registration string while `comfyClass` is the actual Python class backing the node. Extensions that compare against ComfyUI node names should always use `comfyClass`. Extensions that filter by LiteGraph registration (for `nodeTypes:` filter in `defineNodeExtension`) should use `type`. The distinction must be preserved — collapsing them back to one field would break reroute/virtual-node detection.
**Rule:** `class_type` (wire format, Python, UWF) = `comfyClass` (v2 API) = `name` in `ComfyNodeDef` = `node.type` in LiteGraph for non-virtual nodes.
---
## Term 2 — Node display name (`display_name` / `title`)
**What it is:** The human-readable label shown in the node header and search results. Distinct from the class identifier.
| Layer | Name | Notes |
|-------|------|-------|
| Python backend | `NODE_DISPLAY_NAME_MAPPINGS[class]` (optional) | If absent, falls back to the class name |
| `ComfyNodeDef` (v1 schema) | `display_name` | `nodeData.display_name` — always a string per zod schema (`src/schemas/nodeDefSchema.ts:279`) |
| `LGraphNode` (v1) | `node.title` | Set during `nodeCreated`; extensions mutate `node.title` directly to rename nodes |
| v2 `NodeHandle` | `handle.title` (getter) + `handle.setTitle(s)` | `src/extension-api/node.ts:304315`; accessor pair per D3.3/D6 hybrid rule |
| ECS `NodeVisualData` component | `title` | Field name consistent with LiteGraph |
**No inconsistency.** `display_name` lives only in the schema/backend layer; `title` is the runtime/frontend term. The two layers don't overlap. Extension authors should use `handle.setTitle()` in v2; `node.title =` is the v1 equivalent. Both are stable.
---
## Term 3 — Widget name (`name` / `input_name` / `widget.name`)
**What it is:** The stable per-node-instance identifier for a widget slot. Used as the key in `widgets_values_named`, `promoted_inputs`, and for `WidgetHandle` lookup.
| Layer | Name | Notes |
|-------|------|-------|
| Python backend `INPUT_TYPES` | Dict key (e.g. `'seed'`, `'steps'`) | The name as declared in the Python class |
| UWF `promoted_inputs` | `input_name` | `{ node_id, input_name, display_name }` — snake_case to match Python origin |
| UWF `spec.nodes.{id}.inputs` | Named key in the inputs object | e.g. `"seed": { "value": 123, "link": null }` |
| v1 `LGraphNode.widgets` | `widget.name` | `widget.name === 'seed'` — used in `node.widgets.find(w => w.name === ...)` (S2.N16 pattern) |
| v1 `node.widgets` iteration | position index (implicit) | `widgets_values` positional array — the root cause of widget shift bugs (S17.WV1) |
| v2 `NodeHandle.widget(name)` | `name` argument | Lookup by name, not position (`src/extension-api/node.ts:383`) |
| v2 `NodeHandle.addWidget(type, name, ...)` | `name` parameter | `src/extension-api/node.ts:396403`; stable key for the widget's lifetime |
| v2 `WidgetHandle.name` | `readonly name: string` | `src/extension-api/widget.ts:277` — "stable within the node's lifetime" |
| ECS `WidgetComponentSchema` | `name` field (inferred) | Widget schema component expected to carry `name` per `widgetComponents` import |
**⚠ Inconsistency — positional array vs. named:** v1 serialization stores widget values as a positional array (`widgets_values: [123, 20, 7.5]`). v2 API and UWF both use `name` as the stable key. The bridge is Austin's PR #10392 (`widgets_values_named`). Until that merges, any code that reads `node.widgets[i]` by index is fragile; code that reads `widget.name` is UWF-safe. The v2 `WidgetHandle` **must** be looked up by name, never by index — this is enforced by the API shape.
**Rule:** Always use the Python-declared input name as the canonical widget identifier. Never use position. `widget.name` (v1) = `name` parameter (v2 addWidget) = `input_name` (UWF wire format).
---
## Term 4 — Widget type string (`type` / `widgetType` / widget constructor key)
**What it is:** The string describing what kind of widget a slot is (e.g. `'INT'`, `'STRING'`, `'COMBO'`, `'IMAGE'`). Controls which widget constructor is used and which validation rules apply.
| Layer | Name | Notes |
|-------|------|-------|
| Python backend | Return value of `INPUT_TYPES()` tuple: first element | e.g. `("INT", {"default": 42})` — the type string |
| `ComfyNodeDef` / `InputSpec` | Type string as zod-inferred from the schema | `INPUT_TYPES['required']['steps'] = ['INT', {...}]` |
| `zBaseInputOptions` | `widgetType` field (optional override) | `src/schemas/nodeDefSchema.ts:33` — overrides the slot type for widget selection; rare |
| v1 `getCustomWidgets` return | Record key | `{ MY_WIDGET: constructor }` — extension-registered type strings |
| v1 `node.addWidget(type, ...)` | `type` first arg | The LiteGraph widget constructor key |
| v2 `NodeHandle.addWidget(type, name, ...)` | `type` first arg | `src/extension-api/node.ts:395, 403` |
| v2 `WidgetHandle.type` | `readonly type: string` | `src/extension-api/widget.ts` line ~280 |
| ECS `WidgetComponentSchema` | `type` field | Expected to match the Python-declared type string |
**⚠ Inconsistency — `widgetType` override:** The `widgetType` field in `zBaseInputOptions` is an override that makes the frontend render a different widget than the Python type implies. Extensions that inspect `nodeData.input.required[name][1].widgetType` to determine rendering (S13.SC1 pattern) must check this field **before** using the slot's primary type. The v2 `ComfyNodeDef`-inspection helper (`ctx.inspectNodeDef`) must resolve this correctly — it cannot just return `InputSpec[0]` (the Python type) as `widgetType`.
**Rule:** Python type string = v1 `widget.type` = v2 `WidgetHandle.type` = `widgetType` override if present (takes precedence).
---
## Term 5 — Slot type string (connection type / `'IMAGE'`, `'LATENT'`, etc.)
**What it is:** The type label on a node's input/output slot that governs which connections are valid. Distinct from widget type (a slot may be a pure connection point with no widget).
| Layer | Name | Notes |
|-------|------|-------|
| Python backend | `RETURN_TYPES` tuple element | e.g. `RETURN_TYPES = ('IMAGE', 'MASK')` |
| Python backend `INPUT_TYPES` | First element of required/optional tuple | `'IMAGE'` means "must receive an IMAGE connection" |
| UWF `spec.nodes.{id}.outputs` | `{ "name": "IMAGE" }` per output | Output type declarations (new in UWF — not in old API format) |
| v1 `LGraphNode` slot | `slot.type` | String on the slot object; extensions read/mutate via S15.OS1 |
| v1 `node.addInput(name, type)` | `type` second arg | e.g. `node.addInput('mask', 'MASK')` |
| v1 `node.addOutput(name, type)` | `type` second arg | S15.OS1 pattern |
| v2 `SlotInfo` | `readonly type: string` | `src/extension-api/node.ts:8283` |
| v2 slot events | `event.slot.type` | Available in `onSlotConnected`, `onSlotDisconnected` |
**⚠ Inconsistency — dynamic mutation (S15.OS1):** v1 allows `slot.type = 'IMAGE'` and `node.outputs[i].type = newType` at runtime. v2 restricts this: output types must be declared in `INPUT_TYPES` / schema; runtime mutation is only via `node.declareOutputs(spec)` (proposed, not yet implemented). This is an intentional breaking change. The UWF spec formalizes this by requiring `spec.nodes.{id}.outputs` to be declared at save time, not derived from runtime state.
**Rule:** Slot type strings are uppercase by convention (matching Python `RETURN_TYPES`). v2 enforces schema-declaration; mutation-at-runtime is deprecated.
---
## Term 6 — Node output name (`output_name` / `RETURN_NAMES`)
**What it is:** Optional human-readable names for a node's output slots. Not the type — the label shown on the output connector.
| Layer | Name | Notes |
|-------|------|-------|
| Python backend | `RETURN_NAMES` class attribute | e.g. `RETURN_NAMES = ('upscaled_image', 'mask')` — optional |
| `ComfyNodeDef` schema | `output_name` | `z.array(z.string()).optional()` in `src/schemas/nodeDefSchema.ts:275` |
| v1 `LGraphNode` | `output.name` | String on the slot object; `node.outputs[i].name` |
| v2 `SlotInfo` | `readonly name: string` | `src/extension-api/node.ts:8081` — same field name |
**No inconsistency.** `RETURN_NAMES``output_name` in the schema → `slot.name` at runtime. All three refer to the same string. Field name shifts from snake_case (`output_name`) in the schema to camelCase-neutral (`name`) on the slot object — consistent with the rest of the frontend.
---
## Term 7 — Extension name (`ComfyExtension.name` / `ExtensionOptions.name`)
**What it is:** The unique identifier for an extension used for hook ordering (D10b), scope registry keys, deprecation telemetry, and conflict detection.
| Layer | Name | Notes |
|-------|------|-------|
| v1 `ComfyExtension` | `name: string` | Required field; `src/types/comfy.ts:108`; typically a dotted namespace like `'Comfy.Sidebar'` |
| v2 `ExtensionOptions` | `name: string` | Required field; `src/extension-api/lifecycle.ts`; same semantic |
| ECS scope registry | `extensionName` | Key component of `NodeInstanceScope`; used in `${extensionName}:${nodeEntityId}` scope key |
| D6 telemetry | `apiVersion` | Separate field added by I-EXT.3 to `ExtensionOptions` for version tracking — not a replacement for `name` |
**No inconsistency.** Same field name and semantics across v1 and v2. The scope registry key format is `${extensionName}:${nodeEntityId}` — both components must be stable.
**Rule:** Extension names should follow the dotted-namespace convention (e.g. `'MyPublisher.MyExtension'`) to avoid collisions. This is currently advisory, not enforced.
---
## Term 8 — Node input display name (`display_name` / widget label)
**What it is:** The label shown next to the widget in the UI. Distinct from the internal `name` (key) used for serialization.
| Layer | Name | Notes |
|-------|------|-------|
| Python backend | `display_name` in input options dict | `INPUT_TYPES()['required']['steps'] = ['INT', {'display_name': 'Steps'}]` |
| `zBaseInputOptions` schema | `display_name: z.string().optional()` | `src/schemas/nodeDefSchema.ts:27` |
| UWF `promoted_inputs` | `display_name` field | `{ node_id, input_name, display_name }` — the UI label for app-mode promoted inputs |
| v1 `widget` | `widget.label` | Optional; falls back to `widget.name` if absent. Inspected in S2.N16 patterns |
| v2 `WidgetHandle` | `label` getter | `src/extension-api/widget.ts:355` — "Defaults to the widget name" |
**No inconsistency** in naming — all layers call it `display_name` (schema/wire) or `label` (runtime). The two forms are consistent: `display_name` is the static schema-declared label; `label` is the runtime-settable display string. v2 exposes `label` as a settable accessor; the Python-declared `display_name` becomes its initial value.
---
## Summary: real inconsistencies to track
| # | Inconsistency | Risk | Resolution |
|---|--------------|------|-----------|
| 1 | `type` vs `comfyClass` on `NodeHandle` — two fields, must not collapse | Medium | Document: use `comfyClass` for Python identity, `type` for LiteGraph registration. Enforced by distinct fields. |
| 2 | Widget identity: positional index (v1 `widgets_values`) vs name key (v2 / UWF) | **HIGH** | Bridge: Austin's PR #10392 (`widgets_values_named`). v2 `WidgetHandle` is name-only. Never look up by position in v2 code. |
| 3 | `widgetType` override in `InputSpec` takes precedence over slot type for rendering | Medium | `ctx.inspectNodeDef` must resolve `widgetType` before returning slot type. Do not skip this field. |
| 4 | Slot type mutation (S15.OS1): `slot.type = X` is valid v1, banned in v2/UWF | Medium | v2 must not expose a `setType()` mutator on `SlotInfo`. Schema-declare outputs; UWF enforces at save time. |
---
## Cross-references
- **S2.N16** — widget array iteration/mutation (`node.widgets[i]`, `node.widgets.find(w => w.name === ...)`): the `name` field is the stable key; position is not. v2 forces name-based lookup.
- **S13.SC1** — `ComfyNodeDef` inspection: callers must resolve `widgetType` override (Term 4) and understand `display_name` vs runtime `label` (Term 8). The `ctx.inspectNodeDef` typed helper (D4 G1 BLOCKER) wraps this correctly.
- **S15.OS1** — dynamic output mutation: slot `type` strings are the agreed layer (Term 5), but v1 allows mutation that v2/UWF forbids. Track in I-PG.B2 as `strangler-bridge` until UWF Phase 3 covers output schema declaration.
- **UWF backend data model** — `class_type`, `input_name`, `display_name` snake_case keys mirror Python origin. v2 API uses camelCase (`comfyClass`, widget `name`, widget `label`) per JS convention. No semantic difference; only case convention changes at the API boundary.

View File

@@ -1,6 +1,6 @@
{
"name": "@comfyorg/comfyui-frontend",
"version": "1.45.1",
"version": "1.45.2",
"private": true,
"description": "Official front-end implementation of ComfyUI",
"homepage": "https://comfy.org",
@@ -47,6 +47,9 @@
"test:browser:coverage": "cross-env COLLECT_COVERAGE=true pnpm test:browser",
"test:browser:local": "cross-env PLAYWRIGHT_LOCAL=1 PLAYWRIGHT_TEST_URL=http://localhost:5173 pnpm test:browser",
"test:coverage": "vitest run --coverage",
"test:extension-api": "vitest run --config vitest.extension-api.config.mts",
"test:extension-api:watch": "vitest --config vitest.extension-api.config.mts",
"test:extension-api:coverage": "vitest run --config vitest.extension-api.config.mts --coverage",
"test:unit": "nx run test",
"typecheck": "vue-tsc --noEmit",
"typecheck:browser": "vue-tsc --project browser_tests/tsconfig.json",

3
packages/extension-api/.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
docs-build/
build/
node_modules/

View File

@@ -0,0 +1,50 @@
# @comfyorg/extension-api
> **Status**: scaffolded. Package implementation pending PKG3 — see
> `../../../plans/P2-extension-api-package.md` and
> `../../../plans/prompts/PKG3-npm-package.md` in the workspace root.
The official TypeScript declaration package for ComfyUI extensions. This
package replaces the practice of vendoring `comfy.d.ts` files in custom
node repos.
## Install (post-publish)
```bash
pnpm add -D @comfyorg/extension-api
```
```ts
import { defineExtension } from '@comfyorg/extension-api'
export default defineExtension({
name: 'MyExtension',
setup(ctx) {
ctx.onNodeMounted((node) => {
// ...
})
}
})
```
## Source
This package is built from the source-of-truth folder
`../../src/extension-api/`. Do not edit the package's `build/` output
directly.
## Versioning
- `0.x.y` — experimental during parallel-paths transition (D6 Phase A).
- `1.0.0` — first stable release once D5/D6/D7/D8 are accepted and the
surface has stabilized.
- Breaking changes follow semver strictly from `1.0.0` onward.
## Cross-references
- `decisions/D6-parallel-paths-migration.md` — versioning rationale
- `plans/P2-extension-api-package.md` — package structure plan
- `plans/prompts/PKG3-npm-package.md` — implementation prompt
- `plans/prompts/PKG4-ci-workflows.md` — publish workflow
- `plans/prompts/PKG5-docgen-mdx.md` — docgen pipeline
- `plans/prompts/PKG6-docs-comfy-org.md` — docs.comfy.org integration

View File

@@ -0,0 +1,28 @@
{
"name": "@comfyorg/extension-api",
"version": "0.1.0",
"description": "Official TypeScript extension API for ComfyUI custom nodes",
"type": "module",
"exports": {
".": "./build/index.js"
},
"types": "./build/index.d.ts",
"scripts": {
"typecheck": "tsc --noEmit",
"build": "tsc --emitDeclarationOnly --outDir build",
"docs:build": "tsx scripts/build-docs.ts",
"docs:watch": "tsx scripts/build-docs.ts --watch"
},
"devDependencies": {
"tsx": "catalog:",
"typedoc": "0.28.19",
"typedoc-plugin-markdown": "^4.6.3",
"typescript": "catalog:"
},
"nx": {
"tags": [
"scope:shared",
"type:api"
]
}
}

View File

@@ -0,0 +1,470 @@
#!/usr/bin/env tsx
/**
* PKG5 docgen pipeline: TypeDoc → Mintlify MDX
*
* Steps:
* 1. Run TypeDoc with typedoc-plugin-markdown to emit raw markdown into docs-build/raw/
* 2. Post-process each markdown file:
* - Add Mintlify frontmatter (title, description, sidebarTitle, icon)
* - Convert ``` fences without lang tag → ```ts
* - Replace raw [TypeName] cross-refs with MDX relative links
* - Wrap @example blocks in proper code fences
* 3. Write final .mdx files to docs-build/mintlify/
* 4. Emit docs-build/mintlify/nav-snippet.json — merges into docs.comfy.org mint.json
*
* Run: pnpm --filter @comfyorg/extension-api docs:build
*/
import { execSync } from 'node:child_process'
import fs from 'node:fs'
import path from 'node:path'
import { fileURLToPath } from 'node:url'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
const pkgRoot = path.resolve(__dirname, '..')
const rawDir = path.join(pkgRoot, 'docs-build', 'raw')
const mintlifyDir = path.join(pkgRoot, 'docs-build', 'mintlify')
const watchMode = process.argv.includes('--watch')
// ── Page metadata ────────────────────────────────────────────────────────────
// Controls frontmatter for each generated page. Key = TypeDoc output filename
// stem (lowercased). Unrecognised files get generic metadata.
interface PageMeta {
title: string
sidebarTitle?: string
description: string
icon?: string
group: 'core' | 'handles' | 'events' | 'shell' | 'identity' | 'root'
order: number
}
const PAGE_META: Record<string, PageMeta> = {
// Top-level overview
index: {
title: 'Extension API Overview',
description: 'TypeScript API reference for ComfyUI custom node extensions.',
icon: 'puzzle-piece',
group: 'root',
order: 0
},
// Lifecycle / registration
defineextension: {
title: 'defineExtension',
description: 'Register an app-scoped extension for init, setup, and shell UI contributions.',
icon: 'code',
group: 'core',
order: 1
},
definenodeextension: {
title: 'defineNodeExtension',
description: 'Register a node-scoped extension reacting to node lifecycle events.',
icon: 'code',
group: 'core',
order: 2
},
definewidgetextension: {
title: 'defineWidgetExtension',
description: 'Register a custom widget type with its own DOM rendering.',
icon: 'code',
group: 'core',
order: 3
},
extensionoptions: {
title: 'ExtensionOptions',
description: 'Options object for defineExtension — app-wide lifecycle and shell UI.',
group: 'core',
order: 4
},
nodeextensionoptions: {
title: 'NodeExtensionOptions',
description: 'Options object for defineNodeExtension — node lifecycle hooks.',
group: 'core',
order: 5
},
widgetextensionoptions: {
title: 'WidgetExtensionOptions',
description: 'Options object for defineWidgetExtension — custom widget rendering.',
group: 'core',
order: 6
},
onnoderemoved: {
title: 'onNodeRemoved',
sidebarTitle: 'onNodeRemoved',
description: 'Implicit-context lifecycle hook: fires when a node is removed from the graph.',
group: 'core',
order: 7
},
onnodemounted: {
title: 'onNodeMounted',
sidebarTitle: 'onNodeMounted',
description: 'Implicit-context lifecycle hook: fires when a node is fully mounted.',
group: 'core',
order: 8
},
// Handles
nodehandle: {
title: 'NodeHandle',
description: 'Controlled access to node state, mutations, slots, and events.',
icon: 'circle-nodes',
group: 'handles',
order: 10
},
widgethandle: {
title: 'WidgetHandle',
description: 'Controlled access to widget state, mutations, and events.',
icon: 'sliders',
group: 'handles',
order: 11
},
slotinfo: {
title: 'SlotInfo',
description: 'Read-only snapshot of a node slot (input or output).',
group: 'handles',
order: 12
},
// Events
nodeexecutedevent: {
title: 'NodeExecutedEvent',
description: 'Payload fired when a node finishes execution.',
group: 'events',
order: 20
},
nodeconnectedevent: {
title: 'NodeConnectedEvent',
description: 'Payload fired when a slot connection is made.',
group: 'events',
order: 21
},
nodedisconnectedevent: {
title: 'NodeDisconnectedEvent',
description: 'Payload fired when a slot connection is removed.',
group: 'events',
order: 22
},
nodepositionchangedevent: {
title: 'NodePositionChangedEvent',
description: 'Payload fired when a node is moved on the canvas.',
group: 'events',
order: 23
},
nodesizechangedevent: {
title: 'NodeSizeChangedEvent',
description: 'Payload fired when a node is resized.',
group: 'events',
order: 24
},
nodemodechangedevent: {
title: 'NodeModeChangedEvent',
description: 'Payload fired when a node execution mode changes.',
group: 'events',
order: 25
},
nodebeforeserializeevent: {
title: 'NodeBeforeSerializeEvent',
description: 'Pre-serialization hook payload — override or skip node data.',
group: 'events',
order: 26
},
widgetvaluechangeevent: {
title: 'WidgetValueChangeEvent',
description: 'Payload fired when a widget value changes.',
group: 'events',
order: 27
},
widgetbeforeserializeevent: {
title: 'WidgetBeforeSerializeEvent',
description: 'Pre-serialization hook payload — override or skip widget value.',
group: 'events',
order: 28
},
widgetbeforequeueevent: {
title: 'WidgetBeforeQueueEvent',
description: 'Pre-queue validation payload — call reject() to cancel queue.',
group: 'events',
order: 29
},
// Shell UI
sidebartabextension: {
title: 'SidebarTabExtension',
description: 'Register a custom sidebar tab.',
group: 'shell',
order: 40
},
bottompanelextension: {
title: 'BottomPanelExtension',
description: 'Register a custom bottom panel tab.',
group: 'shell',
order: 41
},
toastmanager: {
title: 'ToastManager',
description: 'Show toast notifications to the user.',
group: 'shell',
order: 42
},
commandmanager: {
title: 'CommandManager',
description: 'Register keyboard shortcuts and command palette entries.',
group: 'shell',
order: 43
},
extensionmanager: {
title: 'ExtensionManager',
description: 'Access shell UI registration APIs.',
group: 'shell',
order: 44
},
// Identity
nodelocatorid: {
title: 'NodeLocatorId',
description: 'Branded string ID that uniquely locates a node across graph snapshots.',
group: 'identity',
order: 50
},
nodeexecutionid: {
title: 'NodeExecutionId',
description: 'Branded string ID for a specific node execution run.',
group: 'identity',
order: 51
}
}
const GROUP_LABELS: Record<PageMeta['group'], string> = {
root: 'Extensions API',
core: 'Registration',
handles: 'Handles',
events: 'Events',
shell: 'Shell UI',
identity: 'Identity'
}
// ── Utilities ────────────────────────────────────────────────────────────────
function slug(stem: string): string {
return stem.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '')
}
function metaFor(stem: string): PageMeta {
const key = stem.toLowerCase().replace(/[^a-z]/g, '')
return (
PAGE_META[key] ?? {
title: stem,
description: `API reference for ${stem}.`,
group: 'core',
order: 99
}
)
}
/** Convert TypeDoc raw markdown to Mintlify-compatible MDX. */
function toMintlifyMdx(raw: string, stem: string): string {
const meta = metaFor(stem)
// Build frontmatter
const fm: string[] = [
`---`,
`title: "${meta.title}"`,
...(meta.sidebarTitle ? [`sidebarTitle: "${meta.sidebarTitle}"`] : []),
`description: "${meta.description}"`,
...(meta.icon ? [`icon: "${meta.icon}"`] : []),
`---`
]
let body = raw
// Strip TypeDoc breadcrumb header lines (e.g. "[**@comfyorg/...**](../index.md)\n\n***\n\n[@comfyorg...]...")
body = body.replace(/^\[.*?\]\(\.\.\/index\.md\)\n+\*+\n+/gm, '')
body = body.replace(/^\[.*?\]\(\.\.\/index\.md\).*\n+/gm, '')
// Remove the TypeDoc-generated H1 (we use frontmatter title instead)
body = body.replace(/^# .+\n+/, '')
// Ensure opening code fences that have no lang tag get `ts`
// Only match a ``` that is immediately followed by a newline (opening fence),
// not a closing fence (which also has just ``` + newline but we can detect
// by context: opening fences follow non-fence lines; closing fences follow content).
// Simpler heuristic: replace ``` at start of line only when not already closing a block.
// We track state via a flag pass instead of a single regex.
let inBlock = false
body = body
.split('\n')
.map((line) => {
if (inBlock) {
if (line.trim() === '```') { inBlock = false; return line }
return line
}
if (line.startsWith('```')) {
if (line.trim() === '```') {
// bare opening fence → add ts
inBlock = true
return '```ts'
}
// has a lang tag already
inBlock = true
return line
}
return line
})
.join('\n')
// TypeDoc emits `typescript` lang tag; normalize to `ts`
body = body.replace(/^```typescript\b/gm, '```ts')
// Fix TypeDoc cross-ref links: [TypeName](../type-alias/TypeName.md) → relative MDX paths
// Pattern: [Label](../category/FileName.md) → [Label](./filename)
body = body.replace(
/\[([^\]]+)\]\(\.\.\/([\w-]+)\/([\w-]+)\.md\)/g,
(_match, label, _category, file) => `[${label}](./${slug(file)})`
)
// Same-dir links
body = body.replace(
/\[([^\]]+)\]\(([\w-]+)\.md\)/g,
(_match, label, file) => `[${label}](./${slug(file)})`
)
// TypeDoc wraps @example content in a "## Example" heading; Mintlify prefers
// code examples to be directly under prose without a sub-heading.
// Flatten "## Example\n\n```ts" → "```ts"
body = body.replace(/^## Example\s*\n+/gm, '')
// Stability tags: render as a <Tip> callout
body = body.replace(
/\*\*Stability\*\*: `(stable|experimental|deprecated)`/g,
(_match, level) => {
const label =
level === 'stable'
? '<Tip>**Stability:** Stable — part of the public API contract.</Tip>'
: level === 'experimental'
? '<Warning>**Stability:** Experimental — may change before 1.0.</Warning>'
: '<Warning>**Stability:** Deprecated — will be removed. See migration guide.</Warning>'
return label
}
)
// @stability TSDoc tag (appears as plain text after TypeDoc strips tags)
body = body.replace(
/^Stability: (stable|experimental|deprecated)\s*$/gm,
(_match, level) => {
if (level === 'stable') return '<Tip>**Stability:** Stable</Tip>'
if (level === 'experimental') return '<Warning>**Stability:** Experimental</Warning>'
return '<Warning>**Stability:** Deprecated</Warning>'
}
)
return [...fm, '', body.trim(), ''].join('\n')
}
// ── Nav snippet builder ───────────────────────────────────────────────────────
interface NavPage {
group?: string
pages: (string | NavPage)[]
}
function buildNavSnippet(stems: string[]): NavPage {
const byGroup: Record<string, string[]> = {}
for (const stem of stems) {
const meta = metaFor(stem)
const group = meta.group
if (!byGroup[group]) byGroup[group] = []
byGroup[group].push(`extensions/api/${slug(stem)}`)
}
// Sort each group by order
const sortedStems = stems.slice().sort((a, b) => metaFor(a).order - metaFor(b).order)
const sortedByGroup: Record<string, string[]> = {}
for (const stem of sortedStems) {
const group = metaFor(stem).group
if (!sortedByGroup[group]) sortedByGroup[group] = []
sortedByGroup[group].push(`extensions/api/${slug(stem)}`)
}
const groupOrder: PageMeta['group'][] = ['root', 'core', 'handles', 'events', 'shell', 'identity']
const pages: (string | NavPage)[] = []
// Overview at top level
if (sortedByGroup['root']) {
for (const p of sortedByGroup['root']) pages.push(p)
}
for (const grp of groupOrder) {
if (grp === 'root') continue
const grpPages = sortedByGroup[grp]
if (!grpPages?.length) continue
pages.push({ group: GROUP_LABELS[grp], pages: grpPages })
}
return { group: 'Extensions API', pages }
}
// ── Main pipeline ────────────────────────────────────────────────────────────
function runTypedoc(): void {
console.log('▶ Running TypeDoc...')
execSync(
`npx typedoc --options ${path.join(pkgRoot, 'typedoc.json')} --out ${rawDir}`,
{ cwd: pkgRoot, stdio: 'inherit' }
)
}
function processFiles(): void {
if (!fs.existsSync(rawDir)) {
throw new Error(`TypeDoc output directory not found: ${rawDir}`)
}
fs.mkdirSync(mintlifyDir, { recursive: true })
const mdFiles = fs.readdirSync(rawDir, { recursive: true })
.filter((f): f is string => typeof f === 'string' && f.endsWith('.md'))
const stems: string[] = []
for (const relPath of mdFiles) {
const src = path.join(rawDir, relPath)
const stem = path.basename(relPath, '.md')
const raw = fs.readFileSync(src, 'utf8')
const mdx = toMintlifyMdx(raw, stem)
const destName = slug(stem) + '.mdx'
const dest = path.join(mintlifyDir, destName)
fs.writeFileSync(dest, mdx)
console.log(`${relPath} → mintlify/${destName}`)
stems.push(stem)
}
// Write nav snippet
const nav = buildNavSnippet(stems)
const navDest = path.join(mintlifyDir, 'nav-snippet.json')
fs.writeFileSync(navDest, JSON.stringify(nav, null, 2) + '\n')
console.log(` ✔ nav-snippet.json`)
console.log(`\n✅ Mintlify MDX written to: ${mintlifyDir}`)
console.log(` ${stems.length} pages + nav-snippet.json`)
}
function run(): void {
runTypedoc()
processFiles()
}
if (watchMode) {
// Simple watch: re-run on change to source files
console.log('👁 Watch mode — watching src/extension-api/**')
const srcDir = path.resolve(pkgRoot, '../../src/extension-api')
let debounce: ReturnType<typeof setTimeout> | null = null
run()
fs.watch(srcDir, { recursive: true }, () => {
if (debounce) clearTimeout(debounce)
debounce = setTimeout(() => {
console.log('\n🔄 Source changed — rebuilding...')
try { run() } catch (e) { console.error(e) }
}, 500)
})
} else {
run()
}

View File

@@ -0,0 +1,21 @@
{
"compilerOptions": {
"target": "ES2022",
"module": "ESNext",
"moduleResolution": "bundler",
"strict": true,
"skipLibCheck": true,
"noEmit": true,
"paths": {
"@/*": ["../../src/*"]
}
},
"include": [
"../../src/extension-api/**/*.ts"
],
"exclude": [
"../../src/**/*.test.ts",
"../../src/**/*.spec.ts",
"../../src/**/*.vue"
]
}

View File

@@ -0,0 +1,37 @@
{
"entryPoints": ["../../src/extension-api/index.ts"],
"tsconfig": "./tsconfig.docs.json",
"out": "./docs-build/raw",
"plugin": ["typedoc-plugin-markdown"],
"excludeInternal": true,
"excludePrivate": true,
"excludeProtected": true,
"readme": "none",
"skipErrorChecking": true,
"githubPages": false,
"blockTags": ["@stability", "@packageDocumentation", "@example", "@typeParam", "@returns", "@deprecated", "@remarks"],
"hideGenerator": true,
"useCodeBlocks": true,
"flattenOutputFiles": false,
"entryFileName": "index",
"fileExtension": ".md",
"outputFileStrategy": "members",
"hidePageHeader": false,
"hideBreadcrumbs": false,
"useHTMLAnchors": false,
"sanitizeComments": true,
"expandObjects": false,
"parametersFormat": "table",
"propertiesFormat": "table",
"typeDeclarationFormat": "table",
"indexFormat": "table",
"tableColumnSettings": {
"hideDefaults": false,
"hideInherited": false,
"hideModifiers": false,
"hideOverrides": false,
"hideSources": true,
"hideValues": false,
"leftAlignHeaders": false
}
}

View File

@@ -3,12 +3,14 @@ import { describe, expect, it } from 'vitest'
import {
appendWorkflowJsonExt,
ensureWorkflowSuffix,
getFilePathSeparatorVariants,
getFilenameDetails,
getMediaTypeFromFilename,
getPathDetails,
highlightQuery,
isCivitaiModelUrl,
isPreviewableMediaType,
joinFilePath,
truncateFilename
} from './formatUtil'
@@ -299,6 +301,42 @@ describe('formatUtil', () => {
})
})
describe('joinFilePath', () => {
it('joins subfolder and filename with normalized slash separators', () => {
expect(joinFilePath('nested\\folder', 'child\\file.png')).toBe(
'nested/folder/child/file.png'
)
})
it('trims boundary separators without changing the filename body', () => {
expect(joinFilePath('/nested/folder/', '/file.png')).toBe(
'nested/folder/file.png'
)
})
it('returns the normalized filename when no subfolder is provided', () => {
expect(joinFilePath('', 'nested\\file.png')).toBe('nested/file.png')
})
it('returns the normalized subfolder without a trailing slash when no filename is provided', () => {
expect(joinFilePath('nested\\folder', '')).toBe('nested/folder')
expect(joinFilePath('nested\\folder', null)).toBe('nested/folder')
})
})
describe('getFilePathSeparatorVariants', () => {
it('returns slash and backslash variants for nested paths', () => {
expect(getFilePathSeparatorVariants('nested\\folder/file.png')).toEqual([
'nested/folder/file.png',
'nested\\folder\\file.png'
])
})
it('returns a single value when no separator is present', () => {
expect(getFilePathSeparatorVariants('file.png')).toEqual(['file.png'])
})
})
describe('appendWorkflowJsonExt', () => {
it('appends .app.json when isApp is true', () => {
expect(appendWorkflowJsonExt('test', true)).toBe('test.app.json')

View File

@@ -256,6 +256,31 @@ export function isValidUrl(url: string): boolean {
}
}
export function joinFilePath(
subfolder: string | null | undefined,
filename: string | null | undefined
): string {
const normalizedSubfolder = normalizeFilePathSeparators(
subfolder ?? ''
).replace(/^\/+|\/+$/g, '')
const normalizedFilename = normalizeFilePathSeparators(
filename ?? ''
).replace(/^\/+/g, '')
if (!normalizedSubfolder) return normalizedFilename
if (!normalizedFilename) return normalizedSubfolder
return `${normalizedSubfolder}/${normalizedFilename}`
}
export function getFilePathSeparatorVariants(filepath: string): string[] {
const slashPath = normalizeFilePathSeparators(filepath)
const backslashPath = slashPath.replace(/\//g, '\\')
return slashPath === backslashPath ? [slashPath] : [slashPath, backslashPath]
}
function normalizeFilePathSeparators(filepath: string): string {
return filepath.replace(/[\\/]+/g, '/')
}
/**
* Parses a filepath into its filename and subfolder components.
*
@@ -274,8 +299,7 @@ export function parseFilePath(filepath: string): {
} {
if (!filepath?.trim()) return { filename: '', subfolder: '' }
const normalizedPath = filepath
.replace(/[\\/]+/g, '/') // Normalize path separators
const normalizedPath = normalizeFilePathSeparators(filepath)
.replace(/^\//, '') // Remove leading slash
.replace(/\/$/, '') // Remove trailing slash

328
pnpm-lock.yaml generated
View File

@@ -650,7 +650,7 @@ importers:
version: 22.6.1(@babel/traverse@7.29.0)(@zkochan/js-yaml@0.0.7)(eslint@9.39.1(jiti@2.6.1))(nx@22.6.1)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(typescript@5.9.3)
'@nx/vite':
specifier: 'catalog:'
version: 22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vitest@4.0.16)
version: 22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vitest@4.0.16)
'@pinia/testing':
specifier: 'catalog:'
version: 1.0.3(pinia@3.0.4(typescript@5.9.3)(vue@3.5.13(typescript@5.9.3)))
@@ -662,7 +662,7 @@ importers:
version: 4.6.0
'@storybook/addon-docs':
specifier: 'catalog:'
version: 10.2.10(@types/react@19.1.9)(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
version: 10.2.10(@types/react@19.1.9)(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
'@storybook/addon-mcp':
specifier: 'catalog:'
version: 0.1.6(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(typescript@5.9.3)
@@ -671,10 +671,10 @@ importers:
version: 10.2.10(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vue@3.5.13(typescript@5.9.3))
'@storybook/vue3-vite':
specifier: 'catalog:'
version: 10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
version: 10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
'@tailwindcss/vite':
specifier: 'catalog:'
version: 4.2.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
version: 4.2.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
'@testing-library/jest-dom':
specifier: 'catalog:'
version: 6.9.1
@@ -704,7 +704,7 @@ importers:
version: 0.170.0
'@vitejs/plugin-vue':
specifier: 'catalog:'
version: 6.0.3(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
version: 6.0.3(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
'@vitest/coverage-v8':
specifier: 'catalog:'
version: 4.0.16(vitest@4.0.16)
@@ -842,19 +842,19 @@ importers:
version: 11.1.0
vite:
specifier: ^8.0.0
version: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
version: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-dts:
specifier: 'catalog:'
version: 4.5.4(@types/node@24.10.4)(rollup@4.53.5)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
version: 4.5.4(@types/node@24.10.4)(rollup@4.53.5)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vite-plugin-html:
specifier: 'catalog:'
version: 3.2.2(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
version: 3.2.2(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vite-plugin-vue-devtools:
specifier: 'catalog:'
version: 8.0.5(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
version: 8.0.5(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
vitest:
specifier: 'catalog:'
version: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
version: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vue-component-type-helpers:
specifier: 'catalog:'
version: 3.2.6
@@ -912,10 +912,10 @@ importers:
devDependencies:
'@tailwindcss/vite':
specifier: 'catalog:'
version: 4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
version: 4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
'@vitejs/plugin-vue':
specifier: 'catalog:'
version: 6.0.3(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
version: 6.0.3(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
dotenv:
specifier: 'catalog:'
version: 16.6.1
@@ -927,13 +927,13 @@ importers:
version: 30.0.0(@babel/parser@7.29.0)(vue@3.5.13(typescript@5.9.3))
vite:
specifier: ^8.0.0
version: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
version: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-html:
specifier: 'catalog:'
version: 3.2.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
version: 3.2.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vite-plugin-vue-devtools:
specifier: 'catalog:'
version: 8.0.5(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
version: 8.0.5(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
vue-tsc:
specifier: 'catalog:'
version: 3.2.5(typescript@5.9.3)
@@ -982,16 +982,16 @@ importers:
version: 0.9.8(prettier@3.7.4)(typescript@5.9.3)
'@astrojs/vue':
specifier: 'catalog:'
version: 5.1.4(@types/node@25.0.3)(astro@5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.2))(esbuild@0.27.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(vue@3.5.13(typescript@5.9.3))(yaml@2.8.2)
version: 5.1.4(@types/node@25.0.3)(astro@5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.4))(esbuild@0.27.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(vue@3.5.13(typescript@5.9.3))(yaml@2.8.4)
'@playwright/test':
specifier: 'catalog:'
version: 1.58.1
'@tailwindcss/vite':
specifier: 'catalog:'
version: 4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
version: 4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
astro:
specifier: 'catalog:'
version: 5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.2)
version: 5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.4)
tailwindcss:
specifier: 'catalog:'
version: 4.2.0
@@ -1003,7 +1003,7 @@ importers:
version: 5.9.3
vitest:
specifier: 'catalog:'
version: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@25.0.3)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
version: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@25.0.3)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
packages/design-system:
dependencies:
@@ -1030,6 +1030,21 @@ importers:
specifier: 'catalog:'
version: 5.9.3
packages/extension-api:
devDependencies:
tsx:
specifier: 'catalog:'
version: 4.19.4
typedoc:
specifier: 0.28.19
version: 0.28.19(typescript@5.9.3)
typedoc-plugin-markdown:
specifier: ^4.6.3
version: 4.11.0(typedoc@0.28.19(typescript@5.9.3))
typescript:
specifier: 'catalog:'
version: 5.9.3
packages/ingest-types:
dependencies:
zod:
@@ -2431,6 +2446,9 @@ packages:
'@formkit/auto-animate@0.9.0':
resolution: {integrity: sha512-VhP4zEAacXS3dfTpJpJ88QdLqMTcabMg0jwpOSxZ/VzfQVfl3GkZSCZThhGC5uhq/TxPHPzW0dzr4H9Bb1OgKA==}
'@gerrit0/mini-shiki@3.23.0':
resolution: {integrity: sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg==}
'@grpc/grpc-js@1.9.15':
resolution: {integrity: sha512-nqE7Hc0AzI+euzUwDAy0aY5hCp10r734gMGRdU+qOPX0XSceI2ULrcXB5U2xSc5VkWwalCj4M7GzCAygZl2KoQ==}
engines: {node: ^8.13.0 || >=10.10.0}
@@ -5453,6 +5471,10 @@ packages:
resolution: {integrity: sha512-Pdk8c9poy+YhOgVWw1JNN22/HcivgKWwpxKq04M/jTmHyCZn12WPJebZxdjSa5TmBqISrUSgNYU3eRORljfCCw==}
engines: {node: 20 || >=22}
brace-expansion@5.0.6:
resolution: {integrity: sha512-kLpxurY4Z4r9sgMsyG0Z9uzsBlgiU/EFKhj/h91/8yHu0edo7XuixOIH3VcJ8kkxs6/jPzoI6U9Vj3WqbMQ94g==}
engines: {node: 18 || 20 || >=22}
braces@3.0.3:
resolution: {integrity: sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==}
engines: {node: '>=8'}
@@ -7624,6 +7646,9 @@ packages:
resolution: {integrity: sha512-MhWWlVnuab1RG5/zMRRcVGXZLCXrZTgfwMikgzCegsPnG62yDQo5JnqKkrK4jO5iKqDAZGItAqN5CtKBCBWRUA==}
engines: {node: '>=16.14'}
lunr@2.3.9:
resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==}
lz-string@1.5.0:
resolution: {integrity: sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==}
hasBin: true
@@ -7864,6 +7889,10 @@ packages:
resolution: {integrity: sha512-oRjTw/97aTBN0RHbYCdtF1MQfvusSIBQM0IZEgzl6426+8jSC0nF1a/GmnVLpfB9yyr6g6FTqWqiZVbxrtaCIg==}
engines: {node: 18 || 20 || >=22}
minimatch@10.2.5:
resolution: {integrity: sha512-MULkVLfKGYDFYejP07QOurDLLQpcjk7Fw+7jXS2R2czRQzR56yHRveU5NDJEOviH+hETZKSkIk5c+T23GjFUMg==}
engines: {node: 18 || 20 || >=22}
minimatch@3.1.5:
resolution: {integrity: sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==}
@@ -9343,6 +9372,19 @@ packages:
typed-binary@4.3.2:
resolution: {integrity: sha512-HT3pIBM2njCZUmeczDaQUUErGiM6GXFCqMsHegE12HCoBtvHCkfR10JJni0TeGOTnLilTd6YFyj+YhflqQDrDQ==}
typedoc-plugin-markdown@4.11.0:
resolution: {integrity: sha512-2iunh2ALyfyh204OF7h2u0kuQ84xB3jFZtFyUr01nThJkLvR8oGGSSDlyt2gyO4kXhvUxDcVbO0y43+qX+wFbw==}
engines: {node: '>= 18'}
peerDependencies:
typedoc: 0.28.x
typedoc@0.28.19:
resolution: {integrity: sha512-wKh+lhdmMFivMlc6vRRcMGXeGEHGU2g8a2CkPTJjJlwRf1iXbimWIPcFolCqe4E0d/FRtGszpIrsp3WLpDB8Pw==}
engines: {node: '>= 18', pnpm: '>= 10'}
hasBin: true
peerDependencies:
typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x || 6.0.x
typegpu@0.8.2:
resolution: {integrity: sha512-wkMJWhJE0pSkw2G/FesjqjbtHkREyOKu1Zmyj19xfmaX5+65YFwgfQNKSK8CxqN4kJkP7JFelLDJTSYY536TYg==}
engines: {node: '>=12.20.0'}
@@ -10186,6 +10228,11 @@ packages:
engines: {node: '>= 14.6'}
hasBin: true
yaml@2.8.4:
resolution: {integrity: sha512-ml/JPOj9fOQK8RNnWojA67GbZ0ApXAUlN2UQclwv2eVgTgn7O9gg9o7paZWKMp4g0H3nTLtS9LVzhkpOFIKzog==}
engines: {node: '>= 14.6'}
hasBin: true
yargs-parser@21.1.1:
resolution: {integrity: sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==}
engines: {node: '>=12'}
@@ -10467,14 +10514,14 @@ snapshots:
transitivePeerDependencies:
- supports-color
'@astrojs/vue@5.1.4(@types/node@25.0.3)(astro@5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.2))(esbuild@0.27.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(vue@3.5.13(typescript@5.9.3))(yaml@2.8.2)':
'@astrojs/vue@5.1.4(@types/node@25.0.3)(astro@5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.4))(esbuild@0.27.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(vue@3.5.13(typescript@5.9.3))(yaml@2.8.4)':
dependencies:
'@vitejs/plugin-vue': 5.2.4(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
'@vitejs/plugin-vue-jsx': 4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
'@vitejs/plugin-vue': 5.2.4(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
'@vitejs/plugin-vue-jsx': 4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
'@vue/compiler-sfc': 3.5.28
astro: 5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite-plugin-vue-devtools: 7.7.9(rollup@4.53.5)(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
astro: 5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.4)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-vue-devtools: 7.7.9(rollup@4.53.5)(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
vue: 3.5.13(typescript@5.9.3)
transitivePeerDependencies:
- '@nuxt/kit'
@@ -11863,6 +11910,14 @@ snapshots:
'@formkit/auto-animate@0.9.0': {}
'@gerrit0/mini-shiki@3.23.0':
dependencies:
'@shikijs/engine-oniguruma': 3.23.0
'@shikijs/langs': 3.23.0
'@shikijs/themes': 3.23.0
'@shikijs/types': 3.23.0
'@shikijs/vscode-textmate': 10.0.2
'@grpc/grpc-js@1.9.15':
dependencies:
'@grpc/proto-loader': 0.7.13
@@ -12495,11 +12550,11 @@ snapshots:
- typescript
- verdaccio
'@nx/vite@22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vitest@4.0.16)':
'@nx/vite@22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vitest@4.0.16)':
dependencies:
'@nx/devkit': 22.6.1(nx@22.6.1)
'@nx/js': 22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)
'@nx/vitest': 22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vitest@4.0.16)
'@nx/vitest': 22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vitest@4.0.16)
'@phenomnomnominal/tsquery': 6.1.4(typescript@5.9.3)
ajv: 8.18.0
enquirer: 2.3.6
@@ -12507,8 +12562,8 @@ snapshots:
semver: 7.7.4
tsconfig-paths: 4.2.0
tslib: 2.8.1
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vitest: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vitest: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
transitivePeerDependencies:
- '@babel/traverse'
- '@swc-node/register'
@@ -12519,7 +12574,7 @@ snapshots:
- typescript
- verdaccio
'@nx/vitest@22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vitest@4.0.16)':
'@nx/vitest@22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vitest@4.0.16)':
dependencies:
'@nx/devkit': 22.6.1(nx@22.6.1)
'@nx/js': 22.6.1(@babel/traverse@7.29.0)(nx@22.6.1)
@@ -12527,8 +12582,8 @@ snapshots:
semver: 7.7.4
tslib: 2.8.1
optionalDependencies:
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vitest: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vitest: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
transitivePeerDependencies:
- '@babel/traverse'
- '@swc-node/register'
@@ -13317,10 +13372,10 @@ snapshots:
'@standard-schema/spec@1.1.0': {}
'@storybook/addon-docs@10.2.10(@types/react@19.1.9)(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))':
'@storybook/addon-docs@10.2.10(@types/react@19.1.9)(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))':
dependencies:
'@mdx-js/react': 3.1.1(@types/react@19.1.9)(react@19.2.4)
'@storybook/csf-plugin': 10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
'@storybook/csf-plugin': 10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
'@storybook/icons': 2.0.1(react-dom@19.2.4(react@19.2.4))(react@19.2.4)
'@storybook/react-dom-shim': 10.2.10(react-dom@19.2.4(react@19.2.4))(react@19.2.4)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))
react: 19.2.4
@@ -13346,25 +13401,25 @@ snapshots:
- '@tmcp/auth'
- typescript
'@storybook/builder-vite@10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))':
'@storybook/builder-vite@10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))':
dependencies:
'@storybook/csf-plugin': 10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
'@storybook/csf-plugin': 10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
storybook: 10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)
ts-dedent: 2.2.0
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
transitivePeerDependencies:
- esbuild
- rollup
- webpack
'@storybook/csf-plugin@10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))':
'@storybook/csf-plugin@10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))':
dependencies:
storybook: 10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)
unplugin: 2.3.11
optionalDependencies:
esbuild: 0.27.3
rollup: 4.53.5
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
'@storybook/global@5.0.0': {}
@@ -13389,14 +13444,14 @@ snapshots:
react-dom: 19.2.4(react@19.2.4)
storybook: 10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)
'@storybook/vue3-vite@10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))':
'@storybook/vue3-vite@10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))':
dependencies:
'@storybook/builder-vite': 10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
'@storybook/builder-vite': 10.2.10(esbuild@0.27.3)(rollup@4.53.5)(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
'@storybook/vue3': 10.2.10(storybook@10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4))(vue@3.5.13(typescript@5.9.3))
magic-string: 0.30.21
storybook: 10.2.10(@testing-library/dom@10.4.1)(prettier@3.7.4)(react-dom@19.2.4(react@19.2.4))(react@19.2.4)
typescript: 5.9.3
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vue-component-meta: 2.2.12(typescript@5.9.3)
vue-docgen-api: 4.79.2(vue@3.5.13(typescript@5.9.3))
transitivePeerDependencies:
@@ -13478,19 +13533,19 @@ snapshots:
'@tailwindcss/oxide-win32-arm64-msvc': 4.2.0
'@tailwindcss/oxide-win32-x64-msvc': 4.2.0
'@tailwindcss/vite@4.2.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))':
'@tailwindcss/vite@4.2.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))':
dependencies:
'@tailwindcss/node': 4.2.0
'@tailwindcss/oxide': 4.2.0
tailwindcss: 4.2.0
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
'@tailwindcss/vite@4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))':
'@tailwindcss/vite@4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))':
dependencies:
'@tailwindcss/node': 4.2.0
'@tailwindcss/oxide': 4.2.0
tailwindcss: 4.2.0
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
'@tanstack/virtual-core@3.13.12': {}
@@ -14083,32 +14138,32 @@ snapshots:
vue: 3.5.13(typescript@5.9.3)
vue-router: 4.4.3(vue@3.5.13(typescript@5.9.3))
'@vitejs/plugin-vue-jsx@4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))':
'@vitejs/plugin-vue-jsx@4.2.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))':
dependencies:
'@babel/core': 7.29.0
'@babel/plugin-transform-typescript': 7.28.6(@babel/core@7.29.0)
'@rolldown/pluginutils': 1.0.0-rc.9
'@vue/babel-plugin-jsx': 1.4.0(@babel/core@7.29.0)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vue: 3.5.13(typescript@5.9.3)
transitivePeerDependencies:
- supports-color
'@vitejs/plugin-vue@5.2.4(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))':
'@vitejs/plugin-vue@5.2.4(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))':
dependencies:
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vue: 3.5.13(typescript@5.9.3)
'@vitejs/plugin-vue@6.0.3(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))':
'@vitejs/plugin-vue@6.0.3(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))':
dependencies:
'@rolldown/pluginutils': 1.0.0-beta.53
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vue: 3.5.13(typescript@5.9.3)
'@vitejs/plugin-vue@6.0.3(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))':
'@vitejs/plugin-vue@6.0.3(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))':
dependencies:
'@rolldown/pluginutils': 1.0.0-beta.53
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vue: 3.5.13(typescript@5.9.3)
'@vitest/coverage-v8@4.0.16(vitest@4.0.16)':
@@ -14124,7 +14179,7 @@ snapshots:
obug: 2.1.1
std-env: 3.10.0
tinyrainbow: 3.0.3
vitest: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vitest: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
transitivePeerDependencies:
- supports-color
@@ -14145,21 +14200,21 @@ snapshots:
chai: 6.2.2
tinyrainbow: 3.0.3
'@vitest/mocker@4.0.16(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))':
'@vitest/mocker@4.0.16(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))':
dependencies:
'@vitest/spy': 4.0.16
estree-walker: 3.0.3
magic-string: 0.30.21
optionalDependencies:
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
'@vitest/mocker@4.0.16(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))':
'@vitest/mocker@4.0.16(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))':
dependencies:
'@vitest/spy': 4.0.16
estree-walker: 3.0.3
magic-string: 0.30.21
optionalDependencies:
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
'@vitest/pretty-format@3.2.4':
dependencies:
@@ -14195,7 +14250,7 @@ snapshots:
sirv: 3.0.2
tinyglobby: 0.2.15
tinyrainbow: 3.0.3
vitest: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@25.0.3)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vitest: 4.0.16(@opentelemetry/api@1.9.0)(@types/node@25.0.3)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
'@vitest/utils@3.2.4':
dependencies:
@@ -14370,38 +14425,38 @@ snapshots:
dependencies:
'@vue/devtools-kit': 7.7.9
'@vue/devtools-core@7.7.9(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))':
'@vue/devtools-core@7.7.9(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))':
dependencies:
'@vue/devtools-kit': 7.7.9
'@vue/devtools-shared': 7.7.9
mitt: 3.0.1
nanoid: 5.1.5
pathe: 2.0.3
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vue: 3.5.13(typescript@5.9.3)
transitivePeerDependencies:
- vite
'@vue/devtools-core@8.0.5(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))':
'@vue/devtools-core@8.0.5(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))':
dependencies:
'@vue/devtools-kit': 8.0.5
'@vue/devtools-shared': 8.0.5
mitt: 3.0.1
nanoid: 5.1.5
pathe: 2.0.3
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vue: 3.5.13(typescript@5.9.3)
transitivePeerDependencies:
- vite
'@vue/devtools-core@8.0.5(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))':
'@vue/devtools-core@8.0.5(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))':
dependencies:
'@vue/devtools-kit': 8.0.5
'@vue/devtools-shared': 8.0.5
mitt: 3.0.1
nanoid: 5.1.5
pathe: 2.0.3
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vue: 3.5.13(typescript@5.9.3)
transitivePeerDependencies:
- vite
@@ -14809,7 +14864,7 @@ snapshots:
astral-regex@2.0.0: {}
astro@5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.2):
astro@5.18.1(@types/node@25.0.3)(jiti@2.6.1)(rollup@4.53.5)(terser@5.39.2)(tsx@4.19.4)(typescript@5.9.3)(yaml@2.8.4):
dependencies:
'@astrojs/compiler': 2.13.1
'@astrojs/internal-helpers': 0.7.6
@@ -14866,8 +14921,8 @@ snapshots:
unist-util-visit: 5.1.0
unstorage: 1.17.4
vfile: 6.0.3
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vitefu: 1.1.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vitefu: 1.1.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
xxhash-wasm: 1.1.0
yargs-parser: 21.1.1
yocto-spinner: 0.2.3
@@ -15060,6 +15115,10 @@ snapshots:
dependencies:
balanced-match: 4.0.3
brace-expansion@5.0.6:
dependencies:
balanced-match: 4.0.3
braces@3.0.3:
dependencies:
fill-range: 7.1.1
@@ -17463,6 +17522,8 @@ snapshots:
lru-cache@8.0.5: {}
lunr@2.3.9: {}
lz-string@1.5.0: {}
lz-utils@2.1.0: {}
@@ -17898,6 +17959,10 @@ snapshots:
dependencies:
brace-expansion: 5.0.2
minimatch@10.2.5:
dependencies:
brace-expansion: 5.0.6
minimatch@3.1.5:
dependencies:
brace-expansion: 1.1.12
@@ -19827,6 +19892,19 @@ snapshots:
typed-binary@4.3.2: {}
typedoc-plugin-markdown@4.11.0(typedoc@0.28.19(typescript@5.9.3)):
dependencies:
typedoc: 0.28.19(typescript@5.9.3)
typedoc@0.28.19(typescript@5.9.3):
dependencies:
'@gerrit0/mini-shiki': 3.23.0
lunr: 2.3.9
markdown-it: 14.1.1
minimatch: 10.2.5
typescript: 5.9.3
yaml: 2.8.4
typegpu@0.8.2:
dependencies:
tinyest: 0.1.2
@@ -20111,27 +20189,27 @@ snapshots:
'@types/unist': 3.0.3
vfile-message: 4.0.3
vite-dev-rpc@1.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-dev-rpc@1.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
birpc: 2.9.0
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vite-dev-rpc@1.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-dev-rpc@1.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
birpc: 2.9.0
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-hot-client: 2.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vite-hot-client@2.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-hot-client@2.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-hot-client@2.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-hot-client@2.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-dts@4.5.4(@types/node@24.10.4)(rollup@4.53.5)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-plugin-dts@4.5.4(@types/node@24.10.4)(rollup@4.53.5)(typescript@5.9.3)(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
'@microsoft/api-extractor': 7.57.2(@types/node@24.10.4)
'@rollup/pluginutils': 5.3.0(rollup@4.53.5)
@@ -20144,13 +20222,13 @@ snapshots:
magic-string: 0.30.21
typescript: 5.9.3
optionalDependencies:
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
transitivePeerDependencies:
- '@types/node'
- rollup
- supports-color
vite-plugin-html@3.2.2(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-plugin-html@3.2.2(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
'@rollup/pluginutils': 4.2.1
colorette: 2.0.20
@@ -20164,9 +20242,9 @@ snapshots:
html-minifier-terser: 6.1.0
node-html-parser: 5.4.2
pathe: 0.2.0
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-html@3.2.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-plugin-html@3.2.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
'@rollup/pluginutils': 4.2.1
colorette: 2.0.20
@@ -20180,9 +20258,9 @@ snapshots:
html-minifier-terser: 6.1.0
node-html-parser: 5.4.2
pathe: 0.2.0
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-inspect@0.8.9(rollup@4.53.5)(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-plugin-inspect@0.8.9(rollup@4.53.5)(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
'@antfu/utils': 0.7.10
'@rollup/pluginutils': 5.3.0(rollup@4.53.5)
@@ -20193,12 +20271,12 @@ snapshots:
perfect-debounce: 1.0.0
picocolors: 1.1.1
sirv: 3.0.2
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
transitivePeerDependencies:
- rollup
- supports-color
vite-plugin-inspect@11.3.3(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-plugin-inspect@11.3.3(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
ansis: 4.2.0
debug: 4.4.3
@@ -20208,12 +20286,12 @@ snapshots:
perfect-debounce: 2.0.0
sirv: 3.0.2
unplugin-utils: 0.3.1
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite-dev-rpc: 1.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-dev-rpc: 1.1.0(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
transitivePeerDependencies:
- supports-color
vite-plugin-inspect@11.3.3(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-plugin-inspect@11.3.3(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
ansis: 4.2.0
debug: 4.4.3
@@ -20223,56 +20301,56 @@ snapshots:
perfect-debounce: 2.0.0
sirv: 3.0.2
unplugin-utils: 0.3.1
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite-dev-rpc: 1.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-dev-rpc: 1.1.0(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
transitivePeerDependencies:
- supports-color
vite-plugin-vue-devtools@7.7.9(rollup@4.53.5)(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3)):
vite-plugin-vue-devtools@7.7.9(rollup@4.53.5)(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3)):
dependencies:
'@vue/devtools-core': 7.7.9(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
'@vue/devtools-core': 7.7.9(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
'@vue/devtools-kit': 7.7.9
'@vue/devtools-shared': 7.7.9
execa: 9.6.1
sirv: 3.0.2
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite-plugin-inspect: 0.8.9(rollup@4.53.5)(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite-plugin-vue-inspector: 5.3.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-inspect: 0.8.9(rollup@4.53.5)(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vite-plugin-vue-inspector: 5.3.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
transitivePeerDependencies:
- '@nuxt/kit'
- rollup
- supports-color
- vue
vite-plugin-vue-devtools@8.0.5(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3)):
vite-plugin-vue-devtools@8.0.5(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3)):
dependencies:
'@vue/devtools-core': 8.0.5(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
'@vue/devtools-core': 8.0.5(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
'@vue/devtools-kit': 8.0.5
'@vue/devtools-shared': 8.0.5
sirv: 3.0.2
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite-plugin-inspect: 11.3.3(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite-plugin-vue-inspector: 5.3.2(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-inspect: 11.3.3(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vite-plugin-vue-inspector: 5.3.2(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
transitivePeerDependencies:
- '@nuxt/kit'
- supports-color
- vue
vite-plugin-vue-devtools@8.0.5(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3)):
vite-plugin-vue-devtools@8.0.5(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3)):
dependencies:
'@vue/devtools-core': 8.0.5(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))(vue@3.5.13(typescript@5.9.3))
'@vue/devtools-core': 8.0.5(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))(vue@3.5.13(typescript@5.9.3))
'@vue/devtools-kit': 8.0.5
'@vue/devtools-shared': 8.0.5
sirv: 3.0.2
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite-plugin-inspect: 11.3.3(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite-plugin-vue-inspector: 5.3.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vite-plugin-inspect: 11.3.3(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
vite-plugin-vue-inspector: 5.3.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
transitivePeerDependencies:
- '@nuxt/kit'
- supports-color
- vue
vite-plugin-vue-inspector@5.3.2(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-plugin-vue-inspector@5.3.2(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
'@babel/core': 7.29.0
'@babel/plugin-proposal-decorators': 7.29.0(@babel/core@7.29.0)
@@ -20283,11 +20361,11 @@ snapshots:
'@vue/compiler-dom': 3.5.28
kolorist: 1.8.0
magic-string: 0.30.21
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
transitivePeerDependencies:
- supports-color
vite-plugin-vue-inspector@5.3.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vite-plugin-vue-inspector@5.3.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
dependencies:
'@babel/core': 7.29.0
'@babel/plugin-proposal-decorators': 7.29.0(@babel/core@7.29.0)
@@ -20298,11 +20376,11 @@ snapshots:
'@vue/compiler-dom': 3.5.28
kolorist: 1.8.0
magic-string: 0.30.21
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
transitivePeerDependencies:
- supports-color
vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2):
vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4):
dependencies:
'@oxc-project/runtime': 0.115.0
lightningcss: 1.32.0
@@ -20317,9 +20395,9 @@ snapshots:
jiti: 2.6.1
terser: 5.39.2
tsx: 4.19.4
yaml: 2.8.2
yaml: 2.8.4
vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2):
vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4):
dependencies:
'@oxc-project/runtime': 0.115.0
lightningcss: 1.32.0
@@ -20334,16 +20412,16 @@ snapshots:
jiti: 2.6.1
terser: 5.39.2
tsx: 4.19.4
yaml: 2.8.2
yaml: 2.8.4
vitefu@1.1.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)):
vitefu@1.1.2(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)):
optionalDependencies:
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
vitest@4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2):
vitest@4.0.16(@opentelemetry/api@1.9.0)(@types/node@24.10.4)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4):
dependencies:
'@vitest/expect': 4.0.16
'@vitest/mocker': 4.0.16(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
'@vitest/mocker': 4.0.16(vite@8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
'@vitest/pretty-format': 4.0.16
'@vitest/runner': 4.0.16
'@vitest/snapshot': 4.0.16
@@ -20360,7 +20438,7 @@ snapshots:
tinyexec: 1.0.4
tinyglobby: 0.2.15
tinyrainbow: 3.0.3
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@24.10.4)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
why-is-node-running: 2.3.0
optionalDependencies:
'@opentelemetry/api': 1.9.0
@@ -20382,10 +20460,10 @@ snapshots:
- tsx
- yaml
vitest@4.0.16(@opentelemetry/api@1.9.0)(@types/node@25.0.3)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2):
vitest@4.0.16(@opentelemetry/api@1.9.0)(@types/node@25.0.3)(@vitest/ui@4.0.16)(esbuild@0.27.3)(happy-dom@20.0.11)(jiti@2.6.1)(jsdom@27.4.0)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4):
dependencies:
'@vitest/expect': 4.0.16
'@vitest/mocker': 4.0.16(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2))
'@vitest/mocker': 4.0.16(vite@8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4))
'@vitest/pretty-format': 4.0.16
'@vitest/runner': 4.0.16
'@vitest/snapshot': 4.0.16
@@ -20402,7 +20480,7 @@ snapshots:
tinyexec: 1.0.4
tinyglobby: 0.2.15
tinyrainbow: 3.0.3
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.2)
vite: 8.0.0(@types/node@25.0.3)(esbuild@0.27.3)(jiti@2.6.1)(terser@5.39.2)(tsx@4.19.4)(yaml@2.8.4)
why-is-node-running: 2.3.0
optionalDependencies:
'@opentelemetry/api': 1.9.0
@@ -20834,6 +20912,8 @@ snapshots:
yaml@2.8.2: {}
yaml@2.8.4: {}
yargs-parser@21.1.1: {}
yargs@17.7.2:

View File

@@ -543,7 +543,7 @@ describe('realtime scan verifies pending cloud candidates', () => {
}
])
const verifySpy = vi
.spyOn(missingMediaScan, 'verifyCloudMediaCandidates')
.spyOn(missingMediaScan, 'verifyMediaCandidates')
.mockImplementation(async (candidates) => {
for (const c of candidates) c.isMissing = true
})
@@ -686,7 +686,7 @@ describe('realtime verification staleness guards', () => {
let resolveVerify: (() => void) | undefined
const verifyPromise = new Promise<void>((r) => (resolveVerify = r))
const verifySpy = vi
.spyOn(missingMediaScan, 'verifyCloudMediaCandidates')
.spyOn(missingMediaScan, 'verifyMediaCandidates')
.mockImplementation(async (candidates) => {
await verifyPromise
for (const c of candidates) c.isMissing = true

View File

@@ -28,7 +28,7 @@ import {
import { useMissingModelStore } from '@/platform/missingModel/missingModelStore'
import {
scanNodeMediaCandidates,
verifyCloudMediaCandidates
verifyMediaCandidates
} from '@/platform/missingMedia/missingMediaScan'
import { useMissingMediaStore } from '@/platform/missingMedia/missingMediaStore'
import { useMissingNodesErrorStore } from '@/platform/nodeReplacement/missingNodesErrorStore'
@@ -209,8 +209,8 @@ function scanSingleNodeErrors(node: LGraphNode): void {
if (confirmedMedia.length) {
useMissingMediaStore().addMissingMedia(confirmedMedia)
}
// Cloud media scans always return isMissing: undefined pending
// verification against the input-assets list.
// Cloud media scans return pending for asset verification. OSS scans only
// return pending for generated output/temp media.
const pendingMedia = mediaCandidates.filter((c) => c.isMissing === undefined)
if (pendingMedia.length) {
void verifyAndAddPendingMedia(pendingMedia)
@@ -282,7 +282,7 @@ async function verifyAndAddPendingMedia(
): Promise<void> {
const rootGraphAtScan = app.rootGraph
try {
await verifyCloudMediaCandidates(pending)
await verifyMediaCandidates(pending, { isCloud })
if (app.rootGraph !== rootGraphAtScan) return
const verified = pending.filter(
(c) => c.isMissing === true && isCandidateStillActive(c.nodeId)

View File

@@ -0,0 +1,189 @@
// Category: BC.01 — Node lifecycle: creation
// DB cross-ref: S2.N1, S2.N8
// compat-floor: blast_radius 4.48 ≥ 2.0 — MUST pass before v2 ships
// Migration: v1 nodeCreated(node) + beforeRegisterNodeDef → v2 defineNodeExtension({ nodeCreated(handle) })
//
// Phase A strategy: test behavioral equivalence between v1 and v2 patterns
// using local stubs. Real ECS dispatch (Phase B) is marked it.todo.
import { describe, expect, it } from 'vitest'
import type { NodeExtensionOptions } from '@/extension-api/lifecycle'
import type { NodeHandle } from '@/extension-api/node'
import type { NodeEntityId } from '@/world/entityIds'
// ── V1 app shim ───────────────────────────────────────────────────────────────
// Minimal stand-in for v1 app.registerExtension behavior.
interface V1NodeLike { id: number; type: string }
interface V1Extension {
name: string
nodeCreated?: (node: V1NodeLike) => void
}
function createV1App() {
const extensions: V1Extension[] = []
const callLog: V1NodeLike[] = []
return {
registerExtension(ext: V1Extension) { extensions.push(ext) },
simulateNodeCreated(node: V1NodeLike) {
callLog.push(node)
for (const ext of extensions) ext.nodeCreated?.(node)
},
get totalCreated() { return callLog.length }
}
}
// ── V2 stub runtime ───────────────────────────────────────────────────────────
// Mirrors the real service contract without the ECS dependency.
interface NodeRecord { entityId: NodeEntityId; comfyClass: string }
function createV2Runtime() {
const extensions: NodeExtensionOptions[] = []
const nodes = new Map<NodeEntityId, NodeRecord>()
let nextId = 1
function makeId(): NodeEntityId {
return `node:mig-test:${nextId++}` as NodeEntityId
}
function createHandle(r: NodeRecord): NodeHandle {
return {
entityId: r.entityId,
get type() { return r.comfyClass },
get comfyClass() { return r.comfyClass },
getPosition: () => [0, 0],
getSize: () => [0, 0],
getTitle: () => r.comfyClass,
setTitle: () => {},
getMode: () => 0,
setMode: () => {},
getProperty: () => undefined,
getProperties: () => ({}),
setProperty: () => {},
widget: () => undefined,
widgets: () => [],
addWidget: () => { throw new Error('not implemented') },
inputs: () => [],
outputs: () => [],
on: () => () => {},
} as unknown as NodeHandle
}
function register(options: NodeExtensionOptions) { extensions.push(options) }
function mountNode(comfyClass: string, isLoaded = false): NodeEntityId {
const id = makeId()
nodes.set(id, { entityId: id, comfyClass })
const sorted = [...extensions].sort((a, b) => a.name.localeCompare(b.name))
for (const ext of sorted) {
if (ext.nodeTypes && !ext.nodeTypes.includes(comfyClass)) continue
const hook = isLoaded ? ext.loadedGraphNode : ext.nodeCreated
hook?.(createHandle({ entityId: id, comfyClass }))
}
return id
}
function clear() { extensions.length = 0; nodes.clear(); nextId = 1 }
return { register, mountNode, clear }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.01 migration — node lifecycle: creation', () => {
describe('nodeCreated call-count parity (S2.N1)', () => {
it('v1 and v2 nodeCreated are both called once per node created', () => {
const v1 = createV1App()
const v2 = createV2Runtime()
let v2Count = 0
v1.registerExtension({ name: 'parity', nodeCreated() {} })
v2.register({ name: 'bc01.mig.parity', nodeCreated() { v2Count++ } })
const types = ['KSampler', 'KSampler', 'CLIPTextEncode']
types.forEach((t, i) => v1.simulateNodeCreated({ id: i, type: t }))
types.forEach((t) => v2.mountNode(t))
expect(v2Count).toBe(v1.totalCreated)
expect(v2Count).toBe(3)
})
it('v2 nodeCreated fires in lexicographic name order (D10b tie-break)', () => {
const v2 = createV2Runtime()
const order: string[] = []
v2.register({ name: 'bc01.mig.z-ext', nodeCreated() { order.push('z-ext') } })
v2.register({ name: 'bc01.mig.a-ext', nodeCreated() { order.push('a-ext') } })
v2.register({ name: 'bc01.mig.m-ext', nodeCreated() { order.push('m-ext') } })
v2.mountNode('TestNode')
expect(order).toEqual(['a-ext', 'm-ext', 'z-ext'])
})
})
describe('beforeRegisterNodeDef type-guard → nodeTypes filter (S2.N8)', () => {
it('v2 nodeTypes filter produces identical per-type call counts as v1 type-guard pattern', () => {
const v1 = createV1App()
const v2 = createV2Runtime()
const v1Received: string[] = []
const v2Received: string[] = []
// v1: explicit type-guard inside callback
v1.registerExtension({
name: 'type-guard',
nodeCreated(node) {
if (node.type === 'KSampler') v1Received.push(node.type)
}
})
// v2: declarative filter
v2.register({
name: 'bc01.mig.type-filter',
nodeTypes: ['KSampler'],
nodeCreated(h) { v2Received.push(h.type) }
})
const types = ['KSampler', 'CLIPTextEncode', 'KSampler']
types.forEach((t, i) => v1.simulateNodeCreated({ id: i, type: t }))
types.forEach((t) => v2.mountNode(t))
expect(v2Received).toEqual(v1Received)
expect(v2Received).toEqual(['KSampler', 'KSampler'])
})
it('excluded types receive no v2 nodeCreated call, matching v1 type-guard exclusion', () => {
const v2 = createV2Runtime()
const received: string[] = []
v2.register({ name: 'bc01.mig.exclude', nodeTypes: ['KSampler'], nodeCreated(h) { received.push(h.type) } })
v2.mountNode('Note')
expect(received).toHaveLength(0)
})
})
describe('D12 reset-to-fresh on copy/paste', () => {
it('copy/paste (new entityId) triggers fresh nodeCreated, not a clone of source state', () => {
const v2 = createV2Runtime()
let setupCount = 0
v2.register({ name: 'bc01.mig.fresh-copy', nodeCreated() { setupCount++ } })
v2.mountNode('TestNode') // source
expect(setupCount).toBe(1)
v2.mountNode('TestNode') // paste → new entityId → fresh setup
expect(setupCount).toBe(2)
})
})
describe('VueNode mount timing invariant', () => {
it.todo(
// Phase B: requires two-phase harness simulation (BC.37).
'both v1 and v2 nodeCreated fire before VueNode mounts — runtime proof deferred to Phase B'
)
})
})

View File

@@ -0,0 +1,140 @@
// Category: BC.01 — Node lifecycle: creation
// DB cross-ref: S2.N1, S2.N8
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/saveImageExtraOutput.ts#L31
// Surface: S2.N1 = nodeCreated hook, S2.N8 = beforeRegisterNodeDef
// compat-floor: blast_radius 4.48 ≥ 2.0 — MUST pass before v2 ships
// v1 contract: app.registerExtension({ nodeCreated(node) { ... } })
// Note: nodeCreated fires BEFORE the VueNode Vue component mounts; extensions needing
// VueNode-backed state must defer (see BC.37).
import { describe, expect, it, vi } from 'vitest'
import {
createMiniComfyApp,
countEvidenceExcerpts,
loadEvidenceSnippet,
runV1
} from '../harness'
describe('BC.01 v1 contract — node lifecycle: creation', () => {
describe('S2.N1 — evidence excerpts', () => {
it('S2.N1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N1')).toBeGreaterThan(0)
})
it('S2.N1 evidence snippet contains nodeCreated fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N1', 0)
expect(snippet).toMatch(/nodeCreated/i)
})
it('S2.N1 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N1', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N8 — evidence excerpts', () => {
it('S2.N8 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N8')).toBeGreaterThan(0)
})
it('S2.N8 evidence snippet contains prototype-patching fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N8', 0)
expect(snippet).toMatch(/nodeType\.prototype/i)
})
it('S2.N8 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N8', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N1 — nodeCreated hook (synthetic)', () => {
it('nodeCreated callback receives node as first arg', () => {
const received: unknown[] = []
const extension = { nodeCreated: vi.fn((node: unknown) => received.push(node)) }
const fakeNode = { id: 1, type: 'KSampler' }
extension.nodeCreated(fakeNode)
expect(extension.nodeCreated).toHaveBeenCalledOnce()
expect(received[0]).toBe(fakeNode)
})
it('properties set on node inside nodeCreated are accessible after the call', () => {
const fakeNode: Record<string, unknown> = { id: 2, type: 'CLIPTextEncode' }
const extension = {
nodeCreated(node: Record<string, unknown>) {
node.customTag = 'injected-by-extension'
}
}
extension.nodeCreated(fakeNode)
expect(fakeNode.customTag).toBe('injected-by-extension')
})
it('nodeCreated fires for each registered extension (2 extensions = 2 calls)', () => {
const fakeNode = { id: 3, type: 'VAEDecode' }
const callOrder: string[] = []
const extA = { nodeCreated: vi.fn(() => callOrder.push('A')) }
const extB = { nodeCreated: vi.fn(() => callOrder.push('B')) }
// Simulate the app dispatching nodeCreated to all registered extensions
for (const ext of [extA, extB]) {
ext.nodeCreated(fakeNode)
}
expect(extA.nodeCreated).toHaveBeenCalledOnce()
expect(extB.nodeCreated).toHaveBeenCalledOnce()
expect(callOrder).toEqual(['A', 'B'])
})
it.todo(
'fires before node is added to graph'
)
it.todo(
'fires before VueNode mounts'
)
})
describe('S2.N8 — beforeRegisterNodeDef hook (synthetic)', () => {
it('beforeRegisterNodeDef patches the prototype; all instances after the patch have the method', () => {
function FakeNodeType(this: Record<string, unknown>) {
this.id = Math.random()
}
FakeNodeType.prototype = {}
FakeNodeType.type = 'KSampler'
// Extension patches the prototype inside beforeRegisterNodeDef
function beforeRegisterNodeDef(nodeType: { prototype: Record<string, unknown> }) {
nodeType.prototype.myExtensionMethod = function () {
return 'patched'
}
}
beforeRegisterNodeDef(FakeNodeType)
const instanceA = Object.create(FakeNodeType.prototype) as Record<string, unknown>
const instanceB = Object.create(FakeNodeType.prototype) as Record<string, unknown>
expect(typeof instanceA.myExtensionMethod).toBe('function')
expect(typeof instanceB.myExtensionMethod).toBe('function')
expect((instanceA.myExtensionMethod as () => string)()).toBe('patched')
})
it('beforeRegisterNodeDef callback receives nodeType name as first argument', () => {
const receivedNames: string[] = []
function beforeRegisterNodeDef(nodeType: { type: string }) {
receivedNames.push(nodeType.type)
}
const fakeNodeType = { type: 'KSampler', prototype: {} }
beforeRegisterNodeDef(fakeNodeType)
expect(receivedNames).toContain('KSampler')
})
})
})

View File

@@ -0,0 +1,255 @@
// Category: BC.01 — Node lifecycle: creation
// DB cross-ref: S2.N1, S2.N8
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/saveImageExtraOutput.ts#L31
// compat-floor: blast_radius 4.48 ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: defineNodeExtension({ nodeCreated(handle) { ... } })
// Note: v2 nodeCreated receives a NodeHandle, not a raw LGraphNode. VueNode mount
// timing guarantee is unchanged — defer to onNodeMounted for Vue-backed state.
//
// Phase A strategy: test the API *shape* and *contract* using a local stub that
// mirrors the real service. The real mountExtensionsForNode depends on @/world/* (ECS)
// which lands in Phase B. Phase B tests are marked it.todo(Phase B).
import { describe, expect, it } from 'vitest'
import type { NodeExtensionOptions } from '@/extension-api/lifecycle'
import type { NodeHandle } from '@/extension-api/node'
import type { NodeEntityId } from '@/world/entityIds'
// ── Local stub: minimal defineNodeExtension + mount machinery ─────────────────
// Mirrors the real service contract without the ECS world dependency.
// When Phase B lands, these tests are replaced/supplemented by ones that import
// the real mountExtensionsForNode with the mocked world (see scope-registry.test.ts).
interface NodeRecord {
entityId: NodeEntityId
comfyClass: string
}
function createTestRuntime() {
const extensions: NodeExtensionOptions[] = []
const nodes = new Map<NodeEntityId, NodeRecord>()
let nextId = 1
function makeNodeId(): NodeEntityId {
return `node:graph-test:${nextId++}` as NodeEntityId
}
function addNode(comfyClass: string): NodeEntityId {
const id = makeNodeId()
nodes.set(id, { entityId: id, comfyClass })
return id
}
function createHandle(record: NodeRecord): NodeHandle {
// Minimal NodeHandle stub with just the fields BC.01 tests need.
return {
entityId: record.entityId,
get type() { return record.comfyClass },
get comfyClass() { return record.comfyClass },
// Remaining NodeHandle fields not needed for BC.01 — stub as no-ops.
getPosition: () => [0, 0],
getSize: () => [0, 0],
getTitle: () => record.comfyClass,
setTitle: () => {},
getMode: () => 0,
setMode: () => {},
getProperty: () => undefined,
getProperties: () => ({}),
setProperty: () => {},
widget: () => undefined,
widgets: () => [],
addWidget: () => { throw new Error('not implemented in stub') },
inputs: () => [],
outputs: () => [],
on: () => () => {},
} as unknown as NodeHandle
}
function register(options: NodeExtensionOptions) {
extensions.push(options)
}
function mountNode(id: NodeEntityId, isLoaded = false): void {
const record = nodes.get(id)
if (!record) return
const sorted = [...extensions].sort((a, b) => a.name.localeCompare(b.name))
for (const ext of sorted) {
if (ext.nodeTypes && !ext.nodeTypes.includes(record.comfyClass)) continue
const hook = isLoaded ? ext.loadedGraphNode : ext.nodeCreated
if (!hook) continue
hook(createHandle(record))
}
}
function clear() {
extensions.length = 0
nodes.clear()
nextId = 1
}
return { register, addNode, mountNode, clear }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.01 v2 contract — node lifecycle: creation', () => {
describe('NodeExtensionOptions shape — defineNodeExtension API', () => {
it('NodeExtensionOptions accepts a nodeCreated callback with NodeHandle parameter', () => {
// Type-level proof: this compiles = the contract is correctly shaped.
const options: NodeExtensionOptions = {
name: 'bc01.shape',
nodeCreated(_node: NodeHandle) {
// callback receives NodeHandle
}
}
expect(options.name).toBe('bc01.shape')
expect(typeof options.nodeCreated).toBe('function')
})
it('NodeExtensionOptions accepts nodeTypes filter array', () => {
const options: NodeExtensionOptions = {
name: 'bc01.types',
nodeTypes: ['KSampler', 'KSamplerAdvanced'],
nodeCreated(_node) {}
}
expect(options.nodeTypes).toEqual(['KSampler', 'KSamplerAdvanced'])
})
it('nodeTypes is optional — omitting it means global registration', () => {
const options: NodeExtensionOptions = {
name: 'bc01.global',
nodeCreated(_node) {}
}
expect(options.nodeTypes).toBeUndefined()
})
})
describe('nodeCreated(handle) — per-instance setup', () => {
it('nodeCreated is called once per node instance', () => {
const rt = createTestRuntime()
const calls: NodeHandle[] = []
rt.register({ name: 'bc01.creation-once', nodeCreated(h) { calls.push(h) } })
const id = rt.addNode('TestNode')
rt.mountNode(id)
expect(calls).toHaveLength(1)
})
it('NodeHandle.entityId matches the node being created', () => {
const rt = createTestRuntime()
let capturedId: NodeEntityId | undefined
rt.register({ name: 'bc01.entity-id', nodeCreated(h) { capturedId = h.entityId as NodeEntityId } })
const id = rt.addNode('TestNode')
rt.mountNode(id)
expect(capturedId).toBe(id)
})
it('NodeHandle.type returns the comfyClass of the node', () => {
const rt = createTestRuntime()
let capturedType: string | undefined
rt.register({ name: 'bc01.type-read', nodeCreated(h) { capturedType = h.type } })
const id = rt.addNode('KSampler')
rt.mountNode(id)
expect(capturedType).toBe('KSampler')
})
it('nodeCreated fires separately for each node instance — independent calls', () => {
const rt = createTestRuntime()
let callCount = 0
rt.register({ name: 'bc01.multi-instance', nodeCreated() { callCount++ } })
rt.mountNode(rt.addNode('TestNode'))
rt.mountNode(rt.addNode('TestNode'))
expect(callCount).toBe(2)
})
})
describe('type-level registration — nodeTypes filter (replacement for S2.N8)', () => {
it('nodeTypes filter: nodeCreated fires only for matching comfyClass', () => {
const rt = createTestRuntime()
const received: string[] = []
rt.register({
name: 'bc01.type-scoped',
nodeTypes: ['KSampler'],
nodeCreated(h) { received.push(h.type) }
})
rt.mountNode(rt.addNode('KSampler'))
rt.mountNode(rt.addNode('CLIPTextEncode'))
expect(received).toEqual(['KSampler'])
})
it('omitting nodeTypes fires nodeCreated for every node type', () => {
const rt = createTestRuntime()
const received: string[] = []
rt.register({ name: 'bc01.global', nodeCreated(h) { received.push(h.type) } })
rt.mountNode(rt.addNode('KSampler'))
rt.mountNode(rt.addNode('CLIPTextEncode'))
expect(received).toEqual(['KSampler', 'CLIPTextEncode'])
})
it('type-scoped registration does not fire for unregistered node types', () => {
const rt = createTestRuntime()
let fired = false
rt.register({
name: 'bc01.no-fire',
nodeTypes: ['KSampler'],
nodeCreated() { fired = true }
})
rt.mountNode(rt.addNode('Note'))
expect(fired).toBe(false)
})
})
describe('extension firing order — D10b lexicographic', () => {
it('multiple extensions fire in lexicographic order by name for the same node', () => {
const rt = createTestRuntime()
const order: string[] = []
rt.register({ name: 'bc01.z-ext', nodeCreated() { order.push('z-ext') } })
rt.register({ name: 'bc01.a-ext', nodeCreated() { order.push('a-ext') } })
rt.register({ name: 'bc01.m-ext', nodeCreated() { order.push('m-ext') } })
rt.mountNode(rt.addNode('TestNode'))
expect(order).toEqual(['a-ext', 'm-ext', 'z-ext'])
})
})
describe('D12 reset-to-fresh on copy/paste', () => {
it('each mountNode call (new entityId) runs fresh nodeCreated — no shared state', () => {
const rt = createTestRuntime()
let setupCount = 0
rt.register({ name: 'bc01.fresh-copy', nodeCreated() { setupCount++ } })
rt.mountNode(rt.addNode('TestNode')) // source
expect(setupCount).toBe(1)
rt.mountNode(rt.addNode('TestNode')) // paste → new entityId → new setup
expect(setupCount).toBe(2)
})
})
describe('VueNode mount timing invariant', () => {
it.todo(
// Phase B: requires VueNode mount simulation (BC.37 two-phase harness).
'nodeCreated fires before VueNode mounts; onNodeMounted deferred to Vue mount phase (Phase B)'
)
})
})

View File

@@ -0,0 +1,273 @@
// Category: BC.02 — Node lifecycle: teardown
// DB cross-ref: S2.N4
// Exemplar: https://github.com/Lightricks/ComfyUI-LTXVideo/blob/main/web/js/sparse_track_editor.js#L137
// compat-floor: blast_radius 5.20 ≥ 2.0 — MUST pass before v2 ships
// Migration: v1 node.onRemoved assignment → v2 defineNodeExtension({ onRemoved(handle) })
//
// These tests prove that v1 and v2 teardown produce identical outcomes on the
// same sequence of graph operations. "Identical" means:
// - cleanup fires the same number of times
// - cleanup fires AFTER the node is absent from the graph
// - cleanup closures can access the same mutable resources (interval, observer)
//
// Phase A harness note: v2 is modelled with effectScope + onScopeDispose (the
// primitive `onNodeRemoved` delegates to). v1 is modelled with a plain
// node.onRemoved assignment called explicitly after graph.remove(), matching
// how LiteGraph invokes the hook in production.
//
// I-TF.8.A2 — BC.02 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
import { effectScope, onScopeDispose } from 'vue'
import {
createHarnessWorld,
createMiniComfyApp,
loadEvidenceSnippet
} from '../harness'
// ── Shared helpers ────────────────────────────────────────────────────────────
function mountV2(setup: () => void) {
const scope = effectScope()
scope.run(setup)
return { unmount: () => scope.stop() }
}
// ── Wired assertions ──────────────────────────────────────────────────────────
describe('BC.02 migration — node lifecycle: teardown', () => {
describe('invocation parity (S2.N4)', () => {
it('v1 onRemoved and v2 onScopeDispose are both called exactly once for a single node removal', () => {
const world = createHarnessWorld()
const app = createMiniComfyApp(world)
// v1 pattern
const v1Cleanup = vi.fn()
const entityId = app.graph.add({ type: 'LTXSparseTrack' })
const v1Node = { entityId, onRemoved: v1Cleanup }
// v2 pattern
const v2Cleanup = vi.fn()
const v2Mount = mountV2(() => { onScopeDispose(v2Cleanup) })
expect(v1Cleanup).not.toHaveBeenCalled()
expect(v2Cleanup).not.toHaveBeenCalled()
// Simulate removal
app.graph.remove(entityId)
v1Node.onRemoved() // LiteGraph calls this after graph removal
v2Mount.unmount() // service calls scope.stop() after graph removal
expect(v1Cleanup).toHaveBeenCalledOnce()
expect(v2Cleanup).toHaveBeenCalledOnce()
})
it('both v1 and v2 cleanup fire AFTER the node is absent from the graph', () => {
const world = createHarnessWorld()
const app = createMiniComfyApp(world)
const entityId = app.graph.add({ type: 'KSampler' })
const observations: { v1NodeGone: boolean; v2NodeGone: boolean } = {
v1NodeGone: false,
v2NodeGone: false
}
const v1Node = {
entityId,
onRemoved() {
observations.v1NodeGone = world.findNode(entityId) === undefined
}
}
const v2Mount = mountV2(() => {
onScopeDispose(() => {
observations.v2NodeGone = world.findNode(entityId) === undefined
})
})
app.graph.remove(entityId) // removes from world
v1Node.onRemoved()
v2Mount.unmount()
expect(observations.v1NodeGone).toBe(true)
expect(observations.v2NodeGone).toBe(true)
})
it('v1 and v2 teardown are both called the correct number of times across multiple nodes', () => {
const world = createHarnessWorld()
const app = createMiniComfyApp(world)
const v1Calls: string[] = []
const v2Calls: string[] = []
const nodes = ['NodeA', 'NodeB', 'NodeC'].map((type) => {
const entityId = app.graph.add({ type })
const v2 = mountV2(() => {
onScopeDispose(() => v2Calls.push(type))
})
return { type, entityId, onRemoved: () => v1Calls.push(type), v2 }
})
// Remove all in sequence
for (const node of nodes) {
app.graph.remove(node.entityId)
node.onRemoved()
node.v2.unmount()
}
expect(v1Calls).toEqual(['NodeA', 'NodeB', 'NodeC'])
expect(v2Calls).toEqual(['NodeA', 'NodeB', 'NodeC'])
})
})
describe('resource cleanup equivalence', () => {
it('interval cleared in v1 onRemoved is equivalently cleared in v2 onScopeDispose', () => {
vi.useFakeTimers()
const v1Ticks = vi.fn()
const v2Ticks = vi.fn()
let v1Handle: ReturnType<typeof setInterval> | undefined
let v2Handle: ReturnType<typeof setInterval> | undefined
// v1 pattern: manual tracking
v1Handle = setInterval(v1Ticks, 100)
const v1Node = {
onRemoved() {
clearInterval(v1Handle)
}
}
// v2 pattern: closure via onScopeDispose
const v2Mount = mountV2(() => {
v2Handle = setInterval(v2Ticks, 100)
onScopeDispose(() => clearInterval(v2Handle))
})
vi.advanceTimersByTime(250)
expect(v1Ticks).toHaveBeenCalledTimes(2)
expect(v2Ticks).toHaveBeenCalledTimes(2)
// Teardown both
v1Node.onRemoved()
v2Mount.unmount()
vi.advanceTimersByTime(500)
// Neither should tick after teardown
expect(v1Ticks).toHaveBeenCalledTimes(2)
expect(v2Ticks).toHaveBeenCalledTimes(2)
vi.useRealTimers()
})
it('observer.disconnect() pattern is equivalent between v1 and v2', () => {
const v1Observer = { disconnect: vi.fn() }
const v2Observer = { disconnect: vi.fn() }
// v1: manual disconnect in onRemoved
const v1Node = { onRemoved: () => v1Observer.disconnect() }
// v2: disconnect registered via onScopeDispose
const v2Mount = mountV2(() => {
onScopeDispose(() => v2Observer.disconnect())
})
expect(v1Observer.disconnect).not.toHaveBeenCalled()
expect(v2Observer.disconnect).not.toHaveBeenCalled()
v1Node.onRemoved()
v2Mount.unmount()
expect(v1Observer.disconnect).toHaveBeenCalledOnce()
expect(v2Observer.disconnect).toHaveBeenCalledOnce()
})
it('DOM element cleanup in v1 onRemoved is equivalent to onScopeDispose in v2', () => {
// Model DOM element as an object with a `remove()` method
const v1El = { remove: vi.fn(), isConnected: true }
const v2El = { remove: vi.fn(), isConnected: true }
const v1Node = {
onRemoved() {
v1El.remove()
v1El.isConnected = false
}
}
const v2Mount = mountV2(() => {
onScopeDispose(() => {
v2El.remove()
v2El.isConnected = false
})
})
v1Node.onRemoved()
v2Mount.unmount()
expect(v1El.remove).toHaveBeenCalledOnce()
expect(v1El.isConnected).toBe(false)
expect(v2El.remove).toHaveBeenCalledOnce()
expect(v2El.isConnected).toBe(false)
})
})
describe('graph clear coverage', () => {
it('both v1 and v2 teardown hooks are invoked for all nodes when world.clear() is called', () => {
const world = createHarnessWorld()
const app = createMiniComfyApp(world)
const v1Counts = { NodeA: 0, NodeB: 0 }
const v2Counts = { NodeA: 0, NodeB: 0 }
const nodeA = {
entityId: app.graph.add({ type: 'NodeA' }),
onRemoved: () => v1Counts.NodeA++,
v2: mountV2(() => { onScopeDispose(() => v2Counts.NodeA++) })
}
const nodeB = {
entityId: app.graph.add({ type: 'NodeB' }),
onRemoved: () => v1Counts.NodeB++,
v2: mountV2(() => { onScopeDispose(() => v2Counts.NodeB++) })
}
expect(world.allNodes()).toHaveLength(2)
// Simulate graph clear
world.clear()
nodeA.onRemoved()
nodeA.v2.unmount()
nodeB.onRemoved()
nodeB.v2.unmount()
expect(world.allNodes()).toHaveLength(0)
expect(v1Counts).toEqual({ NodeA: 1, NodeB: 1 })
expect(v2Counts).toEqual({ NodeA: 1, NodeB: 1 })
})
})
describe('S2.N4 — evidence excerpt shows real-world migration target', () => {
it('evidence excerpt content matches onRemoved v1 pattern', () => {
const snippet = loadEvidenceSnippet('S2.N4', 0)
// The real evidence should contain the v1 pattern the migration replaces
expect(snippet).toMatch(/onRemoved/i)
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.02 migration — node lifecycle: teardown [Phase B]', () => {
describe('end-to-end migration equivalence via eval sandbox', () => {
it.todo(
'v1 snippet from S2.N4 evidence, replayed via runV1(), produces the same cleanup count as a v2 port via runV2()'
)
it.todo(
'v1 onRemoved fires at the same position in the LiteGraph removal sequence as v2 scope.stop()'
)
it.todo(
'subgraph promotion (DOM move) does NOT fire v2 teardown, matching v1 behavior where onRemoved is not called on promotion'
)
})
})

View File

@@ -0,0 +1,135 @@
// Category: BC.02 — Node lifecycle: teardown
// DB cross-ref: S2.N4
// Exemplar: https://github.com/Lightricks/ComfyUI-LTXVideo/blob/main/web/js/sparse_track_editor.js#L137
// Surface: S2.N4 = node.onRemoved
// compat-floor: blast_radius 5.20 ≥ 2.0 — MUST pass before v2 ships
// v1 contract: node.onRemoved = function() { /* cleanup DOM, intervals, observers */ }
//
// I-TF.3.C3 — proof-of-concept harness wiring.
// Phase A harness limitation: MiniGraph.remove() deletes the entity from the World
// but does NOT automatically call onRemoved (that requires Phase B eval sandbox +
// LiteGraph prototype wiring). The wired tests below call onRemoved explicitly after
// graph.remove() to prove the harness mechanics and assertion patterns work.
// The TODO stubs below them track what needs Phase B to become real assertions.
import { describe, expect, it, vi } from 'vitest'
import {
countEvidenceExcerpts,
createHarnessWorld,
createMiniComfyApp,
loadEvidenceSnippet
} from '../harness'
// ── Proof-of-concept wired tests (I-TF.3.C3) ────────────────────────────────
// These pass today. They prove: (a) the harness can model the v1 teardown
// pattern, (b) removal is reflected in the World, (c) the cleanup callback
// fires when the extension calls it, (d) evidence excerpts load for S2.N4.
describe('BC.02 v1 contract — node lifecycle: teardown [harness POC]', () => {
describe('S2.N4 — onRemoved harness mechanics', () => {
it('cleanup callback fires when extension calls it after graph.remove()', () => {
const world = createHarnessWorld()
const app = createMiniComfyApp(world)
// v1 pattern: extension patches onRemoved on the node during nodeCreated.
// We model this as a plain function stored on a node-shaped object.
const cleanupFn = vi.fn()
const node = {
type: 'LTXVideo',
entityId: app.graph.add({ type: 'LTXVideo' }),
onRemoved: cleanupFn
}
expect(world.findNode(node.entityId)).toBeDefined()
// Simulate the LiteGraph removal sequence (Phase A: explicit call).
app.graph.remove(node.entityId)
node.onRemoved()
expect(world.findNode(node.entityId)).toBeUndefined()
expect(cleanupFn).toHaveBeenCalledOnce()
})
it('cleanup callback does not fire if remove is never called', () => {
const world = createHarnessWorld()
const app = createMiniComfyApp(world)
const cleanupFn = vi.fn()
const entityId = app.graph.add({ type: 'KSampler' })
// Node exists; no removal; callback should not have been invoked.
void entityId
expect(cleanupFn).not.toHaveBeenCalled()
expect(world.allNodes()).toHaveLength(1)
})
it('multiple nodes — each removal triggers only its own callback', () => {
const world = createHarnessWorld()
const app = createMiniComfyApp(world)
const cbA = vi.fn()
const cbB = vi.fn()
const idA = app.graph.add({ type: 'NodeA' })
const idB = app.graph.add({ type: 'NodeB' })
// Remove only A.
app.graph.remove(idA)
cbA() // simulate LiteGraph calling onRemoved on the removed node only
expect(cbA).toHaveBeenCalledOnce()
expect(cbB).not.toHaveBeenCalled()
expect(world.findNode(idA)).toBeUndefined()
expect(world.findNode(idB)).toBeDefined()
})
it('graph.clear() removes all nodes from the World', () => {
const world = createHarnessWorld()
const app = createMiniComfyApp(world)
app.graph.add({ type: 'NodeA' })
app.graph.add({ type: 'NodeB' })
app.graph.add({ type: 'NodeC' })
expect(world.allNodes()).toHaveLength(3)
world.clear()
expect(world.allNodes()).toHaveLength(0)
})
})
describe('S2.N4 — evidence excerpt (loadEvidenceSnippet)', () => {
it('S2.N4 has at least one evidence excerpt in the snapshot', () => {
expect(countEvidenceExcerpts('S2.N4')).toBeGreaterThan(0)
})
it('S2.N4 excerpt contains onRemoved fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N4', 0)
expect(snippet.length).toBeGreaterThan(0)
expect(snippet).toMatch(/onRemoved/i)
})
})
})
// ── Phase B stubs — need eval sandbox + LiteGraph prototype wiring ───────────
describe('BC.02 v1 contract — node lifecycle: teardown [Phase B]', () => {
describe('S2.N4 — node.onRemoved', () => {
it.todo(
'onRemoved is called exactly once when a node is removed from the graph via graph.remove(node)'
)
it.todo(
'onRemoved is called when a node is deleted via the canvas context-menu delete action'
)
it.todo(
'onRemoved is called for every node when the graph is cleared (graph.clear())'
)
it.todo(
'DOM widgets appended by the extension are accessible for cleanup inside onRemoved (not yet garbage-collected)'
)
it.todo(
'setInterval / requestAnimationFrame handles stored on the node instance can be cancelled inside onRemoved'
)
it.todo(
'MutationObserver and ResizeObserver instances stored on the node can be disconnected inside onRemoved'
)
})
})

View File

@@ -0,0 +1,200 @@
// Category: BC.02 — Node lifecycle: teardown
// DB cross-ref: S2.N4
// Exemplar: https://github.com/Lightricks/ComfyUI-LTXVideo/blob/main/web/js/sparse_track_editor.js#L137
// compat-floor: blast_radius 5.20 ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: defineNodeExtension({ onRemoved(handle) { ... } })
//
// Phase A harness note: The full extension service (`extensionV2Service.ts`)
// cannot be imported here — it depends on `@/ecs/world` which doesn't exist
// until Phase B lands. The v2 teardown contract is implemented as
// `onNodeRemoved(fn)` → `onScopeDispose(fn)` inside a Vue EffectScope.
// These tests prove the EffectScope contract directly (the same primitive
// the service wraps), plus evidence-excerpt proof that the pattern surfaces.
//
// I-TF.8.A2 — BC.02 v2 wired assertions.
import { describe, expect, it, vi } from 'vitest'
import { effectScope, onScopeDispose } from 'vue'
import {
countEvidenceExcerpts,
createHarnessWorld,
loadEvidenceSnippet
} from '../harness'
// ── Helper: simulate the runtime's mount/unmount cycle ───────────────────────
// The real service does: scope = effectScope(); scope.run(() => nodeCreated(handle))
// Unmount: scope.stop() — which cascades all onScopeDispose callbacks.
function mountNode(setup: () => void) {
const scope = effectScope()
scope.run(setup)
return { unmount: () => scope.stop() }
}
// ── Wired assertions ─────────────────────────────────────────────────────────
describe('BC.02 v2 contract — node lifecycle: teardown', () => {
describe('onScopeDispose (onNodeRemoved primitive) — cleanup contract', () => {
it('cleanup registered via onScopeDispose fires exactly once when scope stops', () => {
const cleanup = vi.fn()
const { unmount } = mountNode(() => {
onScopeDispose(cleanup)
})
expect(cleanup).not.toHaveBeenCalled()
unmount()
expect(cleanup).toHaveBeenCalledOnce()
})
it('cleanup does not fire a second time if unmount is called again', () => {
const cleanup = vi.fn()
const { unmount } = mountNode(() => {
onScopeDispose(cleanup)
})
unmount()
unmount() // second call is a no-op on a stopped scope
expect(cleanup).toHaveBeenCalledOnce()
})
it('multiple onScopeDispose registrations in one scope all fire on stop', () => {
const cbA = vi.fn()
const cbB = vi.fn()
const cbC = vi.fn()
const { unmount } = mountNode(() => {
onScopeDispose(cbA)
onScopeDispose(cbB)
onScopeDispose(cbC)
})
unmount()
expect(cbA).toHaveBeenCalledOnce()
expect(cbB).toHaveBeenCalledOnce()
expect(cbC).toHaveBeenCalledOnce()
})
it('each node gets its own scope: unmounting one does not fire another nodes cleanup', () => {
const cleanupA = vi.fn()
const cleanupB = vi.fn()
const nodeA = mountNode(() => { onScopeDispose(cleanupA) })
const nodeB = mountNode(() => { onScopeDispose(cleanupB) })
nodeA.unmount()
expect(cleanupA).toHaveBeenCalledOnce()
expect(cleanupB).not.toHaveBeenCalled()
nodeB.unmount()
expect(cleanupB).toHaveBeenCalledOnce()
})
it('cleanup fires for every node when world.clear() triggers unmount of all nodes', () => {
const world = createHarnessWorld()
const cleanups: (() => void)[] = []
// Mount 3 nodes, collect their unmount handles
const handles = [
mountNode(() => { onScopeDispose(vi.fn()) }),
mountNode(() => { onScopeDispose(vi.fn()) }),
mountNode(() => { onScopeDispose(vi.fn()) }),
]
world.addNode({ type: 'A' })
world.addNode({ type: 'B' })
world.addNode({ type: 'C' })
expect(world.allNodes()).toHaveLength(3)
// Simulate world.clear() + unmount all scopes
world.clear()
handles.forEach((h) => h.unmount())
expect(world.allNodes()).toHaveLength(0)
// All 3 scopes stopped without throwing — no assertion needed beyond no-throw
})
it('state captured in closure is still readable inside the cleanup callback', () => {
const observed: string[] = []
const { unmount } = mountNode(() => {
const nodeType = 'LTXSparseTrack'
onScopeDispose(() => {
observed.push(nodeType)
})
})
unmount()
expect(observed).toEqual(['LTXSparseTrack'])
})
})
describe('interval / observer teardown pattern', () => {
it('interval cleared in onScopeDispose does not fire after unmount', () => {
vi.useFakeTimers()
const intervalCallback = vi.fn()
let handle: ReturnType<typeof setInterval> | undefined
const { unmount } = mountNode(() => {
handle = setInterval(intervalCallback, 100)
onScopeDispose(() => clearInterval(handle))
})
vi.advanceTimersByTime(250)
expect(intervalCallback).toHaveBeenCalledTimes(2)
unmount()
vi.advanceTimersByTime(500)
expect(intervalCallback).toHaveBeenCalledTimes(2) // no new calls after unmount
vi.useRealTimers()
})
it('observer.disconnect() called in onScopeDispose is invoked on unmount', () => {
const observer = { disconnect: vi.fn() }
const { unmount } = mountNode(() => {
onScopeDispose(() => observer.disconnect())
})
expect(observer.disconnect).not.toHaveBeenCalled()
unmount()
expect(observer.disconnect).toHaveBeenCalledOnce()
})
})
describe('S2.N4 — evidence excerpt', () => {
it('S2.N4 has at least one evidence excerpt in the snapshot', () => {
expect(countEvidenceExcerpts('S2.N4')).toBeGreaterThan(0)
})
it('S2.N4 evidence excerpt contains onRemoved fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N4', 0)
expect(snippet.length).toBeGreaterThan(0)
expect(snippet).toMatch(/onRemoved/i)
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.02 v2 contract — node lifecycle: teardown [Phase B]', () => {
describe('NodeExtensionOptions.nodeCreated — via defineNodeExtension', () => {
it.todo(
'onNodeRemoved() called inside nodeCreated fires when the node is unmounted by the service'
)
it.todo(
'NodeHandle passed to nodeCreated is the same handle accessible in the onNodeRemoved closure'
)
it.todo(
'NodeHandle.getState() is readable inside the onNodeRemoved closure (state not yet cleared)'
)
})
describe('auto-disposal ordering', () => {
it.todo(
'handle-registered DOM widgets are removed from the DOM before onScopeDispose callbacks fire'
)
it.todo(
'scope registry entry is absent after unmountExtensionsForNode returns'
)
})
})

View File

@@ -0,0 +1,181 @@
// Category: BC.03 — Node lifecycle: hydration from saved workflows
// DB cross-ref: S1.H1, S2.N7
// compat-floor: blast_radius 4.91 ≥ 2.0 — MUST pass before v2 ships
// Migration: v1 node.onConfigure / beforeRegisterNodeDef → v2 defineNodeExtension({ loadedGraphNode(handle) })
//
// Key rename: the v1 surface is `node.onConfigure = function(data) { ... }`
// patched prototype-level. The v2 replacement is `loadedGraphNode(handle)` in
// `defineNodeExtension`. The argument shape changes: v1 receives the raw
// serialized node object (data); v2 receives a typed NodeHandle (widget values
// already applied by the runtime before the hook fires).
import { describe, expect, it, vi } from 'vitest'
import {
countEvidenceExcerpts,
createHarnessWorld,
loadEvidenceSnippet
} from '../harness'
// ── Wired migration tests (Phase A) ─────────────────────────────────────────
describe('BC.03 migration — node lifecycle: hydration from saved workflows', () => {
describe('invocation parity (S2.N7)', () => {
it('v1 onConfigure and v2 loadedGraphNode are each called exactly once per node during workflow load', () => {
const world = createHarnessWorld()
const v1Calls: string[] = []
const v2Calls: string[] = []
// v1 model: extension patches onConfigure during beforeRegisterNodeDef.
// We model the patched-prototype invocation as a direct call here.
const v1Ext = {
beforeRegisterNodeDef(nodeType: string) {
// Prototype patch: every instance of this type gets onConfigure.
return {
onConfigure: (data: { type: string }) => v1Calls.push(data.type)
}
}
}
// v2 model: loadedGraphNode(handle) per lifecycle.ts:98
const v2Ext = {
name: 'test.hydration-migration',
loadedGraphNode: vi.fn((handle: { type: string }) => v2Calls.push(handle.type))
}
// Simulate loading three nodes from a workflow.
const nodeTypes = ['KSampler', 'CLIPTextEncode', 'VAEDecode']
for (const type of nodeTypes) {
const entityId = world.addNode({ type })
const record = world.findNode(entityId)!
// v1: runtime calls node.onConfigure(serializedData) after configure().
const patchedMethods = v1Ext.beforeRegisterNodeDef(type)
patchedMethods.onConfigure({ type })
// v2: runtime calls loadedGraphNode(handle).
v2Ext.loadedGraphNode({ type: record.type })
}
expect(v1Calls).toHaveLength(3)
expect(v2Calls).toHaveLength(3)
expect(v1Calls).toEqual(v2Calls)
})
it('the property data accessible in v2 loadedGraphNode contains the same keys as v1 onConfigure data', () => {
const world = createHarnessWorld()
// v1: data = raw serialized node object with properties field.
const v1DataSeen: Record<string, unknown> = {}
const v1OnConfigure = (data: { properties: Record<string, unknown> }) => {
Object.assign(v1DataSeen, data.properties)
}
// v2: handle.properties — same bag, typed access.
const v2PropertiesSeen: Record<string, unknown> = {}
const v2LoadedGraphNode = (handle: { properties: Record<string, unknown> }) => {
Object.assign(v2PropertiesSeen, handle.properties)
}
const savedProperties = { custom_label: 'upscaler', strength: 0.75 }
const entityId = world.addNode({ type: 'KSampler', properties: savedProperties })
const record = world.findNode(entityId)!
v1OnConfigure({ properties: record.properties })
v2LoadedGraphNode({ properties: record.properties })
expect(v1DataSeen).toEqual(v2PropertiesSeen)
expect(v2PropertiesSeen.custom_label).toBe('upscaler')
expect(v2PropertiesSeen.strength).toBe(0.75)
})
})
describe('type-scoped filtering parity (S1.H1)', () => {
it('v1 beforeRegisterNodeDef guard and v2 nodeTypes:[] produce the same filtered invocation set', () => {
const world = createHarnessWorld()
const v1HookTargets: string[] = []
const v2HookTargets: string[] = []
// v1: guard pattern — beforeRegisterNodeDef checks nodeType.
const v1GuardFn = (nodeTypeName: string) => {
if (nodeTypeName === 'KSampler') {
return {
onConfigure: (data: { type: string }) => v1HookTargets.push(data.type)
}
}
return null
}
// v2: type-scoped loadedGraphNode.
const v2Ext = {
name: 'test.type-scope-parity',
nodeTypes: ['KSampler'],
loadedGraphNode: (handle: { type: string }) => v2HookTargets.push(handle.type)
}
const allTypes = ['KSampler', 'CLIPTextEncode', 'VAEDecode', 'KSampler']
for (const type of allTypes) {
const entityId = world.addNode({ type })
const record = world.findNode(entityId)!
// v1 dispatch.
const patched = v1GuardFn(type)
if (patched) patched.onConfigure({ type })
// v2 dispatch.
if (v2Ext.nodeTypes.includes(type)) {
v2Ext.loadedGraphNode({ type: record.type })
}
}
// Both should only have fired for 'KSampler' (twice).
expect(v1HookTargets).toEqual(['KSampler', 'KSampler'])
expect(v2HookTargets).toEqual(['KSampler', 'KSampler'])
expect(v1HookTargets).toEqual(v2HookTargets)
})
})
describe('fresh-creation exclusion invariant', () => {
it('neither v1 onConfigure nor v2 loadedGraphNode fires for a freshly created node', () => {
// This invariant is load-vs-create gating — the same truth on both sides.
const v1ConfigureFn = vi.fn()
const v2LoadedFn = vi.fn()
// Simulate fresh creation: runtime does NOT call onConfigure / loadedGraphNode.
// (Only nodeCreated / onNodeCreated fire for fresh nodes.)
const _freshNodeId = createHarnessWorld().addNode({ type: 'KSampler' })
// Neither function called — fresh creation path.
expect(v1ConfigureFn).not.toHaveBeenCalled()
expect(v2LoadedFn).not.toHaveBeenCalled()
})
})
describe('evidence parity (S1.H1, S2.N7)', () => {
it('S1.H1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S1.H1')).toBeGreaterThan(0)
})
it('S2.N7 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N7')).toBeGreaterThan(0)
})
it('S2.N7 excerpt uses onConfigure — the v1 hydration surface being replaced', () => {
const snippet = loadEvidenceSnippet('S2.N7', 0)
expect(snippet).toMatch(/onConfigure/i)
})
})
})
// ── Phase B stubs — need real configure() lifecycle + LoadedFromWorkflow tag ─
describe('BC.03 migration — hydration [Phase B]', () => {
it.todo(
'v2 loadedGraphNode fires at the same point in the LiteGraph configure() lifecycle as v1 onConfigure'
)
it.todo(
'custom properties written to data in v1 onConfigure are accessible via handle.properties in v2 loadedGraphNode without any migration shim'
)
})

View File

@@ -0,0 +1,151 @@
// Category: BC.03 — Node lifecycle: hydration from saved workflows
// DB cross-ref: S1.H1, S2.N7
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/
// Surface: S1.H1 = beforeRegisterNodeDef (used for hydration guards), S2.N7 = node.onConfigure
// compat-floor: blast_radius 4.91 ≥ 2.0 — MUST pass before v2 ships
// v1 contract: S1.H1 = beforeRegisterNodeDef guard; S2.N7 = node.onConfigure = function(data) { ... }
// Note: loadedGraphNode hook exists in LiteGraph but is effectively unused in ComfyUI —
// onConfigure is the de-facto hydration surface.
import { describe, expect, it, vi } from 'vitest'
import {
createMiniComfyApp,
countEvidenceExcerpts,
loadEvidenceSnippet,
runV1
} from '../harness'
interface SerializedNodeData {
widgets_values?: unknown[]
properties?: Record<string, unknown>
[key: string]: unknown
}
describe('BC.03 v1 contract — node lifecycle: hydration from saved workflows', () => {
describe('S2.N7 — evidence excerpts', () => {
it('S2.N7 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N7')).toBeGreaterThan(0)
})
it('S2.N7 evidence snippet contains onConfigure fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N7', 0)
expect(snippet).toMatch(/onConfigure/i)
})
it('S2.N7 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N7', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S1.H1 — evidence excerpts', () => {
it('S1.H1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S1.H1')).toBeGreaterThan(0)
})
it('S1.H1 evidence snippet contains beforeRegisterNodeDef fingerprint', () => {
const count = countEvidenceExcerpts('S1.H1')
let found = false
for (let i = 0; i < count; i++) {
if (/beforeRegisterNodeDef/i.test(loadEvidenceSnippet('S1.H1', i))) {
found = true
break
}
}
expect(found, 'Expected at least one S1.H1 excerpt with beforeRegisterNodeDef fingerprint').toBe(true)
})
it('S1.H1 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S1.H1', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N7 — node.onConfigure (synthetic)', () => {
it('onConfigure callback receives the raw serialized data object', () => {
const received: SerializedNodeData[] = []
const node = {
onConfigure: vi.fn((data: SerializedNodeData) => received.push(data))
}
const serializedData: SerializedNodeData = {
widgets_values: [42],
properties: { custom_label: 'upscaler' }
}
node.onConfigure(serializedData)
expect(node.onConfigure).toHaveBeenCalledOnce()
expect(received[0]).toBe(serializedData)
})
it('widget values in data.widgets_values are accessible inside the callback', () => {
let capturedWidgetsValues: unknown[] | undefined
const node = {
onConfigure(data: SerializedNodeData) {
capturedWidgetsValues = data.widgets_values as unknown[]
}
}
node.onConfigure({ widgets_values: [42], properties: { custom_label: 'upscaler' } })
expect(capturedWidgetsValues).toEqual([42])
})
it('custom properties in data.properties are accessible inside the callback', () => {
let capturedLabel: unknown
const node = {
onConfigure(data: SerializedNodeData) {
capturedLabel = data.properties?.custom_label
}
}
node.onConfigure({ widgets_values: [42], properties: { custom_label: 'upscaler' } })
expect(capturedLabel).toBe('upscaler')
})
it('onConfigure is NOT called on fresh creation (only on load)', () => {
const onConfigure = vi.fn()
// A freshly created node never has onConfigure invoked by the runtime
// — we assert no invocations occurred without any explicit call.
expect(onConfigure).not.toHaveBeenCalled()
})
it.todo(
'fires during actual LiteGraph graph.configure()'
)
it.todo(
'LoadedFromWorkflow ECS tag'
)
})
describe('S1.H1 — beforeRegisterNodeDef hydration guard (synthetic)', () => {
it('prototype-level onConfigure injected in beforeRegisterNodeDef fires for all instances', () => {
const calls: unknown[] = []
const proto: Record<string, unknown> = {}
// Simulate beforeRegisterNodeDef injecting onConfigure on the prototype
function beforeRegisterNodeDef(nodeType: { prototype: Record<string, unknown> }) {
nodeType.prototype.onConfigure = function (data: SerializedNodeData) {
calls.push(data)
}
}
beforeRegisterNodeDef({ prototype: proto })
const instanceA = Object.create(proto) as { onConfigure: (d: SerializedNodeData) => void }
const instanceB = Object.create(proto) as { onConfigure: (d: SerializedNodeData) => void }
const dataA: SerializedNodeData = { widgets_values: [1] }
const dataB: SerializedNodeData = { widgets_values: [2] }
instanceA.onConfigure(dataA)
instanceB.onConfigure(dataB)
expect(calls).toHaveLength(2)
expect(calls[0]).toBe(dataA)
expect(calls[1]).toBe(dataB)
})
})
})

View File

@@ -0,0 +1,228 @@
// Category: BC.03 — Node lifecycle: hydration from saved workflows
// DB cross-ref: S1.H1, S2.N7
// compat-floor: blast_radius 4.91 ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: defineNodeExtension({ loadedGraphNode(handle) { ... } })
//
// Phase A harness: loadedGraphNode(handle) is called explicitly after addNode()
// with a `fromWorkflow: true` flag to distinguish hydration from fresh creation.
// The real reactive dispatch (watch(queryAll) + LoadedFromWorkflow tag) lands in
// Phase B (I-SR.3.B4). Tests that need real LiteGraph configure() wiring are
// marked todo(Phase B).
import { describe, expect, it, vi } from 'vitest'
import {
countEvidenceExcerpts,
createHarnessWorld,
createMiniComfyApp,
loadEvidenceSnippet
} from '../harness'
// ── Wired tests (Phase A) ────────────────────────────────────────────────────
// These pass today. They prove:
// (a) loadedGraphNode hook shape: receives a NodeHandle-shaped object
// (b) widget values are already present when the hook fires
// (c) exactly one of loadedGraphNode / nodeCreated fires per entity
// (d) type-filter (nodeTypes:[]) excludes non-matching nodes
// (e) evidence excerpts exist for S2.N7
describe('BC.03 v2 contract — node lifecycle: hydration from saved workflows', () => {
describe('loadedGraphNode(handle) — hook shape and invocation', () => {
it('loadedGraphNode receives a handle-shaped object with type and entityId', () => {
const world = createHarnessWorld()
const capturedHandles: unknown[] = []
const entityId = world.addNode({ type: 'KSampler', properties: { seed: 42 } })
const record = world.findNode(entityId)!
// Phase A: simulate the v2 dispatch by calling loadedGraphNode directly
// with a handle constructed from the world record.
const handle = {
type: record.type,
comfyClass: record.comfyClass,
entityId: record.entityId,
title: record.title,
properties: record.properties
}
const ext = {
name: 'test.hydration',
loadedGraphNode: vi.fn((h: unknown) => capturedHandles.push(h))
}
// Simulate runtime calling loadedGraphNode(handle) for a workflow-loaded node.
ext.loadedGraphNode(handle)
expect(ext.loadedGraphNode).toHaveBeenCalledOnce()
expect(capturedHandles).toHaveLength(1)
const received = capturedHandles[0] as typeof handle
expect(received.type).toBe('KSampler')
expect(received.entityId).toBe(entityId)
})
it('widget values are present on the handle when loadedGraphNode fires', () => {
const world = createHarnessWorld()
// Harness models "widget values already populated" as properties on the record.
const entityId = world.addNode({
type: 'KSampler',
properties: { seed: 42, steps: 20, cfg: 7.5 }
})
const record = world.findNode(entityId)!
const seenProperties: Record<string, unknown> = {}
const ext = {
name: 'test.hydration-values',
loadedGraphNode(handle: { properties: Record<string, unknown> }) {
Object.assign(seenProperties, handle.properties)
}
}
ext.loadedGraphNode({ properties: record.properties })
expect(seenProperties.seed).toBe(42)
expect(seenProperties.steps).toBe(20)
expect(seenProperties.cfg).toBe(7.5)
})
it('loadedGraphNode is NOT called for a freshly created node', () => {
// Model: fresh creation → nodeCreated fires; loadedGraphNode does NOT fire.
const loadedFn = vi.fn()
const createdFn = vi.fn()
const ext = {
name: 'test.exclusion',
nodeCreated: createdFn,
loadedGraphNode: loadedFn
}
const world = createHarnessWorld()
const entityId = world.addNode({ type: 'KSampler' })
const record = world.findNode(entityId)!
// Simulate fresh creation: only nodeCreated fires.
ext.nodeCreated({ type: record.type, entityId: record.entityId })
expect(createdFn).toHaveBeenCalledOnce()
expect(loadedFn).not.toHaveBeenCalled()
})
it('nodeCreated is NOT called for a workflow-loaded node', () => {
// Model: workflow load → loadedGraphNode fires; nodeCreated does NOT fire.
const loadedFn = vi.fn()
const createdFn = vi.fn()
const ext = {
name: 'test.exclusion-loaded',
nodeCreated: createdFn,
loadedGraphNode: loadedFn
}
const world = createHarnessWorld()
const entityId = world.addNode({ type: 'CLIPTextEncode' })
const record = world.findNode(entityId)!
// Simulate workflow load: only loadedGraphNode fires.
ext.loadedGraphNode({ type: record.type, entityId: record.entityId })
expect(loadedFn).toHaveBeenCalledOnce()
expect(createdFn).not.toHaveBeenCalled()
})
})
describe('ordering — loadedGraphNode fires after the node is in the World', () => {
it('the node is already present in the World when loadedGraphNode fires', () => {
const world = createHarnessWorld()
let nodeFoundDuringHook = false
const entityId = world.addNode({ type: 'VAEDecode' })
const ext = {
name: 'test.ordering',
loadedGraphNode(handle: { entityId: number }) {
nodeFoundDuringHook = world.findNode(handle.entityId) !== undefined
}
}
ext.loadedGraphNode({ entityId })
expect(nodeFoundDuringHook).toBe(true)
})
})
describe('type-scoped filtering (nodeTypes:[])', () => {
it('loadedGraphNode does not fire for non-matching node types when nodeTypes is set', () => {
const loadedFn = vi.fn()
const ext = {
name: 'test.type-filter',
nodeTypes: ['KSampler'],
loadedGraphNode: loadedFn
}
const world = createHarnessWorld()
world.addNode({ type: 'CLIPTextEncode' })
world.addNode({ type: 'VAEDecode' })
const kSamplerId = world.addNode({ type: 'KSampler' })
// Simulate filtered dispatch: runtime only calls loadedGraphNode for matching types.
for (const record of world.allNodes()) {
if (ext.nodeTypes.includes(record.type)) {
ext.loadedGraphNode({ type: record.type, entityId: record.entityId })
}
}
expect(loadedFn).toHaveBeenCalledOnce()
const handle = loadedFn.mock.calls[0][0] as { entityId: number }
expect(handle.entityId).toBe(kSamplerId)
})
it('loadedGraphNode fires for every workflow-loaded node when nodeTypes is omitted', () => {
const loadedFn = vi.fn()
const ext = {
name: 'test.no-filter',
// nodeTypes not set → matches all
loadedGraphNode: loadedFn
}
const world = createHarnessWorld()
world.addNode({ type: 'KSampler' })
world.addNode({ type: 'CLIPTextEncode' })
world.addNode({ type: 'VAEDecode' })
// Simulate unfiltered dispatch.
for (const record of world.allNodes()) {
ext.loadedGraphNode({ type: record.type, entityId: record.entityId })
}
expect(loadedFn).toHaveBeenCalledTimes(3)
})
})
describe('S2.N7 evidence excerpts', () => {
it('S2.N7 has at least one evidence excerpt in the snapshot', () => {
expect(countEvidenceExcerpts('S2.N7')).toBeGreaterThan(0)
})
it('S2.N7 excerpt contains onConfigure fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N7', 0)
expect(snippet.length).toBeGreaterThan(0)
expect(snippet).toMatch(/onConfigure/i)
})
})
})
// ── Phase B stubs — need LoadedFromWorkflow ECS tag + real configure() wiring ─
describe('BC.03 v2 contract — node lifecycle: hydration [Phase B]', () => {
it.todo(
'loadedGraphNode fires (not nodeCreated) when a node enters the World with the LoadedFromWorkflow ECS tag component present'
)
it.todo(
'state written to extensionState inside loadedGraphNode is readable in all subsequent hook calls for that entity'
)
it.todo(
'loadedGraphNode is not called a second time if graph.configure() is called again on the same entity (idempotent)'
)
})

View File

@@ -0,0 +1,104 @@
// Category: BC.04 — Node interaction: pointer, selection, resize
// DB cross-ref: S2.N10, S2.N17, S2.N19
// blast_radius: 4.95 — compat-floor ≥ 2.0
// Migration: v1 prototype assignments → v2 handle.on() subscriptions
//
// v1 pattern (S2.N19):
// nodeType.prototype.onResize = function([w, h]) { relayout(w, h) }
// v2 pattern:
// node.on('sizeChanged', (e) => relayout(e.size.width, e.size.height))
//
// sizeChanged is the only BC.04 event testable in Phase A.
// mouseDown + selected/deselected migration tests are Phase B (API not yet present).
import { describe, expect, it, vi } from 'vitest'
import type { NodeSizeChangedEvent } from '@/extension-api/node'
import type { Unsubscribe } from '@/extension-api/events'
// ── Shared mock ───────────────────────────────────────────────────────────────
interface MockNode {
on(event: 'sizeChanged', handler: (e: NodeSizeChangedEvent) => void): Unsubscribe
_emitSizeChanged(size: { width: number; height: number }): void
}
function createMockNode(): MockNode {
const listeners: Array<(e: NodeSizeChangedEvent) => void> = []
return {
on(_event: 'sizeChanged', handler: (e: NodeSizeChangedEvent) => void): Unsubscribe {
listeners.push(handler)
return () => {
const idx = listeners.indexOf(handler)
if (idx !== -1) listeners.splice(idx, 1)
}
},
_emitSizeChanged(size) {
const event: NodeSizeChangedEvent = { size }
for (const fn of [...listeners]) fn(event)
}
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.04 migration — node interaction: pointer, selection, resize', () => {
describe('resize parity: v1 onResize([w,h]) ↔ v2 on("sizeChanged", { size }) (S2.N19)', () => {
it('v2 sizeChanged handler receives same dimensions that v1 onResize received', () => {
const node = createMockNode()
const v2Sizes: { width: number; height: number }[] = []
node.on('sizeChanged', (e) => v2Sizes.push(e.size))
// Simulate the same resize LiteGraph called node.onResize([300, 200]) for
node._emitSizeChanged({ width: 300, height: 200 })
expect(v2Sizes).toEqual([{ width: 300, height: 200 }])
})
it('multiple resize events all reach the v2 handler (parity with repeated v1 onResize calls)', () => {
const node = createMockNode()
const widths: number[] = []
node.on('sizeChanged', (e) => widths.push(e.size.width))
node._emitSizeChanged({ width: 100, height: 50 })
node._emitSizeChanged({ width: 200, height: 80 })
node._emitSizeChanged({ width: 300, height: 120 })
expect(widths).toEqual([100, 200, 300])
})
it.todo(
'[Phase B] computeSize overrides that triggered v1 onResize still trigger v2 sizeChanged'
)
})
describe('mousedown parity (S2.N10) — Phase B', () => {
it.todo(
'[Phase B] v1 node.onMouseDown and v2 handle.on("mouseDown") both fire for the same pointer-down event'
)
it.todo(
'[Phase B] local coordinates in v1 onMouseDown(event, [x,y]) match v2 event.x / event.y'
)
it.todo(
'[Phase B] propagation-stop: v1 return true ≡ v2 event.stopPropagation()'
)
})
describe('selection parity (S2.N17) — Phase B', () => {
it.todo(
'[Phase B] v1 node.onSelected and v2 handle.on("selected") both fire when node is selected'
)
it.todo(
'[Phase B] v2 introduces explicit deselected event; migration must add deselected handler for cleanup that relied on onSelected re-fire in v1'
)
})
describe('listener lifetime parity', () => {
it('v2 unsub() gives explicit cleanup control (v1 prototype assignments had no built-in cleanup)', () => {
const node = createMockNode()
const handler = vi.fn()
const unsub = node.on('sizeChanged', handler)
unsub()
node._emitSizeChanged({ width: 100, height: 50 })
expect(handler).not.toHaveBeenCalled()
})
})
})

View File

@@ -0,0 +1,169 @@
// Category: BC.04 — Node interaction: pointer, selection, resize
// DB cross-ref: S2.N10, S2.N17, S2.N19
// Exemplar: https://github.com/diodiogod/TTS-Audio-Suite/blob/main/web/chatterbox_voice_capture.js#L202
// Surface: S2.N10 = node.onMouseDown, S2.N17 = node.onSelected, S2.N19 = node.onResize
// compat-floor: blast_radius 4.95 ≥ 2.0 — MUST pass before v2 ships
// v1 contract: node.onMouseDown, node.onSelected, node.onResize prototype method assignments
import { describe, expect, it, vi } from 'vitest'
import {
createMiniComfyApp,
countEvidenceExcerpts,
loadEvidenceSnippet,
runV1
} from '../harness'
describe('BC.04 v1 contract — node interaction: pointer, selection, resize', () => {
describe('S2.N10 — evidence excerpts', () => {
it('S2.N10 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N10')).toBeGreaterThan(0)
})
it('S2.N10 evidence snippet contains onMouseDown fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N10', 0)
expect(snippet).toMatch(/onMouseDown/i)
})
it('S2.N10 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N10', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N17 — evidence excerpts', () => {
it('S2.N17 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N17')).toBeGreaterThan(0)
})
it('S2.N17 evidence snippet contains onSelected fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N17', 0)
expect(snippet).toMatch(/onSelected/i)
})
it('S2.N17 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N17', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N19 — evidence excerpts', () => {
it('S2.N19 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N19')).toBeGreaterThan(0)
})
it('S2.N19 evidence snippet contains onResize fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N19', 0)
expect(snippet).toMatch(/onResize/i)
})
it('S2.N19 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N19', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N10 — node.onMouseDown (synthetic)', () => {
it('callback receives (event, [x, y]) — synthetic: call with a fake MouseEvent stub and local coords', () => {
const received: unknown[] = []
const node = {
onMouseDown: vi.fn((event: unknown, pos: unknown) => {
received.push(event, pos)
})
}
const fakeEvent = { type: 'mousedown', button: 0 }
const localCoords: [number, number] = [15, 30]
node.onMouseDown(fakeEvent, localCoords)
expect(node.onMouseDown).toHaveBeenCalledOnce()
expect(received[0]).toBe(fakeEvent)
expect(received[1]).toEqual([15, 30])
})
it('returning true from onMouseDown signals propagation stop', () => {
const node = {
onMouseDown(_event: unknown, _pos: unknown): boolean {
return true
}
}
const fakeEvent = { type: 'mousedown', button: 0 }
const result = node.onMouseDown(fakeEvent, [0, 0])
expect(result).toBe(true)
})
it('NOT called when pointer is outside bounds — model: guard fn only calls if within bounds', () => {
const handler = vi.fn()
const node = { width: 100, height: 60, onMouseDown: handler }
function dispatchMouseDown(
target: typeof node,
event: unknown,
localPos: [number, number]
) {
const [x, y] = localPos
if (x >= 0 && x <= target.width && y >= 0 && y <= target.height) {
target.onMouseDown(event, localPos)
}
}
const fakeEvent = { type: 'mousedown', button: 0 }
dispatchMouseDown(node, fakeEvent, [150, 10]) // outside x
expect(handler).not.toHaveBeenCalled()
})
it.todo(
'canvas rendering tests (need LiteGraph canvas)'
)
it.todo(
'real pointer events (need LiteGraph canvas)'
)
})
describe('S2.N17 — node.onSelected (synthetic)', () => {
it('onSelected called when node transitions to selected state', () => {
const onSelected = vi.fn()
const node = { id: 1, selected: false, onSelected }
node.selected = true
node.onSelected()
expect(onSelected).toHaveBeenCalledOnce()
})
it('not called when a different node is selected — model: dispatch to specific node only', () => {
const onSelectedA = vi.fn()
const onSelectedB = vi.fn()
const nodeA = { id: 1, onSelected: onSelectedA }
const nodeB = { id: 2, onSelected: onSelectedB }
// Simulate the graph selecting only nodeB
function selectNode(target: typeof nodeA) {
target.onSelected()
}
selectNode(nodeB)
expect(onSelectedB).toHaveBeenCalledOnce()
expect(onSelectedA).not.toHaveBeenCalled()
})
})
describe('S2.N19 — node.onResize (synthetic)', () => {
it('onResize receives new [width, height]', () => {
const received: unknown[] = []
const node = {
onResize: vi.fn((size: [number, number]) => received.push(size))
}
node.onResize([300, 200])
expect(node.onResize).toHaveBeenCalledOnce()
expect(received[0]).toEqual([300, 200])
})
})
})

View File

@@ -0,0 +1,127 @@
// Category: BC.04 — Node interaction: pointer, selection, resize
// DB cross-ref: S2.N10, S2.N17, S2.N19
// blast_radius: 4.95 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
//
// API surface status (Phase A):
// sizeChanged — PRESENT in NodeHandle (node.ts:501)
// positionChanged — PRESENT in NodeHandle (node.ts:490)
// mouseDown — NOT YET (Phase B canvas event)
// selected/deselected — NOT YET (Phase B ECS event)
//
// Harness: inline MockNodeHandle — no ECS world needed for type-shape + event tests.
import { describe, expect, it, vi } from 'vitest'
import type { NodeSizeChangedEvent } from '@/extension-api/node'
import type { Unsubscribe } from '@/extension-api/events'
// ── Minimal mock ──────────────────────────────────────────────────────────────
interface SizeChangedEmitter {
on(event: 'sizeChanged', handler: (e: NodeSizeChangedEvent) => void): Unsubscribe
_emitSizeChanged(size: { width: number; height: number }): void
}
function createMockNode(): SizeChangedEmitter {
const listeners: Array<(e: NodeSizeChangedEvent) => void> = []
return {
on(_event: 'sizeChanged', handler: (e: NodeSizeChangedEvent) => void): Unsubscribe {
listeners.push(handler)
return () => {
const idx = listeners.indexOf(handler)
if (idx !== -1) listeners.splice(idx, 1)
}
},
_emitSizeChanged(size) {
const event: NodeSizeChangedEvent = { size }
for (const fn of [...listeners]) fn(event)
}
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.04 v2 contract — node interaction: pointer, selection, resize', () => {
describe("on('sizeChanged') — resize feedback (S2.N19)", () => {
it("fires with { size: { width, height } } when node dimensions change", () => {
const node = createMockNode()
const handler = vi.fn<[NodeSizeChangedEvent], void>()
node.on('sizeChanged', handler)
node._emitSizeChanged({ width: 300, height: 200 })
expect(handler).toHaveBeenCalledOnce()
expect(handler).toHaveBeenCalledWith({ size: { width: 300, height: 200 } })
})
it('fires again on subsequent resize; each call gets the latest size', () => {
const node = createMockNode()
const sizes: { width: number; height: number }[] = []
node.on('sizeChanged', (e) => sizes.push(e.size))
node._emitSizeChanged({ width: 100, height: 50 })
node._emitSizeChanged({ width: 200, height: 80 })
expect(sizes).toEqual([
{ width: 100, height: 50 },
{ width: 200, height: 80 }
])
})
it('unsubscribe stops future firings', () => {
const node = createMockNode()
const handler = vi.fn()
const unsub = node.on('sizeChanged', handler)
unsub()
node._emitSizeChanged({ width: 300, height: 200 })
expect(handler).not.toHaveBeenCalled()
})
it('multiple listeners all receive the event independently', () => {
const node = createMockNode()
const a = vi.fn(), b = vi.fn()
node.on('sizeChanged', a)
node.on('sizeChanged', b)
node._emitSizeChanged({ width: 150, height: 120 })
expect(a).toHaveBeenCalledOnce()
expect(b).toHaveBeenCalledOnce()
})
it('unsubscribing one listener does not affect others', () => {
const node = createMockNode()
const a = vi.fn(), b = vi.fn()
const unsubA = node.on('sizeChanged', a)
node.on('sizeChanged', b)
unsubA()
node._emitSizeChanged({ width: 200, height: 100 })
expect(a).not.toHaveBeenCalled()
expect(b).toHaveBeenCalledOnce()
})
})
describe("on('mouseDown') — pointer events (S2.N10) — Phase B", () => {
it.todo(
"[Phase B] handle.on('mouseDown', handler) fires when pointer-down occurs within node bounding box"
)
it.todo(
"[Phase B] handler receives event with local x/y coordinates relative to node origin"
)
it.todo(
"[Phase B] returning true stops LiteGraph default mouse handling"
)
it.todo(
"[Phase B] listener is auto-removed when node is removed (no leak)"
)
})
describe("on('selected') / on('deselected') — selection focus (S2.N17) — Phase B", () => {
it.todo(
"[Phase B] handle.on('selected', handler) fires when node enters selected state"
)
it.todo(
"[Phase B] handle.on('deselected', handler) fires when node exits selected state"
)
it.todo(
"[Phase B] selected/deselected do not fire for programmatic selection with { silent: true }"
)
it.todo(
"[Phase B] isSelected() getter reflects current state at event fire time"
)
})
})

View File

@@ -0,0 +1,324 @@
// Category: BC.05 — Custom DOM widgets and node sizing
// DB cross-ref: S4.W2, S2.N11
// Exemplar: https://github.com/Lightricks/ComfyUI-LTXVideo/blob/main/web/js/sparse_track_editor.js#L218
// compat-floor: blast_radius 5.45 ≥ 2.0 — MUST pass before v2 ships
// Migration: v1 node.addDOMWidget + node.computeSize → v2 NodeHandle.addDOMWidget + WidgetHandle.setHeight
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
// ── Mock world (same pattern as bc-01.migration.test.ts) ──────────────────────
const mockGetComponent = vi.fn()
const mockEntitiesWith = vi.fn(() => [])
vi.mock('@/world/worldInstance', () => ({
getWorld: () => ({
getComponent: mockGetComponent,
entitiesWith: mockEntitiesWith,
setComponent: vi.fn(),
removeComponent: vi.fn()
})
}))
vi.mock('@/world/widgets/widgetComponents', () => ({
WidgetComponentContainer: Symbol('WidgetComponentContainer'),
WidgetComponentDisplay: Symbol('WidgetComponentDisplay'),
WidgetComponentSchema: Symbol('WidgetComponentSchema'),
WidgetComponentSerialize: Symbol('WidgetComponentSerialize'),
WidgetComponentValue: Symbol('WidgetComponentValue')
}))
vi.mock('@/world/entityIds', () => ({}))
vi.mock('@/world/componentKey', () => ({
defineComponentKey: (name: string) => ({ name })
}))
vi.mock('@/extension-api/node', () => ({}))
vi.mock('@/extension-api/widget', () => ({}))
vi.mock('@/extension-api/lifecycle', () => ({}))
import {
_clearExtensionsForTesting,
_setDispatchImplForTesting,
defineNodeExtension,
mountExtensionsForNode,
unmountExtensionsForNode
} from '@/services/extension-api-service'
import type { NodeEntityId } from '@/world/entityIds'
// ── V1 shim ───────────────────────────────────────────────────────────────────
// Minimal in-memory replica of v1 node.addDOMWidget + node.computeSize behavior.
interface V1DOMWidgetRecord {
name: string
type: string
element: HTMLElement
height: number
}
interface V1Node {
id: number
type: string
domWidgets: V1DOMWidgetRecord[]
computeSizeOverridden: boolean
computedSize: [number, number]
addDOMWidget(
name: string,
type: string,
element: HTMLElement,
opts?: { getHeight?: () => number }
): V1DOMWidgetRecord
_overrideComputeSize(fn: (out: [number, number]) => [number, number]): void
}
function createV1Node(id: number, type = 'TestNode'): V1Node {
const domWidgets: V1DOMWidgetRecord[] = []
return {
id,
type,
domWidgets,
computeSizeOverridden: false,
computedSize: [200, 100] as [number, number],
addDOMWidget(name, wtype, element, opts) {
const height = opts?.getHeight?.() ?? element.offsetHeight
const record: V1DOMWidgetRecord = { name, type: wtype, element, height }
domWidgets.push(record)
this.computedSize[1] += height
return record
},
_overrideComputeSize(fn) {
this.computeSizeOverridden = true
this.computedSize = fn(this.computedSize)
}
}
}
// ── Helpers ───────────────────────────────────────────────────────────────────
function makeNodeId(n: number): NodeEntityId {
return `node:graph-uuid-bc05-mig:${n}` as NodeEntityId
}
function stubNodeType(id: NodeEntityId, comfyClass = 'TestNode') {
mockGetComponent.mockImplementation((eid, key: { name: string }) => {
if (eid !== id) return undefined
if (key.name === 'NodeType') return { type: comfyClass, comfyClass }
return undefined
})
}
function makeDiv(height = 120): HTMLElement {
const el = document.createElement('div')
Object.defineProperty(el, 'offsetHeight', { value: height, configurable: true })
return el
}
const ALL_TEST_IDS = Array.from({ length: 12 }, (_, i) => makeNodeId(i + 1))
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.05 migration — custom DOM widgets and node sizing', () => {
let dispatchedCommands: Record<string, unknown>[]
beforeEach(() => {
vi.clearAllMocks()
dispatchedCommands = []
_clearExtensionsForTesting()
ALL_TEST_IDS.forEach((id) => unmountExtensionsForNode(id))
_setDispatchImplForTesting((cmd) => {
dispatchedCommands.push(cmd)
if (cmd.type === 'CreateWidget') {
return `widget:graph:${String(cmd.parentNodeId)}:${String(cmd.name)}`
}
return undefined
})
})
afterEach(() => {
_setDispatchImplForTesting(null)
})
describe('widget registration parity (S4.W2)', () => {
it('v1 addDOMWidget and v2 addDOMWidget both register a widget with the given name', () => {
const el = makeDiv()
// v1 pattern
const v1Node = createV1Node(1)
v1Node.addDOMWidget('editor', 'custom', el)
const v1Names = v1Node.domWidgets.map((w) => w.name)
// v2 pattern
const registeredNames: string[] = []
defineNodeExtension({
name: 'bc05.mig.register-parity',
nodeCreated(handle) {
const wh = handle.addDOMWidget({ name: 'editor', element: el })
registeredNames.push(wh.name)
}
})
const id = makeNodeId(1)
stubNodeType(id)
mountExtensionsForNode(id)
expect(registeredNames).toEqual(v1Names)
})
it('v1 opts.getHeight() value matches the v2 height option stored in the dispatch command', () => {
const el = makeDiv(0) // offsetHeight irrelevant
const reportedHeight = 200
// v1: getHeight callback
const v1Node = createV1Node(2)
v1Node.addDOMWidget('widget', 'custom', el, { getHeight: () => reportedHeight })
const v1Height = v1Node.domWidgets[0].height
// v2: explicit height option
defineNodeExtension({
name: 'bc05.mig.height-parity',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'widget', element: el, height: reportedHeight })
}
})
const id = makeNodeId(2)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmd = dispatchedCommands.find(
(c) => c.type === 'CreateWidget' && c.name === 'widget'
) as { options: { __domHeight: number } } | undefined
expect(createCmd?.options.__domHeight).toBe(v1Height)
})
it('v2 registers the same number of DOM widgets as v1 for a multi-widget node', () => {
// v1 pattern: two addDOMWidget calls
const v1Node = createV1Node(3)
v1Node.addDOMWidget('widgetA', 'custom', makeDiv(50))
v1Node.addDOMWidget('widgetB', 'custom', makeDiv(80))
const v1Count = v1Node.domWidgets.length
// v2 pattern
defineNodeExtension({
name: 'bc05.mig.multi-count',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'widgetA', element: makeDiv(50) })
handle.addDOMWidget({ name: 'widgetB', element: makeDiv(80) })
}
})
const id = makeNodeId(3)
stubNodeType(id)
mountExtensionsForNode(id)
const v2DomWidgets = dispatchedCommands.filter(
(c) => c.type === 'CreateWidget' && c.widgetType === 'DOM'
)
expect(v2DomWidgets).toHaveLength(v1Count)
})
})
describe('computeSize elimination (S2.N11)', () => {
it('v2 setHeight produces a SetWidgetOption command; v1 requires a computeSize override for the same effect', () => {
const el = makeDiv(100)
const newHeight = 400
// v1: manual computeSize override is required
const v1Node = createV1Node(4)
v1Node.addDOMWidget('widget', 'custom', el)
v1Node._overrideComputeSize((out) => [out[0], newHeight])
expect(v1Node.computeSizeOverridden).toBe(true)
// v2: no computeSize — just setHeight on the WidgetHandle
defineNodeExtension({
name: 'bc05.mig.no-compute-size',
nodeCreated(handle) {
const wh = handle.addDOMWidget({ name: 'widget', element: el })
wh.setHeight(newHeight)
}
})
const id = makeNodeId(4)
stubNodeType(id)
mountExtensionsForNode(id)
const heightCmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetOption' && c.key === '__domHeight' && c.value === newHeight
)
// v1 needed a computeSize override; v2 achieves the same via SetWidgetOption dispatch
expect(heightCmd).toBeDefined()
})
})
describe('cleanup parity', () => {
it('v1 requires manual removal in onRemoved; v2 auto-removes the element via scope disposal', () => {
const el = makeDiv()
document.body.appendChild(el)
// v1 pattern: manual teardown via onRemoved
let v1CleanedUp = false
const v1OnRemoved = () => {
el.remove()
v1CleanedUp = true
}
v1OnRemoved()
expect(v1CleanedUp).toBe(true)
// Re-attach for v2 test
document.body.appendChild(el)
expect(document.body.contains(el)).toBe(true)
// v2 pattern: auto-cleanup on scope dispose (via onScopeDispose in addDOMWidget)
defineNodeExtension({
name: 'bc05.mig.auto-cleanup',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'widget', element: el })
}
})
const id = makeNodeId(5)
stubNodeType(id)
mountExtensionsForNode(id)
unmountExtensionsForNode(id)
// Both v1 (manual) and v2 (auto) result in element absent after node removal
expect(document.body.contains(el)).toBe(false)
})
it('v2 auto-cleanup only removes the element registered via addDOMWidget, not unrelated elements', () => {
const registeredEl = makeDiv()
const unrelatedEl = makeDiv()
document.body.appendChild(registeredEl)
document.body.appendChild(unrelatedEl)
defineNodeExtension({
name: 'bc05.mig.scoped-cleanup',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'registered', element: registeredEl })
// unrelatedEl is NOT registered — must survive scope disposal
}
})
const id = makeNodeId(6)
stubNodeType(id)
mountExtensionsForNode(id)
unmountExtensionsForNode(id)
expect(document.body.contains(registeredEl)).toBe(false)
expect(document.body.contains(unrelatedEl)).toBe(true)
unrelatedEl.remove()
})
})
describe('Phase B deferred', () => {
it.todo(
// Phase B: requires real LiteGraph canvas + ECS DOM widget component.
'v1 computeSize override and v2 auto-computeSize produce identical node dimensions at render time (Phase B)'
)
it.todo(
// Phase B: requires WidgetComponentContainer wired.
'v1 node.widgets array and v2 NodeHandle.widgets() both include the DOM widget by name (Phase B)'
)
})
})

View File

@@ -0,0 +1,172 @@
// Category: BC.05 — Custom DOM widgets and node sizing
// DB cross-ref: S4.W2, S2.N11
// Exemplar: https://github.com/Lightricks/ComfyUI-LTXVideo/blob/main/web/js/sparse_track_editor.js#L218
// Surface: S4.W2 = node.addDOMWidget, S2.N11 = node.computeSize override
// compat-floor: blast_radius 5.45 ≥ 2.0 — MUST pass before v2 ships
// v1 contract: node.addDOMWidget(name, type, element, opts) + node.computeSize = function(out) { ... }
import { describe, expect, it, vi } from 'vitest'
import {
countEvidenceExcerpts,
createMiniComfyApp,
loadEvidenceSnippet,
runV1
} from '../harness'
// ── Minimal v1 DOM widget stub ────────────────────────────────────────────────
interface DOMWidget {
name: string
type: string
element: HTMLElement
height: number
}
interface V1NodeWithWidgets {
widgets: DOMWidget[]
}
function addDOMWidget(
node: V1NodeWithWidgets,
name: string,
type: string,
element: HTMLElement,
opts?: { getHeight?: () => number }
): DOMWidget {
const height = opts?.getHeight?.() ?? element.offsetHeight
const w: DOMWidget = { name, type, element, height }
node.widgets.push(w)
return w
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.05 v1 contract — custom DOM widgets and node sizing', () => {
describe('S4.W2 — node.addDOMWidget (synthetic)', () => {
it('widget returned by addDOMWidget has the given name', () => {
const node: V1NodeWithWidgets = { widgets: [] }
const el = document.createElement('div')
Object.defineProperty(el, 'offsetHeight', { value: 120, configurable: true })
const w = addDOMWidget(node, 'editor', 'custom', el)
expect(w.name).toBe('editor')
expect(node.widgets).toHaveLength(1)
})
it('opts.getHeight() is used when provided (override > offsetHeight)', () => {
const node: V1NodeWithWidgets = { widgets: [] }
const el = document.createElement('div')
Object.defineProperty(el, 'offsetHeight', { value: 120, configurable: true })
const w = addDOMWidget(node, 'editor', 'custom', el, { getHeight: () => 200 })
expect(w.height).toBe(200)
})
it('widget is accessible in node.widgets by name after registration', () => {
const node: V1NodeWithWidgets = { widgets: [] }
const el = document.createElement('div')
addDOMWidget(node, 'preview', 'dom', el)
const found = node.widgets.find((w) => w.name === 'preview')
expect(found).toBeDefined()
expect(found!.element).toBe(el)
})
it.todo(
'DOM element appended to document'
)
it.todo(
'canvas render triggers opts.onDraw(ctx)'
)
it.todo(
'graph reload persistence'
)
})
describe('S2.N11 — node.computeSize override (synthetic)', () => {
it('assigning node.computeSize = fn overrides the default', () => {
const node: Record<string, unknown> = {
computeSize: (_out: [number, number]) => [140, 80] as [number, number]
}
const custom = vi.fn((_out: [number, number]) => [300, 150] as [number, number])
node.computeSize = custom
const result = (node.computeSize as typeof custom)([0, 0])
expect(custom).toHaveBeenCalledOnce()
expect(result).toEqual([300, 150])
})
it('overridden computeSize receives out array and returns [w,h]', () => {
const out: [number, number] = [0, 0]
const node = {
computeSize: (o: [number, number]): [number, number] => {
o[0] = 256
o[1] = 192
return [256, 192]
}
}
const result = node.computeSize(out)
expect(result[0]).toBe(256)
expect(result[1]).toBe(192)
})
it('computeSize result accounts for DOM widget reserved height', () => {
const widgetHeight = 120
const baseHeight = 80
const node = {
computeSize: (_out: [number, number]): [number, number] => [200, baseHeight + widgetHeight]
}
const [, h] = node.computeSize([0, 0])
expect(h).toBe(baseHeight + widgetHeight)
})
it.todo(
'overridden computeSize is called by LiteGraph layout engine before rendering'
)
it.todo(
'computeSize override persists across graph load/reload if set in nodeCreated or beforeRegisterNodeDef'
)
})
describe('S4.W2 — evidence excerpts', () => {
it('S4.W2 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S4.W2')).toBeGreaterThan(0)
})
it('S4.W2 evidence snippet contains addDOMWidget fingerprint', () => {
const snippet = loadEvidenceSnippet('S4.W2', 0)
expect(snippet).toMatch(/addDOMWidget/i)
})
it('S4.W2 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S4.W2', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N11 — evidence excerpts', () => {
it('S2.N11 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N11')).toBeGreaterThan(0)
})
it('S2.N11 evidence snippet contains computeSize fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N11', 0)
expect(snippet).toMatch(/computeSize/i)
})
it('S2.N11 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N11', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
})

View File

@@ -0,0 +1,281 @@
// Category: BC.05 — Custom DOM widgets and node sizing
// DB cross-ref: S4.W2, S2.N11
// Exemplar: https://github.com/Lightricks/ComfyUI-LTXVideo/blob/main/web/js/sparse_track_editor.js#L218
// compat-floor: blast_radius 5.45 ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: NodeHandle.addDOMWidget(opts) — auto-hooks computeSize via WidgetHandle geometry
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
// ── Mock world (same pattern as bc-01.v2.test.ts) ────────────────────────────
const mockGetComponent = vi.fn()
const mockEntitiesWith = vi.fn(() => [])
vi.mock('@/world/worldInstance', () => ({
getWorld: () => ({
getComponent: mockGetComponent,
entitiesWith: mockEntitiesWith,
setComponent: vi.fn(),
removeComponent: vi.fn()
})
}))
vi.mock('@/world/widgets/widgetComponents', () => ({
WidgetComponentContainer: Symbol('WidgetComponentContainer'),
WidgetComponentDisplay: Symbol('WidgetComponentDisplay'),
WidgetComponentSchema: Symbol('WidgetComponentSchema'),
WidgetComponentSerialize: Symbol('WidgetComponentSerialize'),
WidgetComponentValue: Symbol('WidgetComponentValue')
}))
vi.mock('@/world/entityIds', () => ({}))
vi.mock('@/world/componentKey', () => ({
defineComponentKey: (name: string) => ({ name })
}))
vi.mock('@/extension-api/node', () => ({}))
vi.mock('@/extension-api/widget', () => ({}))
vi.mock('@/extension-api/lifecycle', () => ({}))
import {
_clearExtensionsForTesting,
_setDispatchImplForTesting,
defineNodeExtension,
mountExtensionsForNode,
unmountExtensionsForNode
} from '@/services/extension-api-service'
import type { NodeEntityId } from '@/world/entityIds'
// ── Helpers ───────────────────────────────────────────────────────────────────
function makeNodeId(n: number): NodeEntityId {
return `node:graph-uuid-bc05:${n}` as NodeEntityId
}
function stubNodeType(id: NodeEntityId, comfyClass = 'TestNode') {
mockGetComponent.mockImplementation((eid, key: { name: string }) => {
if (eid !== id) return undefined
if (key.name === 'NodeType') return { type: comfyClass, comfyClass }
return undefined
})
}
function makeDiv(height = 120): HTMLElement {
const el = document.createElement('div')
Object.defineProperty(el, 'offsetHeight', { value: height, configurable: true })
return el
}
const ALL_TEST_IDS = Array.from({ length: 10 }, (_, i) => makeNodeId(i + 1))
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.05 v2 contract — custom DOM widgets and node sizing', () => {
let dispatchedCommands: Record<string, unknown>[]
beforeEach(() => {
vi.clearAllMocks()
dispatchedCommands = []
_clearExtensionsForTesting()
ALL_TEST_IDS.forEach((id) => unmountExtensionsForNode(id))
_setDispatchImplForTesting((cmd) => {
dispatchedCommands.push(cmd)
// Return a synthetic widget entity ID for CreateWidget commands
if (cmd.type === 'CreateWidget') {
return `widget:graph:${String(cmd.parentNodeId)}:${String(cmd.name)}`
}
return undefined
})
})
afterEach(() => {
_setDispatchImplForTesting(null)
})
describe('NodeHandle.addDOMWidget(opts) — widget registration (S4.W2)', () => {
it('addDOMWidget dispatches a CreateWidget command with type "DOM" and the given name', () => {
const el = makeDiv()
defineNodeExtension({
name: 'bc05.v2.register',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'myEditor', element: el })
}
})
const id = makeNodeId(1)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmd = dispatchedCommands.find(
(c) => c.type === 'CreateWidget' && c.name === 'myEditor'
) as { widgetType: string } | undefined
expect(createCmd).toBeDefined()
expect(createCmd?.widgetType).toBe('DOM')
})
it('addDOMWidget returns a WidgetHandle with the correct name', () => {
let handleName: string | undefined
defineNodeExtension({
name: 'bc05.v2.handle-name',
nodeCreated(handle) {
const wh = handle.addDOMWidget({ name: 'preview', element: makeDiv() })
handleName = wh.name
}
})
const id = makeNodeId(2)
stubNodeType(id)
mountExtensionsForNode(id)
expect(handleName).toBe('preview')
})
it('addDOMWidget stores the DOM element reference in the options bag', () => {
const el = makeDiv()
defineNodeExtension({
name: 'bc05.v2.element-stored',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'canvas', element: el })
}
})
const id = makeNodeId(3)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmd = dispatchedCommands.find(
(c) => c.type === 'CreateWidget' && c.name === 'canvas'
) as { options: { __domElement: HTMLElement } } | undefined
expect(createCmd?.options.__domElement).toBe(el)
})
it('addDOMWidget uses the provided height option rather than offsetHeight when specified', () => {
const el = makeDiv(120) // offsetHeight = 120
const customHeight = 250
defineNodeExtension({
name: 'bc05.v2.custom-height',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'editor', element: el, height: customHeight })
}
})
const id = makeNodeId(4)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmd = dispatchedCommands.find(
(c) => c.type === 'CreateWidget' && c.name === 'editor'
) as { options: { __domHeight: number } } | undefined
expect(createCmd?.options.__domHeight).toBe(customHeight)
})
it('addDOMWidget falls back to element.offsetHeight when no height option is given', () => {
const el = makeDiv(88)
defineNodeExtension({
name: 'bc05.v2.fallback-height',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'preview', element: el })
}
})
const id = makeNodeId(5)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmd = dispatchedCommands.find(
(c) => c.type === 'CreateWidget' && c.name === 'preview'
) as { options: { __domHeight: number } } | undefined
expect(createCmd?.options.__domHeight).toBe(88)
})
it('DOM element is removed from the document when the node scope is disposed', () => {
const el = makeDiv()
document.body.appendChild(el)
expect(document.body.contains(el)).toBe(true)
defineNodeExtension({
name: 'bc05.v2.auto-cleanup',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'widget', element: el })
}
})
const id = makeNodeId(6)
stubNodeType(id)
mountExtensionsForNode(id)
// Unmounting the node scope triggers onScopeDispose → el.remove()
unmountExtensionsForNode(id)
expect(document.body.contains(el)).toBe(false)
})
})
describe('WidgetHandle geometry — setHeight (replaces S2.N11 computeSize override)', () => {
it('WidgetHandle.setHeight dispatches a SetWidgetOption command with key "__domHeight"', () => {
defineNodeExtension({
name: 'bc05.v2.set-height',
nodeCreated(handle) {
const wh = handle.addDOMWidget({ name: 'resizable', element: makeDiv(100) })
wh.setHeight(300)
}
})
const id = makeNodeId(7)
stubNodeType(id)
mountExtensionsForNode(id)
const setCmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetOption' && c.key === '__domHeight' && c.value === 300
)
expect(setCmd).toBeDefined()
})
it('multiple addDOMWidget calls each produce independent CreateWidget commands', () => {
defineNodeExtension({
name: 'bc05.v2.multi-widget',
nodeCreated(handle) {
handle.addDOMWidget({ name: 'widgetA', element: makeDiv(50) })
handle.addDOMWidget({ name: 'widgetB', element: makeDiv(80) })
}
})
const id = makeNodeId(8)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmds = dispatchedCommands.filter(
(c) => c.type === 'CreateWidget' && c.widgetType === 'DOM'
)
expect(createCmds).toHaveLength(2)
const names = createCmds.map((c) => c.name)
expect(names).toContain('widgetA')
expect(names).toContain('widgetB')
})
})
describe('Phase B deferred', () => {
it.todo(
// Phase B: requires LiteGraph canvas integration.
// Auto-computeSize integration needs the actual LiteGraph node to reflect WidgetHandle.setHeight — deferred to Phase B.
'WidgetHandle.setHeight() triggers a node relayout — the node height reflects the new widget reservation (Phase B)'
)
it.todo(
// Phase B: requires real ECS DOM widget component.
'addDOMWidget widget is accessible via NodeHandle.widgets() by name (Phase B — needs WidgetComponentContainer wired)'
)
})
})

View File

@@ -0,0 +1,42 @@
// Category: BC.06 — Custom canvas drawing (per-node and canvas-level)
// DB cross-ref: S2.N9, S3.C1, S3.C2
// Exemplar: https://github.com/kijai/ComfyUI-KJNodes/blob/main/web/js/setgetnodes.js#L1256
// compat-floor: blast_radius 5.25 ≥ 2.0 — MUST pass before v2 ships
// Migration: v1 node.onDrawForeground → v2 NodeHandle.onDraw (partial).
// S3.C1 / S3.C2 canvas-level overrides: no v2 migration path yet (D9 Phase C).
import { describe, it } from 'vitest'
describe('BC.06 migration — custom canvas drawing (per-node and canvas-level)', () => {
describe('per-node drawing migration (S2.N9)', () => {
it.todo(
'v1 node.onDrawForeground and v2 NodeHandle.onDraw both produce visually equivalent output on the canvas for the same drawing operations'
)
it.todo(
'draw callback in v2 fires the same number of times per second as v1 onDrawForeground for a static scene'
)
it.todo(
'v2 DrawContext.ctx is the same CanvasRenderingContext2D state as v1 receives (same transform, same clip)'
)
})
describe('auto-deregistration vs manual cleanup', () => {
it.todo(
'v1 onDrawForeground continues to fire after node removal if the reference is not cleared (leak); v2 onDraw is auto-removed'
)
it.todo(
'v2 auto-deregistration on node removal does not affect onDraw callbacks registered for other nodes'
)
})
describe('canvas-level override coexistence (S3.C1, S3.C2)', () => {
// COM-3668: Simon Tranter vetoed canvas-draw testing — no headless canvas renderer available.
// Canvas-level prototype override testing deferred post-D9 Phase C.
it.skip(
'extensions that replace LGraphCanvas.prototype methods in v1 continue to function alongside v2 NodeHandle.onDraw registrations without conflict'
)
it.skip(
'processContextMenu replacement in v1 is not disrupted by extensions migrated to v2 per-node APIs'
)
})
})

View File

@@ -0,0 +1,183 @@
// Category: BC.06 — Custom canvas drawing (per-node and canvas-level)
// DB cross-ref: S2.N9, S3.C1, S3.C2
// Exemplar: https://github.com/kijai/ComfyUI-KJNodes/blob/main/web/js/setgetnodes.js#L1256
// Surface: S2.N9 = node.onDrawForeground, S3.C1 = LGraphCanvas.prototype overrides, S3.C2 = ContextMenu replacement
// compat-floor: blast_radius 5.25 ≥ 2.0 — MUST pass before v2 ships
// v1 contract: node.onDrawForeground(ctx, area), LGraphCanvas.prototype.processContextMenu = ...,
// LGraphCanvas.prototype.drawNodeShape = ... etc.
// v1_scope_note: Simon Tranter (COM-3668) vetoed canvas drawing overrides as "too hacky/specific".
// S3.C* patterns tracked for blast-radius / strangler-fig planning only.
import { describe, expect, it } from 'vitest'
import {
countEvidenceExcerpts,
createMiniComfyApp,
loadEvidenceSnippet,
runV1
} from '../harness'
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.06 v1 contract — custom canvas drawing (per-node and canvas-level)', () => {
describe('S2.N9 — node.onDrawForeground (synthetic)', () => {
it('onDrawForeground callback is invoked with (ctx, visibleArea)', () => {
const mockCtx = { fillRect: () => {}, strokeRect: () => {} }
const mockArea = [0, 0, 800, 600]
const received: unknown[][] = []
const node = {
onDrawForeground(ctx: unknown, visibleArea: unknown) {
received.push([ctx, visibleArea])
}
}
node.onDrawForeground(mockCtx, mockArea)
expect(received).toHaveLength(1)
expect(received[0][0]).toBe(mockCtx)
expect(received[0][1]).toBe(mockArea)
})
it('ctx argument is the same object passed in (identity check)', () => {
const mockCtx = { fillRect: () => {} }
let capturedCtx: unknown
const node = {
onDrawForeground(ctx: unknown, _area: unknown) {
capturedCtx = ctx
}
}
node.onDrawForeground(mockCtx, [])
expect(capturedCtx).toBe(mockCtx)
})
it.todo(
'ctx passed to onDrawForeground is the same CanvasRenderingContext2D used by LiteGraph for the node layer'
)
it.todo(
'onDrawForeground is NOT called for nodes outside the visible area (culled by LiteGraph)'
)
it.todo(
'canvas transform (scale, translate) is already applied when onDrawForeground fires — coordinates are in graph space'
)
})
describe('S3.C1 — LGraphCanvas.prototype method overrides (synthetic)', () => {
it('overriding a prototype method changes behavior for all instances', () => {
interface MockCanvas { drawNodeShape(ctx: object, node: object): string }
const LGraphCanvasProto: MockCanvas = { drawNodeShape: () => 'default' }
LGraphCanvasProto.drawNodeShape = (_ctx, _node) => 'custom'
const instance = Object.create(LGraphCanvasProto) as MockCanvas
expect(instance.drawNodeShape({}, {})).toBe('custom')
})
it('last-writer-wins — two overrides, second wins', () => {
interface MockCanvas { drawNodeShape(ctx: object, node: object): string }
const LGraphCanvasProto: MockCanvas = { drawNodeShape: () => 'default' }
LGraphCanvasProto.drawNodeShape = () => 'first'
LGraphCanvasProto.drawNodeShape = () => 'second'
const instance = Object.create(LGraphCanvasProto) as MockCanvas
expect(instance.drawNodeShape({}, {})).toBe('second')
})
it.todo(
'actual canvas rendering with CanvasRenderingContext2D'
)
it.todo(
'real LiteGraph canvas instance shares the same prototype'
)
})
describe('S3.C2 — ContextMenu global replacement (synthetic)', () => {
it('replacing processContextMenu replaces the handler', () => {
interface MockCanvas { processContextMenu(event: object): string }
const LGraphCanvasProto: MockCanvas = { processContextMenu: () => 'default-menu' }
LGraphCanvasProto.processContextMenu = (_event) => 'custom-menu'
const instance = Object.create(LGraphCanvasProto) as MockCanvas
expect(instance.processContextMenu({})).toBe('custom-menu')
})
it('calling original inside wrapper preserves default entries (chain-call test)', () => {
const entries: string[] = []
interface MockCanvas { processContextMenu(event: object): void }
const LGraphCanvasProto: MockCanvas = {
processContextMenu(_event: object) {
entries.push('default')
}
}
const original = LGraphCanvasProto.processContextMenu.bind(LGraphCanvasProto)
LGraphCanvasProto.processContextMenu = function (event) {
entries.push('custom')
original(event)
}
const instance = Object.create(LGraphCanvasProto) as MockCanvas
instance.processContextMenu({})
expect(entries).toEqual(['custom', 'default'])
})
it.todo(
'actual canvas rendering'
)
it.todo(
'real LiteGraph canvas'
)
})
describe('S2.N9 — evidence excerpts', () => {
it('S2.N9 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N9')).toBeGreaterThan(0)
})
it('S2.N9 evidence snippet contains onDrawForeground fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N9', 0)
expect(snippet).toMatch(/onDrawForeground/i)
})
it('S2.N9 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N9', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S3.C1 — evidence excerpts', () => {
it('S3.C1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S3.C1')).toBeGreaterThan(0)
})
it('S3.C1 evidence snippet contains drawNodeShape or prototype fingerprint', () => {
const count = countEvidenceExcerpts('S3.C1')
let found = false
for (let i = 0; i < count; i++) {
const snippet = loadEvidenceSnippet('S3.C1', i)
if (/drawNodeShape|prototype/i.test(snippet)) {
found = true
break
}
}
expect(found, 'Expected at least one S3.C1 excerpt with drawNodeShape or prototype fingerprint').toBe(true)
})
it('S3.C1 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S3.C1', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S3.C2 — evidence excerpts', () => {
it.todo('S3.C2 evidence excerpts — pattern not yet in database snapshot')
})
})

View File

@@ -0,0 +1,43 @@
// Category: BC.06 — Custom canvas drawing (per-node and canvas-level)
// DB cross-ref: S2.N9, S3.C1, S3.C2
// Exemplar: https://github.com/kijai/ComfyUI-KJNodes/blob/main/web/js/setgetnodes.js#L1256
// compat-floor: blast_radius 5.25 ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: NodeHandle.onDraw(callback) for per-node drawing (S2.N9).
// Canvas-level overrides (S3.C1, S3.C2) are OUT OF v2 SCOPE — deferred to D9 Phase C.
// S3.C* stubs present for blast-radius tracking and strangler-fig planning.
import { describe, it } from 'vitest'
describe('BC.06 v2 contract — custom canvas drawing (per-node and canvas-level)', () => {
describe('NodeHandle.onDraw(callback) — per-node foreground drawing (S2.N9)', () => {
it.todo(
'NodeHandle.onDraw(cb) registers cb to be called once per render frame while the node is visible'
)
it.todo(
'callback receives a DrawContext with ctx (CanvasRenderingContext2D) and area (bounding rect) arguments'
)
it.todo(
'drawing operations in the callback appear in the same layer as v1 onDrawForeground (above node body)'
)
it.todo(
'the canvas transform is pre-applied when the callback fires — coordinates are in graph space, matching v1 behavior'
)
it.todo(
'callback registered via NodeHandle.onDraw() is automatically deregistered when the node is removed'
)
})
describe('canvas-level overrides — deferred (S3.C1, S3.C2)', () => {
// COM-3668: Simon Tranter vetoed canvas-draw testing — no headless canvas renderer available.
// Canvas-level prototype override testing deferred post-D9 Phase C.
it.skip(
'[D9 Phase C] v2 exposes no stable API for replacing LGraphCanvas.prototype.drawNodeShape — extensions using this pattern must remain on v1 shim'
)
it.skip(
'[D9 Phase C] v2 exposes no stable API for replacing processContextMenu — context-menu customization is deferred to the ComfyUI menu extension point'
)
it.skip(
'[D9 Phase C] blast-radius tracking: S3.C1 and S3.C2 overrides coexist with v2 per-node drawing without mutual interference'
)
})
})

View File

@@ -0,0 +1,231 @@
// Category: BC.07 — Connection observation, intercept, and veto
// DB cross-ref: S2.N3, S2.N12, S2.N13
// Exemplar: https://github.com/rgthree/rgthree-comfy/blob/main/web/comfyui/node_mode_relay.js#L90
// Migration: v1 prototype patching (onConnectInput/onConnectOutput/onConnectionsChange)
// → v2 node.on('connected') / node.on('disconnected')
//
// Phase A strategy: prove call-count parity between the two subscription styles
// using a synthetic event bus. Real graph-wiring and veto semantics need Phase B.
//
// I-TF.8.C1 — BC.07 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
import { effectScope, onScopeDispose } from 'vue'
import type { NodeConnectedEvent, NodeDisconnectedEvent, NodeEntityId, SlotEntityId, SlotDirection } from '@/extension-api/node'
import type { Unsubscribe } from '@/extension-api/events'
// ── V1 shim: prototype-assignment style ──────────────────────────────────────
// Models the v1 pattern where extensions assign methods to an LGraphNode-like
// prototype or instance. The "app" calls them directly.
interface V1NodeLike {
id: number
type: string
onConnectInput?: (slot: number, type: string) => boolean | void
onConnectOutput?: (slot: number, type: string) => boolean | void
onConnectionsChange?: (type: number, slot: number, connected: boolean) => void
}
function createV1App() {
const nodes: V1NodeLike[] = []
return {
addNode(node: V1NodeLike) { nodes.push(node) },
simulateConnectInput(nodeId: number, slot: number, type: string) {
const node = nodes.find((n) => n.id === nodeId)
return node?.onConnectInput?.(slot, type)
},
simulateConnectOutput(nodeId: number, slot: number, type: string) {
const node = nodes.find((n) => n.id === nodeId)
return node?.onConnectOutput?.(slot, type)
},
simulateConnectionsChange(nodeId: number, type: number, slot: number, connected: boolean) {
const node = nodes.find((n) => n.id === nodeId)
node?.onConnectionsChange?.(type, slot, connected)
}
}
}
// ── V2 shim: node.on() style ──────────────────────────────────────────────────
type EventName = 'connected' | 'disconnected'
function createV2NodeBus() {
const connectedHandlers: Array<(e: NodeConnectedEvent) => void> = []
const disconnectedHandlers: Array<(e: NodeDisconnectedEvent) => void> = []
function on(event: 'connected', fn: (e: NodeConnectedEvent) => void): Unsubscribe
function on(event: 'disconnected', fn: (e: NodeDisconnectedEvent) => void): Unsubscribe
function on(event: EventName, fn: (e: never) => void): Unsubscribe {
if (event === 'connected') {
connectedHandlers.push(fn as (e: NodeConnectedEvent) => void)
return () => {
const i = connectedHandlers.indexOf(fn as (e: NodeConnectedEvent) => void)
if (i !== -1) connectedHandlers.splice(i, 1)
}
}
disconnectedHandlers.push(fn as (e: NodeDisconnectedEvent) => void)
return () => {
const i = disconnectedHandlers.indexOf(fn as (e: NodeDisconnectedEvent) => void)
if (i !== -1) disconnectedHandlers.splice(i, 1)
}
}
function emitConnected(e: NodeConnectedEvent) {
for (const h of [...connectedHandlers]) h(e)
}
function emitDisconnected(e: NodeDisconnectedEvent) {
for (const h of [...disconnectedHandlers]) h(e)
}
return { on, emitConnected, emitDisconnected, connectedHandlers, disconnectedHandlers }
}
// ── Fixture helpers ───────────────────────────────────────────────────────────
function makeSlot(name: string, dir: SlotDirection) {
return {
entityId: 1 as unknown as SlotEntityId,
name,
type: 'IMAGE',
direction: dir,
nodeEntityId: 1 as unknown as NodeEntityId
} as const
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.07 migration — connection observation', () => {
describe('onConnectionsChange (S2.N3) → on("connected") / on("disconnected")', () => {
it('both v1 and v2 call their handlers the same number of times for the same events', () => {
const v1App = createV1App()
const bus = createV2NodeBus()
let v1Count = 0
let v2Count = 0
// v1: assign method on node instance
const node: V1NodeLike = {
id: 1,
type: 'KSampler',
onConnectionsChange(_type, _slot, _connected) { v1Count++ }
}
v1App.addNode(node)
// v2: register via on()
bus.on('connected', () => { v2Count++ })
bus.on('disconnected', () => { v2Count++ })
// Simulate 2 connect + 1 disconnect
v1App.simulateConnectionsChange(1, 1, 0, true) // input connected
v1App.simulateConnectionsChange(1, 0, 1, true) // output connected
v1App.simulateConnectionsChange(1, 0, 0, false) // input disconnected
bus.emitConnected({ slot: makeSlot('in', 'input'), remote: makeSlot('out', 'output') })
bus.emitConnected({ slot: makeSlot('in2', 'input'), remote: makeSlot('out2', 'output') })
bus.emitDisconnected({ slot: makeSlot('in', 'input') })
expect(v2Count).toBe(v1Count)
expect(v2Count).toBe(3)
})
it('v2 handler receives typed slot info; v1 received raw numeric slot index', () => {
const bus = createV2NodeBus()
let receivedSlotName: string | undefined
bus.on('connected', (e) => {
receivedSlotName = e.slot.name
})
bus.emitConnected({
slot: makeSlot('latent', 'input'),
remote: makeSlot('LATENT', 'output')
})
// v2 gives the slot name directly; v1 gave a numeric index that required
// the extension to call node.inputs[slotIndex] to resolve the name.
expect(receivedSlotName).toBe('latent')
})
})
describe('onConnectInput / onConnectOutput (S2.N12, S2.N13) → on("connected")', () => {
it('on("connected") fires once per link established, matching v1 onConnectInput call count', () => {
const v1App = createV1App()
const bus = createV2NodeBus()
const v1Calls: number[] = []
const v2Calls: string[] = []
const node: V1NodeLike = {
id: 2,
type: 'TestNode',
onConnectInput(slot) { v1Calls.push(slot) }
}
v1App.addNode(node)
bus.on('connected', (e) => { v2Calls.push(e.slot.name) })
// Simulate 2 input connections
v1App.simulateConnectInput(2, 0, 'IMAGE')
v1App.simulateConnectInput(2, 1, 'LATENT')
bus.emitConnected({ slot: makeSlot('image', 'input'), remote: makeSlot('img_out', 'output') })
bus.emitConnected({ slot: makeSlot('latent', 'input'), remote: makeSlot('lat_out', 'output') })
expect(v2Calls).toHaveLength(v1Calls.length)
expect(v2Calls).toHaveLength(2)
})
})
describe('scope and cleanup', () => {
it('v2 on() listener is removed when the EffectScope is stopped (v1 prototype patch persists)', () => {
const bus = createV2NodeBus()
const handler = vi.fn()
// Mount in a scope
const scope = effectScope()
scope.run(() => {
const unsub = bus.on('connected', handler)
onScopeDispose(unsub)
})
bus.emitConnected({ slot: makeSlot('in', 'input'), remote: makeSlot('out', 'output') })
expect(handler).toHaveBeenCalledOnce()
// Stopping scope triggers onScopeDispose → unsub
scope.stop()
bus.emitConnected({ slot: makeSlot('in', 'input'), remote: makeSlot('out', 'output') })
expect(handler).toHaveBeenCalledOnce() // no new call
// v1 contrast: prototype methods have no scope — they leak until the node object is GC'd
})
it('unsubscribing one v2 listener does not affect other listeners on the same bus', () => {
const bus = createV2NodeBus()
const handlerA = vi.fn()
const handlerB = vi.fn()
const unsubA = bus.on('connected', handlerA)
bus.on('connected', handlerB)
bus.emitConnected({ slot: makeSlot('in', 'input'), remote: makeSlot('out', 'output') })
unsubA()
bus.emitConnected({ slot: makeSlot('in', 'input'), remote: makeSlot('out', 'output') })
expect(handlerA).toHaveBeenCalledOnce()
expect(handlerB).toHaveBeenCalledTimes(2)
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.07 migration — connection observation [Phase B]', () => {
it.todo(
'[Phase B] v1 onConnectInput returning false and v2 veto equivalent both leave the graph unwired'
)
it.todo(
'[Phase B] type coercion in v1 onConnectInput matches type coercion in v2 connected handler'
)
it.todo(
'[Phase B] v1 onConnectOutput veto and v2 equivalent both prevent connectionChange from firing on either endpoint'
)
it.todo(
'[Phase B] v2 on("connected") fires at the same point in the link-wiring sequence as v1 onConnectionsChange (after graph mutation)'
)
})

View File

@@ -0,0 +1,256 @@
// Category: BC.07 — Connection observation, intercept, and veto
// DB cross-ref: S2.N3, S2.N12, S2.N13
// Exemplar: https://github.com/rgthree/rgthree-comfy/blob/main/web/comfyui/node_mode_relay.js#L90
// blast_radius: 5.46 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v1 contract: node.onConnectInput(slot, type, link, node, fromSlot)
// node.onConnectOutput(slot, type, link, node, toSlot)
// node.onConnectionsChange(type, slot, connected, link, ioSlot)
import { describe, expect, it } from 'vitest'
import {
countEvidenceExcerpts,
createMiniComfyApp,
loadEvidenceSnippet,
runV1
} from '../harness'
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.07 v1 contract — connection observation, intercept, and veto', () => {
describe('S2.N3 — onConnectionsChange: passive observation (synthetic)', () => {
it('callback fires when called with (type, slot, connected, link, ioSlot)', () => {
const received: unknown[][] = []
const node = {
onConnectionsChange(
type: number,
slot: number,
connected: boolean,
link: unknown,
ioSlot: unknown
) {
received.push([type, slot, connected, link, ioSlot])
}
}
const fakeLink = { id: 1, origin_id: 10, target_id: 20 }
const fakeIoSlot = { name: 'value', type: 'FLOAT' }
node.onConnectionsChange(1, 0, true, fakeLink, fakeIoSlot)
expect(received).toHaveLength(1)
expect(received[0]).toEqual([1, 0, true, fakeLink, fakeIoSlot])
})
it('fires for both source and target (simulate calling on each node in a pair)', () => {
const fired: string[] = []
const sourceNode = {
onConnectionsChange(_type: number, _slot: number, _connected: boolean, _link: unknown, _ioSlot: unknown) {
fired.push('source')
}
}
const targetNode = {
onConnectionsChange(_type: number, _slot: number, _connected: boolean, _link: unknown, _ioSlot: unknown) {
fired.push('target')
}
}
const fakeLink = { id: 2 }
sourceNode.onConnectionsChange(2, 0, true, fakeLink, undefined)
targetNode.onConnectionsChange(1, 0, true, fakeLink, undefined)
expect(fired).toEqual(['source', 'target'])
})
it.todo(
'real LiteGraph graph wiring'
)
it.todo(
'link object from LiteGraph'
)
})
describe('S2.N12 — onConnectInput: intercept and veto incoming connections (synthetic)', () => {
it('returning false from onConnectInput vetoes the connection', () => {
const node = {
onConnectInput(
_slot: number,
_type: string,
_link: unknown,
_sourceNode: unknown,
_sourceSlot: number
): boolean {
return false
}
}
const result = node.onConnectInput(0, 'FLOAT', {}, {}, 0)
const vetoed = result === false
expect(vetoed).toBe(true)
})
it('returning true allows connection', () => {
const node = {
onConnectInput(
_slot: number,
_type: string,
_link: unknown,
_sourceNode: unknown,
_sourceSlot: number
): boolean {
return true
}
}
const result = node.onConnectInput(0, 'FLOAT', {}, {}, 0)
expect(result).toBe(true)
})
it('receives (slot, type, link, sourceNode, sourceSlot) args', () => {
const received: unknown[] = []
const node = {
onConnectInput(
slot: number,
type: string,
link: unknown,
sourceNode: unknown,
sourceSlot: number
): boolean {
received.push(slot, type, link, sourceNode, sourceSlot)
return true
}
}
const fakeLink = { id: 3 }
const fakeSource = { id: 99 }
node.onConnectInput(2, 'IMAGE', fakeLink, fakeSource, 1)
expect(received).toEqual([2, 'IMAGE', fakeLink, fakeSource, 1])
})
it.todo(
'real LiteGraph graph wiring'
)
})
describe('S2.N13 — onConnectOutput: intercept and veto outgoing connections (synthetic)', () => {
it('returning false vetoes outgoing connection', () => {
const node = {
onConnectOutput(
_slot: number,
_type: string,
_link: unknown,
_targetNode: unknown,
_targetSlot: number
): boolean {
return false
}
}
const result = node.onConnectOutput(0, 'LATENT', {}, {}, 0)
expect(result).toBe(false)
})
it('veto means onConnectionsChange does NOT fire', () => {
let changesFired = false
const outputNode = {
onConnectOutput(
_slot: number,
_type: string,
_link: unknown,
_targetNode: unknown,
_targetSlot: number
): boolean {
return false
},
onConnectionsChange(_type: number, _slot: number, _connected: boolean, _link: unknown, _ioSlot: unknown) {
changesFired = true
}
}
const vetoed = outputNode.onConnectOutput(0, 'LATENT', {}, {}, 0) === false
if (!vetoed) {
outputNode.onConnectionsChange(2, 0, true, {}, undefined)
}
expect(changesFired).toBe(false)
})
it('returning false vetoes outgoing connection — same pattern as onConnectInput', () => {
const results: boolean[] = []
const nodeAllow = {
onConnectOutput(): boolean { return true }
}
const nodeVeto = {
onConnectOutput(): boolean { return false }
}
results.push(nodeAllow.onConnectOutput())
results.push(nodeVeto.onConnectOutput())
expect(results).toEqual([true, false])
})
it.todo(
'real LiteGraph graph wiring'
)
it.todo(
'link object from LiteGraph'
)
})
describe('S2.N3 — evidence excerpts', () => {
it('S2.N3 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N3')).toBeGreaterThan(0)
})
it('S2.N3 evidence snippet contains onConnectionsChange fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N3', 0)
expect(snippet).toMatch(/onConnectionsChange/i)
})
it('S2.N3 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N3', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N12 — evidence excerpts', () => {
it('S2.N12 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N12')).toBeGreaterThan(0)
})
it('S2.N12 evidence snippet contains onConnectInput fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N12', 0)
expect(snippet).toMatch(/onConnectInput/i)
})
it('S2.N12 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N12', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
describe('S2.N13 — evidence excerpts', () => {
it('S2.N13 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N13')).toBeGreaterThan(0)
})
it('S2.N13 evidence snippet contains onConnectOutput fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N13', 0)
expect(snippet).toMatch(/onConnectOutput/i)
})
it('S2.N13 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N13', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
})

View File

@@ -0,0 +1,237 @@
// Category: BC.07 — Connection observation, intercept, and veto
// DB cross-ref: S2.N3, S2.N12, S2.N13
// Exemplar: https://github.com/rgthree/rgthree-comfy/blob/main/web/comfyui/node_mode_relay.js#L90
// blast_radius: 5.46 — compat-floor: MUST pass before v2 ships
// v2 replacement: node.on('connected', handler), node.on('disconnected', handler)
//
// Phase A strategy: prove the registration contract (on() returns Unsubscribe,
// unsubscribe stops future calls, multiple listeners are independent) using a
// minimal typed event emitter that mirrors the service contract without the ECS
// dependency. Event-firing from real World mutations is marked todo(Phase B).
//
// I-TF.8.C1 — BC.07 v2 wired assertions.
import { describe, expect, it, vi } from 'vitest'
import type {
NodeConnectedEvent,
NodeDisconnectedEvent,
SlotEntityId,
NodeEntityId,
SlotDirection
} from '@/extension-api/node'
import type { Unsubscribe } from '@/extension-api/events'
// ── Minimal typed event emitter ───────────────────────────────────────────────
// Models the service's node.on() registration contract without ECS.
// The real service wires these to Vue watch() calls on World components (Phase B).
type SupportedEvent = 'connected' | 'disconnected'
interface HandlerEntry<E> {
handler: (event: E) => void
unsub: Unsubscribe
}
function createNodeEventBus() {
const connectedHandlers: HandlerEntry<NodeConnectedEvent>[] = []
const disconnectedHandlers: HandlerEntry<NodeDisconnectedEvent>[] = []
function on(event: 'connected', handler: (e: NodeConnectedEvent) => void): Unsubscribe
function on(event: 'disconnected', handler: (e: NodeDisconnectedEvent) => void): Unsubscribe
function on(event: SupportedEvent, handler: (e: never) => void): Unsubscribe {
if (event === 'connected') {
const entry: HandlerEntry<NodeConnectedEvent> = {
handler: handler as (e: NodeConnectedEvent) => void,
unsub: () => {
const idx = connectedHandlers.indexOf(entry)
if (idx !== -1) connectedHandlers.splice(idx, 1)
}
}
connectedHandlers.push(entry)
return entry.unsub
} else {
const entry: HandlerEntry<NodeDisconnectedEvent> = {
handler: handler as (e: NodeDisconnectedEvent) => void,
unsub: () => {
const idx = disconnectedHandlers.indexOf(entry)
if (idx !== -1) disconnectedHandlers.splice(idx, 1)
}
}
disconnectedHandlers.push(entry)
return entry.unsub
}
}
function emitConnected(event: NodeConnectedEvent) {
for (const { handler } of [...connectedHandlers]) handler(event)
}
function emitDisconnected(event: NodeDisconnectedEvent) {
for (const { handler } of [...disconnectedHandlers]) handler(event)
}
return { on, emitConnected, emitDisconnected }
}
// ── Fixture helpers ───────────────────────────────────────────────────────────
function makeSlotId(n: number) { return n as unknown as SlotEntityId }
function makeNodeId(n: number) { return n as unknown as NodeEntityId }
function makeSlot(name: string, dir: SlotDirection, nodeId = makeNodeId(1)) {
return {
entityId: makeSlotId(Math.random() * 1e9 | 0),
name,
type: 'IMAGE',
direction: dir,
nodeEntityId: nodeId
} as const
}
function makeConnectedEvent(localName = 'input', remoteName = 'output'): NodeConnectedEvent {
return {
slot: makeSlot(localName, 'input'),
remote: makeSlot(remoteName, 'output', makeNodeId(2))
}
}
function makeDisconnectedEvent(slotName = 'input'): NodeDisconnectedEvent {
return { slot: makeSlot(slotName, 'input') }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.07 v2 contract — connection observation', () => {
describe('node.on("connected") — registration shape', () => {
it('on("connected", fn) returns an Unsubscribe function', () => {
const bus = createNodeEventBus()
const unsub = bus.on('connected', () => {})
expect(typeof unsub).toBe('function')
})
it('registered handler is called when a connected event fires', () => {
const bus = createNodeEventBus()
const handler = vi.fn()
bus.on('connected', handler)
bus.emitConnected(makeConnectedEvent())
expect(handler).toHaveBeenCalledOnce()
})
it('handler receives a NodeConnectedEvent with slot and remote fields', () => {
const bus = createNodeEventBus()
let received: NodeConnectedEvent | undefined
bus.on('connected', (e) => { received = e })
const evt = makeConnectedEvent('image_in', 'image_out')
bus.emitConnected(evt)
expect(received).toBeDefined()
expect(received!.slot.name).toBe('image_in')
expect(received!.remote.name).toBe('image_out')
expect(received!.slot.direction).toBe('input')
expect(received!.remote.direction).toBe('output')
})
it('calling Unsubscribe prevents future connected events from reaching the handler', () => {
const bus = createNodeEventBus()
const handler = vi.fn()
const unsub = bus.on('connected', handler)
bus.emitConnected(makeConnectedEvent())
expect(handler).toHaveBeenCalledOnce()
unsub()
bus.emitConnected(makeConnectedEvent())
expect(handler).toHaveBeenCalledOnce() // no new call
})
it('calling Unsubscribe twice is safe (idempotent)', () => {
const bus = createNodeEventBus()
const unsub = bus.on('connected', vi.fn())
expect(() => { unsub(); unsub() }).not.toThrow()
})
it('multiple handlers all fire; unsubscribing one does not affect the others', () => {
const bus = createNodeEventBus()
const handlerA = vi.fn()
const handlerB = vi.fn()
const handlerC = vi.fn()
const unsubA = bus.on('connected', handlerA)
bus.on('connected', handlerB)
bus.on('connected', handlerC)
bus.emitConnected(makeConnectedEvent())
expect(handlerA).toHaveBeenCalledOnce()
expect(handlerB).toHaveBeenCalledOnce()
expect(handlerC).toHaveBeenCalledOnce()
unsubA()
bus.emitConnected(makeConnectedEvent())
expect(handlerA).toHaveBeenCalledOnce() // still just once
expect(handlerB).toHaveBeenCalledTimes(2)
expect(handlerC).toHaveBeenCalledTimes(2)
})
})
describe('node.on("disconnected") — registration shape', () => {
it('on("disconnected", fn) returns an Unsubscribe function', () => {
const bus = createNodeEventBus()
const unsub = bus.on('disconnected', () => {})
expect(typeof unsub).toBe('function')
})
it('handler receives a NodeDisconnectedEvent with a slot field', () => {
const bus = createNodeEventBus()
let received: NodeDisconnectedEvent | undefined
bus.on('disconnected', (e) => { received = e })
const evt = makeDisconnectedEvent('latent_in')
bus.emitDisconnected(evt)
expect(received).toBeDefined()
expect(received!.slot.name).toBe('latent_in')
})
it('Unsubscribe prevents future disconnected events', () => {
const bus = createNodeEventBus()
const handler = vi.fn()
const unsub = bus.on('disconnected', handler)
bus.emitDisconnected(makeDisconnectedEvent())
unsub()
bus.emitDisconnected(makeDisconnectedEvent())
expect(handler).toHaveBeenCalledOnce()
})
})
describe('connected vs disconnected isolation', () => {
it('connected listener does not fire on disconnected events', () => {
const bus = createNodeEventBus()
const connectedFn = vi.fn()
const disconnectedFn = vi.fn()
bus.on('connected', connectedFn)
bus.on('disconnected', disconnectedFn)
bus.emitDisconnected(makeDisconnectedEvent())
expect(connectedFn).not.toHaveBeenCalled()
expect(disconnectedFn).toHaveBeenCalledOnce()
bus.emitConnected(makeConnectedEvent())
expect(connectedFn).toHaveBeenCalledOnce()
expect(disconnectedFn).toHaveBeenCalledOnce()
})
})
})
// ── Phase B stubs — need real ECS World + reactive dispatch ───────────────────
describe('BC.07 v2 contract — connection observation [Phase B]', () => {
it.todo(
'[Phase B] node.on("connected") fires when a real link is added to the World via ECS command'
)
it.todo(
'[Phase B] node.on("disconnected") fires when a link is removed from the World'
)
it.todo(
'[Phase B] handler registered via on() is removed by scope.stop() (onScopeDispose integration)'
)
it.todo(
'[Phase B] veto/intercept: returning false from connectInput handler prevents the link from being wired (if adopted in Phase B API)'
)
it.todo(
'[Phase B] type coercion: mutating event type inside a connection handler is reflected in the wired link'
)
})

View File

@@ -0,0 +1,38 @@
// Category: BC.08 — Programmatic linking
// DB cross-ref: S10.D2
// Exemplar: https://github.com/goodtab/ComfyUI-Custom-Scripts/blob/main/web/js/quickNodes.js#L138
// Migration: v1 node.connect/disconnectInput → v2 NodeHandle.connect/disconnectInput (typed handles)
import { describe, it } from 'vitest'
describe('BC.08 migration — programmatic linking', () => {
describe('connect() equivalence', () => {
it.todo(
'v1 node.connect(srcSlot, targetNode, dstSlot) and v2 NodeHandle.connect(srcSlot, targetHandle, dstSlot) produce identical graph link state'
)
it.todo(
'link id returned by v2 connect() matches the id on the underlying LGraph link created by an equivalent v1 call'
)
it.todo(
'v2 connect() with a type-incompatible pair raises a typed error; v1 returns null — callers must handle both forms during migration'
)
})
describe('disconnectInput() equivalence', () => {
it.todo(
'v1 node.disconnectInput(slot) and v2 NodeHandle.disconnectInput(slotIndex) both leave the graph with no link on that slot'
)
it.todo(
'onConnectionsChange (v1) and on(\'connectionChange\') (v2) both fire for the same disconnect operation with equivalent payload data'
)
})
describe('handle vs. raw node reference', () => {
it.todo(
'v2 NodeHandle.connect() accepts a NodeHandle for targetHandle; passing a raw LGraphNode instance throws a deprecation error'
)
it.todo(
'NodeHandle obtained from v2 nodeCreated correctly wraps the same node that v1 connect() would operate on'
)
})
})

View File

@@ -0,0 +1,40 @@
// Category: BC.08 — Programmatic linking
// DB cross-ref: S10.D2
// Exemplar: https://github.com/goodtab/ComfyUI-Custom-Scripts/blob/main/web/js/quickNodes.js#L138
// blast_radius: 5.99 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v1 contract: node.connect(srcSlot, targetNode, dstSlot)
// node.disconnectInput(slot)
import { describe, it } from 'vitest'
describe('BC.08 v1 contract — programmatic linking', () => {
describe('S10.D2 — node.connect(srcSlot, targetNode, dstSlot)', () => {
it.todo(
'node.connect(srcSlot, targetNode, dstSlot) creates a link between the source output slot and the target input slot'
)
it.todo(
'connect() returns the newly created link object with a stable numeric id'
)
it.todo(
'connect() on an already-occupied input slot replaces the existing link without leaving a dangling reference'
)
it.todo(
'connect() with a type-incompatible slot pair is rejected and returns null without modifying the graph'
)
it.todo(
'onConnectionsChange fires on both the source and target node after a successful connect() call'
)
})
describe('S10.D2 — node.disconnectInput(slot)', () => {
it.todo(
'node.disconnectInput(slot) removes the link on the specified input slot and updates both endpoint nodes'
)
it.todo(
'disconnectInput() on an empty slot is a no-op and does not throw'
)
it.todo(
'onConnectionsChange fires on both the source and target node after disconnectInput() removes a link'
)
})
})

View File

@@ -0,0 +1,39 @@
// Category: BC.08 — Programmatic linking
// DB cross-ref: S10.D2
// Exemplar: https://github.com/goodtab/ComfyUI-Custom-Scripts/blob/main/web/js/quickNodes.js#L138
// blast_radius: 5.99 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: NodeHandle.connect(slotIndex, targetHandle, dstSlot) — same semantics, typed handles
import { describe, it } from 'vitest'
describe('BC.08 v2 contract — programmatic linking', () => {
describe('NodeHandle.connect(slotIndex, targetHandle, dstSlot) — create links', () => {
it.todo(
'NodeHandle.connect(slotIndex, targetHandle, dstSlot) creates a link between the source output slot and the target input slot'
)
it.todo(
'connect() returns a LinkHandle with a stable id that matches the underlying graph link id'
)
it.todo(
'connect() on an already-occupied input slot replaces the existing link and the old LinkHandle becomes invalid'
)
it.todo(
'connect() with a type-incompatible slot pair throws a typed error and leaves the graph unchanged'
)
it.todo(
'on(\'connectionChange\') fires on both NodeHandles after a successful connect() call'
)
})
describe('NodeHandle.disconnectInput(slotIndex) — remove links', () => {
it.todo(
'NodeHandle.disconnectInput(slotIndex) removes the link on the specified input slot and the returned LinkHandle becomes invalid'
)
it.todo(
'disconnectInput() on an empty slot is a no-op and does not throw'
)
it.todo(
'on(\'connectionChange\') fires on both source and target NodeHandles after disconnectInput() removes a link'
)
})
})

View File

@@ -0,0 +1,201 @@
// Category: BC.09 — Dynamic slot and output mutation
// DB cross-ref: S10.D1, S10.D3, S15.OS1
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/lib/litegraph/src/canvas/LinkConnector.core.test.ts#L121
// Migration: v1 positional addInput/removeInput/addOutput/removeOutput + manual setSize
// → v2 NodeHandle slot mutation API (not yet on surface — see gap below)
//
// Phase A findings:
// NodeHandle has inputs()/outputs() (read-only). Slot mutation methods
// (addInput/removeInput/addOutput/removeOutput) are NOT on NodeHandle yet.
// This file tests:
// (a) v1 LGraphNode-style slot mutation shape (documenting the pattern)
// (b) v2 read-surface parity for existing slots
// (c) gap documentation for mutation equivalence (Phase B)
//
// I-TF.8.C2 — BC.09 migration wired assertions.
import { describe, expect, it } from 'vitest'
import type { SlotInfo, NodeEntityId, SlotEntityId } from '@/extension-api/node'
// ── V1 LGraphNode slot shim ───────────────────────────────────────────────────
// Models the v1 pattern: node.addInput(name, type) appends to node.inputs array;
// node.addOutput(name, type) appends to node.outputs array.
// setSize([w, h]) is manual after slot mutation.
interface V1Slot { name: string; type: string }
function createV1Node(type = 'TestNode') {
const inputs: V1Slot[] = []
const outputs: V1Slot[] = []
let size: [number, number] = [200, 100]
const BASE_ROW_HEIGHT = 24
return {
type,
get inputs() { return inputs },
get outputs() { return outputs },
get size() { return size },
addInput(name: string, slotType: string) { inputs.push({ name, type: slotType }) },
addOutput(name: string, slotType: string) { outputs.push({ name, type: slotType }) },
removeInput(index: number) { inputs.splice(index, 1) },
removeOutput(index: number) { outputs.splice(index, 1) },
setSize(s: [number, number]) { size = s },
computeSize(): [number, number] {
const rows = Math.max(inputs.length, outputs.length)
return [200, Math.max(100, rows * BASE_ROW_HEIGHT + 40)]
}
}
}
// ── V2 read surface shim ──────────────────────────────────────────────────────
// Minimal model of the part of NodeHandle that exists today: inputs()/outputs().
// Mutation is a gap — see Phase B stubs.
function makeSlotInfo(name: string, type: string, direction: 'input' | 'output'): SlotInfo {
return {
entityId: (Math.random() * 1e9 | 0) as unknown as SlotEntityId,
name,
type,
direction,
nodeEntityId: 1 as unknown as NodeEntityId
}
}
function createV2ReadSurface(initialInputs: SlotInfo[], initialOutputs: SlotInfo[]) {
const inputs = [...initialInputs]
const outputs = [...initialOutputs]
return {
inputs: () => inputs as readonly SlotInfo[],
outputs: () => outputs as readonly SlotInfo[]
}
}
// ── Wired migration tests (Phase A — read surface) ────────────────────────────
describe('BC.09 migration — dynamic slot and output mutation', () => {
describe('v1 slot mutation shape documentation (S10.D1)', () => {
it('v1 node.addInput(name, type) appends a slot at the end of node.inputs', () => {
const node = createV1Node()
expect(node.inputs).toHaveLength(0)
node.addInput('image', 'IMAGE')
node.addInput('mask', 'MASK')
expect(node.inputs).toHaveLength(2)
expect(node.inputs[0]).toEqual({ name: 'image', type: 'IMAGE' })
expect(node.inputs[1]).toEqual({ name: 'mask', type: 'MASK' })
})
it('v1 node.addOutput(name, type) appends a slot at the end of node.outputs (S10.D3)', () => {
const node = createV1Node()
node.addOutput('LATENT', 'LATENT')
node.addOutput('IMAGE', 'IMAGE')
expect(node.outputs).toHaveLength(2)
expect(node.outputs[0].name).toBe('LATENT')
expect(node.outputs[1].name).toBe('IMAGE')
})
it('v1 removeInput(index) splices by position — order matters', () => {
const node = createV1Node()
node.addInput('a', 'IMAGE')
node.addInput('b', 'LATENT')
node.addInput('c', 'MASK')
node.removeInput(1) // remove 'b' by position
expect(node.inputs).toHaveLength(2)
expect(node.inputs[0].name).toBe('a')
expect(node.inputs[1].name).toBe('c')
})
it('v1 requires manual setSize after addInput to avoid slot overlap', () => {
const node = createV1Node()
const initialSize = node.size[1]
node.addInput('extra', 'IMAGE')
// Without setSize, height is unchanged — this is the v1 footgun
expect(node.size[1]).toBe(initialSize)
// Manual fix: call computeSize + setSize
node.setSize(node.computeSize())
expect(node.size[1]).toBeGreaterThanOrEqual(initialSize)
})
})
describe('v2 read surface parity — inputs() / outputs() shape', () => {
it('v2 inputs() returns the same count as v1 node.inputs after equivalent setup', () => {
// v1 path
const v1 = createV1Node()
v1.addInput('image', 'IMAGE')
v1.addInput('mask', 'MASK')
// v2 path: pre-populated (mutation API gap — see Phase B)
const v2 = createV2ReadSurface(
[
makeSlotInfo('image', 'IMAGE', 'input'),
makeSlotInfo('mask', 'MASK', 'input')
],
[]
)
expect(v2.inputs()).toHaveLength(v1.inputs.length)
expect(v2.inputs()).toHaveLength(2)
})
it('v2 outputs() returns the same count as v1 node.outputs after equivalent setup', () => {
const v1 = createV1Node()
v1.addOutput('LATENT', 'LATENT')
const v2 = createV2ReadSurface([], [
makeSlotInfo('LATENT', 'LATENT', 'output')
])
expect(v2.outputs()).toHaveLength(v1.outputs.length)
})
it('v2 SlotInfo direction field distinguishes inputs from outputs (v1 relies on array membership)', () => {
const v2 = createV2ReadSurface(
[makeSlotInfo('image', 'IMAGE', 'input')],
[makeSlotInfo('LATENT', 'LATENT', 'output')]
)
const allInputs = v2.inputs()
const allOutputs = v2.outputs()
for (const s of allInputs) expect(s.direction).toBe('input')
for (const s of allOutputs) expect(s.direction).toBe('output')
})
it('v2 SlotInfo.name is stable identity (v1 used positional index — fragile)', () => {
const v2 = createV2ReadSurface(
[
makeSlotInfo('image', 'IMAGE', 'input'),
makeSlotInfo('mask', 'MASK', 'input')
],
[]
)
// Name-based access is safe even if order changes in future
const byName = (name: string) => v2.inputs().find((s) => s.name === name)
expect(byName('image')?.type).toBe('IMAGE')
expect(byName('mask')?.type).toBe('MASK')
})
})
describe('[gap] Slot mutation migration — Phase B required', () => {
it.todo(
'[gap] v2 NodeHandle.addInput({ name, type }) equivalent to v1 node.addInput(name, type) — ' +
'addInput/removeInput not yet on NodeHandle surface (src/extension-api/node.ts). Phase B gap.'
)
it.todo(
'[gap] v2 NodeHandle.removeInput(name) equivalent to v1 node.removeInput(index) — name-based vs positional. Phase B gap.'
)
it.todo(
'[gap] v2 addOutput / removeOutput equivalents. Phase B gap.'
)
it.todo(
'[gap] v2 auto-reflow eliminates the need for v1 setSize(computeSize()) after slot mutation. Phase B gap.'
)
})
})

View File

@@ -0,0 +1,191 @@
// Category: BC.09 — Dynamic slot and output mutation
// DB cross-ref: S10.D1, S10.D3, S15.OS1
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/lib/litegraph/src/canvas/LinkConnector.core.test.ts#L121
// blast_radius: 6.03 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v1 contract: node.addInput(name, type), node.removeInput(slot)
// node.addOutput(name, type), node.removeOutput(slot)
// node.setSize([w, h])
import { describe, it, expect } from 'vitest'
type Slot = { name: string; type: string; link?: number | null }
type OutputSlot = { name: string; type: string; links?: number[] }
function makeNode() {
const inputs: Slot[] = []
const outputs: OutputSlot[] = []
const size: [number, number] = [200, 100]
return {
inputs,
outputs,
size,
addInput(name: string, type: string) {
inputs.push({ name, type, link: null })
},
removeInput(slot: number) {
inputs.splice(slot, 1)
},
addOutput(name: string, type: string) {
outputs.push({ name, type, links: [] })
},
removeOutput(slot: number) {
outputs.splice(slot, 1)
},
setSize(s: [number, number]) {
size[0] = s[0]
size[1] = s[1]
},
computeSize(): [number, number] {
const slotHeight = 20
const rows = Math.max(inputs.length, outputs.length, 1)
return [size[0], rows * slotHeight + 40]
},
}
}
describe('BC.09 v1 contract — dynamic slot and output mutation', () => {
describe('S10.D1 — addInput / removeInput', () => {
it('node.addInput(name, type) appends a new input slot to node.inputs and increments node.inputs.length', () => {
const node = makeNode()
expect(node.inputs).toHaveLength(0)
node.addInput('latent', 'LATENT')
expect(node.inputs).toHaveLength(1)
expect(node.inputs[0].name).toBe('latent')
expect(node.inputs[0].type).toBe('LATENT')
})
it('node.removeInput(slot) removes the slot at the given index and shifts subsequent slots down by one', () => {
const node = makeNode()
node.addInput('a', 'INT')
node.addInput('b', 'FLOAT')
node.addInput('c', 'STRING')
// Remove middle slot
node.removeInput(1)
expect(node.inputs).toHaveLength(2)
expect(node.inputs[0].name).toBe('a')
expect(node.inputs[1].name).toBe('c')
})
it('removing an input slot that has an active link also removes the corresponding link from the graph', () => {
const graph = { links: new Map<number, { id: number; target_id: number; target_slot: number }>() }
const node = { id: 10, inputs: [{ name: 'img', type: 'IMAGE', link: 99 }] as Slot[] }
graph.links.set(99, { id: 99, target_id: 10, target_slot: 0 })
// v1 pattern: remove slot and clean up the link
const removedLink = node.inputs[0].link
node.inputs.splice(0, 1)
if (removedLink !== null && removedLink !== undefined) {
graph.links.delete(removedLink)
}
expect(node.inputs).toHaveLength(0)
expect(graph.links.has(99)).toBe(false)
})
it('addInput with a duplicate name appends a second slot without error (v1 allows duplicates)', () => {
const node = makeNode()
node.addInput('image', 'IMAGE')
node.addInput('image', 'IMAGE')
expect(node.inputs).toHaveLength(2)
expect(node.inputs[0].name).toBe('image')
expect(node.inputs[1].name).toBe('image')
})
})
describe('S10.D3 — addOutput / removeOutput', () => {
it('node.addOutput(name, type) appends a new output slot to node.outputs and increments node.outputs.length', () => {
const node = makeNode()
node.addOutput('IMAGE', 'IMAGE')
expect(node.outputs).toHaveLength(1)
expect(node.outputs[0].name).toBe('IMAGE')
expect(node.outputs[0].type).toBe('IMAGE')
})
it('node.removeOutput(slot) removes the output slot and detaches all outgoing links on that slot', () => {
const graph = { links: new Map<number, unknown>() }
const node = {
outputs: [
{ name: 'IMAGE', type: 'IMAGE', links: [5, 6] },
{ name: 'MASK', type: 'MASK', links: [] },
] as OutputSlot[],
}
graph.links.set(5, {})
graph.links.set(6, {})
// v1 pattern: clear outgoing links, then splice
const slot = node.outputs[0]
for (const linkId of slot.links ?? []) {
graph.links.delete(linkId)
}
node.outputs.splice(0, 1)
expect(node.outputs).toHaveLength(1)
expect(node.outputs[0].name).toBe('MASK')
expect(graph.links.has(5)).toBe(false)
expect(graph.links.has(6)).toBe(false)
})
it('removing an output slot does not affect links on other output slots of the same node', () => {
const graph = { links: new Map<number, unknown>() }
const node = {
outputs: [
{ name: 'A', type: 'INT', links: [1] },
{ name: 'B', type: 'INT', links: [2, 3] },
] as OutputSlot[],
}
graph.links.set(1, {})
graph.links.set(2, {})
graph.links.set(3, {})
// Remove first output slot only
for (const linkId of node.outputs[0].links ?? []) {
graph.links.delete(linkId)
}
node.outputs.splice(0, 1)
expect(node.outputs).toHaveLength(1)
expect(graph.links.has(1)).toBe(false)
expect(graph.links.has(2)).toBe(true)
expect(graph.links.has(3)).toBe(true)
})
})
describe('S15.OS1 — computeSize / setSize reflow', () => {
it('node.setSize([w, h]) updates node.size to the provided dimensions immediately', () => {
const node = makeNode()
node.setSize([350, 220])
expect(node.size[0]).toBe(350)
expect(node.size[1]).toBe(220)
})
it('addInput/addOutput followed by node.setSize([...node.computeSize()]) produces a node tall enough to display all slots without overlap', () => {
const node = makeNode()
node.addInput('a', 'INT')
node.addInput('b', 'FLOAT')
node.addInput('c', 'STRING')
node.addOutput('result', 'INT')
const computed = node.computeSize()
node.setSize([...computed])
// 3 input rows × 20px + 40px padding = 100px minimum
expect(node.size[1]).toBeGreaterThanOrEqual(3 * 20)
})
it('setSize does not trigger a canvas redraw synchronously; redraw occurs on the next animation frame', () => {
const drawCalls: string[] = []
const node = makeNode()
// Simulate the canvas draw loop — setSize only mutates size[], not draw
const mockCanvas = {
draw() { drawCalls.push('draw') }
}
node.setSize([400, 300])
// Canvas draw was not called as part of setSize
expect(drawCalls).toHaveLength(0)
// Only when the canvas loop runs does it draw
mockCanvas.draw()
expect(drawCalls).toHaveLength(1)
})
})
})

View File

@@ -0,0 +1,198 @@
// Category: BC.09 — Dynamic slot and output mutation
// DB cross-ref: S10.D1, S10.D3, S15.OS1
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/lib/litegraph/src/canvas/LinkConnector.core.test.ts#L121
// blast_radius: 6.03 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
//
// Phase A findings:
// NodeHandle exposes inputs() and outputs() as read-only slot arrays (stable).
// Slot MUTATION (addInput/removeInput/addOutput/removeOutput) is NOT yet on the
// NodeHandle surface — this is a documented gap for Phase B.
// See: src/extension-api/node.ts — no addInput/removeInput methods present.
//
// Tests here prove the read surface contract that IS available today.
// Mutation and auto-reflow cases are in the Phase B block at the bottom.
import { describe, expect, it } from 'vitest'
import type { NodeHandle, SlotInfo } from '@/extension-api/node'
// ── Synthetic NodeHandle stub ─────────────────────────────────────────────────
// Minimal implementation of the NodeHandle slot surface for Phase A assertions.
function makeSlotInfo(overrides: Partial<SlotInfo> = {}): SlotInfo {
return {
entityId: 1 as SlotInfo['entityId'],
name: 'input_0',
type: 'LATENT',
direction: 'input',
nodeEntityId: 10 as SlotInfo['nodeEntityId'],
...overrides
}
}
function makeNodeHandleWithSlots(
inputs: SlotInfo[],
outputs: SlotInfo[]
): Pick<NodeHandle, 'inputs' | 'outputs'> {
return {
inputs: () => inputs,
outputs: () => outputs
}
}
// ── Wired assertions (Phase A — read surface) ─────────────────────────────────
describe('BC.09 v2 contract — dynamic slot and output mutation', () => {
describe('NodeHandle.inputs() — read-only slot array shape', () => {
it('inputs() returns a readonly array of SlotInfo objects', () => {
const slots = [
makeSlotInfo({ name: 'image', type: 'IMAGE', direction: 'input' }),
makeSlotInfo({ name: 'mask', type: 'MASK', direction: 'input', entityId: 2 as SlotInfo['entityId'] })
]
const handle = makeNodeHandleWithSlots(slots, [])
const result = handle.inputs()
expect(result).toHaveLength(2)
expect(result[0].name).toBe('image')
expect(result[0].type).toBe('IMAGE')
expect(result[0].direction).toBe('input')
})
it('inputs() returns an empty array when the node has no input slots', () => {
const handle = makeNodeHandleWithSlots([], [])
expect(handle.inputs()).toHaveLength(0)
expect(Array.isArray(handle.inputs())).toBe(true)
})
it('each SlotInfo has the required fields: entityId, name, type, direction, nodeEntityId', () => {
const nodeId = 42 as SlotInfo['nodeEntityId']
const slot = makeSlotInfo({ name: 'latent', type: 'LATENT', nodeEntityId: nodeId })
const handle = makeNodeHandleWithSlots([slot], [])
const [s] = handle.inputs()
expect(s).toHaveProperty('entityId')
expect(s).toHaveProperty('name', 'latent')
expect(s).toHaveProperty('type', 'LATENT')
expect(s).toHaveProperty('direction', 'input')
expect(s).toHaveProperty('nodeEntityId', nodeId)
})
it('direction is always "input" for slots returned by inputs()', () => {
const slots = [
makeSlotInfo({ name: 'a', direction: 'input' }),
makeSlotInfo({ name: 'b', direction: 'input', entityId: 2 as SlotInfo['entityId'] })
]
const handle = makeNodeHandleWithSlots(slots, [])
for (const s of handle.inputs()) {
expect(s.direction).toBe('input')
}
})
it('inputs() is stable across repeated calls (same reference contents)', () => {
const slots = [makeSlotInfo({ name: 'x' })]
const handle = makeNodeHandleWithSlots(slots, [])
const first = handle.inputs()
const second = handle.inputs()
expect(first).toHaveLength(second.length)
expect(first[0].name).toBe(second[0].name)
})
})
describe('NodeHandle.outputs() — read-only slot array shape', () => {
it('outputs() returns a readonly array of SlotInfo objects', () => {
const slots = [
makeSlotInfo({ name: 'LATENT', type: 'LATENT', direction: 'output' }),
makeSlotInfo({ name: 'IMAGE', type: 'IMAGE', direction: 'output', entityId: 2 as SlotInfo['entityId'] })
]
const handle = makeNodeHandleWithSlots([], slots)
const result = handle.outputs()
expect(result).toHaveLength(2)
expect(result[0].name).toBe('LATENT')
expect(result[1].name).toBe('IMAGE')
})
it('outputs() returns an empty array when the node has no output slots', () => {
const handle = makeNodeHandleWithSlots([], [])
expect(handle.outputs()).toHaveLength(0)
})
it('direction is always "output" for slots returned by outputs()', () => {
const slots = [
makeSlotInfo({ name: 'out', direction: 'output' }),
makeSlotInfo({ name: 'out2', direction: 'output', entityId: 2 as SlotInfo['entityId'] })
]
const handle = makeNodeHandleWithSlots([], slots)
for (const s of handle.outputs()) {
expect(s.direction).toBe('output')
}
})
it('inputs() and outputs() are independent arrays — do not share references', () => {
const shared = makeSlotInfo({ name: 'shared' })
const inSlot = { ...shared, direction: 'input' as const }
const outSlot = { ...shared, direction: 'output' as const, entityId: 2 as SlotInfo['entityId'] }
const handle = makeNodeHandleWithSlots([inSlot], [outSlot])
expect(handle.inputs()[0].direction).toBe('input')
expect(handle.outputs()[0].direction).toBe('output')
})
})
describe('[gap] Slot mutation API — not yet on NodeHandle surface', () => {
it.todo(
'[gap] addInput(name, type) — not present on NodeHandle v2 surface; gap documented for Phase B. ' +
'See: src/extension-api/node.ts NodeHandle interface (no addInput method). ' +
'Phase B: add addInput/removeInput/addOutput/removeOutput dispatching CreateSlot/RemoveSlot ECS commands.'
)
it.todo(
'[gap] removeInput(name) — same gap; Phase B required'
)
it.todo(
'[gap] addOutput(name, type) — same gap; Phase B required'
)
it.todo(
'[gap] removeOutput(name) — same gap; Phase B required'
)
})
})
// ── Phase B stubs — ECS dispatch + auto-reflow ────────────────────────────────
describe('BC.09 v2 contract — dynamic slot mutation [Phase B]', () => {
describe('addInput / addOutput dispatch', () => {
it.todo(
'NodeHandle.addInput({ name, type }) dispatches CreateInputSlot command and returns a SlotInfo with stable entityId'
)
it.todo(
'NodeHandle.addOutput({ name, type }) dispatches CreateOutputSlot command and the new slot appears in outputs()'
)
it.todo(
'addInput with a duplicate name throws a typed DuplicateSlotError'
)
})
describe('removeInput / removeOutput dispatch', () => {
it.todo(
'NodeHandle.removeInput(name) dispatches RemoveInputSlot; slot no longer appears in inputs()'
)
it.todo(
'NodeHandle.removeOutput(name) dispatches RemoveOutputSlot; any links on that slot are detached'
)
it.todo(
'removeInput(name) on a non-existent slot name throws a typed SlotNotFoundError'
)
})
describe('auto-reflow (replaces S15.OS1 manual setSize)', () => {
it.todo(
'after addInput() the node size is automatically reflowed to fit all slots — no manual setSize required'
)
it.todo(
'after removeOutput() the node height shrinks to remove the vacated slot space'
)
it.todo(
'auto-reflow does not trigger a synchronous canvas redraw; redraw occurs on the next animation frame'
)
})
})

View File

@@ -0,0 +1,229 @@
// Category: BC.10 — Widget value subscription
// DB cross-ref: S4.W1, S2.N14
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/widgetInputs.ts#L317
// Migration: v1 widget.callback chain-patching / node.onWidgetChanged
// → v2 widget.on('valueChange', fn)
//
// Key migration facts:
// 1. v1 event name: (no named event — direct callback assignment)
// v2 event name: 'valueChange' (NOT 'change')
// 2. v1 payload: positional args (value, app, node, pos, event)
// v2 payload: typed object { newValue, oldValue }
// 3. v1 S2.N14 (node.onWidgetChanged) has no direct v2 equivalent.
// Migration: subscribe per-widget via widget.on('valueChange').
// 4. v1 and v2 listeners operate independently; both fire for the same
// logical change in a mixed-mode (parallel-paths) app (D6 Phase A).
import { shallowRef } from 'vue'
import { describe, expect, it, vi } from 'vitest'
import type { WidgetValueChangeEvent } from '@/extension-api/widget'
import type { Unsubscribe } from '@/extension-api/events'
// ── Shared mock: one widget object that supports BOTH v1 and v2 subscriptions ─
// Models the parallel-paths Phase A world where both v1 and v2 extensions
// are active on the same widget simultaneously (D6).
interface V1Widget {
name: string
value: unknown
callback?: (value: unknown, app?: unknown, node?: unknown) => void
}
interface MockWidgetHandle {
name: string
getValue<T = unknown>(): T
setValue(value: unknown): void
on(event: 'valueChange', handler: (e: WidgetValueChangeEvent) => void): Unsubscribe
}
function createDualWidget(name: string, initial: unknown = '') {
const valueRef = shallowRef(initial)
const v2Listeners: Array<(e: WidgetValueChangeEvent) => void> = []
// v1 shape
const v1: V1Widget = { name, value: initial }
// v2 shape
const v2: MockWidgetHandle = {
name,
getValue<T>() { return valueRef.value as T },
setValue(newValue: unknown) {
const oldValue = valueRef.value
if (newValue === oldValue) return
valueRef.value = newValue
v1.value = newValue
// Fire v2 listeners
const event: WidgetValueChangeEvent = { newValue, oldValue }
for (const fn of v2Listeners) fn(event)
},
on(_event: 'valueChange', handler: (e: WidgetValueChangeEvent) => void): Unsubscribe {
v2Listeners.push(handler)
return () => {
const idx = v2Listeners.indexOf(handler)
if (idx !== -1) v2Listeners.splice(idx, 1)
}
}
}
// Simulate LiteGraph calling v1 callback (Phase A: explicit in tests)
function simulateV1Change(newValue: unknown, node?: unknown): void {
const old = v1.value
v1.value = newValue
v1.callback?.(newValue, undefined, node)
// In Phase A the v1 and v2 paths are separate; v2.setValue must be called
// explicitly to trigger v2 listeners. In production (post-Phase B) the
// reactive bridge will do this automatically.
v2.setValue(newValue)
void old
}
return { v1, v2, simulateV1Change }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.10 migration — widget value subscription', () => {
describe('widget.callback → widget.on(\'valueChange\') — payload shape migration (S4.W1)', () => {
it('v1 callback and v2 valueChange handler both fire with the new value for the same interaction', () => {
const { v1, v2, simulateV1Change } = createDualWidget('steps', 20)
const v1Received: unknown[] = []
const v2Received: WidgetValueChangeEvent[] = []
v1.callback = (val) => v1Received.push(val)
v2.on('valueChange', (e) => v2Received.push(e))
simulateV1Change(30)
expect(v1Received).toEqual([30])
expect(v2Received).toHaveLength(1)
expect(v2Received[0].newValue).toBe(30)
})
it('v2 payload is { newValue, oldValue } — v1 payload is positional args; both carry the same new value', () => {
const { v1, v2, simulateV1Change } = createDualWidget('cfg', 7)
let v1Value: unknown
let v2Event: WidgetValueChangeEvent | undefined
v1.callback = (val) => { v1Value = val }
v2.on('valueChange', (e) => { v2Event = e })
simulateV1Change(8)
// v1: first positional arg is the new value
expect(v1Value).toBe(8)
// v2: named object with both new and old
expect(v2Event).toEqual({ newValue: 8, oldValue: 7 })
})
it("v2 event is named 'valueChange' — the v1 pattern has no event name (direct callback assign)", () => {
// Documenting the migration: the v2 string literal is 'valueChange', not 'change'.
// Extension authors migrating from v1 must use the correct name.
const { v2 } = createDualWidget('sampler', 'euler')
const handler = vi.fn()
// Correct v2 event name:
v2.on('valueChange', handler)
v2.setValue('dpm')
expect(handler).toHaveBeenCalledOnce()
})
it('v1 chain-patching and v2 on(\'valueChange\') do not interfere: each operates independently', () => {
const { v1, v2, simulateV1Change } = createDualWidget('seed', 0)
const v1Order: string[] = []
const v2Order: string[] = []
// v1: chain-patch
const orig = v1.callback
v1.callback = function (val, a, n) {
v1Order.push('v1-outer')
orig?.call(this, val, a, n)
}
// v2: independent subscription
v2.on('valueChange', () => v2Order.push('v2-listener'))
simulateV1Change(1)
expect(v1Order).toEqual(['v1-outer'])
expect(v2Order).toEqual(['v2-listener'])
})
})
describe('node.onWidgetChanged → per-widget on(\'valueChange\') — S2.N14 migration', () => {
it('v1 onWidgetChanged and v2 per-widget valueChange both fire for the same widget change', () => {
const { v1, v2, simulateV1Change } = createDualWidget('steps', 20)
const v1NodeCalls: Array<{ name: string; value: unknown }> = []
const v2Calls: WidgetValueChangeEvent[] = []
const node = {
onWidgetChanged: (name: string, value: unknown) => v1NodeCalls.push({ name, value })
}
// v1: node-level subscription (fires at the node level)
v1.callback = (val) => { node.onWidgetChanged(v1.name, val) }
// v2: per-widget subscription
v2.on('valueChange', (e) => v2Calls.push(e))
simulateV1Change(30)
expect(v1NodeCalls).toHaveLength(1)
expect(v1NodeCalls[0]).toEqual({ name: 'steps', value: 30 })
expect(v2Calls).toHaveLength(1)
expect(v2Calls[0].newValue).toBe(30)
})
it('v2 migration: observe all widgets on a node via per-widget subscriptions (replaces single onWidgetChanged)', () => {
const stepW = createDualWidget('steps', 20)
const cfgW = createDualWidget('cfg', 7.0)
const nodeChanges: Array<{ name: string; newValue: unknown }> = []
// v2 migration: subscribe individually — no single node-level event
stepW.v2.on('valueChange', (e) => nodeChanges.push({ name: 'steps', newValue: e.newValue }))
cfgW.v2.on('valueChange', (e) => nodeChanges.push({ name: 'cfg', newValue: e.newValue }))
stepW.v2.setValue(25)
cfgW.v2.setValue(8.0)
expect(nodeChanges).toEqual([
{ name: 'steps', newValue: 25 },
{ name: 'cfg', newValue: 8.0 }
])
})
})
describe('scope disposal isolation', () => {
it('disposing one extension\'s listener does not remove another extension\'s listener on the same widget', () => {
const { v2 } = createDualWidget('steps', 20)
const ext1 = vi.fn()
const ext2 = vi.fn()
const unsub1 = v2.on('valueChange', ext1)
v2.on('valueChange', ext2)
// Ext1 unsubscribes (scope disposed)
unsub1()
v2.setValue(30)
expect(ext1).not.toHaveBeenCalled()
expect(ext2).toHaveBeenCalledOnce()
})
it('v1 chain-patch survival: removing v2 listener does not break v1 chain', () => {
const { v1, v2, simulateV1Change } = createDualWidget('cfg', 7)
const v1Handler = vi.fn()
const v2Handler = vi.fn()
const origCb = v1.callback
v1.callback = function (val, a, n) {
v1Handler(val)
origCb?.call(this, val, a, n)
}
const unsub = v2.on('valueChange', v2Handler)
unsub() // remove v2 listener only
simulateV1Change(8)
expect(v1Handler).toHaveBeenCalledWith(8) // v1 chain intact
expect(v2Handler).not.toHaveBeenCalled() // v2 removed
})
})
})

View File

@@ -0,0 +1,207 @@
// Category: BC.10 — Widget value subscription
// DB cross-ref: S4.W1, S2.N14
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/widgetInputs.ts#L317
// blast_radius: 5.09 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v1 contract: widget.callback = function(value, ...) { ... } (chain-patching)
// node.onWidgetChanged = function(name, value, ...) { ... }
//
// Harness model (Phase A):
// v1 patterns are synthetic — a plain object with .callback and .value.
// Tests call widget.callback(newValue) directly (as LiteGraph would).
// Real LiteGraph invocation requires Phase B eval sandbox.
import { describe, expect, it, vi } from 'vitest'
import {
countEvidenceExcerpts,
loadEvidenceSnippet
} from '../harness'
// ── Minimal v1 widget stub ────────────────────────────────────────────────────
interface V1Widget {
name: string
value: unknown
callback?: (value: unknown, app?: unknown, node?: unknown) => void
}
function createV1Widget(name: string, value: unknown = ''): V1Widget {
return { name, value }
}
// Simulate LiteGraph calling widget.callback when the user changes a value.
function simulateUserChange(widget: V1Widget, newValue: unknown, node?: unknown): void {
widget.value = newValue
widget.callback?.(newValue, undefined, node)
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.10 v1 contract — widget value subscription', () => {
describe('S4.W1 — widget.callback assignment', () => {
it('assigning widget.callback invokes the function with the new value on user interaction', () => {
const widget = createV1Widget('steps', 20)
const handler = vi.fn()
widget.callback = handler
simulateUserChange(widget, 30)
expect(handler).toHaveBeenCalledOnce()
expect(handler).toHaveBeenCalledWith(30, undefined, undefined)
})
it('chain-patching preserves the previous callback: saving old ref and calling it at the end', () => {
const widget = createV1Widget('cfg', 7)
const originalCb = vi.fn()
widget.callback = originalCb
// Extension chain-patches: save original, wrap it.
const patchOrder: string[] = []
const origRef = widget.callback
widget.callback = function (value, app, node) {
patchOrder.push('new')
origRef?.call(this, value, app, node)
}
simulateUserChange(widget, 8)
expect(patchOrder).toEqual(['new'])
expect(originalCb).toHaveBeenCalledOnce()
expect(originalCb).toHaveBeenCalledWith(8, undefined, undefined)
})
it('widget.callback receives (value, app, node, pos, event) — first arg is new value', () => {
const widget = createV1Widget('sampler', 'euler')
const received: unknown[] = []
widget.callback = (...args: unknown[]) => received.push(...args)
const fakeApp = { name: 'app' }
const fakeNode = { id: 42 }
widget.value = 'dpm'
widget.callback('dpm', fakeApp, fakeNode)
expect(received[0]).toBe('dpm')
expect(received[1]).toBe(fakeApp)
expect(received[2]).toBe(fakeNode)
})
it('if multiple extensions chain-patch widget.callback, all callbacks fire in last-patched-first order', () => {
const widget = createV1Widget('steps', 10)
const order: string[] = []
// Extension A patches first
const origA = widget.callback
widget.callback = function (v, a, n) {
order.push('A')
origA?.call(this, v, a, n)
}
// Extension B patches second (outermost)
const origB = widget.callback
widget.callback = function (v, a, n) {
order.push('B')
origB?.call(this, v, a, n)
}
simulateUserChange(widget, 20)
// B is outermost (last patched), calls B → A
expect(order).toEqual(['B', 'A'])
})
it('widget.callback is not invoked when the value does not change (LiteGraph does not call callback for no-ops)', () => {
// This tests the harness model: callback is only invoked when the user
// actually changes the value. The harness calls it explicitly on change.
const widget = createV1Widget('seed', 42)
const handler = vi.fn()
widget.callback = handler
// No change — we do NOT call simulateUserChange, so callback should not fire.
expect(handler).not.toHaveBeenCalled()
expect(widget.value).toBe(42)
})
})
describe('S2.N14 — node.onWidgetChanged', () => {
it('node.onWidgetChanged is called with widget name, new value, old value, and widget reference', () => {
const widget = createV1Widget('steps', 20)
const handler = vi.fn()
const node = { onWidgetChanged: handler }
const oldValue = widget.value
simulateUserChange(widget, 30, node)
node.onWidgetChanged('steps', 30, oldValue, widget)
expect(handler).toHaveBeenCalledWith('steps', 30, 20, widget)
})
it('onWidgetChanged fires for any widget on the node, not only those with an explicit callback', () => {
const widgetA = createV1Widget('steps', 20)
const widgetB = createV1Widget('cfg', 7)
const handler = vi.fn()
const node = { onWidgetChanged: handler }
// widgetB has no .callback — but node.onWidgetChanged still fires.
const oldB = widgetB.value
widgetB.value = 8
node.onWidgetChanged('cfg', 8, oldB, widgetB)
expect(handler).toHaveBeenCalledOnce()
expect(handler).toHaveBeenCalledWith('cfg', 8, 7, widgetB)
})
it('multiple widgets on the same node each trigger onWidgetChanged independently', () => {
const widgets = [
createV1Widget('steps', 20),
createV1Widget('cfg', 7),
createV1Widget('seed', 0)
]
const calls: Array<[string, unknown]> = []
const node = {
onWidgetChanged: (name: string, value: unknown) => calls.push([name, value])
}
// Simulate changes to all three widgets
for (const w of widgets) {
const oldValue = w.value
const newValue = typeof w.value === 'number' ? (w.value as number) + 1 : 'changed'
w.value = newValue
node.onWidgetChanged(w.name, newValue, oldValue, w)
}
expect(calls).toHaveLength(3)
expect(calls[0][0]).toBe('steps')
expect(calls[1][0]).toBe('cfg')
expect(calls[2][0]).toBe('seed')
})
})
describe('S4.W1 — evidence excerpts', () => {
it('S4.W1 has at least one evidence excerpt in the database snapshot', () => {
expect(countEvidenceExcerpts('S4.W1')).toBeGreaterThan(0)
})
it('S4.W1 excerpt contains widget callback chain-patching fingerprint', () => {
// Find an excerpt that contains the chain-patch pattern.
// Not all S4.W1 excerpts are chain-patches (some are direct assigns);
// we search across available excerpts for the canonical fingerprint.
const count = countEvidenceExcerpts('S4.W1')
let found = false
for (let i = 0; i < count; i++) {
const snippet = loadEvidenceSnippet('S4.W1', i)
if (/callback|\.call\s*\(this/.test(snippet)) {
found = true
break
}
}
expect(found, 'Expected at least one S4.W1 excerpt with callback fingerprint').toBe(true)
})
it('S2.N14 has at least one evidence excerpt in the database snapshot', () => {
expect(countEvidenceExcerpts('S2.N14')).toBeGreaterThan(0)
})
it('S2.N14 excerpt contains onWidgetChanged fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N14', 0)
expect(snippet).toMatch(/onWidgetChanged/i)
})
})
})

View File

@@ -0,0 +1,181 @@
// Category: BC.10 — Widget value subscription
// DB cross-ref: S4.W1, S2.N14
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/widgetInputs.ts#L317
// blast_radius: 5.09 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: widget.on('valueChange', fn) — NOTE: event name is 'valueChange' not 'change'
//
// Harness model:
// createMockWidgetHandle() builds a minimal WidgetHandle-shaped object backed by
// a Vue shallowRef. Calling .setValue(v) updates the ref and notifies all
// 'valueChange' listeners synchronously (same tick). This proves the event
// contract without requiring the full ECS world (Phase B).
//
// S2.N14 note: NodeHandle.on('widgetChanged') does NOT exist in the v2 API.
// The v2 replacement for per-node widget observation is per-widget
// widget.on('valueChange'). Tests below reflect the real API surface.
import { shallowRef } from 'vue'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import type { WidgetValueChangeEvent } from '@/extension-api/widget'
import type { Unsubscribe } from '@/extension-api/events'
// ── Minimal mock WidgetHandle ─────────────────────────────────────────────────
interface MockWidgetHandle {
name: string
getValue<T = unknown>(): T
setValue(value: unknown): void
on(event: 'valueChange', handler: (e: WidgetValueChangeEvent) => void): Unsubscribe
}
function createMockWidgetHandle(name: string, initial: unknown = ''): MockWidgetHandle {
const valueRef = shallowRef(initial)
const listeners: Array<(e: WidgetValueChangeEvent) => void> = []
return {
name,
getValue<T>() { return valueRef.value as T },
setValue(newValue: unknown) {
const oldValue = valueRef.value
if (newValue === oldValue) return
valueRef.value = newValue
const event: WidgetValueChangeEvent = { newValue, oldValue }
for (const fn of listeners) fn(event)
},
on(_event: 'valueChange', handler: (e: WidgetValueChangeEvent) => void): Unsubscribe {
listeners.push(handler)
return () => {
const idx = listeners.indexOf(handler)
if (idx !== -1) listeners.splice(idx, 1)
}
}
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.10 v2 contract — widget value subscription', () => {
describe("widget.on('valueChange', fn) — per-widget subscription (S4.W1 replacement)", () => {
it("on('valueChange') fires with {newValue, oldValue} when setValue is called", () => {
const widget = createMockWidgetHandle('steps', 20)
const handler = vi.fn()
widget.on('valueChange', handler)
widget.setValue(30)
expect(handler).toHaveBeenCalledOnce()
expect(handler).toHaveBeenCalledWith({ newValue: 30, oldValue: 20 })
})
it('handler receives the correct oldValue even after multiple sequential changes', () => {
const widget = createMockWidgetHandle('seed', 0)
const received: WidgetValueChangeEvent[] = []
widget.on('valueChange', (e) => received.push(e))
widget.setValue(1)
widget.setValue(2)
widget.setValue(3)
expect(received).toHaveLength(3)
expect(received[0]).toEqual({ newValue: 1, oldValue: 0 })
expect(received[1]).toEqual({ newValue: 2, oldValue: 1 })
expect(received[2]).toEqual({ newValue: 3, oldValue: 2 })
})
it('multiple listeners on the same widget are all invoked in registration order', () => {
const widget = createMockWidgetHandle('cfg', 7)
const order: string[] = []
widget.on('valueChange', () => order.push('first'))
widget.on('valueChange', () => order.push('second'))
widget.on('valueChange', () => order.push('third'))
widget.setValue(8)
expect(order).toEqual(['first', 'second', 'third'])
})
it('unsubscribe return value removes the listener; subsequent changes do not invoke it', () => {
const widget = createMockWidgetHandle('sampler', 'euler')
const handler = vi.fn()
const unsubscribe = widget.on('valueChange', handler)
widget.setValue('dpm')
expect(handler).toHaveBeenCalledOnce()
unsubscribe()
widget.setValue('euler_a')
// Still only one call — handler was removed.
expect(handler).toHaveBeenCalledOnce()
})
it('unsubscribing one listener does not affect other listeners on the same widget', () => {
const widget = createMockWidgetHandle('steps', 10)
const removed = vi.fn()
const kept = vi.fn()
const unsub = widget.on('valueChange', removed)
widget.on('valueChange', kept)
unsub()
widget.setValue(20)
expect(removed).not.toHaveBeenCalled()
expect(kept).toHaveBeenCalledOnce()
})
it('handler does not fire when setValue is called with the same value (no-op change)', () => {
const widget = createMockWidgetHandle('denoise', 1.0)
const handler = vi.fn()
widget.on('valueChange', handler)
widget.setValue(1.0) // same value — should not fire
expect(handler).not.toHaveBeenCalled()
})
it('getValue() returns the current value after setValue', () => {
const widget = createMockWidgetHandle('prompt', 'hello')
widget.setValue('world')
expect(widget.getValue()).toBe('world')
})
})
describe('v2 API surface notes — S2.N14', () => {
// S2.N14 (onWidgetChanged) has no NodeHandle.on('widgetChanged') equivalent.
// The v2 replacement is per-widget widget.on('valueChange') subscriptions.
// A node-level "any widget changed" event is not in the v2 API surface.
it('all widgets on a node can be independently observed via per-widget subscriptions', () => {
const widgetA = createMockWidgetHandle('steps', 20)
const widgetB = createMockWidgetHandle('cfg', 7.0)
const nodeChanges: string[] = []
// v2: subscribe to each widget individually (replaces onWidgetChanged)
widgetA.on('valueChange', (e) => nodeChanges.push(`steps:${e.newValue}`))
widgetB.on('valueChange', (e) => nodeChanges.push(`cfg:${e.newValue}`))
widgetA.setValue(25)
widgetB.setValue(8.0)
widgetA.setValue(30)
expect(nodeChanges).toEqual(['steps:25', 'cfg:8', 'steps:30'])
})
it('unsubscribing from one widget does not affect observation of sibling widgets', () => {
const widgetA = createMockWidgetHandle('steps', 20)
const widgetB = createMockWidgetHandle('cfg', 7.0)
const handlerA = vi.fn()
const handlerB = vi.fn()
const unsubA = widgetA.on('valueChange', handlerA)
widgetB.on('valueChange', handlerB)
unsubA()
widgetA.setValue(25)
widgetB.setValue(8.0)
expect(handlerA).not.toHaveBeenCalled()
expect(handlerB).toHaveBeenCalledOnce()
})
})
})

View File

@@ -0,0 +1,345 @@
// Category: BC.11 — Widget imperative state writes
// DB cross-ref: S4.W4, S4.W5, S2.N16
// Exemplar: https://github.com/r-vage/ComfyUI_Eclipse/blob/main/js/eclipse-set-get.js#L9
// Migration: v1 direct property mutation (widget.value, widget.options.values, node.widgets.push/splice)
// → v2 WidgetHandle.setValue / setOption / NodeHandle.addWidget
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
// ── Mock world (same pattern as bc-01.migration.test.ts) ──────────────────────
const mockGetComponent = vi.fn()
const mockEntitiesWith = vi.fn(() => [])
vi.mock('@/world/worldInstance', () => ({
getWorld: () => ({
getComponent: mockGetComponent,
entitiesWith: mockEntitiesWith,
setComponent: vi.fn(),
removeComponent: vi.fn()
})
}))
vi.mock('@/world/widgets/widgetComponents', () => ({
WidgetComponentContainer: Symbol('WidgetComponentContainer'),
WidgetComponentDisplay: Symbol('WidgetComponentDisplay'),
WidgetComponentSchema: Symbol('WidgetComponentSchema'),
WidgetComponentSerialize: Symbol('WidgetComponentSerialize'),
WidgetComponentValue: Symbol('WidgetComponentValue')
}))
vi.mock('@/world/entityIds', () => ({}))
vi.mock('@/world/componentKey', () => ({
defineComponentKey: (name: string) => ({ name })
}))
vi.mock('@/extension-api/node', () => ({}))
vi.mock('@/extension-api/widget', () => ({}))
vi.mock('@/extension-api/lifecycle', () => ({}))
import {
_clearExtensionsForTesting,
_setDispatchImplForTesting,
defineNodeExtension,
mountExtensionsForNode,
unmountExtensionsForNode
} from '@/services/extension-api-service'
import type { NodeEntityId } from '@/world/entityIds'
// ── V1 widget shim ────────────────────────────────────────────────────────────
// Minimal replica of v1 widget direct-mutation pattern.
interface V1Widget {
name: string
value: unknown
callback?: ((v: unknown) => void) | undefined
options?: { values: unknown[] }
}
interface V1Node {
widgets: V1Widget[]
}
function createV1Widget(name: string, value: unknown): V1Widget {
return { name, value, callback: undefined }
}
function createV1ComboWidget(name: string, value: string, values: string[]): V1Widget {
return { name, value, callback: undefined, options: { values } }
}
function createV1Node(widgets: V1Widget[] = []): V1Node {
return { widgets }
}
// ── Helpers ───────────────────────────────────────────────────────────────────
function makeNodeId(n: number): NodeEntityId {
return `node:graph-uuid-bc11-mig:${n}` as NodeEntityId
}
function stubNodeType(id: NodeEntityId, comfyClass = 'TestNode') {
mockGetComponent.mockImplementation((eid, key: { name: string }) => {
if (eid !== id) return undefined
if (key.name === 'NodeType') return { type: comfyClass, comfyClass }
return undefined
})
}
const ALL_TEST_IDS = Array.from({ length: 8 }, (_, i) => makeNodeId(i + 1))
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.11 migration — widget imperative state writes', () => {
let dispatchedCommands: Record<string, unknown>[]
beforeEach(() => {
vi.clearAllMocks()
dispatchedCommands = []
_clearExtensionsForTesting()
ALL_TEST_IDS.forEach((id) => unmountExtensionsForNode(id))
_setDispatchImplForTesting((cmd) => {
dispatchedCommands.push(cmd)
if (cmd.type === 'CreateWidget') {
return `widget:graph:${String(cmd.parentNodeId)}:${String(cmd.name)}`
}
return undefined
})
})
afterEach(() => {
_setDispatchImplForTesting(null)
})
describe('widget.value → WidgetHandle.setValue() (S4.W4)', () => {
it('v1 direct assignment and v2 setValue() both record the new value', () => {
// v1: direct property mutation
const v1Widget = createV1Widget('steps', 20)
v1Widget.value = 30
const v1Result = v1Widget.value
// v2: dispatch-based setValue
let v2WidgetId: string | undefined
defineNodeExtension({
name: 'bc11.mig.set-value',
nodeCreated(handle) {
const wh = handle.addWidget('INT', 'steps', 20, {})
v2WidgetId = wh.entityId as string
wh.setValue(30)
}
})
const id = makeNodeId(1)
stubNodeType(id)
mountExtensionsForNode(id)
const setCmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetValue' && c.value === 30
) as { widgetId: string; value: unknown } | undefined
// Both recorded value 30; v2 does so via command dispatch
expect(v1Result).toBe(30)
expect(setCmd).toBeDefined()
expect(setCmd?.value).toBe(30)
expect(setCmd?.widgetId).toBe(v2WidgetId)
})
it('v1 direct assignment does not produce a dispatchable record; v2 setValue() always produces one', () => {
// v1: no command dispatch — just a property write
const v1Widget = createV1Widget('cfg', 7.0)
const v1CommandsBefore = dispatchedCommands.length
v1Widget.value = 8.5
const v1CommandsAfter = dispatchedCommands.length
// v1 produces zero dispatch commands
expect(v1CommandsAfter - v1CommandsBefore).toBe(0)
// v2: always dispatches
defineNodeExtension({
name: 'bc11.mig.set-value-dispatch',
nodeCreated(handle) {
const wh = handle.addWidget('FLOAT', 'cfg', 7.0, {})
wh.setValue(8.5)
}
})
const id = makeNodeId(2)
stubNodeType(id)
mountExtensionsForNode(id)
const setCmd = dispatchedCommands.find((c) => c.type === 'SetWidgetValue')
expect(setCmd).toBeDefined()
})
})
describe('widget.options.values → WidgetHandle.setOption({ values }) (S4.W5)', () => {
it('v1 options.values mutation and v2 setOption both replace the COMBO option list', () => {
const newValues = ['euler', 'dpm_2', 'lcm']
// v1: direct options mutation
const v1Widget = createV1ComboWidget('sampler', 'euler', ['euler', 'dpm_2'])
v1Widget.options!.values = newValues
expect(v1Widget.options!.values).toEqual(newValues)
// v2: setOption dispatch
defineNodeExtension({
name: 'bc11.mig.set-options',
nodeCreated(handle) {
const wh = handle.addWidget('COMBO', 'sampler', 'euler', { values: ['euler', 'dpm_2'] })
wh.setOption('values', newValues)
}
})
const id = makeNodeId(3)
stubNodeType(id)
mountExtensionsForNode(id)
const optCmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetOption' && c.key === 'values'
) as { value: unknown } | undefined
expect(optCmd).toBeDefined()
expect(optCmd?.value).toEqual(newValues)
})
it('both v1 and v2 option-set operations are independent per widget', () => {
// v1: two widgets, each with independent options mutation
const v1WidgetA = createV1ComboWidget('schedulerA', 'karras', ['karras', 'normal'])
const v1WidgetB = createV1ComboWidget('schedulerB', 'karras', ['karras', 'normal'])
v1WidgetA.options!.values = ['karras', 'exponential']
// B is unaffected
expect(v1WidgetB.options!.values).toEqual(['karras', 'normal'])
expect(v1WidgetA.options!.values).toEqual(['karras', 'exponential'])
// v2: same independence via named widget identity
defineNodeExtension({
name: 'bc11.mig.option-independence',
nodeCreated(handle) {
const whA = handle.addWidget('COMBO', 'schedulerA', 'karras', { values: ['karras', 'normal'] })
handle.addWidget('COMBO', 'schedulerB', 'karras', { values: ['karras', 'normal'] })
whA.setOption('values', ['karras', 'exponential'])
}
})
const id = makeNodeId(4)
stubNodeType(id)
mountExtensionsForNode(id)
const optCmds = dispatchedCommands.filter((c) => c.type === 'SetWidgetOption' && c.key === 'values')
// Only one setOption dispatch — for whA
expect(optCmds).toHaveLength(1)
})
})
describe('node.widgets.push/splice → NodeHandle.addWidget (S2.N16)', () => {
it('v1 push and v2 addWidget both result in a new widget with the expected name', () => {
// v1: push into node.widgets
const v1Node = createV1Node()
const v1NewWidget = createV1Widget('dynamic_lora', '')
v1Node.widgets.push(v1NewWidget)
const v1Names = v1Node.widgets.map((w) => w.name)
// v2: addWidget dispatch
const v2Names: string[] = []
defineNodeExtension({
name: 'bc11.mig.add-widget',
nodeCreated(handle) {
const wh = handle.addWidget('STRING', 'dynamic_lora', '', {})
v2Names.push(wh.name)
}
})
const id = makeNodeId(5)
stubNodeType(id)
mountExtensionsForNode(id)
expect(v1Names).toContain('dynamic_lora')
expect(v2Names).toContain('dynamic_lora')
})
it('v1 splice by index is position-dependent; v2 addWidget uses name-keyed identity (no drift)', () => {
// v1: positional splice — inserting before 'cfg' bumps 'cfg' index
const v1Node = createV1Node([
createV1Widget('steps', 20),
createV1Widget('cfg', 7.0)
])
// Insert at index 1 — cfg shifts to index 2
v1Node.widgets.splice(1, 0, createV1Widget('new_widget', 0))
expect(v1Node.widgets[2].name).toBe('cfg') // positional drift
expect(v1Node.widgets[1].name).toBe('new_widget')
// v2: addWidget uses name key — 'cfg' remains at key 'cfg' regardless of insertion order
const createCmds: Record<string, unknown>[] = []
defineNodeExtension({
name: 'bc11.mig.no-drift',
nodeCreated(handle) {
handle.addWidget('INT', 'steps', 20, {})
handle.addWidget('INT', 'new_widget', 0, {})
handle.addWidget('FLOAT', 'cfg', 7.0, {})
}
})
const id = makeNodeId(6)
stubNodeType(id)
mountExtensionsForNode(id)
const names = dispatchedCommands
.filter((c) => c.type === 'CreateWidget')
.map((c) => c.name)
// All three present; order is insertion order but names are stable
expect(names).toContain('cfg')
expect(names).toContain('steps')
expect(names).toContain('new_widget')
})
it('v2 addWidget returns a WidgetHandle that can immediately call setValue — no index lookup needed', () => {
defineNodeExtension({
name: 'bc11.mig.immediate-set',
nodeCreated(handle) {
const wh = handle.addWidget('INT', 'strength', 0, {})
wh.setValue(100)
}
})
const id = makeNodeId(7)
stubNodeType(id)
mountExtensionsForNode(id)
const setCmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetValue' && c.value === 100
)
expect(setCmd).toBeDefined()
})
it('v1 push requires manual index tracking; v2 addWidget returns handle directly — no index bookkeeping', () => {
// v1: to get the widget back after push, you track the index
const v1Node = createV1Node()
v1Node.widgets.push(createV1Widget('added', ''))
const v1ByIndex = v1Node.widgets[0] // must track index manually
expect(v1ByIndex.name).toBe('added')
// v2: handle returned from addWidget — no index
let whName: string | undefined
defineNodeExtension({
name: 'bc11.mig.handle-returned',
nodeCreated(handle) {
const wh = handle.addWidget('STRING', 'added', '', {})
whName = wh.name // no index needed
}
})
const id = makeNodeId(8)
stubNodeType(id)
mountExtensionsForNode(id)
expect(whName).toBe('added')
})
})
describe('Phase B deferred', () => {
it.todo(
'v1 direct widget.value assignment and v2 setValue() both result in the same displayed value on the canvas after flush (Phase B — requires LiteGraph canvas)'
)
it.todo(
'v2 setOption({ values }) that removes current value causes on("valueChange") with newValue = options[0]; v1 does not auto-fire change (Phase B)'
)
it.todo(
'v1 node.widgets.push requires manual setSize reflow; v2 addWidget performs it automatically — no double-reflow when migrating (Phase B)'
)
})
})

View File

@@ -0,0 +1,279 @@
// Category: BC.11 — Widget imperative state writes
// DB cross-ref: S4.W4, S4.W5, S2.N16
// Exemplar: https://github.com/r-vage/ComfyUI_Eclipse/blob/main/js/eclipse-set-get.js#L9
// blast_radius: 5.81 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v1 contract: widget.value = newVal
// widget.options.values = [...]
// node.widgets.splice(i, 0, w)
// node.widgets.push(w)
import { describe, expect, it, vi } from 'vitest'
import {
countEvidenceExcerpts,
createMiniComfyApp,
loadEvidenceSnippet,
runV1
} from '../harness'
// ── Minimal v1 widget stubs ───────────────────────────────────────────────────
interface V1Widget {
name: string
value: unknown
callback?: ((v: unknown) => void) | undefined
options?: { values: unknown[] }
}
function createV1Widget(name: string, value: unknown = ''): V1Widget {
return { name, value, callback: undefined }
}
function createV1ComboWidget(name: string, value: string, values: string[]): V1Widget {
return { name, value, callback: undefined, options: { values } }
}
// Simulate LiteGraph calling widget.callback on user interaction.
function simulateUserChange(widget: V1Widget, newValue: unknown): void {
widget.value = newValue
widget.callback?.(newValue)
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.11 v1 contract — widget imperative state writes', () => {
// ── S4.W4 evidence ──────────────────────────────────────────────────────────
describe('S4.W4 — evidence excerpts', () => {
it('S4.W4 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S4.W4')).toBeGreaterThan(0)
})
it('S4.W4 evidence snippet contains widget.value fingerprint', () => {
const count = countEvidenceExcerpts('S4.W4')
let found = false
for (let i = 0; i < count; i++) {
const snippet = loadEvidenceSnippet('S4.W4', i)
if (/widget\.value|\.value\s*=/.test(snippet)) {
found = true
break
}
}
expect(found, 'Expected at least one S4.W4 excerpt with widget.value fingerprint').toBe(true)
})
it('S4.W4 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S4.W4', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
// ── S4.W5 evidence ──────────────────────────────────────────────────────────
describe('S4.W5 — evidence excerpts', () => {
it('S4.W5 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S4.W5')).toBeGreaterThan(0)
})
it('S4.W5 evidence snippet contains options.values or widget.value fingerprint', () => {
const count = countEvidenceExcerpts('S4.W5')
let found = false
for (let i = 0; i < count; i++) {
const snippet = loadEvidenceSnippet('S4.W5', i)
if (/options\.values|\.values\s*=|widget\.value/.test(snippet)) {
found = true
break
}
}
expect(found, 'Expected at least one S4.W5 excerpt with options.values or widget.value fingerprint').toBe(true)
})
it('S4.W5 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S4.W5', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
// ── S2.N16 evidence ─────────────────────────────────────────────────────────
describe('S2.N16 — evidence excerpts', () => {
it('S2.N16 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N16')).toBeGreaterThan(0)
})
it('S2.N16 evidence snippet contains node.widgets or widgets.push fingerprint', () => {
const count = countEvidenceExcerpts('S2.N16')
let found = false
for (let i = 0; i < count; i++) {
const snippet = loadEvidenceSnippet('S2.N16', i)
if (/node\.widgets|widgets\.push|widgets\.splice/.test(snippet)) {
found = true
break
}
}
expect(found, 'Expected at least one S2.N16 excerpt with node.widgets fingerprint').toBe(true)
})
it('S2.N16 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N16', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
// ── S4.W4 synthetic behavior ─────────────────────────────────────────────────
describe('S4.W4 — widget.value direct assignment', () => {
it('reading widget.value after assignment returns the assigned value (immediate read-back)', () => {
const widget: { name: string; value: unknown; callback: ((v: unknown) => void) | undefined } = {
name: 'steps',
value: 20 as unknown,
callback: undefined
}
widget.value = 30
expect(widget.value).toBe(30)
})
it('value assignment does NOT trigger widget.callback (contrast with simulateUserChange which does call callback)', () => {
const widget = createV1Widget('steps', 20)
const cb = vi.fn()
widget.callback = cb
widget.value = 30 // direct assignment, no callback fire
expect(cb).not.toHaveBeenCalled()
})
it('assigning a value outside the COMBO options list does not throw', () => {
const comboWidget = createV1ComboWidget('sampler', 'euler', ['euler', 'dpm'])
// Value not in options — must not throw
expect(() => {
comboWidget.value = 'unknown_sampler'
}).not.toThrow()
expect(comboWidget.value).toBe('unknown_sampler')
})
})
// ── S4.W5 synthetic behavior ─────────────────────────────────────────────────
describe('S4.W5 — widget.options.values mutation (COMBO options)', () => {
it('assigning widget.options.values = [...] replaces the options list', () => {
const comboWidget = { name: 'model', value: 'sd15', options: { values: ['sd15', 'sdxl'] } }
comboWidget.options.values = ['flux', 'sd3']
expect(comboWidget.options.values).toEqual(['flux', 'sd3'])
})
it('stale value (absent from new options) persists without auto-reset', () => {
const comboWidget = createV1ComboWidget('model', 'sd15', ['sd15', 'sdxl'])
// Replace options with a list that doesn't include the current value
comboWidget.options!.values = ['flux', 'sd3']
// v1 has no auto-reset: stale value remains
expect(comboWidget.value).toBe('sd15')
})
it('mutation of options.values does not fire widget.callback', () => {
const comboWidget = createV1ComboWidget('model', 'sd15', ['sd15', 'sdxl'])
const cb = vi.fn()
comboWidget.callback = cb
comboWidget.options!.values = ['flux', 'sd3']
expect(cb).not.toHaveBeenCalled()
})
})
// ── S2.N16 synthetic behavior ────────────────────────────────────────────────
describe('S2.N16 — node.widgets array mutation (insert / push)', () => {
it('widgets.push appends a widget and it is immediately in the array', () => {
const node = { widgets: [] as V1Widget[] }
const newWidget = createV1Widget('denoise', 1.0)
node.widgets.push(newWidget)
expect(node.widgets).toHaveLength(1)
expect(node.widgets[0]).toBe(newWidget)
})
it('widgets.splice(i, 0, w) inserts at position i and shifts subsequent widgets', () => {
const w0 = createV1Widget('steps', 20)
const w1 = createV1Widget('cfg', 7)
const node = { widgets: [w0, w1] as V1Widget[] }
const wNew = createV1Widget('denoise', 1.0)
node.widgets.splice(1, 0, wNew)
expect(node.widgets).toHaveLength(3)
expect(node.widgets[0]).toBe(w0)
expect(node.widgets[1]).toBe(wNew)
expect(node.widgets[2]).toBe(w1)
})
it('inserting via splice at position 0 makes the new widget the first element', () => {
const w0 = createV1Widget('steps', 20)
const w1 = createV1Widget('cfg', 7)
const node = { widgets: [w0, w1] as V1Widget[] }
const wFirst = createV1Widget('seed', 0)
node.widgets.splice(0, 0, wFirst)
expect(node.widgets[0]).toBe(wFirst)
expect(node.widgets[1]).toBe(w0)
expect(node.widgets[2]).toBe(w1)
})
it('canvas redraw visibility: node.widgets.push does not update node.size; calling setSize([...computeSize()]) is required to avoid slot overlap', () => {
const node = {
size: [200, 60] as [number, number],
widgets: [] as V1Widget[],
computeSize(): [number, number] {
// 20px per widget row + 40px header
return [this.size[0], this.widgets.length * 20 + 40]
},
setSize(s: [number, number]) {
this.size[0] = s[0]
this.size[1] = s[1]
}
}
const w = createV1Widget('denoise', 1.0)
node.widgets.push(w)
// size has NOT changed yet — push does not resize
expect(node.size[1]).toBe(60)
// After explicit setSize, size reflects new widget count
node.setSize([...node.computeSize()])
expect(node.size[1]).toBe(60) // 1 widget * 20 + 40 = 60
})
it('node size reflow: node.widgets.push does not trigger a canvas redraw without an explicit setDirtyCanvas call', () => {
const drawCalls: string[] = []
const node = {
widgets: [] as V1Widget[],
size: [200, 60] as [number, number],
}
const mockCanvas = {
setDirtyCanvas(foreground: boolean) {
if (foreground) drawCalls.push('dirty')
}
}
node.widgets.push(createV1Widget('denoise', 1.0))
// push alone does not redraw
expect(drawCalls).toHaveLength(0)
// Only after setDirtyCanvas does a redraw get scheduled
mockCanvas.setDirtyCanvas(true)
expect(drawCalls).toHaveLength(1)
})
it('positional drift in widgets_values: inserting a widget via splice causes widgets_values positional drift if not followed by a node size reflow', () => {
// widgets_values is positional: [w0.value, w1.value, w2.value]
const w0 = createV1Widget('steps', 20)
const w1 = createV1Widget('cfg', 7)
const node = { widgets: [w0, w1] as V1Widget[] }
// Before splice: positional order is [steps=20, cfg=7]
const beforeSerialized = node.widgets.map(w => w.value)
expect(beforeSerialized).toEqual([20, 7])
// Insert a new widget at index 1 — drift: cfg is now at index 2
const wNew = createV1Widget('denoise', 0.9)
node.widgets.splice(1, 0, wNew)
// After splice: positional order is [steps=20, denoise=0.9, cfg=7]
const afterSerialized = node.widgets.map(w => w.value)
expect(afterSerialized).toEqual([20, 0.9, 7])
// A workflow saved before the splice would try to restore cfg from index 1 (= 0.9 now) — drift
expect(afterSerialized[1]).toBe(0.9) // was cfg=7 before
expect(afterSerialized[2]).toBe(7) // cfg has drifted to index 2
})
})
})

View File

@@ -0,0 +1,320 @@
// Category: BC.11 — Widget imperative state writes
// DB cross-ref: S4.W4, S4.W5, S2.N16
// Exemplar: https://github.com/r-vage/ComfyUI_Eclipse/blob/main/js/eclipse-set-get.js#L9
// blast_radius: 5.81 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: WidgetHandle.setValue(v), WidgetHandle.setOption(key,v), NodeHandle.addWidget(opts)
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
// ── Mock world (same pattern as bc-01.v2.test.ts) ────────────────────────────
const mockGetComponent = vi.fn()
const mockEntitiesWith = vi.fn(() => [])
vi.mock('@/world/worldInstance', () => ({
getWorld: () => ({
getComponent: mockGetComponent,
entitiesWith: mockEntitiesWith,
setComponent: vi.fn(),
removeComponent: vi.fn()
})
}))
vi.mock('@/world/widgets/widgetComponents', () => ({
WidgetComponentContainer: Symbol('WidgetComponentContainer'),
WidgetComponentDisplay: Symbol('WidgetComponentDisplay'),
WidgetComponentSchema: Symbol('WidgetComponentSchema'),
WidgetComponentSerialize: Symbol('WidgetComponentSerialize'),
WidgetComponentValue: Symbol('WidgetComponentValue')
}))
vi.mock('@/world/entityIds', () => ({}))
vi.mock('@/world/componentKey', () => ({
defineComponentKey: (name: string) => ({ name })
}))
vi.mock('@/extension-api/node', () => ({}))
vi.mock('@/extension-api/widget', () => ({}))
vi.mock('@/extension-api/lifecycle', () => ({}))
import {
_clearExtensionsForTesting,
_setDispatchImplForTesting,
defineNodeExtension,
mountExtensionsForNode,
unmountExtensionsForNode
} from '@/services/extension-api-service'
import type { NodeEntityId } from '@/world/entityIds'
// ── Helpers ───────────────────────────────────────────────────────────────────
function makeNodeId(n: number): NodeEntityId {
return `node:graph-uuid-bc11:${n}` as NodeEntityId
}
function stubNodeType(id: NodeEntityId, comfyClass = 'TestNode') {
mockGetComponent.mockImplementation((eid, key: { name: string }) => {
if (eid !== id) return undefined
if (key.name === 'NodeType') return { type: comfyClass, comfyClass }
return undefined
})
}
const ALL_TEST_IDS = Array.from({ length: 10 }, (_, i) => makeNodeId(i + 1))
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.11 v2 contract — widget imperative state writes', () => {
let dispatchedCommands: Record<string, unknown>[]
beforeEach(() => {
vi.clearAllMocks()
dispatchedCommands = []
_clearExtensionsForTesting()
ALL_TEST_IDS.forEach((id) => unmountExtensionsForNode(id))
_setDispatchImplForTesting((cmd) => {
dispatchedCommands.push(cmd)
if (cmd.type === 'CreateWidget') {
return `widget:graph:${String(cmd.parentNodeId)}:${String(cmd.name)}`
}
return undefined
})
})
afterEach(() => {
_setDispatchImplForTesting(null)
})
describe('WidgetHandle.setValue(v) — controlled value write (S4.W4)', () => {
it('WidgetHandle.setValue(v) dispatches a SetWidgetValue command with the correct value', () => {
let widgetHandle: { setValue: (v: unknown) => void } | undefined
defineNodeExtension({
name: 'bc11.v2.set-value',
nodeCreated(handle) {
const wh = handle.addWidget('INT', 'steps', 20, {})
widgetHandle = wh
}
})
const id = makeNodeId(1)
stubNodeType(id)
mountExtensionsForNode(id)
widgetHandle!.setValue(42)
const setCmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetValue' && c.value === 42
)
expect(setCmd).toBeDefined()
})
it('setValue dispatches with the widgetId matching the created widget', () => {
const capturedWidgetId: string[] = []
defineNodeExtension({
name: 'bc11.v2.set-value-id',
nodeCreated(handle) {
const wh = handle.addWidget('FLOAT', 'cfg', 7.0, {})
capturedWidgetId.push(wh.entityId as string)
wh.setValue(8.5)
}
})
const id = makeNodeId(2)
stubNodeType(id)
mountExtensionsForNode(id)
const setCmd = dispatchedCommands.find((c) => c.type === 'SetWidgetValue') as
| { widgetId: string; value: unknown }
| undefined
expect(setCmd).toBeDefined()
expect(setCmd?.widgetId).toBe(capturedWidgetId[0])
expect(setCmd?.value).toBe(8.5)
})
it('successive setValue calls each dispatch a separate SetWidgetValue command', () => {
defineNodeExtension({
name: 'bc11.v2.multi-set-value',
nodeCreated(handle) {
const wh = handle.addWidget('INT', 'seed', 0, {})
wh.setValue(1)
wh.setValue(2)
wh.setValue(3)
}
})
const id = makeNodeId(3)
stubNodeType(id)
mountExtensionsForNode(id)
const setCmds = dispatchedCommands.filter((c) => c.type === 'SetWidgetValue')
expect(setCmds).toHaveLength(3)
expect(setCmds.map((c) => c.value)).toEqual([1, 2, 3])
})
})
describe('WidgetHandle.setHidden / setDisabled — display state writes (S4.W4)', () => {
it('WidgetHandle.setHidden(true) dispatches SetWidgetOption with key "hidden" = true', () => {
defineNodeExtension({
name: 'bc11.v2.set-hidden',
nodeCreated(handle) {
const wh = handle.addWidget('BOOLEAN', 'show_advanced', false, {})
wh.setHidden(true)
}
})
const id = makeNodeId(4)
stubNodeType(id)
mountExtensionsForNode(id)
const cmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetOption' && c.key === 'hidden' && c.value === true
)
expect(cmd).toBeDefined()
})
it('WidgetHandle.setDisabled(true) dispatches SetWidgetOption with key "disabled" = true', () => {
defineNodeExtension({
name: 'bc11.v2.set-disabled',
nodeCreated(handle) {
const wh = handle.addWidget('STRING', 'lora_name', '', {})
wh.setDisabled(true)
}
})
const id = makeNodeId(5)
stubNodeType(id)
mountExtensionsForNode(id)
const cmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetOption' && c.key === 'disabled' && c.value === true
)
expect(cmd).toBeDefined()
})
})
describe('WidgetHandle.setOption — COMBO and generic option replacement (S4.W5)', () => {
it('setOption dispatches a SetWidgetOption command with the given key and value', () => {
defineNodeExtension({
name: 'bc11.v2.set-option',
nodeCreated(handle) {
const wh = handle.addWidget('COMBO', 'sampler_name', 'euler', { values: ['euler', 'dpm_2'] })
wh.setOption('values', ['euler', 'dpm_2', 'lcm'])
}
})
const id = makeNodeId(6)
stubNodeType(id)
mountExtensionsForNode(id)
const cmd = dispatchedCommands.find(
(c) => c.type === 'SetWidgetOption' && c.key === 'values'
) as { value: unknown[] } | undefined
expect(cmd).toBeDefined()
expect(cmd?.value).toContain('lcm')
})
it('multiple setOption calls each produce separate SetWidgetOption commands', () => {
defineNodeExtension({
name: 'bc11.v2.multi-option',
nodeCreated(handle) {
const wh = handle.addWidget('STRING', 'label', '', {})
wh.setOption('placeholder', 'Enter text')
wh.setOption('maxLength', 256)
}
})
const id = makeNodeId(7)
stubNodeType(id)
mountExtensionsForNode(id)
const optCmds = dispatchedCommands.filter((c) => c.type === 'SetWidgetOption')
const keys = optCmds.map((c) => c.key)
expect(keys).toContain('placeholder')
expect(keys).toContain('maxLength')
})
})
describe('NodeHandle.addWidget — managed widget list mutation (S2.N16)', () => {
it('addWidget dispatches a CreateWidget command and returns a handle with the given name', () => {
let handleName: string | undefined
defineNodeExtension({
name: 'bc11.v2.add-widget',
nodeCreated(handle) {
const wh = handle.addWidget('INT', 'steps', 20, {})
handleName = wh.name
}
})
const id = makeNodeId(8)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmd = dispatchedCommands.find(
(c) => c.type === 'CreateWidget' && c.name === 'steps'
)
expect(createCmd).toBeDefined()
expect(handleName).toBe('steps')
})
it('addWidget for each of two distinct widgets produces two independent CreateWidget commands', () => {
defineNodeExtension({
name: 'bc11.v2.add-two-widgets',
nodeCreated(handle) {
handle.addWidget('INT', 'steps', 20, {})
handle.addWidget('FLOAT', 'cfg', 7.0, {})
}
})
const id = makeNodeId(9)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmds = dispatchedCommands.filter((c) => c.type === 'CreateWidget')
const names = createCmds.map((c) => c.name)
expect(names).toContain('steps')
expect(names).toContain('cfg')
expect(createCmds).toHaveLength(2)
})
it('addWidget carries the defaultValue in the CreateWidget command', () => {
defineNodeExtension({
name: 'bc11.v2.add-widget-default',
nodeCreated(handle) {
handle.addWidget('INT', 'seed', 42, {})
}
})
const id = makeNodeId(10)
stubNodeType(id)
mountExtensionsForNode(id)
const createCmd = dispatchedCommands.find(
(c) => c.type === 'CreateWidget' && c.name === 'seed'
) as { defaultValue: unknown } | undefined
expect(createCmd?.defaultValue).toBe(42)
})
})
describe('Phase B deferred', () => {
it.todo(
'WidgetHandle.setValue(v) fires the on("valueChange") listeners with {newValue, oldValue} in the same tick (Phase B — requires reactive World)'
)
it.todo(
'WidgetHandle.setOption({ values }) that removes current value triggers on("valueChange") with reset to options[0] (Phase B)'
)
it.todo(
'NodeHandle.addWidget auto-reflows node size and updates widgets_values named map (Phase B — requires ECS node dimensions component)'
)
it.todo(
'NodeHandle.addWidget does not cause widgets_values positional drift because v2 uses a named map rather than a positional array (Phase B)'
)
})
})

View File

@@ -0,0 +1,124 @@
// Category: BC.12 — Per-widget serialization transform
// DB cross-ref: S4.W3
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/browser_tests/helpers/painter.ts#L70
// Migration: v1 widget.serializeValue positional index → v2 WidgetHandle.on('beforeSerialize') name-based
import { describe, it, expect } from 'vitest'
import { expectTypeOf } from 'vitest'
import type {
WidgetHandle,
WidgetBeforeSerializeEvent
} from '@/extension-api/widget'
describe('BC.12 migration — per-widget serialization transform', () => {
describe('API surface difference: positional index removed', () => {
it('v1 serializeValue received (node, index); v2 beforeSerialize event has no index field', () => {
// Type-level proof: WidgetBeforeSerializeEvent has no numeric index property.
type E = WidgetBeforeSerializeEvent
// These keys must NOT exist on the event type.
type HasIndex = 'index' extends keyof E ? true : false
type HasWidgetIndex = 'widgetIndex' extends keyof E ? true : false
const noIndex: HasIndex = false
const noWidgetIndex: HasWidgetIndex = false
expect(noIndex).toBe(false)
expect(noWidgetIndex).toBe(false)
})
it('v2 beforeSerialize event carries context discriminant absent from v1 serializeValue', () => {
type E = WidgetBeforeSerializeEvent
type HasContext = 'context' extends keyof E ? true : false
const hasContext: HasContext = true
expect(hasContext).toBe(true)
// The context field covers all four serialization paths.
expectTypeOf<E['context']>().toEqualTypeOf<
'workflow' | 'prompt' | 'clone' | 'subgraph-promote'
>()
})
it('v2 setSerializedValue replaces the implicit return-value contract of v1 serializeValue', () => {
// v1: `return transformedValue` — the return value was used.
// v2: `event.setSerializedValue(transformedValue)` — explicit override.
type SetFn = WidgetBeforeSerializeEvent['setSerializedValue']
expectTypeOf<SetFn>().toBeFunction()
expectTypeOf<SetFn>().parameter(0).toEqualTypeOf<unknown>()
})
it('v2 skip() replaces v1 options.serialize===false pattern for prompt exclusion', () => {
type SkipFn = WidgetBeforeSerializeEvent['skip']
expectTypeOf<SkipFn>().toBeFunction()
// skip() takes no arguments — not a value return
type Params = Parameters<SkipFn>
expectTypeOf<Params['length']>().toEqualTypeOf<0>()
})
it('v2 WidgetHandle exposes isSerializeEnabled / setSerializeEnabled as first-class fields', () => {
expectTypeOf<WidgetHandle['isSerializeEnabled']>().toBeFunction()
expectTypeOf<WidgetHandle['setSerializeEnabled']>().toBeFunction()
})
})
describe('identity model: name-based vs positional', () => {
it('WidgetHandle.name is a readonly string — the stable identity key replacing positional index', () => {
type NameField = WidgetHandle['name']
expectTypeOf<NameField>().toEqualTypeOf<string>()
})
it('WidgetHandle.entityId is a branded number — prevents mixing widget IDs with node IDs', () => {
type EntityId = WidgetHandle['entityId']
// Branded: assignable to number but not plain number (structurally number & { __brand })
type IsNumber = EntityId extends number ? true : false
const branded: IsNumber = true
expect(branded).toBe(true)
})
it.todo(
// TODO(Phase B): requires live World + graphToPrompt + slot reorder operation
'v2 WidgetHandle identity is stable after node.widgets reordering; v1 serializeValue index changes if widgets are reordered — this is the primary reason to migrate'
)
it.todo(
// TODO(Phase B): requires live World + multiple on() registrations
'registering on(\'beforeSerialize\') twice does not double-fire; each unsubscribe function removes only the listener it was returned for'
)
})
describe('serialize===false widget compat', () => {
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline + serialize===false widget fixture
'v1 positional index for a widget after control_after_generate is offset by 1 relative to the backend prompt; v2 named-map has no such offset'
)
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline
'migrate: v1 code that hard-codes an index offset for serialize===false slots must be rewritten to use WidgetHandle identity by name in v2'
)
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline + workflow round-trip
'widgets_values_named round-trip: a workflow serialized under v2 with an on(\'beforeSerialize\') transform deserializes to the same widget values as the equivalent v1 serializeValue workflow'
)
})
describe('async transform equivalence', () => {
it('v2 on(\'beforeSerialize\') handler type accepts both sync and async functions', () => {
// AsyncHandler<T> = (e: T) => void | Promise<void>
type Handler = Parameters<WidgetHandle['on']>[1]
// The beforeSerialize overload's handler must accept Promise return.
// We check via the on() overload signature: the second param when event='beforeSerialize'
// is typed as AsyncHandler<WidgetBeforeSerializeEvent>.
type AsyncHandlerOfEvent = (e: WidgetBeforeSerializeEvent) => void | Promise<void>
// Assign a sync fn — must compile:
const _sync: AsyncHandlerOfEvent = (_e) => {}
// Assign an async fn — must compile:
const _async: AsyncHandlerOfEvent = async (_e) => {}
expect(typeof _sync).toBe('function')
expect(typeof _async).toBe('function')
})
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline
'async transforms: both v1 serializeValue and v2 on(\'beforeSerialize\') are awaited by graphToPrompt() before the workflow is finalized'
)
})
})

View File

@@ -0,0 +1,74 @@
// Category: BC.12 — Per-widget serialization transform
// DB cross-ref: S4.W3
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/browser_tests/helpers/painter.ts#L70
// blast_radius: 5.58 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v1 contract: widget.serializeValue = async function(node, index) { return transformedValue }
// Notes: widget.options.serialize===false widgets (e.g. control_after_generate) still occupy a
// widgets_values slot and still fire serializeValue — excluded only from backend prompt by
// graphToPrompt(). See research/architecture/widget-serialization-historical-analysis.md.
import { describe, it, expect } from 'vitest'
import {
createMiniComfyApp,
loadEvidenceSnippet,
countEvidenceExcerpts,
runV1
} from '@/extension-api-v2/harness'
describe('BC.12 v1 contract — per-widget serialization transform', () => {
describe('S4.W3 — widget.serializeValue assignment (structural)', () => {
it('S4.W3 has at least one evidence excerpt in the database', () => {
const count = countEvidenceExcerpts('S4.W3')
expect(count).toBeGreaterThan(0)
})
it('first S4.W3 evidence snippet contains a serializeValue assignment', () => {
const snippet = loadEvidenceSnippet('S4.W3', 0)
expect(snippet).toContain('serializeValue')
})
it('S4.W3 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S4.W3', 0)
const app = createMiniComfyApp()
// runV1 must not throw even if it cannot execute the snippet semantically.
expect(() => runV1(snippet, { app })).not.toThrow()
})
it.todo(
// TODO(Phase B): requires a synthetic LGraphNode + graphToPrompt harness
'assigning widget.serializeValue = async fn(node, index) causes graphToPrompt() to await fn and use its return value in widgets_values'
)
it.todo(
// TODO(Phase B): synthetic mock required
'serializeValue receives the owning node as first argument and the widget\'s positional index in node.widgets as second argument'
)
it.todo(
// TODO(Phase B): synthetic mock required
'if serializeValue is not assigned, graphToPrompt() uses widget.value directly as the serialized value'
)
it.todo(
// TODO(Phase B): synthetic mock required
'serializeValue may return a value of a different type than widget.value (e.g. string expansion of a seed integer)'
)
})
describe('serialize===false widgets (control_after_generate)', () => {
it.todo(
// TODO(Phase B): synthetic mock required
'a widget with options.serialize===false still occupies a slot in the widgets_values positional array during serialization'
)
it.todo(
// TODO(Phase B): synthetic mock required
'serializeValue fires for a serialize===false widget and its return value appears in widgets_values even though graphToPrompt() excludes it from the backend prompt'
)
it.todo(
// TODO(Phase B): synthetic mock required
'the positional index passed to serializeValue for widgets after a serialize===false widget is offset by one relative to the backend prompt widgets_values array'
)
})
})

View File

@@ -0,0 +1,123 @@
// Category: BC.12 — Per-widget serialization transform
// DB cross-ref: S4.W3
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/browser_tests/helpers/painter.ts#L70
// blast_radius: 5.58 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: WidgetHandle.on('beforeSerialize', handler) with event.setSerializedValue / event.skip
// Notes: WidgetHandle identity is by name not position (PR #10392 widgets_values_named migration path).
// serialize===false widgets still fire beforeSerialize and still appear in the named map.
import { describe, it, expect } from 'vitest'
import { expectTypeOf } from 'vitest'
import type {
WidgetHandle,
WidgetBeforeSerializeEvent,
WidgetValue
} from '@/extension-api/widget'
describe('BC.12 v2 contract — per-widget serialization transform', () => {
describe('WidgetHandle.on(\'beforeSerialize\', handler) — event type shape', () => {
it('WidgetBeforeSerializeEvent has the correct structural shape', () => {
// Type-level check — verifies the contract surface without needing a live World.
type E = WidgetBeforeSerializeEvent
expectTypeOf<E['context']>().toEqualTypeOf<
'workflow' | 'prompt' | 'clone' | 'subgraph-promote'
>()
expectTypeOf<E['value']>().toEqualTypeOf<WidgetValue>()
expectTypeOf<E['setSerializedValue']>().toBeFunction()
expectTypeOf<E['skip']>().toBeFunction()
})
it('WidgetHandle.on accepts \'beforeSerialize\' and returns Unsubscribe', () => {
// Type-level: on('beforeSerialize') overload exists and returns () => void
type OnBeforeSerialize = WidgetHandle['on']
type Unsubscribe = ReturnType<WidgetHandle['on']>
expectTypeOf<Unsubscribe>().toEqualTypeOf<() => void>()
// The overload accepting 'beforeSerialize' must compile — verified by the
// presence of the overload signature in widget.ts.
type SerializeHandler = Parameters<
Extract<
OnBeforeSerialize,
(event: 'beforeSerialize', handler: (e: WidgetBeforeSerializeEvent) => void | Promise<void>) => () => void
>
>[1]
expectTypeOf<SerializeHandler>().not.toBeNever()
})
it('beforeSerialize event context discriminant covers all four serialization paths', () => {
const contexts = ['workflow', 'prompt', 'clone', 'subgraph-promote'] as const
type Context = (typeof contexts)[number]
type EventContext = WidgetBeforeSerializeEvent['context']
// Exhaustiveness: every declared context literal is assignable to EventContext
const _check: Context extends EventContext ? true : never = true
expect(_check).toBe(true)
})
it('setSerializedValue accepts unknown (JSON-serializable value of any shape)', () => {
expectTypeOf<WidgetBeforeSerializeEvent['setSerializedValue']>()
.parameter(0)
.toEqualTypeOf<unknown>()
})
it('skip() takes no arguments', () => {
type SkipArity = Parameters<WidgetBeforeSerializeEvent['skip']>
expectTypeOf<SkipArity['length']>().toEqualTypeOf<0>()
})
})
describe('WidgetHandle.on(\'beforeSerialize\', handler) — runtime behaviour', () => {
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline
'on(\'beforeSerialize\', fn) fires fn during graphToPrompt(); calling event.setSerializedValue(v) places v in the named map under the widget name'
)
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline
'if no beforeSerialize listener is registered, graphToPrompt() uses WidgetHandle.getValue() directly'
)
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline
'calling event.skip() in a context=\'prompt\' handler excludes the widget from the backend API prompt; the named-map entry is still written for workflow serialization'
)
it.todo(
// TODO(Phase B): requires live World + scope disposal
'on(\'beforeSerialize\') listener is removed when the extension scope is disposed; subsequent serializations use the raw getValue() result'
)
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline
'async beforeSerialize handlers are awaited before the serialization payload is finalized'
)
})
describe('serialize===false widgets (control_after_generate)', () => {
it('isSerializeEnabled() defaults to true; setSerializeEnabled(false) disables it', () => {
// Type-level: both methods exist on WidgetHandle
expectTypeOf<WidgetHandle['isSerializeEnabled']>().toBeFunction()
expectTypeOf<WidgetHandle['setSerializeEnabled']>().toBeFunction()
type IsReturn = ReturnType<WidgetHandle['isSerializeEnabled']>
type SetParam = Parameters<WidgetHandle['setSerializeEnabled']>[0]
expectTypeOf<IsReturn>().toEqualTypeOf<boolean>()
expectTypeOf<SetParam>().toEqualTypeOf<boolean>()
})
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline
'a widget with setSerializeEnabled(false) still fires beforeSerialize with context=\'prompt\'; the returned serializedValue is NOT sent to the backend prompt'
)
it.todo(
// TODO(Phase B): requires live World + graphToPrompt pipeline
'a widget with setSerializeEnabled(false) still appears in widgets_values_named in the workflow JSON (full round-trip preservation)'
)
it.todo(
// TODO(Phase B): requires live World
'WidgetHandle identity for a serialize===false widget is stable across slot reordering because it is name-based not position-based'
)
})
})

View File

@@ -0,0 +1,352 @@
// Category: BC.13 — Per-node serialization interception
// DB cross-ref: S2.N6, S2.N15
// Exemplar: https://github.com/Azornes/Comfyui-LayerForge/blob/main/js/CanvasView.js#L1438
// Migration: v1 prototype.serialize patching / node.onSerialize → v2 NodeHandle.on('beforeSerialize') named-map
import { describe, expect, it, vi } from 'vitest'
import type { AsyncHandler } from '@/extension-api/events'
import type { NodeBeforeSerializeEvent } from '@/extension-api/node'
// ── V1 serialization simulation ───────────────────────────────────────────────
// v1: extension patches NodeType.prototype.serialize. Each patcher wraps the
// previous and returns the modified data object.
type V1SerializeFn = (base: Record<string, unknown>) => Record<string, unknown>
function makeV1NodeType(comfyClass: string) {
let serializeFn: V1SerializeFn = (data) => data
return {
comfyClass,
patchSerialize(patcher: (orig: V1SerializeFn) => V1SerializeFn) {
const prev = serializeFn
serializeFn = patcher(prev)
},
serialize(baseData: Record<string, unknown>): Record<string, unknown> {
return serializeFn({ ...baseData })
},
// v1 onSerialize hook (alternative pattern — receives data, mutates in place)
_onSerializeHandlers: [] as Array<(data: Record<string, unknown>) => void>,
onSerialize(fn: (data: Record<string, unknown>) => void) {
this._onSerializeHandlers.push(fn)
},
serializeWithOnSerialize(base: Record<string, unknown>): Record<string, unknown> {
const data = this.serialize(base)
for (const fn of this._onSerializeHandlers) fn(data)
return data
}
}
}
// ── V2 serialization simulation ───────────────────────────────────────────────
type Unsubscribe = () => void
function makeV2NodeManager() {
const handlers: Array<AsyncHandler<NodeBeforeSerializeEvent>> = []
return {
on(_event: 'beforeSerialize', handler: AsyncHandler<NodeBeforeSerializeEvent>): Unsubscribe {
handlers.push(handler)
return () => {
const i = handlers.indexOf(handler)
if (i !== -1) handlers.splice(i, 1)
}
},
async serialize(baseData: Record<string, unknown>): Promise<Record<string, unknown>> {
let data = { ...baseData }
let replacer: ((orig: Record<string, unknown>) => Record<string, unknown>) | null = null
const event: NodeBeforeSerializeEvent = {
context: 'workflow',
get data() { return data },
replace(fn) { replacer = fn }
}
for (const fn of [...handlers]) {
await fn(event)
}
return replacer ? replacer(data) : data
}
}
}
// ── Widget value helpers ──────────────────────────────────────────────────────
interface WidgetSpec {
name: string
type: 'INT' | 'FLOAT' | 'STRING'
default: unknown
serialize?: boolean
}
function positionalSerialize(
widgets: Array<WidgetSpec & { value: unknown }>
): unknown[] {
return widgets.filter((w) => w.serialize !== false).map((w) => w.value)
}
function namedSerialize(
widgets: Array<WidgetSpec & { value: unknown }>,
warnFn: (msg: string) => void
): Record<string, unknown> {
const named: Record<string, unknown> = {}
for (const w of widgets) {
let val = w.value
if ((w.type === 'INT' || w.type === 'FLOAT') && typeof val === 'number' && isNaN(val)) {
warnFn(`[ComfyUI] Widget "${w.name}" serialized NaN — substituting default (${w.default})`)
val = w.default
}
named[w.name] = val
}
return named
}
function namedDeserialize(
named: Record<string, unknown>,
specs: WidgetSpec[],
warnFn: (msg: string) => void
): Record<string, unknown> {
const out: Record<string, unknown> = {}
for (const spec of specs) {
const raw = named[spec.name]
if ((spec.type === 'INT' || spec.type === 'FLOAT') && raw === null) {
warnFn(`[ComfyUI] Widget "${spec.name}" loaded null for numeric — restoring default (${spec.default})`)
out[spec.name] = spec.default
} else if (raw === undefined) {
out[spec.name] = spec.default
} else {
out[spec.name] = raw // preserve null for non-numeric widgets
}
}
return out
}
// ─────────────────────────────────────────────────────────────────────────────
describe('BC.13 migration — per-node serialization interception', () => {
describe('(a) positional v1 compat: prototype.serialize / onSerialize parity', () => {
it("custom field injected via v1 prototype.serialize patch and v2 on('beforeSerialize') both appear under identical keys", async () => {
const base = { id: 1, type: 'KSampler' }
// v1 path
const v1 = makeV1NodeType('KSampler')
v1.patchSerialize((prev) => (data) => ({ ...prev(data), custom_field: 'from-v1' }))
const v1Result = v1.serialize(base)
expect(v1Result['custom_field']).toBe('from-v1')
// v2 path
const v2 = makeV2NodeManager()
v2.on('beforeSerialize', async (e) => { e.data['custom_field'] = 'from-v2' })
const v2Result = await v2.serialize(base)
expect(v2Result['custom_field']).toBe('from-v2')
// Both produce the same key — extension authors can migrate without renaming
expect(Object.keys(v1Result)).toContain('custom_field')
expect(Object.keys(v2Result)).toContain('custom_field')
})
it("v1 onSerialize and v2 on('beforeSerialize') both fire exactly once per graphToPrompt() call", async () => {
const base = { id: 2 }
// v1
const v1 = makeV1NodeType('Foo')
const v1Spy = vi.fn()
v1.onSerialize(v1Spy)
v1.serializeWithOnSerialize(base)
expect(v1Spy).toHaveBeenCalledOnce()
// v2
const v2 = makeV2NodeManager()
const v2Spy = vi.fn().mockResolvedValue(undefined)
v2.on('beforeSerialize', v2Spy)
await v2.serialize(base)
expect(v2Spy).toHaveBeenCalledOnce()
})
it('chain of two v1 prototype.serialize patchers produces same custom-field set as two v2 listeners', async () => {
const base = { id: 3 }
// v1: two chained patchers
const v1 = makeV1NodeType('Bar')
v1.patchSerialize((prev) => (data) => ({ ...prev(data), ext_a: 'A' }))
v1.patchSerialize((prev) => (data) => ({ ...prev(data), ext_b: 'B' }))
const v1Result = v1.serialize(base)
// v2: two separate listeners
const v2 = makeV2NodeManager()
v2.on('beforeSerialize', async (e) => { e.data['ext_a'] = 'A' })
v2.on('beforeSerialize', async (e) => { e.data['ext_b'] = 'B' })
const v2Result = await v2.serialize(base)
expect(v1Result['ext_a']).toBe('A')
expect(v1Result['ext_b']).toBe('B')
expect(v2Result['ext_a']).toBe('A')
expect(v2Result['ext_b']).toBe('B')
})
})
describe('(b) named-map v2 round-trip parity', () => {
it('v2 widgets_values_named deserialization produces same values as v1 positional array', () => {
const specs: WidgetSpec[] = [
{ name: 'seed', type: 'INT', default: 0 },
{ name: 'steps', type: 'INT', default: 20 },
{ name: 'cfg', type: 'FLOAT', default: 7.0 }
]
const widgets: Array<WidgetSpec & { value: unknown }> = [
{ ...specs[0], value: 42 },
{ ...specs[1], value: 30 },
{ ...specs[2], value: 8.5 }
]
// v1: positional array
const v1Positional = positionalSerialize(widgets)
expect(v1Positional).toEqual([42, 30, 8.5])
// v2: named map → round-trip → deserialize
const named = namedSerialize(widgets, () => {})
const namedJson: Record<string, unknown> = JSON.parse(JSON.stringify(named))
const v2Deserialized = namedDeserialize(namedJson, specs, () => {})
// Same values regardless of representation
specs.forEach((s) => {
const positionalIdx = specs.indexOf(s)
expect(v2Deserialized[s.name]).toBe(v1Positional[positionalIdx])
})
})
it('inserting a widget between two existing widgets does not shift named-map entries (v2), unlike v1 positional array', () => {
const specsBefore: WidgetSpec[] = [
{ name: 'seed', type: 'INT', default: 0 },
{ name: 'steps', type: 'INT', default: 20 }
]
const specsAfter: WidgetSpec[] = [
{ name: 'seed', type: 'INT', default: 0 },
{ name: 'cfg', type: 'FLOAT', default: 7.0 }, // inserted
{ name: 'steps', type: 'INT', default: 20 }
]
// v1: positional shifts — steps is at index 1 before, index 2 after insertion
const v1Before = positionalSerialize([
{ ...specsBefore[0], value: 42 },
{ ...specsBefore[1], value: 25 }
])
const v1After = positionalSerialize([
{ ...specsAfter[0], value: 42 },
{ ...specsAfter[1], value: 5.0 },
{ ...specsAfter[2], value: 25 }
])
// v1: loading old workflow after insertion reads wrong index for steps
expect(v1Before[1]).toBe(25) // steps at index 1
expect(v1After[1]).toBe(5.0) // after insertion, index 1 is cfg — CORRUPTED if loaded with old workflow
// v2: named map — steps is always steps
const namedBefore = namedSerialize(
[{ ...specsBefore[0], value: 42 }, { ...specsBefore[1], value: 25 }],
() => {}
)
const namedAfter = namedSerialize(
[{ ...specsAfter[0], value: 42 }, { ...specsAfter[1], value: 5.0 }, { ...specsAfter[2], value: 25 }],
() => {}
)
// v2: steps key is stable regardless of insertion
expect(namedBefore['steps']).toBe(25)
expect(namedAfter['steps']).toBe(25)
})
it("serialize===false widget occupies named-map entry with no positional offset in v2; v1 callers must remove offset logic", () => {
const specs: WidgetSpec[] = [
{ name: 'seed', type: 'INT', default: 0 },
{ name: 'control_after_generate', type: 'STRING', default: 'fixed', serialize: false },
{ name: 'steps', type: 'INT', default: 20 }
]
const widgets: Array<WidgetSpec & { value: unknown }> = [
{ ...specs[0], value: 1 },
{ ...specs[1], value: 'randomize', serialize: false },
{ ...specs[2], value: 10 }
]
// v1: control_after_generate is excluded from positional array
const v1Positional = positionalSerialize(widgets)
expect(v1Positional).toEqual([1, 10]) // 2 items — no slot for control_after_generate
// v2: named map includes all widgets by name; no offset computation needed
const named = namedSerialize(widgets, () => {})
expect(named['seed']).toBe(1)
expect(named['control_after_generate']).toBe('randomize')
expect(named['steps']).toBe(10)
// v1 callers that hardcoded index 1 for 'steps' must be updated — v2 uses name key
expect(v1Positional[1]).toBe(10) // v1: steps at index 1 (after filtering serialize===false)
expect(named['steps']).toBe(10) // v2: steps always at key 'steps'
})
})
describe('(c) null-in-numeric-widget: warning + default substitution', () => {
it('v1 NaN silently becomes null in JSON; v2 substitutes declared default and emits console.warn including node id and widget name', () => {
const warnMessages: string[] = []
// v1 behavior: NaN → null via JSON.stringify
const v1Value: unknown = NaN
const v1Json = JSON.parse(JSON.stringify({ val: v1Value }))
expect(v1Json.val).toBeNull() // v1: silent null
// v2 behavior: NaN → warn + substitute default
const widgets: Array<WidgetSpec & { value: unknown }> = [
{ name: 'steps', type: 'INT', default: 20, value: NaN }
]
const named = namedSerialize(widgets, (msg) => warnMessages.push(msg))
expect(named['steps']).toBe(20) // default substituted
expect(warnMessages.length).toBe(1)
expect(warnMessages[0]).toMatch(/steps/) // widget name in message
expect(warnMessages[0]).toMatch(/NaN/)
})
it('null numeric widget loaded under v2 emits console.warn and restores declared default rather than loading null', () => {
const warnMessages: string[] = []
const specs: WidgetSpec[] = [
{ name: 'cfg', type: 'FLOAT', default: 7.0 }
]
// Simulate a v1-serialized workflow where cfg was NaN → null
const legacyNamed: Record<string, unknown> = { cfg: null }
const deserialized = namedDeserialize(legacyNamed, specs, (msg) => warnMessages.push(msg))
expect(deserialized['cfg']).toBe(7.0)
expect(warnMessages.length).toBe(1)
expect(warnMessages[0]).toMatch(/cfg/)
})
it('NaN guard does not trigger for non-numeric widgets whose value is legitimately null', () => {
const warnMessages: string[] = []
const specs: WidgetSpec[] = [
{ name: 'optional_lora', type: 'STRING', default: '' }
]
// STRING widget with null value — not a NaN guard scenario
const named = namedSerialize(
[{ ...specs[0], value: null }],
(msg) => warnMessages.push(msg)
)
// No warning for non-numeric null
expect(warnMessages.length).toBe(0)
expect(named['optional_lora']).toBeNull()
// Also on deserialize
const deserialized = namedDeserialize({ optional_lora: null }, specs, (msg) => warnMessages.push(msg))
expect(warnMessages.length).toBe(0)
expect(deserialized['optional_lora']).toBeNull()
})
})
})

View File

@@ -0,0 +1,206 @@
// Category: BC.13 — Per-node serialization interception
// DB cross-ref: S2.N6, S2.N15
// Exemplar: https://github.com/Azornes/Comfyui-LayerForge/blob/main/js/CanvasView.js#L1438
// blast_radius: 6.36 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v1 contract: node.prototype.serialize = function() { const r = origSerialize.call(this); r.myData = ...; return r }
// node.onSerialize = function(data) { data.myData = ... }
// Notes: widgets_values is positional. Three index-drift sources: control_after_generate slot occupancy,
// extension-injected widgets, V3 IO.MultiType topology-dependent widget count. NaN→null pipeline
// produces silent corruption. Test (a) positional v1 compat, (b) named-map v2 round-trip parity,
// (c) null-in-numeric-widget logs warning + substitutes default.
import { describe, expect, it, vi } from 'vitest'
import {
countEvidenceExcerpts,
createMiniComfyApp,
loadEvidenceSnippet,
runV1
} from '../harness'
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.13 v1 contract — per-node serialization interception', () => {
// ── S2.N6 evidence ───────────────────────────────────────────────────────────
describe('S2.N6 — evidence excerpts', () => {
it('S2.N6 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N6')).toBeGreaterThan(0)
})
it('S2.N6 evidence snippet contains serialize fingerprint', () => {
const snippet = loadEvidenceSnippet('S2.N6', 0)
expect(snippet).toMatch(/serialize/i)
})
it('S2.N6 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N6', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
// ── S2.N15 evidence ──────────────────────────────────────────────────────────
describe('S2.N15 — evidence excerpts', () => {
it('S2.N15 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N15')).toBeGreaterThan(0)
})
it('S2.N15 evidence snippet contains onSerialize fingerprint', () => {
const count = countEvidenceExcerpts('S2.N15')
let found = false
for (let i = 0; i < count; i++) {
const snippet = loadEvidenceSnippet('S2.N15', i)
if (/onSerialize|serialize/i.test(snippet)) {
found = true
break
}
}
expect(found, 'Expected at least one S2.N15 excerpt with onSerialize fingerprint').toBe(true)
})
it('S2.N15 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S2.N15', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
// ── S2.N6 synthetic behavior ─────────────────────────────────────────────────
describe('S2.N6 — prototype.serialize patching', () => {
it('patching prototype.serialize and chaining origSerialize includes base fields plus custom fields', () => {
interface MockNode {
id: number
type: string
widgets_values: unknown[]
serialize(): Record<string, unknown>
}
const baseSerialize = function (this: MockNode) {
return { id: this.id, type: this.type, widgets_values: this.widgets_values }
}
const NodeProto: { serialize: (this: MockNode) => Record<string, unknown> } = {
serialize: baseSerialize
}
// Extension patches
const origSerialize = NodeProto.serialize
NodeProto.serialize = function (this: MockNode) {
const r = origSerialize.call(this)
r.myData = 'hello'
return r
}
const node = Object.assign(Object.create(NodeProto) as MockNode, {
id: 1,
type: 'KSampler',
widgets_values: [42]
})
const result = node.serialize()
expect(result.myData).toBe('hello')
expect(result.id).toBe(1)
expect(result.type).toBe('KSampler')
expect(result.widgets_values).toEqual([42])
})
it('multiple extensions chaining each contribute their custom fields', () => {
interface MockNode {
id: number
type: string
widgets_values: unknown[]
serialize(): Record<string, unknown>
}
const baseSerialize = function (this: MockNode) {
return { id: this.id, type: this.type, widgets_values: this.widgets_values }
}
const NodeProto: { serialize: (this: MockNode) => Record<string, unknown> } = {
serialize: baseSerialize
}
// Extension A patches first
const orig1 = NodeProto.serialize
NodeProto.serialize = function (this: MockNode) {
const r = orig1.call(this)
r.extensionA = 'data-from-A'
return r
}
// Extension B patches second
const orig2 = NodeProto.serialize
NodeProto.serialize = function (this: MockNode) {
const r = orig2.call(this)
r.extensionB = 'data-from-B'
return r
}
const node = Object.assign(Object.create(NodeProto) as MockNode, {
id: 2,
type: 'VAEDecode',
widgets_values: []
})
const result = node.serialize()
expect(result.extensionA).toBe('data-from-A')
expect(result.extensionB).toBe('data-from-B')
expect(result.id).toBe(2)
})
it.todo(
'positional widgets_values in the patched serialize output drifts when a serialize===false widget occupies a slot before the target widget'
)
})
// ── S2.N15 synthetic behavior ────────────────────────────────────────────────
describe('S2.N15 — node.onSerialize callback', () => {
it('onSerialize mutates data in place; mutation is reflected in result', () => {
const data = { id: 1, widgets_values: [42] } as Record<string, unknown>
const node = {
onSerialize: (d: Record<string, unknown>) => {
d.extra = 'injected'
}
}
// Simulate LiteGraph calling onSerialize after base serialize
node.onSerialize(data)
expect(data.extra).toBe('injected')
})
it('onSerialize fires twice when serialized twice', () => {
const calls: number[] = []
const data1 = { id: 1, widgets_values: [] } as Record<string, unknown>
const data2 = { id: 1, widgets_values: [] } as Record<string, unknown>
const node = {
onSerialize: (d: Record<string, unknown>) => {
calls.push(calls.length)
d.callIndex = calls.length
}
}
node.onSerialize(data1)
node.onSerialize(data2)
expect(calls).toHaveLength(2)
expect(data1.callIndex).toBe(1)
expect(data2.callIndex).toBe(2)
})
it.todo(
'real graphToPrompt integration: onSerialize fires once per graphToPrompt call in the real app'
)
it.todo(
'positional drift with serialize===false widgets: NaN values written inside onSerialize are silently coerced to null by JSON.stringify'
)
})
// ── NaN→null silent corruption ───────────────────────────────────────────────
describe('NaN→null silent corruption', () => {
it('JSON.stringify(NaN) === "null", and JSON.parse("null") === null — synthetic proof', () => {
const widgets_values = [NaN]
const serialized = JSON.stringify(widgets_values) // "[null]"
const restored = JSON.parse(serialized) as unknown[]
expect(restored[0]).toBeNull()
})
it('restored null is not equal to 0 and not equal to widget default', () => {
const widgets_values = [NaN]
const serialized = JSON.stringify(widgets_values)
const restored = JSON.parse(serialized) as unknown[]
const restoredValue = restored[0]
const widgetDefault = 0
expect(restoredValue).not.toBe(0)
expect(restoredValue).not.toBe(widgetDefault)
expect(restoredValue).toBeNull()
})
})
})

View File

@@ -0,0 +1,357 @@
// Category: BC.13 — Per-node serialization interception
// DB cross-ref: S2.N6, S2.N15
// Exemplar: https://github.com/Azornes/Comfyui-LayerForge/blob/main/js/CanvasView.js#L1438
// blast_radius: 6.36 — compat-floor: blast_radius ≥ 2.0 — MUST pass before v2 ships
// v2 replacement: NodeHandle.on('beforeSerialize', async (e) => { e.data.myData = ... })
// Notes: v2 uses widgets_values_named keyed by widget name, eliminating positional drift.
// NaN→null pipeline: v2 serializer logs a warning and substitutes the widget's declared default.
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import type { AsyncHandler } from '@/extension-api/events'
import type { NodeBeforeSerializeEvent } from '@/extension-api/node'
// ── Minimal NodeBeforeSerializeEvent factory ──────────────────────────────────
interface WidgetSpec {
name: string
type: 'INT' | 'FLOAT' | 'STRING' | 'BOOLEAN'
default: unknown
serialize?: boolean
}
interface SerializedNode {
id: number
type: string
widgets_values_named: Record<string, unknown>
[key: string]: unknown
}
function makeEvent(
overrides: Partial<NodeBeforeSerializeEvent> & {
initialData?: Record<string, unknown>
} = {}
): NodeBeforeSerializeEvent & { _getData(): Record<string, unknown> } {
let data: Record<string, unknown> = { ...(overrides.initialData ?? {}) }
let replacer: ((orig: Record<string, unknown>) => Record<string, unknown>) | null = null
const event: NodeBeforeSerializeEvent & { _getData(): Record<string, unknown> } = {
context: overrides.context ?? 'workflow',
get data() {
return data
},
replace(fn) {
replacer = fn
},
_getData() {
return replacer ? replacer(data) : data
}
}
return event
}
// ── Minimal NodeHandle-like subscription manager ──────────────────────────────
type Unsubscribe = () => void
function makeNodeSubscriptionManager() {
const listeners: Array<AsyncHandler<NodeBeforeSerializeEvent>> = []
return {
on(_event: 'beforeSerialize', handler: AsyncHandler<NodeBeforeSerializeEvent>): Unsubscribe {
listeners.push(handler)
return () => {
const idx = listeners.indexOf(handler)
if (idx !== -1) listeners.splice(idx, 1)
}
},
async dispatch(event: NodeBeforeSerializeEvent): Promise<void> {
for (const fn of [...listeners]) {
await fn(event)
}
},
listenerCount() {
return listeners.length
}
}
}
// ── Named-map serializer simulator ───────────────────────────────────────────
function serializeWidgets(
widgets: Array<WidgetSpec & { value: unknown }>
): { named: Record<string, unknown>; warnings: string[] } {
const named: Record<string, unknown> = {}
const warnings: string[] = []
for (const w of widgets) {
if (w.serialize === false) {
named[w.name] = w.value // still in named map, just not in positional
continue
}
let val = w.value
if ((w.type === 'INT' || w.type === 'FLOAT') && typeof val === 'number' && isNaN(val)) {
warnings.push(
`[ComfyUI] Widget "${w.name}" on node serialized NaN — substituting default (${w.default})`
)
val = w.default
}
named[w.name] = val
}
return { named, warnings }
}
function deserializeWidgets(
named: Record<string, unknown>,
specs: WidgetSpec[],
warn: (msg: string) => void
): Record<string, unknown> {
const out: Record<string, unknown> = {}
for (const spec of specs) {
const raw = named[spec.name]
if ((spec.type === 'INT' || spec.type === 'FLOAT') && raw === null) {
warn(
`[ComfyUI] Widget "${spec.name}" loaded null for numeric widget — restoring default (${spec.default})`
)
out[spec.name] = spec.default
} else {
out[spec.name] = raw ?? spec.default
}
}
return out
}
// ─────────────────────────────────────────────────────────────────────────────
describe('BC.13 v2 contract — per-node serialization interception', () => {
describe("NodeHandle.on('beforeSerialize', fn) — node-level serialization hook (S2.N6, S2.N15)", () => {
it("fires fn with the serialization data object during graphToPrompt(); fn may add custom fields", async () => {
const node = makeNodeSubscriptionManager()
const event = makeEvent({ initialData: { id: 1, type: 'KSampler' } })
node.on('beforeSerialize', async (e) => {
e.data['my_field'] = 'injected'
})
await node.dispatch(event)
expect(event._getData()['my_field']).toBe('injected')
})
it("custom fields added inside on('beforeSerialize') are present in the workflow JSON under the node's entry", async () => {
const node = makeNodeSubscriptionManager()
const initialData: Record<string, unknown> = { id: 42, type: 'PreviewImage' }
const event = makeEvent({ initialData })
node.on('beforeSerialize', async (e) => {
e.data['preview_count'] = 5
e.data['last_preview_url'] = 'blob://abc'
})
await node.dispatch(event)
const serialized: SerializedNode = {
...(event._getData() as object),
widgets_values_named: {}
} as SerializedNode
const json = JSON.parse(JSON.stringify(serialized))
expect(json['preview_count']).toBe(5)
expect(json['last_preview_url']).toBe('blob://abc')
})
it('multiple listeners from different extensions all fire and their custom fields coexist', async () => {
const node = makeNodeSubscriptionManager()
const event = makeEvent({ initialData: { id: 7 } })
node.on('beforeSerialize', async (e) => { e.data['ext_a'] = 'from-A' })
node.on('beforeSerialize', async (e) => { e.data['ext_b'] = 'from-B' })
node.on('beforeSerialize', async (e) => { e.data['ext_c'] = 'from-C' })
await node.dispatch(event)
expect(event._getData()['ext_a']).toBe('from-A')
expect(event._getData()['ext_b']).toBe('from-B')
expect(event._getData()['ext_c']).toBe('from-C')
})
it("listener removed via unsubscribe; subsequent serializations omit its custom fields", async () => {
const node = makeNodeSubscriptionManager()
const unsub = node.on('beforeSerialize', async (e) => {
e.data['removed_field'] = 'should-not-appear'
})
unsub()
expect(node.listenerCount()).toBe(0)
const event = makeEvent({ initialData: {} })
await node.dispatch(event)
expect(event._getData()['removed_field']).toBeUndefined()
})
it('async handler is fully awaited before the next listener runs', async () => {
const node = makeNodeSubscriptionManager()
const order: number[] = []
node.on('beforeSerialize', async (e) => {
await new Promise<void>((r) => setTimeout(r, 10))
order.push(1)
e.data['step'] = 1
})
node.on('beforeSerialize', async (e) => {
// Must see step=1 from the prior handler
order.push(2)
e.data['saw_step'] = e.data['step']
})
const event = makeEvent({ initialData: {} })
await node.dispatch(event)
expect(order).toEqual([1, 2])
expect(event._getData()['saw_step']).toBe(1)
})
it("replace() replaces the entire data object; later listeners see the new object", async () => {
const node = makeNodeSubscriptionManager()
const event = makeEvent({ initialData: { id: 3, orig: true } })
node.on('beforeSerialize', async (e) => {
e.replace((orig) => ({ ...orig, wrapped: true, orig: false }))
})
await node.dispatch(event)
const final = event._getData()
expect(final['wrapped']).toBe(true)
expect(final['orig']).toBe(false)
})
it("context field is passed correctly for 'prompt' serialization context", async () => {
const node = makeNodeSubscriptionManager()
let capturedContext: string | undefined
node.on('beforeSerialize', async (e) => {
capturedContext = e.context
})
const event = makeEvent({ context: 'prompt', initialData: {} })
await node.dispatch(event)
expect(capturedContext).toBe('prompt')
})
})
describe('named-map round-trip (widgets_values_named)', () => {
it('stores widget values keyed by name; map survives JSON round-trip with no null drift', () => {
const widgets: Array<WidgetSpec & { value: unknown }> = [
{ name: 'seed', type: 'INT', default: 0, value: 42 },
{ name: 'steps', type: 'INT', default: 20, value: 30 },
{ name: 'cfg', type: 'FLOAT', default: 7.0, value: 8.5 },
{ name: 'sampler_name', type: 'STRING', default: 'euler', value: 'dpm_2' }
]
const { named } = serializeWidgets(widgets)
const roundTripped: Record<string, unknown> = JSON.parse(JSON.stringify({ named })).named
expect(roundTripped['seed']).toBe(42)
expect(roundTripped['steps']).toBe(30)
expect(roundTripped['cfg']).toBe(8.5)
expect(roundTripped['sampler_name']).toBe('dpm_2')
})
it('workflow with three widgets including serialize===false deserializes correctly regardless of insertion order', () => {
const specs: WidgetSpec[] = [
{ name: 'seed', type: 'INT', default: 0 },
{ name: 'control_after_generate', type: 'STRING', default: 'fixed', serialize: false },
{ name: 'steps', type: 'INT', default: 20 }
]
const widgets: Array<WidgetSpec & { value: unknown }> = [
{ ...specs[0], value: 99 },
{ ...specs[1], value: 'randomize', serialize: false },
{ ...specs[2], value: 15 }
]
const { named } = serializeWidgets(widgets)
// Named map contains all three regardless of insertion order
expect(named['seed']).toBe(99)
expect(named['steps']).toBe(15)
// serialize===false widget still has a named entry (no positional corruption)
expect('control_after_generate' in named).toBe(true)
})
it('widgets added or removed between passes do not corrupt unaffected entries', () => {
const pass1: Array<WidgetSpec & { value: unknown }> = [
{ name: 'seed', type: 'INT', default: 0, value: 1 },
{ name: 'steps', type: 'INT', default: 20, value: 25 }
]
const { named: named1 } = serializeWidgets(pass1)
// Simulate adding a widget between seed and steps
const pass2: Array<WidgetSpec & { value: unknown }> = [
{ name: 'seed', type: 'INT', default: 0, value: 1 },
{ name: 'cfg', type: 'FLOAT', default: 7.0, value: 5.0 }, // new
{ name: 'steps', type: 'INT', default: 20, value: 25 }
]
const { named: named2 } = serializeWidgets(pass2)
// 'steps' is still keyed by name — no positional shift
expect(named1['steps']).toBe(25)
expect(named2['steps']).toBe(25)
expect(named2['cfg']).toBe(5.0)
})
})
describe('NaN→null guard (numeric widget safety)', () => {
it("NaN numeric widget: v2 logs console.warn and substitutes declared default", () => {
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
const widgets: Array<WidgetSpec & { value: unknown }> = [
{ name: 'steps', type: 'INT', default: 20, value: NaN }
]
const { named, warnings } = serializeWidgets(widgets)
expect(named['steps']).toBe(20)
expect(warnings.length).toBe(1)
expect(warnings[0]).toMatch(/steps/)
expect(warnings[0]).toMatch(/NaN/)
warnSpy.mockRestore()
})
it('substituted default value round-trips through JSON correctly', () => {
const widgets: Array<WidgetSpec & { value: unknown }> = [
{ name: 'cfg', type: 'FLOAT', default: 7.5, value: NaN }
]
const { named } = serializeWidgets(widgets)
const json = JSON.parse(JSON.stringify({ named })).named
expect(json['cfg']).toBe(7.5)
expect(json['cfg']).not.toBeNull()
})
it('NaN guard per-widget; does not abort remaining widgets on the same node', () => {
const widgets: Array<WidgetSpec & { value: unknown }> = [
{ name: 'seed', type: 'INT', default: 0, value: NaN },
{ name: 'steps', type: 'INT', default: 20, value: 30 },
{ name: 'cfg', type: 'FLOAT', default: 7.0, value: NaN }
]
const { named, warnings } = serializeWidgets(widgets)
// Two NaN widgets both substituted; steps unaffected
expect(warnings.length).toBe(2)
expect(named['seed']).toBe(0)
expect(named['steps']).toBe(30)
expect(named['cfg']).toBe(7.0)
})
})
})

View File

@@ -0,0 +1,229 @@
// Category: BC.14 — Workflow → API serialization interception (graphToPrompt)
// DB cross-ref: S6.A1
// Exemplar: https://github.com/Comfy-Org/ComfyUI-Manager/blob/main/js/components-manager.js#L781
// blast_radius: 7.02 (HIGHEST in dataset) — compat-floor: MUST pass before v2 ships
// Migration: v1 app.graphToPrompt monkey-patch (S6.A1) → v2 ctx.on('beforePrompt', handler)
//
// S6.A1 classification: 'uwf-resolved' — full migration path goes through UWF Phase 3
// save-time materialization, not beforePrompt alone (decisions/D9 §Phase B, I-PG.B2).
//
// Phase A: No runtime for ctx.on('beforePrompt') yet. This file proves:
// (a) Structural equivalence of v1 monkey-patch and v2 event handler patterns in TypeScript
// (b) That ExtensionOptions.setup() is the Phase B hook point for beforePrompt registration
// (c) That v1 patch call-log patterns are reproducible in a typed event model
// All runtime equivalence cases are marked todo(Phase B + UWF Phase 3).
import { describe, expect, it, vi } from 'vitest'
import type { ExtensionOptions } from '@/extension-api/lifecycle'
// ── V1 pattern: graphToPrompt monkey-patch ────────────────────────────────────
// Models the S6.A1 pattern: extensions replace app.graphToPrompt with a wrapper
// that intercepts the payload, mutates it, then calls the original.
interface ApiPromptOutput { [nodeId: string]: { class_type: string; inputs: Record<string, unknown> } }
interface WorkflowJson { nodes: unknown[]; links: unknown[] }
interface V1App {
graphToPrompt(): { output: ApiPromptOutput; workflow: WorkflowJson }
}
function createV1App(baseOutput: ApiPromptOutput = {}): V1App & { callLog: string[] } {
const callLog: string[] = []
return {
callLog,
graphToPrompt() {
callLog.push('original')
return {
output: { ...baseOutput },
workflow: { nodes: [], links: [] }
}
}
}
}
function applyV1Patch(
app: V1App & { callLog: string[] },
patcher: (payload: { output: ApiPromptOutput; workflow: WorkflowJson }) => void
) {
const original = app.graphToPrompt.bind(app)
app.graphToPrompt = function () {
const result = original()
patcher(result)
app.callLog.push('patched')
return result
}
}
// ── V2 pattern: typed event handler ──────────────────────────────────────────
// Models what ctx.on('beforePrompt', handler) will look like in Phase B.
// The event object is a plain record matching the anticipated BeforePromptEvent shape.
interface BeforePromptEvent {
spec: ApiPromptOutput
workflow: WorkflowJson
reject(reason: string): void
}
function createV2EventBus() {
const handlers: Array<(e: BeforePromptEvent) => void> = []
const rejections: string[] = []
function on(_event: 'beforePrompt', handler: (e: BeforePromptEvent) => void) {
handlers.push(handler)
}
function emit(spec: ApiPromptOutput, workflow: WorkflowJson): { spec: ApiPromptOutput; rejected: string | null } {
const event: BeforePromptEvent = {
spec: { ...spec },
workflow,
reject(reason) { rejections.push(reason) }
}
for (const h of handlers) h(event)
return { spec: event.spec, rejected: rejections.length > 0 ? rejections[0] : null }
}
return { on, emit }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.14 migration — graphToPrompt interception', () => {
describe('structural equivalence of v1 patch and v2 event handler (type-level)', () => {
it('v1 monkey-patch intercepts graphToPrompt and can mutate output keys', () => {
const app = createV1App({ '1': { class_type: 'KSampler', inputs: { steps: 20 } } })
applyV1Patch(app, (payload) => {
payload.output['99'] = { class_type: 'VirtualNode', inputs: {} }
})
const result = app.graphToPrompt()
expect(result.output).toHaveProperty('99')
expect(app.callLog).toEqual(['original', 'patched'])
})
it('v2 beforePrompt handler receives a spec object and can mutate it', () => {
const bus = createV2EventBus()
bus.on('beforePrompt', (e) => {
e.spec['99'] = { class_type: 'VirtualNode', inputs: {} }
})
const baseSpec: ApiPromptOutput = { '1': { class_type: 'KSampler', inputs: { steps: 20 } } }
const { spec } = bus.emit(baseSpec, { nodes: [], links: [] })
expect(spec).toHaveProperty('99')
})
it('both v1 and v2 can inject a custom metadata key into the prompt output', () => {
// v1
const appV1 = createV1App({ '1': { class_type: 'KSampler', inputs: {} } })
applyV1Patch(appV1, (payload) => {
payload.output['_meta'] = { class_type: '__metadata__', inputs: { version: '1.0' } }
})
const v1Result = appV1.graphToPrompt()
// v2
const bus = createV2EventBus()
bus.on('beforePrompt', (e) => {
e.spec['_meta'] = { class_type: '__metadata__', inputs: { version: '1.0' } }
})
const { spec: v2Spec } = bus.emit({ '1': { class_type: 'KSampler', inputs: {} } }, { nodes: [], links: [] })
expect(v1Result.output['_meta']).toEqual(v2Spec['_meta'])
})
it('v1 patch call order: original fires before patch callback — matches v2 handler-before-dispatch ordering', () => {
const app = createV1App()
const order: string[] = []
const originalFn = app.graphToPrompt.bind(app)
app.graphToPrompt = function () {
const r = originalFn()
order.push('patch-handler')
return r
}
app.graphToPrompt()
expect(order[0]).toBe('patch-handler')
expect(app.callLog[0]).toBe('original')
})
})
describe('ExtensionOptions.setup() as the Phase B hook registration point', () => {
it('ExtensionOptions.setup() is defined and can hold async logic (Phase B: register ctx.on here)', () => {
// Phase B: inside setup(), ctx = getCurrentExtensionContext(); ctx.on('beforePrompt', fn)
// Phase A: prove setup() accepts async functions and ExtensionOptions compiles correctly.
const registered: string[] = []
const ext: ExtensionOptions = {
name: 'bc14.mig.setup',
apiVersion: '2',
async setup() {
// Phase B: ctx.on('beforePrompt', handler) goes here
registered.push('setup-called')
}
}
expect(typeof ext.setup).toBe('function')
const result = ext.setup!()
expect(result).toBeInstanceOf(Promise)
return result.then(() => {
expect(registered).toContain('setup-called')
})
})
it('[gap] ExtensionOptions has no beforePrompt field — ctx.on() is the registration mechanism (Phase B)', () => {
// Confirms the pattern: extensions do NOT declare beforePrompt on the options object.
// The handler is registered imperatively inside setup() via the context API.
// This is intentional per D6 §Q4 (no declarative field to avoid Phase A surface bloat).
const ext: ExtensionOptions = { name: 'bc14.mig.gap', setup() {} }
expect('beforePrompt' in ext).toBe(false)
})
})
describe('v2 cancellation shape (type-level)', () => {
it('v2 BeforePromptEvent.reject(reason) is callable and prevents further processing', () => {
const bus = createV2EventBus()
const afterReject = vi.fn()
bus.on('beforePrompt', (e) => {
e.reject('missing required node')
})
bus.on('beforePrompt', afterReject) // second handler still fires in Phase A model
const { rejected } = bus.emit({}, { nodes: [], links: [] })
expect(rejected).toBe('missing required node')
})
})
describe('multiple v2 handlers — each sees prior mutations', () => {
it('handler B sees metadata injected by handler A in the same event cycle', () => {
const bus = createV2EventBus()
bus.on('beforePrompt', (e) => { e.spec['from-A'] = { class_type: 'A', inputs: {} } })
bus.on('beforePrompt', (e) => { e.spec['from-B'] = { class_type: 'B', inputs: { sawA: 'from-A' in e.spec } } })
const { spec } = bus.emit({}, { nodes: [], links: [] })
expect(spec['from-A']).toBeDefined()
expect(spec['from-B'].inputs['sawA']).toBe(true)
})
})
})
// ── Phase B + UWF Phase 3 stubs ───────────────────────────────────────────────
describe('BC.14 migration — graphToPrompt runtime parity [Phase B + UWF Phase 3]', () => {
it.todo(
'[Phase B] v1 monkey-patch and v2 ctx.on("beforePrompt") handler produce identical ApiPromptOutput when given the same base graph'
)
it.todo(
'[Phase B] removing the v1 monkey-patch while keeping the v2 handler produces identical final prompt payload'
)
it.todo(
'[Phase B] v1 patch active alongside v2 handler does not double-mutate the payload (coexistence window)'
)
it.todo(
'[Phase B] v1 throwing inside the patch (cancellation) has equivalent effect to v2 event.reject(reason)'
)
it.todo(
'[UWF Phase 3] S6.A1 graphToPrompt patches that filter virtual nodes are fully replaced by UWF Phase 3 save-time materialization — no extension code needed'
)
it.todo(
'[UWF Phase 3] S9.SG1 Set/Get virtual node connection resolution produces identical backend prompt via resolveConnections vs v1 graphToPrompt patch'
)
})

View File

@@ -0,0 +1,136 @@
// Category: BC.14 — Workflow → API serialization interception (graphToPrompt)
// DB cross-ref: S6.A1
// Exemplar: https://github.com/Comfy-Org/ComfyUI-Manager/blob/main/js/components-manager.js#L781
// blast_radius: 7.02 (HIGHEST in dataset)
// compat-floor: blast_radius ≥ 2.0
// v1 contract: monkey-patch app.graphToPrompt — const orig = app.graphToPrompt.bind(app); app.graphToPrompt = async function(...args) { const r = await orig(...args); /* mutate r */ return r }
// v2 replacement: app.on('beforeGraphToPrompt', (payload) => { /* mutate payload */ }) event with cancellable/mutable payload
import { describe, expect, it } from 'vitest'
import {
countEvidenceExcerpts,
createMiniComfyApp,
loadEvidenceSnippet,
runV1
} from '../harness'
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.14 v1 contract — graphToPrompt monkey-patch', () => {
// ── S6.A1 evidence ───────────────────────────────────────────────────────────
describe('S6.A1 — evidence excerpts', () => {
it('S6.A1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S6.A1')).toBeGreaterThan(0)
})
it('S6.A1 evidence snippet contains graphToPrompt fingerprint', () => {
const snippet = loadEvidenceSnippet('S6.A1', 0)
expect(snippet).toMatch(/graphToPrompt/i)
})
it('S6.A1 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S6.A1', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
// ── S6.A1 synthetic behavior ─────────────────────────────────────────────────
describe('S6.A1 — app.graphToPrompt interception', () => {
it('extension wraps graphToPrompt and calls original; result passes through', async () => {
const mockPrompt = {
output: { '1': { class_type: 'KSampler', inputs: {} } },
workflow: {}
}
const app = {
graphToPrompt: async () => ({ ...mockPrompt })
}
// Extension wraps
const orig = app.graphToPrompt.bind(app)
app.graphToPrompt = async function (...args: Parameters<typeof orig>) {
const r = await orig(...args)
return r
}
const result = await app.graphToPrompt()
expect(result.output).toEqual(mockPrompt.output)
})
it('mutations to the resolved prompt object are reflected in the final result', async () => {
const mockPrompt = {
output: { '1': { class_type: 'KSampler', inputs: {} } } as Record<string, unknown>,
workflow: {} as Record<string, unknown>
}
const app = {
graphToPrompt: async () => ({ ...mockPrompt, output: { ...mockPrompt.output } })
}
// Extension adds custom metadata
const orig = app.graphToPrompt.bind(app)
app.graphToPrompt = async function () {
const r = await orig()
r.output['meta'] = { custom: true } as unknown as (typeof r.output)[string]
return r
}
const result = await app.graphToPrompt()
expect((result.output['meta'] as Record<string, unknown>).custom).toBe(true)
})
it('multiple wrappers in sequence each see prior mutations', async () => {
const base = {
output: { '1': { class_type: 'KSampler', inputs: {} } } as Record<string, unknown>,
workflow: {} as Record<string, unknown>
}
const app = {
graphToPrompt: async () => ({ ...base, output: { ...base.output } })
}
// Extension A wraps first
const origA = app.graphToPrompt.bind(app)
app.graphToPrompt = async function () {
const r = await origA()
r.output['fromA'] = true as unknown as (typeof r.output)[string]
return r
}
// Extension B wraps second (outermost)
const origB = app.graphToPrompt.bind(app)
app.graphToPrompt = async function () {
const r = await origB()
r.output['fromB'] = true as unknown as (typeof r.output)[string]
return r
}
const result = await app.graphToPrompt()
// Both extensions should have contributed
expect(result.output['fromA']).toBe(true)
expect(result.output['fromB']).toBe(true)
})
it('wrapper receives same args passed by caller (args pass-through)', async () => {
const receivedArgs: unknown[][] = []
const app = {
graphToPrompt: async (...args: unknown[]) => {
receivedArgs.push(args)
return { output: {}, workflow: {} }
}
}
const orig = app.graphToPrompt.bind(app)
app.graphToPrompt = async function (...args: Parameters<typeof orig>) {
return orig(...args)
}
// Call with no args — the wrapper must pass them through unchanged
await app.graphToPrompt()
expect(receivedArgs).toHaveLength(1)
})
it.todo(
'virtual node resolution: virtual nodes resolved by the extension wrapper are absent from the serialized output sent to the backend'
)
it.todo(
'full queuePrompt: custom metadata injected into prompt.output is preserved through the full queuePrompt call'
)
it.todo(
'real graphToPrompt implementation: multiple extensions wrapping graphToPrompt via real app wiring all fire in correct order'
)
})
})

View File

@@ -0,0 +1,123 @@
// Category: BC.14 — Workflow → API serialization interception (graphToPrompt)
// DB cross-ref: S6.A1
// Exemplar: https://github.com/Comfy-Org/ComfyUI-Manager/blob/main/js/components-manager.js#L781
// blast_radius: 7.02 (HIGHEST in dataset) — compat-floor: MUST pass before v2 ships
//
// v2 replacement (Phase B): ctx.on('beforePrompt', handler) inside defineExtension setup context.
// Full spec: decisions/D6-parallel-paths-migration.md §Q4
// Virtual nodes (Phase B): virtual:true + resolveConnections(node, graph) → edges[]
// Full spec: decisions/D6-parallel-paths-migration.md §Q5
// S6.A1 classification: 'uwf-resolved' — full migration requires UWF Phase 3 save-time
// materialization (not beforePrompt alone). See decisions/D9-strangler-fig-phases.md §Phase B.
//
// Phase A: beforePrompt is NOT yet on ExtensionOptions; virtual/resolveConnections are NOT yet
// on NodeExtensionOptions. These are Phase B additions pending D6 §Q4/Q5 sign-off.
// This file tests the current type surface and documents gaps precisely.
import { describe, expect, it } from 'vitest'
import type { ExtensionOptions, NodeExtensionOptions } from '@/extension-api/lifecycle'
// ── Phase A — type surface tests ─────────────────────────────────────────────
describe('BC.14 v2 contract — graphToPrompt interception (Phase A type surface)', () => {
describe('ExtensionOptions — current stable surface', () => {
it('ExtensionOptions accepts name, apiVersion, init, and setup — the full Phase A surface', () => {
// Confirm the stable fields compile and accept correct types.
const ext: ExtensionOptions = {
name: 'bc14.test.ext',
apiVersion: '2',
init() {},
setup() {}
}
expect(ext.name).toBe('bc14.test.ext')
expect(ext.apiVersion).toBe('2')
expect(typeof ext.init).toBe('function')
expect(typeof ext.setup).toBe('function')
})
it('ExtensionOptions.name is required — an object without name fails the type check', () => {
// This is a compile-time guarantee; at runtime we assert the field is present.
const ext = { name: 'required', setup() {} } satisfies ExtensionOptions
expect(ext.name).toBeDefined()
})
it('[gap] ExtensionOptions does not yet have a beforePrompt field — Phase B addition', () => {
// beforePrompt / ctx.on('beforePrompt') is documented in D6 §Q4 but not yet on
// the interface. When Phase B lands, this test should be replaced by a real
// type-shape assertion on the handler signature.
const ext: ExtensionOptions = { name: 'bc14.gap.check' }
expect('beforePrompt' in ext).toBe(false)
})
})
describe('NodeExtensionOptions — current stable surface', () => {
it('NodeExtensionOptions accepts name, nodeTypes, nodeCreated, loadedGraphNode', () => {
const ext: NodeExtensionOptions = {
name: 'bc14.node.ext',
nodeTypes: ['SetNode', 'GetNode'],
nodeCreated(_node) {},
loadedGraphNode(_node) {}
}
expect(ext.name).toBe('bc14.node.ext')
expect(ext.nodeTypes).toEqual(['SetNode', 'GetNode'])
})
it('[gap] NodeExtensionOptions does not yet have virtual or resolveConnections — Phase B addition', () => {
// virtual:true + resolveConnections(node, graph) → edges[] is documented in D6 §Q5
// but not yet on the interface. KJNodes Set/Get pattern (S9.SG1) depends on this.
// Classification: uwf-resolved (UWF Phase 3 must know which nodes are layout-only).
const ext: NodeExtensionOptions = { name: 'bc14.virtual.gap' }
expect('virtual' in ext).toBe(false)
expect('resolveConnections' in ext).toBe(false)
})
})
})
// ── Phase B + UWF Phase 3 stubs ───────────────────────────────────────────────
describe('BC.14 v2 contract — beforePrompt runtime [Phase B + UWF Phase 3]', () => {
describe('ctx.on("beforePrompt", handler) — event registration', () => {
it.todo(
'[Phase B] ExtensionOptions accepts a setup() that calls ctx.on("beforePrompt", fn) inside the defineExtension scope context'
)
it.todo(
'[Phase B] beforePrompt handler receives a typed BeforePromptEvent with { spec, workflow } matching the UWF output shape'
)
it.todo(
'[Phase B] mutations to event.spec inside the handler are present in the API body sent to the backend'
)
it.todo(
'[Phase B] handler can reject the prompt via event.reject(reason), preventing queuePrompt from dispatching'
)
it.todo(
'[Phase B] multiple beforePrompt handlers registered across extensions fire in lexicographic name order (D10b)'
)
it.todo(
'[Phase B] each handler sees mutations made by prior handlers in the same event cycle'
)
})
describe('virtual:true + resolveConnections — KJNodes Set/Get class', () => {
it.todo(
'[Phase B] NodeExtensionOptions accepts virtual:true to mark a node type as layout-only (excluded from spec.edges)'
)
it.todo(
'[Phase B] NodeExtensionOptions accepts resolveConnections(node, graph) => ResolvedEdge[] for per-type connection resolution'
)
it.todo(
'[Phase B] resolveConnections receives a read-only graph view (mutations throw in dev mode)'
)
it.todo(
'[UWF Phase 3] virtual nodes absent from spec.edges after UWF Phase 3 save-time materialization runs'
)
it.todo(
'[UWF Phase 3] S9.SG1 Set/Get topology resolved by resolveConnections produces identical backend prompt to v1 graphToPrompt patch'
)
})
describe('cg-use-everywhere bridge (graph-wide topology, not per-type)', () => {
it.todo(
'[Phase B] ctx.on("beforePrompt") is the correct bridge for graph-wide type inference (not resolveConnections, which is per-type)'
)
})
})

View File

@@ -0,0 +1,172 @@
// Category: BC.15 — Workflow loading into the editor
// DB cross-ref: S6.A2
// Exemplar: https://github.com/BennyKok/comfyui-deploy/blob/main/web-plugin/workflow-list.js#L456
// blast_radius: 5.05 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// Migration: v1 app.loadGraphData(json) → v2 app.loadWorkflow(json) with lifecycle hooks
//
// Phase A strategy: prove that v1 interception (wrapping loadGraphData) and
// v2 interception (beforeLoadWorkflow handler) produce structurally equivalent
// outcomes on synthetic workflow fixtures. Shell rendering is todo(Phase B).
//
// I-TF.8.D2 — BC.15 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
import { createMiniComfyApp } from '../harness'
// ── V1 app shim with loadGraphData ────────────────────────────────────────────
interface WorkflowJSON { nodes: Array<{ id: number; type: string }>; links: unknown[] }
function createV1App() {
const loadLog: WorkflowJSON[] = []
let _loadGraphData = (json: WorkflowJSON) => { loadLog.push(json) }
return {
get loadGraphData() { return _loadGraphData },
set loadGraphData(fn: (json: WorkflowJSON) => void) { _loadGraphData = fn },
get loadLog() { return loadLog },
callLoad(json: WorkflowJSON) { _loadGraphData(json) }
}
}
// ── V2 workflow loader (same as bc-15.v2) ────────────────────────────────────
interface BeforeLoadEvent { workflow: WorkflowJSON; cancel(): void }
interface AfterLoadEvent { workflow: WorkflowJSON; nodeCount: number }
function createV2Loader() {
const beforeHandlers: Array<(e: BeforeLoadEvent) => void> = []
const afterHandlers: Array<(e: AfterLoadEvent) => void> = []
const loadLog: WorkflowJSON[] = []
function on(event: 'beforeLoadWorkflow', h: (e: BeforeLoadEvent) => void): () => void
function on(event: 'afterLoadWorkflow', h: (e: AfterLoadEvent) => void): () => void
function on(event: string, h: (e: never) => void): () => void {
const arr = event === 'beforeLoadWorkflow' ? beforeHandlers : afterHandlers as never[]
arr.push(h as never)
return () => { const i = arr.indexOf(h as never); if (i !== -1) arr.splice(i, 1) }
}
async function loadWorkflow(json: WorkflowJSON): Promise<{ loaded: boolean }> {
let cancelled = false
const evt: BeforeLoadEvent = { workflow: { ...json, nodes: [...json.nodes] }, cancel() { cancelled = true } }
for (const h of [...beforeHandlers]) h(evt)
if (cancelled) return { loaded: false }
loadLog.push(evt.workflow)
const afterEvt: AfterLoadEvent = { workflow: evt.workflow, nodeCount: evt.workflow.nodes.length }
for (const h of [...afterHandlers]) h(afterEvt)
return { loaded: true }
}
return { on, loadWorkflow, loadLog }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.15 migration — workflow loading', () => {
describe('load call-count parity', () => {
it('v1 loadGraphData and v2 loadWorkflow each called once per load invocation', async () => {
const v1 = createV1App()
const v2 = createV2Loader()
const workflow: WorkflowJSON = { nodes: [{ id: 1, type: 'KSampler' }], links: [] }
v1.callLoad(workflow)
await v2.loadWorkflow(workflow)
expect(v1.loadLog).toHaveLength(1)
expect(v2.loadLog).toHaveLength(1)
})
})
describe('interception migration — beforeLoad vs loadGraphData monkey-patch', () => {
it('v1 mutation via loadGraphData wrapper and v2 mutation via beforeLoadWorkflow both alter the loaded workflow', async () => {
const v1 = createV1App()
const v2 = createV2Loader()
const v1Seen: WorkflowJSON[] = []
const v2Seen: WorkflowJSON[] = []
// v1: wrap loadGraphData to inject a node
const origV1 = v1.loadGraphData
v1.loadGraphData = (json) => {
const mutated = { ...json, nodes: [...json.nodes, { id: 99, type: 'injected' }] }
v1Seen.push(mutated)
origV1(mutated)
}
// v2: beforeLoadWorkflow handler to inject a node
v2.on('beforeLoadWorkflow', (e) => {
e.workflow.nodes.push({ id: 99, type: 'injected' })
v2Seen.push({ ...e.workflow })
})
const base: WorkflowJSON = { nodes: [{ id: 1, type: 'KSampler' }], links: [] }
v1.callLoad(base)
await v2.loadWorkflow(base)
expect(v1Seen[0].nodes).toHaveLength(2)
expect(v2Seen[0].nodes).toHaveLength(2)
expect(v1Seen[0].nodes[1].type).toBe('injected')
expect(v2Seen[0].nodes[1].type).toBe('injected')
})
})
describe('cancellation migration', () => {
it('v1 no-op wrapper (skip orig call) and v2 event.cancel() both suppress the load', async () => {
const v1 = createV1App()
const v2 = createV2Loader()
// v1: wrapper that swallows the call
v1.loadGraphData = (_json) => { /* intentionally empty — suppressed */ }
// v2: cancel via beforeLoadWorkflow
v2.on('beforeLoadWorkflow', (e) => e.cancel())
const workflow: WorkflowJSON = { nodes: [{ id: 1, type: 'A' }], links: [] }
v1.callLoad(workflow)
const { loaded } = await v2.loadWorkflow(workflow)
expect(v1.loadLog).toHaveLength(0) // inner original was not called
expect(loaded).toBe(false)
expect(v2.loadLog).toHaveLength(0)
})
})
describe('post-load logic migration', () => {
it('v1 synchronous code after loadGraphData and v2 afterLoadWorkflow handler both see the loaded state', async () => {
const v1App = createMiniComfyApp()
const v2 = createV2Loader()
const v1SeenCount: number[] = []
const v2SeenCount: number[] = []
// v1: synchronous post-load
const workflow: WorkflowJSON = { nodes: [{ id: 1, type: 'A' }, { id: 2, type: 'B' }], links: [] }
for (const n of workflow.nodes) v1App.graph.add({ type: n.type })
v1SeenCount.push(v1App.world.allNodes().length)
// v2: afterLoadWorkflow handler
v2.on('afterLoadWorkflow', (e) => v2SeenCount.push(e.nodeCount))
await v2.loadWorkflow(workflow)
expect(v1SeenCount[0]).toBe(2)
expect(v2SeenCount[0]).toBe(2)
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.15 migration — workflow loading [Phase B / shell]', () => {
it.todo(
'[shell] v1 app.loadGraphData(json) and v2 app.loadWorkflow(json) produce identical canvas states for the same workflow'
)
it.todo(
'[shell] widget values are preserved identically between v1 and v2 load paths'
)
it.todo(
'[shell] custom node types registered by extensions are correctly hydrated by both load paths'
)
it.todo(
'[shell] calling v2 app.loadWorkflow does not break extensions that still listen on the legacy nodeCreated hook'
)
})

View File

@@ -0,0 +1,105 @@
// Category: BC.15 — Workflow loading into the editor
// DB cross-ref: S6.A2
// Exemplar: https://github.com/BennyKok/comfyui-deploy/blob/main/web-plugin/workflow-list.js#L456
// blast_radius: 5.05 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// v1 contract: app.loadGraphData(workflowJson) — direct call, no lifecycle events
import { describe, expect, it } from 'vitest'
import {
countEvidenceExcerpts,
createMiniComfyApp,
loadEvidenceSnippet,
runV1
} from '../harness'
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.15 v1 contract — app.loadGraphData', () => {
// ── S6.A2 evidence ───────────────────────────────────────────────────────────
describe('S6.A2 — evidence excerpts', () => {
it('S6.A2 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S6.A2')).toBeGreaterThan(0)
})
it('S6.A2 evidence snippet contains loadGraphData fingerprint', () => {
const count = countEvidenceExcerpts('S6.A2')
let found = false
for (let i = 0; i < count; i++) {
const snippet = loadEvidenceSnippet('S6.A2', i)
if (/loadGraphData/i.test(snippet)) {
found = true
break
}
}
expect(found, 'Expected at least one S6.A2 excerpt with loadGraphData fingerprint').toBe(true)
})
it('S6.A2 snippet is capturable by runV1 without throwing', () => {
const snippet = loadEvidenceSnippet('S6.A2', 0)
const app = createMiniComfyApp()
expect(() => runV1(snippet, { app })).not.toThrow()
})
})
// ── S6.A2 synthetic behavior ─────────────────────────────────────────────────
describe('S6.A2 — direct workflow load', () => {
it('loadGraphData replaces graph nodes with those from the provided JSON', () => {
const app = createMiniComfyApp()
app.graph.add({ type: 'KSampler' })
expect(app.world.allNodes()).toHaveLength(1)
// Simulate loadGraphData clearing the graph and loading new nodes
app.world.clear()
app.graph.add({ type: 'CLIPTextEncode' })
app.graph.add({ type: 'VAEDecode' })
expect(app.world.allNodes()).toHaveLength(2)
expect(app.world.findNodesByType('CLIPTextEncode')).toHaveLength(1)
})
it('calling loadGraphData clears all existing nodes first (world is empty mid-load)', () => {
const app = createMiniComfyApp()
app.graph.add({ type: 'KSampler' })
app.graph.add({ type: 'CLIPTextEncode' })
expect(app.world.allNodes()).toHaveLength(2)
// Simulate loadGraphData: first step is clear
app.world.clear()
expect(app.world.allNodes()).toHaveLength(0)
// Then new nodes are added
app.graph.add({ type: 'VAEDecode' })
expect(app.world.allNodes()).toHaveLength(1)
})
it('accepts a plain JSON object (not a string) — harness world.addNode accepts plain objects too', () => {
const app = createMiniComfyApp()
// The workflow is a plain object literal, not a JSON string
const workflowJson = { nodes: [{ type: 'KSampler' }, { type: 'VAEDecode' }] }
// Simulate loadGraphData: iterate the nodes array and add each
app.world.clear()
for (const nodeSpec of workflowJson.nodes) {
app.world.addNode({ type: nodeSpec.type })
}
expect(app.world.allNodes()).toHaveLength(2)
})
it('node IDs in the loaded workflow are preserved — use world to look up by type after add', () => {
const app = createMiniComfyApp()
app.world.clear()
// Add nodes with specific types; harness assigns sequential IDs
const id1 = app.world.addNode({ type: 'KSampler' })
const id2 = app.world.addNode({ type: 'CLIPTextEncode' })
// Verify that the nodes can be retrieved by their assigned IDs
expect(app.world.findNode(id1)?.type).toBe('KSampler')
expect(app.world.findNode(id2)?.type).toBe('CLIPTextEncode')
// Both IDs are distinct and stable
expect(id1).not.toBe(id2)
})
it.todo(
'real app.loadGraphData implementation: nodeCreated event fires for each deserialized node after loadGraphData completes'
)
it.todo(
'link preservation: edges between nodes are restored after loadGraphData'
)
})
})

View File

@@ -0,0 +1,199 @@
// Category: BC.15 — Workflow loading into the editor
// DB cross-ref: S6.A2
// Exemplar: https://github.com/BennyKok/comfyui-deploy/blob/main/web-plugin/workflow-list.js#L456
// blast_radius: 5.05 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// v2 replacement: app.loadWorkflow(json) — stable public API with beforeLoad/afterLoad hooks
//
// Phase A strategy: test that the MiniComfyApp harness models the v2 load
// contract shape. Real graph deserialization and DOM effects need the shell
// integration (Phase B). Registration + hook firing order can be proved today
// with synthetic mocks.
//
// I-TF.8.D2 — BC.15 v2 wired assertions.
import { describe, expect, it, vi } from 'vitest'
import { createHarnessWorld, createMiniComfyApp } from '../harness'
// ── Synthetic beforeLoad / afterLoad event bus ────────────────────────────────
// Models the app.on('beforeLoadWorkflow') / app.on('afterLoadWorkflow')
// registration contract without a real shell.
interface BeforeLoadEvent {
workflow: Record<string, unknown>
cancel(): void
}
interface AfterLoadEvent {
workflow: Record<string, unknown>
nodeCount: number
}
function createWorkflowLoader() {
const beforeHandlers: Array<(e: BeforeLoadEvent) => void> = []
const afterHandlers: Array<(e: AfterLoadEvent) => void> = []
function on(event: 'beforeLoadWorkflow', handler: (e: BeforeLoadEvent) => void): () => void
function on(event: 'afterLoadWorkflow', handler: (e: AfterLoadEvent) => void): () => void
function on(event: string, handler: (e: never) => void): () => void {
if (event === 'beforeLoadWorkflow') {
beforeHandlers.push(handler as (e: BeforeLoadEvent) => void)
return () => {
const i = beforeHandlers.indexOf(handler as (e: BeforeLoadEvent) => void)
if (i !== -1) beforeHandlers.splice(i, 1)
}
} else {
afterHandlers.push(handler as (e: AfterLoadEvent) => void)
return () => {
const i = afterHandlers.indexOf(handler as (e: AfterLoadEvent) => void)
if (i !== -1) afterHandlers.splice(i, 1)
}
}
}
async function loadWorkflow(json: Record<string, unknown>): Promise<{ loaded: boolean; nodeCount: number }> {
let cancelled = false
const beforeEvt: BeforeLoadEvent = {
workflow: { ...json },
cancel() { cancelled = true }
}
for (const h of [...beforeHandlers]) h(beforeEvt)
if (cancelled) return { loaded: false, nodeCount: 0 }
// Simulate deserialization: count nodes in workflow
const nodes = (beforeEvt.workflow.nodes as unknown[]) ?? []
const nodeCount = nodes.length
const afterEvt: AfterLoadEvent = { workflow: beforeEvt.workflow, nodeCount }
for (const h of [...afterHandlers]) h(afterEvt)
return { loaded: true, nodeCount }
}
return { on, loadWorkflow }
}
// ── Wired assertions (Phase A) ────────────────────────────────────────────────
describe('BC.15 v2 contract — app.loadWorkflow', () => {
describe('core load API shape', () => {
it('loadWorkflow returns a Promise', async () => {
const loader = createWorkflowLoader()
const result = loader.loadWorkflow({ nodes: [], links: [] })
expect(result).toBeInstanceOf(Promise)
await result
})
it('loadWorkflow resolves with loaded: true and the node count for a valid workflow', async () => {
const loader = createWorkflowLoader()
const { loaded, nodeCount } = await loader.loadWorkflow({
nodes: [{ id: 1 }, { id: 2 }, { id: 3 }],
links: []
})
expect(loaded).toBe(true)
expect(nodeCount).toBe(3)
})
it('loadWorkflow resolves with loaded: false and nodeCount 0 when cancelled', async () => {
const loader = createWorkflowLoader()
loader.on('beforeLoadWorkflow', (e) => e.cancel())
const { loaded, nodeCount } = await loader.loadWorkflow({ nodes: [{ id: 1 }], links: [] })
expect(loaded).toBe(false)
expect(nodeCount).toBe(0)
})
it('MiniComfyApp.graph is present and has add/remove/findNodesByType', () => {
const app = createMiniComfyApp()
expect(typeof app.graph.add).toBe('function')
expect(typeof app.graph.remove).toBe('function')
expect(typeof app.graph.findNodesByType).toBe('function')
})
})
describe('beforeLoadWorkflow hook', () => {
it('on("beforeLoadWorkflow", handler) returns an unsubscribe function', () => {
const loader = createWorkflowLoader()
const unsub = loader.on('beforeLoadWorkflow', () => {})
expect(typeof unsub).toBe('function')
})
it('beforeLoadWorkflow handler fires before deserialization', async () => {
const loader = createWorkflowLoader()
const order: string[] = []
loader.on('beforeLoadWorkflow', () => order.push('before'))
await loader.loadWorkflow({ nodes: [], links: [] })
// 'after' fires in afterLoad — before must be first
order.push('load-done')
expect(order[0]).toBe('before')
})
it('handler can mutate event.workflow before deserialization', async () => {
const loader = createWorkflowLoader()
loader.on('beforeLoadWorkflow', (e) => {
e.workflow.nodes = [{ id: 99, type: 'injected' }]
})
const { nodeCount } = await loader.loadWorkflow({ nodes: [], links: [] })
expect(nodeCount).toBe(1)
})
it('calling event.cancel() prevents afterLoadWorkflow from firing', async () => {
const loader = createWorkflowLoader()
const afterHandler = vi.fn()
loader.on('beforeLoadWorkflow', (e) => e.cancel())
loader.on('afterLoadWorkflow', afterHandler)
await loader.loadWorkflow({ nodes: [], links: [] })
expect(afterHandler).not.toHaveBeenCalled()
})
it('unsubscribing a beforeLoadWorkflow handler stops it from firing', async () => {
const loader = createWorkflowLoader()
const handler = vi.fn()
const unsub = loader.on('beforeLoadWorkflow', handler)
unsub()
await loader.loadWorkflow({ nodes: [], links: [] })
expect(handler).not.toHaveBeenCalled()
})
})
describe('afterLoadWorkflow hook', () => {
it('on("afterLoadWorkflow", handler) returns an unsubscribe function', () => {
const loader = createWorkflowLoader()
const unsub = loader.on('afterLoadWorkflow', () => {})
expect(typeof unsub).toBe('function')
})
it('afterLoadWorkflow fires after deserialization with the original workflow and node count', async () => {
const loader = createWorkflowLoader()
let receivedNodeCount = -1
loader.on('afterLoadWorkflow', (e) => { receivedNodeCount = e.nodeCount })
await loader.loadWorkflow({ nodes: [{ id: 1 }, { id: 2 }], links: [] })
expect(receivedNodeCount).toBe(2)
})
it('multiple afterLoadWorkflow handlers all fire in registration order', async () => {
const loader = createWorkflowLoader()
const order: string[] = []
loader.on('afterLoadWorkflow', () => order.push('first'))
loader.on('afterLoadWorkflow', () => order.push('second'))
await loader.loadWorkflow({ nodes: [], links: [] })
expect(order).toEqual(['first', 'second'])
})
})
})
// ── Phase B stubs — shell integration ────────────────────────────────────────
describe('BC.15 v2 contract — app.loadWorkflow [Phase B / shell]', () => {
it.todo(
'[shell] app.loadWorkflow(json) deserializes all node types and renders them to the canvas'
)
it.todo(
'[shell] app.loadWorkflow(json) accepts a JSON string as well as a plain object'
)
it.todo(
'[shell] widget values are fully restored and match the serialized values in the workflow JSON'
)
it.todo(
'[shell] custom node types registered by extensions are correctly hydrated during loadWorkflow'
)
})

View File

@@ -0,0 +1,158 @@
// Category: BC.16 — Execution output consumption (per-node)
// DB cross-ref: S2.N2
// blast_radius: 4.67 (compat-floor)
// Migration: v1 node.onExecuted = fn → v2 NodeHandle.on('executed', fn)
//
// Phase A strategy: prove that v1 assignment and v2 on() registration
// both capture and expose the same event payload structure, using
// synthetic dispatch. Real WebSocket timing is todo(Phase B).
//
// I-TF.8.D2 — BC.16 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
import type { NodeExecutedEvent } from '@/extension-api/node'
// ── V1 node shim ──────────────────────────────────────────────────────────────
interface V1NodeLike {
onExecuted?: (data: { text?: string[]; images?: unknown[] }) => void
}
function createV1Node(): V1NodeLike & { simulateExecuted(data: { text?: string[]; images?: unknown[] }): void } {
const node: V1NodeLike = {}
return {
get onExecuted() { return node.onExecuted },
set onExecuted(fn) { node.onExecuted = fn },
simulateExecuted(data) { node.onExecuted?.(data) }
}
}
// ── V2 event bus (same minimal shape as bc-16.v2) ────────────────────────────
function createV2Bus() {
const handlers: Array<(e: NodeExecutedEvent) => void> = []
return {
on(_evt: 'executed', fn: (e: NodeExecutedEvent) => void) {
handlers.push(fn)
return () => { const i = handlers.indexOf(fn); if (i !== -1) handlers.splice(i, 1) }
},
emit(e: NodeExecutedEvent) { for (const h of [...handlers]) h(e) }
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.16 migration — per-node execution output', () => {
describe('data shape equivalence', () => {
it('v1 onExecuted data.text and v2 executed event.output.text carry the same content', () => {
const v1 = createV1Node()
const v2 = createV2Bus()
const v1Texts: string[][] = []
const v2Texts: string[][] = []
v1.onExecuted = (data) => { if (data.text) v1Texts.push(data.text) }
v2.on('executed', (e) => { if (e.output.text) v2Texts.push(e.output.text) })
const payload = { text: ['Generated text output'], images: [] }
v1.simulateExecuted(payload)
v2.emit({ output: payload })
expect(v1Texts[0]).toEqual(v2Texts[0])
})
it('v1 data.images and v2 event.output.images have the same length', () => {
const v1 = createV1Node()
const v2 = createV2Bus()
let v1ImageCount = -1
let v2ImageCount = -1
v1.onExecuted = (data) => { v1ImageCount = data.images?.length ?? 0 }
v2.on('executed', (e) => { v2ImageCount = e.output.images?.length ?? 0 })
const images = [{ filename: 'a.png', subfolder: '', type: 'output' }]
v1.simulateExecuted({ text: [], images })
v2.emit({ output: { text: [], images } })
expect(v1ImageCount).toBe(v2ImageCount)
})
})
describe('subscription model migration', () => {
it('v1 onExecuted assignment and v2 on() both register exactly one active handler', () => {
const v1 = createV1Node()
const v2 = createV2Bus()
const v1Handler = vi.fn()
const v2Handler = vi.fn()
v1.onExecuted = v1Handler
v2.on('executed', v2Handler)
const data = { text: ['x'], images: [] }
v1.simulateExecuted(data)
v2.emit({ output: data })
expect(v1Handler).toHaveBeenCalledOnce()
expect(v2Handler).toHaveBeenCalledOnce()
})
it('v1 reassignment replaces the handler; v2 unsubscribe + re-on is the equivalent', () => {
const v1 = createV1Node()
const v2 = createV2Bus()
const firstV1 = vi.fn()
const secondV1 = vi.fn()
const firstV2 = vi.fn()
const secondV2 = vi.fn()
v1.onExecuted = firstV1
const unsub = v2.on('executed', firstV2)
// Replace v1 handler
v1.onExecuted = secondV1
// Replace v2 handler
unsub()
v2.on('executed', secondV2)
const data = { text: [], images: [] }
v1.simulateExecuted(data)
v2.emit({ output: data })
expect(firstV1).not.toHaveBeenCalled()
expect(secondV1).toHaveBeenCalledOnce()
expect(firstV2).not.toHaveBeenCalled()
expect(secondV2).toHaveBeenCalledOnce()
})
})
describe('automatic cleanup advantage of v2', () => {
it('v1 onExecuted persists after explicit removal from tracking; v2 unsubscribe removes it cleanly', () => {
const v1 = createV1Node()
const v2 = createV2Bus()
const v1Handler = vi.fn()
const v2Handler = vi.fn()
v1.onExecuted = v1Handler
const unsub = v2.on('executed', v2Handler)
// v2: explicit unsubscribe
unsub()
const data = { text: [], images: [] }
v1.simulateExecuted(data) // v1 still fires (no automatic cleanup in v1)
v2.emit({ output: data }) // v2 handler removed
expect(v1Handler).toHaveBeenCalledOnce()
expect(v2Handler).not.toHaveBeenCalled()
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.16 migration — per-node execution output [Phase B / shell]', () => {
it.todo(
'[Phase B] v1 onExecuted and v2 on("executed") fire at the same point in WebSocket message processing'
)
it.todo(
'[Phase B] v2 on("executed") is automatically cleaned up on node removal; v1 leaks the assignment'
)
})

View File

@@ -0,0 +1,50 @@
// Category: BC.16 — Execution output consumption (per-node)
// DB cross-ref: S2.N2
// blast_radius: 4.67 (compat-floor)
// v1 contract: node.onExecuted(output) — prototype-patched per extension
// TODO(R8): swap with loadEvidenceSnippet('S2.N2', 0) once excerpts populated
import { describe, expect, it } from 'vitest'
import { countEvidenceExcerpts, loadEvidenceSnippet, runV1 } from '../harness'
void [loadEvidenceSnippet, runV1]
describe('BC.16 v1 contract — node.onExecuted callback (S2.N2)', () => {
it('S2.N2 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S2.N2')).toBeGreaterThan(0)
})
it('onExecuted receives the output object with arbitrary keys', () => {
const output = { images: [{ filename: 'out.png', subfolder: '', type: 'output' }] }
let received: unknown
const node = { onExecuted(o: unknown) { received = o } }
node.onExecuted(output)
expect((received as typeof output).images[0].filename).toBe('out.png')
})
it('onExecuted can be prototype-patched; the original is still callable', () => {
const log: string[] = []
const proto = { onExecuted(_o: unknown) { log.push('orig') } }
const orig = proto.onExecuted.bind(proto)
proto.onExecuted = function (o: unknown) { log.push('ext'); orig(o) }
proto.onExecuted({ text: ['hi'] })
expect(log).toEqual(['ext', 'orig'])
})
it('multiple extensions chain onExecuted; all fire in outer-first order', () => {
const log: number[] = []
let fn: (o: unknown) => void = () => { log.push(0) }
fn = ((prev) => (o: unknown) => { log.push(1); prev(o) })(fn)
fn = ((prev) => (o: unknown) => { log.push(2); prev(o) })(fn)
fn({})
expect(log).toEqual([2, 1, 0])
})
it('output object shape for text-type nodes has a text array', () => {
const output: Record<string, unknown> = { text: ['result string'] }
const keys: string[] = []
const node = { onExecuted(o: Record<string, unknown>) { keys.push(...Object.keys(o)) } }
node.onExecuted(output)
expect(keys).toContain('text')
})
})

View File

@@ -0,0 +1,173 @@
// Category: BC.16 — Execution output consumption (per-node)
// DB cross-ref: S2.N2
// Exemplar: https://github.com/andreszs/ComfyUI-Ultralytics-Studio/blob/main/js/show_string.js#L9
// blast_radius: 4.67 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// v2 replacement: NodeHandle.on('executed', handler)
//
// Phase A strategy: prove the on('executed') registration contract and
// NodeExecutedEvent payload shape using a minimal typed event bus.
// Real WebSocket delivery needs Phase B shell integration.
//
// I-TF.8.D2 — BC.16 v2 wired assertions.
import { describe, expect, it, vi } from 'vitest'
import type { NodeExecutedEvent } from '@/extension-api/node'
import type { Unsubscribe } from '@/extension-api/events'
// ── Minimal executed event bus ────────────────────────────────────────────────
function createExecutedBus() {
const handlers: Array<(e: NodeExecutedEvent) => void> = []
function on(_event: 'executed', handler: (e: NodeExecutedEvent) => void): Unsubscribe {
handlers.push(handler)
return () => {
const i = handlers.indexOf(handler)
if (i !== -1) handlers.splice(i, 1)
}
}
function emit(event: NodeExecutedEvent) {
for (const h of [...handlers]) h(event)
}
return { on, emit, handlerCount: () => handlers.length }
}
// ── Fixture ───────────────────────────────────────────────────────────────────
function makeExecutedEvent(overrides: Partial<NodeExecutedEvent> = {}): NodeExecutedEvent {
return {
output: { text: ['hello world'], images: [] },
...overrides
}
}
// ── Wired assertions ──────────────────────────────────────────────────────────
describe('BC.16 v2 contract — NodeHandle executed event', () => {
describe('event subscription shape', () => {
it('on("executed", fn) returns an Unsubscribe function', () => {
const bus = createExecutedBus()
const unsub = bus.on('executed', () => {})
expect(typeof unsub).toBe('function')
})
it('registered handler is called when an executed event fires', () => {
const bus = createExecutedBus()
const handler = vi.fn()
bus.on('executed', handler)
bus.emit(makeExecutedEvent())
expect(handler).toHaveBeenCalledOnce()
})
it('handler receives a NodeExecutedEvent with an output field', () => {
const bus = createExecutedBus()
let received: NodeExecutedEvent | undefined
bus.on('executed', (e) => { received = e })
bus.emit(makeExecutedEvent({ output: { text: ['result'], images: [] } }))
expect(received).toBeDefined()
expect(received!.output).toBeDefined()
})
it('calling Unsubscribe stops future executed events from reaching the handler', () => {
const bus = createExecutedBus()
const handler = vi.fn()
const unsub = bus.on('executed', handler)
bus.emit(makeExecutedEvent())
expect(handler).toHaveBeenCalledOnce()
unsub()
bus.emit(makeExecutedEvent())
expect(handler).toHaveBeenCalledOnce() // no additional call
})
it('calling Unsubscribe twice is safe', () => {
const bus = createExecutedBus()
const unsub = bus.on('executed', vi.fn())
expect(() => { unsub(); unsub() }).not.toThrow()
})
})
describe('NodeExecutedEvent payload shape', () => {
it('event.output.text is an array (string[] for text-output nodes)', () => {
const bus = createExecutedBus()
let output: NodeExecutedEvent['output'] | undefined
bus.on('executed', (e) => { output = e.output })
bus.emit(makeExecutedEvent({ output: { text: ['line1', 'line2'], images: [] } }))
expect(Array.isArray(output!.text)).toBe(true)
expect(output!.text).toEqual(['line1', 'line2'])
})
it('event.output.images is an array', () => {
const bus = createExecutedBus()
let output: NodeExecutedEvent['output'] | undefined
bus.on('executed', (e) => { output = e.output })
bus.emit(makeExecutedEvent({ output: { text: [], images: [] } }))
expect(Array.isArray(output!.images)).toBe(true)
})
it('output fields are accessible without a cast from within the handler', () => {
// Type-level: NodeExecutedEvent.output.text should be string[] — compile-time.
// Runtime: values are accessible as typed properties.
const bus = createExecutedBus()
const texts: string[] = []
bus.on('executed', (e) => {
for (const t of e.output.text ?? []) texts.push(t)
})
bus.emit(makeExecutedEvent({ output: { text: ['alpha', 'beta'], images: [] } }))
expect(texts).toEqual(['alpha', 'beta'])
})
})
describe('multiple handlers', () => {
it('multiple on("executed") handlers all fire independently', () => {
const bus = createExecutedBus()
const handlerA = vi.fn()
const handlerB = vi.fn()
bus.on('executed', handlerA)
bus.on('executed', handlerB)
bus.emit(makeExecutedEvent())
expect(handlerA).toHaveBeenCalledOnce()
expect(handlerB).toHaveBeenCalledOnce()
})
it('unsubscribing one handler does not affect the others', () => {
const bus = createExecutedBus()
const handlerA = vi.fn()
const handlerB = vi.fn()
const unsubA = bus.on('executed', handlerA)
bus.on('executed', handlerB)
unsubA()
bus.emit(makeExecutedEvent())
expect(handlerA).not.toHaveBeenCalled()
expect(handlerB).toHaveBeenCalledOnce()
})
})
describe('handler lifecycle with scope', () => {
it('after all handlers are unsubscribed, the bus has zero active handlers', () => {
const bus = createExecutedBus()
const unsubA = bus.on('executed', vi.fn())
const unsubB = bus.on('executed', vi.fn())
expect(bus.handlerCount()).toBe(2)
unsubA()
unsubB()
expect(bus.handlerCount()).toBe(0)
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.16 v2 contract — NodeHandle executed event [Phase B / shell]', () => {
it.todo(
'[Phase B] NodeHandle.on("executed") fires when the real WebSocket executed message arrives for this node'
)
it.todo(
'[Phase B] handlers registered via on("executed") are automatically removed when the node is removed from the World'
)
it.todo(
'[Phase B] output.images includes filename, subfolder, and type fields matching the backend response schema'
)
})

View File

@@ -0,0 +1,174 @@
// Category: BC.17 — Backend execution lifecycle and progress events
// DB cross-ref: S5.A1, S5.A2, S5.A3
// blast_radius: 5.00 (compat-floor)
// Migration: v1 app.api.addEventListener → v2 comfyApp.on with typed payloads
//
// Phase A strategy: prove that v1 CustomEvent-style registration and v2 on()
// registration both capture and expose the same payload structure for each
// event type, using synthetic dispatch. Real WebSocket timing is todo(Phase B).
//
// I-TF.8.D2 — BC.17 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
// ── V1 event bus (CustomEvent-style addEventListener) ─────────────────────────
function createV1Api() {
const listeners = new Map<string, EventListenerOrEventListenerObject[]>()
return {
addEventListener(type: string, listener: EventListenerOrEventListenerObject) {
if (!listeners.has(type)) listeners.set(type, [])
listeners.get(type)!.push(listener)
},
removeEventListener(type: string, listener: EventListenerOrEventListenerObject) {
const arr = listeners.get(type)
if (arr) { const i = arr.indexOf(listener); if (i !== -1) arr.splice(i, 1) }
},
dispatchCustom(type: string, detail: unknown) {
const event = { type, detail } as unknown as CustomEvent
for (const l of [...(listeners.get(type) ?? [])]) {
if (typeof l === 'function') l(event)
else (l as EventListenerObject).handleEvent(event)
}
}
}
}
// ── V2 app event bus ──────────────────────────────────────────────────────────
function createV2Bus() {
const handlers = new Map<string, Array<(e: unknown) => void>>()
function on(event: string, handler: (e: unknown) => void): () => void {
if (!handlers.has(event)) handlers.set(event, [])
handlers.get(event)!.push(handler)
return () => {
const arr = handlers.get(event)!
const i = arr.indexOf(handler)
if (i !== -1) arr.splice(i, 1)
}
}
function emit(event: string, payload: unknown) {
for (const h of [...(handlers.get(event) ?? [])]) h(payload)
}
return { on, emit }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.17 migration — execution lifecycle events', () => {
describe('S5.A1 — executed / executionError payload equivalence', () => {
it('v1 executed detail and v2 executed payload carry the same nodeId and output', () => {
const v1Api = createV1Api()
const v2 = createV2Bus()
const v1Received: unknown[] = []
const v2Received: unknown[] = []
v1Api.addEventListener('executed', ((e: CustomEvent) => v1Received.push(e.detail)) as EventListener)
v2.on('executed', (e) => v2Received.push(e))
const payload = { nodeId: 'node:g:1', output: { text: ['hello'] } }
v1Api.dispatchCustom('executed', payload)
v2.emit('executed', payload)
expect(v1Received[0]).toEqual(v2Received[0])
})
it('v1 execution_error and v2 executionError carry the same nodeId and message', () => {
const v1Api = createV1Api()
const v2 = createV2Bus()
const v1Detail: unknown[] = []
const v2Payload: unknown[] = []
v1Api.addEventListener('execution_error', ((e: CustomEvent) => v1Detail.push(e.detail)) as EventListener)
v2.on('executionError', (e) => v2Payload.push(e))
const payload = { nodeId: 'node:g:7', message: 'CUDA OOM' }
v1Api.dispatchCustom('execution_error', payload)
v2.emit('executionError', payload)
const v1 = v1Detail[0] as typeof payload
const v2p = v2Payload[0] as typeof payload
expect(v1.nodeId).toBe(v2p.nodeId)
expect(v1.message).toBe(v2p.message)
})
})
describe('S5.A2 — progress payload equivalence', () => {
it('v1 progress {value, max} and v2 progress {step, totalSteps} encode the same completion fraction', () => {
// v1 shape: { value: number, max: number }
// v2 shape: { step: number, totalSteps: number }
const v1Fractions: number[] = []
const v2Fractions: number[] = []
const v1Api = createV1Api()
const v2 = createV2Bus()
v1Api.addEventListener('progress', ((e: CustomEvent) => {
const d = e.detail as { value: number; max: number }
v1Fractions.push(d.value / d.max)
}) as EventListener)
v2.on('progress', (e) => {
const p = e as { step: number; totalSteps: number }
v2Fractions.push(p.step / p.totalSteps)
})
v1Api.dispatchCustom('progress', { value: 8, max: 20 })
v2.emit('progress', { step: 8, totalSteps: 20, nodeId: 'node:g:1' })
expect(v1Fractions[0]).toBeCloseTo(v2Fractions[0])
})
})
describe('handler removal equivalence', () => {
it('v1 removeEventListener and v2 unsubscribe() both prevent subsequent events from reaching the handler', () => {
const v1Api = createV1Api()
const v2 = createV2Bus()
const v1Handler = vi.fn() as EventListenerOrEventListenerObject
const v2Handler = vi.fn()
v1Api.addEventListener('status', v1Handler)
const unsub = v2.on('status', v2Handler)
// Remove both
v1Api.removeEventListener('status', v1Handler)
unsub()
v1Api.dispatchCustom('status', { queueRemaining: 0 })
v2.emit('status', { queueRemaining: 0, running: false })
expect(v1Handler).not.toHaveBeenCalled()
expect(v2Handler).not.toHaveBeenCalled()
})
it('removing a v1 listener does not affect a concurrently registered v2 listener', () => {
const v1Api = createV1Api()
const v2 = createV2Bus()
const v1Handler = vi.fn() as EventListenerOrEventListenerObject
const v2Handler = vi.fn()
v1Api.addEventListener('status', v1Handler)
v2.on('status', v2Handler)
v1Api.removeEventListener('status', v1Handler)
v2.emit('status', { queueRemaining: 1, running: true })
expect(v2Handler).toHaveBeenCalledOnce()
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.17 migration — execution lifecycle events [Phase B / shell]', () => {
it.todo(
'[Phase B] v1 app.api.addEventListener("executed") and v2 on("executed") fire at the same point in WebSocket processing'
)
it.todo(
'[Phase B] v1 "reconnecting" and v2 "reconnecting" both fire before the first reconnect attempt'
)
})

View File

@@ -0,0 +1,63 @@
// Category: BC.17 — Backend execution lifecycle and progress events
// DB cross-ref: S5.A1, S5.A2, S5.A3
// blast_radius: 5.00 (compat-floor)
// v1 contract: api.addEventListener('executed'|'progress'|'executing', fn)
// TODO(R8): swap with loadEvidenceSnippet once excerpts populated
import { describe, expect, it } from 'vitest'
import { countEvidenceExcerpts, loadEvidenceSnippet, runV1 } from '../harness'
void [loadEvidenceSnippet, runV1]
function makeApi() {
const listeners = new Map<string, Array<(e: { detail: unknown }) => void>>()
return {
addEventListener(event: string, fn: (e: { detail: unknown }) => void) {
if (!listeners.has(event)) listeners.set(event, [])
listeners.get(event)!.push(fn)
},
_emit(event: string, detail: unknown) {
listeners.get(event)?.forEach(fn => fn({ detail }))
},
}
}
describe('BC.17 v1 contract — backend execution lifecycle events (S5.A1/A2/A3)', () => {
it('S5.A1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S5.A1')).toBeGreaterThan(0)
})
it("addEventListener('executed') fires with detail.node and detail.output", () => {
const api = makeApi()
let detail: unknown
api.addEventListener('executed', e => { detail = e.detail })
api._emit('executed', { node: '5', output: { images: [] } })
expect((detail as { node: string }).node).toBe('5')
})
it("addEventListener('progress') fires with detail.value and detail.max", () => {
const api = makeApi()
let detail: unknown
api.addEventListener('progress', e => { detail = e.detail })
api._emit('progress', { value: 3, max: 10 })
expect((detail as { value: number; max: number }).value).toBe(3)
expect((detail as { value: number; max: number }).max).toBe(10)
})
it("addEventListener('executing') fires with currently-running node id", () => {
const api = makeApi()
const ids: unknown[] = []
api.addEventListener('executing', e => ids.push((e.detail as { node: string }).node))
api._emit('executing', { node: '7' })
expect(ids).toEqual(['7'])
})
it('multiple listeners on the same event all fire', () => {
const api = makeApi()
const log: number[] = []
api.addEventListener('executed', () => log.push(1))
api.addEventListener('executed', () => log.push(2))
api._emit('executed', {})
expect(log).toEqual([1, 2])
})
})

View File

@@ -0,0 +1,193 @@
// Category: BC.17 — Backend execution lifecycle and progress events
// DB cross-ref: S5.A1, S5.A2, S5.A3
// Exemplar: https://github.com/AIGODLIKE/AIGODLIKE-ComfyUI-Studio/blob/main/loader/components/public/iconRenderer.js#L39
// blast_radius: 5.00 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// v2 replacement: comfyApp.on('executed', fn), comfyApp.on('progress', fn) — typed event payloads
//
// Phase A strategy: prove the registration contract (on() returns Unsubscribe,
// handlers fire when emitted, multiple handlers are independent) using a
// synthetic typed app-level event bus. Real WebSocket delivery is todo(Phase B).
//
// I-TF.8.D2 — BC.17 v2 wired assertions.
import { describe, expect, it, vi } from 'vitest'
import type { Unsubscribe } from '@/extension-api/events'
// ── Typed payload shapes (mirrors what the real shell will emit) ──────────────
interface ExecutedPayload { nodeId: string; output: Record<string, unknown> }
interface ExecutionErrorPayload { nodeId: string; message: string }
interface ExecutionStartPayload { promptId: string }
interface ProgressPayload { step: number; totalSteps: number; nodeId: string }
interface StatusPayload { queueRemaining: number; running: boolean }
interface ReconnectingPayload { attempt: number }
type AppEventMap = {
executed: ExecutedPayload
executionError: ExecutionErrorPayload
executionStart: ExecutionStartPayload
progress: ProgressPayload
status: StatusPayload
reconnecting: ReconnectingPayload
}
// ── Minimal typed app event bus ───────────────────────────────────────────────
function createAppEventBus() {
const handlers = new Map<string, Array<(e: unknown) => void>>()
function on<K extends keyof AppEventMap>(event: K, handler: (e: AppEventMap[K]) => void): Unsubscribe {
if (!handlers.has(event)) handlers.set(event, [])
const arr = handlers.get(event)!
arr.push(handler as (e: unknown) => void)
return () => {
const i = arr.indexOf(handler as (e: unknown) => void)
if (i !== -1) arr.splice(i, 1)
}
}
function emit<K extends keyof AppEventMap>(event: K, payload: AppEventMap[K]) {
for (const h of [...(handlers.get(event) ?? [])]) h(payload)
}
function handlerCount(event: string) { return handlers.get(event)?.length ?? 0 }
return { on, emit, handlerCount }
}
// ── Wired assertions ──────────────────────────────────────────────────────────
describe('BC.17 v2 contract — comfyApp event subscriptions', () => {
describe('S5.A1 — execution lifecycle events', () => {
it('on("executed", fn) returns an Unsubscribe function', () => {
const bus = createAppEventBus()
const unsub = bus.on('executed', () => {})
expect(typeof unsub).toBe('function')
})
it('on("executed") handler fires with typed { nodeId, output } payload', () => {
const bus = createAppEventBus()
let received: ExecutedPayload | undefined
bus.on('executed', (e) => { received = e })
bus.emit('executed', { nodeId: 'node:g:42', output: { text: ['hi'] } })
expect(received).toBeDefined()
expect(received!.nodeId).toBe('node:g:42')
expect(received!.output.text).toEqual(['hi'])
})
it('on("executionError") handler fires with typed { nodeId, message } payload', () => {
const bus = createAppEventBus()
let received: ExecutionErrorPayload | undefined
bus.on('executionError', (e) => { received = e })
bus.emit('executionError', { nodeId: 'node:g:7', message: 'CUDA OOM' })
expect(received!.nodeId).toBe('node:g:7')
expect(received!.message).toBe('CUDA OOM')
})
it('on("executionStart") handler fires with typed { promptId } payload', () => {
const bus = createAppEventBus()
let received: ExecutionStartPayload | undefined
bus.on('executionStart', (e) => { received = e })
bus.emit('executionStart', { promptId: 'abc-123' })
expect(received!.promptId).toBe('abc-123')
})
})
describe('S5.A2 — progress events', () => {
it('on("progress") handler fires with typed { step, totalSteps, nodeId } payload', () => {
const bus = createAppEventBus()
let received: ProgressPayload | undefined
bus.on('progress', (e) => { received = e })
bus.emit('progress', { step: 5, totalSteps: 20, nodeId: 'node:g:1' })
expect(received!.step).toBe(5)
expect(received!.totalSteps).toBe(20)
expect(received!.nodeId).toBe('node:g:1')
})
it('progress percentage (step / totalSteps) encodes the same fraction as v1 (value / max)', () => {
const bus = createAppEventBus()
const fractions: number[] = []
bus.on('progress', (e) => fractions.push(e.step / e.totalSteps))
bus.emit('progress', { step: 10, totalSteps: 20, nodeId: 'node:g:1' })
bus.emit('progress', { step: 20, totalSteps: 20, nodeId: 'node:g:1' })
expect(fractions[0]).toBeCloseTo(0.5)
expect(fractions[1]).toBeCloseTo(1.0)
})
})
describe('S5.A3 — status and connectivity events', () => {
it('on("status") handler fires with typed { queueRemaining, running } payload', () => {
const bus = createAppEventBus()
let received: StatusPayload | undefined
bus.on('status', (e) => { received = e })
bus.emit('status', { queueRemaining: 3, running: true })
expect(received!.queueRemaining).toBe(3)
expect(received!.running).toBe(true)
})
it('on("reconnecting") handler fires with typed { attempt } payload', () => {
const bus = createAppEventBus()
let received: ReconnectingPayload | undefined
bus.on('reconnecting', (e) => { received = e })
bus.emit('reconnecting', { attempt: 1 })
expect(received!.attempt).toBe(1)
})
it('Unsubscribe returned by on() removes the handler', () => {
const bus = createAppEventBus()
const handler = vi.fn()
const unsub = bus.on('status', handler)
bus.emit('status', { queueRemaining: 0, running: false })
expect(handler).toHaveBeenCalledOnce()
unsub()
bus.emit('status', { queueRemaining: 0, running: false })
expect(handler).toHaveBeenCalledOnce() // no new call
})
it('unsubscribing one handler does not affect other subscribers on the same event', () => {
const bus = createAppEventBus()
const handlerA = vi.fn()
const handlerB = vi.fn()
const unsubA = bus.on('status', handlerA)
bus.on('status', handlerB)
unsubA()
bus.emit('status', { queueRemaining: 1, running: true })
expect(handlerA).not.toHaveBeenCalled()
expect(handlerB).toHaveBeenCalledOnce()
})
it('calling Unsubscribe twice does not throw', () => {
const bus = createAppEventBus()
const unsub = bus.on('reconnecting', vi.fn())
expect(() => { unsub(); unsub() }).not.toThrow()
})
})
describe('cross-event independence', () => {
it('"executed" handler does not fire when "progress" is emitted', () => {
const bus = createAppEventBus()
const executedHandler = vi.fn()
bus.on('executed', executedHandler)
bus.emit('progress', { step: 1, totalSteps: 10, nodeId: 'node:g:1' })
expect(executedHandler).not.toHaveBeenCalled()
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.17 v2 contract — comfyApp events [Phase B / shell]', () => {
it.todo(
'[Phase B] on("executed") fires when the real WebSocket "executed" message arrives'
)
it.todo(
'[Phase B] on("progress") fires on each step tick from the real backend'
)
it.todo(
'[Phase B] on("status") fires when queue depth or running state changes via WebSocket'
)
it.todo(
'[Phase B] on("reconnecting") fires before the first reconnect attempt after connection loss'
)
})

View File

@@ -0,0 +1,133 @@
// Category: BC.18 — Backend HTTP calls
// DB cross-ref: S6.A3
// blast_radius: 5.77 (compat-floor)
// Migration: v1 app.api.fetchApi → v2 comfyAPI.fetchApi (same signature, stable import)
//
// Phase A strategy: prove that v1 and v2 both build identical HTTP requests
// from the same inputs, using a fetch mock. Real auth and base-URL behavior
// is todo(Phase B / shell).
//
// I-TF.8.D2 — BC.18 migration wired assertions.
import { describe, expect, it, vi, afterEach } from 'vitest'
// ── V1 app.api shim ───────────────────────────────────────────────────────────
function createV1Api(baseUrl = 'http://localhost:8188') {
return {
async fetchApi(path: string, init?: RequestInit): Promise<Response> {
return globalThis.fetch(`${baseUrl}${path}`, init)
}
}
}
// ── V2 comfyAPI shim ──────────────────────────────────────────────────────────
function createV2ComfyAPI(baseUrl = 'http://localhost:8188') {
return {
async fetchApi(path: string, init?: RequestInit): Promise<Response> {
return globalThis.fetch(`${baseUrl}${path}`, init)
}
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.18 migration — backend HTTP calls', () => {
afterEach(() => vi.restoreAllMocks())
describe('request equivalence', () => {
it('v1 app.api.fetchApi and v2 comfyAPI.fetchApi call fetch with the same URL', async () => {
const mockFetch = vi.spyOn(globalThis, 'fetch').mockResolvedValue(new Response('{}', { status: 200 }))
const v1 = createV1Api()
const v2 = createV2ComfyAPI()
await v1.fetchApi('/api/history')
const v1Url = mockFetch.mock.calls[0][0]
mockFetch.mockClear()
await v2.fetchApi('/api/history')
const v2Url = mockFetch.mock.calls[0][0]
expect(v1Url).toBe(v2Url)
})
it('v1 and v2 both pass RequestInit through to fetch unchanged', async () => {
const mockFetch = vi.spyOn(globalThis, 'fetch').mockResolvedValue(new Response('{}', { status: 200 }))
const v1 = createV1Api()
const v2 = createV2ComfyAPI()
const init: RequestInit = { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: '{"a":1}' }
await v1.fetchApi('/api/prompt', init)
const v1Init = mockFetch.mock.calls[0][1]
mockFetch.mockClear()
await v2.fetchApi('/api/prompt', init)
const v2Init = mockFetch.mock.calls[0][1]
expect(v1Init).toEqual(v2Init)
})
it('FormData uploads produce the same body reference in both v1 and v2', async () => {
const mockFetch = vi.spyOn(globalThis, 'fetch').mockResolvedValue(new Response('{}', { status: 200 }))
const v1 = createV1Api()
const v2 = createV2ComfyAPI()
const form = new FormData()
form.append('image', 'data:image/png;base64,abc')
await v1.fetchApi('/upload/image', { method: 'POST', body: form })
const v1Body = (mockFetch.mock.calls[0][1] as RequestInit).body
mockFetch.mockClear()
await v2.fetchApi('/upload/image', { method: 'POST', body: form })
const v2Body = (mockFetch.mock.calls[0][1] as RequestInit).body
expect(v1Body).toBe(v2Body)
})
})
describe('response handling equivalence', () => {
it('both v1 and v2 resolve with a native Response on 200', async () => {
vi.spyOn(globalThis, 'fetch').mockResolvedValue(new Response('{}', { status: 200 }))
const v1 = createV1Api()
const v2 = createV2ComfyAPI()
const r1 = await v1.fetchApi('/api/system_stats')
const r2 = await v2.fetchApi('/api/system_stats')
expect(r1).toBeInstanceOf(Response)
expect(r2).toBeInstanceOf(Response)
})
it('both v1 and v2 resolve (not reject) on 4xx/5xx', async () => {
vi.spyOn(globalThis, 'fetch').mockResolvedValue(new Response('err', { status: 500 }))
const v1 = createV1Api()
const v2 = createV2ComfyAPI()
const [r1, r2] = await Promise.all([v1.fetchApi('/api/broken'), v2.fetchApi('/api/broken')])
expect(r1.status).toBe(500)
expect(r2.status).toBe(500)
})
})
describe('import-path migration', () => {
it('v2 comfyAPI.fetchApi has the same signature arity as v1 app.api.fetchApi', () => {
const v1 = createV1Api()
const v2 = createV2ComfyAPI()
// Both take (path, init?) → arity 2
expect(v1.fetchApi.length).toBe(2)
expect(v2.fetchApi.length).toBe(2)
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.18 migration — backend HTTP calls [Phase B / shell]', () => {
it.todo(
'[shell] v1 app.api.fetchApi and v2 comfyAPI.fetchApi send identical HTTP requests with the same auth headers'
)
it.todo(
'[shell] comfyAPI.fetchApi is available at extension init time without waiting for app.setup()'
)
})

View File

@@ -0,0 +1,112 @@
// Category: BC.18 — Backend HTTP calls
// DB cross-ref: S6.A3
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/components/common/BackgroundImageUpload.vue#L61
// blast_radius: 5.77 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// v1 contract: app.api.fetchApi('/endpoint', { method: 'POST', body: ... })
import { describe, expect, it, vi } from 'vitest'
// ── Minimal fetchApi shim ─────────────────────────────────────────────────────
// Models the v1 pattern: app.api.fetchApi(path, init) = fetch(baseUrl + path, init)
// No real HTTP calls. Synthetic stub proves the structural contract.
function createFetchApi(baseUrl: string) {
return {
async fetchApi(path: string, init?: RequestInit): Promise<Response> {
const url = baseUrl + path
return fetch(url, init)
}
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.18 v1 contract — app.api.fetchApi', () => {
describe('S6.A3 — authenticated HTTP calls via fetchApi (synthetic)', () => {
it('fetchApi prepends the base URL so callers use relative paths', async () => {
const captured: { url: string; init?: RequestInit }[] = []
global.fetch = vi.fn(async (url: RequestInfo | URL, init?: RequestInit) => {
captured.push({ url: String(url), init })
return new Response('{}', { status: 200 })
}) as typeof fetch
const api = createFetchApi('http://localhost:8188')
await api.fetchApi('/upload/image', { method: 'POST' })
expect(captured[0].url).toBe('http://localhost:8188/upload/image')
})
it('fetchApi passes init options (method, body) through to fetch unchanged', async () => {
const captured: { init?: RequestInit }[] = []
global.fetch = vi.fn(async (_url: RequestInfo | URL, init?: RequestInit) => {
captured.push({ init })
return new Response('{}', { status: 200 })
}) as typeof fetch
const formData = new FormData()
formData.append('file', new Blob(['data'], { type: 'image/png' }), 'test.png')
const api = createFetchApi('http://localhost:8188')
await api.fetchApi('/upload/image', { method: 'POST', body: formData })
expect(captured[0].init?.method).toBe('POST')
expect(captured[0].init?.body).toBe(formData)
})
it('a non-2xx response is returned as resolved Promise — callers must check response.ok', async () => {
global.fetch = vi.fn(async () => new Response('Not Found', { status: 404 })) as typeof fetch
const api = createFetchApi('http://localhost:8188')
const response = await api.fetchApi('/nonexistent')
// v1 contract: does NOT reject on 4xx — callers check response.ok
expect(response.ok).toBe(false)
expect(response.status).toBe(404)
})
it('concurrent fetchApi calls return independent Response objects', async () => {
let callCount = 0
global.fetch = vi.fn(async (url: RequestInfo | URL) => {
callCount++
const n = callCount
return new Response(JSON.stringify({ n }), { status: 200 })
}) as typeof fetch
const api = createFetchApi('http://localhost:8188')
const [r1, r2] = await Promise.all([
api.fetchApi('/endpoint/a'),
api.fetchApi('/endpoint/b')
])
const d1: { n: number } = await r1.json()
const d2: { n: number } = await r2.json()
// Both resolved independently — different call counts
expect(d1.n).not.toBe(d2.n)
})
it('extension can pass Authorization header inside init', async () => {
const captured: { headers?: HeadersInit }[] = []
global.fetch = vi.fn(async (_url: RequestInfo | URL, init?: RequestInit) => {
captured.push({ headers: init?.headers })
return new Response('{}', { status: 200 })
}) as typeof fetch
const api = createFetchApi('http://localhost:8188')
await api.fetchApi('/queue', {
method: 'POST',
headers: { Authorization: 'Bearer test-token' }
})
const hdrs = captured[0].headers as Record<string, string>
expect(hdrs['Authorization']).toBe('Bearer test-token')
})
})
describe('Phase B deferred', () => {
it.todo(
'fetchApi includes ComfyUI session cookie automatically when the browser session is authenticated (Phase B — requires real browser session)'
)
})
})

View File

@@ -0,0 +1,115 @@
// Category: BC.18 — Backend HTTP calls
// DB cross-ref: S6.A3
// blast_radius: 5.77 (compat-floor)
// v2 replacement: comfyAPI.fetchApi(path, opts) — same signature, same auth, stable import
//
// Phase A strategy: prove the fetchApi surface contract using a fetch mock
// (globalThis.fetch replaced by vi.fn). Real base-URL/auth behavior needs
// the shell. Import-path stability and signature shape can be tested today.
//
// I-TF.8.D2 — BC.18 v2 wired assertions.
import { describe, expect, it, vi, afterEach } from 'vitest'
// ── Synthetic fetchApi (mirrors the real shell's contract) ────────────────────
// In the real extension API, comfyAPI.fetchApi prepends the server base URL
// and adds auth headers. Here we prove the shape contract only.
function createFetchApiStub(baseUrl = 'http://localhost:8188') {
async function fetchApi(path: string, init?: RequestInit): Promise<Response> {
const url = path.startsWith('http') ? path : `${baseUrl}${path}`
return globalThis.fetch(url, init)
}
return { fetchApi }
}
// ── Wired assertions ──────────────────────────────────────────────────────────
describe('BC.18 v2 contract — comfyAPI.fetchApi', () => {
afterEach(() => {
vi.restoreAllMocks()
})
describe('API surface shape', () => {
it('fetchApi is a function with signature (path: string, init?: RequestInit) => Promise<Response>', () => {
const { fetchApi } = createFetchApiStub()
expect(typeof fetchApi).toBe('function')
expect(fetchApi.length).toBe(2) // path + init
})
it('fetchApi returns a Promise', () => {
vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(new Response('ok', { status: 200 }))
const { fetchApi } = createFetchApiStub()
const result = fetchApi('/api/history')
expect(result).toBeInstanceOf(Promise)
})
})
describe('request construction', () => {
it('fetchApi prepends the base URL when given a relative path', async () => {
const fetchMock = vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(new Response('{}', { status: 200 }))
const { fetchApi } = createFetchApiStub('http://localhost:8188')
await fetchApi('/api/history')
expect(fetchMock).toHaveBeenCalledWith('http://localhost:8188/api/history', undefined)
})
it('fetchApi passes RequestInit options through to fetch', async () => {
const fetchMock = vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(new Response('{}', { status: 200 }))
const { fetchApi } = createFetchApiStub()
const init: RequestInit = { method: 'POST', body: JSON.stringify({ key: 'val' }), headers: { 'Content-Type': 'application/json' } }
await fetchApi('/api/prompt', init)
expect(fetchMock).toHaveBeenCalledWith(expect.any(String), init)
})
it('fetchApi resolves with the Response object returned by fetch', async () => {
const mockResponse = new Response('{"status":"ok"}', { status: 200, headers: { 'Content-Type': 'application/json' } })
vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(mockResponse)
const { fetchApi } = createFetchApiStub()
const response = await fetchApi('/api/system_stats')
expect(response).toBe(mockResponse)
})
})
describe('non-2xx response handling', () => {
it('fetchApi resolves (does not reject) on 404', async () => {
vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(new Response('Not Found', { status: 404 }))
const { fetchApi } = createFetchApiStub()
const response = await fetchApi('/api/missing')
expect(response.status).toBe(404)
expect(response.ok).toBe(false)
})
it('fetchApi resolves (does not reject) on 500', async () => {
vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(new Response('Server Error', { status: 500 }))
const { fetchApi } = createFetchApiStub()
const response = await fetchApi('/api/broken')
expect(response.status).toBe(500)
})
})
describe('FormData body support', () => {
it('fetchApi accepts a FormData body and passes it to fetch unchanged', async () => {
const fetchMock = vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(new Response('{}', { status: 200 }))
const { fetchApi } = createFetchApiStub()
const form = new FormData()
form.append('filename', 'test.png')
await fetchApi('/upload/image', { method: 'POST', body: form })
const callInit = fetchMock.mock.calls[0][1] as RequestInit
expect(callInit.body).toBe(form)
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.18 v2 contract — comfyAPI.fetchApi [Phase B / shell]', () => {
it.todo(
'[shell] comfyAPI.fetchApi is importable from @comfyorg/extension-api without accessing app.api'
)
it.todo(
'[shell] fetchApi uses the same base URL and authentication headers as v1 app.api.fetchApi'
)
it.todo(
'[shell] fetchApi is available at extension init time without waiting for app.setup() to complete'
)
})

View File

@@ -0,0 +1,153 @@
// Category: BC.19 — Workflow execution trigger
// DB cross-ref: S6.A4
// blast_radius: 6.09 (compat-floor)
// Migration: v1 app.queuePrompt monkey-patch → v2 comfyApp.on('beforeQueuePrompt') + comfyApp.queuePrompt(opts)
//
// Phase A strategy: prove that v1 wrapper pattern (replace queuePrompt, call
// orig selectively) and v2 beforeQueuePrompt (event.cancel / event.payload
// mutation) produce structurally equivalent outcomes on synthetic prompts.
// Real HTTP submission is todo(Phase B).
//
// I-TF.8.D2 — BC.19 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
// ── V1 app shim with patchable queuePrompt ────────────────────────────────────
function createV1App() {
const submitLog: unknown[] = []
let _queuePrompt = async (payload: unknown) => { submitLog.push(payload) }
return {
get queuePrompt() { return _queuePrompt },
set queuePrompt(fn: (payload: unknown) => Promise<void>) { _queuePrompt = fn },
get submitLog() { return submitLog },
async callQueue(payload: unknown) { return _queuePrompt(payload) }
}
}
// ── V2 queue trigger (same as bc-19.v2 shape) ────────────────────────────────
function createV2QueueTrigger() {
const handlers: Array<(e: { payload: Record<string, unknown>; cancel(): void }) => void> = []
const submitLog: unknown[] = []
function on(_evt: 'beforeQueuePrompt', h: (e: { payload: Record<string, unknown>; cancel(): void }) => void) {
handlers.push(h)
return () => { const i = handlers.indexOf(h); if (i !== -1) handlers.splice(i, 1) }
}
async function queuePrompt(opts: { batchCount?: number } = {}) {
let cancelled = false
const payload: Record<string, unknown> = { prompt: {}, extra_data: { extra_pnginfo: {} } }
const evt = { payload, cancel() { cancelled = true } }
for (const h of [...handlers]) { h(evt); if (cancelled) break }
if (!cancelled) submitLog.push({ ...evt.payload, batchCount: opts.batchCount ?? 1 })
return { submitted: !cancelled }
}
return { on, queuePrompt, submitLog }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.19 migration — workflow execution trigger', () => {
describe('payload mutation equivalence', () => {
it('v1 wrapper mutation and v2 event.payload mutation both alter the queued payload', async () => {
const v1 = createV1App()
const v2 = createV2QueueTrigger()
// v1: wrap queuePrompt to inject auth token
const origV1 = v1.queuePrompt
v1.queuePrompt = async (payload: unknown) => {
const p = payload as Record<string, unknown>
p.auth_token = 'tok-v1'
return origV1(p)
}
// v2: inject via beforeQueuePrompt handler
v2.on('beforeQueuePrompt', (e) => { e.payload.auth_token = 'tok-v2' })
await v1.callQueue({ prompt: {}, extra_data: {} })
await v2.queuePrompt()
const v1Submitted = v1.submitLog[0] as Record<string, unknown>
const v2Submitted = v2.submitLog[0] as Record<string, unknown>
expect(v1Submitted.auth_token).toBe('tok-v1')
expect(v2Submitted.auth_token).toBe('tok-v2')
// Both injected an auth_token — structurally equivalent
expect(typeof v1Submitted.auth_token).toBe(typeof v2Submitted.auth_token)
})
})
describe('cancellation equivalence', () => {
it('v1 no-call-orig wrapper and v2 event.cancel() both suppress the submit', async () => {
const v1 = createV1App()
const v2 = createV2QueueTrigger()
// v1: wrapper that swallows the call (does not call orig)
v1.queuePrompt = async (_payload: unknown) => { /* suppressed */ }
// v2: cancel via event
v2.on('beforeQueuePrompt', (e) => e.cancel())
await v1.callQueue({ prompt: {} })
const { submitted } = await v2.queuePrompt()
expect(v1.submitLog).toHaveLength(0)
expect(submitted).toBe(false)
expect(v2.submitLog).toHaveLength(0)
})
})
describe('programmatic trigger equivalence', () => {
it('v1 direct app.queuePrompt(payload) and v2 comfyApp.queuePrompt() both trigger a submit', async () => {
const v1 = createV1App()
const v2 = createV2QueueTrigger()
await v1.callQueue({ prompt: {}, extra_data: {} })
const { submitted } = await v2.queuePrompt()
expect(v1.submitLog).toHaveLength(1)
expect(submitted).toBe(true)
expect(v2.submitLog).toHaveLength(1)
})
})
describe('handler registration count', () => {
it('v1 replaces the handler each time (one active); v2 accumulates handlers (additive)', async () => {
const v1 = createV1App()
const v2 = createV2QueueTrigger()
const v1Calls: number[] = []
const v2Calls: number[] = []
// v1: each assignment replaces
v1.queuePrompt = async (p) => { v1Calls.push(1); return }
v1.queuePrompt = async (p) => { v1Calls.push(2); return }
await v1.callQueue({})
// Only the second (latest) assignment fires
expect(v1Calls).toEqual([2])
// v2: both handlers fire
v2.on('beforeQueuePrompt', () => v2Calls.push(1))
v2.on('beforeQueuePrompt', () => v2Calls.push(2))
await v2.queuePrompt()
expect(v2Calls).toEqual([1, 2])
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.19 migration — workflow execution trigger [Phase B / shell]', () => {
it.todo(
'[Phase B] v1 monkey-patch and v2 beforeQueuePrompt both fire for UI-triggered runs (toolbar Run button)'
)
it.todo(
'[Phase B] a v1 monkey-patch and a v2 beforeQueuePrompt handler active simultaneously do not double-submit'
)
it.todo(
'[Phase B] mutated payload in v2 reaches the backend in the POST body to /api/prompt'
)
})

View File

@@ -0,0 +1,145 @@
// Category: BC.19 — Workflow execution trigger
// DB cross-ref: S6.A4
// Exemplar: https://github.com/MajoorWaldi/ComfyUI-Majoor-AssetsManager/blob/main/js/features/viewer/workflowSidebar/sidebarRunButton.js#L317
// blast_radius: 6.09 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// v1 contract: const orig = app.queuePrompt.bind(app); app.queuePrompt = async function(num, batchCount) { return orig(num, batchCount) }
import { describe, expect, it, vi } from 'vitest'
// ── Minimal app.queuePrompt shim ─────────────────────────────────────────────
// Models the v1 monkey-patch pattern without a real ComfyUI app object.
interface MockApp {
queuePrompt: (number: number, batchCount: number) => Promise<{ queued: boolean }>
}
function createMockApp(): MockApp {
return {
async queuePrompt(number: number, batchCount: number) {
return { queued: true }
}
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.19 v1 contract — app.queuePrompt monkey-patch', () => {
describe('S6.A4 — queuePrompt interception (synthetic)', () => {
it('wrapper replaces app.queuePrompt and delegates to the original', async () => {
const app = createMockApp()
const origCalls: [number, number][] = []
const orig = app.queuePrompt.bind(app)
// v1 pattern: capture and delegate
app.queuePrompt = async function (number, batchCount) {
origCalls.push([number, batchCount])
return orig(number, batchCount)
}
const result = await app.queuePrompt(0, 1)
expect(origCalls).toHaveLength(1)
expect(origCalls[0]).toEqual([0, 1])
expect(result.queued).toBe(true)
})
it('wrapper receives (number, batchCount) arguments matching the call signature', async () => {
const app = createMockApp()
let capturedArgs: [number, number] | undefined
const orig = app.queuePrompt.bind(app)
app.queuePrompt = async function (number, batchCount) {
capturedArgs = [number, batchCount]
return orig(number, batchCount)
}
await app.queuePrompt(2, 4)
expect(capturedArgs).toEqual([2, 4])
})
it('extension can prevent execution by not calling orig() inside the wrapper', async () => {
const app = createMockApp()
const origSpy = vi.fn().mockResolvedValue({ queued: true })
app.queuePrompt = origSpy
const orig = origSpy.bind(app)
let blocked = false
// Extension wrapper: conditionally blocks
app.queuePrompt = async function (number, batchCount) {
if (batchCount === 0) {
blocked = true
return { queued: false } // never calls orig
}
return orig(number, batchCount)
}
const result = await app.queuePrompt(0, 0)
expect(blocked).toBe(true)
expect(origSpy).not.toHaveBeenCalled()
expect(result.queued).toBe(false)
})
it('multiple extensions wrapping queuePrompt execute in wrapping order (LIFO)', async () => {
const app = createMockApp()
const callOrder: string[] = []
const orig0 = app.queuePrompt.bind(app)
app.queuePrompt = async function (n, b) {
callOrder.push('ext-A-pre')
const r = await orig0(n, b)
callOrder.push('ext-A-post')
return r
}
const orig1 = app.queuePrompt.bind(app)
app.queuePrompt = async function (n, b) {
callOrder.push('ext-B-pre')
const r = await orig1(n, b)
callOrder.push('ext-B-post')
return r
}
await app.queuePrompt(0, 1)
// LIFO: B wraps A — B-pre fires first, then A-pre, then A-post, then B-post
expect(callOrder).toEqual(['ext-B-pre', 'ext-A-pre', 'ext-A-post', 'ext-B-post'])
})
it('extension can inject a field into a mutable prompt object before calling orig()', async () => {
const app = createMockApp()
const prompts: Record<string, unknown>[] = []
// Simulate a version of app where queuePrompt receives a prompt object
interface AppWithPrompt {
queuePrompt: (prompt: Record<string, unknown>) => Promise<{ queued: boolean }>
}
const appExt: AppWithPrompt = {
async queuePrompt(prompt) {
prompts.push(prompt)
return { queued: true }
}
}
const origExt = appExt.queuePrompt.bind(appExt)
appExt.queuePrompt = async function (prompt) {
// v1 pattern: inject auth field before delegating
prompt['__auth'] = 'my-token'
return origExt(prompt)
}
await appExt.queuePrompt({ node_1: { class_type: 'KSampler' } })
expect(prompts[0]['__auth']).toBe('my-token')
})
})
describe('Phase B deferred', () => {
it.todo(
'programmatic call to app.queuePrompt(0, 1) from an extension correctly enqueues the current graph and the server receives the prompt (Phase B — requires real ComfyUI API connection)'
)
})
})

View File

@@ -0,0 +1,197 @@
// Category: BC.19 — Workflow execution trigger
// DB cross-ref: S6.A4
// Exemplar: https://github.com/MajoorWaldi/ComfyUI-Majoor-AssetsManager/blob/main/js/features/viewer/workflowSidebar/sidebarRunButton.js#L317
// blast_radius: 6.09 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// v2 replacement: comfyApp.on('beforeQueuePrompt') with event.payload mutation + event.cancel()
//
// Phase A strategy: prove the beforeQueuePrompt registration contract and
// event object shape (payload mutation, cancel(), multiple handlers) using
// a synthetic queue trigger. Real HTTP submission to /prompt is todo(Phase B).
//
// I-TF.8.D2 — BC.19 v2 wired assertions.
import { describe, expect, it, vi } from 'vitest'
import type { Unsubscribe } from '@/extension-api/events'
// ── Synthetic queue trigger ───────────────────────────────────────────────────
interface QueuePayload {
prompt: Record<string, unknown>
extra_data: Record<string, unknown>
client_id?: string
}
interface BeforeQueuePromptEvent {
payload: QueuePayload
cancel(): void
}
function createQueueTrigger() {
const handlers: Array<(e: BeforeQueuePromptEvent) => void> = []
const submitLog: QueuePayload[] = []
function on(_event: 'beforeQueuePrompt', handler: (e: BeforeQueuePromptEvent) => void): Unsubscribe {
handlers.push(handler)
return () => {
const i = handlers.indexOf(handler)
if (i !== -1) handlers.splice(i, 1)
}
}
async function queuePrompt(opts: { batchCount?: number } = {}): Promise<{ submitted: boolean; batchCount: number }> {
const batchCount = opts.batchCount ?? 1
let cancelled = false
const payload: QueuePayload = {
prompt: {},
extra_data: { extra_pnginfo: {} }
}
const event: BeforeQueuePromptEvent = {
payload,
cancel() { cancelled = true }
}
for (const h of [...handlers]) {
h(event)
if (cancelled) break
}
if (cancelled) return { submitted: false, batchCount: 0 }
submitLog.push({ ...event.payload })
return { submitted: true, batchCount }
}
return { on, queuePrompt, submitLog, handlerCount: () => handlers.length }
}
// ── Wired assertions ──────────────────────────────────────────────────────────
describe('BC.19 v2 contract — beforeQueuePrompt event and comfyApp.queuePrompt', () => {
describe('beforeQueuePrompt registration', () => {
it('on("beforeQueuePrompt", fn) returns an Unsubscribe function', () => {
const q = createQueueTrigger()
const unsub = q.on('beforeQueuePrompt', () => {})
expect(typeof unsub).toBe('function')
})
it('handler fires before the prompt is submitted', async () => {
const q = createQueueTrigger()
const order: string[] = []
q.on('beforeQueuePrompt', () => order.push('handler'))
const { submitted } = await q.queuePrompt()
order.push('after')
expect(order[0]).toBe('handler')
expect(submitted).toBe(true)
})
it('handler receives a BeforeQueuePromptEvent with a mutable payload', async () => {
const q = createQueueTrigger()
let receivedPayload: QueuePayload | undefined
q.on('beforeQueuePrompt', (e) => { receivedPayload = e.payload })
await q.queuePrompt()
expect(receivedPayload).toBeDefined()
expect(receivedPayload).toHaveProperty('prompt')
expect(receivedPayload).toHaveProperty('extra_data')
})
})
describe('payload mutation', () => {
it('mutating event.payload.extra_data.extra_pnginfo in the handler persists into the submitted payload', async () => {
const q = createQueueTrigger()
q.on('beforeQueuePrompt', (e) => {
e.payload.extra_data.extra_pnginfo = { workflow: 'injected' }
})
await q.queuePrompt()
expect(q.submitLog[0].extra_data.extra_pnginfo).toEqual({ workflow: 'injected' })
})
it('multiple handlers see each other\'s mutations in order', async () => {
const q = createQueueTrigger()
q.on('beforeQueuePrompt', (e) => { (e.payload.extra_data as Record<string, unknown>).step1 = true })
q.on('beforeQueuePrompt', (e) => {
expect((e.payload.extra_data as Record<string, unknown>).step1).toBe(true)
;(e.payload.extra_data as Record<string, unknown>).step2 = true
})
await q.queuePrompt()
expect(q.submitLog[0].extra_data.step1).toBe(true)
expect(q.submitLog[0].extra_data.step2).toBe(true)
})
})
describe('cancellation', () => {
it('calling event.cancel() prevents the prompt from being submitted', async () => {
const q = createQueueTrigger()
q.on('beforeQueuePrompt', (e) => e.cancel())
const { submitted } = await q.queuePrompt()
expect(submitted).toBe(false)
expect(q.submitLog).toHaveLength(0)
})
it('cancellation by the first handler short-circuits remaining handlers', async () => {
const q = createQueueTrigger()
const secondHandler = vi.fn()
q.on('beforeQueuePrompt', (e) => e.cancel())
q.on('beforeQueuePrompt', secondHandler)
await q.queuePrompt()
expect(secondHandler).not.toHaveBeenCalled()
})
})
describe('programmatic trigger', () => {
it('queuePrompt() resolves with submitted: true when not cancelled', async () => {
const q = createQueueTrigger()
const result = await q.queuePrompt()
expect(result.submitted).toBe(true)
})
it('queuePrompt({ batchCount: 3 }) resolves with batchCount 3', async () => {
const q = createQueueTrigger()
const { batchCount } = await q.queuePrompt({ batchCount: 3 })
expect(batchCount).toBe(3)
})
it('queuePrompt() with no args defaults to batchCount 1', async () => {
const q = createQueueTrigger()
const { batchCount } = await q.queuePrompt()
expect(batchCount).toBe(1)
})
it('queuePrompt() fires beforeQueuePrompt handlers before submitting', async () => {
const q = createQueueTrigger()
const handler = vi.fn()
q.on('beforeQueuePrompt', handler)
await q.queuePrompt()
expect(handler).toHaveBeenCalledOnce()
expect(q.submitLog).toHaveLength(1)
})
})
describe('Unsubscribe', () => {
it('calling Unsubscribe removes the handler; subsequent queuePrompt calls do not invoke it', async () => {
const q = createQueueTrigger()
const handler = vi.fn()
const unsub = q.on('beforeQueuePrompt', handler)
unsub()
await q.queuePrompt()
expect(handler).not.toHaveBeenCalled()
})
it('calling Unsubscribe twice does not throw', () => {
const q = createQueueTrigger()
const unsub = q.on('beforeQueuePrompt', vi.fn())
expect(() => { unsub(); unsub() }).not.toThrow()
})
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.19 v2 contract — beforeQueuePrompt [Phase B / shell]', () => {
it.todo(
'[Phase B] on("beforeQueuePrompt") fires for UI-triggered runs, not just programmatic queuePrompt() calls'
)
it.todo(
'[Phase B] cancellation suppresses the actual HTTP POST to /api/prompt'
)
it.todo(
'[Phase B] mutated extra_data reaches the backend in the POST body'
)
})

View File

@@ -0,0 +1,177 @@
// Category: BC.20 — Custom node-type registration (frontend-only / virtual)
// DB cross-ref: S1.H5, S1.H6, S8.P1
// blast_radius: 5.49 — compat-floor: MUST pass before v2 ships
// Migration: v1 LiteGraph.registerNodeType + isVirtualNode → v2 NodeExtensionOptions + nodeTypes filter
// v1 beforeRegisterNodeDef prototype augmentation → v2 nodeCreated(handle)
//
// Phase A: type-shape and registration contract equivalence using synthetic stubs.
// Virtual exclusion (S8.P1) and resolveConnections are Phase B — marked todo.
//
// I-TF.8 — BC.20 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
import type { NodeExtensionOptions } from '@/extension-api/lifecycle'
// ── V1 app shim ───────────────────────────────────────────────────────────────
interface V1LGraphNode { type: string; id: number }
interface V1Extension {
name: string
beforeRegisterNodeDef?: (nodeType: { comfyClass: string }, nodeDef: { name: string }) => void
nodeCreated?: (node: V1LGraphNode) => void
}
function createV1App() {
const extensions: V1Extension[] = []
const registeredTypes: string[] = []
return {
registerExtension(ext: V1Extension) { extensions.push(ext) },
/** Simulate beforeRegisterNodeDef firing for a batch of node defs */
simulateRegisterNodeDef(nodeType: { comfyClass: string }, nodeDef: { name: string }) {
for (const ext of extensions) {
ext.beforeRegisterNodeDef?.(nodeType, nodeDef)
}
},
simulateNodeCreated(node: V1LGraphNode) {
for (const ext of extensions) ext.nodeCreated?.(node)
},
registerNodeType(type: string) { registeredTypes.push(type) },
get registeredTypes() { return [...registeredTypes] }
}
}
// ── V2 runtime shim ───────────────────────────────────────────────────────────
function createV2Runtime() {
const extensions: NodeExtensionOptions[] = []
let nextId = 1
function register(opts: NodeExtensionOptions) {
extensions.push(opts)
}
function mountNode(comfyClass: string, isLoaded = false) {
const id = nextId++
const handle = { type: comfyClass, comfyClass, entityId: `node:test:${id}` } as Parameters<NonNullable<NodeExtensionOptions['nodeCreated']>>[0]
const sorted = [...extensions].sort((a, b) => a.name.localeCompare(b.name))
for (const ext of sorted) {
if (ext.nodeTypes && !ext.nodeTypes.includes(comfyClass)) continue
const hook = isLoaded ? ext.loadedGraphNode : ext.nodeCreated
hook?.(handle)
}
return id
}
return { register, mountNode }
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.20 migration — custom and virtual node registration', () => {
describe('beforeRegisterNodeDef type-guard → nodeTypes filter (S1.H5, S1.H6)', () => {
it('v1 beforeRegisterNodeDef type-guard and v2 nodeTypes filter produce identical per-type call counts', () => {
const v1 = createV1App()
const v2 = createV2Runtime()
const v1Received: string[] = []
const v2Received: string[] = []
// v1: explicit guard inside beforeRegisterNodeDef
v1.registerExtension({
name: 'bc20.mig.v1-guard',
beforeRegisterNodeDef(nodeType) {
if (nodeType.comfyClass === 'RerouteNode') {
v1Received.push(nodeType.comfyClass)
}
}
})
// v2: declarative filter
v2.register({
name: 'bc20.mig.v2-filter',
nodeTypes: ['RerouteNode'],
nodeCreated(h) { v2Received.push(h.type) }
})
const nodeDefs = ['RerouteNode', 'KSampler', 'RerouteNode', 'CLIPTextEncode']
for (const def of nodeDefs) {
v1.simulateRegisterNodeDef({ comfyClass: def }, { name: def })
v2.mountNode(def)
}
expect(v2Received).toEqual(v1Received)
expect(v2Received).toEqual(['RerouteNode', 'RerouteNode'])
})
it('global extension (no nodeTypes) fires for every node type, matching v1 unguarded handler', () => {
const v1 = createV1App()
const v2 = createV2Runtime()
const v1Count = { n: 0 }
const v2Count = { n: 0 }
v1.registerExtension({ name: 'bc20.mig.v1-global', nodeCreated() { v1Count.n++ } })
v2.register({ name: 'bc20.mig.v2-global', nodeCreated() { v2Count.n++ } })
const types = ['RerouteNode', 'KSampler', 'CLIPTextEncode']
types.forEach((t, i) => v1.simulateNodeCreated({ type: t, id: i }))
types.forEach((t) => v2.mountNode(t))
expect(v2Count.n).toBe(v1Count.n)
expect(v2Count.n).toBe(3)
})
})
describe('nodeCreated as replacement for prototype augmentation (S1.H6)', () => {
it('v2 nodeCreated fires once per instance, matching v1 nodeCreated per-instance semantics', () => {
const v2 = createV2Runtime()
const created = vi.fn()
v2.register({ name: 'bc20.mig.per-instance', nodeCreated: created })
v2.mountNode('KSampler')
v2.mountNode('KSampler')
v2.mountNode('CLIPTextEncode')
expect(created).toHaveBeenCalledTimes(3)
})
it('nodeCreated receives the correct type for each mounted node', () => {
const v2 = createV2Runtime()
const types: string[] = []
v2.register({ name: 'bc20.mig.type-check', nodeCreated(h) { types.push(h.type) } })
v2.mountNode('KSampler')
v2.mountNode('RerouteNode')
expect(types).toEqual(['KSampler', 'RerouteNode'])
})
})
describe('D10b lexicographic hook ordering — v2 only', () => {
it('multiple v2 extensions fire in lexicographic name order for the same node type', () => {
const v2 = createV2Runtime()
const order: string[] = []
v2.register({ name: 'bc20.mig.z', nodeCreated() { order.push('z') } })
v2.register({ name: 'bc20.mig.a', nodeCreated() { order.push('a') } })
v2.register({ name: 'bc20.mig.m', nodeCreated() { order.push('m') } })
v2.mountNode('TestNode')
expect(order).toEqual(['a', 'm', 'z'])
})
})
describe('[gap] isVirtualNode / virtual:true serialization equivalence (S8.P1)', () => {
it.todo(
'[gap] v1 isVirtualNode=true and v2 virtual:true both exclude the node from graphToPrompt output. ' +
'Phase B required — virtual:true field not yet on NodeExtensionOptions.'
)
it.todo(
'[gap] link re-routing through virtual nodes: v1 graphToPrompt patch and v2 resolveConnections produce equivalent source→target pairs. ' +
'Phase B required — resolveConnections not yet on NodeExtensionOptions.'
)
it.todo(
'[gap] canvas rendering of a virtual node registered via v2 defineNodeExtension is identical to v1 LiteGraph.registerNodeType. ' +
'Phase B required — canvas render system not in harness.'
)
})
})

View File

@@ -0,0 +1,222 @@
// Category: BC.20 — Custom node-type registration (frontend-only / virtual)
// DB cross-ref: S1.H5, S1.H6, S8.P1
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/rerouteNode.ts
// blast_radius: 5.49 (compat-floor)
// compat-floor: blast_radius ≥ 2.0
// v1 contract: LiteGraph.registerNodeType('MyType', MyClass)
// MyClass.prototype.isVirtualNode = true
// registerExtension({ beforeRegisterNodeDef(nodeType, nodeData) { ... } })
import { describe, expect, it, vi } from 'vitest'
// ── Minimal LiteGraph.registerNodeType shim ───────────────────────────────────
interface NodeConstructor {
new (): { type?: string }
prototype: { isVirtualNode?: boolean; type?: string }
}
function createMockLiteGraph() {
const registry = new Map<string, NodeConstructor>()
return {
registerNodeType(typeName: string, NodeClass: NodeConstructor) {
NodeClass.prototype.type = typeName
registry.set(typeName, NodeClass)
},
createNode(typeName: string) {
const Cls = registry.get(typeName)
return Cls ? new Cls() : undefined
},
has(typeName: string) {
return registry.has(typeName)
},
get(typeName: string) {
return registry.get(typeName)
}
}
}
// ── Minimal extension registration shim ──────────────────────────────────────
interface NodeDef { name: string; inputs: Record<string, unknown> }
interface NodeTypeStub { prototype: Record<string, unknown>; name: string }
function createMockApp(LiteGraph: ReturnType<typeof createMockLiteGraph>) {
const extensions: { beforeRegisterNodeDef?: (nt: NodeTypeStub, nd: NodeDef) => void; registerCustomNodes?: (app: unknown) => void }[] = []
return {
registerExtension(ext: (typeof extensions)[0]) {
extensions.push(ext)
},
simulateBeforeRegisterNodeDef(nodeType: NodeTypeStub, nodeData: NodeDef) {
for (const ext of extensions) {
ext.beforeRegisterNodeDef?.(nodeType, nodeData)
}
},
simulateSetup() {
for (const ext of extensions) {
ext.registerCustomNodes?.(this)
}
},
LiteGraph
}
}
// ── Minimal prompt serializer ─────────────────────────────────────────────────
// v1 graphToPrompt excludes virtual nodes from backend payload.
function serializeGraph(nodes: Array<{ id: number; type: string; constructor: NodeConstructor }>) {
const output: Record<number, { class_type: string }> = {}
for (const node of nodes) {
if (!node.constructor.prototype.isVirtualNode) {
output[node.id] = { class_type: node.type }
}
}
return output
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.20 v1 contract — LiteGraph.registerNodeType and isVirtualNode', () => {
describe('S1.H5 — registerCustomNodes hook (synthetic)', () => {
it('registerExtension({ registerCustomNodes(app) }) is called during setup', () => {
const LiteGraph = createMockLiteGraph()
const app = createMockApp(LiteGraph)
const setupFn = vi.fn()
app.registerExtension({ registerCustomNodes: setupFn })
app.simulateSetup()
expect(setupFn).toHaveBeenCalledOnce()
})
it('LiteGraph.registerNodeType inside registerCustomNodes makes the type instantiable', () => {
const LiteGraph = createMockLiteGraph()
const app = createMockApp(LiteGraph)
class MyRerouteNode { }
app.registerExtension({
registerCustomNodes() {
LiteGraph.registerNodeType('MyReroute', MyRerouteNode as unknown as NodeConstructor)
}
})
app.simulateSetup()
expect(LiteGraph.has('MyReroute')).toBe(true)
const instance = LiteGraph.createNode('MyReroute')
expect(instance).toBeDefined()
})
it('setting MyClass.prototype.isVirtualNode = true marks the type as virtual', () => {
const LiteGraph = createMockLiteGraph()
const app = createMockApp(LiteGraph)
class VirtualNode { }
VirtualNode.prototype.isVirtualNode = true
app.registerExtension({
registerCustomNodes() {
LiteGraph.registerNodeType('VirtualReroute', VirtualNode as unknown as NodeConstructor)
}
})
app.simulateSetup()
const Cls = LiteGraph.get('VirtualReroute')
expect(Cls?.prototype.isVirtualNode).toBe(true)
})
})
describe('S1.H6 — beforeRegisterNodeDef hook (synthetic)', () => {
it('beforeRegisterNodeDef fires for each node type being registered', () => {
const LiteGraph = createMockLiteGraph()
const app = createMockApp(LiteGraph)
const seenTypes: string[] = []
app.registerExtension({
beforeRegisterNodeDef(nodeType) {
seenTypes.push(nodeType.name)
}
})
app.simulateBeforeRegisterNodeDef({ prototype: {}, name: 'KSampler' }, { name: 'KSampler', inputs: {} })
app.simulateBeforeRegisterNodeDef({ prototype: {}, name: 'CLIPTextEncode' }, { name: 'CLIPTextEncode', inputs: {} })
expect(seenTypes).toEqual(['KSampler', 'CLIPTextEncode'])
})
it('extension can augment nodeType prototype inside beforeRegisterNodeDef', () => {
const LiteGraph = createMockLiteGraph()
const app = createMockApp(LiteGraph)
const nodeType: NodeTypeStub = { prototype: {}, name: 'KSampler' }
app.registerExtension({
beforeRegisterNodeDef(nt) {
nt.prototype['myExtensionData'] = 'injected'
}
})
app.simulateBeforeRegisterNodeDef(nodeType, { name: 'KSampler', inputs: {} })
expect(nodeType.prototype['myExtensionData']).toBe('injected')
})
it('multiple extensions firing beforeRegisterNodeDef each see the same nodeType', () => {
const LiteGraph = createMockLiteGraph()
const app = createMockApp(LiteGraph)
const results: string[] = []
app.registerExtension({ beforeRegisterNodeDef(nt) { nt.prototype['extA'] = true; results.push('A') } })
app.registerExtension({ beforeRegisterNodeDef(nt) { nt.prototype['extB'] = true; results.push('B') } })
const nt: NodeTypeStub = { prototype: {}, name: 'VAEDecode' }
app.simulateBeforeRegisterNodeDef(nt, { name: 'VAEDecode', inputs: {} })
expect(results).toEqual(['A', 'B'])
expect(nt.prototype['extA']).toBe(true)
expect(nt.prototype['extB']).toBe(true)
})
})
describe('S8.P1 — virtual node payload suppression (synthetic)', () => {
it('serializeGraph excludes nodes with isVirtualNode === true from the output', () => {
class RealNode { }
class VirtualNode { }
VirtualNode.prototype.isVirtualNode = true
const nodes = [
{ id: 1, type: 'KSampler', constructor: RealNode as unknown as NodeConstructor },
{ id: 2, type: 'VirtualReroute', constructor: VirtualNode as unknown as NodeConstructor },
{ id: 3, type: 'CLIPTextEncode', constructor: RealNode as unknown as NodeConstructor }
]
const output = serializeGraph(nodes)
expect(Object.keys(output)).toHaveLength(2)
expect(output[1]).toBeDefined()
expect(output[3]).toBeDefined()
expect(output[2]).toBeUndefined() // virtual node excluded
})
it('non-virtual nodes are all included in the serialized output', () => {
class RealNode { }
const nodes = [
{ id: 10, type: 'KSampler', constructor: RealNode as unknown as NodeConstructor },
{ id: 11, type: 'VAEDecode', constructor: RealNode as unknown as NodeConstructor }
]
const output = serializeGraph(nodes)
expect(Object.keys(output)).toHaveLength(2)
})
})
describe('Phase B deferred', () => {
it.todo(
'virtual node is still visible and interactive in the LiteGraph canvas — requires real LiteGraph canvas (Phase B)'
)
it.todo(
'links connected to a virtual node are re-routed in the serialized output to preserve logical connectivity (Phase B + UWF Phase 3)'
)
})
})

View File

@@ -0,0 +1,186 @@
// Category: BC.20 — Custom node-type registration (frontend-only / virtual)
// DB cross-ref: S1.H5, S1.H6, S8.P1
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/rerouteNode.ts
// blast_radius: 5.49 — compat-floor: MUST pass before v2 ships
//
// Phase A findings (from lifecycle.ts inspection):
// - NodeExtensionOptions does NOT yet have `virtual: true` or `resolveConnections` fields.
// These are planned for Phase B per D6 §Q5 decision.
// - What IS testable today: NodeExtensionOptions shape, defineNodeExtension registration,
// type-scoped filtering (nodeTypes:[]), and the documented gap.
//
// I-TF.8 — BC.20 v2 wired assertions.
import { describe, expect, it } from 'vitest'
import type { NodeExtensionOptions, WidgetExtensionOptions } from '@/extension-api/lifecycle'
// ── Type-shape helpers ────────────────────────────────────────────────────────
/** Simulate the runtime registration registry (no ECS dependency). */
function createNodeExtensionRegistry() {
const extensions: NodeExtensionOptions[] = []
return {
register(opts: NodeExtensionOptions) { extensions.push(opts) },
getAll() { return [...extensions] },
findByName(name: string) { return extensions.find((e) => e.name === name) },
clear() { extensions.length = 0 }
}
}
function createWidgetExtensionRegistry() {
const extensions: WidgetExtensionOptions[] = []
return {
register(opts: WidgetExtensionOptions) { extensions.push(opts) },
findByType(type: string) { return extensions.find((e) => e.type === type) },
clear() { extensions.length = 0 }
}
}
// ── Wired assertions (Phase A) ────────────────────────────────────────────────
describe('BC.20 v2 contract — custom node-type registration', () => {
describe('NodeExtensionOptions shape — what is testable today', () => {
it('NodeExtensionOptions accepts name, nodeTypes, nodeCreated, loadedGraphNode', () => {
// Type-shape assertion: if this compiles, the interface is correct.
const opts: NodeExtensionOptions = {
name: 'bc20.test.reroute',
nodeTypes: ['RerouteNode'],
nodeCreated(_node) {},
loadedGraphNode(_node) {}
}
expect(opts.name).toBe('bc20.test.reroute')
expect(opts.nodeTypes).toEqual(['RerouteNode'])
expect(typeof opts.nodeCreated).toBe('function')
expect(typeof opts.loadedGraphNode).toBe('function')
})
it('NodeExtensionOptions with no nodeTypes is valid (global registration — all node types)', () => {
const opts: NodeExtensionOptions = { name: 'bc20.test.global' }
const reg = createNodeExtensionRegistry()
reg.register(opts)
expect(reg.findByName('bc20.test.global')).toBeDefined()
expect(reg.findByName('bc20.test.global')!.nodeTypes).toBeUndefined()
})
it('multiple extensions can register the same nodeTypes without conflict', () => {
const reg = createNodeExtensionRegistry()
reg.register({ name: 'bc20.test.extA', nodeTypes: ['SetNode'] })
reg.register({ name: 'bc20.test.extB', nodeTypes: ['SetNode'] })
const all = reg.getAll()
expect(all).toHaveLength(2)
expect(all.every((e) => e.nodeTypes?.includes('SetNode'))).toBe(true)
})
it('name is the unique identity key for the registry', () => {
const reg = createNodeExtensionRegistry()
reg.register({ name: 'bc20.test.unique', nodeTypes: ['A'] })
const found = reg.findByName('bc20.test.unique')
expect(found).toBeDefined()
expect(found!.name).toBe('bc20.test.unique')
})
})
describe('nodeTypes filter — dispatch simulation', () => {
it('type-scoped extension only receives nodes matching nodeTypes', () => {
const received: string[] = []
const ext: NodeExtensionOptions = {
name: 'bc20.test.type-scoped',
nodeTypes: ['RerouteNode'],
nodeCreated(node) { received.push(node.type) }
}
// Simulate runtime dispatch (filter by nodeTypes before calling hook).
const allTypes = ['RerouteNode', 'KSampler', 'RerouteNode', 'CLIPTextEncode']
for (const type of allTypes) {
if (!ext.nodeTypes || ext.nodeTypes.includes(type)) {
// Minimal handle stub — only `type` matters here.
ext.nodeCreated?.({ type, comfyClass: type } as Parameters<NonNullable<typeof ext.nodeCreated>>[0])
}
}
expect(received).toEqual(['RerouteNode', 'RerouteNode'])
})
it('global extension (no nodeTypes) receives all node types', () => {
const received: string[] = []
const ext: NodeExtensionOptions = {
name: 'bc20.test.global-dispatch',
nodeCreated(node) { received.push(node.type) }
}
const allTypes = ['RerouteNode', 'KSampler', 'CLIPTextEncode']
for (const type of allTypes) {
if (!ext.nodeTypes || ext.nodeTypes.includes(type)) {
ext.nodeCreated?.({ type, comfyClass: type } as Parameters<NonNullable<typeof ext.nodeCreated>>[0])
}
}
expect(received).toHaveLength(3)
})
})
describe('WidgetExtensionOptions shape — custom widget type', () => {
it('WidgetExtensionOptions accepts name, type, widgetCreated', () => {
const opts: WidgetExtensionOptions = {
name: 'bc20.test.color-picker',
type: 'COLOR_PICKER',
widgetCreated(_widget, _parentNode) {
return {
render(_container: HTMLElement) {},
destroy() {}
}
}
}
expect(opts.type).toBe('COLOR_PICKER')
expect(typeof opts.widgetCreated).toBe('function')
})
it('WidgetExtensionOptions.type is the unique widget type key', () => {
const reg = createWidgetExtensionRegistry()
reg.register({ name: 'bc20.test.wext', type: 'MY_WIDGET' })
expect(reg.findByType('MY_WIDGET')).toBeDefined()
expect(reg.findByType('UNKNOWN_TYPE')).toBeUndefined()
})
})
describe('[gap] virtual: true and resolveConnections — Phase B', () => {
it.todo(
'[gap] NodeExtensionOptions does not yet have a `virtual: true` field. ' +
'Phase B: add virtual?: boolean to NodeExtensionOptions per D6 §Q5 decision. ' +
'Virtual nodes are excluded from the ECS spec edges / graphToPrompt output.'
)
it.todo(
'[gap] NodeExtensionOptions does not yet have resolveConnections(node, graph) → edges[]. ' +
'Phase B: KJNodes-style Set/Get node virtual wiring. See D6 §Q5 for full API shape.'
)
it.todo(
'[gap] isVirtualNode=true prototype property (S8.P1) has no v2 equivalent until Phase B virtual:true lands. ' +
'Until then, extensions must continue using the v1 isVirtualNode pattern.'
)
})
})
// ── Phase B stubs ─────────────────────────────────────────────────────────────
describe('BC.20 v2 contract — virtual node registration [Phase B]', () => {
describe('virtual: true exclusion from ECS spec edges', () => {
it.todo(
'NodeExtensionOptions { virtual: true } excludes matching nodes from world.entitiesWith(SpecEdgeKey)'
)
it.todo(
'virtual: true nodes are present in the canvas World but absent from the graphToPrompt payload'
)
})
describe('resolveConnections(node, graph) → ResolvedEdges', () => {
it.todo(
'resolveConnections is called at prompt-build time with a read-only graph view'
)
it.todo(
'returned edges replace the virtual node links in the spec with direct source→target connections'
)
it.todo(
'resolveConnections must be a pure function — mutations to node/graph are rejected in dev mode'
)
})
})

View File

@@ -0,0 +1,154 @@
// Category: BC.21 — Custom widget-type registration
// DB cross-ref: S1.H2
// blast_radius: 4.32 — compat-floor: MUST pass before v2 ships
// Migration: v1 getCustomWidgets({ app }) factory → v2 defineWidgetExtension({ type, widgetCreated })
//
// Phase A: registration shape and widgetCreated contract equivalence.
// Runtime wiring (widgets appear in node after creation) is Phase B.
//
// I-TF.8 — BC.21 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
import type { WidgetExtensionOptions } from '@/extension-api/lifecycle'
// ── V1 app shim ───────────────────────────────────────────────────────────────
interface V1CustomWidget {
type: string
render: (container: HTMLElement) => void
}
interface V1Extension {
name: string
getCustomWidgets?(): Record<string, V1CustomWidget>
}
function createV1App() {
const extensions: V1Extension[] = []
const registeredWidgets: Map<string, V1CustomWidget> = new Map()
return {
registerExtension(ext: V1Extension) {
extensions.push(ext)
if (ext.getCustomWidgets) {
const widgets = ext.getCustomWidgets()
for (const [type, widget] of Object.entries(widgets)) {
registeredWidgets.set(type, widget)
}
}
},
findWidget(type: string) { return registeredWidgets.get(type) },
get widgetTypes() { return [...registeredWidgets.keys()] }
}
}
// ── V2 registry shim ──────────────────────────────────────────────────────────
function createV2WidgetRegistry() {
const extensions: WidgetExtensionOptions[] = []
return {
register(opts: WidgetExtensionOptions) { extensions.push(opts) },
findByType(type: string) { return extensions.find((e) => e.type === type) },
get widgetTypes() { return extensions.map((e) => e.type) }
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.21 migration — custom widget-type registration', () => {
describe('getCustomWidgets → defineWidgetExtension registration equivalence', () => {
it('v1 getCustomWidgets and v2 defineWidgetExtension both make the widget type discoverable by type string', () => {
const v1 = createV1App()
const v2 = createV2WidgetRegistry()
v1.registerExtension({
name: 'bc21.mig.v1',
getCustomWidgets() {
return { MY_WIDGET: { type: 'MY_WIDGET', render() {} } }
}
})
v2.register({ name: 'bc21.mig.v2', type: 'MY_WIDGET' })
expect(v1.findWidget('MY_WIDGET')).toBeDefined()
expect(v2.findByType('MY_WIDGET')).toBeDefined()
})
it('both v1 and v2 registrations produce distinct per-type entries — no type collision', () => {
const v1 = createV1App()
const v2 = createV2WidgetRegistry()
const types = ['WIDGET_A', 'WIDGET_B', 'WIDGET_C']
for (const type of types) {
v1.registerExtension({
name: `bc21.mig.v1.${type}`,
getCustomWidgets() { return { [type]: { type, render() {} } } }
})
v2.register({ name: `bc21.mig.v2.${type}`, type })
}
expect(v1.widgetTypes.sort()).toEqual(types.sort())
expect(v2.widgetTypes.sort()).toEqual(types.sort())
})
})
describe('widgetCreated callback contract', () => {
it('v2 widgetCreated fires once per widget instance, matching v1 factory invocation semantics', () => {
const v2Created = vi.fn()
const opts: WidgetExtensionOptions = {
name: 'bc21.mig.per-instance',
type: 'COUNTER_WIDGET',
widgetCreated: v2Created
}
// Simulate runtime calling widgetCreated for 3 widget instances of this type.
const stubs = [1, 2, 3].map((i) => ({
entityId: i as WidgetExtensionOptions['name'] extends string ? number : never,
name: `counter_${i}`,
widgetType: 'COUNTER_WIDGET'
}))
for (const stub of stubs) {
opts.widgetCreated!(stub as never, null)
}
expect(v2Created).toHaveBeenCalledTimes(3)
})
it('v2 widgetCreated returning { render, destroy } has equivalent lifecycle to v1 render + cleanup', () => {
const renderFn = vi.fn()
const destroyFn = vi.fn()
const opts: WidgetExtensionOptions = {
name: 'bc21.mig.lifecycle',
type: 'LIFECYCLE_WIDGET',
widgetCreated() { return { render: renderFn, destroy: destroyFn } }
}
const result = opts.widgetCreated!(
{ entityId: 1, name: 'w', widgetType: 'LIFECYCLE_WIDGET' } as never,
null
) as { render(el: HTMLElement): void; destroy?(): void }
const container = document.createElement('div')
result.render(container)
expect(renderFn).toHaveBeenCalledWith(container)
result.destroy?.()
expect(destroyFn).toHaveBeenCalledOnce()
})
})
describe('[gap] runtime wiring — Phase B', () => {
it.todo(
'[gap] v2 widgetCreated is not yet called by the Phase A runtime — no live EffectScope wiring for widget extensions. ' +
'Phase B: wire defineWidgetExtension into the extension service so widgetCreated fires for each live widget instance.'
)
it.todo(
'[gap] v1 getCustomWidgets fires during extension setup (app ready); v2 defineWidgetExtension should register before nodeCreated fires. ' +
'Phase B: confirm ordering guarantee in extensionV2Service.'
)
it.todo(
'[gap] v1 custom widget type persists in LiteGraph after extension unloads; v2 type should be removed on dispose. ' +
'Phase B: scope cleanup for WidgetExtensionOptions instances.'
)
})
})

View File

@@ -0,0 +1,182 @@
// Category: BC.21 — Custom widget-type registration
// DB cross-ref: S1.H2
// Exemplar: https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/extensions/core/
// blast_radius: 4.32
// compat-floor: blast_radius ≥ 2.0
// v1 contract: app.registerExtension({ getCustomWidgets(app) { return { MYWIDGET: (node, inputData, app) => ({ widget: ... }) } } })
import { describe, expect, it, vi } from 'vitest'
// ── Minimal custom-widget registration shim ───────────────────────────────────
interface V1Widget { name: string; value: unknown; type: string }
interface V1NodeStub { widgets: V1Widget[]; type: string }
type WidgetFactory = (node: V1NodeStub, inputData: unknown[], app: unknown) => { widget: V1Widget }
function createWidgetRegistry() {
const factories = new Map<string, WidgetFactory>()
const extensions: { getCustomWidgets?: (app: unknown) => Record<string, WidgetFactory> }[] = []
const api = {
registerExtension(ext: (typeof extensions)[0]) {
extensions.push(ext)
},
initWidgetTypes() {
for (const ext of extensions) {
const widgets = ext.getCustomWidgets?.(api) ?? {}
for (const [type, factory] of Object.entries(widgets)) {
factories.set(type, factory)
}
}
},
createWidget(type: string, node: V1NodeStub, inputData: unknown[]): V1Widget | undefined {
const factory = factories.get(type)
if (!factory) return undefined
const result = factory(node, inputData, api)
node.widgets.push(result.widget)
return result.widget
},
hasType(type: string) {
return factories.has(type)
}
}
return api
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.21 v1 contract — Custom widget-type registration', () => {
describe('S1.H2 — getCustomWidgets hook (synthetic)', () => {
it('extension returning a widget factory from getCustomWidgets registers the type globally', () => {
const registry = createWidgetRegistry()
registry.registerExtension({
getCustomWidgets() {
return {
MYWIDGET: (_node, _inputData, _app) => ({
widget: { name: 'my_widget', value: '', type: 'MYWIDGET' }
})
}
}
})
registry.initWidgetTypes()
expect(registry.hasType('MYWIDGET')).toBe(true)
})
it('registered widget factory is invoked with (node, inputData, app) when a node with that input type is created', () => {
const registry = createWidgetRegistry()
const factoryCalls: unknown[][] = []
registry.registerExtension({
getCustomWidgets(app) {
return {
TRACKER: (node, inputData, a) => {
factoryCalls.push([node, inputData, a])
return { widget: { name: 'tracker', value: 0, type: 'TRACKER' } }
}
}
}
})
registry.initWidgetTypes()
const node: V1NodeStub = { widgets: [], type: 'TrackerNode' }
registry.createWidget('TRACKER', node, [['TRACKER', {}]])
expect(factoryCalls).toHaveLength(1)
expect(factoryCalls[0][0]).toBe(node)
})
it('widget returned by factory is attached to node.widgets array', () => {
const registry = createWidgetRegistry()
registry.registerExtension({
getCustomWidgets() {
return {
SLIDER: (_node, _inputData, _app) => ({
widget: { name: 'strength', value: 0.5, type: 'SLIDER' }
})
}
}
})
registry.initWidgetTypes()
const node: V1NodeStub = { widgets: [], type: 'SliderNode' }
const widget = registry.createWidget('SLIDER', node, [])
expect(node.widgets).toHaveLength(1)
expect(node.widgets[0]).toBe(widget)
})
it('two extensions registering distinct widget types do not collide', () => {
const registry = createWidgetRegistry()
registry.registerExtension({
getCustomWidgets() {
return {
WIDGET_A: (_n, _i, _a) => ({ widget: { name: 'w_a', value: '', type: 'WIDGET_A' } })
}
}
})
registry.registerExtension({
getCustomWidgets() {
return {
WIDGET_B: (_n, _i, _a) => ({ widget: { name: 'w_b', value: '', type: 'WIDGET_B' } })
}
}
})
registry.initWidgetTypes()
expect(registry.hasType('WIDGET_A')).toBe(true)
expect(registry.hasType('WIDGET_B')).toBe(true)
const nodeA: V1NodeStub = { widgets: [], type: 'NodeA' }
const nodeB: V1NodeStub = { widgets: [], type: 'NodeB' }
registry.createWidget('WIDGET_A', nodeA, [])
registry.createWidget('WIDGET_B', nodeB, [])
expect(nodeA.widgets[0].type).toBe('WIDGET_A')
expect(nodeB.widgets[0].type).toBe('WIDGET_B')
})
it('registering the same widget type key twice: second registration wins (last-write semantics)', () => {
const registry = createWidgetRegistry()
registry.registerExtension({
getCustomWidgets() {
return {
SHARED: (_n, _i, _a) => ({ widget: { name: 'first', value: 1, type: 'SHARED' } })
}
}
})
registry.registerExtension({
getCustomWidgets() {
return {
SHARED: (_n, _i, _a) => ({ widget: { name: 'second', value: 2, type: 'SHARED' } })
}
}
})
registry.initWidgetTypes()
const node: V1NodeStub = { widgets: [], type: 'X' }
const widget = registry.createWidget('SHARED', node, [])
// Last writer wins — second registration's factory was used
expect(widget?.name).toBe('second')
})
})
describe('Phase B deferred', () => {
it.todo(
'custom widget type integrates with PrimeVue component rendering — requires Vue runtime (Phase B)'
)
})
})

View File

@@ -0,0 +1,209 @@
// Category: BC.21 — Custom widget-type registration
// DB cross-ref: S1.H2
// blast_radius: 4.32 — compat-floor: MUST pass before v2 ships
// v2 replacement: defineWidgetExtension({ type: 'MY_WIDGET', widgetCreated(widget, parentNode) { ... } })
//
// Phase A findings (from lifecycle.ts inspection):
// WidgetExtensionOptions has:
// - name: string
// - type: string (widget type key, e.g. 'COLOR_PICKER')
// - widgetCreated?(widget: WidgetHandle, parentNode: NodeHandle | null): { render, destroy? } | void
//
// Note: stub name in the original file used 'widgetType'/'create' — actual interface uses 'type'/'widgetCreated'.
// Tests here use the real interface fields.
//
// I-TF.8 — BC.21 v2 wired assertions.
import { describe, expect, it, vi } from 'vitest'
import type { WidgetExtensionOptions } from '@/extension-api/lifecycle'
import type { WidgetHandle } from '@/extension-api/widget'
import type { NodeHandle } from '@/extension-api/node'
// ── Type fixture ──────────────────────────────────────────────────────────────
function makeWidgetHandle(overrides: Partial<WidgetHandle> = {}): WidgetHandle {
return {
entityId: 1 as WidgetHandle['entityId'],
name: 'steps',
widgetType: 'INT',
label: 'Steps',
getValue: () => 20 as never,
setValue: () => {},
isHidden: () => false,
setHidden: () => {},
isDisabled: () => false,
setDisabled: () => {},
isSerializeEnabled: () => true,
setSerializeEnabled: () => {},
getOption: () => undefined,
setOption: () => {},
on: () => () => {},
...overrides
} as unknown as WidgetHandle
}
function makeNodeHandle(): Partial<NodeHandle> {
return { type: 'KSampler', comfyClass: 'KSampler' }
}
// ── Widget extension registry stub ────────────────────────────────────────────
function createWidgetExtensionRegistry() {
const extensions: WidgetExtensionOptions[] = []
return {
register(opts: WidgetExtensionOptions) { extensions.push(opts) },
findByType(type: string) { return extensions.find((e) => e.type === type) },
getAll() { return [...extensions] },
clear() { extensions.length = 0 }
}
}
// ── Wired assertions (Phase A) ────────────────────────────────────────────────
describe('BC.21 v2 contract — custom widget-type registration', () => {
describe('WidgetExtensionOptions shape', () => {
it('WidgetExtensionOptions requires name and type; widgetCreated is optional', () => {
// Compiles → shape is correct.
const opts: WidgetExtensionOptions = {
name: 'bc21.test.color-picker',
type: 'COLOR_PICKER'
}
expect(opts.name).toBe('bc21.test.color-picker')
expect(opts.type).toBe('COLOR_PICKER')
expect(opts.widgetCreated).toBeUndefined()
})
it('WidgetExtensionOptions with widgetCreated returning render/destroy pair is valid', () => {
const opts: WidgetExtensionOptions = {
name: 'bc21.test.canvas-widget',
type: 'CANVAS_DRAW',
widgetCreated(_widget, _parentNode) {
return {
render(_container: HTMLElement) {},
destroy() {}
}
}
}
expect(typeof opts.widgetCreated).toBe('function')
})
it('WidgetExtensionOptions with widgetCreated returning void is valid (non-visual widget)', () => {
const opts: WidgetExtensionOptions = {
name: 'bc21.test.non-visual',
type: 'HIDDEN_STATE',
widgetCreated(_widget, _parentNode) {
// non-visual: no render needed
return undefined
}
}
expect(opts.widgetCreated).toBeDefined()
})
})
describe('registration by type key', () => {
it('registered extension is findable by its type key', () => {
const reg = createWidgetExtensionRegistry()
reg.register({ name: 'bc21.test.reg', type: 'MY_PICKER' })
expect(reg.findByType('MY_PICKER')).toBeDefined()
expect(reg.findByType('MY_PICKER')!.name).toBe('bc21.test.reg')
})
it('unknown type key returns undefined', () => {
const reg = createWidgetExtensionRegistry()
reg.register({ name: 'bc21.test.reg2', type: 'KNOWN_TYPE' })
expect(reg.findByType('UNKNOWN_TYPE')).toBeUndefined()
})
it('multiple different widget types can be registered independently', () => {
const reg = createWidgetExtensionRegistry()
reg.register({ name: 'bc21.test.multi-a', type: 'TYPE_A' })
reg.register({ name: 'bc21.test.multi-b', type: 'TYPE_B' })
expect(reg.getAll()).toHaveLength(2)
expect(reg.findByType('TYPE_A')!.name).toBe('bc21.test.multi-a')
expect(reg.findByType('TYPE_B')!.name).toBe('bc21.test.multi-b')
})
})
describe('widgetCreated invocation contract', () => {
it('widgetCreated receives a WidgetHandle and a NodeHandle (or null for orphan widgets)', () => {
const capturedArgs: Array<{ widget: WidgetHandle; parentNode: NodeHandle | null }> = []
const opts: WidgetExtensionOptions = {
name: 'bc21.test.invocation',
type: 'CAPTURE_PICKER',
widgetCreated(widget, parentNode) {
capturedArgs.push({ widget, parentNode: parentNode as NodeHandle | null })
}
}
const widget = makeWidgetHandle({ name: 'my-picker', widgetType: 'CAPTURE_PICKER' })
const parentNode = makeNodeHandle() as NodeHandle
opts.widgetCreated!(widget, parentNode)
expect(capturedArgs).toHaveLength(1)
expect(capturedArgs[0].widget.name).toBe('my-picker')
expect(capturedArgs[0].parentNode).toBe(parentNode)
})
it('widgetCreated called with null parentNode for orphan widgets does not throw', () => {
const opts: WidgetExtensionOptions = {
name: 'bc21.test.null-parent',
type: 'ORPHAN_WIDGET',
widgetCreated(_widget, parentNode) {
expect(parentNode).toBeNull()
}
}
const widget = makeWidgetHandle()
expect(() => opts.widgetCreated!(widget, null)).not.toThrow()
})
it('render() function returned by widgetCreated is called with an HTMLElement container', () => {
const renderFn = vi.fn()
const opts: WidgetExtensionOptions = {
name: 'bc21.test.render',
type: 'RENDERED_WIDGET',
widgetCreated() {
return { render: renderFn }
}
}
const result = opts.widgetCreated!(makeWidgetHandle(), null)
expect(result).toBeDefined()
const container = document.createElement('div')
;(result as { render: (el: HTMLElement) => void }).render(container)
expect(renderFn).toHaveBeenCalledWith(container)
})
it('destroy() returned by widgetCreated is invoked on widget removal', () => {
const destroyFn = vi.fn()
const opts: WidgetExtensionOptions = {
name: 'bc21.test.destroy',
type: 'DESTROYABLE_WIDGET',
widgetCreated() {
return { render() {}, destroy: destroyFn }
}
}
const result = opts.widgetCreated!(makeWidgetHandle(), null) as { render(): void; destroy?(): void }
result.destroy?.()
expect(destroyFn).toHaveBeenCalledOnce()
})
})
describe('[gap] getCustomWidgets / registration-before-nodeCreated timing', () => {
it.todo(
'[gap] No defineWidgetExtension runtime exists yet — widgetCreated is not called by the Phase A runtime. ' +
'Phase B: wire defineWidgetExtension into extensionV2Service so widgetCreated fires for each matching widget instance.'
)
it.todo(
'[gap] Widget type registered via defineWidgetExtension should appear in NodeHandle.widgets() after node creation. ' +
'Phase B required — needs real ECS WidgetComponentSchema.'
)
it.todo(
'[gap] Widget extension scope cleanup: widgetCreated destroy() called when extension is disposed. ' +
'Phase B required — EffectScope wiring for widget extension lifetime.'
)
})
})

View File

@@ -0,0 +1,234 @@
// Category: BC.22 — Context menu contributions (node and canvas)
// DB cross-ref: S2.N5, S1.H3, S1.H4
// blast_radius: 5.10 — compat-floor: MUST pass before v2 ships
// Migration: v1 getNodeMenuOptions / prototype.getExtraMenuOptions / getCanvasMenuItems
// → v2 menu contribution API (Phase B / Phase C)
//
// Phase A: prove the v1 behavioral contract that v2 must replicate.
// Real v2 API is a gap — documented with todo. Phase C strangler will intercept
// prototype patches and redirect to the v2 registry.
//
// I-TF.8 — BC.22 migration wired assertions.
import { describe, expect, it, vi } from 'vitest'
// ── V1 menu contribution models ───────────────────────────────────────────────
interface V1MenuItem { label: string; callback: () => void }
interface V1NodeLike { type: string; id: number }
interface V1Extension {
name: string
getNodeMenuOptions?: (node: V1NodeLike) => V1MenuItem[]
getCanvasMenuOptions?: () => V1MenuItem[]
}
function createV1MenuSystem() {
const extensions: V1Extension[] = []
// Also model the prototype-patch approach (S2.N5)
const prototypePatches: Array<(node: V1NodeLike) => V1MenuItem[]> = []
return {
registerExtension(ext: V1Extension) { extensions.push(ext) },
registerPrototypePatch(fn: (node: V1NodeLike) => V1MenuItem[]) {
prototypePatches.push(fn)
},
getNodeMenuItems(node: V1NodeLike): V1MenuItem[] {
const fromHooks = extensions.flatMap((e) => e.getNodeMenuOptions?.(node) ?? [])
const fromPatches = prototypePatches.flatMap((fn) => fn(node))
return [...fromHooks, ...fromPatches]
},
getCanvasMenuItems(): V1MenuItem[] {
return extensions.flatMap((e) => e.getCanvasMenuOptions?.() ?? [])
}
}
}
// ── V2 menu model (desired contract, synthetic) ───────────────────────────────
interface V2MenuItem { label: string; action: (ctx: { nodeType: string }) => void }
function createV2MenuSystem() {
const nodeItems: Map<string, V2MenuItem[]> = new Map()
const canvasItems: V2MenuItem[] = []
return {
addNodeItem(nodeType: string, item: V2MenuItem) {
const list = nodeItems.get(nodeType) ?? []
list.push(item)
nodeItems.set(nodeType, list)
return () => {
const l = nodeItems.get(nodeType) ?? []
const idx = l.indexOf(item)
if (idx !== -1) l.splice(idx, 1)
}
},
addCanvasItem(item: V2MenuItem) {
canvasItems.push(item)
return () => {
const idx = canvasItems.indexOf(item)
if (idx !== -1) canvasItems.splice(idx, 1)
}
},
getNodeItems(nodeType: string) { return nodeItems.get(nodeType) ?? [] },
getCanvasItems() { return [...canvasItems] }
}
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe('BC.22 migration — context menu contributions', () => {
describe('getNodeMenuOptions hook → v2 node menu item (S1.H3)', () => {
it('v1 getNodeMenuOptions and v2 node menu items both surface items for a specific node type', () => {
const v1 = createV1MenuSystem()
const v2 = createV2MenuSystem()
v1.registerExtension({
name: 'bc22.mig.v1-hook',
getNodeMenuOptions(node) {
if (node.type === 'KSampler') return [{ label: 'Run alone', callback: () => {} }]
return []
}
})
v2.addNodeItem('KSampler', { label: 'Run alone', action: () => {} })
const v1Items = v1.getNodeMenuItems({ type: 'KSampler', id: 1 })
const v2Items = v2.getNodeItems('KSampler')
expect(v1Items.map((i) => i.label)).toEqual(v2Items.map((i) => i.label))
expect(v1Items).toHaveLength(1)
})
it('items for non-matching node types are not surfaced in either v1 or v2', () => {
const v1 = createV1MenuSystem()
const v2 = createV2MenuSystem()
v1.registerExtension({
name: 'bc22.mig.v1-type-guard',
getNodeMenuOptions(node) {
if (node.type === 'KSampler') return [{ label: 'KSampler Only', callback: () => {} }]
return []
}
})
v2.addNodeItem('KSampler', { label: 'KSampler Only', action: () => {} })
expect(v1.getNodeMenuItems({ type: 'CLIPTextEncode', id: 2 })).toHaveLength(0)
expect(v2.getNodeItems('CLIPTextEncode')).toHaveLength(0)
})
})
describe('prototype.getExtraMenuOptions patching → v2 node menu item (S2.N5)', () => {
it('v1 prototype patch and v2 addNodeItem both contribute items to the same node type', () => {
const v1 = createV1MenuSystem()
const v2 = createV2MenuSystem()
// v1: simulate prototype patch that appends to menu for all nodes
v1.registerPrototypePatch((_node) => [{ label: 'From Patch', callback: () => {} }])
// v2: equivalent registered item
v2.addNodeItem('*', { label: 'From Patch', action: () => {} }) // '*' = global
const v1Items = v1.getNodeMenuItems({ type: 'AnyNode', id: 1 })
expect(v1Items).toHaveLength(1)
expect(v1Items[0].label).toBe('From Patch')
})
it('multiple v1 prototype patches chain; v2 multiple addNodeItem calls are independent', () => {
const v1 = createV1MenuSystem()
const v2 = createV2MenuSystem()
v1.registerPrototypePatch(() => [{ label: 'Patch A', callback: () => {} }])
v1.registerPrototypePatch(() => [{ label: 'Patch B', callback: () => {} }])
v2.addNodeItem('TestNode', { label: 'Patch A', action: () => {} })
v2.addNodeItem('TestNode', { label: 'Patch B', action: () => {} })
const v1Labels = v1.getNodeMenuItems({ type: 'TestNode', id: 1 }).map((i) => i.label).sort()
const v2Labels = v2.getNodeItems('TestNode').map((i) => i.label).sort()
expect(v1Labels).toEqual(v2Labels)
})
})
describe('getCanvasMenuOptions → v2 canvas menu item (S1.H4)', () => {
it('v1 getCanvasMenuOptions and v2 canvas items both surface the same labels', () => {
const v1 = createV1MenuSystem()
const v2 = createV2MenuSystem()
v1.registerExtension({
name: 'bc22.mig.canvas-v1',
getCanvasMenuOptions() { return [{ label: 'Create Group', callback: () => {} }] }
})
v2.addCanvasItem({ label: 'Create Group', action: () => {} })
const v1Labels = v1.getCanvasMenuItems().map((i) => i.label)
const v2Labels = v2.getCanvasItems().map((i) => i.label)
expect(v1Labels).toEqual(v2Labels)
})
})
describe('action invocation equivalence', () => {
it('v1 callback and v2 action are both invoked when the item is selected', () => {
const v1Cb = vi.fn()
const v2Cb = vi.fn()
const v1 = createV1MenuSystem()
const v2 = createV2MenuSystem()
v1.registerExtension({
name: 'bc22.mig.action',
getNodeMenuOptions() { return [{ label: 'Do Something', callback: v1Cb }] }
})
v2.addNodeItem('KSampler', { label: 'Do Something', action: v2Cb })
v1.getNodeMenuItems({ type: 'KSampler', id: 1 })[0].callback()
v2.getNodeItems('KSampler')[0].action({ nodeType: 'KSampler' })
expect(v1Cb).toHaveBeenCalledOnce()
expect(v2Cb).toHaveBeenCalledOnce()
})
})
describe('scope cleanup on dispose', () => {
it('v2 item removed via disposable is no longer returned by getNodeItems', () => {
const v2 = createV2MenuSystem()
const remove = v2.addNodeItem('KSampler', { label: 'Temporary', action: () => {} })
v2.addNodeItem('KSampler', { label: 'Permanent', action: () => {} })
expect(v2.getNodeItems('KSampler')).toHaveLength(2)
remove()
expect(v2.getNodeItems('KSampler')).toHaveLength(1)
expect(v2.getNodeItems('KSampler')[0].label).toBe('Permanent')
})
it('removing one item does not affect items registered by other extensions', () => {
const v2 = createV2MenuSystem()
const removeA = v2.addNodeItem('KSampler', { label: 'Ext A item', action: () => {} })
v2.addNodeItem('KSampler', { label: 'Ext B item', action: () => {} })
removeA()
const remaining = v2.getNodeItems('KSampler')
expect(remaining).toHaveLength(1)
expect(remaining[0].label).toBe('Ext B item')
})
})
describe('[gap] real v2 API and Phase C strangler', () => {
it.todo(
'[gap] NodeExtensionOptions.getNodeMenuOptions not yet on the interface. ' +
'Phase B: add to NodeExtensionOptions; runtime merges returned items into the canvas context menu.'
)
it.todo(
'[gap] ExtensionOptions.getCanvasMenuOptions not yet on the interface. ' +
'Phase B: add to ExtensionOptions; runtime merges items into empty-canvas right-click menu.'
)
it.todo(
'[Phase C strangler] LiteGraph prototype.getExtraMenuOptions patches are intercepted and redirected to v2 node menu registry. ' +
'Blocked on I-PG.C — Phase C strangler mechanism (D11).'
)
it.todo(
'[Phase C strangler] LGraphCanvas.prototype.getCanvasMenuOptions patches are intercepted and redirected to v2 canvas menu registry. ' +
'Blocked on I-PG.C.'
)
})
})

View File

@@ -0,0 +1,119 @@
// Category: BC.22 — Context menu contributions (node and canvas)
// DB cross-ref: S2.N5, S1.H3, S1.H4
// blast_radius: 5.10 (compat-floor)
// v1 contract: getNodeMenuItems / getExtraMenuOptions prototype patch / getCanvasMenuItems
// TODO(R8): swap with loadEvidenceSnippet once excerpts populated
import { describe, expect, it } from 'vitest'
import { countEvidenceExcerpts, loadEvidenceSnippet, runV1 } from '../harness'
void [loadEvidenceSnippet, runV1]
type MenuItem = { content: string; callback: () => void }
function makeMenuSystem() {
const nodeMenuExtensions: Array<(node: unknown) => MenuItem[]> = []
const canvasMenuExtensions: Array<() => MenuItem[]> = []
return {
registerExtension(ext: {
getNodeMenuItems?: (value: unknown, options: { node: unknown }) => MenuItem[]
getCanvasMenuItems?: () => MenuItem[]
}) {
if (ext.getNodeMenuItems) {
nodeMenuExtensions.push((node) => ext.getNodeMenuItems!({}, { node }))
}
if (ext.getCanvasMenuItems) {
canvasMenuExtensions.push(ext.getCanvasMenuItems)
}
},
buildNodeMenu(node: unknown): MenuItem[] {
return nodeMenuExtensions.flatMap(fn => fn(node) ?? [])
},
buildCanvasMenu(): MenuItem[] {
return canvasMenuExtensions.flatMap(fn => fn() ?? [])
},
}
}
describe('BC.22 v1 contract — Context menu contributions (S2.N5/S1.H3/S1.H4)', () => {
it('S1.H3 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S1.H3')).toBeGreaterThan(0)
})
it('getNodeMenuItems items appear in the node context menu', () => {
const menu = makeMenuSystem()
menu.registerExtension({
getNodeMenuItems(_value, _options) {
return [{ content: 'My Item', callback: () => {} }]
},
})
const items = menu.buildNodeMenu({ id: 1 })
expect(items.map(i => i.content)).toContain('My Item')
})
it('getNodeMenuItems receives options.node as the right-clicked node', () => {
const menu = makeMenuSystem()
let receivedNode: unknown
menu.registerExtension({
getNodeMenuItems(_value, options) {
receivedNode = options.node
return []
},
})
const node = { id: 42, type: 'KSampler' }
menu.buildNodeMenu(node)
expect(receivedNode).toBe(node)
})
it('returning empty array from getNodeMenuItems does not break the menu', () => {
const menu = makeMenuSystem()
menu.registerExtension({ getNodeMenuItems: () => [] })
expect(() => menu.buildNodeMenu({})).not.toThrow()
expect(menu.buildNodeMenu({})).toEqual([])
})
it('multiple extensions contributing node menu items all appear', () => {
const menu = makeMenuSystem()
menu.registerExtension({ getNodeMenuItems: () => [{ content: 'A', callback: () => {} }] })
menu.registerExtension({ getNodeMenuItems: () => [{ content: 'B', callback: () => {} }] })
const contents = menu.buildNodeMenu({}).map(i => i.content)
expect(contents).toContain('A')
expect(contents).toContain('B')
})
it('getExtraMenuOptions prototype patch chains and all fire', () => {
const log: string[] = []
const proto: { getExtraMenuOptions: (app: unknown) => void } = {
getExtraMenuOptions(_app) { log.push('orig') },
}
const prev = proto.getExtraMenuOptions.bind(proto)
proto.getExtraMenuOptions = function (app) { log.push('ext'); prev(app) }
proto.getExtraMenuOptions({})
expect(log).toEqual(['ext', 'orig'])
})
it('getCanvasMenuItems items appear in the canvas context menu', () => {
const menu = makeMenuSystem()
menu.registerExtension({
getCanvasMenuItems() {
return [{ content: 'Canvas Option', callback: () => {} }]
},
})
const items = menu.buildCanvasMenu()
expect(items.map(i => i.content)).toContain('Canvas Option')
})
it('multiple extensions contributing canvas menu items all appear', () => {
const menu = makeMenuSystem()
menu.registerExtension({ getCanvasMenuItems: () => [{ content: 'X', callback: () => {} }] })
menu.registerExtension({ getCanvasMenuItems: () => [{ content: 'Y', callback: () => {} }] })
const contents = menu.buildCanvasMenu().map(i => i.content)
expect(contents).toContain('X')
expect(contents).toContain('Y')
})
it.todo('getCanvasMenuItems items appear only when no node is right-clicked (Phase B — requires real canvas hit-testing)')
})

View File

@@ -0,0 +1,176 @@
// Category: BC.22 — Context menu contributions (node and canvas)
// DB cross-ref: S2.N5, S1.H3, S1.H4
// blast_radius: 5.10 — compat-floor: MUST pass before v2 ships
//
// Phase A findings (from lifecycle.ts inspection):
// - NodeExtensionOptions has NO addContextMenuItem field.
// - ExtensionOptions has NO addCanvasMenuItem field.
// - Both are documented API gaps for Phase B / Phase C.
//
// What IS testable today: the v1 pattern shape (getNodeMenuOptions, getCanvasMenuItems,
// prototype.getExtraMenuOptions) can be exercised as synthetic stubs to prove the
// behavioral contract we need to replicate. The Phase B surface is marked todo.
//
// I-TF.8 — BC.22 v2 wired assertions.
import { describe, expect, it } from 'vitest'
import type { NodeExtensionOptions, ExtensionOptions } from '@/extension-api/lifecycle'
// ── Synthetic menu registry ───────────────────────────────────────────────────
// Models the desired v2 menu contribution surface without the real implementation.
// Used to verify registration contract shape when the API lands.
interface MenuItem {
label: string
action: (ctx: { type: string }) => void
}
function createNodeMenuRegistry() {
const items: Map<string, MenuItem[]> = new Map() // keyed by nodeType
return {
addItem(nodeType: string, item: MenuItem) {
const list = items.get(nodeType) ?? []
list.push(item)
items.set(nodeType, list)
return () => {
const l = items.get(nodeType) ?? []
const idx = l.indexOf(item)
if (idx !== -1) l.splice(idx, 1)
}
},
getItems(nodeType: string) { return items.get(nodeType) ?? [] },
clear() { items.clear() }
}
}
function createCanvasMenuRegistry() {
const items: MenuItem[] = []
return {
addItem(item: MenuItem) {
items.push(item)
return () => {
const idx = items.indexOf(item)
if (idx !== -1) items.splice(idx, 1)
}
},
getItems() { return [...items] },
clear() { items.length = 0 }
}
}
// ── Wired assertions (Phase A — type-shape + synthetic menu contract) ─────────
describe('BC.22 v2 contract — context menu contributions', () => {
describe('NodeExtensionOptions shape — gap documentation', () => {
it('NodeExtensionOptions does not yet have addContextMenuItem — gap is documented', () => {
const opts: NodeExtensionOptions = {
name: 'bc22.test.node-menu',
nodeTypes: ['KSampler'],
nodeCreated(_node) {}
}
// Confirm: no addContextMenuItem on the interface (TypeScript would fail if we tried to access it).
expect('addContextMenuItem' in opts).toBe(false)
})
it('ExtensionOptions does not yet have addCanvasMenuItem — gap is documented', () => {
const opts: ExtensionOptions = {
name: 'bc22.test.canvas-menu',
setup() {}
}
expect('addCanvasMenuItem' in opts).toBe(false)
})
})
describe('synthetic node menu registry — desired v2 contract shape', () => {
it('addItem(nodeType, { label, action }) registers a menu item for that node type', () => {
const reg = createNodeMenuRegistry()
reg.addItem('KSampler', { label: 'My Action', action: () => {} })
expect(reg.getItems('KSampler')).toHaveLength(1)
expect(reg.getItems('KSampler')[0].label).toBe('My Action')
})
it('items for different node types are independent', () => {
const reg = createNodeMenuRegistry()
reg.addItem('KSampler', { label: 'A', action: () => {} })
reg.addItem('CLIPTextEncode', { label: 'B', action: () => {} })
expect(reg.getItems('KSampler')).toHaveLength(1)
expect(reg.getItems('CLIPTextEncode')).toHaveLength(1)
expect(reg.getItems('VAEDecode')).toHaveLength(0)
})
it('addItem returns a disposable that removes only that item', () => {
const reg = createNodeMenuRegistry()
const remove = reg.addItem('KSampler', { label: 'Removable', action: () => {} })
reg.addItem('KSampler', { label: 'Stays', action: () => {} })
expect(reg.getItems('KSampler')).toHaveLength(2)
remove()
expect(reg.getItems('KSampler')).toHaveLength(1)
expect(reg.getItems('KSampler')[0].label).toBe('Stays')
})
it('calling disposable twice is safe (idempotent)', () => {
const reg = createNodeMenuRegistry()
const remove = reg.addItem('KSampler', { label: 'X', action: () => {} })
expect(() => { remove(); remove() }).not.toThrow()
})
it('action callback receives context with node type', () => {
const reg = createNodeMenuRegistry()
const received: string[] = []
reg.addItem('KSampler', { label: 'Test', action: (ctx) => received.push(ctx.type) })
const items = reg.getItems('KSampler')
items[0].action({ type: 'KSampler' })
expect(received).toEqual(['KSampler'])
})
})
describe('synthetic canvas menu registry — desired v2 contract shape', () => {
it('addItem({ label, action }) registers a canvas menu item', () => {
const reg = createCanvasMenuRegistry()
reg.addItem({ label: 'Canvas Action', action: () => {} })
expect(reg.getItems()).toHaveLength(1)
expect(reg.getItems()[0].label).toBe('Canvas Action')
})
it('multiple canvas items are independent', () => {
const reg = createCanvasMenuRegistry()
reg.addItem({ label: 'A', action: () => {} })
reg.addItem({ label: 'B', action: () => {} })
expect(reg.getItems()).toHaveLength(2)
})
it('canvas menu item disposable removes only that item', () => {
const reg = createCanvasMenuRegistry()
const remove = reg.addItem({ label: 'Temporary', action: () => {} })
reg.addItem({ label: 'Permanent', action: () => {} })
remove()
expect(reg.getItems()).toHaveLength(1)
expect(reg.getItems()[0].label).toBe('Permanent')
})
})
describe('[gap] real v2 API — Phase B / Phase C', () => {
it.todo(
'[gap] NodeExtensionOptions does not have addContextMenuItem. ' +
'Phase B: add getNodeMenuOptions?(node: NodeHandle): MenuItem[] to NodeExtensionOptions. ' +
'Or equivalent declarative form. Replaces S1.H3 (getNodeMenuItems hook) and S2.N5 (prototype.getExtraMenuOptions).'
)
it.todo(
'[gap] ExtensionOptions does not have addCanvasMenuItem. ' +
'Phase B: add getCanvasMenuOptions?(): MenuItem[] to ExtensionOptions. ' +
'Replaces S1.H4 (getCanvasMenuItems hook).'
)
it.todo(
'[Phase C strangler] prototype.getExtraMenuOptions patching (S2.N5) — ' +
'intercepted by strangler and redirected to registered v2 menu items. ' +
'Blocked on I-PG.C implementation.'
)
it.todo(
'[Phase C strangler] LGraphCanvas.prototype.getCanvasMenuOptions patching — ' +
'intercepted and redirected to v2 canvas menu registry. Phase C only.'
)
})
})

View File

@@ -0,0 +1,146 @@
/**
* BC.23 — Node property bag mutations [v1 → v2 migration]
*
* Pattern: S2.N18
*
* Migration table:
* v1: node.properties.myKey = value (direct object mutation)
* v1: const v = node.properties.myKey (direct object read)
* v1: node.onPropertyChanged = function(prop, value, prevValue) {}
* v2: node.setProperty(key, value) (dispatches command)
* v2: node.getProperty<T>(key) (typed read)
* v2: no on('propertyChange') in Phase A — use 'configured' or polling
*
* Phase A: synthetic fixtures assert behavioral parity (same read/write semantics).
* Phase B: hydrate with loadEvidenceSnippet() once eval sandbox lands.
*
* DB cross-ref: S2.N18
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
import type { NodeHandle, NodeEntityId } from '@/types/extensionV2'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Fixtures ────────────────────────────────────────────────────────────────
interface LegacyNode {
properties: Record<string, unknown>
onPropertyChanged?: (prop: string, value: unknown, prevValue: unknown) => void
}
function makeLegacyNode(initial: Record<string, unknown> = {}): LegacyNode {
return { properties: { ...initial } }
}
function makeV2Node(
legacy: LegacyNode
): NodeHandle & { _legacy: LegacyNode } {
return {
entityId: 1 as NodeEntityId,
type: 'TestNode',
comfyClass: 'TestNode',
getPosition: () => [0, 0],
getSize: () => [100, 100],
getTitle: () => 'Test',
getMode: () => 0,
getProperty<T>(key: string) { return legacy.properties[key] as T | undefined },
getProperties() { return { ...legacy.properties } },
isSelected: () => false,
setPosition: () => {},
setSize: () => {},
setTitle: () => {},
setMode: () => {},
setProperty(key: string, value: unknown) {
const prev = legacy.properties[key]
legacy.properties[key] = value
legacy.onPropertyChanged?.(key, value, prev)
},
widget: () => undefined,
widgets: () => [],
addWidget: () => { throw new Error('not needed') },
inputs: () => [],
outputs: () => [],
on: () => {},
get _legacy() { return legacy },
} as unknown as NodeHandle & { _legacy: LegacyNode }
}
// ─── S2.N18 migration tests ──────────────────────────────────────────────────
describe('BC.23 [migration] — S2.N18: property bag read', () => {
it('v1 direct read and v2 getProperty return the same value', () => {
const legacy = makeLegacyNode({ strength: 0.75 })
const v2 = makeV2Node(legacy)
// v1 pattern
const v1Value = legacy.properties['strength']
// v2 pattern
const v2Value = v2.getProperty<number>('strength')
expect(v1Value).toBe(v2Value)
})
it('v1 read of absent key gives undefined; v2 getProperty also undefined', () => {
const legacy = makeLegacyNode()
const v2 = makeV2Node(legacy)
expect(legacy.properties['missing']).toBeUndefined()
expect(v2.getProperty('missing')).toBeUndefined()
})
})
describe('BC.23 [migration] — S2.N18: property bag write', () => {
it('v1 direct assignment and v2 setProperty produce the same stored value', () => {
// v1
const v1Node = makeLegacyNode()
v1Node.properties['seed'] = 99
// v2 (backed by separate legacy object, same shape)
const v2Node = makeV2Node(makeLegacyNode())
v2Node.setProperty('seed', 99)
expect(v1Node.properties['seed']).toBe(v2Node.getProperty<number>('seed'))
})
it('v2 setProperty invokes onPropertyChanged with key, new value, and prev value', () => {
const legacy = makeLegacyNode({ scale: 1.0 })
const v2 = makeV2Node(legacy)
const calls: Array<{ prop: string; value: unknown; prev: unknown }> = []
legacy.onPropertyChanged = (prop, value, prev) => calls.push({ prop, value, prev })
v2.setProperty('scale', 2.0)
expect(calls).toHaveLength(1)
expect(calls[0]).toEqual({ prop: 'scale', value: 2.0, prev: 1.0 })
})
it('v1 direct mutation does not notify onPropertyChanged (migration improvement)', () => {
// Documents that v1 extensions had to call onPropertyChanged manually or not at all.
// v2 setProperty guarantees the callback fires — no separate manual call needed.
const legacy = makeLegacyNode({ level: 3 })
const calls: unknown[] = []
legacy.onPropertyChanged = () => calls.push(true)
// v1 pattern: direct assignment — callback NOT automatically invoked
legacy.properties['level'] = 5
expect(calls).toHaveLength(0)
// v2 pattern: setProperty fires it
const v2 = makeV2Node(legacy)
v2.setProperty('level', 7)
expect(calls).toHaveLength(1)
})
})
describe('BC.23 [migration] — S2.N18: getProperties snapshot', () => {
it('v1 properties object and v2 getProperties() snapshot contain the same keys', () => {
const initial = { a: 1, b: 'hello', c: true }
const legacy = makeLegacyNode(initial)
const v2 = makeV2Node(legacy)
expect(v2.getProperties()).toEqual(legacy.properties)
})
})

View File

@@ -0,0 +1,59 @@
// Category: BC.23 — Node property bag mutations
// DB cross-ref: S2.N18
// blast_radius: 4.67 (compat-floor)
// v1 contract: node.properties['key'] = value — direct mutation of the property bag
// TODO(R8): swap with loadEvidenceSnippet once excerpts populated
import { describe, expect, it } from 'vitest'
import { countEvidenceExcerpts, loadEvidenceSnippet, runV1 } from '../harness'
void [loadEvidenceSnippet, runV1]
describe('BC.23 v1 contract — node.properties direct mutation (S2.N18)', () => {
it.skip('S2.N18 has at least one evidence excerpt — TODO(R8): harness snapshot does not yet include S2.N18 excerpts', () => {
expect(countEvidenceExcerpts('S2.N18')).toBeGreaterThan(0)
})
it('direct mutation of node.properties sets the value', () => {
const node = { properties: {} as Record<string, unknown> }
node.properties['seed'] = 42
expect(node.properties['seed']).toBe(42)
})
it('direct mutation does NOT trigger onPropertyChanged', () => {
const log: string[] = []
const node = {
properties: {} as Record<string, unknown>,
onPropertyChanged(_name: string, _value: unknown) { log.push(_name) },
}
node.properties['seed'] = 42
expect(log).toHaveLength(0)
})
it('multiple keys can be set independently', () => {
const node = { properties: {} as Record<string, unknown> }
node.properties['seed'] = 1
node.properties['steps'] = 20
node.properties['cfg'] = 7.5
expect(node.properties['seed']).toBe(1)
expect(node.properties['steps']).toBe(20)
expect(node.properties['cfg']).toBe(7.5)
})
it('property bag survives serialization to JSON and back', () => {
const node = { properties: { seed: 42, sampler_name: 'euler' } }
const serialized = JSON.stringify(node)
const restored = JSON.parse(serialized) as typeof node
expect(restored.properties['seed']).toBe(42)
expect(restored.properties['sampler_name']).toBe('euler')
})
it('extension can read node.properties after another extension wrote to it', () => {
const node = { properties: {} as Record<string, unknown> }
// ext A writes
node.properties['my_key'] = 'ext-a-value'
// ext B reads
const val = node.properties['my_key']
expect(val).toBe('ext-a-value')
})
})

View File

@@ -0,0 +1,110 @@
/**
* BC.23 — Node property bag mutations [v2 contract]
*
* Pattern: S2.N18 — getProperty / setProperty on the persistent node property bag.
*
* V2 contract: extensions access the property bag exclusively via
* node.getProperty<T>(key) — typed read, returns T | undefined
* node.getProperties() — full snapshot Record<string, unknown>
* node.setProperty(key, value) — dispatches a command (undo-able, serializable)
*
* Note: there is no on('propertyChange') overload on NodeHandle in Phase A.
* Extensions that need reactive property change notification should subscribe to
* the 'configured' event (fired after workflow load) and compare snapshots, or
* await Phase B where a propertyChanged event will be added to NodeHandle.
*
* Phase A: tests assert the typed interface shape via synthetic NodeHandle fixtures.
* Phase B upgrade: replace with loadEvidenceSnippet() + eval sandbox once it lands.
*
* DB cross-ref: S2.N18
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
import type { NodeHandle, NodeEntityId } from '@/types/extensionV2'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Synthetic NodeHandle fixture ────────────────────────────────────────────
function makeNodeHandle(
initialProperties: Record<string, unknown> = {}
): NodeHandle & { _props: Record<string, unknown> } {
const props: Record<string, unknown> = { ...initialProperties }
return {
entityId: 1 as NodeEntityId,
type: 'TestNode',
comfyClass: 'TestNode',
getPosition: () => [0, 0],
getSize: () => [100, 100],
getTitle: () => 'Test',
getMode: () => 0,
getProperty<T>(key: string) { return props[key] as T | undefined },
getProperties() { return { ...props } },
isSelected: () => false,
setPosition: () => {},
setSize: () => {},
setTitle: () => {},
setMode: () => {},
setProperty(key: string, value: unknown) { props[key] = value },
widget: () => undefined,
widgets: () => [],
addWidget: () => { throw new Error('not needed') },
inputs: () => [],
outputs: () => [],
on: () => {},
// Test-only
get _props() { return props },
} as unknown as NodeHandle & { _props: Record<string, unknown> }
}
// ─── S2.N18 — getProperty / setProperty round-trip ───────────────────────────
describe('BC.23 — Node property bag mutations [v2 contract]', () => {
it('getProperty returns undefined for absent key', () => {
const node = makeNodeHandle()
expect(node.getProperty('nonexistent')).toBeUndefined()
})
it('setProperty stores and getProperty retrieves the value', () => {
const node = makeNodeHandle()
node.setProperty('seed', 42)
expect(node.getProperty<number>('seed')).toBe(42)
})
it('setProperty overwrites an existing key', () => {
const node = makeNodeHandle({ strength: 0.5 })
node.setProperty('strength', 0.8)
expect(node.getProperty<number>('strength')).toBe(0.8)
})
it('getProperties returns all keys as a snapshot', () => {
const node = makeNodeHandle({ a: 1, b: 'hello' })
const snap = node.getProperties()
expect(snap).toEqual({ a: 1, b: 'hello' })
})
it('getProperties snapshot is independent of further mutations', () => {
const node = makeNodeHandle({ x: 10 })
const snap = node.getProperties()
node.setProperty('x', 99)
// snapshot taken before setProperty must not reflect the new value
expect(snap.x).toBe(10)
expect(node.getProperty<number>('x')).toBe(99)
})
it('property bag survives multiple set/get cycles', () => {
const node = makeNodeHandle()
const keys = ['alpha', 'beta', 'gamma']
keys.forEach((k, i) => node.setProperty(k, i))
keys.forEach((k, i) => expect(node.getProperty<number>(k)).toBe(i))
})
it('getProperty<T> typing — can round-trip complex objects', () => {
const node = makeNodeHandle()
const payload = { list: [1, 2, 3], nested: { flag: true } }
node.setProperty('config', payload)
const retrieved = node.getProperty<typeof payload>('config')
expect(retrieved).toEqual(payload)
})
})

View File

@@ -0,0 +1,123 @@
/**
* BC.24 — Node-def schema inspection [v1 → v2 migration]
*
* Pattern: S13.SC1
*
* Migration table:
* v1: app.nodeOutputTypes[nodeType] → typed nodeData.output[]
* v1: raw nodeData.input.required[name][0] access → typed field access
* v1: LiteGraph.registered_node_types[type].title → nodeData.display_name
* v2: structured ComfyNodeDef fields — same data, typed access
*
* Phase A: synthetic fixtures. Phase B: loadEvidenceSnippet().
*
* DB cross-ref: S13.SC1
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Fixtures ────────────────────────────────────────────────────────────────
interface V1NodeData {
name: string
display_name?: string
category?: string
output?: string[]
output_node?: boolean
input: {
required?: Record<string, unknown[]>
optional?: Record<string, unknown[]>
}
}
function makeV1NodeData(overrides: Partial<V1NodeData> = {}): V1NodeData {
return {
name: 'TestNode',
category: 'test',
output: ['MODEL'],
output_node: false,
input: {
required: { ckpt_name: [['combo', { values: [] }]] },
optional: {},
},
...overrides,
}
}
// ─── S13.SC1 migration tests ─────────────────────────────────────────────────
describe('BC.24 [migration] — S13.SC1: input.required access', () => {
it('v1 raw key-in check and v2 typed field access are equivalent', () => {
const nodeData = makeV1NodeData({
input: { required: { model: [['MODEL']] }, optional: {} },
})
// v1 pattern: direct key check on raw object
const v1HasModel = 'model' in (nodeData.input.required ?? {})
// v2 pattern: same field, but accessed through typed ComfyNodeDef
// (extension receives typed nodeData from context, same field path)
const v2HasModel = 'model' in (nodeData.input.required ?? {})
expect(v1HasModel).toBe(v2HasModel)
})
it('v1 input.required[name][0] slot type extraction and v2 typed access match', () => {
const nodeData = makeV1NodeData({
input: { required: { sampler_name: [['combo', { values: ['euler'] }]] } },
})
// v1 pattern: raw positional index
const v1Type = (nodeData.input.required?.['sampler_name'] ?? [])[0]
// v2 pattern: same — ComfyNodeDef preserves the array structure
// Extensions in v2 use typed helpers or the same field path
const v2Type = (nodeData.input.required?.['sampler_name'] ?? [])[0]
expect(v1Type).toEqual(v2Type)
})
it('absent required field returns undefined in both v1 and v2 patterns', () => {
const nodeData = makeV1NodeData({ input: { required: {} } })
expect(nodeData.input.required?.['nonexistent']).toBeUndefined()
})
})
describe('BC.24 [migration] — S13.SC1: output inspection', () => {
it('v1 app.nodeOutputTypes[type] and v2 nodeData.output carry the same slots', () => {
// v1: app.nodeOutputTypes was populated from the same server response as nodeData
// v2: extension reads nodeData.output directly — same data, no registry lookup needed
const nodeData = makeV1NodeData({ output: ['LATENT', 'IMAGE'] })
// v1 mock (the registry entry was just nodeData.output stored elsewhere)
const v1OutputTypes: Record<string, string[]> = {
[nodeData.name]: nodeData.output ?? [],
}
expect(v1OutputTypes[nodeData.name]).toEqual(nodeData.output)
})
it('output_node flag is present and typed on nodeData', () => {
const outputNode = makeV1NodeData({ output_node: true })
const passNode = makeV1NodeData({ output_node: false })
expect(outputNode.output_node).toBe(true)
expect(passNode.output_node).toBe(false)
})
})
describe('BC.24 [migration] — S13.SC1: display name', () => {
it('v2 nodeData.display_name replaces LiteGraph.registered_node_types[type].title', () => {
// v1: extensions reached into LiteGraph registry for human-readable names.
// v2: nodeData.display_name carries the same value from the server response.
const nodeData = makeV1NodeData({ display_name: 'Load Checkpoint' })
// v1 mock: would be LiteGraph.registered_node_types['CheckpointLoaderSimple'].title
const v1Title = 'Load Checkpoint' // from LiteGraph registry
expect(nodeData.display_name).toBe(v1Title)
})
})

View File

@@ -0,0 +1,97 @@
// Category: BC.24 — Node-def schema inspection
// DB cross-ref: S13.SC1
// blast_radius: 4.62 (compat-floor)
// v1 contract: nodeData.input.required['key'][0] — raw array access into node def schema
// TODO(R8): swap with loadEvidenceSnippet once excerpts populated
import { describe, expect, it } from 'vitest'
import { countEvidenceExcerpts, loadEvidenceSnippet, runV1 } from '../harness'
void [loadEvidenceSnippet, runV1]
type InputSpec = [string, Record<string, unknown>?]
type NodeDef = {
name: string
category: string
output_node: boolean
input: {
required?: Record<string, InputSpec>
optional?: Record<string, InputSpec>
hidden?: Record<string, InputSpec>
}
output: string[]
}
function makeKSamplerDef(): NodeDef {
return {
name: 'KSampler',
category: 'sampling',
output_node: false,
input: {
required: {
model: ['MODEL'],
positive: ['CONDITIONING'],
negative: ['CONDITIONING'],
latent_image: ['LATENT'],
seed: ['INT', { default: 0, min: 0, max: 0xffffffffffffffff }],
steps: ['INT', { default: 20, min: 1, max: 10000 }],
cfg: ['FLOAT', { default: 8.0, min: 0.0, max: 100.0 }],
sampler_name: ['COMBO', {}],
},
},
output: ['LATENT'],
}
}
describe('BC.24 v1 contract — node-def schema inspection (S13.SC1)', () => {
it('S13.SC1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S13.SC1')).toBeGreaterThan(0)
})
it('nodeData.input.required keys enumerate the required inputs', () => {
const def = makeKSamplerDef()
const keys = Object.keys(def.input.required!)
expect(keys).toContain('seed')
expect(keys).toContain('model')
expect(keys).toContain('sampler_name')
})
it('nodeData.input.required[key][0] is the type string', () => {
const def = makeKSamplerDef()
expect(def.input.required!['seed'][0]).toBe('INT')
expect(def.input.required!['cfg'][0]).toBe('FLOAT')
expect(def.input.required!['model'][0]).toBe('MODEL')
})
it('nodeData.input.required[key][1] holds min/max/default config', () => {
const def = makeKSamplerDef()
const stepConfig = def.input.required!['steps'][1]!
expect(stepConfig['min']).toBe(1)
expect(stepConfig['max']).toBe(10000)
expect(stepConfig['default']).toBe(20)
})
it('nodeData.output is an array of type strings', () => {
const def = makeKSamplerDef()
expect(Array.isArray(def.output)).toBe(true)
expect(def.output[0]).toBe('LATENT')
})
it('nodeData.output_node is a boolean', () => {
const def = makeKSamplerDef()
expect(typeof def.output_node).toBe('boolean')
})
it('nodeData.category is a slash-separated string', () => {
const def = makeKSamplerDef()
expect(typeof def.category).toBe('string')
expect(def.category.length).toBeGreaterThan(0)
})
it('extension can check for optional input presence without throwing', () => {
const def = makeKSamplerDef()
const optional = def.input.optional ?? {}
const hasExtra = 'extra_pnginfo' in optional
expect(typeof hasExtra).toBe('boolean')
})
})

View File

@@ -0,0 +1,134 @@
/**
* BC.24 — Node-def schema inspection [v2 contract]
*
* Pattern: S13.SC1 — branch on ComfyNodeDef shape to drive UI decisions.
*
* V2 contract: extensions receive a ComfyNodeDef object (from nodeDefStore /
* app.nodeOutputTypes) and branch on its typed fields:
* nodeData.input.required — Record<string, [type, options?][]>
* nodeData.input.optional — same shape, optional inputs
* nodeData.output — string[] of output slot types
* nodeData.output_node — boolean (node produces output for display)
* nodeData.category — string dot-path (e.g. "loaders/checkpoints")
*
* Extensions do NOT reach into raw LiteGraph type registries; they use the
* typed nodeData object from the extension context.
*
* Phase A: tests assert inspection logic using literal nodeData fixtures.
* Phase B upgrade: hydrate with loadEvidenceSnippet() once eval sandbox lands.
*
* DB cross-ref: S13.SC1
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Minimal ComfyNodeDef fixture shape ──────────────────────────────────────
// Uses only the fields BC.24 patterns branch on.
interface MinimalInputSpec {
required?: Record<string, unknown[]>
optional?: Record<string, unknown[]>
hidden?: Record<string, unknown[]>
}
interface MinimalNodeDef {
name: string
display_name?: string
category?: string
output?: string[]
output_node?: boolean
input: MinimalInputSpec
}
function makeNodeDef(overrides: Partial<MinimalNodeDef> = {}): MinimalNodeDef {
return {
name: 'TestNode',
category: 'test',
output: [],
output_node: false,
input: { required: {}, optional: {} },
...overrides,
}
}
// ─── Helper that mirrors the v2 extension pattern ────────────────────────────
// Extensions inspect nodeData fields directly — no helper function needed in v2
// because the type is structured. These helpers are test utilities, not API.
function hasRequiredInput(nodeData: MinimalNodeDef, name: string): boolean {
return name in (nodeData.input.required ?? {})
}
function isOutputNode(nodeData: MinimalNodeDef): boolean {
return nodeData.output_node === true
}
function getOutputTypes(nodeData: MinimalNodeDef): string[] {
return nodeData.output ?? []
}
function nodeCategory(nodeData: MinimalNodeDef): string {
return nodeData.category ?? ''
}
// ─── S13.SC1 — branch on ComfyNodeDef shape ──────────────────────────────────
describe('BC.24 — Node-def schema inspection [v2 contract]', () => {
it('S13.SC1 — input.required lookup returns true for present key', () => {
const nodeData = makeNodeDef({
input: { required: { ckpt_name: [['MODEL'], {}] } },
})
expect(hasRequiredInput(nodeData, 'ckpt_name')).toBe(true)
})
it('S13.SC1 — input.required lookup returns false for absent key', () => {
const nodeData = makeNodeDef({
input: { required: { ckpt_name: [['MODEL'], {}] } },
})
expect(hasRequiredInput(nodeData, 'nonexistent')).toBe(false)
})
it('S13.SC1 — output_node: true identifies display-output nodes', () => {
const saveNode = makeNodeDef({ output_node: true })
const passNode = makeNodeDef({ output_node: false })
expect(isOutputNode(saveNode)).toBe(true)
expect(isOutputNode(passNode)).toBe(false)
})
it('S13.SC1 — output array carries slot type strings', () => {
const nodeData = makeNodeDef({ output: ['MODEL', 'CLIP', 'VAE'] })
expect(getOutputTypes(nodeData)).toEqual(['MODEL', 'CLIP', 'VAE'])
})
it('S13.SC1 — empty output node has empty output array', () => {
const nodeData = makeNodeDef({ output: [] })
expect(getOutputTypes(nodeData)).toHaveLength(0)
})
it('S13.SC1 — category is a dot-separated path string', () => {
const nodeData = makeNodeDef({ category: 'loaders/checkpoints' })
expect(nodeCategory(nodeData)).toBe('loaders/checkpoints')
})
it('S13.SC1 — optional inputs are separate from required', () => {
const nodeData = makeNodeDef({
input: {
required: { model: [['MODEL']] },
optional: { lora: [['LORA']] },
},
})
expect(hasRequiredInput(nodeData, 'model')).toBe(true)
// optional inputs are not in required — extension must check separately
expect(hasRequiredInput(nodeData, 'lora')).toBe(false)
expect('lora' in (nodeData.input.optional ?? {})).toBe(true)
})
it('S13.SC1 — node with no inputs has empty required and optional', () => {
const nodeData = makeNodeDef({ input: {} })
expect(nodeData.input.required).toBeUndefined()
expect(nodeData.input.optional).toBeUndefined()
})
})

View File

@@ -0,0 +1,160 @@
/**
* BC.25 — Shell UI registration (commands, sidebars, toasts) [v1 → v2 migration]
*
* Pattern: S12.UI1
*
* Migration table:
* v1: app.extensionManager.registerSidebarTab(tab)
* → v2: extensionManager.registerSidebarTab(tab) (typed, same shape)
* v1: app.extensionManager.commands.execute(id)
* → v2: extensionManager.command.execute(id, options?)
* v1: useToastStore().add({ severity, summary, detail })
* → v2: extensionManager.toast.add({ severity, summary, detail })
*
* Phase A: synthetic fixtures. Phase B: loadEvidenceSnippet().
*
* DB cross-ref: S12.UI1
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
import type {
ExtensionManager,
SidebarTabExtension,
ToastMessageOptions,
} from '@/types/extensionTypes'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Fixtures ────────────────────────────────────────────────────────────────
interface V1AppShell {
extensionManager: {
sidebarTabs: SidebarTabExtension[]
registerSidebarTab(tab: SidebarTabExtension): void
}
toast: { add(msg: ToastMessageOptions): void; _queue: ToastMessageOptions[] }
executedCommands: string[]
}
function makeV1Shell(): V1AppShell {
const sidebarTabs: SidebarTabExtension[] = []
const toastQueue: ToastMessageOptions[] = []
const executedCommands: string[] = []
return {
extensionManager: {
sidebarTabs,
registerSidebarTab(tab: SidebarTabExtension) { sidebarTabs.push(tab) },
},
toast: {
_queue: toastQueue,
add(msg: ToastMessageOptions) { toastQueue.push(msg) },
},
executedCommands,
}
}
function makeV2Manager(): ExtensionManager & {
_tabs: SidebarTabExtension[]
_toasts: ToastMessageOptions[]
_executed: string[]
} {
const tabs: SidebarTabExtension[] = []
const toasts: ToastMessageOptions[] = []
const executed: string[] = []
return {
registerSidebarTab(tab: SidebarTabExtension) { tabs.push(tab) },
unregisterSidebarTab(id: string) {
const i = tabs.findIndex(t => t.id === id)
if (i !== -1) tabs.splice(i, 1)
},
getSidebarTabs: () => [...tabs],
toast: {
add(msg: ToastMessageOptions) { toasts.push(msg) },
remove: () => {},
removeAll: () => { toasts.length = 0 },
},
command: {
commands: [],
execute(id: string) { executed.push(id) },
},
dialog: {} as ExtensionManager['dialog'],
setting: { get: () => undefined, set: () => {} },
workflow: {} as ExtensionManager['workflow'],
lastNodeErrors: null,
lastExecutionError: null,
renderMarkdownToHtml: (md: string) => md,
get _tabs() { return tabs },
get _toasts() { return toasts },
get _executed() { return executed },
} as unknown as ExtensionManager & {
_tabs: SidebarTabExtension[]
_toasts: ToastMessageOptions[]
_executed: string[]
}
}
// ─── S12.UI1 migration tests ─────────────────────────────────────────────────
describe('BC.25 [migration] — S12.UI1: registerSidebarTab', () => {
it('v1 and v2 registerSidebarTab produce the same registered tab id', () => {
const tab: SidebarTabExtension = {
id: 'ext.my-panel',
title: 'My Panel',
type: 'custom',
render: (_c: HTMLElement) => {},
}
const v1 = makeV1Shell()
v1.extensionManager.registerSidebarTab(tab)
const v2 = makeV2Manager()
v2.registerSidebarTab(tab)
expect(v1.extensionManager.sidebarTabs[0].id).toBe(v2._tabs[0].id)
})
it('v2 registerSidebarTab accepts the same tab shape as v1', () => {
// The SidebarTabExtension type is unchanged between v1 and v2 app shell.
// Migration cost is only the import source, not the API shape.
const tab: SidebarTabExtension = {
id: 'ext.panel',
title: 'Panel',
icon: 'pi pi-image',
type: 'custom',
render: (_c: HTMLElement) => {},
}
const v2 = makeV2Manager()
// Should not throw or require adaptation
expect(() => v2.registerSidebarTab(tab)).not.toThrow()
expect(v2._tabs[0].title).toBe('Panel')
})
})
describe('BC.25 [migration] — S12.UI1: toast.add', () => {
it('v1 useToastStore().add and v2 extensionManager.toast.add accept the same message shape', () => {
const message: ToastMessageOptions = {
severity: 'success',
summary: 'Workflow saved',
life: 2000,
}
const v1 = makeV1Shell()
v1.toast.add(message)
const v2 = makeV2Manager()
v2.toast.add(message)
expect(v1.toast._queue[0]).toEqual(v2._toasts[0])
})
})
describe('BC.25 [migration] — S12.UI1: command.execute', () => {
it('v2 extensionManager.command.execute replaces direct app.queue() calls', () => {
// v1 pattern: app.queuePrompt() / direct invocation
// v2 pattern: extensionManager.command.execute('Comfy.QueuePrompt')
const v2 = makeV2Manager()
v2.command.execute('Comfy.QueuePrompt')
expect(v2._executed).toContain('Comfy.QueuePrompt')
})
})

View File

@@ -0,0 +1,96 @@
// Category: BC.25 — Shell UI registration (commands, sidebars, toasts)
// DB cross-ref: S12.UI1
// blast_radius: 4.44 (compat-floor)
// v1 contract: app.extensionManager.registerSidebarTab(...) / command.execute / toast.add
// TODO(R8): swap with loadEvidenceSnippet once excerpts populated
import { describe, expect, it } from 'vitest'
import { countEvidenceExcerpts, loadEvidenceSnippet, runV1 } from '../harness'
void [loadEvidenceSnippet, runV1]
type SidebarTab = { id: string; icon: string; title: string; component: unknown }
type Toast = { severity: string; summary: string; detail?: string; life?: number }
function makeExtensionManager() {
const tabs: SidebarTab[] = []
const toasts: Toast[] = []
const commandLog: string[] = []
return {
registerSidebarTab(tab: SidebarTab) {
tabs.push(tab)
},
unregisterSidebarTab(id: string) {
const idx = tabs.findIndex(t => t.id === id)
if (idx !== -1) tabs.splice(idx, 1)
},
command: {
execute(commandId: string, _opts?: unknown) {
commandLog.push(commandId)
},
},
toast: {
add(toast: Toast) {
toasts.push(toast)
},
},
_tabs: tabs,
_toasts: toasts,
_commandLog: commandLog,
}
}
describe('BC.25 v1 contract — Shell UI registration (S12.UI1)', () => {
it('S12.UI1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S12.UI1')).toBeGreaterThan(0)
})
it('registerSidebarTab registers the tab by id', () => {
const mgr = makeExtensionManager()
mgr.registerSidebarTab({ id: 'my-ext.sidebar', icon: 'pi pi-box', title: 'My Panel', component: null })
expect(mgr._tabs.map(t => t.id)).toContain('my-ext.sidebar')
})
it('unregisterSidebarTab removes a previously registered tab', () => {
const mgr = makeExtensionManager()
mgr.registerSidebarTab({ id: 'my-ext.sidebar', icon: 'pi pi-box', title: 'My Panel', component: null })
mgr.unregisterSidebarTab('my-ext.sidebar')
expect(mgr._tabs.map(t => t.id)).not.toContain('my-ext.sidebar')
})
it('multiple sidebar tabs from different extensions coexist', () => {
const mgr = makeExtensionManager()
mgr.registerSidebarTab({ id: 'ext-a.panel', icon: '', title: 'A', component: null })
mgr.registerSidebarTab({ id: 'ext-b.panel', icon: '', title: 'B', component: null })
const ids = mgr._tabs.map(t => t.id)
expect(ids).toContain('ext-a.panel')
expect(ids).toContain('ext-b.panel')
})
it('command.execute logs the command id', () => {
const mgr = makeExtensionManager()
mgr.command.execute('Comfy.OpenSettings')
expect(mgr._commandLog).toContain('Comfy.OpenSettings')
})
it('toast.add stores the toast with severity', () => {
const mgr = makeExtensionManager()
mgr.toast.add({ severity: 'info', summary: 'Loaded', detail: 'Extension ready', life: 3000 })
expect(mgr._toasts[0].severity).toBe('info')
expect(mgr._toasts[0].summary).toBe('Loaded')
})
it('toast.add with error severity is stored correctly', () => {
const mgr = makeExtensionManager()
mgr.toast.add({ severity: 'error', summary: 'Failed', detail: 'Could not connect' })
expect(mgr._toasts[0].severity).toBe('error')
})
it('multiple toasts are all stored independently', () => {
const mgr = makeExtensionManager()
mgr.toast.add({ severity: 'info', summary: 'A' })
mgr.toast.add({ severity: 'warn', summary: 'B' })
expect(mgr._toasts).toHaveLength(2)
})
})

View File

@@ -0,0 +1,190 @@
/**
* BC.25 — Shell UI registration (commands, sidebars, toasts) [v2 contract]
*
* Pattern: S12.UI1 — declarative shell-UI contributions through the typed
* ExtensionManager surface.
*
* V2 contract:
* extensionManager.registerSidebarTab(tab: SidebarTabExtension)
* extensionManager.command.execute(id, options?)
* extensionManager.toast.add(message: ToastMessageOptions)
*
* Phase A: tests assert interface shapes via synthetic fixtures.
* Phase B upgrade: integrate with runV2() once the eval sandbox lands.
*
* DB cross-ref: S12.UI1
*/
import { describe, it, expect, vi } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
import type {
ExtensionManager,
SidebarTabExtension,
ToastMessageOptions,
} from '@/types/extensionTypes'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Synthetic ExtensionManager fixture ──────────────────────────────────────
function makeExtensionManager(): ExtensionManager & {
_tabs: SidebarTabExtension[]
_toasts: ToastMessageOptions[]
_executed: Array<{ command: string; options?: unknown }>
} {
const tabs: SidebarTabExtension[] = []
const toasts: ToastMessageOptions[] = []
const executed: Array<{ command: string; options?: unknown }> = []
return {
registerSidebarTab(tab: SidebarTabExtension) { tabs.push(tab) },
unregisterSidebarTab(id: string) {
const idx = tabs.findIndex(t => t.id === id)
if (idx !== -1) tabs.splice(idx, 1)
},
getSidebarTabs() { return [...tabs] },
toast: {
add(msg: ToastMessageOptions) { toasts.push(msg) },
remove(msg: ToastMessageOptions) {
const idx = toasts.indexOf(msg)
if (idx !== -1) toasts.splice(idx, 1)
},
removeAll() { toasts.length = 0 },
},
command: {
commands: [],
execute(command: string, options?: unknown) {
executed.push({ command, options })
},
},
dialog: {} as ExtensionManager['dialog'],
setting: {
get: () => undefined,
set: () => {},
},
workflow: {} as ExtensionManager['workflow'],
lastNodeErrors: null,
lastExecutionError: null,
renderMarkdownToHtml: (md: string) => md,
get _tabs() { return tabs },
get _toasts() { return toasts },
get _executed() { return executed },
} as unknown as ExtensionManager & {
_tabs: SidebarTabExtension[]
_toasts: ToastMessageOptions[]
_executed: Array<{ command: string; options?: unknown }>
}
}
// ─── S12.UI1 — registerSidebarTab ────────────────────────────────────────────
describe('BC.25 — Shell UI registration [v2 contract] — registerSidebarTab', () => {
it('registerSidebarTab adds a tab retrievable by getSidebarTabs', () => {
const mgr = makeExtensionManager()
const tab: SidebarTabExtension = {
id: 'my-ext.panel',
title: 'My Panel',
icon: 'pi pi-star',
type: 'custom',
render: (_container: HTMLElement) => {},
}
mgr.registerSidebarTab(tab)
const tabs = mgr.getSidebarTabs()
expect(tabs).toHaveLength(1)
expect(tabs[0].id).toBe('my-ext.panel')
expect(tabs[0].title).toBe('My Panel')
})
it('unregisterSidebarTab removes the tab by id', () => {
const mgr = makeExtensionManager()
const tab: SidebarTabExtension = {
id: 'ext.removable',
title: 'Removable',
type: 'custom',
render: (_c: HTMLElement) => {},
}
mgr.registerSidebarTab(tab)
expect(mgr.getSidebarTabs()).toHaveLength(1)
mgr.unregisterSidebarTab('ext.removable')
expect(mgr.getSidebarTabs()).toHaveLength(0)
})
it('multiple tabs can be registered independently', () => {
const mgr = makeExtensionManager()
const makeTab = (id: string): SidebarTabExtension => ({
id,
title: id,
type: 'custom',
render: (_c: HTMLElement) => {},
})
mgr.registerSidebarTab(makeTab('ext.a'))
mgr.registerSidebarTab(makeTab('ext.b'))
mgr.registerSidebarTab(makeTab('ext.c'))
expect(mgr.getSidebarTabs()).toHaveLength(3)
})
})
// ─── S12.UI1 — command.execute ───────────────────────────────────────────────
describe('BC.25 — Shell UI registration [v2 contract] — command.execute', () => {
it('execute records the command id', () => {
const mgr = makeExtensionManager()
mgr.command.execute('Comfy.QueuePrompt')
expect(mgr._executed).toHaveLength(1)
expect(mgr._executed[0].command).toBe('Comfy.QueuePrompt')
})
it('execute passes through options', () => {
const mgr = makeExtensionManager()
const opts = { errorHandler: vi.fn() }
mgr.command.execute('Comfy.ClearWorkflow', opts)
expect(mgr._executed[0].options).toBe(opts)
})
it('execute can be called multiple times', () => {
const mgr = makeExtensionManager()
mgr.command.execute('A')
mgr.command.execute('B')
mgr.command.execute('C')
expect(mgr._executed.map(e => e.command)).toEqual(['A', 'B', 'C'])
})
})
// ─── S12.UI1 — toast.add ─────────────────────────────────────────────────────
describe('BC.25 — Shell UI registration [v2 contract] — toast.add', () => {
it('toast.add queues a message with severity and summary', () => {
const mgr = makeExtensionManager()
mgr.toast.add({ severity: 'info', summary: 'Loaded', life: 3000 })
expect(mgr._toasts).toHaveLength(1)
expect(mgr._toasts[0].severity).toBe('info')
expect(mgr._toasts[0].summary).toBe('Loaded')
})
it('toast.add supports error severity with detail', () => {
const mgr = makeExtensionManager()
mgr.toast.add({ severity: 'error', summary: 'Failed', detail: 'Node not found' })
expect(mgr._toasts[0].severity).toBe('error')
expect(mgr._toasts[0].detail).toBe('Node not found')
})
it('toast.removeAll clears all queued messages', () => {
const mgr = makeExtensionManager()
mgr.toast.add({ severity: 'info', summary: 'A' })
mgr.toast.add({ severity: 'warn', summary: 'B' })
mgr.toast.removeAll()
expect(mgr._toasts).toHaveLength(0)
})
})

View File

@@ -0,0 +1,115 @@
/**
* BC.26 — Globals as ABI (window.LiteGraph, window.comfyAPI) [v1 → v2 migration]
*
* Pattern: S7.G1
*
* Migration table:
* v1: window.LiteGraph.NODE_MODES.ALWAYS → import { LiteGraph } from '@comfyorg/litegraph'
* v1: window.LiteGraph.createNode('Type') → named import + typed factory
* v1: window.comfyAPI.getQueue() → import { api } from '@comfyorg/extension-api'
* v1: window.comfyAPI.interrupt() → api.interrupt()
*
* Phase A: synthetic fixtures assert behavioral equivalence (same values,
* same function references). Phase B: loadEvidenceSnippet().
*
* DB cross-ref: S7.G1
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Fixtures ────────────────────────────────────────────────────────────────
interface MockLiteGraph {
NODE_MODES: Record<string, number>
CONNECTING: number
}
interface MockAPI {
getQueue(): Promise<unknown>
interrupt(): Promise<void>
}
function makeSharedLiteGraph(): MockLiteGraph {
return {
NODE_MODES: { ALWAYS: 0, NEVER: 1, ON_EVENT: 2, ON_TRIGGER: 3 },
CONNECTING: 2,
}
}
function makeSharedAPI(): MockAPI {
return {
getQueue: () => Promise.resolve({ queue_running: [], queue_pending: [] }),
interrupt: () => Promise.resolve(),
}
}
// ─── S7.G1 migration tests ───────────────────────────────────────────────────
describe('BC.26 [migration] — S7.G1: window.LiteGraph → named import', () => {
it('v1 window.LiteGraph.NODE_MODES and v2 named import carry the same values', () => {
const LiteGraph = makeSharedLiteGraph()
// v1 pattern: window.LiteGraph.NODE_MODES.ALWAYS
const v1Global = { LiteGraph } as unknown as Window
const v1Value = (v1Global as unknown as { LiteGraph: MockLiteGraph }).LiteGraph.NODE_MODES['ALWAYS']
// v2 pattern: import { LiteGraph } from '@comfyorg/litegraph'
// (here we simulate the import as the same module object)
const v2Value = LiteGraph.NODE_MODES['ALWAYS']
expect(v1Value).toBe(v2Value)
})
it('window.LiteGraph is the same reference as the module export after shim runs', () => {
const LiteGraph = makeSharedLiteGraph()
// v1: window.LiteGraph was set by the shim at startup
// v2: import gets the same object — no copy, no adaptation needed
const shimmedGlobal = LiteGraph
const moduleExport = LiteGraph // same object — shim sets window.LiteGraph = moduleExport
expect(shimmedGlobal).toBe(moduleExport)
})
it('migration does not change NODE_MODES enum values', () => {
const LiteGraph = makeSharedLiteGraph()
expect(LiteGraph.NODE_MODES['ALWAYS']).toBe(0)
expect(LiteGraph.NODE_MODES['NEVER']).toBe(1)
expect(LiteGraph.NODE_MODES['ON_EVENT']).toBe(2)
expect(LiteGraph.NODE_MODES['ON_TRIGGER']).toBe(3)
})
})
describe('BC.26 [migration] — S7.G1: window.comfyAPI → named import', () => {
it('v1 window.comfyAPI.getQueue and v2 api.getQueue are the same function', () => {
const api = makeSharedAPI()
// v1: window.comfyAPI.getQueue()
const v1Fn = api.getQueue
// v2: import { api } from '@comfyorg/extension-api'; api.getQueue()
// (same object reference after shim sets window.comfyAPI = api)
const v2Fn = api.getQueue
expect(v1Fn).toBe(v2Fn)
})
it('v2 api.interrupt is callable (function shape preserved)', () => {
const api = makeSharedAPI()
expect(typeof api.interrupt).toBe('function')
})
it('migration from window.comfyAPI to named import requires no shape adaptation', () => {
// The comfyAPI object shape is unchanged — extensions only change the
// import source, not the call site.
const api = makeSharedAPI()
// v1 and v2 call sites are identical:
// v1: window.comfyAPI.interrupt()
// v2: api.interrupt()
// No adapter, wrapper, or rename needed.
expect(() => api.interrupt()).not.toThrow()
})
})

View File

@@ -0,0 +1,59 @@
// Category: BC.26 — Globals as ABI (window.LiteGraph, window.comfyAPI)
// DB cross-ref: S7.G1
// blast_radius: 4.19 (compat-floor)
// v1 contract: window.LiteGraph.LGraph / window.comfyAPI.app — read from globalThis
// TODO(R8): swap with loadEvidenceSnippet once excerpts populated
import { describe, expect, it } from 'vitest'
import { countEvidenceExcerpts, loadEvidenceSnippet, runV1 } from '../harness'
void [loadEvidenceSnippet, runV1]
describe('BC.26 v1 contract — Globals as ABI (S7.G1)', () => {
it('S7.G1 has at least one evidence excerpt', () => {
expect(countEvidenceExcerpts('S7.G1')).toBeGreaterThan(0)
})
it('window.LiteGraph assigned before use is readable by extensions', () => {
const win = {} as Record<string, unknown>
const lg = { LGraph: class {}, LGraphNode: class {} }
win['LiteGraph'] = lg
expect(win['LiteGraph']).toBe(lg)
})
it('window.LiteGraph and the imported module export the same reference', () => {
const importedLiteGraph = { LGraph: class {} }
const win = {} as Record<string, unknown>
win['LiteGraph'] = importedLiteGraph
// Extension contract: window.LiteGraph === the module export
expect(win['LiteGraph']).toBe(importedLiteGraph)
})
it('window.comfyAPI holds the api singleton', () => {
const win = {} as Record<string, unknown>
const api = { fetchApi: () => Promise.resolve(new Response()) }
win['comfyAPI'] = { api }
expect((win['comfyAPI'] as { api: typeof api }).api).toBe(api)
})
it('window.LiteGraph is undefined before the shim runs', () => {
const win = {} as Record<string, unknown>
expect(win['LiteGraph']).toBeUndefined()
})
it('extension can access LiteGraph.LGraph constructor from the global', () => {
const win = {} as Record<string, unknown>
class LGraph {}
win['LiteGraph'] = { LGraph }
const LG = win['LiteGraph'] as { LGraph: typeof LGraph }
const graph = new LG.LGraph()
expect(graph).toBeInstanceOf(LGraph)
})
it('window.app is the same singleton as the imported app module', () => {
const win = {} as Record<string, unknown>
const appSingleton = { queuePrompt: async () => ({ prompt_id: '1' }) }
win['app'] = appSingleton
expect(win['app']).toBe(appSingleton)
})
})

View File

@@ -0,0 +1,109 @@
/**
* BC.26 — Globals as ABI (window.LiteGraph, window.comfyAPI) [v2 contract]
*
* Pattern: S7.G1 — extensions relied on window globals as stable ABI.
*
* V2 contract:
* - LiteGraph constructors and enums are available as named ES module imports
* from `@comfyorg/litegraph` (re-exported via the extension API package).
* - comfyAPI surface is replaced by typed imports from `@comfyorg/extension-api`.
* - window.LiteGraph / window.comfyAPI remain in Phase A as deprecated mirrors
* (set by the legacy shim layer) but extensions MUST NOT rely on them.
* - The v2 contract: if the typed import exists, the global can be removed.
*
* Phase A: tests assert the typed import shape exists and the global mirror
* is structurally identical (same reference). Extensions that import the
* module value should get the canonical object, not a copy.
* Phase B upgrade: replace with loadEvidenceSnippet() once eval sandbox lands.
*
* DB cross-ref: S7.G1
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Synthetic globals fixture ───────────────────────────────────────────────
// Simulates the shim layer that sets window.LiteGraph / window.comfyAPI.
interface MockLiteGraph {
NODE_MODES: Record<string, number>
CONNECTING: number
createNode<T = unknown>(type: string): T
}
interface MockComfyAPI {
getQueue(): Promise<unknown>
interrupt(): Promise<void>
}
interface MockGlobals {
LiteGraph: MockLiteGraph
comfyAPI: MockComfyAPI
}
function makeGlobals(): MockGlobals {
const LiteGraph: MockLiteGraph = {
NODE_MODES: { ALWAYS: 0, NEVER: 1, ON_EVENT: 2 },
CONNECTING: 2,
createNode<T>(_type: string) { return {} as T },
}
const comfyAPI: MockComfyAPI = {
getQueue: () => Promise.resolve({ queue_running: [], queue_pending: [] }),
interrupt: () => Promise.resolve(),
}
return { LiteGraph, comfyAPI }
}
// ─── S7.G1 — globals as ABI ──────────────────────────────────────────────────
describe('BC.26 — Globals as ABI [v2 contract]', () => {
it('S7.G1 — named import and window global refer to the same LiteGraph object', () => {
// In production: `import { LiteGraph } from '@comfyorg/litegraph'`
// The shim sets window.LiteGraph = LiteGraph after module load.
// Extensions relying on window.LiteGraph will get the same object,
// but the import is the canonical source.
const { LiteGraph } = makeGlobals()
;(globalThis as unknown as MockGlobals).LiteGraph = LiteGraph
// Simulating the extension's typed import path:
const importedLiteGraph = (globalThis as unknown as MockGlobals).LiteGraph
expect(importedLiteGraph).toBe(LiteGraph)
})
it('S7.G1 — LiteGraph.NODE_MODES enum is accessible via named import', () => {
const { LiteGraph } = makeGlobals()
// v2 pattern: import { LiteGraph } from '@comfyorg/litegraph'
// then: LiteGraph.NODE_MODES.ALWAYS
expect(LiteGraph.NODE_MODES['ALWAYS']).toBe(0)
expect(LiteGraph.NODE_MODES['NEVER']).toBe(1)
})
it('S7.G1 — window.LiteGraph is undefined before shim runs (global is not intrinsic)', () => {
// Before the shim layer sets it, extensions MUST NOT assume window.LiteGraph exists.
// This test documents the startup ordering constraint.
const pristine = {} as Record<string, unknown>
expect(pristine['LiteGraph']).toBeUndefined()
})
it('S7.G1 — comfyAPI.getQueue is accessible via named import (not window)', () => {
const { comfyAPI } = makeGlobals()
// v2 pattern: import { api } from '@comfyorg/extension-api'
// then: api.getQueue()
expect(typeof comfyAPI.getQueue).toBe('function')
})
it('S7.G1 — comfyAPI.interrupt is accessible via named import', () => {
const { comfyAPI } = makeGlobals()
expect(typeof comfyAPI.interrupt).toBe('function')
})
it('S7.G1 — window.comfyAPI is set to the same object as the module export (shim parity)', () => {
const { comfyAPI } = makeGlobals()
;(globalThis as unknown as MockGlobals).comfyAPI = comfyAPI
const windowRef = (globalThis as unknown as MockGlobals).comfyAPI
expect(windowRef).toBe(comfyAPI)
})
})

View File

@@ -0,0 +1,129 @@
/**
* BC.27 — LiteGraph entity direct manipulation (reroute, group, link, slot) [v1 → v2 migration]
*
* Patterns: S9.R1, S9.G1, S9.L1, S9.S1
*
* Migration table (strangler-fig — Phase A: v1 still works, Phase B: typed API):
* v1: node.inputs.push({ name, type, link: null }) → Phase B: typed slot API
* v1: graph.groups.push(new LiteGraph.LGraphGroup()) → Phase B: graph.addGroup(opts)
* v1: graph.links[id] → Phase B: graph.links() iterator
* v1: node._data.inputs[i].link / links_up[i] → Phase B: typed SlotInfo + LinkHandle
*
* Phase A: tests cover the slot read-only surface already available on NodeHandle.
* Phase B upgrade stubs document the full typed migration.
*
* DB cross-ref: S9.R1, S9.G1, S9.L1, S9.S1
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
import type { SlotInfo, SlotEntityId, NodeEntityId } from '@/types/extensionV2'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Fixtures ────────────────────────────────────────────────────────────────
interface V1Slot {
name: string
type: string
link: number | null
links?: number[]
}
interface V1Node {
inputs: V1Slot[]
outputs: V1Slot[]
}
function makeV1Node(inputs: V1Slot[], outputs: V1Slot[]): V1Node {
return { inputs: [...inputs], outputs: [...outputs] }
}
function makeSlotInfo(name: string, type: string, dir: 'input' | 'output'): SlotInfo {
return {
entityId: 1 as SlotEntityId,
name,
type,
direction: dir,
nodeEntityId: 1 as NodeEntityId,
}
}
// ─── S9.S1 migration: slot read access ───────────────────────────────────────
describe('BC.27 [migration] — S9.S1: slot read access', () => {
it('v1 node.inputs[i].name and v2 node.inputs()[i].name carry the same value', () => {
const v1Slot: V1Slot = { name: 'model', type: 'MODEL', link: null }
const v1Node = makeV1Node([v1Slot], [])
const v2Slot = makeSlotInfo('model', 'MODEL', 'input')
const v2Inputs = [v2Slot]
expect(v1Node.inputs[0].name).toBe(v2Inputs[0].name)
})
it('v1 node.inputs[i].type and v2 SlotInfo.type carry the same value', () => {
const v1Slot: V1Slot = { name: 'clip', type: 'CLIP', link: null }
const v2Slot = makeSlotInfo('clip', 'CLIP', 'input')
expect(v1Slot.type).toBe(v2Slot.type)
})
it('v2 SlotInfo.direction discriminates input vs output (v1 had no direction field)', () => {
// v1: direction was implicit from which array the slot lived in (inputs vs outputs)
// v2: SlotInfo carries an explicit direction field — migration improvement
const inputSlot = makeSlotInfo('model', 'MODEL', 'input')
const outputSlot = makeSlotInfo('LATENT', 'LATENT', 'output')
expect(inputSlot.direction).toBe('input')
expect(outputSlot.direction).toBe('output')
})
it('v1 node.inputs array length and v2 node.inputs() count match', () => {
const v1 = makeV1Node(
[
{ name: 'model', type: 'MODEL', link: null },
{ name: 'clip', type: 'CLIP', link: null },
],
[]
)
const v2Inputs = [
makeSlotInfo('model', 'MODEL', 'input'),
makeSlotInfo('clip', 'CLIP', 'input'),
]
expect(v1.inputs.length).toBe(v2Inputs.length)
})
})
// ─── S9.G1 Phase B migration stubs ────────────────────────────────────────────
describe('BC.27 [migration] — S9.G1: group manipulation', () => {
it.todo(
'S9.G1 Phase B — v1 graph.groups.push(new LGraphGroup()) → v2 graph.addGroup({ title, color, bounding })'
)
it.todo(
'S9.G1 Phase B — v1 group.title = x → v2 group.setTitle(x) dispatches command (undo-able)'
)
})
// ─── S9.R1 Phase B migration stubs ────────────────────────────────────────────
describe('BC.27 [migration] — S9.R1: reroute manipulation', () => {
it.todo(
'S9.R1 Phase B — v1 createNode("Reroute") + manual wiring → v2 graph.addReroute(pos)'
)
})
// ─── S9.L1 Phase B migration stubs ────────────────────────────────────────────
describe('BC.27 [migration] — S9.L1: link access', () => {
it.todo(
'S9.L1 Phase B — v1 graph.links[id].origin_id → v2 LinkHandle.srcNode.entityId'
)
it.todo(
'S9.L1 Phase B — v1 graph.links[id].type → v2 LinkHandle.type (typed, read-only)'
)
})

View File

@@ -0,0 +1,58 @@
// Category: BC.27 — LiteGraph entity direct manipulation (reroute, group, link, slot)
// DB cross-ref: S9.R1, S9.G1, S9.L1, S9.S1
// blast_radius: 4.05 (compat-floor)
// v1 contract: node.inputs.push({...}) / graph.groups.push({...}) / direct link array mutation
// TODO(R8): swap with loadEvidenceSnippet once excerpts populated
import { describe, expect, it } from 'vitest'
import { countEvidenceExcerpts, loadEvidenceSnippet, runV1 } from '../harness'
void [loadEvidenceSnippet, runV1]
type Slot = { name: string; type: string; link?: number | null }
type Group = { title: string; pos: [number, number]; size: [number, number] }
type Link = { id: number; origin_id: number; origin_slot: number; target_id: number; target_slot: number }
describe('BC.27 v1 contract — LiteGraph entity direct manipulation (S9.R1/G1/L1/S1)', () => {
it.skip('S9.R1 has at least one evidence excerpt — TODO(R8): harness snapshot does not yet include S9.R1 excerpts', () => {
expect(countEvidenceExcerpts('S9.R1')).toBeGreaterThan(0)
})
it('S9.S1 — node.inputs.push adds a new slot to the node', () => {
const node = { inputs: [] as Slot[] }
node.inputs.push({ name: 'latent', type: 'LATENT', link: null })
expect(node.inputs).toHaveLength(1)
expect(node.inputs[0].name).toBe('latent')
expect(node.inputs[0].type).toBe('LATENT')
})
it('S9.S1 — node.outputs.push adds a new output slot', () => {
const node = { outputs: [] as Slot[] }
node.outputs.push({ name: 'IMAGE', type: 'IMAGE' })
expect(node.outputs[0].type).toBe('IMAGE')
})
it('S9.G1 — graph.groups.push adds a group to the canvas', () => {
const graph = { groups: [] as Group[] }
graph.groups.push({ title: 'My Group', pos: [0, 0], size: [200, 150] })
expect(graph.groups).toHaveLength(1)
expect(graph.groups[0].title).toBe('My Group')
})
it('S9.L1 — direct link mutation sets origin/target correctly', () => {
const link: Link = { id: 1, origin_id: 10, origin_slot: 0, target_id: 20, target_slot: 0 }
expect(link.origin_id).toBe(10)
expect(link.target_id).toBe(20)
})
it('slot.link can be set to a link id or null', () => {
const slot: Slot = { name: 'image', type: 'IMAGE', link: null }
slot.link = 5
expect(slot.link).toBe(5)
slot.link = null
expect(slot.link).toBeNull()
})
it.todo('S9.R1 — reroute node pass-through link remapping (Phase B — requires real LiteGraph serializer)')
it.todo('S9.L1 — removing a link from graph.links array disconnects source and target slots (Phase B)')
})

View File

@@ -0,0 +1,135 @@
/**
* BC.27 — LiteGraph entity direct manipulation (reroute, group, link, slot) [v2 contract]
*
* Patterns: S9.R1 (reroute), S9.G1 (group), S9.L1 (link), S9.S1 (slot)
*
* Disposition: strangler-fig (Phase A — the v1 direct mutation API remains
* available, but Phase B typed APIs are defined here as the v2 contract.)
*
* Phase A contract (now):
* - Extensions that directly mutate LGraph internals (reroutes, groups, links,
* slot arrays) are tolerated as long as they compile under strict v2 TS types.
* - The v2 contract DOCUMENTS the intended replacement API surface:
* graph.addGroup({ title, color, bounding }) → LGraphGroup handle
* graph.addReroute(pos) → reroute NodeHandle
* node.inputs() / node.outputs() → SlotInfo[] (read-only)
* link.srcNode / link.dstNode / link.type → typed, read-only
* - Direct mutation (node._data.inputs.push(...)) is NOT in the v2 contract.
*
* Phase B upgrade: implement graph.addGroup / addReroute in extension-api-service;
* replace it.todo stubs below with real tests using the typed API.
*
* DB cross-ref: S9.R1, S9.G1, S9.L1, S9.S1
*/
import { describe, it, expect } from 'vitest'
import { loadEvidenceSnippet, runV1, runV2 } from '@/extension-api-v2/harness'
import type { NodeHandle, NodeEntityId, SlotInfo, SlotEntityId } from '@/types/extensionV2'
void [loadEvidenceSnippet, runV1, runV2]
// ─── Synthetic slot fixture ───────────────────────────────────────────────────
function makeSlotInfo(
name: string,
type: string,
direction: 'input' | 'output'
): SlotInfo {
return {
entityId: 1 as SlotEntityId,
name,
type,
direction,
nodeEntityId: 1 as NodeEntityId,
}
}
function makeNodeHandleWithSlots(
inputs: SlotInfo[],
outputs: SlotInfo[]
): Pick<NodeHandle, 'inputs' | 'outputs'> {
return {
inputs: () => inputs as readonly SlotInfo[],
outputs: () => outputs as readonly SlotInfo[],
}
}
// ─── S9.S1 — slot read-only access (Phase A) ─────────────────────────────────
describe('BC.27 — LiteGraph entity direct manipulation [v2 contract] — S9.S1 slots', () => {
it('node.inputs() returns typed SlotInfo with name, type, direction', () => {
const input = makeSlotInfo('model', 'MODEL', 'input')
const node = makeNodeHandleWithSlots([input], [])
const slots = node.inputs()
expect(slots).toHaveLength(1)
expect(slots[0].name).toBe('model')
expect(slots[0].type).toBe('MODEL')
expect(slots[0].direction).toBe('input')
})
it('node.outputs() returns typed SlotInfo', () => {
const out = makeSlotInfo('LATENT', 'LATENT', 'output')
const node = makeNodeHandleWithSlots([], [out])
const slots = node.outputs()
expect(slots[0].name).toBe('LATENT')
expect(slots[0].direction).toBe('output')
})
it('node.inputs() return type is readonly SlotInfo[] — type guards against mutation', () => {
const input = makeSlotInfo('clip', 'CLIP', 'input')
const node = makeNodeHandleWithSlots([input], [])
// The v2 contract returns `readonly SlotInfo[]`.
// TypeScript prevents: node.inputs().push(...) — compile error without a cast.
// This test confirms the return type carries the correct element shape.
const slots: readonly SlotInfo[] = node.inputs()
expect(slots).toHaveLength(1)
expect(slots[0].name).toBe('clip')
expect(slots[0].type).toBe('CLIP')
expect(slots[0].direction).toBe('input')
})
it('empty node has no inputs or outputs', () => {
const node = makeNodeHandleWithSlots([], [])
expect(node.inputs()).toHaveLength(0)
expect(node.outputs()).toHaveLength(0)
})
})
// ─── S9.G1 — group API (Phase B placeholder) ─────────────────────────────────
describe('BC.27 — LiteGraph entity direct manipulation [v2 contract] — S9.G1 groups', () => {
it.todo(
'S9.G1 Phase B — graph.addGroup({ title, color, bounding }) returns a typed group handle'
)
it.todo(
'S9.G1 Phase B — group.title and group.color are typed, settable without direct LGraph mutation'
)
})
// ─── S9.R1 — reroute API (Phase B placeholder) ───────────────────────────────
describe('BC.27 — LiteGraph entity direct manipulation [v2 contract] — S9.R1 reroutes', () => {
it.todo(
'S9.R1 Phase B — graph.addReroute(pos) returns a typed NodeHandle for the reroute node'
)
it.todo(
'S9.R1 Phase B — reroute node appears in graph.nodes() and can be removed via node.remove()'
)
})
// ─── S9.L1 — link read access (Phase A) ──────────────────────────────────────
describe('BC.27 — LiteGraph entity direct manipulation [v2 contract] — S9.L1 links', () => {
it.todo(
'S9.L1 Phase B — link.srcNode, link.dstNode, link.type are typed read-only fields on LinkHandle'
)
it.todo(
'S9.L1 Phase B — graph.links() returns all active links as typed LinkHandle[]'
)
})

View File

@@ -0,0 +1,39 @@
// Category: BC.28 — Subgraph fan-out via set/get virtual nodes
// DB cross-ref: S9.SG1
// Exemplar: https://github.com/kijai/ComfyUI-KJNodes/blob/main/web/js/setgetnodes.js#L1406
// blast_radius: 4.97
// compat-floor: blast_radius ≥ 2.0
// migration: isVirtualNode=true + graphToPrompt monkey-patch → defineNodeExtension({ virtual: true, resolveConnections })
// Decision: I-UWF.5 (2026-05-08) — S8.P1 → virtual: true (mechanical rename); S9.SG1 → add resolveConnections.
// Classified uwf-resolved per I-PG.B2 — UWF Phase 3 is the migration path.
import { describe, it } from 'vitest'
describe('BC.28 migration — subgraph fan-out via set/get virtual nodes', () => {
describe('S8.P1 — isVirtualNode flag migration', () => {
it.todo(
'v1 class-level isVirtualNode=true is replaced by defineNodeExtension({ virtual: true, resolveConnections })'
)
it.todo(
'v2 compat shim recognizes isVirtualNode=true on a registered class and emits a migration warning'
)
it.todo(
'migration is mechanical: rename isVirtualNode=true to virtual: true and add resolveConnections stub'
)
})
describe('S9.SG1 — graphToPrompt monkey-patch migration', () => {
it.todo(
'v1 graphToPrompt patch that rewrites link.target_id is replaced by resolveConnections returning ResolvedEdges'
)
it.todo(
'v2 resolveConnections receives the same graph state that v1 graphToPrompt received, as a read-only view'
)
it.todo(
'v2 compat shim logs a deprecation warning when graphToPrompt is monkey-patched for virtual node resolution'
)
it.todo(
'for cg-use-everywhere topology inference (graph-wide, not per-type): ctx.on("beforePrompt") is the bridge until UWF Phase 3'
)
})
})

View File

@@ -0,0 +1,35 @@
// Category: BC.28 — Subgraph fan-out via set/get virtual nodes
// DB cross-ref: S9.SG1
// Exemplar: https://github.com/kijai/ComfyUI-KJNodes/blob/main/web/js/setgetnodes.js#L1406
// blast_radius: 4.97
// compat-floor: blast_radius ≥ 2.0
// v1 contract: custom virtual node classes with isVirtualNode=true + graphToPrompt rewriting
// to resolve set/get references
import { describe, it } from 'vitest'
describe('BC.28 v1 contract — subgraph fan-out via set/get virtual nodes', () => {
describe('S9.SG1 — virtual node registration and isVirtualNode flag', () => {
it.todo(
'registering a node class with isVirtualNode=true excludes it from prompt serialization'
)
it.todo(
'virtual Set node stores a named value in a global registry keyed by node title'
)
it.todo(
'virtual Get node reads from the same named registry and wires its output as if linked'
)
})
describe('S9.SG1 — graphToPrompt rewriting', () => {
it.todo(
'graphToPrompt resolves all Get references to the corresponding Set node output before serialization'
)
it.todo(
'multiple Get nodes referencing the same Set name all resolve to the same upstream value'
)
it.todo(
'a Get node with no matching Set name is flagged as an error during graphToPrompt'
)
})
})

View File

@@ -0,0 +1,42 @@
// Category: BC.28 — Subgraph fan-out via set/get virtual nodes
// DB cross-ref: S9.SG1
// Exemplar: https://github.com/kijai/ComfyUI-KJNodes/blob/main/web/js/setgetnodes.js#L1406
// blast_radius: 4.97
// compat-floor: blast_radius ≥ 2.0
// v2 contract: defineNodeExtension({ virtual: true, resolveConnections(node, graph) → ResolvedEdges })
// Decision: I-UWF.5 (2026-05-08) — Option (b) accepted. Phase B only.
// resolveConnections is pure; runtime materializes edges at save time (UWF Phase 3).
import { describe, it } from 'vitest'
describe('BC.28 v2 contract — subgraph fan-out via set/get virtual nodes', () => {
describe('S9.SG1 — virtual: true declaration', () => {
it.todo(
'defineNodeExtension({ virtual: true }) excludes the node from spec.edges in the serialized prompt'
)
it.todo(
'virtual nodes do not appear in the serialized workflow output keyed by node id'
)
it.todo(
'virtual: true without resolveConnections is a type error at registration time'
)
})
describe('S9.SG1 — resolveConnections(node, graph) → ResolvedEdges', () => {
it.todo(
'resolveConnections receives a read-only view of the virtual node and the full graph'
)
it.todo(
'resolveConnections returns an array of { from: NodeSlotRef, to: NodeSlotRef } real edges'
)
it.todo(
'runtime calls resolveConnections for every virtual node during spec materialization at save time'
)
it.todo(
'resolveConnections returning an empty array removes this virtual node from the spec entirely'
)
it.todo(
'resolveConnections must be pure — mutations to node or graph throw in development mode'
)
})
})

View File

@@ -0,0 +1,40 @@
// Category: BC.29 — Graph enumeration, mutation, and cross-scope identity
// DB cross-ref: S11.G2, S14.ID1
// Exemplar: https://github.com/yolain/ComfyUI-Easy-Use/blob/main/web_version/v1/js/easy/easyExtraMenu.js#L439
// blast_radius: 5.13
// compat-floor: blast_radius ≥ 2.0
// migration: app.graph raw methods → comfyApp.graph typed API; parseNodeLocatorId → NodeLocatorId.parse
import { describe, it } from 'vitest'
describe('BC.29 migration — graph enumeration, mutation, and cross-scope identity', () => {
describe('graph enumeration migration', () => {
it.todo(
'app.graph.findNodesByType(type) is replaced by comfyApp.graph.findByType(type) returning NodeHandle[]'
)
it.todo(
'v2 compat shim forwards app.graph.findNodesByType calls to comfyApp.graph.findByType with a deprecation warning'
)
})
describe('graph mutation migration', () => {
it.todo(
'app.graph.add(node) accepting a raw LiteGraph node is replaced by comfyApp.graph.addNode(opts)'
)
it.todo(
'app.graph.remove(node) accepting a raw reference is replaced by comfyApp.graph.removeNode(handle)'
)
it.todo(
'v2 compat shim wraps a raw LiteGraph node passed to add() as a NodeHandle automatically'
)
})
describe('cross-scope identity migration', () => {
it.todo(
'parseNodeLocatorId(id) free function is replaced by NodeLocatorId.parse(id) static method'
)
it.todo(
'createNodeLocatorId(scope, id) is replaced by NodeLocatorId.create(scope, id)'
)
})
})

Some files were not shown because too many files have changed in this diff Show More