Compare commits

..
26 Commits
Author SHA1 Message Date
KOFiblto 2696781d6b Release: 2.6.3 2026-10-30 00:02:59 +01:00
KOFiblto 7517f1fe80 Test: scan whole files for deprecated settings default argument 2026-10-27 02:25:32 +01:00
KOFiblto 8a5638221f Fix: avoid deprecated settings default argument in LoRA picker 2026-10-27 02:24:00 +01:00
KOFiblto 0b2b274583 Fix: freeze queued prompts at click time and honor linked iterator input 2026-10-27 02:15:08 +01:00
KOFiblto eacd239d23 Docs: validate LoRA loader audit and correct root cause verdicts 2026-10-27 02:04:58 +01:00
KOFiblto 04ade0dae5 Fix: stabilize sequential LoRA cycle and default selection mode 2026-10-27 02:04:54 +01:00
KOFiblto 3c912c3a1d Ci: restrict registry publish to manual workflow_dispatch on main only 2026-10-26 14:10:26 +01:00
KOFiblto 0eefe12131 Docs: document LoRA loader root causes in LORA_LOADER_AUDIT.md and exclude credentials in .comfyignore 2026-10-26 14:06:25 +01:00
KOFiblto b2b6f6badb Fix: correct registry publisher id and guard missing publish token 2026-10-24 21:52:56 +02:00
KOFiblto 00cfd979bf Test: cover corrupt image restore recovery
Verifies that a corrupt output image still produces a usable restored history entry with empty metadata and mtime-only timing, and refreshes the suite count.
2026-10-24 03:47:25 +02:00
KOFiblto 53dfbe4999 Fix: normalize corrupt duration timestamps and clamp batch indexes
Normalizes malformed completed timestamps during duration-store sanitization so allow_nan=False saves cannot fail on a hand-edited record. Clamps out-of-range restored item indexes to the batch bounds and extends the DOM regression test.
2026-10-24 03:45:47 +02:00
KOFiblto 88d1ac3666 Fix: sanitize stored durations and validate batch hex colors
Drops corrupt generation-time entries on load/save so one bad hand-edited record cannot block future writes under allow_nan=False. Restricts batch colors to complete 3/4/6/8-digit hex values and adds cross-day timestamp plus corrupt-store regression tests.
2026-10-24 03:44:08 +02:00
KOFiblto 0d5f76bf89 Docs: document 2.6.3 restore and batch hardening
Adds the 2.6.3 Added/Changed/Fixed sections covering deterministic restore ordering, queue identity repair, duration validation, cancel/wipe recovery ordering, batch metadata sanitization, and the 221-test regression matrix.
2026-10-24 03:41:29 +02:00
KOFiblto 8c9fcf5225 Fix: harden restore ordering, queue identity, and batch metadata
Deterministic mtime/path ordering, restore locking, duration and metadata validation, persistent queue entry repair and ordered create times, cancel/wipe recovery ordering, batch color sanitization, and concurrency-safe batch item indexes. Adds 61 Python tests and 3 Node DOM regression tests.
2026-10-24 03:41:26 +02:00
KOFiblto 69fe4ceaf1 Chore: start 2.6.3 development 2026-10-24 03:15:07 +02:00
KOFiblto b21497f664 Docs: finalize 2.6.2 release notes 2026-10-24 03:13:37 +02:00
KOFiblto 29a8d9286f Fix: harden recycled DOM state and version the persistent queue 2026-10-24 03:13:18 +02:00
KOFiblto d3ccc24055 Fix: repaint restored queue batch lines when jobs start 2026-10-24 01:16:37 +02:00
KOFiblto 8756d720ae Fix: isolate tests from live SaturnNodes user state 2026-10-20 16:04:53 +02:00
KOFiblto 33e9201ac8 Docs: document 2.6.2 generation times and settings 2026-10-20 15:40:15 +02:00
KOFiblto 3f2a1d5421 Fix: scan image folders off the event loop and cache thumbnails 2026-10-20 15:40:09 +02:00
KOFiblto 49f8cfbde6 Fix: unify .env settings and seed settings UI from backend 2026-10-20 15:39:55 +02:00
KOFiblto 913fc5354d Fix: bound LoRA selection state and usage writes 2026-10-20 15:39:38 +02:00
KOFiblto fb8e8ec8d5 Fix: make prompt iterator state deterministic and workflow-compatible 2026-10-20 15:39:21 +02:00
KOFiblto 59b41a19a4 Fix: harden queue persistence, pause state and batch metadata 2026-10-20 15:39:03 +02:00
KOFiblto aaf49230b2 Feat: record and restore real generation times 2026-10-20 15:38:52 +02:00
56 changed files with 8267 additions and 767 deletions
+7
View File
@@ -11,6 +11,13 @@ AGENTS.md
CLAUDE.md
GEMINI.md
CONTRIBUTING.md
STATUS.md
LORA_LOADER_AUDIT.md
# Environment variables & local credentials
.env
.env.*
*.env
# Python bytecode caches
__pycache__/
+10 -3
View File
@@ -9,18 +9,25 @@ CIVITAI_API_KEY=
TMDB_API_KEY=
# Feature toggles
ENABLE_CIVITAI_SCRAPING=true
ENABLE_TMDB_SCRAPING=true
ENABLE_CIVITAI_SCRAPING=false
ENABLE_TMDB_SCRAPING=false
ENABLE_LORA_USAGE=true
ENABLE_PERSISTENT_QUEUE=true
ENABLE_TRAY_ICON=false
ENABLE_ASSETS_RESTORE=true
RESTORE_ASSETS_COUNT=64
RESTORE_ASSETS_RECURSIVE=true
SHOW_RESTORED_GENERATION_TIME=true
# Visual image loader metadata scanning (0 disables prompt extraction)
IMAGE_LOADER_METADATA_LIMIT=128
# Launch defaults
DEFAULT_PAUSE_STATE=Paused
DEFAULT_PAUSE_STATE=Running
DEFAULT_PAUSE_MODE=after_finish
PERSISTENT_QUEUE_RESTORED_STATE=Match Default
PERSISTENT_QUEUE_MAX_RETRIES=0
PERSIST_PAUSE_STATE=false
# Prompt iterator privacy
CLEAR_PROMPT_ITERATOR_ON_LAUNCH=false
+9 -4
View File
@@ -2,17 +2,22 @@ name: Publish to ComfyUI Registry
on:
workflow_dispatch:
push:
branches: [ main ]
paths:
- 'pyproject.toml'
jobs:
publish:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Verify registry token
env:
REGISTRY_ACCESS_TOKEN: ${{ secrets.REGISTRY_ACCESS_TOKEN }}
run: |
if [ -z "$REGISTRY_ACCESS_TOKEN" ]; then
echo "::error::REGISTRY_ACCESS_TOKEN is not configured. Create an API key at https://registry.comfy.org/nodes for the publisher 'kofiblto' and store it under Settings -> Secrets and variables -> Actions."
exit 1
fi
- name: Publish Custom Node
uses: Comfy-Org/publish-node-action@main
with:
+2
View File
@@ -51,6 +51,7 @@ ComfyUI-SaturnNodes/
│ ├── assets_restore.py # Startup output-folder history restoration
│ ├── auto_watcher.py # Automated folder watch image loaders
│ ├── decision_node.py # Inline pause/gate decision node & notifications
│ ├── generation_times.py # Prompt duration recording for restored asset history
│ ├── image_loader.py # Visual image browser & EXIF/PNG metadata parser
│ ├── load_recent.py # Recent outputs loader node
│ ├── local_runner.py # Confined local script execution node & authorization routes
@@ -238,6 +239,7 @@ STATE_FILE = os.path.join(USER_DIR, "your_state.json")
- `ComfyUI/user/default/SaturnNodes/.env` — API keys and persistent settings
- `ComfyUI/user/default/SaturnNodes/lora_usage.json` — LoRA selection counts and usage badges
- `ComfyUI/user/default/SaturnNodes/image_prompts_cache.json` — Cached positive prompts extracted from images
- `ComfyUI/user/default/SaturnNodes/generation_times.json` — Recorded prompt durations and output filenames for restored asset history
- `ComfyUI/user/default/SaturnNodes/failed_scrapes.json` — Failed Civitai/TMDB scraping attempts cache
- `ComfyUI/user/default/SaturnNodes/prompt_iterator_state.json` — Current iteration pointers and popped prompt queues
- `ComfyUI/user/default/SaturnNodes/persistent_queue.json` — Real-time queue crash recovery state
+51 -3
View File
@@ -5,29 +5,77 @@ All notable changes to `ComfyUI-SaturnNodes` will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [2.6.1] - In Development
## [2.6.3] - 2026-10-30 [Stable]
### Added
- **Restore Regression Test Matrix**: 64 new deterministic Python tests and 3 new Node fake-DOM tests covering DOM injection, cross-day timestamps, equal-mtime ordering, restore limits, corrupt images, batches, cancellation, retries, corrupt state, and recovery. The existing `test_batch_queue_dom.mjs` is now run by the suite as well.
- **Queue Bleed Regression Tests**: `test_batch_queue_snapshot_dom.mjs` models two Queue clicks with an in-flight submission and asserts prompt text/LoRA freezing with live seed merging, and `test_prompt_iterator.py` covers linked-prompt precedence over stale local text.
### Changed
- **Deterministic Restore Ordering**: Output scanning and the Visual Image Loader now tie-break equal modification times by relative path, so bulk-copied or archive-extracted files always restore in the same order and receive stable history numbering.
- **Restored Queue Identity Repair**: `persistent_queue.json` entries are normalized on load and before restore. The top-level `prompt_id` is authoritative, `item[1]` is re-synced before queueing, duplicates collapse to the last occurrence, and malformed entries are dropped instead of crashing recovery.
- **Synthetic Restored Queue Timestamps**: Restored items receive strictly increasing `create_time` values ending just before "now", preserving their saved queue order instead of sharing one timestamp.
- **Best-Effort Asset DB Ingestion**: A failing `app.assets` registration no longer aborts a successful history restore.
- **Serialized Restores**: Startup restore and manual "Restore Now" requests are serialized by a restore lock so overlapping calls cannot interleave history writes or asset ingestion.
### Fixed
- **Restored Duration Validation**: `NaN`, infinite, negative, and non-numeric durations are rejected when recorded and when read, so they can no longer poison restored timestamps or produce invalid JSON.
- **Generation Times Persistence**: `generation_times.json` saves now sanitize corrupt entries, use unique temp files, retry transient Windows `os.replace` locks, serialize with `allow_nan=False`, and clean up leftover temp files.
- **Cancel/Wipe Recovery Loss**: Persistent queue entries are removed only after ComfyUI confirms the cancel or wipe; a failed operation keeps the crash-recovery copy intact.
- **Restore Robustness**: Missing queue mutexes, non-dict histories, history-read failures, malformed retry counters, and invalid restore limits are handled without aborting recovery.
- **EXIF / A1111 Metadata**: EXIF UserComments with BOM/NUL padding and byte-valued A1111 `parameters` now decode to clean prompt text.
- **Batch Color Injection**: Batch colors from `localStorage`/the server are restricted to plain hex values before entering SVG markup; invalid colors fall back to the palette.
- **Batch Counter & Metadata Corruption**: Negative persisted batch counters clamp into the palette range, metadata pruning uses `queuedAt` recency, unknown segment types normalize safely, out-of-range item indexes clamp to the batch bounds, and older server snapshots can no longer overwrite newer local batch metadata.
- **Concurrent Batch Item Indexes**: Concurrent submissions reserve unique `itemIndex` values through a captured batch context and `inFlight` counter, so two prompts can no longer claim the same index or clear the batch early.
- **Recent Output Loading**: `Load Recent Outputs` clamps invalid `amount`/`index` values, tie-breaks equal mtimes by path, and closes image handles after loading.
- **Registry Publisher ID**: `PublisherId` now matches the registry's case-sensitive publisher id `kofiblto` (the previous `KOFiblto` resolved to 404 on `api.comfy.org`), and the publish workflow fails fast with a readable message when `REGISTRY_ACCESS_TOKEN` is missing instead of running a full install first.
- **Sequential LoRA Cycle Reordering**: The Sequential cycle now persists the selection order it started with instead of indexing the live (reorderable) list, so deselecting and reselecting LoRAs can no longer repeat one LoRA and skip another from the same state bucket.
- **Missing LoRA Selection Mode Default**: `load_lora` and `IS_CHANGED` now fall back to `Sequential` (matching `INPUT_TYPES` and the UI) instead of `All`, so API prompts without `_selection_mode` cycle one LoRA per prompt instead of stacking every selected LoRA into one render.
- **Click-to-Queue Prompt Bleed**: Queue clicks made while another batch is still being submitted now serialize the graph at click time. Text, LoRA selections and other node inputs edited afterwards can no longer bleed into the queued prompt, and single-item queues get the same protection as multi-item batches while random seeds still follow the live prompt.
- **Prompt Iterator Linked Input**: A connected `prompt` input now takes precedence over the node's local multiline `text`, so stale local text can no longer be replayed instead of the upstream *Prompt Counter* output.
- **LoRA Picker Console Flood**: The Visual LoRA Loader now reads its thumbnail setting once per picker render and without the deprecated `getSettingValue(id, default)` argument, so opening a large LoRA folder no longer emits a console warning for every tile.
---
## [2.6.2] - 2026-10-24 [Stable]
### Added
- **Per-Resolution Dock Memory & Drag Resize Handles**: The Floating Latent Dock and the queue overlay now remember their size per resolution/monitor and expose on-screen drag resize handles.
- **Visual LoRA Loader Maintenance Controls**: New `↺ Counter`, `🧹 Usage` and `🗑 Cache` reset buttons on the Visual LoRA Loader node (each with a confirmation prompt) to reset the per-node Sequential/Random LoRA cycle and prompt→LoRA assignments, clear usage badges, or delete cached thumbnails.
- **ComfyUI Registry Packaging**: Complete registry metadata (`pyproject.toml` with `requires-comfyui`, classifiers and optional extras), a Saturn icon (`web/logo.png`), a `.comfyignore` manifest, and an automated `publish_action.yml` workflow.
- **Curated GitHub Releases**: `release.yml` now publishes the matching `CHANGELOG.md` section as the GitHub Release body instead of raw auto-generated compare links.
- **Real Generation Times on Restored Assets**: SaturnNodes now records prompt execution duration and output filenames in `generation_times.json`; restored history entries expose real start/success timestamps and the stock duration display when available. Older images keep their file mtime for sorting but show no fabricated `0.00s` duration.
- **Prompt Iterator Tracking Modes & Exhaustion Output**: New `track_by` choice (`Text & Node` / `Node Only`) and `exhausted` boolean output for `Sequential (Stop on End)`.
- **Persistent Pause State**: Optional `PERSIST_PAUSE_STATE` setting restores the last manual Pause/Continue state and pause mode after a restart.
- **Queue Restore Retry Limit**: Optional `PERSISTENT_QUEUE_MAX_RETRIES` setting controls how many later launches may retry failed queue items (default `0`).
- **Assets Restore Controls**: New recursive-folder scan toggle, generation-time display toggle, and a **Restore Now** settings button.
- **Visual Image Loader Metadata Limit**: New `IMAGE_LOADER_METADATA_LIMIT` setting (default `128`) controls how many newest images are scanned for prompts.
### Changed
- **Free-Form Dock Resize**: Dragging the Floating Latent Dock's corner now resizes width and height independently (no longer locked to the latent's aspect ratio) within sane 100–2000px bounds. The drag starts from the dock's current on-screen size (no jump to the larger saved settings box), shows the free-form box live, writes the dragged dimensions back into the `Floating Dock Max Width/Height` settings (now 1px-stepped sliders), and snaps the dock to the exact latent fit on release.
- **Route Namespacing**: All HTTP routes live exclusively under `/saturnnodes/*`; the transitional pre-2.6 route aliases (`/pause_queue/*`, `/persistent_queue/*`, `/image_loader/*`, `/folder_lora_loader/*`) were removed entirely.
- **Compatibility Surface Reduction**: All remaining pre-rename compatibility layers were purged — duplicate legacy route handlers, frontend settings migration and legacy settings-ID lookups, legacy localStorage/storage keys, the legacy CSRF header fallback, the legacy user-directory auto-migration, and all superseded node class-name aliases. No backward-compatibility surface remains.
- **Persistent Queue Schema Versioning**: `persistent_queue.json` now uses a top-level `{"schema_version": 1, "items": [...]}` envelope. Legacy bare-list files are migrated atomically on first load, files written by a newer SaturnNodes are kept read-only when downgrading, and transient Windows sharing violations during the atomic replace are retried.
- **Naming Consistency**: Unified `ComfyUI.SaturnNodes.*` frontend extension names, `saturnnodes-*` CSS prefixes, and `[SaturnNodes ...]` console log tags.
- **Documentation Rebrand**: `WALKTHROUGH.md`, the README settings reference, `.env.example`, `AGENTS.md` and `SECURITY.md` were fully rebranded and reconciled with the real setting labels, widget names and environment variables.
- **Registry Identity**: Package name set to `saturnnodes` (per registry naming best practices); version bumped to `2.6.1`.
- **Registry Identity**: Package name set to `saturnnodes` (per registry naming best practices); version bumped to `2.6.2`.
### Fixed
- **Publishing Compliance**: Removed `install.py` (no runtime `pip` execution, matching the documented "Zero Runtime Package Installs" claim) and corrected a stale README claim about legacy route aliases.
- **Audit Remediation Hardening**: Full audit remediation pass — pause queue stall/deadlock fixes, restart verification hardening, atomic `.env` writes with proper error responses, debug endpoint guards, subgraph-safe lookups, runner pipe streaming, IPv4-mapped loopback handling and more (119 unit tests passing).
- **Test Isolation**: The test suite now redirects every module-level SaturnNodes state path (persistent queue, LoRA usage/cycle state, caches, iterator state, generation times) to a disposable temporary user directory. Running tests while ComfyUI is active can no longer overwrite live user data.
- **Audit Remediation Hardening**: Full audit remediation pass - pause queue stall/deadlock fixes, restart verification hardening, atomic `.env` writes with proper error responses, debug endpoint guards, subgraph-safe lookups, runner pipe streaming, IPv4-mapped loopback handling and more (160 unit tests passing).
- **DOM Reuse & Recycled Widget Hardening**: Fixed all eight stale-DOM audit findings. Power-popup document listeners now die with their popup and a detached popup can no longer swallow a reopen. Copy Prompt revalidates the interacted card by asset identity, rejects detached/recycled cards, re-resolves the image at click time, and rebinds legacy hover-overlay buttons. The floating latent dock observes deep minimap/toolbar/sidebar layout changes. Remounted node widgets (live preview image, prompt counter badge, LoRA count badge) re-resolve their live DOM element instead of writing to detached nodes. Batch lines are painted when a legacy v1 queue table mounts with its rows already built, duplicate `data-job-id` rows no longer skew batch grouping, and the saved queue height is re-applied to `.comfy-list` elements mounted after setup.
- **Restored Queue Batch-Line Repaint**: Queue cards reused by ComfyUI's virtualized Vue list could keep the previous batch's colored line when the next batch started, making the running item appear to jump from the pending color to the previous batch color. Batch lines now repaint on `data-job-id` attribute changes and during a short post-event refresh window; unchanged SVG lines are skipped to avoid unnecessary DOM churn.
- **Floating Latent Dock Resize Crash**: Fixed a `this.renderImage is not a function` error thrown while dragging the dock's resize handles or when the screen profile changed; the resize paths now invoke the dock's actual render routine.
- **Queue Overlay Resize Lag**: Resizing the queue overlay no longer rewrites a stylesheet on every pointermove (which forced a full-document style recalculation, layout and paint churn on every frame); heights are now applied as scoped, rAF-throttled inline styles.
- **Dock Drag Performance & Stuck Drags**: Dragging the dock no longer rebuilds the full-resolution canvas backing store (GPU texture/layer churn, ~74% GPU load during drags) on every pointermove — only CSS sizes change while dragging, with one full-quality redraw on release. Pointer capture plus `pointercancel`/window-blur guards fix drags that "never stopped" when the pointer was released outside the window.
- **Prompt Iterator Reset Clarity**: The Prompt Queue Iterator's `Reset Counter (0)` button now confirms before resetting and explains that it resets the run pointer to the first prompt without wiping the queue state file (use Settings → `Reset All Queues` for a full wipe).
- **Prompt Iterator Correctness & Concurrency**: Hard resets now clear crash-recovery assignments and shuffle permutations; state keys include splitter/mode configuration; `Random (Cycle)` remaining text follows the real shuffle order; `Random (Keep)` no longer reports a fake remaining ordered list; state reads use an mtime cache behind a lock; global state pruning keeps the most recently used entries.
- **LoRA Loader State Growth & Performance**: Prompt→LoRA assignment maps and global cycle state are now bounded by recency; selection mapping is resolved once per run; usage counters are batched in memory and flushed atomically; No-Replace cycles avoid an immediate repeat while still visiting every LoRA; Civitai SHA256 hashes are cached by mtime/size; `TextLoraFinder` scans the prompt once instead of once per installed LoRA.
- **Persistent Queue I/O Storm**: `persistent_queue.json` writes are debounced, compact and fsynced instead of rewriting the full file for every queued/removed item; batch metadata and recently-finished prompt IDs are capped to prevent unbounded growth; late batch syncs can no longer resurrect finished prompts.
- **Assets Restore Blocking & Coverage**: Output scanning, image metadata parsing and asset DB registration now happen outside `prompt_queue.mutex`; restore uses a bounded top-N scan and a single DB session; JPEG/WebP EXIF metadata and A1111/Forge `parameters` prompts are supported; debug reports include elapsed time, scanned count, metadata hits and generation-time matches.
- **Visual Image Loader Responsiveness**: Folder scans and thumbnail generation run off the asyncio event loop; thumbnails are cached on disk by path/mtime/size.
- **Settings/.env Divergence**: `/saturnnodes/settings` now returns the complete effective settings surface, the UI seeds from backend values before registering defaults, and parsed `.env` values are cached with mtime invalidation and explicitly invalidated after saves.
### Removed
- `install.py` — dependencies are declared in `pyproject.toml` / `requirements.txt` only, and ComfyUI Manager handles installation.
+271
View File
@@ -0,0 +1,271 @@
# 🔍 Visual LoRA Loader & Batch Queue Logic Audit
## Root Causes 1–5: Defect Analysis, Locations & Mechanics
> **Status:** Validated against `v2.6.3`. Root Causes **1** and **5** were genuine
> defects and are now fixed. Root Cause **2** is intended persistent-cycle
> behavior and is documented rather than changed. Root Causes **3** and **4** do
> not reproduce with the current submission queue and were corrected below.
---
## Executive Overview of Observed Defects
When a user selects one or more LoRAs, queues a batch of 5, and while they are being queued selects different LoRA(s) and queues a batch of 10, the following symptoms occur:
1. **LoRAs mixing together**: Prompts in Batch 2 receive LoRAs from Batch 1, or prompts in Batch 1 switch to LoRAs from Batch 2 mid-execution.
2. **Duplicate generations**: A LoRA generates twice in a row when sequential single-generation was expected.
3. **Missing LoRAs**: A LoRA that was explicitly selected is skipped and never generated.
4. **Capture bypass**: The previous "workflow capture" (`Batch Graph Snapshot Guard`) failed to prevent these issues.
The audit identified **five candidate root causes**. Validation shows that the
repeat/skip symptoms are explained by Root Causes **1** and **5**, while Root
Cause **2** is by-design cycling; Root Causes **3** and **4** do not produce the
described failures in the current code.
---
## 📌 Root Cause 1: Deterministic Hash Sorting vs. Unsorted Array Indexing
- **File**: [`nodes/lora_loader.py`](nodes/lora_loader.py)
- **Functions**: `select_a_lora(...)`
- **Verdict**: ✅ **Confirmed and fixed**
- **Symptom Produced**: **Same LoRA generated twice; other selected LoRA skipped entirely.**
### What Is Happening
In `select_a_lora`, the persistent state key on disk uses a SHA-256 hash calculated over the **alphabetically sorted** list of choices:
```python
choices_hash = hashlib.sha256(
json.dumps(sorted(valid_choices), ensure_ascii=False).encode("utf-8")
).hexdigest()[:16]
state_key = f"{prefix}_{unique_id}_{choices_hash}"
```
However, the selection indexes into the **unsorted** live list, whose order is
the click/toggle order stored by the frontend (`web/js/folder_lora_loader.js`,
`updateSelection`). Deselecting and reselecting a tile, or using a folder
checkbox, changes that order without changing the hash.
### Failure Scenario:
1. User selects **LoRA A**, then **LoRA B**:
- `valid_choices` = `["A", "B"]`, `sorted(...)` = `["A", "B"]` → `choices_hash` = `H1`.
- Prompt 1 executes at `index = 0` → **A**; saved `index = 1`.
2. The user reorders the selection to **B**, then **A**:
- `valid_choices` = `["B", "A"]`, sorted still `["A", "B"]` → same `H1`, so `index = 1` is loaded.
- `valid_choices[1]` is **A** → **A generated twice, B skipped.**
### Fix Applied
Sequential state now stores the order observed when the cycle started and
indexes into that stored order. Reordering the selection can no longer move the
index onto a different LoRA, so picks are never duplicated or skipped:
```python
new_entry["index"] = index
new_entry["order"] = order
```
The index is also normalized (`index %= len(order)`), which keeps long-lived
state bounded.
---
## 📌 Root Cause 2: Perpetual Inter-Batch Cycle Continuation
- **File**: [`nodes/lora_loader.py`](nodes/lora_loader.py)
- **State**: `user/default/SaturnNodes/lora_loader_state.json`
- **Verdict**: ✅ **Confirmed, but by design — documented, not changed**
- **Symptom Produced**: **Batches starting on arbitrary mid-cycle LoRAs; leftover pools continuing across sessions.**
### What Is Happening
`state_key` is keyed by `(mode, node_id, choices_hash)`; there is **no batch
boundary, run ID, or queue session**. The `index` counter (Sequential) and the
remaining `pool` (Random No-Replace) persist across batches, restarts, and days.
Global state is pruned only by recency (100 most recent buckets).
### Failure Scenario:
1. Three LoRAs (`[A, B, C]`), batch of 5 → A, B, C, A, B; saved `index = 5`.
2. A later batch of 2 resumes at `5 % 3 = 2` → **C, A** instead of A, B.
3. In **Random (No Replace)**, unpopped items from the previous run are consumed
first, so a new batch can start on leftovers from the old pool.
### Why This Is Not Changed
Continuous cycling is the documented "Sequential Cycle" / "Random (No Dupes)"
contract, and `tests/test_lora_loader.py` asserts it across prompts. The suite
already ships a manual `↺ Counter` reset and a per-node prompt→LoRA assignment
map for retries. Resetting automatically per batch would silently change the
documented cycling behavior, so this is treated as expected behavior with the
reset control as the escape hatch.
---
## 📌 Root Cause 3: Premature Snapshot Guard Teardown in Frontend V2
- **File**: [`web/batch_queue.js`](web/batch_queue.js)
- **Functions**: `setupQueueHooks()` (`app.queuePrompt` and `api.queuePrompt` hooks)
- **Verdict**: ❌ **Not reproducible with the current submission queue**
- **Original Claim**: A second batch makes ComfyUI's `app.queuePrompt` return
`false` synchronously, so the wrapper's `finally` clears `activeBatchContext`
before Batch 2's items are serialized, disabling the snapshot guard.
### Why the Claim Does Not Hold
The wrapper defers the original call through `batchSubmissionQueue`:
```javascript
const turn = batchSubmissionQueue.then(async () => {
const batch = getNextBatch(count);
activeBatchContext = batch;
try {
return await origQueuePrompt(number, batchCount, queueNodeIds);
} finally {
activeBatchContext = null;
}
});
batchSubmissionQueue = turn.catch(() => {});
return turn;
```
`batchSubmissionQueue` is updated synchronously before returning, so a second
queue action waits for the previous batch's submission promise to settle. Its
callback — and therefore `origQueuePrompt` — is not invoked while
`processingQueue === true`, so the synchronous `if (this.processingQueue)
return false;` path cannot fire for the second UI batch. This serialization is
present in the released `v2.6.2` as well.
ComfyUI's core behavior quoted in the original analysis is itself correct
(`comfyui_frontend_package/static/assets`): `queuePrompt` pushes to
`queueItems`, returns `false` while already processing, and otherwise loops with
`await graphToPrompt()` per item. The defect was in assuming the wrapper reached
that code immediately.
### Residual Edge Case
The early teardown described above *can* occur if a non-SaturnNodes caller
invokes `app.queuePrompt` while ComfyUI is already processing — the wrapper
would then get the synchronous `false` and clear its context. That is outside
the two-manual-batches scenario and is not addressed here.
---
## 📌 Root Cause 4: Single-Item Batches (`batchCount == 1`) Bypass Snapshot Guard
- **File**: [`web/batch_queue.js`](web/batch_queue.js)
- **Functions**: `api.queuePrompt` hook (`isSnapshotGuardEnabled() && batchContext.batchCount > 1`)
- **Verdict**: ⚠️ **Accurate code, not a defect**
### Why This Is Not a Defect
The snapshot guard exists to keep items **inside one multi-item batch**
consistent while the graph is re-serialized between iterations. A one-item batch
has no later item to protect, so skipping the snapshot is harmless.
Additionally, the guard has never protected the *first* item of any batch: the
snapshot is taken when that item is submitted, not when the user clicked Queue.
Edits made between clicking and submission affect item 0 of a multi-item batch
exactly as they affect a one-item batch. Tightening this would require capturing
the prompt at click time, which is a separate design change, not a
`batchCount > 1` bug.
---
## 📌 Root Cause 5: Function Signature Default Mismatch (`"All"` vs. `"Sequential"`)
- **File**: [`nodes/lora_loader.py`](nodes/lora_loader.py)
- **Functions**: `VisualLoraLoader.INPUT_TYPES`, `VisualLoraLoader.IS_CHANGED`, `VisualLoraLoader.load_lora(...)`
- **Verdict**: ✅ **Confirmed and fixed**
- **Symptom Produced**: **Simultaneous loading of multiple LoRAs (stacking all models into one render).**
### What Is Happening
`INPUT_TYPES` declared the hidden widget default as `"Sequential"`, while both
`IS_CHANGED` and the execution method signature fell back to `"All"`:
```python
# INPUT_TYPES
"_selection_mode": ("STRING", {"default": "Sequential"}),
# IS_CHANGED / load_lora (before the fix)
mode = kwargs.get("_selection_mode", "All")
def load_lora(..., _selection_mode="All", ...)
```
### Failure Scenario:
1. A prompt arrives without `_selection_mode` (raw API call, third-party
client, or hand-built prompt).
2. The backend falls back to `"All"`, so the `share one selection` branch
(`if _selection_mode in ["Random", "Sequential", "Random (No Replace)"]`) is
skipped and `select_a_lora` is never called.
3. Every selected LoRA is loaded onto the model and CLIP in one render instead
of cycling one per prompt.
Normal UI use is unaffected: `web/js/folder_lora_loader.js` always creates a
serialized `_selection_mode` widget defaulting to `"Sequential"`, which is why
the bug only surfaced through API-style prompts. `IS_CHANGED` was also affected:
its `"All"` fallback returned `""` (cacheable) for prompts missing the field.
### Fix Applied
Both fallbacks now match the node definition and UI:
```python
mode = kwargs.get("_selection_mode", "Sequential")
def load_lora(..., _selection_mode="Sequential", ...)
```
An explicit `"All"` sent by the UI still selects every LoRA simultaneously, so
intentional "All Loras" mode is unchanged.
---
## Summary Matrix
| Root Cause | Affected File(s) | Primary Impact | Status |
| :--- | :--- | :--- | :--- |
| **1. Hash vs Indexing Order** | `nodes/lora_loader.py` | Same LoRA selected twice; other selected LoRAs skipped entirely. | ✅ Fixed (stored cycle order) |
| **2. Inter-Batch State Carryover** | `nodes/lora_loader.py` | Prompts start at arbitrary cycle offsets; leftover pools continue. | ✅ By design (manual `↺ Counter` reset) |
| **3. Snapshot Guard Teardown** | `web/batch_queue.js` | — | ❌ Not reproducible; submission queue serializes batches |
| **4. Batch Count == 1 Bypass** | `web/batch_queue.js` | — | ⚠️ Expected; no second item to snapshot |
| **5. Default Mode Mismatch** | `nodes/lora_loader.py` | API prompts silently stack all selected LoRAs. | ✅ Fixed (defaults aligned to `Sequential`) |
### Regression Coverage Added
- `test_sequential_reorder_keeps_cycle_position` — reordering the selection
continues the existing cycle without repeating or skipping a LoRA.
- `test_sequential_changed_selection_starts_fresh_cycle` — changing the selected
set still starts a new bucket.
- `test_missing_selection_mode_defaults_to_sequential` — `INPUT_TYPES`,
`load_lora`, and `IS_CHANGED` agree on the fallback mode.
---
## Follow-up: Click-to-Queue Bleed (reported after the initial audit)
**Symptom:** Queue a batch with LoRA A, then queue more prompts with LoRAs B/C
10× and A again 5× while the earlier batch is still loading, and prompts come
out with text or LoRA selections taken from a different click ("character
bleeding"). Rapid Queue clicks made the effect worse.
**Actual cause (client-side timing, not parallelism):** ComfyUI's
`app.queuePrompt` does not serialize a click immediately when it is already
submitting another batch. It pushes the request onto `queueItems` and returns
`false`; the graph is serialized with `graphToPrompt()` only when that request's
turn starts. SaturnNodes additionally serializes UI queue actions through
`batchSubmissionQueue`. Any canvas edit made between the click and the deferred
serialization was therefore captured by the queued prompt. The old snapshot
guard only froze items **after** item 0 of a multi-item batch, so item 0 and
every single-item queue remained exposed.
**Fix:** `web/batch_queue.js` now captures the graph at click time whenever a
submission is already pending (`pendingSubmissions > 0` or
`app.processingQueue === true`). Item 0 of that batch uses the captured prompt,
later items reuse it as the snapshot, and `mergeDynamicSeeds` keeps randomized
seeds from the live prompt so generated seeds still match the UI. Idle clicks
skip the extra serialization.
**Prompt iterator:** reviewed for the same class of bug. It is not affected by
submission timing because ComfyUI executes prompts serially on the server. One
real bleed source was fixed: the optional `prompt` input was ignored whenever
the node's local `text` widget was non-empty, so stale local characters could
be replayed instead of the connected *Prompt Counter* output. A connected input
now always wins.
**Why the old tests missed it:** the Python tests call selection/iterator
functions directly and the DOM tests never modelled a pending HTTP submission.
The new `tests/test_batch_queue_snapshot_dom.mjs` reproduces the deferred
`graphToPrompt()` order of ComfyUI, and the iterator precedence tests live in
`tests/test_prompt_iterator.py`.
+16 -4
View File
@@ -107,6 +107,8 @@ Visual thumbnail browser for image folders with instant preview selection, indep
- **`display_mode`** (`COMBO`, *Advanced*): `Scrollable` vs `Show All`.
- **`sort_images_by`** (`COMBO`, *Advanced*): `Name (A-Z)`, `Name (Z-A)`, `Date Modified (Newest First)`, `Date Modified (Oldest First)`.
Folder scans run off ComfyUI's event loop, thumbnails are cached on disk, and prompt metadata is extracted only for the newest `IMAGE_LOADER_METADATA_LIMIT` images (default `128`, configurable in Settings).
#### Outputs
- **`IMAGE`**: Selected image tensor.
- **`positive_prompt`** (`STRING`): Extracted prompt metadata.
@@ -242,6 +244,7 @@ Deterministically iterates over multiline prompt text blocks per queue run with
#### Inputs & Widgets
- **`pop_mode`** (`COMBO`): `Sequential (Loop on End)`, `Sequential (Stop on End)`, `Random (Keep)`, `Random (Cycle)`.
- **`track_by`** (`COMBO`): `Text & Node` (default; the pointer is isolated per prompt text and splitter configuration) or `Node Only` (one pointer per graph node that survives prompt edits and splitter changes).
- **`separator`** (`COMBO`): Split prompts by `>1 Empty Line`, `Newline`, `>2 Empty Lines`, or `Custom Regex`.
- **`custom_regex`** (`STRING`): Custom regular expression delimiter (e.g. `\n---\n`). Automatically enabled when `separator` is set to `Custom Regex` and disabled otherwise.
- **`text`** (`STRING`, Multiline): Multiline prompt text containing your queued blocks.
@@ -249,8 +252,11 @@ Deterministically iterates over multiline prompt text blocks per queue run with
#### Outputs
- **`prompt`** (`STRING`): The selected prompt block for the current queue run.
- **`remaining_text`** (`STRING`): All remaining prompt blocks joined by the delimiter.
- **`remaining_count`** (`INT`): Count of remaining items in queue.
- **`remaining_text`** (`STRING`): All remaining prompt blocks joined by the delimiter. For `Random (Keep)` this is empty because random selection does not consume an ordered queue.
- **`remaining_count`** (`INT`): Count of remaining items in the current cycle (always `0` for `Random (Keep)`).
- **`exhausted`** (`BOOLEAN`): `True` when `Sequential (Stop on End)` has reached the final prompt (subsequent runs repeat the last prompt and remain exhausted).
Clicking `Reset Counter (0)` now also clears crash-recovery prompt assignments and random shuffle permutations for the node, so the next run starts from a clean state.
</details>
<details>
@@ -374,12 +380,13 @@ Configure options directly under ComfyUI Settings (⚙ gear icon):
- **`Custom Node Title Color`** (`color`, *Default: `#6a3f20`*): Header / title bar color picker for SaturnNodes when custom colors are enabled.
- **`Custom Node Body Color`** (`color`, *Default: `#472a15`*): Body background color picker for SaturnNodes when custom colors are enabled.
- **`Civitai API Key`** (`text`): Optional key for Civitai SHA256 model preview search (`Authorization: Bearer <key>`).
- **`Enable Civitai Auto-Scraping`** (`boolean`, *Default: true*): Automatically download model preview images from Civitai via SHA256 file hashes. (Note: Local SHA256 hash searching always works).
- **`Enable Civitai Auto-Scraping`** (`boolean`, *Default: false*): Automatically download model preview images from Civitai via SHA256 file hashes. (Note: Local SHA256 hash searching always works).
- **`TMDB Access Token`** (`text`): Optional key or v4 Read Access Token (`eyJ...`) for actor / media preview search.
- **`Enable TMDB Auto-Scraping`** (`boolean`, *Default: false*): Automatically download media preview images from TMDB.
- **`Enable LoRA Usage Tracking`** (`boolean`, *Default: true*): Toggle LoRA usage counting and visual rank badges (🔥, Gold, Silver, Bronze) in the picker.
- **`Reset Failed Scrapes Cache`** (*Button: `🗑️ Clear Scrapes Cache`*): Clears failed scrape history so Civitai/TMDB can retry downloading missing preview images.
- **`Disable Thumbnail Downscaling (Serve Raw)`** (`boolean`, *Default: false*): Serves full-resolution original preview images instead of generating downscaled WebP thumbnails (downscaled WebP thumbnails render faster in the picker and are recommended).
- **`Image Loader Metadata Scan Limit`** (`number`, *Default: 128*, 0–2000): Number of newest images in a folder scanned for embedded prompts by the Visual Image Loader (`0` disables extraction).
</details>
<details>
@@ -411,6 +418,7 @@ Configure options directly under ComfyUI Settings (⚙ gear icon):
- **`Default State on Launch`** (`combo`, *Default: `Running`*): Sets whether the queue starts `Paused` or `Running` on boot.
- **`Default Pause Action`** (`combo`, *Default: `Finish Active Prompt`*): Sets default pause behavior (`Finish Active Prompt` vs `Instant Resume Node`).
- **`Persist Pause State Across Restarts`** (`boolean`, *Default: false*): Restores the last manual Pause/Continue state and pause mode on the next start, overriding the launch defaults.
- **`Enable Top Toolbar Button`** (`boolean`, *Default: true*): Toggle top action bar Pause & Continue button group ON/OFF.
- **`Toolbar Button Unpaused Color`** (`text`, *Default: `#16a34a`*): Hex color for the toolbar unpaused/running state.
- **`Toolbar Button Paused Color`** (`text`, *Default: `#ea580c`*): Hex color for the toolbar paused state.
@@ -424,6 +432,7 @@ Configure options directly under ComfyUI Settings (⚙ gear icon):
- **`Enable Persistent Queue (Auto-Recovery)`** (`boolean`, *Default: true*): Automatically saves unfinished queue items and restores them after restart/crash.
- **`Recovery Launch State`** (`combo`, *Default: `Match Default`*): Override launch state when restored queue items are recovered on startup (`Match Default`, `Force Paused`, `Force Running`).
- **`Max Restore Retries`** (`number`, *Default: 0*, 0–10): How many additional launches may retry a queue item that failed to restore before it is dropped. `0` drops failures immediately.
</details>
<details>
@@ -431,6 +440,9 @@ Configure options directly under ComfyUI Settings (⚙ gear icon):
- **`Restore Assets on Launch`** (`boolean`, *Default: true*): Automatically restores your latest generated images into the Assets / History pane on startup.
- **`Restored Assets Count`** (`number`, *Default: 64*): The number of newest images from the output folder to populate into the Assets pane.
- **`Scan Output Subfolders Recursively`** (`boolean`, *Default: true*): Include images from nested output subfolders, not just the top-level output folder.
- **`Show Generation Time on Restored Assets`** (`boolean`, *Default: true*): Uses SaturnNodes' recorded generation timings (from `generation_times.json`) for real execution times on restored history entries. Images generated before this version have no recorded time: their file mtime is still used for chronology, but no duration is shown.
- **`Restore Now`** (*Button: `🖼️ Restore Now`*): Immediately rescan the output folder and add the newest assets without restarting ComfyUI.
</details>
<details>
@@ -447,7 +459,7 @@ Configure options directly under ComfyUI Settings (⚙ gear icon):
- **Clean 1D Line:** The first item starts with a top curve (`┌`), middle items are straight lines (`│`), and the last item ends with a bottom curve (`└`). Standalone 1-item batches are rounded at both ends (`(`).
- **In-between Infiltration Detection:** If a different prompt is queued in-between items of a batch, the interrupted batch maintains its open line ends without false curves, while the inserted item is highlighted with its own bracket.
- **Works Standalone or with PersistentQueue:** Operates client-side via `localStorage` when standalone, and syncs with `PersistentQueue` to retain batch relationships after server restarts.
- **`Batch Graph Snapshot Guard`** (`boolean`, *Default: true*): Background prompt and node input snapshotting ensuring canvas edits don't mutate active batches.
- **`Batch Graph Snapshot Guard`** (`boolean`, *Default: true*): Snapshots prompt text, LoRA selections and node inputs when you click Queue (including batches queued behind an in-flight submission), ensuring later canvas edits do not mutate queued prompts. Random seeds continue to randomize.
</details>
<details>
+11 -4
View File
@@ -41,14 +41,18 @@ SaturnNodes automatically tracks which workflows are submitted together as a bat
### The Persistent Queue (Crash Recovery)
You don't need to interact with this—it runs silently in the background!
Every time you queue a prompt, SaturnNodes saves the entire queue state to your hard drive in real time. If your computer crashes, power goes out, or you accidentally close the terminal, ComfyUI will automatically restore your unfinished queue upon next boot (in a paused state, so it doesn't overwhelm your GPU before you're ready).
Every time you queue a prompt, SaturnNodes saves the entire queue state to your hard drive in real time. If your computer crashes, power goes out, or you accidentally close the terminal, ComfyUI will automatically restore your unfinished queue upon next boot. The **Recovery Launch State** setting controls whether recovery uses your normal launch state (`Match Default`), always pauses (`Force Paused`), or always runs (`Force Running`); use `Force Paused` if you want to inspect the restored queue before it starts.
The queue file is versioned. Older queue files are upgraded automatically, and if you downgrade to an older SaturnNodes version, a queue file written by a newer version is left read-only instead of being overwritten.
### Automatic Assets Pane & History Restore
In standard ComfyUI, restarting your server wipes the in-memory execution history, leaving your sidebar Assets Pane / History tab completely blank on launch.
- SaturnNodes automatically scans your `output` folder (read-only) on server startup and pre-populates the history with your latest **64 images** (or custom count).
- Scans run without blocking ComfyUI's queue mutex, include nested output subfolders by default, and understand PNG, JPEG, WebP, ComfyUI graphs, and A1111/Forge `parameters` metadata.
- All images are loaded in strict chronological order with embedded workflow and prompt graphs intact.
- Features like **Copy Prompt** and **Copy Workflow** immediately work with restored images as if they were generated in your current session!
- You can adjust the restored image count or toggle this feature in **ComfyUI Settings (⚙️)** under **`Restore Assets on Launch`** and **`Restored Assets Count`** (search for `SaturnNodes`).
- New generations record their real execution duration in `generation_times.json`; restored images show that time when available. Older images still use their file mtime for ordering, but no invented duration is shown when none was recorded.
- Use **`Restore Now`** in Settings to rescan immediately, or adjust **`Restored Assets Count`**, **`Scan Output Subfolders Recursively`**, and **`Show Generation Time on Restored Assets`** (search for `SaturnNodes`).
### Image Overlay Actions & Prompt Bookmarks
Hovering over any image in the ComfyUI Assets / History pane or preview nodes provides powerful quick actions directly on the card:
@@ -94,7 +98,9 @@ Managing multi-prompt queues and setting the exact ComfyUI batch size has never
- If `Custom Regex` is selected, enter any custom delimiter pattern (such as `\n---\n`). The regex field is dynamically enabled only when Custom Regex is active.
2. **`🪐 🔄 Prompt Queue Iterator`**: Connect the `STRING` output of the Prompt Counter into the Prompt Queue Iterator to sequentially pop and execute each prompt run-by-run.
- Now supports `Custom Regex` in addition to empty line and newline separators.
- Includes live progress counter widget (`Run X / Y`), an index reset button (`Reset Counter (0)`, now with a confirmation explaining that it only restarts the run pointer — it does **not** empty the queue state file; use Settings → `🔄 Reset All Queues` for a full wipe), and direct state file access (`Open Queue File`).
- Choose **`Text & Node`** tracking to keep independent pointers per prompt text/splitter, or **`Node Only`** to keep one pointer per node while you edit prompts.
- `Sequential (Stop on End)` exposes an **`exhausted`** boolean so a workflow can stop after the last prompt.
- Includes live progress counter widget (`Run X / Y`), an index reset button (`Reset Counter (0)`, now with a confirmation explaining that it restarts the run pointer and clears crash-recovery assignments/shuffle state — it does **not** empty the queue state file; use Settings → `🔄 Reset All Queues` for a full wipe), and direct state file access (`Open Queue File`).
---
@@ -115,7 +121,8 @@ Several nodes across this suite (e.g. *Load Image From Folder*, *Recent Outputs*
Click the standard ComfyUI Settings gear ⚙️ and search for `SaturnNodes` to access the suite's configurations. Here you can:
- Safely enter and mask API Keys for Civitai and TMDB scraping.
- Change the colors of the Pause Queue buttons via built-in color pickers.
- Adjust the default boot behavior for the Persistent Queue (e.g., forcing ComfyUI to always boot in a Paused state).
- Adjust the default boot behavior for the Persistent Queue (e.g., forcing ComfyUI to always boot in a Paused state), retry limits for failed queue restores, and whether the last manual pause state survives a restart.
- Tune the Visual Image Loader metadata scan limit, restore nested output folders, show recorded generation times on restored assets, and trigger **Restore Now** without restarting.
- Enable the floating Live Latent dock, drag-resize the queue overlay, and hide entire nodes from the Add Node menu under **Node Management**.
> **Cross-Platform Note**: All of the visual nodes, pause features, and OS notifications are fully compatible with Windows, macOS, and Linux, and seamlessly adapt to both the modern ComfyUI V2 interface and the classic LiteGraph UI!
+98 -41
View File
@@ -4,10 +4,11 @@ import subprocess
from aiohttp import web
from server import PromptServer
__version__ = "2.6.1"
__version__ = "2.6.3"
from .nodes.queue_control import (
setup_queue_control_routes,
pause_manager,
tray_manager,
persistent_queue_manager,
is_persistent_queue_enabled
@@ -290,49 +291,42 @@ async def get_image_prompt_endpoint(request):
except Exception as e:
return web.json_response({"success": False, "error": str(e)}, status=500)
def _env_bool(key, default=False):
return str(get_env_setting(key, "true" if default else "false")).lower() in ["true", "1", "yes"]
def _env_int(key, default):
try:
return int(get_env_setting(key, str(default)))
except (TypeError, ValueError):
return default
@routes.get("/saturnnodes/settings")
async def get_settings(request):
if not is_local_request(request):
return web.json_response({"error": "Forbidden: Local access only"}, status=403)
civitai_key = os.getenv("CIVITAI_API_KEY", "")
tmdb_key = os.getenv("TMDB_API_KEY", "")
enable_tray = os.getenv("ENABLE_TRAY_ICON", "false").lower() in ["true", "1", "yes"]
enable_assets_restore = os.getenv("ENABLE_ASSETS_RESTORE", "true").lower() in ["true", "1", "yes"]
restore_assets_count = int(os.getenv("RESTORE_ASSETS_COUNT", "64"))
enable_process_management = os.getenv("ALLOW_PROCESS_MANAGEMENT", "false").lower() in ["true", "1", "yes"]
enable_local_file_execution = os.getenv("ENABLE_LOCAL_FILE_EXECUTION", "false").lower() in ["true", "1", "yes"]
if os.path.exists(ENV_FILE):
try:
with open(ENV_FILE, "r", encoding="utf-8") as f:
for line in f:
line = line.strip()
if line.startswith("CIVITAI_API_KEY="):
civitai_key = line.split("=", 1)[1].strip()
elif line.startswith("TMDB_API_KEY="):
tmdb_key = line.split("=", 1)[1].strip()
elif line.startswith("ENABLE_TRAY_ICON="):
enable_tray = line.split("=", 1)[1].strip().lower() in ["true", "1", "yes"]
elif line.startswith("ENABLE_ASSETS_RESTORE="):
enable_assets_restore = line.split("=", 1)[1].strip().lower() in ["true", "1", "yes"]
elif line.startswith("RESTORE_ASSETS_COUNT="):
try:
restore_assets_count = int(line.split("=", 1)[1].strip())
except Exception:
pass
elif line.startswith("ALLOW_PROCESS_MANAGEMENT="):
enable_process_management = line.split("=", 1)[1].strip().lower() in ["true", "1", "yes"]
elif line.startswith("ENABLE_LOCAL_FILE_EXECUTION="):
enable_local_file_execution = line.split("=", 1)[1].strip().lower() in ["true", "1", "yes"]
except Exception:
pass
# Return the full settings surface (not just API keys) so the settings UI,
# debug export and .env never disagree about the effective values.
return web.json_response({
"civitai_api_key": civitai_key,
"tmdb_api_key": tmdb_key,
"enable_tray_icon": enable_tray,
"enable_assets_restore": enable_assets_restore,
"restore_assets_count": restore_assets_count,
"enable_process_management": enable_process_management,
"enable_local_file_execution": enable_local_file_execution
"civitai_api_key": get_env_setting("CIVITAI_API_KEY", ""),
"tmdb_api_key": get_env_setting("TMDB_API_KEY", ""),
"enable_civitai_scraping": _env_bool("ENABLE_CIVITAI_SCRAPING", False),
"enable_tmdb_scraping": _env_bool("ENABLE_TMDB_SCRAPING", False),
"enable_lora_usage": _env_bool("ENABLE_LORA_USAGE", True),
"enable_persistent_queue": _env_bool("ENABLE_PERSISTENT_QUEUE", True),
"persistent_queue_restored_state": get_env_setting("PERSISTENT_QUEUE_RESTORED_STATE", "Match Default"),
"persistent_queue_max_retries": _env_int("PERSISTENT_QUEUE_MAX_RETRIES", 0),
"persist_pause_state": _env_bool("PERSIST_PAUSE_STATE", False),
"default_pause_state": get_env_setting("DEFAULT_PAUSE_STATE", "Running"),
"default_pause_mode": get_env_setting("DEFAULT_PAUSE_MODE", "after_finish"),
"enable_tray_icon": _env_bool("ENABLE_TRAY_ICON", False),
"enable_assets_restore": _env_bool("ENABLE_ASSETS_RESTORE", True),
"restore_assets_count": _env_int("RESTORE_ASSETS_COUNT", 64),
"restore_assets_recursive": _env_bool("RESTORE_ASSETS_RECURSIVE", True),
"show_restored_generation_time": _env_bool("SHOW_RESTORED_GENERATION_TIME", True),
"image_loader_metadata_limit": _env_int("IMAGE_LOADER_METADATA_LIMIT", 128),
"enable_process_management": _env_bool("ALLOW_PROCESS_MANAGEMENT", False),
"enable_local_file_execution": _env_bool("ENABLE_LOCAL_FILE_EXECUTION", False),
"clear_prompt_iterator_on_launch": _env_bool("CLEAR_PROMPT_ITERATOR_ON_LAUNCH", False)
})
def _clean_env_val(v):
@@ -361,6 +355,11 @@ async def save_settings(request):
restored_state = _clean_env_val(data.get("persistent_queue_restored_state"))
enable_process_management = _clean_env_val(data.get("enable_process_management"))
enable_local_file_execution = _clean_env_val(data.get("enable_local_file_execution"))
persistent_queue_max_retries = _clean_env_val(data.get("persistent_queue_max_retries"))
persist_pause_state = _clean_env_val(data.get("persist_pause_state"))
restore_assets_recursive = _clean_env_val(data.get("restore_assets_recursive"))
show_restored_generation_time = _clean_env_val(data.get("show_restored_generation_time"))
image_loader_metadata_limit = _clean_env_val(data.get("image_loader_metadata_limit"))
lines = []
if os.path.exists(ENV_FILE):
@@ -386,6 +385,11 @@ async def save_settings(request):
has_restored_state = False
has_process_mgmt = False
has_local_file_exec = False
has_pq_retries = False
has_persist_pause = False
has_restore_recursive = False
has_show_generation_time = False
has_image_metadata_limit = False
for line in lines:
if line.strip().startswith("CIVITAI_API_KEY=") and civitai_key is not None:
@@ -433,6 +437,21 @@ async def save_settings(request):
elif line.strip().startswith("ENABLE_LOCAL_FILE_EXECUTION=") and enable_local_file_execution is not None:
new_lines.append(f"ENABLE_LOCAL_FILE_EXECUTION={enable_local_file_execution}\n")
has_local_file_exec = True
elif line.strip().startswith("PERSISTENT_QUEUE_MAX_RETRIES=") and persistent_queue_max_retries is not None:
new_lines.append(f"PERSISTENT_QUEUE_MAX_RETRIES={persistent_queue_max_retries}\n")
has_pq_retries = True
elif line.strip().startswith("PERSIST_PAUSE_STATE=") and persist_pause_state is not None:
new_lines.append(f"PERSIST_PAUSE_STATE={persist_pause_state}\n")
has_persist_pause = True
elif line.strip().startswith("RESTORE_ASSETS_RECURSIVE=") and restore_assets_recursive is not None:
new_lines.append(f"RESTORE_ASSETS_RECURSIVE={restore_assets_recursive}\n")
has_restore_recursive = True
elif line.strip().startswith("SHOW_RESTORED_GENERATION_TIME=") and show_restored_generation_time is not None:
new_lines.append(f"SHOW_RESTORED_GENERATION_TIME={show_restored_generation_time}\n")
has_show_generation_time = True
elif line.strip().startswith("IMAGE_LOADER_METADATA_LIMIT=") and image_loader_metadata_limit is not None:
new_lines.append(f"IMAGE_LOADER_METADATA_LIMIT={image_loader_metadata_limit}\n")
has_image_metadata_limit = True
elif line.strip().startswith("ALLOW_ANY_SCRIPT_PATH="):
# Deprecated and removed for security; drop from .env
continue
@@ -469,6 +488,16 @@ async def save_settings(request):
new_lines.append(f"ALLOW_PROCESS_MANAGEMENT={enable_process_management}\n")
if not has_local_file_exec and enable_local_file_execution is not None:
new_lines.append(f"ENABLE_LOCAL_FILE_EXECUTION={enable_local_file_execution}\n")
if not has_pq_retries and persistent_queue_max_retries is not None:
new_lines.append(f"PERSISTENT_QUEUE_MAX_RETRIES={persistent_queue_max_retries}\n")
if not has_persist_pause and persist_pause_state is not None:
new_lines.append(f"PERSIST_PAUSE_STATE={persist_pause_state}\n")
if not has_restore_recursive and restore_assets_recursive is not None:
new_lines.append(f"RESTORE_ASSETS_RECURSIVE={restore_assets_recursive}\n")
if not has_show_generation_time and show_restored_generation_time is not None:
new_lines.append(f"SHOW_RESTORED_GENERATION_TIME={show_restored_generation_time}\n")
if not has_image_metadata_limit and image_loader_metadata_limit is not None:
new_lines.append(f"IMAGE_LOADER_METADATA_LIMIT={image_loader_metadata_limit}\n")
temp_env = ENV_FILE + ".tmp"
with open(temp_env, "w", encoding="utf-8") as f:
@@ -497,6 +526,29 @@ async def save_settings(request):
os.environ["RESTORE_ASSETS_COUNT"] = str(restore_assets_count)
if clear_prompt_iterator_on_launch is not None:
os.environ["CLEAR_PROMPT_ITERATOR_ON_LAUNCH"] = str(clear_prompt_iterator_on_launch)
if persistent_queue_max_retries is not None:
os.environ["PERSISTENT_QUEUE_MAX_RETRIES"] = str(persistent_queue_max_retries)
if persist_pause_state is not None:
os.environ["PERSIST_PAUSE_STATE"] = str(persist_pause_state)
pause_manager.persist_state = str(persist_pause_state).lower() in ["true", "1", "yes"]
if pause_manager.persist_state:
pause_manager._persist_pause_state()
else:
try:
if os.path.exists(pause_manager.state_file):
os.remove(pause_manager.state_file)
except OSError:
pass
if restore_assets_recursive is not None:
os.environ["RESTORE_ASSETS_RECURSIVE"] = str(restore_assets_recursive)
if show_restored_generation_time is not None:
os.environ["SHOW_RESTORED_GENERATION_TIME"] = str(show_restored_generation_time)
if image_loader_metadata_limit is not None:
os.environ["IMAGE_LOADER_METADATA_LIMIT"] = str(image_loader_metadata_limit)
# Drop the parsed .env cache immediately so all modules see the new values.
from .nodes.utils import invalidate_env_settings_cache
invalidate_env_settings_cache()
except Exception as e:
print(f"[SaturnNodes] Error saving settings to .env: {e}")
@@ -604,14 +656,19 @@ async def export_debug_profile(request):
"enable_persistent_queue": get_env_setting("ENABLE_PERSISTENT_QUEUE", "true"),
"default_pause_state": get_env_setting("DEFAULT_PAUSE_STATE", "Running"),
"default_pause_mode": get_env_setting("DEFAULT_PAUSE_MODE", "after_finish"),
"enable_civitai_scraping": get_env_setting("ENABLE_CIVITAI_SCRAPING", "true"),
"enable_tmdb_scraping": get_env_setting("ENABLE_TMDB_SCRAPING", "true"),
"enable_civitai_scraping": get_env_setting("ENABLE_CIVITAI_SCRAPING", "false"),
"enable_tmdb_scraping": get_env_setting("ENABLE_TMDB_SCRAPING", "false"),
"enable_lora_usage": get_env_setting("ENABLE_LORA_USAGE", "true"),
"enable_tray_icon": get_env_setting("ENABLE_TRAY_ICON", "false"),
"enable_assets_restore": get_env_setting("ENABLE_ASSETS_RESTORE", "true"),
"restore_assets_count": get_env_setting("RESTORE_ASSETS_COUNT", "64"),
"restore_assets_recursive": get_env_setting("RESTORE_ASSETS_RECURSIVE", "true"),
"show_restored_generation_time": get_env_setting("SHOW_RESTORED_GENERATION_TIME", "true"),
"image_loader_metadata_limit": get_env_setting("IMAGE_LOADER_METADATA_LIMIT", "128"),
"clear_prompt_iterator_on_launch": get_env_setting("CLEAR_PROMPT_ITERATOR_ON_LAUNCH", "false"),
"persistent_queue_restored_state": get_env_setting("PERSISTENT_QUEUE_RESTORED_STATE", "Match Default"),
"persistent_queue_max_retries": get_env_setting("PERSISTENT_QUEUE_MAX_RETRIES", "0"),
"persist_pause_state": get_env_setting("PERSIST_PAUSE_STATE", "false"),
"allow_process_management": get_env_setting("ALLOW_PROCESS_MANAGEMENT", "false"),
"enable_local_file_execution": get_env_setting("ENABLE_LOCAL_FILE_EXECUTION", "false"),
"civitai_api_key_configured": bool(civitai_key and civitai_key.strip()),
+362 -152
View File
@@ -1,29 +1,16 @@
import os
import sys
import json
import math
import time
import uuid
import hashlib
import heapq
import datetime
import logging
import threading
from PIL import Image
import folder_paths
from .utils import get_saturnnodes_user_dir
USER_DIR = get_saturnnodes_user_dir()
ENV_FILE = os.path.join(USER_DIR, ".env")
def get_env_setting(key, default_val):
if os.path.exists(ENV_FILE):
try:
with open(ENV_FILE, "r", encoding="utf-8") as f:
for line in f:
if line.strip().startswith(f"{key}="):
return line.strip().split("=", 1)[1].strip()
except Exception:
pass
return default_val
from .utils import get_env_setting
from .generation_times import get_generation_time, get_generation_time_debug
def is_assets_restore_enabled():
val = get_env_setting("ENABLE_ASSETS_RESTORE", "true").lower()
@@ -36,204 +23,427 @@ def get_assets_restore_count():
except Exception:
return 64
def is_recursive_assets_scan_enabled():
val = get_env_setting("RESTORE_ASSETS_RECURSIVE", "true").lower()
return val in ["true", "1", "yes"]
def is_restored_generation_time_enabled():
val = get_env_setting("SHOW_RESTORED_GENERATION_TIME", "true").lower()
return val in ["true", "1", "yes"]
def _strip_exif_text(text):
"""Strip NUL padding, a UTF BOM and surrounding whitespace from EXIF text."""
value = str(text or "").replace("\x00", "").strip()
if value.startswith("\ufeff"):
value = value[1:].strip()
return value
def _decode_exif_text(raw):
"""Decode an EXIF UserComment, including the standard 8-byte prefix."""
if not raw:
return ""
if isinstance(raw, bytes):
prefix, body = raw[:8], raw[8:]
if prefix.startswith(b"UNICODE"):
# The EXIF standard / piexif write UTF-16 big-endian here, not a
# BOM-prefixed native-endian string.
try:
return _strip_exif_text(body.decode("utf-16-be", errors="ignore"))
except Exception:
pass
if prefix.startswith(b"ASCII"):
try:
return _strip_exif_text(body.decode("ascii", errors="ignore"))
except Exception:
pass
if prefix.startswith(b"JIS"):
try:
return _strip_exif_text(body.decode("shift_jis", errors="ignore"))
except Exception:
pass
try:
return _strip_exif_text(raw.decode("utf-8", errors="ignore"))
except Exception:
return ""
return _strip_exif_text(raw)
def parse_a1111_positive_prompt(parameters):
"""Extract the positive prompt from an A1111/Forge `parameters` string."""
if not parameters:
return ""
if isinstance(parameters, bytes):
parameters = _decode_exif_text(parameters)
text = str(parameters).replace("\r\n", "\n").replace("\r", "\n").strip()
if not text:
return ""
negative_index = text.find("Negative prompt:")
if negative_index >= 0:
positive = text[:negative_index].strip()
else:
positive = text
# Drop the trailing generation-settings line (Steps: ..., Sampler: ...).
lines = positive.split("\n")
if lines:
last = lines[-1].strip()
if last.startswith("Steps:") or ("Sampler:" in last and "Steps:" in last):
lines = lines[:-1]
return "\n".join(lines).strip()
class AssetsRestoreManager:
def __init__(self):
self._restored_on_launch = False
self._restore_lock = threading.RLock()
self.last_debug_report = {}
self.restored_count = 0
def extract_image_metadata(self, filepath):
"""Extracts embedded prompt and workflow graph metadata from image (read-only)."""
"""Extracts embedded prompt/workflow metadata from PNG, JPEG or WebP."""
prompt_dict = {}
workflow_dict = {}
positive_prompt = ""
try:
with Image.open(filepath) as img:
if img.format == "PNG":
prompt_raw = img.info.get("prompt")
workflow_raw = img.info.get("workflow")
parameters_raw = img.info.get("parameters")
prompt_raw = img.info.get("prompt")
workflow_raw = img.info.get("workflow")
parameters_raw = img.info.get("parameters")
if prompt_raw:
# JPEG / WebP files written by ComfyUI or A1111 may carry the
# metadata in an EXIF UserComment instead of PNG text chunks.
if not parameters_raw:
exif = None
try:
exif = img.getexif()
except Exception:
exif = None
if not exif:
raw_exif = img.info.get("exif")
if raw_exif:
try:
exif = Image.Exif()
exif.load(raw_exif)
except Exception:
exif = None
if exif:
try:
prompt_dict = json.loads(prompt_raw) if isinstance(prompt_raw, str) else prompt_raw
parameters_raw = _decode_exif_text(exif.get(0x9286))
except Exception:
pass
parameters_raw = ""
if workflow_raw:
try:
workflow_dict = json.loads(workflow_raw) if isinstance(workflow_raw, str) else workflow_raw
except Exception:
pass
if prompt_raw:
try:
parsed_prompt = json.loads(prompt_raw) if isinstance(prompt_raw, str) else prompt_raw
if isinstance(parsed_prompt, dict):
prompt_dict = parsed_prompt
except Exception:
pass
if parameters_raw:
positive_prompt = str(parameters_raw)
if workflow_raw:
try:
parsed_workflow = json.loads(workflow_raw) if isinstance(workflow_raw, str) else workflow_raw
if isinstance(parsed_workflow, dict):
workflow_dict = parsed_workflow
except Exception:
pass
if parameters_raw:
positive_prompt = parse_a1111_positive_prompt(parameters_raw)
except Exception:
pass
return prompt_dict, workflow_dict, positive_prompt
def scan_output_images(self, base_output_dir, limit=64):
"""Scans output directory recursively (strictly read-only) and returns top `limit` newest images."""
def scan_output_images(self, base_output_dir, limit=64, recursive=True, stats=None):
"""Return the newest `limit` images without keeping the full tree in memory."""
if not os.path.exists(base_output_dir):
return []
valid_extensions = {".png", ".jpg", ".jpeg", ".webp", ".PNG", ".JPG", ".JPEG", ".WEBP"}
found_images = []
valid_extensions = {".png", ".jpg", ".jpeg", ".webp"}
norm_base = os.path.normpath(base_output_dir)
if stats is None:
stats = {}
for root, _, files in os.walk(norm_base):
for file in files:
_, ext = os.path.splitext(file)
if ext in valid_extensions:
def iter_images():
if recursive:
roots = os.walk(norm_base)
else:
try:
roots = [(norm_base, [], os.listdir(norm_base))]
except OSError:
roots = []
for root, _, files in roots:
for file in files:
_, ext = os.path.splitext(file)
if ext.lower() not in valid_extensions:
continue
full_path = os.path.join(root, file)
try:
mtime = os.path.getmtime(full_path)
rel_dir = os.path.relpath(root, norm_base)
subfolder = "" if rel_dir == "." else rel_dir.replace("\\", "/")
found_images.append({
"filepath": full_path,
"filename": file,
"subfolder": subfolder,
"mtime": mtime
})
except Exception:
pass
except OSError:
continue
stats["scanned"] = stats.get("scanned", 0) + 1
rel_dir = os.path.relpath(root, norm_base)
subfolder = "" if rel_dir == "." else rel_dir.replace("\\", "/")
yield {
"filepath": full_path,
"filename": file,
"subfolder": subfolder,
"mtime": mtime,
}
# Sort newest first, take limit, then reverse to chronological (oldest to newest)
found_images.sort(key=lambda x: x["mtime"], reverse=True)
top_images = found_images[:limit]
top_images.reverse()
try:
safe_limit = max(1, int(limit))
except (TypeError, ValueError):
safe_limit = 64
# Keep only the top-N candidates (bounded memory). Include the
# normalized relative path in the key so equal mtimes (bulk copies,
# archive extraction, FAT timestamp granularity) always resolve to the
# same files and the same order on every scan.
def sort_key(item):
return (
item["mtime"],
item["subfolder"],
item["filename"],
)
top_images = heapq.nlargest(safe_limit, iter_images(), key=sort_key)
# Restore chronological order (oldest -> newest) for stable history
# numbering. Equal timestamps sort by subfolder/filename ascending.
top_images.sort(key=sort_key)
return top_images
def _ingest_assets(self, prepared):
"""Register restored files in ComfyUI's asset DB using a single session."""
if not prepared:
return 0
try:
import importlib
ingest_mod = importlib.import_module("app.assets.services.ingest")
register_file_in_place = getattr(ingest_mod, "register_file_in_place", None)
if not register_file_in_place:
return 0
except Exception:
return 0
registered = []
for entry in prepared:
try:
res = register_file_in_place(abs_path=entry["filepath"], name=entry["filename"], tags=["output"])
if res and hasattr(res, "ref") and res.ref and hasattr(res.ref, "id"):
registered.append((res.ref.id, entry))
except Exception:
pass
if not registered:
return 0
try:
db_mod = importlib.import_module("app.database.db")
queries_mod = importlib.import_module("app.assets.database.queries")
init_db = getattr(db_mod, "init_db", None)
create_session = getattr(db_mod, "create_session", None)
set_reference_metadata = getattr(queries_mod, "set_reference_metadata", None)
if init_db and create_session and set_reference_metadata:
init_db()
with create_session() as session:
for reference_id, entry in registered:
set_reference_metadata(session, reference_id=reference_id, metadata={
"jobId": entry["prompt_id"],
"nodeId": entry["output_node_id"],
"filename": entry["filename"],
"subfolder": entry["subfolder"],
})
session.commit()
except Exception:
pass
return len(registered)
def restore_on_launch(self, server, limit=None, force=False):
"""Populates PromptQueue.history on ComfyUI startup with the latest generated images."""
"""Populate PromptQueue.history with the newest generated images.
Serialized because the Restore Now endpoint can be triggered from
several browser tabs while the startup restore is still running.
"""
with self._restore_lock:
return self._restore_on_launch(server, limit=limit, force=force)
def _restore_on_launch(self, server, limit=None, force=False):
if self._restored_on_launch and not force:
return 0
started_at = time.time()
if limit is None:
limit = get_assets_restore_count()
else:
try:
limit = max(1, min(1000, int(limit)))
except (TypeError, ValueError):
limit = get_assets_restore_count()
enabled = is_assets_restore_enabled()
if not enabled:
self._restored_on_launch = True
return 0
recursive = is_recursive_assets_scan_enabled()
show_generation_time = is_restored_generation_time_enabled()
base_output_dir = folder_paths.get_output_directory()
output_exists = os.path.exists(base_output_dir)
scan_stats = {}
images = self.scan_output_images(
base_output_dir, limit=limit, recursive=recursive, stats=scan_stats
) if output_exists else []
images = self.scan_output_images(base_output_dir, limit=limit) if output_exists else []
prompt_queue = getattr(server, "prompt_queue", None)
prepared = []
metadata_found = 0
generation_time_matches = 0
# Scan, metadata parsing and history-entry construction happen outside
# the queue mutex so the executor thread is never blocked on disk I/O.
for idx, item in enumerate(images, 1):
filepath = item["filepath"]
filename = item["filename"]
subfolder = item["subfolder"]
rel_key = f"{subfolder}/{filename}" if subfolder else filename
prompt_id = str(uuid.uuid5(uuid.NAMESPACE_URL, f"saturnnodes:{rel_key}"))
prompt_dict, workflow_dict, positive_prompt = self.extract_image_metadata(filepath)
if prompt_dict or workflow_dict or positive_prompt:
metadata_found += 1
output_node_id = None
if isinstance(prompt_dict, dict) and prompt_dict:
for nid, nval in prompt_dict.items():
if isinstance(nval, dict) and "SaveImage" in str(nval.get("class_type", "")):
output_node_id = str(nid)
break
if not output_node_id:
output_node_id = str(next(iter(prompt_dict.keys())))
if not output_node_id:
output_node_id = "0"
extra_pnginfo = {}
if isinstance(workflow_dict, dict) and workflow_dict:
extra_pnginfo["workflow"] = workflow_dict
if positive_prompt:
extra_pnginfo["positive_prompt"] = positive_prompt
try:
mtime_ms = max(0, int(float(item.get("mtime", 0)) * 1000))
except (TypeError, ValueError, OverflowError):
mtime_ms = 0
duration = get_generation_time(filename, subfolder, item.get("mtime")) if show_generation_time else None
if duration is not None:
try:
duration = float(duration)
except (TypeError, ValueError, OverflowError):
duration = None
if duration is not None and (not math.isfinite(duration) or duration < 0):
duration = None
if duration is not None:
generation_time_matches += 1
execution_start_ms = max(0, mtime_ms - int(duration * 1000))
extra_pnginfo["saturnnodes_generation_time"] = round(duration, 3)
else:
execution_start_ms = mtime_ms
# Only emit an execution_success timestamp when a real duration is
# known. Two timestamps would make the stock UI report "0.00s" for
# older images; start-only preserves their mtime for sorting while
# leaving the duration blank.
status_messages = [["execution_start", {"timestamp": execution_start_ms}]]
if duration is not None:
status_messages.append(["execution_success", {"timestamp": mtime_ms}])
history_entry = {
"prompt": [
idx,
prompt_id,
prompt_dict,
{
"create_time": mtime_ms,
"extra_pnginfo": extra_pnginfo,
"client_id": "saturnnodes_restored"
},
[output_node_id]
],
"outputs": {
output_node_id: {
"images": [
{
"filename": filename,
"subfolder": subfolder,
"type": "output"
}
]
}
},
"status": {
"status_str": "success",
"completed": True,
"messages": status_messages
}
}
if duration is not None:
history_entry["status"]["saturnnodes_duration"] = round(duration, 3)
prepared.append({
"prompt_id": prompt_id,
"history_entry": history_entry,
"filepath": filepath,
"filename": filename,
"subfolder": subfolder,
"output_node_id": output_node_id,
})
restored_count = 0
prompt_queue = getattr(server, "prompt_queue", None)
if prompt_queue is not None:
with prompt_queue.mutex:
for idx, item in enumerate(images, 1):
filepath = item["filepath"]
filename = item["filename"]
subfolder = item["subfolder"]
rel_key = f"{subfolder}/{filename}" if subfolder else filename
prompt_id = str(uuid.uuid5(uuid.NAMESPACE_URL, f"saturnnodes:{rel_key}"))
prompt_dict, workflow_dict, positive_prompt = self.extract_image_metadata(filepath)
output_node_id = None
if prompt_dict:
for nid, nval in prompt_dict.items():
if isinstance(nval, dict) and "SaveImage" in nval.get("class_type", ""):
output_node_id = str(nid)
break
if not output_node_id:
output_node_id = str(next(iter(prompt_dict.keys())))
if not output_node_id:
output_node_id = "0"
extra_pnginfo = {}
if workflow_dict:
extra_pnginfo["workflow"] = workflow_dict
if positive_prompt:
extra_pnginfo["positive_prompt"] = positive_prompt
mtime_ms = int(item["mtime"] * 1000)
history_entry = {
"prompt": [
idx,
prompt_id,
prompt_dict,
{
"create_time": mtime_ms,
"extra_pnginfo": extra_pnginfo,
"client_id": "saturnnodes_restored"
},
[output_node_id]
],
"outputs": {
output_node_id: {
"images": [
{
"filename": filename,
"subfolder": subfolder,
"type": "output"
}
]
}
},
"status": {
"status_str": "success",
"completed": True,
"messages": [
["execution_start", {"timestamp": mtime_ms}],
["execution_success", {"timestamp": mtime_ms}]
]
}
}
prompt_queue.history[prompt_id] = history_entry
restored_count += 1
# Ingest into modern ComfyUI asset database if --enable-assets is active
mutex = getattr(prompt_queue, "mutex", None)
if mutex is None:
mutex = threading.RLock()
with mutex:
history = getattr(prompt_queue, "history", None)
if not isinstance(history, dict):
history = {}
try:
import importlib
ingest_mod = importlib.import_module("app.assets.services.ingest")
register_file_in_place = getattr(ingest_mod, "register_file_in_place", None)
if register_file_in_place:
res = register_file_in_place(abs_path=filepath, name=filename, tags=["output"])
if res and hasattr(res, "ref") and res.ref and hasattr(res.ref, "id"):
try:
db_mod = importlib.import_module("app.database.db")
queries_mod = importlib.import_module("app.assets.database.queries")
init_db = getattr(db_mod, "init_db", None)
create_session = getattr(db_mod, "create_session", None)
set_reference_metadata = getattr(queries_mod, "set_reference_metadata", None)
if init_db and create_session and set_reference_metadata:
init_db()
with create_session() as session:
set_reference_metadata(session, reference_id=res.ref.id, metadata={
"jobId": prompt_id,
"nodeId": output_node_id,
"filename": filename,
"subfolder": subfolder
})
session.commit()
except Exception:
pass
prompt_queue.history = history
except Exception:
pass
for entry in prepared:
history[entry["prompt_id"]] = entry["history_entry"]
restored_count += 1
# Asset DB ingestion is best-effort: a broken/absent app.assets must
# never prevent the restored history from being usable.
try:
registered_count = self._ingest_assets(prepared)
except Exception as e:
print(f"[SaturnNodes] Asset DB ingestion failed after restore: {e}")
registered_count = 0
self._restored_on_launch = True
self.restored_count = restored_count
self.last_debug_report = {
"timestamp": datetime.datetime.now().isoformat(),
"status": "success",
"enabled": enabled,
"configured_limit": limit,
"total_scanned_images": len(images),
"restored_count": restored_count
"recursive": recursive,
"show_generation_time": show_generation_time,
"output_exists": output_exists,
"total_scanned_images": scan_stats.get("scanned", 0),
"restored_count": restored_count,
"metadata_found": metadata_found,
"generation_time_matches": generation_time_matches,
"generation_time_records": get_generation_time_debug().get("recorded_files", 0),
"asset_db_registered": registered_count,
"elapsed_ms": int((time.time() - started_at) * 1000),
}
self.restored_count = restored_count
if restored_count > 0:
if server:
+329
View File
@@ -0,0 +1,329 @@
"""
Generation-time tracking for SaturnNodes asset restoration.
ComfyUI measures prompt execution duration in main.py but only logs it; it is
not persisted in history or PNG metadata. This module wraps PromptQueue.get /
task_done once and records duration + output filenames in a small JSON file so
restored history entries can show a real execution time.
"""
import os
import json
import math
import time
import threading
from .utils import get_saturnnodes_user_dir
USER_DIR = get_saturnnodes_user_dir()
GENERATION_TIMES_FILE = os.path.join(USER_DIR, "generation_times.json")
MAX_ENTRIES = 1000
_LOCK = threading.RLock()
_DATA = None
_DATA_MTIME = None
_START_TIMES = {}
_PATCHED = False
def _entry_timestamp(entry):
if not isinstance(entry, dict):
return 0
try:
value = int(entry.get("completed", 0))
except (TypeError, ValueError, OverflowError):
return 0
return value if value >= 0 else 0
def _sanitize_data(data):
"""Return a JSON-safe copy of the duration store.
Hand-edited or partially written files can contain non-finite, negative or
non-numeric durations. Dropping them here keeps one corrupt entry from
making every future save fail under ``allow_nan=False``.
"""
payload = dict(data) if isinstance(data, dict) else {}
payload.setdefault("version", 1)
entries = {}
raw_entries = payload.get("entries")
if isinstance(raw_entries, dict):
for key, entry in raw_entries.items():
if not isinstance(entry, dict):
continue
try:
duration = float(entry.get("duration"))
except (TypeError, ValueError, OverflowError):
continue
if not math.isfinite(duration) or duration < 0:
continue
cleaned = dict(entry)
cleaned["duration"] = duration
try:
completed = int(entry.get("completed", 0))
except (TypeError, ValueError, OverflowError):
completed = 0
cleaned["completed"] = completed if completed >= 0 else 0
entries[key] = cleaned
payload["entries"] = entries
return payload
def _load_data():
global _DATA, _DATA_MTIME
with _LOCK:
mtime = None
try:
if os.path.exists(GENERATION_TIMES_FILE):
mtime = os.stat(GENERATION_TIMES_FILE).st_mtime_ns
except OSError:
mtime = None
if _DATA is not None and mtime == _DATA_MTIME:
return _DATA
data = {"version": 1, "entries": {}}
if mtime is not None:
try:
with open(GENERATION_TIMES_FILE, "r", encoding="utf-8") as f:
loaded = json.load(f)
if isinstance(loaded, dict) and isinstance(loaded.get("entries"), dict):
data = _sanitize_data(loaded)
except Exception:
pass
_DATA = data
_DATA_MTIME = mtime
return _DATA
def _save_data(data):
global _DATA_MTIME
temp_file = None
try:
os.makedirs(USER_DIR, exist_ok=True)
data = _sanitize_data(data)
# Unique temp names keep a stale temp file from a crashed process (or a
# second ComfyUI instance) from being clobbered mid-write.
temp_file = f"{GENERATION_TIMES_FILE}.{os.getpid()}.{threading.get_ident()}.tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump(data, f, separators=(",", ":"), ensure_ascii=False, allow_nan=False)
f.flush()
try:
os.fsync(f.fileno())
except OSError:
pass
for attempt in range(3):
try:
os.replace(temp_file, GENERATION_TIMES_FILE)
temp_file = None
break
except PermissionError:
if attempt == 2:
raise
time.sleep(0.05)
try:
_DATA_MTIME = os.stat(GENERATION_TIMES_FILE).st_mtime_ns
except OSError:
_DATA_MTIME = None
except Exception as e:
print(f"[SaturnNodes] Error saving generation times: {e}")
finally:
if temp_file and os.path.exists(temp_file):
try:
os.remove(temp_file)
except OSError:
pass
def _normalize_ref(filename, subfolder=""):
sub = str(subfolder or "").replace("\\", "/").strip("/")
name = str(filename or "").replace("\\", "/").strip("/")
return f"{sub}/{name}" if sub else name
def record_generation_time(prompt_id, duration, files, status="success"):
"""Store one prompt's wall-clock duration keyed by every output file."""
try:
duration = round(float(duration), 3)
except (TypeError, ValueError, OverflowError):
return
if not math.isfinite(duration) or duration < 0 or not files:
return
completed_ms = int(time.time() * 1000)
with _LOCK:
data = _load_data()
entries = data.setdefault("entries", {})
for file_info in files:
if not isinstance(file_info, dict):
continue
filename = file_info.get("filename")
if not filename:
continue
key = _normalize_ref(filename, file_info.get("subfolder", ""))
entries[key] = {
"duration": duration,
"completed": completed_ms,
"prompt_id": str(prompt_id) if prompt_id else "",
"status": str(status) if status is not None else "success",
}
if len(entries) > MAX_ENTRIES:
keep = set(sorted(entries.keys(), key=lambda k: _entry_timestamp(entries[k]), reverse=True)[:MAX_ENTRIES])
for key in [k for k in entries.keys() if k not in keep]:
del entries[key]
_save_data(data)
def get_generation_time(filename, subfolder="", file_mtime=None):
"""Return the recorded duration in seconds for an output file, or None.
``file_mtime`` (seconds since epoch) is optional and only used for the
moved-file fallback. It prevents two different files that happen to share a
bare filename from being assigned each other's duration.
"""
if not filename:
return None
key = _normalize_ref(filename, subfolder)
with _LOCK:
entries = _load_data().get("entries", {})
entry = entries.get(key)
if entry is None:
bare = str(filename).replace("\\", "/").strip("/")
matches = [
(k, v) for k, v in entries.items()
if k == bare or k.endswith("/" + bare)
]
if file_mtime is not None:
try:
mtime_ms = float(file_mtime) * 1000.0
matches = [
(k, v) for k, v in matches
if abs(_entry_timestamp(v) - mtime_ms) <= 300000
]
except (TypeError, ValueError):
pass
# Only use the fallback when exactly one record can belong to this
# file. Guessing between same-named outputs is worse than showing
# no duration at all.
if len(matches) == 1:
entry = matches[0][1]
if isinstance(entry, dict):
try:
duration = float(entry.get("duration"))
except (TypeError, ValueError, OverflowError):
return None
if math.isfinite(duration) and duration >= 0:
return duration
return None
return None
def get_generation_time_debug():
with _LOCK:
entries = _load_data().get("entries", {})
return {"recorded_files": len(entries), "max_entries": MAX_ENTRIES}
def _extract_output_files(history_result):
files = []
if not isinstance(history_result, dict):
return files
outputs = history_result.get("outputs")
if not isinstance(outputs, dict):
return files
for node_output in outputs.values():
if not isinstance(node_output, dict):
continue
for image in node_output.get("images", []) or []:
if not isinstance(image, dict) or not image.get("filename"):
continue
# Only permanently saved outputs are eligible for restored-asset
# history entries. Temporary previews can share filenames.
if image.get("type", "output") != "output":
continue
files.append({
"filename": image.get("filename"),
"subfolder": image.get("subfolder", ""),
"type": "output",
})
return files
def patch_prompt_queue(server):
"""Wrap PromptQueue.get/task_done once to measure real execution durations."""
global _PATCHED
if _PATCHED:
return
queue = getattr(server, "prompt_queue", None)
if queue is None or not hasattr(queue, "get") or not hasattr(queue, "task_done"):
return
if getattr(queue, "_saturnnodes_time_patched", False):
_PATCHED = True
return
original_get = queue.get
def timed_get(*args, **kwargs):
item = original_get(*args, **kwargs)
if item is not None:
try:
# ComfyUI's PromptQueue.get returns (queue_item, task_id).
# Support a bare queue item as well for lightweight/legacy
# queue implementations used by tests or custom servers.
queue_item = item[0] if (
isinstance(item, (tuple, list))
and len(item) == 2
and isinstance(item[0], (tuple, list))
) else item
prompt_id = str(queue_item[1]) if (
isinstance(queue_item, (tuple, list)) and len(queue_item) > 1
) else None
if prompt_id:
with _LOCK:
_START_TIMES[prompt_id] = time.time()
while len(_START_TIMES) > 2000:
_START_TIMES.pop(next(iter(_START_TIMES)))
except Exception:
pass
return item
original_task_done = queue.task_done
def timed_task_done(item_id, history_result, status=None, process_item=None):
prompt_id = None
try:
mutex = getattr(queue, "mutex", None)
if mutex:
with mutex:
running = queue.currently_running.get(item_id)
else:
running = queue.currently_running.get(item_id)
if isinstance(running, (tuple, list)) and len(running) > 1:
prompt_id = str(running[1])
except Exception:
prompt_id = None
started = None
with _LOCK:
if prompt_id:
started = _START_TIMES.pop(prompt_id, None)
try:
return original_task_done(item_id, history_result, status, process_item)
finally:
if prompt_id and started is not None:
status_str = getattr(status, "status_str", status)
record_generation_time(
prompt_id,
max(0.0, time.time() - started),
_extract_output_files(history_result),
status=status_str,
)
queue.get = timed_get
queue.task_done = timed_task_done
try:
queue._saturnnodes_time_patched = True
except Exception:
pass
_PATCHED = True
+140 -76
View File
@@ -4,6 +4,9 @@ import torch
import numpy as np
from PIL import Image, ImageOps
import io
import asyncio
import hashlib
import threading
import piexif
import piexif.helper
from aiohttp import web
@@ -14,7 +17,8 @@ from .utils import (
is_local_request,
is_safe_path,
sanitize_image_loader_folder,
get_saturnnodes_user_dir
get_saturnnodes_user_dir,
get_env_setting
)
IMAGE_CATEGORY = "🪐 SaturnNodes/Loaders"
@@ -169,6 +173,120 @@ def save_prompts_cache(cache):
except Exception as e:
print(f"[SaturnNodes] Failed to save prompts cache: {e}")
_PROMPTS_CACHE_LOCK = threading.RLock()
IMAGE_THUMBNAILS_DIR = os.path.join(USER_DIR, "cache", "image_thumbs")
def get_image_metadata_scan_limit():
try:
limit = int(get_env_setting("IMAGE_LOADER_METADATA_LIMIT", "128"))
return max(0, min(2000, limit))
except Exception:
return 128
def scan_image_folder(resolved_folder, metadata_limit=None):
"""Scan an image folder and read prompt metadata off the event-loop thread."""
if metadata_limit is None:
metadata_limit = get_image_metadata_scan_limit()
image_extensions = {".png", ".jpg", ".jpeg", ".webp", ".bmp"}
raw_files = []
for root, dirs, files in os.walk(resolved_folder):
for file in files:
ext = os.path.splitext(file)[1]
if ext.lower() in image_extensions:
full_path = os.path.normpath(os.path.join(root, file))
# The folder itself was already validated by the endpoint; just
# enforce that walked files stay inside it.
if not is_safe_path(full_path, [resolved_folder]):
continue
try:
mtime = os.path.getmtime(full_path)
except Exception:
mtime = 0
rel_path = os.path.relpath(full_path, resolved_folder).replace("\\", "/")
raw_files.append((rel_path, full_path, mtime))
# Sort files by newest modified first. Pre-sort by relative path and use a
# stable mtime sort so identical timestamps always produce the same order.
raw_files.sort(key=lambda x: x[0])
raw_files.sort(key=lambda x: x[2], reverse=True)
names = []
mapping = {}
prompts = {}
with _PROMPTS_CACHE_LOCK:
cache = load_prompts_cache()
cache_modified = False
for i, (rel_path, full_path, mtime) in enumerate(raw_files):
names.append(rel_path)
mapping[rel_path] = rel_path
if i < metadata_limit:
try:
cached_entry = cache.get(full_path)
if cached_entry and cached_entry.get("mtime") == mtime:
prompt_text = cached_entry.get("prompt", "")
cache[full_path] = cache.pop(full_path)
else:
prompt_text, _, _ = extract_metadata_from_image(full_path)
cache[full_path] = {
"mtime": mtime,
"prompt": prompt_text
}
cache_modified = True
except Exception:
prompt_text = ""
prompts[rel_path] = prompt_text
else:
prompts[rel_path] = ""
# Prune cache to maximum 256 entries
if len(cache) > 256:
cache_keys = list(cache.keys())[-256:]
cache = {k: cache[k] for k in cache_keys}
cache_modified = True
if cache_modified:
save_prompts_cache(cache)
return names, mapping, prompts
def get_or_create_image_thumbnail(img_path, mtime, max_size=256):
"""Disk-cached WebP thumbnails for the visual image loader."""
try:
max_size = max(64, min(1024, int(max_size)))
cache_key = hashlib.md5(
f"{os.path.normcase(os.path.abspath(img_path))}_{mtime}_{max_size}".encode("utf-8")
).hexdigest()
thumb_path = os.path.join(IMAGE_THUMBNAILS_DIR, f"thumb_{cache_key}.webp")
if os.path.exists(thumb_path) and os.path.getsize(thumb_path) > 0:
return thumb_path
with Image.open(img_path) as img:
img = ImageOps.exif_transpose(img)
if img.width <= max_size and img.height <= max_size:
return img_path
img = img.convert("RGB")
img.thumbnail((max_size, max_size), Image.Resampling.BICUBIC)
os.makedirs(IMAGE_THUMBNAILS_DIR, exist_ok=True)
# Unique temp names keep concurrent requests for the same image from
# overwriting each other's half-written WebP file.
temp_path = thumb_path + f".{threading.get_ident()}.tmp"
try:
img.save(temp_path, format="WEBP", quality=82, method=1)
os.replace(temp_path, thumb_path)
finally:
if os.path.exists(temp_path):
try:
os.remove(temp_path)
except OSError:
pass
return thumb_path
except Exception:
return img_path
if hasattr(PromptServer, "instance") and PromptServer.instance is not None:
routes = PromptServer.instance.routes
else:
@@ -183,73 +301,15 @@ async def get_images_endpoint(request):
folder = request.query.get("folder", "")
if not folder:
folder = request.query.get("folder_path", "")
resolved_folder = sanitize_image_loader_folder(folder)
if not resolved_folder or not is_safe_path(resolved_folder) or not os.path.exists(resolved_folder):
return web.json_response({"names": [], "mapping": {}, "prompts": {}})
image_extensions = {".png", ".jpg", ".jpeg", ".webp", ".PNG", ".JPG", ".JPEG", ".WEBP"}
raw_files = []
for root, dirs, files in os.walk(resolved_folder):
for file in files:
ext = os.path.splitext(file)[1]
if ext in image_extensions:
full_path = os.path.normpath(os.path.join(root, file))
if not is_safe_path(full_path):
continue
try:
mtime = os.path.getmtime(full_path)
except Exception:
mtime = 0
rel_path = os.path.relpath(full_path, resolved_folder).replace("\\", "/")
raw_files.append((rel_path, full_path, mtime))
# Sort files by newest modified first
raw_files.sort(key=lambda x: x[2], reverse=True)
names = []
mapping = {}
prompts = {}
cache = load_prompts_cache()
cache_modified = False
# Extract prompt metadata for the most recent 128 images to keep cache small and fast
METADATA_LIMIT = 128
for i, (rel_path, full_path, mtime) in enumerate(raw_files):
names.append(rel_path)
mapping[rel_path] = rel_path
if i < METADATA_LIMIT:
try:
cached_entry = cache.get(full_path)
if cached_entry and cached_entry.get("mtime") == mtime:
prompt_text = cached_entry.get("prompt", "")
cache[full_path] = cache.pop(full_path)
else:
prompt_text, _, _ = extract_metadata_from_image(full_path)
cache[full_path] = {
"mtime": mtime,
"prompt": prompt_text
}
cache_modified = True
except Exception as e:
prompt_text = ""
prompts[rel_path] = prompt_text
else:
prompts[rel_path] = ""
# Prune cache to maximum 256 entries
if len(cache) > 256:
cache_keys = list(cache.keys())[-256:]
cache = {k: cache[k] for k in cache_keys}
cache_modified = True
if cache_modified:
save_prompts_cache(cache)
# Folder walks and metadata parsing are blocking disk I/O; keep them off
# ComfyUI's asyncio event loop.
names, mapping, prompts = await asyncio.to_thread(scan_image_folder, resolved_folder)
return web.json_response({
"names": names,
@@ -266,25 +326,29 @@ async def get_thumbnail_endpoint(request):
if not folder:
folder = request.query.get("folder_path", "")
resolved_folder = sanitize_image_loader_folder(folder)
image_rel = request.query.get("image", "")
if not image_rel:
return web.Response(status=400)
full_path = os.path.normpath(os.path.join(resolved_folder, image_rel))
if not is_safe_path(full_path) or not os.path.exists(full_path) or not os.path.isfile(full_path):
if not is_safe_path(full_path, [resolved_folder]) or not os.path.exists(full_path) or not os.path.isfile(full_path):
return web.Response(status=404)
image_extensions = {".png", ".jpg", ".jpeg", ".webp", ".bmp"}
if os.path.splitext(full_path)[1].lower() not in image_extensions:
return web.Response(status=403)
try:
with Image.open(full_path) as img:
img.thumbnail((256, 256))
img_byte_arr = io.BytesIO()
img.convert("RGB").save(img_byte_arr, format='JPEG', quality=80)
return web.Response(body=img_byte_arr.getvalue(), content_type="image/jpeg")
thumb_size = int(request.query.get("size", 256))
except Exception:
thumb_size = 256
thumb_size = max(64, min(1024, thumb_size))
try:
mtime = os.path.getmtime(full_path)
serve_path = await asyncio.to_thread(get_or_create_image_thumbnail, full_path, mtime, thumb_size)
return web.FileResponse(serve_path)
except Exception:
return web.FileResponse(full_path)
@@ -297,13 +361,13 @@ async def get_full_image_endpoint(request):
if not folder:
folder = request.query.get("folder_path", "")
resolved_folder = sanitize_image_loader_folder(folder)
image_rel = request.query.get("image", "")
if not image_rel:
return web.Response(status=400)
full_path = os.path.normpath(os.path.join(resolved_folder, image_rel))
if not is_safe_path(full_path) or not os.path.exists(full_path) or not os.path.isfile(full_path):
if not is_safe_path(full_path, [resolved_folder]) or not os.path.exists(full_path) or not os.path.isfile(full_path):
return web.Response(status=404)
image_extensions = {".png", ".jpg", ".jpeg", ".webp", ".bmp"}
+17 -6
View File
@@ -65,7 +65,18 @@ class LoadRecentOutputs:
dummy = torch.zeros((1, 512, 512, 3), dtype=torch.float32)
return (dummy,)
file_list.sort(key=lambda x: x[1], reverse=True)
try:
amount = max(1, int(amount))
except (TypeError, ValueError, OverflowError):
amount = 1
try:
index = max(0, int(index))
except (TypeError, ValueError, OverflowError):
index = 0
# Newest first, with the path as a deterministic tie-breaker for files
# copied/extracted with identical timestamps.
file_list.sort(key=lambda x: (x[1], x[0]), reverse=True)
recent_files = file_list[:amount]
if "oldest" in str(order).lower() or "chronological" in str(order).lower():
recent_files.reverse()
@@ -74,11 +85,11 @@ class LoadRecentOutputs:
target_file, _ = recent_files[actual_index]
try:
img = Image.open(target_file)
img = ImageOps.exif_transpose(img)
image = img.convert("RGB")
image = np.array(image).astype(np.float32) / 255.0
image = torch.from_numpy(image).unsqueeze(0)
with Image.open(target_file) as img:
img = ImageOps.exif_transpose(img)
image = img.convert("RGB")
image = np.array(image).astype(np.float32) / 255.0
image = torch.from_numpy(image).unsqueeze(0)
except Exception as e:
print(f"[SaturnNodes] Error loading recent output image {target_file}: {e}")
image = torch.zeros((1, 512, 512, 3), dtype=torch.float32)
+43 -18
View File
@@ -81,31 +81,36 @@ class TextLoraFinder:
if search_for == "Custom Regex":
if custom_regex and custom_regex.strip():
# Invert the name lookup: build it once instead of scanning the
# whole LoRA mapping for every regex match in the prompt.
lookup = {}
for display_name, sys_path in mapping.items():
if display_name in ["[ NONE ]", "[ RANDOM ]"] or not sys_path or sys_path == "[ NONE ]":
continue
pretty_val = re.sub(r'\s+V\d+(\.\d+)?$', '', parse_pretty_name(sys_path), flags=re.IGNORECASE).strip()
fname = os.path.basename(sys_path)
fname_noext = os.path.splitext(fname)[0]
for key in (pretty_val, fname, fname_noext, display_name):
if key:
lookup.setdefault(key.lower(), []).append((display_name, sys_path))
try:
pattern = re.compile(custom_regex, re.IGNORECASE)
for m in pattern.finditer(text_str):
matched_text = m.group(0).strip()
for display_name, sys_path in mapping.items():
if display_name in ["[ NONE ]", "[ RANDOM ]"] or not sys_path or sys_path == "[ NONE ]":
continue
matched_text = m.group(0).strip().lower()
for display_name, sys_path in lookup.get(matched_text, []):
if sys_path in seen_paths:
continue
pretty_val = re.sub(r'\s+V\d+(\.\d+)?$', '', parse_pretty_name(sys_path), flags=re.IGNORECASE).strip()
fname = os.path.basename(sys_path)
fname_noext = os.path.splitext(fname)[0]
if (matched_text.lower() in [pretty_val.lower(), fname.lower(), fname_noext.lower(), display_name.lower()]):
matches.append((m.start(), display_name, sys_path))
seen_paths.add(sys_path)
matches.append((m.start(), display_name, sys_path))
seen_paths.add(sys_path)
except Exception as e:
print(f"[SaturnNodes] Invalid custom regex pattern '{custom_regex}': {e}")
else:
# Build one name lookup and scan the prompt once (combined regex),
# instead of running one regex scan per installed LoRA.
lookup = {}
for display_name, sys_path in mapping.items():
if display_name in ["[ NONE ]", "[ RANDOM ]"] or not sys_path or sys_path == "[ NONE ]":
continue
if sys_path in seen_paths:
continue
if search_for in ["Pretty Name", "Parsed Name"]:
target_name = re.sub(r'\s+V\d+(\.\d+)?$', '', parse_pretty_name(sys_path), flags=re.IGNORECASE).strip()
@@ -116,11 +121,31 @@ class TextLoraFinder:
if not target_name:
continue
lookup.setdefault(target_name.lower(), []).append((display_name, sys_path))
pattern = r'(?<!\w)' + re.escape(target_name) + r'(?!\w)'
for m in re.finditer(pattern, text_str, flags=re.IGNORECASE):
matches.append((m.start(), display_name, sys_path))
seen_paths.add(sys_path)
if lookup:
# Longest-first so "Style XL" wins over "Style" at the same position.
ordered_names = sorted(lookup.keys(), key=len, reverse=True)
combined_pattern = r'(?<!\w)(?:' + "|".join(re.escape(n) for n in ordered_names) + r')(?!\w)'
try:
combined_regex = re.compile(combined_pattern, flags=re.IGNORECASE)
for m in combined_regex.finditer(text_str):
for display_name, sys_path in lookup.get(m.group(0).lower(), []):
if sys_path in seen_paths:
continue
matches.append((m.start(), display_name, sys_path))
seen_paths.add(sys_path)
except re.error:
# Extremely large catalogs can exceed the regex compiler's
# limits; fall back to the original per-name scan.
for target_name, entries in lookup.items():
pattern = r'(?<!\w)' + re.escape(target_name) + r'(?!\w)'
for m in re.finditer(pattern, text_str, flags=re.IGNORECASE):
for display_name, sys_path in entries:
if sys_path in seen_paths:
continue
matches.append((m.start(), display_name, sys_path))
seen_paths.add(sys_path)
if not matches:
return (model, clip, "")
+314 -132
View File
@@ -5,6 +5,7 @@ import json
import time
import hashlib
import asyncio
import atexit
import folder_paths
import urllib.request
import urllib.parse
@@ -22,7 +23,8 @@ from .utils import (
get_saturnnodes_user_dir,
is_local_request,
is_authenticated_local_request,
is_safe_path
is_safe_path,
get_env_setting
)
LORA_CATEGORY = "🪐 SaturnNodes/Loaders"
@@ -39,34 +41,49 @@ CURRENT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
USER_DIR = get_saturnnodes_user_dir()
ENV_FILE = os.path.join(USER_DIR, ".env")
LORA_STATE_FILE = os.path.join(USER_DIR, "lora_loader_state.json")
HASH_CACHE_FILE = os.path.join(USER_DIR, "lora_hash_cache.json")
_LORA_STATE_LOCK = threading.RLock()
def ensure_user_dir():
os.makedirs(USER_DIR, exist_ok=True)
def _entry_timestamp(entry):
if isinstance(entry, dict):
try:
return int(entry.get("last_updated", 0))
except (TypeError, ValueError):
return 0
return 0
def load_lora_cycle_state():
ensure_user_dir()
if os.path.exists(LORA_STATE_FILE):
try:
with open(LORA_STATE_FILE, "r", encoding="utf-8") as f:
return json.load(f)
except Exception:
pass
return {}
with _LORA_STATE_LOCK:
if os.path.exists(LORA_STATE_FILE):
try:
with open(LORA_STATE_FILE, "r", encoding="utf-8") as f:
data = json.load(f)
if isinstance(data, dict):
return data
except Exception:
pass
return {}
def save_lora_cycle_state(state):
ensure_user_dir()
try:
# Auto-prune abandoned state keys if count exceeds 100 entries
if len(state) > 100:
excess_keys = list(state.keys())[:-100]
for k in excess_keys:
del state[k]
temp_file = LORA_STATE_FILE + ".tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump(state, f, indent=4, ensure_ascii=False)
os.replace(temp_file, LORA_STATE_FILE)
except Exception as e:
print(f"[SaturnNodes] Error saving lora loader cycle state: {e}")
with _LORA_STATE_LOCK:
try:
# Global prune: keep the 100 most recently used node/selection entries.
if len(state) > 100:
keep = set(sorted(state.keys(), key=lambda k: _entry_timestamp(state[k]), reverse=True)[:100])
for k in [k for k in state.keys() if k not in keep]:
del state[k]
temp_file = LORA_STATE_FILE + ".tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump(state, f, indent=4, ensure_ascii=False)
os.replace(temp_file, LORA_STATE_FILE)
except Exception as e:
print(f"[SaturnNodes] Error saving lora loader cycle state: {e}")
def get_api_keys():
civitai_key = os.getenv("CIVITAI_API_KEY", "")
@@ -88,9 +105,18 @@ def get_api_keys():
scraping_thread = None
scraping_lock = threading.Lock()
def load_usage_data():
usage_file = os.path.join(USER_DIR, "lora_usage.json")
_USAGE_LOCK = threading.RLock()
_USAGE_CACHE = None
_USAGE_DIRTY = False
_USAGE_TIMER = None
_USAGE_FLUSH_DELAY = 2.0
def _usage_file_path():
return os.path.join(USER_DIR, "lora_usage.json")
def _read_usage_data_from_disk():
usage_data = {}
usage_file = _usage_file_path()
if os.path.exists(usage_file):
try:
with open(usage_file, "r", encoding="utf-8") as f:
@@ -105,23 +131,69 @@ def load_usage_data():
print(f"[SaturnNodes] Error loading usage data: {e}")
return usage_data
def load_usage_data():
global _USAGE_CACHE
with _USAGE_LOCK:
if _USAGE_CACHE is None:
_USAGE_CACHE = _read_usage_data_from_disk()
return dict(_USAGE_CACHE)
def flush_lora_usage():
"""Write pending usage increments to disk (debounced and atomic)."""
global _USAGE_DIRTY
with _USAGE_LOCK:
if not _USAGE_DIRTY or _USAGE_CACHE is None:
return
try:
ensure_user_dir()
usage_file = _usage_file_path()
temp_file = usage_file + ".tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump(_USAGE_CACHE, f, indent=4, ensure_ascii=False)
os.replace(temp_file, usage_file)
_USAGE_DIRTY = False
except Exception as e:
print(f"[SaturnNodes] Error updating lora usage: {e}")
def _schedule_usage_flush():
global _USAGE_TIMER
if _USAGE_TIMER is None or not _USAGE_TIMER.is_alive():
_USAGE_TIMER = threading.Timer(_USAGE_FLUSH_DELAY, flush_lora_usage)
_USAGE_TIMER.daemon = True
_USAGE_TIMER.start()
atexit.register(flush_lora_usage)
def increment_lora_usage(lora_path):
if not lora_path or lora_path == "[ NONE ]":
return
if get_env_setting("ENABLE_LORA_USAGE", "true").lower() != "true":
if get_env_setting("ENABLE_LORA_USAGE", "true").lower() not in ["true", "1", "yes"]:
return
global _USAGE_CACHE, _USAGE_DIRTY
try:
usage_file = os.path.join(USER_DIR, "lora_usage.json")
usage_data = load_usage_data()
pretty_key = parse_pretty_name(lora_path)
usage_data[pretty_key] = usage_data.get(pretty_key, 0) + 1
temp_file = usage_file + ".tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump(usage_data, f, indent=4, ensure_ascii=False)
os.replace(temp_file, usage_file)
with _USAGE_LOCK:
if _USAGE_CACHE is None:
_USAGE_CACHE = _read_usage_data_from_disk()
pretty_key = parse_pretty_name(lora_path)
_USAGE_CACHE[pretty_key] = _USAGE_CACHE.get(pretty_key, 0) + 1
_USAGE_DIRTY = True
_schedule_usage_flush()
except Exception as e:
print(f"[SaturnNodes] Error updating lora usage: {e}")
def reset_lora_usage_file():
"""Clear usage counters, discarding any pending debounced writes."""
global _USAGE_CACHE, _USAGE_DIRTY
with _USAGE_LOCK:
ensure_user_dir()
usage_file = _usage_file_path()
temp_file = usage_file + ".tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump({}, f, indent=4)
os.replace(temp_file, usage_file)
_USAGE_CACHE = {}
_USAGE_DIRTY = False
def find_preview_image(lora_relative_path):
lora_full_path = folder_paths.get_full_path("loras", lora_relative_path)
if not lora_full_path:
@@ -141,6 +213,73 @@ def get_file_sha256(filepath):
h.update(chunk)
return h.hexdigest().upper()
_HASH_CACHE_LOCK = threading.RLock()
_HASH_CACHE = None
def _load_hash_cache():
global _HASH_CACHE
if _HASH_CACHE is not None:
return _HASH_CACHE
_HASH_CACHE = {}
try:
if os.path.exists(HASH_CACHE_FILE):
with open(HASH_CACHE_FILE, "r", encoding="utf-8") as f:
data = json.load(f)
if isinstance(data, dict):
_HASH_CACHE = data
except Exception:
_HASH_CACHE = {}
return _HASH_CACHE
def _save_hash_cache():
try:
ensure_user_dir()
temp_file = HASH_CACHE_FILE + ".tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump(_HASH_CACHE, f, indent=2, ensure_ascii=False)
os.replace(temp_file, HASH_CACHE_FILE)
except Exception:
pass
def get_file_sha256_cached(filepath):
"""Hash a LoRA once and reuse it while mtime/size stay unchanged."""
try:
before = os.stat(filepath)
except OSError:
return get_file_sha256(filepath)
cache_key = os.path.normcase(os.path.abspath(filepath))
with _HASH_CACHE_LOCK:
cache = _load_hash_cache()
entry = cache.get(cache_key)
if (isinstance(entry, dict)
and entry.get("mtime_ns") == before.st_mtime_ns
and entry.get("size") == before.st_size
and entry.get("sha256")):
return entry["sha256"]
digest = get_file_sha256(filepath)
try:
after = os.stat(filepath)
if after.st_mtime_ns == before.st_mtime_ns and after.st_size == before.st_size:
with _HASH_CACHE_LOCK:
cache = _load_hash_cache()
cache[cache_key] = {
"mtime_ns": before.st_mtime_ns,
"size": before.st_size,
"sha256": digest,
"last_updated": int(time.time()),
}
if len(cache) > 1000:
keep = set(sorted(cache.keys(), key=lambda k: int(cache[k].get("last_updated", 0)), reverse=True)[:1000])
for k in [k for k in cache.keys() if k not in keep]:
del cache[k]
_save_hash_cache()
except OSError:
pass
return digest
def is_safe_external_image_url(url_str):
"""
Validates that a scraped image URL uses a safe web scheme (https/http)
@@ -167,17 +306,6 @@ def is_safe_external_image_url(url_str):
except Exception:
return False
def get_env_setting(key, default_val):
if os.path.exists(ENV_FILE):
try:
with open(ENV_FILE, "r", encoding="utf-8") as f:
for line in f:
if line.strip().startswith(f"{key}="):
return line.strip().split("=", 1)[1].strip()
except Exception:
pass
return default_val
def scrape_missing_images_sync():
try:
civitai_enabled = get_env_setting("ENABLE_CIVITAI_SCRAPING", "false").lower() in ["true", "1", "yes"]
@@ -218,7 +346,7 @@ def scrape_missing_images_sync():
if civitai_enabled:
try:
file_hash = get_file_sha256(lora_path)
file_hash = get_file_sha256_cached(lora_path)
civitai_url = f"https://civitai.com/api/v1/model-versions/by-hash/{file_hash}"
headers = {'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)'}
if civitai_key:
@@ -377,7 +505,7 @@ async def get_loras_endpoint(request):
if scrape_on_new:
start_async_scraping()
usage_enabled = get_env_setting("ENABLE_LORA_USAGE", "true").lower() == "true"
usage_enabled = get_env_setting("ENABLE_LORA_USAGE", "true").lower() in ["true", "1", "yes"]
usage_by_path = {}
mtime_by_path = {}
@@ -504,12 +632,7 @@ async def reset_lora_usage_endpoint(request):
if not is_authenticated_local_request(request):
return web.json_response({"error": "Forbidden: Local authenticated access only"}, status=403)
try:
ensure_user_dir()
usage_file = os.path.join(USER_DIR, "lora_usage.json")
tmp_file = usage_file + ".tmp"
with open(tmp_file, "w", encoding="utf-8") as f:
json.dump({}, f, indent=4)
os.replace(tmp_file, usage_file)
reset_lora_usage_file()
return web.json_response({"status": "ok"})
except Exception as e:
return web.json_response({"status": "error", "message": str(e)}, status=500)
@@ -664,16 +787,13 @@ class FolderLoraLoaderPretty(FolderLoraLoader):
out_name = format_lora_output_name(resolved_path, display_name, output_format=active_format, custom_regex=custom_regex)
if strength_model == 0 and strength_clip == 0:
increment_lora_usage(resolved_path)
return (model, clip, out_name)
if not resolved_path:
return (model, clip, out_name)
lora_path = folder_paths.get_full_path("loras", resolved_path)
if strength_model == 0 and strength_clip == 0:
increment_lora_usage(resolved_path)
return (model, clip, out_name)
if not lora_path or not os.path.exists(lora_path):
return (model, clip, out_name)
@@ -688,14 +808,145 @@ def get_current_prompt_id():
try:
from server import PromptServer
server = PromptServer.instance
if hasattr(server, "prompt_queue") and server.prompt_queue.currently_running:
for item in server.prompt_queue.currently_running.values():
if hasattr(server, "prompt_queue"):
queue = server.prompt_queue
mutex = getattr(queue, "mutex", None)
if mutex:
with mutex:
items = list(queue.currently_running.values())
else:
items = list(queue.currently_running.values())
for item in items:
if isinstance(item, (tuple, list)) and len(item) > 1:
return str(item[1])
except Exception:
pass
return None
def _remember_lora_assignment(assigned, prompt_id, item, limit=50):
"""Insert/refresh a prompt→LoRA mapping, keeping the most recent entries."""
if not prompt_id:
return
assigned.pop(prompt_id, None)
assigned[prompt_id] = item
while len(assigned) > limit:
assigned.pop(next(iter(assigned)))
def select_a_lora(mode, unique_id, valid_choices, prompt_id=None):
"""
Choose one LoRA for Sequential / Random / Random (No Replace), persisting
cycle position, pools and crash-recovery prompt assignments in one atomic
state update. Returns None when there is nothing to select.
"""
valid_choices = [item for item in valid_choices if item and item != "[ NONE ]"]
if not valid_choices:
return None
choices_hash = hashlib.sha256(
json.dumps(sorted(valid_choices), ensure_ascii=False).encode("utf-8")
).hexdigest()[:16]
prefix = {
"Random": "rand",
"Sequential": "seq",
"Random (No Replace)": "noreplace",
}.get(mode)
if not prefix:
return None
state_key = f"{prefix}_{unique_id}_{choices_hash}"
with _LORA_STATE_LOCK:
state = load_lora_cycle_state()
node_state = state.get(state_key)
if isinstance(node_state, dict):
raw_assigned = node_state.get("assigned", {})
assigned = dict(raw_assigned) if isinstance(raw_assigned, dict) else {}
raw_pool = node_state.get("pool", [])
pool = list(raw_pool) if isinstance(raw_pool, (list, tuple)) else []
last_selected = node_state.get("last")
raw_order = node_state.get("order")
order = list(raw_order) if isinstance(raw_order, (list, tuple)) else []
try:
index = max(0, int(node_state.get("index", 0)))
except (TypeError, ValueError):
index = 0
elif isinstance(node_state, list):
# Legacy Random (No Replace) format stored a bare pool list.
assigned = {}
pool = list(node_state)
last_selected = None
order = []
index = 0
else:
assigned = {}
pool = []
last_selected = None
order = []
index = 0
if mode == "Sequential":
# The state key hashes the *set* of selected LoRAs, so selecting the
# same LoRAs in a different order reuses this bucket. Persist the
# order observed when the cycle started and index into that, because
# indexing the live (reordered) list used to land on a different
# LoRA, repeating one pick and skipping another.
if not order or sorted(order) != sorted(valid_choices):
order = list(valid_choices)
if order:
index %= len(order)
else:
order = []
if prompt_id and prompt_id in assigned:
# Retry/crash recovery: reproduce the exact same selection without
# advancing the cycle or consuming another pool entry.
selected = assigned[prompt_id]
if selected not in valid_choices:
selected = None
else:
selected = None
if selected is None:
if mode == "Sequential":
selected = order[index % len(order)] if order else None
index += 1
elif mode == "Random":
import random
selected = random.choice(valid_choices)
elif mode == "Random (No Replace)":
import random
pool = [x for x in pool if x in valid_choices]
if not pool:
pool = list(valid_choices)
# Avoid repeating the last item of the previous cycle
# back-to-back while still visiting every item once.
if len(pool) > 1 and last_selected in pool:
random.shuffle(pool)
if pool[0] == last_selected:
swap_index = random.randrange(1, len(pool))
pool[0], pool[swap_index] = pool[swap_index], pool[0]
else:
random.shuffle(pool)
selected = pool.pop(0)
last_selected = selected
if prompt_id and selected:
_remember_lora_assignment(assigned, prompt_id, selected)
new_entry = {
"assigned": assigned,
"last_updated": int(time.time()),
}
if mode == "Sequential":
new_entry["index"] = index
new_entry["order"] = order
if mode == "Random (No Replace)":
new_entry["pool"] = pool
new_entry["last"] = last_selected
state[state_key] = new_entry
save_lora_cycle_state(state)
return selected
class VisualLoraLoader(FolderLoraLoaderPretty):
@classmethod
def INPUT_TYPES(s):
@@ -728,12 +979,12 @@ class VisualLoraLoader(FolderLoraLoaderPretty):
@classmethod
def IS_CHANGED(cls, **kwargs):
mode = kwargs.get("_selection_mode", "All")
mode = kwargs.get("_selection_mode", "Sequential")
if mode in ["Random", "Sequential", "Random (No Replace)"]:
return time.time()
return ""
def load_lora(self, model, clip, folder, strength_model, strength_clip, display_mode="Scrollable", sort_loras_by="Name (A-Z)", sort_folders_by="Name (A-Z)", folder_position="Folders First", content_alignment="Left Aligned", output_format="Filename", custom_regex="", output_name=None, _selected_lora="[]", _selection_mode="All", _scrape_on_new="true", unique_id="default", **kwargs):
def load_lora(self, model, clip, folder, strength_model, strength_clip, display_mode="Scrollable", sort_loras_by="Name (A-Z)", sort_folders_by="Name (A-Z)", folder_position="Folders First", content_alignment="Left Aligned", output_format="Filename", custom_regex="", output_name=None, _selected_lora="[]", _selection_mode="Sequential", _scrape_on_new="true", unique_id="default", **kwargs):
active_format = output_name if output_name is not None else output_format
active_lora = _selected_lora if _selected_lora else "[]"
if active_lora == "[ NONE ]" or active_lora == "[]" or not active_lora:
@@ -751,82 +1002,14 @@ class VisualLoraLoader(FolderLoraLoaderPretty):
current_pid = get_current_prompt_id()
if _selection_mode in ["Random", "Sequential", "Random (No Replace)"] and len(loras_to_load) > 0:
valid_choices = [item for item in loras_to_load if item != "[ NONE ]" and item]
if valid_choices:
if _selection_mode == "Random":
import random
state = load_lora_cycle_state()
text_hash = hashlib.sha256(json.dumps(sorted(valid_choices)).encode('utf-8')).hexdigest()[:16]
state_key = f"rand_{unique_id}_{text_hash}"
node_state = state.get(state_key, {})
assigned = node_state.get("assigned", {}) if isinstance(node_state, dict) else {}
if current_pid and current_pid in assigned:
selected_item = assigned[current_pid]
else:
selected_item = random.choice(valid_choices)
if current_pid:
assigned[current_pid] = selected_item
state[state_key] = {"assigned": assigned}
save_lora_cycle_state(state)
loras_to_load = [selected_item]
elif _selection_mode == "Sequential":
state = load_lora_cycle_state()
text_hash = hashlib.sha256(json.dumps(sorted(valid_choices)).encode('utf-8')).hexdigest()[:16]
state_key = f"seq_{unique_id}_{text_hash}"
node_state = state.get(state_key, {})
if isinstance(node_state, dict):
idx = int(node_state.get("index", 0))
assigned = node_state.get("assigned", {})
else:
idx = int(node_state) if isinstance(node_state, int) else 0
assigned = {}
if current_pid and current_pid in assigned:
selected_item = assigned[current_pid]
else:
selected_item = valid_choices[idx % len(valid_choices)]
if current_pid:
assigned[current_pid] = selected_item
state[state_key] = {
"index": idx + 1,
"assigned": assigned
}
save_lora_cycle_state(state)
loras_to_load = [selected_item]
elif _selection_mode == "Random (No Replace)":
state = load_lora_cycle_state()
text_hash = hashlib.sha256(json.dumps(sorted(valid_choices)).encode('utf-8')).hexdigest()[:16]
state_key = f"noreplace_{unique_id}_{text_hash}"
node_state = state.get(state_key, {})
if isinstance(node_state, dict):
pool = node_state.get("pool", [])
assigned = node_state.get("assigned", {})
else:
pool = node_state if isinstance(node_state, list) else []
assigned = {}
if current_pid and current_pid in assigned:
selected_item = assigned[current_pid]
else:
pool = [x for x in pool if x in valid_choices]
if not pool:
import random
pool = list(valid_choices)
random.shuffle(pool)
selected_item = pool.pop(0)
if current_pid:
assigned[current_pid] = selected_item
state[state_key] = {
"pool": pool,
"assigned": assigned
}
save_lora_cycle_state(state)
loras_to_load = [selected_item]
else:
loras_to_load = []
selected_item = select_a_lora(_selection_mode, unique_id, valid_choices, current_pid)
loras_to_load = [selected_item] if selected_item else []
current_model = model
current_clip = clip
loaded_names = []
# Resolve the folder mapping once per run instead of once per selected LoRA.
lora_mapping = get_filtered_loras_mapping(folder, pretty=True)
for item in loras_to_load:
if item == "[ NONE ]" or not item:
@@ -836,8 +1019,7 @@ class VisualLoraLoader(FolderLoraLoaderPretty):
if " - " in item:
display_name = item.split(" - ", 1)[1]
mapping = get_filtered_loras_mapping(folder, pretty=True)
resolved_path = mapping.get(item)
resolved_path = lora_mapping.get(item)
if not resolved_path or resolved_path == "[ NONE ]":
all_loras = folder_paths.get_filename_list("loras")
+217 -87
View File
@@ -1,31 +1,25 @@
import os
import re
import json
import copy
import random
import time
import hashlib
import platform
import subprocess
import threading
from aiohttp import web
from server import PromptServer
import folder_paths
from .utils import get_saturnnodes_user_dir, is_authenticated_local_request
from .utils import get_saturnnodes_user_dir, is_authenticated_local_request, get_env_setting
CURRENT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
USER_DIR = get_saturnnodes_user_dir()
STATE_FILE = os.path.join(USER_DIR, "prompt_iterator_state.json")
ENV_FILE = os.path.join(USER_DIR, ".env")
def get_env_setting(key, default_val):
if os.path.exists(ENV_FILE):
try:
with open(ENV_FILE, "r", encoding="utf-8") as f:
for line in f:
if line.strip().startswith(f"{key}="):
return line.strip().split("=", 1)[1].strip()
except Exception:
pass
return default_val
_STATE_LOCK = threading.RLock()
_STATE_CACHE = None
_STATE_CACHE_MTIME = None
def is_clear_prompt_iterator_on_launch():
val = get_env_setting("CLEAR_PROMPT_ITERATOR_ON_LAUNCH", "false").lower()
@@ -34,45 +28,84 @@ def is_clear_prompt_iterator_on_launch():
def ensure_user_dir():
os.makedirs(USER_DIR, exist_ok=True)
def invalidate_state_cache():
global _STATE_CACHE, _STATE_CACHE_MTIME
with _STATE_LOCK:
_STATE_CACHE = None
_STATE_CACHE_MTIME = None
def load_state():
global _STATE_CACHE, _STATE_CACHE_MTIME
ensure_user_dir()
if os.path.exists(STATE_FILE):
with _STATE_LOCK:
mtime = None
try:
with open(STATE_FILE, "r", encoding="utf-8") as f:
data = json.load(f)
if isinstance(data, dict):
return data
except Exception as e:
print(f"[SaturnNodes] Warning reading prompt iterator state: {e}")
return {}
if os.path.exists(STATE_FILE):
mtime = os.stat(STATE_FILE).st_mtime_ns
except OSError:
mtime = None
if _STATE_CACHE is not None and mtime == _STATE_CACHE_MTIME:
return copy.deepcopy(_STATE_CACHE)
data = {}
if mtime is not None:
try:
with open(STATE_FILE, "r", encoding="utf-8") as f:
loaded = json.load(f)
if isinstance(loaded, dict):
data = loaded
except Exception as e:
print(f"[SaturnNodes] Warning reading prompt iterator state: {e}")
_STATE_CACHE = copy.deepcopy(data)
_STATE_CACHE_MTIME = mtime
return copy.deepcopy(data)
def _entry_timestamp(entry):
if isinstance(entry, dict):
try:
return int(entry.get("last_updated", 0))
except (TypeError, ValueError):
return 0
return 0
def save_state(state):
global _STATE_CACHE, _STATE_CACHE_MTIME
ensure_user_dir()
try:
# Auto-prune abandoned state keys if count exceeds 100 entries
if len(state) > 100:
excess_keys = list(state.keys())[:-100]
for k in excess_keys:
del state[k]
tmp_file = STATE_FILE + ".tmp"
with open(tmp_file, "w", encoding="utf-8") as f:
json.dump(state, f, indent=4, ensure_ascii=False)
os.replace(tmp_file, STATE_FILE)
except Exception as e:
print(f"[SaturnNodes] Error saving prompt iterator state: {e}")
with _STATE_LOCK:
try:
# Global prune: keep the 100 most recently touched node/text entries.
if len(state) > 100:
keep = set(sorted(state.keys(), key=lambda k: _entry_timestamp(state[k]), reverse=True)[:100])
for k in [k for k in state.keys() if k not in keep]:
del state[k]
tmp_file = STATE_FILE + ".tmp"
with open(tmp_file, "w", encoding="utf-8") as f:
json.dump(state, f, indent=4, ensure_ascii=False)
os.replace(tmp_file, STATE_FILE)
_STATE_CACHE = copy.deepcopy(state)
try:
_STATE_CACHE_MTIME = os.stat(STATE_FILE).st_mtime_ns
except OSError:
_STATE_CACHE_MTIME = None
except Exception as e:
print(f"[SaturnNodes] Error saving prompt iterator state: {e}")
def clear_state():
ensure_user_dir()
try:
tmp_file = STATE_FILE + ".tmp"
with open(tmp_file, "w", encoding="utf-8") as f:
json.dump({}, f, indent=4)
os.replace(tmp_file, STATE_FILE)
print("[SaturnNodes] Prompt iterator state cleared.")
return True
except Exception as e:
print(f"[SaturnNodes] Error clearing prompt iterator state: {e}")
return False
with _STATE_LOCK:
try:
tmp_file = STATE_FILE + ".tmp"
with open(tmp_file, "w", encoding="utf-8") as f:
json.dump({}, f, indent=4)
os.replace(tmp_file, STATE_FILE)
invalidate_state_cache()
print("[SaturnNodes] Prompt iterator state cleared.")
return True
except Exception as e:
print(f"[SaturnNodes] Error clearing prompt iterator state: {e}")
return False
# Clear state on startup if privacy setting enabled
if is_clear_prompt_iterator_on_launch():
@@ -90,14 +123,7 @@ try:
data = await request.json()
node_id = str(data.get("node_id", ""))
state = load_state()
matched = False
for k in list(state.keys()):
if node_id == "all" or k.startswith(f"node_{node_id}_") or k == f"node_{node_id}":
if isinstance(state[k], dict):
state[k]["index"] = 0
else:
state[k] = {"index": 0, "total": 0}
matched = True
matched = reset_node_state(state, node_id)
save_state(state)
if node_id and node_id != "all":
progress_payload = {
@@ -185,12 +211,31 @@ def parse_prompt_blocks(text_str, separator, custom_regex=""):
raw_blocks = re.split(r'\n\s*\n+', clean_text)
return [b.strip() for b in raw_blocks if b.strip()]
def reset_node_state(state, node_id):
"""Reset every pointer belonging to a node (or all nodes when node_id == 'all')."""
node_id = str(node_id)
matched = False
for k in list(state.keys()):
if node_id == "all" or k.startswith(f"node_{node_id}_") or k == f"node_{node_id}":
if isinstance(state[k], dict):
state[k]["index"] = 0
state[k]["last_run"] = 0
# A hard reset must not leave stale crash-recovery assignments or
# shuffle permutations behind, otherwise the next retry can jump
# to an old prompt or reuse an outdated cycle order.
state[k]["assigned_prompts"] = {}
state[k]["shuffled_order"] = []
else:
state[k] = {"index": 0, "total": 0}
matched = True
return matched
def get_current_prompt_id():
try:
server = getattr(PromptServer, "instance", None)
if server and hasattr(server, "prompt_queue"):
queue = server.prompt_queue
if hasattr(queue, "currently_running") and queue.currently_running:
if hasattr(queue, "currently_running"):
mutex = getattr(queue, "mutex", None)
if mutex:
with mutex:
@@ -204,6 +249,28 @@ def get_current_prompt_id():
pass
return None
def _remember_assignment(assigned_prompts, prompt_id, index, limit=50):
"""Insert/refresh a crash-recovery mapping, keeping the most recent entries."""
if not prompt_id:
return
assigned_prompts.pop(prompt_id, None)
assigned_prompts[prompt_id] = index
while len(assigned_prompts) > limit:
assigned_prompts.pop(next(iter(assigned_prompts)))
def _sanitize_shuffle_order(raw_order, total_count):
if not isinstance(raw_order, (list, tuple)):
return None
try:
order = [int(v) for v in raw_order]
except (TypeError, ValueError):
return None
if len(order) != total_count or len(set(order)) != total_count:
return None
if any(v < 0 or v >= total_count for v in order):
return None
return order
class PromptQueueIterator:
@classmethod
def INPUT_TYPES(cls):
@@ -225,6 +292,12 @@ class PromptQueueIterator:
},
"optional": {
"custom_regex": ("STRING", {"default": "", "placeholder": "Custom regex delimiter (e.g. \\n---\\n)"}),
# Appended after the existing widgets so old workflow widget
# values keep their original positions.
"track_by": ([
"Text & Node",
"Node Only"
], {"default": "Text & Node"}),
"prompt": ("STRING", {"forceInput": True}),
},
"hidden": {
@@ -232,8 +305,8 @@ class PromptQueueIterator:
}
}
RETURN_TYPES = ("STRING", "STRING", "INT")
RETURN_NAMES = ("prompt", "remaining_text", "remaining_count")
RETURN_TYPES = ("STRING", "STRING", "INT", "BOOLEAN")
RETURN_NAMES = ("prompt", "remaining_text", "remaining_count", "exhausted")
FUNCTION = "process_queue"
CATEGORY = "🪐 SaturnNodes/Utils"
DESCRIPTION = "Deterministically iterates over multiline prompt text blocks per queue run with live progress display and index controls."
@@ -246,6 +319,7 @@ class PromptQueueIterator:
def process_queue(
self,
pop_mode="Sequential (Loop on End)",
track_by="Text & Node",
separator=">1 Empty Line",
text="",
custom_regex="",
@@ -254,20 +328,43 @@ class PromptQueueIterator:
unique_id="default",
**kwargs
):
raw_input = text if text else (prompt if prompt is not None else prompt_text)
# A connected `prompt` input is authoritative. Falling back to the
# local `text` widget used to replay stale characters from a previous
# session even though the linked upstream node produced new prompts.
if prompt is not None:
raw_input = prompt
elif text:
raw_input = text
else:
raw_input = prompt_text
text_str = str(raw_input) if raw_input is not None else ""
if not text_str.strip():
return ("", "", 0)
return ("", "", 0, False)
original_blocks = parse_prompt_blocks(text_str, separator, custom_regex)
total_count = len(original_blocks)
if total_count == 0:
return ("", "", 0)
return ("", "", 0, False)
# Calculate stable hash of the complete input text
# Calculate stable hashes of the complete input text and of the splitting
# configuration. Two nodes sharing text but using different separators must
# never share a run pointer.
text_hash = hashlib.sha256(text_str.strip().encode('utf-8')).hexdigest()[:16]
state_key = f"node_{unique_id}_{text_hash}"
config_signature = json.dumps({
"mode": str(pop_mode),
"separator": str(separator),
"regex": str(custom_regex or ""),
}, sort_keys=True)
config_hash = hashlib.sha256(config_signature.encode('utf-8')).hexdigest()[:12]
track_lower = str(track_by or "").lower()
if "node only" in track_lower:
# Optional legacy-style tracking: one pointer per graph node, shared
# across text edits and splitter changes.
state_key = f"node_{unique_id}"
else:
state_key = f"node_{unique_id}_{config_hash}_{text_hash}"
current_prompt_id = get_current_prompt_id()
# Load state fresh from disk (no stale memory cache)
@@ -276,67 +373,100 @@ class PromptQueueIterator:
current_index = 0
assigned_prompts = {}
shuffled_order = []
if isinstance(node_state, dict):
current_index = int(node_state.get("index", 0))
try:
current_index = max(0, int(node_state.get("index", 0)))
except (TypeError, ValueError):
current_index = 0
raw_assigned = node_state.get("assigned_prompts", {})
if isinstance(raw_assigned, dict):
assigned_prompts = dict(raw_assigned)
sanitized = _sanitize_shuffle_order(node_state.get("shuffled_order", []), total_count)
if sanitized is not None:
shuffled_order = sanitized
elif isinstance(node_state, int):
current_index = node_state
current_index = max(0, node_state)
is_stop_mode = pop_mode == "Sequential (Stop on End)"
is_random_keep = pop_mode in ["Random (Keep)", "Random (Delete)"]
is_random_cycle = pop_mode in ["Random (Cycle)"]
if is_random_cycle and not shuffled_order:
shuffled_order = list(range(total_count))
random.shuffle(shuffled_order)
exhausted = False
remaining_count = 0
remaining_text = ""
# Check if this prompt_id was already assigned an index (e.g. recovered from persistent queue / retry)
if current_prompt_id and current_prompt_id in assigned_prompts:
idx = assigned_prompts[current_prompt_id] % total_count
retry_assignment = current_prompt_id and current_prompt_id in assigned_prompts
if retry_assignment:
try:
idx = int(assigned_prompts[current_prompt_id]) % total_count
except (TypeError, ValueError):
idx = current_index % total_count
selected_prompt = original_blocks[idx]
display_run = idx + 1
next_index = current_index # Keep current index without double-advancing
# Refresh recency so long queues do not evict actively retried prompts.
_remember_assignment(assigned_prompts, current_prompt_id, idx)
else:
# Select prompt based on mode and calculate next index
if pop_mode in ["Sequential (Loop on End)", "Cycle / Loop", "Pop Top & Delete"]:
idx = current_index % total_count
selected_prompt = original_blocks[idx]
next_index = (current_index + 1) % total_count
display_run = idx + 1
elif pop_mode in ["Sequential (Stop on End)"]:
elif is_stop_mode:
if current_index >= total_count:
idx = total_count - 1
selected_prompt = original_blocks[idx]
next_index = total_count
display_run = total_count
else:
idx = current_index
selected_prompt = original_blocks[idx]
next_index = current_index + 1
display_run = idx + 1
elif pop_mode in ["Random (Keep)", "Random (Delete)"]:
elif is_random_keep:
idx = random.randint(0, total_count - 1)
selected_prompt = original_blocks[idx]
next_index = current_index + 1
display_run = (current_index % total_count) + 1
elif pop_mode in ["Random (Cycle)"]:
shuffled_order = list(node_state.get("shuffled_order", [])) if isinstance(node_state, dict) else []
elif is_random_cycle:
cycle_index = current_index % total_count
if len(shuffled_order) != total_count or (cycle_index == 0 and current_index > 0) or not shuffled_order:
if len(shuffled_order) != total_count or (cycle_index == 0 and current_index > 0):
shuffled_order = list(range(total_count))
random.shuffle(shuffled_order)
idx = shuffled_order[cycle_index]
selected_prompt = original_blocks[idx]
next_index = (current_index + 1) % total_count
display_run = cycle_index + 1
else: # Default fallback
idx = current_index % total_count
selected_prompt = original_blocks[idx]
next_index = (current_index + 1) % total_count
display_run = idx + 1
if current_prompt_id:
assigned_prompts[current_prompt_id] = idx
if len(assigned_prompts) > 50:
for old_k in list(assigned_prompts.keys())[:-50]:
del assigned_prompts[old_k]
_remember_assignment(assigned_prompts, current_prompt_id, idx)
# Calculate progress and the real remaining set for every mode.
if is_random_cycle:
try:
cycle_position = shuffled_order.index(idx)
except ValueError:
cycle_position = idx
display_run = cycle_position + 1
remaining_blocks = [original_blocks[i] for i in shuffled_order[cycle_position + 1:]]
remaining_count = len(remaining_blocks)
elif is_random_keep:
# Random (Keep) never consumes prompts and has no deterministic order.
display_run = idx + 1 if retry_assignment else (current_index % total_count) + 1
remaining_blocks = []
remaining_count = 0
else:
display_run = idx + 1
remaining_blocks = original_blocks[idx + 1:]
remaining_count = len(remaining_blocks)
if is_stop_mode and remaining_count == 0:
exhausted = True
# Calculate remaining items
remaining_count = max(0, total_count - display_run)
sep_lower = str(separator).lower() if separator else ""
if "newline" in sep_lower:
join_delim = "\n"
@@ -349,7 +479,7 @@ class PromptQueueIterator:
join_delim = "\n\n"
else:
join_delim = "\n\n"
remaining_text = join_delim.join(original_blocks[display_run:]) if display_run < total_count else ""
remaining_text = join_delim.join(remaining_blocks)
# Update state dictionary
new_entry = {
@@ -360,15 +490,15 @@ class PromptQueueIterator:
"preview": selected_prompt[:60].replace('\n', ' '),
"assigned_prompts": assigned_prompts
}
if "shuffled_order" in locals():
if is_random_cycle:
new_entry["shuffled_order"] = shuffled_order
state[state_key] = new_entry
# Keep at most 3 most recent text hashes per node_id
# Keep at most 3 most recent text hashes/configs per node_id
node_prefix = f"node_{unique_id}_"
node_keys = [k for k in state.keys() if k.startswith(node_prefix)]
if len(node_keys) > 3:
node_keys.sort(key=lambda k: state[k].get("last_updated", 0) if isinstance(state[k], dict) else 0)
node_keys.sort(key=lambda k: _entry_timestamp(state[k]))
for old_k in node_keys[:-3]:
del state[old_k]
@@ -386,4 +516,4 @@ class PromptQueueIterator:
except Exception:
pass
return (selected_prompt, remaining_text, remaining_count)
return (selected_prompt, remaining_text, remaining_count, exhausted)
+402 -73
View File
@@ -4,30 +4,25 @@ import secrets
import time
import threading
import asyncio
import atexit
from aiohttp import web
from server import PromptServer
import nodes
from .tray_icon import TrayIconManager, is_tray_icon_enabled
from .assets_restore import assets_restore_manager, is_assets_restore_enabled, get_assets_restore_count
from .utils import get_saturnnodes_user_dir, is_local_request, is_authenticated_local_request
from .generation_times import patch_prompt_queue as patch_generation_times
from .utils import get_saturnnodes_user_dir, is_local_request, is_authenticated_local_request, get_env_setting
QUEUE_CATEGORY = "🪐 SaturnNodes/Queue"
CURRENT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
USER_DIR = get_saturnnodes_user_dir()
PERSISTENT_FILE = os.path.join(USER_DIR, "persistent_queue.json")
ENV_FILE = os.path.join(USER_DIR, ".env")
def get_env_setting(key, default_val):
if os.path.exists(ENV_FILE):
try:
with open(ENV_FILE, "r", encoding="utf-8") as f:
for line in f:
if line.strip().startswith(f"{key}="):
return line.strip().split("=", 1)[1].strip()
except Exception:
pass
return default_val
# Versioned envelope for persistent_queue.json. Bump this when the persisted
# entry shape changes and add a migration branch in
# PersistentQueueManager._normalize_persisted_payload().
PERSISTENT_QUEUE_SCHEMA_VERSION = 1
def is_persistent_queue_enabled():
val = get_env_setting("ENABLE_PERSISTENT_QUEUE", "true").lower()
@@ -41,9 +36,25 @@ class PauseQueueManager:
def __init__(self):
default_state = get_env_setting("DEFAULT_PAUSE_STATE", "Running")
default_mode = get_env_setting("DEFAULT_PAUSE_MODE", "after_finish")
self.paused = (default_state.lower() != "running")
self.mode = "instantly" if "instant" in default_mode.lower() else "after_finish"
self.persist_state = get_env_setting("PERSIST_PAUSE_STATE", "false").lower() in ["true", "1", "yes"]
self.state_file = os.path.join(USER_DIR, "pause_state.json")
paused = (default_state.lower() != "running")
mode = "instantly" if "instant" in default_mode.lower() else "after_finish"
if self.persist_state and os.path.exists(self.state_file):
try:
with open(self.state_file, "r", encoding="utf-8") as f:
saved = json.load(f)
if isinstance(saved, dict):
paused = bool(saved.get("paused", paused))
saved_mode = str(saved.get("mode", mode))
mode = "instantly" if "instant" in saved_mode.lower() else "after_finish"
except Exception:
pass
self.paused = paused
self.mode = mode
self.is_waiting = self.paused
self.event = threading.Event()
if not self.paused:
@@ -52,6 +63,18 @@ class PauseQueueManager:
self.event.clear()
self._patched = False
def _persist_pause_state(self):
if not self.persist_state:
return
try:
os.makedirs(USER_DIR, exist_ok=True)
temp_file = self.state_file + ".tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump({"paused": bool(self.paused), "mode": self.mode}, f)
os.replace(temp_file, self.state_file)
except Exception:
pass
def patch_all(self):
if self._patched:
return
@@ -68,6 +91,8 @@ class PauseQueueManager:
original_get = queue.get
def patched_get(*args, **kwargs):
caller_timeout = args[0] if args else kwargs.get("timeout", None)
caller_blocks = caller_timeout is None
while True:
# 1. If queue is paused, wait BEFORE popping any item from the queue!
# This guarantees that ComfyUI never sets currently_running, never sends
@@ -99,6 +124,14 @@ class PauseQueueManager:
if item is not None:
return item
# Honor a finite caller timeout. Returning None lets ComfyUI's main
# loop run its scheduled GC pass and avoids a busy spin when a
# timeout of 0.0 is requested.
if self.paused:
continue
if not caller_blocks:
return None
queue.get = patched_get
if hasattr(server, "send_sync") and callable(server.send_sync):
@@ -120,6 +153,7 @@ class PauseQueueManager:
self.paused = False
self.is_waiting = False
self.event.set()
self._persist_pause_state()
self.notify_clients()
if hasattr(mm, "throw_exception_if_processing_interrupted"):
mm.throw_exception_if_processing_interrupted()
@@ -178,6 +212,7 @@ class PauseQueueManager:
print("[SaturnNodes PauseQueue] Continue pressed: Resuming execution.")
self.notify_clients()
self._persist_pause_state()
try:
server = getattr(PromptServer, "instance", None)
@@ -205,6 +240,7 @@ class PauseQueueManager:
def set_mode(self, mode):
self.mode = mode
print(f"[SaturnNodes PauseQueue] Selected pause mode: '{self.mode}'")
self._persist_pause_state()
self.notify_clients()
def notify_clients(self):
@@ -224,61 +260,254 @@ class PauseQueueManager:
pass
class PersistentQueueManager:
MAX_BATCH_META = 500
MAX_RECENTLY_FINISHED = 500
SAVE_DEBOUNCE_SECONDS = 0.25
def __init__(self):
self.lock = threading.RLock()
self.persistent_items = []
self.batch_meta = {}
self.batch_meta_updated = {}
self.recently_finished = {}
self.is_restoring = False
self._patched = False
self.has_claimed_once = False
self._save_timer = None
self._save_dirty = False
# Set when persistent_queue.json was written by a newer SaturnNodes.
# In that case the file is read-only for this process so a downgrade
# cannot destroy a queue whose entry shape we do not understand.
self._read_only_newer_schema = False
self.load_from_file()
@staticmethod
def _normalize_entry(raw):
"""Return one repaired persistence entry, or ``None`` if unusable.
The top-level ``prompt_id`` is authoritative because it is the
persistence key used by add/remove. The queued item is only a fallback
for legacy or hand-edited entries that lack it. The restore path
re-syncs ``item[1]`` before queueing so task completion removes the
matching persistence entry.
"""
if not isinstance(raw, dict):
return None
item = raw.get("item")
if not isinstance(item, (list, tuple)) or len(item) < 2:
return None
item_list = list(item)
item_pid = item_list[1]
entry_pid = raw.get("prompt_id")
# The top-level prompt_id is the persistence key. Fall back to the
# queued item only for legacy/hand-edited entries that lack it. The
# restore path re-syncs item[1] before queueing so task_done can always
# find and remove the matching persistence entry.
if entry_pid is None or entry_pid == "":
if item_pid is None or item_pid == "":
return None
entry_pid = str(item_pid)
else:
entry_pid = str(entry_pid)
entry = dict(raw)
entry["prompt_id"] = entry_pid
entry["item"] = item_list
return entry
@classmethod
def _normalize_items(cls, items):
"""Repair entries and drop duplicate prompt ids, keeping the last one."""
normalized = {}
changed = False
for raw in items:
entry = cls._normalize_entry(raw)
if entry is None:
changed = True
continue
pid = entry["prompt_id"]
if pid in normalized:
# add_item() replaces the old entry and appends the new one;
# mirror that "last occurrence wins" rule on load.
normalized.pop(pid, None)
changed = True
normalized[pid] = entry
if entry != raw:
changed = True
return list(normalized.values()), changed
@classmethod
def _normalize_persisted_payload(cls, data):
"""Return ``(items, needs_rewrite, is_foreign)`` for persisted payloads.
- v1 files (pre-2.6.2) are a bare list and are migrated on load.
- Current files are ``{"schema_version": 1, "items": [...]}``.
- A file written by a newer SaturnNodes is reported as foreign so the
caller can keep it read-only instead of destroying a queue it cannot
understand.
"""
if isinstance(data, dict):
version = data.get("schema_version")
items = data.get("items")
if not isinstance(items, list):
return [], False, False
if isinstance(version, int) and version > PERSISTENT_QUEUE_SCHEMA_VERSION:
print(
"[SaturnNodes PersistentQueue] persistent_queue.json was written by a newer "
f"SaturnNodes (schema {version} > {PERSISTENT_QUEUE_SCHEMA_VERSION}); "
"leaving it untouched."
)
return [], False, True
normalized, changed = cls._normalize_items(items)
return (
normalized,
version != PERSISTENT_QUEUE_SCHEMA_VERSION or changed,
False,
)
if isinstance(data, list):
# Legacy bare-list format.
normalized, _ = cls._normalize_items(data)
return normalized, True, False
return [], False, False
def load_from_file(self):
with self.lock:
if os.path.exists(PERSISTENT_FILE):
try:
with open(PERSISTENT_FILE, "r", encoding="utf-8") as f:
data = json.load(f)
if isinstance(data, list):
self.persistent_items = [
x for x in data
if isinstance(x, dict) and "prompt_id" in x and isinstance(x.get("item"), (list, tuple))
]
for x in self.persistent_items:
if "batch_info" in x and "prompt_id" in x:
self.batch_meta[str(x["prompt_id"])] = x["batch_info"]
else:
self.persistent_items = []
except Exception as e:
print(f"[SaturnNodes PersistentQueue] Error loading persistent queue file: {e}")
self.persistent_items = []
else:
self._read_only_newer_schema = False
self.batch_meta = {}
self.batch_meta_updated = {}
if not os.path.exists(PERSISTENT_FILE):
self.persistent_items = []
self._prune_batch_meta_locked()
return
try:
with open(PERSISTENT_FILE, "r", encoding="utf-8") as f:
data = json.load(f)
items, needs_rewrite, is_foreign = self._normalize_persisted_payload(data)
self._read_only_newer_schema = is_foreign
self.persistent_items = items
for x in self.persistent_items:
batch_info = x.get("batch_info")
if isinstance(batch_info, dict) and "prompt_id" in x:
pid = str(x["prompt_id"])
self.batch_meta[pid] = batch_info
self.batch_meta_updated[pid] = time.time()
if needs_rewrite:
# Rewrite once so the legacy bare-list shape is not read
# forever. _write_locked() is a no-op while persistence is
# disabled, in which case the migration is retried later.
self._save_dirty = True
self._write_locked()
except Exception as e:
print(f"[SaturnNodes PersistentQueue] Error loading persistent queue file: {e}")
self.persistent_items = []
self._prune_batch_meta_locked()
def _prune_batch_meta_locked(self):
if len(self.batch_meta) <= self.MAX_BATCH_META:
return
active_ids = {str(x.get("prompt_id")) for x in self.persistent_items}
removable = sorted(
(pid for pid in self.batch_meta if pid not in active_ids),
key=lambda pid: self.batch_meta_updated.get(pid, 0),
)
for pid in removable:
if len(self.batch_meta) <= self.MAX_BATCH_META:
break
self.batch_meta.pop(pid, None)
self.batch_meta_updated.pop(pid, None)
def _mark_finished_locked(self, pid_str):
self.recently_finished.pop(pid_str, None)
self.recently_finished[pid_str] = time.time()
while len(self.recently_finished) > self.MAX_RECENTLY_FINISHED:
self.recently_finished.pop(next(iter(self.recently_finished)))
def set_batch_info(self, prompt_id, batch_info):
if not prompt_id:
if prompt_id is None or prompt_id == "" or not isinstance(batch_info, dict):
return
pid_str = str(prompt_id)
with self.lock:
# Late syncs from another client must not resurrect metadata for a
# prompt that already finished (the id is single-use).
if pid_str in self.recently_finished:
return
self.batch_meta[pid_str] = batch_info
self.batch_meta_updated[pid_str] = time.time()
for item in self.persistent_items:
if str(item.get("prompt_id")) == pid_str:
item["batch_info"] = batch_info
break
self._prune_batch_meta_locked()
if is_persistent_queue_enabled():
self.save_to_file()
def save_to_file(self):
def save_to_file(self, immediate=False):
if not is_persistent_queue_enabled():
return
with self.lock:
try:
temp_file = PERSISTENT_FILE + ".tmp"
with open(temp_file, "w", encoding="utf-8") as f:
json.dump(self.persistent_items, f, indent=2, default=str)
os.replace(temp_file, PERSISTENT_FILE)
except Exception as e:
print(f"[SaturnNodes PersistentQueue] Error saving persistent queue file: {e}")
self._save_dirty = True
if immediate:
self._write_locked()
else:
self._schedule_save_locked()
def _schedule_save_locked(self):
if self._save_timer is not None and self._save_timer.is_alive():
return
self._save_timer = threading.Timer(self.SAVE_DEBOUNCE_SECONDS, self._flush_timer)
self._save_timer.daemon = True
self._save_timer.start()
def _flush_timer(self):
with self.lock:
self._write_locked()
def _write_locked(self):
if not self._save_dirty:
return
if self._read_only_newer_schema:
# Never overwrite a queue file produced by a newer SaturnNodes.
self._save_dirty = False
return
if not is_persistent_queue_enabled():
self._save_dirty = False
return
try:
os.makedirs(USER_DIR, exist_ok=True)
temp_file = PERSISTENT_FILE + ".tmp"
payload = {
"schema_version": PERSISTENT_QUEUE_SCHEMA_VERSION,
"items": self.persistent_items,
}
with open(temp_file, "w", encoding="utf-8") as f:
json.dump(payload, f, separators=(",", ":"), default=str)
f.flush()
try:
os.fsync(f.fileno())
except OSError:
pass
# Windows can transiently lock the destination (antivirus, indexer,
# backup). Retry briefly instead of dropping the save.
for attempt in range(3):
try:
os.replace(temp_file, PERSISTENT_FILE)
break
except PermissionError:
if attempt == 2:
raise
time.sleep(0.05)
self._save_dirty = False
except Exception as e:
print(f"[SaturnNodes PersistentQueue] Error saving persistent queue file: {e}")
def flush(self):
"""Force any pending debounced write (used on shutdown)."""
with self.lock:
self._write_locked()
def add_item(self, item_tuple):
if self.is_restoring or not is_persistent_queue_enabled():
@@ -287,7 +516,7 @@ class PersistentQueueManager:
if isinstance(item_tuple, (tuple, list)):
item_list = list(item_tuple)
prompt_id = item_list[1] if len(item_list) > 1 else None
if not prompt_id:
if prompt_id is None or prompt_id == "":
return
pid_str = str(prompt_id)
entry = {
@@ -297,21 +526,30 @@ class PersistentQueueManager:
if pid_str in self.batch_meta:
entry["batch_info"] = self.batch_meta[pid_str]
with self.lock:
self.recently_finished.pop(pid_str, None)
self.persistent_items = [x for x in self.persistent_items if str(x.get("prompt_id")) != pid_str]
self.persistent_items.append(entry)
self.save_to_file()
print(f"[SaturnNodes PersistentQueue] Persisted prompt {pid_str} to disk.")
if self._read_only_newer_schema:
print(
f"[SaturnNodes PersistentQueue] Queue file uses a newer schema; "
f"prompt {pid_str} kept in memory only."
)
else:
print(f"[SaturnNodes PersistentQueue] Persisted prompt {pid_str} to disk.")
except Exception as e:
print(f"[SaturnNodes PersistentQueue] Error formatting queue item for persistence: {e}")
def remove_item(self, prompt_id):
if not prompt_id:
if prompt_id is None or prompt_id == "":
return
pid_str = str(prompt_id)
with self.lock:
initial_count = len(self.persistent_items)
self.persistent_items = [x for x in self.persistent_items if str(x.get("prompt_id")) != pid_str]
self.batch_meta.pop(pid_str, None)
self.batch_meta_updated.pop(pid_str, None)
self._mark_finished_locked(pid_str)
changed = len(self.persistent_items) != initial_count
if changed and is_persistent_queue_enabled():
self.save_to_file()
@@ -321,8 +559,9 @@ class PersistentQueueManager:
with self.lock:
self.persistent_items = []
self.batch_meta = {}
self.batch_meta_updated = {}
if is_persistent_queue_enabled():
self.save_to_file()
self.save_to_file(immediate=True)
print("[SaturnNodes PersistentQueue] Cleared all saved queue items.")
def patch_server(self):
@@ -374,22 +613,28 @@ class PersistentQueueManager:
if hasattr(queue, "delete_queue_item"):
original_delete = queue.delete_queue_item
def patched_delete(fn, *args, **kwargs):
to_delete = []
try:
with queue.mutex:
to_delete = [item[1] for item in queue.queue if fn(item) and len(item) > 1]
for pid in to_delete:
self.remove_item(pid)
except Exception:
pass
return original_delete(fn, *args, **kwargs)
to_delete = []
res = original_delete(fn, *args, **kwargs)
# Only forget persistence after the in-memory delete succeeded;
# otherwise a failed cancel would silently lose crash recovery.
for pid in to_delete:
self.remove_item(pid)
return res
queue.delete_queue_item = patched_delete
# 4. Patch queue.wipe_queue
if hasattr(queue, "wipe_queue"):
original_wipe = queue.wipe_queue
def patched_wipe(*args, **kwargs):
res = original_wipe(*args, **kwargs)
# Clear persistence only after ComfyUI accepted the wipe.
self.wipe_all()
return original_wipe(*args, **kwargs)
return res
queue.wipe_queue = patched_wipe
# 5. Redundant websocket event hooks
@@ -424,46 +669,116 @@ class PersistentQueueManager:
self.has_claimed_once = True
return
restored_state_setting = get_env_setting("PERSISTENT_QUEUE_RESTORED_STATE", "Match Default")
if restored_state_setting == "Force Paused":
restored_state_setting = str(
get_env_setting("PERSISTENT_QUEUE_RESTORED_STATE", "Match Default")
).strip().lower()
if restored_state_setting == "force paused":
pause_manager.set_pause(True)
elif restored_state_setting == "Force Running":
elif restored_state_setting == "force running":
pause_manager.set_pause(False)
print(f"[SaturnNodes PersistentQueue] Restoring {len(self.persistent_items)} saved queue item(s) to client '{active_client_id}'...")
# Repair duplicates/mismatched prompt ids before restoring. A
# hand-edited file must never queue the same prompt twice or leave an
# entry that task_done cannot remove.
with self.lock:
normalized, repaired = self._normalize_items(list(self.persistent_items))
if repaired:
self.persistent_items = normalized
self._save_dirty = True
if repaired:
self.save_to_file(immediate=True)
snapshot = list(self.persistent_items)
if not snapshot:
self.has_claimed_once = True
return
print(f"[SaturnNodes PersistentQueue] Restoring {len(snapshot)} saved queue item(s) to client '{active_client_id}'...")
try:
max_retries = int(get_env_setting("PERSISTENT_QUEUE_MAX_RETRIES", "0"))
except (TypeError, ValueError, OverflowError):
max_retries = 0
max_retries = max(0, min(10, max_retries))
self.is_restoring = True
max_number = 0
restored_count = 0
state_changed = repaired
# Restored jobs all used to receive the exact same create_time, which
# left their history order dependent on dict iteration. Keep them
# strictly increasing and just before "now" so newly queued prompts
# still sort after every restored one.
create_time_cursor = int(time.time() * 1000) - len(snapshot)
try:
history = server.prompt_queue.get_history() if hasattr(server.prompt_queue, "get_history") else {}
for entry in list(self.persistent_items):
try:
history = server.prompt_queue.get_history() if hasattr(server.prompt_queue, "get_history") else {}
except Exception as e:
print(f"[SaturnNodes PersistentQueue] Could not read history before restore: {e}")
history = {}
if not isinstance(history, dict):
history = {}
for entry in snapshot:
if not isinstance(entry, dict):
continue
item_list = entry.get("item")
if not isinstance(item_list, (list, tuple)):
continue
item_list = list(item_list)
pid = entry.get("prompt_id")
if pid is None or pid == "":
pid = item_list[1] if len(item_list) > 1 else None
pid_str = str(pid) if pid is not None and pid != "" else ""
try:
pid = entry.get("prompt_id")
# If this prompt is already in history, it finished previously - drop it
if pid and pid in history:
self.remove_item(pid)
if pid_str and pid_str in history:
self.remove_item(pid_str)
state_changed = True
continue
item_list = list(entry.get("item", []))
if len(item_list) < 3 or not item_list[1] or not isinstance(item_list[2], dict):
if len(item_list) < 3 or not pid_str or not isinstance(item_list[2], dict):
# Malformed entry, drop from disk
if pid:
self.remove_item(pid)
if pid_str:
self.remove_item(pid_str)
state_changed = True
continue
# Keep the queued item and the persistence key in lockstep.
if item_list[1] != pid_str:
item_list[1] = pid_str
entry["item"] = item_list
state_changed = True
if len(item_list) > 3 and isinstance(item_list[3], dict):
if active_client_id:
item_list[3]["client_id"] = active_client_id
# Update create_time to current timestamp so resumed jobs sort as newest in history & assets
item_list[3]["create_time"] = int(time.time() * 1000)
# Update create_time so resumed jobs sort as newest in
# history & assets, while preserving their queue order.
create_time_cursor += 1
item_list[3]["create_time"] = create_time_cursor
if isinstance(item_list[0], (int, float)):
max_number = max(max_number, int(item_list[0]))
server.prompt_queue.put(tuple(item_list))
if entry.get("retries", 0) != 0:
entry["retries"] = 0
state_changed = True
restored_count += 1
except Exception as e:
print(f"[SaturnNodes PersistentQueue] Error restoring prompt {entry.get('prompt_id')}: {e}")
try:
retries = int(entry.get("retries", 0)) + 1
except (TypeError, ValueError, OverflowError):
retries = 1
if retries > max_retries:
print(f"[SaturnNodes PersistentQueue] Error restoring prompt {pid_str}: {e}. Dropping after {retries} attempt(s).")
if pid_str:
self.remove_item(pid_str)
else:
print(f"[SaturnNodes PersistentQueue] Error restoring prompt {pid_str}: {e}. Retry {retries}/{max_retries} on next launch.")
entry["retries"] = retries
state_changed = True
self.save_to_file(immediate=True)
finally:
self.is_restoring = False
self.has_claimed_once = True
@@ -476,10 +791,13 @@ class PersistentQueueManager:
if active_client_id:
with self.lock:
for entry in self.persistent_items:
if isinstance(entry.get("item"), list) and len(entry["item"]) > 3:
if isinstance(entry["item"][3], dict):
entry["item"][3]["client_id"] = active_client_id
self.save_to_file()
item = entry.get("item") if isinstance(entry, dict) else None
if isinstance(item, (list, tuple)) and len(item) > 3:
if isinstance(item[3], dict):
item[3]["client_id"] = active_client_id
state_changed = True
if state_changed:
self.save_to_file(immediate=True)
# Broadcast updated queue state to client UI
try:
@@ -670,12 +988,14 @@ def _consume_power_ticket(ticket, expected_action=None):
pause_manager = PauseQueueManager()
persistent_manager = PersistentQueueManager()
persistent_queue_manager = persistent_manager
atexit.register(persistent_manager.flush)
tray_manager = TrayIconManager(pause_manager)
power_manager = PowerControlManager(pause_manager)
def setup_queue_control_routes(server):
pause_manager.patch_all()
persistent_manager.patch_server()
patch_generation_times(server)
power_manager.start_watcher()
if is_tray_icon_enabled():
@@ -805,8 +1125,17 @@ def setup_queue_control_routes(server):
except Exception:
data = {}
limit = data.get("limit")
if limit is not None:
try:
limit = max(1, min(1000, int(limit)))
except (TypeError, ValueError):
limit = None
force = bool(data.get("force", False))
count = assets_restore_manager.restore_on_launch(server, limit=limit, force=force)
# Scanning the output tree and parsing metadata is blocking disk I/O;
# keep the aiohttp event loop responsive for the Restore Now button.
count = await asyncio.to_thread(
assets_restore_manager.restore_on_launch, server, limit=limit, force=force
)
return web.json_response({"success": True, "restored": count, "debug": assets_restore_manager.last_debug_report})
@routes.get("/saturnnodes/assets/debug")
@@ -829,7 +1158,7 @@ def setup_queue_control_routes(server):
data = await request.json()
pid = data.get("prompt_id")
info = data.get("batch_info")
if pid and info:
if pid and isinstance(info, dict):
persistent_manager.set_batch_info(pid, info)
return web.json_response({"success": True})
except Exception as e:
+1 -12
View File
@@ -3,22 +3,11 @@ import sys
import threading
import webbrowser
from PIL import Image, ImageDraw
from .utils import get_saturnnodes_user_dir
from .utils import get_saturnnodes_user_dir, get_env_setting
USER_DIR = get_saturnnodes_user_dir()
ENV_FILE = os.path.join(USER_DIR, ".env")
def get_env_setting(key, default_val):
if os.path.exists(ENV_FILE):
try:
with open(ENV_FILE, "r", encoding="utf-8") as f:
for line in f:
if line.strip().startswith(f"{key}="):
return line.strip().split("=", 1)[1].strip()
except Exception:
pass
return default_val
def is_tray_icon_enabled():
val = get_env_setting("ENABLE_TRAY_ICON", "false").lower()
if val not in ["true", "1", "yes"]:
+40 -9
View File
@@ -1,6 +1,7 @@
import os
import re
import secrets
import threading
from urllib.parse import urlparse
import folder_paths
@@ -216,21 +217,51 @@ def sanitize_image_loader_folder(folder_input, default_to_output=True):
return default_dir
_ENV_CACHE_LOCK = threading.RLock()
_ENV_CACHE = None
_ENV_CACHE_MTIME = None
def invalidate_env_settings_cache():
"""Force the next get_env_setting() call to re-read the .env file."""
global _ENV_CACHE, _ENV_CACHE_MTIME
with _ENV_CACHE_LOCK:
_ENV_CACHE = None
_ENV_CACHE_MTIME = None
def get_env_setting(key, default_val):
"""
Reads a key setting from ComfyUI/user/default/SaturnNodes/.env safely.
Parsed values are cached until the file mtime changes.
"""
global _ENV_CACHE, _ENV_CACHE_MTIME
user_dir = get_saturnnodes_user_dir()
env_file = os.path.join(user_dir, ".env")
if os.path.exists(env_file):
try:
with open(env_file, "r", encoding="utf-8") as f:
for line in f:
if line.strip().startswith(f"{key}="):
return line.strip().split("=", 1)[1].strip()
except Exception:
pass
return default_val
mtime = None
try:
if os.path.exists(env_file):
mtime = os.stat(env_file).st_mtime_ns
except OSError:
mtime = None
with _ENV_CACHE_LOCK:
if _ENV_CACHE is None or mtime != _ENV_CACHE_MTIME:
parsed = {}
if mtime is not None:
try:
with open(env_file, "r", encoding="utf-8") as f:
for line in f:
stripped = line.strip()
if not stripped or stripped.startswith("#") or "=" not in stripped:
continue
k, v = stripped.split("=", 1)
parsed[k.strip()] = v.strip()
except Exception:
parsed = {}
_ENV_CACHE = parsed
_ENV_CACHE_MTIME = mtime
return _ENV_CACHE.get(key, default_val)
def parse_pretty_name(filepath):
if not filepath or filepath in ["[ NONE ]", "[ RANDOM ]"]:
+2 -2
View File
@@ -1,7 +1,7 @@
[project]
name = "saturnnodes"
description = "Essential workflow controls, mid-generation pausing, real-time queue persistence, folder watcher, and visual model loaders for ComfyUI."
version = "2.6.1"
version = "2.6.3"
readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.10"
@@ -21,7 +21,7 @@ Repository = "https://github.com/KOFiblto/ComfyUI-SaturnNodes"
Documentation = "https://github.com/KOFiblto/ComfyUI-SaturnNodes#readme"
[tool.comfy]
PublisherId = "KOFiblto"
PublisherId = "kofiblto"
DisplayName = "ComfyUI-SaturnNodes"
Icon = "https://raw.githubusercontent.com/KOFiblto/ComfyUI-SaturnNodes/main/web/logo.png"
requires-comfyui = ">=0.3.0"
+539
View File
@@ -0,0 +1,539 @@
// Minimal DOM used by the standalone frontend regression tests.
// It implements only the APIs the SaturnNodes extensions touch.
function splitTopLevel(selector, delimiter = ",") {
const parts = [];
let depth = 0;
let quote = null;
let current = "";
for (const ch of String(selector)) {
if (quote) {
current += ch;
if (ch === quote) quote = null;
continue;
}
if (ch === '"' || ch === "'") {
quote = ch;
current += ch;
continue;
}
if (ch === "[" || ch === "(") depth++;
if (ch === "]" || ch === ")") depth--;
if (ch === delimiter && depth === 0) {
parts.push(current.trim());
current = "";
continue;
}
current += ch;
}
if (current.trim()) parts.push(current.trim());
return parts.filter(Boolean);
}
function parseAttributeTest(raw) {
const match = raw.match(
/^\[\s*([\w-]+)\s*(?:([*^$~|]?=)\s*(?:"([^"]*)"|'([^']*)'|([^\]\s]+))\s*)?(?:([iIsS]))?\s*\]$/
);
if (!match) return null;
return {
name: match[1],
operator: match[2] || null,
value: match[3] ?? match[4] ?? match[5] ?? "",
insensitive: (match[6] || "").toLowerCase() === "i",
};
}
function matchAttribute(el, test) {
if (!el.hasAttribute(test.name)) return false;
if (!test.operator) return true;
let actual = String(el.getAttribute(test.name));
let expected = test.value;
if (test.insensitive) {
actual = actual.toLowerCase();
expected = expected.toLowerCase();
}
switch (test.operator) {
case "=": return actual === expected;
case "*=": return actual.includes(expected);
case "^=": return actual.startsWith(expected);
case "$=": return actual.endsWith(expected);
case "~=": return actual.split(/\s+/).includes(expected);
case "|=": return actual === expected || actual.startsWith(`${expected}-`);
default: return false;
}
}
function matchCompound(el, compound) {
if (!el || el.nodeType !== 1) return false;
let rest = compound.trim();
if (!rest) return false;
const tagMatch = rest.match(/^([a-zA-Z][\w-]*|\*)/);
if (tagMatch) {
const tag = tagMatch[1];
if (tag !== "*" && el.tagName !== tag.toUpperCase()) return false;
rest = rest.slice(tag.length);
}
while (rest.length) {
if (rest.startsWith("#")) {
const m = rest.match(/^#([\w-]+)/);
if (!m) return false;
if (el.id !== m[1]) return false;
rest = rest.slice(m[0].length);
continue;
}
if (rest.startsWith(".")) {
const m = rest.match(/^\.([\w-]+)/);
if (!m) return false;
if (!el.classList.contains(m[1])) return false;
rest = rest.slice(m[0].length);
continue;
}
if (rest.startsWith("[")) {
let depth = 0;
let end = -1;
for (let i = 0; i < rest.length; i++) {
if (rest[i] === "[") depth++;
if (rest[i] === "]") {
depth--;
if (depth === 0) { end = i; break; }
}
}
if (end < 0) return false;
const test = parseAttributeTest(rest.slice(0, end + 1));
if (!test || !matchAttribute(el, test)) return false;
rest = rest.slice(end + 1);
continue;
}
if (rest.startsWith(":")) {
const m = rest.match(/^:([\w-]+)(?:\([^)]*\))?/);
if (!m) return false;
// :hover / :focus are never true in these tests. Other pseudos are
// treated as non-restrictive so simple selectors still work.
if (m[1] === "hover" || m[1] === "focus" || m[1] === "focus-visible") return false;
rest = rest.slice(m[0].length);
continue;
}
// Unsupported combinator (e.g. ">") - stop rather than mis-match.
break;
}
return true;
}
function matchChain(el, tokens, index) {
if (!matchCompound(el, tokens[index])) return false;
if (index === 0) return true;
let ancestor = el.parentElement;
while (ancestor) {
if (matchChain(ancestor, tokens, index - 1)) return true;
ancestor = ancestor.parentElement;
}
return false;
}
export function matchesSelector(el, selector) {
if (!el || el.nodeType !== 1) return false;
return splitTopLevel(selector).some(part => {
const tokens = part.trim().split(/\s+/).filter(Boolean);
if (!tokens.length) return false;
return matchChain(el, tokens, tokens.length - 1);
});
}
function makeStyle() {
const props = new Map();
const style = {
setProperty(name, value) {
props.set(String(name), String(value));
const camel = String(name).replace(/-([a-z])/g, (_, c) => c.toUpperCase());
style[camel] = String(value);
},
removeProperty(name) {
props.delete(String(name));
const camel = String(name).replace(/-([a-z])/g, (_, c) => c.toUpperCase());
delete style[camel];
},
getPropertyValue(name) {
return props.get(String(name)) || "";
},
cssText: "",
};
return style;
}
export class FakeElement {
constructor(tagName, doc = null) {
this.tagName = String(tagName || "div").toUpperCase();
this.nodeType = 1;
this.ownerDocument = doc;
this.attributes = new Map();
this.children = [];
this.parentNode = null;
this._classes = new Set();
this._listeners = new Map();
this._rect = { left: 0, top: 0, right: 0, bottom: 0, width: 0, height: 0 };
this._isRoot = false;
this._innerHTML = "";
this._text = "";
this.dataset = {};
this.style = makeStyle();
this.id = "";
this.value = "";
this.offsetParent = null;
this.offsetHeight = 0;
this.offsetWidth = 0;
this.scrollTop = 0;
this.scrollHeight = 0;
this.clientHeight = 0;
this.disabled = false;
this.type = "";
this.title = "";
this.src = "";
this.checked = false;
}
get className() {
return Array.from(this._classes).join(" ");
}
set className(value) {
this._classes = new Set(String(value || "").split(/\s+/).filter(Boolean));
}
get classList() {
const el = this;
return {
add(...names) { names.forEach(n => n && el._classes.add(String(n))); },
remove(...names) { names.forEach(n => el._classes.delete(String(n))); },
contains(name) { return el._classes.has(String(name)); },
toggle(name, force) {
const has = el._classes.has(String(name));
const next = force === undefined ? !has : !!force;
if (next) el._classes.add(String(name));
else el._classes.delete(String(name));
return next;
},
};
}
get isConnected() {
let node = this;
while (node) {
if (node._isRoot) return true;
node = node.parentNode;
}
return false;
}
get parentElement() {
return this.parentNode && this.parentNode.nodeType === 1 ? this.parentNode : null;
}
get innerHTML() {
return this._innerHTML;
}
set innerHTML(value) {
this._innerHTML = String(value ?? "");
this.children.forEach(child => { child.parentNode = null; });
this.children = [];
}
get textContent() {
return this._text;
}
set textContent(value) {
this._text = String(value ?? "");
}
getBoundingClientRect() {
return { ...this._rect };
}
setRect(rect) {
this._rect = { ...this._rect, ...rect };
this.offsetHeight = this._rect.height;
this.offsetWidth = this._rect.width;
return this;
}
setAttribute(name, value) {
const key = String(name);
const stringValue = String(value);
this.attributes.set(key, stringValue);
if (key === "id") this.id = stringValue;
if (key === "class") this.className = stringValue;
if (key === "value") this.value = stringValue;
if (key === "src") this.src = stringValue;
if (key.startsWith("data-")) {
const camel = key.slice(5).replace(/-([a-z])/g, (_, c) => c.toUpperCase());
this.dataset[camel] = stringValue;
}
}
getAttribute(name) {
const key = String(name);
if (key === "class") return this.className || null;
if (key === "id") return this.id || null;
return this.attributes.has(key) ? this.attributes.get(key) : null;
}
hasAttribute(name) {
const key = String(name);
if (key === "class") return this._classes.size > 0;
if (key === "id") return !!this.id;
return this.attributes.has(key);
}
removeAttribute(name) {
const key = String(name);
this.attributes.delete(key);
if (key === "id") this.id = "";
if (key === "class") this.className = "";
}
appendChild(child) {
if (!child) return child;
if (child.parentNode) child.parentNode.removeChild(child);
child.parentNode = this;
this.children.push(child);
return child;
}
insertBefore(child, reference) {
if (!child) return child;
if (child.parentNode) child.parentNode.removeChild(child);
const index = reference ? this.children.indexOf(reference) : -1;
child.parentNode = this;
if (index < 0) this.children.push(child);
else this.children.splice(index, 0, child);
return child;
}
removeChild(child) {
const index = this.children.indexOf(child);
if (index >= 0) this.children.splice(index, 1);
child.parentNode = null;
return child;
}
remove() {
if (this.parentNode) this.parentNode.removeChild(this);
}
contains(node) {
let current = node;
while (current) {
if (current === this) return true;
current = current.parentNode;
}
return false;
}
matches(selector) {
return matchesSelector(this, selector);
}
closest(selector) {
let node = this;
while (node && node.nodeType === 1) {
if (matchesSelector(node, selector)) return node;
node = node.parentNode;
}
return null;
}
querySelectorAll(selector) {
const found = [];
const walk = node => {
for (const child of node.children) {
if (matchesSelector(child, selector)) found.push(child);
walk(child);
}
};
walk(this);
return found;
}
querySelector(selector) {
return this.querySelectorAll(selector)[0] || null;
}
addEventListener(type, callback) {
const key = String(type);
if (!this._listeners.has(key)) this._listeners.set(key, []);
this._listeners.get(key).push(callback);
}
removeEventListener(type, callback) {
const key = String(type);
const list = this._listeners.get(key);
if (!list) return;
const index = list.indexOf(callback);
if (index >= 0) list.splice(index, 1);
}
dispatchEvent(event) {
const type = event?.type;
const list = this._listeners.get(type) || [];
if (!event.target) event.target = this;
for (const callback of [...list]) {
callback.call(this, event);
}
const handler = this[`on${type}`];
if (typeof handler === "function") handler.call(this, event);
return !event.defaultPrevented;
}
focus() {}
select() {}
blur() {}
click() { this.dispatchEvent({ type: "click", preventDefault() {}, stopPropagation() {} }); }
setPointerCapture() {}
releasePointerCapture() {}
scrollIntoView() {}
}
export function createDocument() {
const doc = {
nodeType: 9,
readyState: "complete",
_listeners: new Map(),
};
doc.body = new FakeElement("body", doc);
doc.body._isRoot = true;
doc.head = new FakeElement("head", doc);
doc.head._isRoot = true;
doc.documentElement = new FakeElement("html", doc);
doc.documentElement._isRoot = true;
doc.documentElement.appendChild(doc.head);
doc.documentElement.appendChild(doc.body);
doc.createElement = tag => new FakeElement(tag, doc);
doc.createTextNode = text => ({ nodeType: 3, textContent: String(text), parentNode: null });
doc.getElementById = id => {
const search = node => {
if (node.id === id) return node;
for (const child of node.children) {
const found = search(child);
if (found) return found;
}
return null;
};
return search(doc.documentElement);
};
doc.querySelectorAll = selector => doc.documentElement.querySelectorAll(selector);
doc.querySelector = selector => doc.documentElement.querySelector(selector);
doc.addEventListener = (type, callback) => {
const key = String(type);
if (!doc._listeners.has(key)) doc._listeners.set(key, []);
doc._listeners.get(key).push(callback);
};
doc.removeEventListener = (type, callback) => {
const list = doc._listeners.get(String(type));
if (!list) return;
const index = list.indexOf(callback);
if (index >= 0) list.splice(index, 1);
};
doc.dispatchEvent = event => {
if (!event.target) event.target = doc.body;
for (const callback of [...(doc._listeners.get(event.type) || [])]) {
callback.call(doc, event);
}
return !event.defaultPrevented;
};
doc.listenerCount = type => (doc._listeners.get(String(type)) || []).length;
doc.execCommand = () => true;
doc.activeElement = doc.body;
return doc;
}
export function createWindow(doc, overrides = {}) {
const win = {
innerWidth: 1280,
innerHeight: 900,
screen: { width: 1920, height: 1080 },
isSecureContext: false,
location: { origin: "http://localhost", reload() {} },
_listeners: new Map(),
addEventListener(type, callback) {
const key = String(type);
if (!win._listeners.has(key)) win._listeners.set(key, []);
win._listeners.get(key).push(callback);
},
removeEventListener(type, callback) {
const list = win._listeners.get(String(type));
if (!list) return;
const index = list.indexOf(callback);
if (index >= 0) list.splice(index, 1);
},
dispatchEvent(event) {
for (const callback of [...(win._listeners.get(event.type) || [])]) {
callback.call(win, event);
}
return !event.defaultPrevented;
},
getComputedStyle(el) {
return {
display: el?.style?.display || "block",
visibility: el?.style?.visibility || "visible",
};
},
requestAnimationFrame(callback) {
return setTimeout(() => callback(Date.now()), 0);
},
cancelAnimationFrame(id) {
clearTimeout(id);
},
listenerCount(type) {
return (win._listeners.get(String(type)) || []).length;
},
...overrides,
};
return win;
}
export class FakeMutationObserver {
constructor(callback) {
this.callback = callback;
this.target = null;
this.options = null;
this.disconnected = false;
FakeMutationObserver.instances.push(this);
}
observe(target, options) {
this.target = target;
this.options = options;
}
disconnect() {
this.disconnected = true;
}
takeRecords() {
return [];
}
emit(records) {
this.callback(records, this);
}
}
FakeMutationObserver.instances = [];
export function sleep(ms = 15) {
return new Promise(resolve => setTimeout(resolve, ms));
}
export function stripImports(source) {
return source
.replace(/^import .*$/gm, "")
.replace(/export \{[^}]*\};?\s*$/m, "");
}
+251
View File
@@ -0,0 +1,251 @@
import os
import sys
import json
import time
import copy
import shutil
import tempfile
import threading
import unittest
from unittest.mock import MagicMock, patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper
from PIL import Image, PngImagePlugin
import nodes.generation_times as generation_times
from nodes.generation_times import (
record_generation_time,
get_generation_time,
patch_prompt_queue,
)
from nodes.assets_restore import (
AssetsRestoreManager,
parse_a1111_positive_prompt,
_decode_exif_text,
)
class TestAssetsRestore(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.mkdtemp()
self.output_dir = os.path.join(self.temp_dir, "output")
os.makedirs(self.output_dir)
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def _make_png(self, name, mtime, prompt_json=None, parameters=None, subfolder=""):
folder = os.path.join(self.output_dir, subfolder) if subfolder else self.output_dir
os.makedirs(folder, exist_ok=True)
path = os.path.join(folder, name)
info = PngImagePlugin.PngInfo()
if prompt_json is not None:
info.add_text("prompt", json.dumps(prompt_json))
if parameters is not None:
info.add_text("parameters", parameters)
Image.new("RGB", (8, 8), (20, 30, 40)).save(path, pnginfo=info)
os.utime(path, (mtime, mtime))
return path
def test_scan_returns_newest_limit_and_respects_recursive_setting(self):
base = 1_600_000_000
self._make_png("old.png", base)
self._make_png("new.png", base + 100)
self._make_png("nested.png", base + 200, subfolder="child")
manager = AssetsRestoreManager()
stats = {}
recursive = manager.scan_output_images(self.output_dir, limit=2, recursive=True, stats=stats)
self.assertEqual([x["filename"] for x in recursive], ["new.png", "nested.png"])
self.assertEqual(stats["scanned"], 3)
flat = manager.scan_output_images(self.output_dir, limit=10, recursive=False)
self.assertEqual([x["filename"] for x in flat], ["old.png", "new.png"])
def test_extract_png_and_a1111_metadata(self):
base = 1_600_000_000
prompt = {"1": {"class_type": "CLIPTextEncode", "inputs": {"text": "hello"}}}
self._make_png("meta.png", base, prompt_json=prompt)
manager = AssetsRestoreManager()
prompt_dict, workflow_dict, positive = manager.extract_image_metadata(
os.path.join(self.output_dir, "meta.png"))
self.assertEqual(prompt_dict, prompt)
self.assertEqual(workflow_dict, {})
self.assertEqual(positive, "")
self._make_png(
"a1111.png", base + 1,
parameters="A beautiful castle\nNegative prompt: ugly\nSteps: 20, Sampler: Euler")
_, _, positive = manager.extract_image_metadata(os.path.join(self.output_dir, "a1111.png"))
self.assertEqual(positive, "A beautiful castle")
def test_decode_exif_user_comment_prefixes(self):
# EXIF Unicode comments are UTF-16 big-endian after an 8-byte prefix
# (this is what piexif.helper.UserComment.dump produces).
unicode_comment = b"UNICODE\x00" + "A castle\nSteps: 20".encode("utf-16-be")
self.assertEqual(_decode_exif_text(unicode_comment), "A castle\nSteps: 20")
ascii_comment = b"ASCII\x00\x00\x00" + b"plain prompt"
self.assertEqual(_decode_exif_text(ascii_comment), "plain prompt")
def test_parse_a1111_positive_prompt(self):
self.assertEqual(
parse_a1111_positive_prompt("A cat\n\nNegative prompt: dog\nSteps: 20"),
"A cat",
)
self.assertEqual(
parse_a1111_positive_prompt("Just a prompt\nSteps: 10, Sampler: Euler a"),
"Just a prompt",
)
self.assertEqual(parse_a1111_positive_prompt(""), "")
def test_restore_uses_generation_time_and_builds_debug_report(self):
base = 1_600_000_000
first = self._make_png("first.png", base, subfolder="sub")
second = self._make_png("second.png", base + 60)
fake_queue = MagicMock()
fake_queue.history = {}
fake_queue.mutex = threading.RLock()
server = MagicMock()
server.prompt_queue = fake_queue
manager = AssetsRestoreManager()
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_assets_restore_count", return_value=10), \
patch("nodes.assets_restore.get_generation_time", side_effect=lambda fn, sf="", mt=None: 12.5 if fn == "first.png" else None), \
patch.object(manager, "_ingest_assets", return_value=0):
restored = manager.restore_on_launch(server, force=True)
self.assertEqual(restored, 2)
self.assertEqual(len(fake_queue.history), 2)
entries = list(fake_queue.history.values())
self.assertEqual(entries[0]["outputs"]["0"]["images"][0]["filename"], "first.png")
start_ts = entries[0]["status"]["messages"][0][1]["timestamp"]
end_ts = entries[0]["status"]["messages"][1][1]["timestamp"]
self.assertEqual(end_ts - start_ts, 12500)
self.assertEqual(entries[0]["status"]["saturnnodes_duration"], 12.5)
self.assertEqual(entries[0]["prompt"][3]["extra_pnginfo"]["saturnnodes_generation_time"], 12.5)
self.assertEqual(len(entries[0]["status"]["messages"]), 2)
# No recorded duration: keep the mtime for sorting, but do not emit an
# execution_success timestamp that would render as a fake "0.00s".
self.assertEqual(entries[1]["status"]["messages"][0][1]["timestamp"], base * 1000 + 60 * 1000)
self.assertEqual(len(entries[1]["status"]["messages"]), 1)
report = manager.last_debug_report
self.assertEqual(report["restored_count"], 2)
self.assertEqual(report["generation_time_matches"], 1)
self.assertEqual(report["total_scanned_images"], 2)
self.assertIn("elapsed_ms", report)
self.assertTrue(os.path.exists(first) and os.path.exists(second))
class TestGenerationTimes(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.mkdtemp()
self.old_file = generation_times.GENERATION_TIMES_FILE
self.old_data = generation_times._DATA
self.old_mtime = generation_times._DATA_MTIME
self.old_patched = generation_times._PATCHED
self.old_starts = dict(generation_times._START_TIMES)
generation_times.GENERATION_TIMES_FILE = os.path.join(self.temp_dir, "generation_times.json")
generation_times._DATA = None
generation_times._DATA_MTIME = None
generation_times._PATCHED = False
generation_times._START_TIMES.clear()
def tearDown(self):
generation_times.GENERATION_TIMES_FILE = self.old_file
generation_times._DATA = self.old_data
generation_times._DATA_MTIME = self.old_mtime
generation_times._PATCHED = self.old_patched
generation_times._START_TIMES.clear()
generation_times._START_TIMES.update(self.old_starts)
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_record_and_lookup_generation_time(self):
record_generation_time("pid-1", 3.25, [
{"filename": "a.png", "subfolder": ""},
{"filename": "b.png", "subfolder": "nested"},
])
self.assertEqual(get_generation_time("a.png"), 3.25)
self.assertEqual(get_generation_time("b.png", "nested"), 3.25)
self.assertEqual(get_generation_time("b.png"), 3.25) # bare filename fallback
self.assertIsNone(get_generation_time("missing.png"))
with open(generation_times.GENERATION_TIMES_FILE, "r", encoding="utf-8") as f:
raw = f.read()
self.assertNotIn("\n", raw) # compact JSON
def test_moved_file_fallback_is_timestamp_guarded_and_unambiguous(self):
now = time.time()
record_generation_time("pid-moved", 7.0, [
{"filename": "moved.png", "subfolder": "old"},
])
# A moved file has a new subfolder/key; the bare-name fallback works
# only when the recorded completion time is close to the file mtime.
self.assertEqual(get_generation_time("moved.png", "new", now), 7.0)
self.assertIsNone(get_generation_time("moved.png", "new", now - 3600))
record_generation_time("pid-other", 9.0, [
{"filename": "moved.png", "subfolder": "elsewhere"},
])
# Two candidate records are ambiguous, so no duration is invented.
self.assertIsNone(get_generation_time("moved.png", "new", now))
def test_temporary_outputs_are_not_recorded_for_assets(self):
files = generation_times._extract_output_files({
"outputs": {"1": {"images": [
{"filename": "preview.png", "subfolder": "", "type": "temp"},
{"filename": "saved.png", "subfolder": "", "type": "output"},
{"filename": "no-type.png", "subfolder": ""},
]}}
})
self.assertEqual([f["filename"] for f in files], ["saved.png", "no-type.png"])
record_generation_time("pid-temp", 2.0, files)
self.assertIsNone(get_generation_time("preview.png"))
self.assertEqual(get_generation_time("saved.png"), 2.0)
def test_queue_patch_measures_task_duration(self):
class FakeQueue:
def __init__(self):
self.currently_running = {}
self.mutex = threading.RLock()
self.items = [(0, "pid-42", {"prompt": {}}, {}, {}, True)]
self.task_counter = 0
def get(self, *args, **kwargs):
if not self.items:
return None
item = self.items.pop(0)
task_id = self.task_counter
self.task_counter += 1
self.currently_running[task_id] = copy.deepcopy(item)
# Match ComfyUI's real PromptQueue.get return shape.
return (item, task_id)
def task_done(self, item_id, history_result, status, process_item=None):
self.currently_running.pop(item_id, None)
queue = FakeQueue()
server = MagicMock()
server.prompt_queue = queue
patch_prompt_queue(server)
item, task_id = queue.get()
queue.task_done(task_id, {
"outputs": {"9": {"images": [{"filename": "queued.png", "subfolder": "run"}]}}
}, "success")
duration = get_generation_time("queued.png", "run")
self.assertIsNotNone(duration)
self.assertGreaterEqual(duration, 0.0)
with open(generation_times.GENERATION_TIMES_FILE, "r", encoding="utf-8") as f:
saved = json.load(f)
self.assertEqual(saved["entries"]["run/queued.png"]["status"], "success")
if __name__ == "__main__":
unittest.main()
+422
View File
@@ -0,0 +1,422 @@
import json
import os
import shutil
import sys
import tempfile
import threading
import time
import unittest
import uuid
from types import SimpleNamespace
from unittest.mock import patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper # noqa: F401 (redirects SaturnNodes state to a temp dir)
from PIL import Image, PngImagePlugin
from nodes.assets_restore import (
AssetsRestoreManager,
_decode_exif_text,
get_assets_restore_count,
parse_a1111_positive_prompt,
)
class TestAssetsRestoreExtended(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.mkdtemp()
self.output_dir = os.path.join(self.temp_dir, "output")
os.makedirs(self.output_dir)
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def _make_png(self, name, mtime, subfolder="", prompt_json=None, parameters=None):
folder = os.path.join(self.output_dir, subfolder) if subfolder else self.output_dir
os.makedirs(folder, exist_ok=True)
path = os.path.join(folder, name)
info = PngImagePlugin.PngInfo()
if prompt_json is not None:
info.add_text("prompt", json.dumps(prompt_json))
if parameters is not None:
info.add_text("parameters", parameters)
Image.new("RGB", (8, 8), (10, 20, 30)).save(path, pnginfo=info)
os.utime(path, (mtime, mtime))
return path
def _fake_queue(self, history=None, mutex=True):
queue = SimpleNamespace(history=history)
if mutex:
queue.mutex = threading.RLock()
return queue
def _server(self, queue):
return SimpleNamespace(prompt_queue=queue, queue_updated=lambda: None)
def test_scan_equal_mtimes_use_path_tiebreak(self):
base = 1_700_000_000
# Deliberately create in non-sorted order so filesystem iteration order
# cannot accidentally make the test pass.
self._make_png("b.png", base)
self._make_png("a.png", base)
self._make_png("c.png", base, subfolder="sub")
self._make_png("a.png", base, subfolder="sub")
manager = AssetsRestoreManager()
first = manager.scan_output_images(self.output_dir, limit=10)
second = manager.scan_output_images(self.output_dir, limit=10)
expected = [
("a.png", ""),
("b.png", ""),
("a.png", "sub"),
("c.png", "sub"),
]
self.assertEqual([(x["filename"], x["subfolder"]) for x in first], expected)
self.assertEqual(first, second, "repeated scans must return identical ordering")
def test_scan_limit_is_clamped_and_invalid_limits_fall_back(self):
base = 1_700_000_000
for index in range(4):
self._make_png(f"img{index}.png", base + index)
with open(os.path.join(self.output_dir, "notes.txt"), "w", encoding="utf-8") as handle:
handle.write("not an image")
manager = AssetsRestoreManager()
stats = {}
newest_one = manager.scan_output_images(self.output_dir, limit=0, stats=stats)
self.assertEqual([x["filename"] for x in newest_one], ["img3.png"])
self.assertEqual(stats["scanned"], 4, "non-image files must not count as scanned images")
self.assertEqual(
[x["filename"] for x in manager.scan_output_images(self.output_dir, limit=-7)],
["img3.png"],
)
self.assertEqual(
len(manager.scan_output_images(self.output_dir, limit="not-a-number")),
4,
"an invalid limit must fall back to the default scan size",
)
def test_restore_limit_is_clamped_and_invalid_uses_setting(self):
base = 1_700_000_000
self._make_png("one.png", base)
self._make_png("two.png", base + 1)
self._make_png("three.png", base + 2)
manager = AssetsRestoreManager()
queue = self._fake_queue()
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_generation_time", return_value=None), \
patch.object(manager, "_ingest_assets", return_value=0):
self.assertEqual(manager.restore_on_launch(self._server(queue), limit=0, force=True), 1)
manager = AssetsRestoreManager()
queue = self._fake_queue()
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_assets_restore_count", return_value=2), \
patch("nodes.assets_restore.get_generation_time", return_value=None), \
patch.object(manager, "_ingest_assets", return_value=0):
self.assertEqual(
manager.restore_on_launch(self._server(queue), limit="broken", force=True),
2,
)
def test_concurrent_force_restores_are_serialized(self):
self._make_png("image.png", 1_700_000_000)
manager = AssetsRestoreManager()
queue = self._fake_queue()
server = self._server(queue)
intervals = []
intervals_lock = threading.Lock()
def slow_ingest(prepared):
start = time.monotonic()
time.sleep(0.08)
end = time.monotonic()
with intervals_lock:
intervals.append((start, end))
return len(prepared)
errors = []
def run_restore():
try:
manager.restore_on_launch(server, force=True)
except Exception as exc: # pragma: no cover - surfaced via assert below
errors.append(exc)
# Apply the module patches in the main thread. Patching the same target
# from two threads can restore stale values when the contexts unwind in
# a different order and would make this test flaky.
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_generation_time", return_value=None), \
patch.object(manager, "_ingest_assets", side_effect=slow_ingest):
threads = [threading.Thread(target=run_restore) for _ in range(2)]
for thread in threads:
thread.start()
for thread in threads:
thread.join(10)
self.assertEqual(errors, [])
self.assertEqual(len(intervals), 2)
intervals.sort()
self.assertGreaterEqual(
intervals[1][0],
intervals[0][1] - 0.01,
"the restore lock must prevent overlapping restore/ingest runs",
)
def test_restore_preserves_cross_day_timestamps_and_durations(self):
day = 86_400
base = 1_700_000_000
specs = [
("day-one.png", base, 1.5),
("day-two.png", base + day, 2.0),
("day-three.png", base + 2 * day, 3.25),
]
durations = {}
for name, mtime, duration in specs:
self._make_png(name, mtime)
durations[name] = duration
manager = AssetsRestoreManager()
queue = self._fake_queue()
server = self._server(queue)
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch(
"nodes.assets_restore.get_generation_time",
side_effect=lambda fn, sf="", mt=None: durations.get(fn),
), \
patch.object(manager, "_ingest_assets", return_value=0):
restored = manager.restore_on_launch(server, force=True)
self.assertEqual(restored, 3)
entries = list(queue.history.values())
self.assertEqual(
[entry["prompt"][0] for entry in entries],
[1, 2, 3],
"restored history must be numbered oldest to newest across days",
)
for entry, (name, mtime, duration) in zip(entries, specs):
mtime_ms = int(mtime * 1000)
duration_ms = int(duration * 1000)
self.assertEqual(entry["prompt"][3]["create_time"], mtime_ms, name)
messages = entry["status"]["messages"]
self.assertEqual([message[0] for message in messages], ["execution_start", "execution_success"])
self.assertEqual(messages[0][1]["timestamp"], mtime_ms - duration_ms, name)
self.assertEqual(messages[1][1]["timestamp"], mtime_ms, name)
self.assertEqual(entry["status"]["saturnnodes_duration"], duration, name)
self.assertEqual(
entry["prompt"][3]["extra_pnginfo"]["saturnnodes_generation_time"],
duration,
name,
)
self.assertEqual(
entry["outputs"]["0"]["images"][0]["filename"],
name,
)
def test_restore_recovers_from_corrupt_image(self):
path = os.path.join(self.output_dir, "broken.png")
with open(path, "wb") as handle:
handle.write(b"this is not a PNG")
os.utime(path, (1_700_000_000, 1_700_000_000))
manager = AssetsRestoreManager()
queue = self._fake_queue()
server = self._server(queue)
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_generation_time", return_value=None), \
patch.object(manager, "_ingest_assets", return_value=0):
restored = manager.restore_on_launch(server, force=True)
self.assertEqual(restored, 1)
entry = next(iter(queue.history.values()))
self.assertEqual(entry["prompt"][2], {}, "corrupt metadata must fall back to an empty prompt")
self.assertEqual(entry["outputs"]["0"]["images"][0]["filename"], "broken.png")
self.assertEqual(entry["status"]["status_str"], "success")
self.assertEqual(entry["status"]["messages"], [["execution_start", {"timestamp": 1_700_000_000_000}]])
def test_restore_handles_missing_mutex_and_bad_history(self):
self._make_png("image.png", 1_700_000_000)
manager = AssetsRestoreManager()
queue = self._fake_queue(history=None, mutex=False)
server = self._server(queue)
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_generation_time", return_value=None), \
patch.object(manager, "_ingest_assets", return_value=0):
restored = manager.restore_on_launch(server, force=True)
self.assertEqual(restored, 1)
self.assertIsInstance(queue.history, dict)
self.assertEqual(len(queue.history), 1)
def test_restore_survives_asset_db_ingest_failure(self):
self._make_png("image.png", 1_700_000_000)
manager = AssetsRestoreManager()
queue = self._fake_queue()
server = self._server(queue)
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_generation_time", return_value=None), \
patch.object(manager, "_ingest_assets", side_effect=RuntimeError("asset db unavailable")):
restored = manager.restore_on_launch(server, force=True)
self.assertEqual(restored, 1)
self.assertEqual(manager.last_debug_report["asset_db_registered"], 0)
self.assertEqual(manager.last_debug_report["status"], "success")
def test_restore_ignores_non_finite_or_negative_durations(self):
base = 1_700_000_000
for name in ("nan.png", "inf.png", "neg.png", "ok.png"):
self._make_png(name, base)
base += 1
durations = {
"nan.png": float("nan"),
"inf.png": float("inf"),
"neg.png": -2.5,
"ok.png": 4.0,
}
manager = AssetsRestoreManager()
queue = self._fake_queue()
server = self._server(queue)
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_generation_time", side_effect=lambda fn, sf="", mt=None: durations[fn]), \
patch.object(manager, "_ingest_assets", return_value=0):
restored = manager.restore_on_launch(server, force=True)
self.assertEqual(restored, 4)
entries = {
entry["outputs"]["0"]["images"][0]["filename"]: entry
for entry in queue.history.values()
}
for name in ("nan.png", "inf.png", "neg.png"):
self.assertEqual(len(entries[name]["status"]["messages"]), 1, name)
self.assertNotIn("saturnnodes_duration", entries[name]["status"], name)
self.assertNotIn(
"saturnnodes_generation_time",
entries[name]["prompt"][3]["extra_pnginfo"],
name,
)
self.assertEqual(len(entries["ok.png"]["status"]["messages"]), 2)
self.assertEqual(entries["ok.png"]["status"]["saturnnodes_duration"], 4.0)
def test_restore_disabled_marks_launch_and_skips_scan(self):
manager = AssetsRestoreManager()
queue = self._fake_queue()
server = self._server(queue)
with patch("nodes.assets_restore.is_assets_restore_enabled", return_value=False), \
patch.object(manager, "scan_output_images") as scan:
self.assertEqual(manager.restore_on_launch(server), 0)
self.assertEqual(manager.restore_on_launch(server), 0)
scan.assert_not_called()
self.assertTrue(manager._restored_on_launch)
def test_restore_runs_once_without_force(self):
self._make_png("image.png", 1_700_000_000)
manager = AssetsRestoreManager()
queue = self._fake_queue()
server = self._server(queue)
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_generation_time", return_value=None), \
patch.object(manager, "_ingest_assets", return_value=0), \
patch.object(manager, "scan_output_images", wraps=manager.scan_output_images) as scan:
self.assertEqual(manager.restore_on_launch(server), 1)
self.assertEqual(manager.restore_on_launch(server), 0)
self.assertEqual(scan.call_count, 1)
def test_restored_prompt_ids_are_stable_and_unique(self):
base = 1_700_000_000
self._make_png("same.png", base)
self._make_png("same.png", base + 1, subfolder="one")
self._make_png("same.png", base + 2, subfolder="two")
manager = AssetsRestoreManager()
first_queue = self._fake_queue()
second_queue = self._fake_queue()
for queue in (first_queue, second_queue):
with patch("nodes.assets_restore.folder_paths.get_output_directory", return_value=self.output_dir), \
patch("nodes.assets_restore.is_assets_restore_enabled", return_value=True), \
patch("nodes.assets_restore.is_recursive_assets_scan_enabled", return_value=True), \
patch("nodes.assets_restore.get_generation_time", return_value=None), \
patch.object(manager, "_ingest_assets", return_value=0):
manager.restore_on_launch(self._server(queue), force=True)
first_ids = set(first_queue.history)
second_ids = set(second_queue.history)
self.assertEqual(first_ids, second_ids)
self.assertEqual(len(first_ids), 3)
self.assertEqual(
first_ids,
{
str(uuid.uuid5(uuid.NAMESPACE_URL, f"saturnnodes:{key}"))
for key in ("same.png", "one/same.png", "two/same.png")
},
)
for entry in first_queue.history.values():
self.assertIn(entry["prompt"][1], first_ids)
def test_decode_exif_text_strips_bom_and_nul_padding(self):
unicode_comment = b"UNICODE\x00" + "\ufeffA castle\x00".encode("utf-16-be")
self.assertEqual(_decode_exif_text(unicode_comment), "A castle")
self.assertEqual(
_decode_exif_text(b"ASCII\x00\x00\x00" + b"A\x00B\x00"),
"AB",
)
self.assertEqual(_decode_exif_text("\ufeff padded \x00"), "padded")
self.assertEqual(_decode_exif_text(None), "")
self.assertEqual(_decode_exif_text(b""), "")
def test_parse_a1111_accepts_bytes_and_crlf(self):
raw = b"A cat\r\nNegative prompt: dog\r\nSteps: 20, Sampler: Euler"
self.assertEqual(parse_a1111_positive_prompt(raw), "A cat")
self.assertEqual(
parse_a1111_positive_prompt(b"Line one\r\nLine two\r\nSteps: 4"),
"Line one\nLine two",
)
self.assertEqual(parse_a1111_positive_prompt(None), "")
def test_generation_time_count_setting_clamps(self):
with patch("nodes.assets_restore.get_env_setting", return_value="0"):
self.assertEqual(get_assets_restore_count(), 1)
with patch("nodes.assets_restore.get_env_setting", return_value="100000"):
self.assertEqual(get_assets_restore_count(), 1000)
with patch("nodes.assets_restore.get_env_setting", return_value="not-a-number"):
self.assertEqual(get_assets_restore_count(), 64)
if __name__ == "__main__":
unittest.main()
+143 -1
View File
@@ -3,12 +3,14 @@ import sys
import unittest
import json
import tempfile
import threading
from unittest.mock import MagicMock, patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper
from nodes.queue_control import PersistentQueueManager
from nodes.queue_control import PersistentQueueManager, PauseQueueManager
import nodes.queue_control as queue_control
# 36 Colors matching web/batch_queue.js
BATCH_COLORS = [
@@ -162,6 +164,7 @@ class TestPersistentQueueBatchMetadata(unittest.TestCase):
# Add item to persistent queue
item_tuple = (0, "prompt_99", {"prompt": {}}, {}, {})
mgr.add_item(item_tuple)
mgr.flush()
# Verify batch_info is attached inside persistent_items
saved_entry = [x for x in mgr.persistent_items if x["prompt_id"] == "prompt_99"][0]
@@ -179,6 +182,7 @@ class TestPersistentQueueBatchMetadata(unittest.TestCase):
self.assertIn("p1", mgr.batch_meta)
mgr.remove_item("p1")
mgr.flush()
self.assertNotIn("p1", mgr.batch_meta)
self.assertEqual(len(mgr.persistent_items), 0)
@@ -191,5 +195,143 @@ class TestPersistentQueueBatchMetadata(unittest.TestCase):
self.assertEqual(len(mgr.persistent_items), 0)
class TestPersistentQueueHardening(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.TemporaryDirectory()
self.temp_file = os.path.join(self.temp_dir.name, "test_persistent_queue.json")
self.patch_file = patch("nodes.queue_control.PERSISTENT_FILE", self.temp_file)
self.patch_user = patch("nodes.queue_control.USER_DIR", self.temp_dir.name)
self.patch_enabled = patch("nodes.queue_control.is_persistent_queue_enabled", return_value=True)
self.patch_file.start()
self.patch_user.start()
self.patch_enabled.start()
def tearDown(self):
self.patch_enabled.stop()
self.patch_user.stop()
self.patch_file.stop()
self.temp_dir.cleanup()
def test_finished_prompt_cannot_be_resynced(self):
mgr = PersistentQueueManager()
mgr.set_batch_info("p1", {"batchId": "b1"})
mgr.add_item((0, "p1", {}, {}, {}))
mgr.remove_item("p1")
# A late /saturnnodes/batch_queue/sync from another client must not
# resurrect metadata for a prompt that already finished.
mgr.set_batch_info("p1", {"batchId": "b1"})
self.assertNotIn("p1", mgr.batch_meta)
# Flush so the debounce timer cannot fire after tearDown restores the
# real PERSISTENT_FILE (it would write into the live user directory).
mgr.flush()
def test_batch_meta_is_capped_keeping_recent_entries(self):
mgr = PersistentQueueManager()
mgr.MAX_BATCH_META = 3
with patch("nodes.queue_control.time.time", side_effect=[1, 2, 3, 4, 5]):
for i in range(5):
mgr.set_batch_info(f"p{i}", {"batchId": f"b{i}"})
self.assertEqual(len(mgr.batch_meta), 3)
self.assertNotIn("p0", mgr.batch_meta)
self.assertNotIn("p1", mgr.batch_meta)
self.assertIn("p2", mgr.batch_meta)
self.assertIn("p4", mgr.batch_meta)
def test_saves_are_debounced_compact_and_flushable(self):
mgr = PersistentQueueManager()
mgr.add_item((0, "p1", {"prompt": {}}, {}, {}))
# The first write is deliberately deferred; memory is authoritative.
self.assertTrue(mgr._save_dirty)
mgr.flush()
self.assertFalse(mgr._save_dirty)
self.assertTrue(os.path.exists(self.temp_file))
with open(self.temp_file, "r", encoding="utf-8") as f:
raw = f.read()
# Compact JSON (no indentation/newlines) keeps the file small.
self.assertNotIn("\n", raw)
payload = json.loads(raw)
self.assertEqual(payload["schema_version"], queue_control.PERSISTENT_QUEUE_SCHEMA_VERSION)
self.assertEqual(payload["items"][0]["prompt_id"], "p1")
self.assertFalse(os.path.exists(self.temp_file + ".tmp"))
def test_restore_retry_setting_keeps_then_drops_failed_prompts(self):
mgr = PersistentQueueManager()
mgr.persistent_items = [{
"prompt_id": "p1",
"item": [0, "p1", {"prompt": {}}, {}],
"retries": 0,
}]
server = MagicMock()
server.prompt_queue.get_history.return_value = {}
server.prompt_queue.put.side_effect = RuntimeError("queue unavailable")
server.number = 0
def fake_setting(key, default):
return "1" if key == "PERSISTENT_QUEUE_MAX_RETRIES" else default
with patch("nodes.queue_control.PromptServer.instance", server), \
patch("nodes.queue_control.get_env_setting", side_effect=fake_setting):
mgr.restore_queue("test-client")
self.assertEqual(len(mgr.persistent_items), 1)
self.assertEqual(mgr.persistent_items[0]["retries"], 1)
mgr.has_claimed_once = False
mgr.restore_queue("test-client")
self.assertEqual(len(mgr.persistent_items), 0)
self.assertIn("p1", mgr.recently_finished)
def test_pause_state_persists_when_enabled(self):
def fake_setting(key, default):
if key == "PERSIST_PAUSE_STATE":
return "true"
return default
with patch("nodes.queue_control.get_env_setting", side_effect=fake_setting):
first = PauseQueueManager()
first.set_pause(True, "instantly")
second = PauseQueueManager()
self.assertTrue(second.paused)
self.assertEqual(second.mode, "instantly")
self.assertEqual(second.is_waiting, True)
class TestPauseQueuePatchedGet(unittest.TestCase):
def test_finite_timeout_returns_instead_of_busy_spinning(self):
class FakeQueue:
def __init__(self):
self.currently_running = {}
self.mutex = threading.RLock()
self.calls = 0
self.last_timeout = object()
def get(self, timeout=None):
self.calls += 1
self.last_timeout = timeout
return None
queue = FakeQueue()
server = MagicMock()
server.prompt_queue = queue
def fake_setting(key, default):
return default
with patch("nodes.queue_control.get_env_setting", side_effect=fake_setting), \
patch.object(queue_control.PromptServer, "instance", server):
manager = PauseQueueManager()
manager.patch_all()
# ComfyUI main.py calls get(timeout=0.0) when a GC pass is due.
# The wrapper must return immediately (not spin forever).
self.assertIsNone(queue.get(timeout=0.0))
self.assertEqual(queue.calls, 1)
self.assertEqual(queue.last_timeout, 0.0)
if __name__ == "__main__":
unittest.main()
+363
View File
@@ -0,0 +1,363 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "batch_queue.js");
class FakeElement {
constructor(tagName) {
this.tagName = String(tagName).toUpperCase();
this.nodeType = 1;
this.attributes = new Map();
this.children = [];
this.parentNode = null;
this.className = "";
this.id = "";
this.innerHTML = "";
this.style = {};
this.dataset = {};
}
setAttribute(name, value) {
this.attributes.set(String(name), String(value));
}
getAttribute(name) {
return this.attributes.has(String(name)) ? this.attributes.get(String(name)) : null;
}
appendChild(child) {
child.parentNode = this;
this.children.push(child);
return child;
}
remove() {
if (!this.parentNode) return;
const index = this.parentNode.children.indexOf(this);
if (index >= 0) this.parentNode.children.splice(index, 1);
this.parentNode = null;
}
querySelector(selector) {
if (selector === ".saturnnodes-batch-line-wrap") {
return this.children.find(child => child.className === "saturnnodes-batch-line-wrap") || null;
}
return null;
}
matches(selector) {
return String(selector).split(",").some(rawPart => {
const part = rawPart.trim();
if (part === "[data-job-id]") return this.attributes.has("data-job-id");
if (part === '[data-testid="job-assets-list"]') {
return this.getAttribute("data-testid") === "job-assets-list";
}
if (part === ".comfy-table") {
return this.className.split(/\s+/).includes("comfy-table");
}
if (part === "tr") return this.tagName === "TR";
if (part === ".comfy-table tr[data-job-id]") {
return this.tagName === "TR" && this.attributes.has("data-job-id");
}
return false;
});
}
closest(selector) {
let node = this;
while (node) {
if (node.matches?.(selector)) return node;
node = node.parentNode;
}
return null;
}
}
class FakeMutationObserver {
constructor(callback) {
this.callback = callback;
this.target = null;
this.options = null;
FakeMutationObserver.instances.push(this);
}
observe(target, options) {
this.target = target;
this.options = options;
}
}
FakeMutationObserver.instances = [];
let clock = 1_000_000;
let timerId = 0;
const timers = [];
function fakeSetTimeout(callback, delay = 0) {
const timer = {
id: ++timerId,
at: clock + Math.max(0, Number(delay) || 0),
callback,
};
timers.push(timer);
return timer.id;
}
function fakeClearTimeout(id) {
const index = timers.findIndex(timer => timer.id === id);
if (index >= 0) timers.splice(index, 1);
}
function advance(ms) {
const end = clock + Math.max(0, Number(ms) || 0);
while (true) {
let nextIndex = -1;
for (let i = 0; i < timers.length; i++) {
if (timers[i].at <= end && (nextIndex < 0 || timers[i].at < timers[nextIndex].at)) {
nextIndex = i;
}
}
if (nextIndex < 0) break;
const [timer] = timers.splice(nextIndex, 1);
clock = Math.max(clock, timer.at);
timer.callback();
}
clock = end;
}
const queueRoot = new FakeElement("div");
queueRoot.setAttribute("data-testid", "job-assets-list");
const activeCard = new FakeElement("div");
activeCard.setAttribute("data-job-id", "pid-a");
const pendingCard = new FakeElement("div");
pendingCard.setAttribute("data-job-id", "pid-b");
queueRoot.appendChild(activeCard);
queueRoot.appendChild(pendingCard);
// Legacy v1 rows are inserted separately by the test.
const v1Rows = [];
const document = {
body: new FakeElement("body"),
head: new FakeElement("head"),
getElementById(id) {
const find = node => {
if (node.id === id) return node;
for (const child of node.children) {
const found = find(child);
if (found) return found;
}
return null;
};
return find(this.body) || find(this.head);
},
createElement(tagName) {
return new FakeElement(tagName);
},
querySelectorAll(selector) {
if (selector.includes(".comfy-table")) {
return [activeCard, pendingCard, ...v1Rows];
}
if (selector.includes("[data-job-id]")) {
return [activeCard, pendingCard];
}
if (selector === ".saturnnodes-batch-line-wrap") {
const wraps = [];
const find = node => {
for (const child of node.children) {
if (child.className === "saturnnodes-batch-line-wrap") wraps.push(child);
find(child);
}
};
find(this.body);
return wraps;
}
return [];
},
};
document.body.appendChild(queueRoot);
const storage = new Map();
const localStorage = {
getItem(key) {
return storage.has(key) ? storage.get(key) : null;
},
setItem(key, value) {
storage.set(key, String(value));
},
};
function batchInfo(promptId, batchId, color, itemIndex, batchCount = 2) {
return {
prompt_id: promptId,
batchId,
batchNumber: 1,
batchCount,
itemIndex,
color,
colorIndex: 0,
queuedAt: clock,
};
}
const oldBatch = "batch_old";
const newBatch = "batch_new";
storage.set(
"saturnnodes_batch_queue_meta",
JSON.stringify([
batchInfo("pid-a", oldBatch, "#4ade80", 0, 1),
batchInfo("pid-b", newBatch, "#fbbf24", 1, 2),
batchInfo("pid-c", newBatch, "#fbbf24", 0, 2),
batchInfo("pid-d", newBatch, "#fbbf24", 1, 2),
])
);
const extension = {
name: "test",
setup: null,
};
const app = {
queuePrompt: async () => true,
extensionManager: {
setting: {
get: () => true,
},
},
registerExtension(candidate) {
extension.name = candidate.name;
extension.setup = candidate.setup;
},
};
const apiEvents = new Map();
const api = {
queuePrompt: async () => ({ prompt_id: "queued" }),
fetchApi: async () => null,
addEventListener(name, callback) {
if (!apiEvents.has(name)) apiEvents.set(name, []);
apiEvents.get(name).push(callback);
},
};
const source = fs
.readFileSync(sourcePath, "utf8")
.replace(/^import .*$/gm, "")
.replace(/export \{[^}]*\};?\s*$/m, "");
const context = vm.createContext({
console,
app,
api,
authenticatedFetch: async () => null,
document,
localStorage,
MutationObserver: FakeMutationObserver,
setTimeout: fakeSetTimeout,
clearTimeout: fakeClearTimeout,
Date: { now: () => clock },
Math,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
parseInt,
isNaN,
Infinity,
});
vm.runInContext(source, context, { filename: sourcePath });
assert.equal(typeof extension.setup, "function", "batch queue extension must register");
await extension.setup();
advance(100);
const activeLine = activeCard.querySelector(".saturnnodes-batch-line-wrap");
assert.ok(activeLine, "active card must have a batch line");
assert.match(activeLine.innerHTML, /#4ade80/, "initial active line must use its own batch color");
const observer = FakeMutationObserver.instances.find(
item => item.options && item.options.attributes && item.options.attributeFilter?.includes("data-job-id")
);
assert.ok(observer, "queue observer must watch data-job-id attribute changes");
// Simulate Vue reusing the running card for the first item of the next batch.
// The old green SVG remains in the DOM until the attribute mutation is handled.
activeCard.setAttribute("data-job-id", "pid-c");
observer.callback([{ target: activeCard, type: "attributes", attributeName: "data-job-id" }]);
advance(100);
assert.match(
activeCard.querySelector(".saturnnodes-batch-line-wrap").innerHTML,
/#fbbf24/,
"reused active card must repaint with the new batch color"
);
assert.doesNotMatch(
activeCard.querySelector(".saturnnodes-batch-line-wrap").innerHTML,
/#4ade80/,
"stale batch color must not survive a data-job-id change"
);
// The new batch's pending item and active item must share the same color.
const pendingLine = pendingCard.querySelector(".saturnnodes-batch-line-wrap");
assert.ok(pendingLine, "pending card must have a batch line");
assert.match(pendingLine.innerHTML, /#fbbf24/, "pending item must use the new batch color");
// 4. Legacy v1: a table can be inserted with its rows already built, so the
// mutation target is the new parent and the table only appears in addedNodes.
const table = new FakeElement("table");
table.className = "comfy-table";
const v1Row = new FakeElement("tr");
v1Row.setAttribute("data-job-id", "pid-d");
table.appendChild(v1Row);
const tableWrapper = new FakeElement("div");
document.body.appendChild(tableWrapper);
tableWrapper.appendChild(table);
v1Rows.push(v1Row);
observer.callback([{
type: "childList",
target: tableWrapper,
addedNodes: [table],
removedNodes: [],
}]);
advance(100);
const v1Line = v1Row.querySelector(".saturnnodes-batch-line-wrap");
assert.ok(v1Line, "a v1 table inserted with rows must get a batch line");
assert.match(v1Line.innerHTML, /#fbbf24/, "v1 row must use the batch color");
// 5. Duplicate data-job-id rows must not skew batch grouping or paint twice.
const duplicateRow = new FakeElement("tr");
duplicateRow.setAttribute("data-job-id", "pid-b");
// Simulate a line left over from an earlier render on the duplicate.
const staleDuplicateLine = new FakeElement("div");
staleDuplicateLine.className = "saturnnodes-batch-line-wrap";
duplicateRow.appendChild(staleDuplicateLine);
table.appendChild(duplicateRow);
v1Rows.push(duplicateRow);
observer.callback([{
type: "childList",
target: table,
addedNodes: [duplicateRow],
removedNodes: [],
}]);
advance(100);
assert.equal(
duplicateRow.querySelector(".saturnnodes-batch-line-wrap"),
null,
"duplicate job row must be ignored"
);
assert.ok(
pendingCard.querySelector(".saturnnodes-batch-line-wrap"),
"the first occurrence of the job id keeps its batch line"
);
console.log("batch queue DOM regression test passed");
+30
View File
@@ -0,0 +1,30 @@
import os
import shutil
import subprocess
import unittest
class TestBatchQueueDomRegression(unittest.TestCase):
def test_reused_active_card_repaints_after_job_id_change(self):
node = shutil.which("node")
if not node:
self.skipTest("Node.js is not available")
repo_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
script = os.path.join(repo_root, "tests", "test_batch_queue_dom.mjs")
result = subprocess.run(
[node, script],
cwd=repo_root,
capture_output=True,
text=True,
timeout=30,
)
self.assertEqual(
result.returncode,
0,
msg=f"Batch queue DOM regression failed:\n{result.stdout}\n{result.stderr}",
)
if __name__ == "__main__":
unittest.main()
+339
View File
@@ -0,0 +1,339 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import { FakeMutationObserver, createDocument, stripImports } from "./fake_dom.mjs";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "batch_queue.js");
let source = stripImports(fs.readFileSync(sourcePath, "utf8"));
source += `
globalThis.__batchTest = {
updateQueueBatchVisuals,
normalizeBatchColor,
normalizeSegmentType,
buildSvgPath,
getBatchRegistry: () => batchRegistry,
};
`;
let clock = 1_000_000;
let timerId = 0;
const timers = [];
function fakeSetTimeout(callback, delay = 0) {
const timer = {
id: ++timerId,
at: clock + Math.max(0, Number(delay) || 0),
callback,
};
timers.push(timer);
return timer.id;
}
function fakeClearTimeout(id) {
const index = timers.findIndex(timer => timer.id === id);
if (index >= 0) timers.splice(index, 1);
}
function advance(ms) {
const end = clock + Math.max(0, Number(ms) || 0);
while (true) {
let nextIndex = -1;
for (let i = 0; i < timers.length; i++) {
if (timers[i].at <= end && (nextIndex < 0 || timers[i].at < timers[nextIndex].at)) {
nextIndex = i;
}
}
if (nextIndex < 0) break;
const [timer] = timers.splice(nextIndex, 1);
clock = Math.max(clock, timer.at);
timer.callback();
}
clock = end;
}
const document = createDocument();
const queueRoot = document.createElement("div");
queueRoot.setAttribute("data-testid", "job-assets-list");
document.body.appendChild(queueRoot);
const storage = new Map();
const localStorage = {
getItem(key) {
return storage.has(key) ? storage.get(key) : null;
},
setItem(key, value) {
storage.set(key, String(value));
},
};
function info(promptId, batchId, color, itemIndex, batchCount, queuedAt) {
return {
prompt_id: promptId,
batchId,
batchNumber: 1,
batchCount,
itemIndex,
color,
colorIndex: 0,
queuedAt,
};
}
const seeded = [];
for (let index = 0; index < 260; index++) {
seeded.push(info(`old-${index}`, `old-batch-${index}`, "#10b981", 0, 1, index + 1));
}
seeded.push(info("evil-a", "batch-evil", '#fff" onload="alert(1)', 0, 2, 1000));
seeded.push(info("evil-b", "batch-evil", "</style><script>alert(1)</script>", 1, 2, 1001));
seeded.push(info("bad-count", "batch-bad", "#123456", "not-an-int", -5, 1002));
seeded.push(info("evil-c", "batch-evil-c", '#fff" onload="alert(1)', 0, 1, 1003));
seeded.push(info("low-index", "batch-low-index", "#123456", -5, 3, 1004));
seeded.push(info("high-index", "batch-high-index", "#123456", 99, 3, 1005));
storage.set("saturnnodes_batch_queue_meta", JSON.stringify(seeded));
storage.set("saturnnodes_batch_counter", "-12");
const serverBatchData = {
// Older server data must not replace newer local metadata.
"old-0": info("old-0", "old-batch-0", "#10b981", 0, 1, 0),
// Newer server data must replace older local metadata.
"old-1": info("old-1", "old-batch-1", "#10b981", 0, 1, 9999),
"server-only": info("server-only", "server-batch", "#3b82f6", 0, 1, 2000),
};
const apiEvents = new Map();
const deferred = [];
let nextPid = 0;
const api = {
clientId: "client-test",
queuePrompt: () => new Promise(resolve => {
deferred.push(() => resolve({ prompt_id: `conc-${++nextPid}` }));
}),
fetchApi: async url => {
if (url === "/saturnnodes/batch_queue/data") {
return { ok: true, json: async () => serverBatchData };
}
return null;
},
addEventListener(name, callback) {
if (!apiEvents.has(name)) apiEvents.set(name, []);
apiEvents.get(name).push(callback);
},
};
const extension = { name: "", setup: null };
const app = {
extensionManager: { setting: { get: () => true } },
registerExtension(candidate) {
extension.name = candidate.name;
extension.setup = candidate.setup;
},
async queuePrompt(number, batchCount, queueNodeIds) {
// Both submissions start before either response arrives. This is the
// concurrency window that used to race on prompts.length.
const first = api.queuePrompt(number, { output: {} }, queueNodeIds);
const second = api.queuePrompt(number, { output: {} }, queueNodeIds);
return await Promise.all([first, second]);
},
};
const mathStub = Object.create(Math);
let randomSeed = 0;
mathStub.random = () => ((++randomSeed * 0.6180339887) % 1);
const context = vm.createContext({
console,
app,
api,
authenticatedFetch: async () => ({ ok: true }),
document,
localStorage,
MutationObserver: FakeMutationObserver,
setTimeout: fakeSetTimeout,
clearTimeout: fakeClearTimeout,
Date: { now: () => clock },
Math: mathStub,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
parseInt,
isNaN,
Infinity,
});
vm.runInContext(source, context, { filename: sourcePath });
const batchTest = context.__batchTest;
assert.equal(typeof extension.setup, "function", "batch queue extension must register");
await extension.setup();
await new Promise(resolve => setImmediate(resolve));
advance(100);
// ---------------------------------------------------------------------------
// Restored storage is pruned by queuedAt, not by Map insertion order.
// ---------------------------------------------------------------------------
const savedAfterLoad = JSON.parse(storage.get("saturnnodes_batch_queue_meta"));
assert.equal(savedAfterLoad.length, 250, "restored metadata must be pruned to 250 entries");
const savedIds = new Set(savedAfterLoad.map(entry => entry.prompt_id));
assert.equal(savedIds.has("old-0"), false, "oldest restored metadata must be pruned");
assert.equal(savedIds.has("old-259"), true, "newest restored metadata must be kept");
assert.equal(savedIds.has("evil-a"), true, "malicious-color entries must not be dropped");
assert.equal(savedIds.has("server-only"), true, "newer server metadata must be merged");
const registry = batchTest.getBatchRegistry();
assert.equal(registry.get("old-0").queuedAt, 1, "older server snapshot must not overwrite local metadata");
assert.equal(registry.get("old-1").queuedAt, 9999, "newer server snapshot must replace local metadata");
// ---------------------------------------------------------------------------
// Restored rows with injected color strings must render safe hex colors only.
// ---------------------------------------------------------------------------
function makeRow(promptId) {
const row = document.createElement("div");
row.setAttribute("data-job-id", promptId);
queueRoot.appendChild(row);
return row;
}
const evilA = makeRow("evil-a");
const evilB = makeRow("evil-b");
const badCount = makeRow("bad-count");
const lowIndex = makeRow("low-index");
const highIndex = makeRow("high-index");
const duplicateEvilA = makeRow("evil-a");
await batchTest.updateQueueBatchVisuals();
const evilALine = evilA.querySelector(".saturnnodes-batch-line-wrap");
const evilBLine = evilB.querySelector(".saturnnodes-batch-line-wrap");
assert.ok(evilALine, "restored row must receive a batch line");
assert.ok(evilBLine, "restored row must receive a batch line");
assert.match(evilALine.innerHTML, /#10b981/, "invalid color must fall back to the default hex color");
assert.doesNotMatch(evilALine.innerHTML, /alert|onload|<script/i, "color injection must never reach innerHTML");
assert.match(evilBLine.innerHTML, /#10b981/, "markup color must fall back to the default hex color");
assert.doesNotMatch(evilBLine.innerHTML, /alert|<script|<\/style/i, "markup color must never reach innerHTML");
assert.match(
evilALine.innerHTML,
/M 9,6 Q 2,6 2,16 L 2,48/,
"the first visible item of a restored batch must draw the first segment"
);
assert.match(
evilBLine.innerHTML,
/M 2,0 L 2,32 Q 2,42 9,42/,
"the last visible item of a restored batch must draw the last segment"
);
assert.equal(
duplicateEvilA.querySelector(".saturnnodes-batch-line-wrap"),
null,
"a duplicate restored row must not receive a second line"
);
const badLine = badCount.querySelector(".saturnnodes-batch-line-wrap");
assert.ok(badLine, "invalid batch counters must still render a line");
assert.match(badLine.innerHTML, /#123456/, "valid custom hex colors must be preserved");
assert.match(
badLine.innerHTML,
/M 9,6 Q 2,6 2,16 L 2,32 Q 2,42 9,42/,
"negative batchCount and non-integer itemIndex must clamp to a single segment"
);
const lowIndexLine = lowIndex.querySelector(".saturnnodes-batch-line-wrap");
assert.ok(lowIndexLine, "negative itemIndex must still render a line");
assert.match(
lowIndexLine.innerHTML,
/M 9,6 Q 2,6 2,16 L 2,48/,
"a negative itemIndex must clamp to the first segment"
);
const highIndexLine = highIndex.querySelector(".saturnnodes-batch-line-wrap");
assert.ok(highIndexLine, "out-of-range itemIndex must still render a line");
assert.match(
highIndexLine.innerHTML,
/M 2,0 L 2,32 Q 2,42 9,42/,
"an out-of-range itemIndex must clamp to the last segment"
);
// Direct sanitizer checks.
assert.equal(batchTest.normalizeBatchColor("#ABC"), "#ABC");
assert.equal(batchTest.normalizeBatchColor("#ABCD"), "#ABCD");
assert.equal(batchTest.normalizeBatchColor("#123456"), "#123456");
assert.equal(batchTest.normalizeBatchColor("#12345678"), "#12345678");
assert.equal(batchTest.normalizeBatchColor(" #10b981 "), "#10b981");
assert.equal(batchTest.normalizeBatchColor("#12345"), "#10b981");
assert.equal(batchTest.normalizeBatchColor("#1234567"), "#10b981");
assert.equal(batchTest.normalizeBatchColor("red"), "#10b981");
assert.equal(batchTest.normalizeBatchColor("url(javascript:alert(1))"), "#10b981");
assert.equal(batchTest.normalizeSegmentType("bogus"), "single");
assert.equal(batchTest.normalizeSegmentType('"><script>alert(1)</script>'), "single");
assert.equal(batchTest.buildSvgPath("bogus"), batchTest.buildSvgPath("single"));
// ---------------------------------------------------------------------------
// A negative persisted counter must clamp to a valid BATCH_COLORS index.
// ---------------------------------------------------------------------------
const submission = app.queuePrompt(-1, 2, null);
await Promise.resolve();
await Promise.resolve();
assert.equal(deferred.length, 2, "both concurrent submissions must reserve an item index");
deferred.shift()();
deferred.shift()();
await submission;
const afterBatch = JSON.parse(storage.get("saturnnodes_batch_queue_meta"));
const concOne = afterBatch.find(entry => entry.prompt_id === "conc-1");
const concTwo = afterBatch.find(entry => entry.prompt_id === "conc-2");
assert.ok(concOne && concTwo, "both concurrent prompts must be recorded");
assert.equal(concOne.batchId, concTwo.batchId, "concurrent prompts must share one batch");
assert.deepEqual(
[concOne.itemIndex, concTwo.itemIndex].sort((a, b) => a - b),
[0, 1],
"concurrent submissions must reserve unique item indexes"
);
assert.equal(concOne.color, "#10b981", "a negative persisted counter must clamp to color index 0");
assert.equal(concOne.colorIndex, 0);
assert.equal(concTwo.batchCount, 2);
// The completed batch must release the active context, so the next standalone
// submission starts a fresh single-item batch.
const standalone = api.queuePrompt(0, { output: {} }, null);
await Promise.resolve();
await Promise.resolve();
assert.equal(deferred.length, 1, "standalone submission must reach the queue hook");
deferred.shift()();
await standalone;
const afterStandalone = JSON.parse(storage.get("saturnnodes_batch_queue_meta"));
const concThree = afterStandalone.find(entry => entry.prompt_id === "conc-3");
assert.ok(concThree, "standalone prompt must be recorded");
assert.notEqual(concThree.batchId, concOne.batchId, "completed batch context must be cleared");
assert.equal(concThree.batchCount, 1);
assert.equal(concThree.color, "#3b82f6", "the next batch must advance the color counter");
// ---------------------------------------------------------------------------
// Reused restored cards repaint after Vue changes data-job-id.
// ---------------------------------------------------------------------------
const observer = FakeMutationObserver.instances.find(
item => item.target === document.body && item.options?.attributes
);
assert.ok(observer, "queue observer must watch attribute changes");
const reused = makeRow("old-259");
await batchTest.updateQueueBatchVisuals();
assert.ok(reused.querySelector(".saturnnodes-batch-line-wrap"), "reused card must get a line");
reused.setAttribute("data-job-id", "evil-c");
observer.emit([{ target: reused, type: "attributes", attributeName: "data-job-id" }]);
advance(100);
assert.match(
reused.querySelector(".saturnnodes-batch-line-wrap").innerHTML,
/#10b981/,
"reused card must repaint with the new job's safe batch color"
);
console.log("batch queue restore DOM regression test passed");
+309
View File
@@ -0,0 +1,309 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
// Regression coverage for the queue-path bleed reported in the LoRA loader
// audit follow-up:
//
// Queue prompt 1, then queue prompt 2 while prompt 1 is still being
// submitted, then edit the canvas. ComfyUI serializes prompt 2 only after
// prompt 1's submission turn finishes, so without a click-time snapshot the
// edited text/LoRA selection bleeds into prompt 2.
//
// The fake ComfyUI queue below mirrors the real `app.queuePrompt` loop: it
// pushes items, returns early while `processingQueue` is true, and calls
// `graphToPrompt()` freshly for every submitted item.
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "batch_queue.js");
class FakeStyleElement {
constructor() {
this.textContent = "";
this.id = "";
this.children = [];
}
remove() {}
appendChild(child) {
this.children.push(child);
return child;
}
querySelector() {
return null;
}
querySelectorAll() {
return [];
}
}
const document = {
body: new FakeStyleElement(),
head: new FakeStyleElement(),
getElementById() {
return null;
},
createElement() {
return new FakeStyleElement();
},
querySelector() {
return null;
},
querySelectorAll() {
return [];
},
};
const storage = new Map();
const localStorage = {
getItem(key) {
return storage.has(key) ? storage.get(key) : null;
},
setItem(key, value) {
storage.set(key, String(value));
},
};
class FakeMutationObserver {
constructor(callback) {
this.callback = callback;
}
observe() {}
disconnect() {}
}
// --- Fake ComfyUI canvas + queue ---------------------------------------------
const canvas = { text: "", lora: "[]", seed: 1 };
const submissions = [];
const pendingResponses = [];
let graphToPromptCalls = 0;
let nextPromptId = 0;
async function graphToPrompt() {
graphToPromptCalls++;
// Read values synchronously, like the real serializer does.
return {
output: {
"10": {
inputs: {
text: canvas.text,
_selected_lora: canvas.lora,
seed: canvas.seed,
},
},
},
workflow: { nodes: [] },
};
}
async function apiQueuePrompt(number, prompt) {
// Copy the prompt exactly as it will be sent to the server.
submissions.push(JSON.parse(JSON.stringify(prompt)));
await new Promise(resolve => pendingResponses.push(resolve));
nextPromptId++;
return { prompt_id: `pid-${nextPromptId}` };
}
async function comfyQueuePrompt(number, batchCount = 1) {
this.queueItems.push({ number, batchCount });
if (this.processingQueue) return false;
this.processingQueue = true;
try {
while (this.queueItems.length) {
const item = this.queueItems.pop();
for (let r = 0; r < item.batchCount; r++) {
const prompt = await this.graphToPrompt(this.rootGraph);
await api.queuePrompt(item.number, prompt);
}
}
} finally {
this.processingQueue = false;
}
return true;
}
const extension = { setup: null };
const app = {
queuePrompt: comfyQueuePrompt,
graphToPrompt,
graph: { getNodeById: () => null },
queueItems: [],
processingQueue: false,
extensionManager: { setting: { get: () => true } },
registerExtension(candidate) {
extension.setup = candidate.setup;
},
setDirtyCanvas() {},
};
const api = {
queuePrompt: apiQueuePrompt,
fetchApi: async () => null,
addEventListener() {},
};
const source = fs
.readFileSync(sourcePath, "utf8")
.replace(/^import .*$/gm, "")
.replace(/export \{[^}]*\};?\s*$/m, "");
const context = vm.createContext({
console,
app,
api,
authenticatedFetch: async () => null,
document,
localStorage,
MutationObserver: FakeMutationObserver,
setTimeout: (callback) => setTimeout(callback, 0),
clearTimeout,
Date,
Math,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
parseInt,
isNaN,
Infinity,
});
vm.runInContext(source, context, { filename: sourcePath });
assert.equal(typeof extension.setup, "function", "batch queue extension must register");
await extension.setup();
const flush = async () => {
for (let i = 0; i < 50; i++) await Promise.resolve();
};
const resolveNext = async () => {
const resolve = pendingResponses.shift();
assert.ok(resolve, "expected a pending API submission");
resolve();
await flush();
};
const resetCanvas = (text, lora = "[]", seed = 1) => {
canvas.text = text;
canvas.lora = lora;
canvas.seed = seed;
};
const promptText = index => submissions[index].output["10"].inputs.text;
const promptLora = index => submissions[index].output["10"].inputs._selected_lora;
const promptSeed = index => submissions[index].output["10"].inputs.seed;
// --- Scenario 1: queued prompt must keep the text/LoRA shown at click time ---
resetCanvas("prompt one text", '["LoRA_A.safetensors"]');
graphToPromptCalls = 0;
// First click starts submission immediately (no extra snapshot needed).
const first = app.queuePrompt(0, 1);
await flush();
assert.equal(app.processingQueue, true, "first submission must be in flight");
assert.equal(graphToPromptCalls, 1, "an idle click must not serialize twice");
// The user immediately clicks Queue again, then keeps editing the canvas
// while the first prompt is still being submitted.
const second = app.queuePrompt(0, 1);
assert.equal(
graphToPromptCalls,
2,
"a queued click during an in-flight submission must snapshot the graph at click time"
);
canvas.text = "prompt two text"; // edited after both clicks
canvas.lora = '["LoRA_B.safetensors"]';
canvas.seed = 2;
await resolveNext(); // finish prompt one
await resolveNext(); // finish prompt two
await Promise.all([first, second]);
await flush();
assert.equal(submissions.length, 2, "both queued prompts must be submitted");
assert.equal(promptText(0), "prompt one text");
assert.equal(promptLora(0), '["LoRA_A.safetensors"]');
assert.equal(
promptText(1),
"prompt one text",
"canvas text edited after the click must not bleed into the queued prompt"
);
assert.equal(
promptLora(1),
'["LoRA_A.safetensors"]',
"LoRA selection edited after the click must not bleed into the queued prompt"
);
// --- Scenario 2: a multi-item batch stays frozen at click time --------------
submissions.length = 0;
resetCanvas("batch base text", '["LoRA_C.safetensors"]', 3);
app.queueItems.length = 0;
const batch = app.queuePrompt(0, 3);
await flush(); // item 0 in flight
canvas.text = "edited mid batch"; // must not leak into items 2/3
canvas.lora = '["LoRA_D.safetensors"]';
canvas.seed = 99;
await resolveNext(); // item 0
await resolveNext(); // item 1
await resolveNext(); // item 2
await batch;
await flush();
assert.equal(submissions.length, 3);
for (let i = 0; i < 3; i++) {
assert.equal(promptText(i), "batch base text", `batch item ${i + 1} text must stay frozen`);
assert.equal(
promptLora(i),
'["LoRA_C.safetensors"]',
`batch item ${i + 1} LoRA must stay frozen`
);
}
// --- Scenario 3: dynamic seeds still follow the live prompt -----------------
submissions.length = 0;
resetCanvas("blocker", "[]", 10);
const blocker = app.queuePrompt(0, 1);
await flush(); // blocker in flight so the next click has a submission backlog
resetCanvas("seed batch", "[]", 11);
const seeded = app.queuePrompt(0, 2);
await flush();
canvas.seed = 12; // simulates the seed widget randomizing before submission
await resolveNext(); // blocker
await resolveNext(); // seeded item 0
await resolveNext(); // seeded item 1
await blocker;
await seeded;
await flush();
assert.equal(submissions.length, 3);
assert.equal(promptSeed(1), 12, "item 0 must use the seed the live prompt queued");
assert.equal(promptSeed(2), 12, "item 1 must use the live seed after merging");
assert.equal(promptText(1), "seed batch");
assert.equal(promptText(2), "seed batch");
// --- Scenario 4: idle clicks keep serializing once and never double-queue ---
submissions.length = 0;
resetCanvas("solo", "[]", 20);
const solo = app.queuePrompt(0, 1);
await flush();
assert.equal(graphToPromptCalls > 0, true);
await resolveNext();
await solo;
assert.equal(submissions.length, 1);
assert.equal(promptText(0), "solo");
console.log("batch queue click-time snapshot DOM test passed");
+157
View File
@@ -0,0 +1,157 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import {
FakeMutationObserver,
createDocument,
createWindow,
stripImports,
} from "./fake_dom.mjs";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "js", "copy_prompt.js");
const document = createDocument();
const window = createWindow(document);
const extension = { name: "", beforeRegisterNodeDef: null };
const app = {
registerExtension(candidate) {
extension.name = candidate.name;
extension.beforeRegisterNodeDef = candidate.beforeRegisterNodeDef;
},
extensionManager: {
setting: { get: () => true },
toast: { add() {} },
},
ui: { settings: { get: () => undefined, getSettingValue: () => undefined } },
graph: { setDirtyCanvas() {} },
};
let source = stripImports(fs.readFileSync(sourcePath, "utf8"));
source += `
globalThis.__copyTest = {
registerAssetInteraction,
getActiveImageSrc,
injectHoverCopyAction,
setCopyImagePrompt: (fn) => { copyImagePrompt = fn; },
getLastCard: () => lastInteractedAssetCard,
};
`;
const copied = [];
const context = vm.createContext({
console,
document,
window,
navigator: {},
app,
api: { addEventListener() {}, fetchApi: async () => null },
MutationObserver: FakeMutationObserver,
setTimeout: () => 0,
clearTimeout: () => {},
setInterval: () => 0,
clearInterval: () => {},
Math,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
Date,
parseInt,
isNaN,
Infinity,
Node: { ELEMENT_NODE: 1 },
MouseEvent: class MouseEvent {
constructor(type, init = {}) {
this.type = type;
this.bubbles = !!init.bubbles;
this.cancelable = !!init.cancelable;
}
},
});
vm.runInContext(source, context, { filename: sourcePath });
assert.equal(typeof extension.beforeRegisterNodeDef, "function", "copy prompt extension must register");
const {
registerAssetInteraction,
getActiveImageSrc,
injectHoverCopyAction,
setCopyImagePrompt,
getLastCard,
} = context.__copyTest;
setCopyImagePrompt(async src => {
copied.push(src);
return true;
});
function makeCard(assetId, src) {
const card = document.createElement("div");
card.setAttribute("data-asset-id", assetId);
const img = document.createElement("img");
img.src = src;
card.appendChild(img);
document.body.appendChild(card);
return { card, img };
}
// 1. A fresh interaction resolves the current asset.
const first = makeCard("asset-1", "a.png");
registerAssetInteraction(first.img);
assert.equal(getActiveImageSrc(), "a.png", "fresh card interaction must resolve its image");
// 2. The virtual grid recycles the same element for another asset. The stale
// pointer must not silently copy the new asset.
first.card.setAttribute("data-asset-id", "asset-2");
first.img.src = "b.png";
assert.equal(getActiveImageSrc(), null, "recycled card must not resolve a different asset");
assert.equal(getLastCard(), null, "recycled card must be discarded");
// 3. A detached card is discarded as well.
registerAssetInteraction(first.img);
first.card.remove();
assert.equal(getActiveImageSrc(), null, "detached card must not resolve an image");
assert.equal(getLastCard(), null, "detached card must be cleared");
// 4. Legacy hover overlay: the injected button must follow the asset that is
// currently displayed instead of keeping a closure over the old <img>.
const legacy = makeCard("asset-3", "c.png");
const overlay = document.createElement("div");
overlay.className = "asset-card-overlay";
legacy.card.appendChild(overlay);
injectHoverCopyAction(overlay);
const oldButton = overlay.querySelector(".saturnnodes-hover-copy");
assert.ok(oldButton, "legacy overlay must receive a copy button");
assert.equal(oldButton.dataset.saturnnodesAssetKey, "asset:asset-3", "button is bound to the current asset");
await oldButton.onclick({ preventDefault() {}, stopPropagation() {} });
assert.deepEqual(copied, ["c.png"], "legacy button must copy the displayed image");
// Recycle the same overlay for another asset. The old button must be replaced,
// not left bound to c.png.
legacy.card.setAttribute("data-asset-id", "asset-4");
legacy.img.src = "d.png";
injectHoverCopyAction(overlay);
const newButton = overlay.querySelector(".saturnnodes-hover-copy");
assert.ok(newButton, "recycled overlay must still have a copy button");
assert.notEqual(newButton, oldButton, "recycled overlay must rebind the copy button");
assert.equal(newButton.dataset.saturnnodesAssetKey, "asset:asset-4", "button is rebound to the new asset");
await newButton.onclick({ preventDefault() {}, stopPropagation() {} });
assert.deepEqual(copied, ["c.png", "d.png"], "rebound button must copy the new image");
// 5. Re-injecting for the same asset must not churn the button.
injectHoverCopyAction(overlay);
assert.equal(overlay.querySelector(".saturnnodes-hover-copy"), newButton, "same asset must keep the existing button");
console.log("copy prompt DOM regression test passed");
+212
View File
@@ -0,0 +1,212 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import {
FakeMutationObserver,
createDocument,
createWindow,
stripImports,
} from "./fake_dom.mjs";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "js", "copy_prompt.js");
const document = createDocument();
const window = createWindow(document);
const extension = { name: "", beforeRegisterNodeDef: null };
const app = {
registerExtension(candidate) {
extension.name = candidate.name;
extension.beforeRegisterNodeDef = candidate.beforeRegisterNodeDef;
},
extensionManager: {
setting: { get: () => true },
toast: { add() {} },
},
ui: { settings: { get: () => undefined, getSettingValue: () => undefined } },
graph: { setDirtyCanvas() {} },
};
let source = stripImports(fs.readFileSync(sourcePath, "utf8"));
source += `
globalThis.__copyTest = {
injectCopyPromptNextToDownload,
injectContextMenuCopy,
injectHoverCopyAction,
registerAssetInteraction,
getActiveImageSrc,
scanAndInject,
setCopyImagePrompt: (fn) => { copyImagePrompt = fn; },
};
`;
const copied = [];
const context = vm.createContext({
console,
document,
window,
navigator: {},
app,
api: { addEventListener() {}, fetchApi: async () => null },
MutationObserver: FakeMutationObserver,
setTimeout: () => 0,
clearTimeout: () => {},
setInterval: () => 0,
clearInterval: () => {},
Math,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
Date,
parseInt,
isNaN,
Infinity,
Node: { ELEMENT_NODE: 1 },
MouseEvent: class MouseEvent {
constructor(type, init = {}) {
this.type = type;
this.bubbles = !!init.bubbles;
this.cancelable = !!init.cancelable;
}
},
});
vm.runInContext(source, context, { filename: sourcePath });
assert.equal(typeof extension.beforeRegisterNodeDef, "function", "copy prompt extension must register");
const copyTest = context.__copyTest;
copyTest.setCopyImagePrompt(async src => {
copied.push(src);
return true;
});
const observer = FakeMutationObserver.instances.find(
item => item.target === document.body && item.options?.childList
);
assert.ok(observer, "copy prompt extension must observe restored DOM insertions");
function makeCard(assetId, src, { queue = false, icon = false, attach = true } = {}) {
const card = document.createElement("div");
card.className = "asset-card";
if (assetId) card.setAttribute("data-asset-id", assetId);
if (queue) card.setAttribute("data-job-id", "job-1");
const img = document.createElement("img");
img.src = src;
if (icon) img.classList.add("size-8");
card.appendChild(img);
const bar = document.createElement("div");
const download = document.createElement("button");
download.setAttribute("aria-label", "Download");
bar.appendChild(download);
card.appendChild(bar);
if (attach) document.body.appendChild(card);
return { card, img, bar, download };
}
function insertRestored(card) {
observer.emit([{ type: "childList", target: document.body, addedNodes: [card], removedNodes: [] }]);
}
// 1. A restored asset card inserted after page load receives a copy button
// through the MutationObserver path (not only through the periodic scan).
const restored = makeCard("restored-1", "restored.png", { attach: false });
insertRestored(restored.card);
const restoredButton = restored.bar.querySelector(".saturnnodes-hover-copy");
assert.ok(restoredButton, "restored card must receive a copy button");
await restoredButton.onclick({ preventDefault() {}, stopPropagation() {} });
assert.deepEqual(copied, ["restored.png"], "restored copy button must copy the restored image");
// 2. Restored queue rows must never receive asset-card buttons.
const queueRow = makeCard("queue-1", "queued.png", { queue: true, attach: false });
insertRestored(queueRow.card);
assert.equal(
queueRow.bar.querySelector(".saturnnodes-hover-copy"),
null,
"restored queue rows must not receive asset copy buttons"
);
// 3. Tiny icon images (download/status icons) must not be treated as assets.
const iconCard = makeCard("icon-1", "icon.png", { icon: true, attach: false });
insertRestored(iconCard.card);
assert.equal(
iconCard.bar.querySelector(".saturnnodes-hover-copy"),
null,
"icon-sized images must not receive asset copy buttons"
);
// 4. A restored card reused for another asset must copy the asset currently
// displayed, not the one captured when the button was injected.
const recycled = makeCard("recycled-1", "first.png", { attach: false });
insertRestored(recycled.card);
const recycledButton = recycled.bar.querySelector(".saturnnodes-hover-copy");
assert.ok(recycledButton, "recycled card must start with a copy button");
recycled.card.setAttribute("data-asset-id", "recycled-2");
recycled.img.src = "second.png";
await recycledButton.onclick({ preventDefault() {}, stopPropagation() {} });
assert.deepEqual(copied, ["restored.png", "second.png"], "reused button must copy the live image");
// 5. Re-injecting for the same restored card must not duplicate the button.
copyTest.injectCopyPromptNextToDownload(recycled.download);
assert.equal(
recycled.bar.querySelectorAll(".saturnnodes-hover-copy").length,
1,
"restored card must keep exactly one copy button"
);
// 6. Context menus attached to restored cards inject one copy item and copy
// the currently interacted asset.
const menuCard = makeCard("menu-1", "menu-image.png");
copyTest.registerAssetInteraction(menuCard.img);
const menu = document.createElement("div");
menu.className = "p-contextmenu";
const downloadItem = document.createElement("li");
downloadItem.setAttribute("role", "menuitem");
downloadItem.setAttribute("aria-label", "Download");
const downloadButton = document.createElement("button");
downloadItem.appendChild(downloadButton);
menu.appendChild(downloadItem);
document.body.appendChild(menu);
copyTest.injectContextMenuCopy(menu);
const copyItem = menu.querySelector(".saturnnodes-contextmenu-copy");
assert.ok(copyItem, "restored context menu must receive a copy item");
assert.equal(
menu.querySelectorAll(".saturnnodes-contextmenu-copy").length,
1,
"context menu injection must be idempotent"
);
const beforeMenuClick = copied.length;
copyItem.dispatchEvent({ type: "click", preventDefault() {}, stopPropagation() {} });
await Promise.resolve();
await Promise.resolve();
assert.deepEqual(copied.slice(beforeMenuClick), ["menu-image.png"], "menu must copy the active asset");
// 7. A restored card without an asset id but with a stable image URL still
// resolves its image for menu actions.
const srcCard = makeCard(null, "src-only.png");
copyTest.registerAssetInteraction(srcCard.img);
assert.equal(copyTest.getActiveImageSrc(), "src-only.png");
// 8. The periodic scanner must inject into restored cards even when no
// mutation was observed for them (e.g. restored before the observer ran).
const scanned = makeCard("scanned-1", "scanned.png");
copyTest.scanAndInject();
assert.ok(
scanned.bar.querySelector(".saturnnodes-hover-copy"),
"periodic scan must cover restored cards"
);
console.log("copy prompt restore DOM regression test passed");
+133
View File
@@ -0,0 +1,133 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import {
FakeMutationObserver,
createDocument,
createWindow,
stripImports,
} from "./fake_dom.mjs";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "floating_latent_dock.js");
const document = createDocument();
const window = createWindow(document);
const extension = { name: "", setup: null };
const app = {
registerExtension(candidate) {
extension.name = candidate.name;
extension.setup = candidate.setup;
},
ui: { settings: { get: () => undefined, getSettingValue: () => undefined } },
graph: { setDirtyCanvas() {} },
};
let source = stripImports(fs.readFileSync(sourcePath, "utf8"));
source += "\nglobalThis.__dockTest = { FloatingLatentDock };\n";
const context = vm.createContext({
console,
document,
window,
app,
api: { addEventListener() {} },
localStorage: { getItem: () => null, setItem() {} },
MutationObserver: FakeMutationObserver,
setTimeout,
clearTimeout,
setInterval: () => 0,
clearInterval: () => {},
requestAnimationFrame: window.requestAnimationFrame,
cancelAnimationFrame: window.cancelAnimationFrame,
Math,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
Date,
parseInt,
isNaN,
Infinity,
});
vm.runInContext(source, context, { filename: sourcePath });
assert.equal(typeof extension.setup, "function", "floating dock extension must register");
const { FloatingLatentDock } = context.__dockTest;
const dock = {
dockEl: document.createElement("div"),
btnEl: null,
updates: 0,
requestPositionUpdate() {
this.updates++;
},
};
document.body.appendChild(dock.dockEl);
// 1. No minimap and no toolbar: dock sits at the fallback offset.
FloatingLatentDock.prototype.updatePosition.call(dock);
assert.equal(dock.dockEl.style.bottom, "54px", "fallback dock offset");
// 2. A minimap mounted deep in the tree moves the dock above it.
const minimap = document.createElement("div");
minimap.className = "minimap-main-container";
minimap.setRect({ top: 700, height: 150, bottom: 850 });
minimap.offsetParent = {};
document.body.appendChild(minimap);
FloatingLatentDock.prototype.updatePosition.call(dock);
assert.equal(dock.dockEl.style.bottom, "208px", "dock must sit 8px above the minimap");
// 3. The observer must react to a deep minimap insertion/removal, not only to
// direct children of <body>.
FloatingLatentDock.prototype.setupPositionObserver.call(dock);
const observer = FakeMutationObserver.instances.find(
item => item.options?.childList && item.options?.subtree
);
assert.ok(observer, "dock observer must watch the whole subtree");
observer.emit([{
type: "childList",
target: document.body,
addedNodes: [minimap],
removedNodes: [],
}]);
assert.equal(dock.updates, 1, "minimap insertion must request a position update");
observer.emit([{
type: "childList",
target: document.body,
addedNodes: [document.createElement("div")],
removedNodes: [],
}]);
assert.equal(dock.updates, 1, "unrelated DOM insertions must not request updates");
observer.emit([{
type: "childList",
target: document.body,
addedNodes: [],
removedNodes: [minimap],
}]);
assert.equal(dock.updates, 2, "minimap removal must request a position update");
// 4. Removing the minimap restores the toolbar-based offset.
minimap.remove();
const toolbar = document.createElement("div");
toolbar.setAttribute("role", "toolbar");
toolbar.setAttribute("aria-label", "Canvas Toolbar");
toolbar.setRect({ top: 820, height: 40, bottom: 860 });
document.body.appendChild(toolbar);
FloatingLatentDock.prototype.updatePosition.call(dock);
assert.equal(dock.dockEl.style.bottom, "88px", "dock must sit 8px above the canvas toolbar");
console.log("floating dock DOM regression test passed");
+46
View File
@@ -0,0 +1,46 @@
import os
import shutil
import subprocess
import unittest
DOM_TESTS = [
"test_power_popup_dom.mjs",
"test_copy_prompt_dom.mjs",
"test_copy_prompt_restore_dom.mjs",
"test_floating_dock_dom.mjs",
"test_widget_guards_dom.mjs",
"test_queue_height_dom.mjs",
"test_batch_queue_dom.mjs",
"test_batch_queue_snapshot_dom.mjs",
"test_batch_queue_restore_dom.mjs",
"test_persistent_queue_claim_dom.mjs",
]
class TestFrontendDomRegressions(unittest.TestCase):
def test_dom_regressions(self):
node = shutil.which("node")
if not node:
self.skipTest("Node.js is not available")
repo_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
for script_name in DOM_TESTS:
with self.subTest(script=script_name):
script = os.path.join(repo_root, "tests", script_name)
result = subprocess.run(
[node, script],
cwd=repo_root,
capture_output=True,
text=True,
timeout=60,
)
self.assertEqual(
result.returncode,
0,
msg=f"{script_name} failed:\n{result.stdout}\n{result.stderr}",
)
if __name__ == "__main__":
unittest.main()
+46
View File
@@ -0,0 +1,46 @@
import os
import re
import unittest
WEB_ROOT = os.path.join(
os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "web"
)
# ComfyUI's settings API warns every time getSettingValue() receives a default
# value as its second argument. Settings definitions already carry defaults, so
# the argument is redundant and floods the browser console when called per item.
DEPRECATED_SECOND_ARGUMENT = re.compile(
r"""getSettingValue\s*\??\.?\s*\(\s*(?:"[^"]*"|'[^']*'|`[^`]*`)\s*,"""
)
class TestFrontendSettingsApi(unittest.TestCase):
def test_no_deprecated_default_value_argument(self):
offenders = []
for root, _dirs, files in os.walk(WEB_ROOT):
for name in sorted(files):
if not name.endswith(".js"):
continue
path = os.path.join(root, name)
with open(path, encoding="utf-8") as handle:
source = handle.read()
for match in DEPRECATED_SECOND_ARGUMENT.finditer(source):
line_number = source.count("\n", 0, match.start()) + 1
relative = os.path.relpath(path, WEB_ROOT)
offenders.append(f"{relative}:{line_number}")
self.assertEqual(
offenders,
[],
msg=(
"getSettingValue(id, defaultValue) is deprecated in ComfyUI and "
"logs a console warning on every call. Read the setting default "
"from its definition instead: "
+ ", ".join(offenders)
),
)
if __name__ == "__main__":
unittest.main()
+239
View File
@@ -0,0 +1,239 @@
import json
import math
import os
import shutil
import sys
import tempfile
import threading
import unittest
from unittest.mock import patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper # noqa: F401 (redirects SaturnNodes state to a temp dir)
import nodes.generation_times as generation_times
class TestGenerationTimesExtended(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.mkdtemp()
self.old_file = generation_times.GENERATION_TIMES_FILE
self.old_user_dir = generation_times.USER_DIR
self.old_data = generation_times._DATA
self.old_mtime = generation_times._DATA_MTIME
self.old_patched = generation_times._PATCHED
self.old_starts = dict(generation_times._START_TIMES)
generation_times.GENERATION_TIMES_FILE = os.path.join(self.temp_dir, "generation_times.json")
generation_times.USER_DIR = self.temp_dir
generation_times._DATA = None
generation_times._DATA_MTIME = None
generation_times._PATCHED = False
generation_times._START_TIMES.clear()
def tearDown(self):
generation_times.GENERATION_TIMES_FILE = self.old_file
generation_times.USER_DIR = self.old_user_dir
generation_times._DATA = self.old_data
generation_times._DATA_MTIME = self.old_mtime
generation_times._PATCHED = self.old_patched
generation_times._START_TIMES.clear()
generation_times._START_TIMES.update(self.old_starts)
shutil.rmtree(self.temp_dir, ignore_errors=True)
def _write_payload(self, payload):
with open(generation_times.GENERATION_TIMES_FILE, "w", encoding="utf-8") as handle:
json.dump(payload, handle)
generation_times._DATA = None
generation_times._DATA_MTIME = None
def test_rejects_non_finite_negative_and_non_numeric_durations(self):
bad_values = [float("nan"), float("inf"), float("-inf"), -0.001, "not-a-number", None, object()]
for index, value in enumerate(bad_values):
generation_times.record_generation_time(
f"pid-{index}",
value,
[{"filename": f"bad{index}.png", "subfolder": ""}],
)
self.assertFalse(
os.path.exists(generation_times.GENERATION_TIMES_FILE),
"invalid durations must not create a generation-times file",
)
for index in range(len(bad_values)):
self.assertIsNone(generation_times.get_generation_time(f"bad{index}.png"))
def test_rejects_missing_or_malformed_file_entries(self):
generation_times.record_generation_time("pid", 2.0, None)
generation_times.record_generation_time("pid", 2.0, [])
generation_times.record_generation_time("pid", 2.0, [None, "x", {}, {"filename": ""}])
self.assertIsNone(generation_times.get_generation_time(""))
generation_times.record_generation_time("pid", 2.0, [{"filename": "valid.png"}])
self.assertEqual(generation_times.get_generation_time("valid.png"), 2.0)
def test_rounds_and_overwrites_duplicate_file_keys(self):
generation_times.record_generation_time(
"pid-1", 1.23456, [{"filename": "same.png", "subfolder": "sub"}]
)
self.assertEqual(generation_times.get_generation_time("same.png", "sub"), 1.235)
generation_times.record_generation_time(
"pid-2", 9.0, [{"filename": "same.png", "subfolder": "sub"}]
)
with open(generation_times.GENERATION_TIMES_FILE, "r", encoding="utf-8") as handle:
payload = json.load(handle)
self.assertEqual(len(payload["entries"]), 1)
self.assertEqual(payload["entries"]["sub/same.png"]["duration"], 9.0)
self.assertEqual(payload["entries"]["sub/same.png"]["prompt_id"], "pid-2")
def test_pruning_keeps_the_newest_entries(self):
times = iter([1000.0, 1001.0, 1002.0, 1003.0, 1004.0])
with patch.object(generation_times, "MAX_ENTRIES", 3), \
patch("nodes.generation_times.time.time", side_effect=lambda: next(times)):
for index in range(5):
generation_times.record_generation_time(
f"pid-{index}",
float(index),
[{"filename": f"file{index}.png", "subfolder": ""}],
)
with open(generation_times.GENERATION_TIMES_FILE, "r", encoding="utf-8") as handle:
payload = json.load(handle)
self.assertEqual(
set(payload["entries"]),
{"file2.png", "file3.png", "file4.png"},
)
def test_entry_timestamp_handles_malformed_values(self):
self.assertEqual(generation_times._entry_timestamp(None), 0)
self.assertEqual(generation_times._entry_timestamp("x"), 0)
self.assertEqual(generation_times._entry_timestamp({}), 0)
self.assertEqual(generation_times._entry_timestamp({"completed": "bad"}), 0)
self.assertEqual(generation_times._entry_timestamp({"completed": -10}), 0)
self.assertEqual(generation_times._entry_timestamp({"completed": float("inf")}), 0)
self.assertEqual(generation_times._entry_timestamp({"completed": "1234"}), 1234)
def test_get_generation_time_rejects_corrupt_stored_durations(self):
self._write_payload({
"version": 1,
"entries": {
"nan.png": {"duration": float("nan"), "completed": 1},
"inf.png": {"duration": float("inf"), "completed": 1},
"neg.png": {"duration": -4, "completed": 1},
"text.png": {"duration": "fast", "completed": 1},
"ok.png": {"duration": "1.5", "completed": 1},
},
})
for name in ("nan.png", "inf.png", "neg.png", "text.png"):
self.assertIsNone(generation_times.get_generation_time(name), name)
self.assertEqual(generation_times.get_generation_time("ok.png"), 1.5)
def test_load_data_recovers_from_corrupt_or_legacy_payloads(self):
with open(generation_times.GENERATION_TIMES_FILE, "w", encoding="utf-8") as handle:
handle.write("{ this is not json")
data = generation_times._load_data()
self.assertEqual(data, {"version": 1, "entries": {}})
self._write_payload({"entries": {"legacy.png": {"duration": 2.0, "completed": 5}}})
data = generation_times._load_data()
self.assertEqual(data["version"], 1)
self.assertEqual(generation_times.get_generation_time("legacy.png"), 2.0)
def test_corrupt_entries_are_dropped_on_load_and_save(self):
self._write_payload({
"version": 1,
"entries": {
"nan.png": {"duration": float("nan"), "completed": 1},
"inf.png": {"duration": float("inf"), "completed": 1},
"neg.png": {"duration": -4, "completed": 1},
"text.png": {"duration": "fast", "completed": 1},
"ok.png": {"duration": "1.5", "completed": 1},
"nan-completed.png": {"duration": 2.0, "completed": float("nan")},
},
})
data = generation_times._load_data()
self.assertEqual(set(data["entries"]), {"ok.png", "nan-completed.png"})
self.assertEqual(data["entries"]["ok.png"]["duration"], 1.5)
self.assertEqual(data["entries"]["nan-completed.png"]["completed"], 0)
# A corrupt entry must not make every future save fail under
# allow_nan=False. The valid entry and the new one must persist.
generation_times.record_generation_time(
"pid", 3.0, [{"filename": "new.png", "subfolder": ""}]
)
with open(generation_times.GENERATION_TIMES_FILE, "r", encoding="utf-8") as handle:
payload = json.load(handle)
self.assertEqual(
set(payload["entries"]),
{"ok.png", "nan-completed.png", "new.png"},
)
self.assertEqual(payload["entries"]["new.png"]["duration"], 3.0)
self.assertEqual(payload["entries"]["nan-completed.png"]["completed"], 0)
def test_save_retries_windows_replace_lock_and_cleans_temp_file(self):
real_replace = os.replace
attempts = {"count": 0}
def flaky_replace(src, dst):
attempts["count"] += 1
if attempts["count"] < 3:
raise PermissionError("file is locked")
return real_replace(src, dst)
with patch("nodes.generation_times.os.replace", side_effect=flaky_replace), \
patch("nodes.generation_times.time.sleep"):
generation_times._save_data({"version": 1, "entries": {"a.png": {"duration": 1}}})
self.assertEqual(attempts["count"], 3)
self.assertTrue(os.path.exists(generation_times.GENERATION_TIMES_FILE))
self.assertEqual(
[name for name in os.listdir(self.temp_dir) if name.endswith(".tmp")],
[],
)
def test_save_failure_does_not_leave_temp_file_behind(self):
with patch("nodes.generation_times.os.replace", side_effect=PermissionError("locked")), \
patch("nodes.generation_times.time.sleep"):
generation_times._save_data({"version": 1, "entries": {}})
self.assertEqual(
[name for name in os.listdir(self.temp_dir) if name.endswith(".tmp")],
[],
)
def test_moved_file_fallback_handles_invalid_mtime(self):
now = 1_700_000_000.0
with patch("nodes.generation_times.time.time", return_value=now):
generation_times.record_generation_time(
"pid", 6.0, [{"filename": "moved.png", "subfolder": "old"}]
)
# A non-numeric mtime must not crash the fallback path.
self.assertEqual(
generation_times.get_generation_time("moved.png", "new", "not-a-number"),
6.0,
)
def test_extract_output_files_ignores_malformed_history(self):
self.assertEqual(generation_times._extract_output_files(None), [])
self.assertEqual(generation_times._extract_output_files({}), [])
self.assertEqual(
generation_times._extract_output_files({"outputs": {"1": {"images": "bad"}}}),
[],
)
files = generation_times._extract_output_files({
"outputs": {
"1": {"images": [
None,
{"filename": ""},
{"filename": "temp.png", "type": "temp"},
{"filename": "saved.png", "subfolder": "sub"},
]},
"2": "bad",
}
})
self.assertEqual(files, [{"filename": "saved.png", "subfolder": "sub", "type": "output"}])
if __name__ == "__main__":
unittest.main()
+15
View File
@@ -1,10 +1,20 @@
import atexit
import os
import shutil
import sys
import tempfile
import types
from unittest.mock import MagicMock
SATURNNODES_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# Keep every module-level state file (persistent queue, LoRA usage, caches,
# prompt iterator state, generation times) inside a disposable test directory.
# This is critical when ComfyUI is running concurrently: tests must never write
# to the live ComfyUI/user/default/SaturnNodes directory.
TEST_USER_ROOT = tempfile.mkdtemp(prefix="saturnnodes_test_user_")
atexit.register(shutil.rmtree, TEST_USER_ROOT, ignore_errors=True)
# Ensure SaturnNodes root is prioritized at the very start of sys.path
while SATURNNODES_ROOT in sys.path:
sys.path.remove(SATURNNODES_ROOT)
@@ -75,6 +85,11 @@ if "folder_paths" not in sys.modules:
fp_mock.base_path = SATURNNODES_ROOT
sys.modules["folder_paths"] = fp_mock
# Make get_saturnnodes_user_dir() resolve to the disposable test directory,
# whether folder_paths is the lightweight mock or the real ComfyUI module.
import folder_paths
folder_paths.get_user_directory = MagicMock(return_value=TEST_USER_ROOT)
if "server" not in sys.modules:
server_mock = types.ModuleType("server")
ps_mock = MagicMock()
+83
View File
@@ -1,11 +1,18 @@
import os
import sys
import json
import shutil
import tempfile
import unittest
from unittest.mock import patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper
from PIL import Image
from nodes.image_loader import trace_positive_prompt_from_graph, parse_positive_from_parameters
import nodes.image_loader as image_loader
class TestPromptExtraction(unittest.TestCase):
def test_standard_ksampler_graph(self):
@@ -158,5 +165,81 @@ Steps: 30, Sampler: DPM++ 2M Karras, CFG scale: 7, Seed: 12345, Size: 512x768"""
res = parse_positive_from_parameters(param_str)
self.assertEqual(res, "A portrait of an ancient wizard with a glowing crystal staff")
class TestImageFolderScanning(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.mkdtemp()
self.folder = os.path.join(self.temp_dir, "images")
os.makedirs(self.folder)
self.old_cache = image_loader.CACHE_FILE
self.old_thumbs = image_loader.IMAGE_THUMBNAILS_DIR
image_loader.CACHE_FILE = os.path.join(self.temp_dir, "prompts_cache.json")
image_loader.IMAGE_THUMBNAILS_DIR = os.path.join(self.temp_dir, "thumbs")
def tearDown(self):
image_loader.CACHE_FILE = self.old_cache
image_loader.IMAGE_THUMBNAILS_DIR = self.old_thumbs
shutil.rmtree(self.temp_dir, ignore_errors=True)
def _make_image(self, name, size=(32, 32), mtime=None):
path = os.path.join(self.folder, name)
Image.new("RGB", size, (120, 90, 60)).save(path)
if mtime:
os.utime(path, (mtime, mtime))
return path
def test_metadata_limit_and_cache_reuse(self):
base = 1_600_000_000
self._make_image("a.png", mtime=base)
self._make_image("b.png", mtime=base + 10)
self._make_image("c.png", mtime=base + 20)
calls = []
def fake_extract(path):
calls.append(path)
return (f"prompt-{os.path.basename(path)}", 32, 32)
with patch("nodes.image_loader.extract_metadata_from_image", side_effect=fake_extract):
names, mapping, prompts = image_loader.scan_image_folder(self.folder, metadata_limit=2)
self.assertEqual(names, ["c.png", "b.png", "a.png"])
self.assertEqual(mapping["a.png"], "a.png")
self.assertEqual(len(calls), 2)
self.assertEqual(prompts["c.png"], "prompt-c.png")
self.assertEqual(prompts["b.png"], "prompt-b.png")
self.assertEqual(prompts["a.png"], "")
# Unchanged mtimes must be served from the disk cache.
calls.clear()
image_loader.scan_image_folder(self.folder, metadata_limit=2)
self.assertEqual(calls, [])
self.assertTrue(os.path.exists(image_loader.CACHE_FILE))
def test_thumbnail_disk_cache_and_mtime_invalidation(self):
path = self._make_image("large.png", size=(640, 480), mtime=1_600_000_000)
first = image_loader.get_or_create_image_thumbnail(path, 1_600_000_000, 256)
self.assertTrue(first.endswith(".webp"))
self.assertTrue(os.path.exists(first))
with Image.open(first) as thumb:
self.assertLessEqual(max(thumb.size), 256)
second = image_loader.get_or_create_image_thumbnail(path, 1_600_000_000, 256)
self.assertEqual(first, second)
third = image_loader.get_or_create_image_thumbnail(path, 1_600_000_100, 256)
self.assertNotEqual(first, third)
self.assertTrue(os.path.exists(third))
def test_metadata_scan_limit_setting_is_bounded(self):
with patch("nodes.image_loader.get_env_setting", return_value="42"):
self.assertEqual(image_loader.get_image_metadata_scan_limit(), 42)
with patch("nodes.image_loader.get_env_setting", return_value="oops"):
self.assertEqual(image_loader.get_image_metadata_scan_limit(), 128)
with patch("nodes.image_loader.get_env_setting", return_value="-5"):
self.assertEqual(image_loader.get_image_metadata_scan_limit(), 0)
with patch("nodes.image_loader.get_env_setting", return_value="99999"):
self.assertEqual(image_loader.get_image_metadata_scan_limit(), 2000)
if __name__ == "__main__":
unittest.main()
+200
View File
@@ -0,0 +1,200 @@
import json
import os
import shutil
import sys
import tempfile
import unittest
from unittest.mock import patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper # noqa: F401
from PIL import Image, PngImagePlugin
import nodes.image_loader as image_loader
from nodes.image_loader import (
decode_bytes_safely,
parse_positive_from_parameters,
scan_image_folder,
trace_positive_prompt_from_graph,
)
class TestImageLoaderExtended(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.mkdtemp()
self.cache_file = os.path.join(self.temp_dir, "image_prompts_cache.json")
self.old_cache = image_loader.CACHE_FILE
image_loader.CACHE_FILE = self.cache_file
def tearDown(self):
image_loader.CACHE_FILE = self.old_cache
shutil.rmtree(self.temp_dir, ignore_errors=True)
def _make_png(self, name, mtime, subfolder="", prompt_graph=None, parameters=None):
folder = os.path.join(self.temp_dir, subfolder) if subfolder else self.temp_dir
os.makedirs(folder, exist_ok=True)
path = os.path.join(folder, name)
info = PngImagePlugin.PngInfo()
if prompt_graph is not None:
info.add_text("prompt", json.dumps(prompt_graph))
if parameters is not None:
info.add_text("parameters", parameters)
Image.new("RGB", (6, 6), (30, 40, 50)).save(path, pnginfo=info)
os.utime(path, (mtime, mtime))
return path
def test_equal_mtimes_are_sorted_deterministically(self):
base = 1_700_000_000
self._make_png("b.png", base)
self._make_png("a.png", base)
self._make_png("c.png", base, subfolder="sub")
self._make_png("a.png", base, subfolder="sub")
names, mapping, prompts = scan_image_folder(self.temp_dir, metadata_limit=0)
expected = ["a.png", "b.png", "sub/a.png", "sub/c.png"]
self.assertEqual(names, expected)
self.assertEqual(list(mapping), expected)
self.assertEqual(list(prompts), expected)
self.assertTrue(all(value == "" for value in prompts.values()))
def test_newest_images_come_first_across_subfolders(self):
base = 1_700_000_000
self._make_png("old.png", base)
self._make_png("new.png", base + 50, subfolder="nested")
names, _, _ = scan_image_folder(self.temp_dir, metadata_limit=0)
self.assertEqual(names, ["nested/new.png", "old.png"])
def test_metadata_limit_zero_skips_extraction(self):
self._make_png("one.png", 1_700_000_000)
with patch("nodes.image_loader.extract_metadata_from_image") as extract:
names, _, prompts = scan_image_folder(self.temp_dir, metadata_limit=0)
extract.assert_not_called()
self.assertEqual(names, ["one.png"])
self.assertEqual(prompts, {"one.png": ""})
def test_metadata_limit_only_reads_newest_entries(self):
base = 1_700_000_000
self._make_png("older.png", base)
self._make_png("newer.png", base + 10)
with patch(
"nodes.image_loader.extract_metadata_from_image",
side_effect=lambda path: ("prompt:" + os.path.basename(path), 6, 6),
) as extract:
names, _, prompts = scan_image_folder(self.temp_dir, metadata_limit=1)
self.assertEqual(names, ["newer.png", "older.png"])
self.assertEqual(extract.call_count, 1)
self.assertEqual(prompts["newer.png"], "prompt:newer.png")
self.assertEqual(prompts["older.png"], "")
def test_metadata_cache_is_reused_and_invalidated_by_mtime(self):
path = self._make_png("cached.png", 1_700_000_000)
with patch(
"nodes.image_loader.extract_metadata_from_image",
return_value=("cached prompt", 6, 6),
) as extract:
scan_image_folder(self.temp_dir, metadata_limit=10)
scan_image_folder(self.temp_dir, metadata_limit=10)
self.assertEqual(extract.call_count, 1)
os.utime(path, (1_700_000_100, 1_700_000_100))
scan_image_folder(self.temp_dir, metadata_limit=10)
self.assertEqual(extract.call_count, 2)
def test_png_prompt_metadata_is_extracted(self):
graph = {
"1": {"class_type": "KSampler", "inputs": {"positive": ["2", 0], "negative": ["3", 0]}},
"2": {"class_type": "CLIPTextEncode", "inputs": {"text": "a beautiful castle"}},
"3": {"class_type": "CLIPTextEncode", "inputs": {"text": "ugly"}},
}
self._make_png("graph.png", 1_700_000_000, prompt_graph=graph)
names, _, prompts = scan_image_folder(self.temp_dir, metadata_limit=10)
self.assertEqual(names, ["graph.png"])
self.assertEqual(prompts["graph.png"], "a beautiful castle")
def test_corrupt_image_does_not_break_the_scan(self):
path = os.path.join(self.temp_dir, "broken.png")
with open(path, "wb") as handle:
handle.write(b"not a png")
os.utime(path, (1_700_000_000, 1_700_000_000))
names, _, prompts = scan_image_folder(self.temp_dir, metadata_limit=10)
self.assertEqual(names, ["broken.png"])
self.assertEqual(prompts["broken.png"], "")
def test_non_image_files_are_ignored(self):
with open(os.path.join(self.temp_dir, "notes.txt"), "w", encoding="utf-8") as handle:
handle.write("not an image")
names, _, prompts = scan_image_folder(self.temp_dir, metadata_limit=10)
self.assertEqual(names, [])
self.assertEqual(prompts, {})
def test_corrupt_cache_file_is_ignored_and_replaced(self):
self._make_png("image.png", 1_700_000_000)
with open(self.cache_file, "w", encoding="utf-8") as handle:
handle.write("{ broken json")
names, _, _ = scan_image_folder(self.temp_dir, metadata_limit=10)
self.assertEqual(names, ["image.png"])
with open(self.cache_file, "r", encoding="utf-8") as handle:
payload = json.load(handle)
self.assertIsInstance(payload, dict)
self.assertEqual(len(payload), 1)
def test_cache_is_pruned_to_256_entries(self):
self._make_png("image.png", 1_700_000_000)
stale = {
os.path.join(self.temp_dir, f"stale-{index}.png"): {
"mtime": 1,
"prompt": f"old-{index}",
}
for index in range(300)
}
with open(self.cache_file, "w", encoding="utf-8") as handle:
json.dump(stale, handle)
scan_image_folder(self.temp_dir, metadata_limit=10)
with open(self.cache_file, "r", encoding="utf-8") as handle:
payload = json.load(handle)
self.assertEqual(len(payload), 256)
self.assertIn(os.path.join(self.temp_dir, "image.png"), payload)
def test_byte_parameters_and_positive_parser(self):
self.assertEqual(
parse_positive_from_parameters(b"A cat\r\nNegative prompt: dog\r\nSteps: 20"),
"A cat",
)
self.assertEqual(parse_positive_from_parameters(None), "")
self.assertEqual(parse_positive_from_parameters("Line one\nSteps: 2"), "Line one")
self.assertEqual(decode_bytes_safely(b"plain"), "plain")
self.assertEqual(decode_bytes_safely(None), "")
def test_graph_tracing_handles_cycles_and_ignores_negative_links(self):
graph = {
"1": {
"class_type": "KSampler",
"inputs": {"positive": ["2", 0], "negative": ["4", 0]},
},
"2": {
"class_type": "CLIPTextEncode",
"inputs": {"text": "hello", "positive": ["3", 0]},
},
"3": {
"class_type": "CLIPTextEncode",
"inputs": {"text": "world", "positive": ["2", 0]},
},
"4": {"class_type": "CLIPTextEncode", "inputs": {"text": "negative text"}},
}
self.assertEqual(trace_positive_prompt_from_graph(graph), "hello\nworld")
fallback = {"7": {"class_type": "CLIPTextEncode", "inputs": {"text": "fallback text"}}}
self.assertEqual(trace_positive_prompt_from_graph(fallback), "fallback text")
self.assertEqual(trace_positive_prompt_from_graph(None), "")
self.assertEqual(trace_positive_prompt_from_graph({}), "")
if __name__ == "__main__":
unittest.main()
+144
View File
@@ -0,0 +1,144 @@
import os
import shutil
import sys
import tempfile
import unittest
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper # noqa: F401
import folder_paths
import numpy as np
import torch
from PIL import Image
from nodes.load_recent import LoadRecentOutputs
class TestLoadRecentExtended(unittest.TestCase):
def setUp(self):
self.node = LoadRecentOutputs()
out_dir = folder_paths.get_output_directory()
os.makedirs(out_dir, exist_ok=True)
self.temp_dir = tempfile.mkdtemp(dir=out_dir)
self.rel_dir = os.path.relpath(self.temp_dir, out_dir)
def tearDown(self):
shutil.rmtree(self.temp_dir, ignore_errors=True)
def _make_image(self, name, color, mtime):
path = os.path.join(self.temp_dir, name)
Image.new("RGB", (4, 4), color=color).save(path)
os.utime(path, (mtime, mtime))
return path
def _load(self, amount=5, index=0, order="Newest First (0 = latest)", folder=None):
tensor, = self.node.load_single_image(
output_folder=self.rel_dir if folder is None else folder,
amount=amount,
index=index,
order=order,
)
return tensor
def test_equal_mtimes_have_a_deterministic_tiebreak(self):
base = 1_700_000_000
self._make_image("z.png", "red", base)
self._make_image("a.png", "green", base)
self._make_image("m.png", "blue", base)
# Newest-first with equal mtimes sorts by full path descending.
self.assertEqual(tuple(self._load(amount=3, index=0).shape), (1, 4, 4, 3))
colors = [self._load(amount=3, index=i)[0, 0, 0].tolist() for i in range(3)]
self.assertEqual(colors[0][0], 1.0) # z.png red
self.assertEqual(colors[1][2], 1.0) # m.png blue
self.assertAlmostEqual(colors[2][1], 0.5019608, places=5) # a.png green
def test_chronological_order_reverses_the_same_set(self):
base = 1_700_000_000
self._make_image("oldest.png", "red", base)
self._make_image("middle.png", "green", base + 10)
self._make_image("newest.png", "blue", base + 20)
newest_first = [self._load(amount=3, index=i)[0, 0, 0].tolist() for i in range(3)]
oldest_first = [
self._load(amount=3, index=i, order="Chronological (Oldest First)")[0, 0, 0].tolist()
for i in range(3)
]
self.assertEqual(oldest_first, list(reversed(newest_first)))
def test_index_wraps_and_negative_index_clamps_to_zero(self):
base = 1_700_000_000
self._make_image("older.png", "red", base)
self._make_image("newer.png", "blue", base + 10)
wrapped = self._load(amount=2, index=3)[0, 0, 0].tolist()
self.assertEqual(wrapped[0], 1.0, "index 3 must wrap to the second of two images")
clamped = self._load(amount=2, index=-5)[0, 0, 0].tolist()
self.assertEqual(clamped[2], 1.0, "a negative index must clamp to the newest image")
def test_invalid_amount_and_index_fall_back_safely(self):
base = 1_700_000_000
self._make_image("older.png", "red", base)
self._make_image("newer.png", "blue", base + 10)
tensor = self._load(amount="not-a-number", index="not-a-number")
self.assertEqual(tuple(tensor.shape), (1, 4, 4, 3))
self.assertEqual(tensor[0, 0, 0].tolist()[2], 1.0)
tensor = self._load(amount=0, index=0)
self.assertEqual(tensor[0, 0, 0].tolist()[2], 1.0)
def test_amount_larger_than_available_still_wraps(self):
base = 1_700_000_000
self._make_image("only.png", "green", base)
tensor = self._load(amount=100, index=7)
self.assertEqual(tuple(tensor.shape), (1, 4, 4, 3))
self.assertAlmostEqual(float(tensor[0, 0, 0, 1]), 0.5019608, places=5)
def test_missing_or_empty_folder_returns_dummy(self):
missing = os.path.join(self.temp_dir, "does-not-exist")
tensor = self._load(folder=os.path.relpath(missing, folder_paths.get_output_directory()))
self.assertEqual(tuple(tensor.shape), (1, 512, 512, 3))
self.assertEqual(tensor.dtype, torch.float32)
self.assertEqual(float(tensor.sum()), 0.0)
empty = os.path.join(self.temp_dir, "empty")
os.makedirs(empty)
tensor = self._load(folder=os.path.relpath(empty, folder_paths.get_output_directory()))
self.assertEqual(tuple(tensor.shape), (1, 512, 512, 3))
self.assertEqual(float(tensor.sum()), 0.0)
def test_corrupt_image_returns_dummy_instead_of_raising(self):
path = os.path.join(self.temp_dir, "broken.png")
with open(path, "wb") as handle:
handle.write(b"this is not a PNG")
os.utime(path, (1_700_000_000, 1_700_000_000))
tensor = self._load(amount=1, index=0)
self.assertEqual(tuple(tensor.shape), (1, 512, 512, 3))
self.assertEqual(float(tensor.sum()), 0.0)
def test_unsupported_extensions_are_ignored(self):
with open(os.path.join(self.temp_dir, "notes.txt"), "w", encoding="utf-8") as handle:
handle.write("not an image")
tensor = self._load(amount=5, index=0)
self.assertEqual(tuple(tensor.shape), (1, 512, 512, 3))
self.assertEqual(float(tensor.sum()), 0.0)
def test_returned_tensor_is_float_rgb_in_zero_one_range(self):
path = os.path.join(self.temp_dir, "solid.png")
Image.new("RGB", (3, 2), color=(255, 0, 0)).save(path)
os.utime(path, (1_700_000_000, 1_700_000_000))
tensor = self._load(amount=1, index=0)
self.assertEqual(tuple(tensor.shape), (1, 2, 3, 3))
self.assertEqual(tensor.dtype, torch.float32)
self.assertEqual(tensor[0, :, :, 0].tolist(), [[1.0, 1.0, 1.0], [1.0, 1.0, 1.0]])
self.assertEqual(tensor[0, :, :, 1].tolist(), [[0.0, 0.0, 0.0], [0.0, 0.0, 0.0]])
if __name__ == "__main__":
unittest.main()
+202
View File
@@ -0,0 +1,202 @@
import os
import sys
import json
import time
import shutil
import inspect
import tempfile
import unittest
from unittest.mock import patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper
import nodes.lora_loader as lora_loader
from nodes.lora_loader import (
select_a_lora,
save_lora_cycle_state,
load_lora_cycle_state,
increment_lora_usage,
flush_lora_usage,
load_usage_data,
reset_lora_usage_file,
get_file_sha256_cached,
VisualLoraLoader,
)
class TestLoraSelection(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.mkdtemp()
self.old_state_file = lora_loader.LORA_STATE_FILE
self.old_user_dir = lora_loader.USER_DIR
self.old_usage_cache = lora_loader._USAGE_CACHE
self.old_usage_dirty = lora_loader._USAGE_DIRTY
self.old_usage_timer = lora_loader._USAGE_TIMER
self.old_flush_delay = lora_loader._USAGE_FLUSH_DELAY
self.old_hash_cache = lora_loader._HASH_CACHE
self.old_hash_cache_file = lora_loader.HASH_CACHE_FILE
lora_loader.LORA_STATE_FILE = os.path.join(self.temp_dir, "lora_loader_state.json")
lora_loader.HASH_CACHE_FILE = os.path.join(self.temp_dir, "lora_hash_cache.json")
lora_loader.USER_DIR = self.temp_dir
lora_loader._USAGE_CACHE = None
lora_loader._USAGE_DIRTY = False
lora_loader._USAGE_TIMER = None
lora_loader._USAGE_FLUSH_DELAY = 60.0
lora_loader._HASH_CACHE = None
def tearDown(self):
if lora_loader._USAGE_TIMER is not None:
lora_loader._USAGE_TIMER.cancel()
lora_loader.LORA_STATE_FILE = self.old_state_file
lora_loader.USER_DIR = self.old_user_dir
lora_loader._USAGE_CACHE = self.old_usage_cache
lora_loader._USAGE_DIRTY = self.old_usage_dirty
lora_loader._USAGE_TIMER = self.old_usage_timer
lora_loader._USAGE_FLUSH_DELAY = self.old_flush_delay
lora_loader._HASH_CACHE = self.old_hash_cache
lora_loader.HASH_CACHE_FILE = self.old_hash_cache_file
shutil.rmtree(self.temp_dir, ignore_errors=True)
def test_sequential_advances_and_retry_does_not_advance(self):
choices = ["A", "B", "C"]
self.assertEqual(select_a_lora("Sequential", "node1", choices, "p1"), "A")
self.assertEqual(select_a_lora("Sequential", "node1", choices, "p2"), "B")
# Crash recovery / retry returns the assigned item without double-advancing.
self.assertEqual(select_a_lora("Sequential", "node1", choices, "p1"), "A")
self.assertEqual(select_a_lora("Sequential", "node1", choices, "p3"), "C")
self.assertEqual(select_a_lora("Sequential", "node1", choices, "p4"), "A")
def test_sequential_reorder_keeps_cycle_position(self):
# The state bucket is keyed by the selected set, so a different
# click/toggle order must not shift the index onto another LoRA.
self.assertEqual(select_a_lora("Sequential", "node_order", ["A", "B", "C"], "o1"), "A")
self.assertEqual(select_a_lora("Sequential", "node_order", ["A", "B", "C"], "o2"), "B")
# Reordering after a reselect must continue the same cycle (C next),
# never repeat B and never skip C.
self.assertEqual(select_a_lora("Sequential", "node_order", ["C", "A", "B"], "o3"), "C")
self.assertEqual(select_a_lora("Sequential", "node_order", ["B", "C", "A"], "o4"), "A")
# Retrying a reordered prompt still replays its original assignment.
self.assertEqual(select_a_lora("Sequential", "node_order", ["A", "C", "B"], "o3"), "C")
def test_sequential_changed_selection_starts_fresh_cycle(self):
self.assertEqual(select_a_lora("Sequential", "node_set", ["A", "B"], "s1"), "A")
self.assertEqual(select_a_lora("Sequential", "node_set", ["A", "B"], "s2"), "B")
# A different selection set is a different state bucket.
self.assertEqual(select_a_lora("Sequential", "node_set", ["A", "B", "C"], "s3"), "A")
def test_missing_selection_mode_defaults_to_sequential(self):
params = inspect.signature(VisualLoraLoader.load_lora).parameters
self.assertEqual(params["_selection_mode"].default, "Sequential")
self.assertEqual(
VisualLoraLoader.INPUT_TYPES()["hidden"]["_selection_mode"][1]["default"],
"Sequential",
)
# IS_CHANGED must invalidate for the same fallback mode, otherwise a
# prompt without _selection_mode would be treated as cacheable "All".
self.assertIsInstance(VisualLoraLoader.IS_CHANGED(), float)
def test_no_replace_cycles_all_items_and_avoids_immediate_repeat(self):
choices = ["A", "B", "C"]
first_cycle = [
select_a_lora("Random (No Replace)", "node2", choices, f"c1-{i}")
for i in range(3)
]
self.assertEqual(set(first_cycle), {"A", "B", "C"})
second_cycle = [
select_a_lora("Random (No Replace)", "node2", choices, f"c2-{i}")
for i in range(3)
]
self.assertEqual(set(second_cycle), {"A", "B", "C"})
# The first pick of a new cycle must not repeat the final pick of the
# previous cycle back-to-back.
self.assertNotEqual(second_cycle[0], first_cycle[-1])
def test_no_replace_retry_does_not_consume_pool(self):
choices = ["A", "B", "C", "D"]
first = select_a_lora("Random (No Replace)", "node3", choices, "retry-1")
state_before = load_lora_cycle_state()
key = list(state_before.keys())[0]
pool_before = list(state_before[key]["pool"])
retried = select_a_lora("Random (No Replace)", "node3", choices, "retry-1")
state_after = load_lora_cycle_state()
self.assertEqual(first, retried)
self.assertEqual(state_after[key]["pool"], pool_before)
def test_assigned_map_is_pruned_but_recent_retry_survives(self):
choices = ["A", "B", "C"]
for i in range(60):
select_a_lora("Sequential", "node4", choices, f"prompt-{i}")
state = load_lora_cycle_state()
key = list(state.keys())[0]
assigned = state[key]["assigned"]
self.assertLessEqual(len(assigned), 50)
self.assertNotIn("prompt-0", assigned)
self.assertIn("prompt-59", assigned)
# Retrying an old prompt that is no longer tracked simply picks a new
# item instead of crashing, and the map stays bounded.
select_a_lora("Sequential", "node4", choices, "prompt-0")
state = load_lora_cycle_state()
self.assertLessEqual(len(state[key]["assigned"]), 50)
def test_global_state_prune_keeps_recent_entries(self):
state = {}
for i in range(105):
state[f"seq_node_{i}"] = {"index": 0, "assigned": {}, "last_updated": i}
save_lora_cycle_state(state)
self.assertEqual(len(state), 100)
self.assertNotIn("seq_node_0", state)
self.assertNotIn("seq_node_4", state)
self.assertIn("seq_node_5", state)
self.assertIn("seq_node_104", state)
def test_usage_increments_are_batched_until_flush(self):
self.assertEqual(load_usage_data(), {})
with patch("nodes.lora_loader.get_env_setting", return_value="true"):
increment_lora_usage("folder/alpha_one.safetensors")
increment_lora_usage("folder/alpha_one.safetensors")
increment_lora_usage("folder/beta_two.safetensors")
# Nothing written yet, but the in-memory view is already current.
self.assertEqual(load_usage_data().get("One"), 2)
flush_lora_usage()
usage_file = os.path.join(self.temp_dir, "lora_usage.json")
self.assertTrue(os.path.exists(usage_file))
with open(usage_file, "r", encoding="utf-8") as f:
raw = json.load(f)
self.assertEqual(raw.get("One"), 2)
self.assertEqual(raw.get("Two"), 1)
reset_lora_usage_file()
self.assertEqual(load_usage_data(), {})
def test_sha256_cache_reuses_unchanged_file(self):
lora_file = os.path.join(self.temp_dir, "lora.safetensors")
with open(lora_file, "wb") as f:
f.write(b"weights-v1")
with patch("nodes.lora_loader.get_file_sha256", return_value="HASH-1") as mock_hash:
first = get_file_sha256_cached(lora_file)
second = get_file_sha256_cached(lora_file)
self.assertEqual((first, second), ("HASH-1", "HASH-1"))
self.assertEqual(mock_hash.call_count, 1)
# A changed mtime/size invalidates the cached hash.
with open(lora_file, "ab") as f:
f.write(b"-more")
future = time.time() + 5
os.utime(lora_file, (future, future))
get_file_sha256_cached(lora_file)
self.assertEqual(mock_hash.call_count, 2)
if __name__ == "__main__":
unittest.main()
+147
View File
@@ -0,0 +1,147 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import { stripImports } from "./fake_dom.mjs";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "persistent_queue.js");
let clock = 0;
let timerId = 0;
const timers = [];
function fakeSetTimeout(callback, delay = 0) {
const timer = {
id: ++timerId,
at: clock + Math.max(0, Number(delay) || 0),
callback,
};
timers.push(timer);
return timer.id;
}
function advance(ms) {
const end = clock + Math.max(0, Number(ms) || 0);
while (true) {
let nextIndex = -1;
for (let i = 0; i < timers.length; i++) {
if (timers[i].at <= end && (nextIndex < 0 || timers[i].at < timers[nextIndex].at)) {
nextIndex = i;
}
}
if (nextIndex < 0) break;
const [timer] = timers.splice(nextIndex, 1);
clock = Math.max(clock, timer.at);
timer.callback();
}
clock = end;
}
async function flush() {
for (let i = 0; i < 5; i++) await Promise.resolve();
}
const apiEvents = new Map();
const fetchCalls = [];
let fetchImpl = async (url, options) => {
fetchCalls.push({ url, options });
return { ok: true };
};
const api = {
clientId: "client-abc",
addEventListener(name, callback) {
if (!apiEvents.has(name)) apiEvents.set(name, []);
apiEvents.get(name).push(callback);
},
};
const extension = { name: "", setup: null };
const app = {
registerExtension(candidate) {
extension.name = candidate.name;
extension.setup = candidate.setup;
},
};
const context = vm.createContext({
console,
app,
api,
authenticatedFetch: (url, options) => fetchImpl(url, options),
setTimeout: fakeSetTimeout,
clearTimeout: () => {},
JSON,
Promise,
String,
Object,
Error,
});
const source = stripImports(fs.readFileSync(sourcePath, "utf8"));
vm.runInContext(source, context, { filename: sourcePath });
assert.equal(typeof extension.setup, "function", "persistent queue extension must register");
await extension.setup();
assert.deepEqual(
[...apiEvents.keys()].sort(),
["executing", "execution_start", "status"],
"persistent queue must listen for queue status events"
);
// No claim before the 500ms startup delay.
advance(499);
await flush();
assert.equal(fetchCalls.length, 0, "queue ownership must not be claimed before startup settles");
advance(1);
await flush();
assert.equal(fetchCalls.length, 1, "queue ownership must be claimed after startup");
assert.equal(fetchCalls[0].url, "/saturnnodes/persistent_queue/claim");
assert.equal(fetchCalls[0].options.method, "POST");
assert.equal(fetchCalls[0].options.headers["Content-Type"], "application/json");
assert.deepEqual(
JSON.parse(fetchCalls[0].options.body),
{ client_id: "client-abc" },
"claim body must carry the API client id"
);
// Status events re-claim ownership (a reconnecting tab takes over recovery).
apiEvents.get("status")[0]();
await flush();
assert.equal(fetchCalls.length, 2, "status events must re-claim queue ownership");
assert.deepEqual(JSON.parse(fetchCalls[1].options.body), { client_id: "client-abc" });
// A client without an id must not send a claim.
api.clientId = "";
apiEvents.get("status")[0]();
await flush();
assert.equal(fetchCalls.length, 2, "clients without a client id must not claim ownership");
// A failed claim is contained and must not break later events.
api.clientId = "client-xyz";
fetchImpl = async () => {
throw new Error("network unavailable");
};
apiEvents.get("status")[0]();
await flush();
assert.equal(fetchCalls.length, 2, "failed claim must not record a successful request");
// Restore a working transport and verify execution events do not throw when
// rgthree-comfy is not installed (the dynamic import is caught internally).
fetchImpl = async (url, options) => {
fetchCalls.push({ url, options });
return { ok: true };
};
apiEvents.get("execution_start")[0]({ detail: {} });
apiEvents.get("executing")[0]({ detail: { prompt_id: "p1" } });
await flush();
advance(1200);
await flush();
assert.equal(fetchCalls.length, 2, "execution events must not claim ownership");
console.log("persistent queue claim DOM regression test passed");
+381
View File
@@ -0,0 +1,381 @@
import json
import os
import sys
import tempfile
import threading
import unittest
from types import SimpleNamespace
from unittest.mock import MagicMock, patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper # noqa: F401 (redirects SaturnNodes state to a temp dir)
import nodes.queue_control as queue_control
from nodes.queue_control import PersistentQueueManager
def make_entry(prompt_id, priority=0, item_pid=None, create_time=1, extra=None):
item = [
priority,
prompt_id if item_pid is None else item_pid,
{"prompt": {}},
{"client_id": "old-client", "create_time": create_time},
[],
]
entry = {"prompt_id": prompt_id, "item": item}
if extra:
entry.update(extra)
return entry
class FakePromptQueue:
def __init__(self, history=None):
self.history = {} if history is None else history
self.items = []
self.mutex = threading.RLock()
self.currently_running = {}
self.queue = []
self.fail_delete = False
self.fail_wipe = False
self.fail_ids = set()
def get_history(self):
return self.history
def put(self, item):
if item[1] in self.fail_ids:
raise RuntimeError(f"cannot queue {item[1]}")
self.items.append(item)
self.queue.append(item)
def task_done(self, item_id, history_result, status, process_item=None):
self.currently_running.pop(item_id, None)
def delete_queue_item(self, predicate):
if self.fail_delete:
raise RuntimeError("delete failed")
self.queue = [item for item in self.queue if not predicate(item)]
def wipe_queue(self):
if self.fail_wipe:
raise RuntimeError("wipe failed")
self.queue = []
class TestPersistentQueueRestore(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.TemporaryDirectory()
self.temp_file = os.path.join(self.temp_dir.name, "persistent_queue.json")
self.patches = [
patch("nodes.queue_control.PERSISTENT_FILE", self.temp_file),
patch("nodes.queue_control.USER_DIR", self.temp_dir.name),
patch("nodes.queue_control.is_persistent_queue_enabled", return_value=True),
patch.object(
PersistentQueueManager,
"_schedule_save_locked",
new=lambda self: None,
),
]
for patcher in self.patches:
patcher.start()
self.manager = PersistentQueueManager()
def tearDown(self):
for patcher in reversed(self.patches):
patcher.stop()
self.temp_dir.cleanup()
def _server(self, queue, number=0):
return SimpleNamespace(
prompt_queue=queue,
number=number,
queue_updated=MagicMock(),
get_queue_status=MagicMock(return_value={}),
send_sync=MagicMock(),
)
def _write_payload(self, payload):
with open(self.temp_file, "w", encoding="utf-8") as handle:
json.dump(payload, handle)
def _read_payload(self):
with open(self.temp_file, "r", encoding="utf-8") as handle:
return json.load(handle)
def test_normalize_entry_uses_top_level_prompt_id(self):
raw = {"prompt_id": "top-level", "item": [0, "different", {"prompt": {}}]}
entry = PersistentQueueManager._normalize_entry(raw)
self.assertEqual(entry["prompt_id"], "top-level")
self.assertEqual(entry["item"][1], "different")
self.assertIsNone(PersistentQueueManager._normalize_entry(None))
self.assertIsNone(PersistentQueueManager._normalize_entry({"prompt_id": "x", "item": "bad"}))
self.assertIsNone(PersistentQueueManager._normalize_entry({"prompt_id": "x", "item": [0]}))
self.assertIsNone(PersistentQueueManager._normalize_entry({"item": [0, ""]}))
self.assertEqual(
PersistentQueueManager._normalize_entry({"item": [0, "from-item"]})["prompt_id"],
"from-item",
)
def test_normalize_items_repairs_and_dedupes_last_wins(self):
first = make_entry("p1", priority=1)
duplicate = make_entry("p1", priority=99)
malformed = {"prompt_id": "bad", "item": "nope"}
items, changed = PersistentQueueManager._normalize_items([first, malformed, duplicate])
self.assertTrue(changed)
self.assertEqual(len(items), 1)
self.assertEqual(items[0]["prompt_id"], "p1")
self.assertEqual(items[0]["item"][0], 99)
def test_restore_repairs_mismatched_item_prompt_id(self):
entry = make_entry("top-level", item_pid="wrong-id", priority=4)
self.manager.persistent_items = [entry]
queue = FakePromptQueue()
server = self._server(queue, number=2)
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause"):
self.manager.restore_queue("new-client")
self.assertEqual(len(queue.items), 1)
self.assertEqual(queue.items[0][1], "top-level")
self.assertEqual(self.manager.persistent_items[0]["item"][1], "top-level")
payload = self._read_payload()
self.assertEqual(payload["items"][0]["item"][1], "top-level")
def test_restore_drops_prompts_already_in_history(self):
self.manager.persistent_items = [make_entry("finished"), make_entry("pending", priority=2)]
queue = FakePromptQueue(history={"finished": {"status": "success"}})
server = self._server(queue)
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause"):
self.manager.restore_queue()
self.assertEqual([item[1] for item in queue.items], ["pending"])
self.assertEqual([x["prompt_id"] for x in self.manager.persistent_items], ["pending"])
def test_restore_drops_malformed_entries(self):
self.manager.persistent_items = [
{"prompt_id": "short", "item": [0, "short"]},
{"prompt_id": "bad-output", "item": [0, "bad-output", "not-a-dict"]},
{"prompt_id": "valid", "item": [0, "valid", {"prompt": {}}, {}, []]},
]
queue = FakePromptQueue()
server = self._server(queue)
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause"):
self.manager.restore_queue()
self.assertEqual([item[1] for item in queue.items], ["valid"])
self.assertEqual([x["prompt_id"] for x in self.manager.persistent_items], ["valid"])
def test_restore_assigns_ordered_unique_create_times_and_client_id(self):
self.manager.persistent_items = [
make_entry("p1", priority=10),
make_entry("p2", priority=5),
make_entry("p3", priority=7),
]
queue = FakePromptQueue()
server = self._server(queue, number=3)
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause"), \
patch("nodes.queue_control.time.time", return_value=2_000_000.0):
self.manager.restore_queue("client-42")
create_times = [item[3]["create_time"] for item in queue.items]
self.assertEqual(create_times, [1_999_999_998, 1_999_999_999, 2_000_000_000])
self.assertEqual(create_times, sorted(set(create_times)))
for item in queue.items:
self.assertEqual(item[3]["client_id"], "client-42")
self.assertEqual(server.number, 11, "server priority counter must exceed restored items")
def test_restore_retries_with_malformed_retry_counter(self):
entry = make_entry("flaky", extra={"retries": "not-a-number"})
self.manager.persistent_items = [entry]
queue = FakePromptQueue()
queue.fail_ids.add("flaky")
server = self._server(queue)
def env(key, default):
if key == "PERSISTENT_QUEUE_MAX_RETRIES":
return "2"
return default
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause"), \
patch("nodes.queue_control.get_env_setting", side_effect=env):
self.manager.restore_queue()
self.assertEqual(self.manager.persistent_items[0]["retries"], 1)
self.manager.has_claimed_once = False
self.manager.restore_queue()
self.assertEqual(self.manager.persistent_items[0]["retries"], 2)
self.manager.has_claimed_once = False
self.manager.restore_queue()
self.assertEqual(self.manager.persistent_items, [])
self.assertEqual(queue.items, [])
def test_restore_drops_after_first_failure_when_retries_disabled(self):
self.manager.persistent_items = [make_entry("flaky")]
queue = FakePromptQueue()
queue.fail_ids.add("flaky")
server = self._server(queue)
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause"):
self.manager.restore_queue()
self.assertEqual(self.manager.persistent_items, [])
def test_restore_tolerates_history_read_failure(self):
self.manager.persistent_items = [make_entry("p1")]
queue = FakePromptQueue()
def broken_history():
raise RuntimeError("history unavailable")
queue.get_history = broken_history
server = self._server(queue)
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause"):
self.manager.restore_queue()
self.assertEqual([item[1] for item in queue.items], ["p1"])
def test_restore_force_state_setting_is_case_insensitive(self):
for setting, expected in (("force paused", True), ("FORCE RUNNING", False)):
self.manager.persistent_items = [make_entry("p1")]
self.manager.has_claimed_once = False
queue = FakePromptQueue()
server = self._server(queue)
def env(key, default, value=setting):
if key == "PERSISTENT_QUEUE_RESTORED_STATE":
return value
return default
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause") as set_pause, \
patch("nodes.queue_control.get_env_setting", side_effect=env):
self.manager.restore_queue()
set_pause.assert_called_once_with(expected)
def test_restore_is_skipped_when_disabled_or_empty(self):
queue = FakePromptQueue()
server = self._server(queue)
with patch.object(queue_control.PromptServer, "instance", server), \
patch("nodes.queue_control.is_persistent_queue_enabled", return_value=False):
self.manager.persistent_items = [make_entry("p1")]
self.manager.restore_queue()
self.assertTrue(self.manager.has_claimed_once)
self.assertEqual(queue.items, [])
self.manager.has_claimed_once = False
self.manager.persistent_items = []
with patch.object(queue_control.PromptServer, "instance", server):
self.manager.restore_queue()
self.assertEqual(queue.items, [])
def test_newer_schema_file_is_not_overwritten_by_restore_or_add(self):
original = {
"schema_version": 99,
"items": [{"prompt_id": "future", "item": [0, "future", {}, {}, []], "future_field": True}],
}
self._write_payload(original)
self.manager.load_from_file()
self.assertTrue(self.manager._read_only_newer_schema)
self.assertEqual(self.manager.persistent_items, [])
self.manager.add_item((0, "new", {"prompt": {}}, {}, []))
self.manager.save_to_file(immediate=True)
self.assertEqual(self._read_payload(), original)
def test_load_from_file_rewrites_duplicate_entries(self):
duplicate = make_entry("p1", priority=99)
self._write_payload({
"schema_version": 1,
"items": [make_entry("p1", priority=1), duplicate],
})
manager = PersistentQueueManager()
self.assertEqual(len(manager.persistent_items), 1)
self.assertEqual(manager.persistent_items[0]["item"][0], 99)
self.assertEqual(len(self._read_payload()["items"]), 1)
def test_batch_info_requires_dict_and_ignores_finished_prompts(self):
self.manager.set_batch_info("p1", "not-a-dict")
self.manager.set_batch_info("", {"batchId": "empty"})
self.assertEqual(self.manager.batch_meta, {})
info = {"batchId": "b1", "color": "#10b981"}
self.manager.set_batch_info("p1", info)
self.assertEqual(self.manager.batch_meta["p1"], info)
self.manager.add_item((0, "p1", {"prompt": {}}, {}, []))
self.assertEqual(self.manager.persistent_items[0]["batch_info"], info)
self.manager.remove_item("p1")
self.manager.set_batch_info("p1", {"batchId": "late"})
self.assertNotIn("p1", self.manager.batch_meta)
def test_cancel_and_wipe_remove_persistence_only_after_success(self):
queue = FakePromptQueue()
server = self._server(queue)
self.manager._patched = False
with patch.object(queue_control.PromptServer, "instance", server):
self.manager.patch_server()
queue.put((0, "p1", {"prompt": {}}, {}, []))
self.assertEqual([x["prompt_id"] for x in self.manager.persistent_items], ["p1"])
queue.fail_delete = True
with self.assertRaises(RuntimeError):
queue.delete_queue_item(lambda item: True)
self.assertEqual([x["prompt_id"] for x in self.manager.persistent_items], ["p1"])
queue.fail_delete = False
queue.delete_queue_item(lambda item: True)
self.assertEqual(self.manager.persistent_items, [])
queue.put((0, "p2", {"prompt": {}}, {}, []))
self.assertEqual([x["prompt_id"] for x in self.manager.persistent_items], ["p2"])
queue.fail_wipe = True
with self.assertRaises(RuntimeError):
queue.wipe_queue()
self.assertEqual([x["prompt_id"] for x in self.manager.persistent_items], ["p2"])
queue.fail_wipe = False
queue.wipe_queue()
self.assertEqual(self.manager.persistent_items, [])
queue.put((0, "p3", {"prompt": {}}, {}, []))
queue.currently_running[7] = (0, "p3", {"prompt": {}}, {}, [])
queue.task_done(7, {}, "success")
self.assertEqual(self.manager.persistent_items, [])
def test_restore_syncs_client_id_to_all_entries(self):
self.manager.persistent_items = [make_entry("p1"), make_entry("p2", priority=2)]
queue = FakePromptQueue()
server = self._server(queue)
with patch.object(queue_control.PromptServer, "instance", server), \
patch.object(queue_control.pause_manager, "set_pause"):
self.manager.restore_queue("client-x")
payload = self._read_payload()
self.assertEqual(
[item["item"][3]["client_id"] for item in payload["items"]],
["client-x", "client-x"],
)
if __name__ == "__main__":
unittest.main()
+117
View File
@@ -0,0 +1,117 @@
import json
import os
import sys
import tempfile
import unittest
from unittest.mock import patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper # noqa: F401 (redirects SaturnNodes state to a temp dir)
import nodes.queue_control as queue_control
from nodes.queue_control import PersistentQueueManager
ITEM = [0, "p1", {"prompt": {}}, {}, {}]
class TestPersistentQueueSchema(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.TemporaryDirectory()
self.temp_file = os.path.join(self.temp_dir.name, "persistent_queue.json")
self.patches = [
patch("nodes.queue_control.PERSISTENT_FILE", self.temp_file),
patch("nodes.queue_control.USER_DIR", self.temp_dir.name),
patch("nodes.queue_control.is_persistent_queue_enabled", return_value=True),
]
for patcher in self.patches:
patcher.start()
def tearDown(self):
for patcher in reversed(self.patches):
patcher.stop()
self.temp_dir.cleanup()
def write_payload(self, payload):
with open(self.temp_file, "w", encoding="utf-8") as f:
json.dump(payload, f)
def read_payload(self):
with open(self.temp_file, "r", encoding="utf-8") as f:
return json.load(f)
def test_legacy_list_is_migrated_to_versioned_envelope(self):
self.write_payload([
{
"prompt_id": "p1",
"item": ITEM,
"batch_info": {"batchId": "b1", "color": "#4ade80"},
}
])
mgr = PersistentQueueManager()
self.assertEqual(len(mgr.persistent_items), 1)
self.assertEqual(mgr.batch_meta["p1"]["batchId"], "b1")
payload = self.read_payload()
self.assertIsInstance(payload, dict)
self.assertEqual(
payload["schema_version"],
queue_control.PERSISTENT_QUEUE_SCHEMA_VERSION,
)
self.assertEqual(len(payload["items"]), 1)
self.assertEqual(payload["items"][0]["prompt_id"], "p1")
def test_current_envelope_loads_without_rewriting(self):
original = {
"schema_version": queue_control.PERSISTENT_QUEUE_SCHEMA_VERSION,
"items": [{"prompt_id": "p2", "item": ITEM}],
}
self.write_payload(original)
mgr = PersistentQueueManager()
self.assertEqual(len(mgr.persistent_items), 1)
self.assertEqual(mgr.persistent_items[0]["prompt_id"], "p2")
self.assertEqual(self.read_payload(), original)
def test_newer_schema_is_left_untouched(self):
original = {
"schema_version": queue_control.PERSISTENT_QUEUE_SCHEMA_VERSION + 999,
"items": [{"prompt_id": "p3", "item": ITEM}],
}
self.write_payload(original)
mgr = PersistentQueueManager()
self.assertEqual(mgr.persistent_items, [])
self.assertEqual(
self.read_payload(),
original,
"a file from a newer version must not be overwritten on downgrade",
)
# Even an explicit save must keep the foreign file read-only.
mgr.add_item((0, "p5", {}, {}, {}))
mgr.flush()
self.assertEqual(
self.read_payload(),
original,
"saving while downgraded must not overwrite the newer file",
)
def test_save_writes_versioned_envelope(self):
mgr = PersistentQueueManager()
mgr.add_item((0, "p4", {}, {}, {}))
mgr.flush()
payload = self.read_payload()
self.assertEqual(
payload["schema_version"],
queue_control.PERSISTENT_QUEUE_SCHEMA_VERSION,
)
self.assertEqual([x["prompt_id"] for x in payload["items"]], ["p4"])
if __name__ == "__main__":
unittest.main()
+143
View File
@@ -0,0 +1,143 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import {
FakeMutationObserver,
createDocument,
createWindow,
sleep,
stripImports,
} from "./fake_dom.mjs";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "js", "power_sidebar.js");
const document = createDocument();
const window = createWindow(document);
const extension = { name: "", setup: null };
const app = {
registerExtension(candidate) {
extension.name = candidate.name;
extension.setup = candidate.setup;
},
extensionManager: {
setting: { get: () => true },
toast: { add() {} },
},
ui: { settings: { get: () => undefined, getSettingValue: () => undefined } },
};
let source = stripImports(fs.readFileSync(sourcePath, "utf8"));
source += `
globalThis.__powerTest = {
showPowerSidePopup,
closePowerPopup,
getActivePopup: () => activePopup,
hasCleanup: () => typeof activePopupCleanup === "function",
};
`;
const context = vm.createContext({
console,
document,
window,
app,
api: { addEventListener() {}, fetchApi: async () => null },
authenticatedFetch: async () => null,
localStorage: { getItem: () => null, setItem() {} },
MutationObserver: FakeMutationObserver,
setTimeout,
clearTimeout,
Math,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
Date,
parseInt,
isNaN,
Infinity,
});
vm.runInContext(source, context, { filename: sourcePath });
assert.equal(typeof extension.setup, "function", "power sidebar extension must register");
const { showPowerSidePopup, closePowerPopup, getActivePopup, hasCleanup } = context.__powerTest;
const anchor = document.createElement("button");
anchor.id = "power-anchor";
anchor.setRect({ left: 20, top: 850, right: 60, bottom: 890, width: 40, height: 40 });
document.body.appendChild(anchor);
function pointerDown(target) {
document.dispatchEvent({
type: "pointerdown",
target,
preventDefault() {},
stopPropagation() {},
});
}
// 1. Opening arms the outside-click listener exactly once.
showPowerSidePopup(anchor);
await sleep(25);
const popupA = getActivePopup();
assert.ok(popupA && popupA.isConnected, "first popup must be mounted");
assert.equal(document.listenerCount("pointerdown"), 1, "one outside listener after opening");
// 2. Closing via a menu item must also remove its document listeners.
closePowerPopup();
assert.equal(getActivePopup(), null, "popup must be removed");
assert.equal(document.listenerCount("pointerdown"), 0, "outside listener must be removed on close");
assert.equal(document.listenerCount("keydown"), 0, "keydown listener must be removed on close");
assert.equal(hasCleanup(), false, "cleanup reference must be cleared");
// 3. Reopen and click an item: the stale listener from popup A must not
// close popup B before its item click runs.
showPowerSidePopup(anchor);
await sleep(25);
const popupB = getActivePopup();
assert.ok(popupB && popupB.isConnected, "second popup must be mounted");
const item = document.createElement("button");
popupB.appendChild(item);
pointerDown(item);
assert.equal(getActivePopup(), popupB, "first click inside a reopened popup must keep it open");
// 4. A genuine outside click still closes it and cleans up.
const outside = document.createElement("div");
document.body.appendChild(outside);
pointerDown(outside);
assert.equal(getActivePopup(), null, "outside click must close the popup");
assert.equal(document.listenerCount("pointerdown"), 0, "outside listener must be removed after closing");
assert.equal(document.listenerCount("keydown"), 0, "keydown listener must be removed after closing");
// 5. Escape closes and cleans up too.
showPowerSidePopup(anchor);
await sleep(25);
assert.equal(document.listenerCount("keydown"), 1, "keydown listener armed");
document.dispatchEvent({ type: "keydown", key: "Escape", target: document.body });
assert.equal(getActivePopup(), null, "Escape must close the popup");
assert.equal(document.listenerCount("keydown"), 0, "Escape must remove the listener");
// 6. A popup detached by a DOM swap must not block reopening (toggle path).
showPowerSidePopup(anchor);
await sleep(25);
const detached = getActivePopup();
detached.remove();
assert.equal(detached.isConnected, false, "popup is detached");
showPowerSidePopup(anchor);
await sleep(25);
const reopened = getActivePopup();
assert.ok(reopened && reopened.isConnected, "a detached popup must not swallow the reopen");
closePowerPopup();
console.log("power popup DOM regression test passed");
+233 -16
View File
@@ -4,12 +4,21 @@ import unittest
import tempfile
import json
import shutil
import time
from unittest.mock import patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper
from nodes.prompt_iterator import PromptQueueIterator, parse_prompt_blocks, load_state, save_state
from nodes.prompt_iterator import (
PromptQueueIterator,
parse_prompt_blocks,
load_state,
save_state,
reset_node_state,
invalidate_state_cache,
)
import nodes.prompt_iterator as pi
class TestPromptQueueIterator(unittest.TestCase):
def setUp(self):
@@ -67,7 +76,7 @@ class TestPromptQueueIterator(unittest.TestCase):
patch("nodes.prompt_iterator.PromptServer.instance.send_sync"):
for expected_idx in range(10):
p, rem_text, rem_count = self.node.process_queue(
p, rem_text, rem_count, exhausted = self.node.process_queue(
pop_mode="Sequential (Loop on End)",
separator=">1 Empty Line",
text=prompts_10,
@@ -76,6 +85,47 @@ class TestPromptQueueIterator(unittest.TestCase):
self.assertEqual(p, f"Prompt A{expected_idx}")
self.assertEqual(rem_count, 10 - (expected_idx + 1))
def test_linked_prompt_input_wins_over_stale_text(self):
"""
A connected `prompt` input is authoritative; the local multiline `text`
widget must not replay stale characters from an earlier session.
"""
state_db = {}
def mock_load():
return dict(state_db)
def mock_save(new_state):
nonlocal state_db
state_db = dict(new_state)
stale_text = "stale one\n\nstale two"
linked_text = "linked one\n\nlinked two"
with patch("nodes.prompt_iterator.load_state", side_effect=mock_load), \
patch("nodes.prompt_iterator.save_state", side_effect=mock_save), \
patch("nodes.prompt_iterator.PromptServer.instance.send_sync"):
p0, _, _, _ = self.node.process_queue(
text=stale_text, prompt=linked_text, unique_id="linked_node"
)
p1, _, _, _ = self.node.process_queue(
text=stale_text, prompt=linked_text, unique_id="linked_node"
)
self.assertEqual(p0, "linked one")
self.assertEqual(p1, "linked two")
def test_linked_empty_prompt_does_not_replay_local_text(self):
"""An empty linked prompt produces no run, even if `text` is stale."""
p, remaining, count, exhausted = self.node.process_queue(
text="stale prompt text", prompt="", unique_id="linked_empty"
)
self.assertEqual(p, "")
self.assertEqual(remaining, "")
self.assertEqual(count, 0)
self.assertFalse(exhausted)
def test_multi_pack_isolation_pack_a_and_pack_b(self):
"""
Verify Pack A (10 prompts) and Pack B (5 prompts) run with complete isolation.
@@ -96,21 +146,21 @@ class TestPromptQueueIterator(unittest.TestCase):
patch("nodes.prompt_iterator.PromptServer.instance.send_sync"):
# Run 3 items of Pack A
p0, _, _ = self.node.process_queue(text=pack_a, unique_id="shared_node")
p1, _, _ = self.node.process_queue(text=pack_a, unique_id="shared_node")
p2, _, _ = self.node.process_queue(text=pack_a, unique_id="shared_node")
p0, _, _, _ = self.node.process_queue(text=pack_a, unique_id="shared_node")
p1, _, _, _ = self.node.process_queue(text=pack_a, unique_id="shared_node")
p2, _, _, _ = self.node.process_queue(text=pack_a, unique_id="shared_node")
self.assertEqual(p0, "PackA_0")
self.assertEqual(p1, "PackA_1")
self.assertEqual(p2, "PackA_2")
# Run Pack B -> Must start cleanly at PackB_0!
pb0, _, _ = self.node.process_queue(text=pack_b, unique_id="shared_node")
pb1, _, _ = self.node.process_queue(text=pack_b, unique_id="shared_node")
pb0, _, _, _ = self.node.process_queue(text=pack_b, unique_id="shared_node")
pb1, _, _, _ = self.node.process_queue(text=pack_b, unique_id="shared_node")
self.assertEqual(pb0, "PackB_0")
self.assertEqual(pb1, "PackB_1")
# Switch back to Pack A -> Must continue at PackA_3!
p3, _, _ = self.node.process_queue(text=pack_a, unique_id="shared_node")
p3, _, _, _ = self.node.process_queue(text=pack_a, unique_id="shared_node")
self.assertEqual(p3, "PackA_3")
def test_text_modification_resets_counter_to_zero(self):
@@ -137,7 +187,7 @@ class TestPromptQueueIterator(unittest.TestCase):
self.node.process_queue(text=pack_10, unique_id="edit_node")
# Switch to edited 7-pack -> Must start at Item_0!
first_of_7, _, rem_count = self.node.process_queue(text=pack_7, unique_id="edit_node")
first_of_7, _, rem_count, _ = self.node.process_queue(text=pack_7, unique_id="edit_node")
self.assertEqual(first_of_7, "Item_0")
self.assertEqual(rem_count, 6)
@@ -160,8 +210,8 @@ class TestPromptQueueIterator(unittest.TestCase):
patch("nodes.prompt_iterator.PromptServer.instance.send_sync"):
# Run P0, P1
p0, _, _ = self.node.process_queue(text=pack, unique_id="reset_test")
p1, _, _ = self.node.process_queue(text=pack, unique_id="reset_test")
p0, _, _, _ = self.node.process_queue(text=pack, unique_id="reset_test")
p1, _, _, _ = self.node.process_queue(text=pack, unique_id="reset_test")
self.assertEqual(p0, "P0")
self.assertEqual(p1, "P1")
@@ -171,7 +221,7 @@ class TestPromptQueueIterator(unittest.TestCase):
state_db[k]["index"] = 0
# Next run must be P0 again!
p0_again, _, _ = self.node.process_queue(text=pack, unique_id="reset_test")
p0_again, _, _, _ = self.node.process_queue(text=pack, unique_id="reset_test")
self.assertEqual(p0_again, "P0")
def test_crash_recovery_assigned_prompt_id_retains_index(self):
@@ -195,18 +245,18 @@ class TestPromptQueueIterator(unittest.TestCase):
# 1. First execution with prompt_id = "job-uuid-1" -> gets Prompt 0
with patch("nodes.prompt_iterator.get_current_prompt_id", return_value="job-uuid-1"):
p0, _, _ = self.node.process_queue(text=pack, unique_id="recover_node")
p0, _, _, _ = self.node.process_queue(text=pack, unique_id="recover_node")
self.assertEqual(p0, "Prompt 0")
# 2. Workflow is interrupted mid-way and restored by persistent queue (same prompt_id "job-uuid-1")
with patch("nodes.prompt_iterator.get_current_prompt_id", return_value="job-uuid-1"):
p0_retry, _, _ = self.node.process_queue(text=pack, unique_id="recover_node")
p0_retry, _, _, _ = self.node.process_queue(text=pack, unique_id="recover_node")
# Must STILL be Prompt 0, NOT Prompt 1!
self.assertEqual(p0_retry, "Prompt 0")
# 3. Next workflow run with new prompt_id = "job-uuid-2" -> gets Prompt 1!
with patch("nodes.prompt_iterator.get_current_prompt_id", return_value="job-uuid-2"):
p1, _, _ = self.node.process_queue(text=pack, unique_id="recover_node")
p1, _, _, _ = self.node.process_queue(text=pack, unique_id="recover_node")
self.assertEqual(p1, "Prompt 1")
def test_per_node_hash_pruning(self):
@@ -255,7 +305,7 @@ class TestPromptQueueIterator(unittest.TestCase):
picked = []
for _ in range(5):
p, _, _ = self.node.process_queue(
p, _, _, _ = self.node.process_queue(
pop_mode="Random (Cycle)",
text=pack,
unique_id="cycle_test_node"
@@ -266,5 +316,172 @@ class TestPromptQueueIterator(unittest.TestCase):
self.assertEqual(len(picked), 5)
self.assertEqual(set(picked), {"A", "B", "C", "D", "E"})
def test_separator_and_mode_isolate_state_keys(self):
"""Changing the splitter/mode must not continue another config's pointer."""
pack = "A\n\nB\n\nC"
state_db = {}
with patch("nodes.prompt_iterator.load_state", side_effect=lambda: dict(state_db)), \
patch("nodes.prompt_iterator.save_state", side_effect=lambda s: state_db.update(s)), \
patch("nodes.prompt_iterator.PromptServer.instance.send_sync"):
a0, _, _, _ = self.node.process_queue(
separator=">1 Empty Line", text=pack, unique_id="cfg_node")
a1, _, _, _ = self.node.process_queue(
separator=">1 Empty Line", text=pack, unique_id="cfg_node")
self.assertEqual((a0, a1), ("A", "B"))
# Newline splitter is a different config and must start at index 0.
n0, _, _, _ = self.node.process_queue(
separator="Newline", text=pack, unique_id="cfg_node")
self.assertEqual(n0, "A")
# Random mode with the same splitter is also a different config.
r0, _, _, _ = self.node.process_queue(
pop_mode="Random (Keep)", separator=">1 Empty Line", text=pack, unique_id="cfg_node")
self.assertIn(r0, {"A", "B", "C"})
# Returning to the original config resumes at C.
a2, _, _, _ = self.node.process_queue(
separator=">1 Empty Line", text=pack, unique_id="cfg_node")
self.assertEqual(a2, "C")
def test_input_types_preserve_legacy_widget_positions(self):
# New widgets must be appended, never inserted in the middle: ComfyUI
# restores workflow widget values positionally.
spec = PromptQueueIterator.INPUT_TYPES()
self.assertEqual(list(spec["required"].keys()), ["pop_mode", "separator", "text"])
self.assertEqual(list(spec["optional"].keys())[:2], ["custom_regex", "track_by"])
def test_track_by_node_only_shares_pointer_across_text_edits(self):
state_db = {}
with patch("nodes.prompt_iterator.load_state", side_effect=lambda: dict(state_db)), \
patch("nodes.prompt_iterator.save_state", side_effect=lambda s: state_db.update(s)), \
patch("nodes.prompt_iterator.PromptServer.instance.send_sync"):
p0, _, _, _ = self.node.process_queue(
text="A\n\nB\n\nC", unique_id="node_track", track_by="Node Only")
self.assertEqual(p0, "A")
# The edited prompt pack keeps the same pointer (index 1 -> Y).
p1, _, _, _ = self.node.process_queue(
text="X\n\nY\n\nZ", unique_id="node_track", track_by="Node Only")
self.assertEqual(p1, "Y")
# Default tracking starts the edited pack from the beginning.
d0, _, _, _ = self.node.process_queue(
text="X\n\nY\n\nZ", unique_id="text_track")
self.assertEqual(d0, "X")
def test_stop_on_end_exhausted_flag_and_remaining(self):
state_db = {}
with patch("nodes.prompt_iterator.load_state", side_effect=lambda: dict(state_db)), \
patch("nodes.prompt_iterator.save_state", side_effect=lambda s: state_db.update(s)), \
patch("nodes.prompt_iterator.PromptServer.instance.send_sync"):
p0, rem0, count0, exhausted0 = self.node.process_queue(
pop_mode="Sequential (Stop on End)", text="A\n\nB", unique_id="stop_node")
self.assertEqual((p0, rem0, count0, exhausted0), ("A", "B", 1, False))
p1, rem1, count1, exhausted1 = self.node.process_queue(
pop_mode="Sequential (Stop on End)", text="A\n\nB", unique_id="stop_node")
self.assertEqual((p1, rem1, count1, exhausted1), ("B", "", 0, True))
# Further runs keep returning the final prompt and report exhaustion.
p2, _, count2, exhausted2 = self.node.process_queue(
pop_mode="Sequential (Stop on End)", text="A\n\nB", unique_id="stop_node")
self.assertEqual((p2, count2, exhausted2), ("B", 0, True))
def test_random_cycle_remaining_follows_shuffle_order(self):
state_db = {}
with patch("nodes.prompt_iterator.load_state", side_effect=lambda: dict(state_db)), \
patch("nodes.prompt_iterator.save_state", side_effect=lambda s: state_db.update(s)), \
patch("nodes.prompt_iterator.PromptServer.instance.send_sync"), \
patch("nodes.prompt_iterator.random.shuffle", side_effect=lambda seq: seq.reverse()):
results = []
for _ in range(4):
results.append(self.node.process_queue(
pop_mode="Random (Cycle)", text="A\n\nB\n\nC\n\nD", unique_id="cycle_rem"))
# Reversed order is D, C, B, A.
self.assertEqual([r[0] for r in results], ["D", "C", "B", "A"])
self.assertEqual([r[2] for r in results], [3, 2, 1, 0])
self.assertEqual(results[0][1], "C\n\nB\n\nA")
self.assertEqual(results[1][1], "B\n\nA")
self.assertEqual(results[2][1], "A")
self.assertEqual(results[3][1], "")
def test_hard_reset_clears_assignments_and_shuffle(self):
state = {
"node_42_aaaa_1111": {
"index": 3,
"last_run": 3,
"assigned_prompts": {"prompt-a": 1, "prompt-b": 2},
"shuffled_order": [1, 0, 2],
},
"node_42": {"index": 2, "assigned_prompts": {"prompt-c": 0}},
"node_99_bbbb_2222": {"index": 5, "assigned_prompts": {"keep": 1}},
}
matched = reset_node_state(state, "42")
self.assertTrue(matched)
self.assertEqual(state["node_42_aaaa_1111"]["index"], 0)
self.assertEqual(state["node_42_aaaa_1111"]["last_run"], 0)
self.assertEqual(state["node_42_aaaa_1111"]["assigned_prompts"], {})
self.assertEqual(state["node_42_aaaa_1111"]["shuffled_order"], [])
self.assertEqual(state["node_42"]["assigned_prompts"], {})
# Other nodes are untouched.
self.assertEqual(state["node_99_bbbb_2222"]["index"], 5)
self.assertEqual(state["node_99_bbbb_2222"]["assigned_prompts"], {"keep": 1})
def test_global_prune_keeps_most_recent_entries(self):
state = {}
for i in range(105):
state[f"node_prune_{i}_{i}"] = {"index": 0, "last_updated": i}
old_file = pi.STATE_FILE
old_user = pi.USER_DIR
pi.STATE_FILE = os.path.join(self.temp_dir, "prune_state.json")
pi.USER_DIR = self.temp_dir
try:
save_state(state)
finally:
pi.STATE_FILE = old_file
pi.USER_DIR = old_user
invalidate_state_cache()
self.assertEqual(len(state), 100)
self.assertNotIn("node_prune_0_0", state)
self.assertNotIn("node_prune_4_4", state)
self.assertIn("node_prune_5_5", state)
self.assertIn("node_prune_104_104", state)
def test_load_state_uses_mtime_cache_and_returns_copies(self):
state_file = os.path.join(self.temp_dir, "cache_state.json")
old_file = pi.STATE_FILE
old_user = pi.USER_DIR
pi.STATE_FILE = state_file
pi.USER_DIR = self.temp_dir
try:
invalidate_state_cache()
save_state({"node_a": {"index": 1, "last_updated": 1}})
first = load_state()
first["node_a"]["index"] = 999 # Must not mutate the cache.
second = load_state()
self.assertEqual(second["node_a"]["index"], 1)
# External edit (new mtime) must invalidate the in-memory cache.
with open(state_file, "w", encoding="utf-8") as f:
json.dump({"node_a": {"index": 7, "last_updated": 2}}, f)
future = time.time() + 5
os.utime(state_file, (future, future))
third = load_state()
self.assertEqual(third["node_a"]["index"], 7)
finally:
pi.STATE_FILE = old_file
pi.USER_DIR = old_user
invalidate_state_cache()
if __name__ == "__main__":
unittest.main()
+123
View File
@@ -0,0 +1,123 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import {
createDocument,
createWindow,
stripImports,
} from "./fake_dom.mjs";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
const sourcePath = path.join(repoRoot, "web", "saturnnodes_settings.js");
const document = createDocument();
const window = createWindow(document);
const extension = { name: "", setup: null };
const app = {
registerExtension(candidate) {
extension.name = candidate.name;
extension.setup = candidate.setup;
},
ui: { settings: { addSetting() {}, get: () => undefined, getSettingValue: () => undefined } },
extensionManager: { toast: { add() {} } },
graph: { setDirtyCanvas() {} },
};
let source = stripImports(fs.readFileSync(sourcePath, "utf8"));
source += "\nglobalThis.__settingsTest = { reapplyQueueHeightToMountedLists };\n";
const context = vm.createContext({
console,
document,
window,
app,
api: { addEventListener() {} },
authenticatedFetch: async () => null,
updateAllSaturnNodeColors() {},
localStorage: { getItem: () => null, setItem() {} },
fetch: async () => ({ ok: false, json: async () => ({}) }),
MutationObserver: class { observe() {} disconnect() {} },
setTimeout,
clearTimeout,
setInterval: () => 0,
clearInterval: () => {},
requestAnimationFrame: window.requestAnimationFrame,
cancelAnimationFrame: window.cancelAnimationFrame,
Math,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
Date,
parseInt,
parseFloat,
isNaN,
Infinity,
});
vm.runInContext(source, context, { filename: sourcePath });
assert.equal(typeof extension.setup, "function", "settings extension must register");
const { reapplyQueueHeightToMountedLists } = context.__settingsTest;
const overlay = document.createElement("div");
overlay.setAttribute("data-testid", "queue-progress-overlay");
document.body.appendChild(overlay);
const firstList = document.createElement("div");
firstList.className = "comfy-list";
overlay.appendChild(firstList);
const applied = [];
const applyHeight = height => {
applied.push(height);
// Mirrors applyQueueOverlayHeight(): every processed list gets the marker.
for (const list of overlay.querySelectorAll(".comfy-list")) {
list.dataset.saturnQueueHeight = String(height);
}
};
assert.equal(
reapplyQueueHeightToMountedLists(overlay, 360, applyHeight),
true,
"a freshly mounted list must trigger a re-apply"
);
assert.deepEqual(applied, [360], "the saved height must be applied");
assert.equal(
reapplyQueueHeightToMountedLists(overlay, 360, applyHeight),
false,
"an already-styled list must not be rewritten on every mutation"
);
assert.deepEqual(applied, [360], "no duplicate apply");
const secondList = document.createElement("div");
secondList.className = "comfy-list";
overlay.appendChild(secondList);
assert.equal(
reapplyQueueHeightToMountedLists(overlay, 360, applyHeight),
true,
"a second list mounting later must also be styled"
);
assert.deepEqual(applied, [360, 360], "re-apply covers the new list");
assert.equal(
reapplyQueueHeightToMountedLists(overlay, 0, applyHeight),
false,
"Native height (0) must not force a max-height"
);
assert.equal(
reapplyQueueHeightToMountedLists(document.createElement("div"), 360, applyHeight),
false,
"overlays without legacy lists must be ignored"
);
console.log("queue height DOM regression test passed");
+48 -1
View File
@@ -1,6 +1,10 @@
import os
import sys
import time
import shutil
import tempfile
import unittest
from unittest.mock import patch
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
import test_helper
@@ -15,10 +19,22 @@ from nodes.utils import (
sanitize_image_loader_folder,
get_csrf_token,
is_same_origin_or_direct,
is_authenticated_local_request
is_authenticated_local_request,
get_env_setting,
invalidate_env_settings_cache
)
class TestUtils(unittest.TestCase):
def test_user_state_is_isolated_from_live_comfyui(self):
from nodes.utils import get_saturnnodes_user_dir
expected_root = os.path.normpath(test_helper.TEST_USER_ROOT)
actual = os.path.normpath(get_saturnnodes_user_dir())
self.assertEqual(os.path.commonpath([expected_root, actual]), expected_root)
self.assertNotEqual(actual, os.path.normpath(os.path.join(
os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
"..", "..", "user", "default", "SaturnNodes")))
def test_is_local_request(self):
class DummyReq:
def __init__(self, ip):
@@ -204,5 +220,36 @@ class TestUtils(unittest.TestCase):
is_confined = (os.path.commonpath([inp, res_norm]) == inp) or (os.path.commonpath([out, res_norm]) == out)
self.assertTrue(is_confined, f"Image folder '{bad}' escaped confinement: '{res_norm}'")
def test_get_env_setting_cache_and_invalidation(self):
temp_dir = tempfile.mkdtemp()
env_file = os.path.join(temp_dir, ".env")
try:
with open(env_file, "w", encoding="utf-8") as f:
f.write("# comment\nA=1\nB=\nMALFORMED_LINE\nC=hello world\n")
with patch("nodes.utils.get_saturnnodes_user_dir", return_value=temp_dir):
invalidate_env_settings_cache()
self.assertEqual(get_env_setting("A", "fallback"), "1")
self.assertEqual(get_env_setting("B", "fallback"), "")
self.assertEqual(get_env_setting("C", "fallback"), "hello world")
self.assertEqual(get_env_setting("MISSING", "fallback"), "fallback")
# Cached value is returned until mtime changes.
with open(env_file, "w", encoding="utf-8") as f:
f.write("A=2\n")
future = time.time() + 5
os.utime(env_file, (future, future))
self.assertEqual(get_env_setting("A", "fallback"), "2")
self.assertEqual(get_env_setting("B", "fallback"), "fallback")
# Explicit invalidation forces a re-read even with a forced mtime.
with open(env_file, "w", encoding="utf-8") as f:
f.write("A=3\n")
invalidate_env_settings_cache()
self.assertEqual(get_env_setting("A", "fallback"), "3")
finally:
invalidate_env_settings_cache()
shutil.rmtree(temp_dir, ignore_errors=True)
if __name__ == "__main__":
unittest.main()
+137
View File
@@ -0,0 +1,137 @@
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import {
createDocument,
stripImports,
} from "./fake_dom.mjs";
import { resolveLiveElement, resolveLiveWidgetElement } from "../web/js/live_dom.js";
const here = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(here, "..");
// 1. Resolver behavior in isolation.
{
const document = createDocument();
// live_dom.js is a real ES module and resolves `document` from globalThis.
globalThis.document = document;
const stale = document.createElement("div");
const fresh = document.createElement("div");
fresh.setAttribute("data-node-id", "7");
const widget = document.createElement("div");
widget.setAttribute("data-widget-name", "prompt_count_preview");
fresh.appendChild(widget);
document.body.appendChild(fresh);
assert.equal(
resolveLiveWidgetElement(stale, 7, "prompt_count_preview"),
widget,
"detached cache must re-resolve to the remounted widget"
);
const live = document.createElement("div");
document.body.appendChild(live);
let findCalls = 0;
assert.equal(
resolveLiveElement(live, () => { findCalls++; return fresh; }),
live,
"live cache must be used as-is"
);
assert.equal(findCalls, 0, "live cache must not trigger a DOM lookup");
let missingCalls = 0;
assert.equal(
resolveLiveElement(stale, () => { missingCalls++; return null; }),
stale,
"pre-mount writes must keep using the cached element"
);
assert.equal(missingCalls, 1, "a lookup is attempted once before falling back");
}
// 2. Prompt counter: a remounted badge must receive the next update.
const document = createDocument();
globalThis.document = document;
const extension = { name: "", nodeCreated: null };
const app = {
registerExtension(candidate) {
extension.name = candidate.name;
extension.nodeCreated = candidate.nodeCreated;
},
graph: { setDirtyCanvas() {} },
};
let source = stripImports(
fs.readFileSync(path.join(repoRoot, "web", "js", "prompt_counter.js"), "utf8")
);
const context = vm.createContext({
console,
document,
app,
isSaturnColorsEnabled: () => false,
resolveLiveElement,
resolveLiveWidgetElement,
setTimeout,
clearTimeout,
Math,
JSON,
String,
Number,
Object,
Array,
Map,
Set,
Promise,
Date,
parseInt,
isNaN,
Infinity,
});
vm.runInContext(source, context, { filename: "prompt_counter.js" });
assert.equal(typeof extension.nodeCreated, "function", "prompt counter extension must register");
const node = {
id: 7,
comfyClass: "PromptCounter",
type: "PromptCounter",
size: [240, 120],
flags: {},
widgets: [
{ name: "text", value: "a\n\nb", callback: null, inputEl: null },
{ name: "separator", value: ">1 Empty Line", callback: null },
{ name: "custom_regex", value: "", callback: null },
],
addDOMWidget(name, type, element) {
const widget = { name, type, element, value: "" };
this.widgets.push(widget);
return widget;
},
};
await extension.nodeCreated(node);
const staleSpan = node._promptBadgeSpan;
assert.ok(staleSpan, "badge span must be created");
assert.equal(staleSpan.textContent, "0 Prompts", "initial badge label");
// Simulate the Vue renderer remounting the DOM widget with a fresh subtree.
const wrapper = document.createElement("div");
wrapper.setAttribute("data-node-id", "7");
const freshBadge = document.createElement("div");
freshBadge.setAttribute("data-widget-name", "prompt_count_preview");
const freshSpan = document.createElement("span");
freshSpan.textContent = "0 Prompts";
freshBadge.appendChild(freshSpan);
wrapper.appendChild(freshBadge);
document.body.appendChild(wrapper);
const textWidget = node.widgets.find(w => w.name === "text");
textWidget.callback();
assert.equal(node._promptBadgeSpan, freshSpan, "cache must point at the remounted span");
assert.equal(freshSpan.textContent, "2 Prompts", "remounted badge must receive the new count");
assert.equal(staleSpan.textContent, "0 Prompts", "detached span must not be treated as visible");
console.log("widget guard DOM regression test passed");
+270 -65
View File
@@ -67,7 +67,9 @@ function loadStorage() {
}
const savedCounter = localStorage.getItem(BATCH_COUNTER_KEY);
if (savedCounter) {
batchCounter = parseInt(savedCounter, 10) || 0;
// A negative or corrupted counter would index outside BATCH_COLORS
// and render an undefined stroke color.
batchCounter = Math.max(0, parseInt(savedCounter, 10) || 0);
}
} catch (e) {
console.warn("[SaturnNodes BatchQueue] Failed to load batch storage:", e);
@@ -76,9 +78,19 @@ function loadStorage() {
function saveStorage() {
try {
// Prune entries to last 250 items to keep localStorage small
// Prune entries to the 250 most recently queued items. Map insertion
// order is not a reliable recency order when metadata for an existing
// prompt is updated in place.
const allEntries = Array.from(batchRegistry.values());
const pruned = allEntries.slice(-250);
const pruned = allEntries
.map((entry, index) => ({ entry, index }))
.sort((a, b) => {
const aTime = Number(a.entry && a.entry.queuedAt) || 0;
const bTime = Number(b.entry && b.entry.queuedAt) || 0;
return aTime - bTime || a.index - b.index;
})
.slice(-250)
.map(item => item.entry);
localStorage.setItem(STORAGE_KEY, JSON.stringify(pruned));
localStorage.setItem(BATCH_COUNTER_KEY, String(batchCounter));
} catch (e) {
@@ -151,6 +163,25 @@ function injectBatchStyles() {
document.head.appendChild(style);
}
// Batch metadata comes from localStorage and the server, so never trust its
// color string as HTML/SVG markup. Only complete 3/4/6/8-digit hex colors are
// accepted (5 and 7-digit values are not valid CSS colors).
const HEX_COLOR_PATTERN = /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/;
function normalizeBatchColor(color, fallback = BATCH_COLORS[0]) {
if (typeof color === "string") {
const trimmed = color.trim();
if (HEX_COLOR_PATTERN.test(trimmed)) return trimmed;
}
return fallback;
}
function normalizeSegmentType(segmentType) {
return ["single", "first", "middle", "last"].includes(segmentType)
? segmentType
: "single";
}
// Build 1D SVG line path according to segment type:
// 'single': bracket (rounded top & bottom curving right to card)
// 'first': rounded top curving right, straight all the way down
@@ -182,10 +213,19 @@ function renderBatchLineOnElement(element, segmentType, color) {
element.appendChild(wrap);
}
const dPath = buildSvgPath(segmentType);
const safeSegment = normalizeSegmentType(segmentType);
const safeColor = normalizeBatchColor(color);
// Avoid rewriting the SVG on every status/executing refresh when the
// visible segment and batch color have not changed.
const signature = `${safeSegment}|${safeColor}`;
if (wrap.dataset.saturnnodesBatchSignature === signature && wrap.innerHTML) return;
wrap.dataset.saturnnodesBatchSignature = signature;
const dPath = buildSvgPath(safeSegment);
wrap.innerHTML = `
<svg class="saturnnodes-batch-line-svg" viewBox="0 0 10 48" preserveAspectRatio="none">
<path d="${dPath}" stroke="${color}" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" fill="none" />
<path d="${dPath}" stroke="${safeColor}" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" fill="none" />
</svg>
`;
}
@@ -327,9 +367,15 @@ async function loadBatchFromServer() {
const data = await res.json();
if (data && typeof data === "object") {
for (const [pid, info] of Object.entries(data)) {
if (pid && info) {
batchRegistry.set(String(pid), info);
if (!pid || !info || typeof info !== "object") continue;
const key = String(pid);
const existing = batchRegistry.get(key);
// Never let an older server snapshot overwrite newer local
// metadata for the same prompt.
if (existing && (Number(existing.queuedAt) || 0) > (Number(info.queuedAt) || 0)) {
continue;
}
batchRegistry.set(key, info);
}
saveStorage();
}
@@ -337,6 +383,29 @@ async function loadBatchFromServer() {
} catch (e) {}
}
// Queue cards are virtualized/reused by the Vue queue. A card can keep the
// same DOM element when it moves from pending -> running or when the next batch
// starts, so the old batch line must be repainted after Vue has updated its
// data-job-id. A single delayed update can race the async /jobs refresh; poll
// briefly after each queue event and let the MutationObserver below catch the
// actual attribute update as well.
let batchVisualRefreshToken = 0;
function scheduleBatchVisualRefresh(durationMs = 1200) {
const token = ++batchVisualRefreshToken;
const deadline = Date.now() + durationMs;
const refresh = () => {
if (token !== batchVisualRefreshToken) return;
updateQueueBatchVisuals();
if (Date.now() < deadline) {
setTimeout(refresh, 200);
}
};
refresh();
}
// Refresh visual lines in DOM for both v1 and v2
async function updateQueueBatchVisuals() {
if (!isBatchQueueEnabled()) {
@@ -348,14 +417,37 @@ async function updateQueueBatchVisuals() {
const elements = Array.from(document.querySelectorAll('[data-testid="job-assets-list"] [data-job-id], .comfy-table tr[data-job-id]'));
if (!elements.length) return;
// Elements are strictly in visual screen order from top to bottom
const visiblePromptIds = elements.map(el => el.getAttribute("data-job-id")).filter(Boolean);
// Build map of promptId -> element for visible items
// Elements are strictly in visual screen order from top to bottom.
// Dedupe by prompt id: a duplicate row would otherwise skew the batch
// grouping counts and make the line segments disagree with the list.
const visiblePromptIds = [];
const elMap = new Map();
const duplicateElements = [];
for (const el of elements) {
const pid = el.getAttribute("data-job-id");
if (pid) elMap.set(pid, el);
if (!pid) continue;
if (elMap.has(pid)) {
// A duplicate row must not keep a batch line painted by an earlier
// render either; only the first visible occurrence is authoritative.
duplicateElements.push(el);
continue;
}
visiblePromptIds.push(pid);
elMap.set(pid, el);
}
if (!visiblePromptIds.length) return;
for (const el of duplicateElements) {
removeBatchLineFromElement(el);
}
// Group visible prompts by batch once (O(n)) instead of filtering the whole
// visible list for every rendered card (O(n²)).
const batchGroups = new Map();
for (const pid of visiblePromptIds) {
const info = batchRegistry.get(pid);
if (!info || !info.batchId) continue;
if (!batchGroups.has(info.batchId)) batchGroups.set(info.batchId, []);
batchGroups.get(info.batchId).push(pid);
}
// For every prompt on screen, calculate segment type based on visual screen order:
@@ -374,23 +466,25 @@ async function updateQueueBatchVisuals() {
}
const batchId = info.batchId;
const color = info.color || BATCH_COLORS[0];
const color = normalizeBatchColor(info.color);
const batchCount = Math.max(1, Number(info.batchCount) || 1);
const rawItemIndex = Number.isInteger(info.itemIndex) ? info.itemIndex : 0;
// Corrupt metadata must not produce a "middle" segment for an index
// outside the batch (e.g. -1 or 99 in a 3-item batch).
const itemIndex = Math.min(Math.max(0, rawItemIndex), batchCount - 1);
// Find all visible items of this batch in top-to-bottom visual order
const occurrencesOnScreen = visiblePromptIds.filter(p => {
const b = batchRegistry.get(p);
return b && b.batchId === batchId;
});
// All visible items of this batch in top-to-bottom visual order
const occurrencesOnScreen = batchGroups.get(batchId) || [];
if (occurrencesOnScreen.length <= 1) {
// Only 1 item of this batch currently visible on screen
if ((info.batchCount || 1) === 1) {
if (batchCount === 1) {
renderBatchLineOnElement(el, "single", color);
} else {
// Batch originally had multiple items, but only 1 is currently visible/unexecuted
if (info.itemIndex === 0) {
if (itemIndex === 0) {
renderBatchLineOnElement(el, "first", color);
} else if (info.itemIndex === (info.batchCount - 1)) {
} else if (itemIndex === (batchCount - 1)) {
renderBatchLineOnElement(el, "last", color);
} else {
renderBatchLineOnElement(el, "middle", color);
@@ -416,9 +510,32 @@ async function updateQueueBatchVisuals() {
}
let batchSubmissionQueue = Promise.resolve();
// Number of queue actions whose submission turn has not settled yet. Used to
// detect that ComfyUI will serialize this prompt later instead of immediately.
let pendingSubmissions = 0;
function capturePromptAtClick() {
// Serialize the graph now, while the canvas still shows what the user
// clicked. ComfyUI's own loop calls graphToPrompt() much later when another
// batch is still being submitted, so without this the text and LoRA
// selection edited in the meantime bleed into the queued prompt.
try {
if (app && typeof app.graphToPrompt === "function") {
return Promise.resolve(app.graphToPrompt()).catch(e => {
console.warn("[SaturnNodes BatchQueue] Click-time prompt snapshot failed:", e);
return null;
});
}
} catch (e) {
console.warn("[SaturnNodes BatchQueue] Click-time prompt snapshot failed:", e);
}
return null;
}
// Hook queuePrompt to track batch execution and guard multi-item batches
function setupQueueHooks() {
if (setupQueueHooks._installed) return;
setupQueueHooks._installed = true;
loadStorage();
// 1. Hook app.queuePrompt to know when a batch is initiated
@@ -427,9 +544,21 @@ function setupQueueHooks() {
app.queuePrompt = async function(number, batchCount = 1, queueNodeIds) {
const count = Math.max(1, parseInt(batchCount, 10) || 1);
// Only ComfyUI's own processing loop or this submission queue can
// delay serialization. When idle, ComfyUI snapshots immediately, so
// skipping the extra graphToPrompt() keeps single clicks cheap.
const shouldCapture = isSnapshotGuardEnabled() &&
(pendingSubmissions > 0 || (app && app.processingQueue === true));
const clickPromptPromise = shouldCapture ? capturePromptAtClick() : null;
pendingSubmissions++;
// Chain onto batchSubmissionQueue to ensure sequential batch submissions
const turn = batchSubmissionQueue.then(async () => {
const batch = getNextBatch(count);
if (clickPromptPromise) {
batch.clickPromptPromise = clickPromptPromise;
}
activeBatchContext = batch;
saveStorage();
try {
@@ -439,6 +568,10 @@ function setupQueueHooks() {
}
});
batchSubmissionQueue = turn.catch(() => {});
turn.then(
() => { pendingSubmissions = Math.max(0, pendingSubmissions - 1); },
() => { pendingSubmissions = Math.max(0, pendingSubmissions - 1); }
);
return turn;
};
}
@@ -449,53 +582,101 @@ function setupQueueHooks() {
api.queuePrompt = async function(number, prompt, targets) {
let promptToSend = prompt;
// Reserve the item index before the request is sent; concurrent
// submissions must not race on the post-response queue length.
if (!activeBatchContext) {
activeBatchContext = getNextBatch(1);
}
// Capture this request's context. A concurrent request may finish
// the batch and clear the global reference while we are awaiting
// the server.
const batchContext = activeBatchContext;
if (!Number.isInteger(batchContext.nextItemIndex)) {
batchContext.nextItemIndex = 0;
}
if (!Number.isInteger(batchContext.inFlight)) {
batchContext.inFlight = 0;
}
const itemIndex = batchContext.nextItemIndex++;
batchContext.inFlight++;
// Batch Graph Snapshot Guard:
// When queueing a batch with batchCount > 1, snapshot on iteration 0 in the background
// so canvas edits (text, LoRA selection, widgets) don't bleed into subsequent items.
if (isSnapshotGuardEnabled() && activeBatchContext && activeBatchContext.batchCount > 1) {
const itemIndex = activeBatchContext.prompts.length;
if (itemIndex === 0) {
// Freeze the prompt the user clicked instead of the live canvas.
// Multi-item batches additionally reuse that snapshot for every
// later item so canvas edits cannot bleed into the rest of the batch.
if (isSnapshotGuardEnabled()) {
let clickPrompt = null;
if (itemIndex === 0 && batchContext.clickPromptPromise) {
try {
activeBatchContext.snapshotPrompt = JSON.parse(JSON.stringify(prompt));
clickPrompt = await batchContext.clickPromptPromise;
} catch (e) {
console.warn("[SaturnNodes BatchQueue] Failed to snapshot prompt:", e);
clickPrompt = null;
}
} else if (activeBatchContext.snapshotPrompt) {
promptToSend = mergeDynamicSeeds(activeBatchContext.snapshotPrompt, prompt);
batchContext.clickPromptPromise = null;
}
if (itemIndex === 0) {
if (clickPrompt && clickPrompt.output) {
try {
batchContext.snapshotPrompt = JSON.parse(JSON.stringify(clickPrompt));
} catch (e) {
console.warn("[SaturnNodes BatchQueue] Failed to snapshot prompt:", e);
}
// Keep randomized seeds from the live prompt so the
// generated image matches the seed the UI queued.
promptToSend = mergeDynamicSeeds(batchContext.snapshotPrompt, prompt);
} else if (batchContext.batchCount > 1) {
try {
batchContext.snapshotPrompt = JSON.parse(JSON.stringify(prompt));
} catch (e) {
console.warn("[SaturnNodes BatchQueue] Failed to snapshot prompt:", e);
}
}
} else if (batchContext.snapshotPrompt) {
promptToSend = mergeDynamicSeeds(batchContext.snapshotPrompt, prompt);
}
}
const res = await origApiQueuePrompt(number, promptToSend, targets);
let res;
try {
res = await origApiQueuePrompt(number, promptToSend, targets);
} catch (e) {
batchContext.inFlight--;
if (activeBatchContext === batchContext &&
batchContext.nextItemIndex >= batchContext.batchCount &&
batchContext.inFlight === 0) {
activeBatchContext = null;
}
throw e;
}
batchContext.inFlight--;
if (res && res.prompt_id) {
const pid = String(res.prompt_id);
if (!activeBatchContext) {
activeBatchContext = getNextBatch(1);
}
const itemIndex = activeBatchContext.prompts.length;
const batchInfo = {
prompt_id: pid,
batchId: activeBatchContext.batchId,
batchNumber: activeBatchContext.batchNumber,
batchCount: activeBatchContext.batchCount,
batchId: batchContext.batchId,
batchNumber: batchContext.batchNumber,
batchCount: batchContext.batchCount,
itemIndex: itemIndex,
color: activeBatchContext.color,
colorIndex: activeBatchContext.colorIndex,
color: batchContext.color,
colorIndex: batchContext.colorIndex,
isQueueFront: number < 0,
queuedAt: Date.now()
};
activeBatchContext.prompts.push(pid);
batchContext.prompts.push(pid);
batchRegistry.set(pid, batchInfo);
saveStorage();
syncBatchToServer(pid, batchInfo);
// If this batch completed its expected prompt count, clear context
if (activeBatchContext.prompts.length >= activeBatchContext.batchCount) {
if (activeBatchContext === batchContext &&
batchContext.nextItemIndex >= batchContext.batchCount &&
batchContext.inFlight === 0) {
activeBatchContext = null;
}
setTimeout(updateQueueBatchVisuals, 100);
scheduleBatchVisualRefresh(600);
}
return res;
};
@@ -507,32 +688,52 @@ app.registerExtension({
async setup() {
injectBatchStyles();
setupQueueHooks();
loadBatchFromServer();
loadBatchFromServer().then(() => scheduleBatchVisualRefresh(1200));
// Listen for queue changes
if (api && api.addEventListener) {
api.addEventListener("status", () => {
setTimeout(updateQueueBatchVisuals, 100);
});
api.addEventListener("execution_start", () => {
setTimeout(updateQueueBatchVisuals, 80);
});
api.addEventListener("executing", () => {
setTimeout(updateQueueBatchVisuals, 150);
});
const refreshAfterQueueEvent = () => scheduleBatchVisualRefresh();
api.addEventListener("status", refreshAfterQueueEvent);
api.addEventListener("execution_start", refreshAfterQueueEvent);
api.addEventListener("executing", refreshAfterQueueEvent);
api.addEventListener("execution_success", refreshAfterQueueEvent);
api.addEventListener("execution_error", refreshAfterQueueEvent);
api.addEventListener("execution_interrupted", refreshAfterQueueEvent);
}
// Set up MutationObserver on body to detect queue sidebar rendering
// Set up MutationObserver on body to detect queue sidebar rendering.
// `attributes` is essential: Vue reuses a running card and only updates
// its data-job-id when the next batch item starts. Without watching that
// attribute, the old batch line can remain painted on the reused card.
// `addedNodes` is inspected because a legacy .comfy-table can be
// inserted with its rows already built, producing no later mutation
// inside the table.
const QUEUE_MUTATION_SELECTOR =
'[data-testid="job-assets-list"], .comfy-table, [data-job-id]';
const mutationTouchesQueue = (m) => {
if (m.target && m.target.nodeType === 1) {
if (m.target.closest?.(QUEUE_MUTATION_SELECTOR) ||
m.target.matches?.(QUEUE_MUTATION_SELECTOR)) {
return true;
}
}
for (const node of m.addedNodes || []) {
if (node.nodeType !== 1) continue;
if (node.matches?.(QUEUE_MUTATION_SELECTOR) ||
node.querySelector?.(QUEUE_MUTATION_SELECTOR)) {
return true;
}
}
return false;
};
let debounceTimer = null;
const observer = new MutationObserver((mutations) => {
let shouldUpdate = false;
for (const m of mutations) {
if (m.target && m.target.nodeType === 1) {
if (m.target.closest?.('[data-testid="job-assets-list"], .comfy-table') ||
m.target.matches?.('[data-testid="job-assets-list"], [data-job-id]')) {
shouldUpdate = true;
break;
}
if (mutationTouchesQueue(m)) {
shouldUpdate = true;
break;
}
}
if (shouldUpdate) {
@@ -541,11 +742,15 @@ app.registerExtension({
}
});
observer.observe(document.body, { childList: true, subtree: true });
observer.observe(document.body, {
childList: true,
subtree: true,
attributes: true,
attributeFilter: ["data-job-id"],
});
// Initial check after load
setTimeout(updateQueueBatchVisuals, 800);
setTimeout(updateQueueBatchVisuals, 2000);
// Initial checks after load, including the async /jobs hydration.
scheduleBatchVisualRefresh(2500);
}
});
+55 -21
View File
@@ -1035,8 +1035,13 @@ class FloatingLatentDock {
// Safety clamp: bottomGap must never push dock beyond upper half of screen
bottomGap = Math.max(54, Math.min(bottomGap, Math.round(window.innerHeight * 0.75)));
this.dockEl.style.bottom = `${bottomGap}px`;
this.dockEl.style.right = "8px";
const nextBottom = `${bottomGap}px`;
if (this.dockEl.style.bottom !== nextBottom) {
this.dockEl.style.bottom = nextBottom;
}
if (this.dockEl.style.right !== "8px") {
this.dockEl.style.right = "8px";
}
}
requestPositionUpdate() {
@@ -1053,38 +1058,67 @@ class FloatingLatentDock {
// Track window resize (debounced via rAF)
window.addEventListener("resize", () => this.requestPositionUpdate(), { passive: true });
// Observe DOM structural changes only (minimap toggle / toolbar mount) without watching every subtree attribute
const observer = new MutationObserver(() => {
this.requestPositionUpdate();
// The minimap and canvas toolbar mount/unmount deep inside the app
// shell. A shallow body observer never sees those mutations, so the
// dock kept a stale bottom offset and could overlap the minimap while
// idle. Inspect added/removed subtrees for layout-relevant nodes.
const LAYOUT_SELECTOR =
".minimap-main-container, .litegraph-minimap, [role='toolbar'], " +
".graph-canvas-menu, .canvas-toolbar, .side-bar";
const isLayoutNode = (node) => {
if (!node || node.nodeType !== 1) return false;
if (node.matches?.(LAYOUT_SELECTOR)) return true;
return !!node.querySelector?.(LAYOUT_SELECTOR);
};
const observer = new MutationObserver((mutations) => {
for (const mutation of mutations) {
if (mutation.type !== "childList") continue;
for (const node of mutation.addedNodes || []) {
if (isLayoutNode(node)) {
this.requestPositionUpdate();
return;
}
}
for (const node of mutation.removedNodes || []) {
if (isLayoutNode(node)) {
this.requestPositionUpdate();
return;
}
}
}
});
observer.observe(document.body, {
childList: true,
subtree: false
subtree: true
});
}
injectToolbarButtonLoop() {
const tryInject = () => {
if (this.btnEl && document.body.contains(this.btnEl)) return;
if (!this.btnEl || !document.body.contains(this.btnEl)) {
const toolbar = document.querySelector(
'[role="toolbar"][aria-label*="canvasToolbar" i], [role="toolbar"][aria-label*="Canvas Toolbar" i], .graph-canvas-menu, .canvas-toolbar'
);
if (toolbar) {
this.createToolbarButton();
const toolbar = document.querySelector(
'[role="toolbar"][aria-label*="canvasToolbar" i], [role="toolbar"][aria-label*="Canvas Toolbar" i], .graph-canvas-menu, .canvas-toolbar'
);
if (!toolbar) return;
// Find Minimap button or FitView button in the toolbar to place alongside it
const minimapBtn = toolbar.querySelector('button[aria-label*="minimap" i], button[aria-label*="Minimap" i]');
if (minimapBtn && minimapBtn.parentElement === toolbar) {
toolbar.insertBefore(this.btnEl, minimapBtn.nextSibling);
} else {
toolbar.appendChild(this.btnEl);
}
this.createToolbarButton();
// Find Minimap button or FitView button in the toolbar to place alongside it
const minimapBtn = toolbar.querySelector('button[aria-label*="minimap" i], button[aria-label*="Minimap" i]');
if (minimapBtn && minimapBtn.parentElement === toolbar) {
toolbar.insertBefore(this.btnEl, minimapBtn.nextSibling);
} else {
toolbar.appendChild(this.btnEl);
this.updateVisibility();
}
}
this.updateVisibility();
this.updatePosition();
// Catch layout-only toggles (class/style changes) that produce no
// childList mutation. rAF-debounced and a no-op while hidden.
this.requestPositionUpdate();
};
tryInject();
+61 -12
View File
@@ -358,6 +358,20 @@ app.registerExtension({
// 2. Active Interaction Tracking & Image URL Resolution
let lastInteractedAssetCard = null;
let lastInteractedAssetKey = null;
const ASSET_CARD_SELECTOR =
"div[data-virtual-grid-item], [data-asset-id], .asset-card, [data-testid='asset-card'], [data-node-id], .lg-node, .comfy-image-preview, .group";
function assetIdentityKey(card) {
if (!card) return null;
const assetId = card.getAttribute?.("data-asset-id")
|| card.closest?.("[data-asset-id]")?.getAttribute?.("data-asset-id");
if (assetId) return `asset:${assetId}`;
const img = card.querySelector?.("img");
if (img && img.src) return `src:${img.src}`;
return null;
}
function isQueueItemElement(el) {
if (!el || typeof el.closest !== "function") return false;
@@ -370,22 +384,41 @@ function isQueueItemElement(el) {
function registerAssetInteraction(target) {
if (!target) return;
const card = target.closest?.(
"div[data-virtual-grid-item], [data-asset-id], .asset-card, [data-testid='asset-card'], [data-node-id], .lg-node, .comfy-image-preview, .group"
);
const card = target.closest?.(ASSET_CARD_SELECTOR);
if (card && !isQueueItemElement(card)) {
lastInteractedAssetCard = card;
lastInteractedAssetKey = assetIdentityKey(card);
}
}
// The virtual grid recycles card elements. A stored card can therefore be
// detached, or now display a different asset than the one the user clicked.
function getLiveInteractedCard() {
const card = lastInteractedAssetCard;
if (!card) return null;
if (card.isConnected === false) {
lastInteractedAssetCard = null;
lastInteractedAssetKey = null;
return null;
}
const key = assetIdentityKey(card);
if (lastInteractedAssetKey && key && key !== lastInteractedAssetKey) {
lastInteractedAssetCard = null;
lastInteractedAssetKey = null;
return null;
}
return card;
}
document.addEventListener("pointerdown", (e) => registerAssetInteraction(e.target), true);
document.addEventListener("click", (e) => registerAssetInteraction(e.target), true);
document.addEventListener("contextmenu", (e) => registerAssetInteraction(e.target), true);
function getActiveImageSrc() {
// 1. From last clicked / right-clicked / interacted asset card
if (lastInteractedAssetCard) {
const img = lastInteractedAssetCard.querySelector("img");
const interactedCard = getLiveInteractedCard();
if (interactedCard) {
const img = interactedCard.querySelector("img");
if (img && img.src) return img.src;
}
// 2. From currently selected asset card in DOM
@@ -464,7 +497,11 @@ function injectCopyPromptNextToDownload(downloadBtn) {
copyBtn.onclick = async (e) => {
e.preventDefault();
e.stopPropagation();
const activeImg = card.querySelector("img") || img;
// Resolve the card/image at click time: the grid may have
// recycled this card for another asset since injection.
const liveCard = copyBtn.closest(ASSET_CARD_SELECTOR) || card;
const activeImg = liveCard.querySelector("img") || img;
if (!activeImg || !activeImg.src) return;
const success = await copyImagePrompt(activeImg.src);
if (hasModernIcons) {
copyBtn.innerHTML = success
@@ -503,7 +540,8 @@ function injectCopyPromptNextToDownload(downloadBtn) {
inspectBtn.onclick = (e) => {
e.preventDefault();
e.stopPropagation();
const target = card.querySelector(".aspect-square, [class*='aspect-square'], img") || img;
const liveCard = inspectBtn.closest(ASSET_CARD_SELECTOR) || card;
const target = liveCard.querySelector(".aspect-square, [class*='aspect-square'], img") || img;
if (target) {
target.dispatchEvent(new MouseEvent("dblclick", { bubbles: true, cancelable: true, view: window }));
}
@@ -609,7 +647,7 @@ function injectContextMenuCopy(contextMenu) {
// 5. Fallback Hook for Older Frontend Action Bars
function injectHoverCopyAction(overlayBar) {
if (!overlayBar || overlayBar.querySelector(".saturnnodes-hover-copy")) return;
if (!overlayBar) return;
if (!isCopyEnabled("SaturnNodes.📋 Prompt Actions.01_EnableAssetsCopyPromptButton")) return;
if (isQueueItemElement(overlayBar)) return;
@@ -626,9 +664,7 @@ function injectHoverCopyAction(overlayBar) {
overlayBar.querySelector('button[aria-label*="zoom" i]')?.parentElement ||
overlayBar;
const parentCard = overlayBar.closest(
"div[data-virtual-grid-item], .asset-card, [data-testid='asset-card'], [data-node-id], .lg-node, .comfy-image-preview"
);
const parentCard = overlayBar.closest(ASSET_CARD_SELECTOR);
if (!parentCard) return;
if (isQueueItemElement(parentCard)) return;
@@ -636,18 +672,31 @@ function injectHoverCopyAction(overlayBar) {
if (!img || !img.src) return;
if (img.classList.contains("size-8") || img.closest(".size-8, .size-10, .h-12")) return;
// Older action bars keep injected children when they are reused for the
// next asset. Drop a button that is bound to a previous asset instead of
// leaving it to copy the old image.
const assetKey = assetIdentityKey(parentCard) || "";
const existingBtn = overlayBar.querySelector(".saturnnodes-hover-copy");
if (existingBtn && existingBtn.dataset.saturnnodesAssetKey === assetKey) return;
if (existingBtn) existingBtn.remove();
const copyBtn = document.createElement("button");
copyBtn.className =
"saturnnodes-hover-btn saturnnodes-hover-copy relative inline-flex items-center justify-center cursor-pointer touch-manipulation appearance-none border-none text-xs font-medium font-inter transition-colors focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring disabled:pointer-events-none disabled:opacity-50 bg-white text-gray-700 hover:bg-gray-100 size-8 p-0 rounded-none pointer-events-auto border-r border-gray-200 shrink-0";
copyBtn.title = "Copy Prompt";
copyBtn.setAttribute("aria-label", "Copy Prompt");
copyBtn.setAttribute("data-pd-tooltip", "true");
copyBtn.dataset.saturnnodesAssetKey = assetKey;
copyBtn.innerHTML = "<span class='text-sm pointer-events-none'>📋</span>";
copyBtn.onclick = async (e) => {
e.preventDefault();
e.stopPropagation();
const success = await copyImagePrompt(img.src);
// Re-resolve at click time: the overlay may now belong to another asset.
const liveCard = copyBtn.closest(ASSET_CARD_SELECTOR) || parentCard;
const liveImg = liveCard.querySelector("img") || img;
if (!liveImg || !liveImg.src) return;
const success = await copyImagePrompt(liveImg.src);
if (success) {
copyBtn.innerHTML = "<span class='text-sm pointer-events-none'>✅</span>";
setTimeout(() => (copyBtn.innerHTML = "<span class='text-sm pointer-events-none'>📋</span>"), 2000);
+37 -7
View File
@@ -2,6 +2,7 @@ import { app } from "/scripts/app.js";
import { api } from "/scripts/api.js";
import { isSaturnColorsEnabled } from "../saturnnodes_colors.js";
import { authenticatedFetch } from "./auth_helper.js";
import { resolveLiveWidgetElement } from "./live_dom.js";
// Hash folder name to get a consistent color for the border
function getFolderBorderColor(folderName) {
@@ -19,6 +20,17 @@ function getFolderBorderColor(folderName) {
return `hsl(${h}, 65%, 50%)`;
}
// Read the thumbnail setting without the deprecated getSettingValue(id, default)
// second argument, which logs a console warning on every access.
function getBypassThumbnailDownscaling() {
try {
const value = app.ui?.settings?.getSettingValue?.("SaturnNodes.🖼️ Visual Loaders.07_BypassThumbnailDownscaling");
return value === undefined || value === null ? false : Boolean(value);
} catch (_) {
return false;
}
}
// Global CSS injection for the visual node styling
const visualStyles = document.createElement("style");
visualStyles.textContent = `
@@ -684,6 +696,8 @@ app.registerExtension({
createSpecialTile("[ NONE ]", "NONE", "#ff3333", "lora-tile-none");
createSpecialTile("[ RANDOM ]", "RANDOM", "#ffaa00", "lora-tile-random");
const bypassThumbs = getBypassThumbnailDownscaling();
data.names.forEach(loraName => {
if (loraName === "[ NONE ]" || loraName === "[ RANDOM ]") return;
@@ -706,7 +720,6 @@ app.registerExtension({
const img = document.createElement("img");
img.loading = "lazy";
const bypassThumbs = app.ui.settings?.getSettingValue?.("SaturnNodes.🖼️ Visual Loaders.07_BypassThumbnailDownscaling", false);
img.dataset.src = `/saturnnodes/folder_lora_loader/get_preview?lora=${encodeURIComponent(loraName)}&folder=${encodeURIComponent(folder)}&pretty=true` + (bypassThumbs ? "&full=true" : "&size=200");
tileObserver.observe(img);
@@ -1270,10 +1283,18 @@ app.registerExtension({
const updateLoraBadgeColor = () => {
const enabled = isSaturnColorsEnabled();
if (node._loraBadgeSpan) {
node._loraBadgeSpan.style.color = enabled ? "#f59e0b" : "var(--text-muted, #a1a1aa)";
const badgeEl = resolveLiveWidgetElement(
node._loraBadgeEl,
node.id,
"lora_count_preview"
);
if (badgeEl) node._loraBadgeEl = badgeEl;
const badgeSpan = badgeEl?.querySelector?.("span") || node._loraBadgeSpan;
if (badgeSpan) node._loraBadgeSpan = badgeSpan;
if (badgeSpan) {
badgeSpan.style.color = enabled ? "#f59e0b" : "var(--text-muted, #a1a1aa)";
}
const badgeEl = node._loraBadgeEl;
if (badgeEl) {
badgeEl.style.background = enabled
? "rgba(180, 140, 95, 0.12)"
@@ -1314,8 +1335,16 @@ app.registerExtension({
const count = getSelectedLoras().length;
node._selectedLoraCount = count;
const label = `${count} LoRA${count === 1 ? "" : "s"} Selected`;
if (node._loraBadgeSpan) {
node._loraBadgeSpan.textContent = label;
const liveBadgeEl = resolveLiveWidgetElement(
node._loraBadgeEl,
node.id,
"lora_count_preview"
);
if (liveBadgeEl) node._loraBadgeEl = liveBadgeEl;
const liveBadgeSpan = liveBadgeEl?.querySelector?.("span") || node._loraBadgeSpan;
if (liveBadgeSpan) {
node._loraBadgeSpan = liveBadgeSpan;
liveBadgeSpan.textContent = label;
}
if (loraCountWidget) {
loraCountWidget.value = label;
@@ -1535,6 +1564,8 @@ app.registerExtension({
}, { root: gridContainer, rootMargin: "150px" });
// --- Render folder groups ---
const bypassThumbs = getBypassThumbnailDownscaling();
sortedFolders.forEach(subFolder => {
const items = foldersMap[subFolder];
if (items.length === 0) return;
@@ -1624,7 +1655,6 @@ app.registerExtension({
const img = document.createElement("img");
img.loading = "lazy";
const bypassThumbs = app.ui.settings?.getSettingValue?.("SaturnNodes.🖼️ Visual Loaders.07_BypassThumbnailDownscaling", false);
img.dataset.src = `/saturnnodes/folder_lora_loader/get_preview?system_path=${encodeURIComponent(item.systemPath)}` + (bypassThumbs ? "&full=true" : "&size=200");
imageObserver.observe(img);
+42
View File
@@ -0,0 +1,42 @@
/**
* Helpers for DOM widgets whose elements can be unmounted and rebuilt by the
* ComfyUI Vue node renderer or LiteGraph. A cached element reference then
* points at a detached subtree, so writes silently update an invisible node.
*/
export function isLiveElement(el) {
return !!el && (typeof el.isConnected !== "boolean" || el.isConnected);
}
/**
* Return the cached element while it is still live. When it is detached, try
* to find the element the renderer remounted for the same node/widget.
*
* Before the first mount there is no replacement yet, so the cached reference
* is returned to preserve initial-value writes.
*/
export function resolveLiveElement(cachedEl, findFresh) {
if (isLiveElement(cachedEl)) return cachedEl;
if (typeof findFresh === "function") {
try {
const fresh = findFresh();
if (fresh) return fresh;
} catch (_) {}
}
return cachedEl || null;
}
/**
* Re-resolve a node DOM widget by its `data-widget-name` marker.
* Used by the prompt counter and LoRA count badges.
*/
export function resolveLiveWidgetElement(cachedEl, nodeId, widgetName) {
return resolveLiveElement(cachedEl, () => {
if (nodeId === undefined || nodeId === null) return null;
const id = String(nodeId);
return document.querySelector(
`[data-node-id="${id}"] [data-widget-name="${widgetName}"], ` +
`[data-widgets-grid-node-id="${id}"] [data-widget-name="${widgetName}"]`
);
});
}
+23 -5
View File
@@ -12,6 +12,7 @@ let currentPowerState = {
};
let activePopup = null;
let activePopupCleanup = null;
function injectStyles() {
if (document.getElementById(STYLE_ID)) return;
@@ -296,6 +297,15 @@ function checkProcessManagementEnabled() {
}
function closePowerPopup() {
// Document-level listeners must die with the popup they belong to.
// Otherwise an old outside-click handler can close a popup that was
// reopened after this one was dismissed by a menu item.
if (activePopupCleanup) {
try {
activePopupCleanup();
} catch (_) {}
activePopupCleanup = null;
}
if (activePopup) {
activePopup.remove();
activePopup = null;
@@ -307,10 +317,14 @@ async function powerFetch(endpointSuffix, options = {}) {
}
function showPowerSidePopup(anchorElement) {
if (activePopup) {
if (activePopup && activePopup.isConnected) {
closePowerPopup();
return;
}
if (activePopup) {
// Detached popup left over from a DOM swap: clean it up before opening.
closePowerPopup();
}
const popup = document.createElement("div");
popup.className = "help-center-popup sidebar-left saturnnodes-power-popup";
@@ -607,18 +621,22 @@ function showPowerSidePopup(anchorElement) {
const outsideListener = (e) => {
if (popup && !popup.contains(e.target) && !anchorElement.contains(e.target)) {
closePowerPopup();
document.removeEventListener("pointerdown", outsideListener);
document.removeEventListener("keydown", keyListener);
}
};
const keyListener = (e) => {
if (e.key === "Escape") {
closePowerPopup();
document.removeEventListener("pointerdown", outsideListener);
document.removeEventListener("keydown", keyListener);
}
};
const removePopupListeners = () => {
document.removeEventListener("pointerdown", outsideListener);
document.removeEventListener("keydown", keyListener);
};
activePopupCleanup = removePopupListeners;
setTimeout(() => {
// The popup may have been closed (or replaced) before the timer fires.
if (activePopup !== popup) return;
document.addEventListener("pointerdown", outsideListener);
document.addEventListener("keydown", keyListener);
}, 10);
+22 -5
View File
@@ -1,5 +1,6 @@
import { app } from "/scripts/app.js";
import { isSaturnColorsEnabled } from "../saturnnodes_colors.js";
import { resolveLiveWidgetElement } from "./live_dom.js";
function countPromptsInText(text, separator, customRegex) {
if (!text || !text.trim()) return 0;
@@ -104,10 +105,18 @@ app.registerExtension({
function updatePromptBadgeColor() {
const enabled = isSaturnColorsEnabled();
if (node._promptBadgeSpan) {
node._promptBadgeSpan.style.color = enabled ? "#f59e0b" : "var(--text-muted, #a1a1aa)";
const badgeEl = resolveLiveWidgetElement(
node._promptBadgeEl,
node.id,
"prompt_count_preview"
);
if (badgeEl) node._promptBadgeEl = badgeEl;
const badgeSpan = badgeEl?.querySelector?.("span") || node._promptBadgeSpan;
if (badgeSpan) node._promptBadgeSpan = badgeSpan;
if (badgeSpan) {
badgeSpan.style.color = enabled ? "#f59e0b" : "var(--text-muted, #a1a1aa)";
}
const badgeEl = node._promptBadgeEl;
if (badgeEl) {
badgeEl.style.background = enabled
? "rgba(180, 140, 95, 0.12)"
@@ -126,8 +135,16 @@ app.registerExtension({
const count = countPromptsInText(text, sep, regex);
node._promptCount = count;
const label = `${count} Prompt${count === 1 ? "" : "s"}`;
if (node._promptBadgeSpan) {
node._promptBadgeSpan.textContent = label;
const liveBadgeEl = resolveLiveWidgetElement(
node._promptBadgeEl,
node.id,
"prompt_count_preview"
);
if (liveBadgeEl) node._promptBadgeEl = liveBadgeEl;
const liveBadgeSpan = liveBadgeEl?.querySelector?.("span") || node._promptBadgeSpan;
if (liveBadgeSpan) {
node._promptBadgeSpan = liveBadgeSpan;
liveBadgeSpan.textContent = label;
}
if (countWidget) {
countWidget.value = label;
+23 -3
View File
@@ -1,6 +1,7 @@
import { app } from "/scripts/app.js";
import { api } from "/scripts/api.js";
import { PreviewManager } from "./js/preview_manager.js";
import { resolveLiveElement } from "./js/live_dom.js";
// Global CSS injection to guarantee zero-expansion in Vue Node 2.0 and LiteGraph
if (typeof document !== "undefined") {
@@ -370,9 +371,28 @@ app.registerExtension({
}
if (this.previewImgElement && this.previewFallbackText && img && img.src) {
this.previewFallbackText.style.display = "none";
this.previewImgElement.src = img.src;
this.previewImgElement.style.display = "block";
// The Vue node renderer can remount the DOM widget while the
// node object keeps its cached element references. Resolve the
// element that is actually mounted for this node before writing.
const liveImg = resolveLiveElement(this.previewImgElement, () => {
if (this.id === undefined || this.id === null) return null;
return document.querySelector(
`[data-node-id="${this.id}"] .saturnnodes-live-preview-img, ` +
`[data-widgets-grid-node-id="${this.id}"] .saturnnodes-live-preview-img`
);
});
if (liveImg) this.previewImgElement = liveImg;
const liveFallback = resolveLiveElement(this.previewFallbackText, () =>
liveImg?.parentElement?.querySelector?.(".saturnnodes-live-preview-fallback")
);
if (liveFallback) this.previewFallbackText = liveFallback;
if (liveFallback) liveFallback.style.display = "none";
if (liveImg) {
liveImg.src = img.src;
liveImg.style.display = "block";
}
}
if (app.graph && typeof app.graph.setDirtyCanvas === "function") {
+190 -5
View File
@@ -15,6 +15,55 @@ async function postSaturnNodesSettings(bodyObj) {
}
}
let _backendSettings = null;
const BACKEND_SETTING_MAP = {
"SaturnNodes.🖼️ Visual Loaders.01_CivitaiApiKey": "civitai_api_key",
"SaturnNodes.🖼️ Visual Loaders.02_EnableCivitaiScraping": "enable_civitai_scraping",
"SaturnNodes.🖼️ Visual Loaders.03_TMDBApiKey": "tmdb_api_key",
"SaturnNodes.🖼️ Visual Loaders.04_EnableTMDBScraping": "enable_tmdb_scraping",
"SaturnNodes.🖼️ Visual Loaders.05_EnableLoraUsage": "enable_lora_usage",
"SaturnNodes.🖼️ Visual Loaders.08_ImageMetadataScanLimit": "image_loader_metadata_limit",
"SaturnNodes.⏸️ Pause Controls.01_DefaultStateOnLaunch": "default_pause_state",
"SaturnNodes.⏸️ Pause Controls.02_DefaultPauseAction": "default_pause_mode",
"SaturnNodes.⏸️ Pause Controls.02b_PersistPauseState": "persist_pause_state",
"SaturnNodes.⏸️ Pause Controls.06_EnableTrayIcon": "enable_tray_icon",
"SaturnNodes.⏸️ Pause Controls.07_AllowProcessManagement": "enable_process_management",
"SaturnNodes.🔄 Prompt Iterator.01_ClearOnLaunch": "clear_prompt_iterator_on_launch",
"SaturnNodes.💾 Persistent Queue.01_EnablePersistentQueue": "enable_persistent_queue",
"SaturnNodes.💾 Persistent Queue.02_RecoveryLaunchState": "persistent_queue_restored_state",
"SaturnNodes.💾 Persistent Queue.03_MaxRestoreRetries": "persistent_queue_max_retries",
"SaturnNodes.🖼️ Assets Restore.01_RestoreAssetsOnLaunch": "enable_assets_restore",
"SaturnNodes.🖼️ Assets Restore.02_RestoredAssetsCount": "restore_assets_count",
"SaturnNodes.🖼️ Assets Restore.03_RestoreAssetsRecursive": "restore_assets_recursive",
"SaturnNodes.🖼️ Assets Restore.04_ShowRestoredGenerationTime": "show_restored_generation_time",
"SaturnNodes.🛡️ Security.01_AllowLocalFileExecution": "enable_local_file_execution"
};
async function fetchBackendSettings() {
try {
const res = await authenticatedFetch("/saturnnodes/settings");
if (res && res.ok) {
_backendSettings = await res.json();
}
} catch (e) {
console.warn("[SaturnNodes Settings] Failed to load backend .env settings:", e);
}
}
function getBackendInitialSetting(saturnId) {
if (!_backendSettings) return undefined;
const backendKey = BACKEND_SETTING_MAP[saturnId];
if (!backendKey || !(backendKey in _backendSettings)) return undefined;
const value = _backendSettings[backendKey];
if (backendKey === "default_pause_state") {
return String(value).toLowerCase() === "paused" ? "Paused" : "Running";
}
if (backendKey === "default_pause_mode") {
return String(value).toLowerCase().includes("instant") ? "Instant Resume Node" : "Finish Active Prompt";
}
return value;
}
let _disabledNodesCache = null;
let _nodesInfoCache = null;
async function fetchDisabledNodes() {
@@ -716,7 +765,12 @@ function renderSettingButton(label, workingText, successText, onClickHandler) {
}
function getInitialSetting(saturnId, defaultVal) {
// 1. Check ComfyUI settings API (getSettingValue / get)
// 1. The backend .env is the source of truth when it defines the value;
// this keeps the settings UI and the server in sync after manual edits.
const backendValue = getBackendInitialSetting(saturnId);
if (backendValue !== undefined && backendValue !== null) return backendValue;
// 2. Check ComfyUI settings API (getSettingValue / get)
if (typeof app.ui?.settings?.getSettingValue === "function") {
try {
const val = app.ui.settings.getSettingValue(saturnId);
@@ -730,7 +784,7 @@ function getInitialSetting(saturnId, defaultVal) {
} catch (_) {}
}
// 2. Check localStorage
// 3. Check localStorage
if (typeof localStorage !== "undefined") {
const val = localStorage.getItem(`Comfy.Settings.${saturnId}`);
if (val !== null && val !== undefined) {
@@ -740,9 +794,33 @@ function getInitialSetting(saturnId, defaultVal) {
return defaultVal;
}
/**
* Re-apply the saved queue height to lists that mounted after setup.
*
* The legacy v1 queue can mount or recreate its `.comfy-list` independently
* of the overlay, so `attachQueueResizeHandle()` (which early-returns once the
* handle exists) is not enough to keep the height budget applied.
*
* @returns {boolean} true when the apply callback ran for a fresh list.
*/
function reapplyQueueHeightToMountedLists(overlay, heightPx, applyFn) {
if (!overlay || !heightPx || heightPx <= 0 || typeof applyFn !== "function") return false;
const lists = overlay.querySelectorAll?.(".comfy-list") || [];
const marker = String(heightPx);
for (const listEl of lists) {
if (listEl.dataset?.saturnQueueHeight === marker) continue;
applyFn(heightPx);
return true;
}
return false;
}
app.registerExtension({
name: "ComfyUI.SaturnNodes.Settings",
async setup() {
// Load .env-backed settings before registering defaults so the UI and
// backend never disagree about effective values.
await fetchBackendSettings();
// =========================================================================
// GROUP: 🖼️ Visual Loaders
@@ -821,7 +899,7 @@ app.registerExtension({
id: "SaturnNodes.🖼️ Visual Loaders.02_EnableCivitaiScraping",
name: "Enable Civitai Auto-Scraping",
type: "boolean",
defaultValue: getInitialSetting("SaturnNodes.🖼️ Visual Loaders.02_EnableCivitaiScraping", true),
defaultValue: getInitialSetting("SaturnNodes.🖼️ Visual Loaders.02_EnableCivitaiScraping", false),
tooltip: "Toggles automated downloading of preview thumbnails for new LoRAs from Civitai via SHA256 file hashes. Note: SHA256 hash searching will always work regardless of this setting when matching local models.",
onChange(value) {
postSaturnNodesSettings({ enable_civitai_scraping: value ? "true" : "false" });
@@ -918,6 +996,19 @@ app.registerExtension({
}
});
// 3.8 Visual Image Loader Metadata Scan Limit
app.ui.settings.addSetting({
id: "SaturnNodes.🖼️ Visual Loaders.08_ImageMetadataScanLimit",
name: "Image Loader Metadata Scan Limit",
type: "number",
defaultValue: getInitialSetting("SaturnNodes.🖼️ Visual Loaders.08_ImageMetadataScanLimit", 128),
tooltip: "How many of the newest images in a folder are scanned for embedded prompts in the Visual Image Loader (0 disables metadata extraction, max 2000).",
onChange(value) {
const limit = Math.max(0, Math.min(2000, parseInt(value, 10) || 0));
postSaturnNodesSettings({ image_loader_metadata_limit: limit });
}
});
// =========================================================================
// GROUP: 👁️ Live Preview
// =========================================================================
@@ -1121,6 +1212,18 @@ app.registerExtension({
}
});
// 4.2b Persist Manual Pause State Across Restarts
app.ui.settings.addSetting({
id: "SaturnNodes.⏸️ Pause Controls.02b_PersistPauseState",
name: "Persist Pause State Across Restarts",
type: "boolean",
defaultValue: getInitialSetting("SaturnNodes.⏸️ Pause Controls.02b_PersistPauseState", false),
tooltip: "When enabled, the last manual Pause/Continue state and pause mode are restored on the next ComfyUI start (overrides the launch defaults above).",
onChange(value) {
postSaturnNodesSettings({ persist_pause_state: value ? "true" : "false" });
}
});
// 4.3 Enable Pause Queue Toolbar Button
app.ui.settings.addSetting({
id: "SaturnNodes.⏸️ Pause Controls.03_EnableToolbarButton",
@@ -1281,6 +1384,11 @@ app.registerExtension({
} else {
listEl.style.removeProperty("max-height");
}
// Marker lets the overlay observer detect lists that mounted
// after this pass without rewriting styles on every mutation.
if (listEl.dataset) {
listEl.dataset.saturnQueueHeight = String(saturnQueueHeightPx);
}
}
};
@@ -1381,6 +1489,11 @@ app.registerExtension({
const overlay = document.querySelector('[data-testid="queue-progress-overlay"]');
if (overlay) {
attachQueueResizeHandle(overlay);
reapplyQueueHeightToMountedLists(
overlay,
saturnQueueHeightPx,
applyQueueOverlayHeight
);
}
});
queueOverlayObserver.observe(document.body, { childList: true, subtree: true });
@@ -1449,6 +1562,19 @@ app.registerExtension({
}
});
// 5.3 Max Restore Attempts for Failed Queue Items
app.ui.settings.addSetting({
id: "SaturnNodes.💾 Persistent Queue.03_MaxRestoreRetries",
name: "Max Restore Retries",
type: "number",
defaultValue: getInitialSetting("SaturnNodes.💾 Persistent Queue.03_MaxRestoreRetries", 0),
tooltip: "How many times a queue item that fails to restore may be retried on later launches before it is dropped (0 = drop immediately, max 10).",
onChange(value) {
const retries = Math.max(0, Math.min(10, parseInt(value, 10) || 0));
postSaturnNodesSettings({ persistent_queue_max_retries: retries });
}
});
// =========================================================================
// GROUP: 🖼️ Assets Restore
// =========================================================================
@@ -1478,6 +1604,65 @@ app.registerExtension({
}
});
// 6.3 Scan Output Subfolders Recursively
app.ui.settings.addSetting({
id: "SaturnNodes.🖼️ Assets Restore.03_RestoreAssetsRecursive",
name: "Scan Output Subfolders Recursively",
type: "boolean",
defaultValue: getInitialSetting("SaturnNodes.🖼️ Assets Restore.03_RestoreAssetsRecursive", true),
tooltip: "When enabled, restored assets include images in nested output subfolders, not just the top-level output folder.",
onChange(value) {
postSaturnNodesSettings({ restore_assets_recursive: value ? "true" : "false" });
}
});
// 6.4 Show Generation Time on Restored Assets
app.ui.settings.addSetting({
id: "SaturnNodes.🖼️ Assets Restore.04_ShowRestoredGenerationTime",
name: "Show Generation Time on Restored Assets",
type: "boolean",
defaultValue: getInitialSetting("SaturnNodes.🖼️ Assets Restore.04_ShowRestoredGenerationTime", true),
tooltip: "Uses SaturnNodes' generation-time records to show real execution times on restored history entries. Older images keep their file mtime for ordering but show no duration when none was recorded.",
onChange(value) {
postSaturnNodesSettings({ show_restored_generation_time: value ? "true" : "false" });
}
});
// 6.5 Restore Assets Now Button
const handleRestoreAssetsNow = async () => {
const approved = confirm("🪐 Restore assets now?\n\nThis scans the output folder and adds the newest images to the Assets / History pane without restarting ComfyUI.");
if (!approved) return null;
const resp = await authenticatedFetch("/saturnnodes/assets/restore", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ force: true })
});
if (!resp || !resp.ok) throw new Error("Restore request failed");
return await resp.json();
};
const renderRestoreAssetsNowBtn = renderSettingButton("🖼️ Restore Now", "⏳ Restoring...", "✅ Restored!", async () => {
const result = await handleRestoreAssetsNow();
if (result) {
const debug = result.debug || {};
alert(`✅ Restored ${result.restored || 0} asset(s).\n\nScanned: ${debug.total_scanned_images ?? 0}\nElapsed: ${debug.elapsed_ms ?? 0} ms`);
}
});
app.ui.settings.addSetting({
id: "SaturnNodes.🖼️ Assets Restore.05_RestoreNow",
name: "Restore Assets Now",
type: renderRestoreAssetsNowBtn,
render: renderRestoreAssetsNowBtn,
defaultValue: "🖼️ Restore Now",
tooltip: "Immediately scan the output folder and restore the newest images into the Assets / History pane.",
attrs: {
readOnly: true,
style: "display: flex; justify-content: flex-end; width: 100%; border: none !important; background: transparent !important; padding: 0 !important; box-shadow: none !important;",
onClick: handleRestoreAssetsNow
}
});
// =========================================================================
// GROUP: 🩺 Diagnostics
// =========================================================================
@@ -1553,7 +1738,7 @@ app.registerExtension({
name: "Batch Graph Snapshot Guard",
type: "boolean",
defaultValue: getInitialSetting("SaturnNodes.🎨 Batch Queue.02_SnapshotGuard", getInitialSetting("SaturnNodes.BatchQueue.SnapshotGuard", true)),
tooltip: "When queueing multi-item batches, snapshots prompt and node inputs (like text and LoRAs) in the background so mid-queue canvas edits do not corrupt queued items. Random seeds continue to randomize."
tooltip: "Snapshots prompt text, LoRA selections and node inputs when you click Queue (or when a batch is queued behind an in-flight submission), so edits made while ComfyUI is still loading cannot corrupt already queued prompts. Random seeds continue to randomize."
});
// =========================================================================
@@ -1682,7 +1867,7 @@ function setupSettingsFooterObserver() {
<div style="display: flex; align-items: center; gap: 8px;">
<span style="font-size: 16px;">🪐</span>
<span style="font-weight: 600; color: #e4e4e7;">ComfyUI-SaturnNodes</span>
<span style="font-size: 11px; padding: 2px 7px; border-radius: 4px; background: rgba(180, 140, 95, 0.18); color: #decbb2; border: 1px solid rgba(180, 140, 95, 0.35);">v2.6.1 (dev)</span>
<span style="font-size: 11px; padding: 2px 7px; border-radius: 4px; background: rgba(180, 140, 95, 0.18); color: #decbb2; border: 1px solid rgba(180, 140, 95, 0.35);">v2.6.3 (dev)</span>
</div>
<div style="display: flex; align-items: center; gap: 10px; flex-wrap: wrap;">
<a href="https://github.com/KOFiblto/ComfyUI-SaturnNodes" target="_blank" rel="noopener noreferrer" style="color: #decbb2; text-decoration: underline; text-decoration-color: rgba(222, 203, 178, 0.4); text-underline-offset: 3px; font-weight: 500; font-size: 12px; display: inline-flex; align-items: center; gap: 4px; padding: 4px 10px; border-radius: 6px; background: rgba(255, 255, 255, 0.05); border: 1px solid rgba(255, 255, 255, 0.12); transition: all 0.2s ease;" onmouseover="this.style.color='#ffffff'; this.style.background='rgba(255,255,255,0.12)'; this.style.borderColor='rgba(255,255,255,0.25)';" onmouseout="this.style.color='#decbb2'; this.style.background='rgba(255,255,255,0.05)'; this.style.borderColor='rgba(255,255,255,0.12)';">